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 /// EntryNode - The starting token.
85 /// Root - The root of the entire DAG.
88 /// AllNodes - A linked list of nodes in the current DAG.
89 ilist<SDNode> AllNodes;
91 /// NodeAllocatorType - The AllocatorType for allocating SDNodes. We use
92 /// pool allocation with recycling.
93 typedef RecyclingAllocator<BumpPtrAllocator, SDNode, sizeof(LargestSDNode),
94 AlignOf<MostAlignedSDNode>::Alignment>
97 /// NodeAllocator - Pool allocation for nodes.
98 NodeAllocatorType NodeAllocator;
100 /// CSEMap - This structure is used to memoize nodes, automatically performing
101 /// CSE with existing nodes with a duplicate is requested.
102 FoldingSet<SDNode> CSEMap;
104 /// OperandAllocator - Pool allocation for machine-opcode SDNode operands.
105 BumpPtrAllocator OperandAllocator;
107 /// Allocator - Pool allocation for misc. objects that are created once per
109 BumpPtrAllocator Allocator;
111 /// VerifyNode - Sanity check the given node. Aborts if it is invalid.
112 void VerifyNode(SDNode *N);
114 /// setGraphColorHelper - Implementation of setSubgraphColor.
115 /// Return whether we had to truncate the search.
117 bool setSubgraphColorHelper(SDNode *N, const char *Color, DenseSet<SDNode *> &visited,
118 int level, bool &printed);
121 SelectionDAG(TargetLowering &tli, FunctionLoweringInfo &fli);
124 /// init - Prepare this SelectionDAG to process code in the given
127 void init(MachineFunction &mf, MachineModuleInfo *mmi, DwarfWriter *dw);
129 /// clear - Clear state and free memory necessary to make this
130 /// SelectionDAG ready to process a new block.
134 MachineFunction &getMachineFunction() const { return *MF; }
135 const TargetMachine &getTarget() const;
136 TargetLowering &getTargetLoweringInfo() const { return TLI; }
137 FunctionLoweringInfo &getFunctionLoweringInfo() const { return FLI; }
138 MachineModuleInfo *getMachineModuleInfo() const { return MMI; }
139 DwarfWriter *getDwarfWriter() const { return DW; }
141 /// viewGraph - Pop up a GraphViz/gv window with the DAG rendered using 'dot'.
143 void viewGraph(const std::string &Title);
147 std::map<const SDNode *, std::string> NodeGraphAttrs;
150 /// clearGraphAttrs - Clear all previously defined node graph attributes.
151 /// Intended to be used from a debugging tool (eg. gdb).
152 void clearGraphAttrs();
154 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
156 void setGraphAttrs(const SDNode *N, const char *Attrs);
158 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
159 /// Used from getNodeAttributes.
160 const std::string getGraphAttrs(const SDNode *N) const;
162 /// setGraphColor - Convenience for setting node color attribute.
164 void setGraphColor(const SDNode *N, const char *Color);
166 /// setGraphColor - Convenience for setting subgraph color attribute.
168 void setSubgraphColor(SDNode *N, const char *Color);
170 typedef ilist<SDNode>::const_iterator allnodes_const_iterator;
171 allnodes_const_iterator allnodes_begin() const { return AllNodes.begin(); }
172 allnodes_const_iterator allnodes_end() const { return AllNodes.end(); }
173 typedef ilist<SDNode>::iterator allnodes_iterator;
174 allnodes_iterator allnodes_begin() { return AllNodes.begin(); }
175 allnodes_iterator allnodes_end() { return AllNodes.end(); }
176 ilist<SDNode>::size_type allnodes_size() const {
177 return AllNodes.size();
180 /// getRoot - Return the root tag of the SelectionDAG.
182 const SDValue &getRoot() const { return Root; }
184 /// getEntryNode - Return the token chain corresponding to the entry of the
186 SDValue getEntryNode() const {
187 return SDValue(const_cast<SDNode *>(&EntryNode), 0);
190 /// setRoot - Set the current root tag of the SelectionDAG.
192 const SDValue &setRoot(SDValue N) {
193 assert((!N.getNode() || N.getValueType() == MVT::Other) &&
194 "DAG root value is not a chain!");
198 /// Combine - This iterates over the nodes in the SelectionDAG, folding
199 /// certain types of nodes together, or eliminating superfluous nodes. The
200 /// Level argument controls whether Combine is allowed to produce nodes and
201 /// types that are illegal on the target.
202 void Combine(CombineLevel Level, AliasAnalysis &AA, bool Fast);
204 /// LegalizeTypes - This transforms the SelectionDAG into a SelectionDAG that
205 /// only uses types natively supported by the target. Returns "true" if it
206 /// made any changes.
208 /// Note that this is an involved process that may invalidate pointers into
210 bool LegalizeTypes();
212 /// Legalize - This transforms the SelectionDAG into a SelectionDAG that is
213 /// compatible with the target instruction selector, as indicated by the
214 /// TargetLowering object.
216 /// Note that this is an involved process that may invalidate pointers into
218 void Legalize(bool TypesNeedLegalizing);
220 /// RemoveDeadNodes - This method deletes all unreachable nodes in the
222 void RemoveDeadNodes();
224 /// DeleteNode - Remove the specified node from the system. This node must
225 /// have no referrers.
226 void DeleteNode(SDNode *N);
228 /// getVTList - Return an SDVTList that represents the list of values
230 SDVTList getVTList(MVT VT);
231 SDVTList getVTList(MVT VT1, MVT VT2);
232 SDVTList getVTList(MVT VT1, MVT VT2, MVT VT3);
233 SDVTList getVTList(MVT VT1, MVT VT2, MVT VT3, MVT VT4);
234 SDVTList getVTList(const MVT *VTs, unsigned NumVTs);
236 /// getNodeValueTypes - These are obsolete, use getVTList instead.
237 const MVT *getNodeValueTypes(MVT VT) {
238 return getVTList(VT).VTs;
240 const MVT *getNodeValueTypes(MVT VT1, MVT VT2) {
241 return getVTList(VT1, VT2).VTs;
243 const MVT *getNodeValueTypes(MVT VT1, MVT VT2, MVT VT3) {
244 return getVTList(VT1, VT2, VT3).VTs;
246 const MVT *getNodeValueTypes(MVT VT1, MVT VT2, MVT VT3, MVT VT4) {
247 return getVTList(VT1, VT2, VT3, VT4).VTs;
249 const MVT *getNodeValueTypes(const std::vector<MVT> &vtList) {
250 return getVTList(&vtList[0], (unsigned)vtList.size()).VTs;
254 //===--------------------------------------------------------------------===//
255 // Node creation methods.
257 SDValue getConstant(uint64_t Val, MVT VT, bool isTarget = false);
258 SDValue getConstant(const APInt &Val, MVT VT, bool isTarget = false);
259 SDValue getConstant(const ConstantInt &Val, MVT VT, bool isTarget = false);
260 SDValue getIntPtrConstant(uint64_t Val, bool isTarget = false);
261 SDValue getTargetConstant(uint64_t Val, MVT VT) {
262 return getConstant(Val, VT, true);
264 SDValue getTargetConstant(const APInt &Val, MVT VT) {
265 return getConstant(Val, VT, true);
267 SDValue getTargetConstant(const ConstantInt &Val, MVT VT) {
268 return getConstant(Val, VT, true);
270 SDValue getConstantFP(double Val, MVT VT, bool isTarget = false);
271 SDValue getConstantFP(const APFloat& Val, MVT VT, bool isTarget = false);
272 SDValue getConstantFP(const ConstantFP &CF, MVT VT, bool isTarget = false);
273 SDValue getTargetConstantFP(double Val, MVT VT) {
274 return getConstantFP(Val, VT, true);
276 SDValue getTargetConstantFP(const APFloat& Val, MVT VT) {
277 return getConstantFP(Val, VT, true);
279 SDValue getTargetConstantFP(const ConstantFP &Val, MVT VT) {
280 return getConstantFP(Val, VT, true);
282 SDValue getGlobalAddress(const GlobalValue *GV, MVT VT,
283 int64_t offset = 0, bool isTargetGA = false);
284 SDValue getTargetGlobalAddress(const GlobalValue *GV, MVT VT,
285 int64_t offset = 0) {
286 return getGlobalAddress(GV, VT, offset, true);
288 SDValue getFrameIndex(int FI, MVT VT, bool isTarget = false);
289 SDValue getTargetFrameIndex(int FI, MVT VT) {
290 return getFrameIndex(FI, VT, true);
292 SDValue getJumpTable(int JTI, MVT VT, bool isTarget = false);
293 SDValue getTargetJumpTable(int JTI, MVT VT) {
294 return getJumpTable(JTI, VT, true);
296 SDValue getConstantPool(Constant *C, MVT VT,
297 unsigned Align = 0, int Offs = 0, bool isT=false);
298 SDValue getTargetConstantPool(Constant *C, MVT VT,
299 unsigned Align = 0, int Offset = 0) {
300 return getConstantPool(C, VT, Align, Offset, true);
302 SDValue getConstantPool(MachineConstantPoolValue *C, MVT VT,
303 unsigned Align = 0, int Offs = 0, bool isT=false);
304 SDValue getTargetConstantPool(MachineConstantPoolValue *C,
305 MVT VT, unsigned Align = 0,
307 return getConstantPool(C, VT, Align, Offset, true);
309 SDValue getBasicBlock(MachineBasicBlock *MBB);
310 SDValue getBasicBlock(MachineBasicBlock *MBB, DebugLoc dl);
311 SDValue getExternalSymbol(const char *Sym, MVT VT);
312 SDValue getExternalSymbol(const char *Sym, DebugLoc dl, MVT VT);
313 SDValue getTargetExternalSymbol(const char *Sym, MVT VT);
314 SDValue getTargetExternalSymbol(const char *Sym, DebugLoc dl, MVT VT);
315 SDValue getArgFlags(ISD::ArgFlagsTy Flags);
316 SDValue getValueType(MVT);
317 SDValue getRegister(unsigned Reg, MVT VT);
318 SDValue getDbgStopPoint(SDValue Root, unsigned Line, unsigned Col,
320 SDValue getLabel(unsigned Opcode, SDValue Root, unsigned LabelID);
321 SDValue getLabel(unsigned Opcode, DebugLoc dl, SDValue Root,
324 SDValue getCopyToReg(SDValue Chain, unsigned Reg, SDValue N) {
325 return getNode(ISD::CopyToReg, MVT::Other, Chain,
326 getRegister(Reg, N.getValueType()), N);
329 // This version of the getCopyToReg method takes an extra operand, which
330 // indicates that there is potentially an incoming flag value (if Flag is not
331 // null) and that there should be a flag result.
332 SDValue getCopyToReg(SDValue Chain, unsigned Reg, SDValue N,
334 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
335 SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
336 return getNode(ISD::CopyToReg, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
339 // Similar to last getCopyToReg() except parameter Reg is a SDValue
340 SDValue getCopyToReg(SDValue Chain, SDValue Reg, SDValue N,
342 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
343 SDValue Ops[] = { Chain, Reg, N, Flag };
344 return getNode(ISD::CopyToReg, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
347 SDValue getCopyFromReg(SDValue Chain, unsigned Reg, MVT VT) {
348 const MVT *VTs = getNodeValueTypes(VT, MVT::Other);
349 SDValue Ops[] = { Chain, getRegister(Reg, VT) };
350 return getNode(ISD::CopyFromReg, VTs, 2, Ops, 2);
353 // This version of the getCopyFromReg method takes an extra operand, which
354 // indicates that there is potentially an incoming flag value (if Flag is not
355 // null) and that there should be a flag result.
356 SDValue getCopyFromReg(SDValue Chain, unsigned Reg, MVT VT,
358 const MVT *VTs = getNodeValueTypes(VT, MVT::Other, MVT::Flag);
359 SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
360 return getNode(ISD::CopyFromReg, VTs, 3, Ops, Flag.getNode() ? 3 : 2);
363 SDValue getCondCode(ISD::CondCode Cond);
365 /// Returns the ConvertRndSat Note: Avoid using this node because it may
366 /// disappear in the future and most targets don't support it.
367 SDValue getConvertRndSat(MVT VT, SDValue Val, SDValue DTy, SDValue STy,
368 SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
370 /// getZeroExtendInReg - Return the expression required to zero extend the Op
371 /// value assuming it was the smaller SrcTy value.
372 SDValue getZeroExtendInReg(SDValue Op, MVT SrcTy);
374 /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
375 SDValue getNOT(SDValue Val, MVT VT);
377 /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
378 /// a flag result (to ensure it's not CSE'd).
379 SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
380 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
381 SDValue Ops[] = { Chain, Op };
382 return getNode(ISD::CALLSEQ_START, VTs, 2, Ops, 2);
385 /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
386 /// flag result (to ensure it's not CSE'd).
387 SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
389 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
390 SmallVector<SDValue, 4> Ops;
391 Ops.push_back(Chain);
394 Ops.push_back(InFlag);
395 return getNode(ISD::CALLSEQ_END, NodeTys, &Ops[0],
396 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
399 /// getNode - Gets or creates the specified node.
401 SDValue getNode(unsigned Opcode, MVT VT);
402 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT);
403 SDValue getNode(unsigned Opcode, MVT VT, SDValue N);
404 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N);
405 SDValue getNode(unsigned Opcode, MVT VT, SDValue N1, SDValue N2);
406 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N1, SDValue N2);
407 SDValue getNode(unsigned Opcode, MVT VT,
408 SDValue N1, SDValue N2, SDValue N3);
409 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
410 SDValue N1, SDValue N2, SDValue N3);
411 SDValue getNode(unsigned Opcode, MVT VT,
412 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
413 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
414 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
415 SDValue getNode(unsigned Opcode, MVT VT,
416 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
418 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
419 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
421 SDValue getNode(unsigned Opcode, MVT VT,
422 const SDUse *Ops, unsigned NumOps);
423 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
424 const SDUse *Ops, unsigned NumOps);
425 SDValue getNode(unsigned Opcode, MVT VT,
426 const SDValue *Ops, unsigned NumOps);
427 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
428 const SDValue *Ops, unsigned NumOps);
429 SDValue getNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
430 const SDValue *Ops, unsigned NumOps);
431 SDValue getNode(unsigned Opcode, DebugLoc DL,
432 const std::vector<MVT> &ResultTys,
433 const SDValue *Ops, unsigned NumOps);
434 SDValue getNode(unsigned Opcode, const MVT *VTs, unsigned NumVTs,
435 const SDValue *Ops, unsigned NumOps);
436 SDValue getNode(unsigned Opcode, DebugLoc DL, const MVT *VTs, unsigned NumVTs,
437 const SDValue *Ops, unsigned NumOps);
438 SDValue getNode(unsigned Opcode, SDVTList VTs,
439 const SDValue *Ops, unsigned NumOps);
440 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
441 const SDValue *Ops, unsigned NumOps);
443 SDValue getNode(unsigned Opcode, SDVTList VTs);
444 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs);
445 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N);
446 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N);
447 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N1, SDValue N2);
448 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
449 SDValue N1, SDValue N2);
450 SDValue getNode(unsigned Opcode, SDVTList VTs,
451 SDValue N1, SDValue N2, SDValue N3);
452 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
453 SDValue N1, SDValue N2, SDValue N3);
454 SDValue getNode(unsigned Opcode, SDVTList VTs,
455 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
456 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
457 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
458 SDValue getNode(unsigned Opcode, SDVTList VTs,
459 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
461 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
462 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
465 SDValue getMemcpy(SDValue Chain, SDValue Dst, SDValue Src,
466 SDValue Size, unsigned Align, bool AlwaysInline,
467 const Value *DstSV, uint64_t DstSVOff,
468 const Value *SrcSV, uint64_t SrcSVOff);
470 SDValue getMemmove(SDValue Chain, SDValue Dst, SDValue Src,
471 SDValue Size, unsigned Align,
472 const Value *DstSV, uint64_t DstOSVff,
473 const Value *SrcSV, uint64_t SrcSVOff);
475 SDValue getMemset(SDValue Chain, SDValue Dst, SDValue Src,
476 SDValue Size, unsigned Align,
477 const Value *DstSV, uint64_t DstSVOff);
479 /// getSetCC - Helper function to make it easier to build SetCC's if you just
480 /// have an ISD::CondCode instead of an SDValue.
482 SDValue getSetCC(MVT VT, SDValue LHS, SDValue RHS,
483 ISD::CondCode Cond) {
484 return getNode(ISD::SETCC, VT, LHS, RHS, getCondCode(Cond));
487 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
488 /// if you just have an ISD::CondCode instead of an SDValue.
490 SDValue getVSetCC(MVT VT, SDValue LHS, SDValue RHS,
491 ISD::CondCode Cond) {
492 return getNode(ISD::VSETCC, VT, LHS, RHS, getCondCode(Cond));
495 /// getSelectCC - Helper function to make it easier to build SelectCC's if you
496 /// just have an ISD::CondCode instead of an SDValue.
498 SDValue getSelectCC(SDValue LHS, SDValue RHS,
499 SDValue True, SDValue False, ISD::CondCode Cond) {
500 return getNode(ISD::SELECT_CC, True.getValueType(), LHS, RHS, True, False,
504 /// getVAArg - VAArg produces a result and token chain, and takes a pointer
505 /// and a source value as input.
506 SDValue getVAArg(MVT VT, SDValue Chain, SDValue Ptr,
509 /// getAtomic - Gets a node for an atomic op, produces result and chain and
511 SDValue getAtomic(unsigned Opcode, MVT MemVT, SDValue Chain, SDValue Ptr,
512 SDValue Cmp, SDValue Swp, const Value* PtrVal,
513 unsigned Alignment=0);
514 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
515 SDValue Ptr, SDValue Cmp, SDValue Swp, const Value* PtrVal,
516 unsigned Alignment=0);
518 /// getAtomic - Gets a node for an atomic op, produces result and chain and
519 /// takes 2 operands.
520 SDValue getAtomic(unsigned Opcode, MVT MemVT, SDValue Chain, SDValue Ptr,
521 SDValue Val, const Value* PtrVal,
522 unsigned Alignment = 0);
523 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
524 SDValue Ptr, SDValue Val, const Value* PtrVal,
525 unsigned Alignment = 0);
527 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
528 /// result and takes a list of operands.
529 SDValue getMemIntrinsicNode(unsigned Opcode,
530 const MVT *VTs, unsigned NumVTs,
531 const SDValue *Ops, unsigned NumOps,
532 MVT MemVT, const Value *srcValue, int SVOff,
533 unsigned Align = 0, bool Vol = false,
534 bool ReadMem = true, bool WriteMem = true);
535 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl,
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);
542 SDValue getMemIntrinsicNode(unsigned Opcode, SDVTList VTList,
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);
547 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
548 const SDValue *Ops, unsigned NumOps,
549 MVT MemVT, const Value *srcValue, int SVOff,
550 unsigned Align = 0, bool Vol = false,
551 bool ReadMem = true, bool WriteMem = true);
553 /// getMergeValues - Create a MERGE_VALUES node from the given operands.
554 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps);
556 /// getCall - Create a CALL node from the given information.
558 SDValue getCall(unsigned CallingConv, bool IsVarArgs, bool IsTailCall,
559 bool isInreg, SDVTList VTs, const SDValue *Operands,
560 unsigned NumOperands);
561 SDValue getCall(unsigned CallingConv, DebugLoc dl, bool IsVarArgs,
562 bool IsTailCall, bool isInreg, SDVTList VTs,
563 const SDValue *Operands, unsigned NumOperands);
565 /// getLoad - Loads are not normal binary operators: their result type is not
566 /// determined by their operands, and they produce a value AND a token chain.
568 SDValue getLoad(MVT VT, SDValue Chain, SDValue Ptr,
569 const Value *SV, int SVOffset, bool isVolatile=false,
570 unsigned Alignment=0);
571 SDValue getLoad(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
572 const Value *SV, int SVOffset, bool isVolatile=false,
573 unsigned Alignment=0);
574 SDValue getExtLoad(ISD::LoadExtType ExtType, MVT VT,
575 SDValue Chain, SDValue Ptr, const Value *SV,
576 int SVOffset, MVT EVT, bool isVolatile=false,
577 unsigned Alignment=0);
578 SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, MVT VT,
579 SDValue Chain, SDValue Ptr, const Value *SV,
580 int SVOffset, MVT EVT, bool isVolatile=false,
581 unsigned Alignment=0);
582 SDValue getIndexedLoad(SDValue OrigLoad, SDValue Base,
583 SDValue Offset, ISD::MemIndexedMode AM);
584 SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base,
585 SDValue Offset, ISD::MemIndexedMode AM);
586 SDValue getLoad(ISD::MemIndexedMode AM, ISD::LoadExtType ExtType,
587 MVT VT, SDValue Chain,
588 SDValue Ptr, SDValue Offset,
589 const Value *SV, int SVOffset, MVT EVT,
590 bool isVolatile=false, unsigned Alignment=0);
591 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
592 MVT VT, SDValue Chain,
593 SDValue Ptr, SDValue Offset,
594 const Value *SV, int SVOffset, MVT EVT,
595 bool isVolatile=false, unsigned Alignment=0);
597 /// getStore - Helper function to build ISD::STORE nodes.
599 SDValue getStore(SDValue Chain, SDValue Val, SDValue Ptr,
600 const Value *SV, int SVOffset, bool isVolatile=false,
601 unsigned Alignment=0);
602 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
603 const Value *SV, int SVOffset, bool isVolatile=false,
604 unsigned Alignment=0);
605 SDValue getTruncStore(SDValue Chain, SDValue Val, SDValue Ptr,
606 const Value *SV, int SVOffset, MVT TVT,
607 bool isVolatile=false, unsigned Alignment=0);
608 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
609 const Value *SV, int SVOffset, MVT TVT,
610 bool isVolatile=false, unsigned Alignment=0);
611 SDValue getIndexedStore(SDValue OrigStoe, SDValue Base,
612 SDValue Offset, ISD::MemIndexedMode AM);
613 SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base,
614 SDValue Offset, ISD::MemIndexedMode AM);
616 /// getSrcValue - Construct a node to track a Value* through the backend.
617 SDValue getSrcValue(const Value *v);
619 /// getMemOperand - Construct a node to track a memory reference
620 /// through the backend.
621 SDValue getMemOperand(const MachineMemOperand &MO);
623 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
624 /// specified operands. If the resultant node already exists in the DAG,
625 /// this does not modify the specified node, instead it returns the node that
626 /// already exists. If the resultant node does not exist in the DAG, the
627 /// input node is returned. As a degenerate case, if you specify the same
628 /// input operands as the node already has, the input node is returned.
629 SDValue UpdateNodeOperands(SDValue N, SDValue Op);
630 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
631 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
633 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
634 SDValue Op3, SDValue Op4);
635 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
636 SDValue Op3, SDValue Op4, SDValue Op5);
637 SDValue UpdateNodeOperands(SDValue N,
638 const SDValue *Ops, unsigned NumOps);
640 /// SelectNodeTo - These are used for target selectors to *mutate* the
641 /// specified node to have the specified return type, Target opcode, and
642 /// operands. Note that target opcodes are stored as
643 /// ~TargetOpcode in the node opcode field. The resultant node is returned.
644 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT);
645 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, SDValue Op1);
646 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
647 SDValue Op1, SDValue Op2);
648 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
649 SDValue Op1, SDValue Op2, SDValue Op3);
650 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
651 const SDValue *Ops, unsigned NumOps);
652 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, MVT VT2);
653 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
654 MVT VT2, const SDValue *Ops, unsigned NumOps);
655 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
656 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
657 SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, MVT VT1,
658 MVT VT2, MVT VT3, MVT VT4, const SDValue *Ops,
660 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
661 MVT VT2, SDValue Op1);
662 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
663 MVT VT2, SDValue Op1, SDValue Op2);
664 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
665 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
666 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
667 MVT VT2, MVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
668 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
669 const SDValue *Ops, unsigned NumOps);
671 /// MorphNodeTo - These *mutate* the specified node to have the specified
672 /// return type, opcode, and operands.
673 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT);
674 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, SDValue Op1);
675 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
676 SDValue Op1, SDValue Op2);
677 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
678 SDValue Op1, SDValue Op2, SDValue Op3);
679 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
680 const SDValue *Ops, unsigned NumOps);
681 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, MVT VT2);
682 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
683 MVT VT2, const SDValue *Ops, unsigned NumOps);
684 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
685 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
686 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
687 MVT VT2, SDValue Op1);
688 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
689 MVT VT2, SDValue Op1, SDValue Op2);
690 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
691 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
692 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
693 const SDValue *Ops, unsigned NumOps);
695 /// getTargetNode - These are used for target selectors to create a new node
696 /// with specified return type(s), target opcode, and operands.
698 /// Note that getTargetNode returns the resultant node. If there is already a
699 /// node of the specified opcode and operands, it returns that node instead of
701 SDNode *getTargetNode(unsigned Opcode, MVT VT);
702 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT);
704 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1);
705 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1);
707 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1, SDValue Op2);
708 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1,
711 SDNode *getTargetNode(unsigned Opcode, MVT VT,
712 SDValue Op1, SDValue Op2, SDValue Op3);
713 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
714 SDValue Op1, SDValue Op2, SDValue Op3);
716 SDNode *getTargetNode(unsigned Opcode, MVT VT,
717 const SDValue *Ops, unsigned NumOps);
718 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
719 const SDValue *Ops, unsigned NumOps);
721 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2);
722 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2);
724 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, SDValue Op1);
725 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
728 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
729 MVT VT2, SDValue Op1, SDValue Op2);
730 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
731 MVT VT2, SDValue Op1, SDValue Op2);
733 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
734 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
735 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
736 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
738 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2,
739 const SDValue *Ops, unsigned NumOps);
740 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
741 const SDValue *Ops, unsigned NumOps);
743 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
744 SDValue Op1, SDValue Op2);
745 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
746 SDValue Op1, SDValue Op2);
748 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
749 SDValue Op1, SDValue Op2, SDValue Op3);
750 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
751 SDValue Op1, SDValue Op2, SDValue Op3);
753 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
754 const SDValue *Ops, unsigned NumOps);
755 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
756 const SDValue *Ops, unsigned NumOps);
758 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, MVT VT4,
759 const SDValue *Ops, unsigned NumOps);
760 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
761 MVT VT4, const SDValue *Ops, unsigned NumOps);
763 SDNode *getTargetNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
764 const SDValue *Ops, unsigned NumOps);
765 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl,
766 const std::vector<MVT> &ResultTys, const SDValue *Ops,
769 /// getNodeIfExists - Get the specified node if it's already available, or
770 /// else return NULL.
771 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
772 const SDValue *Ops, unsigned NumOps);
774 /// DAGUpdateListener - Clients of various APIs that cause global effects on
775 /// the DAG can optionally implement this interface. This allows the clients
776 /// to handle the various sorts of updates that happen.
777 class DAGUpdateListener {
779 virtual ~DAGUpdateListener();
781 /// NodeDeleted - The node N that was deleted and, if E is not null, an
782 /// equivalent node E that replaced it.
783 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
785 /// NodeUpdated - The node N that was updated.
786 virtual void NodeUpdated(SDNode *N) = 0;
789 /// RemoveDeadNode - Remove the specified node from the system. If any of its
790 /// operands then becomes dead, remove them as well. Inform UpdateListener
791 /// for each node deleted.
792 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
794 /// RemoveDeadNodes - This method deletes the unreachable nodes in the
795 /// given list, and any nodes that become unreachable as a result.
796 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
797 DAGUpdateListener *UpdateListener = 0);
799 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
800 /// This can cause recursive merging of nodes in the DAG. Use the first
801 /// version if 'From' is known to have a single result, use the second
802 /// if you have two nodes with identical results, use the third otherwise.
804 /// These methods all take an optional UpdateListener, which (if not null) is
805 /// informed about nodes that are deleted and modified due to recursive
806 /// changes in the dag.
808 /// These functions only replace all existing uses. It's possible that as
809 /// these replacements are being performed, CSE may cause the From node
810 /// to be given new uses. These new uses of From are left in place, and
811 /// not automatically transfered to To.
813 void ReplaceAllUsesWith(SDValue From, SDValue Op,
814 DAGUpdateListener *UpdateListener = 0);
815 void ReplaceAllUsesWith(SDNode *From, SDNode *To,
816 DAGUpdateListener *UpdateListener = 0);
817 void ReplaceAllUsesWith(SDNode *From, const SDValue *To,
818 DAGUpdateListener *UpdateListener = 0);
820 /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
821 /// uses of other values produced by From.Val alone.
822 void ReplaceAllUsesOfValueWith(SDValue From, SDValue To,
823 DAGUpdateListener *UpdateListener = 0);
825 /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
826 /// for multiple values at once. This correctly handles the case where
827 /// there is an overlap between the From values and the To values.
828 void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
830 DAGUpdateListener *UpdateListener = 0);
832 /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
833 /// assign a unique node id for each node in the DAG based on their
834 /// topological order. Returns the number of nodes.
835 unsigned AssignTopologicalOrder();
837 /// RepositionNode - Move node N in the AllNodes list to be immediately
838 /// before the given iterator Position. This may be used to update the
839 /// topological ordering when the list of nodes is modified.
840 void RepositionNode(allnodes_iterator Position, SDNode *N) {
841 AllNodes.insert(Position, AllNodes.remove(N));
844 /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
846 static bool isCommutativeBinOp(unsigned Opcode) {
847 // FIXME: This should get its info from the td file, so that we can include
862 case ISD::ADDE: return true;
863 default: return false;
869 /// CreateStackTemporary - Create a stack temporary, suitable for holding the
870 /// specified value type. If minAlign is specified, the slot size will have
871 /// at least that alignment.
872 SDValue CreateStackTemporary(MVT VT, unsigned minAlign = 1);
874 /// CreateStackTemporary - Create a stack temporary suitable for holding
875 /// either of the specified value types.
876 SDValue CreateStackTemporary(MVT VT1, MVT VT2);
878 /// FoldConstantArithmetic -
879 SDValue FoldConstantArithmetic(unsigned Opcode,
881 ConstantSDNode *Cst1,
882 ConstantSDNode *Cst2);
884 /// FoldSetCC - Constant fold a setcc to true or false.
885 SDValue FoldSetCC(MVT VT, SDValue N1,
886 SDValue N2, ISD::CondCode Cond);
888 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We
889 /// use this predicate to simplify operations downstream.
890 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
892 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We
893 /// use this predicate to simplify operations downstream. Op and Mask are
894 /// known to be the same type.
895 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
898 /// ComputeMaskedBits - Determine which of the bits specified in Mask are
899 /// known to be either zero or one and return them in the KnownZero/KnownOne
900 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit
901 /// processing. Targets can implement the computeMaskedBitsForTargetNode
902 /// method in the TargetLowering class to allow target nodes to be understood.
903 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
904 APInt &KnownOne, unsigned Depth = 0) const;
906 /// ComputeNumSignBits - Return the number of times the sign bit of the
907 /// register is replicated into the other bits. We know that at least 1 bit
908 /// is always equal to the sign bit (itself), but other cases can give us
909 /// information. For example, immediately after an "SRA X, 2", we know that
910 /// the top 3 bits are all equal to each other, so we return 3. Targets can
911 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
912 /// class to allow target nodes to be understood.
913 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
915 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
916 /// been verified as a debug information descriptor.
917 bool isVerifiedDebugInfoDesc(SDValue Op) const;
919 /// getShuffleScalarElt - Returns the scalar element that will make up the ith
920 /// element of the result of the vector shuffle.
921 SDValue getShuffleScalarElt(const SDNode *N, unsigned Idx);
924 bool RemoveNodeFromCSEMaps(SDNode *N);
925 void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener);
926 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
927 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
929 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
932 void DeleteNodeNotInCSEMaps(SDNode *N);
933 void DeallocateNode(SDNode *N);
935 unsigned getMVTAlignment(MVT MemoryVT) const;
937 void allnodes_clear();
939 /// VTList - List of non-single value types.
940 std::vector<SDVTList> VTList;
942 /// CondCodeNodes - Maps to auto-CSE operations.
943 std::vector<CondCodeSDNode*> CondCodeNodes;
945 std::vector<SDNode*> ValueTypeNodes;
946 std::map<MVT, SDNode*, MVT::compareRawBits> ExtendedValueTypeNodes;
947 StringMap<SDNode*> ExternalSymbols;
948 StringMap<SDNode*> TargetExternalSymbols;
951 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
952 typedef SelectionDAG::allnodes_iterator nodes_iterator;
953 static nodes_iterator nodes_begin(SelectionDAG *G) {
954 return G->allnodes_begin();
956 static nodes_iterator nodes_end(SelectionDAG *G) {
957 return G->allnodes_end();
961 } // end namespace llvm