Split the PPC and X86 intrinsics out to their own files.
[oota-llvm.git] / include / llvm / Intrinsics.td
1 //===- Intrinsics.td - Defines all LLVM intrinsics ---------*- tablegen -*-===//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
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.
7 // 
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines properties of all LLVM intrinsics.
11 //
12 //===----------------------------------------------------------------------===//
13
14 include "llvm/CodeGen/ValueTypes.td"
15
16 //===----------------------------------------------------------------------===//
17 //  Properties we keep track of for intrinsics.
18 //===----------------------------------------------------------------------===//
19
20 class IntrinsicProperty;
21
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).
26
27 // InstrNoMem - The intrinsic does not access memory or have any other side
28 // effects.  It may be CSE'd deleted if dead, etc.
29 def InstrNoMem : IntrinsicProperty;
30
31 // InstrReadArgMem - This intrinsic reads only from memory that one of its
32 // arguments points to, but may read an unspecified amount.
33 def InstrReadArgMem : IntrinsicProperty;
34
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
37 // deleted if dead.
38 def IntrReadMem : IntrinsicProperty;
39
40 // InstrWriteArgMem - 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 InstrWriteArgMem : IntrinsicProperty;
45
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;
50
51 //===----------------------------------------------------------------------===//
52 // Types used by intrinsics.
53 //===----------------------------------------------------------------------===//
54
55 class LLVMType<ValueType vt, string typeval> {
56   ValueType VT = vt;
57   string TypeVal = typeval;
58 }
59
60 class LLVMPackedType<ValueType VT, int numelts, LLVMType elty>
61   : LLVMType<VT, "Type::PackedTyID">{
62   int NumElts = numelts;
63   LLVMType ElTy = elty;
64
65
66 def llvm_void_ty       : LLVMType<isVoid, "Type::VoidTyID">;
67 def llvm_bool_ty       : LLVMType<i1 , "Type::BoolTyID">;
68 def llvm_sbyte_ty      : LLVMType<i8 , "Type::SByteTyID">;
69 def llvm_short_ty      : LLVMType<i16, "Type::ShortTyID">;
70 def llvm_int_ty        : LLVMType<i32, "Type::IntTyID">;
71 def llvm_long_ty       : LLVMType<i64, "Type::LongTyID">;
72 def llvm_ubyte_ty      : LLVMType<i8,  "Type::UByteTyID">;
73 def llvm_ushort_ty     : LLVMType<i16, "Type::UShortTyID">;
74 def llvm_uint_ty       : LLVMType<i32, "Type::UIntTyID">;
75 def llvm_ulong_ty      : LLVMType<i64, "Type::ULongTyID">;
76 def llvm_float_ty      : LLVMType<f32, "Type::FloatTyID">;
77 def llvm_double_ty     : LLVMType<f64, "Type::DoubleTyID">;
78 def llvm_ptr_ty        : LLVMType<OtherVT, "Type::PointerTyID">;     // sbyte*
79 def llvm_ptrptr_ty     : LLVMType<OtherVT, "Type::PointerTyID">;     // sbyte**
80 def llvm_descriptor_ty : LLVMType<OtherVT, "Type::PointerTyID">;     // global*
81
82 def llvm_v16i8_ty      : LLVMPackedType<v16i8,16, llvm_sbyte_ty>;  // 16 x sbyte
83 def llvm_v8i16_ty      : LLVMPackedType<v8i16, 8, llvm_short_ty>;  // 8 x short
84
85 def llvm_v2i32_ty      : LLVMPackedType<v2i32, 2, llvm_int_ty>;    // 2 x int
86 def llvm_v4i32_ty      : LLVMPackedType<v4i32, 4, llvm_int_ty>;    // 4 x int
87 def llvm_v4f32_ty      : LLVMPackedType<v4f32, 4, llvm_float_ty>;  // 4 x float
88 def llvm_v2f64_ty      : LLVMPackedType<v2f64, 2, llvm_double_ty>; // 2 x double
89
90 //===----------------------------------------------------------------------===//
91 // Intrinsic Definitions.
92 //===----------------------------------------------------------------------===//
93
94 // Intrinsic class - This is used to define one LLVM intrinsic.  The name of the
95 // intrinsic definition should start with "int_", then match the LLVM intrinsic
96 // name with the "llvm." prefix removed, and all "."s turned into "_"s.  For
97 // example, llvm.bswap.i16 -> int_bswap_i16.
98 //
99 //  * Types is a list containing the return type and the argument types
100 //    expected for the intrinsic.
101 //  * Properties can be set to describe the behavior of the intrinsic.
102 //
103 class Intrinsic<list<LLVMType> types,
104                 list<IntrinsicProperty> properties = [],
105                 string name = ""> {
106   string LLVMName = name;
107   string TargetPrefix = "";   // Set to a prefix for target-specific intrinsics.
108   list<LLVMType> Types = types;
109   list<IntrinsicProperty> Properties = properties;
110 }
111
112 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
113 /// specifies the name of the builtin.  This provides automatic CBE and CFE
114 /// support.
115 class GCCBuiltin<string name> {
116   string GCCBuiltinName = name;
117 }
118
119
120 //===--------------- Variable Argument Handling Intrinsics ----------------===//
121 //  
122
123 def int_vastart : Intrinsic<[llvm_void_ty, llvm_ptrptr_ty], [], "llvm.va_start">;
124 def int_vacopy  : Intrinsic<[llvm_void_ty, llvm_ptrptr_ty, llvm_ptrptr_ty], [],
125                             "llvm.va_copy">;
126 def int_vaend   : Intrinsic<[llvm_void_ty, llvm_ptrptr_ty], [], "llvm.va_end">;
127
128 //===------------------- Garbage Collection Intrinsics --------------------===//
129 //  
130 def int_gcroot  : Intrinsic<[llvm_void_ty, llvm_ptrptr_ty, llvm_ptr_ty]>;
131 def int_gcread  : Intrinsic<[llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
132                             [InstrReadArgMem]>;
133 def int_gcwrite : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
134                              llvm_ptrptr_ty], [InstrWriteArgMem]>;
135
136 //===--------------------- Code Generator Intrinsics ----------------------===//
137 //  
138 def int_returnaddress : Intrinsic<[llvm_ptr_ty, llvm_uint_ty], [InstrNoMem]>;
139 def int_frameaddress  : Intrinsic<[llvm_ptr_ty, llvm_uint_ty], [InstrNoMem]>;
140 def int_stacksave     : Intrinsic<[llvm_ptr_ty], [IntrReadMem]>;
141 def int_stackrestore  : Intrinsic<[llvm_void_ty, llvm_ptr_ty]>;
142 def int_prefetch      : Intrinsic<[llvm_void_ty, llvm_ptr_ty, 
143                                    llvm_uint_ty, llvm_uint_ty]>;
144 def int_pcmarker      : Intrinsic<[llvm_void_ty, llvm_uint_ty]>;
145
146 def int_readcyclecounter : Intrinsic<[llvm_ulong_ty]>;
147
148 //===------------------- Standard C Library Intrinsics --------------------===//
149 //
150
151 let Properties = [InstrWriteArgMem] in {
152   def int_memcpy_i32  : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
153                                    llvm_uint_ty, llvm_uint_ty]>;
154   def int_memcpy_i64  : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
155                                    llvm_ulong_ty, llvm_uint_ty]>;
156   def int_memmove_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
157                                    llvm_uint_ty, llvm_uint_ty]>;
158   def int_memmove_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
159                                    llvm_ulong_ty, llvm_uint_ty]>;
160   def int_memset_i32  : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ubyte_ty,
161                                    llvm_uint_ty, llvm_uint_ty]>;
162   def int_memset_i64  : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ubyte_ty,
163                                    llvm_ulong_ty, llvm_uint_ty]>;
164 }
165
166 let Properties = [InstrNoMem] in {
167   def int_isunordered_f32 : Intrinsic<[llvm_bool_ty, 
168                                        llvm_float_ty,  llvm_float_ty]>;
169   def int_isunordered_f64 : Intrinsic<[llvm_bool_ty, 
170                                        llvm_double_ty, llvm_double_ty]>;
171   def int_sqrt_f32 : Intrinsic<[llvm_float_ty , llvm_float_ty]>;
172   def int_sqrt_f64 : Intrinsic<[llvm_double_ty, llvm_double_ty]>;
173 }
174
175 // NOTE: these are internal interfaces.
176 def int_setjmp     : Intrinsic<[llvm_int_ty , llvm_ptr_ty]>;
177 def int_longjmp    : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_int_ty]>;
178 def int_sigsetjmp  : Intrinsic<[llvm_int_ty , llvm_ptr_ty]>;
179 def int_siglongjmp : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_int_ty]>;
180
181 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
182 //
183
184 // None of these intrinsics accesses memory at all.
185 let Properties = [InstrNoMem] in {
186   def int_bswap_i16 : Intrinsic<[llvm_ushort_ty, llvm_ushort_ty]>;
187   def int_bswap_i32 : Intrinsic<[llvm_uint_ty,   llvm_uint_ty]>;
188   def int_bswap_i64 : Intrinsic<[llvm_ulong_ty,  llvm_ulong_ty]>;
189
190   def int_ctpop_i8  : Intrinsic<[llvm_ubyte_ty,  llvm_ubyte_ty]>;
191   def int_ctpop_i16 : Intrinsic<[llvm_ushort_ty, llvm_ushort_ty]>;
192   def int_ctpop_i32 : Intrinsic<[llvm_uint_ty,   llvm_uint_ty]>;
193   def int_ctpop_i64 : Intrinsic<[llvm_ulong_ty,  llvm_ulong_ty]>;
194   
195   def int_ctlz_i8  : Intrinsic<[llvm_ubyte_ty,  llvm_ubyte_ty]>;
196   def int_ctlz_i16 : Intrinsic<[llvm_ushort_ty, llvm_ushort_ty]>;
197   def int_ctlz_i32 : Intrinsic<[llvm_uint_ty,   llvm_uint_ty]>;
198   def int_ctlz_i64 : Intrinsic<[llvm_ulong_ty,  llvm_ulong_ty]>;
199
200   def int_cttz_i8  : Intrinsic<[llvm_ubyte_ty,  llvm_ubyte_ty]>;
201   def int_cttz_i16 : Intrinsic<[llvm_ushort_ty, llvm_ushort_ty]>;
202   def int_cttz_i32 : Intrinsic<[llvm_uint_ty,   llvm_uint_ty]>;
203   def int_cttz_i64 : Intrinsic<[llvm_ulong_ty,  llvm_ulong_ty]>;
204
205
206 //===------------------------ Debugger Intrinsics -------------------------===//
207 //
208
209 def int_dbg_stoppoint    : Intrinsic<[llvm_void_ty,
210                                       llvm_uint_ty, llvm_uint_ty, 
211                                       llvm_descriptor_ty]>;
212 def int_dbg_region_start : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
213 def int_dbg_region_end   : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
214 def int_dbg_func_start   : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
215 def int_dbg_declare      : Intrinsic<[llvm_void_ty, llvm_ptr_ty,
216                                                     llvm_descriptor_ty]>;
217
218 //===----------------------------------------------------------------------===//
219 // Target-specific intrinsics
220 //===----------------------------------------------------------------------===//
221
222 include "llvm/IntrinsicsPowerPC.td"
223 include "llvm/IntrinsicsX86.td"