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/CodeGen/ValueTypes.h"
28 #include "llvm/CodeGen/MemOperand.h"
29 #include "llvm/Support/DataTypes.h"
36 class MachineBasicBlock;
37 class MachineConstantPoolValue;
39 template <typename T> struct DenseMapInfo;
40 template <typename T> struct simplify_type;
41 template <typename T> struct ilist_traits;
42 template<typename NodeTy, typename Traits> class iplist;
43 template<typename NodeTy> class ilist_iterator;
45 /// SDVTList - This represents a list of ValueType's that has been intern'd by
46 /// a SelectionDAG. Instances of this simple value class are returned by
47 /// SelectionDAG::getVTList(...).
50 const MVT::ValueType *VTs;
51 unsigned short NumVTs;
54 /// ISD namespace - This namespace contains an enum which represents all of the
55 /// SelectionDAG node types and value types.
58 namespace ParamFlags {
61 ZExt = 1<<0, ///< Parameter should be zero extended
63 SExt = 1<<1, ///< Parameter should be sign extended
65 InReg = 1<<2, ///< Parameter should be passed in register
67 StructReturn = 1<<3, ///< Hidden struct-return pointer
69 ByVal = 1<<4, ///< Struct passed by value
71 Nest = 1<<5, ///< Parameter is nested function static chain
73 ByValAlign = 0xF << 6, //< The alignment of the struct
75 ByValSize = 0x1ffff << 10, //< The size of the struct
77 OrigAlignment = 0x1F<<27,
78 OrigAlignmentOffs = 27
82 //===--------------------------------------------------------------------===//
83 /// ISD::NodeType enum - This enum defines all of the operators valid in a
87 // DELETED_NODE - This is an illegal flag value that is used to catch
88 // errors. This opcode is not a legal opcode for any node.
91 // EntryToken - This is the marker used to indicate the start of the region.
94 // Token factor - This node takes multiple tokens as input and produces a
95 // single token result. This is used to represent the fact that the operand
96 // operators are independent of each other.
99 // AssertSext, AssertZext - These nodes record if a register contains a
100 // value that has already been zero or sign extended from a narrower type.
101 // These nodes take two operands. The first is the node that has already
102 // been extended, and the second is a value type node indicating the width
104 AssertSext, AssertZext,
106 // Various leaf nodes.
107 STRING, BasicBlock, VALUETYPE, CONDCODE, Register,
108 Constant, ConstantFP,
109 GlobalAddress, GlobalTLSAddress, FrameIndex,
110 JumpTable, ConstantPool, ExternalSymbol,
112 // The address of the GOT
115 // FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
116 // llvm.returnaddress on the DAG. These nodes take one operand, the index
117 // of the frame or return address to return. An index of zero corresponds
118 // to the current function's frame or return address, an index of one to the
119 // parent's frame or return address, and so on.
120 FRAMEADDR, RETURNADDR,
122 // FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
123 // first (possible) on-stack argument. This is needed for correct stack
124 // adjustment during unwind.
125 FRAME_TO_ARGS_OFFSET,
127 // RESULT, OUTCHAIN = EXCEPTIONADDR(INCHAIN) - This node represents the
128 // address of the exception block on entry to an landing pad block.
131 // RESULT, OUTCHAIN = EHSELECTION(INCHAIN, EXCEPTION) - This node represents
132 // the selection index of the exception thrown.
135 // OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
136 // 'eh_return' gcc dwarf builtin, which is used to return from
137 // exception. The general meaning is: adjust stack by OFFSET and pass
138 // execution to HANDLER. Many platform-related details also :)
141 // TargetConstant* - Like Constant*, but the DAG does not do any folding or
142 // simplification of the constant.
146 // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
147 // anything else with this node, and this is valid in the target-specific
148 // dag, turning into a GlobalAddress operand.
150 TargetGlobalTLSAddress,
154 TargetExternalSymbol,
156 /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
157 /// This node represents a target intrinsic function with no side effects.
158 /// The first operand is the ID number of the intrinsic from the
159 /// llvm::Intrinsic namespace. The operands to the intrinsic follow. The
160 /// node has returns the result of the intrinsic.
163 /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
164 /// This node represents a target intrinsic function with side effects that
165 /// returns a result. The first operand is a chain pointer. The second is
166 /// the ID number of the intrinsic from the llvm::Intrinsic namespace. The
167 /// operands to the intrinsic follow. The node has two results, the result
168 /// of the intrinsic and an output chain.
171 /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
172 /// This node represents a target intrinsic function with side effects that
173 /// does not return a result. The first operand is a chain pointer. The
174 /// second is the ID number of the intrinsic from the llvm::Intrinsic
175 /// namespace. The operands to the intrinsic follow.
178 // CopyToReg - This node has three operands: a chain, a register number to
179 // set to this value, and a value.
182 // CopyFromReg - This node indicates that the input value is a virtual or
183 // physical register that is defined outside of the scope of this
184 // SelectionDAG. The register is available from the RegisterSDNode object.
187 // UNDEF - An undefined node
190 /// FORMAL_ARGUMENTS(CHAIN, CC#, ISVARARG, FLAG0, ..., FLAGn) - This node
191 /// represents the formal arguments for a function. CC# is a Constant value
192 /// indicating the calling convention of the function, and ISVARARG is a
193 /// flag that indicates whether the function is varargs or not. This node
194 /// has one result value for each incoming argument, plus one for the output
195 /// chain. It must be custom legalized. See description of CALL node for
196 /// FLAG argument contents explanation.
200 /// RV1, RV2...RVn, CHAIN = CALL(CHAIN, CC#, ISVARARG, ISTAILCALL, CALLEE,
201 /// ARG0, FLAG0, ARG1, FLAG1, ... ARGn, FLAGn)
202 /// This node represents a fully general function call, before the legalizer
203 /// runs. This has one result value for each argument / flag pair, plus
204 /// a chain result. It must be custom legalized. Flag argument indicates
205 /// misc. argument attributes. Currently:
207 /// Bit 1 - 'inreg' attribute
208 /// Bit 2 - 'sret' attribute
209 /// Bit 4 - 'byval' attribute
210 /// Bit 5 - 'nest' attribute
211 /// Bit 6-9 - alignment of byval structures
212 /// Bit 10-26 - size of byval structures
213 /// Bits 31:27 - argument ABI alignment in the first argument piece and
214 /// alignment '1' in other argument pieces.
217 // EXTRACT_ELEMENT - This is used to get the first or second (determined by
218 // a Constant, which is required to be operand #1), element of the aggregate
219 // value specified as operand #0. This is only for use before legalization,
220 // for values that will be broken into multiple registers.
223 // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways. Given
224 // two values of the same integer value type, this produces a value twice as
225 // big. Like EXTRACT_ELEMENT, this can only be used before legalization.
228 // MERGE_VALUES - This node takes multiple discrete operands and returns
229 // them all as its individual results. This nodes has exactly the same
230 // number of inputs and outputs, and is only valid before legalization.
231 // This node is useful for some pieces of the code generator that want to
232 // think about a single node with multiple results, not multiple nodes.
235 // Simple integer binary arithmetic operators.
236 ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
238 // SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing
239 // a signed/unsigned value of type i[2*N], and return the full value as
240 // two results, each of type iN.
241 SMUL_LOHI, UMUL_LOHI,
243 // SDIVREM/UDIVREM - Divide two integers and produce both a quotient and
247 // CARRY_FALSE - This node is used when folding other nodes,
248 // like ADDC/SUBC, which indicate the carry result is always false.
251 // Carry-setting nodes for multiple precision addition and subtraction.
252 // These nodes take two operands of the same value type, and produce two
253 // results. The first result is the normal add or sub result, the second
254 // result is the carry flag result.
257 // Carry-using nodes for multiple precision addition and subtraction. These
258 // nodes take three operands: The first two are the normal lhs and rhs to
259 // the add or sub, and the third is the input carry flag. These nodes
260 // produce two results; the normal result of the add or sub, and the output
261 // carry flag. These nodes both read and write a carry flag to allow them
262 // to them to be chained together for add and sub of arbitrarily large
266 // Simple binary floating point operators.
267 FADD, FSUB, FMUL, FDIV, FREM,
269 // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y. NOTE: This
270 // DAG node does not require that X and Y have the same type, just that they
271 // are both floating point. X and the result must have the same type.
272 // FCOPYSIGN(f32, f64) is allowed.
275 // INT = FGETSIGN(FP) - Return the sign bit of the specified floating point
276 // value as an integer 0/1 value.
279 /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector
280 /// with the specified, possibly variable, elements. The number of elements
281 /// is required to be a power of two.
284 /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR with the element
285 /// at IDX replaced with VAL.
288 /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
289 /// identified by the (potentially variable) element number IDX.
292 /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
293 /// vector type with the same length and element type, this produces a
294 /// concatenated vector result value, with length equal to the sum of the
295 /// lengths of the input vectors.
298 /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
299 /// vector value) starting with the (potentially variable) element number
300 /// IDX, which must be a multiple of the result vector length.
303 /// VECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC) - Returns a vector, of the same
304 /// type as VEC1/VEC2. SHUFFLEVEC is a BUILD_VECTOR of constant int values
305 /// (regardless of whether its datatype is legal or not) that indicate
306 /// which value each result element will get. The elements of VEC1/VEC2 are
307 /// enumerated in order. This is quite similar to the Altivec 'vperm'
308 /// instruction, except that the indices must be constants and are in terms
309 /// of the element size of VEC1/VEC2, not in terms of bytes.
312 /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
313 /// scalar value into element 0 of the resultant vector type. The top
314 /// elements 1 to N-1 of the N-element vector are undefined.
317 // EXTRACT_SUBREG - This node is used to extract a sub-register value.
318 // This node takes a superreg and a constant sub-register index as operands.
321 // INSERT_SUBREG - This node is used to insert a sub-register value.
322 // This node takes a superreg, a subreg value, and a constant sub-register
323 // index as operands.
326 // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
327 // an unsigned/signed value of type i[2*N], then return the top part.
330 // Bitwise operators - logical and, logical or, logical xor, shift left,
331 // shift right algebraic (shift in sign bits), shift right logical (shift in
332 // zeroes), rotate left, rotate right, and byteswap.
333 AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
335 // Counting operators
338 // Select(COND, TRUEVAL, FALSEVAL)
341 // Select with condition operator - This selects between a true value and
342 // a false value (ops #2 and #3) based on the boolean result of comparing
343 // the lhs and rhs (ops #0 and #1) of a conditional expression with the
344 // condition code in op #4, a CondCodeSDNode.
347 // SetCC operator - This evaluates to a boolean (i1) true value if the
348 // condition is true. The operands to this are the left and right operands
349 // to compare (ops #0, and #1) and the condition code to compare them with
350 // (op #2) as a CondCodeSDNode.
353 // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
354 // integer shift operations, just like ADD/SUB_PARTS. The operation
356 // [Lo,Hi] = op [LoLHS,HiLHS], Amt
357 SHL_PARTS, SRA_PARTS, SRL_PARTS,
359 // Conversion operators. These are all single input single output
360 // operations. For all of these, the result type must be strictly
361 // wider or narrower (depending on the operation) than the source
364 // SIGN_EXTEND - Used for integer types, replicating the sign bit
368 // ZERO_EXTEND - Used for integer types, zeroing the new bits.
371 // ANY_EXTEND - Used for integer types. The high bits are undefined.
374 // TRUNCATE - Completely drop the high bits.
377 // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
378 // depends on the first letter) to floating point.
382 // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
383 // sign extend a small value in a large integer register (e.g. sign
384 // extending the low 8 bits of a 32-bit register to fill the top 24 bits
385 // with the 7th bit). The size of the smaller type is indicated by the 1th
386 // operand, a ValueType node.
389 /// FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
394 /// X = FP_ROUND(Y, TRUNC) - Rounding 'Y' from a larger floating point type
395 /// down to the precision of the destination VT. TRUNC is a flag, which is
396 /// always an integer that is zero or one. If TRUNC is 0, this is a
397 /// normal rounding, if it is 1, this FP_ROUND is known to not change the
400 /// The TRUNC = 1 case is used in cases where we know that the value will
401 /// not be modified by the node, because Y is not using any of the extra
402 /// precision of source type. This allows certain transformations like
403 /// FP_EXTEND(FP_ROUND(X,1)) -> X which are not safe for
404 /// FP_EXTEND(FP_ROUND(X,0)) because the extra bits aren't removed.
407 // FLT_ROUNDS_ - Returns current rounding mode:
410 // 1 Round to nearest
415 /// X = FP_ROUND_INREG(Y, VT) - This operator takes an FP register, and
416 /// rounds it to a floating point value. It then promotes it and returns it
417 /// in a register of the same size. This operation effectively just
418 /// discards excess precision. The type to round down to is specified by
419 /// the VT operand, a VTSDNode.
422 /// X = FP_EXTEND(Y) - Extend a smaller FP type into a larger FP type.
425 // BIT_CONVERT - Theis operator converts between integer and FP values, as
426 // if one was stored to memory as integer and the other was loaded from the
427 // same address (or equivalently for vector format conversions, etc). The
428 // source and result are required to have the same bit size (e.g.
429 // f32 <-> i32). This can also be used for int-to-int or fp-to-fp
430 // conversions, but that is a noop, deleted by getNode().
433 // FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW - Perform unary floating point
434 // negation, absolute value, square root, sine and cosine, powi, and pow
436 FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
438 // LOAD and STORE have token chains as their first operand, then the same
439 // operands as an LLVM load/store instruction, then an offset node that
440 // is added / subtracted from the base pointer to form the address (for
441 // indexed memory ops).
444 // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
445 // to a specified boundary. This node always has two return values: a new
446 // stack pointer value and a chain. The first operand is the token chain,
447 // the second is the number of bytes to allocate, and the third is the
448 // alignment boundary. The size is guaranteed to be a multiple of the stack
449 // alignment, and the alignment is guaranteed to be bigger than the stack
450 // alignment (if required) or 0 to get standard stack alignment.
453 // Control flow instructions. These all have token chains.
455 // BR - Unconditional branch. The first operand is the chain
456 // operand, the second is the MBB to branch to.
459 // BRIND - Indirect branch. The first operand is the chain, the second
460 // is the value to branch to, which must be of the same type as the target's
464 // BR_JT - Jumptable branch. The first operand is the chain, the second
465 // is the jumptable index, the last one is the jumptable entry index.
468 // BRCOND - Conditional branch. The first operand is the chain,
469 // the second is the condition, the third is the block to branch
470 // to if the condition is true.
473 // BR_CC - Conditional branch. The behavior is like that of SELECT_CC, in
474 // that the condition is represented as condition code, and two nodes to
475 // compare, rather than as a combined SetCC node. The operands in order are
476 // chain, cc, lhs, rhs, block to branch to if condition is true.
479 // RET - Return from function. The first operand is the chain,
480 // and any subsequent operands are pairs of return value and return value
481 // signness for the function. This operation can have variable number of
485 // INLINEASM - Represents an inline asm block. This node always has two
486 // return values: a chain and a flag result. The inputs are as follows:
487 // Operand #0 : Input chain.
488 // Operand #1 : a ExternalSymbolSDNode with a pointer to the asm string.
489 // Operand #2n+2: A RegisterNode.
490 // Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
491 // Operand #last: Optional, an incoming flag.
494 // LABEL - Represents a label in mid basic block used to track
495 // locations needed for debug and exception handling tables. This node
497 // Operand #0 : input chain.
498 // Operand #1 : module unique number use to identify the label.
499 // Operand #2 : 0 indicates a debug label (e.g. stoppoint), 1 indicates
500 // a EH label, 2 indicates unknown label type.
503 // STACKSAVE - STACKSAVE has one operand, an input chain. It produces a
504 // value, the same type as the pointer type for the system, and an output
508 // STACKRESTORE has two operands, an input chain and a pointer to restore to
509 // it returns an output chain.
512 // MEMSET/MEMCPY/MEMMOVE - The first operand is the chain. The following
513 // correspond to the operands of the LLVM intrinsic functions and the last
514 // one is AlwaysInline. The only result is a token chain. The alignment
515 // argument is guaranteed to be a Constant node.
520 // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
521 // a call sequence, and carry arbitrary information that target might want
522 // to know. The first operand is a chain, the rest are specified by the
523 // target and not touched by the DAG optimizers.
524 CALLSEQ_START, // Beginning of a call sequence
525 CALLSEQ_END, // End of a call sequence
527 // VAARG - VAARG has three operands: an input chain, a pointer, and a
528 // SRCVALUE. It returns a pair of values: the vaarg value and a new chain.
531 // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
532 // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
536 // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
537 // pointer, and a SRCVALUE.
540 // SRCVALUE - This is a node type that holds a Value* that is used to
541 // make reference to a value in the LLVM IR.
544 // MEMOPERAND - This is a node that contains a MemOperand which records
545 // information about a memory reference. This is used to make AliasAnalysis
546 // queries from the backend.
549 // PCMARKER - This corresponds to the pcmarker intrinsic.
552 // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
553 // The only operand is a chain and a value and a chain are produced. The
554 // value is the contents of the architecture specific cycle counter like
555 // register (or other high accuracy low latency clock source)
558 // HANDLENODE node - Used as a handle for various purposes.
561 // LOCATION - This node is used to represent a source location for debug
562 // info. It takes token chain as input, then a line number, then a column
563 // number, then a filename, then a working dir. It produces a token chain
567 // DEBUG_LOC - This node is used to represent source line information
568 // embedded in the code. It takes a token chain as input, then a line
569 // number, then a column then a file id (provided by MachineModuleInfo.) It
570 // produces a token chain as output.
573 // TRAMPOLINE - This corresponds to the init_trampoline intrinsic.
574 // It takes as input a token chain, the pointer to the trampoline,
575 // the pointer to the nested function, the pointer to pass for the
576 // 'nest' parameter, a SRCVALUE for the trampoline and another for
577 // the nested function (allowing targets to access the original
578 // Function*). It produces the result of the intrinsic and a token
582 // TRAP - Trapping instruction
585 // BUILTIN_OP_END - This must be the last enum value in this list.
591 /// isBuildVectorAllOnes - Return true if the specified node is a
592 /// BUILD_VECTOR where all of the elements are ~0 or undef.
593 bool isBuildVectorAllOnes(const SDNode *N);
595 /// isBuildVectorAllZeros - Return true if the specified node is a
596 /// BUILD_VECTOR where all of the elements are 0 or undef.
597 bool isBuildVectorAllZeros(const SDNode *N);
599 /// isDebugLabel - Return true if the specified node represents a debug
600 /// label (i.e. ISD::LABEL or TargetInstrInfo::LANEL node and third operand
602 bool isDebugLabel(const SDNode *N);
604 //===--------------------------------------------------------------------===//
605 /// MemIndexedMode enum - This enum defines the load / store indexed
606 /// addressing modes.
608 /// UNINDEXED "Normal" load / store. The effective address is already
609 /// computed and is available in the base pointer. The offset
610 /// operand is always undefined. In addition to producing a
611 /// chain, an unindexed load produces one value (result of the
612 /// load); an unindexed store does not produces a value.
614 /// PRE_INC Similar to the unindexed mode where the effective address is
615 /// PRE_DEC the value of the base pointer add / subtract the offset.
616 /// It considers the computation as being folded into the load /
617 /// store operation (i.e. the load / store does the address
618 /// computation as well as performing the memory transaction).
619 /// The base operand is always undefined. In addition to
620 /// producing a chain, pre-indexed load produces two values
621 /// (result of the load and the result of the address
622 /// computation); a pre-indexed store produces one value (result
623 /// of the address computation).
625 /// POST_INC The effective address is the value of the base pointer. The
626 /// POST_DEC value of the offset operand is then added to / subtracted
627 /// from the base after memory transaction. In addition to
628 /// producing a chain, post-indexed load produces two values
629 /// (the result of the load and the result of the base +/- offset
630 /// computation); a post-indexed store produces one value (the
631 /// the result of the base +/- offset computation).
633 enum MemIndexedMode {
642 //===--------------------------------------------------------------------===//
643 /// LoadExtType enum - This enum defines the three variants of LOADEXT
644 /// (load with extension).
646 /// SEXTLOAD loads the integer operand and sign extends it to a larger
647 /// integer result type.
648 /// ZEXTLOAD loads the integer operand and zero extends it to a larger
649 /// integer result type.
650 /// EXTLOAD is used for three things: floating point extending loads,
651 /// integer extending loads [the top bits are undefined], and vector
652 /// extending loads [load into low elt].
662 //===--------------------------------------------------------------------===//
663 /// ISD::CondCode enum - These are ordered carefully to make the bitfields
664 /// below work out, when considering SETFALSE (something that never exists
665 /// dynamically) as 0. "U" -> Unsigned (for integer operands) or Unordered
666 /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
667 /// to. If the "N" column is 1, the result of the comparison is undefined if
668 /// the input is a NAN.
670 /// All of these (except for the 'always folded ops') should be handled for
671 /// floating point. For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
672 /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
674 /// Note that these are laid out in a specific order to allow bit-twiddling
675 /// to transform conditions.
677 // Opcode N U L G E Intuitive operation
678 SETFALSE, // 0 0 0 0 Always false (always folded)
679 SETOEQ, // 0 0 0 1 True if ordered and equal
680 SETOGT, // 0 0 1 0 True if ordered and greater than
681 SETOGE, // 0 0 1 1 True if ordered and greater than or equal
682 SETOLT, // 0 1 0 0 True if ordered and less than
683 SETOLE, // 0 1 0 1 True if ordered and less than or equal
684 SETONE, // 0 1 1 0 True if ordered and operands are unequal
685 SETO, // 0 1 1 1 True if ordered (no nans)
686 SETUO, // 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
687 SETUEQ, // 1 0 0 1 True if unordered or equal
688 SETUGT, // 1 0 1 0 True if unordered or greater than
689 SETUGE, // 1 0 1 1 True if unordered, greater than, or equal
690 SETULT, // 1 1 0 0 True if unordered or less than
691 SETULE, // 1 1 0 1 True if unordered, less than, or equal
692 SETUNE, // 1 1 1 0 True if unordered or not equal
693 SETTRUE, // 1 1 1 1 Always true (always folded)
694 // Don't care operations: undefined if the input is a nan.
695 SETFALSE2, // 1 X 0 0 0 Always false (always folded)
696 SETEQ, // 1 X 0 0 1 True if equal
697 SETGT, // 1 X 0 1 0 True if greater than
698 SETGE, // 1 X 0 1 1 True if greater than or equal
699 SETLT, // 1 X 1 0 0 True if less than
700 SETLE, // 1 X 1 0 1 True if less than or equal
701 SETNE, // 1 X 1 1 0 True if not equal
702 SETTRUE2, // 1 X 1 1 1 Always true (always folded)
704 SETCC_INVALID // Marker value.
707 /// isSignedIntSetCC - Return true if this is a setcc instruction that
708 /// performs a signed comparison when used with integer operands.
709 inline bool isSignedIntSetCC(CondCode Code) {
710 return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
713 /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
714 /// performs an unsigned comparison when used with integer operands.
715 inline bool isUnsignedIntSetCC(CondCode Code) {
716 return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
719 /// isTrueWhenEqual - Return true if the specified condition returns true if
720 /// the two operands to the condition are equal. Note that if one of the two
721 /// operands is a NaN, this value is meaningless.
722 inline bool isTrueWhenEqual(CondCode Cond) {
723 return ((int)Cond & 1) != 0;
726 /// getUnorderedFlavor - This function returns 0 if the condition is always
727 /// false if an operand is a NaN, 1 if the condition is always true if the
728 /// operand is a NaN, and 2 if the condition is undefined if the operand is a
730 inline unsigned getUnorderedFlavor(CondCode Cond) {
731 return ((int)Cond >> 3) & 3;
734 /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
735 /// 'op' is a valid SetCC operation.
736 CondCode getSetCCInverse(CondCode Operation, bool isInteger);
738 /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
739 /// when given the operation for (X op Y).
740 CondCode getSetCCSwappedOperands(CondCode Operation);
742 /// getSetCCOrOperation - Return the result of a logical OR between different
743 /// comparisons of identical values: ((X op1 Y) | (X op2 Y)). This
744 /// function returns SETCC_INVALID if it is not possible to represent the
745 /// resultant comparison.
746 CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
748 /// getSetCCAndOperation - Return the result of a logical AND between
749 /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)). This
750 /// function returns SETCC_INVALID if it is not possible to represent the
751 /// resultant comparison.
752 CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
753 } // end llvm::ISD namespace
756 //===----------------------------------------------------------------------===//
757 /// SDOperand - Unlike LLVM values, Selection DAG nodes may return multiple
758 /// values as the result of a computation. Many nodes return multiple values,
759 /// from loads (which define a token and a return value) to ADDC (which returns
760 /// a result and a carry value), to calls (which may return an arbitrary number
763 /// As such, each use of a SelectionDAG computation must indicate the node that
764 /// computes it as well as which return value to use from that node. This pair
765 /// of information is represented with the SDOperand value type.
769 SDNode *Val; // The node defining the value we are using.
770 unsigned ResNo; // Which return value of the node we are using.
772 SDOperand() : Val(0), ResNo(0) {}
773 SDOperand(SDNode *val, unsigned resno) : Val(val), ResNo(resno) {}
775 bool operator==(const SDOperand &O) const {
776 return Val == O.Val && ResNo == O.ResNo;
778 bool operator!=(const SDOperand &O) const {
779 return !operator==(O);
781 bool operator<(const SDOperand &O) const {
782 return Val < O.Val || (Val == O.Val && ResNo < O.ResNo);
785 SDOperand getValue(unsigned R) const {
786 return SDOperand(Val, R);
789 // isOperand - Return true if this node is an operand of N.
790 bool isOperand(SDNode *N) const;
792 /// getValueType - Return the ValueType of the referenced return value.
794 inline MVT::ValueType getValueType() const;
796 // Forwarding methods - These forward to the corresponding methods in SDNode.
797 inline unsigned getOpcode() const;
798 inline unsigned getNumOperands() const;
799 inline const SDOperand &getOperand(unsigned i) const;
800 inline uint64_t getConstantOperandVal(unsigned i) const;
801 inline bool isTargetOpcode() const;
802 inline unsigned getTargetOpcode() const;
805 /// reachesChainWithoutSideEffects - Return true if this operand (which must
806 /// be a chain) reaches the specified operand without crossing any
807 /// side-effecting instructions. In practice, this looks through token
808 /// factors and non-volatile loads. In order to remain efficient, this only
809 /// looks a couple of nodes in, it does not do an exhaustive search.
810 bool reachesChainWithoutSideEffects(SDOperand Dest, unsigned Depth = 2) const;
812 /// hasOneUse - Return true if there is exactly one operation using this
813 /// result value of the defining operator.
814 inline bool hasOneUse() const;
816 /// use_empty - Return true if there are no operations using this
817 /// result value of the defining operator.
818 inline bool use_empty() const;
822 template<> struct DenseMapInfo<SDOperand> {
823 static inline SDOperand getEmptyKey() { return SDOperand((SDNode*)-1, -1U); }
824 static inline SDOperand getTombstoneKey() { return SDOperand((SDNode*)-1, 0);}
825 static unsigned getHashValue(const SDOperand &Val) {
826 return (unsigned)((uintptr_t)Val.Val >> 4) ^
827 (unsigned)((uintptr_t)Val.Val >> 9) + Val.ResNo;
829 static bool isEqual(const SDOperand &LHS, const SDOperand &RHS) {
832 static bool isPod() { return true; }
835 /// simplify_type specializations - Allow casting operators to work directly on
836 /// SDOperands as if they were SDNode*'s.
837 template<> struct simplify_type<SDOperand> {
838 typedef SDNode* SimpleType;
839 static SimpleType getSimplifiedValue(const SDOperand &Val) {
840 return static_cast<SimpleType>(Val.Val);
843 template<> struct simplify_type<const SDOperand> {
844 typedef SDNode* SimpleType;
845 static SimpleType getSimplifiedValue(const SDOperand &Val) {
846 return static_cast<SimpleType>(Val.Val);
851 /// SDNode - Represents one node in the SelectionDAG.
853 class SDNode : public FoldingSetNode {
854 /// NodeType - The operation that this node performs.
856 unsigned short NodeType;
858 /// OperandsNeedDelete - This is true if OperandList was new[]'d. If true,
859 /// then they will be delete[]'d when the node is destroyed.
860 bool OperandsNeedDelete : 1;
862 /// NodeId - Unique id per SDNode in the DAG.
865 /// OperandList - The values that are used by this operation.
867 SDOperand *OperandList;
869 /// ValueList - The types of the values this node defines. SDNode's may
870 /// define multiple values simultaneously.
871 const MVT::ValueType *ValueList;
873 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
874 unsigned short NumOperands, NumValues;
876 /// Prev/Next pointers - These pointers form the linked list of of the
877 /// AllNodes list in the current DAG.
879 friend struct ilist_traits<SDNode>;
881 /// Uses - These are all of the SDNode's that use a value produced by this
883 SmallVector<SDNode*,3> Uses;
885 // Out-of-line virtual method to give class a home.
886 virtual void ANCHOR();
889 assert(NumOperands == 0 && "Operand list not cleared before deletion");
890 NodeType = ISD::DELETED_NODE;
893 //===--------------------------------------------------------------------===//
896 unsigned getOpcode() const { return NodeType; }
897 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
898 unsigned getTargetOpcode() const {
899 assert(isTargetOpcode() && "Not a target opcode!");
900 return NodeType - ISD::BUILTIN_OP_END;
903 size_t use_size() const { return Uses.size(); }
904 bool use_empty() const { return Uses.empty(); }
905 bool hasOneUse() const { return Uses.size() == 1; }
907 /// getNodeId - Return the unique node id.
909 int getNodeId() const { return NodeId; }
911 /// setNodeId - Set unique node id.
912 void setNodeId(int Id) { NodeId = Id; }
914 typedef SmallVector<SDNode*,3>::const_iterator use_iterator;
915 use_iterator use_begin() const { return Uses.begin(); }
916 use_iterator use_end() const { return Uses.end(); }
918 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
919 /// indicated value. This method ignores uses of other values defined by this
921 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
923 /// hasAnyUseOfValue - Return true if there are any use of the indicated
924 /// value. This method ignores uses of other values defined by this operation.
925 bool hasAnyUseOfValue(unsigned Value) const;
927 /// isOnlyUse - Return true if this node is the only use of N.
929 bool isOnlyUse(SDNode *N) const;
931 /// isOperand - Return true if this node is an operand of N.
933 bool isOperand(SDNode *N) const;
935 /// isPredecessor - Return true if this node is a predecessor of N. This node
936 /// is either an operand of N or it can be reached by recursively traversing
938 /// NOTE: this is an expensive method. Use it carefully.
939 bool isPredecessor(SDNode *N) const;
941 /// getNumOperands - Return the number of values used by this operation.
943 unsigned getNumOperands() const { return NumOperands; }
945 /// getConstantOperandVal - Helper method returns the integer value of a
946 /// ConstantSDNode operand.
947 uint64_t getConstantOperandVal(unsigned Num) const;
949 const SDOperand &getOperand(unsigned Num) const {
950 assert(Num < NumOperands && "Invalid child # of SDNode!");
951 return OperandList[Num];
954 typedef const SDOperand* op_iterator;
955 op_iterator op_begin() const { return OperandList; }
956 op_iterator op_end() const { return OperandList+NumOperands; }
959 SDVTList getVTList() const {
960 SDVTList X = { ValueList, NumValues };
964 /// getNumValues - Return the number of values defined/returned by this
967 unsigned getNumValues() const { return NumValues; }
969 /// getValueType - Return the type of a specified result.
971 MVT::ValueType getValueType(unsigned ResNo) const {
972 assert(ResNo < NumValues && "Illegal result number!");
973 return ValueList[ResNo];
976 typedef const MVT::ValueType* value_iterator;
977 value_iterator value_begin() const { return ValueList; }
978 value_iterator value_end() const { return ValueList+NumValues; }
980 /// getOperationName - Return the opcode of this operation for printing.
982 std::string getOperationName(const SelectionDAG *G = 0) const;
983 static const char* getIndexedModeName(ISD::MemIndexedMode AM);
985 void dump(const SelectionDAG *G) const;
987 static bool classof(const SDNode *) { return true; }
989 /// Profile - Gather unique data for the node.
991 void Profile(FoldingSetNodeID &ID);
994 friend class SelectionDAG;
996 /// getValueTypeList - Return a pointer to the specified value type.
998 static MVT::ValueType *getValueTypeList(MVT::ValueType VT);
999 static SDVTList getSDVTList(MVT::ValueType VT) {
1000 SDVTList Ret = { getValueTypeList(VT), 1 };
1004 SDNode(unsigned Opc, SDVTList VTs, const SDOperand *Ops, unsigned NumOps)
1005 : NodeType(Opc), NodeId(-1) {
1006 OperandsNeedDelete = true;
1007 NumOperands = NumOps;
1008 OperandList = NumOps ? new SDOperand[NumOperands] : 0;
1010 for (unsigned i = 0; i != NumOps; ++i) {
1011 OperandList[i] = Ops[i];
1012 Ops[i].Val->Uses.push_back(this);
1015 ValueList = VTs.VTs;
1016 NumValues = VTs.NumVTs;
1019 SDNode(unsigned Opc, SDVTList VTs) : NodeType(Opc), NodeId(-1) {
1020 OperandsNeedDelete = false; // Operands set with InitOperands.
1024 ValueList = VTs.VTs;
1025 NumValues = VTs.NumVTs;
1029 /// InitOperands - Initialize the operands list of this node with the
1030 /// specified values, which are part of the node (thus they don't need to be
1031 /// copied in or allocated).
1032 void InitOperands(SDOperand *Ops, unsigned NumOps) {
1033 assert(OperandList == 0 && "Operands already set!");
1034 NumOperands = NumOps;
1037 for (unsigned i = 0; i != NumOps; ++i)
1038 Ops[i].Val->Uses.push_back(this);
1041 /// MorphNodeTo - This frees the operands of the current node, resets the
1042 /// opcode, types, and operands to the specified value. This should only be
1043 /// used by the SelectionDAG class.
1044 void MorphNodeTo(unsigned Opc, SDVTList L,
1045 const SDOperand *Ops, unsigned NumOps);
1047 void addUser(SDNode *User) {
1048 Uses.push_back(User);
1050 void removeUser(SDNode *User) {
1051 // Remove this user from the operand's use list.
1052 for (unsigned i = Uses.size(); ; --i) {
1053 assert(i != 0 && "Didn't find user!");
1054 if (Uses[i-1] == User) {
1055 Uses[i-1] = Uses.back();
1064 // Define inline functions from the SDOperand class.
1066 inline unsigned SDOperand::getOpcode() const {
1067 return Val->getOpcode();
1069 inline MVT::ValueType SDOperand::getValueType() const {
1070 return Val->getValueType(ResNo);
1072 inline unsigned SDOperand::getNumOperands() const {
1073 return Val->getNumOperands();
1075 inline const SDOperand &SDOperand::getOperand(unsigned i) const {
1076 return Val->getOperand(i);
1078 inline uint64_t SDOperand::getConstantOperandVal(unsigned i) const {
1079 return Val->getConstantOperandVal(i);
1081 inline bool SDOperand::isTargetOpcode() const {
1082 return Val->isTargetOpcode();
1084 inline unsigned SDOperand::getTargetOpcode() const {
1085 return Val->getTargetOpcode();
1087 inline bool SDOperand::hasOneUse() const {
1088 return Val->hasNUsesOfValue(1, ResNo);
1090 inline bool SDOperand::use_empty() const {
1091 return !Val->hasAnyUseOfValue(ResNo);
1094 /// UnarySDNode - This class is used for single-operand SDNodes. This is solely
1095 /// to allow co-allocation of node operands with the node itself.
1096 class UnarySDNode : public SDNode {
1097 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1100 UnarySDNode(unsigned Opc, SDVTList VTs, SDOperand X)
1101 : SDNode(Opc, VTs), Op(X) {
1102 InitOperands(&Op, 1);
1106 /// BinarySDNode - This class is used for two-operand SDNodes. This is solely
1107 /// to allow co-allocation of node operands with the node itself.
1108 class BinarySDNode : public SDNode {
1109 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1112 BinarySDNode(unsigned Opc, SDVTList VTs, SDOperand X, SDOperand Y)
1113 : SDNode(Opc, VTs) {
1116 InitOperands(Ops, 2);
1120 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
1121 /// to allow co-allocation of node operands with the node itself.
1122 class TernarySDNode : public SDNode {
1123 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1126 TernarySDNode(unsigned Opc, SDVTList VTs, SDOperand X, SDOperand Y,
1128 : SDNode(Opc, VTs) {
1132 InitOperands(Ops, 3);
1137 /// HandleSDNode - This class is used to form a handle around another node that
1138 /// is persistant and is updated across invocations of replaceAllUsesWith on its
1139 /// operand. This node should be directly created by end-users and not added to
1140 /// the AllNodes list.
1141 class HandleSDNode : public SDNode {
1142 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1145 explicit HandleSDNode(SDOperand X)
1146 : SDNode(ISD::HANDLENODE, getSDVTList(MVT::Other)), Op(X) {
1147 InitOperands(&Op, 1);
1150 SDOperand getValue() const { return Op; }
1153 class StringSDNode : public SDNode {
1155 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1157 friend class SelectionDAG;
1158 explicit StringSDNode(const std::string &val)
1159 : SDNode(ISD::STRING, getSDVTList(MVT::Other)), Value(val) {
1162 const std::string &getValue() const { return Value; }
1163 static bool classof(const StringSDNode *) { return true; }
1164 static bool classof(const SDNode *N) {
1165 return N->getOpcode() == ISD::STRING;
1169 class ConstantSDNode : public SDNode {
1171 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1173 friend class SelectionDAG;
1174 ConstantSDNode(bool isTarget, uint64_t val, MVT::ValueType VT)
1175 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant, getSDVTList(VT)),
1180 uint64_t getValue() const { return Value; }
1182 int64_t getSignExtended() const {
1183 unsigned Bits = MVT::getSizeInBits(getValueType(0));
1184 return ((int64_t)Value << (64-Bits)) >> (64-Bits);
1187 bool isNullValue() const { return Value == 0; }
1188 bool isAllOnesValue() const {
1189 return Value == MVT::getIntVTBitMask(getValueType(0));
1192 static bool classof(const ConstantSDNode *) { return true; }
1193 static bool classof(const SDNode *N) {
1194 return N->getOpcode() == ISD::Constant ||
1195 N->getOpcode() == ISD::TargetConstant;
1199 class ConstantFPSDNode : public SDNode {
1201 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1202 // Longterm plan: replace all uses of getValue with getValueAPF, remove
1203 // getValue, rename getValueAPF to getValue.
1205 friend class SelectionDAG;
1206 ConstantFPSDNode(bool isTarget, const APFloat& val, MVT::ValueType VT)
1207 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1208 getSDVTList(VT)), Value(val) {
1212 const APFloat& getValueAPF() const { return Value; }
1214 /// isExactlyValue - We don't rely on operator== working on double values, as
1215 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1216 /// As such, this method can be used to do an exact bit-for-bit comparison of
1217 /// two floating point values.
1219 /// We leave the version with the double argument here because it's just so
1220 /// convenient to write "2.0" and the like. Without this function we'd
1221 /// have to duplicate its logic everywhere it's called.
1222 bool isExactlyValue(double V) const {
1224 Tmp.convert(Value.getSemantics(), APFloat::rmNearestTiesToEven);
1225 return isExactlyValue(Tmp);
1227 bool isExactlyValue(const APFloat& V) const;
1229 bool isValueValidForType(MVT::ValueType VT, const APFloat& Val);
1231 static bool classof(const ConstantFPSDNode *) { return true; }
1232 static bool classof(const SDNode *N) {
1233 return N->getOpcode() == ISD::ConstantFP ||
1234 N->getOpcode() == ISD::TargetConstantFP;
1238 class GlobalAddressSDNode : public SDNode {
1239 GlobalValue *TheGlobal;
1241 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1243 friend class SelectionDAG;
1244 GlobalAddressSDNode(bool isTarget, const GlobalValue *GA, MVT::ValueType VT,
1248 GlobalValue *getGlobal() const { return TheGlobal; }
1249 int getOffset() const { return Offset; }
1251 static bool classof(const GlobalAddressSDNode *) { return true; }
1252 static bool classof(const SDNode *N) {
1253 return N->getOpcode() == ISD::GlobalAddress ||
1254 N->getOpcode() == ISD::TargetGlobalAddress ||
1255 N->getOpcode() == ISD::GlobalTLSAddress ||
1256 N->getOpcode() == ISD::TargetGlobalTLSAddress;
1260 class FrameIndexSDNode : public SDNode {
1262 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1264 friend class SelectionDAG;
1265 FrameIndexSDNode(int fi, MVT::ValueType VT, bool isTarg)
1266 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex, getSDVTList(VT)),
1271 int getIndex() const { return FI; }
1273 static bool classof(const FrameIndexSDNode *) { return true; }
1274 static bool classof(const SDNode *N) {
1275 return N->getOpcode() == ISD::FrameIndex ||
1276 N->getOpcode() == ISD::TargetFrameIndex;
1280 class JumpTableSDNode : public SDNode {
1282 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1284 friend class SelectionDAG;
1285 JumpTableSDNode(int jti, MVT::ValueType VT, bool isTarg)
1286 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable, getSDVTList(VT)),
1291 int getIndex() const { return JTI; }
1293 static bool classof(const JumpTableSDNode *) { return true; }
1294 static bool classof(const SDNode *N) {
1295 return N->getOpcode() == ISD::JumpTable ||
1296 N->getOpcode() == ISD::TargetJumpTable;
1300 class ConstantPoolSDNode : public SDNode {
1303 MachineConstantPoolValue *MachineCPVal;
1305 int Offset; // It's a MachineConstantPoolValue if top bit is set.
1307 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1309 friend class SelectionDAG;
1310 ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT,
1312 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1313 getSDVTList(VT)), Offset(o), Alignment(0) {
1314 assert((int)Offset >= 0 && "Offset is too large");
1317 ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT, int o,
1319 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1320 getSDVTList(VT)), Offset(o), Alignment(Align) {
1321 assert((int)Offset >= 0 && "Offset is too large");
1324 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1325 MVT::ValueType VT, int o=0)
1326 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1327 getSDVTList(VT)), Offset(o), Alignment(0) {
1328 assert((int)Offset >= 0 && "Offset is too large");
1329 Val.MachineCPVal = v;
1330 Offset |= 1 << (sizeof(unsigned)*8-1);
1332 ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1333 MVT::ValueType VT, int o, unsigned Align)
1334 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1335 getSDVTList(VT)), Offset(o), Alignment(Align) {
1336 assert((int)Offset >= 0 && "Offset is too large");
1337 Val.MachineCPVal = v;
1338 Offset |= 1 << (sizeof(unsigned)*8-1);
1342 bool isMachineConstantPoolEntry() const {
1343 return (int)Offset < 0;
1346 Constant *getConstVal() const {
1347 assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1348 return Val.ConstVal;
1351 MachineConstantPoolValue *getMachineCPVal() const {
1352 assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1353 return Val.MachineCPVal;
1356 int getOffset() const {
1357 return Offset & ~(1 << (sizeof(unsigned)*8-1));
1360 // Return the alignment of this constant pool object, which is either 0 (for
1361 // default alignment) or log2 of the desired value.
1362 unsigned getAlignment() const { return Alignment; }
1364 const Type *getType() const;
1366 static bool classof(const ConstantPoolSDNode *) { return true; }
1367 static bool classof(const SDNode *N) {
1368 return N->getOpcode() == ISD::ConstantPool ||
1369 N->getOpcode() == ISD::TargetConstantPool;
1373 class BasicBlockSDNode : public SDNode {
1374 MachineBasicBlock *MBB;
1375 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1377 friend class SelectionDAG;
1378 explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1379 : SDNode(ISD::BasicBlock, getSDVTList(MVT::Other)), MBB(mbb) {
1383 MachineBasicBlock *getBasicBlock() const { return MBB; }
1385 static bool classof(const BasicBlockSDNode *) { return true; }
1386 static bool classof(const SDNode *N) {
1387 return N->getOpcode() == ISD::BasicBlock;
1391 class SrcValueSDNode : public SDNode {
1393 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1395 friend class SelectionDAG;
1396 /// Create a SrcValue for a general value.
1397 explicit SrcValueSDNode(const Value *v)
1398 : SDNode(ISD::SRCVALUE, getSDVTList(MVT::Other)), V(v) {}
1401 /// getValue - return the contained Value.
1402 const Value *getValue() const { return V; }
1404 static bool classof(const SrcValueSDNode *) { return true; }
1405 static bool classof(const SDNode *N) {
1406 return N->getOpcode() == ISD::SRCVALUE;
1411 /// MemOperandSDNode - An SDNode that holds a MemOperand. This is
1412 /// used to represent a reference to memory after ISD::LOAD
1413 /// and ISD::STORE have been lowered.
1415 class MemOperandSDNode : public SDNode {
1416 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1418 friend class SelectionDAG;
1419 /// Create a MemOperand node
1420 explicit MemOperandSDNode(MemOperand mo)
1421 : SDNode(ISD::MEMOPERAND, getSDVTList(MVT::Other)), MO(mo) {}
1424 /// MO - The contained MemOperand.
1425 const MemOperand MO;
1427 static bool classof(const MemOperandSDNode *) { return true; }
1428 static bool classof(const SDNode *N) {
1429 return N->getOpcode() == ISD::MEMOPERAND;
1434 class RegisterSDNode : public SDNode {
1436 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1438 friend class SelectionDAG;
1439 RegisterSDNode(unsigned reg, MVT::ValueType VT)
1440 : SDNode(ISD::Register, getSDVTList(VT)), Reg(reg) {
1444 unsigned getReg() const { return Reg; }
1446 static bool classof(const RegisterSDNode *) { return true; }
1447 static bool classof(const SDNode *N) {
1448 return N->getOpcode() == ISD::Register;
1452 class ExternalSymbolSDNode : public SDNode {
1454 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1456 friend class SelectionDAG;
1457 ExternalSymbolSDNode(bool isTarget, const char *Sym, MVT::ValueType VT)
1458 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1459 getSDVTList(VT)), Symbol(Sym) {
1463 const char *getSymbol() const { return Symbol; }
1465 static bool classof(const ExternalSymbolSDNode *) { return true; }
1466 static bool classof(const SDNode *N) {
1467 return N->getOpcode() == ISD::ExternalSymbol ||
1468 N->getOpcode() == ISD::TargetExternalSymbol;
1472 class CondCodeSDNode : public SDNode {
1473 ISD::CondCode Condition;
1474 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1476 friend class SelectionDAG;
1477 explicit CondCodeSDNode(ISD::CondCode Cond)
1478 : SDNode(ISD::CONDCODE, getSDVTList(MVT::Other)), Condition(Cond) {
1482 ISD::CondCode get() const { return Condition; }
1484 static bool classof(const CondCodeSDNode *) { return true; }
1485 static bool classof(const SDNode *N) {
1486 return N->getOpcode() == ISD::CONDCODE;
1490 /// VTSDNode - This class is used to represent MVT::ValueType's, which are used
1491 /// to parameterize some operations.
1492 class VTSDNode : public SDNode {
1493 MVT::ValueType ValueType;
1494 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1496 friend class SelectionDAG;
1497 explicit VTSDNode(MVT::ValueType VT)
1498 : SDNode(ISD::VALUETYPE, getSDVTList(MVT::Other)), ValueType(VT) {
1502 MVT::ValueType getVT() const { return ValueType; }
1504 static bool classof(const VTSDNode *) { return true; }
1505 static bool classof(const SDNode *N) {
1506 return N->getOpcode() == ISD::VALUETYPE;
1510 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
1512 class LSBaseSDNode : public SDNode {
1514 // AddrMode - unindexed, pre-indexed, post-indexed.
1515 ISD::MemIndexedMode AddrMode;
1517 // MemoryVT - VT of in-memory value.
1518 MVT::ValueType MemoryVT;
1520 //! SrcValue - Memory location for alias analysis.
1521 const Value *SrcValue;
1523 //! SVOffset - Memory location offset.
1526 //! Alignment - Alignment of memory location in bytes.
1529 //! IsVolatile - True if the store is volatile.
1532 //! Operand array for load and store
1534 \note Moving this array to the base class captures more
1535 common functionality shared between LoadSDNode and
1540 LSBaseSDNode(ISD::NodeType NodeTy, SDOperand *Operands, unsigned NumOperands,
1541 SDVTList VTs, ISD::MemIndexedMode AM, MVT::ValueType VT,
1542 const Value *SV, int SVO, unsigned Align, bool Vol)
1543 : SDNode(NodeTy, VTs),
1544 AddrMode(AM), MemoryVT(VT),
1545 SrcValue(SV), SVOffset(SVO), Alignment(Align), IsVolatile(Vol)
1547 for (unsigned i = 0; i != NumOperands; ++i)
1548 Ops[i] = Operands[i];
1549 InitOperands(Ops, NumOperands);
1550 assert(Align != 0 && "Loads and stores should have non-zero aligment");
1551 assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1552 "Only indexed loads and stores have a non-undef offset operand");
1555 const SDOperand getChain() const {
1556 return getOperand(0);
1558 const SDOperand getBasePtr() const {
1559 return getOperand(getOpcode() == ISD::LOAD ? 1 : 2);
1561 const SDOperand getOffset() const {
1562 return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1564 const SDOperand getValue() const {
1565 assert(getOpcode() == ISD::STORE);
1566 return getOperand(1);
1569 const Value *getSrcValue() const { return SrcValue; }
1570 int getSrcValueOffset() const { return SVOffset; }
1571 unsigned getAlignment() const { return Alignment; }
1572 MVT::ValueType getMemoryVT() const { return MemoryVT; }
1573 bool isVolatile() const { return IsVolatile; }
1575 ISD::MemIndexedMode getAddressingMode() const { return AddrMode; }
1577 /// isIndexed - Return true if this is a pre/post inc/dec load/store.
1578 bool isIndexed() const { return AddrMode != ISD::UNINDEXED; }
1580 /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
1581 bool isUnindexed() const { return AddrMode == ISD::UNINDEXED; }
1583 /// getMemOperand - Return a MemOperand object describing the memory
1584 /// reference performed by this load or store.
1585 MemOperand getMemOperand() const;
1587 static bool classof(const LSBaseSDNode *N) { return true; }
1588 static bool classof(const SDNode *N) {
1589 return N->getOpcode() == ISD::LOAD ||
1590 N->getOpcode() == ISD::STORE;
1594 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
1596 class LoadSDNode : public LSBaseSDNode {
1597 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1599 // ExtType - non-ext, anyext, sext, zext.
1600 ISD::LoadExtType ExtType;
1603 friend class SelectionDAG;
1604 LoadSDNode(SDOperand *ChainPtrOff, SDVTList VTs,
1605 ISD::MemIndexedMode AM, ISD::LoadExtType ETy, MVT::ValueType LVT,
1606 const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
1607 : LSBaseSDNode(ISD::LOAD, ChainPtrOff, 3,
1608 VTs, AM, LVT, SV, O, Align, Vol),
1612 ISD::LoadExtType getExtensionType() const { return ExtType; }
1614 static bool classof(const LoadSDNode *) { return true; }
1615 static bool classof(const SDNode *N) {
1616 return N->getOpcode() == ISD::LOAD;
1620 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
1622 class StoreSDNode : public LSBaseSDNode {
1623 virtual void ANCHOR(); // Out-of-line virtual method to give class a home.
1625 // IsTruncStore - True if the op does a truncation before store.
1628 friend class SelectionDAG;
1629 StoreSDNode(SDOperand *ChainValuePtrOff, SDVTList VTs,
1630 ISD::MemIndexedMode AM, bool isTrunc, MVT::ValueType SVT,
1631 const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
1632 : LSBaseSDNode(ISD::STORE, ChainValuePtrOff, 4,
1633 VTs, AM, SVT, SV, O, Align, Vol),
1634 IsTruncStore(isTrunc) { }
1637 bool isTruncatingStore() const { return IsTruncStore; }
1639 static bool classof(const StoreSDNode *) { return true; }
1640 static bool classof(const SDNode *N) {
1641 return N->getOpcode() == ISD::STORE;
1646 class SDNodeIterator : public forward_iterator<SDNode, ptrdiff_t> {
1650 SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1652 bool operator==(const SDNodeIterator& x) const {
1653 return Operand == x.Operand;
1655 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1657 const SDNodeIterator &operator=(const SDNodeIterator &I) {
1658 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1659 Operand = I.Operand;
1663 pointer operator*() const {
1664 return Node->getOperand(Operand).Val;
1666 pointer operator->() const { return operator*(); }
1668 SDNodeIterator& operator++() { // Preincrement
1672 SDNodeIterator operator++(int) { // Postincrement
1673 SDNodeIterator tmp = *this; ++*this; return tmp;
1676 static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
1677 static SDNodeIterator end (SDNode *N) {
1678 return SDNodeIterator(N, N->getNumOperands());
1681 unsigned getOperand() const { return Operand; }
1682 const SDNode *getNode() const { return Node; }
1685 template <> struct GraphTraits<SDNode*> {
1686 typedef SDNode NodeType;
1687 typedef SDNodeIterator ChildIteratorType;
1688 static inline NodeType *getEntryNode(SDNode *N) { return N; }
1689 static inline ChildIteratorType child_begin(NodeType *N) {
1690 return SDNodeIterator::begin(N);
1692 static inline ChildIteratorType child_end(NodeType *N) {
1693 return SDNodeIterator::end(N);
1698 struct ilist_traits<SDNode> {
1699 static SDNode *getPrev(const SDNode *N) { return N->Prev; }
1700 static SDNode *getNext(const SDNode *N) { return N->Next; }
1702 static void setPrev(SDNode *N, SDNode *Prev) { N->Prev = Prev; }
1703 static void setNext(SDNode *N, SDNode *Next) { N->Next = Next; }
1705 static SDNode *createSentinel() {
1706 return new SDNode(ISD::EntryToken, SDNode::getSDVTList(MVT::Other));
1708 static void destroySentinel(SDNode *N) { delete N; }
1709 //static SDNode *createNode(const SDNode &V) { return new SDNode(V); }
1712 void addNodeToList(SDNode *NTy) {}
1713 void removeNodeFromList(SDNode *NTy) {}
1714 void transferNodesFromList(iplist<SDNode, ilist_traits> &L2,
1715 const ilist_iterator<SDNode> &X,
1716 const ilist_iterator<SDNode> &Y) {}
1720 /// isNormalLoad - Returns true if the specified node is a non-extending
1721 /// and unindexed load.
1722 inline bool isNormalLoad(const SDNode *N) {
1723 if (N->getOpcode() != ISD::LOAD)
1725 const LoadSDNode *Ld = cast<LoadSDNode>(N);
1726 return Ld->getExtensionType() == ISD::NON_EXTLOAD &&
1727 Ld->getAddressingMode() == ISD::UNINDEXED;
1730 /// isNON_EXTLoad - Returns true if the specified node is a non-extending
1732 inline bool isNON_EXTLoad(const SDNode *N) {
1733 return N->getOpcode() == ISD::LOAD &&
1734 cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
1737 /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
1739 inline bool isEXTLoad(const SDNode *N) {
1740 return N->getOpcode() == ISD::LOAD &&
1741 cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
1744 /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
1746 inline bool isSEXTLoad(const SDNode *N) {
1747 return N->getOpcode() == ISD::LOAD &&
1748 cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
1751 /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
1753 inline bool isZEXTLoad(const SDNode *N) {
1754 return N->getOpcode() == ISD::LOAD &&
1755 cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
1758 /// isUNINDEXEDLoad - Returns true if the specified node is a unindexed load.
1760 inline bool isUNINDEXEDLoad(const SDNode *N) {
1761 return N->getOpcode() == ISD::LOAD &&
1762 cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1765 /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
1767 inline bool isNON_TRUNCStore(const SDNode *N) {
1768 return N->getOpcode() == ISD::STORE &&
1769 !cast<StoreSDNode>(N)->isTruncatingStore();
1772 /// isTRUNCStore - Returns true if the specified node is a truncating
1774 inline bool isTRUNCStore(const SDNode *N) {
1775 return N->getOpcode() == ISD::STORE &&
1776 cast<StoreSDNode>(N)->isTruncatingStore();
1781 } // end llvm namespace