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