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, DebugLoc dl, unsigned Reg, SDValue N) {
326 return getNode(ISD::CopyToReg, dl, MVT::Other, Chain,
327 getRegister(Reg, N.getValueType()), N);
330 // This version of the getCopyToReg method takes an extra operand, which
331 // indicates that there is potentially an incoming flag value (if Flag is not
332 // null) and that there should be a flag result.
333 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N,
335 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
336 SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
337 return getNode(ISD::CopyToReg, dl, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
340 // Similar to last getCopyToReg() except parameter Reg is a SDValue
341 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, SDValue Reg, SDValue N,
343 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
344 SDValue Ops[] = { Chain, Reg, N, Flag };
345 return getNode(ISD::CopyToReg, dl, VTs, 2, Ops, Flag.getNode() ? 4 : 3);
348 SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, MVT VT) {
349 const MVT *VTs = getNodeValueTypes(VT, MVT::Other);
350 SDValue Ops[] = { Chain, getRegister(Reg, VT) };
351 return getNode(ISD::CopyFromReg, dl, VTs, 2, Ops, 2);
354 // This version of the getCopyFromReg method takes an extra operand, which
355 // indicates that there is potentially an incoming flag value (if Flag is not
356 // null) and that there should be a flag result.
357 SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, MVT VT,
359 const MVT *VTs = getNodeValueTypes(VT, MVT::Other, MVT::Flag);
360 SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
361 return getNode(ISD::CopyFromReg, dl, VTs, 3, Ops, Flag.getNode() ? 3 : 2);
364 SDValue getCondCode(ISD::CondCode Cond);
366 /// Returns the ConvertRndSat Note: Avoid using this node because it may
367 /// disappear in the future and most targets don't support it.
368 SDValue getConvertRndSat(MVT VT, DebugLoc dl, SDValue Val, SDValue DTy,
370 SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
372 /// getZeroExtendInReg - Return the expression required to zero extend the Op
373 /// value assuming it was the smaller SrcTy value.
374 SDValue getZeroExtendInReg(SDValue Op, MVT SrcTy);
375 SDValue getZeroExtendInReg(SDValue Op, DebugLoc DL, MVT SrcTy);
377 /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
378 SDValue getNOT(DebugLoc DL, SDValue Val, MVT VT);
380 /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
381 /// a flag result (to ensure it's not CSE'd).
382 SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
383 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
384 SDValue Ops[] = { Chain, Op };
385 return getNode(ISD::CALLSEQ_START, VTs, 2, Ops, 2);
388 /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
389 /// flag result (to ensure it's not CSE'd).
390 SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
392 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
393 SmallVector<SDValue, 4> Ops;
394 Ops.push_back(Chain);
397 Ops.push_back(InFlag);
398 return getNode(ISD::CALLSEQ_END, NodeTys, &Ops[0],
399 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
402 /// getNode - Gets or creates the specified node.
404 SDValue getNode(unsigned Opcode, MVT VT);
405 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT);
406 SDValue getNode(unsigned Opcode, MVT VT, SDValue N);
407 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N);
408 SDValue getNode(unsigned Opcode, MVT VT, SDValue N1, SDValue N2);
409 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N1, SDValue N2);
410 SDValue getNode(unsigned Opcode, MVT VT,
411 SDValue N1, SDValue N2, SDValue N3);
412 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
413 SDValue N1, SDValue N2, SDValue N3);
414 SDValue getNode(unsigned Opcode, MVT VT,
415 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
416 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
417 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
418 SDValue getNode(unsigned Opcode, MVT VT,
419 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
421 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
422 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
424 SDValue getNode(unsigned Opcode, MVT VT,
425 const SDUse *Ops, unsigned NumOps);
426 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
427 const SDUse *Ops, unsigned NumOps);
428 SDValue getNode(unsigned Opcode, MVT VT,
429 const SDValue *Ops, unsigned NumOps);
430 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
431 const SDValue *Ops, unsigned NumOps);
432 SDValue getNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
433 const SDValue *Ops, unsigned NumOps);
434 SDValue getNode(unsigned Opcode, DebugLoc DL,
435 const std::vector<MVT> &ResultTys,
436 const SDValue *Ops, unsigned NumOps);
437 SDValue getNode(unsigned Opcode, const MVT *VTs, unsigned NumVTs,
438 const SDValue *Ops, unsigned NumOps);
439 SDValue getNode(unsigned Opcode, DebugLoc DL, const MVT *VTs, unsigned NumVTs,
440 const SDValue *Ops, unsigned NumOps);
441 SDValue getNode(unsigned Opcode, SDVTList VTs,
442 const SDValue *Ops, unsigned NumOps);
443 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
444 const SDValue *Ops, unsigned NumOps);
446 SDValue getNode(unsigned Opcode, SDVTList VTs);
447 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs);
448 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N);
449 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N);
450 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N1, SDValue N2);
451 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
452 SDValue N1, SDValue N2);
453 SDValue getNode(unsigned Opcode, SDVTList VTs,
454 SDValue N1, SDValue N2, SDValue N3);
455 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
456 SDValue N1, SDValue N2, SDValue N3);
457 SDValue getNode(unsigned Opcode, SDVTList VTs,
458 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
459 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
460 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
461 SDValue getNode(unsigned Opcode, SDVTList VTs,
462 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
464 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
465 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
468 SDValue getMemcpy(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
469 SDValue Size, unsigned Align, bool AlwaysInline,
470 const Value *DstSV, uint64_t DstSVOff,
471 const Value *SrcSV, uint64_t SrcSVOff);
473 SDValue getMemmove(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
474 SDValue Size, unsigned Align,
475 const Value *DstSV, uint64_t DstOSVff,
476 const Value *SrcSV, uint64_t SrcSVOff);
478 SDValue getMemset(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
479 SDValue Size, unsigned Align,
480 const Value *DstSV, uint64_t DstSVOff);
482 /// getSetCC - Helper function to make it easier to build SetCC's if you just
483 /// have an ISD::CondCode instead of an SDValue.
485 SDValue getSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS,
486 ISD::CondCode Cond) {
487 return getNode(ISD::SETCC, DL, VT, LHS, RHS, getCondCode(Cond));
490 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
491 /// if you just have an ISD::CondCode instead of an SDValue.
493 SDValue getVSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS,
494 ISD::CondCode Cond) {
495 return getNode(ISD::VSETCC, DL, VT, LHS, RHS, getCondCode(Cond));
498 /// getSelectCC - Helper function to make it easier to build SelectCC's if you
499 /// just have an ISD::CondCode instead of an SDValue.
501 SDValue getSelectCC(DebugLoc DL, SDValue LHS, SDValue RHS,
502 SDValue True, SDValue False, ISD::CondCode Cond) {
503 return getNode(ISD::SELECT_CC, DL, True.getValueType(),
504 LHS, RHS, True, False, getCondCode(Cond));
507 /// getVAArg - VAArg produces a result and token chain, and takes a pointer
508 /// and a source value as input.
509 SDValue getVAArg(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
512 /// getAtomic - Gets a node for an atomic op, produces result and chain and
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, DebugLoc dl, MVT MemVT, SDValue Chain,
521 SDValue Ptr, SDValue Val, const Value* PtrVal,
522 unsigned Alignment = 0);
524 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
525 /// result and takes a list of operands.
526 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl,
527 const MVT *VTs, unsigned NumVTs,
528 const SDValue *Ops, unsigned NumOps,
529 MVT MemVT, const Value *srcValue, int SVOff,
530 unsigned Align = 0, bool Vol = false,
531 bool ReadMem = true, bool WriteMem = true);
533 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
534 const SDValue *Ops, unsigned NumOps,
535 MVT MemVT, const Value *srcValue, int SVOff,
536 unsigned Align = 0, bool Vol = false,
537 bool ReadMem = true, bool WriteMem = true);
539 /// getMergeValues - Create a MERGE_VALUES node from the given operands.
540 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps);
541 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps, DebugLoc dl);
543 /// getCall - Create a CALL node from the given information.
545 SDValue getCall(unsigned CallingConv, DebugLoc dl, bool IsVarArgs,
546 bool IsTailCall, bool isInreg, SDVTList VTs,
547 const SDValue *Operands, unsigned NumOperands);
549 /// getLoad - Loads are not normal binary operators: their result type is not
550 /// determined by their operands, and they produce a value AND a token chain.
552 SDValue getLoad(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
553 const Value *SV, int SVOffset, bool isVolatile=false,
554 unsigned Alignment=0);
555 SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, MVT VT,
556 SDValue Chain, SDValue Ptr, const Value *SV,
557 int SVOffset, MVT EVT, bool isVolatile=false,
558 unsigned Alignment=0);
559 SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base,
560 SDValue Offset, ISD::MemIndexedMode AM);
561 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
562 MVT VT, SDValue Chain,
563 SDValue Ptr, SDValue Offset,
564 const Value *SV, int SVOffset, MVT EVT,
565 bool isVolatile=false, unsigned Alignment=0);
567 /// getStore - Helper function to build ISD::STORE nodes.
569 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
570 const Value *SV, int SVOffset, bool isVolatile=false,
571 unsigned Alignment=0);
572 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
573 const Value *SV, int SVOffset, MVT TVT,
574 bool isVolatile=false, unsigned Alignment=0);
575 SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base,
576 SDValue Offset, ISD::MemIndexedMode AM);
578 /// getSrcValue - Construct a node to track a Value* through the backend.
579 SDValue getSrcValue(const Value *v);
581 /// getMemOperand - Construct a node to track a memory reference
582 /// through the backend.
583 SDValue getMemOperand(const MachineMemOperand &MO);
585 /// getShiftAmountOperand - Return the specified value casted to
586 /// the target's desired shift amount type.
587 SDValue getShiftAmountOperand(SDValue Op);
589 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
590 /// specified operands. If the resultant node already exists in the DAG,
591 /// this does not modify the specified node, instead it returns the node that
592 /// already exists. If the resultant node does not exist in the DAG, the
593 /// input node is returned. As a degenerate case, if you specify the same
594 /// input operands as the node already has, the input node is returned.
595 SDValue UpdateNodeOperands(SDValue N, SDValue Op);
596 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
597 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
599 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
600 SDValue Op3, SDValue Op4);
601 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
602 SDValue Op3, SDValue Op4, SDValue Op5);
603 SDValue UpdateNodeOperands(SDValue N,
604 const SDValue *Ops, unsigned NumOps);
606 /// SelectNodeTo - These are used for target selectors to *mutate* the
607 /// specified node to have the specified return type, Target opcode, and
608 /// operands. Note that target opcodes are stored as
609 /// ~TargetOpcode in the node opcode field. The resultant node is returned.
610 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT);
611 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, SDValue Op1);
612 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
613 SDValue Op1, SDValue Op2);
614 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
615 SDValue Op1, SDValue Op2, SDValue Op3);
616 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
617 const SDValue *Ops, unsigned NumOps);
618 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, MVT VT2);
619 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
620 MVT VT2, const SDValue *Ops, unsigned NumOps);
621 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
622 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
623 SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, MVT VT1,
624 MVT VT2, MVT VT3, MVT VT4, const SDValue *Ops,
626 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
627 MVT VT2, SDValue Op1);
628 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
629 MVT VT2, SDValue Op1, SDValue Op2);
630 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
631 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
632 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
633 MVT VT2, MVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
634 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
635 const SDValue *Ops, unsigned NumOps);
637 /// MorphNodeTo - These *mutate* the specified node to have the specified
638 /// return type, opcode, and operands.
639 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT);
640 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, SDValue Op1);
641 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
642 SDValue Op1, SDValue Op2);
643 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
644 SDValue Op1, SDValue Op2, SDValue Op3);
645 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
646 const SDValue *Ops, unsigned NumOps);
647 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, MVT VT2);
648 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
649 MVT VT2, const SDValue *Ops, unsigned NumOps);
650 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
651 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
652 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
653 MVT VT2, SDValue Op1);
654 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
655 MVT VT2, SDValue Op1, SDValue Op2);
656 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
657 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
658 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
659 const SDValue *Ops, unsigned NumOps);
661 /// getTargetNode - These are used for target selectors to create a new node
662 /// with specified return type(s), target opcode, and operands.
664 /// Note that getTargetNode returns the resultant node. If there is already a
665 /// node of the specified opcode and operands, it returns that node instead of
667 SDNode *getTargetNode(unsigned Opcode, MVT VT);
668 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT);
670 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1);
671 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1);
673 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1, SDValue Op2);
674 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1,
677 SDNode *getTargetNode(unsigned Opcode, MVT VT,
678 SDValue Op1, SDValue Op2, SDValue Op3);
679 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
680 SDValue Op1, SDValue Op2, SDValue Op3);
682 SDNode *getTargetNode(unsigned Opcode, MVT VT,
683 const SDValue *Ops, unsigned NumOps);
684 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
685 const SDValue *Ops, unsigned NumOps);
687 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2);
688 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2);
690 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, SDValue Op1);
691 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
694 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
695 MVT VT2, SDValue Op1, SDValue Op2);
696 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
697 MVT VT2, SDValue Op1, SDValue Op2);
699 SDNode *getTargetNode(unsigned Opcode, MVT VT1,
700 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
701 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
702 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
704 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2,
705 const SDValue *Ops, unsigned NumOps);
706 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
707 const SDValue *Ops, unsigned NumOps);
709 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
710 SDValue Op1, SDValue Op2);
711 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
712 SDValue Op1, SDValue Op2);
714 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
715 SDValue Op1, SDValue Op2, SDValue Op3);
716 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
717 SDValue Op1, SDValue Op2, SDValue Op3);
719 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3,
720 const SDValue *Ops, unsigned NumOps);
721 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
722 const SDValue *Ops, unsigned NumOps);
724 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, MVT VT4,
725 const SDValue *Ops, unsigned NumOps);
726 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
727 MVT VT4, const SDValue *Ops, unsigned NumOps);
729 SDNode *getTargetNode(unsigned Opcode, const std::vector<MVT> &ResultTys,
730 const SDValue *Ops, unsigned NumOps);
731 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl,
732 const std::vector<MVT> &ResultTys, const SDValue *Ops,
735 /// getNodeIfExists - Get the specified node if it's already available, or
736 /// else return NULL.
737 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
738 const SDValue *Ops, unsigned NumOps);
740 /// DAGUpdateListener - Clients of various APIs that cause global effects on
741 /// the DAG can optionally implement this interface. This allows the clients
742 /// to handle the various sorts of updates that happen.
743 class DAGUpdateListener {
745 virtual ~DAGUpdateListener();
747 /// NodeDeleted - The node N that was deleted and, if E is not null, an
748 /// equivalent node E that replaced it.
749 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
751 /// NodeUpdated - The node N that was updated.
752 virtual void NodeUpdated(SDNode *N) = 0;
755 /// RemoveDeadNode - Remove the specified node from the system. If any of its
756 /// operands then becomes dead, remove them as well. Inform UpdateListener
757 /// for each node deleted.
758 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
760 /// RemoveDeadNodes - This method deletes the unreachable nodes in the
761 /// given list, and any nodes that become unreachable as a result.
762 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
763 DAGUpdateListener *UpdateListener = 0);
765 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
766 /// This can cause recursive merging of nodes in the DAG. Use the first
767 /// version if 'From' is known to have a single result, use the second
768 /// if you have two nodes with identical results, use the third otherwise.
770 /// These methods all take an optional UpdateListener, which (if not null) is
771 /// informed about nodes that are deleted and modified due to recursive
772 /// changes in the dag.
774 /// These functions only replace all existing uses. It's possible that as
775 /// these replacements are being performed, CSE may cause the From node
776 /// to be given new uses. These new uses of From are left in place, and
777 /// not automatically transfered to To.
779 void ReplaceAllUsesWith(SDValue From, SDValue Op,
780 DAGUpdateListener *UpdateListener = 0);
781 void ReplaceAllUsesWith(SDNode *From, SDNode *To,
782 DAGUpdateListener *UpdateListener = 0);
783 void ReplaceAllUsesWith(SDNode *From, const SDValue *To,
784 DAGUpdateListener *UpdateListener = 0);
786 /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
787 /// uses of other values produced by From.Val alone.
788 void ReplaceAllUsesOfValueWith(SDValue From, SDValue To,
789 DAGUpdateListener *UpdateListener = 0);
791 /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
792 /// for multiple values at once. This correctly handles the case where
793 /// there is an overlap between the From values and the To values.
794 void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
796 DAGUpdateListener *UpdateListener = 0);
798 /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
799 /// assign a unique node id for each node in the DAG based on their
800 /// topological order. Returns the number of nodes.
801 unsigned AssignTopologicalOrder();
803 /// RepositionNode - Move node N in the AllNodes list to be immediately
804 /// before the given iterator Position. This may be used to update the
805 /// topological ordering when the list of nodes is modified.
806 void RepositionNode(allnodes_iterator Position, SDNode *N) {
807 AllNodes.insert(Position, AllNodes.remove(N));
810 /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
812 static bool isCommutativeBinOp(unsigned Opcode) {
813 // FIXME: This should get its info from the td file, so that we can include
828 case ISD::ADDE: return true;
829 default: return false;
835 /// CreateStackTemporary - Create a stack temporary, suitable for holding the
836 /// specified value type. If minAlign is specified, the slot size will have
837 /// at least that alignment.
838 SDValue CreateStackTemporary(MVT VT, unsigned minAlign = 1);
840 /// CreateStackTemporary - Create a stack temporary suitable for holding
841 /// either of the specified value types.
842 SDValue CreateStackTemporary(MVT VT1, MVT VT2);
844 /// FoldConstantArithmetic -
845 SDValue FoldConstantArithmetic(unsigned Opcode,
847 ConstantSDNode *Cst1,
848 ConstantSDNode *Cst2);
850 /// FoldSetCC - Constant fold a setcc to true or false.
851 SDValue FoldSetCC(MVT VT, SDValue N1,
852 SDValue N2, ISD::CondCode Cond, DebugLoc dl);
854 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We
855 /// use this predicate to simplify operations downstream.
856 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
858 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We
859 /// use this predicate to simplify operations downstream. Op and Mask are
860 /// known to be the same type.
861 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
864 /// ComputeMaskedBits - Determine which of the bits specified in Mask are
865 /// known to be either zero or one and return them in the KnownZero/KnownOne
866 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit
867 /// processing. Targets can implement the computeMaskedBitsForTargetNode
868 /// method in the TargetLowering class to allow target nodes to be understood.
869 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
870 APInt &KnownOne, unsigned Depth = 0) const;
872 /// ComputeNumSignBits - Return the number of times the sign bit of the
873 /// register is replicated into the other bits. We know that at least 1 bit
874 /// is always equal to the sign bit (itself), but other cases can give us
875 /// information. For example, immediately after an "SRA X, 2", we know that
876 /// the top 3 bits are all equal to each other, so we return 3. Targets can
877 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
878 /// class to allow target nodes to be understood.
879 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
881 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
882 /// been verified as a debug information descriptor.
883 bool isVerifiedDebugInfoDesc(SDValue Op) const;
885 /// getShuffleScalarElt - Returns the scalar element that will make up the ith
886 /// element of the result of the vector shuffle.
887 SDValue getShuffleScalarElt(const SDNode *N, unsigned Idx);
890 bool RemoveNodeFromCSEMaps(SDNode *N);
891 void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener);
892 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
893 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
895 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
898 void DeleteNodeNotInCSEMaps(SDNode *N);
899 void DeallocateNode(SDNode *N);
901 unsigned getMVTAlignment(MVT MemoryVT) const;
903 void allnodes_clear();
905 /// VTList - List of non-single value types.
906 std::vector<SDVTList> VTList;
908 /// CondCodeNodes - Maps to auto-CSE operations.
909 std::vector<CondCodeSDNode*> CondCodeNodes;
911 std::vector<SDNode*> ValueTypeNodes;
912 std::map<MVT, SDNode*, MVT::compareRawBits> ExtendedValueTypeNodes;
913 StringMap<SDNode*> ExternalSymbols;
914 StringMap<SDNode*> TargetExternalSymbols;
917 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
918 typedef SelectionDAG::allnodes_iterator nodes_iterator;
919 static nodes_iterator nodes_begin(SelectionDAG *G) {
920 return G->allnodes_begin();
922 static nodes_iterator nodes_end(SelectionDAG *G) {
923 return G->allnodes_end();
927 } // end namespace llvm