Sort a few more #include lines in tools/... unittests/... and utils/...
[oota-llvm.git] / include / llvm / Instruction.def
index f3140753030d1708d8756e3fd0788c095357ebb1..e59a0528e90f14767c11df376d49f4b21767e9ba 100644 (file)
@@ -1,4 +1,11 @@
-//===-- llvm/Instruction.def - File that describes Instructions --*- C++ -*--=//
+//===-- llvm/Instruction.def - File that describes Instructions -*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file contains descriptions of the various LLVM instructions.  This is
 // used as a central place for enumerating the different instructions and 
 
 // NOTE: NO INCLUDE GUARD DESIRED!
 
-// Provide definitions of macros so that users of this file don't have to define
-// everything to use it...
+// Provide definitions of macros so that users of this file do not have to 
+// define everything to use it...
 //
 #ifndef FIRST_TERM_INST
 #define FIRST_TERM_INST(num)
 #endif
 #ifndef HANDLE_TERM_INST
-#define HANDLE_TERM_INST(num, opcode, instclass)
+#ifndef HANDLE_INST
+#define HANDLE_TERM_INST(num, opcode, Class)
+#else
+#define HANDLE_TERM_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
+#endif
 #endif
 #ifndef LAST_TERM_INST
 #define LAST_TERM_INST(num)
 #endif
 
-#ifndef FIRST_UNARY_INST
-#define FIRST_UNARY_INST(num)
-#endif
-#ifndef HANDLE_UNARY_INST
-#define HANDLE_UNARY_INST(num, opcode, instclass)
-#endif
-#ifndef LAST_UNARY_INST
-#define LAST_UNARY_INST(num)
-#endif
-
 #ifndef FIRST_BINARY_INST
 #define FIRST_BINARY_INST(num)
 #endif
 #ifndef HANDLE_BINARY_INST
+#ifndef HANDLE_INST
 #define HANDLE_BINARY_INST(num, opcode, instclass)
+#else
+#define HANDLE_BINARY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
+#endif
 #endif
 #ifndef LAST_BINARY_INST
 #define LAST_BINARY_INST(num)
 #define FIRST_MEMORY_INST(num)
 #endif
 #ifndef HANDLE_MEMORY_INST
-#define HANDLE_MEMORY_INST(num, opcode, instclass)
+#ifndef HANDLE_INST
+#define HANDLE_MEMORY_INST(num, opcode, Class)
+#else
+#define HANDLE_MEMORY_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
+#endif
 #endif
 #ifndef LAST_MEMORY_INST
 #define LAST_MEMORY_INST(num)
 #endif
 
+#ifndef FIRST_CAST_INST
+#define FIRST_CAST_INST(num)
+#endif
+#ifndef HANDLE_CAST_INST
+#ifndef HANDLE_INST
+#define HANDLE_CAST_INST(num, opcode, Class)
+#else
+#define HANDLE_CAST_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
+#endif
+#endif
+#ifndef LAST_CAST_INST
+#define LAST_CAST_INST(num)
+#endif
+
 #ifndef FIRST_OTHER_INST
 #define FIRST_OTHER_INST(num)
 #endif
 #ifndef HANDLE_OTHER_INST
-#define HANDLE_OTHER_INST(num, opcode, instclass)
+#ifndef HANDLE_INST
+#define HANDLE_OTHER_INST(num, opcode, Class)
+#else
+#define HANDLE_OTHER_INST(num, opcode, Class) HANDLE_INST(num, opcode, Class)
+#endif
 #endif
 #ifndef LAST_OTHER_INST
 #define LAST_OTHER_INST(num)
 // instructions for it to be a well formed basic block.
 //
  FIRST_TERM_INST  ( 1)
-HANDLE_TERM_INST  ( 1, Ret   , ReturnInst)
-HANDLE_TERM_INST  ( 2, Br    , BranchInst)
-HANDLE_TERM_INST  ( 3, Switch, SwitchInst)
-HANDLE_TERM_INST  ( 4, Invoke, InvokeInst)
-  LAST_TERM_INST  ( 4)
-
-// The single unary instruction... a binary inverse.
- FIRST_UNARY_INST ( 5)
-HANDLE_UNARY_INST ( 5, Not   , GenericUnaryInst)
-  LAST_UNARY_INST ( 5)
+HANDLE_TERM_INST  ( 1, Ret        , ReturnInst)
+HANDLE_TERM_INST  ( 2, Br         , BranchInst)
+HANDLE_TERM_INST  ( 3, Switch     , SwitchInst)
+HANDLE_TERM_INST  ( 4, IndirectBr , IndirectBrInst)
+HANDLE_TERM_INST  ( 5, Invoke     , InvokeInst)
+HANDLE_TERM_INST  ( 6, Resume     , ResumeInst)
+HANDLE_TERM_INST  ( 7, Unreachable, UnreachableInst)
+  LAST_TERM_INST  ( 7)
 
 // Standard binary operators...
- FIRST_BINARY_INST( 6)
-HANDLE_BINARY_INST( 6, Add   , GenericBinaryInst)
-HANDLE_BINARY_INST( 7, Sub   , GenericBinaryInst)
-HANDLE_BINARY_INST( 8, Mul   , GenericBinaryInst)
-HANDLE_BINARY_INST( 9, Div   , GenericBinaryInst)
-HANDLE_BINARY_INST(10, Rem   , GenericBinaryInst)
-
-// Logical operators...
-HANDLE_BINARY_INST(11, And   , GenericBinaryInst)
-HANDLE_BINARY_INST(12, Or    , GenericBinaryInst)
-HANDLE_BINARY_INST(13, Xor   , GenericBinaryInst)
-
-// Binary comparison operators...
-HANDLE_BINARY_INST(14, SetEQ , SetCondInst)
-HANDLE_BINARY_INST(15, SetNE , SetCondInst)
-HANDLE_BINARY_INST(16, SetLE , SetCondInst)
-HANDLE_BINARY_INST(17, SetGE , SetCondInst)
-HANDLE_BINARY_INST(18, SetLT , SetCondInst)
-HANDLE_BINARY_INST(19, SetGT , SetCondInst)
-  LAST_BINARY_INST(19)
+ FIRST_BINARY_INST( 8)
+HANDLE_BINARY_INST( 8, Add  , BinaryOperator)
+HANDLE_BINARY_INST( 9, FAdd , BinaryOperator)
+HANDLE_BINARY_INST(10, Sub  , BinaryOperator)
+HANDLE_BINARY_INST(11, FSub , BinaryOperator)
+HANDLE_BINARY_INST(12, Mul  , BinaryOperator)
+HANDLE_BINARY_INST(13, FMul , BinaryOperator)
+HANDLE_BINARY_INST(14, UDiv , BinaryOperator)
+HANDLE_BINARY_INST(15, SDiv , BinaryOperator)
+HANDLE_BINARY_INST(16, FDiv , BinaryOperator)
+HANDLE_BINARY_INST(17, URem , BinaryOperator)
+HANDLE_BINARY_INST(18, SRem , BinaryOperator)
+HANDLE_BINARY_INST(19, FRem , BinaryOperator)
+
+// Logical operators (integer operands)
+HANDLE_BINARY_INST(20, Shl  , BinaryOperator) // Shift left  (logical)
+HANDLE_BINARY_INST(21, LShr , BinaryOperator) // Shift right (logical)
+HANDLE_BINARY_INST(22, AShr , BinaryOperator) // Shift right (arithmetic)
+HANDLE_BINARY_INST(23, And  , BinaryOperator)
+HANDLE_BINARY_INST(24, Or   , BinaryOperator)
+HANDLE_BINARY_INST(25, Xor  , BinaryOperator)
+  LAST_BINARY_INST(25)
 
 // Memory operators...
- FIRST_MEMORY_INST(20)
-HANDLE_MEMORY_INST(20, Malloc, MallocInst)  // Heap management instructions
-HANDLE_MEMORY_INST(21, Free  , FreeInst  )
-HANDLE_MEMORY_INST(22, Alloca, AllocaInst)  // Stack management
-HANDLE_MEMORY_INST(23, Load  , LoadInst  )  // Memory manipulation instrs
-HANDLE_MEMORY_INST(24, Store , StoreInst )
-HANDLE_MEMORY_INST(25, GetElementPtr, GetElementPtrInst)
-  LAST_MEMORY_INST(25)
+ FIRST_MEMORY_INST(26)
+HANDLE_MEMORY_INST(26, Alloca, AllocaInst)  // Stack management
+HANDLE_MEMORY_INST(27, Load  , LoadInst  )  // Memory manipulation instrs
+HANDLE_MEMORY_INST(28, Store , StoreInst )
+HANDLE_MEMORY_INST(29, GetElementPtr, GetElementPtrInst)
+HANDLE_MEMORY_INST(30, Fence , FenceInst )
+HANDLE_MEMORY_INST(31, AtomicCmpXchg , AtomicCmpXchgInst )
+HANDLE_MEMORY_INST(32, AtomicRMW , AtomicRMWInst )
+  LAST_MEMORY_INST(32)
+
+// Cast operators ...
+// NOTE: The order matters here because CastInst::isEliminableCastPair 
+// NOTE: (see Instructions.cpp) encodes a table based on this ordering.
+ FIRST_CAST_INST(33)
+HANDLE_CAST_INST(33, Trunc   , TruncInst   )  // Truncate integers
+HANDLE_CAST_INST(34, ZExt    , ZExtInst    )  // Zero extend integers
+HANDLE_CAST_INST(35, SExt    , SExtInst    )  // Sign extend integers
+HANDLE_CAST_INST(36, FPToUI  , FPToUIInst  )  // floating point -> UInt
+HANDLE_CAST_INST(37, FPToSI  , FPToSIInst  )  // floating point -> SInt
+HANDLE_CAST_INST(38, UIToFP  , UIToFPInst  )  // UInt -> floating point
+HANDLE_CAST_INST(39, SIToFP  , SIToFPInst  )  // SInt -> floating point
+HANDLE_CAST_INST(40, FPTrunc , FPTruncInst )  // Truncate floating point
+HANDLE_CAST_INST(41, FPExt   , FPExtInst   )  // Extend floating point
+HANDLE_CAST_INST(42, PtrToInt, PtrToIntInst)  // Pointer -> Integer
+HANDLE_CAST_INST(43, IntToPtr, IntToPtrInst)  // Integer -> Pointer
+HANDLE_CAST_INST(44, BitCast , BitCastInst )  // Type cast
+  LAST_CAST_INST(44)
 
 // Other operators...
- FIRST_OTHER_INST(26)
-HANDLE_OTHER_INST(26, PHINode, PHINode    )  // PHI node instruction
-HANDLE_OTHER_INST(27, Cast   , CastInst   )  // Type cast
-HANDLE_OTHER_INST(28, Call   , CallInst   )  // Call a function
-
-HANDLE_OTHER_INST(29, Shl    , ShiftInst  )  // Shift operations
-HANDLE_OTHER_INST(30, Shr    , ShiftInst  )
-
-HANDLE_OTHER_INST(31, UserOp1, Instruction)  // May be used internally in a pass
-HANDLE_OTHER_INST(32, UserOp2, Instruction)
-  LAST_OTHER_INST(32)
+ FIRST_OTHER_INST(45)
+HANDLE_OTHER_INST(45, ICmp   , ICmpInst   )  // Integer comparison instruction
+HANDLE_OTHER_INST(46, FCmp   , FCmpInst   )  // Floating point comparison instr.
+HANDLE_OTHER_INST(47, PHI    , PHINode    )  // PHI node instruction
+HANDLE_OTHER_INST(48, Call   , CallInst   )  // Call a function
+HANDLE_OTHER_INST(49, Select , SelectInst )  // select instruction
+HANDLE_OTHER_INST(50, UserOp1, Instruction)  // May be used internally in a pass
+HANDLE_OTHER_INST(51, UserOp2, Instruction)  // Internal to passes only
+HANDLE_OTHER_INST(52, VAArg  , VAArgInst  )  // vaarg instruction
+HANDLE_OTHER_INST(53, ExtractElement, ExtractElementInst)// extract from vector
+HANDLE_OTHER_INST(54, InsertElement, InsertElementInst)  // insert into vector
+HANDLE_OTHER_INST(55, ShuffleVector, ShuffleVectorInst)  // shuffle two vectors.
+HANDLE_OTHER_INST(56, ExtractValue, ExtractValueInst)// extract from aggregate
+HANDLE_OTHER_INST(57, InsertValue, InsertValueInst)  // insert into aggregate
+HANDLE_OTHER_INST(58, LandingPad, LandingPadInst)  // Landing pad instruction.
+  LAST_OTHER_INST(58)
 
 #undef  FIRST_TERM_INST
 #undef HANDLE_TERM_INST
 #undef   LAST_TERM_INST
 
-#undef  FIRST_UNARY_INST
-#undef HANDLE_UNARY_INST
-#undef   LAST_UNARY_INST
-
 #undef  FIRST_BINARY_INST
 #undef HANDLE_BINARY_INST
 #undef   LAST_BINARY_INST
@@ -139,7 +186,14 @@ HANDLE_OTHER_INST(32, UserOp2, Instruction)
 #undef HANDLE_MEMORY_INST
 #undef   LAST_MEMORY_INST
 
+#undef  FIRST_CAST_INST
+#undef HANDLE_CAST_INST
+#undef   LAST_CAST_INST
+
 #undef  FIRST_OTHER_INST
 #undef HANDLE_OTHER_INST
 #undef   LAST_OTHER_INST
 
+#ifdef HANDLE_INST
+#undef HANDLE_INST
+#endif