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_CONVERT_INST
  64 #define FIRST_CONVERT_INST(num)
  65 #endif
  66 #ifndef HANDLE_CONVERT_INST
  67 #ifndef HANDLE_INST
  68 #define HANDLE_CONVERT_INST(num, opcode, Class)
  69 #else
  70 #define HANDLE_CONVERT_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
  71 #endif
  72 #endif
  73 #ifndef LAST_CONVERT_INST
  74 #define LAST_CONVERT_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, Invoke     , InvokeInst)
 101 HANDLE_TERM_INST  ( 5, Unwind     , UnwindInst)
 102 HANDLE_TERM_INST  ( 6, Unreachable, UnreachableInst)
 103   LAST_TERM_INST  ( 6)
 104
 105 // Standard binary operators...
 106  FIRST_BINARY_INST( 7)
 107 HANDLE_BINARY_INST( 7, Add  , BinaryOperator)
 108 HANDLE_BINARY_INST( 8, Sub  , BinaryOperator)
 109 HANDLE_BINARY_INST( 9, Mul  , BinaryOperator)
 110 HANDLE_BINARY_INST(10, UDiv , BinaryOperator)
 111 HANDLE_BINARY_INST(11, SDiv , BinaryOperator)
 112 HANDLE_BINARY_INST(12, FDiv , BinaryOperator)
 113 HANDLE_BINARY_INST(13, URem , BinaryOperator)
 114 HANDLE_BINARY_INST(14, SRem , BinaryOperator)
 115 HANDLE_BINARY_INST(15, FRem , BinaryOperator)
 116
 117 // Logical operators...
 118 HANDLE_BINARY_INST(16, And   , BinaryOperator)
 119 HANDLE_BINARY_INST(17, Or    , BinaryOperator)
 120 HANDLE_BINARY_INST(18, Xor   , BinaryOperator)
 121
 122 // Binary comparison operators...
 123 HANDLE_BINARY_INST(19, SetEQ , SetCondInst)
 124 HANDLE_BINARY_INST(20, SetNE , SetCondInst)
 125 HANDLE_BINARY_INST(21, SetLE , SetCondInst)
 126 HANDLE_BINARY_INST(22, SetGE , SetCondInst)
 127 HANDLE_BINARY_INST(23, SetLT , SetCondInst)
 128 HANDLE_BINARY_INST(24, SetGT , SetCondInst)
 129   LAST_BINARY_INST(24)
 130
 131 // Memory operators...
 132  FIRST_MEMORY_INST(25)
 133 HANDLE_MEMORY_INST(25, Malloc, MallocInst)  // Heap management instructions
 134 HANDLE_MEMORY_INST(26, Free  , FreeInst  )
 135 HANDLE_MEMORY_INST(27, Alloca, AllocaInst)  // Stack management
 136 HANDLE_MEMORY_INST(28, Load  , LoadInst  )  // Memory manipulation instrs
 137 HANDLE_MEMORY_INST(29, Store , StoreInst )
 138 HANDLE_MEMORY_INST(30, GetElementPtr, GetElementPtrInst)
 139   LAST_MEMORY_INST(30)
 140
 141 // Conversion operators ...
 142 // NOTE: The order matters here, see InstCombine (isEliminableCastOfCast)
 143  FIRST_CONVERT_INST(31)
 144 HANDLE_CONVERT_INST(31, Trunc   , ConvertInst )  // Truncate integers
 145 HANDLE_CONVERT_INST(32, ZExt    , ConvertInst )  // Zero extend integers
 146 HANDLE_CONVERT_INST(33, SExt    , ConvertInst )  // Sign extend integers
 147 HANDLE_CONVERT_INST(34, FPToUI  , ConvertInst )  // floating point -> UInt
 148 HANDLE_CONVERT_INST(35, FPToSI  , ConvertInst )  // floating point -> SInt
 149 HANDLE_CONVERT_INST(36, UIToFP  , ConvertInst )  // UInt -> floating point
 150 HANDLE_CONVERT_INST(37, SIToFP  , ConvertInst )  // SInt -> floating point
 151 HANDLE_CONVERT_INST(38, FPTrunc , ConvertInst )  // Truncate floating point
 152 HANDLE_CONVERT_INST(39, FPExt   , ConvertInst )  // Extend floating point
 153 HANDLE_CONVERT_INST(40, IntToPtr, ConvertInst )  // Integer -> Pointer
 154 HANDLE_CONVERT_INST(41, PtrToInt, ConvertInst )  // Pointer -> Integer
 155 HANDLE_CONVERT_INST(42, BitCast , ConvertInst )  // Type cast
 156   LAST_CONVERT_INST(42)
 157
 158 // Other operators...
 159  FIRST_OTHER_INST(43)
 160 HANDLE_OTHER_INST(43, PHI    , PHINode    )  // PHI node instruction
 161 HANDLE_OTHER_INST(44, Call   , CallInst   )  // Call a function
 162 HANDLE_OTHER_INST(45, Shl    , ShiftInst  )  // Shift Left operations (logical)
 163 HANDLE_OTHER_INST(46, LShr   , ShiftInst  )  // Logical Shift right (unsigned)
 164 HANDLE_OTHER_INST(47, AShr   , ShiftInst  )  // Arithmetic shift right (signed)
 165 HANDLE_OTHER_INST(48, Select , SelectInst )  // select instruction
 166 HANDLE_OTHER_INST(49, UserOp1, Instruction)  // May be used internally in a pass
 167 HANDLE_OTHER_INST(50, UserOp2, Instruction)  // Internal to passes only
 168 HANDLE_OTHER_INST(51, VAArg  , VAArgInst  )  // vaarg instruction
 169 HANDLE_OTHER_INST(52, ExtractElement, ExtractElementInst)// extract from vector.
 170 HANDLE_OTHER_INST(53, InsertElement, InsertElementInst)  // insert into vector
 171 HANDLE_OTHER_INST(54, ShuffleVector, ShuffleVectorInst)  // shuffle two vectors.
 172   LAST_OTHER_INST(54)
 173
 174 #undef  FIRST_TERM_INST
 175 #undef HANDLE_TERM_INST
 176 #undef   LAST_TERM_INST
 177
 178 #undef  FIRST_BINARY_INST
 179 #undef HANDLE_BINARY_INST
 180 #undef   LAST_BINARY_INST
 181
 182 #undef  FIRST_MEMORY_INST
 183 #undef HANDLE_MEMORY_INST
 184 #undef   LAST_MEMORY_INST
 185
 186 #undef  FIRST_CONVERT_INST
 187 #undef HANDLE_CONVERT_INST
 188 #undef   LAST_CONVERT_INST
 189
 190 #undef  FIRST_OTHER_INST
 191 #undef HANDLE_OTHER_INST
 192 #undef   LAST_OTHER_INST
 193
 194 #ifdef HANDLE_INST
 195 #undef HANDLE_INST
 196 #endif