include/llvm/IR/Instruction.def

   1 //===-- llvm/Instruction.def - File that describes Instructions -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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_CAST_INST
  64 #define FIRST_CAST_INST(num)
  65 #endif
  66 #ifndef HANDLE_CAST_INST
  67 #ifndef HANDLE_INST
  68 #define HANDLE_CAST_INST(num, opcode, Class)
  69 #else
  70 #define HANDLE_CAST_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  71 #endif
  72 #endif
  73 #ifndef LAST_CAST_INST
  74 #define LAST_CAST_INST(num)
  75 #endif
  76
  77 #ifndef FIRST_OTHER_INST
  78 #define FIRST_OTHER_INST(num)
  79 #endif
  80 #ifndef HANDLE_OTHER_INST
  81 #ifndef HANDLE_INST
  82 #define HANDLE_OTHER_INST(num, opcode, Class)
  83 #else
  84 #define HANDLE_OTHER_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  85 #endif
  86 #endif
  87 #ifndef LAST_OTHER_INST
  88 #define LAST_OTHER_INST(num)
  89 #endif
  90
  91
  92 // Terminator Instructions - These instructions are used to terminate a basic
  93 // block of the program.   Every basic block must end with one of these
  94 // instructions for it to be a well formed basic block.
  95 //
  96  FIRST_TERM_INST  ( 1)
  97 HANDLE_TERM_INST  ( 1, Ret           , ReturnInst)
  98 HANDLE_TERM_INST  ( 2, Br            , BranchInst)
  99 HANDLE_TERM_INST  ( 3, Switch        , SwitchInst)
 100 HANDLE_TERM_INST  ( 4, IndirectBr    , IndirectBrInst)
 101 HANDLE_TERM_INST  ( 5, Invoke        , InvokeInst)
 102 HANDLE_TERM_INST  ( 6, Resume        , ResumeInst)
 103 HANDLE_TERM_INST  ( 7, Unreachable   , UnreachableInst)
 104 HANDLE_TERM_INST  ( 8, CleanupRet    , CleanupReturnInst)
 105 HANDLE_TERM_INST  ( 9, CatchRet      , CatchReturnInst)
 106 HANDLE_TERM_INST  (10, CatchPad      , CatchPadInst)
 107 HANDLE_TERM_INST  (11, TerminatePad  , TerminatePadInst)
 108 HANDLE_TERM_INST  (12, CatchEndPad   , CatchEndPadInst)
 109 HANDLE_TERM_INST  (13, CleanupEndPad , CleanupEndPadInst)
 110   LAST_TERM_INST  (13)
 111
 112 // Standard binary operators...
 113  FIRST_BINARY_INST(14)
 114 HANDLE_BINARY_INST(14, Add  , BinaryOperator)
 115 HANDLE_BINARY_INST(15, FAdd , BinaryOperator)
 116 HANDLE_BINARY_INST(16, Sub  , BinaryOperator)
 117 HANDLE_BINARY_INST(17, FSub , BinaryOperator)
 118 HANDLE_BINARY_INST(18, Mul  , BinaryOperator)
 119 HANDLE_BINARY_INST(19, FMul , BinaryOperator)
 120 HANDLE_BINARY_INST(20, UDiv , BinaryOperator)
 121 HANDLE_BINARY_INST(21, SDiv , BinaryOperator)
 122 HANDLE_BINARY_INST(22, FDiv , BinaryOperator)
 123 HANDLE_BINARY_INST(23, URem , BinaryOperator)
 124 HANDLE_BINARY_INST(24, SRem , BinaryOperator)
 125 HANDLE_BINARY_INST(25, FRem , BinaryOperator)
 126
 127 // Logical operators (integer operands)
 128 HANDLE_BINARY_INST(26, Shl  , BinaryOperator) // Shift left  (logical)
 129 HANDLE_BINARY_INST(27, LShr , BinaryOperator) // Shift right (logical)
 130 HANDLE_BINARY_INST(28, AShr , BinaryOperator) // Shift right (arithmetic)
 131 HANDLE_BINARY_INST(29, And  , BinaryOperator)
 132 HANDLE_BINARY_INST(30, Or   , BinaryOperator)
 133 HANDLE_BINARY_INST(31, Xor  , BinaryOperator)
 134   LAST_BINARY_INST(31)
 135
 136 // Memory operators...
 137  FIRST_MEMORY_INST(32)
 138 HANDLE_MEMORY_INST(32, Alloca, AllocaInst)  // Stack management
 139 HANDLE_MEMORY_INST(33, Load  , LoadInst  )  // Memory manipulation instrs
 140 HANDLE_MEMORY_INST(34, Store , StoreInst )
 141 HANDLE_MEMORY_INST(35, GetElementPtr, GetElementPtrInst)
 142 HANDLE_MEMORY_INST(36, Fence , FenceInst )
 143 HANDLE_MEMORY_INST(37, AtomicCmpXchg , AtomicCmpXchgInst )
 144 HANDLE_MEMORY_INST(38, AtomicRMW , AtomicRMWInst )
 145   LAST_MEMORY_INST(38)
 146
 147 // Cast operators ...
 148 // NOTE: The order matters here because CastInst::isEliminableCastPair
 149 // NOTE: (see Instructions.cpp) encodes a table based on this ordering.
 150  FIRST_CAST_INST(39)
 151 HANDLE_CAST_INST(39, Trunc   , TruncInst   )  // Truncate integers
 152 HANDLE_CAST_INST(40, ZExt    , ZExtInst    )  // Zero extend integers
 153 HANDLE_CAST_INST(41, SExt    , SExtInst    )  // Sign extend integers
 154 HANDLE_CAST_INST(42, FPToUI  , FPToUIInst  )  // floating point -> UInt
 155 HANDLE_CAST_INST(43, FPToSI  , FPToSIInst  )  // floating point -> SInt
 156 HANDLE_CAST_INST(44, UIToFP  , UIToFPInst  )  // UInt -> floating point
 157 HANDLE_CAST_INST(45, SIToFP  , SIToFPInst  )  // SInt -> floating point
 158 HANDLE_CAST_INST(46, FPTrunc , FPTruncInst )  // Truncate floating point
 159 HANDLE_CAST_INST(47, FPExt   , FPExtInst   )  // Extend floating point
 160 HANDLE_CAST_INST(48, PtrToInt, PtrToIntInst)  // Pointer -> Integer
 161 HANDLE_CAST_INST(49, IntToPtr, IntToPtrInst)  // Integer -> Pointer
 162 HANDLE_CAST_INST(50, BitCast , BitCastInst )  // Type cast
 163 HANDLE_CAST_INST(51, AddrSpaceCast, AddrSpaceCastInst)  // addrspace cast
 164   LAST_CAST_INST(51)
 165
 166 // Other operators...
 167  FIRST_OTHER_INST(52)
 168 HANDLE_OTHER_INST(52, ICmp   , ICmpInst   )  // Integer comparison instruction
 169 HANDLE_OTHER_INST(53, FCmp   , FCmpInst   )  // Floating point comparison instr.
 170 HANDLE_OTHER_INST(54, PHI    , PHINode    )  // PHI node instruction
 171 HANDLE_OTHER_INST(55, Call   , CallInst   )  // Call a function
 172 HANDLE_OTHER_INST(56, Select , SelectInst )  // select instruction
 173 HANDLE_OTHER_INST(57, UserOp1, Instruction)  // May be used internally in a pass
 174 HANDLE_OTHER_INST(58, UserOp2, Instruction)  // Internal to passes only
 175 HANDLE_OTHER_INST(59, VAArg  , VAArgInst  )  // vaarg instruction
 176 HANDLE_OTHER_INST(60, ExtractElement, ExtractElementInst)// extract from vector
 177 HANDLE_OTHER_INST(61, InsertElement, InsertElementInst)  // insert into vector
 178 HANDLE_OTHER_INST(62, ShuffleVector, ShuffleVectorInst)  // shuffle two vectors.
 179 HANDLE_OTHER_INST(63, ExtractValue, ExtractValueInst)// extract from aggregate
 180 HANDLE_OTHER_INST(64, InsertValue, InsertValueInst)  // insert into aggregate
 181 HANDLE_OTHER_INST(65, LandingPad, LandingPadInst)  // Landing pad instruction.
 182 HANDLE_OTHER_INST(66, CleanupPad, CleanupPadInst)
 183   LAST_OTHER_INST(66)
 184
 185 #undef  FIRST_TERM_INST
 186 #undef HANDLE_TERM_INST
 187 #undef   LAST_TERM_INST
 188
 189 #undef  FIRST_BINARY_INST
 190 #undef HANDLE_BINARY_INST
 191 #undef   LAST_BINARY_INST
 192
 193 #undef  FIRST_MEMORY_INST
 194 #undef HANDLE_MEMORY_INST
 195 #undef   LAST_MEMORY_INST
 196
 197 #undef  FIRST_CAST_INST
 198 #undef HANDLE_CAST_INST
 199 #undef   LAST_CAST_INST
 200
 201 #undef  FIRST_OTHER_INST
 202 #undef HANDLE_OTHER_INST
 203 #undef   LAST_OTHER_INST
 204
 205 #ifdef HANDLE_INST
 206 #undef HANDLE_INST
 207 #endif