1 //===-- llvm/Target/TargetIntrinsicInfo.h - Instruction Info ----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file describes the target intrinsic instructions to the code generator.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_TARGET_TARGETINTRINSICINFO_H
14 #define LLVM_TARGET_TARGETINTRINSICINFO_H
15 
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/Support/Compiler.h"
18 #include <string>
19 
20 namespace llvm {
21 
22 class Function;
23 class Module;
24 class Type;
25 
26 //---------------------------------------------------------------------------
27 ///
28 /// TargetIntrinsicInfo - Interface to description of machine instruction set
29 ///
30 class TargetIntrinsicInfo {
31   TargetIntrinsicInfo(const TargetIntrinsicInfo &) = delete;
32   void operator=(const TargetIntrinsicInfo &) = delete;
33 public:
34   TargetIntrinsicInfo();
35   virtual ~TargetIntrinsicInfo();
36 
37   /// Return the name of a target intrinsic, e.g. "llvm.bfin.ssync".
38   /// The Tys and numTys parameters are for intrinsics with overloaded types
39   /// (e.g., those using iAny or fAny). For a declaration for an overloaded
40   /// intrinsic, Tys should point to an array of numTys pointers to Type,
41   /// and must provide exactly one type for each overloaded type in the
42   /// intrinsic.
43   virtual std::string getName(unsigned IID, Type **Tys = nullptr,
44                               unsigned numTys = 0) const = 0;
45 
46   /// Look up target intrinsic by name. Return intrinsic ID or 0 for unknown
47   /// names.
48   virtual unsigned lookupName(const char *Name, unsigned Len) const =0;
49 
50   unsigned lookupName(StringRef Name) const {
51     return lookupName(Name.data(), Name.size());
52   }
53 
54   /// Return the target intrinsic ID of a function, or 0.
55   virtual unsigned getIntrinsicID(const Function *F) const;
56 
57   /// Returns true if the intrinsic can be overloaded.
58   virtual bool isOverloaded(unsigned IID) const = 0;
59 
60   /// Create or insert an LLVM Function declaration for an intrinsic,
61   /// and return it. The Tys and numTys are for intrinsics with overloaded
62   /// types. See above for more information.
63   virtual Function *getDeclaration(Module *M, unsigned ID, Type **Tys = nullptr,
64                                    unsigned numTys = 0) const = 0;
65 };
66 
67 } // End llvm namespace
68 
69 #endif
70