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 SDNode Sentinel;
44 ilist_traits() : Sentinel(ISD::DELETED_NODE, SDVTList()) {}
46 SDNode *createSentinel() const {
49 static void destroySentinel(SDNode *) {}
51 static void deleteNode(SDNode *) {
52 assert(0 && "ilist_traits<SDNode> shouldn't see a deleteNode call!");
55 static void createNode(const SDNode &);
59 Unrestricted, // Combine may create illegal operations and illegal types.
60 NoIllegalTypes, // Combine may create illegal operations but no illegal types.
61 NoIllegalOperations // Combine may only create legal operations and types.
64 /// SelectionDAG class - This is used to represent a portion of an LLVM function
65 /// in a low-level Data Dependence DAG representation suitable for instruction
66 /// selection. This DAG is constructed as the first step of instruction
67 /// selection in order to allow implementation of machine specific optimizations
68 /// and code simplifications.
70 /// The representation used by the SelectionDAG is a target-independent
71 /// representation, which has some similarities to the GCC RTL representation,
72 /// but is significantly more simple, powerful, and is a graph form instead of a
78 FunctionLoweringInfo &FLI;
79 MachineModuleInfo *MMI;
82 /// CurDebugLoc - current file + line number. Changes as we build the DAG.
85 /// EntryNode - The starting token.
88 /// Root - The root of the entire DAG.
91 /// AllNodes - A linked list of nodes in the current DAG.
92 ilist<SDNode> AllNodes;
94 /// NodeAllocatorType - The AllocatorType for allocating SDNodes. We use
95 /// pool allocation with recycling.
96 typedef RecyclingAllocator<BumpPtrAllocator, SDNode, sizeof(LargestSDNode),
97 AlignOf<MostAlignedSDNode>::Alignment>
100 /// NodeAllocator - Pool allocation for nodes.
101 NodeAllocatorType NodeAllocator;
103 /// CSEMap - This structure is used to memoize nodes, automatically performing
104 /// CSE with existing nodes with a duplicate is requested.
105 FoldingSet<SDNode> CSEMap;
107 /// OperandAllocator - Pool allocation for machine-opcode SDNode operands.
108 BumpPtrAllocator OperandAllocator;
110 /// Allocator - Pool allocation for misc. objects that are created once per
112 BumpPtrAllocator Allocator;
114 /// VerifyNode - Sanity check the given node. Aborts if it is invalid.
115 void VerifyNode(SDNode *N);
117 /// setGraphColorHelper - Implementation of setSubgraphColor.
118 /// Return whether we had to truncate the search.
120 bool setSubgraphColorHelper(SDNode *N, const char *Color, 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; }
143 DebugLoc getCurDebugLoc() const { return CurDebugLoc; }
145 /// viewGraph - Pop up a GraphViz/gv window with the DAG rendered using 'dot'.
147 void viewGraph(const std::string &Title);
151 std::map<const SDNode *, std::string> NodeGraphAttrs;
154 /// clearGraphAttrs - Clear all previously defined node graph attributes.
155 /// Intended to be used from a debugging tool (eg. gdb).
156 void clearGraphAttrs();
158 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
160 void setGraphAttrs(const SDNode *N, const char *Attrs);
162 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
163 /// Used from getNodeAttributes.
164 const std::string getGraphAttrs(const SDNode *N) const;
166 /// setGraphColor - Convenience for setting node color attribute.
168 void setGraphColor(const SDNode *N, const char *Color);
170 /// setGraphColor - Convenience for setting subgraph color attribute.
172 void setSubgraphColor(SDNode *N, const char *Color);
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();
184 /// getRoot - Return the root tag of the SelectionDAG.
186 const SDValue &getRoot() const { return Root; }
188 /// getEntryNode - Return the token chain corresponding to the entry of the
190 SDValue getEntryNode() const {
191 return SDValue(const_cast<SDNode *>(&EntryNode), 0);
194 /// setRoot - Set the current root tag of the SelectionDAG.
196 const SDValue &setRoot(SDValue N) {
197 assert((!N.getNode() || N.getValueType() == MVT::Other) &&
198 "DAG root value is not a chain!");
202 void setCurDebugLoc(DebugLoc dl) { CurDebugLoc = dl; }
204 /// Combine - This iterates over the nodes in the SelectionDAG, folding
205 /// certain types of nodes together, or eliminating superfluous nodes. The
206 /// Level argument controls whether Combine is allowed to produce nodes and
207 /// types that are illegal on the target.
208 void Combine(CombineLevel Level, AliasAnalysis &AA, bool Fast);
210 /// LegalizeTypes - This transforms the SelectionDAG into a SelectionDAG that
211 /// only uses types natively supported by the target. Returns "true" if it
212 /// made any changes.
214 /// Note that this is an involved process that may invalidate pointers into
216 bool LegalizeTypes();
218 /// Legalize - This transforms the SelectionDAG into a SelectionDAG that is
219 /// compatible with the target instruction selector, as indicated by the
220 /// TargetLowering object.
222 /// Note that this is an involved process that may invalidate pointers into
224 void Legalize(bool TypesNeedLegalizing);
226 /// RemoveDeadNodes - This method deletes all unreachable nodes in the
228 void RemoveDeadNodes();
230 /// DeleteNode - Remove the specified node from the system. This node must
231 /// have no referrers.
232 void DeleteNode(SDNode *N);
234 /// getVTList - Return an SDVTList that represents the list of values
236 SDVTList getVTList(MVT VT);
237 SDVTList getVTList(MVT VT1, MVT VT2);
238 SDVTList getVTList(MVT VT1, MVT VT2, MVT VT3);
239 SDVTList getVTList(MVT VT1, MVT VT2, MVT VT3, MVT VT4);
240 SDVTList getVTList(const MVT *VTs, unsigned NumVTs);
242 /// getNodeValueTypes - These are obsolete, use getVTList instead.
243 const MVT *getNodeValueTypes(MVT VT) {
244 return getVTList(VT).VTs;
246 const MVT *getNodeValueTypes(MVT VT1, MVT VT2) {
247 return getVTList(VT1, VT2).VTs;
249 const MVT *getNodeValueTypes(MVT VT1, MVT VT2, MVT VT3) {
250 return getVTList(VT1, VT2, VT3).VTs;
252 const MVT *getNodeValueTypes(MVT VT1, MVT VT2, MVT VT3, MVT VT4) {
253 return getVTList(VT1, VT2, VT3, VT4).VTs;
255 const MVT *getNodeValueTypes(const std::vector<MVT> &vtList) {
256 return getVTList(&vtList[0], (unsigned)vtList.size()).VTs;
260 //===--------------------------------------------------------------------===//
261 // Node creation methods.
263 SDValue getConstant(uint64_t Val, MVT VT, bool isTarget = false);
264 SDValue getConstant(const APInt &Val, MVT VT, bool isTarget = false);
265 SDValue getConstant(const ConstantInt &Val, MVT VT, bool isTarget = false);
266 SDValue getIntPtrConstant(uint64_t Val, bool isTarget = false);
267 SDValue getTargetConstant(uint64_t Val, MVT VT) {
268 return getConstant(Val, VT, true);
270 SDValue getTargetConstant(const APInt &Val, MVT VT) {
271 return getConstant(Val, VT, true);
273 SDValue getTargetConstant(const ConstantInt &Val, MVT VT) {
274 return getConstant(Val, VT, true);
276 SDValue getConstantFP(double Val, MVT VT, bool isTarget = false);
277 SDValue getConstantFP(const APFloat& Val, MVT VT, bool isTarget = false);
278 SDValue getConstantFP(const ConstantFP &CF, MVT VT, bool isTarget = false);
279 SDValue getTargetConstantFP(double Val, MVT VT) {
280 return getConstantFP(Val, VT, true);
282 SDValue getTargetConstantFP(const APFloat& Val, MVT VT) {
283 return getConstantFP(Val, VT, true);
285 SDValue getTargetConstantFP(const ConstantFP &Val, MVT VT) {
286 return getConstantFP(Val, VT, true);
288 SDValue getGlobalAddress(const GlobalValue *GV, MVT VT,
289 int64_t offset = 0, bool isTargetGA = false);
290 SDValue getTargetGlobalAddress(const GlobalValue *GV, MVT VT,
291 int64_t offset = 0) {
292 return getGlobalAddress(GV, VT, offset, true);
294 SDValue getFrameIndex(int FI, MVT VT, bool isTarget = false);
295 SDValue getTargetFrameIndex(int FI, MVT VT) {
296 return getFrameIndex(FI, VT, true);
298 SDValue getJumpTable(int JTI, MVT VT, bool isTarget = false);
299 SDValue getTargetJumpTable(int JTI, MVT VT) {
300 return getJumpTable(JTI, VT, true);
302 SDValue getConstantPool(Constant *C, MVT VT,
303 unsigned Align = 0, int Offs = 0, bool isT=false);
304 SDValue getTargetConstantPool(Constant *C, MVT VT,
305 unsigned Align = 0, int Offset = 0) {
306 return getConstantPool(C, VT, Align, Offset, true);
308 SDValue getConstantPool(MachineConstantPoolValue *C, MVT VT,
309 unsigned Align = 0, int Offs = 0, bool isT=false);
310 SDValue getTargetConstantPool(MachineConstantPoolValue *C,
311 MVT VT, unsigned Align = 0,
313 return getConstantPool(C, VT, Align, Offset, true);
315 SDValue getBasicBlock(MachineBasicBlock *MBB);
316 SDValue getBasicBlock(MachineBasicBlock *MBB, DebugLoc dl);
317 SDValue getExternalSymbol(const char *Sym, MVT VT);
318 SDValue getExternalSymbol(const char *Sym, DebugLoc dl, MVT VT);
319 SDValue getTargetExternalSymbol(const char *Sym, MVT VT);
320 SDValue getTargetExternalSymbol(const char *Sym, DebugLoc dl, MVT VT);
321 SDValue getArgFlags(ISD::ArgFlagsTy Flags);
322 SDValue getValueType(MVT);
323 SDValue getRegister(unsigned Reg, MVT VT);
324 SDValue getDbgStopPoint(SDValue Root, unsigned Line, unsigned Col,
326 SDValue getLabel(unsigned Opcode, SDValue Root, unsigned LabelID);
327 SDValue getLabel(unsigned Opcode, DebugLoc dl, SDValue Root,
330 SDValue getCopyToReg(SDValue Chain, unsigned Reg, SDValue N) {
331 return getNode(ISD::CopyToReg, MVT::Other, Chain,
332 getRegister(Reg, N.getValueType()), N);
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, unsigned Reg, SDValue N,
340 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
341 SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
342 return getNode(ISD::CopyToReg, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
345 // Similar to last getCopyToReg() except parameter Reg is a SDValue
346 SDValue getCopyToReg(SDValue Chain, SDValue Reg, SDValue N,
348 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
349 SDValue Ops[] = { Chain, Reg, N, Flag };
350 return getNode(ISD::CopyToReg, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
353 SDValue getCopyFromReg(SDValue Chain, unsigned Reg, MVT VT) {
354 const MVT *VTs = getNodeValueTypes(VT, MVT::Other);
355 SDValue Ops[] = { Chain, getRegister(Reg, VT) };
356 return getNode(ISD::CopyFromReg, VTs, 2, Ops, 2);
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, unsigned Reg, MVT VT,
364 const MVT *VTs = getNodeValueTypes(VT, MVT::Other, MVT::Flag);
365 SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
366 return getNode(ISD::CopyFromReg, VTs, 3, Ops, Flag.getNode() ? 3 : 2);
369 SDValue getCondCode(ISD::CondCode Cond);
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(MVT VT, SDValue Val, SDValue DTy, SDValue STy,
374 SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
376 /// getZeroExtendInReg - Return the expression required to zero extend the Op
377 /// value assuming it was the smaller SrcTy value.
378 SDValue getZeroExtendInReg(SDValue Op, MVT SrcTy);
380 /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
381 SDValue getNOT(SDValue Val, MVT VT);
383 /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
384 /// a flag result (to ensure it's not CSE'd).
385 SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
386 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
387 SDValue Ops[] = { Chain, Op };
388 return getNode(ISD::CALLSEQ_START, VTs, 2, Ops, 2);
391 /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
392 /// flag result (to ensure it's not CSE'd).
393 SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
395 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
396 SmallVector<SDValue, 4> Ops;
397 Ops.push_back(Chain);
400 Ops.push_back(InFlag);
401 return getNode(ISD::CALLSEQ_END, NodeTys, &Ops[0],
402 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
405 /// getNode - Gets or creates the specified node.
407 SDValue getNode(unsigned Opcode, MVT VT);
408 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT);
409 SDValue getNode(unsigned Opcode, MVT VT, SDValue N);
410 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N);
411 SDValue getNode(unsigned Opcode, MVT VT, SDValue N1, SDValue N2);
412 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N1, SDValue N2);
413 SDValue getNode(unsigned Opcode, MVT VT,
414 SDValue N1, SDValue N2, SDValue N3);
415 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
416 SDValue N1, SDValue N2, SDValue N3);
417 SDValue getNode(unsigned Opcode, MVT VT,
418 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
419 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
420 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
421 SDValue getNode(unsigned Opcode, MVT VT,
422 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
424 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
425 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
427 SDValue getNode(unsigned Opcode, MVT VT,
428 const SDUse *Ops, unsigned NumOps);
429 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
430 const SDUse *Ops, unsigned NumOps);
431 SDValue getNode(unsigned Opcode, MVT VT,
432 const SDValue *Ops, unsigned NumOps);
433 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
434 const SDValue *Ops, unsigned NumOps);
435 SDValue getNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
436 const SDValue *Ops, unsigned NumOps);
437 SDValue getNode(unsigned Opcode, DebugLoc DL,
438 const std::vector<MVT> &ResultTys,
439 const SDValue *Ops, unsigned NumOps);
440 SDValue getNode(unsigned Opcode, const MVT *VTs, unsigned NumVTs,
441 const SDValue *Ops, unsigned NumOps);
442 SDValue getNode(unsigned Opcode, DebugLoc DL, const MVT *VTs, unsigned NumVTs,
443 const SDValue *Ops, unsigned NumOps);
444 SDValue getNode(unsigned Opcode, SDVTList VTs,
445 const SDValue *Ops, unsigned NumOps);
446 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
447 const SDValue *Ops, unsigned NumOps);
449 SDValue getNode(unsigned Opcode, SDVTList VTs);
450 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs);
451 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N);
452 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N);
453 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N1, SDValue N2);
454 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
455 SDValue N1, SDValue N2);
456 SDValue getNode(unsigned Opcode, SDVTList VTs,
457 SDValue N1, SDValue N2, SDValue N3);
458 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
459 SDValue N1, SDValue N2, SDValue N3);
460 SDValue getNode(unsigned Opcode, SDVTList VTs,
461 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
462 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
463 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
464 SDValue getNode(unsigned Opcode, SDVTList VTs,
465 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,
471 SDValue getMemcpy(SDValue Chain, SDValue Dst, SDValue Src,
472 SDValue Size, unsigned Align, bool AlwaysInline,
473 const Value *DstSV, uint64_t DstSVOff,
474 const Value *SrcSV, uint64_t SrcSVOff);
476 SDValue getMemmove(SDValue Chain, SDValue Dst, SDValue Src,
477 SDValue Size, unsigned Align,
478 const Value *DstSV, uint64_t DstOSVff,
479 const Value *SrcSV, uint64_t SrcSVOff);
481 SDValue getMemset(SDValue Chain, SDValue Dst, SDValue Src,
482 SDValue Size, unsigned Align,
483 const Value *DstSV, uint64_t DstSVOff);
485 /// getSetCC - Helper function to make it easier to build SetCC's if you just
486 /// have an ISD::CondCode instead of an SDValue.
488 SDValue getSetCC(MVT VT, SDValue LHS, SDValue RHS,
489 ISD::CondCode Cond) {
490 return getNode(ISD::SETCC, VT, LHS, RHS, getCondCode(Cond));
493 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
494 /// if you just have an ISD::CondCode instead of an SDValue.
496 SDValue getVSetCC(MVT VT, SDValue LHS, SDValue RHS,
497 ISD::CondCode Cond) {
498 return getNode(ISD::VSETCC, VT, LHS, RHS, getCondCode(Cond));
501 /// getSelectCC - Helper function to make it easier to build SelectCC's if you
502 /// just have an ISD::CondCode instead of an SDValue.
504 SDValue getSelectCC(SDValue LHS, SDValue RHS,
505 SDValue True, SDValue False, ISD::CondCode Cond) {
506 return getNode(ISD::SELECT_CC, True.getValueType(), LHS, RHS, True, False,
510 /// getVAArg - VAArg produces a result and token chain, and takes a pointer
511 /// and a source value as input.
512 SDValue getVAArg(MVT VT, SDValue Chain, SDValue Ptr,
515 /// getAtomic - Gets a node for an atomic op, produces result and chain and
517 SDValue getAtomic(unsigned Opcode, MVT MemVT, SDValue Chain, SDValue Ptr,
518 SDValue Cmp, SDValue Swp, const Value* PtrVal,
519 unsigned Alignment=0);
520 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
521 SDValue Ptr, SDValue Cmp, SDValue Swp, const Value* PtrVal,
522 unsigned Alignment=0);
524 /// getAtomic - Gets a node for an atomic op, produces result and chain and
525 /// takes 2 operands.
526 SDValue getAtomic(unsigned Opcode, MVT MemVT, SDValue Chain, SDValue Ptr,
527 SDValue Val, const Value* PtrVal,
528 unsigned Alignment = 0);
529 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
530 SDValue Ptr, SDValue Val, const Value* PtrVal,
531 unsigned Alignment = 0);
533 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
534 /// result and takes a list of operands.
535 SDValue getMemIntrinsicNode(unsigned Opcode,
536 const MVT *VTs, unsigned NumVTs,
537 const SDValue *Ops, unsigned NumOps,
538 MVT MemVT, const Value *srcValue, int SVOff,
539 unsigned Align = 0, bool Vol = false,
540 bool ReadMem = true, bool WriteMem = true);
541 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl,
542 const MVT *VTs, unsigned NumVTs,
543 const SDValue *Ops, unsigned NumOps,
544 MVT MemVT, const Value *srcValue, int SVOff,
545 unsigned Align = 0, bool Vol = false,
546 bool ReadMem = true, bool WriteMem = true);
548 SDValue getMemIntrinsicNode(unsigned Opcode, SDVTList VTList,
549 const SDValue *Ops, unsigned NumOps,
550 MVT MemVT, const Value *srcValue, int SVOff,
551 unsigned Align = 0, bool Vol = false,
552 bool ReadMem = true, bool WriteMem = true);
553 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
554 const SDValue *Ops, unsigned NumOps,
555 MVT MemVT, const Value *srcValue, int SVOff,
556 unsigned Align = 0, bool Vol = false,
557 bool ReadMem = true, bool WriteMem = true);
559 /// getMergeValues - Create a MERGE_VALUES node from the given operands.
560 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps);
562 /// getCall - Create a CALL node from the given information.
564 SDValue getCall(unsigned CallingConv, bool IsVarArgs, bool IsTailCall,
565 bool isInreg, SDVTList VTs, const SDValue *Operands,
566 unsigned NumOperands);
567 SDValue getCall(unsigned CallingConv, DebugLoc dl, bool IsVarArgs,
568 bool IsTailCall, bool isInreg, SDVTList VTs,
569 const SDValue *Operands, unsigned NumOperands);
571 /// getLoad - Loads are not normal binary operators: their result type is not
572 /// determined by their operands, and they produce a value AND a token chain.
574 SDValue getLoad(MVT VT, SDValue Chain, SDValue Ptr,
575 const Value *SV, int SVOffset, bool isVolatile=false,
576 unsigned Alignment=0);
577 SDValue getLoad(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
578 const Value *SV, int SVOffset, bool isVolatile=false,
579 unsigned Alignment=0);
580 SDValue getExtLoad(ISD::LoadExtType ExtType, MVT VT,
581 SDValue Chain, SDValue Ptr, const Value *SV,
582 int SVOffset, MVT EVT, bool isVolatile=false,
583 unsigned Alignment=0);
584 SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, MVT VT,
585 SDValue Chain, SDValue Ptr, const Value *SV,
586 int SVOffset, MVT EVT, bool isVolatile=false,
587 unsigned Alignment=0);
588 SDValue getIndexedLoad(SDValue OrigLoad, SDValue Base,
589 SDValue Offset, ISD::MemIndexedMode AM);
590 SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base,
591 SDValue Offset, ISD::MemIndexedMode AM);
592 SDValue getLoad(ISD::MemIndexedMode AM, ISD::LoadExtType ExtType,
593 MVT VT, SDValue Chain,
594 SDValue Ptr, SDValue Offset,
595 const Value *SV, int SVOffset, MVT EVT,
596 bool isVolatile=false, unsigned Alignment=0);
597 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
598 MVT VT, SDValue Chain,
599 SDValue Ptr, SDValue Offset,
600 const Value *SV, int SVOffset, MVT EVT,
601 bool isVolatile=false, unsigned Alignment=0);
603 /// getStore - Helper function to build ISD::STORE nodes.
605 SDValue getStore(SDValue Chain, SDValue Val, SDValue Ptr,
606 const Value *SV, int SVOffset, bool isVolatile=false,
607 unsigned Alignment=0);
608 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
609 const Value *SV, int SVOffset, bool isVolatile=false,
610 unsigned Alignment=0);
611 SDValue getTruncStore(SDValue Chain, SDValue Val, SDValue Ptr,
612 const Value *SV, int SVOffset, MVT TVT,
613 bool isVolatile=false, unsigned Alignment=0);
614 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
615 const Value *SV, int SVOffset, MVT TVT,
616 bool isVolatile=false, unsigned Alignment=0);
617 SDValue getIndexedStore(SDValue OrigStoe, SDValue Base,
618 SDValue Offset, ISD::MemIndexedMode AM);
619 SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base,
620 SDValue Offset, ISD::MemIndexedMode AM);
622 /// getSrcValue - Construct a node to track a Value* through the backend.
623 SDValue getSrcValue(const Value *v);
625 /// getMemOperand - Construct a node to track a memory reference
626 /// through the backend.
627 SDValue getMemOperand(const MachineMemOperand &MO);
629 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
630 /// specified operands. If the resultant node already exists in the DAG,
631 /// this does not modify the specified node, instead it returns the node that
632 /// already exists. If the resultant node does not exist in the DAG, the
633 /// input node is returned. As a degenerate case, if you specify the same
634 /// input operands as the node already has, the input node is returned.
635 SDValue UpdateNodeOperands(SDValue N, SDValue Op);
636 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
637 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
639 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
640 SDValue Op3, SDValue Op4);
641 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
642 SDValue Op3, SDValue Op4, SDValue Op5);
643 SDValue UpdateNodeOperands(SDValue N,
644 const SDValue *Ops, unsigned NumOps);
646 /// SelectNodeTo - These are used for target selectors to *mutate* the
647 /// specified node to have the specified return type, Target opcode, and
648 /// operands. Note that target opcodes are stored as
649 /// ~TargetOpcode in the node opcode field. The resultant node is returned.
650 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT);
651 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, SDValue Op1);
652 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
653 SDValue Op1, SDValue Op2);
654 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
655 SDValue Op1, SDValue Op2, SDValue Op3);
656 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
657 const SDValue *Ops, unsigned NumOps);
658 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, MVT VT2);
659 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
660 MVT VT2, const SDValue *Ops, unsigned NumOps);
661 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
662 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
663 SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, MVT VT1,
664 MVT VT2, MVT VT3, MVT VT4, const SDValue *Ops,
666 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
667 MVT VT2, SDValue Op1);
668 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
669 MVT VT2, SDValue Op1, SDValue Op2);
670 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
671 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
672 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
673 MVT VT2, MVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
674 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
675 const SDValue *Ops, unsigned NumOps);
677 /// MorphNodeTo - These *mutate* the specified node to have the specified
678 /// return type, opcode, and operands.
679 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT);
680 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, SDValue Op1);
681 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
682 SDValue Op1, SDValue Op2);
683 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
684 SDValue Op1, SDValue Op2, SDValue Op3);
685 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
686 const SDValue *Ops, unsigned NumOps);
687 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, MVT VT2);
688 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
689 MVT VT2, const SDValue *Ops, unsigned NumOps);
690 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
691 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
692 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
693 MVT VT2, SDValue Op1);
694 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
695 MVT VT2, SDValue Op1, SDValue Op2);
696 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
697 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
698 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
699 const SDValue *Ops, unsigned NumOps);
701 /// getTargetNode - These are used for target selectors to create a new node
702 /// with specified return type(s), target opcode, and operands.
704 /// Note that getTargetNode returns the resultant node. If there is already a
705 /// node of the specified opcode and operands, it returns that node instead of
707 SDNode *getTargetNode(unsigned Opcode, MVT VT);
708 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT);
710 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1);
711 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1);
713 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1, SDValue Op2);
714 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1,
717 SDNode *getTargetNode(unsigned Opcode, MVT VT,
718 SDValue Op1, SDValue Op2, SDValue Op3);
719 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
720 SDValue Op1, SDValue Op2, SDValue Op3);
722 SDNode *getTargetNode(unsigned Opcode, MVT VT,
723 const SDValue *Ops, unsigned NumOps);
724 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
725 const SDValue *Ops, unsigned NumOps);
727 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2);
728 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2);
730 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, SDValue Op1);
731 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
734 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
735 MVT VT2, SDValue Op1, SDValue Op2);
736 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
737 MVT VT2, SDValue Op1, SDValue Op2);
739 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
740 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
741 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
742 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
744 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2,
745 const SDValue *Ops, unsigned NumOps);
746 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
747 const SDValue *Ops, unsigned NumOps);
749 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
750 SDValue Op1, SDValue Op2);
751 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
752 SDValue Op1, SDValue Op2);
754 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
755 SDValue Op1, SDValue Op2, SDValue Op3);
756 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
757 SDValue Op1, SDValue Op2, SDValue Op3);
759 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
760 const SDValue *Ops, unsigned NumOps);
761 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
762 const SDValue *Ops, unsigned NumOps);
764 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, MVT VT4,
765 const SDValue *Ops, unsigned NumOps);
766 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
767 MVT VT4, const SDValue *Ops, unsigned NumOps);
769 SDNode *getTargetNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
770 const SDValue *Ops, unsigned NumOps);
771 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl,
772 const std::vector<MVT> &ResultTys, const SDValue *Ops,
775 /// getNodeIfExists - Get the specified node if it's already available, or
776 /// else return NULL.
777 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
778 const SDValue *Ops, unsigned NumOps);
780 /// DAGUpdateListener - Clients of various APIs that cause global effects on
781 /// the DAG can optionally implement this interface. This allows the clients
782 /// to handle the various sorts of updates that happen.
783 class DAGUpdateListener {
785 virtual ~DAGUpdateListener();
787 /// NodeDeleted - The node N that was deleted and, if E is not null, an
788 /// equivalent node E that replaced it.
789 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
791 /// NodeUpdated - The node N that was updated.
792 virtual void NodeUpdated(SDNode *N) = 0;
795 /// RemoveDeadNode - Remove the specified node from the system. If any of its
796 /// operands then becomes dead, remove them as well. Inform UpdateListener
797 /// for each node deleted.
798 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
800 /// RemoveDeadNodes - This method deletes the unreachable nodes in the
801 /// given list, and any nodes that become unreachable as a result.
802 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
803 DAGUpdateListener *UpdateListener = 0);
805 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
806 /// This can cause recursive merging of nodes in the DAG. Use the first
807 /// version if 'From' is known to have a single result, use the second
808 /// if you have two nodes with identical results, use the third otherwise.
810 /// These methods all take an optional UpdateListener, which (if not null) is
811 /// informed about nodes that are deleted and modified due to recursive
812 /// changes in the dag.
814 /// These functions only replace all existing uses. It's possible that as
815 /// these replacements are being performed, CSE may cause the From node
816 /// to be given new uses. These new uses of From are left in place, and
817 /// not automatically transfered to To.
819 void ReplaceAllUsesWith(SDValue From, SDValue Op,
820 DAGUpdateListener *UpdateListener = 0);
821 void ReplaceAllUsesWith(SDNode *From, SDNode *To,
822 DAGUpdateListener *UpdateListener = 0);
823 void ReplaceAllUsesWith(SDNode *From, const SDValue *To,
824 DAGUpdateListener *UpdateListener = 0);
826 /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
827 /// uses of other values produced by From.Val alone.
828 void ReplaceAllUsesOfValueWith(SDValue From, SDValue To,
829 DAGUpdateListener *UpdateListener = 0);
831 /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
832 /// for multiple values at once. This correctly handles the case where
833 /// there is an overlap between the From values and the To values.
834 void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
836 DAGUpdateListener *UpdateListener = 0);
838 /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
839 /// assign a unique node id for each node in the DAG based on their
840 /// topological order. Returns the number of nodes.
841 unsigned AssignTopologicalOrder();
843 /// RepositionNode - Move node N in the AllNodes list to be immediately
844 /// before the given iterator Position. This may be used to update the
845 /// topological ordering when the list of nodes is modified.
846 void RepositionNode(allnodes_iterator Position, SDNode *N) {
847 AllNodes.insert(Position, AllNodes.remove(N));
850 /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
852 static bool isCommutativeBinOp(unsigned Opcode) {
853 // FIXME: This should get its info from the td file, so that we can include
868 case ISD::ADDE: return true;
869 default: return false;
875 /// CreateStackTemporary - Create a stack temporary, suitable for holding the
876 /// specified value type. If minAlign is specified, the slot size will have
877 /// at least that alignment.
878 SDValue CreateStackTemporary(MVT VT, unsigned minAlign = 1);
880 /// CreateStackTemporary - Create a stack temporary suitable for holding
881 /// either of the specified value types.
882 SDValue CreateStackTemporary(MVT VT1, MVT VT2);
884 /// FoldConstantArithmetic -
885 SDValue FoldConstantArithmetic(unsigned Opcode,
887 ConstantSDNode *Cst1,
888 ConstantSDNode *Cst2);
890 /// FoldSetCC - Constant fold a setcc to true or false.
891 SDValue FoldSetCC(MVT VT, SDValue N1,
892 SDValue N2, ISD::CondCode Cond);
894 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We
895 /// use this predicate to simplify operations downstream.
896 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
898 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We
899 /// use this predicate to simplify operations downstream. Op and Mask are
900 /// known to be the same type.
901 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
904 /// ComputeMaskedBits - Determine which of the bits specified in Mask are
905 /// known to be either zero or one and return them in the KnownZero/KnownOne
906 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit
907 /// processing. Targets can implement the computeMaskedBitsForTargetNode
908 /// method in the TargetLowering class to allow target nodes to be understood.
909 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
910 APInt &KnownOne, unsigned Depth = 0) const;
912 /// ComputeNumSignBits - Return the number of times the sign bit of the
913 /// register is replicated into the other bits. We know that at least 1 bit
914 /// is always equal to the sign bit (itself), but other cases can give us
915 /// information. For example, immediately after an "SRA X, 2", we know that
916 /// the top 3 bits are all equal to each other, so we return 3. Targets can
917 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
918 /// class to allow target nodes to be understood.
919 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
921 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
922 /// been verified as a debug information descriptor.
923 bool isVerifiedDebugInfoDesc(SDValue Op) const;
925 /// getShuffleScalarElt - Returns the scalar element that will make up the ith
926 /// element of the result of the vector shuffle.
927 SDValue getShuffleScalarElt(const SDNode *N, unsigned Idx);
930 bool RemoveNodeFromCSEMaps(SDNode *N);
931 void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener);
932 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
933 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
935 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
938 void DeleteNodeNotInCSEMaps(SDNode *N);
939 void DeallocateNode(SDNode *N);
941 unsigned getMVTAlignment(MVT MemoryVT) const;
943 void allnodes_clear();
945 /// VTList - List of non-single value types.
946 std::vector<SDVTList> VTList;
948 /// CondCodeNodes - Maps to auto-CSE operations.
949 std::vector<CondCodeSDNode*> CondCodeNodes;
951 std::vector<SDNode*> ValueTypeNodes;
952 std::map<MVT, SDNode*, MVT::compareRawBits> ExtendedValueTypeNodes;
953 StringMap<SDNode*> ExternalSymbols;
954 StringMap<SDNode*> TargetExternalSymbols;
957 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
958 typedef SelectionDAG::allnodes_iterator nodes_iterator;
959 static nodes_iterator nodes_begin(SelectionDAG *G) {
960 return G->allnodes_begin();
962 static nodes_iterator nodes_end(SelectionDAG *G) {
963 return G->allnodes_end();
967 } // end namespace llvm