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/StringMap.h"
21 #include "llvm/CodeGen/SelectionDAGNodes.h"
22 #include "llvm/Support/RecyclingAllocator.h"
23 #include "llvm/Target/TargetMachine.h"
33 class FunctionLoweringInfo;
34 class MachineConstantPoolValue;
35 class MachineFunction;
36 class MachineModuleInfo;
41 template<> struct ilist_traits<SDNode> : public ilist_default_traits<SDNode> {
43 mutable ilist_half_node<SDNode> Sentinel;
45 SDNode *createSentinel() const {
46 return static_cast<SDNode*>(&Sentinel);
48 static void destroySentinel(SDNode *) {}
50 SDNode *provideInitialHead() const { return createSentinel(); }
51 SDNode *ensureHead(SDNode*) const { return createSentinel(); }
52 static void noteHead(SDNode*, SDNode*) {}
54 static void deleteNode(SDNode *) {
55 assert(0 && "ilist_traits<SDNode> shouldn't see a deleteNode call!");
58 static void createNode(const SDNode &);
61 /// SDDbgInfo - Keeps track of dbg_value information through SDISel. We do
62 /// not build SDNodes for these so as not to perturb the generated code;
63 /// instead the info is kept off to the side in this structure. SDNodes may
64 /// have an associated dbg_value entry in DbgValMap. Debug info that is not
65 /// associated with any SDNode is held in DbgConstMap. It is possible for
66 /// optimizations to change a variable to a constant, in which case the
67 /// corresponding debug info is moved from the variable to the constant table
70 DenseMap<const SDNode*, SDDbgValue*> DbgVblMap;
71 SmallVector<SDDbgValue*, 4> DbgConstMap;
73 void operator=(const SDDbgInfo&); // Do not implement.
74 SDDbgInfo(const SDDbgInfo&); // Do not implement.
78 void add(const SDNode *Node, SDDbgValue *V) {
81 void add(SDDbgValue *V) { DbgConstMap.push_back(V); }
82 void remove(const SDNode *Node) {
83 DenseMap<const SDNode*, SDDbgValue*>::iterator Itr =
85 if (Itr != DbgVblMap.end())
88 // No need to remove a constant.
93 SDDbgValue *getSDDbgValue(const SDNode *Node) {
94 return DbgVblMap[Node];
96 typedef SmallVector<SDDbgValue*, 4>::iterator ConstDbgIterator;
97 ConstDbgIterator DbgConstBegin() { return DbgConstMap.begin(); }
98 ConstDbgIterator DbgConstEnd() { return DbgConstMap.end(); }
102 Unrestricted, // Combine may create illegal operations and illegal types.
103 NoIllegalTypes, // Combine may create illegal operations but no illegal types.
104 NoIllegalOperations // Combine may only create legal operations and types.
108 void checkForCycles(const SDNode *N);
109 void checkForCycles(const SelectionDAG *DAG);
111 /// SelectionDAG class - This is used to represent a portion of an LLVM function
112 /// in a low-level Data Dependence DAG representation suitable for instruction
113 /// selection. This DAG is constructed as the first step of instruction
114 /// selection in order to allow implementation of machine specific optimizations
115 /// and code simplifications.
117 /// The representation used by the SelectionDAG is a target-independent
118 /// representation, which has some similarities to the GCC RTL representation,
119 /// but is significantly more simple, powerful, and is a graph form instead of a
125 FunctionLoweringInfo &FLI;
126 MachineModuleInfo *MMI;
128 LLVMContext* Context;
130 /// EntryNode - The starting token.
133 /// Root - The root of the entire DAG.
136 /// AllNodes - A linked list of nodes in the current DAG.
137 ilist<SDNode> AllNodes;
139 /// NodeAllocatorType - The AllocatorType for allocating SDNodes. We use
140 /// pool allocation with recycling.
141 typedef RecyclingAllocator<BumpPtrAllocator, SDNode, sizeof(LargestSDNode),
142 AlignOf<MostAlignedSDNode>::Alignment>
145 /// NodeAllocator - Pool allocation for nodes.
146 NodeAllocatorType NodeAllocator;
148 /// CSEMap - This structure is used to memoize nodes, automatically performing
149 /// CSE with existing nodes when a duplicate is requested.
150 FoldingSet<SDNode> CSEMap;
152 /// OperandAllocator - Pool allocation for machine-opcode SDNode operands.
153 BumpPtrAllocator OperandAllocator;
155 /// Allocator - Pool allocation for misc. objects that are created once per
157 BumpPtrAllocator Allocator;
159 /// SDNodeOrdering - The ordering of the SDNodes. It roughly corresponds to
160 /// the ordering of the original LLVM instructions.
161 SDNodeOrdering *Ordering;
163 /// DbgInfo - Tracks dbg_value information through SDISel.
166 /// VerifyNode - Sanity check the given node. Aborts if it is invalid.
167 void VerifyNode(SDNode *N);
169 /// setGraphColorHelper - Implementation of setSubgraphColor.
170 /// Return whether we had to truncate the search.
172 bool setSubgraphColorHelper(SDNode *N, const char *Color,
173 DenseSet<SDNode *> &visited,
174 int level, bool &printed);
176 void operator=(const SelectionDAG&); // Do not implement.
177 SelectionDAG(const SelectionDAG&); // Do not implement.
180 SelectionDAG(TargetLowering &tli, FunctionLoweringInfo &fli);
183 /// init - Prepare this SelectionDAG to process code in the given
186 void init(MachineFunction &mf, MachineModuleInfo *mmi, DwarfWriter *dw);
188 /// clear - Clear state and free memory necessary to make this
189 /// SelectionDAG ready to process a new block.
193 MachineFunction &getMachineFunction() const { return *MF; }
194 const TargetMachine &getTarget() const;
195 TargetLowering &getTargetLoweringInfo() const { return TLI; }
196 FunctionLoweringInfo &getFunctionLoweringInfo() const { return FLI; }
197 MachineModuleInfo *getMachineModuleInfo() const { return MMI; }
198 DwarfWriter *getDwarfWriter() const { return DW; }
199 LLVMContext *getContext() const {return Context; }
201 /// viewGraph - Pop up a GraphViz/gv window with the DAG rendered using 'dot'.
203 void viewGraph(const std::string &Title);
207 std::map<const SDNode *, std::string> NodeGraphAttrs;
210 /// clearGraphAttrs - Clear all previously defined node graph attributes.
211 /// Intended to be used from a debugging tool (eg. gdb).
212 void clearGraphAttrs();
214 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".)
216 void setGraphAttrs(const SDNode *N, const char *Attrs);
218 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".)
219 /// Used from getNodeAttributes.
220 const std::string getGraphAttrs(const SDNode *N) const;
222 /// setGraphColor - Convenience for setting node color attribute.
224 void setGraphColor(const SDNode *N, const char *Color);
226 /// setGraphColor - Convenience for setting subgraph color attribute.
228 void setSubgraphColor(SDNode *N, const char *Color);
230 typedef ilist<SDNode>::const_iterator allnodes_const_iterator;
231 allnodes_const_iterator allnodes_begin() const { return AllNodes.begin(); }
232 allnodes_const_iterator allnodes_end() const { return AllNodes.end(); }
233 typedef ilist<SDNode>::iterator allnodes_iterator;
234 allnodes_iterator allnodes_begin() { return AllNodes.begin(); }
235 allnodes_iterator allnodes_end() { return AllNodes.end(); }
236 ilist<SDNode>::size_type allnodes_size() const {
237 return AllNodes.size();
240 /// getRoot - Return the root tag of the SelectionDAG.
242 const SDValue &getRoot() const { return Root; }
244 /// getEntryNode - Return the token chain corresponding to the entry of the
246 SDValue getEntryNode() const {
247 return SDValue(const_cast<SDNode *>(&EntryNode), 0);
250 /// setRoot - Set the current root tag of the SelectionDAG.
252 const SDValue &setRoot(SDValue N) {
253 assert((!N.getNode() || N.getValueType() == MVT::Other) &&
254 "DAG root value is not a chain!");
256 checkForCycles(N.getNode());
259 checkForCycles(this);
263 /// Combine - This iterates over the nodes in the SelectionDAG, folding
264 /// certain types of nodes together, or eliminating superfluous nodes. The
265 /// Level argument controls whether Combine is allowed to produce nodes and
266 /// types that are illegal on the target.
267 void Combine(CombineLevel Level, AliasAnalysis &AA,
268 CodeGenOpt::Level OptLevel);
270 /// LegalizeTypes - This transforms the SelectionDAG into a SelectionDAG that
271 /// only uses types natively supported by the target. Returns "true" if it
272 /// made any changes.
274 /// Note that this is an involved process that may invalidate pointers into
276 bool LegalizeTypes();
278 /// Legalize - This transforms the SelectionDAG into a SelectionDAG that is
279 /// compatible with the target instruction selector, as indicated by the
280 /// TargetLowering object.
282 /// Note that this is an involved process that may invalidate pointers into
284 void Legalize(CodeGenOpt::Level OptLevel);
286 /// LegalizeVectors - This transforms the SelectionDAG into a SelectionDAG
287 /// that only uses vector math operations supported by the target. This is
288 /// necessary as a separate step from Legalize because unrolling a vector
289 /// operation can introduce illegal types, which requires running
290 /// LegalizeTypes again.
292 /// This returns true if it made any changes; in that case, LegalizeTypes
293 /// is called again before Legalize.
295 /// Note that this is an involved process that may invalidate pointers into
297 bool LegalizeVectors();
299 /// RemoveDeadNodes - This method deletes all unreachable nodes in the
301 void RemoveDeadNodes();
303 /// DeleteNode - Remove the specified node from the system. This node must
304 /// have no referrers.
305 void DeleteNode(SDNode *N);
307 /// getVTList - Return an SDVTList that represents the list of values
309 SDVTList getVTList(EVT VT);
310 SDVTList getVTList(EVT VT1, EVT VT2);
311 SDVTList getVTList(EVT VT1, EVT VT2, EVT VT3);
312 SDVTList getVTList(EVT VT1, EVT VT2, EVT VT3, EVT VT4);
313 SDVTList getVTList(const EVT *VTs, unsigned NumVTs);
315 //===--------------------------------------------------------------------===//
316 // Node creation methods.
318 SDValue getConstant(uint64_t Val, EVT VT, bool isTarget = false);
319 SDValue getConstant(const APInt &Val, EVT VT, bool isTarget = false);
320 SDValue getConstant(const ConstantInt &Val, EVT VT, bool isTarget = false);
321 SDValue getIntPtrConstant(uint64_t Val, bool isTarget = false);
322 SDValue getTargetConstant(uint64_t Val, EVT VT) {
323 return getConstant(Val, VT, true);
325 SDValue getTargetConstant(const APInt &Val, EVT VT) {
326 return getConstant(Val, VT, true);
328 SDValue getTargetConstant(const ConstantInt &Val, EVT VT) {
329 return getConstant(Val, VT, true);
331 SDValue getConstantFP(double Val, EVT VT, bool isTarget = false);
332 SDValue getConstantFP(const APFloat& Val, EVT VT, bool isTarget = false);
333 SDValue getConstantFP(const ConstantFP &CF, EVT VT, bool isTarget = false);
334 SDValue getTargetConstantFP(double Val, EVT VT) {
335 return getConstantFP(Val, VT, true);
337 SDValue getTargetConstantFP(const APFloat& Val, EVT VT) {
338 return getConstantFP(Val, VT, true);
340 SDValue getTargetConstantFP(const ConstantFP &Val, EVT VT) {
341 return getConstantFP(Val, VT, true);
343 SDValue getGlobalAddress(const GlobalValue *GV, EVT VT,
344 int64_t offset = 0, bool isTargetGA = false,
345 unsigned char TargetFlags = 0);
346 SDValue getTargetGlobalAddress(const GlobalValue *GV, EVT VT,
348 unsigned char TargetFlags = 0) {
349 return getGlobalAddress(GV, VT, offset, true, TargetFlags);
351 SDValue getFrameIndex(int FI, EVT VT, bool isTarget = false);
352 SDValue getTargetFrameIndex(int FI, EVT VT) {
353 return getFrameIndex(FI, VT, true);
355 SDValue getJumpTable(int JTI, EVT VT, bool isTarget = false,
356 unsigned char TargetFlags = 0);
357 SDValue getTargetJumpTable(int JTI, EVT VT, unsigned char TargetFlags = 0) {
358 return getJumpTable(JTI, VT, true, TargetFlags);
360 SDValue getConstantPool(Constant *C, EVT VT,
361 unsigned Align = 0, int Offs = 0, bool isT=false,
362 unsigned char TargetFlags = 0);
363 SDValue getTargetConstantPool(Constant *C, EVT VT,
364 unsigned Align = 0, int Offset = 0,
365 unsigned char TargetFlags = 0) {
366 return getConstantPool(C, VT, Align, Offset, true, TargetFlags);
368 SDValue getConstantPool(MachineConstantPoolValue *C, EVT VT,
369 unsigned Align = 0, int Offs = 0, bool isT=false,
370 unsigned char TargetFlags = 0);
371 SDValue getTargetConstantPool(MachineConstantPoolValue *C,
372 EVT VT, unsigned Align = 0,
373 int Offset = 0, unsigned char TargetFlags=0) {
374 return getConstantPool(C, VT, Align, Offset, true, TargetFlags);
376 // When generating a branch to a BB, we don't in general know enough
377 // to provide debug info for the BB at that time, so keep this one around.
378 SDValue getBasicBlock(MachineBasicBlock *MBB);
379 SDValue getBasicBlock(MachineBasicBlock *MBB, DebugLoc dl);
380 SDValue getExternalSymbol(const char *Sym, EVT VT);
381 SDValue getExternalSymbol(const char *Sym, DebugLoc dl, EVT VT);
382 SDValue getTargetExternalSymbol(const char *Sym, EVT VT,
383 unsigned char TargetFlags = 0);
384 SDValue getValueType(EVT);
385 SDValue getRegister(unsigned Reg, EVT VT);
386 SDValue getLabel(unsigned Opcode, DebugLoc dl, SDValue Root,
388 SDValue getBlockAddress(BlockAddress *BA, EVT VT,
389 bool isTarget = false, unsigned char TargetFlags = 0);
391 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N) {
392 return getNode(ISD::CopyToReg, dl, MVT::Other, Chain,
393 getRegister(Reg, N.getValueType()), N);
396 // This version of the getCopyToReg method takes an extra operand, which
397 // indicates that there is potentially an incoming flag value (if Flag is not
398 // null) and that there should be a flag result.
399 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, unsigned Reg, SDValue N,
401 SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
402 SDValue Ops[] = { Chain, getRegister(Reg, N.getValueType()), N, Flag };
403 return getNode(ISD::CopyToReg, dl, VTs, Ops, Flag.getNode() ? 4 : 3);
406 // Similar to last getCopyToReg() except parameter Reg is a SDValue
407 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, SDValue Reg, SDValue N,
409 SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
410 SDValue Ops[] = { Chain, Reg, N, Flag };
411 return getNode(ISD::CopyToReg, dl, VTs, Ops, Flag.getNode() ? 4 : 3);
414 SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, EVT VT) {
415 SDVTList VTs = getVTList(VT, MVT::Other);
416 SDValue Ops[] = { Chain, getRegister(Reg, VT) };
417 return getNode(ISD::CopyFromReg, dl, VTs, Ops, 2);
420 // This version of the getCopyFromReg method takes an extra operand, which
421 // indicates that there is potentially an incoming flag value (if Flag is not
422 // null) and that there should be a flag result.
423 SDValue getCopyFromReg(SDValue Chain, DebugLoc dl, unsigned Reg, EVT VT,
425 SDVTList VTs = getVTList(VT, MVT::Other, MVT::Flag);
426 SDValue Ops[] = { Chain, getRegister(Reg, VT), Flag };
427 return getNode(ISD::CopyFromReg, dl, VTs, Ops, Flag.getNode() ? 3 : 2);
430 SDValue getCondCode(ISD::CondCode Cond);
432 /// Returns the ConvertRndSat Note: Avoid using this node because it may
433 /// disappear in the future and most targets don't support it.
434 SDValue getConvertRndSat(EVT VT, DebugLoc dl, SDValue Val, SDValue DTy,
436 SDValue Rnd, SDValue Sat, ISD::CvtCode Code);
438 /// getVectorShuffle - Return an ISD::VECTOR_SHUFFLE node. The number of
439 /// elements in VT, which must be a vector type, must match the number of
440 /// mask elements NumElts. A integer mask element equal to -1 is treated as
442 SDValue getVectorShuffle(EVT VT, DebugLoc dl, SDValue N1, SDValue N2,
443 const int *MaskElts);
445 /// getSExtOrTrunc - Convert Op, which must be of integer type, to the
446 /// integer type VT, by either sign-extending or truncating it.
447 SDValue getSExtOrTrunc(SDValue Op, DebugLoc DL, EVT VT);
449 /// getZExtOrTrunc - Convert Op, which must be of integer type, to the
450 /// integer type VT, by either zero-extending or truncating it.
451 SDValue getZExtOrTrunc(SDValue Op, DebugLoc DL, EVT VT);
453 /// getZeroExtendInReg - Return the expression required to zero extend the Op
454 /// value assuming it was the smaller SrcTy value.
455 SDValue getZeroExtendInReg(SDValue Op, DebugLoc DL, EVT SrcTy);
457 /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
458 SDValue getNOT(DebugLoc DL, SDValue Val, EVT VT);
460 /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
461 /// a flag result (to ensure it's not CSE'd). CALLSEQ_START does not have a
463 SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
464 SDVTList VTs = getVTList(MVT::Other, MVT::Flag);
465 SDValue Ops[] = { Chain, Op };
466 return getNode(ISD::CALLSEQ_START, DebugLoc::getUnknownLoc(),
470 /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
471 /// flag result (to ensure it's not CSE'd). CALLSEQ_END does not have
472 /// a useful DebugLoc.
473 SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
475 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
476 SmallVector<SDValue, 4> Ops;
477 Ops.push_back(Chain);
480 Ops.push_back(InFlag);
481 return getNode(ISD::CALLSEQ_END, DebugLoc::getUnknownLoc(), NodeTys,
483 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
486 /// getUNDEF - Return an UNDEF node. UNDEF does not have a useful DebugLoc.
487 SDValue getUNDEF(EVT VT) {
488 return getNode(ISD::UNDEF, DebugLoc::getUnknownLoc(), VT);
491 /// getGLOBAL_OFFSET_TABLE - Return a GLOBAL_OFFSET_TABLE node. This does
492 /// not have a useful DebugLoc.
493 SDValue getGLOBAL_OFFSET_TABLE(EVT VT) {
494 return getNode(ISD::GLOBAL_OFFSET_TABLE, DebugLoc::getUnknownLoc(), VT);
497 /// getNode - Gets or creates the specified node.
499 SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT);
500 SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT, SDValue N);
501 SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT, SDValue N1, SDValue N2);
502 SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
503 SDValue N1, SDValue N2, SDValue N3);
504 SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
505 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
506 SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
507 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
509 SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
510 const SDUse *Ops, unsigned NumOps);
511 SDValue getNode(unsigned Opcode, DebugLoc DL, EVT VT,
512 const SDValue *Ops, unsigned NumOps);
513 SDValue getNode(unsigned Opcode, DebugLoc DL,
514 const std::vector<EVT> &ResultTys,
515 const SDValue *Ops, unsigned NumOps);
516 SDValue getNode(unsigned Opcode, DebugLoc DL, const EVT *VTs, unsigned NumVTs,
517 const SDValue *Ops, unsigned NumOps);
518 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
519 const SDValue *Ops, unsigned NumOps);
520 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs);
521 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N);
522 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
523 SDValue N1, SDValue N2);
524 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
525 SDValue N1, SDValue N2, SDValue N3);
526 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
527 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
528 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
529 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
532 /// getStackArgumentTokenFactor - Compute a TokenFactor to force all
533 /// the incoming stack arguments to be loaded from the stack. This is
534 /// used in tail call lowering to protect stack arguments from being
536 SDValue getStackArgumentTokenFactor(SDValue Chain);
538 SDValue getMemcpy(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
539 SDValue Size, unsigned Align, bool AlwaysInline,
540 const Value *DstSV, uint64_t DstSVOff,
541 const Value *SrcSV, uint64_t SrcSVOff);
543 SDValue getMemmove(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
544 SDValue Size, unsigned Align,
545 const Value *DstSV, uint64_t DstOSVff,
546 const Value *SrcSV, uint64_t SrcSVOff);
548 SDValue getMemset(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
549 SDValue Size, unsigned Align,
550 const Value *DstSV, uint64_t DstSVOff);
552 /// getSetCC - Helper function to make it easier to build SetCC's if you just
553 /// have an ISD::CondCode instead of an SDValue.
555 SDValue getSetCC(DebugLoc DL, EVT VT, SDValue LHS, SDValue RHS,
556 ISD::CondCode Cond) {
557 return getNode(ISD::SETCC, DL, VT, LHS, RHS, getCondCode(Cond));
560 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
561 /// if you just have an ISD::CondCode instead of an SDValue.
563 SDValue getVSetCC(DebugLoc DL, EVT VT, SDValue LHS, SDValue RHS,
564 ISD::CondCode Cond) {
565 return getNode(ISD::VSETCC, DL, VT, LHS, RHS, getCondCode(Cond));
568 /// getSelectCC - Helper function to make it easier to build SelectCC's if you
569 /// just have an ISD::CondCode instead of an SDValue.
571 SDValue getSelectCC(DebugLoc DL, SDValue LHS, SDValue RHS,
572 SDValue True, SDValue False, ISD::CondCode Cond) {
573 return getNode(ISD::SELECT_CC, DL, True.getValueType(),
574 LHS, RHS, True, False, getCondCode(Cond));
577 /// getVAArg - VAArg produces a result and token chain, and takes a pointer
578 /// and a source value as input.
579 SDValue getVAArg(EVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
582 /// getAtomic - Gets a node for an atomic op, produces result and chain and
584 SDValue getAtomic(unsigned Opcode, DebugLoc dl, EVT MemVT, SDValue Chain,
585 SDValue Ptr, SDValue Cmp, SDValue Swp, const Value* PtrVal,
586 unsigned Alignment=0);
587 SDValue getAtomic(unsigned Opcode, DebugLoc dl, EVT MemVT, SDValue Chain,
588 SDValue Ptr, SDValue Cmp, SDValue Swp,
589 MachineMemOperand *MMO);
591 /// getAtomic - Gets a node for an atomic op, produces result and chain and
592 /// takes 2 operands.
593 SDValue getAtomic(unsigned Opcode, DebugLoc dl, EVT MemVT, SDValue Chain,
594 SDValue Ptr, SDValue Val, const Value* PtrVal,
595 unsigned Alignment = 0);
596 SDValue getAtomic(unsigned Opcode, DebugLoc dl, EVT MemVT, SDValue Chain,
597 SDValue Ptr, SDValue Val,
598 MachineMemOperand *MMO);
600 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
601 /// result and takes a list of operands. Opcode may be INTRINSIC_VOID,
602 /// INTRINSIC_W_CHAIN, or a target-specific opcode with a value not
603 /// less than FIRST_TARGET_MEMORY_OPCODE.
604 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl,
605 const EVT *VTs, unsigned NumVTs,
606 const SDValue *Ops, unsigned NumOps,
607 EVT MemVT, const Value *srcValue, int SVOff,
608 unsigned Align = 0, bool Vol = false,
609 bool ReadMem = true, bool WriteMem = true);
611 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
612 const SDValue *Ops, unsigned NumOps,
613 EVT MemVT, const Value *srcValue, int SVOff,
614 unsigned Align = 0, bool Vol = false,
615 bool ReadMem = true, bool WriteMem = true);
617 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
618 const SDValue *Ops, unsigned NumOps,
619 EVT MemVT, MachineMemOperand *MMO);
621 /// getMergeValues - Create a MERGE_VALUES node from the given operands.
622 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps, DebugLoc dl);
624 /// getLoad - Loads are not normal binary operators: their result type is not
625 /// determined by their operands, and they produce a value AND a token chain.
627 SDValue getLoad(EVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
628 const Value *SV, int SVOffset, bool isVolatile,
629 bool isNonTemporal, unsigned Alignment);
630 SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, EVT VT,
631 SDValue Chain, SDValue Ptr, const Value *SV,
632 int SVOffset, EVT MemVT, bool isVolatile,
633 bool isNonTemporal, unsigned Alignment);
634 SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base,
635 SDValue Offset, ISD::MemIndexedMode AM);
636 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
637 EVT VT, SDValue Chain, SDValue Ptr, SDValue Offset,
638 const Value *SV, int SVOffset, EVT MemVT,
639 bool isVolatile, bool isNonTemporal, unsigned Alignment);
640 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
641 EVT VT, SDValue Chain, SDValue Ptr, SDValue Offset,
642 EVT MemVT, MachineMemOperand *MMO);
644 /// getStore - Helper function to build ISD::STORE nodes.
646 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
647 const Value *SV, int SVOffset, bool isVolatile,
648 bool isNonTemporal, unsigned Alignment);
649 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
650 MachineMemOperand *MMO);
651 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
652 const Value *SV, int SVOffset, EVT TVT,
653 bool isNonTemporal, bool isVolatile,
655 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
656 EVT TVT, MachineMemOperand *MMO);
657 SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base,
658 SDValue Offset, ISD::MemIndexedMode AM);
660 /// getSrcValue - Construct a node to track a Value* through the backend.
661 SDValue getSrcValue(const Value *v);
663 /// getShiftAmountOperand - Return the specified value casted to
664 /// the target's desired shift amount type.
665 SDValue getShiftAmountOperand(SDValue Op);
667 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
668 /// specified operands. If the resultant node already exists in the DAG,
669 /// this does not modify the specified node, instead it returns the node that
670 /// already exists. If the resultant node does not exist in the DAG, the
671 /// input node is returned. As a degenerate case, if you specify the same
672 /// input operands as the node already has, the input node is returned.
673 SDValue UpdateNodeOperands(SDValue N, SDValue Op);
674 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
675 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
677 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
678 SDValue Op3, SDValue Op4);
679 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
680 SDValue Op3, SDValue Op4, SDValue Op5);
681 SDValue UpdateNodeOperands(SDValue N,
682 const SDValue *Ops, unsigned NumOps);
684 /// SelectNodeTo - These are used for target selectors to *mutate* the
685 /// specified node to have the specified return type, Target opcode, and
686 /// operands. Note that target opcodes are stored as
687 /// ~TargetOpcode in the node opcode field. The resultant node is returned.
688 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT);
689 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT, SDValue Op1);
690 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
691 SDValue Op1, SDValue Op2);
692 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
693 SDValue Op1, SDValue Op2, SDValue Op3);
694 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT,
695 const SDValue *Ops, unsigned NumOps);
696 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1, EVT VT2);
697 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
698 EVT VT2, const SDValue *Ops, unsigned NumOps);
699 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
700 EVT VT2, EVT VT3, const SDValue *Ops, unsigned NumOps);
701 SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, EVT VT1,
702 EVT VT2, EVT VT3, EVT VT4, const SDValue *Ops,
704 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
705 EVT VT2, SDValue Op1);
706 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
707 EVT VT2, SDValue Op1, SDValue Op2);
708 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
709 EVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
710 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, EVT VT1,
711 EVT VT2, EVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
712 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
713 const SDValue *Ops, unsigned NumOps);
715 /// MorphNodeTo - This *mutates* the specified node to have the specified
716 /// return type, opcode, and operands.
717 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
718 const SDValue *Ops, unsigned NumOps);
720 /// getMachineNode - These are used for target selectors to create a new node
721 /// with specified return type(s), MachineInstr opcode, and operands.
723 /// Note that getMachineNode returns the resultant node. If there is already
724 /// a node of the specified opcode and operands, it returns that node instead
725 /// of the current one.
726 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT);
727 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT,
729 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT,
730 SDValue Op1, SDValue Op2);
731 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT,
732 SDValue Op1, SDValue Op2, SDValue Op3);
733 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT,
734 const SDValue *Ops, unsigned NumOps);
735 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2);
736 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
738 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1,
739 EVT VT2, SDValue Op1, SDValue Op2);
740 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1,
741 EVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
742 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
743 const SDValue *Ops, unsigned NumOps);
744 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
745 EVT VT3, SDValue Op1, SDValue Op2);
746 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
747 EVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
748 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
749 EVT VT3, const SDValue *Ops, unsigned NumOps);
750 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, EVT VT1, EVT VT2,
751 EVT VT3, EVT VT4, const SDValue *Ops, unsigned NumOps);
752 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl,
753 const std::vector<EVT> &ResultTys, const SDValue *Ops,
755 MachineSDNode *getMachineNode(unsigned Opcode, DebugLoc dl, SDVTList VTs,
756 const SDValue *Ops, unsigned NumOps);
758 /// getTargetExtractSubreg - A convenience function for creating
759 /// TargetInstrInfo::EXTRACT_SUBREG nodes.
760 SDValue getTargetExtractSubreg(int SRIdx, DebugLoc DL, EVT VT,
763 /// getTargetInsertSubreg - A convenience function for creating
764 /// TargetInstrInfo::INSERT_SUBREG nodes.
765 SDValue getTargetInsertSubreg(int SRIdx, DebugLoc DL, EVT VT,
766 SDValue Operand, SDValue Subreg);
768 /// getNodeIfExists - Get the specified node if it's already available, or
769 /// else return NULL.
770 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
771 const SDValue *Ops, unsigned NumOps);
773 /// DAGUpdateListener - Clients of various APIs that cause global effects on
774 /// the DAG can optionally implement this interface. This allows the clients
775 /// to handle the various sorts of updates that happen.
776 class DAGUpdateListener {
778 virtual ~DAGUpdateListener();
780 /// NodeDeleted - The node N that was deleted and, if E is not null, an
781 /// equivalent node E that replaced it.
782 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
784 /// NodeUpdated - The node N that was updated.
785 virtual void NodeUpdated(SDNode *N) = 0;
788 /// RemoveDeadNode - Remove the specified node from the system. If any of its
789 /// operands then becomes dead, remove them as well. Inform UpdateListener
790 /// for each node deleted.
791 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
793 /// RemoveDeadNodes - This method deletes the unreachable nodes in the
794 /// given list, and any nodes that become unreachable as a result.
795 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
796 DAGUpdateListener *UpdateListener = 0);
798 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
799 /// This can cause recursive merging of nodes in the DAG. Use the first
800 /// version if 'From' is known to have a single result, use the second
801 /// if you have two nodes with identical results (or if 'To' has a superset
802 /// of the results of 'From'), 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
864 case ISD::ADDE: return true;
865 default: return false;
869 /// AssignOrdering - Assign an order to the SDNode.
870 void AssignOrdering(const SDNode *SD, unsigned Order);
872 /// GetOrdering - Get the order for the SDNode.
873 unsigned GetOrdering(const SDNode *SD) const;
875 /// AssignDbgInfo - Assign debug info to the SDNode.
876 void AssignDbgInfo(SDNode *SD, SDDbgValue *db);
878 /// RememberDbgInfo - Remember debug info with no associated SDNode.
879 void RememberDbgInfo(SDDbgValue *db);
881 /// GetDbgInfo - Get the debug info for the SDNode.
882 SDDbgValue *GetDbgInfo(const SDNode* SD);
884 SDDbgInfo::ConstDbgIterator DbgConstBegin() {
885 return DbgInfo->DbgConstBegin();
887 SDDbgInfo::ConstDbgIterator DbgConstEnd() { return DbgInfo->DbgConstEnd(); }
891 /// CreateStackTemporary - Create a stack temporary, suitable for holding the
892 /// specified value type. If minAlign is specified, the slot size will have
893 /// at least that alignment.
894 SDValue CreateStackTemporary(EVT VT, unsigned minAlign = 1);
896 /// CreateStackTemporary - Create a stack temporary suitable for holding
897 /// either of the specified value types.
898 SDValue CreateStackTemporary(EVT VT1, EVT VT2);
900 /// FoldConstantArithmetic -
901 SDValue FoldConstantArithmetic(unsigned Opcode,
903 ConstantSDNode *Cst1,
904 ConstantSDNode *Cst2);
906 /// FoldSetCC - Constant fold a setcc to true or false.
907 SDValue FoldSetCC(EVT VT, SDValue N1,
908 SDValue N2, ISD::CondCode Cond, DebugLoc dl);
910 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We
911 /// use this predicate to simplify operations downstream.
912 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
914 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We
915 /// use this predicate to simplify operations downstream. Op and Mask are
916 /// known to be the same type.
917 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
920 /// ComputeMaskedBits - Determine which of the bits specified in Mask are
921 /// known to be either zero or one and return them in the KnownZero/KnownOne
922 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit
923 /// processing. Targets can implement the computeMaskedBitsForTargetNode
924 /// method in the TargetLowering class to allow target nodes to be understood.
925 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
926 APInt &KnownOne, unsigned Depth = 0) const;
928 /// ComputeNumSignBits - Return the number of times the sign bit of the
929 /// register is replicated into the other bits. We know that at least 1 bit
930 /// is always equal to the sign bit (itself), but other cases can give us
931 /// information. For example, immediately after an "SRA X, 2", we know that
932 /// the top 3 bits are all equal to each other, so we return 3. Targets can
933 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
934 /// class to allow target nodes to be understood.
935 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
937 /// isKnownNeverNan - Test whether the given SDValue is known to never be NaN.
938 bool isKnownNeverNaN(SDValue Op) const;
940 /// isKnownNeverZero - Test whether the given SDValue is known to never be
941 /// positive or negative Zero.
942 bool isKnownNeverZero(SDValue Op) const;
944 /// isEqualTo - Test whether two SDValues are known to compare equal. This
945 /// is true if they are the same value, or if one is negative zero and the
946 /// other positive zero.
947 bool isEqualTo(SDValue A, SDValue B) const;
949 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
950 /// been verified as a debug information descriptor.
951 bool isVerifiedDebugInfoDesc(SDValue Op) const;
953 /// getShuffleScalarElt - Returns the scalar element that will make up the ith
954 /// element of the result of the vector shuffle.
955 SDValue getShuffleScalarElt(const ShuffleVectorSDNode *N, unsigned Idx);
957 /// UnrollVectorOp - Utility function used by legalize and lowering to
958 /// "unroll" a vector operation by splitting out the scalars and operating
959 /// on each element individually. If the ResNE is 0, fully unroll the vector
960 /// op. If ResNE is less than the width of the vector op, unroll up to ResNE.
961 /// If the ResNE is greater than the width of the vector op, unroll the
962 /// vector op and fill the end of the resulting vector with UNDEFS.
963 SDValue UnrollVectorOp(SDNode *N, unsigned ResNE = 0);
965 /// isConsecutiveLoad - Return true if LD is loading 'Bytes' bytes from a
966 /// location that is 'Dist' units away from the location that the 'Base' load
968 bool isConsecutiveLoad(LoadSDNode *LD, LoadSDNode *Base,
969 unsigned Bytes, int Dist) const;
971 /// InferPtrAlignment - Infer alignment of a load / store address. Return 0 if
972 /// it cannot be inferred.
973 unsigned InferPtrAlignment(SDValue Ptr) const;
976 bool RemoveNodeFromCSEMaps(SDNode *N);
977 void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener);
978 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
979 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
981 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
984 void DeleteNodeNotInCSEMaps(SDNode *N);
985 void DeallocateNode(SDNode *N);
987 unsigned getEVTAlignment(EVT MemoryVT) const;
989 void allnodes_clear();
991 /// VTList - List of non-single value types.
992 std::vector<SDVTList> VTList;
994 /// CondCodeNodes - Maps to auto-CSE operations.
995 std::vector<CondCodeSDNode*> CondCodeNodes;
997 std::vector<SDNode*> ValueTypeNodes;
998 std::map<EVT, SDNode*, EVT::compareRawBits> ExtendedValueTypeNodes;
999 StringMap<SDNode*> ExternalSymbols;
1001 std::map<std::pair<std::string, unsigned char>,SDNode*> TargetExternalSymbols;
1004 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
1005 typedef SelectionDAG::allnodes_iterator nodes_iterator;
1006 static nodes_iterator nodes_begin(SelectionDAG *G) {
1007 return G->allnodes_begin();
1009 static nodes_iterator nodes_end(SelectionDAG *G) {
1010 return G->allnodes_end();
1014 } // end namespace llvm