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/Value.h"
23 #include "llvm/Constants.h"
24 #include "llvm/ADT/FoldingSet.h"
25 #include "llvm/ADT/GraphTraits.h"
26 #include "llvm/ADT/iterator.h"
27 #include "llvm/ADT/ilist_node.h"
28 #include "llvm/ADT/STLExtras.h"
29 #include "llvm/CodeGen/ValueTypes.h"
30 #include "llvm/CodeGen/MachineMemOperand.h"
31 #include "llvm/Support/Allocator.h"
32 #include "llvm/Support/RecyclingAllocator.h"
33 #include "llvm/Support/DataTypes.h"
40 class MachineBasicBlock;
41 class MachineConstantPoolValue;
43 class CompileUnitDesc;
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.
60 /// If you add new elements here you should increase OpActionsCapacity in
61 /// TargetLowering.h by the number of new elements.
64 //===--------------------------------------------------------------------===//
65 /// ISD::NodeType enum - This enum defines all of the operators valid in a
69 // DELETED_NODE - This is an illegal flag value that is used to catch
70 // errors. This opcode is not a legal opcode for any node.
73 // EntryToken - This is the marker used to indicate the start of the region.
76 // Token factor - This node takes multiple tokens as input and produces a
77 // single token result. This is used to represent the fact that the operand
78 // operators are independent of each other.
81 // AssertSext, AssertZext - These nodes record if a register contains a
82 // value that has already been zero or sign extended from a narrower type.
83 // These nodes take two operands. The first is the node that has already
84 // been extended, and the second is a value type node indicating the width
86 AssertSext, AssertZext,
88 // Various leaf nodes.
89 BasicBlock, VALUETYPE, ARG_FLAGS, CONDCODE, Register,
91 GlobalAddress, GlobalTLSAddress, FrameIndex,
92 JumpTable, ConstantPool, ExternalSymbol,
94 // The address of the GOT
97 // FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
98 // llvm.returnaddress on the DAG. These nodes take one operand, the index
99 // of the frame or return address to return. An index of zero corresponds
100 // to the current function's frame or return address, an index of one to the
101 // parent's frame or return address, and so on.
102 FRAMEADDR, RETURNADDR,
104 // FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
105 // first (possible) on-stack argument. This is needed for correct stack
106 // adjustment during unwind.
107 FRAME_TO_ARGS_OFFSET,
109 // RESULT, OUTCHAIN = EXCEPTIONADDR(INCHAIN) - This node represents the
110 // address of the exception block on entry to an landing pad block.
113 // RESULT, OUTCHAIN = EHSELECTION(INCHAIN, EXCEPTION) - This node represents
114 // the selection index of the exception thrown.
117 // OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
118 // 'eh_return' gcc dwarf builtin, which is used to return from
119 // exception. The general meaning is: adjust stack by OFFSET and pass
120 // execution to HANDLER. Many platform-related details also :)
123 // TargetConstant* - Like Constant*, but the DAG does not do any folding or
124 // simplification of the constant.
128 // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
129 // anything else with this node, and this is valid in the target-specific
130 // dag, turning into a GlobalAddress operand.
132 TargetGlobalTLSAddress,
136 TargetExternalSymbol,
138 /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
139 /// This node represents a target intrinsic function with no side effects.
140 /// The first operand is the ID number of the intrinsic from the
141 /// llvm::Intrinsic namespace. The operands to the intrinsic follow. The
142 /// node has returns the result of the intrinsic.
145 /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
146 /// This node represents a target intrinsic function with side effects that
147 /// returns a result. The first operand is a chain pointer. The second is
148 /// the ID number of the intrinsic from the llvm::Intrinsic namespace. The
149 /// operands to the intrinsic follow. The node has two results, the result
150 /// of the intrinsic and an output chain.
153 /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
154 /// This node represents a target intrinsic function with side effects that
155 /// does not return a result. The first operand is a chain pointer. The
156 /// second is the ID number of the intrinsic from the llvm::Intrinsic
157 /// namespace. The operands to the intrinsic follow.
160 // CopyToReg - This node has three operands: a chain, a register number to
161 // set to this value, and a value.
164 // CopyFromReg - This node indicates that the input value is a virtual or
165 // physical register that is defined outside of the scope of this
166 // SelectionDAG. The register is available from the RegisterSDNode object.
169 // UNDEF - An undefined node
172 /// FORMAL_ARGUMENTS(CHAIN, CC#, ISVARARG, FLAG0, ..., FLAGn) - This node
173 /// represents the formal arguments for a function. CC# is a Constant value
174 /// indicating the calling convention of the function, and ISVARARG is a
175 /// flag that indicates whether the function is varargs or not. This node
176 /// has one result value for each incoming argument, plus one for the output
177 /// chain. It must be custom legalized. See description of CALL node for
178 /// FLAG argument contents explanation.
182 /// RV1, RV2...RVn, CHAIN = CALL(CHAIN, CALLEE,
183 /// ARG0, FLAG0, ARG1, FLAG1, ... ARGn, FLAGn)
184 /// This node represents a fully general function call, before the legalizer
185 /// runs. This has one result value for each argument / flag pair, plus
186 /// a chain result. It must be custom legalized. Flag argument indicates
187 /// misc. argument attributes. Currently:
189 /// Bit 1 - 'inreg' attribute
190 /// Bit 2 - 'sret' attribute
191 /// Bit 4 - 'byval' attribute
192 /// Bit 5 - 'nest' attribute
193 /// Bit 6-9 - alignment of byval structures
194 /// Bit 10-26 - size of byval structures
195 /// Bits 31:27 - argument ABI alignment in the first argument piece and
196 /// alignment '1' in other argument pieces.
198 /// CALL nodes use the CallSDNode subclass of SDNode, which
199 /// additionally carries information about the calling convention,
200 /// whether the call is varargs, and if it's marked as a tail call.
204 // EXTRACT_ELEMENT - This is used to get the lower or upper (determined by
205 // a Constant, which is required to be operand #1) half of the integer or
206 // float value specified as operand #0. This is only for use before
207 // legalization, for values that will be broken into multiple registers.
210 // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways. Given
211 // two values of the same integer value type, this produces a value twice as
212 // big. Like EXTRACT_ELEMENT, this can only be used before legalization.
215 // MERGE_VALUES - This node takes multiple discrete operands and returns
216 // them all as its individual results. This nodes has exactly the same
217 // number of inputs and outputs, and is only valid before legalization.
218 // This node is useful for some pieces of the code generator that want to
219 // think about a single node with multiple results, not multiple nodes.
222 // Simple integer binary arithmetic operators.
223 ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
225 // SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing
226 // a signed/unsigned value of type i[2*N], and return the full value as
227 // two results, each of type iN.
228 SMUL_LOHI, UMUL_LOHI,
230 // SDIVREM/UDIVREM - Divide two integers and produce both a quotient and
234 // CARRY_FALSE - This node is used when folding other nodes,
235 // like ADDC/SUBC, which indicate the carry result is always false.
238 // Carry-setting nodes for multiple precision addition and subtraction.
239 // These nodes take two operands of the same value type, and produce two
240 // results. The first result is the normal add or sub result, the second
241 // result is the carry flag result.
244 // Carry-using nodes for multiple precision addition and subtraction. These
245 // nodes take three operands: The first two are the normal lhs and rhs to
246 // the add or sub, and the third is the input carry flag. These nodes
247 // produce two results; the normal result of the add or sub, and the output
248 // carry flag. These nodes both read and write a carry flag to allow them
249 // to them to be chained together for add and sub of arbitrarily large
253 // Simple binary floating point operators.
254 FADD, FSUB, FMUL, FDIV, FREM,
256 // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y. NOTE: This
257 // DAG node does not require that X and Y have the same type, just that they
258 // are both floating point. X and the result must have the same type.
259 // FCOPYSIGN(f32, f64) is allowed.
262 // INT = FGETSIGN(FP) - Return the sign bit of the specified floating point
263 // value as an integer 0/1 value.
266 /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector
267 /// with the specified, possibly variable, elements. The number of elements
268 /// is required to be a power of two.
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.
280 /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
281 /// vector type with the same length and element type, this produces a
282 /// concatenated vector result value, with length equal to the sum of the
283 /// lengths of the input vectors.
286 /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
287 /// vector value) starting with the (potentially variable) element number
288 /// IDX, which must be a multiple of the result vector length.
291 /// VECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC) - Returns a vector, of the same
292 /// type as VEC1/VEC2. SHUFFLEVEC is a BUILD_VECTOR of constant int values
293 /// (maybe of an illegal datatype) or undef that indicate which value each
294 /// result element will get. The elements of VEC1/VEC2 are enumerated in
295 /// order. This is quite similar to the Altivec 'vperm' instruction, except
296 /// that the indices must be constants and are in terms of the element size
297 /// of VEC1/VEC2, not in terms of bytes.
300 /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
301 /// scalar value into element 0 of the resultant vector type. The top
302 /// elements 1 to N-1 of the N-element vector are undefined.
305 // EXTRACT_SUBREG - This node is used to extract a sub-register value.
306 // This node takes a superreg and a constant sub-register index as operands.
307 // Note sub-register indices must be increasing. That is, if the
308 // sub-register index of a 8-bit sub-register is N, then the index for a
309 // 16-bit sub-register must be at least N+1.
312 // INSERT_SUBREG - This node is used to insert a sub-register value.
313 // This node takes a superreg, a subreg value, and a constant sub-register
314 // index as operands.
317 // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
318 // an unsigned/signed value of type i[2*N], then return the top part.
321 // Bitwise operators - logical and, logical or, logical xor, shift left,
322 // shift right algebraic (shift in sign bits), shift right logical (shift in
323 // zeroes), rotate left, rotate right, and byteswap.
324 AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
326 // Counting operators
329 // Select(COND, TRUEVAL, FALSEVAL)
332 // Select with condition operator - This selects between a true value and
333 // a false value (ops #2 and #3) based on the boolean result of comparing
334 // the lhs and rhs (ops #0 and #1) of a conditional expression with the
335 // condition code in op #4, a CondCodeSDNode.
338 // SetCC operator - This evaluates to a boolean (i1) true value if the
339 // condition is true. The operands to this are the left and right operands
340 // to compare (ops #0, and #1) and the condition code to compare them with
341 // (op #2) as a CondCodeSDNode.
344 // Vector SetCC operator - This evaluates to a vector of integer elements
345 // with the high bit in each element set to true if the comparison is true
346 // and false if the comparison is false. All other bits in each element
347 // are undefined. The operands to this are the left and right operands
348 // to compare (ops #0, and #1) and the condition code to compare them with
349 // (op #2) as a CondCodeSDNode.
352 // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
353 // integer shift operations, just like ADD/SUB_PARTS. The operation
355 // [Lo,Hi] = op [LoLHS,HiLHS], Amt
356 SHL_PARTS, SRA_PARTS, SRL_PARTS,
358 // Conversion operators. These are all single input single output
359 // operations. For all of these, the result type must be strictly
360 // wider or narrower (depending on the operation) than the source
363 // SIGN_EXTEND - Used for integer types, replicating the sign bit
367 // ZERO_EXTEND - Used for integer types, zeroing the new bits.
370 // ANY_EXTEND - Used for integer types. The high bits are undefined.
373 // TRUNCATE - Completely drop the high bits.
376 // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
377 // depends on the first letter) to floating point.
381 // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
382 // sign extend a small value in a large integer register (e.g. sign
383 // extending the low 8 bits of a 32-bit register to fill the top 24 bits
384 // with the 7th bit). The size of the smaller type is indicated by the 1th
385 // operand, a ValueType node.
388 /// FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
393 /// X = FP_ROUND(Y, TRUNC) - Rounding 'Y' from a larger floating point type
394 /// down to the precision of the destination VT. TRUNC is a flag, which is
395 /// always an integer that is zero or one. If TRUNC is 0, this is a
396 /// normal rounding, if it is 1, this FP_ROUND is known to not change the
399 /// The TRUNC = 1 case is used in cases where we know that the value will
400 /// not be modified by the node, because Y is not using any of the extra
401 /// precision of source type. This allows certain transformations like
402 /// FP_EXTEND(FP_ROUND(X,1)) -> X which are not safe for
403 /// FP_EXTEND(FP_ROUND(X,0)) because the extra bits aren't removed.
406 // FLT_ROUNDS_ - Returns current rounding mode:
409 // 1 Round to nearest
414 /// X = FP_ROUND_INREG(Y, VT) - This operator takes an FP register, and
415 /// rounds it to a floating point value. It then promotes it and returns it
416 /// in a register of the same size. This operation effectively just
417 /// discards excess precision. The type to round down to is specified by
418 /// the VT operand, a VTSDNode.
421 /// X = FP_EXTEND(Y) - Extend a smaller FP type into a larger FP type.
424 // BIT_CONVERT - Theis operator converts between integer and FP values, as
425 // if one was stored to memory as integer and the other was loaded from the
426 // same address (or equivalently for vector format conversions, etc). The
427 // source and result are required to have the same bit size (e.g.
428 // f32 <-> i32). This can also be used for int-to-int or fp-to-fp
429 // conversions, but that is a noop, deleted by getNode().
432 // FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
433 // FLOG, FLOG2, FLOG10, FEXP, FEXP2,
434 // FCEIL, FTRUNC, FRINT, FNEARBYINT, FFLOOR - Perform various unary floating
435 // point operations. These are inspired by libm.
436 FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
437 FLOG, FLOG2, FLOG10, FEXP, FEXP2,
438 FCEIL, FTRUNC, FRINT, FNEARBYINT, FFLOOR,
440 // LOAD and STORE have token chains as their first operand, then the same
441 // operands as an LLVM load/store instruction, then an offset node that
442 // is added / subtracted from the base pointer to form the address (for
443 // indexed memory ops).
446 // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
447 // to a specified boundary. This node always has two return values: a new
448 // stack pointer value and a chain. The first operand is the token chain,
449 // the second is the number of bytes to allocate, and the third is the
450 // alignment boundary. The size is guaranteed to be a multiple of the stack
451 // alignment, and the alignment is guaranteed to be bigger than the stack
452 // alignment (if required) or 0 to get standard stack alignment.
455 // Control flow instructions. These all have token chains.
457 // BR - Unconditional branch. The first operand is the chain
458 // operand, the second is the MBB to branch to.
461 // BRIND - Indirect branch. The first operand is the chain, the second
462 // is the value to branch to, which must be of the same type as the target's
466 // BR_JT - Jumptable branch. The first operand is the chain, the second
467 // is the jumptable index, the last one is the jumptable entry index.
470 // BRCOND - Conditional branch. The first operand is the chain,
471 // the second is the condition, the third is the block to branch
472 // to if the condition is true.
475 // BR_CC - Conditional branch. The behavior is like that of SELECT_CC, in
476 // that the condition is represented as condition code, and two nodes to
477 // compare, rather than as a combined SetCC node. The operands in order are
478 // chain, cc, lhs, rhs, block to branch to if condition is true.
481 // RET - Return from function. The first operand is the chain,
482 // and any subsequent operands are pairs of return value and return value
483 // attributes (see CALL for description of attributes) for the function.
484 // This operation can have variable number of operands.
487 // INLINEASM - Represents an inline asm block. This node always has two
488 // return values: a chain and a flag result. The inputs are as follows:
489 // Operand #0 : Input chain.
490 // Operand #1 : a ExternalSymbolSDNode with a pointer to the asm string.
491 // Operand #2n+2: A RegisterNode.
492 // Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
493 // Operand #last: Optional, an incoming flag.
496 // DBG_LABEL, EH_LABEL - Represents a label in mid basic block used to track
497 // locations needed for debug and exception handling tables. These nodes
498 // take a chain as input and return a chain.
502 // DECLARE - Represents a llvm.dbg.declare intrinsic. It's used to track
503 // local variable declarations for debugging information. First operand is
504 // a chain, while the next two operands are first two arguments (address
505 // and variable) of a llvm.dbg.declare instruction.
508 // STACKSAVE - STACKSAVE has one operand, an input chain. It produces a
509 // value, the same type as the pointer type for the system, and an output
513 // STACKRESTORE has two operands, an input chain and a pointer to restore to
514 // it returns an output chain.
517 // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
518 // a call sequence, and carry arbitrary information that target might want
519 // to know. The first operand is a chain, the rest are specified by the
520 // target and not touched by the DAG optimizers.
521 // CALLSEQ_START..CALLSEQ_END pairs may not be nested.
522 CALLSEQ_START, // Beginning of a call sequence
523 CALLSEQ_END, // End of a call sequence
525 // VAARG - VAARG has three operands: an input chain, a pointer, and a
526 // SRCVALUE. It returns a pair of values: the vaarg value and a new chain.
529 // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
530 // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
534 // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
535 // pointer, and a SRCVALUE.
538 // SRCVALUE - This is a node type that holds a Value* that is used to
539 // make reference to a value in the LLVM IR.
542 // MEMOPERAND - This is a node that contains a MachineMemOperand which
543 // records information about a memory reference. This is used to make
544 // AliasAnalysis queries from the backend.
547 // PCMARKER - This corresponds to the pcmarker intrinsic.
550 // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
551 // The only operand is a chain and a value and a chain are produced. The
552 // value is the contents of the architecture specific cycle counter like
553 // register (or other high accuracy low latency clock source)
556 // HANDLENODE node - Used as a handle for various purposes.
559 // DBG_STOPPOINT - This node is used to represent a source location for
560 // debug info. It takes token chain as input, and carries a line number,
561 // column number, and a pointer to a CompileUnitDesc object identifying
562 // the containing compilation unit. It produces a token chain as output.
565 // DEBUG_LOC - This node is used to represent source line information
566 // embedded in the code. It takes a token chain as input, then a line
567 // number, then a column then a file id (provided by MachineModuleInfo.) It
568 // produces a token chain as output.
571 // TRAMPOLINE - This corresponds to the init_trampoline intrinsic.
572 // It takes as input a token chain, the pointer to the trampoline,
573 // the pointer to the nested function, the pointer to pass for the
574 // 'nest' parameter, a SRCVALUE for the trampoline and another for
575 // the nested function (allowing targets to access the original
576 // Function*). It produces the result of the intrinsic and a token
580 // TRAP - Trapping instruction
583 // PREFETCH - This corresponds to a prefetch intrinsic. It takes chains are
584 // their first operand. The other operands are the address to prefetch,
585 // read / write specifier, and locality specifier.
588 // OUTCHAIN = MEMBARRIER(INCHAIN, load-load, load-store, store-load,
589 // store-store, device)
590 // This corresponds to the memory.barrier intrinsic.
591 // it takes an input chain, 4 operands to specify the type of barrier, an
592 // operand specifying if the barrier applies to device and uncached memory
593 // and produces an output chain.
596 // Val, OUTCHAIN = ATOMIC_CMP_SWAP(INCHAIN, ptr, cmp, swap)
597 // this corresponds to the atomic.lcs intrinsic.
598 // cmp is compared to *ptr, and if equal, swap is stored in *ptr.
599 // the return is always the original value in *ptr
605 // Val, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amt)
606 // this corresponds to the atomic.swap intrinsic.
607 // amt is stored to *ptr atomically.
608 // the return is always the original value in *ptr
614 // Val, OUTCHAIN = ATOMIC_L[OpName]S(INCHAIN, ptr, amt)
615 // this corresponds to the atomic.[OpName] intrinsic.
616 // op(*ptr, amt) is stored to *ptr atomically.
617 // the return is always the original value in *ptr
659 // BUILTIN_OP_END - This must be the last enum value in this list.
665 /// isBuildVectorAllOnes - Return true if the specified node is a
666 /// BUILD_VECTOR where all of the elements are ~0 or undef.
667 bool isBuildVectorAllOnes(const SDNode *N);
669 /// isBuildVectorAllZeros - Return true if the specified node is a
670 /// BUILD_VECTOR where all of the elements are 0 or undef.
671 bool isBuildVectorAllZeros(const SDNode *N);
673 /// isScalarToVector - Return true if the specified node is a
674 /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
675 /// element is not an undef.
676 bool isScalarToVector(const SDNode *N);
678 /// isDebugLabel - Return true if the specified node represents a debug
679 /// label (i.e. ISD::DBG_LABEL or TargetInstrInfo::DBG_LABEL node).
680 bool isDebugLabel(const SDNode *N);
682 //===--------------------------------------------------------------------===//
683 /// MemIndexedMode enum - This enum defines the load / store indexed
684 /// addressing modes.
686 /// UNINDEXED "Normal" load / store. The effective address is already
687 /// computed and is available in the base pointer. The offset
688 /// operand is always undefined. In addition to producing a
689 /// chain, an unindexed load produces one value (result of the
690 /// load); an unindexed store does not produce a value.
692 /// PRE_INC Similar to the unindexed mode where the effective address is
693 /// PRE_DEC the value of the base pointer add / subtract the offset.
694 /// It considers the computation as being folded into the load /
695 /// store operation (i.e. the load / store does the address
696 /// computation as well as performing the memory transaction).
697 /// The base operand is always undefined. In addition to
698 /// producing a chain, pre-indexed load produces two values
699 /// (result of the load and the result of the address
700 /// computation); a pre-indexed store produces one value (result
701 /// of the address computation).
703 /// POST_INC The effective address is the value of the base pointer. The
704 /// POST_DEC value of the offset operand is then added to / subtracted
705 /// from the base after memory transaction. In addition to
706 /// producing a chain, post-indexed load produces two values
707 /// (the result of the load and the result of the base +/- offset
708 /// computation); a post-indexed store produces one value (the
709 /// the result of the base +/- offset computation).
711 enum MemIndexedMode {
720 //===--------------------------------------------------------------------===//
721 /// LoadExtType enum - This enum defines the three variants of LOADEXT
722 /// (load with extension).
724 /// SEXTLOAD loads the integer operand and sign extends it to a larger
725 /// integer result type.
726 /// ZEXTLOAD loads the integer operand and zero extends it to a larger
727 /// integer result type.
728 /// EXTLOAD is used for three things: floating point extending loads,
729 /// integer extending loads [the top bits are undefined], and vector
730 /// extending loads [load into low elt].
740 //===--------------------------------------------------------------------===//
741 /// ISD::CondCode enum - These are ordered carefully to make the bitfields
742 /// below work out, when considering SETFALSE (something that never exists
743 /// dynamically) as 0. "U" -> Unsigned (for integer operands) or Unordered
744 /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
745 /// to. If the "N" column is 1, the result of the comparison is undefined if
746 /// the input is a NAN.
748 /// All of these (except for the 'always folded ops') should be handled for
749 /// floating point. For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
750 /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
752 /// Note that these are laid out in a specific order to allow bit-twiddling
753 /// to transform conditions.
755 // Opcode N U L G E Intuitive operation
756 SETFALSE, // 0 0 0 0 Always false (always folded)
757 SETOEQ, // 0 0 0 1 True if ordered and equal
758 SETOGT, // 0 0 1 0 True if ordered and greater than
759 SETOGE, // 0 0 1 1 True if ordered and greater than or equal
760 SETOLT, // 0 1 0 0 True if ordered and less than
761 SETOLE, // 0 1 0 1 True if ordered and less than or equal
762 SETONE, // 0 1 1 0 True if ordered and operands are unequal
763 SETO, // 0 1 1 1 True if ordered (no nans)
764 SETUO, // 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
765 SETUEQ, // 1 0 0 1 True if unordered or equal
766 SETUGT, // 1 0 1 0 True if unordered or greater than
767 SETUGE, // 1 0 1 1 True if unordered, greater than, or equal
768 SETULT, // 1 1 0 0 True if unordered or less than
769 SETULE, // 1 1 0 1 True if unordered, less than, or equal
770 SETUNE, // 1 1 1 0 True if unordered or not equal
771 SETTRUE, // 1 1 1 1 Always true (always folded)
772 // Don't care operations: undefined if the input is a nan.
773 SETFALSE2, // 1 X 0 0 0 Always false (always folded)
774 SETEQ, // 1 X 0 0 1 True if equal
775 SETGT, // 1 X 0 1 0 True if greater than
776 SETGE, // 1 X 0 1 1 True if greater than or equal
777 SETLT, // 1 X 1 0 0 True if less than
778 SETLE, // 1 X 1 0 1 True if less than or equal
779 SETNE, // 1 X 1 1 0 True if not equal
780 SETTRUE2, // 1 X 1 1 1 Always true (always folded)
782 SETCC_INVALID // Marker value.
785 /// isSignedIntSetCC - Return true if this is a setcc instruction that
786 /// performs a signed comparison when used with integer operands.
787 inline bool isSignedIntSetCC(CondCode Code) {
788 return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
791 /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
792 /// performs an unsigned comparison when used with integer operands.
793 inline bool isUnsignedIntSetCC(CondCode Code) {
794 return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
797 /// isTrueWhenEqual - Return true if the specified condition returns true if
798 /// the two operands to the condition are equal. Note that if one of the two
799 /// operands is a NaN, this value is meaningless.
800 inline bool isTrueWhenEqual(CondCode Cond) {
801 return ((int)Cond & 1) != 0;
804 /// getUnorderedFlavor - This function returns 0 if the condition is always
805 /// false if an operand is a NaN, 1 if the condition is always true if the
806 /// operand is a NaN, and 2 if the condition is undefined if the operand is a
808 inline unsigned getUnorderedFlavor(CondCode Cond) {
809 return ((int)Cond >> 3) & 3;
812 /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
813 /// 'op' is a valid SetCC operation.
814 CondCode getSetCCInverse(CondCode Operation, bool isInteger);
816 /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
817 /// when given the operation for (X op Y).
818 CondCode getSetCCSwappedOperands(CondCode Operation);
820 /// getSetCCOrOperation - Return the result of a logical OR between different
821 /// comparisons of identical values: ((X op1 Y) | (X op2 Y)). This
822 /// function returns SETCC_INVALID if it is not possible to represent the
823 /// resultant comparison.
824 CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
826 /// getSetCCAndOperation - Return the result of a logical AND between
827 /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)). This
828 /// function returns SETCC_INVALID if it is not possible to represent the
829 /// resultant comparison.
830 CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
831 } // end llvm::ISD namespace
834 //===----------------------------------------------------------------------===//
835 /// SDValue - Unlike LLVM values, Selection DAG nodes may return multiple
836 /// values as the result of a computation. Many nodes return multiple values,
837 /// from loads (which define a token and a return value) to ADDC (which returns
838 /// a result and a carry value), to calls (which may return an arbitrary number
841 /// As such, each use of a SelectionDAG computation must indicate the node that
842 /// computes it as well as which return value to use from that node. This pair
843 /// of information is represented with the SDValue value type.
846 SDNode *Node; // The node defining the value we are using.
847 unsigned ResNo; // Which return value of the node we are using.
849 SDValue() : Node(0), ResNo(0) {}
850 SDValue(SDNode *node, unsigned resno) : Node(node), ResNo(resno) {}
852 /// get the index which selects a specific result in the SDNode
853 unsigned getResNo() const { return ResNo; }
855 /// get the SDNode which holds the desired result
856 SDNode *getNode() const { return Node; }
859 void setNode(SDNode *N) { Node = N; }
861 bool operator==(const SDValue &O) const {
862 return Node == O.Node && ResNo == O.ResNo;
864 bool operator!=(const SDValue &O) const {
865 return !operator==(O);
867 bool operator<(const SDValue &O) const {
868 return Node < O.Node || (Node == O.Node && ResNo < O.ResNo);
871 SDValue getValue(unsigned R) const {
872 return SDValue(Node, R);
875 // isOperandOf - Return true if this node is an operand of N.
876 bool isOperandOf(SDNode *N) const;
878 /// getValueType - Return the ValueType of the referenced return value.
880 inline MVT getValueType() const;
882 /// getValueSizeInBits - Returns the size of the value in bits.
884 unsigned getValueSizeInBits() const {
885 return getValueType().getSizeInBits();
888 // Forwarding methods - These forward to the corresponding methods in SDNode.
889 inline unsigned getOpcode() const;
890 inline unsigned getNumOperands() const;
891 inline const SDValue &getOperand(unsigned i) const;
892 inline uint64_t getConstantOperandVal(unsigned i) const;
893 inline bool isTargetOpcode() const;
894 inline bool isMachineOpcode() const;
895 inline unsigned getMachineOpcode() const;
898 /// reachesChainWithoutSideEffects - Return true if this operand (which must
899 /// be a chain) reaches the specified operand without crossing any
900 /// side-effecting instructions. In practice, this looks through token
901 /// factors and non-volatile loads. In order to remain efficient, this only
902 /// looks a couple of nodes in, it does not do an exhaustive search.
903 bool reachesChainWithoutSideEffects(SDValue Dest,
904 unsigned Depth = 2) const;
906 /// use_empty - Return true if there are no nodes using value ResNo
909 inline bool use_empty() const;
911 /// hasOneUse - Return true if there is exactly one node using value
914 inline bool hasOneUse() const;
918 template<> struct DenseMapInfo<SDValue> {
919 static inline SDValue getEmptyKey() {
920 return SDValue((SDNode*)-1, -1U);
922 static inline SDValue getTombstoneKey() {
923 return SDValue((SDNode*)-1, 0);
925 static unsigned getHashValue(const SDValue &Val) {
926 return ((unsigned)((uintptr_t)Val.getNode() >> 4) ^
927 (unsigned)((uintptr_t)Val.getNode() >> 9)) + Val.getResNo();
929 static bool isEqual(const SDValue &LHS, const SDValue &RHS) {
932 static bool isPod() { return true; }
935 /// simplify_type specializations - Allow casting operators to work directly on
936 /// SDValues as if they were SDNode*'s.
937 template<> struct simplify_type<SDValue> {
938 typedef SDNode* SimpleType;
939 static SimpleType getSimplifiedValue(const SDValue &Val) {
940 return static_cast<SimpleType>(Val.getNode());
943 template<> struct simplify_type<const SDValue> {
944 typedef SDNode* SimpleType;
945 static SimpleType getSimplifiedValue(const SDValue &Val) {
946 return static_cast<SimpleType>(Val.getNode());
950 /// SDUse - Represents a use of the SDNode referred by
954 /// User - Parent node of this operand.
956 /// Prev, next - Pointers to the uses list of the SDNode referred by
961 SDUse(): Operand(), User(NULL), Prev(NULL), Next(NULL) {}
963 SDUse(SDNode *val, unsigned resno) :
964 Operand(val,resno), User(NULL), Prev(NULL), Next(NULL) {}
966 SDUse& operator= (const SDValue& Op) {
973 SDUse& operator= (const SDUse& Op) {
980 SDUse *getNext() { return Next; }
982 SDNode *getUser() { return User; }
984 void setUser(SDNode *p) { User = p; }
986 operator SDValue() const { return Operand; }
988 const SDValue& getSDValue() const { return Operand; }
990 SDValue &getSDValue() { return Operand; }
991 SDNode *getVal() { return Operand.getNode(); }
992 SDNode *getVal() const { return Operand.getNode(); } // FIXME: const correct?
994 bool operator==(const SDValue &O) const {
998 bool operator!=(const SDValue &O) const {
999 return !(Operand == O);
1002 bool operator<(const SDValue &O) const {
1007 void addToList(SDUse **List) {
1009 if (Next) Next->Prev = &Next;
1014 void removeFromList() {
1016 if (Next) Next->Prev = Prev;
1021 /// simplify_type specializations - Allow casting operators to work directly on
1022 /// SDValues as if they were SDNode*'s.
1023 template<> struct simplify_type<SDUse> {
1024 typedef SDNode* SimpleType;
1025 static SimpleType getSimplifiedValue(const SDUse &Val) {
1026 return static_cast<SimpleType>(Val.getVal());
1029 template<> struct simplify_type<const SDUse> {
1030 typedef SDNode* SimpleType;
1031 static SimpleType getSimplifiedValue(const SDUse &Val) {
1032 return static_cast<SimpleType>(Val.getVal());
1037 /// SDOperandPtr - A helper SDValue pointer class, that can handle
1038 /// arrays of SDUse and arrays of SDValue objects. This is required
1039 /// in many places inside the SelectionDAG.
1041 class SDOperandPtr {
1042 const SDValue *ptr; // The pointer to the SDValue object
1043 int object_size; // The size of the object containg the SDValue
1045 SDOperandPtr() : ptr(0), object_size(0) {}
1047 SDOperandPtr(SDUse * use_ptr) {
1048 ptr = &use_ptr->getSDValue();
1049 object_size = (int)sizeof(SDUse);
1052 SDOperandPtr(const SDValue * op_ptr) {
1054 object_size = (int)sizeof(SDValue);
1057 const SDValue operator *() { return *ptr; }
1058 const SDValue *operator ->() { return ptr; }
1059 SDOperandPtr operator ++ () {
1060 ptr = (SDValue*)((char *)ptr + object_size);
1064 SDOperandPtr operator ++ (int) {
1065 SDOperandPtr tmp = *this;
1066 ptr = (SDValue*)((char *)ptr + object_size);
1070 SDValue operator[] (int idx) const {
1071 return *(SDValue*)((char*) ptr + object_size * idx);
1075 /// SDNode - Represents one node in the SelectionDAG.
1077 class SDNode : public FoldingSetNode, public ilist_node<SDNode> {
1079 /// NodeType - The operation that this node performs.
1083 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
1084 /// then they will be delete[]'d when the node is destroyed.
1085 unsigned short OperandsNeedDelete : 1;
1088 /// SubclassData - This member is defined by this class, but is not used for
1089 /// anything. Subclasses can use it to hold whatever state they find useful.
1090 /// This field is initialized to zero by the ctor.
1091 unsigned short SubclassData : 15;
1094 /// NodeId - Unique id per SDNode in the DAG.
1097 /// OperandList - The values that are used by this operation.
1101 /// ValueList - The types of the values this node defines. SDNode's may
1102 /// define multiple values simultaneously.
1103 const MVT *ValueList;
1105 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
1106 unsigned short NumOperands, NumValues;
1108 /// Uses - List of uses for this SDNode.
1111 /// addUse - add SDUse to the list of uses.
1112 void addUse(SDUse &U) { U.addToList(&Uses); }
1114 // Out-of-line virtual method to give class a home.
1115 virtual void ANCHOR();
1118 assert(NumOperands == 0 && "Operand list not cleared before deletion");
1119 NodeType = ISD::DELETED_NODE;
1122 //===--------------------------------------------------------------------===//
1126 /// getOpcode - Return the SelectionDAG opcode value for this node. For
1127 /// pre-isel nodes (those for which isMachineOpcode returns false), these
1128 /// are the opcode values in the ISD and <target>ISD namespaces. For
1129 /// post-isel opcodes, see getMachineOpcode.
1130 unsigned getOpcode() const { return (unsigned short)NodeType; }
1132 /// isTargetOpcode - Test if this node has a target-specific opcode (in the
1133 /// <target>ISD namespace).
1134 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
1136 /// isMachineOpcode - Test if this node has a post-isel opcode, directly
1137 /// corresponding to a MachineInstr opcode.
1138 bool isMachineOpcode() const { return NodeType < 0; }
1140 /// getMachineOpcode - This may only be called if isMachineOpcode returns
1141 /// true. It returns the MachineInstr opcode value that the node's opcode
1143 unsigned getMachineOpcode() const {
1144 assert(isMachineOpcode() && "Not a MachineInstr opcode!");
1148 /// use_empty - Return true if there are no uses of this node.
1150 bool use_empty() const { return Uses == NULL; }
1152 /// hasOneUse - Return true if there is exactly one use of this node.
1154 bool hasOneUse() const {
1155 return !use_empty() && next(use_begin()) == use_end();
1158 /// use_size - Return the number of uses of this node. This method takes
1159 /// time proportional to the number of uses.
1161 size_t use_size() const { return std::distance(use_begin(), use_end()); }
1163 /// getNodeId - Return the unique node id.
1165 int getNodeId() const { return NodeId; }
1167 /// setNodeId - Set unique node id.
1168 void setNodeId(int Id) { NodeId = Id; }
1170 /// use_iterator - This class provides iterator support for SDUse
1171 /// operands that use a specific SDNode.
1173 : public forward_iterator<SDUse, ptrdiff_t> {
1175 explicit use_iterator(SDUse *op) : Op(op) {
1177 friend class SDNode;
1179 typedef forward_iterator<SDUse, ptrdiff_t>::reference reference;
1180 typedef forward_iterator<SDUse, ptrdiff_t>::pointer pointer;
1182 use_iterator(const use_iterator &I) : Op(I.Op) {}
1183 use_iterator() : Op(0) {}
1185 bool operator==(const use_iterator &x) const {
1188 bool operator!=(const use_iterator &x) const {
1189 return !operator==(x);
1192 /// atEnd - return true if this iterator is at the end of uses list.
1193 bool atEnd() const { return Op == 0; }
1195 // Iterator traversal: forward iteration only.
1196 use_iterator &operator++() { // Preincrement
1197 assert(Op && "Cannot increment end iterator!");
1202 use_iterator operator++(int) { // Postincrement
1203 use_iterator tmp = *this; ++*this; return tmp;
1206 /// Retrieve a pointer to the current user node.
1207 SDNode *operator*() const {
1208 assert(Op && "Cannot dereference end iterator!");
1209 return Op->getUser();
1212 SDNode *operator->() const { return operator*(); }
1214 SDUse &getUse() const { return *Op; }
1216 /// getOperandNo - Retrive the operand # of this use in its user.
1218 unsigned getOperandNo() const {
1219 assert(Op && "Cannot dereference end iterator!");
1220 return (unsigned)(Op - Op->getUser()->OperandList);
1224 /// use_begin/use_end - Provide iteration support to walk over all uses
1227 use_iterator use_begin() const {
1228 return use_iterator(Uses);
1231 static use_iterator use_end() { return use_iterator(0); }
1234 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
1235 /// indicated value. This method ignores uses of other values defined by this
1237 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
1239 /// hasAnyUseOfValue - Return true if there are any use of the indicated
1240 /// value. This method ignores uses of other values defined by this operation.
1241 bool hasAnyUseOfValue(unsigned Value) const;
1243 /// isOnlyUserOf - Return true if this node is the only use of N.
1245 bool isOnlyUserOf(SDNode *N) const;
1247 /// isOperandOf - Return true if this node is an operand of N.
1249 bool isOperandOf(SDNode *N) const;
1251 /// isPredecessorOf - Return true if this node is a predecessor of N. This
1252 /// node is either an operand of N or it can be reached by recursively
1253 /// traversing up the operands.
1254 /// NOTE: this is an expensive method. Use it carefully.
1255 bool isPredecessorOf(SDNode *N) const;
1257 /// getNumOperands - Return the number of values used by this operation.
1259 unsigned getNumOperands() const { return NumOperands; }
1261 /// getConstantOperandVal - Helper method returns the integer value of a
1262 /// ConstantSDNode operand.
1263 uint64_t getConstantOperandVal(unsigned Num) const;
1265 const SDValue &getOperand(unsigned Num) const {
1266 assert(Num < NumOperands && "Invalid child # of SDNode!");
1267 return OperandList[Num].getSDValue();
1270 typedef SDUse* op_iterator;
1271 op_iterator op_begin() const { return OperandList; }
1272 op_iterator op_end() const { return OperandList+NumOperands; }
1275 SDVTList getVTList() const {
1276 SDVTList X = { ValueList, NumValues };
1280 /// getNumValues - Return the number of values defined/returned by this
1283 unsigned getNumValues() const { return NumValues; }
1285 /// getValueType - Return the type of a specified result.
1287 MVT getValueType(unsigned ResNo) const {
1288 assert(ResNo < NumValues && "Illegal result number!");
1289 return ValueList[ResNo];
1292 /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType(ResNo)).
1294 unsigned getValueSizeInBits(unsigned ResNo) const {
1295 return getValueType(ResNo).getSizeInBits();
1298 typedef const MVT* value_iterator;
1299 value_iterator value_begin() const { return ValueList; }
1300 value_iterator value_end() const { return ValueList+NumValues; }
1302 /// getOperationName - Return the opcode of this operation for printing.
1304 std::string getOperationName(const SelectionDAG *G = 0) const;
1305 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
1306 void print(raw_ostream &OS, const SelectionDAG *G = 0) const;
1308 void dump(const SelectionDAG *G) const;
1310 static bool classof(const SDNode *) { return true; }
1312 /// Profile - Gather unique data for the node.
1314 void Profile(FoldingSetNodeID &ID) const;
1317 friend class SelectionDAG;
1318 friend struct ilist_traits<SDNode>;
1320 /// getValueTypeList - Return a pointer to the specified value type.
1322 static const MVT *getValueTypeList(MVT VT);
1323 static SDVTList getSDVTList(MVT VT) {
1324 SDVTList Ret = { getValueTypeList(VT), 1 };
1328 SDNode(unsigned Opc, SDVTList VTs, const SDValue *Ops, unsigned NumOps)
1329 : NodeType(Opc), OperandsNeedDelete(true), SubclassData(0),
1330 NodeId(-1), Uses(NULL) {
1331 NumOperands = NumOps;
1332 OperandList = NumOps ? new SDUse[NumOperands] : 0;
1334 for (unsigned i = 0; i != NumOps; ++i) {
1335 OperandList[i] = Ops[i];
1336 OperandList[i].setUser(this);
1337 Ops[i].getNode()->addUse(OperandList[i]);
1340 ValueList = VTs.VTs;
1341 NumValues = VTs.NumVTs;
1344 SDNode(unsigned Opc, SDVTList VTs, const SDUse *Ops, unsigned NumOps)
1345 : NodeType(Opc), OperandsNeedDelete(true), SubclassData(0),
1346 NodeId(-1), Uses(NULL) {
1347 OperandsNeedDelete = true;
1348 NumOperands = NumOps;
1349 OperandList = NumOps ? new SDUse[NumOperands] : 0;
1351 for (unsigned i = 0; i != NumOps; ++i) {
1352 OperandList[i] = Ops[i];
1353 OperandList[i].setUser(this);
1354 Ops[i].getVal()->addUse(OperandList[i]);
1357 ValueList = VTs.VTs;
1358 NumValues = VTs.NumVTs;
1361 /// This constructor adds no operands itself; operands can be
1362 /// set later with InitOperands.
1363 SDNode(unsigned Opc, SDVTList VTs)
1364 : NodeType(Opc), OperandsNeedDelete(false), SubclassData(0),
1365 NodeId(-1), Uses(NULL) {
1368 ValueList = VTs.VTs;
1369 NumValues = VTs.NumVTs;
1372 /// InitOperands - Initialize the operands list of this node with the
1373 /// specified values, which are part of the node (thus they don't need to be
1374 /// copied in or allocated).
1375 void InitOperands(SDUse *Ops, unsigned NumOps) {
1376 assert(OperandList == 0 && "Operands already set!");
1377 NumOperands = NumOps;
1381 for (unsigned i = 0; i != NumOps; ++i) {
1382 OperandList[i].setUser(this);
1383 Ops[i].getVal()->addUse(OperandList[i]);
1387 /// DropOperands - Release the operands and set this node to have
1389 void DropOperands();
1391 void addUser(unsigned i, SDNode *User) {
1392 assert(User->OperandList[i].getUser() && "Node without parent");
1393 addUse(User->OperandList[i]);
1396 void removeUser(unsigned i, SDNode *User) {
1397 assert(User->OperandList[i].getUser() && "Node without parent");
1398 SDUse &Op = User->OperandList[i];
1399 Op.removeFromList();
1404 // Define inline functions from the SDValue class.
1406 inline unsigned SDValue::getOpcode() const {
1407 return Node->getOpcode();
1409 inline MVT SDValue::getValueType() const {
1410 return Node->getValueType(ResNo);
1412 inline unsigned SDValue::getNumOperands() const {
1413 return Node->getNumOperands();
1415 inline const SDValue &SDValue::getOperand(unsigned i) const {
1416 return Node->getOperand(i);
1418 inline uint64_t SDValue::getConstantOperandVal(unsigned i) const {
1419 return Node->getConstantOperandVal(i);
1421 inline bool SDValue::isTargetOpcode() const {
1422 return Node->isTargetOpcode();
1424 inline bool SDValue::isMachineOpcode() const {
1425 return Node->isMachineOpcode();
1427 inline unsigned SDValue::getMachineOpcode() const {
1428 return Node->getMachineOpcode();
1430 inline bool SDValue::use_empty() const {
1431 return !Node->hasAnyUseOfValue(ResNo);
1433 inline bool SDValue::hasOneUse() const {
1434 return Node->hasNUsesOfValue(1, ResNo);
1437 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
1438 /// to allow co-allocation of node operands with the node itself.
1439 class UnarySDNode : public SDNode {
1440 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1443 UnarySDNode(unsigned Opc, SDVTList VTs, SDValue X)
1444 : SDNode(Opc, VTs) {
1446 InitOperands(&Op, 1);
1450 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
1451 /// to allow co-allocation of node operands with the node itself.
1452 class BinarySDNode : public SDNode {
1453 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1456 BinarySDNode(unsigned Opc, SDVTList VTs, SDValue X, SDValue Y)
1457 : SDNode(Opc, VTs) {
1460 InitOperands(Ops, 2);
1464 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
1465 /// to allow co-allocation of node operands with the node itself.
1466 class TernarySDNode : public SDNode {
1467 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1470 TernarySDNode(unsigned Opc, SDVTList VTs, SDValue X, SDValue Y,
1472 : SDNode(Opc, VTs) {
1476 InitOperands(Ops, 3);
1481 /// HandleSDNode - This class is used to form a handle around another node that
1482 /// is persistant and is updated across invocations of replaceAllUsesWith on its
1483 /// operand. This node should be directly created by end-users and not added to
1484 /// the AllNodes list.
1485 class HandleSDNode : public SDNode {
1486 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1489 // FIXME: Remove the "noinline" attribute once <rdar://problem/5852746> is
1492 explicit __attribute__((__noinline__)) HandleSDNode(SDValue X)
1494 explicit HandleSDNode(SDValue X)
1496 : SDNode(ISD::HANDLENODE, getSDVTList(MVT::Other)) {
1498 InitOperands(&Op, 1);
1501 const SDValue &getValue() const { return Op.getSDValue(); }
1504 /// Abstact virtual class for operations for memory operations
1505 class MemSDNode : public SDNode {
1506 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1509 // MemoryVT - VT of in-memory value.
1512 //! SrcValue - Memory location for alias analysis.
1513 const Value *SrcValue;
1515 //! SVOffset - Memory location offset. Note that base is defined in MemSDNode
1518 /// Flags - the low bit indicates whether this is a volatile reference;
1519 /// the remainder is a log2 encoding of the alignment in bytes.
1523 MemSDNode(unsigned Opc, SDVTList VTs, MVT MemoryVT,
1524 const Value *srcValue, int SVOff,
1525 unsigned alignment, bool isvolatile);
1527 MemSDNode(unsigned Opc, SDVTList VTs, const SDValue *Ops, unsigned NumOps,
1528 MVT MemoryVT, const Value *srcValue, int SVOff,
1529 unsigned alignment, bool isvolatile);
1531 /// Returns alignment and volatility of the memory access
1532 unsigned getAlignment() const { return (1u << (Flags >> 1)) >> 1; }
1533 bool isVolatile() const { return Flags & 1; }
1535 /// Returns the SrcValue and offset that describes the location of the access
1536 const Value *getSrcValue() const { return SrcValue; }
1537 int getSrcValueOffset() const { return SVOffset; }
1539 /// getMemoryVT - Return the type of the in-memory value.
1540 MVT getMemoryVT() const { return MemoryVT; }
1542 /// getMemOperand - Return a MachineMemOperand object describing the memory
1543 /// reference performed by operation.
1544 MachineMemOperand getMemOperand() const;
1546 const SDValue &getChain() const { return getOperand(0); }
1547 const SDValue &getBasePtr() const {
1548 return getOperand(getOpcode() == ISD::STORE ? 2 : 1);
1551 /// getRawFlags - Represent the flags as a bunch of bits.
1553 unsigned getRawFlags() const { return Flags; }
1555 // Methods to support isa and dyn_cast
1556 static bool classof(const MemSDNode *) { return true; }
1557 static bool classof(const SDNode *N) {
1558 // For some targets, we lower some target intrinsics to a MemIntrinsicNode
1559 // with either an intrinsic or a target opcode.
1560 return N->getOpcode() == ISD::LOAD ||
1561 N->getOpcode() == ISD::STORE ||
1562 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_8 ||
1563 N->getOpcode() == ISD::ATOMIC_SWAP_8 ||
1564 N->getOpcode() == ISD::ATOMIC_LOAD_ADD_8 ||
1565 N->getOpcode() == ISD::ATOMIC_LOAD_SUB_8 ||
1566 N->getOpcode() == ISD::ATOMIC_LOAD_AND_8 ||
1567 N->getOpcode() == ISD::ATOMIC_LOAD_OR_8 ||
1568 N->getOpcode() == ISD::ATOMIC_LOAD_XOR_8 ||
1569 N->getOpcode() == ISD::ATOMIC_LOAD_NAND_8 ||
1570 N->getOpcode() == ISD::ATOMIC_LOAD_MIN_8 ||
1571 N->getOpcode() == ISD::ATOMIC_LOAD_MAX_8 ||
1572 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN_8 ||
1573 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX_8 ||
1575 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_16 ||
1576 N->getOpcode() == ISD::ATOMIC_SWAP_16 ||
1577 N->getOpcode() == ISD::ATOMIC_LOAD_ADD_16 ||
1578 N->getOpcode() == ISD::ATOMIC_LOAD_SUB_16 ||
1579 N->getOpcode() == ISD::ATOMIC_LOAD_AND_16 ||
1580 N->getOpcode() == ISD::ATOMIC_LOAD_OR_16 ||
1581 N->getOpcode() == ISD::ATOMIC_LOAD_XOR_16 ||
1582 N->getOpcode() == ISD::ATOMIC_LOAD_NAND_16 ||
1583 N->getOpcode() == ISD::ATOMIC_LOAD_MIN_16 ||
1584 N->getOpcode() == ISD::ATOMIC_LOAD_MAX_16 ||
1585 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN_16 ||
1586 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX_16 ||
1588 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_32 ||
1589 N->getOpcode() == ISD::ATOMIC_SWAP_32 ||
1590 N->getOpcode() == ISD::ATOMIC_LOAD_ADD_32 ||
1591 N->getOpcode() == ISD::ATOMIC_LOAD_SUB_32 ||
1592 N->getOpcode() == ISD::ATOMIC_LOAD_AND_32 ||
1593 N->getOpcode() == ISD::ATOMIC_LOAD_OR_32 ||
1594 N->getOpcode() == ISD::ATOMIC_LOAD_XOR_32 ||
1595 N->getOpcode() == ISD::ATOMIC_LOAD_NAND_32 ||
1596 N->getOpcode() == ISD::ATOMIC_LOAD_MIN_32 ||
1597 N->getOpcode() == ISD::ATOMIC_LOAD_MAX_32 ||
1598 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN_32 ||
1599 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX_32 ||
1601 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_64 ||
1602 N->getOpcode() == ISD::ATOMIC_SWAP_64 ||
1603 N->getOpcode() == ISD::ATOMIC_LOAD_ADD_64 ||
1604 N->getOpcode() == ISD::ATOMIC_LOAD_SUB_64 ||
1605 N->getOpcode() == ISD::ATOMIC_LOAD_AND_64 ||
1606 N->getOpcode() == ISD::ATOMIC_LOAD_OR_64 ||
1607 N->getOpcode() == ISD::ATOMIC_LOAD_XOR_64 ||
1608 N->getOpcode() == ISD::ATOMIC_LOAD_NAND_64 ||
1609 N->getOpcode() == ISD::ATOMIC_LOAD_MIN_64 ||
1610 N->getOpcode() == ISD::ATOMIC_LOAD_MAX_64 ||
1611 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN_64 ||
1612 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX_64 ||
1614 N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1615 N->getOpcode() == ISD::INTRINSIC_VOID ||
1616 N->isTargetOpcode();
1620 /// AtomicSDNode - A SDNode reprenting atomic operations.
1622 class AtomicSDNode : public MemSDNode {
1623 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1627 // Opc: opcode for atomic
1628 // VTL: value type list
1629 // Chain: memory chain for operaand
1630 // Ptr: address to update as a SDValue
1631 // Cmp: compare value
1633 // SrcVal: address to update as a Value (used for MemOperand)
1634 // Align: alignment of memory
1635 AtomicSDNode(unsigned Opc, SDVTList VTL, SDValue Chain, SDValue Ptr,
1636 SDValue Cmp, SDValue Swp, const Value* SrcVal,
1638 : MemSDNode(Opc, VTL, Cmp.getValueType(), SrcVal, /*SVOffset=*/0,
1639 Align, /*isVolatile=*/true) {
1644 InitOperands(Ops, 4);
1646 AtomicSDNode(unsigned Opc, SDVTList VTL, SDValue Chain, SDValue Ptr,
1647 SDValue Val, const Value* SrcVal, unsigned Align=0)
1648 : MemSDNode(Opc, VTL, Val.getValueType(), SrcVal, /*SVOffset=*/0,
1649 Align, /*isVolatile=*/true) {
1653 InitOperands(Ops, 3);
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_8 ||
1662 Op == ISD::ATOMIC_CMP_SWAP_16 ||
1663 Op == ISD::ATOMIC_CMP_SWAP_32 ||
1664 Op == ISD::ATOMIC_CMP_SWAP_64;
1667 // Methods to support isa and dyn_cast
1668 static bool classof(const AtomicSDNode *) { return true; }
1669 static bool classof(const SDNode *N) {
1670 return N->getOpcode() == ISD::ATOMIC_CMP_SWAP_8 ||
1671 N->getOpcode() == ISD::ATOMIC_SWAP_8 ||
1672 N->getOpcode() == ISD::ATOMIC_LOAD_ADD_8 ||
1673 N->getOpcode() == ISD::ATOMIC_LOAD_SUB_8 ||
1674 N->getOpcode() == ISD::ATOMIC_LOAD_AND_8 ||
1675 N->getOpcode() == ISD::ATOMIC_LOAD_OR_8 ||
1676 N->getOpcode() == ISD::ATOMIC_LOAD_XOR_8 ||
1677 N->getOpcode() == ISD::ATOMIC_LOAD_NAND_8 ||
1678 N->getOpcode() == ISD::ATOMIC_LOAD_MIN_8 ||
1679 N->getOpcode() == ISD::ATOMIC_LOAD_MAX_8 ||
1680 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN_8 ||
1681 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX_8 ||
1682 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_16 ||
1683 N->getOpcode() == ISD::ATOMIC_SWAP_16 ||
1684 N->getOpcode() == ISD::ATOMIC_LOAD_ADD_16 ||
1685 N->getOpcode() == ISD::ATOMIC_LOAD_SUB_16 ||
1686 N->getOpcode() == ISD::ATOMIC_LOAD_AND_16 ||
1687 N->getOpcode() == ISD::ATOMIC_LOAD_OR_16 ||
1688 N->getOpcode() == ISD::ATOMIC_LOAD_XOR_16 ||
1689 N->getOpcode() == ISD::ATOMIC_LOAD_NAND_16 ||
1690 N->getOpcode() == ISD::ATOMIC_LOAD_MIN_16 ||
1691 N->getOpcode() == ISD::ATOMIC_LOAD_MAX_16 ||
1692 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN_16 ||
1693 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX_16 ||
1694 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_32 ||
1695 N->getOpcode() == ISD::ATOMIC_SWAP_32 ||
1696 N->getOpcode() == ISD::ATOMIC_LOAD_ADD_32 ||
1697 N->getOpcode() == ISD::ATOMIC_LOAD_SUB_32 ||
1698 N->getOpcode() == ISD::ATOMIC_LOAD_AND_32 ||
1699 N->getOpcode() == ISD::ATOMIC_LOAD_OR_32 ||
1700 N->getOpcode() == ISD::ATOMIC_LOAD_XOR_32 ||
1701 N->getOpcode() == ISD::ATOMIC_LOAD_NAND_32 ||
1702 N->getOpcode() == ISD::ATOMIC_LOAD_MIN_32 ||
1703 N->getOpcode() == ISD::ATOMIC_LOAD_MAX_32 ||
1704 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN_32 ||
1705 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX_32 ||
1706 N->getOpcode() == ISD::ATOMIC_CMP_SWAP_64 ||
1707 N->getOpcode() == ISD::ATOMIC_SWAP_64 ||
1708 N->getOpcode() == ISD::ATOMIC_LOAD_ADD_64 ||
1709 N->getOpcode() == ISD::ATOMIC_LOAD_SUB_64 ||
1710 N->getOpcode() == ISD::ATOMIC_LOAD_AND_64 ||
1711 N->getOpcode() == ISD::ATOMIC_LOAD_OR_64 ||
1712 N->getOpcode() == ISD::ATOMIC_LOAD_XOR_64 ||
1713 N->getOpcode() == ISD::ATOMIC_LOAD_NAND_64 ||
1714 N->getOpcode() == ISD::ATOMIC_LOAD_MIN_64 ||
1715 N->getOpcode() == ISD::ATOMIC_LOAD_MAX_64 ||
1716 N->getOpcode() == ISD::ATOMIC_LOAD_UMIN_64 ||
1717 N->getOpcode() == ISD::ATOMIC_LOAD_UMAX_64;
1721 /// MemIntrinsicSDNode - This SDNode is used for target intrinsic that touches
1722 /// memory and need an associated memory operand.
1724 class MemIntrinsicSDNode : public MemSDNode {
1725 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1726 bool ReadMem; // Intrinsic reads memory
1727 bool WriteMem; // Intrinsic writes memory
1729 MemIntrinsicSDNode(unsigned Opc, SDVTList VTs,
1730 const SDValue *Ops, unsigned NumOps,
1731 MVT MemoryVT, const Value *srcValue, int SVO,
1732 unsigned Align, bool Vol, bool ReadMem, bool WriteMem)
1733 : MemSDNode(Opc, VTs, Ops, NumOps, MemoryVT, srcValue, SVO, Align, Vol),
1734 ReadMem(ReadMem), WriteMem(WriteMem) {
1737 bool readMem() const { return ReadMem; }
1738 bool writeMem() const { return WriteMem; }
1740 // Methods to support isa and dyn_cast
1741 static bool classof(const MemIntrinsicSDNode *) { return true; }
1742 static bool classof(const SDNode *N) {
1743 // We lower some target intrinsics to their target opcode
1744 // early a node with a target opcode can be of this class
1745 return N->getOpcode() == ISD::INTRINSIC_W_CHAIN ||
1746 N->getOpcode() == ISD::INTRINSIC_VOID ||
1747 N->isTargetOpcode();
1751 class ConstantSDNode : public SDNode {
1752 const ConstantInt *Value;
1753 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1755 friend class SelectionDAG;
1756 ConstantSDNode(bool isTarget, const ConstantInt *val, MVT VT)
1757 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant, getSDVTList(VT)),
1762 const ConstantInt *getConstantIntValue() const { return Value; }
1763 const APInt &getAPIntValue() const { return Value->getValue(); }
1764 uint64_t getZExtValue() const { return Value->getZExtValue(); }
1765 int64_t getSExtValue() const { return Value->getSExtValue(); }
1767 bool isNullValue() const { return Value->isNullValue(); }
1768 bool isAllOnesValue() const { return Value->isAllOnesValue(); }
1770 static bool classof(const ConstantSDNode *) { return true; }
1771 static bool classof(const SDNode *N) {
1772 return N->getOpcode() == ISD::Constant ||
1773 N->getOpcode() == ISD::TargetConstant;
1777 class ConstantFPSDNode : public SDNode {
1778 const ConstantFP *Value;
1779 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1781 friend class SelectionDAG;
1782 ConstantFPSDNode(bool isTarget, const ConstantFP *val, MVT VT)
1783 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1784 getSDVTList(VT)), Value(val) {
1788 const APFloat& getValueAPF() const { return Value->getValueAPF(); }
1789 const ConstantFP *getConstantFPValue() const { return Value; }
1791 /// isExactlyValue - We don't rely on operator== working on double values, as
1792 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1793 /// As such, this method can be used to do an exact bit-for-bit comparison of
1794 /// two floating point values.
1796 /// We leave the version with the double argument here because it's just so
1797 /// convenient to write "2.0" and the like. Without this function we'd
1798 /// have to duplicate its logic everywhere it's called.
1799 bool isExactlyValue(double V) const {
1801 // convert is not supported on this type
1802 if (&Value->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
1805 Tmp.convert(Value->getValueAPF().getSemantics(),
1806 APFloat::rmNearestTiesToEven, &ignored);
1807 return isExactlyValue(Tmp);
1809 bool isExactlyValue(const APFloat& V) const;
1811 bool isValueValidForType(MVT VT, const APFloat& Val);
1813 static bool classof(const ConstantFPSDNode *) { return true; }
1814 static bool classof(const SDNode *N) {
1815 return N->getOpcode() == ISD::ConstantFP ||
1816 N->getOpcode() == ISD::TargetConstantFP;
1820 class GlobalAddressSDNode : public SDNode {
1821 GlobalValue *TheGlobal;
1823 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1825 friend class SelectionDAG;
1826 GlobalAddressSDNode(bool isTarget, const GlobalValue *GA, MVT VT,
1830 GlobalValue *getGlobal() const { return TheGlobal; }
1831 int64_t getOffset() const { return Offset; }
1833 static bool classof(const GlobalAddressSDNode *) { return true; }
1834 static bool classof(const SDNode *N) {
1835 return N->getOpcode() == ISD::GlobalAddress ||
1836 N->getOpcode() == ISD::TargetGlobalAddress ||
1837 N->getOpcode() == ISD::GlobalTLSAddress ||
1838 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1842 class FrameIndexSDNode : public SDNode {
1844 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1846 friend class SelectionDAG;
1847 FrameIndexSDNode(int fi, MVT VT, bool isTarg)
1848 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex, getSDVTList(VT)),
1853 int getIndex() const { return FI; }
1855 static bool classof(const FrameIndexSDNode *) { return true; }
1856 static bool classof(const SDNode *N) {
1857 return N->getOpcode() == ISD::FrameIndex ||
1858 N->getOpcode() == ISD::TargetFrameIndex;
1862 class JumpTableSDNode : public SDNode {
1864 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1866 friend class SelectionDAG;
1867 JumpTableSDNode(int jti, MVT VT, bool isTarg)
1868 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable, getSDVTList(VT)),
1873 int getIndex() const { return JTI; }
1875 static bool classof(const JumpTableSDNode *) { return true; }
1876 static bool classof(const SDNode *N) {
1877 return N->getOpcode() == ISD::JumpTable ||
1878 N->getOpcode() == ISD::TargetJumpTable;
1882 class ConstantPoolSDNode : public SDNode {
1885 MachineConstantPoolValue *MachineCPVal;
1887 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1889 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1891 friend class SelectionDAG;
1892 ConstantPoolSDNode(bool isTarget, Constant *c, MVT VT, int o=0)
1893 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1894 getSDVTList(VT)), Offset(o), Alignment(0) {
1895 assert((int)Offset >= 0 && "Offset is too large");
1898 ConstantPoolSDNode(bool isTarget, Constant *c, MVT VT, int o, unsigned Align)
1899 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1900 getSDVTList(VT)), Offset(o), Alignment(Align) {
1901 assert((int)Offset >= 0 && "Offset is too large");
1904 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1906 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1907 getSDVTList(VT)), Offset(o), Alignment(0) {
1908 assert((int)Offset >= 0 && "Offset is too large");
1909 Val.MachineCPVal = v;
1910 Offset |= 1 << (sizeof(unsigned)*8-1);
1912 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1913 MVT VT, int o, unsigned Align)
1914 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1915 getSDVTList(VT)), Offset(o), Alignment(Align) {
1916 assert((int)Offset >= 0 && "Offset is too large");
1917 Val.MachineCPVal = v;
1918 Offset |= 1 << (sizeof(unsigned)*8-1);
1922 bool isMachineConstantPoolEntry() const {
1923 return (int)Offset < 0;
1926 Constant *getConstVal() const {
1927 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1928 return Val.ConstVal;
1931 MachineConstantPoolValue *getMachineCPVal() const {
1932 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1933 return Val.MachineCPVal;
1936 int getOffset() const {
1937 return Offset & ~(1 << (sizeof(unsigned)*8-1));
1940 // Return the alignment of this constant pool object, which is either 0 (for
1941 // default alignment) or log2 of the desired value.
1942 unsigned getAlignment() const { return Alignment; }
1944 const Type *getType() const;
1946 static bool classof(const ConstantPoolSDNode *) { return true; }
1947 static bool classof(const SDNode *N) {
1948 return N->getOpcode() == ISD::ConstantPool ||
1949 N->getOpcode() == ISD::TargetConstantPool;
1953 class BasicBlockSDNode : public SDNode {
1954 MachineBasicBlock *MBB;
1955 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1957 friend class SelectionDAG;
1958 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1959 : SDNode(ISD::BasicBlock, getSDVTList(MVT::Other)), MBB(mbb) {
1963 MachineBasicBlock *getBasicBlock() const { return MBB; }
1965 static bool classof(const BasicBlockSDNode *) { return true; }
1966 static bool classof(const SDNode *N) {
1967 return N->getOpcode() == ISD::BasicBlock;
1971 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1972 /// used when the SelectionDAG needs to make a simple reference to something
1973 /// in the LLVM IR representation.
1975 /// Note that this is not used for carrying alias information; that is done
1976 /// with MemOperandSDNode, which includes a Value which is required to be a
1977 /// pointer, and several other fields specific to memory references.
1979 class SrcValueSDNode : public SDNode {
1981 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1983 friend class SelectionDAG;
1984 /// Create a SrcValue for a general value.
1985 explicit SrcValueSDNode(const Value *v)
1986 : SDNode(ISD::SRCVALUE, getSDVTList(MVT::Other)), V(v) {}
1989 /// getValue - return the contained Value.
1990 const Value *getValue() const { return V; }
1992 static bool classof(const SrcValueSDNode *) { return true; }
1993 static bool classof(const SDNode *N) {
1994 return N->getOpcode() == ISD::SRCVALUE;
1999 /// MemOperandSDNode - An SDNode that holds a MachineMemOperand. This is
2000 /// used to represent a reference to memory after ISD::LOAD
2001 /// and ISD::STORE have been lowered.
2003 class MemOperandSDNode : public SDNode {
2004 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2006 friend class SelectionDAG;
2007 /// Create a MachineMemOperand node
2008 explicit MemOperandSDNode(const MachineMemOperand &mo)
2009 : SDNode(ISD::MEMOPERAND, getSDVTList(MVT::Other)), MO(mo) {}
2012 /// MO - The contained MachineMemOperand.
2013 const MachineMemOperand MO;
2015 static bool classof(const MemOperandSDNode *) { return true; }
2016 static bool classof(const SDNode *N) {
2017 return N->getOpcode() == ISD::MEMOPERAND;
2022 class RegisterSDNode : public SDNode {
2024 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2026 friend class SelectionDAG;
2027 RegisterSDNode(unsigned reg, MVT VT)
2028 : SDNode(ISD::Register, getSDVTList(VT)), Reg(reg) {
2032 unsigned getReg() const { return Reg; }
2034 static bool classof(const RegisterSDNode *) { return true; }
2035 static bool classof(const SDNode *N) {
2036 return N->getOpcode() == ISD::Register;
2040 class DbgStopPointSDNode : public SDNode {
2044 const CompileUnitDesc *CU;
2045 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2047 friend class SelectionDAG;
2048 DbgStopPointSDNode(SDValue ch, unsigned l, unsigned c,
2049 const CompileUnitDesc *cu)
2050 : SDNode(ISD::DBG_STOPPOINT, getSDVTList(MVT::Other)),
2051 Line(l), Column(c), CU(cu) {
2053 InitOperands(&Chain, 1);
2056 unsigned getLine() const { return Line; }
2057 unsigned getColumn() const { return Column; }
2058 const CompileUnitDesc *getCompileUnit() const { return CU; }
2060 static bool classof(const DbgStopPointSDNode *) { return true; }
2061 static bool classof(const SDNode *N) {
2062 return N->getOpcode() == ISD::DBG_STOPPOINT;
2066 class LabelSDNode : public SDNode {
2069 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2071 friend class SelectionDAG;
2072 LabelSDNode(unsigned NodeTy, SDValue ch, unsigned id)
2073 : SDNode(NodeTy, getSDVTList(MVT::Other)), LabelID(id) {
2075 InitOperands(&Chain, 1);
2078 unsigned getLabelID() const { return LabelID; }
2080 static bool classof(const LabelSDNode *) { return true; }
2081 static bool classof(const SDNode *N) {
2082 return N->getOpcode() == ISD::DBG_LABEL ||
2083 N->getOpcode() == ISD::EH_LABEL;
2087 class ExternalSymbolSDNode : public SDNode {
2089 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2091 friend class SelectionDAG;
2092 ExternalSymbolSDNode(bool isTarget, const char *Sym, MVT VT)
2093 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
2094 getSDVTList(VT)), Symbol(Sym) {
2098 const char *getSymbol() const { return Symbol; }
2100 static bool classof(const ExternalSymbolSDNode *) { return true; }
2101 static bool classof(const SDNode *N) {
2102 return N->getOpcode() == ISD::ExternalSymbol ||
2103 N->getOpcode() == ISD::TargetExternalSymbol;
2107 class CondCodeSDNode : public SDNode {
2108 ISD::CondCode Condition;
2109 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2111 friend class SelectionDAG;
2112 explicit CondCodeSDNode(ISD::CondCode Cond)
2113 : SDNode(ISD::CONDCODE, getSDVTList(MVT::Other)), Condition(Cond) {
2117 ISD::CondCode get() const { return Condition; }
2119 static bool classof(const CondCodeSDNode *) { return true; }
2120 static bool classof(const SDNode *N) {
2121 return N->getOpcode() == ISD::CONDCODE;
2128 static const uint64_t NoFlagSet = 0ULL;
2129 static const uint64_t ZExt = 1ULL<<0; ///< Zero extended
2130 static const uint64_t ZExtOffs = 0;
2131 static const uint64_t SExt = 1ULL<<1; ///< Sign extended
2132 static const uint64_t SExtOffs = 1;
2133 static const uint64_t InReg = 1ULL<<2; ///< Passed in register
2134 static const uint64_t InRegOffs = 2;
2135 static const uint64_t SRet = 1ULL<<3; ///< Hidden struct-ret ptr
2136 static const uint64_t SRetOffs = 3;
2137 static const uint64_t ByVal = 1ULL<<4; ///< Struct passed by value
2138 static const uint64_t ByValOffs = 4;
2139 static const uint64_t Nest = 1ULL<<5; ///< Nested fn static chain
2140 static const uint64_t NestOffs = 5;
2141 static const uint64_t ByValAlign = 0xFULL << 6; //< Struct alignment
2142 static const uint64_t ByValAlignOffs = 6;
2143 static const uint64_t Split = 1ULL << 10;
2144 static const uint64_t SplitOffs = 10;
2145 static const uint64_t OrigAlign = 0x1FULL<<27;
2146 static const uint64_t OrigAlignOffs = 27;
2147 static const uint64_t ByValSize = 0xffffffffULL << 32; //< Struct size
2148 static const uint64_t ByValSizeOffs = 32;
2150 static const uint64_t One = 1ULL; //< 1 of this type, for shifts
2154 ArgFlagsTy() : Flags(0) { }
2156 bool isZExt() const { return Flags & ZExt; }
2157 void setZExt() { Flags |= One << ZExtOffs; }
2159 bool isSExt() const { return Flags & SExt; }
2160 void setSExt() { Flags |= One << SExtOffs; }
2162 bool isInReg() const { return Flags & InReg; }
2163 void setInReg() { Flags |= One << InRegOffs; }
2165 bool isSRet() const { return Flags & SRet; }
2166 void setSRet() { Flags |= One << SRetOffs; }
2168 bool isByVal() const { return Flags & ByVal; }
2169 void setByVal() { Flags |= One << ByValOffs; }
2171 bool isNest() const { return Flags & Nest; }
2172 void setNest() { Flags |= One << NestOffs; }
2174 unsigned getByValAlign() const {
2176 ((One << ((Flags & ByValAlign) >> ByValAlignOffs)) / 2);
2178 void setByValAlign(unsigned A) {
2179 Flags = (Flags & ~ByValAlign) |
2180 (uint64_t(Log2_32(A) + 1) << ByValAlignOffs);
2183 bool isSplit() const { return Flags & Split; }
2184 void setSplit() { Flags |= One << SplitOffs; }
2186 unsigned getOrigAlign() const {
2188 ((One << ((Flags & OrigAlign) >> OrigAlignOffs)) / 2);
2190 void setOrigAlign(unsigned A) {
2191 Flags = (Flags & ~OrigAlign) |
2192 (uint64_t(Log2_32(A) + 1) << OrigAlignOffs);
2195 unsigned getByValSize() const {
2196 return (unsigned)((Flags & ByValSize) >> ByValSizeOffs);
2198 void setByValSize(unsigned S) {
2199 Flags = (Flags & ~ByValSize) | (uint64_t(S) << ByValSizeOffs);
2202 /// getArgFlagsString - Returns the flags as a string, eg: "zext align:4".
2203 std::string getArgFlagsString();
2205 /// getRawBits - Represent the flags as a bunch of bits.
2206 uint64_t getRawBits() const { return Flags; }
2210 /// ARG_FLAGSSDNode - Leaf node holding parameter flags.
2211 class ARG_FLAGSSDNode : public SDNode {
2212 ISD::ArgFlagsTy TheFlags;
2213 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2215 friend class SelectionDAG;
2216 explicit ARG_FLAGSSDNode(ISD::ArgFlagsTy Flags)
2217 : SDNode(ISD::ARG_FLAGS, getSDVTList(MVT::Other)), TheFlags(Flags) {
2220 ISD::ArgFlagsTy getArgFlags() const { return TheFlags; }
2222 static bool classof(const ARG_FLAGSSDNode *) { return true; }
2223 static bool classof(const SDNode *N) {
2224 return N->getOpcode() == ISD::ARG_FLAGS;
2228 /// CallSDNode - Node for calls -- ISD::CALL.
2229 class CallSDNode : public SDNode {
2230 unsigned CallingConv;
2233 // We might eventually want a full-blown Attributes for the result; that
2234 // will expand the size of the representation. At the moment we only
2237 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2239 friend class SelectionDAG;
2240 CallSDNode(unsigned cc, bool isvararg, bool istailcall, bool isinreg,
2241 SDVTList VTs, const SDValue *Operands, unsigned numOperands)
2242 : SDNode(ISD::CALL, VTs, Operands, numOperands),
2243 CallingConv(cc), IsVarArg(isvararg), IsTailCall(istailcall),
2246 unsigned getCallingConv() const { return CallingConv; }
2247 unsigned isVarArg() const { return IsVarArg; }
2248 unsigned isTailCall() const { return IsTailCall; }
2249 unsigned isInreg() const { return Inreg; }
2251 /// Set this call to not be marked as a tail call. Normally setter
2252 /// methods in SDNodes are unsafe because it breaks the CSE map,
2253 /// but we don't include the tail call flag for calls so it's ok
2255 void setNotTailCall() { IsTailCall = false; }
2257 SDValue getChain() const { return getOperand(0); }
2258 SDValue getCallee() const { return getOperand(1); }
2260 unsigned getNumArgs() const { return (getNumOperands() - 2) / 2; }
2261 SDValue getArg(unsigned i) const { return getOperand(2+2*i); }
2262 SDValue getArgFlagsVal(unsigned i) const {
2263 return getOperand(3+2*i);
2265 ISD::ArgFlagsTy getArgFlags(unsigned i) const {
2266 return cast<ARG_FLAGSSDNode>(getArgFlagsVal(i).getNode())->getArgFlags();
2269 unsigned getNumRetVals() const { return getNumValues() - 1; }
2270 MVT getRetValType(unsigned i) const { return getValueType(i); }
2272 static bool classof(const CallSDNode *) { return true; }
2273 static bool classof(const SDNode *N) {
2274 return N->getOpcode() == ISD::CALL;
2278 /// VTSDNode - This class is used to represent MVT's, which are used
2279 /// to parameterize some operations.
2280 class VTSDNode : public SDNode {
2282 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2284 friend class SelectionDAG;
2285 explicit VTSDNode(MVT VT)
2286 : SDNode(ISD::VALUETYPE, getSDVTList(MVT::Other)), ValueType(VT) {
2290 MVT getVT() const { return ValueType; }
2292 static bool classof(const VTSDNode *) { return true; }
2293 static bool classof(const SDNode *N) {
2294 return N->getOpcode() == ISD::VALUETYPE;
2298 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
2300 class LSBaseSDNode : public MemSDNode {
2302 //! Operand array for load and store
2304 \note Moving this array to the base class captures more
2305 common functionality shared between LoadSDNode and
2310 LSBaseSDNode(ISD::NodeType NodeTy, SDValue *Operands, unsigned numOperands,
2311 SDVTList VTs, ISD::MemIndexedMode AM, MVT VT,
2312 const Value *SV, int SVO, unsigned Align, bool Vol)
2313 : MemSDNode(NodeTy, VTs, VT, SV, SVO, Align, Vol) {
2315 for (unsigned i = 0; i != numOperands; ++i)
2316 Ops[i] = Operands[i];
2317 InitOperands(Ops, numOperands);
2318 assert(Align != 0 && "Loads and stores should have non-zero aligment");
2319 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
2320 "Only indexed loads and stores have a non-undef offset operand");
2323 const SDValue &getOffset() const {
2324 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
2327 /// getAddressingMode - Return the addressing mode for this load or store:
2328 /// unindexed, pre-inc, pre-dec, post-inc, or post-dec.
2329 ISD::MemIndexedMode getAddressingMode() const {
2330 return ISD::MemIndexedMode(SubclassData & 7);
2333 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
2334 bool isIndexed() const { return getAddressingMode() != ISD::UNINDEXED; }
2336 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
2337 bool isUnindexed() const { return getAddressingMode() == ISD::UNINDEXED; }
2339 static bool classof(const LSBaseSDNode *) { return true; }
2340 static bool classof(const SDNode *N) {
2341 return N->getOpcode() == ISD::LOAD ||
2342 N->getOpcode() == ISD::STORE;
2346 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
2348 class LoadSDNode : public LSBaseSDNode {
2349 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2351 friend class SelectionDAG;
2352 LoadSDNode(SDValue *ChainPtrOff, SDVTList VTs,
2353 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, MVT LVT,
2354 const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
2355 : LSBaseSDNode(ISD::LOAD, ChainPtrOff, 3,
2356 VTs, AM, LVT, SV, O, Align, Vol) {
2357 SubclassData |= (unsigned short)ETy << 3;
2361 /// getExtensionType - Return whether this is a plain node,
2362 /// or one of the varieties of value-extending loads.
2363 ISD::LoadExtType getExtensionType() const {
2364 return ISD::LoadExtType((SubclassData >> 3) & 3);
2367 const SDValue &getBasePtr() const { return getOperand(1); }
2368 const SDValue &getOffset() const { return getOperand(2); }
2370 static bool classof(const LoadSDNode *) { return true; }
2371 static bool classof(const SDNode *N) {
2372 return N->getOpcode() == ISD::LOAD;
2376 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
2378 class StoreSDNode : public LSBaseSDNode {
2379 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
2381 friend class SelectionDAG;
2382 StoreSDNode(SDValue *ChainValuePtrOff, SDVTList VTs,
2383 ISD::MemIndexedMode AM, bool isTrunc, MVT SVT,
2384 const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
2385 : LSBaseSDNode(ISD::STORE, ChainValuePtrOff, 4,
2386 VTs, AM, SVT, SV, O, Align, Vol) {
2387 SubclassData |= (unsigned short)isTrunc << 3;
2391 /// isTruncatingStore - Return true if the op does a truncation before store.
2392 /// For integers this is the same as doing a TRUNCATE and storing the result.
2393 /// For floats, it is the same as doing an FP_ROUND and storing the result.
2394 bool isTruncatingStore() const { return (SubclassData >> 3) & 1; }
2396 const SDValue &getValue() const { return getOperand(1); }
2397 const SDValue &getBasePtr() const { return getOperand(2); }
2398 const SDValue &getOffset() const { return getOperand(3); }
2400 static bool classof(const StoreSDNode *) { return true; }
2401 static bool classof(const SDNode *N) {
2402 return N->getOpcode() == ISD::STORE;
2407 class SDNodeIterator : public forward_iterator<SDNode, ptrdiff_t> {
2411 SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
2413 bool operator==(const SDNodeIterator& x) const {
2414 return Operand == x.Operand;
2416 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
2418 const SDNodeIterator &operator=(const SDNodeIterator &I) {
2419 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
2420 Operand = I.Operand;
2424 pointer operator*() const {
2425 return Node->getOperand(Operand).getNode();
2427 pointer operator->() const { return operator*(); }
2429 SDNodeIterator& operator++() { // Preincrement
2433 SDNodeIterator operator++(int) { // Postincrement
2434 SDNodeIterator tmp = *this; ++*this; return tmp;
2437 static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
2438 static SDNodeIterator end (SDNode *N) {
2439 return SDNodeIterator(N, N->getNumOperands());
2442 unsigned getOperand() const { return Operand; }
2443 const SDNode *getNode() const { return Node; }
2446 template <> struct GraphTraits<SDNode*> {
2447 typedef SDNode NodeType;
2448 typedef SDNodeIterator ChildIteratorType;
2449 static inline NodeType *getEntryNode(SDNode *N) { return N; }
2450 static inline ChildIteratorType child_begin(NodeType *N) {
2451 return SDNodeIterator::begin(N);
2453 static inline ChildIteratorType child_end(NodeType *N) {
2454 return SDNodeIterator::end(N);
2458 /// LargestSDNode - The largest SDNode class.
2460 typedef LoadSDNode LargestSDNode;
2462 /// MostAlignedSDNode - The SDNode class with the greatest alignment
2465 typedef ARG_FLAGSSDNode MostAlignedSDNode;
2468 /// isNormalLoad - Returns true if the specified node is a non-extending
2469 /// and unindexed load.
2470 inline bool isNormalLoad(const SDNode *N) {
2471 const LoadSDNode *Ld = dyn_cast<LoadSDNode>(N);
2472 return Ld && Ld->getExtensionType() == ISD::NON_EXTLOAD &&
2473 Ld->getAddressingMode() == ISD::UNINDEXED;
2476 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
2478 inline bool isNON_EXTLoad(const SDNode *N) {
2479 return isa<LoadSDNode>(N) &&
2480 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
2483 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
2485 inline bool isEXTLoad(const SDNode *N) {
2486 return isa<LoadSDNode>(N) &&
2487 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
2490 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
2492 inline bool isSEXTLoad(const SDNode *N) {
2493 return isa<LoadSDNode>(N) &&
2494 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
2497 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
2499 inline bool isZEXTLoad(const SDNode *N) {
2500 return isa<LoadSDNode>(N) &&
2501 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
2504 /// isUNINDEXEDLoad - Returns true if the specified node is an unindexed load.
2506 inline bool isUNINDEXEDLoad(const SDNode *N) {
2507 return isa<LoadSDNode>(N) &&
2508 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2511 /// isNormalStore - Returns true if the specified node is a non-truncating
2512 /// and unindexed store.
2513 inline bool isNormalStore(const SDNode *N) {
2514 const StoreSDNode *St = dyn_cast<StoreSDNode>(N);
2515 return St && !St->isTruncatingStore() &&
2516 St->getAddressingMode() == ISD::UNINDEXED;
2519 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
2521 inline bool isNON_TRUNCStore(const SDNode *N) {
2522 return isa<StoreSDNode>(N) && !cast<StoreSDNode>(N)->isTruncatingStore();
2525 /// isTRUNCStore - Returns true if the specified node is a truncating
2527 inline bool isTRUNCStore(const SDNode *N) {
2528 return isa<StoreSDNode>(N) && cast<StoreSDNode>(N)->isTruncatingStore();
2531 /// isUNINDEXEDStore - Returns true if the specified node is an
2532 /// unindexed store.
2533 inline bool isUNINDEXEDStore(const SDNode *N) {
2534 return isa<StoreSDNode>(N) &&
2535 cast<StoreSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2540 } // end llvm namespace