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_BINARY_INST
  29 #define FIRST_BINARY_INST(num)
  30 #endif
  31 #ifndef HANDLE_BINARY_INST
  32 #ifndef HANDLE_INST
  33 #define HANDLE_BINARY_INST(num, opcode, instclass)
  34 #else
  35 #define HANDLE_BINARY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  36 #endif
  37 #endif
  38 #ifndef LAST_BINARY_INST
  39 #define LAST_BINARY_INST(num)
  40 #endif
  41
  42 #ifndef FIRST_MEMORY_INST
  43 #define FIRST_MEMORY_INST(num)
  44 #endif
  45 #ifndef HANDLE_MEMORY_INST
  46 #ifndef HANDLE_INST
  47 #define HANDLE_MEMORY_INST(num, opcode, Class)
  48 #else
  49 #define HANDLE_MEMORY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  50 #endif
  51 #endif
  52 #ifndef LAST_MEMORY_INST
  53 #define LAST_MEMORY_INST(num)
  54 #endif
  55
  56 #ifndef FIRST_OTHER_INST
  57 #define FIRST_OTHER_INST(num)
  58 #endif
  59 #ifndef HANDLE_OTHER_INST
  60 #ifndef HANDLE_INST
  61 #define HANDLE_OTHER_INST(num, opcode, Class)
  62 #else
  63 #define HANDLE_OTHER_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  64 #endif
  65 #endif
  66 #ifndef LAST_OTHER_INST
  67 #define LAST_OTHER_INST(num)
  68 #endif
  69
  70
  71 // Terminator Instructions - These instructions are used to terminate a basic
  72 // block of the program.   Every basic block must end with one of these
  73 // instructions for it to be a well formed basic block.
  74 //
  75  FIRST_TERM_INST  ( 1)
  76 HANDLE_TERM_INST  ( 1, Ret   , ReturnInst)
  77 HANDLE_TERM_INST  ( 2, Br    , BranchInst)
  78 HANDLE_TERM_INST  ( 3, Switch, SwitchInst)
  79 HANDLE_TERM_INST  ( 4, Invoke, InvokeInst)
  80   LAST_TERM_INST  ( 4)
  81
  82 // Standard binary operators...
  83  FIRST_BINARY_INST( 6)
  84 HANDLE_BINARY_INST( 6, Add   , BinaryOperator)
  85 HANDLE_BINARY_INST( 7, Sub   , BinaryOperator)
  86 HANDLE_BINARY_INST( 8, Mul   , BinaryOperator)
  87 HANDLE_BINARY_INST( 9, Div   , BinaryOperator)
  88 HANDLE_BINARY_INST(10, Rem   , BinaryOperator)
  89
  90 // Logical operators...
  91 HANDLE_BINARY_INST(11, And   , BinaryOperator)
  92 HANDLE_BINARY_INST(12, Or    , BinaryOperator)
  93 HANDLE_BINARY_INST(13, Xor   , BinaryOperator)
  94
  95 // Binary comparison operators...
  96 HANDLE_BINARY_INST(14, SetEQ , SetCondInst)
  97 HANDLE_BINARY_INST(15, SetNE , SetCondInst)
  98 HANDLE_BINARY_INST(16, SetLE , SetCondInst)
  99 HANDLE_BINARY_INST(17, SetGE , SetCondInst)
 100 HANDLE_BINARY_INST(18, SetLT , SetCondInst)
 101 HANDLE_BINARY_INST(19, SetGT , SetCondInst)
 102   LAST_BINARY_INST(19)
 103
 104 // Memory operators...
 105  FIRST_MEMORY_INST(20)
 106 HANDLE_MEMORY_INST(20, Malloc, MallocInst)  // Heap management instructions
 107 HANDLE_MEMORY_INST(21, Free  , FreeInst  )
 108 HANDLE_MEMORY_INST(22, Alloca, AllocaInst)  // Stack management
 109 HANDLE_MEMORY_INST(23, Load  , LoadInst  )  // Memory manipulation instrs
 110 HANDLE_MEMORY_INST(24, Store , StoreInst )
 111 HANDLE_MEMORY_INST(25, GetElementPtr, GetElementPtrInst)
 112   LAST_MEMORY_INST(25)
 113
 114 // Other operators...
 115  FIRST_OTHER_INST(26)
 116 HANDLE_OTHER_INST(26, PHINode, PHINode    )  // PHI node instruction
 117 HANDLE_OTHER_INST(27, Cast   , CastInst   )  // Type cast
 118 HANDLE_OTHER_INST(28, Call   , CallInst   )  // Call a function
 119
 120 HANDLE_OTHER_INST(29, Shl    , ShiftInst  )  // Shift operations
 121 HANDLE_OTHER_INST(30, Shr    , ShiftInst  )
 122 HANDLE_OTHER_INST(31, VarArg , VarArgInst )  // va_arg instruction
 123
 124 HANDLE_OTHER_INST(32, UserOp1, Instruction)  // May be used internally in a pass
 125 HANDLE_OTHER_INST(33, UserOp2, Instruction)
 126   LAST_OTHER_INST(33)
 127
 128 #undef  FIRST_TERM_INST
 129 #undef HANDLE_TERM_INST
 130 #undef   LAST_TERM_INST
 131
 132 #undef  FIRST_BINARY_INST
 133 #undef HANDLE_BINARY_INST
 134 #undef   LAST_BINARY_INST
 135
 136 #undef  FIRST_MEMORY_INST
 137 #undef HANDLE_MEMORY_INST
 138 #undef   LAST_MEMORY_INST
 139
 140 #undef  FIRST_OTHER_INST
 141 #undef HANDLE_OTHER_INST
 142 #undef   LAST_OTHER_INST
 143
 144 #ifdef HANDLE_INST
 145 #undef HANDLE_INST
 146 #endif