include/llvm/CodeGen/ISDOpcodes.h

   1 //===-- llvm/CodeGen/ISDOpcodes.h - CodeGen opcodes -------------*- 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 declares codegen opcodes and related utilities.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CODEGEN_ISDOPCODES_H
  15 #define LLVM_CODEGEN_ISDOPCODES_H
  16
  17 namespace llvm {
  18
  19 /// ISD namespace - This namespace contains an enum which represents all of the
  20 /// SelectionDAG node types and value types.
  21 ///
  22 namespace ISD {
  23
  24   //===--------------------------------------------------------------------===//
  25   /// ISD::NodeType enum - This enum defines the target-independent operators
  26   /// for a SelectionDAG.
  27   ///
  28   /// Targets may also define target-dependent operator codes for SDNodes. For
  29   /// example, on x86, these are the enum values in the X86ISD namespace.
  30   /// Targets should aim to use target-independent operators to model their
  31   /// instruction sets as much as possible, and only use target-dependent
  32   /// operators when they have special requirements.
  33   ///
  34   /// Finally, during and after selection proper, SNodes may use special
  35   /// operator codes that correspond directly with MachineInstr opcodes. These
  36   /// are used to represent selected instructions. See the isMachineOpcode()
  37   /// and getMachineOpcode() member functions of SDNode.
  38   ///
  39   enum NodeType {
  40     /// DELETED_NODE - This is an illegal value that is used to catch
  41     /// errors.  This opcode is not a legal opcode for any node.
  42     DELETED_NODE,
  43
  44     /// EntryToken - This is the marker used to indicate the start of a region.
  45     EntryToken,
  46
  47     /// TokenFactor - This node takes multiple tokens as input and produces a
  48     /// single token result. This is used to represent the fact that the operand
  49     /// operators are independent of each other.
  50     TokenFactor,
  51
  52     /// AssertSext, AssertZext - These nodes record if a register contains a
  53     /// value that has already been zero or sign extended from a narrower type.
  54     /// These nodes take two operands.  The first is the node that has already
  55     /// been extended, and the second is a value type node indicating the width
  56     /// of the extension
  57     AssertSext, AssertZext,
  58
  59     /// Various leaf nodes.
  60     BasicBlock, VALUETYPE, CONDCODE, Register, RegisterMask,
  61     Constant, ConstantFP,
  62     GlobalAddress, GlobalTLSAddress, FrameIndex,
  63     JumpTable, ConstantPool, ExternalSymbol, BlockAddress,
  64
  65     /// The address of the GOT
  66     GLOBAL_OFFSET_TABLE,
  67
  68     /// FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
  69     /// llvm.returnaddress on the DAG.  These nodes take one operand, the index
  70     /// of the frame or return address to return.  An index of zero corresponds
  71     /// to the current function's frame or return address, an index of one to
  72     /// the parent's frame or return address, and so on.
  73     FRAMEADDR, RETURNADDR,
  74
  75     /// READ_REGISTER, WRITE_REGISTER - This node represents llvm.register on
  76     /// the DAG, which implements the named register global variables extension.
  77     READ_REGISTER,
  78     WRITE_REGISTER,
  79
  80     /// FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
  81     /// first (possible) on-stack argument. This is needed for correct stack
  82     /// adjustment during unwind.
  83     FRAME_TO_ARGS_OFFSET,
  84
  85     /// OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
  86     /// 'eh_return' gcc dwarf builtin, which is used to return from
  87     /// exception. The general meaning is: adjust stack by OFFSET and pass
  88     /// execution to HANDLER. Many platform-related details also :)
  89     EH_RETURN,
  90
  91     /// RESULT, OUTCHAIN = EH_SJLJ_SETJMP(INCHAIN, buffer)
  92     /// This corresponds to the eh.sjlj.setjmp intrinsic.
  93     /// It takes an input chain and a pointer to the jump buffer as inputs
  94     /// and returns an outchain.
  95     EH_SJLJ_SETJMP,
  96
  97     /// OUTCHAIN = EH_SJLJ_LONGJMP(INCHAIN, buffer)
  98     /// This corresponds to the eh.sjlj.longjmp intrinsic.
  99     /// It takes an input chain and a pointer to the jump buffer as inputs
 100     /// and returns an outchain.
 101     EH_SJLJ_LONGJMP,
 102
 103     /// TargetConstant* - Like Constant*, but the DAG does not do any folding,
 104     /// simplification, or lowering of the constant. They are used for constants
 105     /// which are known to fit in the immediate fields of their users, or for
 106     /// carrying magic numbers which are not values which need to be
 107     /// materialized in registers.
 108     TargetConstant,
 109     TargetConstantFP,
 110
 111     /// TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
 112     /// anything else with this node, and this is valid in the target-specific
 113     /// dag, turning into a GlobalAddress operand.
 114     TargetGlobalAddress,
 115     TargetGlobalTLSAddress,
 116     TargetFrameIndex,
 117     TargetJumpTable,
 118     TargetConstantPool,
 119     TargetExternalSymbol,
 120     TargetBlockAddress,
 121
 122     /// TargetIndex - Like a constant pool entry, but with completely
 123     /// target-dependent semantics. Holds target flags, a 32-bit index, and a
 124     /// 64-bit index. Targets can use this however they like.
 125     TargetIndex,
 126
 127     /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
 128     /// This node represents a target intrinsic function with no side effects.
 129     /// The first operand is the ID number of the intrinsic from the
 130     /// llvm::Intrinsic namespace.  The operands to the intrinsic follow.  The
 131     /// node returns the result of the intrinsic.
 132     INTRINSIC_WO_CHAIN,
 133
 134     /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
 135     /// This node represents a target intrinsic function with side effects that
 136     /// returns a result.  The first operand is a chain pointer.  The second is
 137     /// the ID number of the intrinsic from the llvm::Intrinsic namespace.  The
 138     /// operands to the intrinsic follow.  The node has two results, the result
 139     /// of the intrinsic and an output chain.
 140     INTRINSIC_W_CHAIN,
 141
 142     /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
 143     /// This node represents a target intrinsic function with side effects that
 144     /// does not return a result.  The first operand is a chain pointer.  The
 145     /// second is the ID number of the intrinsic from the llvm::Intrinsic
 146     /// namespace.  The operands to the intrinsic follow.
 147     INTRINSIC_VOID,
 148
 149     /// CopyToReg - This node has three operands: a chain, a register number to
 150     /// set to this value, and a value.
 151     CopyToReg,
 152
 153     /// CopyFromReg - This node indicates that the input value is a virtual or
 154     /// physical register that is defined outside of the scope of this
 155     /// SelectionDAG.  The register is available from the RegisterSDNode object.
 156     CopyFromReg,
 157
 158     /// UNDEF - An undefined node.
 159     UNDEF,
 160
 161     /// EXTRACT_ELEMENT - This is used to get the lower or upper (determined by
 162     /// a Constant, which is required to be operand #1) half of the integer or
 163     /// float value specified as operand #0.  This is only for use before
 164     /// legalization, for values that will be broken into multiple registers.
 165     EXTRACT_ELEMENT,
 166
 167     /// BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways.
 168     /// Given two values of the same integer value type, this produces a value
 169     /// twice as big.  Like EXTRACT_ELEMENT, this can only be used before
 170     /// legalization.
 171     BUILD_PAIR,
 172
 173     /// MERGE_VALUES - This node takes multiple discrete operands and returns
 174     /// them all as its individual results.  This nodes has exactly the same
 175     /// number of inputs and outputs. This node is useful for some pieces of the
 176     /// code generator that want to think about a single node with multiple
 177     /// results, not multiple nodes.
 178     MERGE_VALUES,
 179
 180     /// Simple integer binary arithmetic operators.
 181     ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
 182
 183     /// SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing
 184     /// a signed/unsigned value of type i[2*N], and return the full value as
 185     /// two results, each of type iN.
 186     SMUL_LOHI, UMUL_LOHI,
 187
 188     /// SDIVREM/UDIVREM - Divide two integers and produce both a quotient and
 189     /// remainder result.
 190     SDIVREM, UDIVREM,
 191
 192     /// CARRY_FALSE - This node is used when folding other nodes,
 193     /// like ADDC/SUBC, which indicate the carry result is always false.
 194     CARRY_FALSE,
 195
 196     /// Carry-setting nodes for multiple precision addition and subtraction.
 197     /// These nodes take two operands of the same value type, and produce two
 198     /// results.  The first result is the normal add or sub result, the second
 199     /// result is the carry flag result.
 200     ADDC, SUBC,
 201
 202     /// Carry-using nodes for multiple precision addition and subtraction. These
 203     /// nodes take three operands: The first two are the normal lhs and rhs to
 204     /// the add or sub, and the third is the input carry flag.  These nodes
 205     /// produce two results; the normal result of the add or sub, and the output
 206     /// carry flag.  These nodes both read and write a carry flag to allow them
 207     /// to them to be chained together for add and sub of arbitrarily large
 208     /// values.
 209     ADDE, SUBE,
 210
 211     /// RESULT, BOOL = [SU]ADDO(LHS, RHS) - Overflow-aware nodes for addition.
 212     /// These nodes take two operands: the normal LHS and RHS to the add. They
 213     /// produce two results: the normal result of the add, and a boolean that
 214     /// indicates if an overflow occurred (*not* a flag, because it may be store
 215     /// to memory, etc.).  If the type of the boolean is not i1 then the high
 216     /// bits conform to getBooleanContents.
 217     /// These nodes are generated from llvm.[su]add.with.overflow intrinsics.
 218     SADDO, UADDO,
 219
 220     /// Same for subtraction.
 221     SSUBO, USUBO,
 222
 223     /// Same for multiplication.
 224     SMULO, UMULO,
 225
 226     /// Simple binary floating point operators.
 227     FADD, FSUB, FMUL, FMA, FDIV, FREM,
 228
 229     /// FCOPYSIGN(X, Y) - Return the value of X with the sign of Y.  NOTE: This
 230     /// DAG node does not require that X and Y have the same type, just that the
 231     /// are both floating point.  X and the result must have the same type.
 232     /// FCOPYSIGN(f32, f64) is allowed.
 233     FCOPYSIGN,
 234
 235     /// INT = FGETSIGN(FP) - Return the sign bit of the specified floating point
 236     /// value as an integer 0/1 value.
 237     FGETSIGN,
 238
 239     /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector with the
 240     /// specified, possibly variable, elements.  The number of elements is
 241     /// required to be a power of two.  The types of the operands must all be
 242     /// the same and must match the vector element type, except that integer
 243     /// types are allowed to be larger than the element type, in which case
 244     /// the operands are implicitly truncated.
 245     BUILD_VECTOR,
 246
 247     /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR with the element
 248     /// at IDX replaced with VAL.  If the type of VAL is larger than the vector
 249     /// element type then VAL is truncated before replacement.
 250     INSERT_VECTOR_ELT,
 251
 252     /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
 253     /// identified by the (potentially variable) element number IDX.  If the
 254     /// return type is an integer type larger than the element type of the
 255     /// vector, the result is extended to the width of the return type.
 256     EXTRACT_VECTOR_ELT,
 257
 258     /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
 259     /// vector type with the same length and element type, this produces a
 260     /// concatenated vector result value, with length equal to the sum of the
 261     /// lengths of the input vectors.
 262     CONCAT_VECTORS,
 263
 264     /// INSERT_SUBVECTOR(VECTOR1, VECTOR2, IDX) - Returns a vector
 265     /// with VECTOR2 inserted into VECTOR1 at the (potentially
 266     /// variable) element number IDX, which must be a multiple of the
 267     /// VECTOR2 vector length.  The elements of VECTOR1 starting at
 268     /// IDX are overwritten with VECTOR2.  Elements IDX through
 269     /// vector_length(VECTOR2) must be valid VECTOR1 indices.
 270     INSERT_SUBVECTOR,
 271
 272     /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
 273     /// vector value) starting with the element number IDX, which must be a
 274     /// constant multiple of the result vector length.
 275     EXTRACT_SUBVECTOR,
 276
 277     /// VECTOR_SHUFFLE(VEC1, VEC2) - Returns a vector, of the same type as
 278     /// VEC1/VEC2.  A VECTOR_SHUFFLE node also contains an array of constant int
 279     /// values that indicate which value (or undef) each result element will
 280     /// get.  These constant ints are accessible through the
 281     /// ShuffleVectorSDNode class.  This is quite similar to the Altivec
 282     /// 'vperm' instruction, except that the indices must be constants and are
 283     /// in terms of the element size of VEC1/VEC2, not in terms of bytes.
 284     VECTOR_SHUFFLE,
 285
 286     /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
 287     /// scalar value into element 0 of the resultant vector type.  The top
 288     /// elements 1 to N-1 of the N-element vector are undefined.  The type
 289     /// of the operand must match the vector element type, except when they
 290     /// are integer types.  In this case the operand is allowed to be wider
 291     /// than the vector element type, and is implicitly truncated to it.
 292     SCALAR_TO_VECTOR,
 293
 294     /// MULHU/MULHS - Multiply high - Multiply two integers of type iN,
 295     /// producing an unsigned/signed value of type i[2*N], then return the top
 296     /// part.
 297     MULHU, MULHS,
 298
 299     /// Bitwise operators - logical and, logical or, logical xor.
 300     AND, OR, XOR,
 301
 302     /// Shift and rotation operations.  After legalization, the type of the
 303     /// shift amount is known to be TLI.getShiftAmountTy().  Before legalization
 304     /// the shift amount can be any type, but care must be taken to ensure it is
 305     /// large enough.  TLI.getShiftAmountTy() is i8 on some targets, but before
 306     /// legalization, types like i1024 can occur and i8 doesn't have enough bits
 307     /// to represent the shift amount.
 308     /// When the 1st operand is a vector, the shift amount must be in the same
 309     /// type. (TLI.getShiftAmountTy() will return the same type when the input
 310     /// type is a vector.)
 311     SHL, SRA, SRL, ROTL, ROTR,
 312
 313     /// Byte Swap and Counting operators.
 314     BSWAP, CTTZ, CTLZ, CTPOP,
 315
 316     /// Bit counting operators with an undefined result for zero inputs.
 317     CTTZ_ZERO_UNDEF, CTLZ_ZERO_UNDEF,
 318
 319     /// Select(COND, TRUEVAL, FALSEVAL).  If the type of the boolean COND is not
 320     /// i1 then the high bits must conform to getBooleanContents.
 321     SELECT,
 322
 323     /// Select with a vector condition (op #0) and two vector operands (ops #1
 324     /// and #2), returning a vector result.  All vectors have the same length.
 325     /// Much like the scalar select and setcc, each bit in the condition selects
 326     /// whether the corresponding result element is taken from op #1 or op #2.
 327     /// At first, the VSELECT condition is of vXi1 type. Later, targets may
 328     /// change the condition type in order to match the VSELECT node using a
 329     /// pattern. The condition follows the BooleanContent format of the target.
 330     VSELECT,
 331
 332     /// Select with condition operator - This selects between a true value and
 333     /// a false value (ops #2 and #3) based on the boolean result of comparing
 334     /// the lhs and rhs (ops #0 and #1) of a conditional expression with the
 335     /// condition code in op #4, a CondCodeSDNode.
 336     SELECT_CC,
 337
 338     /// SetCC operator - This evaluates to a true value iff the condition is
 339     /// true.  If the result value type is not i1 then the high bits conform
 340     /// to getBooleanContents.  The operands to this are the left and right
 341     /// operands to compare (ops #0, and #1) and the condition code to compare
 342     /// them with (op #2) as a CondCodeSDNode. If the operands are vector types
 343     /// then the result type must also be a vector type.
 344     SETCC,
 345
 346     /// SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
 347     /// integer shift operations, just like ADD/SUB_PARTS.  The operation
 348     /// ordering is:
 349     ///       [Lo,Hi] = op [LoLHS,HiLHS], Amt
 350     SHL_PARTS, SRA_PARTS, SRL_PARTS,
 351
 352     /// Conversion operators.  These are all single input single output
 353     /// operations.  For all of these, the result type must be strictly
 354     /// wider or narrower (depending on the operation) than the source
 355     /// type.
 356
 357     /// SIGN_EXTEND - Used for integer types, replicating the sign bit
 358     /// into new bits.
 359     SIGN_EXTEND,
 360
 361     /// ZERO_EXTEND - Used for integer types, zeroing the new bits.
 362     ZERO_EXTEND,
 363
 364     /// ANY_EXTEND - Used for integer types.  The high bits are undefined.
 365     ANY_EXTEND,
 366
 367     /// TRUNCATE - Completely drop the high bits.
 368     TRUNCATE,
 369
 370     /// [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
 371     /// depends on the first letter) to floating point.
 372     SINT_TO_FP,
 373     UINT_TO_FP,
 374
 375     /// SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
 376     /// sign extend a small value in a large integer register (e.g. sign
 377     /// extending the low 8 bits of a 32-bit register to fill the top 24 bits
 378     /// with the 7th bit).  The size of the smaller type is indicated by the 1th
 379     /// operand, a ValueType node.
 380     SIGN_EXTEND_INREG,
 381
 382     /// ZERO_EXTEND_VECTOR_INREG(Vector) - This operator represents an
 383     /// in-register zero-extension of the low lanes of an integer vector. The
 384     /// result type must have fewer elements than the operand type, and those
 385     /// elements must be larger integer types such that the total size of the
 386     /// operand type and the result type match. Each of the low operand
 387     /// elements is zero-extended into the corresponding, wider result
 388     /// elements.
 389     ZERO_EXTEND_VECTOR_INREG,
 390
 391     /// FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
 392     /// integer.
 393     FP_TO_SINT,
 394     FP_TO_UINT,
 395
 396     /// X = FP_ROUND(Y, TRUNC) - Rounding 'Y' from a larger floating point type
 397     /// down to the precision of the destination VT.  TRUNC is a flag, which is
 398     /// always an integer that is zero or one.  If TRUNC is 0, this is a
 399     /// normal rounding, if it is 1, this FP_ROUND is known to not change the
 400     /// value of Y.
 401     ///
 402     /// The TRUNC = 1 case is used in cases where we know that the value will
 403     /// not be modified by the node, because Y is not using any of the extra
 404     /// precision of source type.  This allows certain transformations like
 405     /// FP_EXTEND(FP_ROUND(X,1)) -> X which are not safe for
 406     /// FP_EXTEND(FP_ROUND(X,0)) because the extra bits aren't removed.
 407     FP_ROUND,
 408
 409     /// FLT_ROUNDS_ - Returns current rounding mode:
 410     /// -1 Undefined
 411     ///  0 Round to 0
 412     ///  1 Round to nearest
 413     ///  2 Round to +inf
 414     ///  3 Round to -inf
 415     FLT_ROUNDS_,
 416
 417     /// X = FP_ROUND_INREG(Y, VT) - This operator takes an FP register, and
 418     /// rounds it to a floating point value.  It then promotes it and returns it
 419     /// in a register of the same size.  This operation effectively just
 420     /// discards excess precision.  The type to round down to is specified by
 421     /// the VT operand, a VTSDNode.
 422     FP_ROUND_INREG,
 423
 424     /// X = FP_EXTEND(Y) - Extend a smaller FP type into a larger FP type.
 425     FP_EXTEND,
 426
 427     /// BITCAST - This operator converts between integer, vector and FP
 428     /// values, as if the value was stored to memory with one type and loaded
 429     /// from the same address with the other type (or equivalently for vector
 430     /// format conversions, etc).  The source and result are required to have
 431     /// the same bit size (e.g.  f32 <-> i32).  This can also be used for
 432     /// int-to-int or fp-to-fp conversions, but that is a noop, deleted by
 433     /// getNode().
 434     BITCAST,
 435
 436     /// ADDRSPACECAST - This operator converts between pointers of different
 437     /// address spaces.
 438     ADDRSPACECAST,
 439
 440     /// CONVERT_RNDSAT - This operator is used to support various conversions
 441     /// between various types (float, signed, unsigned and vectors of those
 442     /// types) with rounding and saturation. NOTE: Avoid using this operator as
 443     /// most target don't support it and the operator might be removed in the
 444     /// future. It takes the following arguments:
 445     ///   0) value
 446     ///   1) dest type (type to convert to)
 447     ///   2) src type (type to convert from)
 448     ///   3) rounding imm
 449     ///   4) saturation imm
 450     ///   5) ISD::CvtCode indicating the type of conversion to do
 451     CONVERT_RNDSAT,
 452
 453     /// FP16_TO_FP32, FP32_TO_FP16 - These operators are used to perform
 454     /// promotions and truncation for half-precision (16 bit) floating
 455     /// numbers. We need special nodes since FP16 is a storage-only type with
 456     /// special semantics of operations.
 457     FP16_TO_FP32, FP32_TO_FP16,
 458
 459     /// FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
 460     /// FLOG, FLOG2, FLOG10, FEXP, FEXP2,
 461     /// FCEIL, FTRUNC, FRINT, FNEARBYINT, FROUND, FFLOOR - Perform various unary
 462     /// floating point operations. These are inspired by libm.
 463     FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
 464     FLOG, FLOG2, FLOG10, FEXP, FEXP2,
 465     FCEIL, FTRUNC, FRINT, FNEARBYINT, FROUND, FFLOOR,
 466
 467     /// FSINCOS - Compute both fsin and fcos as a single operation.
 468     FSINCOS,
 469
 470     /// LOAD and STORE have token chains as their first operand, then the same
 471     /// operands as an LLVM load/store instruction, then an offset node that
 472     /// is added / subtracted from the base pointer to form the address (for
 473     /// indexed memory ops).
 474     LOAD, STORE,
 475
 476     /// DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
 477     /// to a specified boundary.  This node always has two return values: a new
 478     /// stack pointer value and a chain. The first operand is the token chain,
 479     /// the second is the number of bytes to allocate, and the third is the
 480     /// alignment boundary.  The size is guaranteed to be a multiple of the
 481     /// stack alignment, and the alignment is guaranteed to be bigger than the
 482     /// stack alignment (if required) or 0 to get standard stack alignment.
 483     DYNAMIC_STACKALLOC,
 484
 485     /// Control flow instructions.  These all have token chains.
 486
 487     /// BR - Unconditional branch.  The first operand is the chain
 488     /// operand, the second is the MBB to branch to.
 489     BR,
 490
 491     /// BRIND - Indirect branch.  The first operand is the chain, the second
 492     /// is the value to branch to, which must be of the same type as the
 493     /// target's pointer type.
 494     BRIND,
 495
 496     /// BR_JT - Jumptable branch. The first operand is the chain, the second
 497     /// is the jumptable index, the last one is the jumptable entry index.
 498     BR_JT,
 499
 500     /// BRCOND - Conditional branch.  The first operand is the chain, the
 501     /// second is the condition, the third is the block to branch to if the
 502     /// condition is true.  If the type of the condition is not i1, then the
 503     /// high bits must conform to getBooleanContents.
 504     BRCOND,
 505
 506     /// BR_CC - Conditional branch.  The behavior is like that of SELECT_CC, in
 507     /// that the condition is represented as condition code, and two nodes to
 508     /// compare, rather than as a combined SetCC node.  The operands in order
 509     /// are chain, cc, lhs, rhs, block to branch to if condition is true.
 510     BR_CC,
 511
 512     /// INLINEASM - Represents an inline asm block.  This node always has two
 513     /// return values: a chain and a flag result.  The inputs are as follows:
 514     ///   Operand #0  : Input chain.
 515     ///   Operand #1  : a ExternalSymbolSDNode with a pointer to the asm string.
 516     ///   Operand #2  : a MDNodeSDNode with the !srcloc metadata.
 517     ///   Operand #3  : HasSideEffect, IsAlignStack bits.
 518     ///   After this, it is followed by a list of operands with this format:
 519     ///     ConstantSDNode: Flags that encode whether it is a mem or not, the
 520     ///                     of operands that follow, etc.  See InlineAsm.h.
 521     ///     ... however many operands ...
 522     ///   Operand #last: Optional, an incoming flag.
 523     ///
 524     /// The variable width operands are required to represent target addressing
 525     /// modes as a single "operand", even though they may have multiple
 526     /// SDOperands.
 527     INLINEASM,
 528
 529     /// EH_LABEL - Represents a label in mid basic block used to track
 530     /// locations needed for debug and exception handling tables.  These nodes
 531     /// take a chain as input and return a chain.
 532     EH_LABEL,
 533
 534     /// STACKSAVE - STACKSAVE has one operand, an input chain.  It produces a
 535     /// value, the same type as the pointer type for the system, and an output
 536     /// chain.
 537     STACKSAVE,
 538
 539     /// STACKRESTORE has two operands, an input chain and a pointer to restore
 540     /// to it returns an output chain.
 541     STACKRESTORE,
 542
 543     /// CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end
 544     /// of a call sequence, and carry arbitrary information that target might
 545     /// want to know.  The first operand is a chain, the rest are specified by
 546     /// the target and not touched by the DAG optimizers.
 547     /// CALLSEQ_START..CALLSEQ_END pairs may not be nested.
 548     CALLSEQ_START,  // Beginning of a call sequence
 549     CALLSEQ_END,    // End of a call sequence
 550
 551     /// VAARG - VAARG has four operands: an input chain, a pointer, a SRCVALUE,
 552     /// and the alignment. It returns a pair of values: the vaarg value and a
 553     /// new chain.
 554     VAARG,
 555
 556     /// VACOPY - VACOPY has 5 operands: an input chain, a destination pointer,
 557     /// a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
 558     /// source.
 559     VACOPY,
 560
 561     /// VAEND, VASTART - VAEND and VASTART have three operands: an input chain,
 562     /// pointer, and a SRCVALUE.
 563     VAEND, VASTART,
 564
 565     /// SRCVALUE - This is a node type that holds a Value* that is used to
 566     /// make reference to a value in the LLVM IR.
 567     SRCVALUE,
 568
 569     /// MDNODE_SDNODE - This is a node that holdes an MDNode*, which is used to
 570     /// reference metadata in the IR.
 571     MDNODE_SDNODE,
 572
 573     /// PCMARKER - This corresponds to the pcmarker intrinsic.
 574     PCMARKER,
 575
 576     /// READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
 577     /// The only operand is a chain and a value and a chain are produced.  The
 578     /// value is the contents of the architecture specific cycle counter like
 579     /// register (or other high accuracy low latency clock source)
 580     READCYCLECOUNTER,
 581
 582     /// HANDLENODE node - Used as a handle for various purposes.
 583     HANDLENODE,
 584
 585     /// INIT_TRAMPOLINE - This corresponds to the init_trampoline intrinsic.  It
 586     /// takes as input a token chain, the pointer to the trampoline, the pointer
 587     /// to the nested function, the pointer to pass for the 'nest' parameter, a
 588     /// SRCVALUE for the trampoline and another for the nested function
 589     /// (allowing targets to access the original Function*).
 590     /// It produces a token chain as output.
 591     INIT_TRAMPOLINE,
 592
 593     /// ADJUST_TRAMPOLINE - This corresponds to the adjust_trampoline intrinsic.
 594     /// It takes a pointer to the trampoline and produces a (possibly) new
 595     /// pointer to the same trampoline with platform-specific adjustments
 596     /// applied.  The pointer it returns points to an executable block of code.
 597     ADJUST_TRAMPOLINE,
 598
 599     /// TRAP - Trapping instruction
 600     TRAP,
 601
 602     /// DEBUGTRAP - Trap intended to get the attention of a debugger.
 603     DEBUGTRAP,
 604
 605     /// PREFETCH - This corresponds to a prefetch intrinsic. The first operand
 606     /// is the chain.  The other operands are the address to prefetch,
 607     /// read / write specifier, locality specifier and instruction / data cache
 608     /// specifier.
 609     PREFETCH,
 610
 611     /// OUTCHAIN = ATOMIC_FENCE(INCHAIN, ordering, scope)
 612     /// This corresponds to the fence instruction. It takes an input chain, and
 613     /// two integer constants: an AtomicOrdering and a SynchronizationScope.
 614     ATOMIC_FENCE,
 615
 616     /// Val, OUTCHAIN = ATOMIC_LOAD(INCHAIN, ptr)
 617     /// This corresponds to "load atomic" instruction.
 618     ATOMIC_LOAD,
 619
 620     /// OUTCHAIN = ATOMIC_STORE(INCHAIN, ptr, val)
 621     /// This corresponds to "store atomic" instruction.
 622     ATOMIC_STORE,
 623
 624     /// Val, OUTCHAIN = ATOMIC_CMP_SWAP(INCHAIN, ptr, cmp, swap)
 625     /// For double-word atomic operations:
 626     /// ValLo, ValHi, OUTCHAIN = ATOMIC_CMP_SWAP(INCHAIN, ptr, cmpLo, cmpHi,
 627     ///                                          swapLo, swapHi)
 628     /// This corresponds to the cmpxchg instruction.
 629     ATOMIC_CMP_SWAP,
 630
 631     /// Val, Success, OUTCHAIN
 632     ///     = ATOMIC_CMP_SWAP_WITH_SUCCESS(INCHAIN, ptr, cmp, swap)
 633     /// N.b. this is still a strong cmpxchg operation, so
 634     /// Success == "Val == cmp".
 635     ATOMIC_CMP_SWAP_WITH_SUCCESS,
 636
 637     /// Val, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amt)
 638     /// Val, OUTCHAIN = ATOMIC_LOAD_[OpName](INCHAIN, ptr, amt)
 639     /// For double-word atomic operations:
 640     /// ValLo, ValHi, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amtLo, amtHi)
 641     /// ValLo, ValHi, OUTCHAIN = ATOMIC_LOAD_[OpName](INCHAIN, ptr, amtLo, amtHi)
 642     /// These correspond to the atomicrmw instruction.
 643     ATOMIC_SWAP,
 644     ATOMIC_LOAD_ADD,
 645     ATOMIC_LOAD_SUB,
 646     ATOMIC_LOAD_AND,
 647     ATOMIC_LOAD_OR,
 648     ATOMIC_LOAD_XOR,
 649     ATOMIC_LOAD_NAND,
 650     ATOMIC_LOAD_MIN,
 651     ATOMIC_LOAD_MAX,
 652     ATOMIC_LOAD_UMIN,
 653     ATOMIC_LOAD_UMAX,
 654
 655     /// This corresponds to the llvm.lifetime.* intrinsics. The first operand
 656     /// is the chain and the second operand is the alloca pointer.
 657     LIFETIME_START, LIFETIME_END,
 658
 659     /// BUILTIN_OP_END - This must be the last enum value in this list.
 660     /// The target-specific pre-isel opcode values start here.
 661     BUILTIN_OP_END
 662   };
 663
 664   /// FIRST_TARGET_MEMORY_OPCODE - Target-specific pre-isel operations
 665   /// which do not reference a specific memory location should be less than
 666   /// this value. Those that do must not be less than this value, and can
 667   /// be used with SelectionDAG::getMemIntrinsicNode.
 668   static const int FIRST_TARGET_MEMORY_OPCODE = BUILTIN_OP_END+180;
 669
 670   //===--------------------------------------------------------------------===//
 671   /// MemIndexedMode enum - This enum defines the load / store indexed
 672   /// addressing modes.
 673   ///
 674   /// UNINDEXED    "Normal" load / store. The effective address is already
 675   ///              computed and is available in the base pointer. The offset
 676   ///              operand is always undefined. In addition to producing a
 677   ///              chain, an unindexed load produces one value (result of the
 678   ///              load); an unindexed store does not produce a value.
 679   ///
 680   /// PRE_INC      Similar to the unindexed mode where the effective address is
 681   /// PRE_DEC      the value of the base pointer add / subtract the offset.
 682   ///              It considers the computation as being folded into the load /
 683   ///              store operation (i.e. the load / store does the address
 684   ///              computation as well as performing the memory transaction).
 685   ///              The base operand is always undefined. In addition to
 686   ///              producing a chain, pre-indexed load produces two values
 687   ///              (result of the load and the result of the address
 688   ///              computation); a pre-indexed store produces one value (result
 689   ///              of the address computation).
 690   ///
 691   /// POST_INC     The effective address is the value of the base pointer. The
 692   /// POST_DEC     value of the offset operand is then added to / subtracted
 693   ///              from the base after memory transaction. In addition to
 694   ///              producing a chain, post-indexed load produces two values
 695   ///              (the result of the load and the result of the base +/- offset
 696   ///              computation); a post-indexed store produces one value (the
 697   ///              the result of the base +/- offset computation).
 698   enum MemIndexedMode {
 699     UNINDEXED = 0,
 700     PRE_INC,
 701     PRE_DEC,
 702     POST_INC,
 703     POST_DEC,
 704     LAST_INDEXED_MODE
 705   };
 706
 707   //===--------------------------------------------------------------------===//
 708   /// LoadExtType enum - This enum defines the three variants of LOADEXT
 709   /// (load with extension).
 710   ///
 711   /// SEXTLOAD loads the integer operand and sign extends it to a larger
 712   ///          integer result type.
 713   /// ZEXTLOAD loads the integer operand and zero extends it to a larger
 714   ///          integer result type.
 715   /// EXTLOAD  is used for two things: floating point extending loads and
 716   ///          integer extending loads [the top bits are undefined].
 717   enum LoadExtType {
 718     NON_EXTLOAD = 0,
 719     EXTLOAD,
 720     SEXTLOAD,
 721     ZEXTLOAD,
 722     LAST_LOADEXT_TYPE
 723   };
 724
 725   NodeType getExtForLoadExtType(LoadExtType);
 726
 727   //===--------------------------------------------------------------------===//
 728   /// ISD::CondCode enum - These are ordered carefully to make the bitfields
 729   /// below work out, when considering SETFALSE (something that never exists
 730   /// dynamically) as 0.  "U" -> Unsigned (for integer operands) or Unordered
 731   /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
 732   /// to.  If the "N" column is 1, the result of the comparison is undefined if
 733   /// the input is a NAN.
 734   ///
 735   /// All of these (except for the 'always folded ops') should be handled for
 736   /// floating point.  For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
 737   /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
 738   ///
 739   /// Note that these are laid out in a specific order to allow bit-twiddling
 740   /// to transform conditions.
 741   enum CondCode {
 742     // Opcode          N U L G E       Intuitive operation
 743     SETFALSE,      //    0 0 0 0       Always false (always folded)
 744     SETOEQ,        //    0 0 0 1       True if ordered and equal
 745     SETOGT,        //    0 0 1 0       True if ordered and greater than
 746     SETOGE,        //    0 0 1 1       True if ordered and greater than or equal
 747     SETOLT,        //    0 1 0 0       True if ordered and less than
 748     SETOLE,        //    0 1 0 1       True if ordered and less than or equal
 749     SETONE,        //    0 1 1 0       True if ordered and operands are unequal
 750     SETO,          //    0 1 1 1       True if ordered (no nans)
 751     SETUO,         //    1 0 0 0       True if unordered: isnan(X) | isnan(Y)
 752     SETUEQ,        //    1 0 0 1       True if unordered or equal
 753     SETUGT,        //    1 0 1 0       True if unordered or greater than
 754     SETUGE,        //    1 0 1 1       True if unordered, greater than, or equal
 755     SETULT,        //    1 1 0 0       True if unordered or less than
 756     SETULE,        //    1 1 0 1       True if unordered, less than, or equal
 757     SETUNE,        //    1 1 1 0       True if unordered or not equal
 758     SETTRUE,       //    1 1 1 1       Always true (always folded)
 759     // Don't care operations: undefined if the input is a nan.
 760     SETFALSE2,     //  1 X 0 0 0       Always false (always folded)
 761     SETEQ,         //  1 X 0 0 1       True if equal
 762     SETGT,         //  1 X 0 1 0       True if greater than
 763     SETGE,         //  1 X 0 1 1       True if greater than or equal
 764     SETLT,         //  1 X 1 0 0       True if less than
 765     SETLE,         //  1 X 1 0 1       True if less than or equal
 766     SETNE,         //  1 X 1 1 0       True if not equal
 767     SETTRUE2,      //  1 X 1 1 1       Always true (always folded)
 768
 769     SETCC_INVALID       // Marker value.
 770   };
 771
 772   /// isSignedIntSetCC - Return true if this is a setcc instruction that
 773   /// performs a signed comparison when used with integer operands.
 774   inline bool isSignedIntSetCC(CondCode Code) {
 775     return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
 776   }
 777
 778   /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
 779   /// performs an unsigned comparison when used with integer operands.
 780   inline bool isUnsignedIntSetCC(CondCode Code) {
 781     return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
 782   }
 783
 784   /// isTrueWhenEqual - Return true if the specified condition returns true if
 785   /// the two operands to the condition are equal.  Note that if one of the two
 786   /// operands is a NaN, this value is meaningless.
 787   inline bool isTrueWhenEqual(CondCode Cond) {
 788     return ((int)Cond & 1) != 0;
 789   }
 790
 791   /// getUnorderedFlavor - This function returns 0 if the condition is always
 792   /// false if an operand is a NaN, 1 if the condition is always true if the
 793   /// operand is a NaN, and 2 if the condition is undefined if the operand is a
 794   /// NaN.
 795   inline unsigned getUnorderedFlavor(CondCode Cond) {
 796     return ((int)Cond >> 3) & 3;
 797   }
 798
 799   /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
 800   /// 'op' is a valid SetCC operation.
 801   CondCode getSetCCInverse(CondCode Operation, bool isInteger);
 802
 803   /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
 804   /// when given the operation for (X op Y).
 805   CondCode getSetCCSwappedOperands(CondCode Operation);
 806
 807   /// getSetCCOrOperation - Return the result of a logical OR between different
 808   /// comparisons of identical values: ((X op1 Y) | (X op2 Y)).  This
 809   /// function returns SETCC_INVALID if it is not possible to represent the
 810   /// resultant comparison.
 811   CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
 812
 813   /// getSetCCAndOperation - Return the result of a logical AND between
 814   /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)).  This
 815   /// function returns SETCC_INVALID if it is not possible to represent the
 816   /// resultant comparison.
 817   CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
 818
 819   //===--------------------------------------------------------------------===//
 820   /// CvtCode enum - This enum defines the various converts CONVERT_RNDSAT
 821   /// supports.
 822   enum CvtCode {
 823     CVT_FF,     /// Float from Float
 824     CVT_FS,     /// Float from Signed
 825     CVT_FU,     /// Float from Unsigned
 826     CVT_SF,     /// Signed from Float
 827     CVT_UF,     /// Unsigned from Float
 828     CVT_SS,     /// Signed from Signed
 829     CVT_SU,     /// Signed from Unsigned
 830     CVT_US,     /// Unsigned from Signed
 831     CVT_UU,     /// Unsigned from Unsigned
 832     CVT_INVALID /// Marker - Invalid opcode
 833   };
 834
 835 } // end llvm::ISD namespace
 836
 837 } // end llvm namespace
 838
 839 #endif