1 //===- CodeGenIntrinsic.h - Intrinsic Class Wrapper ------------*- C++ -*--===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines a wrapper class for the 'Intrinsic' TableGen class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_UTILS_TABLEGEN_CODEGENINTRINSICS_H
15 #define LLVM_UTILS_TABLEGEN_CODEGENINTRINSICS_H
16 
17 #include "llvm/CodeGen/MachineValueType.h"
18 #include <string>
19 #include <vector>
20 
21 namespace llvm {
22 class Record;
23 class RecordKeeper;
24 class CodeGenTarget;
25 
26 struct CodeGenIntrinsic {
27   Record *TheDef;             // The actual record defining this intrinsic.
28   std::string Name;           // The name of the LLVM function "llvm.bswap.i32"
29   std::string EnumName;       // The name of the enum "bswap_i32"
30   std::string GCCBuiltinName; // Name of the corresponding GCC builtin, or "".
31   std::string MSBuiltinName;  // Name of the corresponding MS builtin, or "".
32   std::string TargetPrefix;   // Target prefix, e.g. "ppc" for t-s intrinsics.
33 
34   /// This structure holds the return values and parameter values of an
35   /// intrinsic. If the number of return values is > 1, then the intrinsic
36   /// implicitly returns a first-class aggregate. The numbering of the types
37   /// starts at 0 with the first return value and continues from there through
38   /// the parameter list. This is useful for "matching" types.
39   struct IntrinsicSignature {
40     /// The MVT::SimpleValueType for each return type. Note that this list is
41     /// only populated when in the context of a target .td file. When building
42     /// Intrinsics.td, this isn't available, because we don't know the target
43     /// pointer size.
44     std::vector<MVT::SimpleValueType> RetVTs;
45 
46     /// The records for each return type.
47     std::vector<Record *> RetTypeDefs;
48 
49     /// The MVT::SimpleValueType for each parameter type. Note that this list is
50     /// only populated when in the context of a target .td file.  When building
51     /// Intrinsics.td, this isn't available, because we don't know the target
52     /// pointer size.
53     std::vector<MVT::SimpleValueType> ParamVTs;
54 
55     /// The records for each parameter type.
56     std::vector<Record *> ParamTypeDefs;
57   };
58 
59   IntrinsicSignature IS;
60 
61   /// Bit flags describing the type (ref/mod) and location of memory
62   /// accesses that may be performed by the intrinsics. Analogous to
63   /// \c FunctionModRefBehaviour.
64   enum ModRefBits {
65     /// The intrinsic may access memory that is otherwise inaccessible via
66     /// LLVM IR.
67     MR_InaccessibleMem = 1,
68 
69     /// The intrinsic may access memory through pointer arguments.
70     /// LLVM IR.
71     MR_ArgMem = 2,
72 
73     /// The intrinsic may access memory anywhere, i.e. it is not restricted
74     /// to access through pointer arguments.
75     MR_Anywhere = 4 | MR_ArgMem | MR_InaccessibleMem,
76 
77     /// The intrinsic may read memory.
78     MR_Ref = 8,
79 
80     /// The intrinsic may write memory.
81     MR_Mod = 16,
82 
83     /// The intrinsic may both read and write memory.
84     MR_ModRef = MR_Ref | MR_Mod,
85   };
86 
87   /// Memory mod/ref behavior of this intrinsic, corresponding to intrinsic
88   /// properties (IntrReadMem, IntrArgMemOnly, etc.).
89   enum ModRefBehavior {
90     NoMem = 0,
91     ReadArgMem = MR_Ref | MR_ArgMem,
92     ReadInaccessibleMem = MR_Ref | MR_InaccessibleMem,
93     ReadInaccessibleMemOrArgMem = MR_Ref | MR_ArgMem | MR_InaccessibleMem,
94     ReadMem = MR_Ref | MR_Anywhere,
95     WriteArgMem = MR_Mod | MR_ArgMem,
96     WriteInaccessibleMem = MR_Mod | MR_InaccessibleMem,
97     WriteInaccessibleMemOrArgMem = MR_Mod | MR_ArgMem | MR_InaccessibleMem,
98     WriteMem = MR_Mod | MR_Anywhere,
99     ReadWriteArgMem = MR_ModRef | MR_ArgMem,
100     ReadWriteInaccessibleMem = MR_ModRef | MR_InaccessibleMem,
101     ReadWriteInaccessibleMemOrArgMem = MR_ModRef | MR_ArgMem |
102                                        MR_InaccessibleMem,
103     ReadWriteMem = MR_ModRef | MR_Anywhere,
104   };
105   ModRefBehavior ModRef;
106 
107   /// This is set to true if the intrinsic is overloaded by its argument
108   /// types.
109   bool isOverloaded;
110 
111   /// True if the intrinsic is commutative.
112   bool isCommutative;
113 
114   /// True if the intrinsic can throw.
115   bool canThrow;
116 
117   /// True if the intrinsic is marked as noduplicate.
118   bool isNoDuplicate;
119 
120   /// True if the intrinsic is no-return.
121   bool isNoReturn;
122 
123   /// True if the intrinsic is marked as convergent.
124   bool isConvergent;
125 
126   /// True if the intrinsic has side effects that aren't captured by any
127   /// of the other flags.
128   bool hasSideEffects;
129 
130   // True if the intrinsic is marked as speculatable.
131   bool isSpeculatable;
132 
133   enum ArgAttribute { NoCapture, Returned, ReadOnly, WriteOnly, ReadNone };
134   std::vector<std::pair<unsigned, ArgAttribute>> ArgumentAttributes;
135 
136   CodeGenIntrinsic(Record *R);
137 };
138 
139 class CodeGenIntrinsicTable {
140   std::vector<CodeGenIntrinsic> Intrinsics;
141 
142 public:
143   struct TargetSet {
144     std::string Name;
145     size_t Offset;
146     size_t Count;
147   };
148   std::vector<TargetSet> Targets;
149 
150   explicit CodeGenIntrinsicTable(const RecordKeeper &RC, bool TargetOnly);
151   CodeGenIntrinsicTable() = default;
152 
153   bool empty() const { return Intrinsics.empty(); }
154   size_t size() const { return Intrinsics.size(); }
155   CodeGenIntrinsic &operator[](size_t Pos) { return Intrinsics[Pos]; }
156   const CodeGenIntrinsic &operator[](size_t Pos) const {
157     return Intrinsics[Pos];
158   }
159 };
160 }
161 
162 #endif
163