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;
36 class MachineFunction;
37 class MachineConstantPoolValue;
38 class FunctionLoweringInfo;
40 template<> struct ilist_traits<SDNode> : public ilist_default_traits<SDNode> {
42 mutable ilist_node<SDNode> Sentinel;
44 SDNode *createSentinel() const {
45 return static_cast<SDNode*>(&Sentinel);
47 static void destroySentinel(SDNode *) {}
49 SDNode *provideInitialHead() const { return createSentinel(); }
50 SDNode *ensureHead(SDNode*) const { return createSentinel(); }
51 static void noteHead(SDNode*, SDNode*) {}
53 static void deleteNode(SDNode *) {
54 assert(0 && "ilist_traits<SDNode> shouldn't see a deleteNode call!");
57 static void createNode(const SDNode &);
61 Unrestricted, // Combine may create illegal operations and illegal types.
62 NoIllegalTypes, // Combine may create illegal operations but no illegal types.
63 NoIllegalOperations // Combine may only create legal operations and types.
66 /// SelectionDAG class - This is used to represent a portion of an LLVM function
67 /// in a low-level Data Dependence DAG representation suitable for instruction
68 /// selection. This DAG is constructed as the first step of instruction
69 /// selection in order to allow implementation of machine specific optimizations
70 /// and code simplifications.
72 /// The representation used by the SelectionDAG is a target-independent
73 /// representation, which has some similarities to the GCC RTL representation,
74 /// but is significantly more simple, powerful, and is a graph form instead of a
80 FunctionLoweringInfo &FLI;
81 MachineModuleInfo *MMI;
84 /// EntryNode - The starting token.
87 /// Root - The root of the entire DAG.
90 /// AllNodes - A linked list of nodes in the current DAG.
91 ilist<SDNode> AllNodes;
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>
99 /// NodeAllocator - Pool allocation for nodes.
100 NodeAllocatorType NodeAllocator;
102 /// CSEMap - This structure is used to memoize nodes, automatically performing
103 /// CSE with existing nodes with a duplicate is requested.
104 FoldingSet<SDNode> CSEMap;
106 /// OperandAllocator - Pool allocation for machine-opcode SDNode operands.
107 BumpPtrAllocator OperandAllocator;
109 /// Allocator - Pool allocation for misc. objects that are created once per
111 BumpPtrAllocator Allocator;
113 /// VerifyNode - Sanity check the given node. Aborts if it is invalid.
114 void VerifyNode(SDNode *N);
116 /// setGraphColorHelper - Implementation of setSubgraphColor.
117 /// Return whether we had to truncate the search.
119 bool setSubgraphColorHelper(SDNode *N, const char *Color,
120 DenseSet<SDNode *> &visited,
121 int level, bool &printed);
124 SelectionDAG(TargetLowering &tli, FunctionLoweringInfo &fli);
127 /// init - Prepare this SelectionDAG to process code in the given
130 void init(MachineFunction &mf, MachineModuleInfo *mmi, DwarfWriter *dw);
132 /// clear - Clear state and free memory necessary to make this
133 /// SelectionDAG ready to process a new block.
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; }
144 /// viewGraph - Pop up a GraphViz/gv window with the DAG rendered using 'dot'.
146 void viewGraph(const std::string &Title);
150 std::map<const SDNode *, std::string> NodeGraphAttrs;
153 /// clearGraphAttrs - Clear all previously defined node graph attributes.
154 /// Intended to be used from a debugging tool (eg. gdb).
155 void clearGraphAttrs();
157 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
159 void setGraphAttrs(const SDNode *N, const char *Attrs);
161 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
162 /// Used from getNodeAttributes.
163 const std::string getGraphAttrs(const SDNode *N) const;
165 /// setGraphColor - Convenience for setting node color attribute.
167 void setGraphColor(const SDNode *N, const char *Color);
169 /// setGraphColor - Convenience for setting subgraph color attribute.
171 void setSubgraphColor(SDNode *N, const char *Color);
173 typedef ilist<SDNode>::const_iterator allnodes_const_iterator;
174 allnodes_const_iterator allnodes_begin() const { return AllNodes.begin(); }
175 allnodes_const_iterator allnodes_end() const { return AllNodes.end(); }
176 typedef ilist<SDNode>::iterator allnodes_iterator;
177 allnodes_iterator allnodes_begin() { return AllNodes.begin(); }
178 allnodes_iterator allnodes_end() { return AllNodes.end(); }
179 ilist<SDNode>::size_type allnodes_size() const {
180 return AllNodes.size();
183 /// getRoot - Return the root tag of the SelectionDAG.
185 const SDValue &getRoot() const { return Root; }
187 /// getEntryNode - Return the token chain corresponding to the entry of the
189 SDValue getEntryNode() const {
190 return SDValue(const_cast<SDNode *>(&EntryNode), 0);
193 /// setRoot - Set the current root tag of the SelectionDAG.
195 const SDValue &setRoot(SDValue N) {
196 assert((!N.getNode() || N.getValueType() == MVT::Other) &&
197 "DAG root value is not a chain!");
201 /// Combine - This iterates over the nodes in the SelectionDAG, folding
202 /// certain types of nodes together, or eliminating superfluous nodes. The
203 /// Level argument controls whether Combine is allowed to produce nodes and
204 /// types that are illegal on the target.
205 void Combine(CombineLevel Level, AliasAnalysis &AA, bool Fast);
207 /// LegalizeTypes - This transforms the SelectionDAG into a SelectionDAG that
208 /// only uses types natively supported by the target. Returns "true" if it
209 /// made any changes.
211 /// Note that this is an involved process that may invalidate pointers into
213 bool LegalizeTypes();
215 /// Legalize - This transforms the SelectionDAG into a SelectionDAG that is
216 /// compatible with the target instruction selector, as indicated by the
217 /// TargetLowering object.
219 /// Note that this is an involved process that may invalidate pointers into
221 void Legalize(bool TypesNeedLegalizing, bool Fast);
223 /// RemoveDeadNodes - This method deletes all unreachable nodes in the
225 void RemoveDeadNodes();
227 /// DeleteNode - Remove the specified node from the system. This node must
228 /// have no referrers.
229 void DeleteNode(SDNode *N);
231 /// getVTList - Return an SDVTList that represents the list of values
233 SDVTList getVTList(MVT VT);
234 SDVTList getVTList(MVT VT1, MVT VT2);
235 SDVTList getVTList(MVT VT1, MVT VT2, MVT VT3);
236 SDVTList getVTList(MVT VT1, MVT VT2, MVT VT3, MVT VT4);
237 SDVTList getVTList(const MVT *VTs, unsigned NumVTs);
239 //===--------------------------------------------------------------------===//
240 // Node creation methods.
242 SDValue getConstant(uint64_t Val, MVT VT, bool isTarget = false);
243 SDValue getConstant(const APInt &Val, MVT VT, bool isTarget = false);
244 SDValue getConstant(const ConstantInt &Val, MVT VT, bool isTarget = false);
245 SDValue getIntPtrConstant(uint64_t Val, bool isTarget = false);
246 SDValue getTargetConstant(uint64_t Val, MVT VT) {
247 return getConstant(Val, VT, true);
249 SDValue getTargetConstant(const APInt &Val, MVT VT) {
250 return getConstant(Val, VT, true);
252 SDValue getTargetConstant(const ConstantInt &Val, MVT VT) {
253 return getConstant(Val, VT, true);
255 SDValue getConstantFP(double Val, MVT VT, bool isTarget = false);
256 SDValue getConstantFP(const APFloat& Val, MVT VT, bool isTarget = false);
257 SDValue getConstantFP(const ConstantFP &CF, MVT VT, bool isTarget = false);
258 SDValue getTargetConstantFP(double Val, MVT VT) {
259 return getConstantFP(Val, VT, true);
261 SDValue getTargetConstantFP(const APFloat& Val, MVT VT) {
262 return getConstantFP(Val, VT, true);
264 SDValue getTargetConstantFP(const ConstantFP &Val, MVT VT) {
265 return getConstantFP(Val, VT, true);
267 SDValue getGlobalAddress(const GlobalValue *GV, MVT VT,
268 int64_t offset = 0, bool isTargetGA = false);
269 SDValue getTargetGlobalAddress(const GlobalValue *GV, MVT VT,
270 int64_t offset = 0) {
271 return getGlobalAddress(GV, VT, offset, true);
273 SDValue getFrameIndex(int FI, MVT VT, bool isTarget = false);
274 SDValue getTargetFrameIndex(int FI, MVT VT) {
275 return getFrameIndex(FI, VT, true);
277 SDValue getJumpTable(int JTI, MVT VT, bool isTarget = false);
278 SDValue getTargetJumpTable(int JTI, MVT VT) {
279 return getJumpTable(JTI, VT, true);
281 SDValue getConstantPool(Constant *C, MVT VT,
282 unsigned Align = 0, int Offs = 0, bool isT=false);
283 SDValue getTargetConstantPool(Constant *C, MVT VT,
284 unsigned Align = 0, int Offset = 0) {
285 return getConstantPool(C, VT, Align, Offset, true);
287 SDValue getConstantPool(MachineConstantPoolValue *C, MVT VT,
288 unsigned Align = 0, int Offs = 0, bool isT=false);
289 SDValue getTargetConstantPool(MachineConstantPoolValue *C,
290 MVT VT, unsigned Align = 0,
292 return getConstantPool(C, VT, Align, Offset, true);
294 // When generating a branch to a BB, we don't in general know enough
295 // to provide debug info for the BB at that time, so keep this one around.
296 SDValue getBasicBlock(MachineBasicBlock *MBB);
297 SDValue getBasicBlock(MachineBasicBlock *MBB, DebugLoc dl);
298 SDValue getExternalSymbol(const char *Sym, MVT VT);
299 SDValue getExternalSymbol(const char *Sym, DebugLoc dl, MVT VT);
300 SDValue getTargetExternalSymbol(const char *Sym, MVT VT);
301 SDValue getTargetExternalSymbol(const char *Sym, DebugLoc dl, MVT VT);
302 SDValue getArgFlags(ISD::ArgFlagsTy Flags);
303 SDValue getValueType(MVT);
304 SDValue getRegister(unsigned Reg, MVT VT);
305 SDValue getDbgStopPoint(SDValue Root, unsigned Line, unsigned Col,
307 SDValue getLabel(unsigned Opcode, DebugLoc dl, SDValue Root,
310 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N) {
311 return getNode(ISD::CopyToReg, dl, MVT::Other, Chain,
312 getRegister(Reg, N.getValueType()), N);
315 // This version of the getCopyToReg method takes an extra operand, which
316 // indicates that there is potentially an incoming flag value (if Flag is not
317 // null) and that there should be a flag result.
318 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N,
320 SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
321 SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
322 return getNode(ISD::CopyToReg, dl, VTs, Ops, Flag.getNode() ? 4 : 3);
325 // Similar to last getCopyToReg() except parameter Reg is a SDValue
326 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, SDValue Reg, SDValue N,
328 SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
329 SDValue Ops[] = { Chain, Reg, N, Flag };
330 return getNode(ISD::CopyToReg, dl, VTs, Ops, Flag.getNode() ? 4 : 3);
333 SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, MVT VT) {
334 SDVTList VTs = getVTList(VT, MVT::Other);
335 SDValue Ops[] = { Chain, getRegister(Reg, VT) };
336 return getNode(ISD::CopyFromReg, dl, VTs, Ops, 2);
339 // This version of the getCopyFromReg method takes an extra operand, which
340 // indicates that there is potentially an incoming flag value (if Flag is not
341 // null) and that there should be a flag result.
342 SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, MVT VT,
344 SDVTList VTs = getVTList(VT, MVT::Other, MVT::Flag);
345 SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
346 return getNode(ISD::CopyFromReg, dl, VTs, Ops, Flag.getNode() ? 3 : 2);
349 SDValue getCondCode(ISD::CondCode Cond);
351 /// Returns the ConvertRndSat Note: Avoid using this node because it may
352 /// disappear in the future and most targets don't support it.
353 SDValue getConvertRndSat(MVT VT, DebugLoc dl, SDValue Val, SDValue DTy,
355 SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
357 /// getZeroExtendInReg - Return the expression required to zero extend the Op
358 /// value assuming it was the smaller SrcTy value.
359 SDValue getZeroExtendInReg(SDValue Op, DebugLoc DL, MVT SrcTy);
361 /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
362 SDValue getNOT(DebugLoc DL, SDValue Val, MVT VT);
364 /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
365 /// a flag result (to ensure it's not CSE'd). CALLSEQ_START does not have a
367 SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
368 SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
369 SDValue Ops[] = { Chain, Op };
370 return getNode(ISD::CALLSEQ_START, DebugLoc::getUnknownLoc(),
374 /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
375 /// flag result (to ensure it's not CSE'd). CALLSEQ_END does not have
376 /// a useful DebugLoc.
377 SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
379 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
380 SmallVector<SDValue, 4> Ops;
381 Ops.push_back(Chain);
384 Ops.push_back(InFlag);
385 return getNode(ISD::CALLSEQ_END, DebugLoc::getUnknownLoc(), NodeTys,
387 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
390 /// getUNDEF - Return an UNDEF node. UNDEF does not have a useful DebugLoc.
391 SDValue getUNDEF(MVT VT) {
392 return getNode(ISD::UNDEF, DebugLoc::getUnknownLoc(), VT);
395 /// getGLOBAL_OFFSET_TABLE - Return a GLOBAL_OFFSET_TABLE node. This does
396 /// not have a useful DebugLoc.
397 SDValue getGLOBAL_OFFSET_TABLE(MVT VT) {
398 return getNode(ISD::GLOBAL_OFFSET_TABLE, DebugLoc::getUnknownLoc(), VT);
401 /// getNode - Gets or creates the specified node.
403 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT);
404 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N);
405 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N1, SDValue N2);
406 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
407 SDValue N1, SDValue N2, SDValue N3);
408 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
409 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
410 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
411 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
413 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
414 const SDUse *Ops, unsigned NumOps);
415 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
416 const SDValue *Ops, unsigned NumOps);
417 SDValue getNode(unsigned Opcode, DebugLoc DL,
418 const std::vector<MVT> &ResultTys,
419 const SDValue *Ops, unsigned NumOps);
420 SDValue getNode(unsigned Opcode, DebugLoc DL, const MVT *VTs, unsigned NumVTs,
421 const SDValue *Ops, unsigned NumOps);
422 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
423 const SDValue *Ops, unsigned NumOps);
424 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs);
425 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N);
426 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
427 SDValue N1, SDValue N2);
428 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
429 SDValue N1, SDValue N2, SDValue N3);
430 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
431 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
432 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
433 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
436 SDValue getMemcpy(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
437 SDValue Size, unsigned Align, bool AlwaysInline,
438 const Value *DstSV, uint64_t DstSVOff,
439 const Value *SrcSV, uint64_t SrcSVOff);
441 SDValue getMemmove(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
442 SDValue Size, unsigned Align,
443 const Value *DstSV, uint64_t DstOSVff,
444 const Value *SrcSV, uint64_t SrcSVOff);
446 SDValue getMemset(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
447 SDValue Size, unsigned Align,
448 const Value *DstSV, uint64_t DstSVOff);
450 /// getSetCC - Helper function to make it easier to build SetCC's if you just
451 /// have an ISD::CondCode instead of an SDValue.
453 SDValue getSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS,
454 ISD::CondCode Cond) {
455 return getNode(ISD::SETCC, DL, VT, LHS, RHS, getCondCode(Cond));
458 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
459 /// if you just have an ISD::CondCode instead of an SDValue.
461 SDValue getVSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS,
462 ISD::CondCode Cond) {
463 return getNode(ISD::VSETCC, DL, VT, LHS, RHS, getCondCode(Cond));
466 /// getSelectCC - Helper function to make it easier to build SelectCC's if you
467 /// just have an ISD::CondCode instead of an SDValue.
469 SDValue getSelectCC(DebugLoc DL, SDValue LHS, SDValue RHS,
470 SDValue True, SDValue False, ISD::CondCode Cond) {
471 return getNode(ISD::SELECT_CC, DL, True.getValueType(),
472 LHS, RHS, True, False, getCondCode(Cond));
475 /// getVAArg - VAArg produces a result and token chain, and takes a pointer
476 /// and a source value as input.
477 SDValue getVAArg(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
480 /// getAtomic - Gets a node for an atomic op, produces result and chain and
482 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
483 SDValue Ptr, SDValue Cmp, SDValue Swp, const Value* PtrVal,
484 unsigned Alignment=0);
486 /// getAtomic - Gets a node for an atomic op, produces result and chain and
487 /// takes 2 operands.
488 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
489 SDValue Ptr, SDValue Val, const Value* PtrVal,
490 unsigned Alignment = 0);
492 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
493 /// result and takes a list of operands.
494 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl,
495 const MVT *VTs, unsigned NumVTs,
496 const SDValue *Ops, unsigned NumOps,
497 MVT MemVT, const Value *srcValue, int SVOff,
498 unsigned Align = 0, bool Vol = false,
499 bool ReadMem = true, bool WriteMem = true);
501 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
502 const SDValue *Ops, unsigned NumOps,
503 MVT MemVT, const Value *srcValue, int SVOff,
504 unsigned Align = 0, bool Vol = false,
505 bool ReadMem = true, bool WriteMem = true);
507 /// getMergeValues - Create a MERGE_VALUES node from the given operands.
508 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps, DebugLoc dl);
510 /// getCall - Create a CALL node from the given information.
512 SDValue getCall(unsigned CallingConv, DebugLoc dl, bool IsVarArgs,
513 bool IsTailCall, bool isInreg, SDVTList VTs,
514 const SDValue *Operands, unsigned NumOperands);
516 /// getLoad - Loads are not normal binary operators: their result type is not
517 /// determined by their operands, and they produce a value AND a token chain.
519 SDValue getLoad(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
520 const Value *SV, int SVOffset, bool isVolatile=false,
521 unsigned Alignment=0);
522 SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, MVT VT,
523 SDValue Chain, SDValue Ptr, const Value *SV,
524 int SVOffset, MVT EVT, bool isVolatile=false,
525 unsigned Alignment=0);
526 SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base,
527 SDValue Offset, ISD::MemIndexedMode AM);
528 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
529 MVT VT, SDValue Chain,
530 SDValue Ptr, SDValue Offset,
531 const Value *SV, int SVOffset, MVT EVT,
532 bool isVolatile=false, unsigned Alignment=0);
534 /// getStore - Helper function to build ISD::STORE nodes.
536 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
537 const Value *SV, int SVOffset, bool isVolatile=false,
538 unsigned Alignment=0);
539 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
540 const Value *SV, int SVOffset, MVT TVT,
541 bool isVolatile=false, unsigned Alignment=0);
542 SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base,
543 SDValue Offset, ISD::MemIndexedMode AM);
545 /// getSrcValue - Construct a node to track a Value* through the backend.
546 SDValue getSrcValue(const Value *v);
548 /// getMemOperand - Construct a node to track a memory reference
549 /// through the backend.
550 SDValue getMemOperand(const MachineMemOperand &MO);
552 /// getShiftAmountOperand - Return the specified value casted to
553 /// the target's desired shift amount type.
554 SDValue getShiftAmountOperand(SDValue Op);
556 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
557 /// specified operands. If the resultant node already exists in the DAG,
558 /// this does not modify the specified node, instead it returns the node that
559 /// already exists. If the resultant node does not exist in the DAG, the
560 /// input node is returned. As a degenerate case, if you specify the same
561 /// input operands as the node already has, the input node is returned.
562 SDValue UpdateNodeOperands(SDValue N, SDValue Op);
563 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
564 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
566 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
567 SDValue Op3, SDValue Op4);
568 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
569 SDValue Op3, SDValue Op4, SDValue Op5);
570 SDValue UpdateNodeOperands(SDValue N,
571 const SDValue *Ops, unsigned NumOps);
573 /// SelectNodeTo - These are used for target selectors to *mutate* the
574 /// specified node to have the specified return type, Target opcode, and
575 /// operands. Note that target opcodes are stored as
576 /// ~TargetOpcode in the node opcode field. The resultant node is returned.
577 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT);
578 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, SDValue Op1);
579 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
580 SDValue Op1, SDValue Op2);
581 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
582 SDValue Op1, SDValue Op2, SDValue Op3);
583 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
584 const SDValue *Ops, unsigned NumOps);
585 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, MVT VT2);
586 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
587 MVT VT2, const SDValue *Ops, unsigned NumOps);
588 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
589 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
590 SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, MVT VT1,
591 MVT VT2, MVT VT3, MVT VT4, const SDValue *Ops,
593 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
594 MVT VT2, SDValue Op1);
595 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
596 MVT VT2, SDValue Op1, SDValue Op2);
597 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
598 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
599 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
600 MVT VT2, MVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
601 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
602 const SDValue *Ops, unsigned NumOps);
604 /// MorphNodeTo - These *mutate* the specified node to have the specified
605 /// return type, opcode, and operands.
606 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT);
607 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, SDValue Op1);
608 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
609 SDValue Op1, SDValue Op2);
610 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
611 SDValue Op1, SDValue Op2, SDValue Op3);
612 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
613 const SDValue *Ops, unsigned NumOps);
614 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, MVT VT2);
615 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
616 MVT VT2, const SDValue *Ops, unsigned NumOps);
617 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
618 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
619 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
620 MVT VT2, SDValue Op1);
621 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
622 MVT VT2, SDValue Op1, SDValue Op2);
623 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
624 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
625 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
626 const SDValue *Ops, unsigned NumOps);
628 /// getTargetNode - These are used for target selectors to create a new node
629 /// with specified return type(s), target opcode, and operands.
631 /// Note that getTargetNode returns the resultant node. If there is already a
632 /// node of the specified opcode and operands, it returns that node instead of
634 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT);
635 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1);
636 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1,
638 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
639 SDValue Op1, SDValue Op2, SDValue Op3);
640 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
641 const SDValue *Ops, unsigned NumOps);
642 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2);
643 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
645 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
646 MVT VT2, SDValue Op1, SDValue Op2);
647 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
648 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
649 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
650 const SDValue *Ops, unsigned NumOps);
651 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
652 SDValue Op1, SDValue Op2);
653 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
654 SDValue Op1, SDValue Op2, SDValue Op3);
655 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
656 const SDValue *Ops, unsigned NumOps);
657 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
658 MVT VT4, const SDValue *Ops, unsigned NumOps);
659 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl,
660 const std::vector<MVT> &ResultTys, const SDValue *Ops,
663 /// getNodeIfExists - Get the specified node if it's already available, or
664 /// else return NULL.
665 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
666 const SDValue *Ops, unsigned NumOps);
668 /// DAGUpdateListener - Clients of various APIs that cause global effects on
669 /// the DAG can optionally implement this interface. This allows the clients
670 /// to handle the various sorts of updates that happen.
671 class DAGUpdateListener {
673 virtual ~DAGUpdateListener();
675 /// NodeDeleted - The node N that was deleted and, if E is not null, an
676 /// equivalent node E that replaced it.
677 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
679 /// NodeUpdated - The node N that was updated.
680 virtual void NodeUpdated(SDNode *N) = 0;
683 /// RemoveDeadNode - Remove the specified node from the system. If any of its
684 /// operands then becomes dead, remove them as well. Inform UpdateListener
685 /// for each node deleted.
686 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
688 /// RemoveDeadNodes - This method deletes the unreachable nodes in the
689 /// given list, and any nodes that become unreachable as a result.
690 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
691 DAGUpdateListener *UpdateListener = 0);
693 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
694 /// This can cause recursive merging of nodes in the DAG. Use the first
695 /// version if 'From' is known to have a single result, use the second
696 /// if you have two nodes with identical results, use the third otherwise.
698 /// These methods all take an optional UpdateListener, which (if not null) is
699 /// informed about nodes that are deleted and modified due to recursive
700 /// changes in the dag.
702 /// These functions only replace all existing uses. It's possible that as
703 /// these replacements are being performed, CSE may cause the From node
704 /// to be given new uses. These new uses of From are left in place, and
705 /// not automatically transfered to To.
707 void ReplaceAllUsesWith(SDValue From, SDValue Op,
708 DAGUpdateListener *UpdateListener = 0);
709 void ReplaceAllUsesWith(SDNode *From, SDNode *To,
710 DAGUpdateListener *UpdateListener = 0);
711 void ReplaceAllUsesWith(SDNode *From, const SDValue *To,
712 DAGUpdateListener *UpdateListener = 0);
714 /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
715 /// uses of other values produced by From.Val alone.
716 void ReplaceAllUsesOfValueWith(SDValue From, SDValue To,
717 DAGUpdateListener *UpdateListener = 0);
719 /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
720 /// for multiple values at once. This correctly handles the case where
721 /// there is an overlap between the From values and the To values.
722 void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
724 DAGUpdateListener *UpdateListener = 0);
726 /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
727 /// assign a unique node id for each node in the DAG based on their
728 /// topological order. Returns the number of nodes.
729 unsigned AssignTopologicalOrder();
731 /// RepositionNode - Move node N in the AllNodes list to be immediately
732 /// before the given iterator Position. This may be used to update the
733 /// topological ordering when the list of nodes is modified.
734 void RepositionNode(allnodes_iterator Position, SDNode *N) {
735 AllNodes.insert(Position, AllNodes.remove(N));
738 /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
740 static bool isCommutativeBinOp(unsigned Opcode) {
741 // FIXME: This should get its info from the td file, so that we can include
758 case ISD::ADDE: return true;
759 default: return false;
765 /// CreateStackTemporary - Create a stack temporary, suitable for holding the
766 /// specified value type. If minAlign is specified, the slot size will have
767 /// at least that alignment.
768 SDValue CreateStackTemporary(MVT VT, unsigned minAlign = 1);
770 /// CreateStackTemporary - Create a stack temporary suitable for holding
771 /// either of the specified value types.
772 SDValue CreateStackTemporary(MVT VT1, MVT VT2);
774 /// FoldConstantArithmetic -
775 SDValue FoldConstantArithmetic(unsigned Opcode,
777 ConstantSDNode *Cst1,
778 ConstantSDNode *Cst2);
780 /// FoldSetCC - Constant fold a setcc to true or false.
781 SDValue FoldSetCC(MVT VT, SDValue N1,
782 SDValue N2, ISD::CondCode Cond, DebugLoc dl);
784 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We
785 /// use this predicate to simplify operations downstream.
786 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
788 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We
789 /// use this predicate to simplify operations downstream. Op and Mask are
790 /// known to be the same type.
791 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
794 /// ComputeMaskedBits - Determine which of the bits specified in Mask are
795 /// known to be either zero or one and return them in the KnownZero/KnownOne
796 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit
797 /// processing. Targets can implement the computeMaskedBitsForTargetNode
798 /// method in the TargetLowering class to allow target nodes to be understood.
799 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
800 APInt &KnownOne, unsigned Depth = 0) const;
802 /// ComputeNumSignBits - Return the number of times the sign bit of the
803 /// register is replicated into the other bits. We know that at least 1 bit
804 /// is always equal to the sign bit (itself), but other cases can give us
805 /// information. For example, immediately after an "SRA X, 2", we know that
806 /// the top 3 bits are all equal to each other, so we return 3. Targets can
807 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
808 /// class to allow target nodes to be understood.
809 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
811 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
812 /// been verified as a debug information descriptor.
813 bool isVerifiedDebugInfoDesc(SDValue Op) const;
815 /// getShuffleScalarElt - Returns the scalar element that will make up the ith
816 /// element of the result of the vector shuffle.
817 SDValue getShuffleScalarElt(const SDNode *N, unsigned Idx);
820 bool RemoveNodeFromCSEMaps(SDNode *N);
821 void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener);
822 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
823 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
825 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
828 void DeleteNodeNotInCSEMaps(SDNode *N);
829 void DeallocateNode(SDNode *N);
831 unsigned getMVTAlignment(MVT MemoryVT) const;
833 void allnodes_clear();
835 /// VTList - List of non-single value types.
836 std::vector<SDVTList> VTList;
838 /// CondCodeNodes - Maps to auto-CSE operations.
839 std::vector<CondCodeSDNode*> CondCodeNodes;
841 std::vector<SDNode*> ValueTypeNodes;
842 std::map<MVT, SDNode*, MVT::compareRawBits> ExtendedValueTypeNodes;
843 StringMap<SDNode*> ExternalSymbols;
844 StringMap<SDNode*> TargetExternalSymbols;
847 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
848 typedef SelectionDAG::allnodes_iterator nodes_iterator;
849 static nodes_iterator nodes_begin(SelectionDAG *G) {
850 return G->allnodes_begin();
852 static nodes_iterator nodes_end(SelectionDAG *G) {
853 return G->allnodes_end();
857 } // end namespace llvm