1 //===-- llvm/Instruction.def - File that describes Instructions -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains descriptions of the various LLVM instructions. This is
11 // used as a central place for enumerating the different instructions and
12 // should eventually be the place to put comments about the instructions.
14 //===----------------------------------------------------------------------===//
16 // NOTE: NO INCLUDE GUARD DESIRED!
18 // Provide definitions of macros so that users of this file do not have to
19 // define everything to use it...
21 #ifndef FIRST_TERM_INST
22 #define FIRST_TERM_INST(num)
24 #ifndef HANDLE_TERM_INST
26 #define HANDLE_TERM_INST(num, opcode, Class)
28 #define HANDLE_TERM_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
31 #ifndef LAST_TERM_INST
32 #define LAST_TERM_INST(num)
35 #ifndef FIRST_BINARY_INST
36 #define FIRST_BINARY_INST(num)
38 #ifndef HANDLE_BINARY_INST
40 #define HANDLE_BINARY_INST(num, opcode, instclass)
42 #define HANDLE_BINARY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
45 #ifndef LAST_BINARY_INST
46 #define LAST_BINARY_INST(num)
49 #ifndef FIRST_MEMORY_INST
50 #define FIRST_MEMORY_INST(num)
52 #ifndef HANDLE_MEMORY_INST
54 #define HANDLE_MEMORY_INST(num, opcode, Class)
56 #define HANDLE_MEMORY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
59 #ifndef LAST_MEMORY_INST
60 #define LAST_MEMORY_INST(num)
63 #ifndef FIRST_CAST_INST
64 #define FIRST_CAST_INST(num)
66 #ifndef HANDLE_CAST_INST
68 #define HANDLE_CAST_INST(num, opcode, Class)
70 #define HANDLE_CAST_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
73 #ifndef LAST_CAST_INST
74 #define LAST_CAST_INST(num)
77 #ifndef FIRST_OTHER_INST
78 #define FIRST_OTHER_INST(num)
80 #ifndef HANDLE_OTHER_INST
82 #define HANDLE_OTHER_INST(num, opcode, Class)
84 #define HANDLE_OTHER_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
87 #ifndef LAST_OTHER_INST
88 #define LAST_OTHER_INST(num)
92 // Terminator Instructions - These instructions are used to terminate a basic
93 // block of the program. Every basic block must end with one of these
94 // instructions for it to be a well formed basic block.
97 HANDLE_TERM_INST ( 1, Ret , ReturnInst)
98 HANDLE_TERM_INST ( 2, Br , BranchInst)
99 HANDLE_TERM_INST ( 3, Switch , SwitchInst)
100 HANDLE_TERM_INST ( 4, Invoke , InvokeInst)
101 HANDLE_TERM_INST ( 5, Unwind , UnwindInst)
102 HANDLE_TERM_INST ( 6, Unreachable, UnreachableInst)
105 // Standard binary operators...
106 FIRST_BINARY_INST( 7)
107 HANDLE_BINARY_INST( 7, Add , BinaryOperator)
108 HANDLE_BINARY_INST( 8, FAdd , BinaryOperator)
109 HANDLE_BINARY_INST( 9, Sub , BinaryOperator)
110 HANDLE_BINARY_INST(10, FSub , BinaryOperator)
111 HANDLE_BINARY_INST(11, Mul , BinaryOperator)
112 HANDLE_BINARY_INST(12, FMul , BinaryOperator)
113 HANDLE_BINARY_INST(13, UDiv , BinaryOperator)
114 HANDLE_BINARY_INST(14, SDiv , BinaryOperator)
115 HANDLE_BINARY_INST(15, FDiv , BinaryOperator)
116 HANDLE_BINARY_INST(16, URem , BinaryOperator)
117 HANDLE_BINARY_INST(17, SRem , BinaryOperator)
118 HANDLE_BINARY_INST(18, FRem , BinaryOperator)
120 // Logical operators (integer operands)
121 HANDLE_BINARY_INST(19, Shl , BinaryOperator) // Shift left (logical)
122 HANDLE_BINARY_INST(20, LShr , BinaryOperator) // Shift right (logical)
123 HANDLE_BINARY_INST(21, AShr , BinaryOperator) // Shift right (arithmetic)
124 HANDLE_BINARY_INST(22, And , BinaryOperator)
125 HANDLE_BINARY_INST(23, Or , BinaryOperator)
126 HANDLE_BINARY_INST(24, Xor , BinaryOperator)
129 // Memory operators...
130 FIRST_MEMORY_INST(25)
131 HANDLE_MEMORY_INST(25, Malloc, MallocInst) // Heap management instructions
132 HANDLE_MEMORY_INST(26, Free , FreeInst )
133 HANDLE_MEMORY_INST(27, Alloca, AllocaInst) // Stack management
134 HANDLE_MEMORY_INST(28, Load , LoadInst ) // Memory manipulation instrs
135 HANDLE_MEMORY_INST(29, Store , StoreInst )
136 HANDLE_MEMORY_INST(30, GetElementPtr, GetElementPtrInst)
139 // Cast operators ...
140 // NOTE: The order matters here because CastInst::isEliminableCastPair
141 // NOTE: (see Instructions.cpp) encodes a table based on this ordering.
143 HANDLE_CAST_INST(31, Trunc , TruncInst ) // Truncate integers
144 HANDLE_CAST_INST(32, ZExt , ZExtInst ) // Zero extend integers
145 HANDLE_CAST_INST(33, SExt , SExtInst ) // Sign extend integers
146 HANDLE_CAST_INST(34, FPToUI , FPToUIInst ) // floating point -> UInt
147 HANDLE_CAST_INST(35, FPToSI , FPToSIInst ) // floating point -> SInt
148 HANDLE_CAST_INST(36, UIToFP , UIToFPInst ) // UInt -> floating point
149 HANDLE_CAST_INST(37, SIToFP , SIToFPInst ) // SInt -> floating point
150 HANDLE_CAST_INST(38, FPTrunc , FPTruncInst ) // Truncate floating point
151 HANDLE_CAST_INST(39, FPExt , FPExtInst ) // Extend floating point
152 HANDLE_CAST_INST(40, PtrToInt, PtrToIntInst) // Pointer -> Integer
153 HANDLE_CAST_INST(41, IntToPtr, IntToPtrInst) // Integer -> Pointer
154 HANDLE_CAST_INST(42, BitCast , BitCastInst ) // Type cast
157 // Other operators...
159 HANDLE_OTHER_INST(43, ICmp , ICmpInst ) // Integer comparison instruction
160 HANDLE_OTHER_INST(44, FCmp , FCmpInst ) // Floating point comparison instr.
161 HANDLE_OTHER_INST(45, PHI , PHINode ) // PHI node instruction
162 HANDLE_OTHER_INST(46, Call , CallInst ) // Call a function
163 HANDLE_OTHER_INST(47, Select , SelectInst ) // select instruction
164 HANDLE_OTHER_INST(48, UserOp1, Instruction) // May be used internally in a pass
165 HANDLE_OTHER_INST(49, UserOp2, Instruction) // Internal to passes only
166 HANDLE_OTHER_INST(50, VAArg , VAArgInst ) // vaarg instruction
167 HANDLE_OTHER_INST(51, ExtractElement, ExtractElementInst)// extract from vector
168 HANDLE_OTHER_INST(52, InsertElement, InsertElementInst) // insert into vector
169 HANDLE_OTHER_INST(53, ShuffleVector, ShuffleVectorInst) // shuffle two vectors.
170 HANDLE_OTHER_INST(54, ExtractValue, ExtractValueInst)// extract from aggregate
171 HANDLE_OTHER_INST(55, InsertValue, InsertValueInst) // insert into aggregate
175 #undef FIRST_TERM_INST
176 #undef HANDLE_TERM_INST
177 #undef LAST_TERM_INST
179 #undef FIRST_BINARY_INST
180 #undef HANDLE_BINARY_INST
181 #undef LAST_BINARY_INST
183 #undef FIRST_MEMORY_INST
184 #undef HANDLE_MEMORY_INST
185 #undef LAST_MEMORY_INST
187 #undef FIRST_CAST_INST
188 #undef HANDLE_CAST_INST
189 #undef LAST_CAST_INST
191 #undef FIRST_OTHER_INST
192 #undef HANDLE_OTHER_INST
193 #undef LAST_OTHER_INST