SelectionDAGNodes.h revision f7331b3dd72409e644833ecaf62a0f6db03c97ee
1//===-- llvm/CodeGen/SelectionDAGNodes.h - SelectionDAG Nodes ---*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
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.
7//
8//===----------------------------------------------------------------------===//
9//
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.
14//
15// Clients should include the SelectionDAG.h file instead of this file directly.
16//
17//===----------------------------------------------------------------------===//
18
19#ifndef LLVM_CODEGEN_SELECTIONDAGNODES_H
20#define LLVM_CODEGEN_SELECTIONDAGNODES_H
21
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/Support/DataTypes.h"
29#include <cassert>
30
31namespace llvm {
32
33class SelectionDAG;
34class GlobalValue;
35class MachineBasicBlock;
36class MachineConstantPoolValue;
37class SDNode;
38template <typename T> struct DenseMapKeyInfo;
39template <typename T> struct simplify_type;
40template <typename T> struct ilist_traits;
41template<typename NodeTy, typename Traits> class iplist;
42template<typename NodeTy> class ilist_iterator;
43
44/// SDVTList - This represents a list of ValueType's that has been intern'd by
45/// a SelectionDAG.  Instances of this simple value class are returned by
46/// SelectionDAG::getVTList(...).
47///
48struct SDVTList {
49  const MVT::ValueType *VTs;
50  unsigned short NumVTs;
51};
52
53/// ISD namespace - This namespace contains an enum which represents all of the
54/// SelectionDAG node types and value types.
55///
56namespace ISD {
57  namespace ParamFlags {
58  enum Flags {
59    NoFlagSet         = 0,
60    ZExt              = 1<<0,  ///< Parameter should be zero extended
61    ZExtOffs          = 0,
62    SExt              = 1<<1,  ///< Parameter should be sign extended
63    SExtOffs          = 1,
64    InReg             = 1<<2,  ///< Parameter should be passed in register
65    InRegOffs         = 2,
66    StructReturn      = 1<<3,  ///< Hidden struct-return pointer
67    StructReturnOffs  = 3,
68    ByVal             = 1<<4,  ///< Struct passed by value
69    ByValOffs         = 4,
70    Nest              = 1<<5,  ///< Parameter is nested function static chain
71    NestOffs          = 5,
72    ByValAlign        = 0xF << 6, //< The alignment of the struct
73    ByValAlignOffs    = 6,
74    ByValSize         = 0x1ffff << 10, //< The size of the struct
75    ByValSizeOffs     = 10,
76    OrigAlignment     = 0x1F<<27,
77    OrigAlignmentOffs = 27
78  };
79  }
80
81  //===--------------------------------------------------------------------===//
82  /// ISD::NodeType enum - This enum defines all of the operators valid in a
83  /// SelectionDAG.
84  ///
85  enum NodeType {
86    // DELETED_NODE - This is an illegal flag value that is used to catch
87    // errors.  This opcode is not a legal opcode for any node.
88    DELETED_NODE,
89
90    // EntryToken - This is the marker used to indicate the start of the region.
91    EntryToken,
92
93    // Token factor - This node takes multiple tokens as input and produces a
94    // single token result.  This is used to represent the fact that the operand
95    // operators are independent of each other.
96    TokenFactor,
97
98    // AssertSext, AssertZext - These nodes record if a register contains a
99    // value that has already been zero or sign extended from a narrower type.
100    // These nodes take two operands.  The first is the node that has already
101    // been extended, and the second is a value type node indicating the width
102    // of the extension
103    AssertSext, AssertZext,
104
105    // Various leaf nodes.
106    STRING, BasicBlock, VALUETYPE, CONDCODE, Register,
107    Constant, ConstantFP,
108    GlobalAddress, GlobalTLSAddress, FrameIndex,
109    JumpTable, ConstantPool, ExternalSymbol,
110
111    // The address of the GOT
112    GLOBAL_OFFSET_TABLE,
113
114    // FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
115    // llvm.returnaddress on the DAG.  These nodes take one operand, the index
116    // of the frame or return address to return.  An index of zero corresponds
117    // to the current function's frame or return address, an index of one to the
118    // parent's frame or return address, and so on.
119    FRAMEADDR, RETURNADDR,
120
121    // FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
122    // first (possible) on-stack argument. This is needed for correct stack
123    // adjustment during unwind.
124    FRAME_TO_ARGS_OFFSET,
125
126    // RESULT, OUTCHAIN = EXCEPTIONADDR(INCHAIN) - This node represents the
127    // address of the exception block on entry to an landing pad block.
128    EXCEPTIONADDR,
129
130    // RESULT, OUTCHAIN = EHSELECTION(INCHAIN, EXCEPTION) - This node represents
131    // the selection index of the exception thrown.
132    EHSELECTION,
133
134    // OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
135    // 'eh_return' gcc dwarf builtin, which is used to return from
136    // exception. The general meaning is: adjust stack by OFFSET and pass
137    // execution to HANDLER. Many platform-related details also :)
138    EH_RETURN,
139
140    // TargetConstant* - Like Constant*, but the DAG does not do any folding or
141    // simplification of the constant.
142    TargetConstant,
143    TargetConstantFP,
144
145    // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
146    // anything else with this node, and this is valid in the target-specific
147    // dag, turning into a GlobalAddress operand.
148    TargetGlobalAddress,
149    TargetGlobalTLSAddress,
150    TargetFrameIndex,
151    TargetJumpTable,
152    TargetConstantPool,
153    TargetExternalSymbol,
154
155    /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
156    /// This node represents a target intrinsic function with no side effects.
157    /// The first operand is the ID number of the intrinsic from the
158    /// llvm::Intrinsic namespace.  The operands to the intrinsic follow.  The
159    /// node has returns the result of the intrinsic.
160    INTRINSIC_WO_CHAIN,
161
162    /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
163    /// This node represents a target intrinsic function with side effects that
164    /// returns a result.  The first operand is a chain pointer.  The second is
165    /// the ID number of the intrinsic from the llvm::Intrinsic namespace.  The
166    /// operands to the intrinsic follow.  The node has two results, the result
167    /// of the intrinsic and an output chain.
168    INTRINSIC_W_CHAIN,
169
170    /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
171    /// This node represents a target intrinsic function with side effects that
172    /// does not return a result.  The first operand is a chain pointer.  The
173    /// second is the ID number of the intrinsic from the llvm::Intrinsic
174    /// namespace.  The operands to the intrinsic follow.
175    INTRINSIC_VOID,
176
177    // CopyToReg - This node has three operands: a chain, a register number to
178    // set to this value, and a value.
179    CopyToReg,
180
181    // CopyFromReg - This node indicates that the input value is a virtual or
182    // physical register that is defined outside of the scope of this
183    // SelectionDAG.  The register is available from the RegSDNode object.
184    CopyFromReg,
185
186    // UNDEF - An undefined node
187    UNDEF,
188
189    /// FORMAL_ARGUMENTS(CHAIN, CC#, ISVARARG, FLAG0, ..., FLAGn) - This node
190    /// represents the formal arguments for a function.  CC# is a Constant value
191    /// indicating the calling convention of the function, and ISVARARG is a
192    /// flag that indicates whether the function is varargs or not. This node
193    /// has one result value for each incoming argument, plus one for the output
194    /// chain. It must be custom legalized. See description of CALL node for
195    /// FLAG argument contents explanation.
196    ///
197    FORMAL_ARGUMENTS,
198
199    /// RV1, RV2...RVn, CHAIN = CALL(CHAIN, CC#, ISVARARG, ISTAILCALL, CALLEE,
200    ///                              ARG0, FLAG0, ARG1, FLAG1, ... ARGn, FLAGn)
201    /// This node represents a fully general function call, before the legalizer
202    /// runs.  This has one result value for each argument / flag pair, plus
203    /// a chain result. It must be custom legalized. Flag argument indicates
204    /// misc. argument attributes. Currently:
205    /// Bit 0 - signness
206    /// Bit 1 - 'inreg' attribute
207    /// Bit 2 - 'sret' attribute
208    /// Bit 4 - 'byval' attribute
209    /// Bit 5 - 'nest' attribute
210    /// Bit 6-9 - alignment of byval structures
211    /// Bit 10-26 - size of byval structures
212    /// Bits 31:27 - argument ABI alignment in the first argument piece and
213    /// alignment '1' in other argument pieces.
214    CALL,
215
216    // EXTRACT_ELEMENT - This is used to get the first or second (determined by
217    // a Constant, which is required to be operand #1), element of the aggregate
218    // value specified as operand #0.  This is only for use before legalization,
219    // for values that will be broken into multiple registers.
220    EXTRACT_ELEMENT,
221
222    // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways.  Given
223    // two values of the same integer value type, this produces a value twice as
224    // big.  Like EXTRACT_ELEMENT, this can only be used before legalization.
225    BUILD_PAIR,
226
227    // MERGE_VALUES - This node takes multiple discrete operands and returns
228    // them all as its individual results.  This nodes has exactly the same
229    // number of inputs and outputs, and is only valid before legalization.
230    // This node is useful for some pieces of the code generator that want to
231    // think about a single node with multiple results, not multiple nodes.
232    MERGE_VALUES,
233
234    // Simple integer binary arithmetic operators.
235    ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
236
237    // CARRY_FALSE - This node is used when folding other nodes,
238    // like ADDC/SUBC, which indicate the carry result is always false.
239    CARRY_FALSE,
240
241    // Carry-setting nodes for multiple precision addition and subtraction.
242    // These nodes take two operands of the same value type, and produce two
243    // results.  The first result is the normal add or sub result, the second
244    // result is the carry flag result.
245    ADDC, SUBC,
246
247    // Carry-using nodes for multiple precision addition and subtraction.  These
248    // nodes take three operands: The first two are the normal lhs and rhs to
249    // the add or sub, and the third is the input carry flag.  These nodes
250    // produce two results; the normal result of the add or sub, and the output
251    // carry flag.  These nodes both read and write a carry flag to allow them
252    // to them to be chained together for add and sub of arbitrarily large
253    // values.
254    ADDE, SUBE,
255
256    // Simple binary floating point operators.
257    FADD, FSUB, FMUL, FDIV, FREM,
258
259    // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y.  NOTE: This
260    // DAG node does not require that X and Y have the same type, just that they
261    // are both floating point.  X and the result must have the same type.
262    // FCOPYSIGN(f32, f64) is allowed.
263    FCOPYSIGN,
264
265    /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector
266    /// with the specified, possibly variable, elements.  The number of elements
267    /// is required to be a power of two.
268    BUILD_VECTOR,
269
270    /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR with the element
271    /// at IDX replaced with VAL.
272    INSERT_VECTOR_ELT,
273
274    /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
275    /// identified by the (potentially variable) element number IDX.
276    EXTRACT_VECTOR_ELT,
277
278    /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
279    /// vector type with the same length and element type, this produces a
280    /// concatenated vector result value, with length equal to the sum of the
281    /// lengths of the input vectors.
282    CONCAT_VECTORS,
283
284    /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
285    /// vector value) starting with the (potentially variable) element number
286    /// IDX, which must be a multiple of the result vector length.
287    EXTRACT_SUBVECTOR,
288
289    /// VECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC) - Returns a vector, of the same
290    /// type as VEC1/VEC2.  SHUFFLEVEC is a BUILD_VECTOR of constant int values
291    /// (regardless of whether its datatype is legal or not) that indicate
292    /// which value each result element will get.  The elements of VEC1/VEC2 are
293    /// enumerated in order.  This is quite similar to the Altivec 'vperm'
294    /// instruction, except that the indices must be constants and are in terms
295    /// of the element size of VEC1/VEC2, not in terms of bytes.
296    VECTOR_SHUFFLE,
297
298    /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
299    /// scalar value into the low element of the resultant vector type.  The top
300    /// elements of the vector are undefined.
301    SCALAR_TO_VECTOR,
302
303    // EXTRACT_SUBREG - This node is used to extract a sub-register value.
304    // This node takes a superreg and a constant sub-register index as operands.
305    EXTRACT_SUBREG,
306
307    // INSERT_SUBREG - This node is used to insert a sub-register value.
308    // This node takes a superreg, a subreg value, and a constant sub-register
309    // index as operands.
310    INSERT_SUBREG,
311
312    // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
313    // an unsigned/signed value of type i[2*n], then return the top part.
314    MULHU, MULHS,
315
316    // Bitwise operators - logical and, logical or, logical xor, shift left,
317    // shift right algebraic (shift in sign bits), shift right logical (shift in
318    // zeroes), rotate left, rotate right, and byteswap.
319    AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
320
321    // Counting operators
322    CTTZ, CTLZ, CTPOP,
323
324    // Select(COND, TRUEVAL, FALSEVAL)
325    SELECT,
326
327    // Select with condition operator - This selects between a true value and
328    // a false value (ops #2 and #3) based on the boolean result of comparing
329    // the lhs and rhs (ops #0 and #1) of a conditional expression with the
330    // condition code in op #4, a CondCodeSDNode.
331    SELECT_CC,
332
333    // SetCC operator - This evaluates to a boolean (i1) true value if the
334    // condition is true.  The operands to this are the left and right operands
335    // to compare (ops #0, and #1) and the condition code to compare them with
336    // (op #2) as a CondCodeSDNode.
337    SETCC,
338
339    // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
340    // integer shift operations, just like ADD/SUB_PARTS.  The operation
341    // ordering is:
342    //       [Lo,Hi] = op [LoLHS,HiLHS], Amt
343    SHL_PARTS, SRA_PARTS, SRL_PARTS,
344
345    // Conversion operators.  These are all single input single output
346    // operations.  For all of these, the result type must be strictly
347    // wider or narrower (depending on the operation) than the source
348    // type.
349
350    // SIGN_EXTEND - Used for integer types, replicating the sign bit
351    // into new bits.
352    SIGN_EXTEND,
353
354    // ZERO_EXTEND - Used for integer types, zeroing the new bits.
355    ZERO_EXTEND,
356
357    // ANY_EXTEND - Used for integer types.  The high bits are undefined.
358    ANY_EXTEND,
359
360    // TRUNCATE - Completely drop the high bits.
361    TRUNCATE,
362
363    // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
364    // depends on the first letter) to floating point.
365    SINT_TO_FP,
366    UINT_TO_FP,
367
368    // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
369    // sign extend a small value in a large integer register (e.g. sign
370    // extending the low 8 bits of a 32-bit register to fill the top 24 bits
371    // with the 7th bit).  The size of the smaller type is indicated by the 1th
372    // operand, a ValueType node.
373    SIGN_EXTEND_INREG,
374
375    // FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
376    // integer.
377    FP_TO_SINT,
378    FP_TO_UINT,
379
380    // FP_ROUND - Perform a rounding operation from the current
381    // precision down to the specified precision (currently always 64->32).
382    FP_ROUND,
383
384    // FP_ROUND_INREG - This operator takes a floating point register, and
385    // rounds it to a floating point value.  It then promotes it and returns it
386    // in a register of the same size.  This operation effectively just discards
387    // excess precision.  The type to round down to is specified by the 1th
388    // operation, a VTSDNode (currently always 64->32->64).
389    FP_ROUND_INREG,
390
391    // FP_EXTEND - Extend a smaller FP type into a larger FP type.
392    FP_EXTEND,
393
394    // BIT_CONVERT - Theis operator converts between integer and FP values, as
395    // if one was stored to memory as integer and the other was loaded from the
396    // same address (or equivalently for vector format conversions, etc).  The
397    // source and result are required to have the same bit size (e.g.
398    // f32 <-> i32).  This can also be used for int-to-int or fp-to-fp
399    // conversions, but that is a noop, deleted by getNode().
400    BIT_CONVERT,
401
402    // FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI - Perform unary floating point
403    // negation, absolute value, square root, sine and cosine, and powi
404    // operations.
405    FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI,
406
407    // LOAD and STORE have token chains as their first operand, then the same
408    // operands as an LLVM load/store instruction, then an offset node that
409    // is added / subtracted from the base pointer to form the address (for
410    // indexed memory ops).
411    LOAD, STORE,
412
413    // TRUNCSTORE - This operators truncates (for integer) or rounds (for FP) a
414    // value and stores it to memory in one operation.  This can be used for
415    // either integer or floating point operands.  The first four operands of
416    // this are the same as a standard store.  The fifth is the ValueType to
417    // store it as (which will be smaller than the source value).
418    TRUNCSTORE,
419
420    // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
421    // to a specified boundary.  This node always has two return values: a new
422    // stack pointer value and a chain. The first operand is the token chain,
423    // the second is the number of bytes to allocate, and the third is the
424    // alignment boundary.  The size is guaranteed to be a multiple of the stack
425    // alignment, and the alignment is guaranteed to be bigger than the stack
426    // alignment (if required) or 0 to get standard stack alignment.
427    DYNAMIC_STACKALLOC,
428
429    // Control flow instructions.  These all have token chains.
430
431    // BR - Unconditional branch.  The first operand is the chain
432    // operand, the second is the MBB to branch to.
433    BR,
434
435    // BRIND - Indirect branch.  The first operand is the chain, the second
436    // is the value to branch to, which must be of the same type as the target's
437    // pointer type.
438    BRIND,
439
440    // BR_JT - Jumptable branch. The first operand is the chain, the second
441    // is the jumptable index, the last one is the jumptable entry index.
442    BR_JT,
443
444    // BRCOND - Conditional branch.  The first operand is the chain,
445    // the second is the condition, the third is the block to branch
446    // to if the condition is true.
447    BRCOND,
448
449    // BR_CC - Conditional branch.  The behavior is like that of SELECT_CC, in
450    // that the condition is represented as condition code, and two nodes to
451    // compare, rather than as a combined SetCC node.  The operands in order are
452    // chain, cc, lhs, rhs, block to branch to if condition is true.
453    BR_CC,
454
455    // RET - Return from function.  The first operand is the chain,
456    // and any subsequent operands are pairs of return value and return value
457    // signness for the function.  This operation can have variable number of
458    // operands.
459    RET,
460
461    // INLINEASM - Represents an inline asm block.  This node always has two
462    // return values: a chain and a flag result.  The inputs are as follows:
463    //   Operand #0   : Input chain.
464    //   Operand #1   : a ExternalSymbolSDNode with a pointer to the asm string.
465    //   Operand #2n+2: A RegisterNode.
466    //   Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
467    //   Operand #last: Optional, an incoming flag.
468    INLINEASM,
469
470    // LABEL - Represents a label in mid basic block used to track
471    // locations needed for debug and exception handling tables.  This node
472    // returns a chain.
473    //   Operand #0 : input chain.
474    //   Operand #1 : module unique number use to identify the label.
475    LABEL,
476
477    // STACKSAVE - STACKSAVE has one operand, an input chain.  It produces a
478    // value, the same type as the pointer type for the system, and an output
479    // chain.
480    STACKSAVE,
481
482    // STACKRESTORE has two operands, an input chain and a pointer to restore to
483    // it returns an output chain.
484    STACKRESTORE,
485
486    // MEMSET/MEMCPY/MEMMOVE - The first operand is the chain, and the rest
487    // correspond to the operands of the LLVM intrinsic functions.  The only
488    // result is a token chain.  The alignment argument is guaranteed to be a
489    // Constant node.
490    MEMSET,
491    MEMMOVE,
492    MEMCPY,
493
494    // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
495    // a call sequence, and carry arbitrary information that target might want
496    // to know.  The first operand is a chain, the rest are specified by the
497    // target and not touched by the DAG optimizers.
498    CALLSEQ_START,  // Beginning of a call sequence
499    CALLSEQ_END,    // End of a call sequence
500
501    // VAARG - VAARG has three operands: an input chain, a pointer, and a
502    // SRCVALUE.  It returns a pair of values: the vaarg value and a new chain.
503    VAARG,
504
505    // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
506    // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
507    // source.
508    VACOPY,
509
510    // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
511    // pointer, and a SRCVALUE.
512    VAEND, VASTART,
513
514    // SRCVALUE - This corresponds to a Value*, and is used to associate memory
515    // locations with their value.  This allows one use alias analysis
516    // information in the backend.
517    SRCVALUE,
518
519    // PCMARKER - This corresponds to the pcmarker intrinsic.
520    PCMARKER,
521
522    // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
523    // The only operand is a chain and a value and a chain are produced.  The
524    // value is the contents of the architecture specific cycle counter like
525    // register (or other high accuracy low latency clock source)
526    READCYCLECOUNTER,
527
528    // HANDLENODE node - Used as a handle for various purposes.
529    HANDLENODE,
530
531    // LOCATION - This node is used to represent a source location for debug
532    // info.  It takes token chain as input, then a line number, then a column
533    // number, then a filename, then a working dir.  It produces a token chain
534    // as output.
535    LOCATION,
536
537    // DEBUG_LOC - This node is used to represent source line information
538    // embedded in the code.  It takes a token chain as input, then a line
539    // number, then a column then a file id (provided by MachineModuleInfo.) It
540    // produces a token chain as output.
541    DEBUG_LOC,
542
543    // TRAMPOLINE - This corresponds to the init_trampoline intrinsic.
544    // It takes as input a token chain, the pointer to the trampoline,
545    // the pointer to the nested function, the pointer to pass for the
546    // 'nest' parameter, a SRCVALUE for the trampoline and another for
547    // the nested function (allowing targets to access the original
548    // Function*).  It produces the result of the intrinsic and a token
549    // chain as output.
550    TRAMPOLINE,
551
552    // BUILTIN_OP_END - This must be the last enum value in this list.
553    BUILTIN_OP_END
554  };
555
556  /// Node predicates
557
558  /// isBuildVectorAllOnes - Return true if the specified node is a
559  /// BUILD_VECTOR where all of the elements are ~0 or undef.
560  bool isBuildVectorAllOnes(const SDNode *N);
561
562  /// isBuildVectorAllZeros - Return true if the specified node is a
563  /// BUILD_VECTOR where all of the elements are 0 or undef.
564  bool isBuildVectorAllZeros(const SDNode *N);
565
566  //===--------------------------------------------------------------------===//
567  /// MemIndexedMode enum - This enum defines the load / store indexed
568  /// addressing modes.
569  ///
570  /// UNINDEXED    "Normal" load / store. The effective address is already
571  ///              computed and is available in the base pointer. The offset
572  ///              operand is always undefined. In addition to producing a
573  ///              chain, an unindexed load produces one value (result of the
574  ///              load); an unindexed store does not produces a value.
575  ///
576  /// PRE_INC      Similar to the unindexed mode where the effective address is
577  /// PRE_DEC      the value of the base pointer add / subtract the offset.
578  ///              It considers the computation as being folded into the load /
579  ///              store operation (i.e. the load / store does the address
580  ///              computation as well as performing the memory transaction).
581  ///              The base operand is always undefined. In addition to
582  ///              producing a chain, pre-indexed load produces two values
583  ///              (result of the load and the result of the address
584  ///              computation); a pre-indexed store produces one value (result
585  ///              of the address computation).
586  ///
587  /// POST_INC     The effective address is the value of the base pointer. The
588  /// POST_DEC     value of the offset operand is then added to / subtracted
589  ///              from the base after memory transaction. In addition to
590  ///              producing a chain, post-indexed load produces two values
591  ///              (the result of the load and the result of the base +/- offset
592  ///              computation); a post-indexed store produces one value (the
593  ///              the result of the base +/- offset computation).
594  ///
595  enum MemIndexedMode {
596    UNINDEXED = 0,
597    PRE_INC,
598    PRE_DEC,
599    POST_INC,
600    POST_DEC,
601    LAST_INDEXED_MODE
602  };
603
604  //===--------------------------------------------------------------------===//
605  /// LoadExtType enum - This enum defines the three variants of LOADEXT
606  /// (load with extension).
607  ///
608  /// SEXTLOAD loads the integer operand and sign extends it to a larger
609  ///          integer result type.
610  /// ZEXTLOAD loads the integer operand and zero extends it to a larger
611  ///          integer result type.
612  /// EXTLOAD  is used for three things: floating point extending loads,
613  ///          integer extending loads [the top bits are undefined], and vector
614  ///          extending loads [load into low elt].
615  ///
616  enum LoadExtType {
617    NON_EXTLOAD = 0,
618    EXTLOAD,
619    SEXTLOAD,
620    ZEXTLOAD,
621    LAST_LOADX_TYPE
622  };
623
624  //===--------------------------------------------------------------------===//
625  /// ISD::CondCode enum - These are ordered carefully to make the bitfields
626  /// below work out, when considering SETFALSE (something that never exists
627  /// dynamically) as 0.  "U" -> Unsigned (for integer operands) or Unordered
628  /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
629  /// to.  If the "N" column is 1, the result of the comparison is undefined if
630  /// the input is a NAN.
631  ///
632  /// All of these (except for the 'always folded ops') should be handled for
633  /// floating point.  For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
634  /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
635  ///
636  /// Note that these are laid out in a specific order to allow bit-twiddling
637  /// to transform conditions.
638  enum CondCode {
639    // Opcode          N U L G E       Intuitive operation
640    SETFALSE,      //    0 0 0 0       Always false (always folded)
641    SETOEQ,        //    0 0 0 1       True if ordered and equal
642    SETOGT,        //    0 0 1 0       True if ordered and greater than
643    SETOGE,        //    0 0 1 1       True if ordered and greater than or equal
644    SETOLT,        //    0 1 0 0       True if ordered and less than
645    SETOLE,        //    0 1 0 1       True if ordered and less than or equal
646    SETONE,        //    0 1 1 0       True if ordered and operands are unequal
647    SETO,          //    0 1 1 1       True if ordered (no nans)
648    SETUO,         //    1 0 0 0       True if unordered: isnan(X) | isnan(Y)
649    SETUEQ,        //    1 0 0 1       True if unordered or equal
650    SETUGT,        //    1 0 1 0       True if unordered or greater than
651    SETUGE,        //    1 0 1 1       True if unordered, greater than, or equal
652    SETULT,        //    1 1 0 0       True if unordered or less than
653    SETULE,        //    1 1 0 1       True if unordered, less than, or equal
654    SETUNE,        //    1 1 1 0       True if unordered or not equal
655    SETTRUE,       //    1 1 1 1       Always true (always folded)
656    // Don't care operations: undefined if the input is a nan.
657    SETFALSE2,     //  1 X 0 0 0       Always false (always folded)
658    SETEQ,         //  1 X 0 0 1       True if equal
659    SETGT,         //  1 X 0 1 0       True if greater than
660    SETGE,         //  1 X 0 1 1       True if greater than or equal
661    SETLT,         //  1 X 1 0 0       True if less than
662    SETLE,         //  1 X 1 0 1       True if less than or equal
663    SETNE,         //  1 X 1 1 0       True if not equal
664    SETTRUE2,      //  1 X 1 1 1       Always true (always folded)
665
666    SETCC_INVALID       // Marker value.
667  };
668
669  /// isSignedIntSetCC - Return true if this is a setcc instruction that
670  /// performs a signed comparison when used with integer operands.
671  inline bool isSignedIntSetCC(CondCode Code) {
672    return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
673  }
674
675  /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
676  /// performs an unsigned comparison when used with integer operands.
677  inline bool isUnsignedIntSetCC(CondCode Code) {
678    return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
679  }
680
681  /// isTrueWhenEqual - Return true if the specified condition returns true if
682  /// the two operands to the condition are equal.  Note that if one of the two
683  /// operands is a NaN, this value is meaningless.
684  inline bool isTrueWhenEqual(CondCode Cond) {
685    return ((int)Cond & 1) != 0;
686  }
687
688  /// getUnorderedFlavor - This function returns 0 if the condition is always
689  /// false if an operand is a NaN, 1 if the condition is always true if the
690  /// operand is a NaN, and 2 if the condition is undefined if the operand is a
691  /// NaN.
692  inline unsigned getUnorderedFlavor(CondCode Cond) {
693    return ((int)Cond >> 3) & 3;
694  }
695
696  /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
697  /// 'op' is a valid SetCC operation.
698  CondCode getSetCCInverse(CondCode Operation, bool isInteger);
699
700  /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
701  /// when given the operation for (X op Y).
702  CondCode getSetCCSwappedOperands(CondCode Operation);
703
704  /// getSetCCOrOperation - Return the result of a logical OR between different
705  /// comparisons of identical values: ((X op1 Y) | (X op2 Y)).  This
706  /// function returns SETCC_INVALID if it is not possible to represent the
707  /// resultant comparison.
708  CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
709
710  /// getSetCCAndOperation - Return the result of a logical AND between
711  /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)).  This
712  /// function returns SETCC_INVALID if it is not possible to represent the
713  /// resultant comparison.
714  CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
715}  // end llvm::ISD namespace
716
717
718//===----------------------------------------------------------------------===//
719/// SDOperand - Unlike LLVM values, Selection DAG nodes may return multiple
720/// values as the result of a computation.  Many nodes return multiple values,
721/// from loads (which define a token and a return value) to ADDC (which returns
722/// a result and a carry value), to calls (which may return an arbitrary number
723/// of values).
724///
725/// As such, each use of a SelectionDAG computation must indicate the node that
726/// computes it as well as which return value to use from that node.  This pair
727/// of information is represented with the SDOperand value type.
728///
729class SDOperand {
730public:
731  SDNode *Val;        // The node defining the value we are using.
732  unsigned ResNo;     // Which return value of the node we are using.
733
734  SDOperand() : Val(0), ResNo(0) {}
735  SDOperand(SDNode *val, unsigned resno) : Val(val), ResNo(resno) {}
736
737  bool operator==(const SDOperand &O) const {
738    return Val == O.Val && ResNo == O.ResNo;
739  }
740  bool operator!=(const SDOperand &O) const {
741    return !operator==(O);
742  }
743  bool operator<(const SDOperand &O) const {
744    return Val < O.Val || (Val == O.Val && ResNo < O.ResNo);
745  }
746
747  SDOperand getValue(unsigned R) const {
748    return SDOperand(Val, R);
749  }
750
751  // isOperand - Return true if this node is an operand of N.
752  bool isOperand(SDNode *N) const;
753
754  /// getValueType - Return the ValueType of the referenced return value.
755  ///
756  inline MVT::ValueType getValueType() const;
757
758  // Forwarding methods - These forward to the corresponding methods in SDNode.
759  inline unsigned getOpcode() const;
760  inline unsigned getNumOperands() const;
761  inline const SDOperand &getOperand(unsigned i) const;
762  inline uint64_t getConstantOperandVal(unsigned i) const;
763  inline bool isTargetOpcode() const;
764  inline unsigned getTargetOpcode() const;
765
766  /// hasOneUse - Return true if there is exactly one operation using this
767  /// result value of the defining operator.
768  inline bool hasOneUse() const;
769};
770
771
772template<> struct DenseMapKeyInfo<SDOperand> {
773  static inline SDOperand getEmptyKey() { return SDOperand((SDNode*)-1, -1U); }
774  static inline SDOperand getTombstoneKey() { return SDOperand((SDNode*)-1, 0);}
775  static unsigned getHashValue(const SDOperand &Val) {
776    return (unsigned)((uintptr_t)Val.Val >> 4) ^
777           (unsigned)((uintptr_t)Val.Val >> 9) + Val.ResNo;
778  }
779  static bool isPod() { return true; }
780};
781
782/// simplify_type specializations - Allow casting operators to work directly on
783/// SDOperands as if they were SDNode*'s.
784template<> struct simplify_type<SDOperand> {
785  typedef SDNode* SimpleType;
786  static SimpleType getSimplifiedValue(const SDOperand &Val) {
787    return static_cast<SimpleType>(Val.Val);
788  }
789};
790template<> struct simplify_type<const SDOperand> {
791  typedef SDNode* SimpleType;
792  static SimpleType getSimplifiedValue(const SDOperand &Val) {
793    return static_cast<SimpleType>(Val.Val);
794  }
795};
796
797
798/// SDNode - Represents one node in the SelectionDAG.
799///
800class SDNode : public FoldingSetNode {
801  /// NodeType - The operation that this node performs.
802  ///
803  unsigned short NodeType;
804
805  /// OperandsNeedDelete - This is true if OperandList was new[]'d.  If true,
806  /// then they will be delete[]'d when the node is destroyed.
807  bool OperandsNeedDelete : 1;
808
809  /// NodeId - Unique id per SDNode in the DAG.
810  int NodeId;
811
812  /// OperandList - The values that are used by this operation.
813  ///
814  SDOperand *OperandList;
815
816  /// ValueList - The types of the values this node defines.  SDNode's may
817  /// define multiple values simultaneously.
818  const MVT::ValueType *ValueList;
819
820  /// NumOperands/NumValues - The number of entries in the Operand/Value list.
821  unsigned short NumOperands, NumValues;
822
823  /// Prev/Next pointers - These pointers form the linked list of of the
824  /// AllNodes list in the current DAG.
825  SDNode *Prev, *Next;
826  friend struct ilist_traits<SDNode>;
827
828  /// Uses - These are all of the SDNode's that use a value produced by this
829  /// node.
830  SmallVector<SDNode*,3> Uses;
831
832  // Out-of-line virtual method to give class a home.
833  virtual void ANCHOR();
834public:
835  virtual ~SDNode() {
836    assert(NumOperands == 0 && "Operand list not cleared before deletion");
837    NodeType = ISD::DELETED_NODE;
838  }
839
840  //===--------------------------------------------------------------------===//
841  //  Accessors
842  //
843  unsigned getOpcode()  const { return NodeType; }
844  bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
845  unsigned getTargetOpcode() const {
846    assert(isTargetOpcode() && "Not a target opcode!");
847    return NodeType - ISD::BUILTIN_OP_END;
848  }
849
850  size_t use_size() const { return Uses.size(); }
851  bool use_empty() const { return Uses.empty(); }
852  bool hasOneUse() const { return Uses.size() == 1; }
853
854  /// getNodeId - Return the unique node id.
855  ///
856  int getNodeId() const { return NodeId; }
857
858  typedef SmallVector<SDNode*,3>::const_iterator use_iterator;
859  use_iterator use_begin() const { return Uses.begin(); }
860  use_iterator use_end() const { return Uses.end(); }
861
862  /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
863  /// indicated value.  This method ignores uses of other values defined by this
864  /// operation.
865  bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
866
867  /// hasAnyUseOfValue - Return true if there are any use of the indicated
868  /// value. This method ignores uses of other values defined by this operation.
869  bool hasAnyUseOfValue(unsigned Value) const;
870
871  /// isOnlyUse - Return true if this node is the only use of N.
872  ///
873  bool isOnlyUse(SDNode *N) const;
874
875  /// isOperand - Return true if this node is an operand of N.
876  ///
877  bool isOperand(SDNode *N) const;
878
879  /// isPredecessor - Return true if this node is a predecessor of N. This node
880  /// is either an operand of N or it can be reached by recursively traversing
881  /// up the operands.
882  /// NOTE: this is an expensive method. Use it carefully.
883  bool isPredecessor(SDNode *N) const;
884
885  /// getNumOperands - Return the number of values used by this operation.
886  ///
887  unsigned getNumOperands() const { return NumOperands; }
888
889  /// getConstantOperandVal - Helper method returns the integer value of a
890  /// ConstantSDNode operand.
891  uint64_t getConstantOperandVal(unsigned Num) const;
892
893  const SDOperand &getOperand(unsigned Num) const {
894    assert(Num < NumOperands && "Invalid child # of SDNode!");
895    return OperandList[Num];
896  }
897
898  typedef const SDOperand* op_iterator;
899  op_iterator op_begin() const { return OperandList; }
900  op_iterator op_end() const { return OperandList+NumOperands; }
901
902
903  SDVTList getVTList() const {
904    SDVTList X = { ValueList, NumValues };
905    return X;
906  };
907
908  /// getNumValues - Return the number of values defined/returned by this
909  /// operator.
910  ///
911  unsigned getNumValues() const { return NumValues; }
912
913  /// getValueType - Return the type of a specified result.
914  ///
915  MVT::ValueType getValueType(unsigned ResNo) const {
916    assert(ResNo < NumValues && "Illegal result number!");
917    return ValueList[ResNo];
918  }
919
920  typedef const MVT::ValueType* value_iterator;
921  value_iterator value_begin() const { return ValueList; }
922  value_iterator value_end() const { return ValueList+NumValues; }
923
924  /// getOperationName - Return the opcode of this operation for printing.
925  ///
926  std::string getOperationName(const SelectionDAG *G = 0) const;
927  static const char* getIndexedModeName(ISD::MemIndexedMode AM);
928  void dump() const;
929  void dump(const SelectionDAG *G) const;
930
931  static bool classof(const SDNode *) { return true; }
932
933  /// Profile - Gather unique data for the node.
934  ///
935  void Profile(FoldingSetNodeID &ID);
936
937protected:
938  friend class SelectionDAG;
939
940  /// getValueTypeList - Return a pointer to the specified value type.
941  ///
942  static MVT::ValueType *getValueTypeList(MVT::ValueType VT);
943  static SDVTList getSDVTList(MVT::ValueType VT) {
944    SDVTList Ret = { getValueTypeList(VT), 1 };
945    return Ret;
946  }
947
948  SDNode(unsigned Opc, SDVTList VTs, const SDOperand *Ops, unsigned NumOps)
949    : NodeType(Opc), NodeId(-1) {
950    OperandsNeedDelete = true;
951    NumOperands = NumOps;
952    OperandList = NumOps ? new SDOperand[NumOperands] : 0;
953
954    for (unsigned i = 0; i != NumOps; ++i) {
955      OperandList[i] = Ops[i];
956      Ops[i].Val->Uses.push_back(this);
957    }
958
959    ValueList = VTs.VTs;
960    NumValues = VTs.NumVTs;
961    Prev = 0; Next = 0;
962  }
963  SDNode(unsigned Opc, SDVTList VTs) : NodeType(Opc), NodeId(-1) {
964    OperandsNeedDelete = false;  // Operands set with InitOperands.
965    NumOperands = 0;
966    OperandList = 0;
967
968    ValueList = VTs.VTs;
969    NumValues = VTs.NumVTs;
970    Prev = 0; Next = 0;
971  }
972
973  /// InitOperands - Initialize the operands list of this node with the
974  /// specified values, which are part of the node (thus they don't need to be
975  /// copied in or allocated).
976  void InitOperands(SDOperand *Ops, unsigned NumOps) {
977    assert(OperandList == 0 && "Operands already set!");
978    NumOperands = NumOps;
979    OperandList = Ops;
980
981    for (unsigned i = 0; i != NumOps; ++i)
982      Ops[i].Val->Uses.push_back(this);
983  }
984
985  /// MorphNodeTo - This frees the operands of the current node, resets the
986  /// opcode, types, and operands to the specified value.  This should only be
987  /// used by the SelectionDAG class.
988  void MorphNodeTo(unsigned Opc, SDVTList L,
989                   const SDOperand *Ops, unsigned NumOps);
990
991  void addUser(SDNode *User) {
992    Uses.push_back(User);
993  }
994  void removeUser(SDNode *User) {
995    // Remove this user from the operand's use list.
996    for (unsigned i = Uses.size(); ; --i) {
997      assert(i != 0 && "Didn't find user!");
998      if (Uses[i-1] == User) {
999        Uses[i-1] = Uses.back();
1000        Uses.pop_back();
1001        return;
1002      }
1003    }
1004  }
1005
1006  void setNodeId(int Id) {
1007    NodeId = Id;
1008  }
1009};
1010
1011
1012// Define inline functions from the SDOperand class.
1013
1014inline unsigned SDOperand::getOpcode() const {
1015  return Val->getOpcode();
1016}
1017inline MVT::ValueType SDOperand::getValueType() const {
1018  return Val->getValueType(ResNo);
1019}
1020inline unsigned SDOperand::getNumOperands() const {
1021  return Val->getNumOperands();
1022}
1023inline const SDOperand &SDOperand::getOperand(unsigned i) const {
1024  return Val->getOperand(i);
1025}
1026inline uint64_t SDOperand::getConstantOperandVal(unsigned i) const {
1027  return Val->getConstantOperandVal(i);
1028}
1029inline bool SDOperand::isTargetOpcode() const {
1030  return Val->isTargetOpcode();
1031}
1032inline unsigned SDOperand::getTargetOpcode() const {
1033  return Val->getTargetOpcode();
1034}
1035inline bool SDOperand::hasOneUse() const {
1036  return Val->hasNUsesOfValue(1, ResNo);
1037}
1038
1039/// UnarySDNode - This class is used for single-operand SDNodes.  This is solely
1040/// to allow co-allocation of node operands with the node itself.
1041class UnarySDNode : public SDNode {
1042  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1043  SDOperand Op;
1044public:
1045  UnarySDNode(unsigned Opc, SDVTList VTs, SDOperand X)
1046    : SDNode(Opc, VTs), Op(X) {
1047    InitOperands(&Op, 1);
1048  }
1049};
1050
1051/// BinarySDNode - This class is used for two-operand SDNodes.  This is solely
1052/// to allow co-allocation of node operands with the node itself.
1053class BinarySDNode : public SDNode {
1054  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1055  SDOperand Ops[2];
1056public:
1057  BinarySDNode(unsigned Opc, SDVTList VTs, SDOperand X, SDOperand Y)
1058    : SDNode(Opc, VTs) {
1059    Ops[0] = X;
1060    Ops[1] = Y;
1061    InitOperands(Ops, 2);
1062  }
1063};
1064
1065/// TernarySDNode - This class is used for three-operand SDNodes. This is solely
1066/// to allow co-allocation of node operands with the node itself.
1067class TernarySDNode : public SDNode {
1068  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1069  SDOperand Ops[3];
1070public:
1071  TernarySDNode(unsigned Opc, SDVTList VTs, SDOperand X, SDOperand Y,
1072                SDOperand Z)
1073    : SDNode(Opc, VTs) {
1074    Ops[0] = X;
1075    Ops[1] = Y;
1076    Ops[2] = Z;
1077    InitOperands(Ops, 3);
1078  }
1079};
1080
1081
1082/// HandleSDNode - This class is used to form a handle around another node that
1083/// is persistant and is updated across invocations of replaceAllUsesWith on its
1084/// operand.  This node should be directly created by end-users and not added to
1085/// the AllNodes list.
1086class HandleSDNode : public SDNode {
1087  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1088  SDOperand Op;
1089public:
1090  explicit HandleSDNode(SDOperand X)
1091    : SDNode(ISD::HANDLENODE, getSDVTList(MVT::Other)), Op(X) {
1092    InitOperands(&Op, 1);
1093  }
1094  ~HandleSDNode();
1095  SDOperand getValue() const { return Op; }
1096};
1097
1098class StringSDNode : public SDNode {
1099  std::string Value;
1100  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1101protected:
1102  friend class SelectionDAG;
1103  explicit StringSDNode(const std::string &val)
1104    : SDNode(ISD::STRING, getSDVTList(MVT::Other)), Value(val) {
1105  }
1106public:
1107  const std::string &getValue() const { return Value; }
1108  static bool classof(const StringSDNode *) { return true; }
1109  static bool classof(const SDNode *N) {
1110    return N->getOpcode() == ISD::STRING;
1111  }
1112};
1113
1114class ConstantSDNode : public SDNode {
1115  uint64_t Value;
1116  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1117protected:
1118  friend class SelectionDAG;
1119  ConstantSDNode(bool isTarget, uint64_t val, MVT::ValueType VT)
1120    : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant, getSDVTList(VT)),
1121      Value(val) {
1122  }
1123public:
1124
1125  uint64_t getValue() const { return Value; }
1126
1127  int64_t getSignExtended() const {
1128    unsigned Bits = MVT::getSizeInBits(getValueType(0));
1129    return ((int64_t)Value << (64-Bits)) >> (64-Bits);
1130  }
1131
1132  bool isNullValue() const { return Value == 0; }
1133  bool isAllOnesValue() const {
1134    return Value == MVT::getIntVTBitMask(getValueType(0));
1135  }
1136
1137  static bool classof(const ConstantSDNode *) { return true; }
1138  static bool classof(const SDNode *N) {
1139    return N->getOpcode() == ISD::Constant ||
1140           N->getOpcode() == ISD::TargetConstant;
1141  }
1142};
1143
1144class ConstantFPSDNode : public SDNode {
1145  APFloat Value;
1146  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1147  // Longterm plan: replace all uses of getValue with getValueAPF, remove
1148  // getValue, rename getValueAPF to getValue.
1149protected:
1150  friend class SelectionDAG;
1151  ConstantFPSDNode(bool isTarget, const APFloat& val, MVT::ValueType VT)
1152    : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1153             getSDVTList(VT)), Value(val) {
1154  }
1155public:
1156
1157  const APFloat& getValueAPF() const { return Value; }
1158
1159  /// isExactlyValue - We don't rely on operator== working on double values, as
1160  /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1161  /// As such, this method can be used to do an exact bit-for-bit comparison of
1162  /// two floating point values.
1163
1164  /// We leave the version with the double argument here because it's just so
1165  /// convenient to write "2.0" and the like.  Without this function we'd
1166  /// have to duplicate its logic everywhere it's called.
1167  bool isExactlyValue(double V) const {
1168    if (getValueType(0)==MVT::f64)
1169      return isExactlyValue(APFloat(V));
1170    else
1171      return isExactlyValue(APFloat((float)V));
1172  }
1173  bool isExactlyValue(const APFloat& V) const;
1174
1175  bool isValueValidForType(MVT::ValueType VT, const APFloat& Val);
1176
1177  static bool classof(const ConstantFPSDNode *) { return true; }
1178  static bool classof(const SDNode *N) {
1179    return N->getOpcode() == ISD::ConstantFP ||
1180           N->getOpcode() == ISD::TargetConstantFP;
1181  }
1182};
1183
1184class GlobalAddressSDNode : public SDNode {
1185  GlobalValue *TheGlobal;
1186  int Offset;
1187  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1188protected:
1189  friend class SelectionDAG;
1190  GlobalAddressSDNode(bool isTarget, const GlobalValue *GA, MVT::ValueType VT,
1191                      int o = 0);
1192public:
1193
1194  GlobalValue *getGlobal() const { return TheGlobal; }
1195  int getOffset() const { return Offset; }
1196
1197  static bool classof(const GlobalAddressSDNode *) { return true; }
1198  static bool classof(const SDNode *N) {
1199    return N->getOpcode() == ISD::GlobalAddress ||
1200           N->getOpcode() == ISD::TargetGlobalAddress ||
1201           N->getOpcode() == ISD::GlobalTLSAddress ||
1202           N->getOpcode() == ISD::TargetGlobalTLSAddress;
1203  }
1204};
1205
1206class FrameIndexSDNode : public SDNode {
1207  int FI;
1208  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1209protected:
1210  friend class SelectionDAG;
1211  FrameIndexSDNode(int fi, MVT::ValueType VT, bool isTarg)
1212    : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex, getSDVTList(VT)),
1213      FI(fi) {
1214  }
1215public:
1216
1217  int getIndex() const { return FI; }
1218
1219  static bool classof(const FrameIndexSDNode *) { return true; }
1220  static bool classof(const SDNode *N) {
1221    return N->getOpcode() == ISD::FrameIndex ||
1222           N->getOpcode() == ISD::TargetFrameIndex;
1223  }
1224};
1225
1226class JumpTableSDNode : public SDNode {
1227  int JTI;
1228  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1229protected:
1230  friend class SelectionDAG;
1231  JumpTableSDNode(int jti, MVT::ValueType VT, bool isTarg)
1232    : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable, getSDVTList(VT)),
1233      JTI(jti) {
1234  }
1235public:
1236
1237    int getIndex() const { return JTI; }
1238
1239  static bool classof(const JumpTableSDNode *) { return true; }
1240  static bool classof(const SDNode *N) {
1241    return N->getOpcode() == ISD::JumpTable ||
1242           N->getOpcode() == ISD::TargetJumpTable;
1243  }
1244};
1245
1246class ConstantPoolSDNode : public SDNode {
1247  union {
1248    Constant *ConstVal;
1249    MachineConstantPoolValue *MachineCPVal;
1250  } Val;
1251  int Offset;  // It's a MachineConstantPoolValue if top bit is set.
1252  unsigned Alignment;
1253  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1254protected:
1255  friend class SelectionDAG;
1256  ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT,
1257                     int o=0)
1258    : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1259             getSDVTList(VT)), Offset(o), Alignment(0) {
1260    assert((int)Offset >= 0 && "Offset is too large");
1261    Val.ConstVal = c;
1262  }
1263  ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT, int o,
1264                     unsigned Align)
1265    : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1266             getSDVTList(VT)), Offset(o), Alignment(Align) {
1267    assert((int)Offset >= 0 && "Offset is too large");
1268    Val.ConstVal = c;
1269  }
1270  ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1271                     MVT::ValueType VT, int o=0)
1272    : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1273             getSDVTList(VT)), Offset(o), Alignment(0) {
1274    assert((int)Offset >= 0 && "Offset is too large");
1275    Val.MachineCPVal = v;
1276    Offset |= 1 << (sizeof(unsigned)*8-1);
1277  }
1278  ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1279                     MVT::ValueType VT, int o, unsigned Align)
1280    : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1281             getSDVTList(VT)), Offset(o), Alignment(Align) {
1282    assert((int)Offset >= 0 && "Offset is too large");
1283    Val.MachineCPVal = v;
1284    Offset |= 1 << (sizeof(unsigned)*8-1);
1285  }
1286public:
1287
1288  bool isMachineConstantPoolEntry() const {
1289    return (int)Offset < 0;
1290  }
1291
1292  Constant *getConstVal() const {
1293    assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1294    return Val.ConstVal;
1295  }
1296
1297  MachineConstantPoolValue *getMachineCPVal() const {
1298    assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1299    return Val.MachineCPVal;
1300  }
1301
1302  int getOffset() const {
1303    return Offset & ~(1 << (sizeof(unsigned)*8-1));
1304  }
1305
1306  // Return the alignment of this constant pool object, which is either 0 (for
1307  // default alignment) or log2 of the desired value.
1308  unsigned getAlignment() const { return Alignment; }
1309
1310  const Type *getType() const;
1311
1312  static bool classof(const ConstantPoolSDNode *) { return true; }
1313  static bool classof(const SDNode *N) {
1314    return N->getOpcode() == ISD::ConstantPool ||
1315           N->getOpcode() == ISD::TargetConstantPool;
1316  }
1317};
1318
1319class BasicBlockSDNode : public SDNode {
1320  MachineBasicBlock *MBB;
1321  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1322protected:
1323  friend class SelectionDAG;
1324  explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1325    : SDNode(ISD::BasicBlock, getSDVTList(MVT::Other)), MBB(mbb) {
1326  }
1327public:
1328
1329  MachineBasicBlock *getBasicBlock() const { return MBB; }
1330
1331  static bool classof(const BasicBlockSDNode *) { return true; }
1332  static bool classof(const SDNode *N) {
1333    return N->getOpcode() == ISD::BasicBlock;
1334  }
1335};
1336
1337class SrcValueSDNode : public SDNode {
1338  const Value *V;
1339  int offset;
1340  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1341protected:
1342  friend class SelectionDAG;
1343  SrcValueSDNode(const Value* v, int o)
1344    : SDNode(ISD::SRCVALUE, getSDVTList(MVT::Other)), V(v), offset(o) {
1345  }
1346
1347public:
1348  const Value *getValue() const { return V; }
1349  int getOffset() const { return offset; }
1350
1351  static bool classof(const SrcValueSDNode *) { return true; }
1352  static bool classof(const SDNode *N) {
1353    return N->getOpcode() == ISD::SRCVALUE;
1354  }
1355};
1356
1357
1358class RegisterSDNode : public SDNode {
1359  unsigned Reg;
1360  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1361protected:
1362  friend class SelectionDAG;
1363  RegisterSDNode(unsigned reg, MVT::ValueType VT)
1364    : SDNode(ISD::Register, getSDVTList(VT)), Reg(reg) {
1365  }
1366public:
1367
1368  unsigned getReg() const { return Reg; }
1369
1370  static bool classof(const RegisterSDNode *) { return true; }
1371  static bool classof(const SDNode *N) {
1372    return N->getOpcode() == ISD::Register;
1373  }
1374};
1375
1376class ExternalSymbolSDNode : public SDNode {
1377  const char *Symbol;
1378  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1379protected:
1380  friend class SelectionDAG;
1381  ExternalSymbolSDNode(bool isTarget, const char *Sym, MVT::ValueType VT)
1382    : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1383             getSDVTList(VT)), Symbol(Sym) {
1384  }
1385public:
1386
1387  const char *getSymbol() const { return Symbol; }
1388
1389  static bool classof(const ExternalSymbolSDNode *) { return true; }
1390  static bool classof(const SDNode *N) {
1391    return N->getOpcode() == ISD::ExternalSymbol ||
1392           N->getOpcode() == ISD::TargetExternalSymbol;
1393  }
1394};
1395
1396class CondCodeSDNode : public SDNode {
1397  ISD::CondCode Condition;
1398  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1399protected:
1400  friend class SelectionDAG;
1401  explicit CondCodeSDNode(ISD::CondCode Cond)
1402    : SDNode(ISD::CONDCODE, getSDVTList(MVT::Other)), Condition(Cond) {
1403  }
1404public:
1405
1406  ISD::CondCode get() const { return Condition; }
1407
1408  static bool classof(const CondCodeSDNode *) { return true; }
1409  static bool classof(const SDNode *N) {
1410    return N->getOpcode() == ISD::CONDCODE;
1411  }
1412};
1413
1414/// VTSDNode - This class is used to represent MVT::ValueType's, which are used
1415/// to parameterize some operations.
1416class VTSDNode : public SDNode {
1417  MVT::ValueType ValueType;
1418  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1419protected:
1420  friend class SelectionDAG;
1421  explicit VTSDNode(MVT::ValueType VT)
1422    : SDNode(ISD::VALUETYPE, getSDVTList(MVT::Other)), ValueType(VT) {
1423  }
1424public:
1425
1426  MVT::ValueType getVT() const { return ValueType; }
1427
1428  static bool classof(const VTSDNode *) { return true; }
1429  static bool classof(const SDNode *N) {
1430    return N->getOpcode() == ISD::VALUETYPE;
1431  }
1432};
1433
1434/// LoadSDNode - This class is used to represent ISD::LOAD nodes.
1435///
1436class LoadSDNode : public SDNode {
1437  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1438  SDOperand Ops[3];
1439
1440  // AddrMode - unindexed, pre-indexed, post-indexed.
1441  ISD::MemIndexedMode AddrMode;
1442
1443  // ExtType - non-ext, anyext, sext, zext.
1444  ISD::LoadExtType ExtType;
1445
1446  // LoadedVT - VT of loaded value before extension.
1447  MVT::ValueType LoadedVT;
1448
1449  // SrcValue - Memory location for alias analysis.
1450  const Value *SrcValue;
1451
1452  // SVOffset - Memory location offset.
1453  int SVOffset;
1454
1455  // Alignment - Alignment of memory location in bytes.
1456  unsigned Alignment;
1457
1458  // IsVolatile - True if the load is volatile.
1459  bool IsVolatile;
1460protected:
1461  friend class SelectionDAG;
1462  LoadSDNode(SDOperand *ChainPtrOff, SDVTList VTs,
1463             ISD::MemIndexedMode AM, ISD::LoadExtType ETy, MVT::ValueType LVT,
1464             const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
1465    : SDNode(ISD::LOAD, VTs),
1466      AddrMode(AM), ExtType(ETy), LoadedVT(LVT), SrcValue(SV), SVOffset(O),
1467      Alignment(Align), IsVolatile(Vol) {
1468    Ops[0] = ChainPtrOff[0]; // Chain
1469    Ops[1] = ChainPtrOff[1]; // Ptr
1470    Ops[2] = ChainPtrOff[2]; // Off
1471    InitOperands(Ops, 3);
1472    assert(Align != 0 && "Loads should have non-zero aligment");
1473    assert((getOffset().getOpcode() == ISD::UNDEF ||
1474            AddrMode != ISD::UNINDEXED) &&
1475           "Only indexed load has a non-undef offset operand");
1476  }
1477public:
1478
1479  const SDOperand getChain() const { return getOperand(0); }
1480  const SDOperand getBasePtr() const { return getOperand(1); }
1481  const SDOperand getOffset() const { return getOperand(2); }
1482  ISD::MemIndexedMode getAddressingMode() const { return AddrMode; }
1483  ISD::LoadExtType getExtensionType() const { return ExtType; }
1484  MVT::ValueType getLoadedVT() const { return LoadedVT; }
1485  const Value *getSrcValue() const { return SrcValue; }
1486  int getSrcValueOffset() const { return SVOffset; }
1487  unsigned getAlignment() const { return Alignment; }
1488  bool isVolatile() const { return IsVolatile; }
1489
1490  static bool classof(const LoadSDNode *) { return true; }
1491  static bool classof(const SDNode *N) {
1492    return N->getOpcode() == ISD::LOAD;
1493  }
1494};
1495
1496/// StoreSDNode - This class is used to represent ISD::STORE nodes.
1497///
1498class StoreSDNode : public SDNode {
1499  virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1500  SDOperand Ops[4];
1501
1502  // AddrMode - unindexed, pre-indexed, post-indexed.
1503  ISD::MemIndexedMode AddrMode;
1504
1505  // IsTruncStore - True is the op does a truncation before store.
1506  bool IsTruncStore;
1507
1508  // StoredVT - VT of the value after truncation.
1509  MVT::ValueType StoredVT;
1510
1511  // SrcValue - Memory location for alias analysis.
1512  const Value *SrcValue;
1513
1514  // SVOffset - Memory location offset.
1515  int SVOffset;
1516
1517  // Alignment - Alignment of memory location in bytes.
1518  unsigned Alignment;
1519
1520  // IsVolatile - True if the store is volatile.
1521  bool IsVolatile;
1522protected:
1523  friend class SelectionDAG;
1524  StoreSDNode(SDOperand *ChainValuePtrOff, SDVTList VTs,
1525              ISD::MemIndexedMode AM, bool isTrunc, MVT::ValueType SVT,
1526              const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
1527    : SDNode(ISD::STORE, VTs),
1528      AddrMode(AM), IsTruncStore(isTrunc), StoredVT(SVT), SrcValue(SV),
1529      SVOffset(O), Alignment(Align), IsVolatile(Vol) {
1530    Ops[0] = ChainValuePtrOff[0]; // Chain
1531    Ops[1] = ChainValuePtrOff[1]; // Value
1532    Ops[2] = ChainValuePtrOff[2]; // Ptr
1533    Ops[3] = ChainValuePtrOff[3]; // Off
1534    InitOperands(Ops, 4);
1535    assert(Align != 0 && "Stores should have non-zero aligment");
1536    assert((getOffset().getOpcode() == ISD::UNDEF ||
1537            AddrMode != ISD::UNINDEXED) &&
1538           "Only indexed store has a non-undef offset operand");
1539  }
1540public:
1541
1542  const SDOperand getChain() const { return getOperand(0); }
1543  const SDOperand getValue() const { return getOperand(1); }
1544  const SDOperand getBasePtr() const { return getOperand(2); }
1545  const SDOperand getOffset() const { return getOperand(3); }
1546  ISD::MemIndexedMode getAddressingMode() const { return AddrMode; }
1547  bool isTruncatingStore() const { return IsTruncStore; }
1548  MVT::ValueType getStoredVT() const { return StoredVT; }
1549  const Value *getSrcValue() const { return SrcValue; }
1550  int getSrcValueOffset() const { return SVOffset; }
1551  unsigned getAlignment() const { return Alignment; }
1552  bool isVolatile() const { return IsVolatile; }
1553
1554  static bool classof(const StoreSDNode *) { return true; }
1555  static bool classof(const SDNode *N) {
1556    return N->getOpcode() == ISD::STORE;
1557  }
1558};
1559
1560
1561class SDNodeIterator : public forward_iterator<SDNode, ptrdiff_t> {
1562  SDNode *Node;
1563  unsigned Operand;
1564
1565  SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1566public:
1567  bool operator==(const SDNodeIterator& x) const {
1568    return Operand == x.Operand;
1569  }
1570  bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1571
1572  const SDNodeIterator &operator=(const SDNodeIterator &I) {
1573    assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1574    Operand = I.Operand;
1575    return *this;
1576  }
1577
1578  pointer operator*() const {
1579    return Node->getOperand(Operand).Val;
1580  }
1581  pointer operator->() const { return operator*(); }
1582
1583  SDNodeIterator& operator++() {                // Preincrement
1584    ++Operand;
1585    return *this;
1586  }
1587  SDNodeIterator operator++(int) { // Postincrement
1588    SDNodeIterator tmp = *this; ++*this; return tmp;
1589  }
1590
1591  static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
1592  static SDNodeIterator end  (SDNode *N) {
1593    return SDNodeIterator(N, N->getNumOperands());
1594  }
1595
1596  unsigned getOperand() const { return Operand; }
1597  const SDNode *getNode() const { return Node; }
1598};
1599
1600template <> struct GraphTraits<SDNode*> {
1601  typedef SDNode NodeType;
1602  typedef SDNodeIterator ChildIteratorType;
1603  static inline NodeType *getEntryNode(SDNode *N) { return N; }
1604  static inline ChildIteratorType child_begin(NodeType *N) {
1605    return SDNodeIterator::begin(N);
1606  }
1607  static inline ChildIteratorType child_end(NodeType *N) {
1608    return SDNodeIterator::end(N);
1609  }
1610};
1611
1612template<>
1613struct ilist_traits<SDNode> {
1614  static SDNode *getPrev(const SDNode *N) { return N->Prev; }
1615  static SDNode *getNext(const SDNode *N) { return N->Next; }
1616
1617  static void setPrev(SDNode *N, SDNode *Prev) { N->Prev = Prev; }
1618  static void setNext(SDNode *N, SDNode *Next) { N->Next = Next; }
1619
1620  static SDNode *createSentinel() {
1621    return new SDNode(ISD::EntryToken, SDNode::getSDVTList(MVT::Other));
1622  }
1623  static void destroySentinel(SDNode *N) { delete N; }
1624  //static SDNode *createNode(const SDNode &V) { return new SDNode(V); }
1625
1626
1627  void addNodeToList(SDNode *NTy) {}
1628  void removeNodeFromList(SDNode *NTy) {}
1629  void transferNodesFromList(iplist<SDNode, ilist_traits> &L2,
1630                             const ilist_iterator<SDNode> &X,
1631                             const ilist_iterator<SDNode> &Y) {}
1632};
1633
1634namespace ISD {
1635  /// isNON_EXTLoad - Returns true if the specified node is a non-extending
1636  /// load.
1637  inline bool isNON_EXTLoad(const SDNode *N) {
1638    return N->getOpcode() == ISD::LOAD &&
1639      cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
1640  }
1641
1642  /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
1643  ///
1644  inline bool isEXTLoad(const SDNode *N) {
1645    return N->getOpcode() == ISD::LOAD &&
1646      cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
1647  }
1648
1649  /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
1650  ///
1651  inline bool isSEXTLoad(const SDNode *N) {
1652    return N->getOpcode() == ISD::LOAD &&
1653      cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
1654  }
1655
1656  /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
1657  ///
1658  inline bool isZEXTLoad(const SDNode *N) {
1659    return N->getOpcode() == ISD::LOAD &&
1660      cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
1661  }
1662
1663  /// isUNINDEXEDLoad - Returns true if the specified node is a unindexed load.
1664  ///
1665  inline bool isUNINDEXEDLoad(const SDNode *N) {
1666    return N->getOpcode() == ISD::LOAD &&
1667      cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
1668  }
1669
1670  /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
1671  /// store.
1672  inline bool isNON_TRUNCStore(const SDNode *N) {
1673    return N->getOpcode() == ISD::STORE &&
1674      !cast<StoreSDNode>(N)->isTruncatingStore();
1675  }
1676
1677  /// isTRUNCStore - Returns true if the specified node is a truncating
1678  /// store.
1679  inline bool isTRUNCStore(const SDNode *N) {
1680    return N->getOpcode() == ISD::STORE &&
1681      cast<StoreSDNode>(N)->isTruncatingStore();
1682  }
1683}
1684
1685
1686} // end llvm namespace
1687
1688#endif
1689