include/llvm/Instruction.def

   1 //===-- llvm/Instruction.def - File that describes Instructions --*- C++ -*--=//
   2 //
   3 // This file contains descriptions of the various LLVM instructions.  This is
   4 // used as a central place for enumerating the different instructions and
   5 // should eventually be the place to put comments about the instructions.
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 // NOTE: NO INCLUDE GUARD DESIRED!
  10
  11 // Provide definitions of macros so that users of this file don't have to define
  12 // everything to use it...
  13 //
  14 #ifndef FIRST_TERM_INST
  15 #define FIRST_TERM_INST(num)
  16 #endif
  17 #ifndef HANDLE_TERM_INST
  18 #ifndef HANDLE_INST
  19 #define HANDLE_TERM_INST(num, opcode, Class)
  20 #else
  21 #define HANDLE_TERM_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  22 #endif
  23 #endif
  24 #ifndef LAST_TERM_INST
  25 #define LAST_TERM_INST(num)
  26 #endif
  27
  28 #ifndef FIRST_UNARY_INST
  29 #define FIRST_UNARY_INST(num)
  30 #endif
  31 #ifndef HANDLE_UNARY_INST
  32 #ifndef HANDLE_INST
  33 #define HANDLE_UNARY_INST(num, opcode, Class)
  34 #else
  35 #define HANDLE_UNARY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  36 #endif
  37 #endif
  38 #ifndef LAST_UNARY_INST
  39 #define LAST_UNARY_INST(num)
  40 #endif
  41
  42 #ifndef FIRST_BINARY_INST
  43 #define FIRST_BINARY_INST(num)
  44 #endif
  45 #ifndef HANDLE_BINARY_INST
  46 #ifndef HANDLE_INST
  47 #define HANDLE_BINARY_INST(num, opcode, instclass)
  48 #else
  49 #define HANDLE_BINARY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  50 #endif
  51 #endif
  52 #ifndef LAST_BINARY_INST
  53 #define LAST_BINARY_INST(num)
  54 #endif
  55
  56 #ifndef FIRST_MEMORY_INST
  57 #define FIRST_MEMORY_INST(num)
  58 #endif
  59 #ifndef HANDLE_MEMORY_INST
  60 #ifndef HANDLE_INST
  61 #define HANDLE_MEMORY_INST(num, opcode, Class)
  62 #else
  63 #define HANDLE_MEMORY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  64 #endif
  65 #endif
  66 #ifndef LAST_MEMORY_INST
  67 #define LAST_MEMORY_INST(num)
  68 #endif
  69
  70 #ifndef FIRST_OTHER_INST
  71 #define FIRST_OTHER_INST(num)
  72 #endif
  73 #ifndef HANDLE_OTHER_INST
  74 #ifndef HANDLE_INST
  75 #define HANDLE_OTHER_INST(num, opcode, Class)
  76 #else
  77 #define HANDLE_OTHER_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  78 #endif
  79 #endif
  80 #ifndef LAST_OTHER_INST
  81 #define LAST_OTHER_INST(num)
  82 #endif
  83
  84
  85 // Terminator Instructions - These instructions are used to terminate a basic
  86 // block of the program.   Every basic block must end with one of these
  87 // instructions for it to be a well formed basic block.
  88 //
  89  FIRST_TERM_INST  ( 1)
  90 HANDLE_TERM_INST  ( 1, Ret   , ReturnInst)
  91 HANDLE_TERM_INST  ( 2, Br    , BranchInst)
  92 HANDLE_TERM_INST  ( 3, Switch, SwitchInst)
  93 HANDLE_TERM_INST  ( 4, Invoke, InvokeInst)
  94   LAST_TERM_INST  ( 4)
  95
  96 // The single unary instruction... a binary inverse.
  97  FIRST_UNARY_INST ( 5)
  98 HANDLE_UNARY_INST ( 5, Not   , GenericUnaryInst)
  99   LAST_UNARY_INST ( 5)
 100
 101 // Standard binary operators...
 102  FIRST_BINARY_INST( 6)
 103 HANDLE_BINARY_INST( 6, Add   , GenericBinaryInst)
 104 HANDLE_BINARY_INST( 7, Sub   , GenericBinaryInst)
 105 HANDLE_BINARY_INST( 8, Mul   , GenericBinaryInst)
 106 HANDLE_BINARY_INST( 9, Div   , GenericBinaryInst)
 107 HANDLE_BINARY_INST(10, Rem   , GenericBinaryInst)
 108
 109 // Logical operators...
 110 HANDLE_BINARY_INST(11, And   , GenericBinaryInst)
 111 HANDLE_BINARY_INST(12, Or    , GenericBinaryInst)
 112 HANDLE_BINARY_INST(13, Xor   , GenericBinaryInst)
 113
 114 // Binary comparison operators...
 115 HANDLE_BINARY_INST(14, SetEQ , SetCondInst)
 116 HANDLE_BINARY_INST(15, SetNE , SetCondInst)
 117 HANDLE_BINARY_INST(16, SetLE , SetCondInst)
 118 HANDLE_BINARY_INST(17, SetGE , SetCondInst)
 119 HANDLE_BINARY_INST(18, SetLT , SetCondInst)
 120 HANDLE_BINARY_INST(19, SetGT , SetCondInst)
 121   LAST_BINARY_INST(19)
 122
 123 // Memory operators...
 124  FIRST_MEMORY_INST(20)
 125 HANDLE_MEMORY_INST(20, Malloc, MallocInst)  // Heap management instructions
 126 HANDLE_MEMORY_INST(21, Free  , FreeInst  )
 127 HANDLE_MEMORY_INST(22, Alloca, AllocaInst)  // Stack management
 128 HANDLE_MEMORY_INST(23, Load  , LoadInst  )  // Memory manipulation instrs
 129 HANDLE_MEMORY_INST(24, Store , StoreInst )
 130 HANDLE_MEMORY_INST(25, GetElementPtr, GetElementPtrInst)
 131   LAST_MEMORY_INST(25)
 132
 133 // Other operators...
 134  FIRST_OTHER_INST(26)
 135 HANDLE_OTHER_INST(26, PHINode, PHINode    )  // PHI node instruction
 136 HANDLE_OTHER_INST(27, Cast   , CastInst   )  // Type cast
 137 HANDLE_OTHER_INST(28, Call   , CallInst   )  // Call a function
 138
 139 HANDLE_OTHER_INST(29, Shl    , ShiftInst  )  // Shift operations
 140 HANDLE_OTHER_INST(30, Shr    , ShiftInst  )
 141
 142 HANDLE_OTHER_INST(31, UserOp1, Instruction)  // May be used internally in a pass
 143 HANDLE_OTHER_INST(32, UserOp2, Instruction)
 144   LAST_OTHER_INST(32)
 145
 146 #undef  FIRST_TERM_INST
 147 #undef HANDLE_TERM_INST
 148 #undef   LAST_TERM_INST
 149
 150 #undef  FIRST_UNARY_INST
 151 #undef HANDLE_UNARY_INST
 152 #undef   LAST_UNARY_INST
 153
 154 #undef  FIRST_BINARY_INST
 155 #undef HANDLE_BINARY_INST
 156 #undef   LAST_BINARY_INST
 157
 158 #undef  FIRST_MEMORY_INST
 159 #undef HANDLE_MEMORY_INST
 160 #undef   LAST_MEMORY_INST
 161
 162 #undef  FIRST_OTHER_INST
 163 #undef HANDLE_OTHER_INST
 164 #undef   LAST_OTHER_INST
 165
 166 #ifdef HANDLE_INST
 167 #undef HANDLE_INST
 168 #endif