Ongoing work on improving the instruction selection infrastructure:
[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 is distributed under the University of Illinois Open Source
6 // 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/ADT/APInt.h"
28 #include "llvm/CodeGen/ValueTypes.h"
29 #include "llvm/CodeGen/MachineMemOperand.h"
30 #include "llvm/Support/DataTypes.h"
31 #include <cassert>
32
33 namespace llvm {
34
35 class SelectionDAG;
36 class GlobalValue;
37 class MachineBasicBlock;
38 class MachineConstantPoolValue;
39 class SDNode;
40 template <typename T> struct DenseMapInfo;
41 template <typename T> struct simplify_type;
42 template <typename T> struct ilist_traits;
43 template<typename NodeTy, typename Traits> class iplist;
44 template<typename NodeTy> class ilist_iterator;
45
46 /// SDVTList - This represents a list of ValueType's that has been intern'd by
47 /// a SelectionDAG.  Instances of this simple value class are returned by
48 /// SelectionDAG::getVTList(...).
49 ///
50 struct SDVTList {
51   const MVT::ValueType *VTs;
52   unsigned short NumVTs;
53 };
54
55 /// ISD namespace - This namespace contains an enum which represents all of the
56 /// SelectionDAG node types and value types.
57 ///
58 namespace ISD {
59
60   //===--------------------------------------------------------------------===//
61   /// ISD::NodeType enum - This enum defines all of the operators valid in a
62   /// SelectionDAG.
63   ///
64   enum NodeType {
65     // DELETED_NODE - This is an illegal flag value that is used to catch
66     // errors.  This opcode is not a legal opcode for any node.
67     DELETED_NODE,
68     
69     // EntryToken - This is the marker used to indicate the start of the region.
70     EntryToken,
71
72     // Token factor - This node takes multiple tokens as input and produces a
73     // single token result.  This is used to represent the fact that the operand
74     // operators are independent of each other.
75     TokenFactor,
76     
77     // AssertSext, AssertZext - These nodes record if a register contains a 
78     // value that has already been zero or sign extended from a narrower type.  
79     // These nodes take two operands.  The first is the node that has already 
80     // been extended, and the second is a value type node indicating the width
81     // of the extension
82     AssertSext, AssertZext,
83
84     // Various leaf nodes.
85     STRING, BasicBlock, VALUETYPE, ARG_FLAGS, CONDCODE, Register,
86     Constant, ConstantFP,
87     GlobalAddress, GlobalTLSAddress, FrameIndex,
88     JumpTable, ConstantPool, ExternalSymbol,
89
90     // The address of the GOT
91     GLOBAL_OFFSET_TABLE,
92     
93     // FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
94     // llvm.returnaddress on the DAG.  These nodes take one operand, the index
95     // of the frame or return address to return.  An index of zero corresponds
96     // to the current function's frame or return address, an index of one to the
97     // parent's frame or return address, and so on.
98     FRAMEADDR, RETURNADDR,
99
100     // FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
101     // first (possible) on-stack argument. This is needed for correct stack
102     // adjustment during unwind.
103     FRAME_TO_ARGS_OFFSET,
104     
105     // RESULT, OUTCHAIN = EXCEPTIONADDR(INCHAIN) - This node represents the
106     // address of the exception block on entry to an landing pad block.
107     EXCEPTIONADDR,
108     
109     // RESULT, OUTCHAIN = EHSELECTION(INCHAIN, EXCEPTION) - This node represents
110     // the selection index of the exception thrown.
111     EHSELECTION,
112
113     // OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
114     // 'eh_return' gcc dwarf builtin, which is used to return from
115     // exception. The general meaning is: adjust stack by OFFSET and pass
116     // execution to HANDLER. Many platform-related details also :)
117     EH_RETURN,
118
119     // TargetConstant* - Like Constant*, but the DAG does not do any folding or
120     // simplification of the constant.
121     TargetConstant,
122     TargetConstantFP,
123     
124     // TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
125     // anything else with this node, and this is valid in the target-specific
126     // dag, turning into a GlobalAddress operand.
127     TargetGlobalAddress,
128     TargetGlobalTLSAddress,
129     TargetFrameIndex,
130     TargetJumpTable,
131     TargetConstantPool,
132     TargetExternalSymbol,
133     
134     /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
135     /// This node represents a target intrinsic function with no side effects.
136     /// The first operand is the ID number of the intrinsic from the
137     /// llvm::Intrinsic namespace.  The operands to the intrinsic follow.  The
138     /// node has returns the result of the intrinsic.
139     INTRINSIC_WO_CHAIN,
140     
141     /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
142     /// This node represents a target intrinsic function with side effects that
143     /// returns a result.  The first operand is a chain pointer.  The second is
144     /// the ID number of the intrinsic from the llvm::Intrinsic namespace.  The
145     /// operands to the intrinsic follow.  The node has two results, the result
146     /// of the intrinsic and an output chain.
147     INTRINSIC_W_CHAIN,
148
149     /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
150     /// This node represents a target intrinsic function with side effects that
151     /// does not return a result.  The first operand is a chain pointer.  The
152     /// second is the ID number of the intrinsic from the llvm::Intrinsic
153     /// namespace.  The operands to the intrinsic follow.
154     INTRINSIC_VOID,
155     
156     // CopyToReg - This node has three operands: a chain, a register number to
157     // set to this value, and a value.  
158     CopyToReg,
159
160     // CopyFromReg - This node indicates that the input value is a virtual or
161     // physical register that is defined outside of the scope of this
162     // SelectionDAG.  The register is available from the RegisterSDNode object.
163     CopyFromReg,
164
165     // UNDEF - An undefined node
166     UNDEF,
167     
168     /// FORMAL_ARGUMENTS(CHAIN, CC#, ISVARARG, FLAG0, ..., FLAGn) - This node
169     /// represents the formal arguments for a function.  CC# is a Constant value
170     /// indicating the calling convention of the function, and ISVARARG is a
171     /// flag that indicates whether the function is varargs or not. This node
172     /// has one result value for each incoming argument, plus one for the output
173     /// chain. It must be custom legalized. See description of CALL node for
174     /// FLAG argument contents explanation.
175     /// 
176     FORMAL_ARGUMENTS,
177     
178     /// RV1, RV2...RVn, CHAIN = CALL(CHAIN, CC#, ISVARARG, ISTAILCALL, CALLEE,
179     ///                              ARG0, FLAG0, ARG1, FLAG1, ... ARGn, FLAGn)
180     /// This node represents a fully general function call, before the legalizer
181     /// runs.  This has one result value for each argument / flag pair, plus
182     /// a chain result. It must be custom legalized. Flag argument indicates
183     /// misc. argument attributes. Currently:
184     /// Bit 0 - signness
185     /// Bit 1 - 'inreg' attribute
186     /// Bit 2 - 'sret' attribute
187     /// Bit 4 - 'byval' attribute
188     /// Bit 5 - 'nest' attribute
189     /// Bit 6-9 - alignment of byval structures
190     /// Bit 10-26 - size of byval structures
191     /// Bits 31:27 - argument ABI alignment in the first argument piece and
192     /// alignment '1' in other argument pieces.
193     CALL,
194
195     // EXTRACT_ELEMENT - This is used to get the lower or upper (determined by
196     // a Constant, which is required to be operand #1) half of the integer value
197     // specified as operand #0.  This is only for use before legalization, for
198     // values that will be broken into multiple registers.
199     EXTRACT_ELEMENT,
200
201     // BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways.  Given
202     // two values of the same integer value type, this produces a value twice as
203     // big.  Like EXTRACT_ELEMENT, this can only be used before legalization.
204     BUILD_PAIR,
205     
206     // MERGE_VALUES - This node takes multiple discrete operands and returns
207     // them all as its individual results.  This nodes has exactly the same
208     // number of inputs and outputs, and is only valid before legalization.
209     // This node is useful for some pieces of the code generator that want to
210     // think about a single node with multiple results, not multiple nodes.
211     MERGE_VALUES,
212
213     // Simple integer binary arithmetic operators.
214     ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
215
216     // SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing
217     // a signed/unsigned value of type i[2*N], and return the full value as
218     // two results, each of type iN.
219     SMUL_LOHI, UMUL_LOHI,
220
221     // SDIVREM/UDIVREM - Divide two integers and produce both a quotient and
222     // remainder result.
223     SDIVREM, UDIVREM,
224     
225     // CARRY_FALSE - This node is used when folding other nodes,
226     // like ADDC/SUBC, which indicate the carry result is always false.
227     CARRY_FALSE,
228     
229     // Carry-setting nodes for multiple precision addition and subtraction.
230     // These nodes take two operands of the same value type, and produce two
231     // results.  The first result is the normal add or sub result, the second
232     // result is the carry flag result.
233     ADDC, SUBC,
234     
235     // Carry-using nodes for multiple precision addition and subtraction.  These
236     // nodes take three operands: The first two are the normal lhs and rhs to
237     // the add or sub, and the third is the input carry flag.  These nodes
238     // produce two results; the normal result of the add or sub, and the output
239     // carry flag.  These nodes both read and write a carry flag to allow them
240     // to them to be chained together for add and sub of arbitrarily large
241     // values.
242     ADDE, SUBE,
243     
244     // Simple binary floating point operators.
245     FADD, FSUB, FMUL, FDIV, FREM,
246
247     // FCOPYSIGN(X, Y) - Return the value of X with the sign of Y.  NOTE: This
248     // DAG node does not require that X and Y have the same type, just that they
249     // are both floating point.  X and the result must have the same type.
250     // FCOPYSIGN(f32, f64) is allowed.
251     FCOPYSIGN,
252
253     // INT = FGETSIGN(FP) - Return the sign bit of the specified floating point
254     // value as an integer 0/1 value.
255     FGETSIGN,
256     
257     /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector
258     /// with the specified, possibly variable, elements.  The number of elements
259     /// is required to be a power of two.
260     BUILD_VECTOR,
261     
262     /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR with the element
263     /// at IDX replaced with VAL.  If the type of VAL is larger than the vector
264     /// element type then VAL is truncated before replacement.
265     INSERT_VECTOR_ELT,
266
267     /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
268     /// identified by the (potentially variable) element number IDX.
269     EXTRACT_VECTOR_ELT,
270     
271     /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
272     /// vector type with the same length and element type, this produces a
273     /// concatenated vector result value, with length equal to the sum of the
274     /// lengths of the input vectors.
275     CONCAT_VECTORS,
276     
277     /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
278     /// vector value) starting with the (potentially variable) element number
279     /// IDX, which must be a multiple of the result vector length.
280     EXTRACT_SUBVECTOR,
281
282     /// VECTOR_SHUFFLE(VEC1, VEC2, SHUFFLEVEC) - Returns a vector, of the same
283     /// type as VEC1/VEC2.  SHUFFLEVEC is a BUILD_VECTOR of constant int values
284     /// (maybe of an illegal datatype) or undef that indicate which value each
285     /// result element will get.  The elements of VEC1/VEC2 are enumerated in
286     /// order.  This is quite similar to the Altivec 'vperm' instruction, except
287     /// that the indices must be constants and are in terms of the element size
288     /// of VEC1/VEC2, not in terms of bytes.
289     VECTOR_SHUFFLE,
290
291     /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
292     /// scalar value into element 0 of the resultant vector type.  The top
293     /// elements 1 to N-1 of the N-element vector are undefined.
294     SCALAR_TO_VECTOR,
295     
296     // EXTRACT_SUBREG - This node is used to extract a sub-register value. 
297     // This node takes a superreg and a constant sub-register index as operands.
298     // Note sub-register indices must be increasing. That is, if the
299     // sub-register index of a 8-bit sub-register is N, then the index for a
300     // 16-bit sub-register must be at least N+1.
301     EXTRACT_SUBREG,
302     
303     // INSERT_SUBREG - This node is used to insert a sub-register value. 
304     // This node takes a superreg, a subreg value, and a constant sub-register
305     // index as operands.
306     INSERT_SUBREG,
307     
308     // MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing
309     // an unsigned/signed value of type i[2*N], then return the top part.
310     MULHU, MULHS,
311
312     // Bitwise operators - logical and, logical or, logical xor, shift left,
313     // shift right algebraic (shift in sign bits), shift right logical (shift in
314     // zeroes), rotate left, rotate right, and byteswap.
315     AND, OR, XOR, SHL, SRA, SRL, ROTL, ROTR, BSWAP,
316
317     // Counting operators
318     CTTZ, CTLZ, CTPOP,
319
320     // Select(COND, TRUEVAL, FALSEVAL)
321     SELECT, 
322     
323     // Select with condition operator - This selects between a true value and 
324     // a false value (ops #2 and #3) based on the boolean result of comparing
325     // the lhs and rhs (ops #0 and #1) of a conditional expression with the 
326     // condition code in op #4, a CondCodeSDNode.
327     SELECT_CC,
328
329     // SetCC operator - This evaluates to a boolean (i1) true value if the
330     // condition is true.  The operands to this are the left and right operands
331     // to compare (ops #0, and #1) and the condition code to compare them with
332     // (op #2) as a CondCodeSDNode.
333     SETCC,
334
335     // SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
336     // integer shift operations, just like ADD/SUB_PARTS.  The operation
337     // ordering is:
338     //       [Lo,Hi] = op [LoLHS,HiLHS], Amt
339     SHL_PARTS, SRA_PARTS, SRL_PARTS,
340
341     // Conversion operators.  These are all single input single output
342     // operations.  For all of these, the result type must be strictly
343     // wider or narrower (depending on the operation) than the source
344     // type.
345
346     // SIGN_EXTEND - Used for integer types, replicating the sign bit
347     // into new bits.
348     SIGN_EXTEND,
349
350     // ZERO_EXTEND - Used for integer types, zeroing the new bits.
351     ZERO_EXTEND,
352
353     // ANY_EXTEND - Used for integer types.  The high bits are undefined.
354     ANY_EXTEND,
355     
356     // TRUNCATE - Completely drop the high bits.
357     TRUNCATE,
358
359     // [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
360     // depends on the first letter) to floating point.
361     SINT_TO_FP,
362     UINT_TO_FP,
363
364     // SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
365     // sign extend a small value in a large integer register (e.g. sign
366     // extending the low 8 bits of a 32-bit register to fill the top 24 bits
367     // with the 7th bit).  The size of the smaller type is indicated by the 1th
368     // operand, a ValueType node.
369     SIGN_EXTEND_INREG,
370
371     /// FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
372     /// integer.
373     FP_TO_SINT,
374     FP_TO_UINT,
375
376     /// X = FP_ROUND(Y, TRUNC) - Rounding 'Y' from a larger floating point type
377     /// down to the precision of the destination VT.  TRUNC is a flag, which is
378     /// always an integer that is zero or one.  If TRUNC is 0, this is a
379     /// normal rounding, if it is 1, this FP_ROUND is known to not change the
380     /// value of Y.
381     ///
382     /// The TRUNC = 1 case is used in cases where we know that the value will
383     /// not be modified by the node, because Y is not using any of the extra
384     /// precision of source type.  This allows certain transformations like
385     /// FP_EXTEND(FP_ROUND(X,1)) -> X which are not safe for 
386     /// FP_EXTEND(FP_ROUND(X,0)) because the extra bits aren't removed.
387     FP_ROUND,
388     
389     // FLT_ROUNDS_ - Returns current rounding mode:
390     // -1 Undefined
391     //  0 Round to 0
392     //  1 Round to nearest
393     //  2 Round to +inf
394     //  3 Round to -inf
395     FLT_ROUNDS_,
396
397     /// X = FP_ROUND_INREG(Y, VT) - This operator takes an FP register, and
398     /// rounds it to a floating point value.  It then promotes it and returns it
399     /// in a register of the same size.  This operation effectively just
400     /// discards excess precision.  The type to round down to is specified by
401     /// the VT operand, a VTSDNode.
402     FP_ROUND_INREG,
403
404     /// X = FP_EXTEND(Y) - Extend a smaller FP type into a larger FP type.
405     FP_EXTEND,
406
407     // BIT_CONVERT - Theis operator converts between integer and FP values, as
408     // if one was stored to memory as integer and the other was loaded from the
409     // same address (or equivalently for vector format conversions, etc).  The 
410     // source and result are required to have the same bit size (e.g. 
411     // f32 <-> i32).  This can also be used for int-to-int or fp-to-fp 
412     // conversions, but that is a noop, deleted by getNode().
413     BIT_CONVERT,
414     
415     // FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW - Perform unary floating point
416     // negation, absolute value, square root, sine and cosine, powi, and pow
417     // operations.
418     FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
419     
420     // LOAD and STORE have token chains as their first operand, then the same
421     // operands as an LLVM load/store instruction, then an offset node that
422     // is added / subtracted from the base pointer to form the address (for
423     // indexed memory ops).
424     LOAD, STORE,
425
426     // DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
427     // to a specified boundary.  This node always has two return values: a new
428     // stack pointer value and a chain. The first operand is the token chain,
429     // the second is the number of bytes to allocate, and the third is the
430     // alignment boundary.  The size is guaranteed to be a multiple of the stack
431     // alignment, and the alignment is guaranteed to be bigger than the stack
432     // alignment (if required) or 0 to get standard stack alignment.
433     DYNAMIC_STACKALLOC,
434
435     // Control flow instructions.  These all have token chains.
436
437     // BR - Unconditional branch.  The first operand is the chain
438     // operand, the second is the MBB to branch to.
439     BR,
440
441     // BRIND - Indirect branch.  The first operand is the chain, the second
442     // is the value to branch to, which must be of the same type as the target's
443     // pointer type.
444     BRIND,
445
446     // BR_JT - Jumptable branch. The first operand is the chain, the second
447     // is the jumptable index, the last one is the jumptable entry index.
448     BR_JT,
449     
450     // BRCOND - Conditional branch.  The first operand is the chain,
451     // the second is the condition, the third is the block to branch
452     // to if the condition is true.
453     BRCOND,
454
455     // BR_CC - Conditional branch.  The behavior is like that of SELECT_CC, in
456     // that the condition is represented as condition code, and two nodes to
457     // compare, rather than as a combined SetCC node.  The operands in order are
458     // chain, cc, lhs, rhs, block to branch to if condition is true.
459     BR_CC,
460     
461     // RET - Return from function.  The first operand is the chain,
462     // and any subsequent operands are pairs of return value and return value
463     // signness for the function.  This operation can have variable number of
464     // operands.
465     RET,
466
467     // INLINEASM - Represents an inline asm block.  This node always has two
468     // return values: a chain and a flag result.  The inputs are as follows:
469     //   Operand #0   : Input chain.
470     //   Operand #1   : a ExternalSymbolSDNode with a pointer to the asm string.
471     //   Operand #2n+2: A RegisterNode.
472     //   Operand #2n+3: A TargetConstant, indicating if the reg is a use/def
473     //   Operand #last: Optional, an incoming flag.
474     INLINEASM,
475     
476     // LABEL - Represents a label in mid basic block used to track
477     // locations needed for debug and exception handling tables.  This node
478     // returns a chain.
479     //   Operand #0 : input chain.
480     //   Operand #1 : module unique number use to identify the label.
481     //   Operand #2 : 0 indicates a debug label (e.g. stoppoint), 1 indicates
482     //                a EH label, 2 indicates unknown label type.
483     LABEL,
484
485     // DECLARE - Represents a llvm.dbg.declare intrinsic. It's used to track
486     // local variable declarations for debugging information. First operand is
487     // a chain, while the next two operands are first two arguments (address
488     // and variable) of a llvm.dbg.declare instruction.
489     DECLARE,
490     
491     // STACKSAVE - STACKSAVE has one operand, an input chain.  It produces a
492     // value, the same type as the pointer type for the system, and an output
493     // chain.
494     STACKSAVE,
495     
496     // STACKRESTORE has two operands, an input chain and a pointer to restore to
497     // it returns an output chain.
498     STACKRESTORE,
499     
500     // CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end of
501     // a call sequence, and carry arbitrary information that target might want
502     // to know.  The first operand is a chain, the rest are specified by the
503     // target and not touched by the DAG optimizers.
504     // CALLSEQ_START..CALLSEQ_END pairs may not be nested.
505     CALLSEQ_START,  // Beginning of a call sequence
506     CALLSEQ_END,    // End of a call sequence
507     
508     // VAARG - VAARG has three operands: an input chain, a pointer, and a 
509     // SRCVALUE.  It returns a pair of values: the vaarg value and a new chain.
510     VAARG,
511     
512     // VACOPY - VACOPY has five operands: an input chain, a destination pointer,
513     // a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
514     // source.
515     VACOPY,
516     
517     // VAEND, VASTART - VAEND and VASTART have three operands: an input chain, a
518     // pointer, and a SRCVALUE.
519     VAEND, VASTART,
520
521     // SRCVALUE - This is a node type that holds a Value* that is used to
522     // make reference to a value in the LLVM IR.
523     SRCVALUE,
524
525     // MEMOPERAND - This is a node that contains a MachineMemOperand which
526     // records information about a memory reference. This is used to make
527     // AliasAnalysis queries from the backend.
528     MEMOPERAND,
529
530     // PCMARKER - This corresponds to the pcmarker intrinsic.
531     PCMARKER,
532
533     // READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
534     // The only operand is a chain and a value and a chain are produced.  The
535     // value is the contents of the architecture specific cycle counter like 
536     // register (or other high accuracy low latency clock source)
537     READCYCLECOUNTER,
538
539     // HANDLENODE node - Used as a handle for various purposes.
540     HANDLENODE,
541
542     // LOCATION - This node is used to represent a source location for debug
543     // info.  It takes token chain as input, then a line number, then a column
544     // number, then a filename, then a working dir.  It produces a token chain
545     // as output.
546     LOCATION,
547     
548     // DEBUG_LOC - This node is used to represent source line information
549     // embedded in the code.  It takes a token chain as input, then a line
550     // number, then a column then a file id (provided by MachineModuleInfo.) It
551     // produces a token chain as output.
552     DEBUG_LOC,
553
554     // TRAMPOLINE - This corresponds to the init_trampoline intrinsic.
555     // It takes as input a token chain, the pointer to the trampoline,
556     // the pointer to the nested function, the pointer to pass for the
557     // 'nest' parameter, a SRCVALUE for the trampoline and another for
558     // the nested function (allowing targets to access the original
559     // Function*).  It produces the result of the intrinsic and a token
560     // chain as output.
561     TRAMPOLINE,
562
563     // TRAP - Trapping instruction
564     TRAP,
565
566     // PREFETCH - This corresponds to a prefetch intrinsic. It takes chains are
567     // their first operand. The other operands are the address to prefetch,
568     // read / write specifier, and locality specifier.
569     PREFETCH,
570
571     // OUTCHAIN = MEMBARRIER(INCHAIN, load-load, load-store, store-load, 
572     //                       store-store, device)
573     // This corresponds to the memory.barrier intrinsic.
574     // it takes an input chain, 4 operands to specify the type of barrier, an
575     // operand specifying if the barrier applies to device and uncached memory
576     // and produces an output chain.
577     MEMBARRIER,
578
579     // Val, OUTCHAIN = ATOMIC_LCS(INCHAIN, ptr, cmp, swap)
580     // this corresponds to the atomic.lcs intrinsic.
581     // cmp is compared to *ptr, and if equal, swap is stored in *ptr.
582     // the return is always the original value in *ptr
583     ATOMIC_LCS,
584
585     // Val, OUTCHAIN = ATOMIC_LAS(INCHAIN, ptr, amt)
586     // this corresponds to the atomic.las intrinsic.
587     // *ptr + amt is stored to *ptr atomically.
588     // the return is always the original value in *ptr
589     ATOMIC_LAS,
590
591     // Val, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amt)
592     // this corresponds to the atomic.swap intrinsic.
593     // amt is stored to *ptr atomically.
594     // the return is always the original value in *ptr
595     ATOMIC_SWAP,
596
597     // BUILTIN_OP_END - This must be the last enum value in this list.
598     BUILTIN_OP_END
599   };
600
601   /// Node predicates
602
603   /// isBuildVectorAllOnes - Return true if the specified node is a
604   /// BUILD_VECTOR where all of the elements are ~0 or undef.
605   bool isBuildVectorAllOnes(const SDNode *N);
606
607   /// isBuildVectorAllZeros - Return true if the specified node is a
608   /// BUILD_VECTOR where all of the elements are 0 or undef.
609   bool isBuildVectorAllZeros(const SDNode *N);
610
611   /// isScalarToVector - Return true if the specified node is a
612   /// ISD::SCALAR_TO_VECTOR node or a BUILD_VECTOR node where only the low
613   /// element is not an undef.
614   bool isScalarToVector(const SDNode *N);
615
616   /// isDebugLabel - Return true if the specified node represents a debug
617   /// label (i.e. ISD::LABEL or TargetInstrInfo::LABEL node and third operand
618   /// is 0).
619   bool isDebugLabel(const SDNode *N);
620   
621   //===--------------------------------------------------------------------===//
622   /// MemIndexedMode enum - This enum defines the load / store indexed 
623   /// addressing modes.
624   ///
625   /// UNINDEXED    "Normal" load / store. The effective address is already
626   ///              computed and is available in the base pointer. The offset
627   ///              operand is always undefined. In addition to producing a
628   ///              chain, an unindexed load produces one value (result of the
629   ///              load); an unindexed store does not produce a value.
630   ///
631   /// PRE_INC      Similar to the unindexed mode where the effective address is
632   /// PRE_DEC      the value of the base pointer add / subtract the offset.
633   ///              It considers the computation as being folded into the load /
634   ///              store operation (i.e. the load / store does the address
635   ///              computation as well as performing the memory transaction).
636   ///              The base operand is always undefined. In addition to
637   ///              producing a chain, pre-indexed load produces two values
638   ///              (result of the load and the result of the address
639   ///              computation); a pre-indexed store produces one value (result
640   ///              of the address computation).
641   ///
642   /// POST_INC     The effective address is the value of the base pointer. The
643   /// POST_DEC     value of the offset operand is then added to / subtracted
644   ///              from the base after memory transaction. In addition to
645   ///              producing a chain, post-indexed load produces two values
646   ///              (the result of the load and the result of the base +/- offset
647   ///              computation); a post-indexed store produces one value (the
648   ///              the result of the base +/- offset computation).
649   ///
650   enum MemIndexedMode {
651     UNINDEXED = 0,
652     PRE_INC,
653     PRE_DEC,
654     POST_INC,
655     POST_DEC,
656     LAST_INDEXED_MODE
657   };
658
659   //===--------------------------------------------------------------------===//
660   /// LoadExtType enum - This enum defines the three variants of LOADEXT
661   /// (load with extension).
662   ///
663   /// SEXTLOAD loads the integer operand and sign extends it to a larger
664   ///          integer result type.
665   /// ZEXTLOAD loads the integer operand and zero extends it to a larger
666   ///          integer result type.
667   /// EXTLOAD  is used for three things: floating point extending loads, 
668   ///          integer extending loads [the top bits are undefined], and vector
669   ///          extending loads [load into low elt].
670   ///
671   enum LoadExtType {
672     NON_EXTLOAD = 0,
673     EXTLOAD,
674     SEXTLOAD,
675     ZEXTLOAD,
676     LAST_LOADX_TYPE
677   };
678
679   //===--------------------------------------------------------------------===//
680   /// ISD::CondCode enum - These are ordered carefully to make the bitfields
681   /// below work out, when considering SETFALSE (something that never exists
682   /// dynamically) as 0.  "U" -> Unsigned (for integer operands) or Unordered
683   /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
684   /// to.  If the "N" column is 1, the result of the comparison is undefined if
685   /// the input is a NAN.
686   ///
687   /// All of these (except for the 'always folded ops') should be handled for
688   /// floating point.  For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
689   /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
690   ///
691   /// Note that these are laid out in a specific order to allow bit-twiddling
692   /// to transform conditions.
693   enum CondCode {
694     // Opcode          N U L G E       Intuitive operation
695     SETFALSE,      //    0 0 0 0       Always false (always folded)
696     SETOEQ,        //    0 0 0 1       True if ordered and equal
697     SETOGT,        //    0 0 1 0       True if ordered and greater than
698     SETOGE,        //    0 0 1 1       True if ordered and greater than or equal
699     SETOLT,        //    0 1 0 0       True if ordered and less than
700     SETOLE,        //    0 1 0 1       True if ordered and less than or equal
701     SETONE,        //    0 1 1 0       True if ordered and operands are unequal
702     SETO,          //    0 1 1 1       True if ordered (no nans)
703     SETUO,         //    1 0 0 0       True if unordered: isnan(X) | isnan(Y)
704     SETUEQ,        //    1 0 0 1       True if unordered or equal
705     SETUGT,        //    1 0 1 0       True if unordered or greater than
706     SETUGE,        //    1 0 1 1       True if unordered, greater than, or equal
707     SETULT,        //    1 1 0 0       True if unordered or less than
708     SETULE,        //    1 1 0 1       True if unordered, less than, or equal
709     SETUNE,        //    1 1 1 0       True if unordered or not equal
710     SETTRUE,       //    1 1 1 1       Always true (always folded)
711     // Don't care operations: undefined if the input is a nan.
712     SETFALSE2,     //  1 X 0 0 0       Always false (always folded)
713     SETEQ,         //  1 X 0 0 1       True if equal
714     SETGT,         //  1 X 0 1 0       True if greater than
715     SETGE,         //  1 X 0 1 1       True if greater than or equal
716     SETLT,         //  1 X 1 0 0       True if less than
717     SETLE,         //  1 X 1 0 1       True if less than or equal
718     SETNE,         //  1 X 1 1 0       True if not equal
719     SETTRUE2,      //  1 X 1 1 1       Always true (always folded)
720
721     SETCC_INVALID       // Marker value.
722   };
723
724   /// isSignedIntSetCC - Return true if this is a setcc instruction that
725   /// performs a signed comparison when used with integer operands.
726   inline bool isSignedIntSetCC(CondCode Code) {
727     return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
728   }
729
730   /// isUnsignedIntSetCC - Return true if this is a setcc instruction that
731   /// performs an unsigned comparison when used with integer operands.
732   inline bool isUnsignedIntSetCC(CondCode Code) {
733     return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
734   }
735
736   /// isTrueWhenEqual - Return true if the specified condition returns true if
737   /// the two operands to the condition are equal.  Note that if one of the two
738   /// operands is a NaN, this value is meaningless.
739   inline bool isTrueWhenEqual(CondCode Cond) {
740     return ((int)Cond & 1) != 0;
741   }
742
743   /// getUnorderedFlavor - This function returns 0 if the condition is always
744   /// false if an operand is a NaN, 1 if the condition is always true if the
745   /// operand is a NaN, and 2 if the condition is undefined if the operand is a
746   /// NaN.
747   inline unsigned getUnorderedFlavor(CondCode Cond) {
748     return ((int)Cond >> 3) & 3;
749   }
750
751   /// getSetCCInverse - Return the operation corresponding to !(X op Y), where
752   /// 'op' is a valid SetCC operation.
753   CondCode getSetCCInverse(CondCode Operation, bool isInteger);
754
755   /// getSetCCSwappedOperands - Return the operation corresponding to (Y op X)
756   /// when given the operation for (X op Y).
757   CondCode getSetCCSwappedOperands(CondCode Operation);
758
759   /// getSetCCOrOperation - Return the result of a logical OR between different
760   /// comparisons of identical values: ((X op1 Y) | (X op2 Y)).  This
761   /// function returns SETCC_INVALID if it is not possible to represent the
762   /// resultant comparison.
763   CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
764
765   /// getSetCCAndOperation - Return the result of a logical AND between
766   /// different comparisons of identical values: ((X op1 Y) & (X op2 Y)).  This
767   /// function returns SETCC_INVALID if it is not possible to represent the
768   /// resultant comparison.
769   CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
770 }  // end llvm::ISD namespace
771
772
773 //===----------------------------------------------------------------------===//
774 /// SDOperand - Unlike LLVM values, Selection DAG nodes may return multiple
775 /// values as the result of a computation.  Many nodes return multiple values,
776 /// from loads (which define a token and a return value) to ADDC (which returns
777 /// a result and a carry value), to calls (which may return an arbitrary number
778 /// of values).
779 ///
780 /// As such, each use of a SelectionDAG computation must indicate the node that
781 /// computes it as well as which return value to use from that node.  This pair
782 /// of information is represented with the SDOperand value type.
783 ///
784 class SDOperand {
785 public:
786   SDNode *Val;        // The node defining the value we are using.
787   unsigned ResNo;     // Which return value of the node we are using.
788
789   SDOperand() : Val(0), ResNo(0) {}
790   SDOperand(SDNode *val, unsigned resno) : Val(val), ResNo(resno) {}
791
792   bool operator==(const SDOperand &O) const {
793     return Val == O.Val && ResNo == O.ResNo;
794   }
795   bool operator!=(const SDOperand &O) const {
796     return !operator==(O);
797   }
798   bool operator<(const SDOperand &O) const {
799     return Val < O.Val || (Val == O.Val && ResNo < O.ResNo);
800   }
801
802   SDOperand getValue(unsigned R) const {
803     return SDOperand(Val, R);
804   }
805
806   // isOperandOf - Return true if this node is an operand of N.
807   bool isOperandOf(SDNode *N) const;
808
809   /// getValueType - Return the ValueType of the referenced return value.
810   ///
811   inline MVT::ValueType getValueType() const;
812
813   /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType()).
814   ///
815   unsigned getValueSizeInBits() const {
816     return MVT::getSizeInBits(getValueType());
817   }
818
819   // Forwarding methods - These forward to the corresponding methods in SDNode.
820   inline unsigned getOpcode() const;
821   inline unsigned getNumOperands() const;
822   inline const SDOperand &getOperand(unsigned i) const;
823   inline uint64_t getConstantOperandVal(unsigned i) const;
824   inline bool isTargetOpcode() const;
825   inline unsigned getTargetOpcode() const;
826
827   
828   /// reachesChainWithoutSideEffects - Return true if this operand (which must
829   /// be a chain) reaches the specified operand without crossing any 
830   /// side-effecting instructions.  In practice, this looks through token
831   /// factors and non-volatile loads.  In order to remain efficient, this only
832   /// looks a couple of nodes in, it does not do an exhaustive search.
833   bool reachesChainWithoutSideEffects(SDOperand Dest, 
834                                       unsigned Depth = 2) const;
835   
836   /// hasOneUse - Return true if there is exactly one operation using this
837   /// result value of the defining operator.
838   inline bool hasOneUse() const;
839
840   /// use_empty - Return true if there are no operations using this
841   /// result value of the defining operator.
842   inline bool use_empty() const;
843 };
844
845
846 template<> struct DenseMapInfo<SDOperand> {
847   static inline SDOperand getEmptyKey() { 
848     return SDOperand((SDNode*)-1, -1U); 
849   }
850   static inline SDOperand getTombstoneKey() { 
851     return SDOperand((SDNode*)-1, 0);
852   }
853   static unsigned getHashValue(const SDOperand &Val) {
854     return ((unsigned)((uintptr_t)Val.Val >> 4) ^
855             (unsigned)((uintptr_t)Val.Val >> 9)) + Val.ResNo;
856   }
857   static bool isEqual(const SDOperand &LHS, const SDOperand &RHS) {
858     return LHS == RHS;
859   }
860   static bool isPod() { return true; }
861 };
862
863 /// simplify_type specializations - Allow casting operators to work directly on
864 /// SDOperands as if they were SDNode*'s.
865 template<> struct simplify_type<SDOperand> {
866   typedef SDNode* SimpleType;
867   static SimpleType getSimplifiedValue(const SDOperand &Val) {
868     return static_cast<SimpleType>(Val.Val);
869   }
870 };
871 template<> struct simplify_type<const SDOperand> {
872   typedef SDNode* SimpleType;
873   static SimpleType getSimplifiedValue(const SDOperand &Val) {
874     return static_cast<SimpleType>(Val.Val);
875   }
876 };
877
878 /// SDUse - Represents a use of the SDNode referred by
879 /// the SDOperand.
880 class SDUse {
881   SDOperand Operand;
882   /// parent - Parent node of this operand.
883   SDNode    *parent;
884   /// Prev, next - Pointers to the uses list of the SDNode referred by 
885   /// this operand.
886   SDUse **Prev, *Next;
887 public:
888   friend class SDNode;
889   SDUse(): Operand(), parent(NULL), Prev(NULL), Next(NULL) {}
890
891   SDUse(SDNode *val, unsigned resno) : 
892     Operand(val,resno), parent(NULL), Prev(NULL), Next(NULL) {}
893
894
895   SDUse& operator= (SDOperand& Op) {
896       Operand = Op;
897       Next = NULL;
898       Prev = NULL;
899       return *this;
900   }
901
902   SDUse& operator= (const SDOperand& Op) {
903       Operand = Op;
904       Next = NULL;
905       Prev = NULL;
906       return *this;
907   }
908
909   SDUse& operator= (SDUse& Op) {
910       Operand = Op;
911       Next = NULL;
912       Prev = NULL;
913       return *this;
914   }
915
916   SDUse& operator= (const SDUse& Op) {
917       Operand = Op;
918       Next = NULL;
919       Prev = NULL;
920       return *this;
921   }
922
923   SDUse * getNext() { return Next; }
924
925   SDNode *getUser() { return parent; }
926
927   void setUser(SDNode *p) { parent = p; }
928
929   operator SDOperand() const { return Operand; }
930
931   const SDOperand& getSDOperand() const { return Operand; }
932
933   SDNode* &getVal () { return Operand.Val; }
934
935   bool operator==(const SDOperand &O) const {
936     return Operand == O;
937   }
938
939   bool operator!=(const SDOperand &O) const {
940     return !(Operand == O);
941   }
942
943   bool operator<(const SDOperand &O) const {
944     return Operand < O;
945   }
946
947 protected:
948   void addToList(SDUse **List) {
949     Next = *List;
950     if (Next) Next->Prev = &Next;
951     Prev = List;
952     *List = this;
953   }
954
955   void removeFromList() {
956     *Prev = Next;
957     if (Next) Next->Prev = Prev;
958   }
959 };
960
961
962 /// simplify_type specializations - Allow casting operators to work directly on
963 /// SDOperands as if they were SDNode*'s.
964 template<> struct simplify_type<SDUse> {
965   typedef SDNode* SimpleType;
966   static SimpleType getSimplifiedValue(const SDUse &Val) {
967     return static_cast<SimpleType>(Val.getSDOperand().Val);
968   }
969 };
970 template<> struct simplify_type<const SDUse> {
971   typedef SDNode* SimpleType;
972   static SimpleType getSimplifiedValue(const SDUse &Val) {
973     return static_cast<SimpleType>(Val.getSDOperand().Val);
974   }
975 };
976
977
978 /// SDOperandPtr - A helper SDOperand poiner class, that can handle
979 /// arrays of SDUse and arrays of SDOperand objects. This is required
980 /// in many places inside the SelectionDAG.
981 /// 
982 class SDOperandPtr {
983   const SDOperand *ptr; // The pointer to the SDOperand object
984   int object_size;      // The size of the object containg the SDOperand
985 public:
986   SDOperandPtr(SDUse * use_ptr) { 
987     ptr = &use_ptr->getSDOperand(); 
988     object_size = sizeof(SDUse); 
989   }
990
991   SDOperandPtr(const SDOperand * op_ptr) { 
992     ptr = op_ptr; 
993     object_size = sizeof(SDOperand); 
994   }
995
996   operator const SDOperand *() const {
997     assert(object_size == sizeof(SDOperand) && 
998            "Only SDOperand can be converted");
999     return ptr;
1000   }
1001
1002   const SDOperand operator *() { return *ptr; }
1003   const SDOperand *operator ->() { return ptr; }
1004   SDOperandPtr operator ++ () { 
1005     ptr = (SDOperand*)((char *)ptr + object_size); 
1006     return *this; 
1007   }
1008
1009   SDOperandPtr operator ++ (int) { 
1010     SDOperandPtr tmp = *this;
1011     ptr = (SDOperand*)((char *)ptr + object_size); 
1012     return tmp; 
1013   }
1014
1015   SDOperand operator[] (int idx) const {
1016     return *(SDOperand*)((char*) ptr + object_size * idx);
1017   } 
1018 };
1019
1020 /// SDNode - Represents one node in the SelectionDAG.
1021 ///
1022 class SDNode : public FoldingSetNode {
1023 private:
1024   /// NodeType - The operation that this node performs.
1025   ///
1026   unsigned short NodeType;
1027   
1028   /// OperandsNeedDelete - This is true if OperandList was new[]'d.  If true,
1029   /// then they will be delete[]'d when the node is destroyed.
1030   bool OperandsNeedDelete : 1;
1031
1032   /// NodeId - Unique id per SDNode in the DAG.
1033   int NodeId;
1034
1035   /// OperandList - The values that are used by this operation.
1036   ///
1037   SDUse *OperandList;
1038   
1039   /// ValueList - The types of the values this node defines.  SDNode's may
1040   /// define multiple values simultaneously.
1041   const MVT::ValueType *ValueList;
1042
1043   /// NumOperands/NumValues - The number of entries in the Operand/Value list.
1044   unsigned short NumOperands, NumValues;
1045   
1046   /// Prev/Next pointers - These pointers form the linked list of of the
1047   /// AllNodes list in the current DAG.
1048   SDNode *Prev, *Next;
1049   friend struct ilist_traits<SDNode>;
1050
1051   /// UsesSize - The size of the uses list.
1052   unsigned UsesSize;
1053
1054   /// Uses - List of uses for this SDNode.
1055   SDUse *Uses;
1056
1057   /// addUse - add SDUse to the list of uses.
1058   void addUse(SDUse &U) { U.addToList(&Uses); }
1059
1060   // Out-of-line virtual method to give class a home.
1061   virtual void ANCHOR();
1062 public:
1063   virtual ~SDNode() {
1064     assert(NumOperands == 0 && "Operand list not cleared before deletion");
1065     NodeType = ISD::DELETED_NODE;
1066   }
1067   
1068   //===--------------------------------------------------------------------===//
1069   //  Accessors
1070   //
1071   unsigned getOpcode()  const { return NodeType; }
1072   bool isTargetOpcode() const { return NodeType >= ISD::BUILTIN_OP_END; }
1073   unsigned getTargetOpcode() const {
1074     assert(isTargetOpcode() && "Not a target opcode!");
1075     return NodeType - ISD::BUILTIN_OP_END;
1076   }
1077
1078   size_t use_size() const { return UsesSize; }
1079   bool use_empty() const { return Uses == NULL; }
1080   bool hasOneUse() const { return use_size() == 1; }
1081
1082   /// getNodeId - Return the unique node id.
1083   ///
1084   int getNodeId() const { return NodeId; }
1085
1086   /// setNodeId - Set unique node id.
1087   void setNodeId(int Id) { NodeId = Id; }
1088
1089   /// use_iterator - This class provides iterator support for SDUse
1090   /// operands that use a specific SDNode. 
1091   class use_iterator
1092     : public forward_iterator<SDUse, ptrdiff_t> {
1093     SDUse *Op;
1094     explicit use_iterator(SDUse *op) : Op(op) {
1095     }
1096     friend class SDNode;
1097   public:
1098     typedef forward_iterator<SDUse, ptrdiff_t>::reference reference;
1099     typedef forward_iterator<SDUse, ptrdiff_t>::pointer pointer;
1100
1101     use_iterator(const use_iterator &I) : Op(I.Op) {}
1102     use_iterator() : Op(0) {}
1103
1104     bool operator==(const use_iterator &x) const {
1105       return Op == x.Op;
1106     }
1107     bool operator!=(const use_iterator &x) const {
1108       return !operator==(x);
1109     }
1110  
1111     /// atEnd - return true if this iterator is at the end of uses list.
1112     bool atEnd() const { return Op == 0; }
1113
1114     // Iterator traversal: forward iteration only.
1115     use_iterator &operator++() {          // Preincrement
1116       assert(Op && "Cannot increment end iterator!");
1117       Op = Op->getNext();
1118       return *this;
1119     }
1120
1121     use_iterator operator++(int) {        // Postincrement
1122       use_iterator tmp = *this; ++*this; return tmp;
1123     }
1124
1125
1126     /// getOperandNum - Retrive a number of a current operand.
1127     unsigned getOperandNum() const {
1128       assert(Op && "Cannot dereference end iterator!");
1129       return (Op - Op->getUser()->OperandList);
1130     }
1131
1132     /// Retrieve a reference to the current operand.
1133     SDUse &operator*() const {
1134       assert(Op && "Cannot dereference end iterator!");
1135       return *Op;
1136     }
1137
1138     /// Retrieve a pointer to the current operand.
1139     SDUse *operator->() const {
1140       assert(Op && "Cannot dereference end iterator!");
1141       return Op;
1142     }
1143   };
1144
1145   /// use_begin/use_end - Provide iteration support to walk over all uses
1146   /// of an SDNode.
1147
1148   use_iterator use_begin(SDNode *node) const {
1149     return use_iterator(node->Uses);
1150   }
1151
1152   use_iterator use_begin() const {
1153     return use_iterator(Uses);
1154   }
1155
1156   static use_iterator use_end() { return use_iterator(0); }
1157
1158
1159   /// hasNUsesOfValue - Return true if there are exactly NUSES uses of the
1160   /// indicated value.  This method ignores uses of other values defined by this
1161   /// operation.
1162   bool hasNUsesOfValue(unsigned NUses, unsigned Value) const;
1163
1164   /// hasAnyUseOfValue - Return true if there are any use of the indicated
1165   /// value. This method ignores uses of other values defined by this operation.
1166   bool hasAnyUseOfValue(unsigned Value) const;
1167
1168   /// isOnlyUseOf - Return true if this node is the only use of N.
1169   ///
1170   bool isOnlyUseOf(SDNode *N) const;
1171
1172   /// isOperandOf - Return true if this node is an operand of N.
1173   ///
1174   bool isOperandOf(SDNode *N) const;
1175
1176   /// isPredecessorOf - Return true if this node is a predecessor of N. This
1177   /// node is either an operand of N or it can be reached by recursively
1178   /// traversing up the operands.
1179   /// NOTE: this is an expensive method. Use it carefully.
1180   bool isPredecessorOf(SDNode *N) const;
1181
1182   /// getNumOperands - Return the number of values used by this operation.
1183   ///
1184   unsigned getNumOperands() const { return NumOperands; }
1185
1186   /// getConstantOperandVal - Helper method returns the integer value of a 
1187   /// ConstantSDNode operand.
1188   uint64_t getConstantOperandVal(unsigned Num) const;
1189
1190   const SDOperand &getOperand(unsigned Num) const {
1191     assert(Num < NumOperands && "Invalid child # of SDNode!");
1192     return OperandList[Num].getSDOperand();
1193   }
1194
1195   typedef SDUse* op_iterator;
1196   op_iterator op_begin() const { return OperandList; }
1197   op_iterator op_end() const { return OperandList+NumOperands; }
1198
1199
1200   SDVTList getVTList() const {
1201     SDVTList X = { ValueList, NumValues };
1202     return X;
1203   };
1204   
1205   /// getNumValues - Return the number of values defined/returned by this
1206   /// operator.
1207   ///
1208   unsigned getNumValues() const { return NumValues; }
1209
1210   /// getValueType - Return the type of a specified result.
1211   ///
1212   MVT::ValueType getValueType(unsigned ResNo) const {
1213     assert(ResNo < NumValues && "Illegal result number!");
1214     return ValueList[ResNo];
1215   }
1216
1217   /// getValueSizeInBits - Returns MVT::getSizeInBits(getValueType(ResNo)).
1218   ///
1219   unsigned getValueSizeInBits(unsigned ResNo) const {
1220     return MVT::getSizeInBits(getValueType(ResNo));
1221   }
1222
1223   typedef const MVT::ValueType* value_iterator;
1224   value_iterator value_begin() const { return ValueList; }
1225   value_iterator value_end() const { return ValueList+NumValues; }
1226
1227   /// getOperationName - Return the opcode of this operation for printing.
1228   ///
1229   std::string getOperationName(const SelectionDAG *G = 0) const;
1230   static const char* getIndexedModeName(ISD::MemIndexedMode AM);
1231   void dump() const;
1232   void dump(const SelectionDAG *G) const;
1233
1234   static bool classof(const SDNode *) { return true; }
1235
1236   /// Profile - Gather unique data for the node.
1237   ///
1238   void Profile(FoldingSetNodeID &ID);
1239
1240 protected:
1241   friend class SelectionDAG;
1242   
1243   /// getValueTypeList - Return a pointer to the specified value type.
1244   ///
1245   static const MVT::ValueType *getValueTypeList(MVT::ValueType VT);
1246   static SDVTList getSDVTList(MVT::ValueType VT) {
1247     SDVTList Ret = { getValueTypeList(VT), 1 };
1248     return Ret;
1249   }
1250
1251   SDNode(unsigned Opc, SDVTList VTs, const SDOperand *Ops, unsigned NumOps)
1252     : NodeType(Opc), NodeId(-1), UsesSize(0), Uses(NULL) {
1253     OperandsNeedDelete = true;
1254     NumOperands = NumOps;
1255     OperandList = NumOps ? new SDUse[NumOperands] : 0;
1256     
1257     for (unsigned i = 0; i != NumOps; ++i) {
1258       OperandList[i] = Ops[i];
1259       OperandList[i].setUser(this);
1260       Ops[i].Val->addUse(OperandList[i]);
1261       ++Ops[i].Val->UsesSize;
1262     }
1263     
1264     ValueList = VTs.VTs;
1265     NumValues = VTs.NumVTs;
1266     Prev = 0; Next = 0;
1267   }
1268
1269   SDNode(unsigned Opc, SDVTList VTs, SDOperandPtr Ops, unsigned NumOps)
1270     : NodeType(Opc), NodeId(-1), UsesSize(0), Uses(NULL) {
1271     OperandsNeedDelete = true;
1272     NumOperands = NumOps;
1273     OperandList = NumOps ? new SDUse[NumOperands] : 0;
1274     
1275     for (unsigned i = 0; i != NumOps; ++i) {
1276       OperandList[i] = Ops[i];
1277       OperandList[i].setUser(this);
1278       Ops[i].Val->addUse(OperandList[i]);
1279       ++Ops[i].Val->UsesSize;
1280     }
1281     
1282     ValueList = VTs.VTs;
1283     NumValues = VTs.NumVTs;
1284     Prev = 0; Next = 0;
1285   }
1286
1287   SDNode(unsigned Opc, SDVTList VTs)
1288     : NodeType(Opc), NodeId(-1), UsesSize(0), Uses(NULL) {
1289     OperandsNeedDelete = false;  // Operands set with InitOperands.
1290     NumOperands = 0;
1291     OperandList = 0;
1292     ValueList = VTs.VTs;
1293     NumValues = VTs.NumVTs;
1294     Prev = 0; Next = 0;
1295   }
1296   
1297   /// InitOperands - Initialize the operands list of this node with the
1298   /// specified values, which are part of the node (thus they don't need to be
1299   /// copied in or allocated).
1300   void InitOperands(SDUse *Ops, unsigned NumOps) {
1301     assert(OperandList == 0 && "Operands already set!");
1302     NumOperands = NumOps;
1303     OperandList = Ops;
1304     UsesSize = 0;
1305     Uses = NULL;
1306     
1307     for (unsigned i = 0; i != NumOps; ++i) {
1308       OperandList[i].setUser(this);
1309       Ops[i].getVal()->addUse(OperandList[i]);
1310       ++Ops[i].getVal()->UsesSize;
1311     }
1312   }
1313   
1314   /// MorphNodeTo - This frees the operands of the current node, resets the
1315   /// opcode, types, and operands to the specified value.  This should only be
1316   /// used by the SelectionDAG class.
1317   void MorphNodeTo(unsigned Opc, SDVTList L,
1318                    const SDOperand *Ops, unsigned NumOps);
1319   
1320   void addUser(unsigned i, SDNode *User) {
1321     assert(User->OperandList[i].getUser() && "Node without parent");
1322     addUse(User->OperandList[i]);
1323     ++UsesSize;
1324   }
1325
1326   void removeUser(unsigned i, SDNode *User) {
1327     assert(User->OperandList[i].getUser() && "Node without parent");
1328     SDUse &Op = User->OperandList[i];
1329     Op.removeFromList();
1330     --UsesSize;
1331   }
1332 };
1333
1334
1335 // Define inline functions from the SDOperand class.
1336
1337 inline unsigned SDOperand::getOpcode() const {
1338   return Val->getOpcode();
1339 }
1340 inline MVT::ValueType SDOperand::getValueType() const {
1341   return Val->getValueType(ResNo);
1342 }
1343 inline unsigned SDOperand::getNumOperands() const {
1344   return Val->getNumOperands();
1345 }
1346 inline const SDOperand &SDOperand::getOperand(unsigned i) const {
1347   return Val->getOperand(i);
1348 }
1349 inline uint64_t SDOperand::getConstantOperandVal(unsigned i) const {
1350   return Val->getConstantOperandVal(i);
1351 }
1352 inline bool SDOperand::isTargetOpcode() const {
1353   return Val->isTargetOpcode();
1354 }
1355 inline unsigned SDOperand::getTargetOpcode() const {
1356   return Val->getTargetOpcode();
1357 }
1358 inline bool SDOperand::hasOneUse() const {
1359   return Val->hasNUsesOfValue(1, ResNo);
1360 }
1361 inline bool SDOperand::use_empty() const {
1362   return !Val->hasAnyUseOfValue(ResNo);
1363 }
1364
1365 /// UnarySDNode - This class is used for single-operand SDNodes.  This is solely
1366 /// to allow co-allocation of node operands with the node itself.
1367 class UnarySDNode : public SDNode {
1368   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1369   SDUse Op;
1370 public:
1371   UnarySDNode(unsigned Opc, SDVTList VTs, SDOperand X)
1372     : SDNode(Opc, VTs) {
1373     Op = X;
1374     InitOperands(&Op, 1);
1375   }
1376 };
1377
1378 /// BinarySDNode - This class is used for two-operand SDNodes.  This is solely
1379 /// to allow co-allocation of node operands with the node itself.
1380 class BinarySDNode : public SDNode {
1381   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1382   SDUse Ops[2];
1383 public:
1384   BinarySDNode(unsigned Opc, SDVTList VTs, SDOperand X, SDOperand Y)
1385     : SDNode(Opc, VTs) {
1386     Ops[0] = X;
1387     Ops[1] = Y;
1388     InitOperands(Ops, 2);
1389   }
1390 };
1391
1392 /// TernarySDNode - This class is used for three-operand SDNodes. This is solely
1393 /// to allow co-allocation of node operands with the node itself.
1394 class TernarySDNode : public SDNode {
1395   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1396   SDUse Ops[3];
1397 public:
1398   TernarySDNode(unsigned Opc, SDVTList VTs, SDOperand X, SDOperand Y,
1399                 SDOperand Z)
1400     : SDNode(Opc, VTs) {
1401     Ops[0] = X;
1402     Ops[1] = Y;
1403     Ops[2] = Z;
1404     InitOperands(Ops, 3);
1405   }
1406 };
1407
1408
1409 /// HandleSDNode - This class is used to form a handle around another node that
1410 /// is persistant and is updated across invocations of replaceAllUsesWith on its
1411 /// operand.  This node should be directly created by end-users and not added to
1412 /// the AllNodes list.
1413 class HandleSDNode : public SDNode {
1414   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1415   SDUse Op;
1416 public:
1417   explicit HandleSDNode(SDOperand X)
1418     : SDNode(ISD::HANDLENODE, getSDVTList(MVT::Other)) {
1419     Op = X;
1420     InitOperands(&Op, 1);
1421   }
1422   ~HandleSDNode();  
1423   SDUse getValue() const { return Op; }
1424 };
1425
1426 class AtomicSDNode : public SDNode {
1427   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1428   SDUse Ops[4];
1429   MVT::ValueType OrigVT;
1430 public:
1431   AtomicSDNode(unsigned Opc, SDVTList VTL, SDOperand Chain, SDOperand Ptr, 
1432                SDOperand Cmp, SDOperand Swp, MVT::ValueType VT)
1433     : SDNode(Opc, VTL) {
1434     Ops[0] = Chain;
1435     Ops[1] = Ptr;
1436     Ops[2] = Swp;
1437     Ops[3] = Cmp;
1438     InitOperands(Ops, 4);
1439     OrigVT=VT;
1440   }
1441   AtomicSDNode(unsigned Opc, SDVTList VTL, SDOperand Chain, SDOperand Ptr, 
1442                SDOperand Val, MVT::ValueType VT)
1443     : SDNode(Opc, VTL) {
1444     Ops[0] = Chain;
1445     Ops[1] = Ptr;
1446     Ops[2] = Val;
1447     InitOperands(Ops, 3);
1448     OrigVT=VT;
1449   }
1450   MVT::ValueType getVT() const { return OrigVT; }
1451   bool isCompareAndSwap() const { return getOpcode() == ISD::ATOMIC_LCS; }
1452 };
1453
1454 class StringSDNode : public SDNode {
1455   std::string Value;
1456   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1457 protected:
1458   friend class SelectionDAG;
1459   explicit StringSDNode(const std::string &val)
1460     : SDNode(ISD::STRING, getSDVTList(MVT::Other)), Value(val) {
1461   }
1462 public:
1463   const std::string &getValue() const { return Value; }
1464   static bool classof(const StringSDNode *) { return true; }
1465   static bool classof(const SDNode *N) {
1466     return N->getOpcode() == ISD::STRING;
1467   }
1468 };  
1469
1470 class ConstantSDNode : public SDNode {
1471   APInt Value;
1472   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1473 protected:
1474   friend class SelectionDAG;
1475   ConstantSDNode(bool isTarget, const APInt &val, MVT::ValueType VT)
1476     : SDNode(isTarget ? ISD::TargetConstant : ISD::Constant, getSDVTList(VT)),
1477       Value(val) {
1478   }
1479 public:
1480
1481   const APInt &getAPIntValue() const { return Value; }
1482   uint64_t getValue() const { return Value.getZExtValue(); }
1483
1484   int64_t getSignExtended() const {
1485     unsigned Bits = MVT::getSizeInBits(getValueType(0));
1486     return ((int64_t)Value.getZExtValue() << (64-Bits)) >> (64-Bits);
1487   }
1488
1489   bool isNullValue() const { return Value == 0; }
1490   bool isAllOnesValue() const {
1491     return Value == MVT::getIntVTBitMask(getValueType(0));
1492   }
1493
1494   static bool classof(const ConstantSDNode *) { return true; }
1495   static bool classof(const SDNode *N) {
1496     return N->getOpcode() == ISD::Constant ||
1497            N->getOpcode() == ISD::TargetConstant;
1498   }
1499 };
1500
1501 class ConstantFPSDNode : public SDNode {
1502   APFloat Value;
1503   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1504 protected:
1505   friend class SelectionDAG;
1506   ConstantFPSDNode(bool isTarget, const APFloat& val, MVT::ValueType VT)
1507     : SDNode(isTarget ? ISD::TargetConstantFP : ISD::ConstantFP,
1508              getSDVTList(VT)), Value(val) {
1509   }
1510 public:
1511
1512   const APFloat& getValueAPF() const { return Value; }
1513
1514   /// isExactlyValue - We don't rely on operator== working on double values, as
1515   /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
1516   /// As such, this method can be used to do an exact bit-for-bit comparison of
1517   /// two floating point values.
1518
1519   /// We leave the version with the double argument here because it's just so
1520   /// convenient to write "2.0" and the like.  Without this function we'd 
1521   /// have to duplicate its logic everywhere it's called.
1522   bool isExactlyValue(double V) const { 
1523     APFloat Tmp(V);
1524     Tmp.convert(Value.getSemantics(), APFloat::rmNearestTiesToEven);
1525     return isExactlyValue(Tmp);
1526   }
1527   bool isExactlyValue(const APFloat& V) const;
1528
1529   bool isValueValidForType(MVT::ValueType VT, const APFloat& Val);
1530
1531   static bool classof(const ConstantFPSDNode *) { return true; }
1532   static bool classof(const SDNode *N) {
1533     return N->getOpcode() == ISD::ConstantFP || 
1534            N->getOpcode() == ISD::TargetConstantFP;
1535   }
1536 };
1537
1538 class GlobalAddressSDNode : public SDNode {
1539   GlobalValue *TheGlobal;
1540   int Offset;
1541   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1542 protected:
1543   friend class SelectionDAG;
1544   GlobalAddressSDNode(bool isTarget, const GlobalValue *GA, MVT::ValueType VT,
1545                       int o = 0);
1546 public:
1547
1548   GlobalValue *getGlobal() const { return TheGlobal; }
1549   int getOffset() const { return Offset; }
1550
1551   static bool classof(const GlobalAddressSDNode *) { return true; }
1552   static bool classof(const SDNode *N) {
1553     return N->getOpcode() == ISD::GlobalAddress ||
1554            N->getOpcode() == ISD::TargetGlobalAddress ||
1555            N->getOpcode() == ISD::GlobalTLSAddress ||
1556            N->getOpcode() == ISD::TargetGlobalTLSAddress;
1557   }
1558 };
1559
1560 class FrameIndexSDNode : public SDNode {
1561   int FI;
1562   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1563 protected:
1564   friend class SelectionDAG;
1565   FrameIndexSDNode(int fi, MVT::ValueType VT, bool isTarg)
1566     : SDNode(isTarg ? ISD::TargetFrameIndex : ISD::FrameIndex, getSDVTList(VT)),
1567       FI(fi) {
1568   }
1569 public:
1570
1571   int getIndex() const { return FI; }
1572
1573   static bool classof(const FrameIndexSDNode *) { return true; }
1574   static bool classof(const SDNode *N) {
1575     return N->getOpcode() == ISD::FrameIndex ||
1576            N->getOpcode() == ISD::TargetFrameIndex;
1577   }
1578 };
1579
1580 class JumpTableSDNode : public SDNode {
1581   int JTI;
1582   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1583 protected:
1584   friend class SelectionDAG;
1585   JumpTableSDNode(int jti, MVT::ValueType VT, bool isTarg)
1586     : SDNode(isTarg ? ISD::TargetJumpTable : ISD::JumpTable, getSDVTList(VT)),
1587       JTI(jti) {
1588   }
1589 public:
1590     
1591   int getIndex() const { return JTI; }
1592   
1593   static bool classof(const JumpTableSDNode *) { return true; }
1594   static bool classof(const SDNode *N) {
1595     return N->getOpcode() == ISD::JumpTable ||
1596            N->getOpcode() == ISD::TargetJumpTable;
1597   }
1598 };
1599
1600 class ConstantPoolSDNode : public SDNode {
1601   union {
1602     Constant *ConstVal;
1603     MachineConstantPoolValue *MachineCPVal;
1604   } Val;
1605   int Offset;  // It's a MachineConstantPoolValue if top bit is set.
1606   unsigned Alignment;
1607   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1608 protected:
1609   friend class SelectionDAG;
1610   ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT,
1611                      int o=0)
1612     : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1613              getSDVTList(VT)), Offset(o), Alignment(0) {
1614     assert((int)Offset >= 0 && "Offset is too large");
1615     Val.ConstVal = c;
1616   }
1617   ConstantPoolSDNode(bool isTarget, Constant *c, MVT::ValueType VT, int o,
1618                      unsigned Align)
1619     : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 
1620              getSDVTList(VT)), Offset(o), Alignment(Align) {
1621     assert((int)Offset >= 0 && "Offset is too large");
1622     Val.ConstVal = c;
1623   }
1624   ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1625                      MVT::ValueType VT, int o=0)
1626     : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool, 
1627              getSDVTList(VT)), Offset(o), Alignment(0) {
1628     assert((int)Offset >= 0 && "Offset is too large");
1629     Val.MachineCPVal = v;
1630     Offset |= 1 << (sizeof(unsigned)*8-1);
1631   }
1632   ConstantPoolSDNode(bool isTarget, MachineConstantPoolValue *v,
1633                      MVT::ValueType VT, int o, unsigned Align)
1634     : SDNode(isTarget ? ISD::TargetConstantPool : ISD::ConstantPool,
1635              getSDVTList(VT)), Offset(o), Alignment(Align) {
1636     assert((int)Offset >= 0 && "Offset is too large");
1637     Val.MachineCPVal = v;
1638     Offset |= 1 << (sizeof(unsigned)*8-1);
1639   }
1640 public:
1641
1642   bool isMachineConstantPoolEntry() const {
1643     return (int)Offset < 0;
1644   }
1645
1646   Constant *getConstVal() const {
1647     assert(!isMachineConstantPoolEntry() && "Wrong constantpool type");
1648     return Val.ConstVal;
1649   }
1650
1651   MachineConstantPoolValue *getMachineCPVal() const {
1652     assert(isMachineConstantPoolEntry() && "Wrong constantpool type");
1653     return Val.MachineCPVal;
1654   }
1655
1656   int getOffset() const {
1657     return Offset & ~(1 << (sizeof(unsigned)*8-1));
1658   }
1659   
1660   // Return the alignment of this constant pool object, which is either 0 (for
1661   // default alignment) or log2 of the desired value.
1662   unsigned getAlignment() const { return Alignment; }
1663
1664   const Type *getType() const;
1665
1666   static bool classof(const ConstantPoolSDNode *) { return true; }
1667   static bool classof(const SDNode *N) {
1668     return N->getOpcode() == ISD::ConstantPool ||
1669            N->getOpcode() == ISD::TargetConstantPool;
1670   }
1671 };
1672
1673 class BasicBlockSDNode : public SDNode {
1674   MachineBasicBlock *MBB;
1675   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1676 protected:
1677   friend class SelectionDAG;
1678   explicit BasicBlockSDNode(MachineBasicBlock *mbb)
1679     : SDNode(ISD::BasicBlock, getSDVTList(MVT::Other)), MBB(mbb) {
1680   }
1681 public:
1682
1683   MachineBasicBlock *getBasicBlock() const { return MBB; }
1684
1685   static bool classof(const BasicBlockSDNode *) { return true; }
1686   static bool classof(const SDNode *N) {
1687     return N->getOpcode() == ISD::BasicBlock;
1688   }
1689 };
1690
1691 /// SrcValueSDNode - An SDNode that holds an arbitrary LLVM IR Value. This is
1692 /// used when the SelectionDAG needs to make a simple reference to something
1693 /// in the LLVM IR representation.
1694 ///
1695 /// Note that this is not used for carrying alias information; that is done
1696 /// with MemOperandSDNode, which includes a Value which is required to be a
1697 /// pointer, and several other fields specific to memory references.
1698 ///
1699 class SrcValueSDNode : public SDNode {
1700   const Value *V;
1701   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1702 protected:
1703   friend class SelectionDAG;
1704   /// Create a SrcValue for a general value.
1705   explicit SrcValueSDNode(const Value *v)
1706     : SDNode(ISD::SRCVALUE, getSDVTList(MVT::Other)), V(v) {}
1707
1708 public:
1709   /// getValue - return the contained Value.
1710   const Value *getValue() const { return V; }
1711
1712   static bool classof(const SrcValueSDNode *) { return true; }
1713   static bool classof(const SDNode *N) {
1714     return N->getOpcode() == ISD::SRCVALUE;
1715   }
1716 };
1717
1718
1719 /// MemOperandSDNode - An SDNode that holds a MachineMemOperand. This is
1720 /// used to represent a reference to memory after ISD::LOAD
1721 /// and ISD::STORE have been lowered.
1722 ///
1723 class MemOperandSDNode : public SDNode {
1724   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1725 protected:
1726   friend class SelectionDAG;
1727   /// Create a MachineMemOperand node
1728   explicit MemOperandSDNode(const MachineMemOperand &mo)
1729     : SDNode(ISD::MEMOPERAND, getSDVTList(MVT::Other)), MO(mo) {}
1730
1731 public:
1732   /// MO - The contained MachineMemOperand.
1733   const MachineMemOperand MO;
1734
1735   static bool classof(const MemOperandSDNode *) { return true; }
1736   static bool classof(const SDNode *N) {
1737     return N->getOpcode() == ISD::MEMOPERAND;
1738   }
1739 };
1740
1741
1742 class RegisterSDNode : public SDNode {
1743   unsigned Reg;
1744   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1745 protected:
1746   friend class SelectionDAG;
1747   RegisterSDNode(unsigned reg, MVT::ValueType VT)
1748     : SDNode(ISD::Register, getSDVTList(VT)), Reg(reg) {
1749   }
1750 public:
1751
1752   unsigned getReg() const { return Reg; }
1753
1754   static bool classof(const RegisterSDNode *) { return true; }
1755   static bool classof(const SDNode *N) {
1756     return N->getOpcode() == ISD::Register;
1757   }
1758 };
1759
1760 class ExternalSymbolSDNode : public SDNode {
1761   const char *Symbol;
1762   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1763 protected:
1764   friend class SelectionDAG;
1765   ExternalSymbolSDNode(bool isTarget, const char *Sym, MVT::ValueType VT)
1766     : SDNode(isTarget ? ISD::TargetExternalSymbol : ISD::ExternalSymbol,
1767              getSDVTList(VT)), Symbol(Sym) {
1768   }
1769 public:
1770
1771   const char *getSymbol() const { return Symbol; }
1772
1773   static bool classof(const ExternalSymbolSDNode *) { return true; }
1774   static bool classof(const SDNode *N) {
1775     return N->getOpcode() == ISD::ExternalSymbol ||
1776            N->getOpcode() == ISD::TargetExternalSymbol;
1777   }
1778 };
1779
1780 class CondCodeSDNode : public SDNode {
1781   ISD::CondCode Condition;
1782   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1783 protected:
1784   friend class SelectionDAG;
1785   explicit CondCodeSDNode(ISD::CondCode Cond)
1786     : SDNode(ISD::CONDCODE, getSDVTList(MVT::Other)), Condition(Cond) {
1787   }
1788 public:
1789
1790   ISD::CondCode get() const { return Condition; }
1791
1792   static bool classof(const CondCodeSDNode *) { return true; }
1793   static bool classof(const SDNode *N) {
1794     return N->getOpcode() == ISD::CONDCODE;
1795   }
1796 };
1797
1798 namespace ISD {
1799   struct ArgFlagsTy {
1800   private:
1801     static const uint64_t NoFlagSet      = 0ULL;
1802     static const uint64_t ZExt           = 1ULL<<0;  ///< Zero extended
1803     static const uint64_t ZExtOffs       = 0;
1804     static const uint64_t SExt           = 1ULL<<1;  ///< Sign extended
1805     static const uint64_t SExtOffs       = 1;
1806     static const uint64_t InReg          = 1ULL<<2;  ///< Passed in register
1807     static const uint64_t InRegOffs      = 2;
1808     static const uint64_t SRet           = 1ULL<<3;  ///< Hidden struct-ret ptr
1809     static const uint64_t SRetOffs       = 3;
1810     static const uint64_t ByVal          = 1ULL<<4;  ///< Struct passed by value
1811     static const uint64_t ByValOffs      = 4;
1812     static const uint64_t Nest           = 1ULL<<5;  ///< Nested fn static chain
1813     static const uint64_t NestOffs       = 5;
1814     static const uint64_t ByValAlign     = 0xFULL << 6; //< Struct alignment
1815     static const uint64_t ByValAlignOffs = 6;
1816     static const uint64_t Split          = 1ULL << 10;
1817     static const uint64_t SplitOffs      = 10;
1818     static const uint64_t OrigAlign      = 0x1FULL<<27;
1819     static const uint64_t OrigAlignOffs  = 27;
1820     static const uint64_t ByValSize      = 0xffffffffULL << 32; //< Struct size
1821     static const uint64_t ByValSizeOffs  = 32;
1822
1823     static const uint64_t One            = 1ULL; //< 1 of this type, for shifts
1824
1825     uint64_t Flags;
1826   public:
1827     ArgFlagsTy() : Flags(0) { }
1828
1829     bool isZExt()   const { return Flags & ZExt; }
1830     void setZExt()  { Flags |= One << ZExtOffs; }
1831
1832     bool isSExt()   const { return Flags & SExt; }
1833     void setSExt()  { Flags |= One << SExtOffs; }
1834
1835     bool isInReg()  const { return Flags & InReg; }
1836     void setInReg() { Flags |= One << InRegOffs; }
1837
1838     bool isSRet()   const { return Flags & SRet; }
1839     void setSRet()  { Flags |= One << SRetOffs; }
1840
1841     bool isByVal()  const { return Flags & ByVal; }
1842     void setByVal() { Flags |= One << ByValOffs; }
1843
1844     bool isNest()   const { return Flags & Nest; }
1845     void setNest()  { Flags |= One << NestOffs; }
1846
1847     unsigned getByValAlign() const {
1848       return (unsigned) 
1849         ((One << ((Flags & ByValAlign) >> ByValAlignOffs)) / 2);
1850     }
1851     void setByValAlign(unsigned A) {
1852       Flags = (Flags & ~ByValAlign) |
1853         (uint64_t(Log2_32(A) + 1) << ByValAlignOffs);
1854     }
1855             
1856     bool isSplit()   const { return Flags & Split; }
1857     void setSplit()  { Flags |= One << SplitOffs; }
1858
1859     unsigned getOrigAlign() const {
1860       return (unsigned)
1861         ((One << ((Flags & OrigAlign) >> OrigAlignOffs)) / 2);
1862     }
1863     void setOrigAlign(unsigned A) {
1864       Flags = (Flags & ~OrigAlign) |
1865         (uint64_t(Log2_32(A) + 1) << OrigAlignOffs);
1866     }
1867
1868     unsigned getByValSize() const {
1869       return (unsigned)((Flags & ByValSize) >> ByValSizeOffs);
1870     }
1871     void setByValSize(unsigned S) {
1872       Flags = (Flags & ~ByValSize) | (uint64_t(S) << ByValSizeOffs);
1873     }
1874
1875     /// getArgFlagsString - Returns the flags as a string, eg: "zext align:4".
1876     std::string getArgFlagsString();
1877
1878     /// getRawBits - Represent the flags as a bunch of bits.
1879     uint64_t getRawBits() const { return Flags; }
1880   };
1881 }
1882
1883 /// ARG_FLAGSSDNode - Leaf node holding parameter flags.
1884 class ARG_FLAGSSDNode : public SDNode {
1885   ISD::ArgFlagsTy TheFlags;
1886   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1887 protected:
1888   friend class SelectionDAG;
1889   explicit ARG_FLAGSSDNode(ISD::ArgFlagsTy Flags)
1890     : SDNode(ISD::ARG_FLAGS, getSDVTList(MVT::Other)), TheFlags(Flags) {
1891   }
1892 public:
1893   ISD::ArgFlagsTy getArgFlags() const { return TheFlags; }
1894
1895   static bool classof(const ARG_FLAGSSDNode *) { return true; }
1896   static bool classof(const SDNode *N) {
1897     return N->getOpcode() == ISD::ARG_FLAGS;
1898   }
1899 };
1900
1901 /// VTSDNode - This class is used to represent MVT::ValueType's, which are used
1902 /// to parameterize some operations.
1903 class VTSDNode : public SDNode {
1904   MVT::ValueType ValueType;
1905   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
1906 protected:
1907   friend class SelectionDAG;
1908   explicit VTSDNode(MVT::ValueType VT)
1909     : SDNode(ISD::VALUETYPE, getSDVTList(MVT::Other)), ValueType(VT) {
1910   }
1911 public:
1912
1913   MVT::ValueType getVT() const { return ValueType; }
1914
1915   static bool classof(const VTSDNode *) { return true; }
1916   static bool classof(const SDNode *N) {
1917     return N->getOpcode() == ISD::VALUETYPE;
1918   }
1919 };
1920
1921 /// LSBaseSDNode - Base class for LoadSDNode and StoreSDNode
1922 ///
1923 class LSBaseSDNode : public SDNode {
1924 private:
1925   // AddrMode - unindexed, pre-indexed, post-indexed.
1926   ISD::MemIndexedMode AddrMode;
1927
1928   // MemoryVT - VT of in-memory value.
1929   MVT::ValueType MemoryVT;
1930
1931   //! SrcValue - Memory location for alias analysis.
1932   const Value *SrcValue;
1933
1934   //! SVOffset - Memory location offset.
1935   int SVOffset;
1936
1937   //! Alignment - Alignment of memory location in bytes.
1938   unsigned Alignment;
1939
1940   //! IsVolatile - True if the store is volatile.
1941   bool IsVolatile;
1942 protected:
1943   //! Operand array for load and store
1944   /*!
1945     \note Moving this array to the base class captures more
1946     common functionality shared between LoadSDNode and
1947     StoreSDNode
1948    */
1949   SDUse Ops[4];
1950 public:
1951   LSBaseSDNode(ISD::NodeType NodeTy, SDOperand *Operands, unsigned NumOperands,
1952                SDVTList VTs, ISD::MemIndexedMode AM, MVT::ValueType VT, 
1953                const Value *SV, int SVO, unsigned Align, bool Vol)
1954     : SDNode(NodeTy, VTs),
1955       AddrMode(AM), MemoryVT(VT),
1956       SrcValue(SV), SVOffset(SVO), Alignment(Align), IsVolatile(Vol) {
1957     for (unsigned i = 0; i != NumOperands; ++i)
1958       Ops[i] = Operands[i];
1959     InitOperands(Ops, NumOperands);
1960     assert(Align != 0 && "Loads and stores should have non-zero aligment");
1961     assert((getOffset().getOpcode() == ISD::UNDEF || isIndexed()) &&
1962            "Only indexed loads and stores have a non-undef offset operand");
1963   }
1964
1965   const SDOperand &getChain() const { return getOperand(0); }
1966   const SDOperand &getBasePtr() const {
1967     return getOperand(getOpcode() == ISD::LOAD ? 1 : 2);
1968   }
1969   const SDOperand &getOffset() const {
1970     return getOperand(getOpcode() == ISD::LOAD ? 2 : 3);
1971   }
1972
1973   const Value *getSrcValue() const { return SrcValue; }
1974   int getSrcValueOffset() const { return SVOffset; }
1975   unsigned getAlignment() const { return Alignment; }
1976   MVT::ValueType getMemoryVT() const { return MemoryVT; }
1977   bool isVolatile() const { return IsVolatile; }
1978
1979   ISD::MemIndexedMode getAddressingMode() const { return AddrMode; }
1980
1981   /// isIndexed - Return true if this is a pre/post inc/dec load/store.
1982   bool isIndexed() const { return AddrMode != ISD::UNINDEXED; }
1983
1984   /// isUnindexed - Return true if this is NOT a pre/post inc/dec load/store.
1985   bool isUnindexed() const { return AddrMode == ISD::UNINDEXED; }
1986
1987   /// getMemOperand - Return a MachineMemOperand object describing the memory
1988   /// reference performed by this load or store.
1989   MachineMemOperand getMemOperand() const;
1990
1991   static bool classof(const LSBaseSDNode *N) { return true; }
1992   static bool classof(const SDNode *N) {
1993     return N->getOpcode() == ISD::LOAD ||
1994            N->getOpcode() == ISD::STORE;
1995   }
1996 };
1997
1998 /// LoadSDNode - This class is used to represent ISD::LOAD nodes.
1999 ///
2000 class LoadSDNode : public LSBaseSDNode {
2001   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
2002   
2003   // ExtType - non-ext, anyext, sext, zext.
2004   ISD::LoadExtType ExtType;
2005
2006 protected:
2007   friend class SelectionDAG;
2008   LoadSDNode(SDOperand *ChainPtrOff, SDVTList VTs,
2009              ISD::MemIndexedMode AM, ISD::LoadExtType ETy, MVT::ValueType LVT,
2010              const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
2011     : LSBaseSDNode(ISD::LOAD, ChainPtrOff, 3,
2012                    VTs, AM, LVT, SV, O, Align, Vol),
2013       ExtType(ETy) {}
2014 public:
2015
2016   ISD::LoadExtType getExtensionType() const { return ExtType; }
2017   const SDOperand &getBasePtr() const { return getOperand(1); }
2018   const SDOperand &getOffset() const { return getOperand(2); }
2019   
2020   static bool classof(const LoadSDNode *) { return true; }
2021   static bool classof(const SDNode *N) {
2022     return N->getOpcode() == ISD::LOAD;
2023   }
2024 };
2025
2026 /// StoreSDNode - This class is used to represent ISD::STORE nodes.
2027 ///
2028 class StoreSDNode : public LSBaseSDNode {
2029   virtual void ANCHOR();  // Out-of-line virtual method to give class a home.
2030     
2031   // IsTruncStore - True if the op does a truncation before store.
2032   bool IsTruncStore;
2033 protected:
2034   friend class SelectionDAG;
2035   StoreSDNode(SDOperand *ChainValuePtrOff, SDVTList VTs,
2036               ISD::MemIndexedMode AM, bool isTrunc, MVT::ValueType SVT,
2037               const Value *SV, int O=0, unsigned Align=0, bool Vol=false)
2038     : LSBaseSDNode(ISD::STORE, ChainValuePtrOff, 4,
2039                    VTs, AM, SVT, SV, O, Align, Vol),
2040       IsTruncStore(isTrunc) {}
2041 public:
2042
2043   bool isTruncatingStore() const { return IsTruncStore; }
2044   const SDOperand &getValue() const { return getOperand(1); }
2045   const SDOperand &getBasePtr() const { return getOperand(2); }
2046   const SDOperand &getOffset() const { return getOperand(3); }
2047   
2048   static bool classof(const StoreSDNode *) { return true; }
2049   static bool classof(const SDNode *N) {
2050     return N->getOpcode() == ISD::STORE;
2051   }
2052 };
2053
2054
2055 class SDNodeIterator : public forward_iterator<SDNode, ptrdiff_t> {
2056   SDNode *Node;
2057   unsigned Operand;
2058
2059   SDNodeIterator(SDNode *N, unsigned Op) : Node(N), Operand(Op) {}
2060 public:
2061   bool operator==(const SDNodeIterator& x) const {
2062     return Operand == x.Operand;
2063   }
2064   bool operator!=(const SDNodeIterator& x) const { return !operator==(x); }
2065
2066   const SDNodeIterator &operator=(const SDNodeIterator &I) {
2067     assert(I.Node == Node && "Cannot assign iterators to two different nodes!");
2068     Operand = I.Operand;
2069     return *this;
2070   }
2071
2072   pointer operator*() const {
2073     return Node->getOperand(Operand).Val;
2074   }
2075   pointer operator->() const { return operator*(); }
2076
2077   SDNodeIterator& operator++() {                // Preincrement
2078     ++Operand;
2079     return *this;
2080   }
2081   SDNodeIterator operator++(int) { // Postincrement
2082     SDNodeIterator tmp = *this; ++*this; return tmp;
2083   }
2084
2085   static SDNodeIterator begin(SDNode *N) { return SDNodeIterator(N, 0); }
2086   static SDNodeIterator end  (SDNode *N) {
2087     return SDNodeIterator(N, N->getNumOperands());
2088   }
2089
2090   unsigned getOperand() const { return Operand; }
2091   const SDNode *getNode() const { return Node; }
2092 };
2093
2094 template <> struct GraphTraits<SDNode*> {
2095   typedef SDNode NodeType;
2096   typedef SDNodeIterator ChildIteratorType;
2097   static inline NodeType *getEntryNode(SDNode *N) { return N; }
2098   static inline ChildIteratorType child_begin(NodeType *N) {
2099     return SDNodeIterator::begin(N);
2100   }
2101   static inline ChildIteratorType child_end(NodeType *N) {
2102     return SDNodeIterator::end(N);
2103   }
2104 };
2105
2106 template<>
2107 struct ilist_traits<SDNode> {
2108   static SDNode *getPrev(const SDNode *N) { return N->Prev; }
2109   static SDNode *getNext(const SDNode *N) { return N->Next; }
2110   
2111   static void setPrev(SDNode *N, SDNode *Prev) { N->Prev = Prev; }
2112   static void setNext(SDNode *N, SDNode *Next) { N->Next = Next; }
2113   
2114   static SDNode *createSentinel() {
2115     return new SDNode(ISD::EntryToken, SDNode::getSDVTList(MVT::Other));
2116   }
2117   static void destroySentinel(SDNode *N) { delete N; }
2118   //static SDNode *createNode(const SDNode &V) { return new SDNode(V); }
2119   
2120   
2121   void addNodeToList(SDNode *NTy) {}
2122   void removeNodeFromList(SDNode *NTy) {}
2123   void transferNodesFromList(iplist<SDNode, ilist_traits> &L2,
2124                              const ilist_iterator<SDNode> &X,
2125                              const ilist_iterator<SDNode> &Y) {}
2126 };
2127
2128 namespace ISD {
2129   /// isNormalLoad - Returns true if the specified node is a non-extending
2130   /// and unindexed load.
2131   inline bool isNormalLoad(const SDNode *N) {
2132     if (N->getOpcode() != ISD::LOAD)
2133       return false;
2134     const LoadSDNode *Ld = cast<LoadSDNode>(N);
2135     return Ld->getExtensionType() == ISD::NON_EXTLOAD &&
2136       Ld->getAddressingMode() == ISD::UNINDEXED;
2137   }
2138
2139   /// isNON_EXTLoad - Returns true if the specified node is a non-extending
2140   /// load.
2141   inline bool isNON_EXTLoad(const SDNode *N) {
2142     return N->getOpcode() == ISD::LOAD &&
2143       cast<LoadSDNode>(N)->getExtensionType() == ISD::NON_EXTLOAD;
2144   }
2145
2146   /// isEXTLoad - Returns true if the specified node is a EXTLOAD.
2147   ///
2148   inline bool isEXTLoad(const SDNode *N) {
2149     return N->getOpcode() == ISD::LOAD &&
2150       cast<LoadSDNode>(N)->getExtensionType() == ISD::EXTLOAD;
2151   }
2152
2153   /// isSEXTLoad - Returns true if the specified node is a SEXTLOAD.
2154   ///
2155   inline bool isSEXTLoad(const SDNode *N) {
2156     return N->getOpcode() == ISD::LOAD &&
2157       cast<LoadSDNode>(N)->getExtensionType() == ISD::SEXTLOAD;
2158   }
2159
2160   /// isZEXTLoad - Returns true if the specified node is a ZEXTLOAD.
2161   ///
2162   inline bool isZEXTLoad(const SDNode *N) {
2163     return N->getOpcode() == ISD::LOAD &&
2164       cast<LoadSDNode>(N)->getExtensionType() == ISD::ZEXTLOAD;
2165   }
2166
2167   /// isUNINDEXEDLoad - Returns true if the specified node is a unindexed load.
2168   ///
2169   inline bool isUNINDEXEDLoad(const SDNode *N) {
2170     return N->getOpcode() == ISD::LOAD &&
2171       cast<LoadSDNode>(N)->getAddressingMode() == ISD::UNINDEXED;
2172   }
2173
2174   /// isNON_TRUNCStore - Returns true if the specified node is a non-truncating
2175   /// store.
2176   inline bool isNON_TRUNCStore(const SDNode *N) {
2177     return N->getOpcode() == ISD::STORE &&
2178       !cast<StoreSDNode>(N)->isTruncatingStore();
2179   }
2180
2181   /// isTRUNCStore - Returns true if the specified node is a truncating
2182   /// store.
2183   inline bool isTRUNCStore(const SDNode *N) {
2184     return N->getOpcode() == ISD::STORE &&
2185       cast<StoreSDNode>(N)->isTruncatingStore();
2186   }
2187 }
2188
2189
2190 } // end llvm namespace
2191
2192 #endif