1 //===-- llvm/CodeGen/SelectionDAGNodes.h - SelectionDAG Nodes ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the SDNode class and derived classes, which are used to
11 // represent the nodes and operations present in a SelectionDAG. These nodes
12 // and operations are machine code level operations, with some similarities to
13 // the GCC RTL representation.
15 // Clients should include the SelectionDAG.h file instead of this file directly.
17 //===----------------------------------------------------------------------===//
19 #ifndef LLVM_CODEGEN_SELECTIONDAGNODES_H
20 #define LLVM_CODEGEN_SELECTIONDAGNODES_H
22 #include "llvm/Constants.h"
23 #include "llvm/ADT/FoldingSet.h"
24 #include "llvm/ADT/GraphTraits.h"
25 #include "llvm/ADT/iterator.h"
26 #include "llvm/ADT/ilist_node.h"
27 #include "llvm/ADT/STLExtras.h"
28 #include "llvm/CodeGen/ValueTypes.h"
29 #include "llvm/CodeGen/MachineMemOperand.h"
30 #include "llvm/Support/Allocator.h"
31 #include "llvm/Support/RecyclingAllocator.h"
32 #include "llvm/Support/DataTypes.h"
33 #include "llvm/CodeGen/DebugLoc.h"
40 class MachineBasicBlock;
41 class MachineConstantPoolValue;
44 template <typename T> struct DenseMapInfo;
45 template <typename T> struct simplify_type;
46 template <typename T> struct ilist_traits;
48 /// SDVTList - This represents a list of ValueType's that has been intern'd by
49 /// a SelectionDAG. Instances of this simple value class are returned by
50 /// SelectionDAG::getVTList(...).
54 unsigned short NumVTs;
57 /// ISD namespace - This namespace contains an enum which represents all of the
58 /// SelectionDAG node types and value types.
62 //===--------------------------------------------------------------------===//
63 /// ISD::NodeType enum - This enum defines the target-independent operators
64 /// for a SelectionDAG.
66 /// Targets may also define target-dependent operator codes for SDNodes. For
67 /// example, on x86, these are the enum values in the X86ISD namespace.
68 /// Targets should aim to use target-independent operators to model their
69 /// instruction sets as much as possible, and only use target-dependent
70 /// operators when they have special requirements.
72 /// Finally, during and after selection proper, SNodes may use special
73 /// operator codes that correspond directly with MachineInstr opcodes. These
74 /// are used to represent selected instructions. See the isMachineOpcode()
75 /// and getMachineOpcode() member functions of SDNode.
78 // DELETED_NODE - This is an illegal value that is used to catch
79 // errors. This opcode is not a legal opcode for any node.
82 // EntryToken - This is the marker used to indicate the start of the region.
85 // TokenFactor - This node takes multiple tokens as input and produces a
86 // single token result. This is used to represent the fact that the operand
87 // operators are independent of each other.
90 // AssertSext, AssertZext - These nodes record if a register contains a
91 // value that has already been zero or sign extended from a narrower type.
92 // These nodes take two operands. The first is the node that has already
93 // been extended, and the second is a value type node indicating the width
95 AssertSext, AssertZext,
97 // Various leaf nodes.
98 BasicBlock, VALUETYPE, ARG_FLAGS, CONDCODE, Register,
100 GlobalAddress, GlobalTLSAddress, FrameIndex,
101 JumpTable, ConstantPool, ExternalSymbol,
103 // The address of the GOT
106 // FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
107 // llvm.returnaddress on the DAG. These nodes take one operand, the index
108 // of the frame or return address to return. An index of zero corresponds
109 // to the current function's frame or return address, an index of one to the
110 // parent's frame or return address, and so on.
111 FRAMEADDR, RETURNADDR,
113 // FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
114 // first (possible) on-stack argument. This is needed for correct stack
115 // adjustment during unwind.
116 FRAME_TO_ARGS_OFFSET,
118 // RESULT, OUTCHAIN = EXCEPTIONADDR(INCHAIN) - This node represents the
119 // address of the exception block on entry to an landing pad block.
122 // RESULT, OUTCHAIN = EHSELECTION(INCHAIN, EXCEPTION) - This node represents
123 // the selection index of the exception thrown.
126 // OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
127 // 'eh_return' gcc dwarf builtin, which is used to return from
128 // exception. The general meaning is: adjust stack by OFFSET and pass
129 // execution to HANDLER. Many platform-related details also :)
132 // TargetConstant* - Like Constant*, but the DAG does not do any folding or
133 // simplification of the constant.
137 // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
138 // anything else with this node, and this is valid in the target-specific
139 // dag, turning into a GlobalAddress operand.
141 TargetGlobalTLSAddress,
145 TargetExternalSymbol,
147 /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
148 /// This node represents a target intrinsic function with no side effects.
149 /// The first operand is the ID number of the intrinsic from the
150 /// llvm::Intrinsic namespace. The operands to the intrinsic follow. The
151 /// node has returns the result of the intrinsic.
154 /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
155 /// This node represents a target intrinsic function with side effects that
156 /// returns a result. The first operand is a chain pointer. The second is
157 /// the ID number of the intrinsic from the llvm::Intrinsic namespace. The
158 /// operands to the intrinsic follow. The node has two results, the result
159 /// of the intrinsic and an output chain.
162 /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
163 /// This node represents a target intrinsic function with side effects that
164 /// does not return a result. The first operand is a chain pointer. The
165 /// second is the ID number of the intrinsic from the llvm::Intrinsic
166 /// namespace. The operands to the intrinsic follow.
169 // CopyToReg - This node has three operands: a chain, a register number to
170 // set to this value, and a value.
173 // CopyFromReg - This node indicates that the input value is a virtual or
174 // physical register that is defined outside of the scope of this
175 // SelectionDAG. The register is available from the RegisterSDNode object.
178 // UNDEF - An undefined node
181 /// FORMAL_ARGUMENTS(CHAIN, CC#, ISVARARG, FLAG0, ..., FLAGn) - This node
182 /// represents the formal arguments for a function. CC# is a Constant value
183 /// indicating the calling convention of the function, and ISVARARG is a
184 /// flag that indicates whether the function is varargs or not. This node
185 /// has one result value for each incoming argument, plus one for the output
186 /// chain. It must be custom legalized. See description of CALL node for
187 /// FLAG argument contents explanation.
191 /// RV1, RV2...RVn, CHAIN = CALL(CHAIN, CALLEE,
192 /// ARG0, FLAG0, ARG1, FLAG1, ... ARGn, FLAGn)
193 /// This node represents a fully general function call, before the legalizer
194 /// runs. This has one result value for each argument / flag pair, plus
195 /// a chain result. It must be custom legalized. Flag argument indicates
196 /// misc. argument attributes. Currently:
198 /// Bit 1 - 'inreg' attribute
199 /// Bit 2 - 'sret' attribute
200 /// Bit 4 - 'byval' attribute
201 /// Bit 5 - 'nest' attribute
202 /// Bit 6-9 - alignment of byval structures
203 /// Bit 10-26 - size of byval structures
204 /// Bits 31:27 - argument ABI alignment in the first argument piece and
205 /// alignment '1' in other argument pieces.
207 /// CALL nodes use the CallSDNode subclass of SDNode, which
208 /// additionally carries information about the calling convention,
209 /// whether the call is varargs, and if it's marked as a tail call.
213 // EXTRACT_ELEMENT - This is used to get the lower or upper (determined by
214 // a Constant, which is required to be operand #1) half of the integer or
215 // float value specified as operand #0. This is only for use before
216 // legalization, for values that will be broken into multiple registers.
219 // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways. Given
220 // two values of the same integer value type, this produces a value twice as
221 // big. Like EXTRACT_ELEMENT, this can only be used before legalization.
224 // MERGE_VALUES - This node takes multiple discrete operands and returns
225 // them all as its individual results. This nodes has exactly the same
226 // number of inputs and outputs, and is only valid before legalization.
227 // This node is useful for some pieces of the code generator that want to
228 // think about a single node with multiple results, not multiple nodes.
231 // Simple integer binary arithmetic operators.
232 ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
234 // SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing
235 // a signed/unsigned value of type i[2*N], and return the full value as
236 // two results, each of type iN.
237 SMUL_LOHI, UMUL_LOHI,
239 // SDIVREM/UDIVREM - Divide two integers and produce both a quotient and
243 // CARRY_FALSE - This node is used when folding other nodes,
244 // like ADDC/SUBC, which indicate the carry result is always false.
247 // Carry-setting nodes for multiple precision addition and subtraction.
248 // These nodes take two operands of the same value type, and produce two
249 // results. The first result is the normal add or sub result, the second
250 // result is the carry flag result.
253 // Carry-using nodes for multiple precision addition and subtraction. These
254 // nodes take three operands: The first two are the normal lhs and rhs to
255 // the add or sub, and the third is the input carry flag. These nodes
256 // produce two results; the normal result of the add or sub, and the output
257 // carry flag. These nodes both read and write a carry flag to allow them
258 // to them to be chained together for add and sub of arbitrarily large
262 // RESULT, BOOL = [SU]ADDO(LHS, RHS) - Overflow-aware nodes for addition.
263 // These nodes take two operands: the normal LHS and RHS to the add. They
264 // produce two results: the normal result of the add, and a boolean that
265 // indicates if an overflow occured (*not* a flag, because it may be stored
266 // to memory, etc.). If the type of the boolean is not i1 then the high
267 // bits conform to getBooleanContents.
268 // These nodes are generated from the llvm.[su]add.with.overflow intrinsics.
271 // Same for subtraction
274 // Same for multiplication
277 // Simple binary floating point operators.
278 FADD, FSUB, FMUL, FDIV, FREM,
280 // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y. NOTE: This
281 // DAG node does not require that X and Y have the same type, just that they
282 // are both floating point. X and the result must have the same type.
283 // FCOPYSIGN(f32, f64) is allowed.
286 // INT = FGETSIGN(FP) - Return the sign bit of the specified floating point
287 // value as an integer 0/1 value.
290 /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector
291 /// with the specified, possibly variable, elements. The number of elements
292 /// is required to be a power of two.
295 /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR with the element
296 /// at IDX replaced with VAL. If the type of VAL is larger than the vector
297 /// element type then VAL is truncated before replacement.
300 /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
301 /// identified by the (potentially variable) element number IDX.
304 /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
305 /// vector type with the same length and element type, this produces a
306 /// concatenated vector result value, with length equal to the sum of the
307 /// lengths of the input vectors.
310 /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
311 /// vector value) starting with the (potentially variable) element number
312 /// IDX, which must be a multiple of the result vector length.
315 /// VECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC) - Returns a vector, of the same
316 /// type as VEC1/VEC2. SHUFFLEVEC is a BUILD_VECTOR of constant int values
317 /// (maybe of an illegal datatype) or undef that indicate which value each
318 /// result element will get. The elements of VEC1/VEC2 are enumerated in
319 /// order. This is quite similar to the Altivec 'vperm' instruction, except
320 /// that the indices must be constants and are in terms of the element size
321 /// of VEC1/VEC2, not in terms of bytes.
324 /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
325 /// scalar value into element 0 of the resultant vector type. The top
326 /// elements 1 to N-1 of the N-element vector are undefined.
329 // EXTRACT_SUBREG - This node is used to extract a sub-register value.
330 // This node takes a superreg and a constant sub-register index as operands.
331 // Note sub-register indices must be increasing. That is, if the
332 // sub-register index of a 8-bit sub-register is N, then the index for a
333 // 16-bit sub-register must be at least N+1.
336 // INSERT_SUBREG - This node is used to insert a sub-register value.
337 // This node takes a superreg, a subreg value, and a constant sub-register
338 // index as operands.
341 // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
342 // an unsigned/signed value of type i[2*N], then return the top part.
345 // Bitwise operators - logical and, logical or, logical xor, shift left,
346 // shift right algebraic (shift in sign bits), shift right logical (shift in
347 // zeroes), rotate left, rotate right, and byteswap.
348 AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
350 // Counting operators
353 // Select(COND, TRUEVAL, FALSEVAL). If the type of the boolean COND is not
354 // i1 then the high bits must conform to getBooleanContents.
357 // Select with condition operator - This selects between a true value and
358 // a false value (ops #2 and #3) based on the boolean result of comparing
359 // the lhs and rhs (ops #0 and #1) of a conditional expression with the
360 // condition code in op #4, a CondCodeSDNode.
363 // SetCC operator - This evaluates to a true value iff the condition is
364 // true. If the result value type is not i1 then the high bits conform
365 // to getBooleanContents. The operands to this are the left and right
366 // operands to compare (ops #0, and #1) and the condition code to compare
367 // them with (op #2) as a CondCodeSDNode.
370 // Vector SetCC operator - This evaluates to a vector of integer elements
371 // with the high bit in each element set to true if the comparison is true
372 // and false if the comparison is false. All other bits in each element
373 // are undefined. The operands to this are the left and right operands
374 // to compare (ops #0, and #1) and the condition code to compare them with
375 // (op #2) as a CondCodeSDNode.
378 // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
379 // integer shift operations, just like ADD/SUB_PARTS. The operation
381 // [Lo,Hi] = op [LoLHS,HiLHS], Amt
382 SHL_PARTS, SRA_PARTS, SRL_PARTS,
384 // Conversion operators. These are all single input single output
385 // operations. For all of these, the result type must be strictly
386 // wider or narrower (depending on the operation) than the source
389 // SIGN_EXTEND - Used for integer types, replicating the sign bit
393 // ZERO_EXTEND - Used for integer types, zeroing the new bits.
396 // ANY_EXTEND - Used for integer types. The high bits are undefined.
399 // TRUNCATE - Completely drop the high bits.
402 // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
403 // depends on the first letter) to floating point.
407 // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
408 // sign extend a small value in a large integer register (e.g. sign
409 // extending the low 8 bits of a 32-bit register to fill the top 24 bits
410 // with the 7th bit). The size of the smaller type is indicated by the 1th
411 // operand, a ValueType node.
414 /// FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
419 /// X = FP_ROUND(Y, TRUNC) - Rounding 'Y' from a larger floating point type
420 /// down to the precision of the destination VT. TRUNC is a flag, which is
421 /// always an integer that is zero or one. If TRUNC is 0, this is a
422 /// normal rounding, if it is 1, this FP_ROUND is known to not change the
425 /// The TRUNC = 1 case is used in cases where we know that the value will
426 /// not be modified by the node, because Y is not using any of the extra
427 /// precision of source type. This allows certain transformations like
428 /// FP_EXTEND(FP_ROUND(X,1)) -> X which are not safe for
429 /// FP_EXTEND(FP_ROUND(X,0)) because the extra bits aren't removed.
432 // FLT_ROUNDS_ - Returns current rounding mode:
435 // 1 Round to nearest
440 /// X = FP_ROUND_INREG(Y, VT) - This operator takes an FP register, and
441 /// rounds it to a floating point value. It then promotes it and returns it
442 /// in a register of the same size. This operation effectively just
443 /// discards excess precision. The type to round down to is specified by
444 /// the VT operand, a VTSDNode.
447 /// X = FP_EXTEND(Y) - Extend a smaller FP type into a larger FP type.
450 // BIT_CONVERT - Theis operator converts between integer and FP values, as
451 // if one was stored to memory as integer and the other was loaded from the
452 // same address (or equivalently for vector format conversions, etc). The
453 // source and result are required to have the same bit size (e.g.
454 // f32 <-> i32). This can also be used for int-to-int or fp-to-fp
455 // conversions, but that is a noop, deleted by getNode().
458 // CONVERT_RNDSAT - This operator is used to support various conversions
459 // between various types (float, signed, unsigned and vectors of those
460 // types) with rounding and saturation. NOTE: Avoid using this operator as
461 // most target don't support it and the operator might be removed in the
462 // future. It takes the following arguments:
464 // 1) dest type (type to convert to)
465 // 2) src type (type to convert from)
468 // 5) ISD::CvtCode indicating the type of conversion to do
471 // FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
472 // FLOG, FLOG2, FLOG10, FEXP, FEXP2,
473 // FCEIL, FTRUNC, FRINT, FNEARBYINT, FFLOOR - Perform various unary floating
474 // point operations. These are inspired by libm.
475 FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
476 FLOG, FLOG2, FLOG10, FEXP, FEXP2,
477 FCEIL, FTRUNC, FRINT, FNEARBYINT, FFLOOR,
479 // LOAD and STORE have token chains as their first operand, then the same
480 // operands as an LLVM load/store instruction, then an offset node that
481 // is added / subtracted from the base pointer to form the address (for
482 // indexed memory ops).
485 // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
486 // to a specified boundary. This node always has two return values: a new
487 // stack pointer value and a chain. The first operand is the token chain,
488 // the second is the number of bytes to allocate, and the third is the
489 // alignment boundary. The size is guaranteed to be a multiple of the stack
490 // alignment, and the alignment is guaranteed to be bigger than the stack
491 // alignment (if required) or 0 to get standard stack alignment.
494 // Control flow instructions. These all have token chains.
496 // BR - Unconditional branch. The first operand is the chain
497 // operand, the second is the MBB to branch to.
500 // BRIND - Indirect branch. The first operand is the chain, the second
501 // is the value to branch to, which must be of the same type as the target's
505 // BR_JT - Jumptable branch. The first operand is the chain, the second
506 // is the jumptable index, the last one is the jumptable entry index.
509 // BRCOND - Conditional branch. The first operand is the chain, the
510 // second is the condition, the third is the block to branch to if the
511 // condition is true. If the type of the condition is not i1, then the
512 // high bits must conform to getBooleanContents.
515 // BR_CC - Conditional branch. The behavior is like that of SELECT_CC, in
516 // that the condition is represented as condition code, and two nodes to
517 // compare, rather than as a combined SetCC node. The operands in order are
518 // chain, cc, lhs, rhs, block to branch to if condition is true.
521 // RET - Return from function. The first operand is the chain,
522 // and any subsequent operands are pairs of return value and return value
523 // attributes (see CALL for description of attributes) for the function.
524 // This operation can have variable number of operands.
527 // INLINEASM - Represents an inline asm block. This node always has two
528 // return values: a chain and a flag result. The inputs are as follows:
529 // Operand #0 : Input chain.
530 // Operand #1 : a ExternalSymbolSDNode with a pointer to the asm string.
531 // Operand #2n+2: A RegisterNode.
532 // Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
533 // Operand #last: Optional, an incoming flag.
536 // DBG_LABEL, EH_LABEL - Represents a label in mid basic block used to track
537 // locations needed for debug and exception handling tables. These nodes
538 // take a chain as input and return a chain.
542 // DECLARE - Represents a llvm.dbg.declare intrinsic. It's used to track
543 // local variable declarations for debugging information. First operand is
544 // a chain, while the next two operands are first two arguments (address
545 // and variable) of a llvm.dbg.declare instruction.
548 // STACKSAVE - STACKSAVE has one operand, an input chain. It produces a
549 // value, the same type as the pointer type for the system, and an output
553 // STACKRESTORE has two operands, an input chain and a pointer to restore to
554 // it returns an output chain.
557 // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
558 // a call sequence, and carry arbitrary information that target might want
559 // to know. The first operand is a chain, the rest are specified by the
560 // target and not touched by the DAG optimizers.
561 // CALLSEQ_START..CALLSEQ_END pairs may not be nested.
562 CALLSEQ_START, // Beginning of a call sequence
563 CALLSEQ_END, // End of a call sequence
565 // VAARG - VAARG has three operands: an input chain, a pointer, and a
566 // SRCVALUE. It returns a pair of values: the vaarg value and a new chain.
569 // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
570 // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
574 // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
575 // pointer, and a SRCVALUE.
578 // SRCVALUE - This is a node type that holds a Value* that is used to
579 // make reference to a value in the LLVM IR.
582 // MEMOPERAND - This is a node that contains a MachineMemOperand which
583 // records information about a memory reference. This is used to make
584 // AliasAnalysis queries from the backend.
587 // PCMARKER - This corresponds to the pcmarker intrinsic.
590 // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
591 // The only operand is a chain and a value and a chain are produced. The
592 // value is the contents of the architecture specific cycle counter like
593 // register (or other high accuracy low latency clock source)
596 // HANDLENODE node - Used as a handle for various purposes.
599 // DBG_STOPPOINT - This node is used to represent a source location for
600 // debug info. It takes token chain as input, and carries a line number,
601 // column number, and a pointer to a CompileUnit object identifying
602 // the containing compilation unit. It produces a token chain as output.
605 // DEBUG_LOC - This node is used to represent source line information
606 // embedded in the code. It takes a token chain as input, then a line
607 // number, then a column then a file id (provided by MachineModuleInfo.) It
608 // produces a token chain as output.
611 // TRAMPOLINE - This corresponds to the init_trampoline intrinsic.
612 // It takes as input a token chain, the pointer to the trampoline,
613 // the pointer to the nested function, the pointer to pass for the
614 // 'nest' parameter, a SRCVALUE for the trampoline and another for
615 // the nested function (allowing targets to access the original
616 // Function*). It produces the result of the intrinsic and a token
620 // TRAP - Trapping instruction
623 // PREFETCH - This corresponds to a prefetch intrinsic. It takes chains are
624 // their first operand. The other operands are the address to prefetch,
625 // read / write specifier, and locality specifier.
628 // OUTCHAIN = MEMBARRIER(INCHAIN, load-load, load-store, store-load,
629 // store-store, device)
630 // This corresponds to the memory.barrier intrinsic.
631 // it takes an input chain, 4 operands to specify the type of barrier, an
632 // operand specifying if the barrier applies to device and uncached memory
633 // and produces an output chain.
636 // Val, OUTCHAIN = ATOMIC_CMP_SWAP(INCHAIN, ptr, cmp, swap)
637 // this corresponds to the atomic.lcs intrinsic.
638 // cmp is compared to *ptr, and if equal, swap is stored in *ptr.
639 // the return is always the original value in *ptr
642 // Val, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amt)
643 // this corresponds to the atomic.swap intrinsic.
644 // amt is stored to *ptr atomically.
645 // the return is always the original value in *ptr
648 // Val, OUTCHAIN = ATOMIC_LOAD_[OpName](INCHAIN, ptr, amt)
649 // this corresponds to the atomic.load.[OpName] intrinsic.
650 // op(*ptr, amt) is stored to *ptr atomically.
651 // the return is always the original value in *ptr
663 // BUILTIN_OP_END - This must be the last enum value in this list.
669 /// isBuildVectorAllOnes - Return true if the specified node is a
670 /// BUILD_VECTOR where all of the elements are ~0 or undef.
671 bool isBuildVectorAllOnes(const SDNode *N);
673 /// isBuildVectorAllZeros - Return true if the specified node is a
674 /// BUILD_VECTOR where all of the elements are 0 or undef.
675 bool isBuildVectorAllZeros(const SDNode *N);
677 /// isScalarToVector - Return true if the specified node is a
678 /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
679 /// element is not an undef.
680 bool isScalarToVector(const SDNode *N);
682 /// isDebugLabel - Return true if the specified node represents a debug
683 /// label (i.e. ISD::DBG_LABEL or TargetInstrInfo::DBG_LABEL node).
684 bool isDebugLabel(const SDNode *N);
686 //===--------------------------------------------------------------------===//
687 /// MemIndexedMode enum - This enum defines the load / store indexed
688 /// addressing modes.
690 /// UNINDEXED "Normal" load / store. The effective address is already
691 /// computed and is available in the base pointer. The offset
692 /// operand is always undefined. In addition to producing a
693 /// chain, an unindexed load produces one value (result of the
694 /// load); an unindexed store does not produce a value.
696 /// PRE_INC Similar to the unindexed mode where the effective address is
697 /// PRE_DEC the value of the base pointer add / subtract the offset.
698 /// It considers the computation as being folded into the load /
699 /// store operation (i.e. the load / store does the address
700 /// computation as well as performing the memory transaction).
701 /// The base operand is always undefined. In addition to
702 /// producing a chain, pre-indexed load produces two values
703 /// (result of the load and the result of the address
704 /// computation); a pre-indexed store produces one value (result
705 /// of the address computation).
707 /// POST_INC The effective address is the value of the base pointer. The
708 /// POST_DEC value of the offset operand is then added to / subtracted
709 /// from the base after memory transaction. In addition to
710 /// producing a chain, post-indexed load produces two values
711 /// (the result of the load and the result of the base +/- offset
712 /// computation); a post-indexed store produces one value (the
713 /// the result of the base +/- offset computation).
715 enum MemIndexedMode {
724 //===--------------------------------------------------------------------===//
725 /// LoadExtType enum - This enum defines the three variants of LOADEXT
726 /// (load with extension).
728 /// SEXTLOAD loads the integer operand and sign extends it to a larger
729 /// integer result type.
730 /// ZEXTLOAD loads the integer operand and zero extends it to a larger
731 /// integer result type.
732 /// EXTLOAD is used for three things: floating point extending loads,
733 /// integer extending loads [the top bits are undefined], and vector
734 /// extending loads [load into low elt].
744 //===--------------------------------------------------------------------===//
745 /// ISD::CondCode enum - These are ordered carefully to make the bitfields
746 /// below work out, when considering SETFALSE (something that never exists
747 /// dynamically) as 0. "U" -> Unsigned (for integer operands) or Unordered
748 /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
749 /// to. If the "N" column is 1, the result of the comparison is undefined if
750 /// the input is a NAN.
752 /// All of these (except for the 'always folded ops') should be handled for
753 /// floating point. For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
754 /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
756 /// Note that these are laid out in a specific order to allow bit-twiddling
757 /// to transform conditions.
759 // Opcode N U L G E Intuitive operation
760 SETFALSE, // 0 0 0 0 Always false (always folded)
761 SETOEQ, // 0 0 0 1 True if ordered and equal
762 SETOGT, // 0 0 1 0 True if ordered and greater than
763 SETOGE, // 0 0 1 1 True if ordered and greater than or equal
764 SETOLT, // 0 1 0 0 True if ordered and less than
765 SETOLE, // 0 1 0 1 True if ordered and less than or equal
766 SETONE, // 0 1 1 0 True if ordered and operands are unequal
767 SETO, // 0 1 1 1 True if ordered (no nans)
768 SETUO, // 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
769 SETUEQ, // 1 0 0 1 True if unordered or equal
770 SETUGT, // 1 0 1 0 True if unordered or greater than
771 SETUGE, // 1 0 1 1 True if unordered, greater than, or equal
772 SETULT, // 1 1 0 0 True if unordered or less than
773 SETULE, // 1 1 0 1 True if unordered, less than, or equal
774 SETUNE, // 1 1 1 0 True if unordered or not equal
775 SETTRUE, // 1 1 1 1 Always true (always folded)
776 // Don't care operations: undefined if the input is a nan.
777 SETFALSE2, // 1 X 0 0 0 Always false (always folded)
778 SETEQ, // 1 X 0 0 1 True if equal
779 SETGT, // 1 X 0 1 0 True if greater than
780 SETGE, // 1 X 0 1 1 True if greater than or equal
781 SETLT, // 1 X 1 0 0 True if less than
782 SETLE, // 1 X 1 0 1 True if less than or equal
783 SETNE, // 1 X 1 1 0 True if not equal
784 SETTRUE2, // 1 X 1 1 1 Always true (always folded)
786 SETCC_INVALID // Marker value.
789 /// isSignedIntSetCC - Return true if this is a setcc instruction that
790 /// performs a signed comparison when used with integer operands.
791 inline bool isSignedIntSetCC(CondCode Code) {
792 return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
795 /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
796 /// performs an unsigned comparison when used with integer operands.
797 inline bool isUnsignedIntSetCC(CondCode Code) {
798 return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
801 /// isTrueWhenEqual - Return true if the specified condition returns true if
802 /// the two operands to the condition are equal. Note that if one of the two
803 /// operands is a NaN, this value is meaningless.
804 inline bool isTrueWhenEqual(CondCode Cond) {
805 return ((int)Cond & 1) != 0;
808 /// getUnorderedFlavor - This function returns 0 if the condition is always
809 /// false if an operand is a NaN, 1 if the condition is always true if the
810 /// operand is a NaN, and 2 if the condition is undefined if the operand is a
812 inline unsigned getUnorderedFlavor(CondCode Cond) {
813 return ((int)Cond >> 3) & 3;
816 /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
817 /// 'op' is a valid SetCC operation.
818 CondCode getSetCCInverse(CondCode Operation, bool isInteger);
820 /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
821 /// when given the operation for (X op Y).
822 CondCode getSetCCSwappedOperands(CondCode Operation);
824 /// getSetCCOrOperation - Return the result of a logical OR between different
825 /// comparisons of identical values: ((X op1 Y) | (X op2 Y)). This
826 /// function returns SETCC_INVALID if it is not possible to represent the
827 /// resultant comparison.
828 CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
830 /// getSetCCAndOperation - Return the result of a logical AND between
831 /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)). This
832 /// function returns SETCC_INVALID if it is not possible to represent the
833 /// resultant comparison.
834 CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
836 //===--------------------------------------------------------------------===//
837 /// CvtCode enum - This enum defines the various converts CONVERT_RNDSAT
840 CVT_FF, // Float from Float
841 CVT_FS, // Float from Signed
842 CVT_FU, // Float from Unsigned
843 CVT_SF, // Signed from Float
844 CVT_UF, // Unsigned from Float
845 CVT_SS, // Signed from Signed
846 CVT_SU, // Signed from Unsigned
847 CVT_US, // Unsigned from Signed
848 CVT_UU, // Unsigned from Unsigned
849 CVT_INVALID // Marker - Invalid opcode
851 } // end llvm::ISD namespace
854 //===----------------------------------------------------------------------===//
855 /// SDValue - Unlike LLVM values, Selection DAG nodes may return multiple
856 /// values as the result of a computation. Many nodes return multiple values,
857 /// from loads (which define a token and a return value) to ADDC (which returns
858 /// a result and a carry value), to calls (which may return an arbitrary number
861 /// As such, each use of a SelectionDAG computation must indicate the node that
862 /// computes it as well as which return value to use from that node. This pair
863 /// of information is represented with the SDValue value type.
866 SDNode *Node; // The node defining the value we are using.
867 unsigned ResNo; // Which return value of the node we are using.
869 SDValue() : Node(0), ResNo(0) {}
870 SDValue(SDNode *node, unsigned resno) : Node(node), ResNo(resno) {}
872 /// get the index which selects a specific result in the SDNode
873 unsigned getResNo() const { return ResNo; }
875 /// get the SDNode which holds the desired result
876 SDNode *getNode() const { return Node; }
879 void setNode(SDNode *N) { Node = N; }
881 bool operator==(const SDValue &O) const {
882 return Node == O.Node && ResNo == O.ResNo;
884 bool operator!=(const SDValue &O) const {
885 return !operator==(O);
887 bool operator<(const SDValue &O) const {
888 return Node < O.Node || (Node == O.Node && ResNo < O.ResNo);
891 SDValue getValue(unsigned R) const {
892 return SDValue(Node, R);
895 // isOperandOf - Return true if this node is an operand of N.
896 bool isOperandOf(SDNode *N) const;
898 /// getValueType - Return the ValueType of the referenced return value.
900 inline MVT getValueType() const;
902 /// getValueSizeInBits - Returns the size of the value in bits.
904 unsigned getValueSizeInBits() const {
905 return getValueType().getSizeInBits();
908 // Forwarding methods - These forward to the corresponding methods in SDNode.
909 inline unsigned getOpcode() const;
910 inline unsigned getNumOperands() const;
911 inline const SDValue &getOperand(unsigned i) const;
912 inline uint64_t getConstantOperandVal(unsigned i) const;
913 inline bool isTargetOpcode() const;
914 inline bool isMachineOpcode() const;
915 inline unsigned getMachineOpcode() const;
916 inline const DebugLoc getDebugLoc() const;
919 /// reachesChainWithoutSideEffects - Return true if this operand (which must
920 /// be a chain) reaches the specified operand without crossing any
921 /// side-effecting instructions. In practice, this looks through token
922 /// factors and non-volatile loads. In order to remain efficient, this only
923 /// looks a couple of nodes in, it does not do an exhaustive search.
924 bool reachesChainWithoutSideEffects(SDValue Dest,
925 unsigned Depth = 2) const;
927 /// use_empty - Return true if there are no nodes using value ResNo
930 inline bool use_empty() const;
932 /// hasOneUse - Return true if there is exactly one node using value
935 inline bool hasOneUse() const;
939 template<> struct DenseMapInfo<SDValue> {
940 static inline SDValue getEmptyKey() {
941 return SDValue((SDNode*)-1, -1U);
943 static inline SDValue getTombstoneKey() {
944 return SDValue((SDNode*)-1, 0);
946 static unsigned getHashValue(const SDValue &Val) {
947 return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
948 (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
950 static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
953 static bool isPod() { return true; }
956 /// simplify_type specializations - Allow casting operators to work directly on
957 /// SDValues as if they were SDNode*'s.
958 template<> struct simplify_type<SDValue> {
959 typedef SDNode* SimpleType;
960 static SimpleType getSimplifiedValue(const SDValue &Val) {
961 return static_cast<SimpleType>(Val.getNode());
964 template<> struct simplify_type<const SDValue> {
965 typedef SDNode* SimpleType;
966 static SimpleType getSimplifiedValue(const SDValue &Val) {
967 return static_cast<SimpleType>(Val.getNode());
971 /// SDUse - Represents a use of a SDNode. This class holds an SDValue,
972 /// which records the SDNode being used and the result number, a
973 /// pointer to the SDNode using the value, and Next and Prev pointers,
974 /// which link together all the uses of an SDNode.
977 /// Val - The value being used.
979 /// User - The user of this value.
981 /// Prev, Next - Pointers to the uses list of the SDNode referred by
985 SDUse(const SDUse &U); // Do not implement
986 void operator=(const SDUse &U); // Do not implement
989 SDUse() : Val(), User(NULL), Prev(NULL), Next(NULL) {}
991 /// Normally SDUse will just implicitly convert to an SDValue that it holds.
992 operator const SDValue&() const { return Val; }
994 /// If implicit conversion to SDValue doesn't work, the get() method returns
996 const SDValue &get() const { return Val; }
998 /// getUser - This returns the SDNode that contains this Use.
999 SDNode *getUser() { return User; }
1001 /// getNext - Get the next SDUse in the use list.
1002 SDUse *getNext() const { return Next; }
1004 /// getNode - Convenience function for get().getNode().
1005 SDNode *getNode() const { return Val.getNode(); }
1006 /// getResNo - Convenience function for get().getResNo().
1007 unsigned getResNo() const { return Val.getResNo(); }
1008 /// getValueType - Convenience function for get().getValueType().
1009 MVT getValueType() const { return Val.getValueType(); }
1011 /// operator== - Convenience function for get().operator==
1012 bool operator==(const SDValue &V) const {
1016 /// operator!= - Convenience function for get().operator!=
1017 bool operator!=(const SDValue &V) const {
1021 /// operator< - Convenience function for get().operator<
1022 bool operator<(const SDValue &V) const {
1027 friend class SelectionDAG;
1028 friend class SDNode;
1030 void setUser(SDNode *p) { User = p; }
1032 /// set - Remove this use from its existing use list, assign it the
1033 /// given value, and add it to the new value's node's use list.
1034 inline void set(const SDValue &V);
1035 /// setInitial - like set, but only supports initializing a newly-allocated
1036 /// SDUse with a non-null value.
1037 inline void setInitial(const SDValue &V);
1038 /// setNode - like set, but only sets the Node portion of the value,
1039 /// leaving the ResNo portion unmodified.
1040 inline void setNode(SDNode *N);
1042 void addToList(SDUse **List) {
1044 if (Next) Next->Prev = &Next;
1049 void removeFromList() {
1051 if (Next) Next->Prev = Prev;
1055 /// simplify_type specializations - Allow casting operators to work directly on
1056 /// SDValues as if they were SDNode*'s.
1057 template<> struct simplify_type<SDUse> {
1058 typedef SDNode* SimpleType;
1059 static SimpleType getSimplifiedValue(const SDUse &Val) {
1060 return static_cast<SimpleType>(Val.getNode());
1063 template<> struct simplify_type<const SDUse> {
1064 typedef SDNode* SimpleType;
1065 static SimpleType getSimplifiedValue(const SDUse &Val) {
1066 return static_cast<SimpleType>(Val.getNode());
1071 /// SDNode - Represents one node in the SelectionDAG.
1073 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
1075 /// NodeType - The operation that this node performs.
1079 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
1080 /// then they will be delete[]'d when the node is destroyed.
1081 unsigned short OperandsNeedDelete : 1;
1084 /// SubclassData - This member is defined by this class, but is not used for
1085 /// anything. Subclasses can use it to hold whatever state they find useful.
1086 /// This field is initialized to zero by the ctor.
1087 unsigned short SubclassData : 15;
1090 /// NodeId - Unique id per SDNode in the DAG.
1093 /// OperandList - The values that are used by this operation.
1097 /// ValueList - The types of the values this node defines. SDNode's may
1098 /// define multiple values simultaneously.
1099 const MVT *ValueList;
1101 /// UseList - List of uses for this SDNode.
1104 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
1105 unsigned short NumOperands, NumValues;
1107 /// debugLoc - source line information.
1110 /// getValueTypeList - Return a pointer to the specified value type.
1111 static const MVT *getValueTypeList(MVT VT);
1113 friend class SelectionDAG;
1114 friend struct ilist_traits<SDNode>;
1117 //===--------------------------------------------------------------------===//
1121 /// getOpcode - Return the SelectionDAG opcode value for this node. For
1122 /// pre-isel nodes (those for which isMachineOpcode returns false), these
1123 /// are the opcode values in the ISD and <target>ISD namespaces. For
1124 /// post-isel opcodes, see getMachineOpcode.
1125 unsigned getOpcode() const { return (unsigned short)NodeType; }
1127 /// isTargetOpcode - Test if this node has a target-specific opcode (in the
1128 /// \<target\>ISD namespace).
1129 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
1131 /// isMachineOpcode - Test if this node has a post-isel opcode, directly
1132 /// corresponding to a MachineInstr opcode.
1133 bool isMachineOpcode() const { return NodeType < 0; }
1135 /// getMachineOpcode - This may only be called if isMachineOpcode returns
1136 /// true. It returns the MachineInstr opcode value that the node's opcode
1138 unsigned getMachineOpcode() const {
1139 assert(isMachineOpcode() && "Not a MachineInstr opcode!");
1143 /// use_empty - Return true if there are no uses of this node.
1145 bool use_empty() const { return UseList == NULL; }
1147 /// hasOneUse - Return true if there is exactly one use of this node.
1149 bool hasOneUse() const {
1150 return !use_empty() && next(use_begin()) == use_end();
1153 /// use_size - Return the number of uses of this node. This method takes
1154 /// time proportional to the number of uses.
1156 size_t use_size() const { return std::distance(use_begin(), use_end()); }
1158 /// getNodeId - Return the unique node id.
1160 int getNodeId() const { return NodeId; }
1162 /// setNodeId - Set unique node id.
1163 void setNodeId(int Id) { NodeId = Id; }
1165 /// getDebugLoc - Return the source location info.
1166 const DebugLoc getDebugLoc() const { return debugLoc; }
1168 /// setDebugLoc - Set source location info. Try to avoid this, putting
1169 /// it in the constructor is preferable.
1170 void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
1172 /// use_iterator - This class provides iterator support for SDUse
1173 /// operands that use a specific SDNode.
1175 : public forward_iterator<SDUse, ptrdiff_t> {
1177 explicit use_iterator(SDUse *op) : Op(op) {
1179 friend class SDNode;
1181 typedef forward_iterator<SDUse, ptrdiff_t>::reference reference;
1182 typedef forward_iterator<SDUse, ptrdiff_t>::pointer pointer;
1184 use_iterator(const use_iterator &I) : Op(I.Op) {}
1185 use_iterator() : Op(0) {}
1187 bool operator==(const use_iterator &x) const {
1190 bool operator!=(const use_iterator &x) const {
1191 return !operator==(x);
1194 /// atEnd - return true if this iterator is at the end of uses list.
1195 bool atEnd() const { return Op == 0; }
1197 // Iterator traversal: forward iteration only.
1198 use_iterator &operator++() { // Preincrement
1199 assert(Op && "Cannot increment end iterator!");
1204 use_iterator operator++(int) { // Postincrement
1205 use_iterator tmp = *this; ++*this; return tmp;
1208 /// Retrieve a pointer to the current user node.
1209 SDNode *operator*() const {
1210 assert(Op && "Cannot dereference end iterator!");
1211 return Op->getUser();
1214 SDNode *operator->() const { return operator*(); }
1216 SDUse &getUse() const { return *Op; }
1218 /// getOperandNo - Retrieve the operand # of this use in its user.
1220 unsigned getOperandNo() const {
1221 assert(Op && "Cannot dereference end iterator!");
1222 return (unsigned)(Op - Op->getUser()->OperandList);
1226 /// use_begin/use_end - Provide iteration support to walk over all uses
1229 use_iterator use_begin() const {
1230 return use_iterator(UseList);
1233 static use_iterator use_end() { return use_iterator(0); }
1236 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
1237 /// indicated value. This method ignores uses of other values defined by this
1239 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
1241 /// hasAnyUseOfValue - Return true if there are any use of the indicated
1242 /// value. This method ignores uses of other values defined by this operation.
1243 bool hasAnyUseOfValue(unsigned Value) const;
1245 /// isOnlyUserOf - Return true if this node is the only use of N.
1247 bool isOnlyUserOf(SDNode *N) const;
1249 /// isOperandOf - Return true if this node is an operand of N.
1251 bool isOperandOf(SDNode *N) const;
1253 /// isPredecessorOf - Return true if this node is a predecessor of N. This
1254 /// node is either an operand of N or it can be reached by recursively
1255 /// traversing up the operands.
1256 /// NOTE: this is an expensive method. Use it carefully.
1257 bool isPredecessorOf(SDNode *N) const;
1259 /// getNumOperands - Return the number of values used by this operation.
1261 unsigned getNumOperands() const { return NumOperands; }
1263 /// getConstantOperandVal - Helper method returns the integer value of a
1264 /// ConstantSDNode operand.
1265 uint64_t getConstantOperandVal(unsigned Num) const;
1267 const SDValue &getOperand(unsigned Num) const {
1268 assert(Num < NumOperands && "Invalid child # of SDNode!");
1269 return OperandList[Num];
1272 typedef SDUse* op_iterator;
1273 op_iterator op_begin() const { return OperandList; }
1274 op_iterator op_end() const { return OperandList+NumOperands; }
1276 SDVTList getVTList() const {
1277 SDVTList X = { ValueList, NumValues };
1281 /// getFlaggedNode - If this node has a flag operand, return the node
1282 /// to which the flag operand points. Otherwise return NULL.
1283 SDNode *getFlaggedNode() const {
1284 if (getNumOperands() != 0 &&
1285 getOperand(getNumOperands()-1).getValueType() == MVT::Flag)
1286 return getOperand(getNumOperands()-1).getNode();
1290 // If this is a pseudo op, like copyfromreg, look to see if there is a
1291 // real target node flagged to it. If so, return the target node.
1292 const SDNode *getFlaggedMachineNode() const {
1293 const SDNode *FoundNode = this;
1295 // Climb up flag edges until a machine-opcode node is found, or the
1296 // end of the chain is reached.
1297 while (!FoundNode->isMachineOpcode()) {
1298 const SDNode *N = FoundNode->getFlaggedNode();
1306 /// getNumValues - Return the number of values defined/returned by this
1309 unsigned getNumValues() const { return NumValues; }
1311 /// getValueType - Return the type of a specified result.
1313 MVT getValueType(unsigned ResNo) const {
1314 assert(ResNo < NumValues && "Illegal result number!");
1315 return ValueList[ResNo];
1318 /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType(ResNo)).
1320 unsigned getValueSizeInBits(unsigned ResNo) const {
1321 return getValueType(ResNo).getSizeInBits();
1324 typedef const MVT* value_iterator;
1325 value_iterator value_begin() const { return ValueList; }
1326 value_iterator value_end() const { return ValueList+NumValues; }
1328 /// getOperationName - Return the opcode of this operation for printing.
1330 std::string getOperationName(const SelectionDAG *G = 0) const;
1331 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
1332 void print_types(raw_ostream &OS, const SelectionDAG *G) const;
1333 void print_details(raw_ostream &OS, const SelectionDAG *G) const;
1334 void print(raw_ostream &OS, const SelectionDAG *G = 0) const;
1335 void printr(raw_ostream &OS, const SelectionDAG *G = 0) const;
1338 void dump(const SelectionDAG *G) const;
1340 static bool classof(const SDNode *) { return true; }
1342 /// Profile - Gather unique data for the node.
1344 void Profile(FoldingSetNodeID &ID) const;
1346 /// addUse - This method should only be used by the SDUse class.
1348 void addUse(SDUse &U) { U.addToList(&UseList); }
1351 static SDVTList getSDVTList(MVT VT) {
1352 SDVTList Ret = { getValueTypeList(VT), 1 };
1356 SDNode(unsigned Opc, const DebugLoc dl, SDVTList VTs, const SDValue *Ops,
1358 : NodeType(Opc), OperandsNeedDelete(true), SubclassData(0),
1360 OperandList(NumOps ? new SDUse[NumOps] : 0),
1361 ValueList(VTs.VTs), UseList(NULL),
1362 NumOperands(NumOps), NumValues(VTs.NumVTs),
1364 for (unsigned i = 0; i != NumOps; ++i) {
1365 OperandList[i].setUser(this);
1366 OperandList[i].setInitial(Ops[i]);
1370 /// This constructor adds no operands itself; operands can be
1371 /// set later with InitOperands.
1372 SDNode(unsigned Opc, const DebugLoc dl, SDVTList VTs)
1373 : NodeType(Opc), OperandsNeedDelete(false), SubclassData(0),
1374 NodeId(-1), OperandList(0), ValueList(VTs.VTs), UseList(NULL),
1375 NumOperands(0), NumValues(VTs.NumVTs),
1378 /// InitOperands - Initialize the operands list of this with 1 operand.
1379 void InitOperands(SDUse *Ops, const SDValue &Op0) {
1380 Ops[0].setUser(this);
1381 Ops[0].setInitial(Op0);
1386 /// InitOperands - Initialize the operands list of this with 2 operands.
1387 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1) {
1388 Ops[0].setUser(this);
1389 Ops[0].setInitial(Op0);
1390 Ops[1].setUser(this);
1391 Ops[1].setInitial(Op1);
1396 /// InitOperands - Initialize the operands list of this with 3 operands.
1397 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
1398 const SDValue &Op2) {
1399 Ops[0].setUser(this);
1400 Ops[0].setInitial(Op0);
1401 Ops[1].setUser(this);
1402 Ops[1].setInitial(Op1);
1403 Ops[2].setUser(this);
1404 Ops[2].setInitial(Op2);
1409 /// InitOperands - Initialize the operands list of this with 4 operands.
1410 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
1411 const SDValue &Op2, const SDValue &Op3) {
1412 Ops[0].setUser(this);
1413 Ops[0].setInitial(Op0);
1414 Ops[1].setUser(this);
1415 Ops[1].setInitial(Op1);
1416 Ops[2].setUser(this);
1417 Ops[2].setInitial(Op2);
1418 Ops[3].setUser(this);
1419 Ops[3].setInitial(Op3);
1424 /// InitOperands - Initialize the operands list of this with N operands.
1425 void InitOperands(SDUse *Ops, const SDValue *Vals, unsigned N) {
1426 for (unsigned i = 0; i != N; ++i) {
1427 Ops[i].setUser(this);
1428 Ops[i].setInitial(Vals[i]);
1434 /// DropOperands - Release the operands and set this node to have
1436 void DropOperands();
1440 // Define inline functions from the SDValue class.
1442 inline unsigned SDValue::getOpcode() const {
1443 return Node->getOpcode();
1445 inline MVT SDValue::getValueType() const {
1446 return Node->getValueType(ResNo);
1448 inline unsigned SDValue::getNumOperands() const {
1449 return Node->getNumOperands();
1451 inline const SDValue &SDValue::getOperand(unsigned i) const {
1452 return Node->getOperand(i);
1454 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
1455 return Node->getConstantOperandVal(i);
1457 inline bool SDValue::isTargetOpcode() const {
1458 return Node->isTargetOpcode();
1460 inline bool SDValue::isMachineOpcode() const {
1461 return Node->isMachineOpcode();
1463 inline unsigned SDValue::getMachineOpcode() const {
1464 return Node->getMachineOpcode();
1466 inline bool SDValue::use_empty() const {
1467 return !Node->hasAnyUseOfValue(ResNo);
1469 inline bool SDValue::hasOneUse() const {
1470 return Node->hasNUsesOfValue(1, ResNo);
1472 inline const DebugLoc SDValue::getDebugLoc() const {
1473 return Node->getDebugLoc();
1476 // Define inline functions from the SDUse class.
1478 inline void SDUse::set(const SDValue &V) {
1479 if (Val.getNode()) removeFromList();
1481 if (V.getNode()) V.getNode()->addUse(*this);
1484 inline void SDUse::setInitial(const SDValue &V) {
1486 V.getNode()->addUse(*this);
1489 inline void SDUse::setNode(SDNode *N) {
1490 if (Val.getNode()) removeFromList();
1492 if (N) N->addUse(*this);
1495 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
1496 /// to allow co-allocation of node operands with the node itself.
1497 class UnarySDNode : public SDNode {
1500 UnarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X)
1501 : SDNode(Opc, dl, VTs) {
1502 InitOperands(&Op, X);
1506 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
1507 /// to allow co-allocation of node operands with the node itself.
1508 class BinarySDNode : public SDNode {
1511 BinarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X, SDValue Y)
1512 : SDNode(Opc, dl, VTs) {
1513 InitOperands(Ops, X, Y);
1517 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
1518 /// to allow co-allocation of node operands with the node itself.
1519 class TernarySDNode : public SDNode {
1522 TernarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X, SDValue Y,
1524 : SDNode(Opc, dl, VTs) {
1525 InitOperands(Ops, X, Y, Z);
1530 /// HandleSDNode - This class is used to form a handle around another node that
1531 /// is persistant and is updated across invocations of replaceAllUsesWith on its
1532 /// operand. This node should be directly created by end-users and not added to
1533 /// the AllNodes list.
1534 class HandleSDNode : public SDNode {
1537 // FIXME: Remove the "noinline" attribute once <rdar://problem/5852746> is
1540 explicit __attribute__((__noinline__)) HandleSDNode(SDValue X)
1542 explicit HandleSDNode(SDValue X)
1544 : SDNode(ISD::HANDLENODE, DebugLoc::getUnknownLoc(),
1545 getSDVTList(MVT::Other)) {
1546 InitOperands(&Op, X);
1549 const SDValue &getValue() const { return Op; }
1552 /// Abstact virtual class for operations for memory operations
1553 class MemSDNode : public SDNode {
1555 // MemoryVT - VT of in-memory value.
1558 //! SrcValue - Memory location for alias analysis.
1559 const Value *SrcValue;
1561 //! SVOffset - Memory location offset. Note that base is defined in MemSDNode
1565 MemSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, MVT MemoryVT,
1566 const Value *srcValue, int SVOff,
1567 unsigned alignment, bool isvolatile);
1569 MemSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, const SDValue *Ops,
1570 unsigned NumOps, MVT MemoryVT, const Value *srcValue, int SVOff,
1571 unsigned alignment, bool isvolatile);
1573 /// Returns alignment and volatility of the memory access
1574 unsigned getAlignment() const { return (1u << (SubclassData >> 6)) >> 1; }
1575 bool isVolatile() const { return (SubclassData >> 5) & 1; }
1577 /// getRawSubclassData - Return the SubclassData value, which contains an
1578 /// encoding of the alignment and volatile information, as well as bits
1579 /// used by subclasses. This function should only be used to compute a
1580 /// FoldingSetNodeID value.
1581 unsigned getRawSubclassData() const {
1582 return SubclassData;
1585 /// Returns the SrcValue and offset that describes the location of the access
1586 const Value *getSrcValue() const { return SrcValue; }
1587 int getSrcValueOffset() const { return SVOffset; }
1589 /// getMemoryVT - Return the type of the in-memory value.
1590 MVT getMemoryVT() const { return MemoryVT; }
1592 /// getMemOperand - Return a MachineMemOperand object describing the memory
1593 /// reference performed by operation.
1594 MachineMemOperand getMemOperand() const;
1596 const SDValue &getChain() const { return getOperand(0); }
1597 const SDValue &getBasePtr() const {
1598 return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
1601 // Methods to support isa and dyn_cast
1602 static bool classof(const MemSDNode *) { return true; }
1603 static bool classof(const SDNode *N) {
1604 // For some targets, we lower some target intrinsics to a MemIntrinsicNode
1605 // with either an intrinsic or a target opcode.
1606 return N->getOpcode() == ISD::LOAD ||
1607 N->getOpcode() == ISD::STORE ||
1608 N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1609 N->getOpcode() == ISD::ATOMIC_SWAP ||
1610 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1611 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1612 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1613 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1614 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1615 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1616 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1617 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1618 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1619 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1620 N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1621 N->getOpcode() == ISD::INTRINSIC_VOID ||
1622 N->isTargetOpcode();
1626 /// AtomicSDNode - A SDNode reprenting atomic operations.
1628 class AtomicSDNode : public MemSDNode {
1632 // Opc: opcode for atomic
1633 // VTL: value type list
1634 // Chain: memory chain for operaand
1635 // Ptr: address to update as a SDValue
1636 // Cmp: compare value
1638 // SrcVal: address to update as a Value (used for MemOperand)
1639 // Align: alignment of memory
1640 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, MVT MemVT,
1641 SDValue Chain, SDValue Ptr,
1642 SDValue Cmp, SDValue Swp, const Value* SrcVal,
1644 : MemSDNode(Opc, dl, VTL, MemVT, SrcVal, /*SVOffset=*/0,
1645 Align, /*isVolatile=*/true) {
1646 InitOperands(Ops, Chain, Ptr, Cmp, Swp);
1648 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, MVT MemVT,
1649 SDValue Chain, SDValue Ptr,
1650 SDValue Val, const Value* SrcVal, unsigned Align=0)
1651 : MemSDNode(Opc, dl, VTL, MemVT, SrcVal, /*SVOffset=*/0,
1652 Align, /*isVolatile=*/true) {
1653 InitOperands(Ops, Chain, Ptr, Val);
1656 const SDValue &getBasePtr() const { return getOperand(1); }
1657 const SDValue &getVal() const { return getOperand(2); }
1659 bool isCompareAndSwap() const {
1660 unsigned Op = getOpcode();
1661 return Op == ISD::ATOMIC_CMP_SWAP;
1664 // Methods to support isa and dyn_cast
1665 static bool classof(const AtomicSDNode *) { return true; }
1666 static bool classof(const SDNode *N) {
1667 return N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1668 N->getOpcode() == ISD::ATOMIC_SWAP ||
1669 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1670 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1671 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1672 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1673 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1674 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1675 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1676 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1677 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1678 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX;
1682 /// MemIntrinsicSDNode - This SDNode is used for target intrinsic that touches
1683 /// memory and need an associated memory operand.
1685 class MemIntrinsicSDNode : public MemSDNode {
1686 bool ReadMem; // Intrinsic reads memory
1687 bool WriteMem; // Intrinsic writes memory
1689 MemIntrinsicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs,
1690 const SDValue *Ops, unsigned NumOps,
1691 MVT MemoryVT, const Value *srcValue, int SVO,
1692 unsigned Align, bool Vol, bool ReadMem, bool WriteMem)
1693 : MemSDNode(Opc, dl, VTs, Ops, NumOps, MemoryVT, srcValue, SVO, Align, Vol),
1694 ReadMem(ReadMem), WriteMem(WriteMem) {
1697 bool readMem() const { return ReadMem; }
1698 bool writeMem() const { return WriteMem; }
1700 // Methods to support isa and dyn_cast
1701 static bool classof(const MemIntrinsicSDNode *) { return true; }
1702 static bool classof(const SDNode *N) {
1703 // We lower some target intrinsics to their target opcode
1704 // early a node with a target opcode can be of this class
1705 return N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1706 N->getOpcode() == ISD::INTRINSIC_VOID ||
1707 N->isTargetOpcode();
1711 class ConstantSDNode : public SDNode {
1712 const ConstantInt *Value;
1714 friend class SelectionDAG;
1715 ConstantSDNode(bool isTarget, const ConstantInt *val, MVT VT)
1716 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant,
1717 DebugLoc::getUnknownLoc(), getSDVTList(VT)), Value(val) {
1721 const ConstantInt *getConstantIntValue() const { return Value; }
1722 const APInt &getAPIntValue() const { return Value->getValue(); }
1723 uint64_t getZExtValue() const { return Value->getZExtValue(); }
1724 int64_t getSExtValue() const { return Value->getSExtValue(); }
1726 bool isNullValue() const { return Value->isNullValue(); }
1727 bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1729 static bool classof(const ConstantSDNode *) { return true; }
1730 static bool classof(const SDNode *N) {
1731 return N->getOpcode() == ISD::Constant ||
1732 N->getOpcode() == ISD::TargetConstant;
1736 class ConstantFPSDNode : public SDNode {
1737 const ConstantFP *Value;
1739 friend class SelectionDAG;
1740 ConstantFPSDNode(bool isTarget, const ConstantFP *val, MVT VT)
1741 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1742 DebugLoc::getUnknownLoc(), getSDVTList(VT)), Value(val) {
1746 const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1747 const ConstantFP *getConstantFPValue() const { return Value; }
1749 /// isExactlyValue - We don't rely on operator== working on double values, as
1750 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1751 /// As such, this method can be used to do an exact bit-for-bit comparison of
1752 /// two floating point values.
1754 /// We leave the version with the double argument here because it's just so
1755 /// convenient to write "2.0" and the like. Without this function we'd
1756 /// have to duplicate its logic everywhere it's called.
1757 bool isExactlyValue(double V) const {
1759 // convert is not supported on this type
1760 if (&Value->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
1763 Tmp.convert(Value->getValueAPF().getSemantics(),
1764 APFloat::rmNearestTiesToEven, &ignored);
1765 return isExactlyValue(Tmp);
1767 bool isExactlyValue(const APFloat& V) const;
1769 bool isValueValidForType(MVT VT, const APFloat& Val);
1771 static bool classof(const ConstantFPSDNode *) { return true; }
1772 static bool classof(const SDNode *N) {
1773 return N->getOpcode() == ISD::ConstantFP ||
1774 N->getOpcode() == ISD::TargetConstantFP;
1778 class GlobalAddressSDNode : public SDNode {
1779 GlobalValue *TheGlobal;
1782 friend class SelectionDAG;
1783 GlobalAddressSDNode(bool isTarget, const GlobalValue *GA, MVT VT,
1787 GlobalValue *getGlobal() const { return TheGlobal; }
1788 int64_t getOffset() const { return Offset; }
1790 static bool classof(const GlobalAddressSDNode *) { return true; }
1791 static bool classof(const SDNode *N) {
1792 return N->getOpcode() == ISD::GlobalAddress ||
1793 N->getOpcode() == ISD::TargetGlobalAddress ||
1794 N->getOpcode() == ISD::GlobalTLSAddress ||
1795 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1799 class FrameIndexSDNode : public SDNode {
1802 friend class SelectionDAG;
1803 FrameIndexSDNode(int fi, MVT VT, bool isTarg)
1804 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex,
1805 DebugLoc::getUnknownLoc(), getSDVTList(VT)), FI(fi) {
1809 int getIndex() const { return FI; }
1811 static bool classof(const FrameIndexSDNode *) { return true; }
1812 static bool classof(const SDNode *N) {
1813 return N->getOpcode() == ISD::FrameIndex ||
1814 N->getOpcode() == ISD::TargetFrameIndex;
1818 class JumpTableSDNode : public SDNode {
1821 friend class SelectionDAG;
1822 JumpTableSDNode(int jti, MVT VT, bool isTarg)
1823 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable,
1824 DebugLoc::getUnknownLoc(), getSDVTList(VT)), JTI(jti) {
1828 int getIndex() const { return JTI; }
1830 static bool classof(const JumpTableSDNode *) { return true; }
1831 static bool classof(const SDNode *N) {
1832 return N->getOpcode() == ISD::JumpTable ||
1833 N->getOpcode() == ISD::TargetJumpTable;
1837 class ConstantPoolSDNode : public SDNode {
1840 MachineConstantPoolValue *MachineCPVal;
1842 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1843 unsigned Alignment; // Minimum alignment requirement of CP (not log2 value).
1845 friend class SelectionDAG;
1846 ConstantPoolSDNode(bool isTarget, Constant *c, MVT VT, int o=0)
1847 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1848 DebugLoc::getUnknownLoc(),
1849 getSDVTList(VT)), Offset(o), Alignment(0) {
1850 assert((int)Offset >= 0 && "Offset is too large");
1853 ConstantPoolSDNode(bool isTarget, Constant *c, MVT VT, int o, unsigned Align)
1854 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1855 DebugLoc::getUnknownLoc(),
1856 getSDVTList(VT)), Offset(o), Alignment(Align) {
1857 assert((int)Offset >= 0 && "Offset is too large");
1860 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1862 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1863 DebugLoc::getUnknownLoc(),
1864 getSDVTList(VT)), Offset(o), Alignment(0) {
1865 assert((int)Offset >= 0 && "Offset is too large");
1866 Val.MachineCPVal = v;
1867 Offset |= 1 << (sizeof(unsigned)*8-1);
1869 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1870 MVT VT, int o, unsigned Align)
1871 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1872 DebugLoc::getUnknownLoc(),
1873 getSDVTList(VT)), Offset(o), Alignment(Align) {
1874 assert((int)Offset >= 0 && "Offset is too large");
1875 Val.MachineCPVal = v;
1876 Offset |= 1 << (sizeof(unsigned)*8-1);
1880 bool isMachineConstantPoolEntry() const {
1881 return (int)Offset < 0;
1884 Constant *getConstVal() const {
1885 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1886 return Val.ConstVal;
1889 MachineConstantPoolValue *getMachineCPVal() const {
1890 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1891 return Val.MachineCPVal;
1894 int getOffset() const {
1895 return Offset & ~(1 << (sizeof(unsigned)*8-1));
1898 // Return the alignment of this constant pool object, which is either 0 (for
1899 // default alignment) or the desired value.
1900 unsigned getAlignment() const { return Alignment; }
1902 const Type *getType() const;
1904 static bool classof(const ConstantPoolSDNode *) { return true; }
1905 static bool classof(const SDNode *N) {
1906 return N->getOpcode() == ISD::ConstantPool ||
1907 N->getOpcode() == ISD::TargetConstantPool;
1911 class BasicBlockSDNode : public SDNode {
1912 MachineBasicBlock *MBB;
1914 friend class SelectionDAG;
1915 /// Debug info is meaningful and potentially useful here, but we create
1916 /// blocks out of order when they're jumped to, which makes it a bit
1917 /// harder. Let's see if we need it first.
1918 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1919 : SDNode(ISD::BasicBlock, DebugLoc::getUnknownLoc(),
1920 getSDVTList(MVT::Other)), MBB(mbb) {
1924 MachineBasicBlock *getBasicBlock() const { return MBB; }
1926 static bool classof(const BasicBlockSDNode *) { return true; }
1927 static bool classof(const SDNode *N) {
1928 return N->getOpcode() == ISD::BasicBlock;
1932 /// BuildVectorSDNode - A "pseudo-class" with methods for operating on
1934 class BuildVectorSDNode : public SDNode {
1935 // These are constructed as SDNodes and then cast to BuildVectorSDNodes.
1936 explicit BuildVectorSDNode(); // Do not implement
1938 /// isConstantSplat - Check if this is a constant splat, and if so, find the
1939 /// smallest element size that splats the vector. If MinSplatBits is
1940 /// nonzero, the element size must be at least that large. Note that the
1941 /// splat element may be the entire vector (i.e., a one element vector).
1942 /// Returns the splat element value in SplatValue. Any undefined bits in
1943 /// that value are zero, and the corresponding bits in the SplatUndef mask
1944 /// are set. The SplatBitSize value is set to the splat element size in
1945 /// bits. HasAnyUndefs is set to true if any bits in the vector are
1947 bool isConstantSplat(APInt &SplatValue, APInt &SplatUndef,
1948 unsigned &SplatBitSize, bool &HasAnyUndefs,
1949 unsigned MinSplatBits = 0);
1951 static inline bool classof(const BuildVectorSDNode *) { return true; }
1952 static inline bool classof(const SDNode *N) {
1953 return N->getOpcode() == ISD::BUILD_VECTOR;
1957 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1958 /// used when the SelectionDAG needs to make a simple reference to something
1959 /// in the LLVM IR representation.
1961 /// Note that this is not used for carrying alias information; that is done
1962 /// with MemOperandSDNode, which includes a Value which is required to be a
1963 /// pointer, and several other fields specific to memory references.
1965 class SrcValueSDNode : public SDNode {
1968 friend class SelectionDAG;
1969 /// Create a SrcValue for a general value.
1970 explicit SrcValueSDNode(const Value *v)
1971 : SDNode(ISD::SRCVALUE, DebugLoc::getUnknownLoc(),
1972 getSDVTList(MVT::Other)), V(v) {}
1975 /// getValue - return the contained Value.
1976 const Value *getValue() const { return V; }
1978 static bool classof(const SrcValueSDNode *) { return true; }
1979 static bool classof(const SDNode *N) {
1980 return N->getOpcode() == ISD::SRCVALUE;
1985 /// MemOperandSDNode - An SDNode that holds a MachineMemOperand. This is
1986 /// used to represent a reference to memory after ISD::LOAD
1987 /// and ISD::STORE have been lowered.
1989 class MemOperandSDNode : public SDNode {
1991 friend class SelectionDAG;
1992 /// Create a MachineMemOperand node
1993 explicit MemOperandSDNode(const MachineMemOperand &mo)
1994 : SDNode(ISD::MEMOPERAND, DebugLoc::getUnknownLoc(),
1995 getSDVTList(MVT::Other)), MO(mo) {}
1998 /// MO - The contained MachineMemOperand.
1999 const MachineMemOperand MO;
2001 static bool classof(const MemOperandSDNode *) { return true; }
2002 static bool classof(const SDNode *N) {
2003 return N->getOpcode() == ISD::MEMOPERAND;
2008 class RegisterSDNode : public SDNode {
2011 friend class SelectionDAG;
2012 RegisterSDNode(unsigned reg, MVT VT)
2013 : SDNode(ISD::Register, DebugLoc::getUnknownLoc(),
2014 getSDVTList(VT)), Reg(reg) {
2018 unsigned getReg() const { return Reg; }
2020 static bool classof(const RegisterSDNode *) { return true; }
2021 static bool classof(const SDNode *N) {
2022 return N->getOpcode() == ISD::Register;
2026 class DbgStopPointSDNode : public SDNode {
2032 friend class SelectionDAG;
2033 DbgStopPointSDNode(SDValue ch, unsigned l, unsigned c,
2035 : SDNode(ISD::DBG_STOPPOINT, DebugLoc::getUnknownLoc(),
2036 getSDVTList(MVT::Other)), Line(l), Column(c), CU(cu) {
2037 InitOperands(&Chain, ch);
2040 unsigned getLine() const { return Line; }
2041 unsigned getColumn() const { return Column; }
2042 Value *getCompileUnit() const { return CU; }
2044 static bool classof(const DbgStopPointSDNode *) { return true; }
2045 static bool classof(const SDNode *N) {
2046 return N->getOpcode() == ISD::DBG_STOPPOINT;
2050 class LabelSDNode : public SDNode {
2054 friend class SelectionDAG;
2055 LabelSDNode(unsigned NodeTy, DebugLoc dl, SDValue ch, unsigned id)
2056 : SDNode(NodeTy, dl, getSDVTList(MVT::Other)), LabelID(id) {
2057 InitOperands(&Chain, ch);
2060 unsigned getLabelID() const { return LabelID; }
2062 static bool classof(const LabelSDNode *) { return true; }
2063 static bool classof(const SDNode *N) {
2064 return N->getOpcode() == ISD::DBG_LABEL ||
2065 N->getOpcode() == ISD::EH_LABEL;
2069 class ExternalSymbolSDNode : public SDNode {
2072 friend class SelectionDAG;
2073 ExternalSymbolSDNode(bool isTarget, const char *Sym, MVT VT)
2074 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
2075 DebugLoc::getUnknownLoc(),
2076 getSDVTList(VT)), Symbol(Sym) {
2080 const char *getSymbol() const { return Symbol; }
2082 static bool classof(const ExternalSymbolSDNode *) { return true; }
2083 static bool classof(const SDNode *N) {
2084 return N->getOpcode() == ISD::ExternalSymbol ||
2085 N->getOpcode() == ISD::TargetExternalSymbol;
2089 class CondCodeSDNode : public SDNode {
2090 ISD::CondCode Condition;
2092 friend class SelectionDAG;
2093 explicit CondCodeSDNode(ISD::CondCode Cond)
2094 : SDNode(ISD::CONDCODE, DebugLoc::getUnknownLoc(),
2095 getSDVTList(MVT::Other)), Condition(Cond) {
2099 ISD::CondCode get() const { return Condition; }
2101 static bool classof(const CondCodeSDNode *) { return true; }
2102 static bool classof(const SDNode *N) {
2103 return N->getOpcode() == ISD::CONDCODE;
2107 /// CvtRndSatSDNode - NOTE: avoid using this node as this may disappear in the
2108 /// future and most targets don't support it.
2109 class CvtRndSatSDNode : public SDNode {
2110 ISD::CvtCode CvtCode;
2112 friend class SelectionDAG;
2113 explicit CvtRndSatSDNode(MVT VT, DebugLoc dl, const SDValue *Ops,
2114 unsigned NumOps, ISD::CvtCode Code)
2115 : SDNode(ISD::CONVERT_RNDSAT, dl, getSDVTList(VT), Ops, NumOps),
2117 assert(NumOps == 5 && "wrong number of operations");
2120 ISD::CvtCode getCvtCode() const { return CvtCode; }
2122 static bool classof(const CvtRndSatSDNode *) { return true; }
2123 static bool classof(const SDNode *N) {
2124 return N->getOpcode() == ISD::CONVERT_RNDSAT;
2131 static const uint64_t NoFlagSet = 0ULL;
2132 static const uint64_t ZExt = 1ULL<<0; ///< Zero extended
2133 static const uint64_t ZExtOffs = 0;
2134 static const uint64_t SExt = 1ULL<<1; ///< Sign extended
2135 static const uint64_t SExtOffs = 1;
2136 static const uint64_t InReg = 1ULL<<2; ///< Passed in register
2137 static const uint64_t InRegOffs = 2;
2138 static const uint64_t SRet = 1ULL<<3; ///< Hidden struct-ret ptr
2139 static const uint64_t SRetOffs = 3;
2140 static const uint64_t ByVal = 1ULL<<4; ///< Struct passed by value
2141 static const uint64_t ByValOffs = 4;
2142 static const uint64_t Nest = 1ULL<<5; ///< Nested fn static chain
2143 static const uint64_t NestOffs = 5;
2144 static const uint64_t ByValAlign = 0xFULL << 6; //< Struct alignment
2145 static const uint64_t ByValAlignOffs = 6;
2146 static const uint64_t Split = 1ULL << 10;
2147 static const uint64_t SplitOffs = 10;
2148 static const uint64_t OrigAlign = 0x1FULL<<27;
2149 static const uint64_t OrigAlignOffs = 27;
2150 static const uint64_t ByValSize = 0xffffffffULL << 32; //< Struct size
2151 static const uint64_t ByValSizeOffs = 32;
2153 static const uint64_t One = 1ULL; //< 1 of this type, for shifts
2157 ArgFlagsTy() : Flags(0) { }
2159 bool isZExt() const { return Flags & ZExt; }
2160 void setZExt() { Flags |= One << ZExtOffs; }
2162 bool isSExt() const { return Flags & SExt; }
2163 void setSExt() { Flags |= One << SExtOffs; }
2165 bool isInReg() const { return Flags & InReg; }
2166 void setInReg() { Flags |= One << InRegOffs; }
2168 bool isSRet() const { return Flags & SRet; }
2169 void setSRet() { Flags |= One << SRetOffs; }
2171 bool isByVal() const { return Flags & ByVal; }
2172 void setByVal() { Flags |= One << ByValOffs; }
2174 bool isNest() const { return Flags & Nest; }
2175 void setNest() { Flags |= One << NestOffs; }
2177 unsigned getByValAlign() const {
2179 ((One << ((Flags & ByValAlign) >> ByValAlignOffs)) / 2);
2181 void setByValAlign(unsigned A) {
2182 Flags = (Flags & ~ByValAlign) |
2183 (uint64_t(Log2_32(A) + 1) << ByValAlignOffs);
2186 bool isSplit() const { return Flags & Split; }
2187 void setSplit() { Flags |= One << SplitOffs; }
2189 unsigned getOrigAlign() const {
2191 ((One << ((Flags & OrigAlign) >> OrigAlignOffs)) / 2);
2193 void setOrigAlign(unsigned A) {
2194 Flags = (Flags & ~OrigAlign) |
2195 (uint64_t(Log2_32(A) + 1) << OrigAlignOffs);
2198 unsigned getByValSize() const {
2199 return (unsigned)((Flags & ByValSize) >> ByValSizeOffs);
2201 void setByValSize(unsigned S) {
2202 Flags = (Flags & ~ByValSize) | (uint64_t(S) << ByValSizeOffs);
2205 /// getArgFlagsString - Returns the flags as a string, eg: "zext align:4".
2206 std::string getArgFlagsString();
2208 /// getRawBits - Represent the flags as a bunch of bits.
2209 uint64_t getRawBits() const { return Flags; }
2213 /// ARG_FLAGSSDNode - Leaf node holding parameter flags.
2214 class ARG_FLAGSSDNode : public SDNode {
2215 ISD::ArgFlagsTy TheFlags;
2217 friend class SelectionDAG;
2218 explicit ARG_FLAGSSDNode(ISD::ArgFlagsTy Flags)
2219 : SDNode(ISD::ARG_FLAGS, DebugLoc::getUnknownLoc(),
2220 getSDVTList(MVT::Other)), TheFlags(Flags) {
2223 ISD::ArgFlagsTy getArgFlags() const { return TheFlags; }
2225 static bool classof(const ARG_FLAGSSDNode *) { return true; }
2226 static bool classof(const SDNode *N) {
2227 return N->getOpcode() == ISD::ARG_FLAGS;
2231 /// CallSDNode - Node for calls -- ISD::CALL.
2232 class CallSDNode : public SDNode {
2233 unsigned CallingConv;
2236 // We might eventually want a full-blown Attributes for the result; that
2237 // will expand the size of the representation. At the moment we only
2241 friend class SelectionDAG;
2242 CallSDNode(unsigned cc, DebugLoc dl, bool isvararg, bool istailcall,
2243 bool isinreg, SDVTList VTs, const SDValue *Operands,
2244 unsigned numOperands)
2245 : SDNode(ISD::CALL, dl, VTs, Operands, numOperands),
2246 CallingConv(cc), IsVarArg(isvararg), IsTailCall(istailcall),
2249 unsigned getCallingConv() const { return CallingConv; }
2250 unsigned isVarArg() const { return IsVarArg; }
2251 unsigned isTailCall() const { return IsTailCall; }
2252 unsigned isInreg() const { return Inreg; }
2254 /// Set this call to not be marked as a tail call. Normally setter
2255 /// methods in SDNodes are unsafe because it breaks the CSE map,
2256 /// but we don't include the tail call flag for calls so it's ok
2258 void setNotTailCall() { IsTailCall = false; }
2260 SDValue getChain() const { return getOperand(0); }
2261 SDValue getCallee() const { return getOperand(1); }
2263 unsigned getNumArgs() const { return (getNumOperands() - 2) / 2; }
2264 SDValue getArg(unsigned i) const { return getOperand(2+2*i); }
2265 SDValue getArgFlagsVal(unsigned i) const {
2266 return getOperand(3+2*i);
2268 ISD::ArgFlagsTy getArgFlags(unsigned i) const {
2269 return cast<ARG_FLAGSSDNode>(getArgFlagsVal(i).getNode())->getArgFlags();
2272 unsigned getNumRetVals() const { return getNumValues() - 1; }
2273 MVT getRetValType(unsigned i) const { return getValueType(i); }
2275 static bool classof(const CallSDNode *) { return true; }
2276 static bool classof(const SDNode *N) {
2277 return N->getOpcode() == ISD::CALL;
2281 /// VTSDNode - This class is used to represent MVT's, which are used
2282 /// to parameterize some operations.
2283 class VTSDNode : public SDNode {
2286 friend class SelectionDAG;
2287 explicit VTSDNode(MVT VT)
2288 : SDNode(ISD::VALUETYPE, DebugLoc::getUnknownLoc(),
2289 getSDVTList(MVT::Other)), ValueType(VT) {
2293 MVT getVT() const { return ValueType; }
2295 static bool classof(const VTSDNode *) { return true; }
2296 static bool classof(const SDNode *N) {
2297 return N->getOpcode() == ISD::VALUETYPE;
2301 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
2303 class LSBaseSDNode : public MemSDNode {
2305 //! Operand array for load and store
2307 \note Moving this array to the base class captures more
2308 common functionality shared between LoadSDNode and
2313 LSBaseSDNode(ISD::NodeType NodeTy, DebugLoc dl, SDValue *Operands,
2314 unsigned numOperands, SDVTList VTs, ISD::MemIndexedMode AM,
2315 MVT VT, const Value *SV, int SVO, unsigned Align, bool Vol)
2316 : MemSDNode(NodeTy, dl, VTs, VT, SV, SVO, Align, Vol) {
2317 assert(Align != 0 && "Loads and stores should have non-zero aligment");
2318 SubclassData |= AM << 2;
2319 assert(getAddressingMode() == AM && "MemIndexedMode encoding error!");
2320 InitOperands(Ops, Operands, numOperands);
2321 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
2322 "Only indexed loads and stores have a non-undef offset operand");
2325 const SDValue &getOffset() const {
2326 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
2329 /// getAddressingMode - Return the addressing mode for this load or store:
2330 /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
2331 ISD::MemIndexedMode getAddressingMode() const {
2332 return ISD::MemIndexedMode((SubclassData >> 2) & 7);
2335 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
2336 bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
2338 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
2339 bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
2341 static bool classof(const LSBaseSDNode *) { return true; }
2342 static bool classof(const SDNode *N) {
2343 return N->getOpcode() == ISD::LOAD ||
2344 N->getOpcode() == ISD::STORE;
2348 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
2350 class LoadSDNode : public LSBaseSDNode {
2352 friend class SelectionDAG;
2353 LoadSDNode(SDValue *ChainPtrOff, DebugLoc dl, SDVTList VTs,
2354 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, MVT LVT,
2355 const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
2356 : LSBaseSDNode(ISD::LOAD, dl, ChainPtrOff, 3,
2357 VTs, AM, LVT, SV, O, Align, Vol) {
2358 SubclassData |= (unsigned short)ETy;
2359 assert(getExtensionType() == ETy && "LoadExtType encoding error!");
2363 /// getExtensionType - Return whether this is a plain node,
2364 /// or one of the varieties of value-extending loads.
2365 ISD::LoadExtType getExtensionType() const {
2366 return ISD::LoadExtType(SubclassData & 3);
2369 const SDValue &getBasePtr() const { return getOperand(1); }
2370 const SDValue &getOffset() const { return getOperand(2); }
2372 static bool classof(const LoadSDNode *) { return true; }
2373 static bool classof(const SDNode *N) {
2374 return N->getOpcode() == ISD::LOAD;
2378 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
2380 class StoreSDNode : public LSBaseSDNode {
2382 friend class SelectionDAG;
2383 StoreSDNode(SDValue *ChainValuePtrOff, DebugLoc dl, SDVTList VTs,
2384 ISD::MemIndexedMode AM, bool isTrunc, MVT SVT,
2385 const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
2386 : LSBaseSDNode(ISD::STORE, dl, ChainValuePtrOff, 4,
2387 VTs, AM, SVT, SV, O, Align, Vol) {
2388 SubclassData |= (unsigned short)isTrunc;
2389 assert(isTruncatingStore() == isTrunc && "isTrunc encoding error!");
2393 /// isTruncatingStore - Return true if the op does a truncation before store.
2394 /// For integers this is the same as doing a TRUNCATE and storing the result.
2395 /// For floats, it is the same as doing an FP_ROUND and storing the result.
2396 bool isTruncatingStore() const { return SubclassData & 1; }
2398 const SDValue &getValue() const { return getOperand(1); }
2399 const SDValue &getBasePtr() const { return getOperand(2); }
2400 const SDValue &getOffset() const { return getOperand(3); }
2402 static bool classof(const StoreSDNode *) { return true; }
2403 static bool classof(const SDNode *N) {
2404 return N->getOpcode() == ISD::STORE;
2409 class SDNodeIterator : public forward_iterator<SDNode, ptrdiff_t> {
2413 SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
2415 bool operator==(const SDNodeIterator& x) const {
2416 return Operand == x.Operand;
2418 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
2420 const SDNodeIterator &operator=(const SDNodeIterator &I) {
2421 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
2422 Operand = I.Operand;
2426 pointer operator*() const {
2427 return Node->getOperand(Operand).getNode();
2429 pointer operator->() const { return operator*(); }
2431 SDNodeIterator& operator++() { // Preincrement
2435 SDNodeIterator operator++(int) { // Postincrement
2436 SDNodeIterator tmp = *this; ++*this; return tmp;
2439 static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
2440 static SDNodeIterator end (SDNode *N) {
2441 return SDNodeIterator(N, N->getNumOperands());
2444 unsigned getOperand() const { return Operand; }
2445 const SDNode *getNode() const { return Node; }
2448 template <> struct GraphTraits<SDNode*> {
2449 typedef SDNode NodeType;
2450 typedef SDNodeIterator ChildIteratorType;
2451 static inline NodeType *getEntryNode(SDNode *N) { return N; }
2452 static inline ChildIteratorType child_begin(NodeType *N) {
2453 return SDNodeIterator::begin(N);
2455 static inline ChildIteratorType child_end(NodeType *N) {
2456 return SDNodeIterator::end(N);
2460 /// LargestSDNode - The largest SDNode class.
2462 typedef LoadSDNode LargestSDNode;
2464 /// MostAlignedSDNode - The SDNode class with the greatest alignment
2467 typedef ARG_FLAGSSDNode MostAlignedSDNode;
2470 /// isNormalLoad - Returns true if the specified node is a non-extending
2471 /// and unindexed load.
2472 inline bool isNormalLoad(const SDNode *N) {
2473 const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
2474 return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
2475 Ld->getAddressingMode() == ISD::UNINDEXED;
2478 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
2480 inline bool isNON_EXTLoad(const SDNode *N) {
2481 return isa<LoadSDNode>(N) &&
2482 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
2485 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
2487 inline bool isEXTLoad(const SDNode *N) {
2488 return isa<LoadSDNode>(N) &&
2489 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
2492 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
2494 inline bool isSEXTLoad(const SDNode *N) {
2495 return isa<LoadSDNode>(N) &&
2496 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
2499 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
2501 inline bool isZEXTLoad(const SDNode *N) {
2502 return isa<LoadSDNode>(N) &&
2503 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
2506 /// isUNINDEXEDLoad - Returns true if the specified node is an unindexed load.
2508 inline bool isUNINDEXEDLoad(const SDNode *N) {
2509 return isa<LoadSDNode>(N) &&
2510 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2513 /// isNormalStore - Returns true if the specified node is a non-truncating
2514 /// and unindexed store.
2515 inline bool isNormalStore(const SDNode *N) {
2516 const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
2517 return St && !St->isTruncatingStore() &&
2518 St->getAddressingMode() == ISD::UNINDEXED;
2521 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
2523 inline bool isNON_TRUNCStore(const SDNode *N) {
2524 return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
2527 /// isTRUNCStore - Returns true if the specified node is a truncating
2529 inline bool isTRUNCStore(const SDNode *N) {
2530 return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
2533 /// isUNINDEXEDStore - Returns true if the specified node is an
2534 /// unindexed store.
2535 inline bool isUNINDEXEDStore(const SDNode *N) {
2536 return isa<StoreSDNode>(N) &&
2537 cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2542 } // end llvm namespace