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/ilist_node.h"
26 #include "llvm/ADT/SmallVector.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/Support/DebugLoc.h"
41 class MachineBasicBlock;
42 class MachineConstantPoolValue;
45 template <typename T> struct DenseMapInfo;
46 template <typename T> struct simplify_type;
47 template <typename T> struct ilist_traits;
49 /// SDVTList - This represents a list of ValueType's that has been intern'd by
50 /// a SelectionDAG. Instances of this simple value class are returned by
51 /// SelectionDAG::getVTList(...).
58 /// ISD namespace - This namespace contains an enum which represents all of the
59 /// SelectionDAG node types and value types.
63 //===--------------------------------------------------------------------===//
64 /// ISD::NodeType enum - This enum defines the target-independent operators
65 /// for a SelectionDAG.
67 /// Targets may also define target-dependent operator codes for SDNodes. For
68 /// example, on x86, these are the enum values in the X86ISD namespace.
69 /// Targets should aim to use target-independent operators to model their
70 /// instruction sets as much as possible, and only use target-dependent
71 /// operators when they have special requirements.
73 /// Finally, during and after selection proper, SNodes may use special
74 /// operator codes that correspond directly with MachineInstr opcodes. These
75 /// are used to represent selected instructions. See the isMachineOpcode()
76 /// and getMachineOpcode() member functions of SDNode.
79 // DELETED_NODE - This is an illegal value that is used to catch
80 // errors. This opcode is not a legal opcode for any node.
83 // EntryToken - This is the marker used to indicate the start of the region.
86 // TokenFactor - This node takes multiple tokens as input and produces a
87 // single token result. This is used to represent the fact that the operand
88 // operators are independent of each other.
91 // AssertSext, AssertZext - These nodes record if a register contains a
92 // value that has already been zero or sign extended from a narrower type.
93 // These nodes take two operands. The first is the node that has already
94 // been extended, and the second is a value type node indicating the width
96 AssertSext, AssertZext,
98 // Various leaf nodes.
99 BasicBlock, VALUETYPE, CONDCODE, Register,
100 Constant, ConstantFP,
101 GlobalAddress, GlobalTLSAddress, FrameIndex,
102 JumpTable, ConstantPool, ExternalSymbol,
104 // The address of the GOT
107 // FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
108 // llvm.returnaddress on the DAG. These nodes take one operand, the index
109 // of the frame or return address to return. An index of zero corresponds
110 // to the current function's frame or return address, an index of one to the
111 // parent's frame or return address, and so on.
112 FRAMEADDR, RETURNADDR,
114 // FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
115 // first (possible) on-stack argument. This is needed for correct stack
116 // adjustment during unwind.
117 FRAME_TO_ARGS_OFFSET,
119 // RESULT, OUTCHAIN = EXCEPTIONADDR(INCHAIN) - This node represents the
120 // address of the exception block on entry to an landing pad block.
123 // RESULT, OUTCHAIN = LSDAADDR(INCHAIN) - This node represents the
124 // address of the Language Specific Data Area for the enclosing function.
127 // RESULT, OUTCHAIN = EHSELECTION(INCHAIN, EXCEPTION) - This node represents
128 // the selection index of the exception thrown.
131 // OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
132 // 'eh_return' gcc dwarf builtin, which is used to return from
133 // exception. The general meaning is: adjust stack by OFFSET and pass
134 // execution to HANDLER. Many platform-related details also :)
137 // TargetConstant* - Like Constant*, but the DAG does not do any folding or
138 // simplification of the constant.
142 // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
143 // anything else with this node, and this is valid in the target-specific
144 // dag, turning into a GlobalAddress operand.
146 TargetGlobalTLSAddress,
150 TargetExternalSymbol,
152 /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
153 /// This node represents a target intrinsic function with no side effects.
154 /// The first operand is the ID number of the intrinsic from the
155 /// llvm::Intrinsic namespace. The operands to the intrinsic follow. The
156 /// node has returns the result of the intrinsic.
159 /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
160 /// This node represents a target intrinsic function with side effects that
161 /// returns a result. The first operand is a chain pointer. The second is
162 /// the ID number of the intrinsic from the llvm::Intrinsic namespace. The
163 /// operands to the intrinsic follow. The node has two results, the result
164 /// of the intrinsic and an output chain.
167 /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
168 /// This node represents a target intrinsic function with side effects that
169 /// does not return a result. The first operand is a chain pointer. The
170 /// second is the ID number of the intrinsic from the llvm::Intrinsic
171 /// namespace. The operands to the intrinsic follow.
174 // CopyToReg - This node has three operands: a chain, a register number to
175 // set to this value, and a value.
178 // CopyFromReg - This node indicates that the input value is a virtual or
179 // physical register that is defined outside of the scope of this
180 // SelectionDAG. The register is available from the RegisterSDNode object.
183 // UNDEF - An undefined node
186 // EXTRACT_ELEMENT - This is used to get the lower or upper (determined by
187 // a Constant, which is required to be operand #1) half of the integer or
188 // float value specified as operand #0. This is only for use before
189 // legalization, for values that will be broken into multiple registers.
192 // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways. Given
193 // two values of the same integer value type, this produces a value twice as
194 // big. Like EXTRACT_ELEMENT, this can only be used before legalization.
197 // MERGE_VALUES - This node takes multiple discrete operands and returns
198 // them all as its individual results. This nodes has exactly the same
199 // number of inputs and outputs. This node is useful for some pieces of the
200 // code generator that want to think about a single node with multiple
201 // results, not multiple nodes.
204 // Simple integer binary arithmetic operators.
205 ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
207 // SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing
208 // a signed/unsigned value of type i[2*N], and return the full value as
209 // two results, each of type iN.
210 SMUL_LOHI, UMUL_LOHI,
212 // SDIVREM/UDIVREM - Divide two integers and produce both a quotient and
216 // CARRY_FALSE - This node is used when folding other nodes,
217 // like ADDC/SUBC, which indicate the carry result is always false.
220 // Carry-setting nodes for multiple precision addition and subtraction.
221 // These nodes take two operands of the same value type, and produce two
222 // results. The first result is the normal add or sub result, the second
223 // result is the carry flag result.
226 // Carry-using nodes for multiple precision addition and subtraction. These
227 // nodes take three operands: The first two are the normal lhs and rhs to
228 // the add or sub, and the third is the input carry flag. These nodes
229 // produce two results; the normal result of the add or sub, and the output
230 // carry flag. These nodes both read and write a carry flag to allow them
231 // to them to be chained together for add and sub of arbitrarily large
235 // RESULT, BOOL = [SU]ADDO(LHS, RHS) - Overflow-aware nodes for addition.
236 // These nodes take two operands: the normal LHS and RHS to the add. They
237 // produce two results: the normal result of the add, and a boolean that
238 // indicates if an overflow occured (*not* a flag, because it may be stored
239 // to memory, etc.). If the type of the boolean is not i1 then the high
240 // bits conform to getBooleanContents.
241 // These nodes are generated from the llvm.[su]add.with.overflow intrinsics.
244 // Same for subtraction
247 // Same for multiplication
250 // Simple binary floating point operators.
251 FADD, FSUB, FMUL, FDIV, FREM,
253 // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y. NOTE: This
254 // DAG node does not require that X and Y have the same type, just that they
255 // are both floating point. X and the result must have the same type.
256 // FCOPYSIGN(f32, f64) is allowed.
259 // INT = FGETSIGN(FP) - Return the sign bit of the specified floating point
260 // value as an integer 0/1 value.
263 /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector with the
264 /// specified, possibly variable, elements. The number of elements is
265 /// required to be a power of two. The types of the operands must all be
266 /// the same and must match the vector element type, except that integer
267 /// types are allowed to be larger than the element type, in which case
268 /// the operands are implicitly truncated.
271 /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR with the element
272 /// at IDX replaced with VAL. If the type of VAL is larger than the vector
273 /// element type then VAL is truncated before replacement.
276 /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
277 /// identified by the (potentially variable) element number IDX. If the
278 /// return type is an integer type larger than the element type of the
279 /// vector, the result is extended to the width of the return type.
282 /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
283 /// vector type with the same length and element type, this produces a
284 /// concatenated vector result value, with length equal to the sum of the
285 /// lengths of the input vectors.
288 /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
289 /// vector value) starting with the (potentially variable) element number
290 /// IDX, which must be a multiple of the result vector length.
293 /// VECTOR_SHUFFLE(VEC1, VEC2) - Returns a vector, of the same type as
294 /// VEC1/VEC2. A VECTOR_SHUFFLE node also contains an array of constant int
295 /// values that indicate which value (or undef) each result element will
296 /// get. These constant ints are accessible through the
297 /// ShuffleVectorSDNode class. This is quite similar to the Altivec
298 /// 'vperm' instruction, except that the indices must be constants and are
299 /// in terms of the element size of VEC1/VEC2, not in terms of bytes.
302 /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
303 /// scalar value into element 0 of the resultant vector type. The top
304 /// elements 1 to N-1 of the N-element vector are undefined. The type
305 /// of the operand must match the vector element type, except when they
306 /// are integer types. In this case the operand is allowed to be wider
307 /// than the vector element type, and is implicitly truncated to it.
310 // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
311 // an unsigned/signed value of type i[2*N], then return the top part.
314 // Bitwise operators - logical and, logical or, logical xor, shift left,
315 // shift right algebraic (shift in sign bits), shift right logical (shift in
316 // zeroes), rotate left, rotate right, and byteswap.
317 AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
319 // Counting operators
322 // Select(COND, TRUEVAL, FALSEVAL). If the type of the boolean COND is not
323 // i1 then the high bits must conform to getBooleanContents.
326 // Select with condition operator - This selects between a true value and
327 // a false value (ops #2 and #3) based on the boolean result of comparing
328 // the lhs and rhs (ops #0 and #1) of a conditional expression with the
329 // condition code in op #4, a CondCodeSDNode.
332 // SetCC operator - This evaluates to a true value iff the condition is
333 // true. If the result value type is not i1 then the high bits conform
334 // to getBooleanContents. The operands to this are the left and right
335 // operands to compare (ops #0, and #1) and the condition code to compare
336 // them with (op #2) as a CondCodeSDNode.
339 // RESULT = VSETCC(LHS, RHS, COND) operator - This evaluates to a vector of
340 // integer elements with all bits of the result elements set to true if the
341 // comparison is true or all cleared if the comparison is false. The
342 // operands to this are the left and right operands to compare (LHS/RHS) and
343 // the condition code to compare them with (COND) as a CondCodeSDNode.
346 // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
347 // integer shift operations, just like ADD/SUB_PARTS. The operation
349 // [Lo,Hi] = op [LoLHS,HiLHS], Amt
350 SHL_PARTS, SRA_PARTS, SRL_PARTS,
352 // Conversion operators. These are all single input single output
353 // operations. For all of these, the result type must be strictly
354 // wider or narrower (depending on the operation) than the source
357 // SIGN_EXTEND - Used for integer types, replicating the sign bit
361 // ZERO_EXTEND - Used for integer types, zeroing the new bits.
364 // ANY_EXTEND - Used for integer types. The high bits are undefined.
367 // TRUNCATE - Completely drop the high bits.
370 // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
371 // depends on the first letter) to floating point.
375 // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
376 // sign extend a small value in a large integer register (e.g. sign
377 // extending the low 8 bits of a 32-bit register to fill the top 24 bits
378 // with the 7th bit). The size of the smaller type is indicated by the 1th
379 // operand, a ValueType node.
382 /// FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
387 /// X = FP_ROUND(Y, TRUNC) - Rounding 'Y' from a larger floating point type
388 /// down to the precision of the destination VT. TRUNC is a flag, which is
389 /// always an integer that is zero or one. If TRUNC is 0, this is a
390 /// normal rounding, if it is 1, this FP_ROUND is known to not change the
393 /// The TRUNC = 1 case is used in cases where we know that the value will
394 /// not be modified by the node, because Y is not using any of the extra
395 /// precision of source type. This allows certain transformations like
396 /// FP_EXTEND(FP_ROUND(X,1)) -> X which are not safe for
397 /// FP_EXTEND(FP_ROUND(X,0)) because the extra bits aren't removed.
400 // FLT_ROUNDS_ - Returns current rounding mode:
403 // 1 Round to nearest
408 /// X = FP_ROUND_INREG(Y, VT) - This operator takes an FP register, and
409 /// rounds it to a floating point value. It then promotes it and returns it
410 /// in a register of the same size. This operation effectively just
411 /// discards excess precision. The type to round down to is specified by
412 /// the VT operand, a VTSDNode.
415 /// X = FP_EXTEND(Y) - Extend a smaller FP type into a larger FP type.
418 // BIT_CONVERT - Theis operator converts between integer and FP values, as
419 // if one was stored to memory as integer and the other was loaded from the
420 // same address (or equivalently for vector format conversions, etc). The
421 // source and result are required to have the same bit size (e.g.
422 // f32 <-> i32). This can also be used for int-to-int or fp-to-fp
423 // conversions, but that is a noop, deleted by getNode().
426 // CONVERT_RNDSAT - This operator is used to support various conversions
427 // between various types (float, signed, unsigned and vectors of those
428 // types) with rounding and saturation. NOTE: Avoid using this operator as
429 // most target don't support it and the operator might be removed in the
430 // future. It takes the following arguments:
432 // 1) dest type (type to convert to)
433 // 2) src type (type to convert from)
436 // 5) ISD::CvtCode indicating the type of conversion to do
439 // FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
440 // FLOG, FLOG2, FLOG10, FEXP, FEXP2,
441 // FCEIL, FTRUNC, FRINT, FNEARBYINT, FFLOOR - Perform various unary floating
442 // point operations. These are inspired by libm.
443 FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
444 FLOG, FLOG2, FLOG10, FEXP, FEXP2,
445 FCEIL, FTRUNC, FRINT, FNEARBYINT, FFLOOR,
447 // LOAD and STORE have token chains as their first operand, then the same
448 // operands as an LLVM load/store instruction, then an offset node that
449 // is added / subtracted from the base pointer to form the address (for
450 // indexed memory ops).
453 // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
454 // to a specified boundary. This node always has two return values: a new
455 // stack pointer value and a chain. The first operand is the token chain,
456 // the second is the number of bytes to allocate, and the third is the
457 // alignment boundary. The size is guaranteed to be a multiple of the stack
458 // alignment, and the alignment is guaranteed to be bigger than the stack
459 // alignment (if required) or 0 to get standard stack alignment.
462 // Control flow instructions. These all have token chains.
464 // BR - Unconditional branch. The first operand is the chain
465 // operand, the second is the MBB to branch to.
468 // BRIND - Indirect branch. The first operand is the chain, the second
469 // is the value to branch to, which must be of the same type as the target's
473 // BR_JT - Jumptable branch. The first operand is the chain, the second
474 // is the jumptable index, the last one is the jumptable entry index.
477 // BRCOND - Conditional branch. The first operand is the chain, the
478 // second is the condition, the third is the block to branch to if the
479 // condition is true. If the type of the condition is not i1, then the
480 // high bits must conform to getBooleanContents.
483 // BR_CC - Conditional branch. The behavior is like that of SELECT_CC, in
484 // that the condition is represented as condition code, and two nodes to
485 // compare, rather than as a combined SetCC node. The operands in order are
486 // chain, cc, lhs, rhs, block to branch to if condition is true.
489 // INLINEASM - Represents an inline asm block. This node always has two
490 // return values: a chain and a flag result. The inputs are as follows:
491 // Operand #0 : Input chain.
492 // Operand #1 : a ExternalSymbolSDNode with a pointer to the asm string.
493 // Operand #2n+2: A RegisterNode.
494 // Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
495 // Operand #last: Optional, an incoming flag.
498 // DBG_LABEL, EH_LABEL - Represents a label in mid basic block used to track
499 // locations needed for debug and exception handling tables. These nodes
500 // take a chain as input and return a chain.
504 // STACKSAVE - STACKSAVE has one operand, an input chain. It produces a
505 // value, the same type as the pointer type for the system, and an output
509 // STACKRESTORE has two operands, an input chain and a pointer to restore to
510 // it returns an output chain.
513 // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
514 // a call sequence, and carry arbitrary information that target might want
515 // to know. The first operand is a chain, the rest are specified by the
516 // target and not touched by the DAG optimizers.
517 // CALLSEQ_START..CALLSEQ_END pairs may not be nested.
518 CALLSEQ_START, // Beginning of a call sequence
519 CALLSEQ_END, // End of a call sequence
521 // VAARG - VAARG has three operands: an input chain, a pointer, and a
522 // SRCVALUE. It returns a pair of values: the vaarg value and a new chain.
525 // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
526 // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
530 // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
531 // pointer, and a SRCVALUE.
534 // SRCVALUE - This is a node type that holds a Value* that is used to
535 // make reference to a value in the LLVM IR.
538 // MEMOPERAND - This is a node that contains a MachineMemOperand which
539 // records information about a memory reference. This is used to make
540 // AliasAnalysis queries from the backend.
543 // PCMARKER - This corresponds to the pcmarker intrinsic.
546 // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
547 // The only operand is a chain and a value and a chain are produced. The
548 // value is the contents of the architecture specific cycle counter like
549 // register (or other high accuracy low latency clock source)
552 // HANDLENODE node - Used as a handle for various purposes.
555 // DBG_STOPPOINT - This node is used to represent a source location for
556 // debug info. It takes token chain as input, and carries a line number,
557 // column number, and a pointer to a CompileUnit object identifying
558 // the containing compilation unit. It produces a token chain as output.
561 // DEBUG_LOC - This node is used to represent source line information
562 // embedded in the code. It takes a token chain as input, then a line
563 // number, then a column then a file id (provided by MachineModuleInfo.) It
564 // produces a token chain as output.
567 // TRAMPOLINE - This corresponds to the init_trampoline intrinsic.
568 // It takes as input a token chain, the pointer to the trampoline,
569 // the pointer to the nested function, the pointer to pass for the
570 // 'nest' parameter, a SRCVALUE for the trampoline and another for
571 // the nested function (allowing targets to access the original
572 // Function*). It produces the result of the intrinsic and a token
576 // TRAP - Trapping instruction
579 // PREFETCH - This corresponds to a prefetch intrinsic. It takes chains are
580 // their first operand. The other operands are the address to prefetch,
581 // read / write specifier, and locality specifier.
584 // OUTCHAIN = MEMBARRIER(INCHAIN, load-load, load-store, store-load,
585 // store-store, device)
586 // This corresponds to the memory.barrier intrinsic.
587 // it takes an input chain, 4 operands to specify the type of barrier, an
588 // operand specifying if the barrier applies to device and uncached memory
589 // and produces an output chain.
592 // Val, OUTCHAIN = ATOMIC_CMP_SWAP(INCHAIN, ptr, cmp, swap)
593 // this corresponds to the atomic.lcs intrinsic.
594 // cmp is compared to *ptr, and if equal, swap is stored in *ptr.
595 // the return is always the original value in *ptr
598 // Val, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amt)
599 // this corresponds to the atomic.swap intrinsic.
600 // amt is stored to *ptr atomically.
601 // the return is always the original value in *ptr
604 // Val, OUTCHAIN = ATOMIC_LOAD_[OpName](INCHAIN, ptr, amt)
605 // this corresponds to the atomic.load.[OpName] intrinsic.
606 // op(*ptr, amt) is stored to *ptr atomically.
607 // the return is always the original value in *ptr
619 // BUILTIN_OP_END - This must be the last enum value in this list.
625 /// isBuildVectorAllOnes - Return true if the specified node is a
626 /// BUILD_VECTOR where all of the elements are ~0 or undef.
627 bool isBuildVectorAllOnes(const SDNode *N);
629 /// isBuildVectorAllZeros - Return true if the specified node is a
630 /// BUILD_VECTOR where all of the elements are 0 or undef.
631 bool isBuildVectorAllZeros(const SDNode *N);
633 /// isScalarToVector - Return true if the specified node is a
634 /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
635 /// element is not an undef.
636 bool isScalarToVector(const SDNode *N);
638 /// isDebugLabel - Return true if the specified node represents a debug
639 /// label (i.e. ISD::DBG_LABEL or TargetInstrInfo::DBG_LABEL node).
640 bool isDebugLabel(const SDNode *N);
642 //===--------------------------------------------------------------------===//
643 /// MemIndexedMode enum - This enum defines the load / store indexed
644 /// addressing modes.
646 /// UNINDEXED "Normal" load / store. The effective address is already
647 /// computed and is available in the base pointer. The offset
648 /// operand is always undefined. In addition to producing a
649 /// chain, an unindexed load produces one value (result of the
650 /// load); an unindexed store does not produce a value.
652 /// PRE_INC Similar to the unindexed mode where the effective address is
653 /// PRE_DEC the value of the base pointer add / subtract the offset.
654 /// It considers the computation as being folded into the load /
655 /// store operation (i.e. the load / store does the address
656 /// computation as well as performing the memory transaction).
657 /// The base operand is always undefined. In addition to
658 /// producing a chain, pre-indexed load produces two values
659 /// (result of the load and the result of the address
660 /// computation); a pre-indexed store produces one value (result
661 /// of the address computation).
663 /// POST_INC The effective address is the value of the base pointer. The
664 /// POST_DEC value of the offset operand is then added to / subtracted
665 /// from the base after memory transaction. In addition to
666 /// producing a chain, post-indexed load produces two values
667 /// (the result of the load and the result of the base +/- offset
668 /// computation); a post-indexed store produces one value (the
669 /// the result of the base +/- offset computation).
671 enum MemIndexedMode {
680 //===--------------------------------------------------------------------===//
681 /// LoadExtType enum - This enum defines the three variants of LOADEXT
682 /// (load with extension).
684 /// SEXTLOAD loads the integer operand and sign extends it to a larger
685 /// integer result type.
686 /// ZEXTLOAD loads the integer operand and zero extends it to a larger
687 /// integer result type.
688 /// EXTLOAD is used for three things: floating point extending loads,
689 /// integer extending loads [the top bits are undefined], and vector
690 /// extending loads [load into low elt].
700 //===--------------------------------------------------------------------===//
701 /// ISD::CondCode enum - These are ordered carefully to make the bitfields
702 /// below work out, when considering SETFALSE (something that never exists
703 /// dynamically) as 0. "U" -> Unsigned (for integer operands) or Unordered
704 /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
705 /// to. If the "N" column is 1, the result of the comparison is undefined if
706 /// the input is a NAN.
708 /// All of these (except for the 'always folded ops') should be handled for
709 /// floating point. For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
710 /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
712 /// Note that these are laid out in a specific order to allow bit-twiddling
713 /// to transform conditions.
715 // Opcode N U L G E Intuitive operation
716 SETFALSE, // 0 0 0 0 Always false (always folded)
717 SETOEQ, // 0 0 0 1 True if ordered and equal
718 SETOGT, // 0 0 1 0 True if ordered and greater than
719 SETOGE, // 0 0 1 1 True if ordered and greater than or equal
720 SETOLT, // 0 1 0 0 True if ordered and less than
721 SETOLE, // 0 1 0 1 True if ordered and less than or equal
722 SETONE, // 0 1 1 0 True if ordered and operands are unequal
723 SETO, // 0 1 1 1 True if ordered (no nans)
724 SETUO, // 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
725 SETUEQ, // 1 0 0 1 True if unordered or equal
726 SETUGT, // 1 0 1 0 True if unordered or greater than
727 SETUGE, // 1 0 1 1 True if unordered, greater than, or equal
728 SETULT, // 1 1 0 0 True if unordered or less than
729 SETULE, // 1 1 0 1 True if unordered, less than, or equal
730 SETUNE, // 1 1 1 0 True if unordered or not equal
731 SETTRUE, // 1 1 1 1 Always true (always folded)
732 // Don't care operations: undefined if the input is a nan.
733 SETFALSE2, // 1 X 0 0 0 Always false (always folded)
734 SETEQ, // 1 X 0 0 1 True if equal
735 SETGT, // 1 X 0 1 0 True if greater than
736 SETGE, // 1 X 0 1 1 True if greater than or equal
737 SETLT, // 1 X 1 0 0 True if less than
738 SETLE, // 1 X 1 0 1 True if less than or equal
739 SETNE, // 1 X 1 1 0 True if not equal
740 SETTRUE2, // 1 X 1 1 1 Always true (always folded)
742 SETCC_INVALID // Marker value.
745 /// isSignedIntSetCC - Return true if this is a setcc instruction that
746 /// performs a signed comparison when used with integer operands.
747 inline bool isSignedIntSetCC(CondCode Code) {
748 return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
751 /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
752 /// performs an unsigned comparison when used with integer operands.
753 inline bool isUnsignedIntSetCC(CondCode Code) {
754 return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
757 /// isTrueWhenEqual - Return true if the specified condition returns true if
758 /// the two operands to the condition are equal. Note that if one of the two
759 /// operands is a NaN, this value is meaningless.
760 inline bool isTrueWhenEqual(CondCode Cond) {
761 return ((int)Cond & 1) != 0;
764 /// getUnorderedFlavor - This function returns 0 if the condition is always
765 /// false if an operand is a NaN, 1 if the condition is always true if the
766 /// operand is a NaN, and 2 if the condition is undefined if the operand is a
768 inline unsigned getUnorderedFlavor(CondCode Cond) {
769 return ((int)Cond >> 3) & 3;
772 /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
773 /// 'op' is a valid SetCC operation.
774 CondCode getSetCCInverse(CondCode Operation, bool isInteger);
776 /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
777 /// when given the operation for (X op Y).
778 CondCode getSetCCSwappedOperands(CondCode Operation);
780 /// getSetCCOrOperation - Return the result of a logical OR between different
781 /// comparisons of identical values: ((X op1 Y) | (X op2 Y)). This
782 /// function returns SETCC_INVALID if it is not possible to represent the
783 /// resultant comparison.
784 CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
786 /// getSetCCAndOperation - Return the result of a logical AND between
787 /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)). This
788 /// function returns SETCC_INVALID if it is not possible to represent the
789 /// resultant comparison.
790 CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
792 //===--------------------------------------------------------------------===//
793 /// CvtCode enum - This enum defines the various converts CONVERT_RNDSAT
796 CVT_FF, // Float from Float
797 CVT_FS, // Float from Signed
798 CVT_FU, // Float from Unsigned
799 CVT_SF, // Signed from Float
800 CVT_UF, // Unsigned from Float
801 CVT_SS, // Signed from Signed
802 CVT_SU, // Signed from Unsigned
803 CVT_US, // Unsigned from Signed
804 CVT_UU, // Unsigned from Unsigned
805 CVT_INVALID // Marker - Invalid opcode
807 } // end llvm::ISD namespace
810 //===----------------------------------------------------------------------===//
811 /// SDValue - Unlike LLVM values, Selection DAG nodes may return multiple
812 /// values as the result of a computation. Many nodes return multiple values,
813 /// from loads (which define a token and a return value) to ADDC (which returns
814 /// a result and a carry value), to calls (which may return an arbitrary number
817 /// As such, each use of a SelectionDAG computation must indicate the node that
818 /// computes it as well as which return value to use from that node. This pair
819 /// of information is represented with the SDValue value type.
822 SDNode *Node; // The node defining the value we are using.
823 unsigned ResNo; // Which return value of the node we are using.
825 SDValue() : Node(0), ResNo(0) {}
826 SDValue(SDNode *node, unsigned resno) : Node(node), ResNo(resno) {}
828 /// get the index which selects a specific result in the SDNode
829 unsigned getResNo() const { return ResNo; }
831 /// get the SDNode which holds the desired result
832 SDNode *getNode() const { return Node; }
835 void setNode(SDNode *N) { Node = N; }
837 bool operator==(const SDValue &O) const {
838 return Node == O.Node && ResNo == O.ResNo;
840 bool operator!=(const SDValue &O) const {
841 return !operator==(O);
843 bool operator<(const SDValue &O) const {
844 return Node < O.Node || (Node == O.Node && ResNo < O.ResNo);
847 SDValue getValue(unsigned R) const {
848 return SDValue(Node, R);
851 // isOperandOf - Return true if this node is an operand of N.
852 bool isOperandOf(SDNode *N) const;
854 /// getValueType - Return the ValueType of the referenced return value.
856 inline EVT getValueType() const;
858 /// getValueSizeInBits - Returns the size of the value in bits.
860 unsigned getValueSizeInBits() const {
861 return getValueType().getSizeInBits();
864 // Forwarding methods - These forward to the corresponding methods in SDNode.
865 inline unsigned getOpcode() const;
866 inline unsigned getNumOperands() const;
867 inline const SDValue &getOperand(unsigned i) const;
868 inline uint64_t getConstantOperandVal(unsigned i) const;
869 inline bool isTargetOpcode() const;
870 inline bool isMachineOpcode() const;
871 inline unsigned getMachineOpcode() const;
872 inline const DebugLoc getDebugLoc() const;
875 /// reachesChainWithoutSideEffects - Return true if this operand (which must
876 /// be a chain) reaches the specified operand without crossing any
877 /// side-effecting instructions. In practice, this looks through token
878 /// factors and non-volatile loads. In order to remain efficient, this only
879 /// looks a couple of nodes in, it does not do an exhaustive search.
880 bool reachesChainWithoutSideEffects(SDValue Dest,
881 unsigned Depth = 2) const;
883 /// use_empty - Return true if there are no nodes using value ResNo
886 inline bool use_empty() const;
888 /// hasOneUse - Return true if there is exactly one node using value
891 inline bool hasOneUse() const;
895 template<> struct DenseMapInfo<SDValue> {
896 static inline SDValue getEmptyKey() {
897 return SDValue((SDNode*)-1, -1U);
899 static inline SDValue getTombstoneKey() {
900 return SDValue((SDNode*)-1, 0);
902 static unsigned getHashValue(const SDValue &Val) {
903 return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
904 (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
906 static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
909 static bool isPod() { return true; }
912 /// simplify_type specializations - Allow casting operators to work directly on
913 /// SDValues as if they were SDNode*'s.
914 template<> struct simplify_type<SDValue> {
915 typedef SDNode* SimpleType;
916 static SimpleType getSimplifiedValue(const SDValue &Val) {
917 return static_cast<SimpleType>(Val.getNode());
920 template<> struct simplify_type<const SDValue> {
921 typedef SDNode* SimpleType;
922 static SimpleType getSimplifiedValue(const SDValue &Val) {
923 return static_cast<SimpleType>(Val.getNode());
927 /// SDUse - Represents a use of a SDNode. This class holds an SDValue,
928 /// which records the SDNode being used and the result number, a
929 /// pointer to the SDNode using the value, and Next and Prev pointers,
930 /// which link together all the uses of an SDNode.
933 /// Val - The value being used.
935 /// User - The user of this value.
937 /// Prev, Next - Pointers to the uses list of the SDNode referred by
941 SDUse(const SDUse &U); // Do not implement
942 void operator=(const SDUse &U); // Do not implement
945 SDUse() : Val(), User(NULL), Prev(NULL), Next(NULL) {}
947 /// Normally SDUse will just implicitly convert to an SDValue that it holds.
948 operator const SDValue&() const { return Val; }
950 /// If implicit conversion to SDValue doesn't work, the get() method returns
952 const SDValue &get() const { return Val; }
954 /// getUser - This returns the SDNode that contains this Use.
955 SDNode *getUser() { return User; }
957 /// getNext - Get the next SDUse in the use list.
958 SDUse *getNext() const { return Next; }
960 /// getNode - Convenience function for get().getNode().
961 SDNode *getNode() const { return Val.getNode(); }
962 /// getResNo - Convenience function for get().getResNo().
963 unsigned getResNo() const { return Val.getResNo(); }
964 /// getValueType - Convenience function for get().getValueType().
965 EVT getValueType() const { return Val.getValueType(); }
967 /// operator== - Convenience function for get().operator==
968 bool operator==(const SDValue &V) const {
972 /// operator!= - Convenience function for get().operator!=
973 bool operator!=(const SDValue &V) const {
977 /// operator< - Convenience function for get().operator<
978 bool operator<(const SDValue &V) const {
983 friend class SelectionDAG;
986 void setUser(SDNode *p) { User = p; }
988 /// set - Remove this use from its existing use list, assign it the
989 /// given value, and add it to the new value's node's use list.
990 inline void set(const SDValue &V);
991 /// setInitial - like set, but only supports initializing a newly-allocated
992 /// SDUse with a non-null value.
993 inline void setInitial(const SDValue &V);
994 /// setNode - like set, but only sets the Node portion of the value,
995 /// leaving the ResNo portion unmodified.
996 inline void setNode(SDNode *N);
998 void addToList(SDUse **List) {
1000 if (Next) Next->Prev = &Next;
1005 void removeFromList() {
1007 if (Next) Next->Prev = Prev;
1011 /// simplify_type specializations - Allow casting operators to work directly on
1012 /// SDValues as if they were SDNode*'s.
1013 template<> struct simplify_type<SDUse> {
1014 typedef SDNode* SimpleType;
1015 static SimpleType getSimplifiedValue(const SDUse &Val) {
1016 return static_cast<SimpleType>(Val.getNode());
1019 template<> struct simplify_type<const SDUse> {
1020 typedef SDNode* SimpleType;
1021 static SimpleType getSimplifiedValue(const SDUse &Val) {
1022 return static_cast<SimpleType>(Val.getNode());
1027 /// SDNode - Represents one node in the SelectionDAG.
1029 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
1031 /// NodeType - The operation that this node performs.
1035 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
1036 /// then they will be delete[]'d when the node is destroyed.
1037 unsigned short OperandsNeedDelete : 1;
1040 /// SubclassData - This member is defined by this class, but is not used for
1041 /// anything. Subclasses can use it to hold whatever state they find useful.
1042 /// This field is initialized to zero by the ctor.
1043 unsigned short SubclassData : 15;
1046 /// NodeId - Unique id per SDNode in the DAG.
1049 /// OperandList - The values that are used by this operation.
1053 /// ValueList - The types of the values this node defines. SDNode's may
1054 /// define multiple values simultaneously.
1055 const EVT *ValueList;
1057 /// UseList - List of uses for this SDNode.
1060 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
1061 unsigned short NumOperands, NumValues;
1063 /// debugLoc - source line information.
1066 /// getValueTypeList - Return a pointer to the specified value type.
1067 static const EVT *getValueTypeList(EVT VT);
1069 friend class SelectionDAG;
1070 friend struct ilist_traits<SDNode>;
1073 //===--------------------------------------------------------------------===//
1077 /// getOpcode - Return the SelectionDAG opcode value for this node. For
1078 /// pre-isel nodes (those for which isMachineOpcode returns false), these
1079 /// are the opcode values in the ISD and <target>ISD namespaces. For
1080 /// post-isel opcodes, see getMachineOpcode.
1081 unsigned getOpcode() const { return (unsigned short)NodeType; }
1083 /// isTargetOpcode - Test if this node has a target-specific opcode (in the
1084 /// \<target\>ISD namespace).
1085 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
1087 /// isMachineOpcode - Test if this node has a post-isel opcode, directly
1088 /// corresponding to a MachineInstr opcode.
1089 bool isMachineOpcode() const { return NodeType < 0; }
1091 /// getMachineOpcode - This may only be called if isMachineOpcode returns
1092 /// true. It returns the MachineInstr opcode value that the node's opcode
1094 unsigned getMachineOpcode() const {
1095 assert(isMachineOpcode() && "Not a MachineInstr opcode!");
1099 /// use_empty - Return true if there are no uses of this node.
1101 bool use_empty() const { return UseList == NULL; }
1103 /// hasOneUse - Return true if there is exactly one use of this node.
1105 bool hasOneUse() const {
1106 return !use_empty() && next(use_begin()) == use_end();
1109 /// use_size - Return the number of uses of this node. This method takes
1110 /// time proportional to the number of uses.
1112 size_t use_size() const { return std::distance(use_begin(), use_end()); }
1114 /// getNodeId - Return the unique node id.
1116 int getNodeId() const { return NodeId; }
1118 /// setNodeId - Set unique node id.
1119 void setNodeId(int Id) { NodeId = Id; }
1121 /// getDebugLoc - Return the source location info.
1122 const DebugLoc getDebugLoc() const { return debugLoc; }
1124 /// setDebugLoc - Set source location info. Try to avoid this, putting
1125 /// it in the constructor is preferable.
1126 void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
1128 /// use_iterator - This class provides iterator support for SDUse
1129 /// operands that use a specific SDNode.
1131 : public std::iterator<std::forward_iterator_tag, SDUse, ptrdiff_t> {
1133 explicit use_iterator(SDUse *op) : Op(op) {
1135 friend class SDNode;
1137 typedef std::iterator<std::forward_iterator_tag,
1138 SDUse, ptrdiff_t>::reference reference;
1139 typedef std::iterator<std::forward_iterator_tag,
1140 SDUse, ptrdiff_t>::pointer pointer;
1142 use_iterator(const use_iterator &I) : Op(I.Op) {}
1143 use_iterator() : Op(0) {}
1145 bool operator==(const use_iterator &x) const {
1148 bool operator!=(const use_iterator &x) const {
1149 return !operator==(x);
1152 /// atEnd - return true if this iterator is at the end of uses list.
1153 bool atEnd() const { return Op == 0; }
1155 // Iterator traversal: forward iteration only.
1156 use_iterator &operator++() { // Preincrement
1157 assert(Op && "Cannot increment end iterator!");
1162 use_iterator operator++(int) { // Postincrement
1163 use_iterator tmp = *this; ++*this; return tmp;
1166 /// Retrieve a pointer to the current user node.
1167 SDNode *operator*() const {
1168 assert(Op && "Cannot dereference end iterator!");
1169 return Op->getUser();
1172 SDNode *operator->() const { return operator*(); }
1174 SDUse &getUse() const { return *Op; }
1176 /// getOperandNo - Retrieve the operand # of this use in its user.
1178 unsigned getOperandNo() const {
1179 assert(Op && "Cannot dereference end iterator!");
1180 return (unsigned)(Op - Op->getUser()->OperandList);
1184 /// use_begin/use_end - Provide iteration support to walk over all uses
1187 use_iterator use_begin() const {
1188 return use_iterator(UseList);
1191 static use_iterator use_end() { return use_iterator(0); }
1194 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
1195 /// indicated value. This method ignores uses of other values defined by this
1197 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
1199 /// hasAnyUseOfValue - Return true if there are any use of the indicated
1200 /// value. This method ignores uses of other values defined by this operation.
1201 bool hasAnyUseOfValue(unsigned Value) const;
1203 /// isOnlyUserOf - Return true if this node is the only use of N.
1205 bool isOnlyUserOf(SDNode *N) const;
1207 /// isOperandOf - Return true if this node is an operand of N.
1209 bool isOperandOf(SDNode *N) const;
1211 /// isPredecessorOf - Return true if this node is a predecessor of N. This
1212 /// node is either an operand of N or it can be reached by recursively
1213 /// traversing up the operands.
1214 /// NOTE: this is an expensive method. Use it carefully.
1215 bool isPredecessorOf(SDNode *N) const;
1217 /// getNumOperands - Return the number of values used by this operation.
1219 unsigned getNumOperands() const { return NumOperands; }
1221 /// getConstantOperandVal - Helper method returns the integer value of a
1222 /// ConstantSDNode operand.
1223 uint64_t getConstantOperandVal(unsigned Num) const;
1225 const SDValue &getOperand(unsigned Num) const {
1226 assert(Num < NumOperands && "Invalid child # of SDNode!");
1227 return OperandList[Num];
1230 typedef SDUse* op_iterator;
1231 op_iterator op_begin() const { return OperandList; }
1232 op_iterator op_end() const { return OperandList+NumOperands; }
1234 SDVTList getVTList() const {
1235 SDVTList X = { ValueList, NumValues };
1239 /// getFlaggedNode - If this node has a flag operand, return the node
1240 /// to which the flag operand points. Otherwise return NULL.
1241 SDNode *getFlaggedNode() const {
1242 if (getNumOperands() != 0 &&
1243 getOperand(getNumOperands()-1).getValueType().getSimpleVT() == MVT::Flag)
1244 return getOperand(getNumOperands()-1).getNode();
1248 // If this is a pseudo op, like copyfromreg, look to see if there is a
1249 // real target node flagged to it. If so, return the target node.
1250 const SDNode *getFlaggedMachineNode() const {
1251 const SDNode *FoundNode = this;
1253 // Climb up flag edges until a machine-opcode node is found, or the
1254 // end of the chain is reached.
1255 while (!FoundNode->isMachineOpcode()) {
1256 const SDNode *N = FoundNode->getFlaggedNode();
1264 /// getNumValues - Return the number of values defined/returned by this
1267 unsigned getNumValues() const { return NumValues; }
1269 /// getValueType - Return the type of a specified result.
1271 EVT getValueType(unsigned ResNo) const {
1272 assert(ResNo < NumValues && "Illegal result number!");
1273 return ValueList[ResNo];
1276 /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType(ResNo)).
1278 unsigned getValueSizeInBits(unsigned ResNo) const {
1279 return getValueType(ResNo).getSizeInBits();
1282 typedef const EVT* value_iterator;
1283 value_iterator value_begin() const { return ValueList; }
1284 value_iterator value_end() const { return ValueList+NumValues; }
1286 /// getOperationName - Return the opcode of this operation for printing.
1288 std::string getOperationName(const SelectionDAG *G = 0) const;
1289 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
1290 void print_types(raw_ostream &OS, const SelectionDAG *G) const;
1291 void print_details(raw_ostream &OS, const SelectionDAG *G) const;
1292 void print(raw_ostream &OS, const SelectionDAG *G = 0) const;
1293 void printr(raw_ostream &OS, const SelectionDAG *G = 0) const;
1296 void dump(const SelectionDAG *G) const;
1298 static bool classof(const SDNode *) { return true; }
1300 /// Profile - Gather unique data for the node.
1302 void Profile(FoldingSetNodeID &ID) const;
1304 /// addUse - This method should only be used by the SDUse class.
1306 void addUse(SDUse &U) { U.addToList(&UseList); }
1309 static SDVTList getSDVTList(EVT VT) {
1310 SDVTList Ret = { getValueTypeList(VT), 1 };
1314 SDNode(unsigned Opc, const DebugLoc dl, SDVTList VTs, const SDValue *Ops,
1316 : NodeType(Opc), OperandsNeedDelete(true), SubclassData(0),
1318 OperandList(NumOps ? new SDUse[NumOps] : 0),
1319 ValueList(VTs.VTs), UseList(NULL),
1320 NumOperands(NumOps), NumValues(VTs.NumVTs),
1322 for (unsigned i = 0; i != NumOps; ++i) {
1323 OperandList[i].setUser(this);
1324 OperandList[i].setInitial(Ops[i]);
1328 /// This constructor adds no operands itself; operands can be
1329 /// set later with InitOperands.
1330 SDNode(unsigned Opc, const DebugLoc dl, SDVTList VTs)
1331 : NodeType(Opc), OperandsNeedDelete(false), SubclassData(0),
1332 NodeId(-1), OperandList(0), ValueList(VTs.VTs), UseList(NULL),
1333 NumOperands(0), NumValues(VTs.NumVTs),
1336 /// InitOperands - Initialize the operands list of this with 1 operand.
1337 void InitOperands(SDUse *Ops, const SDValue &Op0) {
1338 Ops[0].setUser(this);
1339 Ops[0].setInitial(Op0);
1344 /// InitOperands - Initialize the operands list of this with 2 operands.
1345 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1) {
1346 Ops[0].setUser(this);
1347 Ops[0].setInitial(Op0);
1348 Ops[1].setUser(this);
1349 Ops[1].setInitial(Op1);
1354 /// InitOperands - Initialize the operands list of this with 3 operands.
1355 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
1356 const SDValue &Op2) {
1357 Ops[0].setUser(this);
1358 Ops[0].setInitial(Op0);
1359 Ops[1].setUser(this);
1360 Ops[1].setInitial(Op1);
1361 Ops[2].setUser(this);
1362 Ops[2].setInitial(Op2);
1367 /// InitOperands - Initialize the operands list of this with 4 operands.
1368 void InitOperands(SDUse *Ops, const SDValue &Op0, const SDValue &Op1,
1369 const SDValue &Op2, const SDValue &Op3) {
1370 Ops[0].setUser(this);
1371 Ops[0].setInitial(Op0);
1372 Ops[1].setUser(this);
1373 Ops[1].setInitial(Op1);
1374 Ops[2].setUser(this);
1375 Ops[2].setInitial(Op2);
1376 Ops[3].setUser(this);
1377 Ops[3].setInitial(Op3);
1382 /// InitOperands - Initialize the operands list of this with N operands.
1383 void InitOperands(SDUse *Ops, const SDValue *Vals, unsigned N) {
1384 for (unsigned i = 0; i != N; ++i) {
1385 Ops[i].setUser(this);
1386 Ops[i].setInitial(Vals[i]);
1392 /// DropOperands - Release the operands and set this node to have
1394 void DropOperands();
1398 // Define inline functions from the SDValue class.
1400 inline unsigned SDValue::getOpcode() const {
1401 return Node->getOpcode();
1403 inline EVT SDValue::getValueType() const {
1404 return Node->getValueType(ResNo);
1406 inline unsigned SDValue::getNumOperands() const {
1407 return Node->getNumOperands();
1409 inline const SDValue &SDValue::getOperand(unsigned i) const {
1410 return Node->getOperand(i);
1412 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
1413 return Node->getConstantOperandVal(i);
1415 inline bool SDValue::isTargetOpcode() const {
1416 return Node->isTargetOpcode();
1418 inline bool SDValue::isMachineOpcode() const {
1419 return Node->isMachineOpcode();
1421 inline unsigned SDValue::getMachineOpcode() const {
1422 return Node->getMachineOpcode();
1424 inline bool SDValue::use_empty() const {
1425 return !Node->hasAnyUseOfValue(ResNo);
1427 inline bool SDValue::hasOneUse() const {
1428 return Node->hasNUsesOfValue(1, ResNo);
1430 inline const DebugLoc SDValue::getDebugLoc() const {
1431 return Node->getDebugLoc();
1434 // Define inline functions from the SDUse class.
1436 inline void SDUse::set(const SDValue &V) {
1437 if (Val.getNode()) removeFromList();
1439 if (V.getNode()) V.getNode()->addUse(*this);
1442 inline void SDUse::setInitial(const SDValue &V) {
1444 V.getNode()->addUse(*this);
1447 inline void SDUse::setNode(SDNode *N) {
1448 if (Val.getNode()) removeFromList();
1450 if (N) N->addUse(*this);
1453 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
1454 /// to allow co-allocation of node operands with the node itself.
1455 class UnarySDNode : public SDNode {
1458 UnarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X)
1459 : SDNode(Opc, dl, VTs) {
1460 InitOperands(&Op, X);
1464 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
1465 /// to allow co-allocation of node operands with the node itself.
1466 class BinarySDNode : public SDNode {
1469 BinarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X, SDValue Y)
1470 : SDNode(Opc, dl, VTs) {
1471 InitOperands(Ops, X, Y);
1475 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
1476 /// to allow co-allocation of node operands with the node itself.
1477 class TernarySDNode : public SDNode {
1480 TernarySDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, SDValue X, SDValue Y,
1482 : SDNode(Opc, dl, VTs) {
1483 InitOperands(Ops, X, Y, Z);
1488 /// HandleSDNode - This class is used to form a handle around another node that
1489 /// is persistant and is updated across invocations of replaceAllUsesWith on its
1490 /// operand. This node should be directly created by end-users and not added to
1491 /// the AllNodes list.
1492 class HandleSDNode : public SDNode {
1495 // FIXME: Remove the "noinline" attribute once <rdar://problem/5852746> is
1498 explicit __attribute__((__noinline__)) HandleSDNode(SDValue X)
1500 explicit HandleSDNode(SDValue X)
1502 : SDNode(ISD::HANDLENODE, DebugLoc::getUnknownLoc(),
1503 getSDVTList(MVT::Other)) {
1504 InitOperands(&Op, X);
1507 const SDValue &getValue() const { return Op; }
1510 /// Abstact virtual class for operations for memory operations
1511 class MemSDNode : public SDNode {
1513 // MemoryVT - VT of in-memory value.
1516 //! SrcValue - Memory location for alias analysis.
1517 const Value *SrcValue;
1519 //! SVOffset - Memory location offset. Note that base is defined in MemSDNode
1522 //! OrigAlign - The original alignment of this MemSDNode in the case where
1523 // this node was created by legalize from a MemSDNode with known alignment.
1527 MemSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, EVT MemoryVT,
1528 const Value *srcValue, int SVOff,
1529 unsigned alignment, bool isvolatile, unsigned oalign);
1531 MemSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs, const SDValue *Ops,
1532 unsigned NumOps, EVT MemoryVT, const Value *srcValue, int SVOff,
1533 unsigned alignment, bool isvolatile, unsigned oalign);
1535 /// Returns alignment and volatility of the memory access
1536 unsigned getAlignment() const { return (1u << (SubclassData >> 6)) >> 1; }
1537 unsigned getOriginalAlignment() const { return OrigAlign; }
1538 bool isVolatile() const { return (SubclassData >> 5) & 1; }
1540 /// getRawSubclassData - Return the SubclassData value, which contains an
1541 /// encoding of the alignment and volatile information, as well as bits
1542 /// used by subclasses. This function should only be used to compute a
1543 /// FoldingSetNodeID value.
1544 unsigned getRawSubclassData() const {
1545 return SubclassData;
1548 /// Returns the SrcValue and offset that describes the location of the access
1549 const Value *getSrcValue() const { return SrcValue; }
1550 int getSrcValueOffset() const { return SVOffset; }
1552 /// getMemoryVT - Return the type of the in-memory value.
1553 EVT getMemoryVT() const { return MemoryVT; }
1555 /// getMemOperand - Return a MachineMemOperand object describing the memory
1556 /// reference performed by operation.
1557 MachineMemOperand getMemOperand() const;
1559 const SDValue &getChain() const { return getOperand(0); }
1560 const SDValue &getBasePtr() const {
1561 return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
1564 // Methods to support isa and dyn_cast
1565 static bool classof(const MemSDNode *) { return true; }
1566 static bool classof(const SDNode *N) {
1567 // For some targets, we lower some target intrinsics to a MemIntrinsicNode
1568 // with either an intrinsic or a target opcode.
1569 return N->getOpcode() == ISD::LOAD ||
1570 N->getOpcode() == ISD::STORE ||
1571 N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1572 N->getOpcode() == ISD::ATOMIC_SWAP ||
1573 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1574 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1575 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1576 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1577 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1578 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1579 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1580 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1581 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1582 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX ||
1583 N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1584 N->getOpcode() == ISD::INTRINSIC_VOID ||
1585 N->isTargetOpcode();
1589 /// AtomicSDNode - A SDNode reprenting atomic operations.
1591 class AtomicSDNode : public MemSDNode {
1595 // Opc: opcode for atomic
1596 // VTL: value type list
1597 // Chain: memory chain for operaand
1598 // Ptr: address to update as a SDValue
1599 // Cmp: compare value
1601 // SrcVal: address to update as a Value (used for MemOperand)
1602 // Align: alignment of memory
1603 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, EVT MemVT,
1604 SDValue Chain, SDValue Ptr,
1605 SDValue Cmp, SDValue Swp, const Value* SrcVal,
1607 : MemSDNode(Opc, dl, VTL, MemVT, SrcVal, /*SVOffset=*/0,
1608 Align, /*isVolatile=*/true, /* OrigAlign=*/0) {
1609 InitOperands(Ops, Chain, Ptr, Cmp, Swp);
1611 AtomicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTL, EVT MemVT,
1612 SDValue Chain, SDValue Ptr,
1613 SDValue Val, const Value* SrcVal, unsigned Align=0)
1614 : MemSDNode(Opc, dl, VTL, MemVT, SrcVal, /*SVOffset=*/0,
1615 Align, /*isVolatile=*/true, /* OrigAlign=*/0) {
1616 InitOperands(Ops, Chain, Ptr, Val);
1619 const SDValue &getBasePtr() const { return getOperand(1); }
1620 const SDValue &getVal() const { return getOperand(2); }
1622 bool isCompareAndSwap() const {
1623 unsigned Op = getOpcode();
1624 return Op == ISD::ATOMIC_CMP_SWAP;
1627 // Methods to support isa and dyn_cast
1628 static bool classof(const AtomicSDNode *) { return true; }
1629 static bool classof(const SDNode *N) {
1630 return N->getOpcode() == ISD::ATOMIC_CMP_SWAP ||
1631 N->getOpcode() == ISD::ATOMIC_SWAP ||
1632 N->getOpcode() == ISD::ATOMIC_LOAD_ADD ||
1633 N->getOpcode() == ISD::ATOMIC_LOAD_SUB ||
1634 N->getOpcode() == ISD::ATOMIC_LOAD_AND ||
1635 N->getOpcode() == ISD::ATOMIC_LOAD_OR ||
1636 N->getOpcode() == ISD::ATOMIC_LOAD_XOR ||
1637 N->getOpcode() == ISD::ATOMIC_LOAD_NAND ||
1638 N->getOpcode() == ISD::ATOMIC_LOAD_MIN ||
1639 N->getOpcode() == ISD::ATOMIC_LOAD_MAX ||
1640 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN ||
1641 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX;
1645 /// MemIntrinsicSDNode - This SDNode is used for target intrinsic that touches
1646 /// memory and need an associated memory operand.
1648 class MemIntrinsicSDNode : public MemSDNode {
1649 bool ReadMem; // Intrinsic reads memory
1650 bool WriteMem; // Intrinsic writes memory
1652 MemIntrinsicSDNode(unsigned Opc, DebugLoc dl, SDVTList VTs,
1653 const SDValue *Ops, unsigned NumOps,
1654 EVT MemoryVT, const Value *srcValue, int SVO,
1655 unsigned Align, bool Vol, bool ReadMem, bool WriteMem)
1656 : MemSDNode(Opc, dl, VTs, Ops, NumOps, MemoryVT, srcValue, SVO, Align, Vol,
1658 ReadMem(ReadMem), WriteMem(WriteMem) {
1661 bool readMem() const { return ReadMem; }
1662 bool writeMem() const { return WriteMem; }
1664 // Methods to support isa and dyn_cast
1665 static bool classof(const MemIntrinsicSDNode *) { return true; }
1666 static bool classof(const SDNode *N) {
1667 // We lower some target intrinsics to their target opcode
1668 // early a node with a target opcode can be of this class
1669 return N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1670 N->getOpcode() == ISD::INTRINSIC_VOID ||
1671 N->isTargetOpcode();
1675 /// ShuffleVectorSDNode - This SDNode is used to implement the code generator
1676 /// support for the llvm IR shufflevector instruction. It combines elements
1677 /// from two input vectors into a new input vector, with the selection and
1678 /// ordering of elements determined by an array of integers, referred to as
1679 /// the shuffle mask. For input vectors of width N, mask indices of 0..N-1
1680 /// refer to elements from the LHS input, and indices from N to 2N-1 the RHS.
1681 /// An index of -1 is treated as undef, such that the code generator may put
1682 /// any value in the corresponding element of the result.
1683 class ShuffleVectorSDNode : public SDNode {
1686 // The memory for Mask is owned by the SelectionDAG's OperandAllocator, and
1687 // is freed when the SelectionDAG object is destroyed.
1690 friend class SelectionDAG;
1691 ShuffleVectorSDNode(EVT VT, DebugLoc dl, SDValue N1, SDValue N2,
1693 : SDNode(ISD::VECTOR_SHUFFLE, dl, getSDVTList(VT)), Mask(M) {
1694 InitOperands(Ops, N1, N2);
1698 void getMask(SmallVectorImpl<int> &M) const {
1699 EVT VT = getValueType(0);
1701 for (unsigned i = 0, e = VT.getVectorNumElements(); i != e; ++i)
1702 M.push_back(Mask[i]);
1704 int getMaskElt(unsigned Idx) const {
1705 assert(Idx < getValueType(0).getVectorNumElements() && "Idx out of range!");
1709 bool isSplat() const { return isSplatMask(Mask, getValueType(0)); }
1710 int getSplatIndex() const {
1711 assert(isSplat() && "Cannot get splat index for non-splat!");
1714 static bool isSplatMask(const int *Mask, EVT VT);
1716 static bool classof(const ShuffleVectorSDNode *) { return true; }
1717 static bool classof(const SDNode *N) {
1718 return N->getOpcode() == ISD::VECTOR_SHUFFLE;
1722 class ConstantSDNode : public SDNode {
1723 const ConstantInt *Value;
1724 friend class SelectionDAG;
1725 ConstantSDNode(bool isTarget, const ConstantInt *val, EVT VT)
1726 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant,
1727 DebugLoc::getUnknownLoc(), getSDVTList(VT)), Value(val) {
1731 const ConstantInt *getConstantIntValue() const { return Value; }
1732 const APInt &getAPIntValue() const { return Value->getValue(); }
1733 uint64_t getZExtValue() const { return Value->getZExtValue(); }
1734 int64_t getSExtValue() const { return Value->getSExtValue(); }
1736 bool isNullValue() const { return Value->isNullValue(); }
1737 bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1739 static bool classof(const ConstantSDNode *) { return true; }
1740 static bool classof(const SDNode *N) {
1741 return N->getOpcode() == ISD::Constant ||
1742 N->getOpcode() == ISD::TargetConstant;
1746 class ConstantFPSDNode : public SDNode {
1747 const ConstantFP *Value;
1748 friend class SelectionDAG;
1749 ConstantFPSDNode(bool isTarget, const ConstantFP *val, EVT VT)
1750 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1751 DebugLoc::getUnknownLoc(), getSDVTList(VT)), Value(val) {
1755 const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1756 const ConstantFP *getConstantFPValue() const { return Value; }
1758 /// isExactlyValue - We don't rely on operator== working on double values, as
1759 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1760 /// As such, this method can be used to do an exact bit-for-bit comparison of
1761 /// two floating point values.
1763 /// We leave the version with the double argument here because it's just so
1764 /// convenient to write "2.0" and the like. Without this function we'd
1765 /// have to duplicate its logic everywhere it's called.
1766 bool isExactlyValue(double V) const {
1768 // convert is not supported on this type
1769 if (&Value->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
1772 Tmp.convert(Value->getValueAPF().getSemantics(),
1773 APFloat::rmNearestTiesToEven, &ignored);
1774 return isExactlyValue(Tmp);
1776 bool isExactlyValue(const APFloat& V) const;
1778 bool isValueValidForType(EVT VT, const APFloat& Val);
1780 static bool classof(const ConstantFPSDNode *) { return true; }
1781 static bool classof(const SDNode *N) {
1782 return N->getOpcode() == ISD::ConstantFP ||
1783 N->getOpcode() == ISD::TargetConstantFP;
1787 class GlobalAddressSDNode : public SDNode {
1788 GlobalValue *TheGlobal;
1790 unsigned char TargetFlags;
1791 friend class SelectionDAG;
1792 GlobalAddressSDNode(unsigned Opc, const GlobalValue *GA, EVT VT,
1793 int64_t o, unsigned char TargetFlags);
1796 GlobalValue *getGlobal() const { return TheGlobal; }
1797 int64_t getOffset() const { return Offset; }
1798 unsigned char getTargetFlags() const { return TargetFlags; }
1799 // Return the address space this GlobalAddress belongs to.
1800 unsigned getAddressSpace() const;
1802 static bool classof(const GlobalAddressSDNode *) { return true; }
1803 static bool classof(const SDNode *N) {
1804 return N->getOpcode() == ISD::GlobalAddress ||
1805 N->getOpcode() == ISD::TargetGlobalAddress ||
1806 N->getOpcode() == ISD::GlobalTLSAddress ||
1807 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1811 class FrameIndexSDNode : public SDNode {
1813 friend class SelectionDAG;
1814 FrameIndexSDNode(int fi, EVT VT, bool isTarg)
1815 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex,
1816 DebugLoc::getUnknownLoc(), getSDVTList(VT)), FI(fi) {
1820 int getIndex() const { return FI; }
1822 static bool classof(const FrameIndexSDNode *) { return true; }
1823 static bool classof(const SDNode *N) {
1824 return N->getOpcode() == ISD::FrameIndex ||
1825 N->getOpcode() == ISD::TargetFrameIndex;
1829 class JumpTableSDNode : public SDNode {
1831 unsigned char TargetFlags;
1832 friend class SelectionDAG;
1833 JumpTableSDNode(int jti, EVT VT, bool isTarg, unsigned char TF)
1834 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable,
1835 DebugLoc::getUnknownLoc(), getSDVTList(VT)), JTI(jti), TargetFlags(TF) {
1839 int getIndex() const { return JTI; }
1840 unsigned char getTargetFlags() const { return TargetFlags; }
1842 static bool classof(const JumpTableSDNode *) { return true; }
1843 static bool classof(const SDNode *N) {
1844 return N->getOpcode() == ISD::JumpTable ||
1845 N->getOpcode() == ISD::TargetJumpTable;
1849 class ConstantPoolSDNode : public SDNode {
1852 MachineConstantPoolValue *MachineCPVal;
1854 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1855 unsigned Alignment; // Minimum alignment requirement of CP (not log2 value).
1856 unsigned char TargetFlags;
1857 friend class SelectionDAG;
1858 ConstantPoolSDNode(bool isTarget, Constant *c, EVT VT, int o, unsigned Align,
1860 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1861 DebugLoc::getUnknownLoc(),
1862 getSDVTList(VT)), Offset(o), Alignment(Align), TargetFlags(TF) {
1863 assert((int)Offset >= 0 && "Offset is too large");
1866 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1867 EVT VT, int o, unsigned Align, unsigned char TF)
1868 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1869 DebugLoc::getUnknownLoc(),
1870 getSDVTList(VT)), Offset(o), Alignment(Align), TargetFlags(TF) {
1871 assert((int)Offset >= 0 && "Offset is too large");
1872 Val.MachineCPVal = v;
1873 Offset |= 1 << (sizeof(unsigned)*CHAR_BIT-1);
1878 bool isMachineConstantPoolEntry() const {
1879 return (int)Offset < 0;
1882 Constant *getConstVal() const {
1883 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1884 return Val.ConstVal;
1887 MachineConstantPoolValue *getMachineCPVal() const {
1888 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1889 return Val.MachineCPVal;
1892 int getOffset() const {
1893 return Offset & ~(1 << (sizeof(unsigned)*CHAR_BIT-1));
1896 // Return the alignment of this constant pool object, which is either 0 (for
1897 // default alignment) or the desired value.
1898 unsigned getAlignment() const { return Alignment; }
1899 unsigned char getTargetFlags() const { return TargetFlags; }
1901 const Type *getType() const;
1903 static bool classof(const ConstantPoolSDNode *) { return true; }
1904 static bool classof(const SDNode *N) {
1905 return N->getOpcode() == ISD::ConstantPool ||
1906 N->getOpcode() == ISD::TargetConstantPool;
1910 class BasicBlockSDNode : public SDNode {
1911 MachineBasicBlock *MBB;
1912 friend class SelectionDAG;
1913 /// Debug info is meaningful and potentially useful here, but we create
1914 /// blocks out of order when they're jumped to, which makes it a bit
1915 /// harder. Let's see if we need it first.
1916 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1917 : SDNode(ISD::BasicBlock, DebugLoc::getUnknownLoc(),
1918 getSDVTList(MVT::Other)), MBB(mbb) {
1922 MachineBasicBlock *getBasicBlock() const { return MBB; }
1924 static bool classof(const BasicBlockSDNode *) { return true; }
1925 static bool classof(const SDNode *N) {
1926 return N->getOpcode() == ISD::BasicBlock;
1930 /// BuildVectorSDNode - A "pseudo-class" with methods for operating on
1932 class BuildVectorSDNode : public SDNode {
1933 // These are constructed as SDNodes and then cast to BuildVectorSDNodes.
1934 explicit BuildVectorSDNode(); // Do not implement
1936 /// isConstantSplat - Check if this is a constant splat, and if so, find the
1937 /// smallest element size that splats the vector. If MinSplatBits is
1938 /// nonzero, the element size must be at least that large. Note that the
1939 /// splat element may be the entire vector (i.e., a one element vector).
1940 /// Returns the splat element value in SplatValue. Any undefined bits in
1941 /// that value are zero, and the corresponding bits in the SplatUndef mask
1942 /// are set. The SplatBitSize value is set to the splat element size in
1943 /// bits. HasAnyUndefs is set to true if any bits in the vector are
1945 bool isConstantSplat(APInt &SplatValue, APInt &SplatUndef,
1946 unsigned &SplatBitSize, bool &HasAnyUndefs,
1947 unsigned MinSplatBits = 0);
1949 static inline bool classof(const BuildVectorSDNode *) { return true; }
1950 static inline bool classof(const SDNode *N) {
1951 return N->getOpcode() == ISD::BUILD_VECTOR;
1955 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1956 /// used when the SelectionDAG needs to make a simple reference to something
1957 /// in the LLVM IR representation.
1959 /// Note that this is not used for carrying alias information; that is done
1960 /// with MemOperandSDNode, which includes a Value which is required to be a
1961 /// pointer, and several other fields specific to memory references.
1963 class SrcValueSDNode : public SDNode {
1965 friend class SelectionDAG;
1966 /// Create a SrcValue for a general value.
1967 explicit SrcValueSDNode(const Value *v)
1968 : SDNode(ISD::SRCVALUE, DebugLoc::getUnknownLoc(),
1969 getSDVTList(MVT::Other)), V(v) {}
1972 /// getValue - return the contained Value.
1973 const Value *getValue() const { return V; }
1975 static bool classof(const SrcValueSDNode *) { return true; }
1976 static bool classof(const SDNode *N) {
1977 return N->getOpcode() == ISD::SRCVALUE;
1982 /// MemOperandSDNode - An SDNode that holds a MachineMemOperand. This is
1983 /// used to represent a reference to memory after ISD::LOAD
1984 /// and ISD::STORE have been lowered.
1986 class MemOperandSDNode : public SDNode {
1987 friend class SelectionDAG;
1988 /// Create a MachineMemOperand node
1989 explicit MemOperandSDNode(const MachineMemOperand &mo)
1990 : SDNode(ISD::MEMOPERAND, DebugLoc::getUnknownLoc(),
1991 getSDVTList(MVT::Other)), MO(mo) {}
1994 /// MO - The contained MachineMemOperand.
1995 const MachineMemOperand MO;
1997 static bool classof(const MemOperandSDNode *) { return true; }
1998 static bool classof(const SDNode *N) {
1999 return N->getOpcode() == ISD::MEMOPERAND;
2004 class RegisterSDNode : public SDNode {
2006 friend class SelectionDAG;
2007 RegisterSDNode(unsigned reg, EVT VT)
2008 : SDNode(ISD::Register, DebugLoc::getUnknownLoc(),
2009 getSDVTList(VT)), Reg(reg) {
2013 unsigned getReg() const { return Reg; }
2015 static bool classof(const RegisterSDNode *) { return true; }
2016 static bool classof(const SDNode *N) {
2017 return N->getOpcode() == ISD::Register;
2021 class DbgStopPointSDNode : public SDNode {
2026 friend class SelectionDAG;
2027 DbgStopPointSDNode(SDValue ch, unsigned l, unsigned c,
2029 : SDNode(ISD::DBG_STOPPOINT, DebugLoc::getUnknownLoc(),
2030 getSDVTList(MVT::Other)), Line(l), Column(c), CU(cu) {
2031 InitOperands(&Chain, ch);
2034 unsigned getLine() const { return Line; }
2035 unsigned getColumn() const { return Column; }
2036 MDNode *getCompileUnit() const { return CU; }
2038 static bool classof(const DbgStopPointSDNode *) { return true; }
2039 static bool classof(const SDNode *N) {
2040 return N->getOpcode() == ISD::DBG_STOPPOINT;
2044 class LabelSDNode : public SDNode {
2047 friend class SelectionDAG;
2048 LabelSDNode(unsigned NodeTy, DebugLoc dl, SDValue ch, unsigned id)
2049 : SDNode(NodeTy, dl, getSDVTList(MVT::Other)), LabelID(id) {
2050 InitOperands(&Chain, ch);
2053 unsigned getLabelID() const { return LabelID; }
2055 static bool classof(const LabelSDNode *) { return true; }
2056 static bool classof(const SDNode *N) {
2057 return N->getOpcode() == ISD::DBG_LABEL ||
2058 N->getOpcode() == ISD::EH_LABEL;
2062 class ExternalSymbolSDNode : public SDNode {
2064 unsigned char TargetFlags;
2066 friend class SelectionDAG;
2067 ExternalSymbolSDNode(bool isTarget, const char *Sym, unsigned char TF, EVT VT)
2068 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
2069 DebugLoc::getUnknownLoc(),
2070 getSDVTList(VT)), Symbol(Sym), TargetFlags(TF) {
2074 const char *getSymbol() const { return Symbol; }
2075 unsigned char getTargetFlags() const { return TargetFlags; }
2077 static bool classof(const ExternalSymbolSDNode *) { return true; }
2078 static bool classof(const SDNode *N) {
2079 return N->getOpcode() == ISD::ExternalSymbol ||
2080 N->getOpcode() == ISD::TargetExternalSymbol;
2084 class CondCodeSDNode : public SDNode {
2085 ISD::CondCode Condition;
2086 friend class SelectionDAG;
2087 explicit CondCodeSDNode(ISD::CondCode Cond)
2088 : SDNode(ISD::CONDCODE, DebugLoc::getUnknownLoc(),
2089 getSDVTList(MVT::Other)), Condition(Cond) {
2093 ISD::CondCode get() const { return Condition; }
2095 static bool classof(const CondCodeSDNode *) { return true; }
2096 static bool classof(const SDNode *N) {
2097 return N->getOpcode() == ISD::CONDCODE;
2101 /// CvtRndSatSDNode - NOTE: avoid using this node as this may disappear in the
2102 /// future and most targets don't support it.
2103 class CvtRndSatSDNode : public SDNode {
2104 ISD::CvtCode CvtCode;
2105 friend class SelectionDAG;
2106 explicit CvtRndSatSDNode(EVT VT, DebugLoc dl, const SDValue *Ops,
2107 unsigned NumOps, ISD::CvtCode Code)
2108 : SDNode(ISD::CONVERT_RNDSAT, dl, getSDVTList(VT), Ops, NumOps),
2110 assert(NumOps == 5 && "wrong number of operations");
2113 ISD::CvtCode getCvtCode() const { return CvtCode; }
2115 static bool classof(const CvtRndSatSDNode *) { return true; }
2116 static bool classof(const SDNode *N) {
2117 return N->getOpcode() == ISD::CONVERT_RNDSAT;
2124 static const uint64_t NoFlagSet = 0ULL;
2125 static const uint64_t ZExt = 1ULL<<0; ///< Zero extended
2126 static const uint64_t ZExtOffs = 0;
2127 static const uint64_t SExt = 1ULL<<1; ///< Sign extended
2128 static const uint64_t SExtOffs = 1;
2129 static const uint64_t InReg = 1ULL<<2; ///< Passed in register
2130 static const uint64_t InRegOffs = 2;
2131 static const uint64_t SRet = 1ULL<<3; ///< Hidden struct-ret ptr
2132 static const uint64_t SRetOffs = 3;
2133 static const uint64_t ByVal = 1ULL<<4; ///< Struct passed by value
2134 static const uint64_t ByValOffs = 4;
2135 static const uint64_t Nest = 1ULL<<5; ///< Nested fn static chain
2136 static const uint64_t NestOffs = 5;
2137 static const uint64_t ByValAlign = 0xFULL << 6; //< Struct alignment
2138 static const uint64_t ByValAlignOffs = 6;
2139 static const uint64_t Split = 1ULL << 10;
2140 static const uint64_t SplitOffs = 10;
2141 static const uint64_t OrigAlign = 0x1FULL<<27;
2142 static const uint64_t OrigAlignOffs = 27;
2143 static const uint64_t ByValSize = 0xffffffffULL << 32; //< Struct size
2144 static const uint64_t ByValSizeOffs = 32;
2146 static const uint64_t One = 1ULL; //< 1 of this type, for shifts
2150 ArgFlagsTy() : Flags(0) { }
2152 bool isZExt() const { return Flags & ZExt; }
2153 void setZExt() { Flags |= One << ZExtOffs; }
2155 bool isSExt() const { return Flags & SExt; }
2156 void setSExt() { Flags |= One << SExtOffs; }
2158 bool isInReg() const { return Flags & InReg; }
2159 void setInReg() { Flags |= One << InRegOffs; }
2161 bool isSRet() const { return Flags & SRet; }
2162 void setSRet() { Flags |= One << SRetOffs; }
2164 bool isByVal() const { return Flags & ByVal; }
2165 void setByVal() { Flags |= One << ByValOffs; }
2167 bool isNest() const { return Flags & Nest; }
2168 void setNest() { Flags |= One << NestOffs; }
2170 unsigned getByValAlign() const {
2172 ((One << ((Flags & ByValAlign) >> ByValAlignOffs)) / 2);
2174 void setByValAlign(unsigned A) {
2175 Flags = (Flags & ~ByValAlign) |
2176 (uint64_t(Log2_32(A) + 1) << ByValAlignOffs);
2179 bool isSplit() const { return Flags & Split; }
2180 void setSplit() { Flags |= One << SplitOffs; }
2182 unsigned getOrigAlign() const {
2184 ((One << ((Flags & OrigAlign) >> OrigAlignOffs)) / 2);
2186 void setOrigAlign(unsigned A) {
2187 Flags = (Flags & ~OrigAlign) |
2188 (uint64_t(Log2_32(A) + 1) << OrigAlignOffs);
2191 unsigned getByValSize() const {
2192 return (unsigned)((Flags & ByValSize) >> ByValSizeOffs);
2194 void setByValSize(unsigned S) {
2195 Flags = (Flags & ~ByValSize) | (uint64_t(S) << ByValSizeOffs);
2198 /// getArgFlagsString - Returns the flags as a string, eg: "zext align:4".
2199 std::string getArgFlagsString();
2201 /// getRawBits - Represent the flags as a bunch of bits.
2202 uint64_t getRawBits() const { return Flags; }
2205 /// InputArg - This struct carries flags and type information about a
2206 /// single incoming (formal) argument or incoming (from the perspective
2207 /// of the caller) return value virtual register.
2214 InputArg() : VT(MVT::Other), Used(false) {}
2215 InputArg(ISD::ArgFlagsTy flags, EVT vt, bool used)
2216 : Flags(flags), VT(vt), Used(used) {
2217 assert(VT.isSimple() &&
2218 "InputArg value type must be Simple!");
2222 /// OutputArg - This struct carries flags and a value for a
2223 /// single outgoing (actual) argument or outgoing (from the perspective
2224 /// of the caller) return value virtual register.
2231 OutputArg() : IsFixed(false) {}
2232 OutputArg(ISD::ArgFlagsTy flags, SDValue val, bool isfixed)
2233 : Flags(flags), Val(val), IsFixed(isfixed) {
2234 assert(Val.getValueType().isSimple() &&
2235 "OutputArg value type must be Simple!");
2240 /// VTSDNode - This class is used to represent EVT's, which are used
2241 /// to parameterize some operations.
2242 class VTSDNode : public SDNode {
2244 friend class SelectionDAG;
2245 explicit VTSDNode(EVT VT)
2246 : SDNode(ISD::VALUETYPE, DebugLoc::getUnknownLoc(),
2247 getSDVTList(MVT::Other)), ValueType(VT) {
2251 EVT getVT() const { return ValueType; }
2253 static bool classof(const VTSDNode *) { return true; }
2254 static bool classof(const SDNode *N) {
2255 return N->getOpcode() == ISD::VALUETYPE;
2259 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
2261 class LSBaseSDNode : public MemSDNode {
2262 //! Operand array for load and store
2264 \note Moving this array to the base class captures more
2265 common functionality shared between LoadSDNode and
2270 LSBaseSDNode(ISD::NodeType NodeTy, DebugLoc dl, SDValue *Operands,
2271 unsigned numOperands, SDVTList VTs, ISD::MemIndexedMode AM,
2272 EVT VT, const Value *SV, int SVO, unsigned Align, bool Vol,
2274 : MemSDNode(NodeTy, dl, VTs, VT, SV, SVO, Align, Vol, OAlign) {
2275 assert(Align != 0 && "Loads and stores should have non-zero aligment");
2276 SubclassData |= AM << 2;
2277 assert(getAddressingMode() == AM && "MemIndexedMode encoding error!");
2278 InitOperands(Ops, Operands, numOperands);
2279 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
2280 "Only indexed loads and stores have a non-undef offset operand");
2283 const SDValue &getOffset() const {
2284 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
2287 /// getAddressingMode - Return the addressing mode for this load or store:
2288 /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
2289 ISD::MemIndexedMode getAddressingMode() const {
2290 return ISD::MemIndexedMode((SubclassData >> 2) & 7);
2293 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
2294 bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
2296 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
2297 bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
2299 static bool classof(const LSBaseSDNode *) { return true; }
2300 static bool classof(const SDNode *N) {
2301 return N->getOpcode() == ISD::LOAD ||
2302 N->getOpcode() == ISD::STORE;
2306 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
2308 class LoadSDNode : public LSBaseSDNode {
2309 friend class SelectionDAG;
2310 LoadSDNode(SDValue *ChainPtrOff, DebugLoc dl, SDVTList VTs,
2311 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, EVT LVT,
2312 const Value *SV, int O=0, unsigned Align=0, bool Vol=false,
2314 : LSBaseSDNode(ISD::LOAD, dl, ChainPtrOff, 3,
2315 VTs, AM, LVT, SV, O, Align, Vol, OAlign) {
2316 SubclassData |= (unsigned short)ETy;
2317 assert(getExtensionType() == ETy && "LoadExtType encoding error!");
2321 /// getExtensionType - Return whether this is a plain node,
2322 /// or one of the varieties of value-extending loads.
2323 ISD::LoadExtType getExtensionType() const {
2324 return ISD::LoadExtType(SubclassData & 3);
2327 const SDValue &getBasePtr() const { return getOperand(1); }
2328 const SDValue &getOffset() const { return getOperand(2); }
2330 static bool classof(const LoadSDNode *) { return true; }
2331 static bool classof(const SDNode *N) {
2332 return N->getOpcode() == ISD::LOAD;
2336 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
2338 class StoreSDNode : public LSBaseSDNode {
2339 friend class SelectionDAG;
2340 StoreSDNode(SDValue *ChainValuePtrOff, DebugLoc dl, SDVTList VTs,
2341 ISD::MemIndexedMode AM, bool isTrunc, EVT SVT,
2342 const Value *SV, int O=0, unsigned Align=0, bool Vol=false,
2344 : LSBaseSDNode(ISD::STORE, dl, ChainValuePtrOff, 4,
2345 VTs, AM, SVT, SV, O, Align, Vol, OAlign) {
2346 SubclassData |= (unsigned short)isTrunc;
2347 assert(isTruncatingStore() == isTrunc && "isTrunc encoding error!");
2351 /// isTruncatingStore - Return true if the op does a truncation before store.
2352 /// For integers this is the same as doing a TRUNCATE and storing the result.
2353 /// For floats, it is the same as doing an FP_ROUND and storing the result.
2354 bool isTruncatingStore() const { return SubclassData & 1; }
2356 const SDValue &getValue() const { return getOperand(1); }
2357 const SDValue &getBasePtr() const { return getOperand(2); }
2358 const SDValue &getOffset() const { return getOperand(3); }
2360 static bool classof(const StoreSDNode *) { return true; }
2361 static bool classof(const SDNode *N) {
2362 return N->getOpcode() == ISD::STORE;
2367 class SDNodeIterator : public std::iterator<std::forward_iterator_tag,
2368 SDNode, ptrdiff_t> {
2372 SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
2374 bool operator==(const SDNodeIterator& x) const {
2375 return Operand == x.Operand;
2377 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
2379 const SDNodeIterator &operator=(const SDNodeIterator &I) {
2380 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
2381 Operand = I.Operand;
2385 pointer operator*() const {
2386 return Node->getOperand(Operand).getNode();
2388 pointer operator->() const { return operator*(); }
2390 SDNodeIterator& operator++() { // Preincrement
2394 SDNodeIterator operator++(int) { // Postincrement
2395 SDNodeIterator tmp = *this; ++*this; return tmp;
2398 static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
2399 static SDNodeIterator end (SDNode *N) {
2400 return SDNodeIterator(N, N->getNumOperands());
2403 unsigned getOperand() const { return Operand; }
2404 const SDNode *getNode() const { return Node; }
2407 template <> struct GraphTraits<SDNode*> {
2408 typedef SDNode NodeType;
2409 typedef SDNodeIterator ChildIteratorType;
2410 static inline NodeType *getEntryNode(SDNode *N) { return N; }
2411 static inline ChildIteratorType child_begin(NodeType *N) {
2412 return SDNodeIterator::begin(N);
2414 static inline ChildIteratorType child_end(NodeType *N) {
2415 return SDNodeIterator::end(N);
2419 /// LargestSDNode - The largest SDNode class.
2421 typedef LoadSDNode LargestSDNode;
2423 /// MostAlignedSDNode - The SDNode class with the greatest alignment
2426 typedef GlobalAddressSDNode MostAlignedSDNode;
2429 /// isNormalLoad - Returns true if the specified node is a non-extending
2430 /// and unindexed load.
2431 inline bool isNormalLoad(const SDNode *N) {
2432 const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
2433 return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
2434 Ld->getAddressingMode() == ISD::UNINDEXED;
2437 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
2439 inline bool isNON_EXTLoad(const SDNode *N) {
2440 return isa<LoadSDNode>(N) &&
2441 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
2444 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
2446 inline bool isEXTLoad(const SDNode *N) {
2447 return isa<LoadSDNode>(N) &&
2448 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
2451 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
2453 inline bool isSEXTLoad(const SDNode *N) {
2454 return isa<LoadSDNode>(N) &&
2455 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
2458 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
2460 inline bool isZEXTLoad(const SDNode *N) {
2461 return isa<LoadSDNode>(N) &&
2462 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
2465 /// isUNINDEXEDLoad - Returns true if the specified node is an unindexed load.
2467 inline bool isUNINDEXEDLoad(const SDNode *N) {
2468 return isa<LoadSDNode>(N) &&
2469 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2472 /// isNormalStore - Returns true if the specified node is a non-truncating
2473 /// and unindexed store.
2474 inline bool isNormalStore(const SDNode *N) {
2475 const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
2476 return St && !St->isTruncatingStore() &&
2477 St->getAddressingMode() == ISD::UNINDEXED;
2480 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
2482 inline bool isNON_TRUNCStore(const SDNode *N) {
2483 return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
2486 /// isTRUNCStore - Returns true if the specified node is a truncating
2488 inline bool isTRUNCStore(const SDNode *N) {
2489 return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
2492 /// isUNINDEXEDStore - Returns true if the specified node is an
2493 /// unindexed store.
2494 inline bool isUNINDEXEDStore(const SDNode *N) {
2495 return isa<StoreSDNode>(N) &&
2496 cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2501 } // end llvm namespace