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 do not have to
  19 // define 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 HANDLE_TERM_INST  ( 6, Unreachable, UnreachableInst)
  89   LAST_TERM_INST  ( 6)
  90
  91 // Standard binary operators...
  92  FIRST_BINARY_INST( 7)
  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, UDiv , BinaryOperator)
  97 HANDLE_BINARY_INST(11, SDiv , BinaryOperator)
  98 HANDLE_BINARY_INST(12, FDiv , BinaryOperator)
  99 HANDLE_BINARY_INST(13, URem , BinaryOperator)
 100 HANDLE_BINARY_INST(14, SRem , BinaryOperator)
 101 HANDLE_BINARY_INST(15, FRem , BinaryOperator)
 102
 103 // Logical operators...
 104 HANDLE_BINARY_INST(16, And   , BinaryOperator)
 105 HANDLE_BINARY_INST(17, Or    , BinaryOperator)
 106 HANDLE_BINARY_INST(18, Xor   , BinaryOperator)
 107
 108 // Binary comparison operators...
 109 HANDLE_BINARY_INST(19, SetEQ , SetCondInst)
 110 HANDLE_BINARY_INST(20, SetNE , SetCondInst)
 111 HANDLE_BINARY_INST(21, SetLE , SetCondInst)
 112 HANDLE_BINARY_INST(22, SetGE , SetCondInst)
 113 HANDLE_BINARY_INST(23, SetLT , SetCondInst)
 114 HANDLE_BINARY_INST(24, SetGT , SetCondInst)
 115   LAST_BINARY_INST(24)
 116
 117 // Memory operators...
 118  FIRST_MEMORY_INST(25)
 119 HANDLE_MEMORY_INST(25, Malloc, MallocInst)  // Heap management instructions
 120 HANDLE_MEMORY_INST(26, Free  , FreeInst  )
 121 HANDLE_MEMORY_INST(27, Alloca, AllocaInst)  // Stack management
 122 HANDLE_MEMORY_INST(28, Load  , LoadInst  )  // Memory manipulation instrs
 123 HANDLE_MEMORY_INST(29, Store , StoreInst )
 124 HANDLE_MEMORY_INST(30, GetElementPtr, GetElementPtrInst)
 125   LAST_MEMORY_INST(30)
 126
 127 // Other operators...
 128  FIRST_OTHER_INST(31)
 129 HANDLE_OTHER_INST(31, ICmp   , ICmpInst   )  // Integer comparison instruction
 130 HANDLE_OTHER_INST(32, FCmp   , FCmpInst   )  // Floating point comparison instr.
 131 HANDLE_OTHER_INST(33, PHI    , PHINode    )  // PHI node instruction
 132 HANDLE_OTHER_INST(34, Cast   , CastInst   )  // Type cast
 133 HANDLE_OTHER_INST(35, Call   , CallInst   )  // Call a function
 134 HANDLE_OTHER_INST(36, Shl    , ShiftInst  )  // Shift Left operations (logical)
 135 HANDLE_OTHER_INST(37, LShr   , ShiftInst  )  // Logical Shift right (unsigned)
 136 HANDLE_OTHER_INST(38, AShr   , ShiftInst  )  // Arithmetic shift right (signed)
 137 HANDLE_OTHER_INST(39, Select , SelectInst )  // select instruction
 138 HANDLE_OTHER_INST(40, UserOp1, Instruction)  // May be used internally in a pass
 139 HANDLE_OTHER_INST(41, UserOp2, Instruction)  // Internal to passes only
 140 HANDLE_OTHER_INST(42, VAArg  , VAArgInst  )  // vaarg instruction
 141 HANDLE_OTHER_INST(43, ExtractElement, ExtractElementInst)// extract from vector.
 142 HANDLE_OTHER_INST(44, InsertElement, InsertElementInst)  // insert into vector
 143 HANDLE_OTHER_INST(45, ShuffleVector, ShuffleVectorInst)  // shuffle two vectors.
 144   LAST_OTHER_INST(45)
 145
 146 #undef  FIRST_TERM_INST
 147 #undef HANDLE_TERM_INST
 148 #undef   LAST_TERM_INST
 149
 150 #undef  FIRST_BINARY_INST
 151 #undef HANDLE_BINARY_INST
 152 #undef   LAST_BINARY_INST
 153
 154 #undef  FIRST_MEMORY_INST
 155 #undef HANDLE_MEMORY_INST
 156 #undef   LAST_MEMORY_INST
 157
 158 #undef  FIRST_OTHER_INST
 159 #undef HANDLE_OTHER_INST
 160 #undef   LAST_OTHER_INST
 161
 162 #ifdef HANDLE_INST
 163 #undef HANDLE_INST
 164 #endif