SelectionDAG.h revision bef8888a9197655512f156e50b10799da7240252 
1//===-- llvm/CodeGen/SelectionDAG.h - InstSelection DAG ---------*- 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 SelectionDAG class, and transitively defines the
11// SDNode class and subclasses.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_CODEGEN_SELECTIONDAG_H
16#define LLVM_CODEGEN_SELECTIONDAG_H
17
18#include "llvm/ADT/ilist.h"
19#include "llvm/ADT/DenseSet.h"
20#include "llvm/ADT/StringMap.h"
21#include "llvm/CodeGen/SelectionDAGNodes.h"
22#include "llvm/Support/RecyclingAllocator.h"
23#include "llvm/Target/TargetMachine.h"
24#include <cassert>
25#include <vector>
26#include <map>
27#include <string>
28
29namespace llvm {
30
31class AliasAnalysis;
32class TargetLowering;
33class MachineModuleInfo;
34class DwarfWriter;
35class MachineFunction;
36class MachineConstantPoolValue;
37class FunctionLoweringInfo;
38
39template<> struct ilist_traits<SDNode> : public ilist_default_traits<SDNode> {
40private:
41  mutable ilist_half_node<SDNode> Sentinel;
42public:
43  SDNode *createSentinel() const {
44    return static_cast<SDNode*>(&Sentinel);
45  }
46  static void destroySentinel(SDNode *) {}
47
48  SDNode *provideInitialHead() const { return createSentinel(); }
49  SDNode *ensureHead(SDNode*) const { return createSentinel(); }
50  static void noteHead(SDNode*, SDNode*) {}
51
52  static void deleteNode(SDNode *) {
53    assert(0 && "ilist_traits<SDNode> shouldn't see a deleteNode call!");
54  }
55private:
56  static void createNode(const SDNode &);
57};
58
59enum CombineLevel {
60  Unrestricted,   // Combine may create illegal operations and illegal types.
61  NoIllegalTypes, // Combine may create illegal operations but no illegal types.
62  NoIllegalOperations // Combine may only create legal operations and types.
63};
64
65/// SelectionDAG class - This is used to represent a portion of an LLVM function
66/// in a low-level Data Dependence DAG representation suitable for instruction
67/// selection.  This DAG is constructed as the first step of instruction
68/// selection in order to allow implementation of machine specific optimizations
69/// and code simplifications.
70///
71/// The representation used by the SelectionDAG is a target-independent
72/// representation, which has some similarities to the GCC RTL representation,
73/// but is significantly more simple, powerful, and is a graph form instead of a
74/// linear form.
75///
76class SelectionDAG {
77  TargetLowering &TLI;
78  MachineFunction *MF;
79  FunctionLoweringInfo &FLI;
80  MachineModuleInfo *MMI;
81  DwarfWriter *DW;
82  LLVMContext* Context;
83
84  /// EntryNode - The starting token.
85  SDNode EntryNode;
86
87  /// Root - The root of the entire DAG.
88  SDValue Root;
89
90  /// AllNodes - A linked list of nodes in the current DAG.
91  ilist<SDNode> AllNodes;
92
93  /// NodeAllocatorType - The AllocatorType for allocating SDNodes. We use
94  /// pool allocation with recycling.
95  typedef RecyclingAllocator<BumpPtrAllocator, SDNode, sizeof(LargestSDNode),
96                             AlignOf<MostAlignedSDNode>::Alignment>
97    NodeAllocatorType;
98
99  /// NodeAllocator - Pool allocation for nodes.
100  NodeAllocatorType NodeAllocator;
101
102  /// CSEMap - This structure is used to memoize nodes, automatically performing
103  /// CSE with existing nodes when a duplicate is requested.
104  FoldingSet<SDNode> CSEMap;
105
106  /// OperandAllocator - Pool allocation for machine-opcode SDNode operands.
107  BumpPtrAllocator OperandAllocator;
108
109  /// Allocator - Pool allocation for misc. objects that are created once per
110  /// SelectionDAG.
111  BumpPtrAllocator Allocator;
112
113  /// VerifyNode - Sanity check the given node.  Aborts if it is invalid.
114  void VerifyNode(SDNode *N);
115
116  /// setGraphColorHelper - Implementation of setSubgraphColor.
117  /// Return whether we had to truncate the search.
118  ///
119  bool setSubgraphColorHelper(SDNode *N, const char *Color,
120                              DenseSet<SDNode *> &visited,
121                              int level, bool &printed);
122
123public:
124  SelectionDAG(TargetLowering &tli, FunctionLoweringInfo &fli);
125  ~SelectionDAG();
126
127  /// init - Prepare this SelectionDAG to process code in the given
128  /// MachineFunction.
129  ///
130  void init(MachineFunction &mf, MachineModuleInfo *mmi, DwarfWriter *dw);
131
132  /// clear - Clear state and free memory necessary to make this
133  /// SelectionDAG ready to process a new block.
134  ///
135  void clear();
136
137  MachineFunction &getMachineFunction() const { return *MF; }
138  const TargetMachine &getTarget() const;
139  TargetLowering &getTargetLoweringInfo() const { return TLI; }
140  FunctionLoweringInfo &getFunctionLoweringInfo() const { return FLI; }
141  MachineModuleInfo *getMachineModuleInfo() const { return MMI; }
142  DwarfWriter *getDwarfWriter() const { return DW; }
143  LLVMContext *getContext() const {return Context; }
144
145  /// viewGraph - Pop up a GraphViz/gv window with the DAG rendered using 'dot'.
146  ///
147  void viewGraph(const std::string &Title);
148  void viewGraph();
149
150#ifndef NDEBUG
151  std::map<const SDNode *, std::string> NodeGraphAttrs;
152#endif
153
154  /// clearGraphAttrs - Clear all previously defined node graph attributes.
155  /// Intended to be used from a debugging tool (eg. gdb).
156  void clearGraphAttrs();
157
158  /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
159  ///
160  void setGraphAttrs(const SDNode *N, const char *Attrs);
161
162  /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
163  /// Used from getNodeAttributes.
164  const std::string getGraphAttrs(const SDNode *N) const;
165
166  /// setGraphColor - Convenience for setting node color attribute.
167  ///
168  void setGraphColor(const SDNode *N, const char *Color);
169
170  /// setGraphColor - Convenience for setting subgraph color attribute.
171  ///
172  void setSubgraphColor(SDNode *N, const char *Color);
173
174  typedef ilist<SDNode>::const_iterator allnodes_const_iterator;
175  allnodes_const_iterator allnodes_begin() const { return AllNodes.begin(); }
176  allnodes_const_iterator allnodes_end() const { return AllNodes.end(); }
177  typedef ilist<SDNode>::iterator allnodes_iterator;
178  allnodes_iterator allnodes_begin() { return AllNodes.begin(); }
179  allnodes_iterator allnodes_end() { return AllNodes.end(); }
180  ilist<SDNode>::size_type allnodes_size() const {
181    return AllNodes.size();
182  }
183
184  /// getRoot - Return the root tag of the SelectionDAG.
185  ///
186  const SDValue &getRoot() const { return Root; }
187
188  /// getEntryNode - Return the token chain corresponding to the entry of the
189  /// function.
190  SDValue getEntryNode() const {
191    return SDValue(const_cast<SDNode *>(&EntryNode), 0);
192  }
193
194  /// setRoot - Set the current root tag of the SelectionDAG.
195  ///
196  const SDValue &setRoot(SDValue N) {
197    assert((!N.getNode() || N.getValueType() == MVT::Other) &&
198           "DAG root value is not a chain!");
199    return Root = N;
200  }
201
202  /// Combine - This iterates over the nodes in the SelectionDAG, folding
203  /// certain types of nodes together, or eliminating superfluous nodes.  The
204  /// Level argument controls whether Combine is allowed to produce nodes and
205  /// types that are illegal on the target.
206  void Combine(CombineLevel Level, AliasAnalysis &AA,
207               CodeGenOpt::Level OptLevel);
208
209  /// LegalizeTypes - This transforms the SelectionDAG into a SelectionDAG that
210  /// only uses types natively supported by the target.  Returns "true" if it
211  /// made any changes.
212  ///
213  /// Note that this is an involved process that may invalidate pointers into
214  /// the graph.
215  bool LegalizeTypes();
216
217  /// Legalize - This transforms the SelectionDAG into a SelectionDAG that is
218  /// compatible with the target instruction selector, as indicated by the
219  /// TargetLowering object.
220  ///
221  /// Note that this is an involved process that may invalidate pointers into
222  /// the graph.
223  void Legalize(bool TypesNeedLegalizing, CodeGenOpt::Level OptLevel);
224
225  /// LegalizeVectors - This transforms the SelectionDAG into a SelectionDAG
226  /// that only uses vector math operations supported by the target.  This is
227  /// necessary as a separate step from Legalize because unrolling a vector
228  /// operation can introduce illegal types, which requires running
229  /// LegalizeTypes again.
230  ///
231  /// This returns true if it made any changes; in that case, LegalizeTypes
232  /// is called again before Legalize.
233  ///
234  /// Note that this is an involved process that may invalidate pointers into
235  /// the graph.
236  bool LegalizeVectors();
237
238  /// RemoveDeadNodes - This method deletes all unreachable nodes in the
239  /// SelectionDAG.
240  void RemoveDeadNodes();
241
242  /// DeleteNode - Remove the specified node from the system.  This node must
243  /// have no referrers.
244  void DeleteNode(SDNode *N);
245
246  /// getVTList - Return an SDVTList that represents the list of values
247  /// specified.
248  SDVTList getVTList(EVT VT);
249  SDVTList getVTList(EVT VT1, EVT VT2);
250  SDVTList getVTList(EVT VT1, EVT VT2, EVT VT3);
251  SDVTList getVTList(EVT VT1, EVT VT2, EVT VT3, EVT VT4);
252  SDVTList getVTList(const EVT *VTs, unsigned NumVTs);
253
254  //===--------------------------------------------------------------------===//
255  // Node creation methods.
256  //
257  SDValue getConstant(uint64_t Val, EVT VT, bool isTarget = false);
258  SDValue getConstant(const APInt &Val, EVT VT, bool isTarget = false);
259  SDValue getConstant(const ConstantInt &Val, EVT VT, bool isTarget = false);
260  SDValue getIntPtrConstant(uint64_t Val, bool isTarget = false);
261  SDValue getTargetConstant(uint64_t Val, EVT VT) {
262    return getConstant(Val, VT, true);
263  }
264  SDValue getTargetConstant(const APInt &Val, EVT VT) {
265    return getConstant(Val, VT, true);
266  }
267  SDValue getTargetConstant(const ConstantInt &Val, EVT VT) {
268    return getConstant(Val, VT, true);
269  }
270  SDValue getConstantFP(double Val, EVT VT, bool isTarget = false);
271  SDValue getConstantFP(const APFloat& Val, EVT VT, bool isTarget = false);
272  SDValue getConstantFP(const ConstantFP &CF, EVT VT, bool isTarget = false);
273  SDValue getTargetConstantFP(double Val, EVT VT) {
274    return getConstantFP(Val, VT, true);
275  }
276  SDValue getTargetConstantFP(const APFloat& Val, EVT VT) {
277    return getConstantFP(Val, VT, true);
278  }
279  SDValue getTargetConstantFP(const ConstantFP &Val, EVT VT) {
280    return getConstantFP(Val, VT, true);
281  }
282  SDValue getGlobalAddress(const GlobalValue *GV, EVT VT,
283                           int64_t offset = 0, bool isTargetGA = false,
284                           unsigned char TargetFlags = 0);
285  SDValue getTargetGlobalAddress(const GlobalValue *GV, EVT VT,
286                                 int64_t offset = 0,
287                                 unsigned char TargetFlags = 0) {
288    return getGlobalAddress(GV, VT, offset, true, TargetFlags);
289  }
290  SDValue getFrameIndex(int FI, EVT VT, bool isTarget = false);
291  SDValue getTargetFrameIndex(int FI, EVT VT) {
292    return getFrameIndex(FI, VT, true);
293  }
294  SDValue getJumpTable(int JTI, EVT VT, bool isTarget = false,
295                       unsigned char TargetFlags = 0);
296  SDValue getTargetJumpTable(int JTI, EVT VT, unsigned char TargetFlags = 0) {
297    return getJumpTable(JTI, VT, true, TargetFlags);
298  }
299  SDValue getConstantPool(Constant *C, EVT VT,
300                          unsigned Align = 0, int Offs = 0, bool isT=false,
301                          unsigned char TargetFlags = 0);
302  SDValue getTargetConstantPool(Constant *C, EVT VT,
303                                unsigned Align = 0, int Offset = 0,
304                                unsigned char TargetFlags = 0) {
305    return getConstantPool(C, VT, Align, Offset, true, TargetFlags);
306  }
307  SDValue getConstantPool(MachineConstantPoolValue *C, EVT VT,
308                          unsigned Align = 0, int Offs = 0, bool isT=false,
309                          unsigned char TargetFlags = 0);
310  SDValue getTargetConstantPool(MachineConstantPoolValue *C,
311                                  EVT VT, unsigned Align = 0,
312                                  int Offset = 0, unsigned char TargetFlags=0) {
313    return getConstantPool(C, VT, Align, Offset, true, TargetFlags);
314  }
315  // When generating a branch to a BB, we don't in general know enough
316  // to provide debug info for the BB at that time, so keep this one around.
317  SDValue getBasicBlock(MachineBasicBlock *MBB);
318  SDValue getBasicBlock(MachineBasicBlock *MBB, DebugLoc dl);
319  SDValue getExternalSymbol(const char *Sym, EVT VT);
320  SDValue getExternalSymbol(const char *Sym, DebugLoc dl, EVT VT);
321  SDValue getTargetExternalSymbol(const char *Sym, EVT VT,
322                                  unsigned char TargetFlags = 0);
323  SDValue getValueType(EVT);
324  SDValue getRegister(unsigned Reg, EVT VT);
325  SDValue getLabel(unsigned Opcode, DebugLoc dl, SDValue Root,
326                   unsigned LabelID);
327  SDValue getBlockAddress(BlockAddress *BA, EVT VT,
328                          bool isTarget = false, unsigned char TargetFlags = 0);
329
330  SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N) {
331    return getNode(ISD::CopyToReg, dl, MVT::Other, Chain,
332                   getRegister(Reg, N.getValueType()), N);
333  }
334
335  // This version of the getCopyToReg method takes an extra operand, which
336  // indicates that there is potentially an incoming flag value (if Flag is not
337  // null) and that there should be a flag result.
338  SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N,
339                       SDValue Flag) {
340    SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
341    SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
342    return getNode(ISD::CopyToReg, dl, VTs, Ops, Flag.getNode() ? 4 : 3);
343  }
344
345  // Similar to last getCopyToReg() except parameter Reg is a SDValue
346  SDValue getCopyToReg(SDValue Chain, DebugLoc dl, SDValue Reg, SDValue N,
347                         SDValue Flag) {
348    SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
349    SDValue Ops[] = { Chain, Reg, N, Flag };
350    return getNode(ISD::CopyToReg, dl, VTs, Ops, Flag.getNode() ? 4 : 3);
351  }
352
353  SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, EVT VT) {
354    SDVTList VTs = getVTList(VT, MVT::Other);
355    SDValue Ops[] = { Chain, getRegister(Reg, VT) };
356    return getNode(ISD::CopyFromReg, dl, VTs, Ops, 2);
357  }
358
359  // This version of the getCopyFromReg method takes an extra operand, which
360  // indicates that there is potentially an incoming flag value (if Flag is not
361  // null) and that there should be a flag result.
362  SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, EVT VT,
363                           SDValue Flag) {
364    SDVTList VTs = getVTList(VT, MVT::Other, MVT::Flag);
365    SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
366    return getNode(ISD::CopyFromReg, dl, VTs, Ops, Flag.getNode() ? 3 : 2);
367  }
368
369  SDValue getCondCode(ISD::CondCode Cond);
370
371  /// Returns the ConvertRndSat Note: Avoid using this node because it may
372  /// disappear in the future and most targets don't support it.
373  SDValue getConvertRndSat(EVT VT, DebugLoc dl, SDValue Val, SDValue DTy,
374                           SDValue STy,
375                           SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
376
377  /// getVectorShuffle - Return an ISD::VECTOR_SHUFFLE node.  The number of
378  /// elements in VT, which must be a vector type, must match the number of
379  /// mask elements NumElts.  A integer mask element equal to -1 is treated as
380  /// undefined.
381  SDValue getVectorShuffle(EVT VT, DebugLoc dl, SDValue N1, SDValue N2,
382                           const int *MaskElts);
383
384  /// getSExtOrTrunc - Convert Op, which must be of integer type, to the
385  /// integer type VT, by either sign-extending or truncating it.
386  SDValue getSExtOrTrunc(SDValue Op, DebugLoc DL, EVT VT);
387
388  /// getZExtOrTrunc - Convert Op, which must be of integer type, to the
389  /// integer type VT, by either zero-extending or truncating it.
390  SDValue getZExtOrTrunc(SDValue Op, DebugLoc DL, EVT VT);
391
392  /// getZeroExtendInReg - Return the expression required to zero extend the Op
393  /// value assuming it was the smaller SrcTy value.
394  SDValue getZeroExtendInReg(SDValue Op, DebugLoc DL, EVT SrcTy);
395
396  /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
397  SDValue getNOT(DebugLoc DL, SDValue Val, EVT VT);
398
399  /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
400  /// a flag result (to ensure it's not CSE'd).  CALLSEQ_START does not have a
401  /// useful DebugLoc.
402  SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
403    SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
404    SDValue Ops[] = { Chain,  Op };
405    return getNode(ISD::CALLSEQ_START, DebugLoc::getUnknownLoc(),
406                   VTs, Ops, 2);
407  }
408
409  /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
410  /// flag result (to ensure it's not CSE'd).  CALLSEQ_END does not have
411  /// a useful DebugLoc.
412  SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
413                           SDValue InFlag) {
414    SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
415    SmallVector<SDValue, 4> Ops;
416    Ops.push_back(Chain);
417    Ops.push_back(Op1);
418    Ops.push_back(Op2);
419    Ops.push_back(InFlag);
420    return getNode(ISD::CALLSEQ_END, DebugLoc::getUnknownLoc(), NodeTys,
421                   &Ops[0],
422                   (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
423  }
424
425  /// getUNDEF - Return an UNDEF node.  UNDEF does not have a useful DebugLoc.
426  SDValue getUNDEF(EVT VT) {
427    return getNode(ISD::UNDEF, DebugLoc::getUnknownLoc(), VT);
428  }
429
430  /// getGLOBAL_OFFSET_TABLE - Return a GLOBAL_OFFSET_TABLE node.  This does
431  /// not have a useful DebugLoc.
432  SDValue getGLOBAL_OFFSET_TABLE(EVT VT) {
433    return getNode(ISD::GLOBAL_OFFSET_TABLE, DebugLoc::getUnknownLoc(), VT);
434  }
435
436  /// getNode - Gets or creates the specified node.
437  ///
438  SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT);
439  SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT, SDValue N);
440  SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT, SDValue N1, SDValue N2);
441  SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
442                  SDValue N1, SDValue N2, SDValue N3);
443  SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
444                  SDValue N1, SDValue N2, SDValue N3, SDValue N4);
445  SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
446                  SDValue N1, SDValue N2, SDValue N3, SDValue N4,
447                  SDValue N5);
448  SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
449                  const SDUse *Ops, unsigned NumOps);
450  SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
451                  const SDValue *Ops, unsigned NumOps);
452  SDValue getNode(unsigned Opcode, DebugLoc DL,
453                  const std::vector<EVT> &ResultTys,
454                  const SDValue *Ops, unsigned NumOps);
455  SDValue getNode(unsigned Opcode, DebugLoc DL, const EVT *VTs, unsigned NumVTs,
456                  const SDValue *Ops, unsigned NumOps);
457  SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
458                  const SDValue *Ops, unsigned NumOps);
459  SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs);
460  SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N);
461  SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
462                  SDValue N1, SDValue N2);
463  SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
464                  SDValue N1, SDValue N2, SDValue N3);
465  SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
466                  SDValue N1, SDValue N2, SDValue N3, SDValue N4);
467  SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
468                  SDValue N1, SDValue N2, SDValue N3, SDValue N4,
469                  SDValue N5);
470
471  /// getStackArgumentTokenFactor - Compute a TokenFactor to force all
472  /// the incoming stack arguments to be loaded from the stack. This is
473  /// used in tail call lowering to protect stack arguments from being
474  /// clobbered.
475  SDValue getStackArgumentTokenFactor(SDValue Chain);
476
477  SDValue getMemcpy(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
478                    SDValue Size, unsigned Align, bool AlwaysInline,
479                    const Value *DstSV, uint64_t DstSVOff,
480                    const Value *SrcSV, uint64_t SrcSVOff);
481
482  SDValue getMemmove(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
483                     SDValue Size, unsigned Align,
484                     const Value *DstSV, uint64_t DstOSVff,
485                     const Value *SrcSV, uint64_t SrcSVOff);
486
487  SDValue getMemset(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
488                    SDValue Size, unsigned Align,
489                    const Value *DstSV, uint64_t DstSVOff);
490
491  /// getSetCC - Helper function to make it easier to build SetCC's if you just
492  /// have an ISD::CondCode instead of an SDValue.
493  ///
494  SDValue getSetCC(DebugLoc DL, EVT VT, SDValue LHS, SDValue RHS,
495                   ISD::CondCode Cond) {
496    return getNode(ISD::SETCC, DL, VT, LHS, RHS, getCondCode(Cond));
497  }
498
499  /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
500  /// if you just have an ISD::CondCode instead of an SDValue.
501  ///
502  SDValue getVSetCC(DebugLoc DL, EVT VT, SDValue LHS, SDValue RHS,
503                    ISD::CondCode Cond) {
504    return getNode(ISD::VSETCC, DL, VT, LHS, RHS, getCondCode(Cond));
505  }
506
507  /// getSelectCC - Helper function to make it easier to build SelectCC's if you
508  /// just have an ISD::CondCode instead of an SDValue.
509  ///
510  SDValue getSelectCC(DebugLoc DL, SDValue LHS, SDValue RHS,
511                      SDValue True, SDValue False, ISD::CondCode Cond) {
512    return getNode(ISD::SELECT_CC, DL, True.getValueType(),
513                   LHS, RHS, True, False, getCondCode(Cond));
514  }
515
516  /// getVAArg - VAArg produces a result and token chain, and takes a pointer
517  /// and a source value as input.
518  SDValue getVAArg(EVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
519                   SDValue SV);
520
521  /// getAtomic - Gets a node for an atomic op, produces result and chain and
522  /// takes 3 operands
523  SDValue getAtomic(unsigned Opcode, DebugLoc dl, EVT MemVT, SDValue Chain,
524                    SDValue Ptr, SDValue Cmp, SDValue Swp, const Value* PtrVal,
525                    unsigned Alignment=0);
526  SDValue getAtomic(unsigned Opcode, DebugLoc dl, EVT MemVT, SDValue Chain,
527                    SDValue Ptr, SDValue Cmp, SDValue Swp,
528                    MachineMemOperand *MMO);
529
530  /// getAtomic - Gets a node for an atomic op, produces result and chain and
531  /// takes 2 operands.
532  SDValue getAtomic(unsigned Opcode, DebugLoc dl, EVT MemVT, SDValue Chain,
533                    SDValue Ptr, SDValue Val, const Value* PtrVal,
534                    unsigned Alignment = 0);
535  SDValue getAtomic(unsigned Opcode, DebugLoc dl, EVT MemVT, SDValue Chain,
536                    SDValue Ptr, SDValue Val,
537                    MachineMemOperand *MMO);
538
539  /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
540  /// result and takes a list of operands. Opcode may be INTRINSIC_VOID,
541  /// INTRINSIC_W_CHAIN, or a target-specific opcode with a value not
542  /// less than FIRST_TARGET_MEMORY_OPCODE.
543  SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl,
544                              const EVT *VTs, unsigned NumVTs,
545                              const SDValue *Ops, unsigned NumOps,
546                              EVT MemVT, const Value *srcValue, int SVOff,
547                              unsigned Align = 0, bool Vol = false,
548                              bool ReadMem = true, bool WriteMem = true);
549
550  SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
551                              const SDValue *Ops, unsigned NumOps,
552                              EVT MemVT, const Value *srcValue, int SVOff,
553                              unsigned Align = 0, bool Vol = false,
554                              bool ReadMem = true, bool WriteMem = true);
555
556  SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
557                              const SDValue *Ops, unsigned NumOps,
558                              EVT MemVT, MachineMemOperand *MMO);
559
560  /// getMergeValues - Create a MERGE_VALUES node from the given operands.
561  SDValue getMergeValues(const SDValue *Ops, unsigned NumOps, DebugLoc dl);
562
563  /// getLoad - Loads are not normal binary operators: their result type is not
564  /// determined by their operands, and they produce a value AND a token chain.
565  ///
566  SDValue getLoad(EVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
567                    const Value *SV, int SVOffset, bool isVolatile=false,
568                    unsigned Alignment=0);
569  SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, EVT VT,
570                       SDValue Chain, SDValue Ptr, const Value *SV,
571                       int SVOffset, EVT MemVT, bool isVolatile=false,
572                       unsigned Alignment=0);
573  SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base,
574                           SDValue Offset, ISD::MemIndexedMode AM);
575  SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
576                  EVT VT, SDValue Chain, SDValue Ptr, SDValue Offset,
577                  const Value *SV, int SVOffset, EVT MemVT,
578                  bool isVolatile=false, unsigned Alignment=0);
579  SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
580                  EVT VT, SDValue Chain, SDValue Ptr, SDValue Offset,
581                  EVT MemVT, MachineMemOperand *MMO);
582
583  /// getStore - Helper function to build ISD::STORE nodes.
584  ///
585  SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
586                     const Value *SV, int SVOffset, bool isVolatile=false,
587                     unsigned Alignment=0);
588  SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
589                   MachineMemOperand *MMO);
590  SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
591                          const Value *SV, int SVOffset, EVT TVT,
592                          bool isVolatile=false, unsigned Alignment=0);
593  SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
594                        EVT TVT, MachineMemOperand *MMO);
595  SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base,
596                           SDValue Offset, ISD::MemIndexedMode AM);
597
598  /// getSrcValue - Construct a node to track a Value* through the backend.
599  SDValue getSrcValue(const Value *v);
600
601  /// getShiftAmountOperand - Return the specified value casted to
602  /// the target's desired shift amount type.
603  SDValue getShiftAmountOperand(SDValue Op);
604
605  /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
606  /// specified operands.  If the resultant node already exists in the DAG,
607  /// this does not modify the specified node, instead it returns the node that
608  /// already exists.  If the resultant node does not exist in the DAG, the
609  /// input node is returned.  As a degenerate case, if you specify the same
610  /// input operands as the node already has, the input node is returned.
611  SDValue UpdateNodeOperands(SDValue N, SDValue Op);
612  SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
613  SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
614                               SDValue Op3);
615  SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
616                               SDValue Op3, SDValue Op4);
617  SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
618                               SDValue Op3, SDValue Op4, SDValue Op5);
619  SDValue UpdateNodeOperands(SDValue N,
620                               const SDValue *Ops, unsigned NumOps);
621
622  /// SelectNodeTo - These are used for target selectors to *mutate* the
623  /// specified node to have the specified return type, Target opcode, and
624  /// operands.  Note that target opcodes are stored as
625  /// ~TargetOpcode in the node opcode field.  The resultant node is returned.
626  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT);
627  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT, SDValue Op1);
628  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
629                       SDValue Op1, SDValue Op2);
630  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
631                       SDValue Op1, SDValue Op2, SDValue Op3);
632  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
633                       const SDValue *Ops, unsigned NumOps);
634  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1, EVT VT2);
635  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
636                       EVT VT2, const SDValue *Ops, unsigned NumOps);
637  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
638                       EVT VT2, EVT VT3, const SDValue *Ops, unsigned NumOps);
639  SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, EVT VT1,
640                       EVT VT2, EVT VT3, EVT VT4, const SDValue *Ops,
641                       unsigned NumOps);
642  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
643                       EVT VT2, SDValue Op1);
644  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
645                       EVT VT2, SDValue Op1, SDValue Op2);
646  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
647                       EVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
648  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
649                       EVT VT2, EVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
650  SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
651                       const SDValue *Ops, unsigned NumOps);
652
653  /// MorphNodeTo - These *mutate* the specified node to have the specified
654  /// return type, opcode, and operands.
655  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT);
656  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT, SDValue Op1);
657  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT,
658                      SDValue Op1, SDValue Op2);
659  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT,
660                      SDValue Op1, SDValue Op2, SDValue Op3);
661  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT,
662                      const SDValue *Ops, unsigned NumOps);
663  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT1, EVT VT2);
664  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT1,
665                      EVT VT2, const SDValue *Ops, unsigned NumOps);
666  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT1,
667                      EVT VT2, EVT VT3, const SDValue *Ops, unsigned NumOps);
668  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT1,
669                      EVT VT2, SDValue Op1);
670  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT1,
671                      EVT VT2, SDValue Op1, SDValue Op2);
672  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, EVT VT1,
673                      EVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
674  SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
675                      const SDValue *Ops, unsigned NumOps);
676
677  /// getMachineNode - These are used for target selectors to create a new node
678  /// with specified return type(s), MachineInstr opcode, and operands.
679  ///
680  /// Note that getMachineNode returns the resultant node.  If there is already
681  /// a node of the specified opcode and operands, it returns that node instead
682  /// of the current one.
683  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT);
684  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT,
685                                SDValue Op1);
686  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT,
687                                SDValue Op1, SDValue Op2);
688  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT,
689                         SDValue Op1, SDValue Op2, SDValue Op3);
690  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT,
691                         const SDValue *Ops, unsigned NumOps);
692  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2);
693  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
694                         SDValue Op1);
695  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1,
696                         EVT VT2, SDValue Op1, SDValue Op2);
697  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1,
698                         EVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
699  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
700                         const SDValue *Ops, unsigned NumOps);
701  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
702                         EVT VT3, SDValue Op1, SDValue Op2);
703  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
704                         EVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
705  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
706                         EVT VT3, const SDValue *Ops, unsigned NumOps);
707  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
708                         EVT VT3, EVT VT4, const SDValue *Ops, unsigned NumOps);
709  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl,
710                         const std::vector<EVT> &ResultTys, const SDValue *Ops,
711                         unsigned NumOps);
712  MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, SDVTList VTs,
713                         const SDValue *Ops, unsigned NumOps);
714
715  /// getTargetExtractSubreg - A convenience function for creating
716  /// TargetInstrInfo::EXTRACT_SUBREG nodes.
717  SDValue getTargetExtractSubreg(int SRIdx, DebugLoc DL, EVT VT,
718                                 SDValue Operand);
719
720  /// getTargetInsertSubreg - A convenience function for creating
721  /// TargetInstrInfo::INSERT_SUBREG nodes.
722  SDValue getTargetInsertSubreg(int SRIdx, DebugLoc DL, EVT VT,
723                                SDValue Operand, SDValue Subreg);
724
725  /// getNodeIfExists - Get the specified node if it's already available, or
726  /// else return NULL.
727  SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
728                          const SDValue *Ops, unsigned NumOps);
729
730  /// DAGUpdateListener - Clients of various APIs that cause global effects on
731  /// the DAG can optionally implement this interface.  This allows the clients
732  /// to handle the various sorts of updates that happen.
733  class DAGUpdateListener {
734  public:
735    virtual ~DAGUpdateListener();
736
737    /// NodeDeleted - The node N that was deleted and, if E is not null, an
738    /// equivalent node E that replaced it.
739    virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
740
741    /// NodeUpdated - The node N that was updated.
742    virtual void NodeUpdated(SDNode *N) = 0;
743  };
744
745  /// RemoveDeadNode - Remove the specified node from the system. If any of its
746  /// operands then becomes dead, remove them as well. Inform UpdateListener
747  /// for each node deleted.
748  void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
749
750  /// RemoveDeadNodes - This method deletes the unreachable nodes in the
751  /// given list, and any nodes that become unreachable as a result.
752  void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
753                       DAGUpdateListener *UpdateListener = 0);
754
755  /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
756  /// This can cause recursive merging of nodes in the DAG.  Use the first
757  /// version if 'From' is known to have a single result, use the second
758  /// if you have two nodes with identical results (or if 'To' has a superset
759  /// of the results of 'From'), use the third otherwise.
760  ///
761  /// These methods all take an optional UpdateListener, which (if not null) is
762  /// informed about nodes that are deleted and modified due to recursive
763  /// changes in the dag.
764  ///
765  /// These functions only replace all existing uses. It's possible that as
766  /// these replacements are being performed, CSE may cause the From node
767  /// to be given new uses. These new uses of From are left in place, and
768  /// not automatically transfered to To.
769  ///
770  void ReplaceAllUsesWith(SDValue From, SDValue Op,
771                          DAGUpdateListener *UpdateListener = 0);
772  void ReplaceAllUsesWith(SDNode *From, SDNode *To,
773                          DAGUpdateListener *UpdateListener = 0);
774  void ReplaceAllUsesWith(SDNode *From, const SDValue *To,
775                          DAGUpdateListener *UpdateListener = 0);
776
777  /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
778  /// uses of other values produced by From.Val alone.
779  void ReplaceAllUsesOfValueWith(SDValue From, SDValue To,
780                                 DAGUpdateListener *UpdateListener = 0);
781
782  /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
783  /// for multiple values at once. This correctly handles the case where
784  /// there is an overlap between the From values and the To values.
785  void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
786                                  unsigned Num,
787                                  DAGUpdateListener *UpdateListener = 0);
788
789  /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
790  /// assign a unique node id for each node in the DAG based on their
791  /// topological order. Returns the number of nodes.
792  unsigned AssignTopologicalOrder();
793
794  /// RepositionNode - Move node N in the AllNodes list to be immediately
795  /// before the given iterator Position. This may be used to update the
796  /// topological ordering when the list of nodes is modified.
797  void RepositionNode(allnodes_iterator Position, SDNode *N) {
798    AllNodes.insert(Position, AllNodes.remove(N));
799  }
800
801  /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
802  /// operation.
803  static bool isCommutativeBinOp(unsigned Opcode) {
804    // FIXME: This should get its info from the td file, so that we can include
805    // target info.
806    switch (Opcode) {
807    case ISD::ADD:
808    case ISD::MUL:
809    case ISD::MULHU:
810    case ISD::MULHS:
811    case ISD::SMUL_LOHI:
812    case ISD::UMUL_LOHI:
813    case ISD::FADD:
814    case ISD::FMUL:
815    case ISD::AND:
816    case ISD::OR:
817    case ISD::XOR:
818    case ISD::SADDO:
819    case ISD::UADDO:
820    case ISD::ADDC:
821    case ISD::ADDE: return true;
822    default: return false;
823    }
824  }
825
826  void dump() const;
827
828  /// CreateStackTemporary - Create a stack temporary, suitable for holding the
829  /// specified value type.  If minAlign is specified, the slot size will have
830  /// at least that alignment.
831  SDValue CreateStackTemporary(EVT VT, unsigned minAlign = 1);
832
833  /// CreateStackTemporary - Create a stack temporary suitable for holding
834  /// either of the specified value types.
835  SDValue CreateStackTemporary(EVT VT1, EVT VT2);
836
837  /// FoldConstantArithmetic -
838  SDValue FoldConstantArithmetic(unsigned Opcode,
839                                 EVT VT,
840                                 ConstantSDNode *Cst1,
841                                 ConstantSDNode *Cst2);
842
843  /// FoldSetCC - Constant fold a setcc to true or false.
844  SDValue FoldSetCC(EVT VT, SDValue N1,
845                    SDValue N2, ISD::CondCode Cond, DebugLoc dl);
846
847  /// SignBitIsZero - Return true if the sign bit of Op is known to be zero.  We
848  /// use this predicate to simplify operations downstream.
849  bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
850
851  /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero.  We
852  /// use this predicate to simplify operations downstream.  Op and Mask are
853  /// known to be the same type.
854  bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
855    const;
856
857  /// ComputeMaskedBits - Determine which of the bits specified in Mask are
858  /// known to be either zero or one and return them in the KnownZero/KnownOne
859  /// bitsets.  This code only analyzes bits in Mask, in order to short-circuit
860  /// processing.  Targets can implement the computeMaskedBitsForTargetNode
861  /// method in the TargetLowering class to allow target nodes to be understood.
862  void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
863                         APInt &KnownOne, unsigned Depth = 0) const;
864
865  /// ComputeNumSignBits - Return the number of times the sign bit of the
866  /// register is replicated into the other bits.  We know that at least 1 bit
867  /// is always equal to the sign bit (itself), but other cases can give us
868  /// information.  For example, immediately after an "SRA X, 2", we know that
869  /// the top 3 bits are all equal to each other, so we return 3.  Targets can
870  /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
871  /// class to allow target nodes to be understood.
872  unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
873
874  /// isKnownNeverNan - Test whether the given SDValue is known to never be NaN.
875  bool isKnownNeverNaN(SDValue Op) const;
876
877  /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
878  /// been verified as a debug information descriptor.
879  bool isVerifiedDebugInfoDesc(SDValue Op) const;
880
881  /// getShuffleScalarElt - Returns the scalar element that will make up the ith
882  /// element of the result of the vector shuffle.
883  SDValue getShuffleScalarElt(const ShuffleVectorSDNode *N, unsigned Idx);
884
885private:
886  bool RemoveNodeFromCSEMaps(SDNode *N);
887  void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener);
888  SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
889  SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
890                               void *&InsertPos);
891  SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
892                               void *&InsertPos);
893
894  void DeleteNodeNotInCSEMaps(SDNode *N);
895  void DeallocateNode(SDNode *N);
896
897  unsigned getEVTAlignment(EVT MemoryVT) const;
898
899  void allnodes_clear();
900
901  /// VTList - List of non-single value types.
902  std::vector<SDVTList> VTList;
903
904  /// CondCodeNodes - Maps to auto-CSE operations.
905  std::vector<CondCodeSDNode*> CondCodeNodes;
906
907  std::vector<SDNode*> ValueTypeNodes;
908  std::map<EVT, SDNode*, EVT::compareRawBits> ExtendedValueTypeNodes;
909  StringMap<SDNode*> ExternalSymbols;
910
911  std::map<std::pair<std::string, unsigned char>,SDNode*> TargetExternalSymbols;
912};
913
914template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
915  typedef SelectionDAG::allnodes_iterator nodes_iterator;
916  static nodes_iterator nodes_begin(SelectionDAG *G) {
917    return G->allnodes_begin();
918  }
919  static nodes_iterator nodes_end(SelectionDAG *G) {
920    return G->allnodes_end();
921  }
922};
923
924}  // end namespace llvm
925
926#endif
927