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 // When generating a branch to a BB, we don't in general know enough
310 // to provide debug info for the BB at that time, so keep this one around.
311 SDValue getBasicBlock(MachineBasicBlock *MBB);
312 SDValue getBasicBlock(MachineBasicBlock *MBB, DebugLoc dl);
313 SDValue getExternalSymbol(const char *Sym, MVT VT);
314 SDValue getExternalSymbol(const char *Sym, DebugLoc dl, MVT VT);
315 SDValue getTargetExternalSymbol(const char *Sym, MVT VT);
316 SDValue getTargetExternalSymbol(const char *Sym, DebugLoc dl, MVT VT);
317 SDValue getArgFlags(ISD::ArgFlagsTy Flags);
318 SDValue getValueType(MVT);
319 SDValue getRegister(unsigned Reg, MVT VT);
320 SDValue getDbgStopPoint(SDValue Root, unsigned Line, unsigned Col,
322 SDValue getLabel(unsigned Opcode, DebugLoc dl, SDValue Root,
325 SDValue getCopyToReg(SDValue Chain, unsigned Reg, SDValue N) {
326 return getNode(ISD::CopyToReg, MVT::Other, Chain,
327 getRegister(Reg, N.getValueType()), N);
329 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N) {
330 return getNode(ISD::CopyToReg, dl, MVT::Other, Chain,
331 getRegister(Reg, N.getValueType()), N);
334 // This version of the getCopyToReg method takes an extra operand, which
335 // indicates that there is potentially an incoming flag value (if Flag is not
336 // null) and that there should be a flag result.
337 SDValue getCopyToReg(SDValue Chain, unsigned Reg, SDValue N,
339 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
340 SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
341 return getNode(ISD::CopyToReg, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
343 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N,
345 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
346 SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
347 return getNode(ISD::CopyToReg, dl, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
350 // Similar to last getCopyToReg() except parameter Reg is a SDValue
351 SDValue getCopyToReg(SDValue Chain, SDValue Reg, SDValue N,
353 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
354 SDValue Ops[] = { Chain, Reg, N, Flag };
355 return getNode(ISD::CopyToReg, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
357 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, SDValue Reg, SDValue N,
359 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
360 SDValue Ops[] = { Chain, Reg, N, Flag };
361 return getNode(ISD::CopyToReg, dl, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
364 SDValue getCopyFromReg(SDValue Chain, unsigned Reg, MVT VT) {
365 const MVT *VTs = getNodeValueTypes(VT, MVT::Other);
366 SDValue Ops[] = { Chain, getRegister(Reg, VT) };
367 return getNode(ISD::CopyFromReg, VTs, 2, Ops, 2);
369 SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, MVT VT) {
370 const MVT *VTs = getNodeValueTypes(VT, MVT::Other);
371 SDValue Ops[] = { Chain, getRegister(Reg, VT) };
372 return getNode(ISD::CopyFromReg, dl, VTs, 2, Ops, 2);
375 // This version of the getCopyFromReg method takes an extra operand, which
376 // indicates that there is potentially an incoming flag value (if Flag is not
377 // null) and that there should be a flag result.
378 SDValue getCopyFromReg(SDValue Chain, unsigned Reg, MVT VT,
380 const MVT *VTs = getNodeValueTypes(VT, MVT::Other, MVT::Flag);
381 SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
382 return getNode(ISD::CopyFromReg, VTs, 3, Ops, Flag.getNode() ? 3 : 2);
384 SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, MVT VT,
386 const MVT *VTs = getNodeValueTypes(VT, MVT::Other, MVT::Flag);
387 SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
388 return getNode(ISD::CopyFromReg, dl, VTs, 3, Ops, Flag.getNode() ? 3 : 2);
391 SDValue getCondCode(ISD::CondCode Cond);
393 /// Returns the ConvertRndSat Note: Avoid using this node because it may
394 /// disappear in the future and most targets don't support it.
395 SDValue getConvertRndSat(MVT VT, DebugLoc dl, SDValue Val, SDValue DTy,
397 SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
399 /// getZeroExtendInReg - Return the expression required to zero extend the Op
400 /// value assuming it was the smaller SrcTy value.
401 SDValue getZeroExtendInReg(SDValue Op, MVT SrcTy);
402 SDValue getZeroExtendInReg(SDValue Op, DebugLoc DL, MVT SrcTy);
404 /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
405 SDValue getNOT(DebugLoc DL, SDValue Val, MVT VT);
407 /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
408 /// a flag result (to ensure it's not CSE'd).
409 SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
410 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
411 SDValue Ops[] = { Chain, Op };
412 return getNode(ISD::CALLSEQ_START, VTs, 2, Ops, 2);
415 /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
416 /// flag result (to ensure it's not CSE'd).
417 SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
419 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
420 SmallVector<SDValue, 4> Ops;
421 Ops.push_back(Chain);
424 Ops.push_back(InFlag);
425 return getNode(ISD::CALLSEQ_END, NodeTys, &Ops[0],
426 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
429 /// getNode - Gets or creates the specified node.
431 SDValue getNode(unsigned Opcode, MVT VT);
432 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT);
433 SDValue getNode(unsigned Opcode, MVT VT, SDValue N);
434 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N);
435 SDValue getNode(unsigned Opcode, MVT VT, SDValue N1, SDValue N2);
436 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N1, SDValue N2);
437 SDValue getNode(unsigned Opcode, MVT VT,
438 SDValue N1, SDValue N2, SDValue N3);
439 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
440 SDValue N1, SDValue N2, SDValue N3);
441 SDValue getNode(unsigned Opcode, MVT VT,
442 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
443 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
444 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
445 SDValue getNode(unsigned Opcode, MVT VT,
446 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
448 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
449 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
451 SDValue getNode(unsigned Opcode, MVT VT,
452 const SDUse *Ops, unsigned NumOps);
453 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
454 const SDUse *Ops, unsigned NumOps);
455 SDValue getNode(unsigned Opcode, MVT VT,
456 const SDValue *Ops, unsigned NumOps);
457 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
458 const SDValue *Ops, unsigned NumOps);
459 SDValue getNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
460 const SDValue *Ops, unsigned NumOps);
461 SDValue getNode(unsigned Opcode, DebugLoc DL,
462 const std::vector<MVT> &ResultTys,
463 const SDValue *Ops, unsigned NumOps);
464 SDValue getNode(unsigned Opcode, const MVT *VTs, unsigned NumVTs,
465 const SDValue *Ops, unsigned NumOps);
466 SDValue getNode(unsigned Opcode, DebugLoc DL, const MVT *VTs, unsigned NumVTs,
467 const SDValue *Ops, unsigned NumOps);
468 SDValue getNode(unsigned Opcode, SDVTList VTs,
469 const SDValue *Ops, unsigned NumOps);
470 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
471 const SDValue *Ops, unsigned NumOps);
473 SDValue getNode(unsigned Opcode, SDVTList VTs);
474 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs);
475 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N);
476 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N);
477 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N1, SDValue N2);
478 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
479 SDValue N1, SDValue N2);
480 SDValue getNode(unsigned Opcode, SDVTList VTs,
481 SDValue N1, SDValue N2, SDValue N3);
482 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
483 SDValue N1, SDValue N2, SDValue N3);
484 SDValue getNode(unsigned Opcode, SDVTList VTs,
485 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
486 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
487 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
488 SDValue getNode(unsigned Opcode, SDVTList VTs,
489 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
491 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
492 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
495 SDValue getMemcpy(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
496 SDValue Size, unsigned Align, bool AlwaysInline,
497 const Value *DstSV, uint64_t DstSVOff,
498 const Value *SrcSV, uint64_t SrcSVOff);
500 SDValue getMemmove(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
501 SDValue Size, unsigned Align,
502 const Value *DstSV, uint64_t DstOSVff,
503 const Value *SrcSV, uint64_t SrcSVOff);
505 SDValue getMemset(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
506 SDValue Size, unsigned Align,
507 const Value *DstSV, uint64_t DstSVOff);
509 /// getSetCC - Helper function to make it easier to build SetCC's if you just
510 /// have an ISD::CondCode instead of an SDValue.
512 SDValue getSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS,
513 ISD::CondCode Cond) {
514 return getNode(ISD::SETCC, DL, VT, LHS, RHS, getCondCode(Cond));
517 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
518 /// if you just have an ISD::CondCode instead of an SDValue.
520 SDValue getVSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS,
521 ISD::CondCode Cond) {
522 return getNode(ISD::VSETCC, DL, VT, LHS, RHS, getCondCode(Cond));
525 /// getSelectCC - Helper function to make it easier to build SelectCC's if you
526 /// just have an ISD::CondCode instead of an SDValue.
528 SDValue getSelectCC(DebugLoc DL, SDValue LHS, SDValue RHS,
529 SDValue True, SDValue False, ISD::CondCode Cond) {
530 return getNode(ISD::SELECT_CC, DL, True.getValueType(),
531 LHS, RHS, True, False, getCondCode(Cond));
534 /// getVAArg - VAArg produces a result and token chain, and takes a pointer
535 /// and a source value as input.
536 SDValue getVAArg(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
539 /// getAtomic - Gets a node for an atomic op, produces result and chain and
541 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
542 SDValue Ptr, SDValue Cmp, SDValue Swp, const Value* PtrVal,
543 unsigned Alignment=0);
545 /// getAtomic - Gets a node for an atomic op, produces result and chain and
546 /// takes 2 operands.
547 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
548 SDValue Ptr, SDValue Val, const Value* PtrVal,
549 unsigned Alignment = 0);
551 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
552 /// result and takes a list of operands.
553 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl,
554 const MVT *VTs, unsigned NumVTs,
555 const SDValue *Ops, unsigned NumOps,
556 MVT MemVT, const Value *srcValue, int SVOff,
557 unsigned Align = 0, bool Vol = false,
558 bool ReadMem = true, bool WriteMem = true);
560 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
561 const SDValue *Ops, unsigned NumOps,
562 MVT MemVT, const Value *srcValue, int SVOff,
563 unsigned Align = 0, bool Vol = false,
564 bool ReadMem = true, bool WriteMem = true);
566 /// getMergeValues - Create a MERGE_VALUES node from the given operands.
567 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps);
568 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps, DebugLoc dl);
570 /// getCall - Create a CALL node from the given information.
572 SDValue getCall(unsigned CallingConv, DebugLoc dl, bool IsVarArgs,
573 bool IsTailCall, bool isInreg, SDVTList VTs,
574 const SDValue *Operands, unsigned NumOperands);
576 /// getLoad - Loads are not normal binary operators: their result type is not
577 /// determined by their operands, and they produce a value AND a token chain.
579 SDValue getLoad(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
580 const Value *SV, int SVOffset, bool isVolatile=false,
581 unsigned Alignment=0);
582 SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, MVT VT,
583 SDValue Chain, SDValue Ptr, const Value *SV,
584 int SVOffset, MVT EVT, bool isVolatile=false,
585 unsigned Alignment=0);
586 SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base,
587 SDValue Offset, ISD::MemIndexedMode AM);
588 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
589 MVT VT, SDValue Chain,
590 SDValue Ptr, SDValue Offset,
591 const Value *SV, int SVOffset, MVT EVT,
592 bool isVolatile=false, unsigned Alignment=0);
594 /// getStore - Helper function to build ISD::STORE nodes.
596 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
597 const Value *SV, int SVOffset, bool isVolatile=false,
598 unsigned Alignment=0);
599 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
600 const Value *SV, int SVOffset, MVT TVT,
601 bool isVolatile=false, unsigned Alignment=0);
602 SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base,
603 SDValue Offset, ISD::MemIndexedMode AM);
605 /// getSrcValue - Construct a node to track a Value* through the backend.
606 SDValue getSrcValue(const Value *v);
608 /// getMemOperand - Construct a node to track a memory reference
609 /// through the backend.
610 SDValue getMemOperand(const MachineMemOperand &MO);
612 /// getShiftAmountOperand - Return the specified value casted to
613 /// the target's desired shift amount type.
614 SDValue getShiftAmountOperand(SDValue Op);
616 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
617 /// specified operands. If the resultant node already exists in the DAG,
618 /// this does not modify the specified node, instead it returns the node that
619 /// already exists. If the resultant node does not exist in the DAG, the
620 /// input node is returned. As a degenerate case, if you specify the same
621 /// input operands as the node already has, the input node is returned.
622 SDValue UpdateNodeOperands(SDValue N, SDValue Op);
623 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
624 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
626 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
627 SDValue Op3, SDValue Op4);
628 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
629 SDValue Op3, SDValue Op4, SDValue Op5);
630 SDValue UpdateNodeOperands(SDValue N,
631 const SDValue *Ops, unsigned NumOps);
633 /// SelectNodeTo - These are used for target selectors to *mutate* the
634 /// specified node to have the specified return type, Target opcode, and
635 /// operands. Note that target opcodes are stored as
636 /// ~TargetOpcode in the node opcode field. The resultant node is returned.
637 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT);
638 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, SDValue Op1);
639 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
640 SDValue Op1, SDValue Op2);
641 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
642 SDValue Op1, SDValue Op2, SDValue Op3);
643 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
644 const SDValue *Ops, unsigned NumOps);
645 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, MVT VT2);
646 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
647 MVT VT2, const SDValue *Ops, unsigned NumOps);
648 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
649 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
650 SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, MVT VT1,
651 MVT VT2, MVT VT3, MVT VT4, const SDValue *Ops,
653 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
654 MVT VT2, SDValue Op1);
655 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
656 MVT VT2, SDValue Op1, SDValue Op2);
657 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
658 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
659 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
660 MVT VT2, MVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
661 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
662 const SDValue *Ops, unsigned NumOps);
664 /// MorphNodeTo - These *mutate* the specified node to have the specified
665 /// return type, opcode, and operands.
666 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT);
667 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, SDValue Op1);
668 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
669 SDValue Op1, SDValue Op2);
670 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
671 SDValue Op1, SDValue Op2, SDValue Op3);
672 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
673 const SDValue *Ops, unsigned NumOps);
674 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, MVT VT2);
675 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
676 MVT VT2, const SDValue *Ops, unsigned NumOps);
677 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
678 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
679 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
680 MVT VT2, SDValue Op1);
681 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
682 MVT VT2, SDValue Op1, SDValue Op2);
683 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
684 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
685 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
686 const SDValue *Ops, unsigned NumOps);
688 /// getTargetNode - These are used for target selectors to create a new node
689 /// with specified return type(s), target opcode, and operands.
691 /// Note that getTargetNode returns the resultant node. If there is already a
692 /// node of the specified opcode and operands, it returns that node instead of
694 SDNode *getTargetNode(unsigned Opcode, MVT VT);
695 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT);
697 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1);
698 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1);
700 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1, SDValue Op2);
701 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1,
704 SDNode *getTargetNode(unsigned Opcode, MVT VT,
705 SDValue Op1, SDValue Op2, SDValue Op3);
706 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
707 SDValue Op1, SDValue Op2, SDValue Op3);
709 SDNode *getTargetNode(unsigned Opcode, MVT VT,
710 const SDValue *Ops, unsigned NumOps);
711 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
712 const SDValue *Ops, unsigned NumOps);
714 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2);
715 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2);
717 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, SDValue Op1);
718 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
721 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
722 MVT VT2, SDValue Op1, SDValue Op2);
723 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
724 MVT VT2, SDValue Op1, SDValue Op2);
726 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
727 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
728 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
729 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
731 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2,
732 const SDValue *Ops, unsigned NumOps);
733 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
734 const SDValue *Ops, unsigned NumOps);
736 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
737 SDValue Op1, SDValue Op2);
738 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
739 SDValue Op1, SDValue Op2);
741 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
742 SDValue Op1, SDValue Op2, SDValue Op3);
743 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
744 SDValue Op1, SDValue Op2, SDValue Op3);
746 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
747 const SDValue *Ops, unsigned NumOps);
748 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
749 const SDValue *Ops, unsigned NumOps);
751 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, MVT VT4,
752 const SDValue *Ops, unsigned NumOps);
753 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
754 MVT VT4, const SDValue *Ops, unsigned NumOps);
756 SDNode *getTargetNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
757 const SDValue *Ops, unsigned NumOps);
758 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl,
759 const std::vector<MVT> &ResultTys, const SDValue *Ops,
762 /// getNodeIfExists - Get the specified node if it's already available, or
763 /// else return NULL.
764 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
765 const SDValue *Ops, unsigned NumOps);
767 /// DAGUpdateListener - Clients of various APIs that cause global effects on
768 /// the DAG can optionally implement this interface. This allows the clients
769 /// to handle the various sorts of updates that happen.
770 class DAGUpdateListener {
772 virtual ~DAGUpdateListener();
774 /// NodeDeleted - The node N that was deleted and, if E is not null, an
775 /// equivalent node E that replaced it.
776 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
778 /// NodeUpdated - The node N that was updated.
779 virtual void NodeUpdated(SDNode *N) = 0;
782 /// RemoveDeadNode - Remove the specified node from the system. If any of its
783 /// operands then becomes dead, remove them as well. Inform UpdateListener
784 /// for each node deleted.
785 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
787 /// RemoveDeadNodes - This method deletes the unreachable nodes in the
788 /// given list, and any nodes that become unreachable as a result.
789 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
790 DAGUpdateListener *UpdateListener = 0);
792 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
793 /// This can cause recursive merging of nodes in the DAG. Use the first
794 /// version if 'From' is known to have a single result, use the second
795 /// if you have two nodes with identical results, use the third otherwise.
797 /// These methods all take an optional UpdateListener, which (if not null) is
798 /// informed about nodes that are deleted and modified due to recursive
799 /// changes in the dag.
801 /// These functions only replace all existing uses. It's possible that as
802 /// these replacements are being performed, CSE may cause the From node
803 /// to be given new uses. These new uses of From are left in place, and
804 /// not automatically transfered to To.
806 void ReplaceAllUsesWith(SDValue From, SDValue Op,
807 DAGUpdateListener *UpdateListener = 0);
808 void ReplaceAllUsesWith(SDNode *From, SDNode *To,
809 DAGUpdateListener *UpdateListener = 0);
810 void ReplaceAllUsesWith(SDNode *From, const SDValue *To,
811 DAGUpdateListener *UpdateListener = 0);
813 /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
814 /// uses of other values produced by From.Val alone.
815 void ReplaceAllUsesOfValueWith(SDValue From, SDValue To,
816 DAGUpdateListener *UpdateListener = 0);
818 /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
819 /// for multiple values at once. This correctly handles the case where
820 /// there is an overlap between the From values and the To values.
821 void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
823 DAGUpdateListener *UpdateListener = 0);
825 /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
826 /// assign a unique node id for each node in the DAG based on their
827 /// topological order. Returns the number of nodes.
828 unsigned AssignTopologicalOrder();
830 /// RepositionNode - Move node N in the AllNodes list to be immediately
831 /// before the given iterator Position. This may be used to update the
832 /// topological ordering when the list of nodes is modified.
833 void RepositionNode(allnodes_iterator Position, SDNode *N) {
834 AllNodes.insert(Position, AllNodes.remove(N));
837 /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
839 static bool isCommutativeBinOp(unsigned Opcode) {
840 // FIXME: This should get its info from the td file, so that we can include
855 case ISD::ADDE: return true;
856 default: return false;
862 /// CreateStackTemporary - Create a stack temporary, suitable for holding the
863 /// specified value type. If minAlign is specified, the slot size will have
864 /// at least that alignment.
865 SDValue CreateStackTemporary(MVT VT, unsigned minAlign = 1);
867 /// CreateStackTemporary - Create a stack temporary suitable for holding
868 /// either of the specified value types.
869 SDValue CreateStackTemporary(MVT VT1, MVT VT2);
871 /// FoldConstantArithmetic -
872 SDValue FoldConstantArithmetic(unsigned Opcode,
874 ConstantSDNode *Cst1,
875 ConstantSDNode *Cst2);
877 /// FoldSetCC - Constant fold a setcc to true or false.
878 SDValue FoldSetCC(MVT VT, SDValue N1,
879 SDValue N2, ISD::CondCode Cond, DebugLoc dl);
881 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We
882 /// use this predicate to simplify operations downstream.
883 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
885 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We
886 /// use this predicate to simplify operations downstream. Op and Mask are
887 /// known to be the same type.
888 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
891 /// ComputeMaskedBits - Determine which of the bits specified in Mask are
892 /// known to be either zero or one and return them in the KnownZero/KnownOne
893 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit
894 /// processing. Targets can implement the computeMaskedBitsForTargetNode
895 /// method in the TargetLowering class to allow target nodes to be understood.
896 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
897 APInt &KnownOne, unsigned Depth = 0) const;
899 /// ComputeNumSignBits - Return the number of times the sign bit of the
900 /// register is replicated into the other bits. We know that at least 1 bit
901 /// is always equal to the sign bit (itself), but other cases can give us
902 /// information. For example, immediately after an "SRA X, 2", we know that
903 /// the top 3 bits are all equal to each other, so we return 3. Targets can
904 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
905 /// class to allow target nodes to be understood.
906 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
908 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
909 /// been verified as a debug information descriptor.
910 bool isVerifiedDebugInfoDesc(SDValue Op) const;
912 /// getShuffleScalarElt - Returns the scalar element that will make up the ith
913 /// element of the result of the vector shuffle.
914 SDValue getShuffleScalarElt(const SDNode *N, unsigned Idx);
917 bool RemoveNodeFromCSEMaps(SDNode *N);
918 void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener);
919 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
920 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
922 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
925 void DeleteNodeNotInCSEMaps(SDNode *N);
926 void DeallocateNode(SDNode *N);
928 unsigned getMVTAlignment(MVT MemoryVT) const;
930 void allnodes_clear();
932 /// VTList - List of non-single value types.
933 std::vector<SDVTList> VTList;
935 /// CondCodeNodes - Maps to auto-CSE operations.
936 std::vector<CondCodeSDNode*> CondCodeNodes;
938 std::vector<SDNode*> ValueTypeNodes;
939 std::map<MVT, SDNode*, MVT::compareRawBits> ExtendedValueTypeNodes;
940 StringMap<SDNode*> ExternalSymbols;
941 StringMap<SDNode*> TargetExternalSymbols;
944 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
945 typedef SelectionDAG::allnodes_iterator nodes_iterator;
946 static nodes_iterator nodes_begin(SelectionDAG *G) {
947 return G->allnodes_begin();
949 static nodes_iterator nodes_end(SelectionDAG *G) {
950 return G->allnodes_end();
954 } // end namespace llvm