1 //===-- llvm/CodeGen/SelectionDAGNodes.h - SelectionDAG Nodes ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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/CodeGen/ValueTypes.h"
23 #include "llvm/Value.h"
24 #include "llvm/ADT/GraphTraits.h"
25 #include "llvm/ADT/iterator"
26 #include "llvm/ADT/SmallVector.h"
27 #include "llvm/Support/DataTypes.h"
34 class MachineBasicBlock;
36 template <typename T> struct simplify_type;
37 template <typename T> struct ilist_traits;
38 template<typename NodeTy, typename Traits> class iplist;
39 template<typename NodeTy> class ilist_iterator;
41 /// SDVTList - This represents a list of ValueType's that has been intern'd by
42 /// a SelectionDAG. Instances of this simple value class are returned by
43 /// SelectionDAG::getVTList(...).
46 const MVT::ValueType *VTs;
47 unsigned short NumVTs;
51 /// ISD namespace - This namespace contains an enum which represents all of the
52 /// SelectionDAG node types and value types.
55 //===--------------------------------------------------------------------===//
56 /// ISD::NodeType enum - This enum defines all of the operators valid in a
60 // DELETED_NODE - This is an illegal flag value that is used to catch
61 // errors. This opcode is not a legal opcode for any node.
64 // EntryToken - This is the marker used to indicate the start of the region.
67 // Token factor - This node takes multiple tokens as input and produces a
68 // single token result. This is used to represent the fact that the operand
69 // operators are independent of each other.
72 // AssertSext, AssertZext - These nodes record if a register contains a
73 // value that has already been zero or sign extended from a narrower type.
74 // These nodes take two operands. The first is the node that has already
75 // been extended, and the second is a value type node indicating the width
77 AssertSext, AssertZext,
79 // Various leaf nodes.
80 STRING, BasicBlock, VALUETYPE, CONDCODE, Register,
82 GlobalAddress, FrameIndex, JumpTable, ConstantPool, ExternalSymbol,
84 // TargetConstant* - Like Constant*, but the DAG does not do any folding or
85 // simplification of the constant.
89 // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
90 // anything else with this node, and this is valid in the target-specific
91 // dag, turning into a GlobalAddress operand.
98 /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
99 /// This node represents a target intrinsic function with no side effects.
100 /// The first operand is the ID number of the intrinsic from the
101 /// llvm::Intrinsic namespace. The operands to the intrinsic follow. The
102 /// node has returns the result of the intrinsic.
105 /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
106 /// This node represents a target intrinsic function with side effects that
107 /// returns a result. The first operand is a chain pointer. The second is
108 /// the ID number of the intrinsic from the llvm::Intrinsic namespace. The
109 /// operands to the intrinsic follow. The node has two results, the result
110 /// of the intrinsic and an output chain.
113 /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
114 /// This node represents a target intrinsic function with side effects that
115 /// does not return a result. The first operand is a chain pointer. The
116 /// second is the ID number of the intrinsic from the llvm::Intrinsic
117 /// namespace. The operands to the intrinsic follow.
120 // CopyToReg - This node has three operands: a chain, a register number to
121 // set to this value, and a value.
124 // CopyFromReg - This node indicates that the input value is a virtual or
125 // physical register that is defined outside of the scope of this
126 // SelectionDAG. The register is available from the RegSDNode object.
129 // UNDEF - An undefined node
132 /// FORMAL_ARGUMENTS(CHAIN, CC#, ISVARARG) - This node represents the formal
133 /// arguments for a function. CC# is a Constant value indicating the
134 /// calling convention of the function, and ISVARARG is a flag that
135 /// indicates whether the function is varargs or not. This node has one
136 /// result value for each incoming argument, plus one for the output chain.
137 /// It must be custom legalized.
141 /// RV1, RV2...RVn, CHAIN = CALL(CHAIN, CC#, ISVARARG, ISTAILCALL, CALLEE,
142 /// ARG0, SIGN0, ARG1, SIGN1, ... ARGn, SIGNn)
143 /// This node represents a fully general function call, before the legalizer
144 /// runs. This has one result value for each argument / signness pair, plus
145 /// a chain result. It must be custom legalized.
148 // EXTRACT_ELEMENT - This is used to get the first or second (determined by
149 // a Constant, which is required to be operand #1), element of the aggregate
150 // value specified as operand #0. This is only for use before legalization,
151 // for values that will be broken into multiple registers.
154 // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways. Given
155 // two values of the same integer value type, this produces a value twice as
156 // big. Like EXTRACT_ELEMENT, this can only be used before legalization.
159 // MERGE_VALUES - This node takes multiple discrete operands and returns
160 // them all as its individual results. This nodes has exactly the same
161 // number of inputs and outputs, and is only valid before legalization.
162 // This node is useful for some pieces of the code generator that want to
163 // think about a single node with multiple results, not multiple nodes.
166 // Simple integer binary arithmetic operators.
167 ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
169 // Carry-setting nodes for multiple precision addition and subtraction.
170 // These nodes take two operands of the same value type, and produce two
171 // results. The first result is the normal add or sub result, the second
172 // result is the carry flag result.
175 // Carry-using nodes for multiple precision addition and subtraction. These
176 // nodes take three operands: The first two are the normal lhs and rhs to
177 // the add or sub, and the third is the input carry flag. These nodes
178 // produce two results; the normal result of the add or sub, and the output
179 // carry flag. These nodes both read and write a carry flag to allow them
180 // to them to be chained together for add and sub of arbitrarily large
184 // Simple binary floating point operators.
185 FADD, FSUB, FMUL, FDIV, FREM,
187 // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y. NOTE: This
188 // DAG node does not require that X and Y have the same type, just that they
189 // are both floating point. X and the result must have the same type.
190 // FCOPYSIGN(f32, f64) is allowed.
193 /// VBUILD_VECTOR(ELT1, ELT2, ELT3, ELT4,..., COUNT,TYPE) - Return a vector
194 /// with the specified, possibly variable, elements. The number of elements
195 /// is required to be a power of two.
198 /// BUILD_VECTOR(ELT1, ELT2, ELT3, ELT4,...) - Return a vector
199 /// with the specified, possibly variable, elements. The number of elements
200 /// is required to be a power of two.
203 /// VINSERT_VECTOR_ELT(VECTOR, VAL, IDX, COUNT,TYPE) - Given a vector
204 /// VECTOR, an element ELEMENT, and a (potentially variable) index IDX,
205 /// return an vector with the specified element of VECTOR replaced with VAL.
206 /// COUNT and TYPE specify the type of vector, as is standard for V* nodes.
209 /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR (a legal packed
210 /// type) with the element at IDX replaced with VAL.
213 /// VEXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
214 /// (an MVT::Vector value) identified by the (potentially variable) element
218 /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
219 /// (a legal packed type vector) identified by the (potentially variable)
220 /// element number IDX.
223 /// VVECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC, COUNT,TYPE) - Returns a vector,
224 /// of the same type as VEC1/VEC2. SHUFFLEVEC is a VBUILD_VECTOR of
225 /// constant int values that indicate which value each result element will
226 /// get. The elements of VEC1/VEC2 are enumerated in order. This is quite
227 /// similar to the Altivec 'vperm' instruction, except that the indices must
228 /// be constants and are in terms of the element size of VEC1/VEC2, not in
232 /// VECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC) - Returns a vector, of the same
233 /// type as VEC1/VEC2. SHUFFLEVEC is a BUILD_VECTOR of constant int values
234 /// (regardless of whether its datatype is legal or not) that indicate
235 /// which value each result element will get. The elements of VEC1/VEC2 are
236 /// enumerated in order. This is quite similar to the Altivec 'vperm'
237 /// instruction, except that the indices must be constants and are in terms
238 /// of the element size of VEC1/VEC2, not in terms of bytes.
241 /// X = VBIT_CONVERT(Y) and X = VBIT_CONVERT(Y, COUNT,TYPE) - This node
242 /// represents a conversion from or to an ISD::Vector type.
244 /// This is lowered to a BIT_CONVERT of the appropriate input/output types.
245 /// The input and output are required to have the same size and at least one
246 /// is required to be a vector (if neither is a vector, just use
249 /// If the result is a vector, this takes three operands (like any other
250 /// vector producer) which indicate the size and type of the vector result.
251 /// Otherwise it takes one input.
254 /// BINOP(LHS, RHS, COUNT,TYPE)
255 /// Simple abstract vector operators. Unlike the integer and floating point
256 /// binary operators, these nodes also take two additional operands:
257 /// a constant element count, and a value type node indicating the type of
258 /// the elements. The order is count, type, op0, op1. All vector opcodes,
259 /// including VLOAD and VConstant must currently have count and type as
260 /// their last two operands.
261 VADD, VSUB, VMUL, VSDIV, VUDIV,
264 /// VSELECT(COND,LHS,RHS, COUNT,TYPE) - Select for MVT::Vector values.
265 /// COND is a boolean value. This node return LHS if COND is true, RHS if
269 /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
270 /// scalar value into the low element of the resultant vector type. The top
271 /// elements of the vector are undefined.
274 // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
275 // an unsigned/signed value of type i[2*n], then return the top part.
278 // Bitwise operators - logical and, logical or, logical xor, shift left,
279 // shift right algebraic (shift in sign bits), shift right logical (shift in
280 // zeroes), rotate left, rotate right, and byteswap.
281 AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
283 // Counting operators
286 // Select(COND, TRUEVAL, FALSEVAL)
289 // Select with condition operator - This selects between a true value and
290 // a false value (ops #2 and #3) based on the boolean result of comparing
291 // the lhs and rhs (ops #0 and #1) of a conditional expression with the
292 // condition code in op #4, a CondCodeSDNode.
295 // SetCC operator - This evaluates to a boolean (i1) true value if the
296 // condition is true. The operands to this are the left and right operands
297 // to compare (ops #0, and #1) and the condition code to compare them with
298 // (op #2) as a CondCodeSDNode.
301 // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
302 // integer shift operations, just like ADD/SUB_PARTS. The operation
304 // [Lo,Hi] = op [LoLHS,HiLHS], Amt
305 SHL_PARTS, SRA_PARTS, SRL_PARTS,
307 // Conversion operators. These are all single input single output
308 // operations. For all of these, the result type must be strictly
309 // wider or narrower (depending on the operation) than the source
312 // SIGN_EXTEND - Used for integer types, replicating the sign bit
316 // ZERO_EXTEND - Used for integer types, zeroing the new bits.
319 // ANY_EXTEND - Used for integer types. The high bits are undefined.
322 // TRUNCATE - Completely drop the high bits.
325 // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
326 // depends on the first letter) to floating point.
330 // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
331 // sign extend a small value in a large integer register (e.g. sign
332 // extending the low 8 bits of a 32-bit register to fill the top 24 bits
333 // with the 7th bit). The size of the smaller type is indicated by the 1th
334 // operand, a ValueType node.
337 // FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
342 // FP_ROUND - Perform a rounding operation from the current
343 // precision down to the specified precision (currently always 64->32).
346 // FP_ROUND_INREG - This operator takes a floating point register, and
347 // rounds it to a floating point value. It then promotes it and returns it
348 // in a register of the same size. This operation effectively just discards
349 // excess precision. The type to round down to is specified by the 1th
350 // operation, a VTSDNode (currently always 64->32->64).
353 // FP_EXTEND - Extend a smaller FP type into a larger FP type.
356 // BIT_CONVERT - Theis operator converts between integer and FP values, as
357 // if one was stored to memory as integer and the other was loaded from the
358 // same address (or equivalently for vector format conversions, etc). The
359 // source and result are required to have the same bit size (e.g.
360 // f32 <-> i32). This can also be used for int-to-int or fp-to-fp
361 // conversions, but that is a noop, deleted by getNode().
364 // FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI - Perform unary floating point
365 // negation, absolute value, square root, sine and cosine, and powi
367 FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI,
369 // Other operators. LOAD and STORE have token chains as their first
370 // operand, then the same operands as an LLVM load/store instruction, then a
371 // SRCVALUE node that provides alias analysis information.
374 // Abstract vector version of LOAD. VLOAD has a constant element count as
375 // the first operand, followed by a value type node indicating the type of
376 // the elements, a token chain, a pointer operand, and a SRCVALUE node.
379 // EXTLOAD, SEXTLOAD, ZEXTLOAD - These three operators all load a value from
380 // memory and extend them to a larger value (e.g. load a byte into a word
381 // register). All three of these have four operands, a token chain, a
382 // pointer to load from, a SRCVALUE for alias analysis, and a VALUETYPE node
383 // indicating the type to load.
385 // SEXTLOAD loads the integer operand and sign extends it to a larger
386 // integer result type.
387 // ZEXTLOAD loads the integer operand and zero extends it to a larger
388 // integer result type.
389 // EXTLOAD is used for three things: floating point extending loads,
390 // integer extending loads [the top bits are undefined], and vector
391 // extending loads [load into low elt].
392 EXTLOAD, SEXTLOAD, ZEXTLOAD,
394 // TRUNCSTORE - This operators truncates (for integer) or rounds (for FP) a
395 // value and stores it to memory in one operation. This can be used for
396 // either integer or floating point operands. The first four operands of
397 // this are the same as a standard store. The fifth is the ValueType to
398 // store it as (which will be smaller than the source value).
401 // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
402 // to a specified boundary. The first operand is the token chain, the
403 // second is the number of bytes to allocate, and the third is the alignment
404 // boundary. The size is guaranteed to be a multiple of the stack
405 // alignment, and the alignment is guaranteed to be bigger than the stack
406 // alignment (if required) or 0 to get standard stack alignment.
409 // Control flow instructions. These all have token chains.
411 // BR - Unconditional branch. The first operand is the chain
412 // operand, the second is the MBB to branch to.
415 // BRIND - Indirect branch. The first operand is the chain, the second
416 // is the value to branch to, which must be of the same type as the target's
420 // BRCOND - Conditional branch. The first operand is the chain,
421 // the second is the condition, the third is the block to branch
422 // to if the condition is true.
425 // BR_CC - Conditional branch. The behavior is like that of SELECT_CC, in
426 // that the condition is represented as condition code, and two nodes to
427 // compare, rather than as a combined SetCC node. The operands in order are
428 // chain, cc, lhs, rhs, block to branch to if condition is true.
431 // RET - Return from function. The first operand is the chain,
432 // and any subsequent operands are pairs of return value and return value
433 // signness for the function. This operation can have variable number of
437 // INLINEASM - Represents an inline asm block. This node always has two
438 // return values: a chain and a flag result. The inputs are as follows:
439 // Operand #0 : Input chain.
440 // Operand #1 : a ExternalSymbolSDNode with a pointer to the asm string.
441 // Operand #2n+2: A RegisterNode.
442 // Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
443 // Operand #last: Optional, an incoming flag.
446 // STACKSAVE - STACKSAVE has one operand, an input chain. It produces a
447 // value, the same type as the pointer type for the system, and an output
451 // STACKRESTORE has two operands, an input chain and a pointer to restore to
452 // it returns an output chain.
455 // MEMSET/MEMCPY/MEMMOVE - The first operand is the chain, and the rest
456 // correspond to the operands of the LLVM intrinsic functions. The only
457 // result is a token chain. The alignment argument is guaranteed to be a
463 // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
464 // a call sequence, and carry arbitrary information that target might want
465 // to know. The first operand is a chain, the rest are specified by the
466 // target and not touched by the DAG optimizers.
467 CALLSEQ_START, // Beginning of a call sequence
468 CALLSEQ_END, // End of a call sequence
470 // VAARG - VAARG has three operands: an input chain, a pointer, and a
471 // SRCVALUE. It returns a pair of values: the vaarg value and a new chain.
474 // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
475 // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
479 // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
480 // pointer, and a SRCVALUE.
483 // SRCVALUE - This corresponds to a Value*, and is used to associate memory
484 // locations with their value. This allows one use alias analysis
485 // information in the backend.
488 // PCMARKER - This corresponds to the pcmarker intrinsic.
491 // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
492 // The only operand is a chain and a value and a chain are produced. The
493 // value is the contents of the architecture specific cycle counter like
494 // register (or other high accuracy low latency clock source)
497 // HANDLENODE node - Used as a handle for various purposes.
500 // LOCATION - This node is used to represent a source location for debug
501 // info. It takes token chain as input, then a line number, then a column
502 // number, then a filename, then a working dir. It produces a token chain
506 // DEBUG_LOC - This node is used to represent source line information
507 // embedded in the code. It takes a token chain as input, then a line
508 // number, then a column then a file id (provided by MachineDebugInfo.) It
509 // produces a token chain as output.
512 // DEBUG_LABEL - This node is used to mark a location in the code where a
513 // label should be generated for use by the debug information. It takes a
514 // token chain as input and then a unique id (provided by MachineDebugInfo.)
515 // It produces a token chain as output.
518 // BUILTIN_OP_END - This must be the last enum value in this list.
524 /// isBuildVectorAllOnes - Return true if the specified node is a
525 /// BUILD_VECTOR where all of the elements are ~0 or undef.
526 bool isBuildVectorAllOnes(const SDNode *N);
528 /// isBuildVectorAllZeros - Return true if the specified node is a
529 /// BUILD_VECTOR where all of the elements are 0 or undef.
530 bool isBuildVectorAllZeros(const SDNode *N);
532 //===--------------------------------------------------------------------===//
533 /// ISD::CondCode enum - These are ordered carefully to make the bitfields
534 /// below work out, when considering SETFALSE (something that never exists
535 /// dynamically) as 0. "U" -> Unsigned (for integer operands) or Unordered
536 /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
537 /// to. If the "N" column is 1, the result of the comparison is undefined if
538 /// the input is a NAN.
540 /// All of these (except for the 'always folded ops') should be handled for
541 /// floating point. For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
542 /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
544 /// Note that these are laid out in a specific order to allow bit-twiddling
545 /// to transform conditions.
547 // Opcode N U L G E Intuitive operation
548 SETFALSE, // 0 0 0 0 Always false (always folded)
549 SETOEQ, // 0 0 0 1 True if ordered and equal
550 SETOGT, // 0 0 1 0 True if ordered and greater than
551 SETOGE, // 0 0 1 1 True if ordered and greater than or equal
552 SETOLT, // 0 1 0 0 True if ordered and less than
553 SETOLE, // 0 1 0 1 True if ordered and less than or equal
554 SETONE, // 0 1 1 0 True if ordered and operands are unequal
555 SETO, // 0 1 1 1 True if ordered (no nans)
556 SETUO, // 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
557 SETUEQ, // 1 0 0 1 True if unordered or equal
558 SETUGT, // 1 0 1 0 True if unordered or greater than
559 SETUGE, // 1 0 1 1 True if unordered, greater than, or equal
560 SETULT, // 1 1 0 0 True if unordered or less than
561 SETULE, // 1 1 0 1 True if unordered, less than, or equal
562 SETUNE, // 1 1 1 0 True if unordered or not equal
563 SETTRUE, // 1 1 1 1 Always true (always folded)
564 // Don't care operations: undefined if the input is a nan.
565 SETFALSE2, // 1 X 0 0 0 Always false (always folded)
566 SETEQ, // 1 X 0 0 1 True if equal
567 SETGT, // 1 X 0 1 0 True if greater than
568 SETGE, // 1 X 0 1 1 True if greater than or equal
569 SETLT, // 1 X 1 0 0 True if less than
570 SETLE, // 1 X 1 0 1 True if less than or equal
571 SETNE, // 1 X 1 1 0 True if not equal
572 SETTRUE2, // 1 X 1 1 1 Always true (always folded)
574 SETCC_INVALID // Marker value.
577 /// isSignedIntSetCC - Return true if this is a setcc instruction that
578 /// performs a signed comparison when used with integer operands.
579 inline bool isSignedIntSetCC(CondCode Code) {
580 return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
583 /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
584 /// performs an unsigned comparison when used with integer operands.
585 inline bool isUnsignedIntSetCC(CondCode Code) {
586 return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
589 /// isTrueWhenEqual - Return true if the specified condition returns true if
590 /// the two operands to the condition are equal. Note that if one of the two
591 /// operands is a NaN, this value is meaningless.
592 inline bool isTrueWhenEqual(CondCode Cond) {
593 return ((int)Cond & 1) != 0;
596 /// getUnorderedFlavor - This function returns 0 if the condition is always
597 /// false if an operand is a NaN, 1 if the condition is always true if the
598 /// operand is a NaN, and 2 if the condition is undefined if the operand is a
600 inline unsigned getUnorderedFlavor(CondCode Cond) {
601 return ((int)Cond >> 3) & 3;
604 /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
605 /// 'op' is a valid SetCC operation.
606 CondCode getSetCCInverse(CondCode Operation, bool isInteger);
608 /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
609 /// when given the operation for (X op Y).
610 CondCode getSetCCSwappedOperands(CondCode Operation);
612 /// getSetCCOrOperation - Return the result of a logical OR between different
613 /// comparisons of identical values: ((X op1 Y) | (X op2 Y)). This
614 /// function returns SETCC_INVALID if it is not possible to represent the
615 /// resultant comparison.
616 CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
618 /// getSetCCAndOperation - Return the result of a logical AND between
619 /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)). This
620 /// function returns SETCC_INVALID if it is not possible to represent the
621 /// resultant comparison.
622 CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
623 } // end llvm::ISD namespace
626 //===----------------------------------------------------------------------===//
627 /// SDOperand - Unlike LLVM values, Selection DAG nodes may return multiple
628 /// values as the result of a computation. Many nodes return multiple values,
629 /// from loads (which define a token and a return value) to ADDC (which returns
630 /// a result and a carry value), to calls (which may return an arbitrary number
633 /// As such, each use of a SelectionDAG computation must indicate the node that
634 /// computes it as well as which return value to use from that node. This pair
635 /// of information is represented with the SDOperand value type.
639 SDNode *Val; // The node defining the value we are using.
640 unsigned ResNo; // Which return value of the node we are using.
642 SDOperand() : Val(0), ResNo(0) {}
643 SDOperand(SDNode *val, unsigned resno) : Val(val), ResNo(resno) {}
645 bool operator==(const SDOperand &O) const {
646 return Val == O.Val && ResNo == O.ResNo;
648 bool operator!=(const SDOperand &O) const {
649 return !operator==(O);
651 bool operator<(const SDOperand &O) const {
652 return Val < O.Val || (Val == O.Val && ResNo < O.ResNo);
655 SDOperand getValue(unsigned R) const {
656 return SDOperand(Val, R);
659 // isOperand - Return true if this node is an operand of N.
660 bool isOperand(SDNode *N) const;
662 /// getValueType - Return the ValueType of the referenced return value.
664 inline MVT::ValueType getValueType() const;
666 // Forwarding methods - These forward to the corresponding methods in SDNode.
667 inline unsigned getOpcode() const;
668 inline unsigned getNumOperands() const;
669 inline const SDOperand &getOperand(unsigned i) const;
670 inline bool isTargetOpcode() const;
671 inline unsigned getTargetOpcode() const;
673 /// hasOneUse - Return true if there is exactly one operation using this
674 /// result value of the defining operator.
675 inline bool hasOneUse() const;
679 /// simplify_type specializations - Allow casting operators to work directly on
680 /// SDOperands as if they were SDNode*'s.
681 template<> struct simplify_type<SDOperand> {
682 typedef SDNode* SimpleType;
683 static SimpleType getSimplifiedValue(const SDOperand &Val) {
684 return static_cast<SimpleType>(Val.Val);
687 template<> struct simplify_type<const SDOperand> {
688 typedef SDNode* SimpleType;
689 static SimpleType getSimplifiedValue(const SDOperand &Val) {
690 return static_cast<SimpleType>(Val.Val);
695 /// SDNode - Represents one node in the SelectionDAG.
698 /// NodeType - The operation that this node performs.
700 unsigned short NodeType;
702 /// NodeId - Unique id per SDNode in the DAG.
705 /// OperandList - The values that are used by this operation.
707 SDOperand *OperandList;
709 /// ValueList - The types of the values this node defines. SDNode's may
710 /// define multiple values simultaneously.
711 const MVT::ValueType *ValueList;
713 /// NumOperands/NumValues - The number of entries in the Operand/Value list.
714 unsigned short NumOperands, NumValues;
716 /// Prev/Next pointers - These pointers form the linked list of of the
717 /// AllNodes list in the current DAG.
719 friend struct ilist_traits<SDNode>;
721 /// NextInBucket - This is used by the SelectionDAGCSEMap.
724 /// Uses - These are all of the SDNode's that use a value produced by this
726 SmallVector<SDNode*,3> Uses;
728 // Out-of-line virtual method to give class a home.
729 virtual void ANCHOR();
732 assert(NumOperands == 0 && "Operand list not cleared before deletion");
733 assert(NextInBucket == 0 && "Still in CSEMap?");
734 NodeType = ISD::DELETED_NODE;
737 //===--------------------------------------------------------------------===//
740 unsigned getOpcode() const { return NodeType; }
741 bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
742 unsigned getTargetOpcode() const {
743 assert(isTargetOpcode() && "Not a target opcode!");
744 return NodeType - ISD::BUILTIN_OP_END;
747 size_t use_size() const { return Uses.size(); }
748 bool use_empty() const { return Uses.empty(); }
749 bool hasOneUse() const { return Uses.size() == 1; }
751 /// getNodeId - Return the unique node id.
753 int getNodeId() const { return NodeId; }
755 typedef SmallVector<SDNode*,3>::const_iterator use_iterator;
756 use_iterator use_begin() const { return Uses.begin(); }
757 use_iterator use_end() const { return Uses.end(); }
759 /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
760 /// indicated value. This method ignores uses of other values defined by this
762 bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
764 // isOnlyUse - Return true if this node is the only use of N.
765 bool isOnlyUse(SDNode *N) const;
767 // isOperand - Return true if this node is an operand of N.
768 bool isOperand(SDNode *N) const;
770 /// getNumOperands - Return the number of values used by this operation.
772 unsigned getNumOperands() const { return NumOperands; }
774 const SDOperand &getOperand(unsigned Num) const {
775 assert(Num < NumOperands && "Invalid child # of SDNode!");
776 return OperandList[Num];
778 typedef const SDOperand* op_iterator;
779 op_iterator op_begin() const { return OperandList; }
780 op_iterator op_end() const { return OperandList+NumOperands; }
783 SDVTList getVTList() const {
784 SDVTList X = { ValueList, NumValues };
788 /// getNumValues - Return the number of values defined/returned by this
791 unsigned getNumValues() const { return NumValues; }
793 /// getValueType - Return the type of a specified result.
795 MVT::ValueType getValueType(unsigned ResNo) const {
796 assert(ResNo < NumValues && "Illegal result number!");
797 return ValueList[ResNo];
800 typedef const MVT::ValueType* value_iterator;
801 value_iterator value_begin() const { return ValueList; }
802 value_iterator value_end() const { return ValueList+NumValues; }
804 /// getOperationName - Return the opcode of this operation for printing.
806 const char* getOperationName(const SelectionDAG *G = 0) const;
808 void dump(const SelectionDAG *G) const;
810 static bool classof(const SDNode *) { return true; }
813 /// NextInBucket accessors, these are private to SelectionDAGCSEMap.
814 void *getNextInBucket() const { return NextInBucket; }
815 void SetNextInBucket(void *N) { NextInBucket = N; }
818 friend class SelectionDAG;
820 /// getValueTypeList - Return a pointer to the specified value type.
822 static MVT::ValueType *getValueTypeList(MVT::ValueType VT);
824 SDNode(unsigned NT, MVT::ValueType VT) : NodeType(NT), NodeId(-1) {
825 OperandList = 0; NumOperands = 0;
826 ValueList = getValueTypeList(VT);
831 SDNode(unsigned NT, SDOperand Op)
832 : NodeType(NT), NodeId(-1) {
833 OperandList = new SDOperand[1];
836 Op.Val->Uses.push_back(this);
842 SDNode(unsigned NT, SDOperand N1, SDOperand N2)
843 : NodeType(NT), NodeId(-1) {
844 OperandList = new SDOperand[2];
848 N1.Val->Uses.push_back(this); N2.Val->Uses.push_back(this);
854 SDNode(unsigned NT, SDOperand N1, SDOperand N2, SDOperand N3)
855 : NodeType(NT), NodeId(-1) {
856 OperandList = new SDOperand[3];
862 N1.Val->Uses.push_back(this); N2.Val->Uses.push_back(this);
863 N3.Val->Uses.push_back(this);
869 SDNode(unsigned NT, SDOperand N1, SDOperand N2, SDOperand N3, SDOperand N4)
870 : NodeType(NT), NodeId(-1) {
871 OperandList = new SDOperand[4];
878 N1.Val->Uses.push_back(this); N2.Val->Uses.push_back(this);
879 N3.Val->Uses.push_back(this); N4.Val->Uses.push_back(this);
885 SDNode(unsigned Opc, const SDOperand *Ops, unsigned NumOps)
886 : NodeType(Opc), NodeId(-1) {
887 NumOperands = NumOps;
888 OperandList = new SDOperand[NumOperands];
890 for (unsigned i = 0, e = NumOps; i != e; ++i) {
891 OperandList[i] = Ops[i];
892 SDNode *N = OperandList[i].Val;
893 N->Uses.push_back(this);
901 /// MorphNodeTo - This clears the return value and operands list, and sets the
902 /// opcode of the node to the specified value. This should only be used by
903 /// the SelectionDAG class.
904 void MorphNodeTo(unsigned Opc) {
909 // Clear the operands list, updating used nodes to remove this from their
911 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I)
912 I->Val->removeUser(this);
913 delete [] OperandList;
918 void setValueTypes(SDVTList L) {
919 assert(NumValues == 0 && "Should not have values yet!");
921 NumValues = L.NumVTs;
924 void setOperands(SDOperand Op0) {
925 assert(NumOperands == 0 && "Should not have operands yet!");
926 OperandList = new SDOperand[1];
927 OperandList[0] = Op0;
929 Op0.Val->Uses.push_back(this);
931 void setOperands(SDOperand Op0, SDOperand Op1) {
932 assert(NumOperands == 0 && "Should not have operands yet!");
933 OperandList = new SDOperand[2];
934 OperandList[0] = Op0;
935 OperandList[1] = Op1;
937 Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
939 void setOperands(SDOperand Op0, SDOperand Op1, SDOperand Op2) {
940 assert(NumOperands == 0 && "Should not have operands yet!");
941 OperandList = new SDOperand[3];
942 OperandList[0] = Op0;
943 OperandList[1] = Op1;
944 OperandList[2] = Op2;
946 Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
947 Op2.Val->Uses.push_back(this);
949 void setOperands(const SDOperand *Ops, unsigned NumOps) {
950 assert(NumOperands == 0 && "Should not have operands yet!");
951 NumOperands = NumOps;
952 OperandList = new SDOperand[NumOperands];
954 for (unsigned i = 0, e = NumOps; i != e; ++i) {
955 OperandList[i] = Ops[i];
956 SDNode *N = OperandList[i].Val;
957 N->Uses.push_back(this);
961 void addUser(SDNode *User) {
962 Uses.push_back(User);
964 void removeUser(SDNode *User) {
965 // Remove this user from the operand's use list.
966 for (unsigned i = Uses.size(); ; --i) {
967 assert(i != 0 && "Didn't find user!");
968 if (Uses[i-1] == User) {
969 Uses[i-1] = Uses.back();
976 void setNodeId(int Id) {
982 // Define inline functions from the SDOperand class.
984 inline unsigned SDOperand::getOpcode() const {
985 return Val->getOpcode();
987 inline MVT::ValueType SDOperand::getValueType() const {
988 return Val->getValueType(ResNo);
990 inline unsigned SDOperand::getNumOperands() const {
991 return Val->getNumOperands();
993 inline const SDOperand &SDOperand::getOperand(unsigned i) const {
994 return Val->getOperand(i);
996 inline bool SDOperand::isTargetOpcode() const {
997 return Val->isTargetOpcode();
999 inline unsigned SDOperand::getTargetOpcode() const {
1000 return Val->getTargetOpcode();
1002 inline bool SDOperand::hasOneUse() const {
1003 return Val->hasNUsesOfValue(1, ResNo);
1006 /// HandleSDNode - This class is used to form a handle around another node that
1007 /// is persistant and is updated across invocations of replaceAllUsesWith on its
1008 /// operand. This node should be directly created by end-users and not added to
1009 /// the AllNodes list.
1010 class HandleSDNode : public SDNode {
1012 HandleSDNode(SDOperand X) : SDNode(ISD::HANDLENODE, X) {}
1014 MorphNodeTo(ISD::HANDLENODE); // Drops operand uses.
1017 SDOperand getValue() const { return getOperand(0); }
1020 class StringSDNode : public SDNode {
1023 friend class SelectionDAG;
1024 StringSDNode(const std::string &val)
1025 : SDNode(ISD::STRING, MVT::Other), Value(val) {
1028 const std::string &getValue() const { return Value; }
1029 static bool classof(const StringSDNode *) { return true; }
1030 static bool classof(const SDNode *N) {
1031 return N->getOpcode() == ISD::STRING;
1035 class ConstantSDNode : public SDNode {
1038 friend class SelectionDAG;
1039 ConstantSDNode(bool isTarget, uint64_t val, MVT::ValueType VT)
1040 : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant, VT), Value(val) {
1044 uint64_t getValue() const { return Value; }
1046 int64_t getSignExtended() const {
1047 unsigned Bits = MVT::getSizeInBits(getValueType(0));
1048 return ((int64_t)Value << (64-Bits)) >> (64-Bits);
1051 bool isNullValue() const { return Value == 0; }
1052 bool isAllOnesValue() const {
1053 return Value == MVT::getIntVTBitMask(getValueType(0));
1056 static bool classof(const ConstantSDNode *) { return true; }
1057 static bool classof(const SDNode *N) {
1058 return N->getOpcode() == ISD::Constant ||
1059 N->getOpcode() == ISD::TargetConstant;
1063 class ConstantFPSDNode : public SDNode {
1066 friend class SelectionDAG;
1067 ConstantFPSDNode(bool isTarget, double val, MVT::ValueType VT)
1068 : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP, VT),
1073 double getValue() const { return Value; }
1075 /// isExactlyValue - We don't rely on operator== working on double values, as
1076 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1077 /// As such, this method can be used to do an exact bit-for-bit comparison of
1078 /// two floating point values.
1079 bool isExactlyValue(double V) const;
1081 static bool classof(const ConstantFPSDNode *) { return true; }
1082 static bool classof(const SDNode *N) {
1083 return N->getOpcode() == ISD::ConstantFP ||
1084 N->getOpcode() == ISD::TargetConstantFP;
1088 class GlobalAddressSDNode : public SDNode {
1089 GlobalValue *TheGlobal;
1092 friend class SelectionDAG;
1093 GlobalAddressSDNode(bool isTarget, const GlobalValue *GA, MVT::ValueType VT,
1095 : SDNode(isTarget ? ISD::TargetGlobalAddress : ISD::GlobalAddress, VT),
1097 TheGlobal = const_cast<GlobalValue*>(GA);
1101 GlobalValue *getGlobal() const { return TheGlobal; }
1102 int getOffset() const { return Offset; }
1104 static bool classof(const GlobalAddressSDNode *) { return true; }
1105 static bool classof(const SDNode *N) {
1106 return N->getOpcode() == ISD::GlobalAddress ||
1107 N->getOpcode() == ISD::TargetGlobalAddress;
1112 class FrameIndexSDNode : public SDNode {
1115 friend class SelectionDAG;
1116 FrameIndexSDNode(int fi, MVT::ValueType VT, bool isTarg)
1117 : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex, VT), FI(fi) {}
1120 int getIndex() const { return FI; }
1122 static bool classof(const FrameIndexSDNode *) { return true; }
1123 static bool classof(const SDNode *N) {
1124 return N->getOpcode() == ISD::FrameIndex ||
1125 N->getOpcode() == ISD::TargetFrameIndex;
1129 class JumpTableSDNode : public SDNode {
1132 friend class SelectionDAG;
1133 JumpTableSDNode(int jti, MVT::ValueType VT, bool isTarg)
1134 : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable, VT),
1138 int getIndex() const { return JTI; }
1140 static bool classof(const JumpTableSDNode *) { return true; }
1141 static bool classof(const SDNode *N) {
1142 return N->getOpcode() == ISD::JumpTable ||
1143 N->getOpcode() == ISD::TargetJumpTable;
1147 class ConstantPoolSDNode : public SDNode {
1152 friend class SelectionDAG;
1153 ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT,
1155 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, VT),
1156 C(c), Offset(o), Alignment(0) {}
1157 ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT, int o,
1159 : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, VT),
1160 C(c), Offset(o), Alignment(Align) {}
1163 Constant *get() const { return C; }
1164 int getOffset() const { return Offset; }
1166 // Return the alignment of this constant pool object, which is either 0 (for
1167 // default alignment) or log2 of the desired value.
1168 unsigned getAlignment() const { return Alignment; }
1170 static bool classof(const ConstantPoolSDNode *) { return true; }
1171 static bool classof(const SDNode *N) {
1172 return N->getOpcode() == ISD::ConstantPool ||
1173 N->getOpcode() == ISD::TargetConstantPool;
1177 class BasicBlockSDNode : public SDNode {
1178 MachineBasicBlock *MBB;
1180 friend class SelectionDAG;
1181 BasicBlockSDNode(MachineBasicBlock *mbb)
1182 : SDNode(ISD::BasicBlock, MVT::Other), MBB(mbb) {}
1185 MachineBasicBlock *getBasicBlock() const { return MBB; }
1187 static bool classof(const BasicBlockSDNode *) { return true; }
1188 static bool classof(const SDNode *N) {
1189 return N->getOpcode() == ISD::BasicBlock;
1193 class SrcValueSDNode : public SDNode {
1197 friend class SelectionDAG;
1198 SrcValueSDNode(const Value* v, int o)
1199 : SDNode(ISD::SRCVALUE, MVT::Other), V(v), offset(o) {}
1202 const Value *getValue() const { return V; }
1203 int getOffset() const { return offset; }
1205 static bool classof(const SrcValueSDNode *) { return true; }
1206 static bool classof(const SDNode *N) {
1207 return N->getOpcode() == ISD::SRCVALUE;
1212 class RegisterSDNode : public SDNode {
1215 friend class SelectionDAG;
1216 RegisterSDNode(unsigned reg, MVT::ValueType VT)
1217 : SDNode(ISD::Register, VT), Reg(reg) {}
1220 unsigned getReg() const { return Reg; }
1222 static bool classof(const RegisterSDNode *) { return true; }
1223 static bool classof(const SDNode *N) {
1224 return N->getOpcode() == ISD::Register;
1228 class ExternalSymbolSDNode : public SDNode {
1231 friend class SelectionDAG;
1232 ExternalSymbolSDNode(bool isTarget, const char *Sym, MVT::ValueType VT)
1233 : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol, VT),
1238 const char *getSymbol() const { return Symbol; }
1240 static bool classof(const ExternalSymbolSDNode *) { return true; }
1241 static bool classof(const SDNode *N) {
1242 return N->getOpcode() == ISD::ExternalSymbol ||
1243 N->getOpcode() == ISD::TargetExternalSymbol;
1247 class CondCodeSDNode : public SDNode {
1248 ISD::CondCode Condition;
1250 friend class SelectionDAG;
1251 CondCodeSDNode(ISD::CondCode Cond)
1252 : SDNode(ISD::CONDCODE, MVT::Other), Condition(Cond) {
1256 ISD::CondCode get() const { return Condition; }
1258 static bool classof(const CondCodeSDNode *) { return true; }
1259 static bool classof(const SDNode *N) {
1260 return N->getOpcode() == ISD::CONDCODE;
1264 /// VTSDNode - This class is used to represent MVT::ValueType's, which are used
1265 /// to parameterize some operations.
1266 class VTSDNode : public SDNode {
1267 MVT::ValueType ValueType;
1269 friend class SelectionDAG;
1270 VTSDNode(MVT::ValueType VT)
1271 : SDNode(ISD::VALUETYPE, MVT::Other), ValueType(VT) {}
1274 MVT::ValueType getVT() const { return ValueType; }
1276 static bool classof(const VTSDNode *) { return true; }
1277 static bool classof(const SDNode *N) {
1278 return N->getOpcode() == ISD::VALUETYPE;
1283 class SDNodeIterator : public forward_iterator<SDNode, ptrdiff_t> {
1287 SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1289 bool operator==(const SDNodeIterator& x) const {
1290 return Operand == x.Operand;
1292 bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1294 const SDNodeIterator &operator=(const SDNodeIterator &I) {
1295 assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1296 Operand = I.Operand;
1300 pointer operator*() const {
1301 return Node->getOperand(Operand).Val;
1303 pointer operator->() const { return operator*(); }
1305 SDNodeIterator& operator++() { // Preincrement
1309 SDNodeIterator operator++(int) { // Postincrement
1310 SDNodeIterator tmp = *this; ++*this; return tmp;
1313 static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
1314 static SDNodeIterator end (SDNode *N) {
1315 return SDNodeIterator(N, N->getNumOperands());
1318 unsigned getOperand() const { return Operand; }
1319 const SDNode *getNode() const { return Node; }
1322 template <> struct GraphTraits<SDNode*> {
1323 typedef SDNode NodeType;
1324 typedef SDNodeIterator ChildIteratorType;
1325 static inline NodeType *getEntryNode(SDNode *N) { return N; }
1326 static inline ChildIteratorType child_begin(NodeType *N) {
1327 return SDNodeIterator::begin(N);
1329 static inline ChildIteratorType child_end(NodeType *N) {
1330 return SDNodeIterator::end(N);
1335 struct ilist_traits<SDNode> {
1336 static SDNode *getPrev(const SDNode *N) { return N->Prev; }
1337 static SDNode *getNext(const SDNode *N) { return N->Next; }
1339 static void setPrev(SDNode *N, SDNode *Prev) { N->Prev = Prev; }
1340 static void setNext(SDNode *N, SDNode *Next) { N->Next = Next; }
1342 static SDNode *createSentinel() {
1343 return new SDNode(ISD::EntryToken, MVT::Other);
1345 static void destroySentinel(SDNode *N) { delete N; }
1346 //static SDNode *createNode(const SDNode &V) { return new SDNode(V); }
1349 void addNodeToList(SDNode *NTy) {}
1350 void removeNodeFromList(SDNode *NTy) {}
1351 void transferNodesFromList(iplist<SDNode, ilist_traits> &L2,
1352 const ilist_iterator<SDNode> &X,
1353 const ilist_iterator<SDNode> &Y) {}
1356 } // end llvm namespace