Add a new sentry node type, allowing assertions to catch trivial
[oota-llvm.git] / include / llvm / CodeGen / SelectionDAGNodes.h
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/CodeGen/ValueTypes.h"
23 #include "llvm/Value.h"
24 #include "llvm/ADT/GraphTraits.h"
25 #include "llvm/ADT/iterator"
26 #include "llvm/Support/DataTypes.h"
27 #include <cassert>
28 #include <vector>
29
30 namespace llvm {
31
32 class SelectionDAG;
33 class GlobalValue;
34 class MachineBasicBlock;
35 class SDNode;
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;
40
41 /// ISD namespace - This namespace contains an enum which represents all of the
42 /// SelectionDAG node types and value types.
43 ///
44 namespace ISD {
45   //===--------------------------------------------------------------------===//
46   /// ISD::NodeType enum - This enum defines all of the operators valid in a
47   /// SelectionDAG.
48   ///
49   enum NodeType {
50     // DELETED_NODE - This is an illegal flag value that is used to catch
51     // errors.  This opcode is not a legal opcode for any node.
52     DELETED_NODE,
53     
54     // EntryToken - This is the marker used to indicate the start of the region.
55     EntryToken,
56
57     // Token factor - This node takes multiple tokens as input and produces a
58     // single token result.  This is used to represent the fact that the operand
59     // operators are independent of each other.
60     TokenFactor,
61     
62     // AssertSext, AssertZext - These nodes record if a register contains a 
63     // value that has already been zero or sign extended from a narrower type.  
64     // These nodes take two operands.  The first is the node that has already 
65     // been extended, and the second is a value type node indicating the width
66     // of the extension
67     AssertSext, AssertZext,
68
69     // Various leaf nodes.
70     STRING, BasicBlock, VALUETYPE, CONDCODE, Register,
71     Constant, ConstantFP,
72     GlobalAddress, FrameIndex, JumpTable, ConstantPool, ExternalSymbol,
73
74     // TargetConstant* - Like Constant*, but the DAG does not do any folding or
75     // simplification of the constant.
76     TargetConstant,
77     TargetConstantFP,
78     
79     // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
80     // anything else with this node, and this is valid in the target-specific
81     // dag, turning into a GlobalAddress operand.
82     TargetGlobalAddress,
83     TargetFrameIndex,
84     TargetJumpTable,
85     TargetConstantPool,
86     TargetExternalSymbol,
87     
88     /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
89     /// This node represents a target intrinsic function with no side effects.
90     /// The first operand is the ID number of the intrinsic from the
91     /// llvm::Intrinsic namespace.  The operands to the intrinsic follow.  The
92     /// node has returns the result of the intrinsic.
93     INTRINSIC_WO_CHAIN,
94     
95     /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
96     /// This node represents a target intrinsic function with side effects that
97     /// returns a result.  The first operand is a chain pointer.  The second is
98     /// the ID number of the intrinsic from the llvm::Intrinsic namespace.  The
99     /// operands to the intrinsic follow.  The node has two results, the result
100     /// of the intrinsic and an output chain.
101     INTRINSIC_W_CHAIN,
102
103     /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
104     /// This node represents a target intrinsic function with side effects that
105     /// does not return a result.  The first operand is a chain pointer.  The
106     /// second is the ID number of the intrinsic from the llvm::Intrinsic
107     /// namespace.  The operands to the intrinsic follow.
108     INTRINSIC_VOID,
109     
110     // CopyToReg - This node has three operands: a chain, a register number to
111     // set to this value, and a value.  
112     CopyToReg,
113
114     // CopyFromReg - This node indicates that the input value is a virtual or
115     // physical register that is defined outside of the scope of this
116     // SelectionDAG.  The register is available from the RegSDNode object.
117     CopyFromReg,
118
119     // UNDEF - An undefined node
120     UNDEF,
121     
122     /// FORMAL_ARGUMENTS(CHAIN, CC#, ISVARARG) - This node represents the formal
123     /// arguments for a function.  CC# is a Constant value indicating the
124     /// calling convention of the function, and ISVARARG is a flag that
125     /// indicates whether the function is varargs or not.  This node has one
126     /// result value for each incoming argument, plus one for the output chain.
127     /// It must be custom legalized.
128     /// 
129     FORMAL_ARGUMENTS,
130     
131     /// RV1, RV2...RVn, CHAIN = CALL(CHAIN, CC#, ISVARARG, ISTAILCALL, CALLEE,
132     ///                              ARG0, SIGN0, ARG1, SIGN1, ... ARGn, SIGNn)
133     /// This node represents a fully general function call, before the legalizer
134     /// runs.  This has one result value for each argument / signness pair, plus
135     /// a chain result. It must be custom legalized.
136     CALL,
137
138     // EXTRACT_ELEMENT - This is used to get the first or second (determined by
139     // a Constant, which is required to be operand #1), element of the aggregate
140     // value specified as operand #0.  This is only for use before legalization,
141     // for values that will be broken into multiple registers.
142     EXTRACT_ELEMENT,
143
144     // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways.  Given
145     // two values of the same integer value type, this produces a value twice as
146     // big.  Like EXTRACT_ELEMENT, this can only be used before legalization.
147     BUILD_PAIR,
148     
149     // MERGE_VALUES - This node takes multiple discrete operands and returns
150     // them all as its individual results.  This nodes has exactly the same
151     // number of inputs and outputs, and is only valid before legalization.
152     // This node is useful for some pieces of the code generator that want to
153     // think about a single node with multiple results, not multiple nodes.
154     MERGE_VALUES,
155
156     // Simple integer binary arithmetic operators.
157     ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
158     
159     // Carry-setting nodes for multiple precision addition and subtraction.
160     // These nodes take two operands of the same value type, and produce two
161     // results.  The first result is the normal add or sub result, the second
162     // result is the carry flag result.
163     ADDC, SUBC,
164     
165     // Carry-using nodes for multiple precision addition and subtraction.  These
166     // nodes take three operands: The first two are the normal lhs and rhs to
167     // the add or sub, and the third is the input carry flag.  These nodes
168     // produce two results; the normal result of the add or sub, and the output
169     // carry flag.  These nodes both read and write a carry flag to allow them
170     // to them to be chained together for add and sub of arbitrarily large
171     // values.
172     ADDE, SUBE,
173     
174     // Simple binary floating point operators.
175     FADD, FSUB, FMUL, FDIV, FREM,
176
177     // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y.  NOTE: This
178     // DAG node does not require that X and Y have the same type, just that they
179     // are both floating point.  X and the result must have the same type.
180     // FCOPYSIGN(f32, f64) is allowed.
181     FCOPYSIGN,
182
183     /// VBUILD_VECTOR(ELT1, ELT2, ELT3, ELT4,...,  COUNT,TYPE) - Return a vector
184     /// with the specified, possibly variable, elements.  The number of elements
185     /// is required to be a power of two.
186     VBUILD_VECTOR,
187
188     /// BUILD_VECTOR(ELT1, ELT2, ELT3, ELT4,...) - Return a vector
189     /// with the specified, possibly variable, elements.  The number of elements
190     /// is required to be a power of two.
191     BUILD_VECTOR,
192     
193     /// VINSERT_VECTOR_ELT(VECTOR, VAL, IDX,  COUNT,TYPE) - Given a vector
194     /// VECTOR, an element ELEMENT, and a (potentially variable) index IDX,
195     /// return an vector with the specified element of VECTOR replaced with VAL.
196     /// COUNT and TYPE specify the type of vector, as is standard for V* nodes.
197     VINSERT_VECTOR_ELT,
198     
199     /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR (a legal packed
200     /// type) with the element at IDX replaced with VAL.
201     INSERT_VECTOR_ELT,
202
203     /// VEXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
204     /// (an MVT::Vector value) identified by the (potentially variable) element
205     /// number IDX.
206     VEXTRACT_VECTOR_ELT,
207     
208     /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
209     /// (a legal packed type vector) identified by the (potentially variable)
210     /// element number IDX.
211     EXTRACT_VECTOR_ELT,
212     
213     /// VVECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC, COUNT,TYPE) - Returns a vector,
214     /// of the same type as VEC1/VEC2.  SHUFFLEVEC is a VBUILD_VECTOR of
215     /// constant int values that indicate which value each result element will
216     /// get.  The elements of VEC1/VEC2 are enumerated in order.  This is quite
217     /// similar to the Altivec 'vperm' instruction, except that the indices must
218     /// be constants and are in terms of the element size of VEC1/VEC2, not in
219     /// terms of bytes.
220     VVECTOR_SHUFFLE,
221
222     /// VECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC) - Returns a vector, of the same
223     /// type as VEC1/VEC2.  SHUFFLEVEC is a BUILD_VECTOR of constant int values
224     /// (regardless of whether its datatype is legal or not) that indicate
225     /// which value each result element will get.  The elements of VEC1/VEC2 are
226     /// enumerated in order.  This is quite similar to the Altivec 'vperm'
227     /// instruction, except that the indices must be constants and are in terms
228     /// of the element size of VEC1/VEC2, not in terms of bytes.
229     VECTOR_SHUFFLE,
230     
231     /// X = VBIT_CONVERT(Y)  and X = VBIT_CONVERT(Y, COUNT,TYPE) - This node
232     /// represents a conversion from or to an ISD::Vector type.
233     ///
234     /// This is lowered to a BIT_CONVERT of the appropriate input/output types.
235     /// The input and output are required to have the same size and at least one
236     /// is required to be a vector (if neither is a vector, just use
237     /// BIT_CONVERT).
238     ///
239     /// If the result is a vector, this takes three operands (like any other
240     /// vector producer) which indicate the size and type of the vector result.
241     /// Otherwise it takes one input.
242     VBIT_CONVERT,
243     
244     /// BINOP(LHS, RHS,  COUNT,TYPE)
245     /// Simple abstract vector operators.  Unlike the integer and floating point
246     /// binary operators, these nodes also take two additional operands:
247     /// a constant element count, and a value type node indicating the type of
248     /// the elements.  The order is count, type, op0, op1.  All vector opcodes,
249     /// including VLOAD and VConstant must currently have count and type as
250     /// their last two operands.
251     VADD, VSUB, VMUL, VSDIV, VUDIV,
252     VAND, VOR, VXOR,
253     
254     /// VSELECT(COND,LHS,RHS,  COUNT,TYPE) - Select for MVT::Vector values.
255     /// COND is a boolean value.  This node return LHS if COND is true, RHS if
256     /// COND is false.
257     VSELECT,
258     
259     /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
260     /// scalar value into the low element of the resultant vector type.  The top
261     /// elements of the vector are undefined.
262     SCALAR_TO_VECTOR,
263     
264     // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
265     // an unsigned/signed value of type i[2*n], then return the top part.
266     MULHU, MULHS,
267
268     // Bitwise operators - logical and, logical or, logical xor, shift left,
269     // shift right algebraic (shift in sign bits), shift right logical (shift in
270     // zeroes), rotate left, rotate right, and byteswap.
271     AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
272
273     // Counting operators
274     CTTZ, CTLZ, CTPOP,
275
276     // Select(COND, TRUEVAL, FALSEVAL)
277     SELECT, 
278     
279     // Select with condition operator - This selects between a true value and 
280     // a false value (ops #2 and #3) based on the boolean result of comparing
281     // the lhs and rhs (ops #0 and #1) of a conditional expression with the 
282     // condition code in op #4, a CondCodeSDNode.
283     SELECT_CC,
284
285     // SetCC operator - This evaluates to a boolean (i1) true value if the
286     // condition is true.  The operands to this are the left and right operands
287     // to compare (ops #0, and #1) and the condition code to compare them with
288     // (op #2) as a CondCodeSDNode.
289     SETCC,
290
291     // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
292     // integer shift operations, just like ADD/SUB_PARTS.  The operation
293     // ordering is:
294     //       [Lo,Hi] = op [LoLHS,HiLHS], Amt
295     SHL_PARTS, SRA_PARTS, SRL_PARTS,
296
297     // Conversion operators.  These are all single input single output
298     // operations.  For all of these, the result type must be strictly
299     // wider or narrower (depending on the operation) than the source
300     // type.
301
302     // SIGN_EXTEND - Used for integer types, replicating the sign bit
303     // into new bits.
304     SIGN_EXTEND,
305
306     // ZERO_EXTEND - Used for integer types, zeroing the new bits.
307     ZERO_EXTEND,
308
309     // ANY_EXTEND - Used for integer types.  The high bits are undefined.
310     ANY_EXTEND,
311     
312     // TRUNCATE - Completely drop the high bits.
313     TRUNCATE,
314
315     // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
316     // depends on the first letter) to floating point.
317     SINT_TO_FP,
318     UINT_TO_FP,
319
320     // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
321     // sign extend a small value in a large integer register (e.g. sign
322     // extending the low 8 bits of a 32-bit register to fill the top 24 bits
323     // with the 7th bit).  The size of the smaller type is indicated by the 1th
324     // operand, a ValueType node.
325     SIGN_EXTEND_INREG,
326
327     // FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
328     // integer.
329     FP_TO_SINT,
330     FP_TO_UINT,
331
332     // FP_ROUND - Perform a rounding operation from the current
333     // precision down to the specified precision (currently always 64->32).
334     FP_ROUND,
335
336     // FP_ROUND_INREG - This operator takes a floating point register, and
337     // rounds it to a floating point value.  It then promotes it and returns it
338     // in a register of the same size.  This operation effectively just discards
339     // excess precision.  The type to round down to is specified by the 1th
340     // operation, a VTSDNode (currently always 64->32->64).
341     FP_ROUND_INREG,
342
343     // FP_EXTEND - Extend a smaller FP type into a larger FP type.
344     FP_EXTEND,
345
346     // BIT_CONVERT - Theis operator converts between integer and FP values, as
347     // if one was stored to memory as integer and the other was loaded from the
348     // same address (or equivalently for vector format conversions, etc).  The 
349     // source and result are required to have the same bit size (e.g. 
350     // f32 <-> i32).  This can also be used for int-to-int or fp-to-fp 
351     // conversions, but that is a noop, deleted by getNode().
352     BIT_CONVERT,
353     
354     // FNEG, FABS, FSQRT, FSIN, FCOS - Perform unary floating point negation,
355     // absolute value, square root, sine and cosine operations.
356     FNEG, FABS, FSQRT, FSIN, FCOS,
357     
358     // Other operators.  LOAD and STORE have token chains as their first
359     // operand, then the same operands as an LLVM load/store instruction, then a
360     // SRCVALUE node that provides alias analysis information.
361     LOAD, STORE,
362     
363     // Abstract vector version of LOAD.  VLOAD has a constant element count as
364     // the first operand, followed by a value type node indicating the type of
365     // the elements, a token chain, a pointer operand, and a SRCVALUE node.
366     VLOAD,
367
368     // EXTLOAD, SEXTLOAD, ZEXTLOAD - These three operators all load a value from
369     // memory and extend them to a larger value (e.g. load a byte into a word
370     // register).  All three of these have four operands, a token chain, a
371     // pointer to load from, a SRCVALUE for alias analysis, and a VALUETYPE node
372     // indicating the type to load.
373     //
374     // SEXTLOAD loads the integer operand and sign extends it to a larger
375     //          integer result type.
376     // ZEXTLOAD loads the integer operand and zero extends it to a larger
377     //          integer result type.
378     // EXTLOAD  is used for three things: floating point extending loads, 
379     //          integer extending loads [the top bits are undefined], and vector
380     //          extending loads [load into low elt].
381     EXTLOAD, SEXTLOAD, ZEXTLOAD,
382
383     // TRUNCSTORE - This operators truncates (for integer) or rounds (for FP) a
384     // value and stores it to memory in one operation.  This can be used for
385     // either integer or floating point operands.  The first four operands of
386     // this are the same as a standard store.  The fifth is the ValueType to
387     // store it as (which will be smaller than the source value).
388     TRUNCSTORE,
389
390     // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
391     // to a specified boundary.  The first operand is the token chain, the
392     // second is the number of bytes to allocate, and the third is the alignment
393     // boundary.  The size is guaranteed to be a multiple of the stack 
394     // alignment, and the alignment is guaranteed to be bigger than the stack 
395     // alignment (if required) or 0 to get standard stack alignment.
396     DYNAMIC_STACKALLOC,
397
398     // Control flow instructions.  These all have token chains.
399
400     // BR - Unconditional branch.  The first operand is the chain
401     // operand, the second is the MBB to branch to.
402     BR,
403
404     // BRIND - Indirect branch.  The first operand is the chain, the second
405     // is the value to branch to, which must be of the same type as the target's
406     // pointer type.
407     BRIND,
408     
409     // BRCOND - Conditional branch.  The first operand is the chain,
410     // the second is the condition, the third is the block to branch
411     // to if the condition is true.
412     BRCOND,
413
414     // BR_CC - Conditional branch.  The behavior is like that of SELECT_CC, in
415     // that the condition is represented as condition code, and two nodes to
416     // compare, rather than as a combined SetCC node.  The operands in order are
417     // chain, cc, lhs, rhs, block to branch to if condition is true.
418     BR_CC,
419     
420     // RET - Return from function.  The first operand is the chain,
421     // and any subsequent operands are pairs of return value and return value
422     // signness for the function.  This operation can have variable number of
423     // operands.
424     RET,
425
426     // INLINEASM - Represents an inline asm block.  This node always has two
427     // return values: a chain and a flag result.  The inputs are as follows:
428     //   Operand #0   : Input chain.
429     //   Operand #1   : a ExternalSymbolSDNode with a pointer to the asm string.
430     //   Operand #2n+2: A RegisterNode.
431     //   Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
432     //   Operand #last: Optional, an incoming flag.
433     INLINEASM,
434
435     // STACKSAVE - STACKSAVE has one operand, an input chain.  It produces a
436     // value, the same type as the pointer type for the system, and an output
437     // chain.
438     STACKSAVE,
439     
440     // STACKRESTORE has two operands, an input chain and a pointer to restore to
441     // it returns an output chain.
442     STACKRESTORE,
443     
444     // MEMSET/MEMCPY/MEMMOVE - The first operand is the chain, and the rest
445     // correspond to the operands of the LLVM intrinsic functions.  The only
446     // result is a token chain.  The alignment argument is guaranteed to be a
447     // Constant node.
448     MEMSET,
449     MEMMOVE,
450     MEMCPY,
451
452     // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
453     // a call sequence, and carry arbitrary information that target might want
454     // to know.  The first operand is a chain, the rest are specified by the
455     // target and not touched by the DAG optimizers.
456     CALLSEQ_START,  // Beginning of a call sequence
457     CALLSEQ_END,    // End of a call sequence
458     
459     // VAARG - VAARG has three operands: an input chain, a pointer, and a 
460     // SRCVALUE.  It returns a pair of values: the vaarg value and a new chain.
461     VAARG,
462     
463     // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
464     // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
465     // source.
466     VACOPY,
467     
468     // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
469     // pointer, and a SRCVALUE.
470     VAEND, VASTART,
471
472     // SRCVALUE - This corresponds to a Value*, and is used to associate memory
473     // locations with their value.  This allows one use alias analysis
474     // information in the backend.
475     SRCVALUE,
476
477     // PCMARKER - This corresponds to the pcmarker intrinsic.
478     PCMARKER,
479
480     // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
481     // The only operand is a chain and a value and a chain are produced.  The
482     // value is the contents of the architecture specific cycle counter like 
483     // register (or other high accuracy low latency clock source)
484     READCYCLECOUNTER,
485
486     // HANDLENODE node - Used as a handle for various purposes.
487     HANDLENODE,
488
489     // LOCATION - This node is used to represent a source location for debug
490     // info.  It takes token chain as input, then a line number, then a column
491     // number, then a filename, then a working dir.  It produces a token chain
492     // as output.
493     LOCATION,
494     
495     // DEBUG_LOC - This node is used to represent source line information
496     // embedded in the code.  It takes a token chain as input, then a line
497     // number, then a column then a file id (provided by MachineDebugInfo.) It
498     // produces a token chain as output.
499     DEBUG_LOC,
500     
501     // DEBUG_LABEL - This node is used to mark a location in the code where a
502     // label should be generated for use by the debug information.  It takes a
503     // token chain as input and then a unique id (provided by MachineDebugInfo.)
504     // It produces a token chain as output.
505     DEBUG_LABEL,
506     
507     // BUILTIN_OP_END - This must be the last enum value in this list.
508     BUILTIN_OP_END
509   };
510
511   /// Node predicates
512
513   /// isBuildVectorAllOnes - Return true if the specified node is a
514   /// BUILD_VECTOR where all of the elements are ~0 or undef.
515   bool isBuildVectorAllOnes(const SDNode *N);
516
517   /// isBuildVectorAllZeros - Return true if the specified node is a
518   /// BUILD_VECTOR where all of the elements are 0 or undef.
519   bool isBuildVectorAllZeros(const SDNode *N);
520   
521   //===--------------------------------------------------------------------===//
522   /// ISD::CondCode enum - These are ordered carefully to make the bitfields
523   /// below work out, when considering SETFALSE (something that never exists
524   /// dynamically) as 0.  "U" -> Unsigned (for integer operands) or Unordered
525   /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
526   /// to.  If the "N" column is 1, the result of the comparison is undefined if
527   /// the input is a NAN.
528   ///
529   /// All of these (except for the 'always folded ops') should be handled for
530   /// floating point.  For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
531   /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
532   ///
533   /// Note that these are laid out in a specific order to allow bit-twiddling
534   /// to transform conditions.
535   enum CondCode {
536     // Opcode          N U L G E       Intuitive operation
537     SETFALSE,      //    0 0 0 0       Always false (always folded)
538     SETOEQ,        //    0 0 0 1       True if ordered and equal
539     SETOGT,        //    0 0 1 0       True if ordered and greater than
540     SETOGE,        //    0 0 1 1       True if ordered and greater than or equal
541     SETOLT,        //    0 1 0 0       True if ordered and less than
542     SETOLE,        //    0 1 0 1       True if ordered and less than or equal
543     SETONE,        //    0 1 1 0       True if ordered and operands are unequal
544     SETO,          //    0 1 1 1       True if ordered (no nans)
545     SETUO,         //    1 0 0 0       True if unordered: isnan(X) | isnan(Y)
546     SETUEQ,        //    1 0 0 1       True if unordered or equal
547     SETUGT,        //    1 0 1 0       True if unordered or greater than
548     SETUGE,        //    1 0 1 1       True if unordered, greater than, or equal
549     SETULT,        //    1 1 0 0       True if unordered or less than
550     SETULE,        //    1 1 0 1       True if unordered, less than, or equal
551     SETUNE,        //    1 1 1 0       True if unordered or not equal
552     SETTRUE,       //    1 1 1 1       Always true (always folded)
553     // Don't care operations: undefined if the input is a nan.
554     SETFALSE2,     //  1 X 0 0 0       Always false (always folded)
555     SETEQ,         //  1 X 0 0 1       True if equal
556     SETGT,         //  1 X 0 1 0       True if greater than
557     SETGE,         //  1 X 0 1 1       True if greater than or equal
558     SETLT,         //  1 X 1 0 0       True if less than
559     SETLE,         //  1 X 1 0 1       True if less than or equal
560     SETNE,         //  1 X 1 1 0       True if not equal
561     SETTRUE2,      //  1 X 1 1 1       Always true (always folded)
562
563     SETCC_INVALID       // Marker value.
564   };
565
566   /// isSignedIntSetCC - Return true if this is a setcc instruction that
567   /// performs a signed comparison when used with integer operands.
568   inline bool isSignedIntSetCC(CondCode Code) {
569     return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
570   }
571
572   /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
573   /// performs an unsigned comparison when used with integer operands.
574   inline bool isUnsignedIntSetCC(CondCode Code) {
575     return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
576   }
577
578   /// isTrueWhenEqual - Return true if the specified condition returns true if
579   /// the two operands to the condition are equal.  Note that if one of the two
580   /// operands is a NaN, this value is meaningless.
581   inline bool isTrueWhenEqual(CondCode Cond) {
582     return ((int)Cond & 1) != 0;
583   }
584
585   /// getUnorderedFlavor - This function returns 0 if the condition is always
586   /// false if an operand is a NaN, 1 if the condition is always true if the
587   /// operand is a NaN, and 2 if the condition is undefined if the operand is a
588   /// NaN.
589   inline unsigned getUnorderedFlavor(CondCode Cond) {
590     return ((int)Cond >> 3) & 3;
591   }
592
593   /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
594   /// 'op' is a valid SetCC operation.
595   CondCode getSetCCInverse(CondCode Operation, bool isInteger);
596
597   /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
598   /// when given the operation for (X op Y).
599   CondCode getSetCCSwappedOperands(CondCode Operation);
600
601   /// getSetCCOrOperation - Return the result of a logical OR between different
602   /// comparisons of identical values: ((X op1 Y) | (X op2 Y)).  This
603   /// function returns SETCC_INVALID if it is not possible to represent the
604   /// resultant comparison.
605   CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
606
607   /// getSetCCAndOperation - Return the result of a logical AND between
608   /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)).  This
609   /// function returns SETCC_INVALID if it is not possible to represent the
610   /// resultant comparison.
611   CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
612 }  // end llvm::ISD namespace
613
614
615 //===----------------------------------------------------------------------===//
616 /// SDOperand - Unlike LLVM values, Selection DAG nodes may return multiple
617 /// values as the result of a computation.  Many nodes return multiple values,
618 /// from loads (which define a token and a return value) to ADDC (which returns
619 /// a result and a carry value), to calls (which may return an arbitrary number
620 /// of values).
621 ///
622 /// As such, each use of a SelectionDAG computation must indicate the node that
623 /// computes it as well as which return value to use from that node.  This pair
624 /// of information is represented with the SDOperand value type.
625 ///
626 class SDOperand {
627 public:
628   SDNode *Val;        // The node defining the value we are using.
629   unsigned ResNo;     // Which return value of the node we are using.
630
631   SDOperand() : Val(0), ResNo(0) {}
632   SDOperand(SDNode *val, unsigned resno) : Val(val), ResNo(resno) {}
633
634   bool operator==(const SDOperand &O) const {
635     return Val == O.Val && ResNo == O.ResNo;
636   }
637   bool operator!=(const SDOperand &O) const {
638     return !operator==(O);
639   }
640   bool operator<(const SDOperand &O) const {
641     return Val < O.Val || (Val == O.Val && ResNo < O.ResNo);
642   }
643
644   SDOperand getValue(unsigned R) const {
645     return SDOperand(Val, R);
646   }
647
648   // isOperand - Return true if this node is an operand of N.
649   bool isOperand(SDNode *N) const;
650
651   /// getValueType - Return the ValueType of the referenced return value.
652   ///
653   inline MVT::ValueType getValueType() const;
654
655   // Forwarding methods - These forward to the corresponding methods in SDNode.
656   inline unsigned getOpcode() const;
657   inline unsigned getNodeDepth() const;
658   inline unsigned getNumOperands() const;
659   inline const SDOperand &getOperand(unsigned i) const;
660   inline bool isTargetOpcode() const;
661   inline unsigned getTargetOpcode() const;
662
663   /// hasOneUse - Return true if there is exactly one operation using this
664   /// result value of the defining operator.
665   inline bool hasOneUse() const;
666 };
667
668
669 /// simplify_type specializations - Allow casting operators to work directly on
670 /// SDOperands as if they were SDNode*'s.
671 template<> struct simplify_type<SDOperand> {
672   typedef SDNode* SimpleType;
673   static SimpleType getSimplifiedValue(const SDOperand &Val) {
674     return static_cast<SimpleType>(Val.Val);
675   }
676 };
677 template<> struct simplify_type<const SDOperand> {
678   typedef SDNode* SimpleType;
679   static SimpleType getSimplifiedValue(const SDOperand &Val) {
680     return static_cast<SimpleType>(Val.Val);
681   }
682 };
683
684
685 /// SDNode - Represents one node in the SelectionDAG.
686 ///
687 class SDNode {
688   /// NodeType - The operation that this node performs.
689   ///
690   unsigned short NodeType;
691
692   /// NodeDepth - Node depth is defined as MAX(Node depth of children)+1.  This
693   /// means that leaves have a depth of 1, things that use only leaves have a
694   /// depth of 2, etc.
695   unsigned short NodeDepth;
696
697   /// OperandList - The values that are used by this operation.
698   ///
699   SDOperand *OperandList;
700   
701   /// ValueList - The types of the values this node defines.  SDNode's may
702   /// define multiple values simultaneously.
703   MVT::ValueType *ValueList;
704
705   /// NumOperands/NumValues - The number of entries in the Operand/Value list.
706   unsigned short NumOperands, NumValues;
707   
708   /// Prev/Next pointers - These pointers form the linked list of of the
709   /// AllNodes list in the current DAG.
710   SDNode *Prev, *Next;
711   friend struct ilist_traits<SDNode>;
712
713   /// Uses - These are all of the SDNode's that use a value produced by this
714   /// node.
715   std::vector<SDNode*> Uses;
716 public:
717   virtual ~SDNode() {
718     assert(NumOperands == 0 && "Operand list not cleared before deletion");
719     NodeType = ISD::DELETED_NODE;
720   }
721   
722   //===--------------------------------------------------------------------===//
723   //  Accessors
724   //
725   unsigned getOpcode()  const { return NodeType; }
726   bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
727   unsigned getTargetOpcode() const {
728     assert(isTargetOpcode() && "Not a target opcode!");
729     return NodeType - ISD::BUILTIN_OP_END;
730   }
731
732   size_t use_size() const { return Uses.size(); }
733   bool use_empty() const { return Uses.empty(); }
734   bool hasOneUse() const { return Uses.size() == 1; }
735
736   /// getNodeDepth - Return the distance from this node to the leaves in the
737   /// graph.  The leaves have a depth of 1.
738   unsigned getNodeDepth() const { return NodeDepth; }
739
740   typedef std::vector<SDNode*>::const_iterator use_iterator;
741   use_iterator use_begin() const { return Uses.begin(); }
742   use_iterator use_end() const { return Uses.end(); }
743
744   /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
745   /// indicated value.  This method ignores uses of other values defined by this
746   /// operation.
747   bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
748
749   // isOnlyUse - Return true if this node is the only use of N.
750   bool isOnlyUse(SDNode *N) const;
751
752   // isOperand - Return true if this node is an operand of N.
753   bool isOperand(SDNode *N) const;
754
755   /// getNumOperands - Return the number of values used by this operation.
756   ///
757   unsigned getNumOperands() const { return NumOperands; }
758
759   const SDOperand &getOperand(unsigned Num) const {
760     assert(Num < NumOperands && "Invalid child # of SDNode!");
761     return OperandList[Num];
762   }
763   typedef const SDOperand* op_iterator;
764   op_iterator op_begin() const { return OperandList; }
765   op_iterator op_end() const { return OperandList+NumOperands; }
766
767
768   /// getNumValues - Return the number of values defined/returned by this
769   /// operator.
770   ///
771   unsigned getNumValues() const { return NumValues; }
772
773   /// getValueType - Return the type of a specified result.
774   ///
775   MVT::ValueType getValueType(unsigned ResNo) const {
776     assert(ResNo < NumValues && "Illegal result number!");
777     return ValueList[ResNo];
778   }
779
780   typedef const MVT::ValueType* value_iterator;
781   value_iterator value_begin() const { return ValueList; }
782   value_iterator value_end() const { return ValueList+NumValues; }
783
784   /// getOperationName - Return the opcode of this operation for printing.
785   ///
786   const char* getOperationName(const SelectionDAG *G = 0) const;
787   void dump() const;
788   void dump(const SelectionDAG *G) const;
789
790   static bool classof(const SDNode *) { return true; }
791
792 protected:
793   friend class SelectionDAG;
794   
795   /// getValueTypeList - Return a pointer to the specified value type.
796   ///
797   static MVT::ValueType *getValueTypeList(MVT::ValueType VT);
798
799   SDNode(unsigned NT, MVT::ValueType VT) : NodeType(NT), NodeDepth(1) {
800     OperandList = 0; NumOperands = 0;
801     ValueList = getValueTypeList(VT);
802     NumValues = 1;
803     Prev = 0; Next = 0;
804   }
805   SDNode(unsigned NT, SDOperand Op)
806     : NodeType(NT), NodeDepth(Op.Val->getNodeDepth()+1) {
807     OperandList = new SDOperand[1];
808     OperandList[0] = Op;
809     NumOperands = 1;
810     Op.Val->Uses.push_back(this);
811     ValueList = 0;
812     NumValues = 0;
813     Prev = 0; Next = 0;
814   }
815   SDNode(unsigned NT, SDOperand N1, SDOperand N2)
816     : NodeType(NT) {
817     if (N1.Val->getNodeDepth() > N2.Val->getNodeDepth())
818       NodeDepth = N1.Val->getNodeDepth()+1;
819     else
820       NodeDepth = N2.Val->getNodeDepth()+1;
821     OperandList = new SDOperand[2];
822     OperandList[0] = N1;
823     OperandList[1] = N2;
824     NumOperands = 2;
825     N1.Val->Uses.push_back(this); N2.Val->Uses.push_back(this);
826     ValueList = 0;
827     NumValues = 0;
828     Prev = 0; Next = 0;
829   }
830   SDNode(unsigned NT, SDOperand N1, SDOperand N2, SDOperand N3)
831     : NodeType(NT) {
832     unsigned ND = N1.Val->getNodeDepth();
833     if (ND < N2.Val->getNodeDepth())
834       ND = N2.Val->getNodeDepth();
835     if (ND < N3.Val->getNodeDepth())
836       ND = N3.Val->getNodeDepth();
837     NodeDepth = ND+1;
838
839     OperandList = new SDOperand[3];
840     OperandList[0] = N1;
841     OperandList[1] = N2;
842     OperandList[2] = N3;
843     NumOperands = 3;
844     
845     N1.Val->Uses.push_back(this); N2.Val->Uses.push_back(this);
846     N3.Val->Uses.push_back(this);
847     ValueList = 0;
848     NumValues = 0;
849     Prev = 0; Next = 0;
850   }
851   SDNode(unsigned NT, SDOperand N1, SDOperand N2, SDOperand N3, SDOperand N4)
852     : NodeType(NT) {
853     unsigned ND = N1.Val->getNodeDepth();
854     if (ND < N2.Val->getNodeDepth())
855       ND = N2.Val->getNodeDepth();
856     if (ND < N3.Val->getNodeDepth())
857       ND = N3.Val->getNodeDepth();
858     if (ND < N4.Val->getNodeDepth())
859       ND = N4.Val->getNodeDepth();
860     NodeDepth = ND+1;
861
862     OperandList = new SDOperand[4];
863     OperandList[0] = N1;
864     OperandList[1] = N2;
865     OperandList[2] = N3;
866     OperandList[3] = N4;
867     NumOperands = 4;
868     
869     N1.Val->Uses.push_back(this); N2.Val->Uses.push_back(this);
870     N3.Val->Uses.push_back(this); N4.Val->Uses.push_back(this);
871     ValueList = 0;
872     NumValues = 0;
873     Prev = 0; Next = 0;
874   }
875   SDNode(unsigned Opc, const std::vector<SDOperand> &Nodes) : NodeType(Opc) {
876     NumOperands = Nodes.size();
877     OperandList = new SDOperand[NumOperands];
878     
879     unsigned ND = 0;
880     for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
881       OperandList[i] = Nodes[i];
882       SDNode *N = OperandList[i].Val;
883       N->Uses.push_back(this);
884       if (ND < N->getNodeDepth()) ND = N->getNodeDepth();
885     }
886     NodeDepth = ND+1;
887     ValueList = 0;
888     NumValues = 0;
889     Prev = 0; Next = 0;
890   }
891
892   /// MorphNodeTo - This clears the return value and operands list, and sets the
893   /// opcode of the node to the specified value.  This should only be used by
894   /// the SelectionDAG class.
895   void MorphNodeTo(unsigned Opc) {
896     NodeType = Opc;
897     ValueList = 0;
898     NumValues = 0;
899     
900     // Clear the operands list, updating used nodes to remove this from their
901     // use list.
902     for (op_iterator I = op_begin(), E = op_end(); I != E; ++I)
903       I->Val->removeUser(this);
904     delete [] OperandList;
905     OperandList = 0;
906     NumOperands = 0;
907   }
908   
909   void setValueTypes(MVT::ValueType VT) {
910     assert(NumValues == 0 && "Should not have values yet!");
911     ValueList = getValueTypeList(VT);
912     NumValues = 1;
913   }
914   void setValueTypes(MVT::ValueType *List, unsigned NumVal) {
915     assert(NumValues == 0 && "Should not have values yet!");
916     ValueList = List;
917     NumValues = NumVal;
918   }
919   
920   void setOperands(SDOperand Op0) {
921     assert(NumOperands == 0 && "Should not have operands yet!");
922     OperandList = new SDOperand[1];
923     OperandList[0] = Op0;
924     NumOperands = 1;
925     Op0.Val->Uses.push_back(this);
926   }
927   void setOperands(SDOperand Op0, SDOperand Op1) {
928     assert(NumOperands == 0 && "Should not have operands yet!");
929     OperandList = new SDOperand[2];
930     OperandList[0] = Op0;
931     OperandList[1] = Op1;
932     NumOperands = 2;
933     Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
934   }
935   void setOperands(SDOperand Op0, SDOperand Op1, SDOperand Op2) {
936     assert(NumOperands == 0 && "Should not have operands yet!");
937     OperandList = new SDOperand[3];
938     OperandList[0] = Op0;
939     OperandList[1] = Op1;
940     OperandList[2] = Op2;
941     NumOperands = 3;
942     Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
943     Op2.Val->Uses.push_back(this);
944   }
945   void setOperands(SDOperand Op0, SDOperand Op1, SDOperand Op2, SDOperand Op3) {
946     assert(NumOperands == 0 && "Should not have operands yet!");
947     OperandList = new SDOperand[4];
948     OperandList[0] = Op0;
949     OperandList[1] = Op1;
950     OperandList[2] = Op2;
951     OperandList[3] = Op3;
952     NumOperands = 4;
953     Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
954     Op2.Val->Uses.push_back(this); Op3.Val->Uses.push_back(this);
955   }
956   void setOperands(SDOperand Op0, SDOperand Op1, SDOperand Op2, SDOperand Op3,
957                    SDOperand Op4) {
958     assert(NumOperands == 0 && "Should not have operands yet!");
959     OperandList = new SDOperand[5];
960     OperandList[0] = Op0;
961     OperandList[1] = Op1;
962     OperandList[2] = Op2;
963     OperandList[3] = Op3;
964     OperandList[4] = Op4;
965     NumOperands = 5;
966     Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
967     Op2.Val->Uses.push_back(this); Op3.Val->Uses.push_back(this);
968     Op4.Val->Uses.push_back(this);
969   }
970   void setOperands(SDOperand Op0, SDOperand Op1, SDOperand Op2, SDOperand Op3,
971                    SDOperand Op4, SDOperand Op5) {
972     assert(NumOperands == 0 && "Should not have operands yet!");
973     OperandList = new SDOperand[6];
974     OperandList[0] = Op0;
975     OperandList[1] = Op1;
976     OperandList[2] = Op2;
977     OperandList[3] = Op3;
978     OperandList[4] = Op4;
979     OperandList[5] = Op5;
980     NumOperands = 6;
981     Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
982     Op2.Val->Uses.push_back(this); Op3.Val->Uses.push_back(this);
983     Op4.Val->Uses.push_back(this); Op5.Val->Uses.push_back(this);
984   }
985   void setOperands(SDOperand Op0, SDOperand Op1, SDOperand Op2, SDOperand Op3,
986                    SDOperand Op4, SDOperand Op5, SDOperand Op6) {
987     assert(NumOperands == 0 && "Should not have operands yet!");
988     OperandList = new SDOperand[7];
989     OperandList[0] = Op0;
990     OperandList[1] = Op1;
991     OperandList[2] = Op2;
992     OperandList[3] = Op3;
993     OperandList[4] = Op4;
994     OperandList[5] = Op5;
995     OperandList[6] = Op6;
996     NumOperands = 7;
997     Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
998     Op2.Val->Uses.push_back(this); Op3.Val->Uses.push_back(this);
999     Op4.Val->Uses.push_back(this); Op5.Val->Uses.push_back(this);
1000     Op6.Val->Uses.push_back(this);
1001   }
1002   void setOperands(SDOperand Op0, SDOperand Op1, SDOperand Op2, SDOperand Op3,
1003                    SDOperand Op4, SDOperand Op5, SDOperand Op6, SDOperand Op7) {
1004     assert(NumOperands == 0 && "Should not have operands yet!");
1005     OperandList = new SDOperand[8];
1006     OperandList[0] = Op0;
1007     OperandList[1] = Op1;
1008     OperandList[2] = Op2;
1009     OperandList[3] = Op3;
1010     OperandList[4] = Op4;
1011     OperandList[5] = Op5;
1012     OperandList[6] = Op6;
1013     OperandList[7] = Op7;
1014     NumOperands = 8;
1015     Op0.Val->Uses.push_back(this); Op1.Val->Uses.push_back(this);
1016     Op2.Val->Uses.push_back(this); Op3.Val->Uses.push_back(this);
1017     Op4.Val->Uses.push_back(this); Op5.Val->Uses.push_back(this);
1018     Op6.Val->Uses.push_back(this); Op7.Val->Uses.push_back(this);
1019   }
1020
1021   void addUser(SDNode *User) {
1022     Uses.push_back(User);
1023   }
1024   void removeUser(SDNode *User) {
1025     // Remove this user from the operand's use list.
1026     for (unsigned i = Uses.size(); ; --i) {
1027       assert(i != 0 && "Didn't find user!");
1028       if (Uses[i-1] == User) {
1029         Uses[i-1] = Uses.back();
1030         Uses.pop_back();
1031         return;
1032       }
1033     }
1034   }
1035 };
1036
1037
1038 // Define inline functions from the SDOperand class.
1039
1040 inline unsigned SDOperand::getOpcode() const {
1041   return Val->getOpcode();
1042 }
1043 inline unsigned SDOperand::getNodeDepth() const {
1044   return Val->getNodeDepth();
1045 }
1046 inline MVT::ValueType SDOperand::getValueType() const {
1047   return Val->getValueType(ResNo);
1048 }
1049 inline unsigned SDOperand::getNumOperands() const {
1050   return Val->getNumOperands();
1051 }
1052 inline const SDOperand &SDOperand::getOperand(unsigned i) const {
1053   return Val->getOperand(i);
1054 }
1055 inline bool SDOperand::isTargetOpcode() const {
1056   return Val->isTargetOpcode();
1057 }
1058 inline unsigned SDOperand::getTargetOpcode() const {
1059   return Val->getTargetOpcode();
1060 }
1061 inline bool SDOperand::hasOneUse() const {
1062   return Val->hasNUsesOfValue(1, ResNo);
1063 }
1064
1065 /// HandleSDNode - This class is used to form a handle around another node that
1066 /// is persistant and is updated across invocations of replaceAllUsesWith on its
1067 /// operand.  This node should be directly created by end-users and not added to
1068 /// the AllNodes list.
1069 class HandleSDNode : public SDNode {
1070 public:
1071   HandleSDNode(SDOperand X) : SDNode(ISD::HANDLENODE, X) {}
1072   ~HandleSDNode() {
1073     MorphNodeTo(ISD::HANDLENODE);  // Drops operand uses.
1074   }
1075   
1076   SDOperand getValue() const { return getOperand(0); }
1077 };
1078
1079 class StringSDNode : public SDNode {
1080   std::string Value;
1081 protected:
1082   friend class SelectionDAG;
1083   StringSDNode(const std::string &val)
1084     : SDNode(ISD::STRING, MVT::Other), Value(val) {
1085   }
1086 public:
1087   const std::string &getValue() const { return Value; }
1088   static bool classof(const StringSDNode *) { return true; }
1089   static bool classof(const SDNode *N) {
1090     return N->getOpcode() == ISD::STRING;
1091   }
1092 };  
1093
1094 class ConstantSDNode : public SDNode {
1095   uint64_t Value;
1096 protected:
1097   friend class SelectionDAG;
1098   ConstantSDNode(bool isTarget, uint64_t val, MVT::ValueType VT)
1099     : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant, VT), Value(val) {
1100   }
1101 public:
1102
1103   uint64_t getValue() const { return Value; }
1104
1105   int64_t getSignExtended() const {
1106     unsigned Bits = MVT::getSizeInBits(getValueType(0));
1107     return ((int64_t)Value << (64-Bits)) >> (64-Bits);
1108   }
1109
1110   bool isNullValue() const { return Value == 0; }
1111   bool isAllOnesValue() const {
1112     return Value == MVT::getIntVTBitMask(getValueType(0));
1113   }
1114
1115   static bool classof(const ConstantSDNode *) { return true; }
1116   static bool classof(const SDNode *N) {
1117     return N->getOpcode() == ISD::Constant ||
1118            N->getOpcode() == ISD::TargetConstant;
1119   }
1120 };
1121
1122 class ConstantFPSDNode : public SDNode {
1123   double Value;
1124 protected:
1125   friend class SelectionDAG;
1126   ConstantFPSDNode(bool isTarget, double val, MVT::ValueType VT)
1127     : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP, VT), 
1128       Value(val) {
1129   }
1130 public:
1131
1132   double getValue() const { return Value; }
1133
1134   /// isExactlyValue - We don't rely on operator== working on double values, as
1135   /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1136   /// As such, this method can be used to do an exact bit-for-bit comparison of
1137   /// two floating point values.
1138   bool isExactlyValue(double V) const;
1139
1140   static bool classof(const ConstantFPSDNode *) { return true; }
1141   static bool classof(const SDNode *N) {
1142     return N->getOpcode() == ISD::ConstantFP || 
1143            N->getOpcode() == ISD::TargetConstantFP;
1144   }
1145 };
1146
1147 class GlobalAddressSDNode : public SDNode {
1148   GlobalValue *TheGlobal;
1149   int Offset;
1150 protected:
1151   friend class SelectionDAG;
1152   GlobalAddressSDNode(bool isTarget, const GlobalValue *GA, MVT::ValueType VT,
1153                       int o=0)
1154     : SDNode(isTarget ? ISD::TargetGlobalAddress : ISD::GlobalAddress, VT),
1155       Offset(o) {
1156     TheGlobal = const_cast<GlobalValue*>(GA);
1157   }
1158 public:
1159
1160   GlobalValue *getGlobal() const { return TheGlobal; }
1161   int getOffset() const { return Offset; }
1162
1163   static bool classof(const GlobalAddressSDNode *) { return true; }
1164   static bool classof(const SDNode *N) {
1165     return N->getOpcode() == ISD::GlobalAddress ||
1166            N->getOpcode() == ISD::TargetGlobalAddress;
1167   }
1168 };
1169
1170
1171 class FrameIndexSDNode : public SDNode {
1172   int FI;
1173 protected:
1174   friend class SelectionDAG;
1175   FrameIndexSDNode(int fi, MVT::ValueType VT, bool isTarg)
1176     : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex, VT), FI(fi) {}
1177 public:
1178
1179   int getIndex() const { return FI; }
1180
1181   static bool classof(const FrameIndexSDNode *) { return true; }
1182   static bool classof(const SDNode *N) {
1183     return N->getOpcode() == ISD::FrameIndex ||
1184            N->getOpcode() == ISD::TargetFrameIndex;
1185   }
1186 };
1187
1188 class JumpTableSDNode : public SDNode {
1189   int JTI;
1190 protected:
1191   friend class SelectionDAG;
1192   JumpTableSDNode(int jti, MVT::ValueType VT, bool isTarg)
1193     : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable, VT), 
1194     JTI(jti) {}
1195 public:
1196     
1197     int getIndex() const { return JTI; }
1198   
1199   static bool classof(const JumpTableSDNode *) { return true; }
1200   static bool classof(const SDNode *N) {
1201     return N->getOpcode() == ISD::JumpTable ||
1202            N->getOpcode() == ISD::TargetJumpTable;
1203   }
1204 };
1205
1206 class ConstantPoolSDNode : public SDNode {
1207   Constant *C;
1208   int Offset;
1209   unsigned Alignment;
1210 protected:
1211   friend class SelectionDAG;
1212   ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT,
1213                      int o=0)
1214     : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, VT),
1215       C(c), Offset(o), Alignment(0) {}
1216   ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT, int o,
1217                      unsigned Align)
1218     : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, VT),
1219       C(c), Offset(o), Alignment(Align) {}
1220 public:
1221
1222   Constant *get() const { return C; }
1223   int getOffset() const { return Offset; }
1224   
1225   // Return the alignment of this constant pool object, which is either 0 (for
1226   // default alignment) or log2 of the desired value.
1227   unsigned getAlignment() const { return Alignment; }
1228
1229   static bool classof(const ConstantPoolSDNode *) { return true; }
1230   static bool classof(const SDNode *N) {
1231     return N->getOpcode() == ISD::ConstantPool ||
1232            N->getOpcode() == ISD::TargetConstantPool;
1233   }
1234 };
1235
1236 class BasicBlockSDNode : public SDNode {
1237   MachineBasicBlock *MBB;
1238 protected:
1239   friend class SelectionDAG;
1240   BasicBlockSDNode(MachineBasicBlock *mbb)
1241     : SDNode(ISD::BasicBlock, MVT::Other), MBB(mbb) {}
1242 public:
1243
1244   MachineBasicBlock *getBasicBlock() const { return MBB; }
1245
1246   static bool classof(const BasicBlockSDNode *) { return true; }
1247   static bool classof(const SDNode *N) {
1248     return N->getOpcode() == ISD::BasicBlock;
1249   }
1250 };
1251
1252 class SrcValueSDNode : public SDNode {
1253   const Value *V;
1254   int offset;
1255 protected:
1256   friend class SelectionDAG;
1257   SrcValueSDNode(const Value* v, int o)
1258     : SDNode(ISD::SRCVALUE, MVT::Other), V(v), offset(o) {}
1259
1260 public:
1261   const Value *getValue() const { return V; }
1262   int getOffset() const { return offset; }
1263
1264   static bool classof(const SrcValueSDNode *) { return true; }
1265   static bool classof(const SDNode *N) {
1266     return N->getOpcode() == ISD::SRCVALUE;
1267   }
1268 };
1269
1270
1271 class RegisterSDNode : public SDNode {
1272   unsigned Reg;
1273 protected:
1274   friend class SelectionDAG;
1275   RegisterSDNode(unsigned reg, MVT::ValueType VT)
1276     : SDNode(ISD::Register, VT), Reg(reg) {}
1277 public:
1278
1279   unsigned getReg() const { return Reg; }
1280
1281   static bool classof(const RegisterSDNode *) { return true; }
1282   static bool classof(const SDNode *N) {
1283     return N->getOpcode() == ISD::Register;
1284   }
1285 };
1286
1287 class ExternalSymbolSDNode : public SDNode {
1288   const char *Symbol;
1289 protected:
1290   friend class SelectionDAG;
1291   ExternalSymbolSDNode(bool isTarget, const char *Sym, MVT::ValueType VT)
1292     : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol, VT),
1293       Symbol(Sym) {
1294     }
1295 public:
1296
1297   const char *getSymbol() const { return Symbol; }
1298
1299   static bool classof(const ExternalSymbolSDNode *) { return true; }
1300   static bool classof(const SDNode *N) {
1301     return N->getOpcode() == ISD::ExternalSymbol ||
1302            N->getOpcode() == ISD::TargetExternalSymbol;
1303   }
1304 };
1305
1306 class CondCodeSDNode : public SDNode {
1307   ISD::CondCode Condition;
1308 protected:
1309   friend class SelectionDAG;
1310   CondCodeSDNode(ISD::CondCode Cond)
1311     : SDNode(ISD::CONDCODE, MVT::Other), Condition(Cond) {
1312   }
1313 public:
1314
1315   ISD::CondCode get() const { return Condition; }
1316
1317   static bool classof(const CondCodeSDNode *) { return true; }
1318   static bool classof(const SDNode *N) {
1319     return N->getOpcode() == ISD::CONDCODE;
1320   }
1321 };
1322
1323 /// VTSDNode - This class is used to represent MVT::ValueType's, which are used
1324 /// to parameterize some operations.
1325 class VTSDNode : public SDNode {
1326   MVT::ValueType ValueType;
1327 protected:
1328   friend class SelectionDAG;
1329   VTSDNode(MVT::ValueType VT)
1330     : SDNode(ISD::VALUETYPE, MVT::Other), ValueType(VT) {}
1331 public:
1332
1333   MVT::ValueType getVT() const { return ValueType; }
1334
1335   static bool classof(const VTSDNode *) { return true; }
1336   static bool classof(const SDNode *N) {
1337     return N->getOpcode() == ISD::VALUETYPE;
1338   }
1339 };
1340
1341
1342 class SDNodeIterator : public forward_iterator<SDNode, ptrdiff_t> {
1343   SDNode *Node;
1344   unsigned Operand;
1345
1346   SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
1347 public:
1348   bool operator==(const SDNodeIterator& x) const {
1349     return Operand == x.Operand;
1350   }
1351   bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
1352
1353   const SDNodeIterator &operator=(const SDNodeIterator &I) {
1354     assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
1355     Operand = I.Operand;
1356     return *this;
1357   }
1358
1359   pointer operator*() const {
1360     return Node->getOperand(Operand).Val;
1361   }
1362   pointer operator->() const { return operator*(); }
1363
1364   SDNodeIterator& operator++() {                // Preincrement
1365     ++Operand;
1366     return *this;
1367   }
1368   SDNodeIterator operator++(int) { // Postincrement
1369     SDNodeIterator tmp = *this; ++*this; return tmp;
1370   }
1371
1372   static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
1373   static SDNodeIterator end  (SDNode *N) {
1374     return SDNodeIterator(N, N->getNumOperands());
1375   }
1376
1377   unsigned getOperand() const { return Operand; }
1378   const SDNode *getNode() const { return Node; }
1379 };
1380
1381 template <> struct GraphTraits<SDNode*> {
1382   typedef SDNode NodeType;
1383   typedef SDNodeIterator ChildIteratorType;
1384   static inline NodeType *getEntryNode(SDNode *N) { return N; }
1385   static inline ChildIteratorType child_begin(NodeType *N) {
1386     return SDNodeIterator::begin(N);
1387   }
1388   static inline ChildIteratorType child_end(NodeType *N) {
1389     return SDNodeIterator::end(N);
1390   }
1391 };
1392
1393 template<>
1394 struct ilist_traits<SDNode> {
1395   static SDNode *getPrev(const SDNode *N) { return N->Prev; }
1396   static SDNode *getNext(const SDNode *N) { return N->Next; }
1397   
1398   static void setPrev(SDNode *N, SDNode *Prev) { N->Prev = Prev; }
1399   static void setNext(SDNode *N, SDNode *Next) { N->Next = Next; }
1400   
1401   static SDNode *createSentinel() {
1402     return new SDNode(ISD::EntryToken, MVT::Other);
1403   }
1404   static void destroySentinel(SDNode *N) { delete N; }
1405   //static SDNode *createNode(const SDNode &V) { return new SDNode(V); }
1406   
1407   
1408   void addNodeToList(SDNode *NTy) {}
1409   void removeNodeFromList(SDNode *NTy) {}
1410   void transferNodesFromList(iplist<SDNode, ilist_traits> &L2,
1411                              const ilist_iterator<SDNode> &X,
1412                              const ilist_iterator<SDNode> &Y) {}
1413 };
1414
1415 } // end llvm namespace
1416
1417 #endif