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