1 //===-- llvm/CodeGen/SelectionDAG.h - InstSelection DAG ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the SelectionDAG class, and transitively defines the
11 // SDNode class and subclasses.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CODEGEN_SELECTIONDAG_H
16 #define LLVM_CODEGEN_SELECTIONDAG_H
18 #include "llvm/ADT/ilist.h"
19 #include "llvm/ADT/DenseSet.h"
20 #include "llvm/ADT/FoldingSet.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/CodeGen/SelectionDAGNodes.h"
34 class MachineModuleInfo;
35 class MachineFunction;
36 class MachineConstantPoolValue;
37 class FunctionLoweringInfo;
39 template<> struct ilist_traits<SDNode> : public ilist_default_traits<SDNode> {
41 mutable SDNode Sentinel;
43 ilist_traits() : Sentinel(ISD::DELETED_NODE, SDVTList()) {}
45 SDNode *createSentinel() const {
48 static void destroySentinel(SDNode *) {}
50 static void deleteNode(SDNode *) {
51 assert(0 && "ilist_traits<SDNode> shouldn't see a deleteNode call!");
54 static void createNode(const SDNode &);
57 /// SelectionDAG class - This is used to represent a portion of an LLVM function
58 /// in a low-level Data Dependence DAG representation suitable for instruction
59 /// selection. This DAG is constructed as the first step of instruction
60 /// selection in order to allow implementation of machine specific optimizations
61 /// and code simplifications.
63 /// The representation used by the SelectionDAG is a target-independent
64 /// representation, which has some similarities to the GCC RTL representation,
65 /// but is significantly more simple, powerful, and is a graph form instead of a
71 FunctionLoweringInfo &FLI;
72 MachineModuleInfo *MMI;
74 /// EntryNode - The starting token.
77 /// Root - The root of the entire DAG.
80 /// AllNodes - A linked list of nodes in the current DAG.
81 ilist<SDNode> AllNodes;
83 /// NodeAllocatorType - The AllocatorType for allocating SDNodes. We use
84 /// pool allocation with recycling.
85 typedef RecyclingAllocator<BumpPtrAllocator, SDNode, sizeof(LargestSDNode),
86 AlignOf<MostAlignedSDNode>::Alignment>
89 /// NodeAllocator - Pool allocation for nodes.
90 NodeAllocatorType NodeAllocator;
92 /// CSEMap - This structure is used to memoize nodes, automatically performing
93 /// CSE with existing nodes with a duplicate is requested.
94 FoldingSet<SDNode> CSEMap;
96 /// OperandAllocator - Pool allocation for machine-opcode SDNode operands.
97 BumpPtrAllocator OperandAllocator;
99 /// Allocator - Pool allocation for misc. objects that are created once per
101 BumpPtrAllocator Allocator;
103 /// VerifyNode - Sanity check the given node. Aborts if it is invalid.
104 void VerifyNode(SDNode *N);
106 /// setGraphColorHelper - Implementation of setSubgraphColor.
107 /// Return whether we had to truncate the search.
109 bool setSubgraphColorHelper(SDNode *N, const char *Color, DenseSet<SDNode *> &visited,
110 int level, bool &printed);
113 SelectionDAG(TargetLowering &tli, FunctionLoweringInfo &fli);
116 /// init - Prepare this SelectionDAG to process code in the given
119 void init(MachineFunction &mf, MachineModuleInfo *mmi);
121 /// clear - Clear state and free memory necessary to make this
122 /// SelectionDAG ready to process a new block.
126 MachineFunction &getMachineFunction() const { return *MF; }
127 const TargetMachine &getTarget() const;
128 TargetLowering &getTargetLoweringInfo() const { return TLI; }
129 FunctionLoweringInfo &getFunctionLoweringInfo() const { return FLI; }
130 MachineModuleInfo *getMachineModuleInfo() const { return MMI; }
132 /// viewGraph - Pop up a GraphViz/gv window with the DAG rendered using 'dot'.
134 void viewGraph(const std::string &Title);
138 std::map<const SDNode *, std::string> NodeGraphAttrs;
141 /// clearGraphAttrs - Clear all previously defined node graph attributes.
142 /// Intended to be used from a debugging tool (eg. gdb).
143 void clearGraphAttrs();
145 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
147 void setGraphAttrs(const SDNode *N, const char *Attrs);
149 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
150 /// Used from getNodeAttributes.
151 const std::string getGraphAttrs(const SDNode *N) const;
153 /// setGraphColor - Convenience for setting node color attribute.
155 void setGraphColor(const SDNode *N, const char *Color);
157 /// setGraphColor - Convenience for setting subgraph color attribute.
159 void setSubgraphColor(SDNode *N, const char *Color);
161 typedef ilist<SDNode>::const_iterator allnodes_const_iterator;
162 allnodes_const_iterator allnodes_begin() const { return AllNodes.begin(); }
163 allnodes_const_iterator allnodes_end() const { return AllNodes.end(); }
164 typedef ilist<SDNode>::iterator allnodes_iterator;
165 allnodes_iterator allnodes_begin() { return AllNodes.begin(); }
166 allnodes_iterator allnodes_end() { return AllNodes.end(); }
167 ilist<SDNode>::size_type allnodes_size() const {
168 return AllNodes.size();
171 /// getRoot - Return the root tag of the SelectionDAG.
173 const SDValue &getRoot() const { return Root; }
175 /// getEntryNode - Return the token chain corresponding to the entry of the
177 SDValue getEntryNode() const {
178 return SDValue(const_cast<SDNode *>(&EntryNode), 0);
181 /// setRoot - Set the current root tag of the SelectionDAG.
183 const SDValue &setRoot(SDValue N) {
184 assert((!N.getNode() || N.getValueType() == MVT::Other) &&
185 "DAG root value is not a chain!");
189 /// Combine - This iterates over the nodes in the SelectionDAG, folding
190 /// certain types of nodes together, or eliminating superfluous nodes. When
191 /// the AfterLegalize argument is set to 'true', Combine takes care not to
192 /// generate any nodes that will be illegal on the target.
193 void Combine(bool AfterLegalize, AliasAnalysis &AA, bool Fast);
195 /// LegalizeTypes - This transforms the SelectionDAG into a SelectionDAG that
196 /// only uses types natively supported by the target.
198 /// Note that this is an involved process that may invalidate pointers into
200 void LegalizeTypes();
202 /// Legalize - This transforms the SelectionDAG into a SelectionDAG that is
203 /// compatible with the target instruction selector, as indicated by the
204 /// TargetLowering object.
206 /// Note that this is an involved process that may invalidate pointers into
210 /// RemoveDeadNodes - This method deletes all unreachable nodes in the
212 void RemoveDeadNodes();
214 /// DeleteNode - Remove the specified node from the system. This node must
215 /// have no referrers.
216 void DeleteNode(SDNode *N);
218 /// getVTList - Return an SDVTList that represents the list of values
220 SDVTList getVTList(MVT VT);
221 SDVTList getVTList(MVT VT1, MVT VT2);
222 SDVTList getVTList(MVT VT1, MVT VT2, MVT VT3);
223 SDVTList getVTList(const MVT *VTs, unsigned NumVTs);
225 /// getNodeValueTypes - These are obsolete, use getVTList instead.
226 const MVT *getNodeValueTypes(MVT VT) {
227 return getVTList(VT).VTs;
229 const MVT *getNodeValueTypes(MVT VT1, MVT VT2) {
230 return getVTList(VT1, VT2).VTs;
232 const MVT *getNodeValueTypes(MVT VT1, MVT VT2, MVT VT3) {
233 return getVTList(VT1, VT2, VT3).VTs;
235 const MVT *getNodeValueTypes(const std::vector<MVT> &vtList) {
236 return getVTList(&vtList[0], (unsigned)vtList.size()).VTs;
240 //===--------------------------------------------------------------------===//
241 // Node creation methods.
243 SDValue getConstant(uint64_t Val, MVT VT, bool isTarget = false);
244 SDValue getConstant(const APInt &Val, MVT VT, bool isTarget = false);
245 SDValue getConstant(const ConstantInt &Val, MVT VT, bool isTarget = false);
246 SDValue getIntPtrConstant(uint64_t Val, bool isTarget = false);
247 SDValue getTargetConstant(uint64_t Val, MVT VT) {
248 return getConstant(Val, VT, true);
250 SDValue getTargetConstant(const APInt &Val, MVT VT) {
251 return getConstant(Val, VT, true);
253 SDValue getTargetConstant(const ConstantInt &Val, MVT VT) {
254 return getConstant(Val, VT, true);
256 SDValue getConstantFP(double Val, MVT VT, bool isTarget = false);
257 SDValue getConstantFP(const APFloat& Val, MVT VT, bool isTarget = false);
258 SDValue getConstantFP(const ConstantFP &CF, MVT VT, bool isTarget = false);
259 SDValue getTargetConstantFP(double Val, MVT VT) {
260 return getConstantFP(Val, VT, true);
262 SDValue getTargetConstantFP(const APFloat& Val, MVT VT) {
263 return getConstantFP(Val, VT, true);
265 SDValue getTargetConstantFP(const ConstantFP &Val, MVT VT) {
266 return getConstantFP(Val, VT, true);
268 SDValue getGlobalAddress(const GlobalValue *GV, MVT VT,
269 int64_t offset = 0, bool isTargetGA = false);
270 SDValue getTargetGlobalAddress(const GlobalValue *GV, MVT VT,
271 int64_t offset = 0) {
272 return getGlobalAddress(GV, VT, offset, true);
274 SDValue getFrameIndex(int FI, MVT VT, bool isTarget = false);
275 SDValue getTargetFrameIndex(int FI, MVT VT) {
276 return getFrameIndex(FI, VT, true);
278 SDValue getJumpTable(int JTI, MVT VT, bool isTarget = false);
279 SDValue getTargetJumpTable(int JTI, MVT VT) {
280 return getJumpTable(JTI, VT, true);
282 SDValue getConstantPool(Constant *C, MVT VT,
283 unsigned Align = 0, int Offs = 0, bool isT=false);
284 SDValue getTargetConstantPool(Constant *C, MVT VT,
285 unsigned Align = 0, int Offset = 0) {
286 return getConstantPool(C, VT, Align, Offset, true);
288 SDValue getConstantPool(MachineConstantPoolValue *C, MVT VT,
289 unsigned Align = 0, int Offs = 0, bool isT=false);
290 SDValue getTargetConstantPool(MachineConstantPoolValue *C,
291 MVT VT, unsigned Align = 0,
293 return getConstantPool(C, VT, Align, Offset, true);
295 SDValue getBasicBlock(MachineBasicBlock *MBB);
296 SDValue getExternalSymbol(const char *Sym, MVT VT);
297 SDValue getTargetExternalSymbol(const char *Sym, MVT VT);
298 SDValue getArgFlags(ISD::ArgFlagsTy Flags);
299 SDValue getValueType(MVT);
300 SDValue getRegister(unsigned Reg, MVT VT);
301 SDValue getDbgStopPoint(SDValue Root, unsigned Line, unsigned Col,
302 const CompileUnitDesc *CU);
303 SDValue getLabel(unsigned Opcode, SDValue Root, unsigned LabelID);
305 SDValue getCopyToReg(SDValue Chain, unsigned Reg, SDValue N) {
306 return getNode(ISD::CopyToReg, MVT::Other, Chain,
307 getRegister(Reg, N.getValueType()), N);
310 // This version of the getCopyToReg method takes an extra operand, which
311 // indicates that there is potentially an incoming flag value (if Flag is not
312 // null) and that there should be a flag result.
313 SDValue getCopyToReg(SDValue Chain, unsigned Reg, SDValue N,
315 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
316 SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
317 return getNode(ISD::CopyToReg, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
320 // Similar to last getCopyToReg() except parameter Reg is a SDValue
321 SDValue getCopyToReg(SDValue Chain, SDValue Reg, SDValue N,
323 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
324 SDValue Ops[] = { Chain, Reg, N, Flag };
325 return getNode(ISD::CopyToReg, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
328 SDValue getCopyFromReg(SDValue Chain, unsigned Reg, MVT VT) {
329 const MVT *VTs = getNodeValueTypes(VT, MVT::Other);
330 SDValue Ops[] = { Chain, getRegister(Reg, VT) };
331 return getNode(ISD::CopyFromReg, VTs, 2, Ops, 2);
334 // This version of the getCopyFromReg method takes an extra operand, which
335 // indicates that there is potentially an incoming flag value (if Flag is not
336 // null) and that there should be a flag result.
337 SDValue getCopyFromReg(SDValue Chain, unsigned Reg, MVT VT,
339 const MVT *VTs = getNodeValueTypes(VT, MVT::Other, MVT::Flag);
340 SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
341 return getNode(ISD::CopyFromReg, VTs, 3, Ops, Flag.getNode() ? 3 : 2);
344 SDValue getCondCode(ISD::CondCode Cond);
346 /// Returns the ConvertRndSat Note: Avoid using this node because it may
347 /// disappear in the future and most targets don't support it.
348 SDValue getConvertRndSat(MVT VT, SDValue Val, SDValue DTy, SDValue STy,
349 SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
351 /// getZeroExtendInReg - Return the expression required to zero extend the Op
352 /// value assuming it was the smaller SrcTy value.
353 SDValue getZeroExtendInReg(SDValue Op, MVT SrcTy);
355 /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
356 /// a flag result (to ensure it's not CSE'd).
357 SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
358 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
359 SDValue Ops[] = { Chain, Op };
360 return getNode(ISD::CALLSEQ_START, VTs, 2, Ops, 2);
363 /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
364 /// flag result (to ensure it's not CSE'd).
365 SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
367 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
368 SmallVector<SDValue, 4> Ops;
369 Ops.push_back(Chain);
372 Ops.push_back(InFlag);
373 return getNode(ISD::CALLSEQ_END, NodeTys, &Ops[0],
374 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
377 /// getNode - Gets or creates the specified node.
379 SDValue getNode(unsigned Opcode, MVT VT);
380 SDValue getNode(unsigned Opcode, MVT VT, SDValue N);
381 SDValue getNode(unsigned Opcode, MVT VT, SDValue N1, SDValue N2);
382 SDValue getNode(unsigned Opcode, MVT VT,
383 SDValue N1, SDValue N2, SDValue N3);
384 SDValue getNode(unsigned Opcode, MVT VT,
385 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
386 SDValue getNode(unsigned Opcode, MVT VT,
387 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
389 SDValue getNode(unsigned Opcode, MVT VT,
390 const SDValue *Ops, unsigned NumOps);
391 SDValue getNode(unsigned Opcode, MVT VT,
392 const SDUse *Ops, unsigned NumOps);
393 SDValue getNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
394 const SDValue *Ops, unsigned NumOps);
395 SDValue getNode(unsigned Opcode, const MVT *VTs, unsigned NumVTs,
396 const SDValue *Ops, unsigned NumOps);
397 SDValue getNode(unsigned Opcode, SDVTList VTs);
398 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N);
399 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N1, SDValue N2);
400 SDValue getNode(unsigned Opcode, SDVTList VTs,
401 SDValue N1, SDValue N2, SDValue N3);
402 SDValue getNode(unsigned Opcode, SDVTList VTs,
403 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
404 SDValue getNode(unsigned Opcode, SDVTList VTs,
405 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
407 SDValue getNode(unsigned Opcode, SDVTList VTs,
408 const SDValue *Ops, unsigned NumOps);
410 SDValue getMemcpy(SDValue Chain, SDValue Dst, SDValue Src,
411 SDValue Size, unsigned Align,
413 const Value *DstSV, uint64_t DstSVOff,
414 const Value *SrcSV, uint64_t SrcSVOff);
416 SDValue getMemmove(SDValue Chain, SDValue Dst, SDValue Src,
417 SDValue Size, unsigned Align,
418 const Value *DstSV, uint64_t DstOSVff,
419 const Value *SrcSV, uint64_t SrcSVOff);
421 SDValue getMemset(SDValue Chain, SDValue Dst, SDValue Src,
422 SDValue Size, unsigned Align,
423 const Value *DstSV, uint64_t DstSVOff);
425 /// getSetCC - Helper function to make it easier to build SetCC's if you just
426 /// have an ISD::CondCode instead of an SDValue.
428 SDValue getSetCC(MVT VT, SDValue LHS, SDValue RHS,
429 ISD::CondCode Cond) {
430 return getNode(ISD::SETCC, VT, LHS, RHS, getCondCode(Cond));
433 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
434 /// if you just have an ISD::CondCode instead of an SDValue.
436 SDValue getVSetCC(MVT VT, SDValue LHS, SDValue RHS,
437 ISD::CondCode Cond) {
438 return getNode(ISD::VSETCC, VT, LHS, RHS, getCondCode(Cond));
441 /// getSelectCC - Helper function to make it easier to build SelectCC's if you
442 /// just have an ISD::CondCode instead of an SDValue.
444 SDValue getSelectCC(SDValue LHS, SDValue RHS,
445 SDValue True, SDValue False, ISD::CondCode Cond) {
446 return getNode(ISD::SELECT_CC, True.getValueType(), LHS, RHS, True, False,
450 /// getVAArg - VAArg produces a result and token chain, and takes a pointer
451 /// and a source value as input.
452 SDValue getVAArg(MVT VT, SDValue Chain, SDValue Ptr,
455 /// getAtomic - Gets a node for an atomic op, produces result and chain and
457 SDValue getAtomic(unsigned Opcode, SDValue Chain, SDValue Ptr,
458 SDValue Cmp, SDValue Swp, const Value* PtrVal,
459 unsigned Alignment=0);
461 /// getAtomic - Gets a node for an atomic op, produces result and chain and
462 /// takes 2 operands.
463 SDValue getAtomic(unsigned Opcode, SDValue Chain, SDValue Ptr,
464 SDValue Val, const Value* PtrVal,
465 unsigned Alignment = 0);
467 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
468 /// result and takes a list of operands.
469 SDValue getMemIntrinsicNode(unsigned Opcode,
470 const MVT *VTs, unsigned NumVTs,
471 const SDValue *Ops, unsigned NumOps,
472 MVT MemVT, const Value *srcValue, int SVOff,
473 unsigned Align = 0, bool Vol = false,
474 bool ReadMem = true, bool WriteMem = true);
476 SDValue getMemIntrinsicNode(unsigned Opcode, SDVTList VTList,
477 const SDValue *Ops, unsigned NumOps,
478 MVT MemVT, const Value *srcValue, int SVOff,
479 unsigned Align = 0, bool Vol = false,
480 bool ReadMem = true, bool WriteMem = true);
482 /// getMergeValues - Create a MERGE_VALUES node from the given operands.
483 /// Allowed to return something different (and simpler) if Simplify is true.
484 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps,
485 bool Simplify = true);
487 /// getMergeValues - Create a MERGE_VALUES node from the given types and ops.
488 /// Allowed to return something different (and simpler) if Simplify is true.
489 /// May be faster than the above version if VTs is known and NumOps is large.
490 SDValue getMergeValues(SDVTList VTs, const SDValue *Ops, unsigned NumOps,
491 bool Simplify = true) {
492 if (Simplify && NumOps == 1)
494 return getNode(ISD::MERGE_VALUES, VTs, Ops, NumOps);
497 /// getCall - Create a CALL node from the given information.
499 SDValue getCall(unsigned CallingConv, bool IsVarArgs, bool IsTailCall,
500 bool isInreg, SDVTList VTs, const SDValue *Operands,
501 unsigned NumOperands);
503 /// getLoad - Loads are not normal binary operators: their result type is not
504 /// determined by their operands, and they produce a value AND a token chain.
506 SDValue getLoad(MVT VT, SDValue Chain, SDValue Ptr,
507 const Value *SV, int SVOffset, bool isVolatile=false,
508 unsigned Alignment=0);
509 SDValue getExtLoad(ISD::LoadExtType ExtType, MVT VT,
510 SDValue Chain, SDValue Ptr, const Value *SV,
511 int SVOffset, MVT EVT, bool isVolatile=false,
512 unsigned Alignment=0);
513 SDValue getIndexedLoad(SDValue OrigLoad, SDValue Base,
514 SDValue Offset, ISD::MemIndexedMode AM);
515 SDValue getLoad(ISD::MemIndexedMode AM, ISD::LoadExtType ExtType,
516 MVT VT, SDValue Chain,
517 SDValue Ptr, SDValue Offset,
518 const Value *SV, int SVOffset, MVT EVT,
519 bool isVolatile=false, unsigned Alignment=0);
521 /// getStore - Helper function to build ISD::STORE nodes.
523 SDValue getStore(SDValue Chain, SDValue Val, SDValue Ptr,
524 const Value *SV, int SVOffset, bool isVolatile=false,
525 unsigned Alignment=0);
526 SDValue getTruncStore(SDValue Chain, SDValue Val, SDValue Ptr,
527 const Value *SV, int SVOffset, MVT TVT,
528 bool isVolatile=false, unsigned Alignment=0);
529 SDValue getIndexedStore(SDValue OrigStoe, SDValue Base,
530 SDValue Offset, ISD::MemIndexedMode AM);
532 // getSrcValue - Construct a node to track a Value* through the backend.
533 SDValue getSrcValue(const Value *v);
535 // getMemOperand - Construct a node to track a memory reference
536 // through the backend.
537 SDValue getMemOperand(const MachineMemOperand &MO);
539 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
540 /// specified operands. If the resultant node already exists in the DAG,
541 /// this does not modify the specified node, instead it returns the node that
542 /// already exists. If the resultant node does not exist in the DAG, the
543 /// input node is returned. As a degenerate case, if you specify the same
544 /// input operands as the node already has, the input node is returned.
545 SDValue UpdateNodeOperands(SDValue N, SDValue Op);
546 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
547 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
549 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
550 SDValue Op3, SDValue Op4);
551 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
552 SDValue Op3, SDValue Op4, SDValue Op5);
553 SDValue UpdateNodeOperands(SDValue N,
554 const SDValue *Ops, unsigned NumOps);
556 /// SelectNodeTo - These are used for target selectors to *mutate* the
557 /// specified node to have the specified return type, Target opcode, and
558 /// operands. Note that target opcodes are stored as
559 /// ~TargetOpcode in the node opcode field. The resultant node is returned.
560 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT);
561 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, SDValue Op1);
562 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
563 SDValue Op1, SDValue Op2);
564 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
565 SDValue Op1, SDValue Op2, SDValue Op3);
566 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
567 const SDValue *Ops, unsigned NumOps);
568 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, MVT VT2);
569 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
570 MVT VT2, const SDValue *Ops, unsigned NumOps);
571 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
572 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
573 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
574 MVT VT2, SDValue Op1);
575 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
576 MVT VT2, SDValue Op1, SDValue Op2);
577 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
578 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
579 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
580 const SDValue *Ops, unsigned NumOps);
582 /// MorphNodeTo - These *mutate* the specified node to have the specified
583 /// return type, opcode, and operands.
584 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT);
585 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, SDValue Op1);
586 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
587 SDValue Op1, SDValue Op2);
588 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
589 SDValue Op1, SDValue Op2, SDValue Op3);
590 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
591 const SDValue *Ops, unsigned NumOps);
592 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, MVT VT2);
593 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
594 MVT VT2, const SDValue *Ops, unsigned NumOps);
595 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
596 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
597 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
598 MVT VT2, SDValue Op1);
599 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
600 MVT VT2, SDValue Op1, SDValue Op2);
601 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
602 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
603 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
604 const SDValue *Ops, unsigned NumOps);
606 /// getTargetNode - These are used for target selectors to create a new node
607 /// with specified return type(s), target opcode, and operands.
609 /// Note that getTargetNode returns the resultant node. If there is already a
610 /// node of the specified opcode and operands, it returns that node instead of
612 SDNode *getTargetNode(unsigned Opcode, MVT VT);
613 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1);
614 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1, SDValue Op2);
615 SDNode *getTargetNode(unsigned Opcode, MVT VT,
616 SDValue Op1, SDValue Op2, SDValue Op3);
617 SDNode *getTargetNode(unsigned Opcode, MVT VT,
618 const SDValue *Ops, unsigned NumOps);
619 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2);
620 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, SDValue Op1);
621 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
622 MVT VT2, SDValue Op1, SDValue Op2);
623 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
624 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
625 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2,
626 const SDValue *Ops, unsigned NumOps);
627 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
628 SDValue Op1, SDValue Op2);
629 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
630 SDValue Op1, SDValue Op2, SDValue Op3);
631 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
632 const SDValue *Ops, unsigned NumOps);
633 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, MVT VT4,
634 const SDValue *Ops, unsigned NumOps);
635 SDNode *getTargetNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
636 const SDValue *Ops, unsigned NumOps);
638 /// getNodeIfExists - Get the specified node if it's already available, or
639 /// else return NULL.
640 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
641 const SDValue *Ops, unsigned NumOps);
643 /// DAGUpdateListener - Clients of various APIs that cause global effects on
644 /// the DAG can optionally implement this interface. This allows the clients
645 /// to handle the various sorts of updates that happen.
646 class DAGUpdateListener {
648 virtual ~DAGUpdateListener();
650 /// NodeDeleted - The node N that was deleted and, if E is not null, an
651 /// equivalent node E that replaced it.
652 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
654 /// NodeUpdated - The node N that was updated.
655 virtual void NodeUpdated(SDNode *N) = 0;
658 /// RemoveDeadNode - Remove the specified node from the system. If any of its
659 /// operands then becomes dead, remove them as well. Inform UpdateListener
660 /// for each node deleted.
661 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
663 /// RemoveDeadNodes - This method deletes the unreachable nodes in the
664 /// given list, and any nodes that become unreachable as a result.
665 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
666 DAGUpdateListener *UpdateListener = 0);
668 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
669 /// This can cause recursive merging of nodes in the DAG. Use the first
670 /// version if 'From' is known to have a single result, use the second
671 /// if you have two nodes with identical results, use the third otherwise.
673 /// These methods all take an optional UpdateListener, which (if not null) is
674 /// informed about nodes that are deleted and modified due to recursive
675 /// changes in the dag.
677 void ReplaceAllUsesWith(SDValue From, SDValue Op,
678 DAGUpdateListener *UpdateListener = 0);
679 void ReplaceAllUsesWith(SDNode *From, SDNode *To,
680 DAGUpdateListener *UpdateListener = 0);
681 void ReplaceAllUsesWith(SDNode *From, const SDValue *To,
682 DAGUpdateListener *UpdateListener = 0);
684 /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
685 /// uses of other values produced by From.Val alone.
686 void ReplaceAllUsesOfValueWith(SDValue From, SDValue To,
687 DAGUpdateListener *UpdateListener = 0);
689 /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
690 /// for multiple values at once. This correctly handles the case where
691 /// there is an overlap between the From values and the To values.
692 void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
694 DAGUpdateListener *UpdateListener = 0);
696 /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
697 /// assign a unique node id for each node in the DAG based on their
698 /// topological order. Returns the number of nodes.
699 unsigned AssignTopologicalOrder();
701 /// RepositionNode - Move node N in the AllNodes list to be immediately
702 /// before the given iterator Position. This may be used to update the
703 /// topological ordering when the list of nodes is modified.
704 void RepositionNode(allnodes_iterator Position, SDNode *N) {
705 AllNodes.insert(Position, AllNodes.remove(N));
708 /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
710 static bool isCommutativeBinOp(unsigned Opcode) {
711 // FIXME: This should get its info from the td file, so that we can include
726 case ISD::ADDE: return true;
727 default: return false;
733 /// CreateStackTemporary - Create a stack temporary, suitable for holding the
734 /// specified value type. If minAlign is specified, the slot size will have
735 /// at least that alignment.
736 SDValue CreateStackTemporary(MVT VT, unsigned minAlign = 1);
738 /// FoldConstantArithmetic -
739 SDValue FoldConstantArithmetic(unsigned Opcode,
741 ConstantSDNode *Cst1,
742 ConstantSDNode *Cst2);
744 /// FoldSetCC - Constant fold a setcc to true or false.
745 SDValue FoldSetCC(MVT VT, SDValue N1,
746 SDValue N2, ISD::CondCode Cond);
748 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We
749 /// use this predicate to simplify operations downstream.
750 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
752 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We
753 /// use this predicate to simplify operations downstream. Op and Mask are
754 /// known to be the same type.
755 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
758 /// ComputeMaskedBits - Determine which of the bits specified in Mask are
759 /// known to be either zero or one and return them in the KnownZero/KnownOne
760 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit
761 /// processing. Targets can implement the computeMaskedBitsForTargetNode
762 /// method in the TargetLowering class to allow target nodes to be understood.
763 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
764 APInt &KnownOne, unsigned Depth = 0) const;
766 /// ComputeNumSignBits - Return the number of times the sign bit of the
767 /// register is replicated into the other bits. We know that at least 1 bit
768 /// is always equal to the sign bit (itself), but other cases can give us
769 /// information. For example, immediately after an "SRA X, 2", we know that
770 /// the top 3 bits are all equal to each other, so we return 3. Targets can
771 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
772 /// class to allow target nodes to be understood.
773 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
775 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
776 /// been verified as a debug information descriptor.
777 bool isVerifiedDebugInfoDesc(SDValue Op) const;
779 /// getShuffleScalarElt - Returns the scalar element that will make up the ith
780 /// element of the result of the vector shuffle.
781 SDValue getShuffleScalarElt(const SDNode *N, unsigned Idx);
784 bool RemoveNodeFromCSEMaps(SDNode *N);
785 SDNode *AddNonLeafNodeToCSEMaps(SDNode *N);
786 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
787 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
789 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
792 void DeleteNodeNotInCSEMaps(SDNode *N);
794 unsigned getMVTAlignment(MVT MemoryVT) const;
796 void allnodes_clear();
798 // List of non-single value types.
799 std::vector<SDVTList> VTList;
801 // Maps to auto-CSE operations.
802 std::vector<CondCodeSDNode*> CondCodeNodes;
804 std::vector<SDNode*> ValueTypeNodes;
805 std::map<MVT, SDNode*, MVT::compareRawBits> ExtendedValueTypeNodes;
806 StringMap<SDNode*> ExternalSymbols;
807 StringMap<SDNode*> TargetExternalSymbols;
810 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
811 typedef SelectionDAG::allnodes_iterator nodes_iterator;
812 static nodes_iterator nodes_begin(SelectionDAG *G) {
813 return G->allnodes_begin();
815 static nodes_iterator nodes_end(SelectionDAG *G) {
816 return G->allnodes_end();
820 } // end namespace llvm