1 //===-- llvm/Instruction.def - File that describes Instructions -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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 define
19 // 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_OTHER_INST
64 #define FIRST_OTHER_INST(num)
66 #ifndef HANDLE_OTHER_INST
68 #define HANDLE_OTHER_INST(num, opcode, Class)
70 #define HANDLE_OTHER_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
73 #ifndef LAST_OTHER_INST
74 #define LAST_OTHER_INST(num)
78 // Terminator Instructions - These instructions are used to terminate a basic
79 // block of the program. Every basic block must end with one of these
80 // instructions for it to be a well formed basic block.
83 HANDLE_TERM_INST ( 1, Ret , ReturnInst)
84 HANDLE_TERM_INST ( 2, Br , BranchInst)
85 HANDLE_TERM_INST ( 3, Switch , SwitchInst)
86 HANDLE_TERM_INST ( 4, Invoke , InvokeInst)
87 HANDLE_TERM_INST ( 5, Unwind , UnwindInst)
88 HANDLE_TERM_INST ( 6, Unreachable, UnreachableInst)
91 // Standard binary operators...
93 HANDLE_BINARY_INST( 7, Add , BinaryOperator)
94 HANDLE_BINARY_INST( 8, Sub , BinaryOperator)
95 HANDLE_BINARY_INST( 9, Mul , BinaryOperator)
96 HANDLE_BINARY_INST(10, Div , BinaryOperator)
97 HANDLE_BINARY_INST(11, Rem , BinaryOperator)
99 // Logical operators...
100 HANDLE_BINARY_INST(12, And , BinaryOperator)
101 HANDLE_BINARY_INST(13, Or , BinaryOperator)
102 HANDLE_BINARY_INST(14, Xor , BinaryOperator)
104 // Binary comparison operators...
105 HANDLE_BINARY_INST(15, SetEQ , SetCondInst)
106 HANDLE_BINARY_INST(16, SetNE , SetCondInst)
107 HANDLE_BINARY_INST(17, SetLE , SetCondInst)
108 HANDLE_BINARY_INST(18, SetGE , SetCondInst)
109 HANDLE_BINARY_INST(19, SetLT , SetCondInst)
110 HANDLE_BINARY_INST(20, SetGT , SetCondInst)
113 // Memory operators...
114 FIRST_MEMORY_INST(21)
115 HANDLE_MEMORY_INST(21, Malloc, MallocInst) // Heap management instructions
116 HANDLE_MEMORY_INST(22, Free , FreeInst )
117 HANDLE_MEMORY_INST(23, Alloca, AllocaInst) // Stack management
118 HANDLE_MEMORY_INST(24, Load , LoadInst ) // Memory manipulation instrs
119 HANDLE_MEMORY_INST(25, Store , StoreInst )
120 HANDLE_MEMORY_INST(26, GetElementPtr, GetElementPtrInst)
123 // Other operators...
125 HANDLE_OTHER_INST(27, PHI , PHINode ) // PHI node instruction
126 HANDLE_OTHER_INST(28, Cast , CastInst ) // Type cast
127 HANDLE_OTHER_INST(29, Call , CallInst ) // Call a function
129 HANDLE_OTHER_INST(30, Shl , ShiftInst ) // Shift operations
130 HANDLE_OTHER_INST(31, Shr , ShiftInst )
131 HANDLE_OTHER_INST(32, VANext , VANextInst ) // vanext instruction
132 HANDLE_OTHER_INST(33, VAArg , VAArgInst ) // vaarg instruction
133 HANDLE_OTHER_INST(34, Select , SelectInst ) // select instruction
135 HANDLE_OTHER_INST(35, UserOp1, Instruction) // May be used internally in a pass
136 HANDLE_OTHER_INST(36, UserOp2, Instruction)
139 #undef FIRST_TERM_INST
140 #undef HANDLE_TERM_INST
141 #undef LAST_TERM_INST
143 #undef FIRST_BINARY_INST
144 #undef HANDLE_BINARY_INST
145 #undef LAST_BINARY_INST
147 #undef FIRST_MEMORY_INST
148 #undef HANDLE_MEMORY_INST
149 #undef LAST_MEMORY_INST
151 #undef FIRST_OTHER_INST
152 #undef HANDLE_OTHER_INST
153 #undef LAST_OTHER_INST