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/ADT/FoldingSet.h"
24 #include "llvm/ADT/GraphTraits.h"
25 #include "llvm/ADT/iterator"
26 #include "llvm/ADT/APFloat.h"
27 #include "llvm/ADT/APInt.h"
28 #include "llvm/CodeGen/ValueTypes.h"
29 #include "llvm/CodeGen/MemOperand.h"
30 #include "llvm/Support/DataTypes.h"
37 class MachineBasicBlock;
38 class MachineConstantPoolValue;
40 template <typename T> struct DenseMapInfo;
41 template <typename T> struct simplify_type;
42 template <typename T> struct ilist_traits;
43 template<typename NodeTy, typename Traits> class iplist;
44 template<typename NodeTy> class ilist_iterator;
46 /// SDVTList - This represents a list of ValueType's that has been intern'd by
47 /// a SelectionDAG. Instances of this simple value class are returned by
48 /// SelectionDAG::getVTList(...).
51 const MVT::ValueType *VTs;
52 unsigned short NumVTs;
55 /// ISD namespace - This namespace contains an enum which represents all of the
56 /// SelectionDAG node types and value types.
59 namespace ParamFlags {
62 ZExt = 1<<0, ///< Parameter should be zero extended
64 SExt = 1<<1, ///< Parameter should be sign extended
66 InReg = 1<<2, ///< Parameter should be passed in register
68 StructReturn = 1<<3, ///< Hidden struct-return pointer
70 ByVal = 1<<4, ///< Struct passed by value
72 Nest = 1<<5, ///< Parameter is nested function static chain
74 ByValAlign = 0xF << 6, //< The alignment of the struct
76 ByValSize = 0x1ffff << 10, //< The size of the struct
78 OrigAlignment = 0x1F<<27,
79 OrigAlignmentOffs = 27
83 //===--------------------------------------------------------------------===//
84 /// ISD::NodeType enum - This enum defines all of the operators valid in a
88 // DELETED_NODE - This is an illegal flag value that is used to catch
89 // errors. This opcode is not a legal opcode for any node.
92 // EntryToken - This is the marker used to indicate the start of the region.
95 // Token factor - This node takes multiple tokens as input and produces a
96 // single token result. This is used to represent the fact that the operand
97 // operators are independent of each other.
100 // AssertSext, AssertZext - These nodes record if a register contains a
101 // value that has already been zero or sign extended from a narrower type.
102 // These nodes take two operands. The first is the node that has already
103 // been extended, and the second is a value type node indicating the width
105 AssertSext, AssertZext,
107 // Various leaf nodes.
108 STRING, BasicBlock, VALUETYPE, CONDCODE, Register,
109 Constant, ConstantFP,
110 GlobalAddress, GlobalTLSAddress, FrameIndex,
111 JumpTable, ConstantPool, ExternalSymbol,
113 // The address of the GOT
116 // FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
117 // llvm.returnaddress on the DAG. These nodes take one operand, the index
118 // of the frame or return address to return. An index of zero corresponds
119 // to the current function's frame or return address, an index of one to the
120 // parent's frame or return address, and so on.
121 FRAMEADDR, RETURNADDR,
123 // FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
124 // first (possible) on-stack argument. This is needed for correct stack
125 // adjustment during unwind.
126 FRAME_TO_ARGS_OFFSET,
128 // RESULT, OUTCHAIN = EXCEPTIONADDR(INCHAIN) - This node represents the
129 // address of the exception block on entry to an landing pad block.
132 // RESULT, OUTCHAIN = EHSELECTION(INCHAIN, EXCEPTION) - This node represents
133 // the selection index of the exception thrown.
136 // OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
137 // 'eh_return' gcc dwarf builtin, which is used to return from
138 // exception. The general meaning is: adjust stack by OFFSET and pass
139 // execution to HANDLER. Many platform-related details also :)
142 // TargetConstant* - Like Constant*, but the DAG does not do any folding or
143 // simplification of the constant.
147 // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
148 // anything else with this node, and this is valid in the target-specific
149 // dag, turning into a GlobalAddress operand.
151 TargetGlobalTLSAddress,
155 TargetExternalSymbol,
157 /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
158 /// This node represents a target intrinsic function with no side effects.
159 /// The first operand is the ID number of the intrinsic from the
160 /// llvm::Intrinsic namespace. The operands to the intrinsic follow. The
161 /// node has returns the result of the intrinsic.
164 /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
165 /// This node represents a target intrinsic function with side effects that
166 /// returns a result. The first operand is a chain pointer. The second is
167 /// the ID number of the intrinsic from the llvm::Intrinsic namespace. The
168 /// operands to the intrinsic follow. The node has two results, the result
169 /// of the intrinsic and an output chain.
172 /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
173 /// This node represents a target intrinsic function with side effects that
174 /// does not return a result. The first operand is a chain pointer. The
175 /// second is the ID number of the intrinsic from the llvm::Intrinsic
176 /// namespace. The operands to the intrinsic follow.
179 // CopyToReg - This node has three operands: a chain, a register number to
180 // set to this value, and a value.
183 // CopyFromReg - This node indicates that the input value is a virtual or
184 // physical register that is defined outside of the scope of this
185 // SelectionDAG. The register is available from the RegisterSDNode object.
188 // UNDEF - An undefined node
191 /// FORMAL_ARGUMENTS(CHAIN, CC#, ISVARARG, FLAG0, ..., FLAGn) - This node
192 /// represents the formal arguments for a function. CC# is a Constant value
193 /// indicating the calling convention of the function, and ISVARARG is a
194 /// flag that indicates whether the function is varargs or not. This node
195 /// has one result value for each incoming argument, plus one for the output
196 /// chain. It must be custom legalized. See description of CALL node for
197 /// FLAG argument contents explanation.
201 /// RV1, RV2...RVn, CHAIN = CALL(CHAIN, CC#, ISVARARG, ISTAILCALL, CALLEE,
202 /// ARG0, FLAG0, ARG1, FLAG1, ... ARGn, FLAGn)
203 /// This node represents a fully general function call, before the legalizer
204 /// runs. This has one result value for each argument / flag pair, plus
205 /// a chain result. It must be custom legalized. Flag argument indicates
206 /// misc. argument attributes. Currently:
208 /// Bit 1 - 'inreg' attribute
209 /// Bit 2 - 'sret' attribute
210 /// Bit 4 - 'byval' attribute
211 /// Bit 5 - 'nest' attribute
212 /// Bit 6-9 - alignment of byval structures
213 /// Bit 10-26 - size of byval structures
214 /// Bits 31:27 - argument ABI alignment in the first argument piece and
215 /// alignment '1' in other argument pieces.
218 // EXTRACT_ELEMENT - This is used to get the first or second (determined by
219 // a Constant, which is required to be operand #1), element of the aggregate
220 // value specified as operand #0. This is only for use before legalization,
221 // for values that will be broken into multiple registers.
224 // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways. Given
225 // two values of the same integer value type, this produces a value twice as
226 // big. Like EXTRACT_ELEMENT, this can only be used before legalization.
229 // MERGE_VALUES - This node takes multiple discrete operands and returns
230 // them all as its individual results. This nodes has exactly the same
231 // number of inputs and outputs, and is only valid before legalization.
232 // This node is useful for some pieces of the code generator that want to
233 // think about a single node with multiple results, not multiple nodes.
236 // Simple integer binary arithmetic operators.
237 ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
239 // SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing
240 // a signed/unsigned value of type i[2*N], and return the full value as
241 // two results, each of type iN.
242 SMUL_LOHI, UMUL_LOHI,
244 // SDIVREM/UDIVREM - Divide two integers and produce both a quotient and
248 // CARRY_FALSE - This node is used when folding other nodes,
249 // like ADDC/SUBC, which indicate the carry result is always false.
252 // Carry-setting nodes for multiple precision addition and subtraction.
253 // These nodes take two operands of the same value type, and produce two
254 // results. The first result is the normal add or sub result, the second
255 // result is the carry flag result.
258 // Carry-using nodes for multiple precision addition and subtraction. These
259 // nodes take three operands: The first two are the normal lhs and rhs to
260 // the add or sub, and the third is the input carry flag. These nodes
261 // produce two results; the normal result of the add or sub, and the output
262 // carry flag. These nodes both read and write a carry flag to allow them
263 // to them to be chained together for add and sub of arbitrarily large
267 // Simple binary floating point operators.
268 FADD, FSUB, FMUL, FDIV, FREM,
270 // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y. NOTE: This
271 // DAG node does not require that X and Y have the same type, just that they
272 // are both floating point. X and the result must have the same type.
273 // FCOPYSIGN(f32, f64) is allowed.
276 // INT = FGETSIGN(FP) - Return the sign bit of the specified floating point
277 // value as an integer 0/1 value.
280 /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector
281 /// with the specified, possibly variable, elements. The number of elements
282 /// is required to be a power of two.
285 /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR with the element
286 /// at IDX replaced with VAL.
289 /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
290 /// identified by the (potentially variable) element number IDX.
293 /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
294 /// vector type with the same length and element type, this produces a
295 /// concatenated vector result value, with length equal to the sum of the
296 /// lengths of the input vectors.
299 /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
300 /// vector value) starting with the (potentially variable) element number
301 /// IDX, which must be a multiple of the result vector length.
304 /// VECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC) - Returns a vector, of the same
305 /// type as VEC1/VEC2. SHUFFLEVEC is a BUILD_VECTOR of constant int values
306 /// (regardless of whether its datatype is legal or not) that indicate
307 /// which value each result element will get. The elements of VEC1/VEC2 are
308 /// enumerated in order. This is quite similar to the Altivec 'vperm'
309 /// instruction, except that the indices must be constants and are in terms
310 /// of the element size of VEC1/VEC2, not in terms of bytes.
313 /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
314 /// scalar value into element 0 of the resultant vector type. The top
315 /// elements 1 to N-1 of the N-element vector are undefined.
318 // EXTRACT_SUBREG - This node is used to extract a sub-register value.
319 // This node takes a superreg and a constant sub-register index as operands.
322 // INSERT_SUBREG - This node is used to insert a sub-register value.
323 // This node takes a superreg, a subreg value, and a constant sub-register
324 // index as operands.
327 // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
328 // an unsigned/signed value of type i[2*N], then return the top part.
331 // Bitwise operators - logical and, logical or, logical xor, shift left,
332 // shift right algebraic (shift in sign bits), shift right logical (shift in
333 // zeroes), rotate left, rotate right, and byteswap.
334 AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
336 // Counting operators
339 // Select(COND, TRUEVAL, FALSEVAL)
342 // Select with condition operator - This selects between a true value and
343 // a false value (ops #2 and #3) based on the boolean result of comparing
344 // the lhs and rhs (ops #0 and #1) of a conditional expression with the
345 // condition code in op #4, a CondCodeSDNode.
348 // SetCC operator - This evaluates to a boolean (i1) true value if the
349 // condition is true. The operands to this are the left and right operands
350 // to compare (ops #0, and #1) and the condition code to compare them with
351 // (op #2) as a CondCodeSDNode.
354 // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
355 // integer shift operations, just like ADD/SUB_PARTS. The operation
357 // [Lo,Hi] = op [LoLHS,HiLHS], Amt
358 SHL_PARTS, SRA_PARTS, SRL_PARTS,
360 // Conversion operators. These are all single input single output
361 // operations. For all of these, the result type must be strictly
362 // wider or narrower (depending on the operation) than the source
365 // SIGN_EXTEND - Used for integer types, replicating the sign bit
369 // ZERO_EXTEND - Used for integer types, zeroing the new bits.
372 // ANY_EXTEND - Used for integer types. The high bits are undefined.
375 // TRUNCATE - Completely drop the high bits.
378 // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
379 // depends on the first letter) to floating point.
383 // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
384 // sign extend a small value in a large integer register (e.g. sign
385 // extending the low 8 bits of a 32-bit register to fill the top 24 bits
386 // with the 7th bit). The size of the smaller type is indicated by the 1th
387 // operand, a ValueType node.
390 /// FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
395 /// X = FP_ROUND(Y, TRUNC) - Rounding 'Y' from a larger floating point type
396 /// down to the precision of the destination VT. TRUNC is a flag, which is
397 /// always an integer that is zero or one. If TRUNC is 0, this is a
398 /// normal rounding, if it is 1, this FP_ROUND is known to not change the
401 /// The TRUNC = 1 case is used in cases where we know that the value will
402 /// not be modified by the node, because Y is not using any of the extra
403 /// precision of source type. This allows certain transformations like
404 /// FP_EXTEND(FP_ROUND(X,1)) -> X which are not safe for
405 /// FP_EXTEND(FP_ROUND(X,0)) because the extra bits aren't removed.
408 // FLT_ROUNDS_ - Returns current rounding mode:
411 // 1 Round to nearest
416 /// X = FP_ROUND_INREG(Y, VT) - This operator takes an FP register, and
417 /// rounds it to a floating point value. It then promotes it and returns it
418 /// in a register of the same size. This operation effectively just
419 /// discards excess precision. The type to round down to is specified by
420 /// the VT operand, a VTSDNode.
423 /// X = FP_EXTEND(Y) - Extend a smaller FP type into a larger FP type.
426 // BIT_CONVERT - Theis operator converts between integer and FP values, as
427 // if one was stored to memory as integer and the other was loaded from the
428 // same address (or equivalently for vector format conversions, etc). The
429 // source and result are required to have the same bit size (e.g.
430 // f32 <-> i32). This can also be used for int-to-int or fp-to-fp
431 // conversions, but that is a noop, deleted by getNode().
434 // FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW - Perform unary floating point
435 // negation, absolute value, square root, sine and cosine, powi, and pow
437 FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
439 // LOAD and STORE have token chains as their first operand, then the same
440 // operands as an LLVM load/store instruction, then an offset node that
441 // is added / subtracted from the base pointer to form the address (for
442 // indexed memory ops).
445 // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
446 // to a specified boundary. This node always has two return values: a new
447 // stack pointer value and a chain. The first operand is the token chain,
448 // the second is the number of bytes to allocate, and the third is the
449 // alignment boundary. The size is guaranteed to be a multiple of the stack
450 // alignment, and the alignment is guaranteed to be bigger than the stack
451 // alignment (if required) or 0 to get standard stack alignment.
454 // Control flow instructions. These all have token chains.
456 // BR - Unconditional branch. The first operand is the chain
457 // operand, the second is the MBB to branch to.
460 // BRIND - Indirect branch. The first operand is the chain, the second
461 // is the value to branch to, which must be of the same type as the target's
465 // BR_JT - Jumptable branch. The first operand is the chain, the second
466 // is the jumptable index, the last one is the jumptable entry index.
469 // BRCOND - Conditional branch. The first operand is the chain,
470 // the second is the condition, the third is the block to branch
471 // to if the condition is true.
474 // BR_CC - Conditional branch. The behavior is like that of SELECT_CC, in
475 // that the condition is represented as condition code, and two nodes to
476 // compare, rather than as a combined SetCC node. The operands in order are
477 // chain, cc, lhs, rhs, block to branch to if condition is true.
480 // RET - Return from function. The first operand is the chain,
481 // and any subsequent operands are pairs of return value and return value
482 // signness for the function. This operation can have variable number of
486 // INLINEASM - Represents an inline asm block. This node always has two
487 // return values: a chain and a flag result. The inputs are as follows:
488 // Operand #0 : Input chain.
489 // Operand #1 : a ExternalSymbolSDNode with a pointer to the asm string.
490 // Operand #2n+2: A RegisterNode.
491 // Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
492 // Operand #last: Optional, an incoming flag.
495 // LABEL - Represents a label in mid basic block used to track
496 // locations needed for debug and exception handling tables. This node
498 // Operand #0 : input chain.
499 // Operand #1 : module unique number use to identify the label.
500 // Operand #2 : 0 indicates a debug label (e.g. stoppoint), 1 indicates
501 // a EH label, 2 indicates unknown label type.
504 // DECLARE - Represents a llvm.dbg.declare intrinsic. It's used to track
505 // local variable declarations for debugging information. First operand is
506 // a chain, while the next two operands are first two arguments (address
507 // and variable) of a llvm.dbg.declare instruction.
510 // STACKSAVE - STACKSAVE has one operand, an input chain. It produces a
511 // value, the same type as the pointer type for the system, and an output
515 // STACKRESTORE has two operands, an input chain and a pointer to restore to
516 // it returns an output chain.
519 // MEMSET/MEMCPY/MEMMOVE - The first operand is the chain. The following
520 // correspond to the operands of the LLVM intrinsic functions and the last
521 // one is AlwaysInline. The only result is a token chain. The alignment
522 // argument is guaranteed to be a Constant node.
527 // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
528 // a call sequence, and carry arbitrary information that target might want
529 // to know. The first operand is a chain, the rest are specified by the
530 // target and not touched by the DAG optimizers.
531 CALLSEQ_START, // Beginning of a call sequence
532 CALLSEQ_END, // End of a call sequence
534 // VAARG - VAARG has three operands: an input chain, a pointer, and a
535 // SRCVALUE. It returns a pair of values: the vaarg value and a new chain.
538 // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
539 // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
543 // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
544 // pointer, and a SRCVALUE.
547 // SRCVALUE - This is a node type that holds a Value* that is used to
548 // make reference to a value in the LLVM IR.
551 // MEMOPERAND - This is a node that contains a MemOperand which records
552 // information about a memory reference. This is used to make AliasAnalysis
553 // queries from the backend.
556 // PCMARKER - This corresponds to the pcmarker intrinsic.
559 // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
560 // The only operand is a chain and a value and a chain are produced. The
561 // value is the contents of the architecture specific cycle counter like
562 // register (or other high accuracy low latency clock source)
565 // HANDLENODE node - Used as a handle for various purposes.
568 // LOCATION - This node is used to represent a source location for debug
569 // info. It takes token chain as input, then a line number, then a column
570 // number, then a filename, then a working dir. It produces a token chain
574 // DEBUG_LOC - This node is used to represent source line information
575 // embedded in the code. It takes a token chain as input, then a line
576 // number, then a column then a file id (provided by MachineModuleInfo.) It
577 // produces a token chain as output.
580 // TRAMPOLINE - This corresponds to the init_trampoline intrinsic.
581 // It takes as input a token chain, the pointer to the trampoline,
582 // the pointer to the nested function, the pointer to pass for the
583 // 'nest' parameter, a SRCVALUE for the trampoline and another for
584 // the nested function (allowing targets to access the original
585 // Function*). It produces the result of the intrinsic and a token
589 // TRAP - Trapping instruction
592 // OUTCHAIN = MEMBARRIER(INCHAIN, load-load, load-store, store-load,
593 // store-store, device)
594 // This corresponds to the memory.barrier intrinsic.
595 // it takes an input chain, 4 operands to specify the type of barrier, an
596 // operand specifying if the barrier applies to device and uncached memory
597 // and produces an output chain.
600 // Val, OUTCHAIN = ATOMIC_LCS(INCHAIN, ptr, cmp, swap)
601 // this corresponds to the atomic.lcs intrinsic.
602 // cmp is compared to *ptr, and if equal, swap is stored in *ptr.
603 // the return is always the original value in *ptr
606 // Val, OUTCHAIN = ATOMIC_LAS(INCHAIN, ptr, amt)
607 // this corresponds to the atomic.las intrinsic.
608 // *ptr + amt is stored to *ptr atomically.
609 // the return is always the original value in *ptr
612 // Val, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amt)
613 // this corresponds to the atomic.swap intrinsic.
614 // amt is stored to *ptr atomically.
615 // the return is always the original value in *ptr
618 // BUILTIN_OP_END - This must be the last enum value in this list.
624 /// isBuildVectorAllOnes - Return true if the specified node is a
625 /// BUILD_VECTOR where all of the elements are ~0 or undef.
626 bool isBuildVectorAllOnes(const SDNode *N);
628 /// isBuildVectorAllZeros - Return true if the specified node is a
629 /// BUILD_VECTOR where all of the elements are 0 or undef.
630 bool isBuildVectorAllZeros(const SDNode *N);
632 /// isScalarToVector - Return true if the specified node is a
633 /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
634 /// element is not an undef.
635 bool isScalarToVector(const SDNode *N);
637 /// isDebugLabel - Return true if the specified node represents a debug
638 /// label (i.e. ISD::LABEL or TargetInstrInfo::LABEL node and third operand
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 produces 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);
791 } // end llvm::ISD namespace
794 //===----------------------------------------------------------------------===//
795 /// SDOperand - Unlike LLVM values, Selection DAG nodes may return multiple
796 /// values as the result of a computation. Many nodes return multiple values,
797 /// from loads (which define a token and a return value) to ADDC (which returns
798 /// a result and a carry value), to calls (which may return an arbitrary number
801 /// As such, each use of a SelectionDAG computation must indicate the node that
802 /// computes it as well as which return value to use from that node. This pair
803 /// of information is represented with the SDOperand value type.
807 SDNode *Val; // The node defining the value we are using.
808 unsigned ResNo; // Which return value of the node we are using.
810 SDOperand() : Val(0), ResNo(0) {}
811 SDOperand(SDNode *val, unsigned resno) : Val(val), ResNo(resno) {}
813 bool operator==(const SDOperand &O) const {
814 return Val == O.Val && ResNo == O.ResNo;
816 bool operator!=(const SDOperand &O) const {
817 return !operator==(O);
819 bool operator<(const SDOperand &O) const {
820 return Val < O.Val || (Val == O.Val && ResNo < O.ResNo);
823 SDOperand getValue(unsigned R) const {
824 return SDOperand(Val, R);
827 // isOperand - Return true if this node is an operand of N.
828 bool isOperand(SDNode *N) const;
830 /// getValueType - Return the ValueType of the referenced return value.
832 inline MVT::ValueType getValueType() const;
834 // Forwarding methods - These forward to the corresponding methods in SDNode.
835 inline unsigned getOpcode() const;
836 inline unsigned getNumOperands() const;
837 inline const SDOperand &getOperand(unsigned i) const;
838 inline uint64_t getConstantOperandVal(unsigned i) const;
839 inline bool isTargetOpcode() const;
840 inline unsigned getTargetOpcode() const;
843 /// reachesChainWithoutSideEffects - Return true if this operand (which must
844 /// be a chain) reaches the specified operand without crossing any
845 /// side-effecting instructions. In practice, this looks through token
846 /// factors and non-volatile loads. In order to remain efficient, this only
847 /// looks a couple of nodes in, it does not do an exhaustive search.
848 bool reachesChainWithoutSideEffects(SDOperand Dest, unsigned Depth = 2) const;
850 /// hasOneUse - Return true if there is exactly one operation using this
851 /// result value of the defining operator.
852 inline bool hasOneUse() const;
854 /// use_empty - Return true if there are no operations using this
855 /// result value of the defining operator.
856 inline bool use_empty() const;
860 template<> struct DenseMapInfo<SDOperand> {
861 static inline SDOperand getEmptyKey() { return SDOperand((SDNode*)-1, -1U); }
862 static inline SDOperand getTombstoneKey() { return SDOperand((SDNode*)-1, 0);}
863 static unsigned getHashValue(const SDOperand &Val) {
864 return ((unsigned)((uintptr_t)Val.Val >> 4) ^
865 (unsigned)((uintptr_t)Val.Val >> 9)) + Val.ResNo;
867 static bool isEqual(const SDOperand &LHS, const SDOperand &RHS) {
870 static bool isPod() { return true; }
873 /// simplify_type specializations - Allow casting operators to work directly on
874 /// SDOperands as if they were SDNode*'s.
875 template<> struct simplify_type<SDOperand> {
876 typedef SDNode* SimpleType;
877 static SimpleType getSimplifiedValue(const SDOperand &Val) {
878 return static_cast<SimpleType>(Val.Val);
881 template<> struct simplify_type<const SDOperand> {
882 typedef SDNode* SimpleType;
883 static SimpleType getSimplifiedValue(const SDOperand &Val) {
884 return static_cast<SimpleType>(Val.Val);
889 /// SDNode - Represents one node in the SelectionDAG.
891 class SDNode : public FoldingSetNode {
892 /// NodeType - The operation that this node performs.
894 unsigned short NodeType;
896 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
897 /// then they will be delete[]'d when the node is destroyed.
898 bool OperandsNeedDelete : 1;
900 /// NodeId - Unique id per SDNode in the DAG.
903 /// OperandList - The values that are used by this operation.
905 SDOperand *OperandList;
907 /// ValueList - The types of the values this node defines. SDNode's may
908 /// define multiple values simultaneously.
909 const MVT::ValueType *ValueList;
911 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
912 unsigned short NumOperands, NumValues;
914 /// Prev/Next pointers - These pointers form the linked list of of the
915 /// AllNodes list in the current DAG.
917 friend struct ilist_traits<SDNode>;
919 /// Uses - These are all of the SDNode's that use a value produced by this
921 SmallVector<SDNode*,3> Uses;
923 // Out-of-line virtual method to give class a home.
924 virtual void ANCHOR();
927 assert(NumOperands == 0 && "Operand list not cleared before deletion");
928 NodeType = ISD::DELETED_NODE;
931 //===--------------------------------------------------------------------===//
934 unsigned getOpcode() const { return NodeType; }
935 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
936 unsigned getTargetOpcode() const {
937 assert(isTargetOpcode() && "Not a target opcode!");
938 return NodeType - ISD::BUILTIN_OP_END;
941 size_t use_size() const { return Uses.size(); }
942 bool use_empty() const { return Uses.empty(); }
943 bool hasOneUse() const { return Uses.size() == 1; }
945 /// getNodeId - Return the unique node id.
947 int getNodeId() const { return NodeId; }
949 /// setNodeId - Set unique node id.
950 void setNodeId(int Id) { NodeId = Id; }
952 typedef SmallVector<SDNode*,3>::const_iterator use_iterator;
953 use_iterator use_begin() const { return Uses.begin(); }
954 use_iterator use_end() const { return Uses.end(); }
956 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
957 /// indicated value. This method ignores uses of other values defined by this
959 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
961 /// hasAnyUseOfValue - Return true if there are any use of the indicated
962 /// value. This method ignores uses of other values defined by this operation.
963 bool hasAnyUseOfValue(unsigned Value) const;
965 /// isOnlyUse - Return true if this node is the only use of N.
967 bool isOnlyUse(SDNode *N) const;
969 /// isOperand - Return true if this node is an operand of N.
971 bool isOperand(SDNode *N) const;
973 /// isPredecessor - Return true if this node is a predecessor of N. This node
974 /// is either an operand of N or it can be reached by recursively traversing
976 /// NOTE: this is an expensive method. Use it carefully.
977 bool isPredecessor(SDNode *N) const;
979 /// getNumOperands - Return the number of values used by this operation.
981 unsigned getNumOperands() const { return NumOperands; }
983 /// getConstantOperandVal - Helper method returns the integer value of a
984 /// ConstantSDNode operand.
985 uint64_t getConstantOperandVal(unsigned Num) const;
987 const SDOperand &getOperand(unsigned Num) const {
988 assert(Num < NumOperands && "Invalid child # of SDNode!");
989 return OperandList[Num];
992 typedef const SDOperand* op_iterator;
993 op_iterator op_begin() const { return OperandList; }
994 op_iterator op_end() const { return OperandList+NumOperands; }
997 SDVTList getVTList() const {
998 SDVTList X = { ValueList, NumValues };
1002 /// getNumValues - Return the number of values defined/returned by this
1005 unsigned getNumValues() const { return NumValues; }
1007 /// getValueType - Return the type of a specified result.
1009 MVT::ValueType getValueType(unsigned ResNo) const {
1010 assert(ResNo < NumValues && "Illegal result number!");
1011 return ValueList[ResNo];
1014 typedef const MVT::ValueType* value_iterator;
1015 value_iterator value_begin() const { return ValueList; }
1016 value_iterator value_end() const { return ValueList+NumValues; }
1018 /// getOperationName - Return the opcode of this operation for printing.
1020 std::string getOperationName(const SelectionDAG *G = 0) const;
1021 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
1023 void dump(const SelectionDAG *G) const;
1025 static bool classof(const SDNode *) { return true; }
1027 /// Profile - Gather unique data for the node.
1029 void Profile(FoldingSetNodeID &ID);
1032 friend class SelectionDAG;
1034 /// getValueTypeList - Return a pointer to the specified value type.
1036 static const MVT::ValueType *getValueTypeList(MVT::ValueType VT);
1037 static SDVTList getSDVTList(MVT::ValueType VT) {
1038 SDVTList Ret = { getValueTypeList(VT), 1 };
1042 SDNode(unsigned Opc, SDVTList VTs, const SDOperand *Ops, unsigned NumOps)
1043 : NodeType(Opc), NodeId(-1) {
1044 OperandsNeedDelete = true;
1045 NumOperands = NumOps;
1046 OperandList = NumOps ? new SDOperand[NumOperands] : 0;
1048 for (unsigned i = 0; i != NumOps; ++i) {
1049 OperandList[i] = Ops[i];
1050 Ops[i].Val->Uses.push_back(this);
1053 ValueList = VTs.VTs;
1054 NumValues = VTs.NumVTs;
1057 SDNode(unsigned Opc, SDVTList VTs) : NodeType(Opc), NodeId(-1) {
1058 OperandsNeedDelete = false; // Operands set with InitOperands.
1062 ValueList = VTs.VTs;
1063 NumValues = VTs.NumVTs;
1067 /// InitOperands - Initialize the operands list of this node with the
1068 /// specified values, which are part of the node (thus they don't need to be
1069 /// copied in or allocated).
1070 void InitOperands(SDOperand *Ops, unsigned NumOps) {
1071 assert(OperandList == 0 && "Operands already set!");
1072 NumOperands = NumOps;
1075 for (unsigned i = 0; i != NumOps; ++i)
1076 Ops[i].Val->Uses.push_back(this);
1079 /// MorphNodeTo - This frees the operands of the current node, resets the
1080 /// opcode, types, and operands to the specified value. This should only be
1081 /// used by the SelectionDAG class.
1082 void MorphNodeTo(unsigned Opc, SDVTList L,
1083 const SDOperand *Ops, unsigned NumOps);
1085 void addUser(SDNode *User) {
1086 Uses.push_back(User);
1088 void removeUser(SDNode *User) {
1089 // Remove this user from the operand's use list.
1090 for (unsigned i = Uses.size(); ; --i) {
1091 assert(i != 0 && "Didn't find user!");
1092 if (Uses[i-1] == User) {
1093 Uses[i-1] = Uses.back();
1102 // Define inline functions from the SDOperand class.
1104 inline unsigned SDOperand::getOpcode() const {
1105 return Val->getOpcode();
1107 inline MVT::ValueType SDOperand::getValueType() const {
1108 return Val->getValueType(ResNo);
1110 inline unsigned SDOperand::getNumOperands() const {
1111 return Val->getNumOperands();
1113 inline const SDOperand &SDOperand::getOperand(unsigned i) const {
1114 return Val->getOperand(i);
1116 inline uint64_t SDOperand::getConstantOperandVal(unsigned i) const {
1117 return Val->getConstantOperandVal(i);
1119 inline bool SDOperand::isTargetOpcode() const {
1120 return Val->isTargetOpcode();
1122 inline unsigned SDOperand::getTargetOpcode() const {
1123 return Val->getTargetOpcode();
1125 inline bool SDOperand::hasOneUse() const {
1126 return Val->hasNUsesOfValue(1, ResNo);
1128 inline bool SDOperand::use_empty() const {
1129 return !Val->hasAnyUseOfValue(ResNo);
1132 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
1133 /// to allow co-allocation of node operands with the node itself.
1134 class UnarySDNode : public SDNode {
1135 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1138 UnarySDNode(unsigned Opc, SDVTList VTs, SDOperand X)
1139 : SDNode(Opc, VTs), Op(X) {
1140 InitOperands(&Op, 1);
1144 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
1145 /// to allow co-allocation of node operands with the node itself.
1146 class BinarySDNode : public SDNode {
1147 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1150 BinarySDNode(unsigned Opc, SDVTList VTs, SDOperand X, SDOperand Y)
1151 : SDNode(Opc, VTs) {
1154 InitOperands(Ops, 2);
1158 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
1159 /// to allow co-allocation of node operands with the node itself.
1160 class TernarySDNode : public SDNode {
1161 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1164 TernarySDNode(unsigned Opc, SDVTList VTs, SDOperand X, SDOperand Y,
1166 : SDNode(Opc, VTs) {
1170 InitOperands(Ops, 3);
1175 /// HandleSDNode - This class is used to form a handle around another node that
1176 /// is persistant and is updated across invocations of replaceAllUsesWith on its
1177 /// operand. This node should be directly created by end-users and not added to
1178 /// the AllNodes list.
1179 class HandleSDNode : public SDNode {
1180 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1183 explicit HandleSDNode(SDOperand X)
1184 : SDNode(ISD::HANDLENODE, getSDVTList(MVT::Other)), Op(X) {
1185 InitOperands(&Op, 1);
1188 SDOperand getValue() const { return Op; }
1191 class AtomicSDNode : public SDNode {
1192 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1194 MVT::ValueType OrigVT;
1196 AtomicSDNode(unsigned Opc, SDVTList VTL, SDOperand Chain, SDOperand X,
1197 SDOperand Y, SDOperand Z, MVT::ValueType VT)
1198 : SDNode(Opc, VTL) {
1203 InitOperands(Ops, 4);
1206 AtomicSDNode(unsigned Opc, SDVTList VTL, SDOperand Chain, SDOperand X,
1207 SDOperand Y, MVT::ValueType VT)
1208 : SDNode(Opc, VTL) {
1212 InitOperands(Ops, 3);
1215 MVT::ValueType getVT() const { return OrigVT; }
1218 class StringSDNode : public SDNode {
1220 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1222 friend class SelectionDAG;
1223 explicit StringSDNode(const std::string &val)
1224 : SDNode(ISD::STRING, getSDVTList(MVT::Other)), Value(val) {
1227 const std::string &getValue() const { return Value; }
1228 static bool classof(const StringSDNode *) { return true; }
1229 static bool classof(const SDNode *N) {
1230 return N->getOpcode() == ISD::STRING;
1234 class ConstantSDNode : public SDNode {
1236 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1238 friend class SelectionDAG;
1239 ConstantSDNode(bool isTarget, const APInt &val, MVT::ValueType VT)
1240 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant, getSDVTList(VT)),
1245 const APInt &getAPIntValue() const { return Value; }
1246 uint64_t getValue() const { return Value.getZExtValue(); }
1248 int64_t getSignExtended() const {
1249 unsigned Bits = MVT::getSizeInBits(getValueType(0));
1250 return ((int64_t)Value.getZExtValue() << (64-Bits)) >> (64-Bits);
1253 bool isNullValue() const { return Value == 0; }
1254 bool isAllOnesValue() const {
1255 return Value == MVT::getIntVTBitMask(getValueType(0));
1258 static bool classof(const ConstantSDNode *) { return true; }
1259 static bool classof(const SDNode *N) {
1260 return N->getOpcode() == ISD::Constant ||
1261 N->getOpcode() == ISD::TargetConstant;
1265 class ConstantFPSDNode : public SDNode {
1267 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1269 friend class SelectionDAG;
1270 ConstantFPSDNode(bool isTarget, const APFloat& val, MVT::ValueType VT)
1271 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1272 getSDVTList(VT)), Value(val) {
1276 const APFloat& getValueAPF() const { return Value; }
1278 /// isExactlyValue - We don't rely on operator== working on double values, as
1279 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1280 /// As such, this method can be used to do an exact bit-for-bit comparison of
1281 /// two floating point values.
1283 /// We leave the version with the double argument here because it's just so
1284 /// convenient to write "2.0" and the like. Without this function we'd
1285 /// have to duplicate its logic everywhere it's called.
1286 bool isExactlyValue(double V) const {
1288 Tmp.convert(Value.getSemantics(), APFloat::rmNearestTiesToEven);
1289 return isExactlyValue(Tmp);
1291 bool isExactlyValue(const APFloat& V) const;
1293 bool isValueValidForType(MVT::ValueType VT, const APFloat& Val);
1295 static bool classof(const ConstantFPSDNode *) { return true; }
1296 static bool classof(const SDNode *N) {
1297 return N->getOpcode() == ISD::ConstantFP ||
1298 N->getOpcode() == ISD::TargetConstantFP;
1302 class GlobalAddressSDNode : public SDNode {
1303 GlobalValue *TheGlobal;
1305 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1307 friend class SelectionDAG;
1308 GlobalAddressSDNode(bool isTarget, const GlobalValue *GA, MVT::ValueType VT,
1312 GlobalValue *getGlobal() const { return TheGlobal; }
1313 int getOffset() const { return Offset; }
1315 static bool classof(const GlobalAddressSDNode *) { return true; }
1316 static bool classof(const SDNode *N) {
1317 return N->getOpcode() == ISD::GlobalAddress ||
1318 N->getOpcode() == ISD::TargetGlobalAddress ||
1319 N->getOpcode() == ISD::GlobalTLSAddress ||
1320 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1324 class FrameIndexSDNode : public SDNode {
1326 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1328 friend class SelectionDAG;
1329 FrameIndexSDNode(int fi, MVT::ValueType VT, bool isTarg)
1330 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex, getSDVTList(VT)),
1335 int getIndex() const { return FI; }
1337 static bool classof(const FrameIndexSDNode *) { return true; }
1338 static bool classof(const SDNode *N) {
1339 return N->getOpcode() == ISD::FrameIndex ||
1340 N->getOpcode() == ISD::TargetFrameIndex;
1344 class JumpTableSDNode : public SDNode {
1346 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1348 friend class SelectionDAG;
1349 JumpTableSDNode(int jti, MVT::ValueType VT, bool isTarg)
1350 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable, getSDVTList(VT)),
1355 int getIndex() const { return JTI; }
1357 static bool classof(const JumpTableSDNode *) { return true; }
1358 static bool classof(const SDNode *N) {
1359 return N->getOpcode() == ISD::JumpTable ||
1360 N->getOpcode() == ISD::TargetJumpTable;
1364 class ConstantPoolSDNode : public SDNode {
1367 MachineConstantPoolValue *MachineCPVal;
1369 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1371 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1373 friend class SelectionDAG;
1374 ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT,
1376 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1377 getSDVTList(VT)), Offset(o), Alignment(0) {
1378 assert((int)Offset >= 0 && "Offset is too large");
1381 ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT, int o,
1383 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1384 getSDVTList(VT)), Offset(o), Alignment(Align) {
1385 assert((int)Offset >= 0 && "Offset is too large");
1388 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1389 MVT::ValueType VT, int o=0)
1390 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1391 getSDVTList(VT)), Offset(o), Alignment(0) {
1392 assert((int)Offset >= 0 && "Offset is too large");
1393 Val.MachineCPVal = v;
1394 Offset |= 1 << (sizeof(unsigned)*8-1);
1396 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1397 MVT::ValueType VT, int o, unsigned Align)
1398 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1399 getSDVTList(VT)), Offset(o), Alignment(Align) {
1400 assert((int)Offset >= 0 && "Offset is too large");
1401 Val.MachineCPVal = v;
1402 Offset |= 1 << (sizeof(unsigned)*8-1);
1406 bool isMachineConstantPoolEntry() const {
1407 return (int)Offset < 0;
1410 Constant *getConstVal() const {
1411 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1412 return Val.ConstVal;
1415 MachineConstantPoolValue *getMachineCPVal() const {
1416 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1417 return Val.MachineCPVal;
1420 int getOffset() const {
1421 return Offset & ~(1 << (sizeof(unsigned)*8-1));
1424 // Return the alignment of this constant pool object, which is either 0 (for
1425 // default alignment) or log2 of the desired value.
1426 unsigned getAlignment() const { return Alignment; }
1428 const Type *getType() const;
1430 static bool classof(const ConstantPoolSDNode *) { return true; }
1431 static bool classof(const SDNode *N) {
1432 return N->getOpcode() == ISD::ConstantPool ||
1433 N->getOpcode() == ISD::TargetConstantPool;
1437 class BasicBlockSDNode : public SDNode {
1438 MachineBasicBlock *MBB;
1439 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1441 friend class SelectionDAG;
1442 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1443 : SDNode(ISD::BasicBlock, getSDVTList(MVT::Other)), MBB(mbb) {
1447 MachineBasicBlock *getBasicBlock() const { return MBB; }
1449 static bool classof(const BasicBlockSDNode *) { return true; }
1450 static bool classof(const SDNode *N) {
1451 return N->getOpcode() == ISD::BasicBlock;
1455 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1456 /// used when the SelectionDAG needs to make a simple reference to something
1457 /// in the LLVM IR representation.
1459 /// Note that this is not used for carrying alias information; that is done
1460 /// with MemOperandSDNode, which includes a Value which is required to be a
1461 /// pointer, and several other fields specific to memory references.
1463 class SrcValueSDNode : public SDNode {
1465 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1467 friend class SelectionDAG;
1468 /// Create a SrcValue for a general value.
1469 explicit SrcValueSDNode(const Value *v)
1470 : SDNode(ISD::SRCVALUE, getSDVTList(MVT::Other)), V(v) {}
1473 /// getValue - return the contained Value.
1474 const Value *getValue() const { return V; }
1476 static bool classof(const SrcValueSDNode *) { return true; }
1477 static bool classof(const SDNode *N) {
1478 return N->getOpcode() == ISD::SRCVALUE;
1483 /// MemOperandSDNode - An SDNode that holds a MemOperand. This is
1484 /// used to represent a reference to memory after ISD::LOAD
1485 /// and ISD::STORE have been lowered.
1487 class MemOperandSDNode : public SDNode {
1488 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1490 friend class SelectionDAG;
1491 /// Create a MemOperand node
1492 explicit MemOperandSDNode(const MemOperand &mo)
1493 : SDNode(ISD::MEMOPERAND, getSDVTList(MVT::Other)), MO(mo) {}
1496 /// MO - The contained MemOperand.
1497 const MemOperand MO;
1499 static bool classof(const MemOperandSDNode *) { return true; }
1500 static bool classof(const SDNode *N) {
1501 return N->getOpcode() == ISD::MEMOPERAND;
1506 class RegisterSDNode : public SDNode {
1508 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1510 friend class SelectionDAG;
1511 RegisterSDNode(unsigned reg, MVT::ValueType VT)
1512 : SDNode(ISD::Register, getSDVTList(VT)), Reg(reg) {
1516 unsigned getReg() const { return Reg; }
1518 static bool classof(const RegisterSDNode *) { return true; }
1519 static bool classof(const SDNode *N) {
1520 return N->getOpcode() == ISD::Register;
1524 class ExternalSymbolSDNode : public SDNode {
1526 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1528 friend class SelectionDAG;
1529 ExternalSymbolSDNode(bool isTarget, const char *Sym, MVT::ValueType VT)
1530 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1531 getSDVTList(VT)), Symbol(Sym) {
1535 const char *getSymbol() const { return Symbol; }
1537 static bool classof(const ExternalSymbolSDNode *) { return true; }
1538 static bool classof(const SDNode *N) {
1539 return N->getOpcode() == ISD::ExternalSymbol ||
1540 N->getOpcode() == ISD::TargetExternalSymbol;
1544 class CondCodeSDNode : public SDNode {
1545 ISD::CondCode Condition;
1546 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1548 friend class SelectionDAG;
1549 explicit CondCodeSDNode(ISD::CondCode Cond)
1550 : SDNode(ISD::CONDCODE, getSDVTList(MVT::Other)), Condition(Cond) {
1554 ISD::CondCode get() const { return Condition; }
1556 static bool classof(const CondCodeSDNode *) { return true; }
1557 static bool classof(const SDNode *N) {
1558 return N->getOpcode() == ISD::CONDCODE;
1562 /// VTSDNode - This class is used to represent MVT::ValueType's, which are used
1563 /// to parameterize some operations.
1564 class VTSDNode : public SDNode {
1565 MVT::ValueType ValueType;
1566 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1568 friend class SelectionDAG;
1569 explicit VTSDNode(MVT::ValueType VT)
1570 : SDNode(ISD::VALUETYPE, getSDVTList(MVT::Other)), ValueType(VT) {
1574 MVT::ValueType getVT() const { return ValueType; }
1576 static bool classof(const VTSDNode *) { return true; }
1577 static bool classof(const SDNode *N) {
1578 return N->getOpcode() == ISD::VALUETYPE;
1582 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
1584 class LSBaseSDNode : public SDNode {
1586 // AddrMode - unindexed, pre-indexed, post-indexed.
1587 ISD::MemIndexedMode AddrMode;
1589 // MemoryVT - VT of in-memory value.
1590 MVT::ValueType MemoryVT;
1592 //! SrcValue - Memory location for alias analysis.
1593 const Value *SrcValue;
1595 //! SVOffset - Memory location offset.
1598 //! Alignment - Alignment of memory location in bytes.
1601 //! IsVolatile - True if the store is volatile.
1604 //! Operand array for load and store
1606 \note Moving this array to the base class captures more
1607 common functionality shared between LoadSDNode and
1612 LSBaseSDNode(ISD::NodeType NodeTy, SDOperand *Operands, unsigned NumOperands,
1613 SDVTList VTs, ISD::MemIndexedMode AM, MVT::ValueType VT,
1614 const Value *SV, int SVO, unsigned Align, bool Vol)
1615 : SDNode(NodeTy, VTs),
1616 AddrMode(AM), MemoryVT(VT),
1617 SrcValue(SV), SVOffset(SVO), Alignment(Align), IsVolatile(Vol)
1619 for (unsigned i = 0; i != NumOperands; ++i)
1620 Ops[i] = Operands[i];
1621 InitOperands(Ops, NumOperands);
1622 assert(Align != 0 && "Loads and stores should have non-zero aligment");
1623 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1624 "Only indexed loads and stores have a non-undef offset operand");
1627 const SDOperand getChain() const {
1628 return getOperand(0);
1630 const SDOperand getBasePtr() const {
1631 return getOperand(getOpcode() == ISD::LOAD ? 1 : 2);
1633 const SDOperand getOffset() const {
1634 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1636 const SDOperand getValue() const {
1637 assert(getOpcode() == ISD::STORE);
1638 return getOperand(1);
1641 const Value *getSrcValue() const { return SrcValue; }
1642 int getSrcValueOffset() const { return SVOffset; }
1643 unsigned getAlignment() const { return Alignment; }
1644 MVT::ValueType getMemoryVT() const { return MemoryVT; }
1645 bool isVolatile() const { return IsVolatile; }
1647 ISD::MemIndexedMode getAddressingMode() const { return AddrMode; }
1649 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
1650 bool isIndexed() const { return AddrMode != ISD::UNINDEXED; }
1652 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
1653 bool isUnindexed() const { return AddrMode == ISD::UNINDEXED; }
1655 /// getMemOperand - Return a MemOperand object describing the memory
1656 /// reference performed by this load or store.
1657 MemOperand getMemOperand() const;
1659 static bool classof(const LSBaseSDNode *N) { return true; }
1660 static bool classof(const SDNode *N) {
1661 return N->getOpcode() == ISD::LOAD ||
1662 N->getOpcode() == ISD::STORE;
1666 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
1668 class LoadSDNode : public LSBaseSDNode {
1669 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1671 // ExtType - non-ext, anyext, sext, zext.
1672 ISD::LoadExtType ExtType;
1675 friend class SelectionDAG;
1676 LoadSDNode(SDOperand *ChainPtrOff, SDVTList VTs,
1677 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, MVT::ValueType LVT,
1678 const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
1679 : LSBaseSDNode(ISD::LOAD, ChainPtrOff, 3,
1680 VTs, AM, LVT, SV, O, Align, Vol),
1684 ISD::LoadExtType getExtensionType() const { return ExtType; }
1686 static bool classof(const LoadSDNode *) { return true; }
1687 static bool classof(const SDNode *N) {
1688 return N->getOpcode() == ISD::LOAD;
1692 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
1694 class StoreSDNode : public LSBaseSDNode {
1695 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1697 // IsTruncStore - True if the op does a truncation before store.
1700 friend class SelectionDAG;
1701 StoreSDNode(SDOperand *ChainValuePtrOff, SDVTList VTs,
1702 ISD::MemIndexedMode AM, bool isTrunc, MVT::ValueType SVT,
1703 const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
1704 : LSBaseSDNode(ISD::STORE, ChainValuePtrOff, 4,
1705 VTs, AM, SVT, SV, O, Align, Vol),
1706 IsTruncStore(isTrunc) { }
1709 bool isTruncatingStore() const { return IsTruncStore; }
1711 static bool classof(const StoreSDNode *) { return true; }
1712 static bool classof(const SDNode *N) {
1713 return N->getOpcode() == ISD::STORE;
1718 class SDNodeIterator : public forward_iterator<SDNode, ptrdiff_t> {
1722 SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1724 bool operator==(const SDNodeIterator& x) const {
1725 return Operand == x.Operand;
1727 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1729 const SDNodeIterator &operator=(const SDNodeIterator &I) {
1730 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1731 Operand = I.Operand;
1735 pointer operator*() const {
1736 return Node->getOperand(Operand).Val;
1738 pointer operator->() const { return operator*(); }
1740 SDNodeIterator& operator++() { // Preincrement
1744 SDNodeIterator operator++(int) { // Postincrement
1745 SDNodeIterator tmp = *this; ++*this; return tmp;
1748 static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
1749 static SDNodeIterator end (SDNode *N) {
1750 return SDNodeIterator(N, N->getNumOperands());
1753 unsigned getOperand() const { return Operand; }
1754 const SDNode *getNode() const { return Node; }
1757 template <> struct GraphTraits<SDNode*> {
1758 typedef SDNode NodeType;
1759 typedef SDNodeIterator ChildIteratorType;
1760 static inline NodeType *getEntryNode(SDNode *N) { return N; }
1761 static inline ChildIteratorType child_begin(NodeType *N) {
1762 return SDNodeIterator::begin(N);
1764 static inline ChildIteratorType child_end(NodeType *N) {
1765 return SDNodeIterator::end(N);
1770 struct ilist_traits<SDNode> {
1771 static SDNode *getPrev(const SDNode *N) { return N->Prev; }
1772 static SDNode *getNext(const SDNode *N) { return N->Next; }
1774 static void setPrev(SDNode *N, SDNode *Prev) { N->Prev = Prev; }
1775 static void setNext(SDNode *N, SDNode *Next) { N->Next = Next; }
1777 static SDNode *createSentinel() {
1778 return new SDNode(ISD::EntryToken, SDNode::getSDVTList(MVT::Other));
1780 static void destroySentinel(SDNode *N) { delete N; }
1781 //static SDNode *createNode(const SDNode &V) { return new SDNode(V); }
1784 void addNodeToList(SDNode *NTy) {}
1785 void removeNodeFromList(SDNode *NTy) {}
1786 void transferNodesFromList(iplist<SDNode, ilist_traits> &L2,
1787 const ilist_iterator<SDNode> &X,
1788 const ilist_iterator<SDNode> &Y) {}
1792 /// isNormalLoad - Returns true if the specified node is a non-extending
1793 /// and unindexed load.
1794 inline bool isNormalLoad(const SDNode *N) {
1795 if (N->getOpcode() != ISD::LOAD)
1797 const LoadSDNode *Ld = cast<LoadSDNode>(N);
1798 return Ld->getExtensionType() == ISD::NON_EXTLOAD &&
1799 Ld->getAddressingMode() == ISD::UNINDEXED;
1802 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
1804 inline bool isNON_EXTLoad(const SDNode *N) {
1805 return N->getOpcode() == ISD::LOAD &&
1806 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
1809 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
1811 inline bool isEXTLoad(const SDNode *N) {
1812 return N->getOpcode() == ISD::LOAD &&
1813 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
1816 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
1818 inline bool isSEXTLoad(const SDNode *N) {
1819 return N->getOpcode() == ISD::LOAD &&
1820 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
1823 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
1825 inline bool isZEXTLoad(const SDNode *N) {
1826 return N->getOpcode() == ISD::LOAD &&
1827 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
1830 /// isUNINDEXEDLoad - Returns true if the specified node is a unindexed load.
1832 inline bool isUNINDEXEDLoad(const SDNode *N) {
1833 return N->getOpcode() == ISD::LOAD &&
1834 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1837 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
1839 inline bool isNON_TRUNCStore(const SDNode *N) {
1840 return N->getOpcode() == ISD::STORE &&
1841 !cast<StoreSDNode>(N)->isTruncatingStore();
1844 /// isTRUNCStore - Returns true if the specified node is a truncating
1846 inline bool isTRUNCStore(const SDNode *N) {
1847 return N->getOpcode() == ISD::STORE &&
1848 cast<StoreSDNode>(N)->isTruncatingStore();
1853 } // end llvm namespace