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