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, DebugLoc DL, MVT SrcTy);
376 /// getNOT - Create a bitwise NOT operation as (XOR Val, -1).
377 SDValue getNOT(DebugLoc DL, SDValue Val, MVT VT);
379 /// getCALLSEQ_START - Return a new CALLSEQ_START node, which always must have
380 /// a flag result (to ensure it's not CSE'd).
381 SDValue getCALLSEQ_START(SDValue Chain, SDValue Op) {
382 const MVT *VTs = getNodeValueTypes(MVT::Other, MVT::Flag);
383 SDValue Ops[] = { Chain, Op };
384 return getNode(ISD::CALLSEQ_START, VTs, 2, Ops, 2);
387 /// getCALLSEQ_END - Return a new CALLSEQ_END node, which always must have a
388 /// flag result (to ensure it's not CSE'd).
389 SDValue getCALLSEQ_END(SDValue Chain, SDValue Op1, SDValue Op2,
391 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag);
392 SmallVector<SDValue, 4> Ops;
393 Ops.push_back(Chain);
396 Ops.push_back(InFlag);
397 return getNode(ISD::CALLSEQ_END, NodeTys, &Ops[0],
398 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0));
401 /// getNode - Gets or creates the specified node.
403 SDValue getNode(unsigned Opcode, MVT VT);
404 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT);
405 SDValue getNode(unsigned Opcode, MVT VT, SDValue N);
406 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N);
407 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N1, SDValue N2);
408 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
409 SDValue N1, SDValue N2, SDValue N3);
410 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
411 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
412 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
413 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
415 SDValue getNode(unsigned Opcode, MVT VT,
416 const SDUse *Ops, unsigned NumOps);
417 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
418 const SDUse *Ops, unsigned NumOps);
419 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT,
420 const SDValue *Ops, unsigned NumOps);
421 SDValue getNode(unsigned Opcode, DebugLoc DL,
422 const std::vector<MVT> &ResultTys,
423 const SDValue *Ops, unsigned NumOps);
424 SDValue getNode(unsigned Opcode, const MVT *VTs, unsigned NumVTs,
425 const SDValue *Ops, unsigned NumOps);
426 SDValue getNode(unsigned Opcode, DebugLoc DL, const MVT *VTs, unsigned NumVTs,
427 const SDValue *Ops, unsigned NumOps);
428 SDValue getNode(unsigned Opcode, SDVTList VTs,
429 const SDValue *Ops, unsigned NumOps);
430 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
431 const SDValue *Ops, unsigned NumOps);
433 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs);
434 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N);
435 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
436 SDValue N1, SDValue N2);
437 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
438 SDValue N1, SDValue N2, SDValue N3);
439 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
440 SDValue N1, SDValue N2, SDValue N3, SDValue N4);
441 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs,
442 SDValue N1, SDValue N2, SDValue N3, SDValue N4,
445 SDValue getMemcpy(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
446 SDValue Size, unsigned Align, bool AlwaysInline,
447 const Value *DstSV, uint64_t DstSVOff,
448 const Value *SrcSV, uint64_t SrcSVOff);
450 SDValue getMemmove(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
451 SDValue Size, unsigned Align,
452 const Value *DstSV, uint64_t DstOSVff,
453 const Value *SrcSV, uint64_t SrcSVOff);
455 SDValue getMemset(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src,
456 SDValue Size, unsigned Align,
457 const Value *DstSV, uint64_t DstSVOff);
459 /// getSetCC - Helper function to make it easier to build SetCC's if you just
460 /// have an ISD::CondCode instead of an SDValue.
462 SDValue getSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS,
463 ISD::CondCode Cond) {
464 return getNode(ISD::SETCC, DL, VT, LHS, RHS, getCondCode(Cond));
467 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes
468 /// if you just have an ISD::CondCode instead of an SDValue.
470 SDValue getVSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS,
471 ISD::CondCode Cond) {
472 return getNode(ISD::VSETCC, DL, VT, LHS, RHS, getCondCode(Cond));
475 /// getSelectCC - Helper function to make it easier to build SelectCC's if you
476 /// just have an ISD::CondCode instead of an SDValue.
478 SDValue getSelectCC(DebugLoc DL, SDValue LHS, SDValue RHS,
479 SDValue True, SDValue False, ISD::CondCode Cond) {
480 return getNode(ISD::SELECT_CC, DL, True.getValueType(),
481 LHS, RHS, True, False, getCondCode(Cond));
484 /// getVAArg - VAArg produces a result and token chain, and takes a pointer
485 /// and a source value as input.
486 SDValue getVAArg(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
489 /// getAtomic - Gets a node for an atomic op, produces result and chain and
491 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
492 SDValue Ptr, SDValue Cmp, SDValue Swp, const Value* PtrVal,
493 unsigned Alignment=0);
495 /// getAtomic - Gets a node for an atomic op, produces result and chain and
496 /// takes 2 operands.
497 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain,
498 SDValue Ptr, SDValue Val, const Value* PtrVal,
499 unsigned Alignment = 0);
501 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a
502 /// result and takes a list of operands.
503 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl,
504 const MVT *VTs, unsigned NumVTs,
505 const SDValue *Ops, unsigned NumOps,
506 MVT MemVT, const Value *srcValue, int SVOff,
507 unsigned Align = 0, bool Vol = false,
508 bool ReadMem = true, bool WriteMem = true);
510 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList,
511 const SDValue *Ops, unsigned NumOps,
512 MVT MemVT, const Value *srcValue, int SVOff,
513 unsigned Align = 0, bool Vol = false,
514 bool ReadMem = true, bool WriteMem = true);
516 /// getMergeValues - Create a MERGE_VALUES node from the given operands.
517 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps, DebugLoc dl);
519 /// getCall - Create a CALL node from the given information.
521 SDValue getCall(unsigned CallingConv, DebugLoc dl, bool IsVarArgs,
522 bool IsTailCall, bool isInreg, SDVTList VTs,
523 const SDValue *Operands, unsigned NumOperands);
525 /// getLoad - Loads are not normal binary operators: their result type is not
526 /// determined by their operands, and they produce a value AND a token chain.
528 SDValue getLoad(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr,
529 const Value *SV, int SVOffset, bool isVolatile=false,
530 unsigned Alignment=0);
531 SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, MVT VT,
532 SDValue Chain, SDValue Ptr, const Value *SV,
533 int SVOffset, MVT EVT, bool isVolatile=false,
534 unsigned Alignment=0);
535 SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base,
536 SDValue Offset, ISD::MemIndexedMode AM);
537 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType,
538 MVT VT, SDValue Chain,
539 SDValue Ptr, SDValue Offset,
540 const Value *SV, int SVOffset, MVT EVT,
541 bool isVolatile=false, unsigned Alignment=0);
543 /// getStore - Helper function to build ISD::STORE nodes.
545 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
546 const Value *SV, int SVOffset, bool isVolatile=false,
547 unsigned Alignment=0);
548 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr,
549 const Value *SV, int SVOffset, MVT TVT,
550 bool isVolatile=false, unsigned Alignment=0);
551 SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base,
552 SDValue Offset, ISD::MemIndexedMode AM);
554 /// getSrcValue - Construct a node to track a Value* through the backend.
555 SDValue getSrcValue(const Value *v);
557 /// getMemOperand - Construct a node to track a memory reference
558 /// through the backend.
559 SDValue getMemOperand(const MachineMemOperand &MO);
561 /// getShiftAmountOperand - Return the specified value casted to
562 /// the target's desired shift amount type.
563 SDValue getShiftAmountOperand(SDValue Op);
565 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the
566 /// specified operands. If the resultant node already exists in the DAG,
567 /// this does not modify the specified node, instead it returns the node that
568 /// already exists. If the resultant node does not exist in the DAG, the
569 /// input node is returned. As a degenerate case, if you specify the same
570 /// input operands as the node already has, the input node is returned.
571 SDValue UpdateNodeOperands(SDValue N, SDValue Op);
572 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2);
573 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
575 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
576 SDValue Op3, SDValue Op4);
577 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2,
578 SDValue Op3, SDValue Op4, SDValue Op5);
579 SDValue UpdateNodeOperands(SDValue N,
580 const SDValue *Ops, unsigned NumOps);
582 /// SelectNodeTo - These are used for target selectors to *mutate* the
583 /// specified node to have the specified return type, Target opcode, and
584 /// operands. Note that target opcodes are stored as
585 /// ~TargetOpcode in the node opcode field. The resultant node is returned.
586 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT);
587 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, SDValue Op1);
588 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
589 SDValue Op1, SDValue Op2);
590 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
591 SDValue Op1, SDValue Op2, SDValue Op3);
592 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT,
593 const SDValue *Ops, unsigned NumOps);
594 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, MVT VT2);
595 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
596 MVT VT2, const SDValue *Ops, unsigned NumOps);
597 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
598 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
599 SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, MVT VT1,
600 MVT VT2, MVT VT3, MVT VT4, const SDValue *Ops,
602 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
603 MVT VT2, SDValue Op1);
604 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
605 MVT VT2, SDValue Op1, SDValue Op2);
606 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
607 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
608 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1,
609 MVT VT2, MVT VT3, SDValue Op1, SDValue Op2, SDValue Op3);
610 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs,
611 const SDValue *Ops, unsigned NumOps);
613 /// MorphNodeTo - These *mutate* the specified node to have the specified
614 /// return type, opcode, and operands.
615 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT);
616 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, SDValue Op1);
617 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
618 SDValue Op1, SDValue Op2);
619 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
620 SDValue Op1, SDValue Op2, SDValue Op3);
621 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT,
622 const SDValue *Ops, unsigned NumOps);
623 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, MVT VT2);
624 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
625 MVT VT2, const SDValue *Ops, unsigned NumOps);
626 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
627 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps);
628 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
629 MVT VT2, SDValue Op1);
630 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
631 MVT VT2, SDValue Op1, SDValue Op2);
632 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1,
633 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
634 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs,
635 const SDValue *Ops, unsigned NumOps);
637 /// getTargetNode - These are used for target selectors to create a new node
638 /// with specified return type(s), target opcode, and operands.
640 /// Note that getTargetNode returns the resultant node. If there is already a
641 /// node of the specified opcode and operands, it returns that node instead of
643 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT);
644 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1);
645 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1,
647 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
648 SDValue Op1, SDValue Op2, SDValue Op3);
649 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT,
650 const SDValue *Ops, unsigned NumOps);
651 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2);
652 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
654 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
655 MVT VT2, SDValue Op1, SDValue Op2);
656 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1,
657 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3);
658 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2,
659 const SDValue *Ops, unsigned NumOps);
660 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
661 SDValue Op1, SDValue Op2);
662 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
663 SDValue Op1, SDValue Op2, SDValue Op3);
664 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
665 const SDValue *Ops, unsigned NumOps);
666 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3,
667 MVT VT4, const SDValue *Ops, unsigned NumOps);
668 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl,
669 const std::vector<MVT> &ResultTys, const SDValue *Ops,
672 /// getNodeIfExists - Get the specified node if it's already available, or
673 /// else return NULL.
674 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs,
675 const SDValue *Ops, unsigned NumOps);
677 /// DAGUpdateListener - Clients of various APIs that cause global effects on
678 /// the DAG can optionally implement this interface. This allows the clients
679 /// to handle the various sorts of updates that happen.
680 class DAGUpdateListener {
682 virtual ~DAGUpdateListener();
684 /// NodeDeleted - The node N that was deleted and, if E is not null, an
685 /// equivalent node E that replaced it.
686 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0;
688 /// NodeUpdated - The node N that was updated.
689 virtual void NodeUpdated(SDNode *N) = 0;
692 /// RemoveDeadNode - Remove the specified node from the system. If any of its
693 /// operands then becomes dead, remove them as well. Inform UpdateListener
694 /// for each node deleted.
695 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0);
697 /// RemoveDeadNodes - This method deletes the unreachable nodes in the
698 /// given list, and any nodes that become unreachable as a result.
699 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes,
700 DAGUpdateListener *UpdateListener = 0);
702 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead.
703 /// This can cause recursive merging of nodes in the DAG. Use the first
704 /// version if 'From' is known to have a single result, use the second
705 /// if you have two nodes with identical results, use the third otherwise.
707 /// These methods all take an optional UpdateListener, which (if not null) is
708 /// informed about nodes that are deleted and modified due to recursive
709 /// changes in the dag.
711 /// These functions only replace all existing uses. It's possible that as
712 /// these replacements are being performed, CSE may cause the From node
713 /// to be given new uses. These new uses of From are left in place, and
714 /// not automatically transfered to To.
716 void ReplaceAllUsesWith(SDValue From, SDValue Op,
717 DAGUpdateListener *UpdateListener = 0);
718 void ReplaceAllUsesWith(SDNode *From, SDNode *To,
719 DAGUpdateListener *UpdateListener = 0);
720 void ReplaceAllUsesWith(SDNode *From, const SDValue *To,
721 DAGUpdateListener *UpdateListener = 0);
723 /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving
724 /// uses of other values produced by From.Val alone.
725 void ReplaceAllUsesOfValueWith(SDValue From, SDValue To,
726 DAGUpdateListener *UpdateListener = 0);
728 /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but
729 /// for multiple values at once. This correctly handles the case where
730 /// there is an overlap between the From values and the To values.
731 void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To,
733 DAGUpdateListener *UpdateListener = 0);
735 /// AssignTopologicalOrder - Topological-sort the AllNodes list and a
736 /// assign a unique node id for each node in the DAG based on their
737 /// topological order. Returns the number of nodes.
738 unsigned AssignTopologicalOrder();
740 /// RepositionNode - Move node N in the AllNodes list to be immediately
741 /// before the given iterator Position. This may be used to update the
742 /// topological ordering when the list of nodes is modified.
743 void RepositionNode(allnodes_iterator Position, SDNode *N) {
744 AllNodes.insert(Position, AllNodes.remove(N));
747 /// isCommutativeBinOp - Returns true if the opcode is a commutative binary
749 static bool isCommutativeBinOp(unsigned Opcode) {
750 // FIXME: This should get its info from the td file, so that we can include
765 case ISD::ADDE: return true;
766 default: return false;
772 /// CreateStackTemporary - Create a stack temporary, suitable for holding the
773 /// specified value type. If minAlign is specified, the slot size will have
774 /// at least that alignment.
775 SDValue CreateStackTemporary(MVT VT, unsigned minAlign = 1);
777 /// CreateStackTemporary - Create a stack temporary suitable for holding
778 /// either of the specified value types.
779 SDValue CreateStackTemporary(MVT VT1, MVT VT2);
781 /// FoldConstantArithmetic -
782 SDValue FoldConstantArithmetic(unsigned Opcode,
784 ConstantSDNode *Cst1,
785 ConstantSDNode *Cst2);
787 /// FoldSetCC - Constant fold a setcc to true or false.
788 SDValue FoldSetCC(MVT VT, SDValue N1,
789 SDValue N2, ISD::CondCode Cond, DebugLoc dl);
791 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We
792 /// use this predicate to simplify operations downstream.
793 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const;
795 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We
796 /// use this predicate to simplify operations downstream. Op and Mask are
797 /// known to be the same type.
798 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0)
801 /// ComputeMaskedBits - Determine which of the bits specified in Mask are
802 /// known to be either zero or one and return them in the KnownZero/KnownOne
803 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit
804 /// processing. Targets can implement the computeMaskedBitsForTargetNode
805 /// method in the TargetLowering class to allow target nodes to be understood.
806 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero,
807 APInt &KnownOne, unsigned Depth = 0) const;
809 /// ComputeNumSignBits - Return the number of times the sign bit of the
810 /// register is replicated into the other bits. We know that at least 1 bit
811 /// is always equal to the sign bit (itself), but other cases can give us
812 /// information. For example, immediately after an "SRA X, 2", we know that
813 /// the top 3 bits are all equal to each other, so we return 3. Targets can
814 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering
815 /// class to allow target nodes to be understood.
816 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const;
818 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has
819 /// been verified as a debug information descriptor.
820 bool isVerifiedDebugInfoDesc(SDValue Op) const;
822 /// getShuffleScalarElt - Returns the scalar element that will make up the ith
823 /// element of the result of the vector shuffle.
824 SDValue getShuffleScalarElt(const SDNode *N, unsigned Idx);
827 bool RemoveNodeFromCSEMaps(SDNode *N);
828 void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener);
829 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos);
830 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2,
832 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps,
835 void DeleteNodeNotInCSEMaps(SDNode *N);
836 void DeallocateNode(SDNode *N);
838 unsigned getMVTAlignment(MVT MemoryVT) const;
840 void allnodes_clear();
842 /// VTList - List of non-single value types.
843 std::vector<SDVTList> VTList;
845 /// CondCodeNodes - Maps to auto-CSE operations.
846 std::vector<CondCodeSDNode*> CondCodeNodes;
848 std::vector<SDNode*> ValueTypeNodes;
849 std::map<MVT, SDNode*, MVT::compareRawBits> ExtendedValueTypeNodes;
850 StringMap<SDNode*> ExternalSymbols;
851 StringMap<SDNode*> TargetExternalSymbols;
854 template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> {
855 typedef SelectionDAG::allnodes_iterator nodes_iterator;
856 static nodes_iterator nodes_begin(SelectionDAG *G) {
857 return G->allnodes_begin();
859 static nodes_iterator nodes_end(SelectionDAG *G) {
860 return G->allnodes_end();
864 } // end namespace llvm