1 //===- Intrinsics.td - Defines all LLVM intrinsics ---------*- tablegen -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines properties of all LLVM intrinsics.
12 //===----------------------------------------------------------------------===//
14 include "llvm/CodeGen/ValueTypes.td"
16 //===----------------------------------------------------------------------===//
17 // Properties we keep track of for intrinsics.
18 //===----------------------------------------------------------------------===//
20 class IntrinsicProperty;
22 // Intr*Mem - Memory properties. An intrinsic is allowed to have exactly one of
23 // these properties set. They are listed from the most aggressive (best to use
24 // if correct) to the least aggressive. If no property is set, the worst case
25 // is assumed (IntrWriteMem).
27 // IntrNoMem - The intrinsic does not access memory or have any other side
28 // effects. It may be CSE'd deleted if dead, etc.
29 def IntrNoMem : IntrinsicProperty;
31 // IntrReadArgMem - This intrinsic reads only from memory that one of its
32 // arguments points to, but may read an unspecified amount.
33 def IntrReadArgMem : IntrinsicProperty;
35 // IntrReadMem - This intrinsic reads from unspecified memory, so it cannot be
36 // moved across stores. However, it can be reordered otherwise and can be
38 def IntrReadMem : IntrinsicProperty;
40 // IntrWriteArgMem - This intrinsic reads and writes only from memory that one
41 // of its arguments points to, but may access an unspecified amount. It has no
42 // other side effects. This may only be used if the intrinsic doesn't "capture"
43 // the argument pointer (e.g. storing it someplace).
44 def IntrWriteArgMem : IntrinsicProperty;
46 // IntrWriteMem - This intrinsic may read or modify unspecified memory or has
47 // other side effects. It cannot be modified by the optimizer. This is the
48 // default if the intrinsic has no other Intr*Mem property.
49 def IntrWriteMem : IntrinsicProperty;
51 //===----------------------------------------------------------------------===//
52 // Types used by intrinsics.
53 //===----------------------------------------------------------------------===//
55 class LLVMType<ValueType vt, string typeval> {
57 string TypeVal = typeval;
60 class LLVMIntegerType<ValueType VT, int width>
61 : LLVMType<VT, "Type::IntegerTyID"> {
65 class LLVMVectorType<ValueType VT, int numelts, LLVMType elty>
66 : LLVMType<VT, "Type::VectorTyID">{
67 int NumElts = numelts;
71 class LLVMPointerType<LLVMType elty>
72 : LLVMType<iPTR, "Type::PointerTyID">{
76 class LLVMEmptyStructType
77 : LLVMType<OtherVT, "Type::StructTyID">{
80 def llvm_void_ty : LLVMType<isVoid, "Type::VoidTyID">;
81 def llvm_bool_ty : LLVMIntegerType<i1, 1>;
82 def llvm_i8_ty : LLVMIntegerType<i8 , 8>;
83 def llvm_i16_ty : LLVMIntegerType<i16, 16>;
84 def llvm_i32_ty : LLVMIntegerType<i32, 32>;
85 def llvm_i64_ty : LLVMIntegerType<i64, 64>;
86 def llvm_float_ty : LLVMType<f32, "Type::FloatTyID">;
87 def llvm_double_ty : LLVMType<f64, "Type::DoubleTyID">;
88 def llvm_ptr_ty : LLVMPointerType<llvm_i8_ty>; // i8*
89 def llvm_ptrptr_ty : LLVMPointerType<llvm_ptr_ty>; // i8**
90 def llvm_empty_ty : LLVMEmptyStructType; // { }
91 def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>; // { }*
93 def llvm_v16i8_ty : LLVMVectorType<v16i8,16, llvm_i8_ty>; // 16 x i8
94 def llvm_v8i16_ty : LLVMVectorType<v8i16, 8, llvm_i16_ty>; // 8 x i16
95 def llvm_v2i64_ty : LLVMVectorType<v2i64, 2, llvm_i64_ty>; // 2 x i64
96 def llvm_v2i32_ty : LLVMVectorType<v2i32, 2, llvm_i32_ty>; // 2 x i32
97 def llvm_v4i32_ty : LLVMVectorType<v4i32, 4, llvm_i32_ty>; // 4 x i32
98 def llvm_v4f32_ty : LLVMVectorType<v4f32, 4, llvm_float_ty>; // 4 x float
99 def llvm_v2f64_ty : LLVMVectorType<v2f64, 2, llvm_double_ty>;// 2 x double
101 def llvm_vararg_ty : LLVMType<isVoid, "...">; // vararg
103 //===----------------------------------------------------------------------===//
104 // Intrinsic Definitions.
105 //===----------------------------------------------------------------------===//
107 // Intrinsic class - This is used to define one LLVM intrinsic. The name of the
108 // intrinsic definition should start with "int_", then match the LLVM intrinsic
109 // name with the "llvm." prefix removed, and all "."s turned into "_"s. For
110 // example, llvm.bswap.i16 -> int_bswap_i16.
112 // * Types is a list containing the return type and the argument types
113 // expected for the intrinsic.
114 // * Properties can be set to describe the behavior of the intrinsic.
116 class Intrinsic<list<LLVMType> types,
117 list<IntrinsicProperty> properties = [],
119 string LLVMName = name;
120 string TargetPrefix = ""; // Set to a prefix for target-specific intrinsics.
121 list<LLVMType> Types = types;
122 list<IntrinsicProperty> Properties = properties;
125 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
126 /// specifies the name of the builtin. This provides automatic CBE and CFE
128 class GCCBuiltin<string name> {
129 string GCCBuiltinName = name;
133 //===--------------- Variable Argument Handling Intrinsics ----------------===//
136 def int_vastart : Intrinsic<[llvm_void_ty, llvm_ptr_ty], [], "llvm.va_start">;
137 def int_vacopy : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty], [],
139 def int_vaend : Intrinsic<[llvm_void_ty, llvm_ptr_ty], [], "llvm.va_end">;
141 //===------------------- Garbage Collection Intrinsics --------------------===//
143 def int_gcroot : Intrinsic<[llvm_void_ty, llvm_ptrptr_ty, llvm_ptr_ty]>;
144 def int_gcread : Intrinsic<[llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
146 def int_gcwrite : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
147 llvm_ptrptr_ty], [IntrWriteArgMem]>;
149 //===--------------------- Code Generator Intrinsics ----------------------===//
151 def int_returnaddress : Intrinsic<[llvm_ptr_ty, llvm_i32_ty], [IntrNoMem]>;
152 def int_frameaddress : Intrinsic<[llvm_ptr_ty, llvm_i32_ty], [IntrNoMem]>;
153 def int_stacksave : Intrinsic<[llvm_ptr_ty], [IntrReadMem]>,
154 GCCBuiltin<"__builtin_stack_save">;
155 def int_stackrestore : Intrinsic<[llvm_void_ty, llvm_ptr_ty]>,
156 GCCBuiltin<"__builtin_stack_restore">;
157 def int_prefetch : Intrinsic<[llvm_void_ty, llvm_ptr_ty,
158 llvm_i32_ty, llvm_i32_ty]>;
159 def int_pcmarker : Intrinsic<[llvm_void_ty, llvm_i32_ty]>;
161 def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
163 //===------------------- Standard C Library Intrinsics --------------------===//
166 let Properties = [IntrWriteArgMem] in {
167 def int_memcpy_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
168 llvm_i32_ty, llvm_i32_ty]>;
169 def int_memcpy_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
170 llvm_i64_ty, llvm_i32_ty]>;
171 def int_memmove_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
172 llvm_i32_ty, llvm_i32_ty]>;
173 def int_memmove_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
174 llvm_i64_ty, llvm_i32_ty]>;
175 def int_memset_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i8_ty,
176 llvm_i32_ty, llvm_i32_ty]>;
177 def int_memset_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i8_ty,
178 llvm_i64_ty, llvm_i32_ty]>;
181 let Properties = [IntrNoMem] in {
182 def int_sqrt_f32 : Intrinsic<[llvm_float_ty , llvm_float_ty]>;
183 def int_sqrt_f64 : Intrinsic<[llvm_double_ty, llvm_double_ty]>;
185 def int_powi_f32 : Intrinsic<[llvm_float_ty , llvm_float_ty, llvm_i32_ty]>;
186 def int_powi_f64 : Intrinsic<[llvm_double_ty, llvm_double_ty, llvm_i32_ty]>;
189 // NOTE: these are internal interfaces.
190 def int_setjmp : Intrinsic<[llvm_i32_ty , llvm_ptr_ty]>;
191 def int_longjmp : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i32_ty]>;
192 def int_sigsetjmp : Intrinsic<[llvm_i32_ty , llvm_ptr_ty, llvm_i32_ty]>;
193 def int_siglongjmp : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i32_ty]>;
195 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
198 // None of these intrinsics accesses memory at all.
199 let Properties = [IntrNoMem] in {
200 def int_bswap_i16 : Intrinsic<[llvm_i16_ty, llvm_i16_ty]>;
201 def int_bswap_i32 : Intrinsic<[llvm_i32_ty, llvm_i32_ty]>;
202 def int_bswap_i64 : Intrinsic<[llvm_i64_ty, llvm_i64_ty]>;
204 def int_ctpop_i8 : Intrinsic<[llvm_i8_ty, llvm_i8_ty]>;
205 def int_ctpop_i16 : Intrinsic<[llvm_i16_ty, llvm_i16_ty]>;
206 def int_ctpop_i32 : Intrinsic<[llvm_i32_ty, llvm_i32_ty]>;
207 def int_ctpop_i64 : Intrinsic<[llvm_i64_ty, llvm_i64_ty]>;
209 def int_ctlz_i8 : Intrinsic<[llvm_i8_ty, llvm_i8_ty]>;
210 def int_ctlz_i16 : Intrinsic<[llvm_i16_ty, llvm_i16_ty]>;
211 def int_ctlz_i32 : Intrinsic<[llvm_i32_ty, llvm_i32_ty]>;
212 def int_ctlz_i64 : Intrinsic<[llvm_i64_ty, llvm_i64_ty]>;
214 def int_cttz_i8 : Intrinsic<[llvm_i8_ty, llvm_i8_ty]>;
215 def int_cttz_i16 : Intrinsic<[llvm_i16_ty, llvm_i16_ty]>;
216 def int_cttz_i32 : Intrinsic<[llvm_i32_ty, llvm_i32_ty]>;
217 def int_cttz_i64 : Intrinsic<[llvm_i64_ty, llvm_i64_ty]>;
220 //===------------------------ Debugger Intrinsics -------------------------===//
223 def int_dbg_stoppoint : Intrinsic<[llvm_void_ty,
224 llvm_i32_ty, llvm_i32_ty,
225 llvm_descriptor_ty]>;
226 def int_dbg_region_start : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
227 def int_dbg_region_end : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
228 def int_dbg_func_start : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
229 def int_dbg_declare : Intrinsic<[llvm_void_ty, llvm_descriptor_ty,
230 llvm_descriptor_ty]>;
232 //===------------------ Exception Handling Intrinsics----------------------===//
234 def int_eh_exception : Intrinsic<[llvm_ptr_ty]>;
235 def int_eh_selector : Intrinsic<[llvm_i32_ty, llvm_ptr_ty, llvm_ptr_ty,
237 def int_eh_typeid_for : Intrinsic<[llvm_i32_ty, llvm_ptr_ty]>;
239 //===----------------------------------------------------------------------===//
240 // Target-specific intrinsics
241 //===----------------------------------------------------------------------===//
243 include "llvm/IntrinsicsPowerPC.td"
244 include "llvm/IntrinsicsX86.td"