include/llvm/Instruction.def

   1 //===-- llvm/Instruction.def - File that describes Instructions -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 // NOTE: NO INCLUDE GUARD DESIRED!
  17
  18 // Provide definitions of macros so that users of this file don't have to define
  19 // everything to use it...
  20 //
  21 #ifndef FIRST_TERM_INST
  22 #define FIRST_TERM_INST(num)
  23 #endif
  24 #ifndef HANDLE_TERM_INST
  25 #ifndef HANDLE_INST
  26 #define HANDLE_TERM_INST(num, opcode, Class)
  27 #else
  28 #define HANDLE_TERM_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  29 #endif
  30 #endif
  31 #ifndef LAST_TERM_INST
  32 #define LAST_TERM_INST(num)
  33 #endif
  34
  35 #ifndef FIRST_BINARY_INST
  36 #define FIRST_BINARY_INST(num)
  37 #endif
  38 #ifndef HANDLE_BINARY_INST
  39 #ifndef HANDLE_INST
  40 #define HANDLE_BINARY_INST(num, opcode, instclass)
  41 #else
  42 #define HANDLE_BINARY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  43 #endif
  44 #endif
  45 #ifndef LAST_BINARY_INST
  46 #define LAST_BINARY_INST(num)
  47 #endif
  48
  49 #ifndef FIRST_MEMORY_INST
  50 #define FIRST_MEMORY_INST(num)
  51 #endif
  52 #ifndef HANDLE_MEMORY_INST
  53 #ifndef HANDLE_INST
  54 #define HANDLE_MEMORY_INST(num, opcode, Class)
  55 #else
  56 #define HANDLE_MEMORY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  57 #endif
  58 #endif
  59 #ifndef LAST_MEMORY_INST
  60 #define LAST_MEMORY_INST(num)
  61 #endif
  62
  63 #ifndef FIRST_OTHER_INST
  64 #define FIRST_OTHER_INST(num)
  65 #endif
  66 #ifndef HANDLE_OTHER_INST
  67 #ifndef HANDLE_INST
  68 #define HANDLE_OTHER_INST(num, opcode, Class)
  69 #else
  70 #define HANDLE_OTHER_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  71 #endif
  72 #endif
  73 #ifndef LAST_OTHER_INST
  74 #define LAST_OTHER_INST(num)
  75 #endif
  76
  77
  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.
  81 //
  82  FIRST_TERM_INST  ( 1)
  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   LAST_TERM_INST  ( 5)
  89
  90 // Standard binary operators...
  91  FIRST_BINARY_INST( 6)
  92 HANDLE_BINARY_INST( 6, Add   , BinaryOperator)
  93 HANDLE_BINARY_INST( 7, Sub   , BinaryOperator)
  94 HANDLE_BINARY_INST( 8, Mul   , BinaryOperator)
  95 HANDLE_BINARY_INST( 9, Div   , BinaryOperator)
  96 HANDLE_BINARY_INST(10, Rem   , BinaryOperator)
  97
  98 // Logical operators...
  99 HANDLE_BINARY_INST(11, And   , BinaryOperator)
 100 HANDLE_BINARY_INST(12, Or    , BinaryOperator)
 101 HANDLE_BINARY_INST(13, Xor   , BinaryOperator)
 102
 103 // Binary comparison operators...
 104 HANDLE_BINARY_INST(14, SetEQ , SetCondInst)
 105 HANDLE_BINARY_INST(15, SetNE , SetCondInst)
 106 HANDLE_BINARY_INST(16, SetLE , SetCondInst)
 107 HANDLE_BINARY_INST(17, SetGE , SetCondInst)
 108 HANDLE_BINARY_INST(18, SetLT , SetCondInst)
 109 HANDLE_BINARY_INST(19, SetGT , SetCondInst)
 110   LAST_BINARY_INST(19)
 111
 112 // Memory operators...
 113  FIRST_MEMORY_INST(20)
 114 HANDLE_MEMORY_INST(20, Malloc, MallocInst)  // Heap management instructions
 115 HANDLE_MEMORY_INST(21, Free  , FreeInst  )
 116 HANDLE_MEMORY_INST(22, Alloca, AllocaInst)  // Stack management
 117 HANDLE_MEMORY_INST(23, Load  , LoadInst  )  // Memory manipulation instrs
 118 HANDLE_MEMORY_INST(24, Store , StoreInst )
 119 HANDLE_MEMORY_INST(25, GetElementPtr, GetElementPtrInst)
 120   LAST_MEMORY_INST(25)
 121
 122 // Other operators...
 123  FIRST_OTHER_INST(26)
 124 HANDLE_OTHER_INST(26, PHI    , PHINode    )  // PHI node instruction
 125 HANDLE_OTHER_INST(27, Cast   , CastInst   )  // Type cast
 126 HANDLE_OTHER_INST(28, Call   , CallInst   )  // Call a function
 127
 128 HANDLE_OTHER_INST(29, Shl    , ShiftInst  )  // Shift operations
 129 HANDLE_OTHER_INST(30, Shr    , ShiftInst  )
 130 HANDLE_OTHER_INST(31, VANext , VANextInst )  // vanext instruction
 131 HANDLE_OTHER_INST(32, VAArg  , VAArgInst  )  // vaarg  instruction
 132
 133 HANDLE_OTHER_INST(33, UserOp1, Instruction)  // May be used internally in a pass
 134 HANDLE_OTHER_INST(34, UserOp2, Instruction)
 135   LAST_OTHER_INST(34)
 136
 137 #undef  FIRST_TERM_INST
 138 #undef HANDLE_TERM_INST
 139 #undef   LAST_TERM_INST
 140
 141 #undef  FIRST_BINARY_INST
 142 #undef HANDLE_BINARY_INST
 143 #undef   LAST_BINARY_INST
 144
 145 #undef  FIRST_MEMORY_INST
 146 #undef HANDLE_MEMORY_INST
 147 #undef   LAST_MEMORY_INST
 148
 149 #undef  FIRST_OTHER_INST
 150 #undef HANDLE_OTHER_INST
 151 #undef   LAST_OTHER_INST
 152
 153 #ifdef HANDLE_INST
 154 #undef HANDLE_INST
 155 #endif