SelectionDAG.h revision 2fabcb27761e0f07368f065fda0144d824e1e51c
1//===-- llvm/CodeGen/SelectionDAG.h - InstSelection DAG ---------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file declares the SelectionDAG class, and transitively defines the 11// SDNode class and subclasses. 12// 13//===----------------------------------------------------------------------===// 14 15#ifndef LLVM_CODEGEN_SELECTIONDAG_H 16#define LLVM_CODEGEN_SELECTIONDAG_H 17 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" 23 24#include <cassert> 25#include <vector> 26#include <map> 27#include <string> 28 29namespace llvm { 30 31class AliasAnalysis; 32class TargetLowering; 33class TargetMachine; 34class MachineModuleInfo; 35class DwarfWriter; 36class MachineFunction; 37class MachineConstantPoolValue; 38class FunctionLoweringInfo; 39 40template<> struct ilist_traits<SDNode> : public ilist_default_traits<SDNode> { 41private: 42 mutable SDNode Sentinel; 43public: 44 ilist_traits() : Sentinel(ISD::DELETED_NODE, SDVTList()) {} 45 46 SDNode *createSentinel() const { 47 return &Sentinel; 48 } 49 static void destroySentinel(SDNode *) {} 50 51 static void deleteNode(SDNode *) { 52 assert(0 && "ilist_traits<SDNode> shouldn't see a deleteNode call!"); 53 } 54private: 55 static void createNode(const SDNode &); 56}; 57 58enum CombineLevel { 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. 62}; 63 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. 69/// 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 73/// linear form. 74/// 75class SelectionDAG { 76 TargetLowering &TLI; 77 MachineFunction *MF; 78 FunctionLoweringInfo &FLI; 79 MachineModuleInfo *MMI; 80 DwarfWriter *DW; 81 82 /// EntryNode - The starting token. 83 SDNode EntryNode; 84 85 /// Root - The root of the entire DAG. 86 SDValue Root; 87 88 /// AllNodes - A linked list of nodes in the current DAG. 89 ilist<SDNode> AllNodes; 90 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> 95 NodeAllocatorType; 96 97 /// NodeAllocator - Pool allocation for nodes. 98 NodeAllocatorType NodeAllocator; 99 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; 103 104 /// OperandAllocator - Pool allocation for machine-opcode SDNode operands. 105 BumpPtrAllocator OperandAllocator; 106 107 /// Allocator - Pool allocation for misc. objects that are created once per 108 /// SelectionDAG. 109 BumpPtrAllocator Allocator; 110 111 /// VerifyNode - Sanity check the given node. Aborts if it is invalid. 112 void VerifyNode(SDNode *N); 113 114 /// setGraphColorHelper - Implementation of setSubgraphColor. 115 /// Return whether we had to truncate the search. 116 /// 117 bool setSubgraphColorHelper(SDNode *N, const char *Color, DenseSet<SDNode *> &visited, 118 int level, bool &printed); 119 120public: 121 SelectionDAG(TargetLowering &tli, FunctionLoweringInfo &fli); 122 ~SelectionDAG(); 123 124 /// init - Prepare this SelectionDAG to process code in the given 125 /// MachineFunction. 126 /// 127 void init(MachineFunction &mf, MachineModuleInfo *mmi, DwarfWriter *dw); 128 129 /// clear - Clear state and free memory necessary to make this 130 /// SelectionDAG ready to process a new block. 131 /// 132 void clear(); 133 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; } 140 141 /// viewGraph - Pop up a GraphViz/gv window with the DAG rendered using 'dot'. 142 /// 143 void viewGraph(const std::string &Title); 144 void viewGraph(); 145 146#ifndef NDEBUG 147 std::map<const SDNode *, std::string> NodeGraphAttrs; 148#endif 149 150 /// clearGraphAttrs - Clear all previously defined node graph attributes. 151 /// Intended to be used from a debugging tool (eg. gdb). 152 void clearGraphAttrs(); 153 154 /// setGraphAttrs - Set graph attributes for a node. (eg. "color=red".) 155 /// 156 void setGraphAttrs(const SDNode *N, const char *Attrs); 157 158 /// getGraphAttrs - Get graph attributes for a node. (eg. "color=red".) 159 /// Used from getNodeAttributes. 160 const std::string getGraphAttrs(const SDNode *N) const; 161 162 /// setGraphColor - Convenience for setting node color attribute. 163 /// 164 void setGraphColor(const SDNode *N, const char *Color); 165 166 /// setGraphColor - Convenience for setting subgraph color attribute. 167 /// 168 void setSubgraphColor(SDNode *N, const char *Color); 169 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(); 178 } 179 180 /// getRoot - Return the root tag of the SelectionDAG. 181 /// 182 const SDValue &getRoot() const { return Root; } 183 184 /// getEntryNode - Return the token chain corresponding to the entry of the 185 /// function. 186 SDValue getEntryNode() const { 187 return SDValue(const_cast<SDNode *>(&EntryNode), 0); 188 } 189 190 /// setRoot - Set the current root tag of the SelectionDAG. 191 /// 192 const SDValue &setRoot(SDValue N) { 193 assert((!N.getNode() || N.getValueType() == MVT::Other) && 194 "DAG root value is not a chain!"); 195 return Root = N; 196 } 197 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); 203 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. 207 /// 208 /// Note that this is an involved process that may invalidate pointers into 209 /// the graph. 210 bool LegalizeTypes(); 211 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. 215 /// 216 /// Note that this is an involved process that may invalidate pointers into 217 /// the graph. 218 void Legalize(bool TypesNeedLegalizing); 219 220 /// RemoveDeadNodes - This method deletes all unreachable nodes in the 221 /// SelectionDAG. 222 void RemoveDeadNodes(); 223 224 /// DeleteNode - Remove the specified node from the system. This node must 225 /// have no referrers. 226 void DeleteNode(SDNode *N); 227 228 /// getVTList - Return an SDVTList that represents the list of values 229 /// specified. 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); 235 236 /// getNodeValueTypes - These are obsolete, use getVTList instead. 237 const MVT *getNodeValueTypes(MVT VT) { 238 return getVTList(VT).VTs; 239 } 240 const MVT *getNodeValueTypes(MVT VT1, MVT VT2) { 241 return getVTList(VT1, VT2).VTs; 242 } 243 const MVT *getNodeValueTypes(MVT VT1, MVT VT2, MVT VT3) { 244 return getVTList(VT1, VT2, VT3).VTs; 245 } 246 const MVT *getNodeValueTypes(MVT VT1, MVT VT2, MVT VT3, MVT VT4) { 247 return getVTList(VT1, VT2, VT3, VT4).VTs; 248 } 249 const MVT *getNodeValueTypes(const std::vector<MVT> &vtList) { 250 return getVTList(&vtList[0], (unsigned)vtList.size()).VTs; 251 } 252 253 254 //===--------------------------------------------------------------------===// 255 // Node creation methods. 256 // 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); 263 } 264 SDValue getTargetConstant(const APInt &Val, MVT VT) { 265 return getConstant(Val, VT, true); 266 } 267 SDValue getTargetConstant(const ConstantInt &Val, MVT VT) { 268 return getConstant(Val, VT, true); 269 } 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); 275 } 276 SDValue getTargetConstantFP(const APFloat& Val, MVT VT) { 277 return getConstantFP(Val, VT, true); 278 } 279 SDValue getTargetConstantFP(const ConstantFP &Val, MVT VT) { 280 return getConstantFP(Val, VT, true); 281 } 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); 287 } 288 SDValue getFrameIndex(int FI, MVT VT, bool isTarget = false); 289 SDValue getTargetFrameIndex(int FI, MVT VT) { 290 return getFrameIndex(FI, VT, true); 291 } 292 SDValue getJumpTable(int JTI, MVT VT, bool isTarget = false); 293 SDValue getTargetJumpTable(int JTI, MVT VT) { 294 return getJumpTable(JTI, VT, true); 295 } 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); 301 } 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, 306 int Offset = 0) { 307 return getConstantPool(C, VT, Align, Offset, true); 308 } 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, 321 Value *CU); 322 SDValue getLabel(unsigned Opcode, DebugLoc dl, SDValue Root, 323 unsigned LabelID); 324 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); 328 } 329 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, 334 SDValue Flag) { 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); 338 } 339 340 // Similar to last getCopyToReg() except parameter Reg is a SDValue 341 SDValue getCopyToReg(SDValue Chain, DebugLoc dl, SDValue Reg, SDValue N, 342 SDValue Flag) { 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); 346 } 347 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); 352 } 353 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, 358 SDValue Flag) { 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); 362 } 363 364 SDValue getCondCode(ISD::CondCode Cond); 365 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, 369 SDValue STy, 370 SDValue Rnd, SDValue Sat, ISD::CvtCode Code); 371 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); 375 376 /// getNOT - Create a bitwise NOT operation as (XOR Val, -1). 377 SDValue getNOT(DebugLoc DL, SDValue Val, MVT VT); 378 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); 385 } 386 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, 390 SDValue InFlag) { 391 SDVTList NodeTys = getVTList(MVT::Other, MVT::Flag); 392 SmallVector<SDValue, 4> Ops; 393 Ops.push_back(Chain); 394 Ops.push_back(Op1); 395 Ops.push_back(Op2); 396 Ops.push_back(InFlag); 397 return getNode(ISD::CALLSEQ_END, NodeTys, &Ops[0], 398 (unsigned)Ops.size() - (InFlag.getNode() == 0 ? 1 : 0)); 399 } 400 401 /// getNode - Gets or creates the specified node. 402 /// 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, MVT VT, SDValue N1, SDValue N2); 408 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, SDValue N1, SDValue N2); 409 SDValue getNode(unsigned Opcode, MVT VT, 410 SDValue N1, SDValue N2, SDValue N3); 411 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, 412 SDValue N1, SDValue N2, SDValue N3); 413 SDValue getNode(unsigned Opcode, MVT VT, 414 SDValue N1, SDValue N2, SDValue N3, SDValue N4); 415 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, 416 SDValue N1, SDValue N2, SDValue N3, SDValue N4); 417 SDValue getNode(unsigned Opcode, MVT VT, 418 SDValue N1, SDValue N2, SDValue N3, SDValue N4, 419 SDValue N5); 420 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, 421 SDValue N1, SDValue N2, SDValue N3, SDValue N4, 422 SDValue N5); 423 SDValue getNode(unsigned Opcode, MVT VT, 424 const SDUse *Ops, unsigned NumOps); 425 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, 426 const SDUse *Ops, unsigned NumOps); 427 SDValue getNode(unsigned Opcode, MVT VT, 428 const SDValue *Ops, unsigned NumOps); 429 SDValue getNode(unsigned Opcode, DebugLoc DL, MVT VT, 430 const SDValue *Ops, unsigned NumOps); 431 SDValue getNode(unsigned Opcode, const std::vector<MVT> &ResultTys, 432 const SDValue *Ops, unsigned NumOps); 433 SDValue getNode(unsigned Opcode, DebugLoc DL, 434 const std::vector<MVT> &ResultTys, 435 const SDValue *Ops, unsigned NumOps); 436 SDValue getNode(unsigned Opcode, const MVT *VTs, unsigned NumVTs, 437 const SDValue *Ops, unsigned NumOps); 438 SDValue getNode(unsigned Opcode, DebugLoc DL, const MVT *VTs, unsigned NumVTs, 439 const SDValue *Ops, unsigned NumOps); 440 SDValue getNode(unsigned Opcode, SDVTList VTs, 441 const SDValue *Ops, unsigned NumOps); 442 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, 443 const SDValue *Ops, unsigned NumOps); 444 445 SDValue getNode(unsigned Opcode, SDVTList VTs); 446 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs); 447 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N); 448 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, SDValue N); 449 SDValue getNode(unsigned Opcode, SDVTList VTs, SDValue N1, SDValue N2); 450 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, 451 SDValue N1, SDValue N2); 452 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, 453 SDValue N1, SDValue N2, SDValue N3); 454 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, 455 SDValue N1, SDValue N2, SDValue N3, SDValue N4); 456 SDValue getNode(unsigned Opcode, DebugLoc DL, SDVTList VTs, 457 SDValue N1, SDValue N2, SDValue N3, SDValue N4, 458 SDValue N5); 459 460 SDValue getMemcpy(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src, 461 SDValue Size, unsigned Align, bool AlwaysInline, 462 const Value *DstSV, uint64_t DstSVOff, 463 const Value *SrcSV, uint64_t SrcSVOff); 464 465 SDValue getMemmove(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src, 466 SDValue Size, unsigned Align, 467 const Value *DstSV, uint64_t DstOSVff, 468 const Value *SrcSV, uint64_t SrcSVOff); 469 470 SDValue getMemset(SDValue Chain, DebugLoc dl, SDValue Dst, SDValue Src, 471 SDValue Size, unsigned Align, 472 const Value *DstSV, uint64_t DstSVOff); 473 474 /// getSetCC - Helper function to make it easier to build SetCC's if you just 475 /// have an ISD::CondCode instead of an SDValue. 476 /// 477 SDValue getSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS, 478 ISD::CondCode Cond) { 479 return getNode(ISD::SETCC, DL, VT, LHS, RHS, getCondCode(Cond)); 480 } 481 482 /// getVSetCC - Helper function to make it easier to build VSetCC's nodes 483 /// if you just have an ISD::CondCode instead of an SDValue. 484 /// 485 SDValue getVSetCC(DebugLoc DL, MVT VT, SDValue LHS, SDValue RHS, 486 ISD::CondCode Cond) { 487 return getNode(ISD::VSETCC, DL, VT, LHS, RHS, getCondCode(Cond)); 488 } 489 490 /// getSelectCC - Helper function to make it easier to build SelectCC's if you 491 /// just have an ISD::CondCode instead of an SDValue. 492 /// 493 SDValue getSelectCC(DebugLoc DL, SDValue LHS, SDValue RHS, 494 SDValue True, SDValue False, ISD::CondCode Cond) { 495 return getNode(ISD::SELECT_CC, DL, True.getValueType(), 496 LHS, RHS, True, False, getCondCode(Cond)); 497 } 498 499 /// getVAArg - VAArg produces a result and token chain, and takes a pointer 500 /// and a source value as input. 501 SDValue getVAArg(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr, 502 SDValue SV); 503 504 /// getAtomic - Gets a node for an atomic op, produces result and chain and 505 /// takes 3 operands 506 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain, 507 SDValue Ptr, SDValue Cmp, SDValue Swp, const Value* PtrVal, 508 unsigned Alignment=0); 509 510 /// getAtomic - Gets a node for an atomic op, produces result and chain and 511 /// takes 2 operands. 512 SDValue getAtomic(unsigned Opcode, DebugLoc dl, MVT MemVT, SDValue Chain, 513 SDValue Ptr, SDValue Val, const Value* PtrVal, 514 unsigned Alignment = 0); 515 516 /// getMemIntrinsicNode - Creates a MemIntrinsicNode that may produce a 517 /// result and takes a list of operands. 518 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, 519 const MVT *VTs, unsigned NumVTs, 520 const SDValue *Ops, unsigned NumOps, 521 MVT MemVT, const Value *srcValue, int SVOff, 522 unsigned Align = 0, bool Vol = false, 523 bool ReadMem = true, bool WriteMem = true); 524 525 SDValue getMemIntrinsicNode(unsigned Opcode, DebugLoc dl, SDVTList VTList, 526 const SDValue *Ops, unsigned NumOps, 527 MVT MemVT, const Value *srcValue, int SVOff, 528 unsigned Align = 0, bool Vol = false, 529 bool ReadMem = true, bool WriteMem = true); 530 531 /// getMergeValues - Create a MERGE_VALUES node from the given operands. 532 SDValue getMergeValues(const SDValue *Ops, unsigned NumOps, DebugLoc dl); 533 534 /// getCall - Create a CALL node from the given information. 535 /// 536 SDValue getCall(unsigned CallingConv, DebugLoc dl, bool IsVarArgs, 537 bool IsTailCall, bool isInreg, SDVTList VTs, 538 const SDValue *Operands, unsigned NumOperands); 539 540 /// getLoad - Loads are not normal binary operators: their result type is not 541 /// determined by their operands, and they produce a value AND a token chain. 542 /// 543 SDValue getLoad(MVT VT, DebugLoc dl, SDValue Chain, SDValue Ptr, 544 const Value *SV, int SVOffset, bool isVolatile=false, 545 unsigned Alignment=0); 546 SDValue getExtLoad(ISD::LoadExtType ExtType, DebugLoc dl, MVT VT, 547 SDValue Chain, SDValue Ptr, const Value *SV, 548 int SVOffset, MVT EVT, bool isVolatile=false, 549 unsigned Alignment=0); 550 SDValue getIndexedLoad(SDValue OrigLoad, DebugLoc dl, SDValue Base, 551 SDValue Offset, ISD::MemIndexedMode AM); 552 SDValue getLoad(ISD::MemIndexedMode AM, DebugLoc dl, ISD::LoadExtType ExtType, 553 MVT VT, SDValue Chain, 554 SDValue Ptr, SDValue Offset, 555 const Value *SV, int SVOffset, MVT EVT, 556 bool isVolatile=false, unsigned Alignment=0); 557 558 /// getStore - Helper function to build ISD::STORE nodes. 559 /// 560 SDValue getStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr, 561 const Value *SV, int SVOffset, bool isVolatile=false, 562 unsigned Alignment=0); 563 SDValue getTruncStore(SDValue Chain, DebugLoc dl, SDValue Val, SDValue Ptr, 564 const Value *SV, int SVOffset, MVT TVT, 565 bool isVolatile=false, unsigned Alignment=0); 566 SDValue getIndexedStore(SDValue OrigStoe, DebugLoc dl, SDValue Base, 567 SDValue Offset, ISD::MemIndexedMode AM); 568 569 /// getSrcValue - Construct a node to track a Value* through the backend. 570 SDValue getSrcValue(const Value *v); 571 572 /// getMemOperand - Construct a node to track a memory reference 573 /// through the backend. 574 SDValue getMemOperand(const MachineMemOperand &MO); 575 576 /// getShiftAmountOperand - Return the specified value casted to 577 /// the target's desired shift amount type. 578 SDValue getShiftAmountOperand(SDValue Op); 579 580 /// UpdateNodeOperands - *Mutate* the specified node in-place to have the 581 /// specified operands. If the resultant node already exists in the DAG, 582 /// this does not modify the specified node, instead it returns the node that 583 /// already exists. If the resultant node does not exist in the DAG, the 584 /// input node is returned. As a degenerate case, if you specify the same 585 /// input operands as the node already has, the input node is returned. 586 SDValue UpdateNodeOperands(SDValue N, SDValue Op); 587 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2); 588 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2, 589 SDValue Op3); 590 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2, 591 SDValue Op3, SDValue Op4); 592 SDValue UpdateNodeOperands(SDValue N, SDValue Op1, SDValue Op2, 593 SDValue Op3, SDValue Op4, SDValue Op5); 594 SDValue UpdateNodeOperands(SDValue N, 595 const SDValue *Ops, unsigned NumOps); 596 597 /// SelectNodeTo - These are used for target selectors to *mutate* the 598 /// specified node to have the specified return type, Target opcode, and 599 /// operands. Note that target opcodes are stored as 600 /// ~TargetOpcode in the node opcode field. The resultant node is returned. 601 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT); 602 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, SDValue Op1); 603 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, 604 SDValue Op1, SDValue Op2); 605 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, 606 SDValue Op1, SDValue Op2, SDValue Op3); 607 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT, 608 const SDValue *Ops, unsigned NumOps); 609 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, MVT VT2); 610 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, 611 MVT VT2, const SDValue *Ops, unsigned NumOps); 612 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, 613 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps); 614 SDNode *SelectNodeTo(SDNode *N, unsigned MachineOpc, MVT VT1, 615 MVT VT2, MVT VT3, MVT VT4, const SDValue *Ops, 616 unsigned NumOps); 617 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, 618 MVT VT2, SDValue Op1); 619 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, 620 MVT VT2, SDValue Op1, SDValue Op2); 621 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, 622 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3); 623 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, MVT VT1, 624 MVT VT2, MVT VT3, SDValue Op1, SDValue Op2, SDValue Op3); 625 SDNode *SelectNodeTo(SDNode *N, unsigned TargetOpc, SDVTList VTs, 626 const SDValue *Ops, unsigned NumOps); 627 628 /// MorphNodeTo - These *mutate* the specified node to have the specified 629 /// return type, opcode, and operands. 630 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT); 631 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, SDValue Op1); 632 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, 633 SDValue Op1, SDValue Op2); 634 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, 635 SDValue Op1, SDValue Op2, SDValue Op3); 636 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT, 637 const SDValue *Ops, unsigned NumOps); 638 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, MVT VT2); 639 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, 640 MVT VT2, const SDValue *Ops, unsigned NumOps); 641 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, 642 MVT VT2, MVT VT3, const SDValue *Ops, unsigned NumOps); 643 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, 644 MVT VT2, SDValue Op1); 645 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, 646 MVT VT2, SDValue Op1, SDValue Op2); 647 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, MVT VT1, 648 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3); 649 SDNode *MorphNodeTo(SDNode *N, unsigned Opc, SDVTList VTs, 650 const SDValue *Ops, unsigned NumOps); 651 652 /// getTargetNode - These are used for target selectors to create a new node 653 /// with specified return type(s), target opcode, and operands. 654 /// 655 /// Note that getTargetNode returns the resultant node. If there is already a 656 /// node of the specified opcode and operands, it returns that node instead of 657 /// the current one. 658 SDNode *getTargetNode(unsigned Opcode, MVT VT); 659 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT); 660 661 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1); 662 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1); 663 664 SDNode *getTargetNode(unsigned Opcode, MVT VT, SDValue Op1, SDValue Op2); 665 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, SDValue Op1, 666 SDValue Op2); 667 668 SDNode *getTargetNode(unsigned Opcode, MVT VT, 669 SDValue Op1, SDValue Op2, SDValue Op3); 670 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, 671 SDValue Op1, SDValue Op2, SDValue Op3); 672 673 SDNode *getTargetNode(unsigned Opcode, MVT VT, 674 const SDValue *Ops, unsigned NumOps); 675 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT, 676 const SDValue *Ops, unsigned NumOps); 677 678 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2); 679 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2); 680 681 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, SDValue Op1); 682 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, 683 SDValue Op1); 684 685 SDNode *getTargetNode(unsigned Opcode, MVT VT1, 686 MVT VT2, SDValue Op1, SDValue Op2); 687 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, 688 MVT VT2, SDValue Op1, SDValue Op2); 689 690 SDNode *getTargetNode(unsigned Opcode, MVT VT1, 691 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3); 692 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, 693 MVT VT2, SDValue Op1, SDValue Op2, SDValue Op3); 694 695 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, 696 const SDValue *Ops, unsigned NumOps); 697 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, 698 const SDValue *Ops, unsigned NumOps); 699 700 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, 701 SDValue Op1, SDValue Op2); 702 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3, 703 SDValue Op1, SDValue Op2); 704 705 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, 706 SDValue Op1, SDValue Op2, SDValue Op3); 707 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3, 708 SDValue Op1, SDValue Op2, SDValue Op3); 709 710 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, 711 const SDValue *Ops, unsigned NumOps); 712 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3, 713 const SDValue *Ops, unsigned NumOps); 714 715 SDNode *getTargetNode(unsigned Opcode, MVT VT1, MVT VT2, MVT VT3, MVT VT4, 716 const SDValue *Ops, unsigned NumOps); 717 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, MVT VT1, MVT VT2, MVT VT3, 718 MVT VT4, const SDValue *Ops, unsigned NumOps); 719 720 SDNode *getTargetNode(unsigned Opcode, const std::vector<MVT> &ResultTys, 721 const SDValue *Ops, unsigned NumOps); 722 SDNode *getTargetNode(unsigned Opcode, DebugLoc dl, 723 const std::vector<MVT> &ResultTys, const SDValue *Ops, 724 unsigned NumOps); 725 726 /// getNodeIfExists - Get the specified node if it's already available, or 727 /// else return NULL. 728 SDNode *getNodeIfExists(unsigned Opcode, SDVTList VTs, 729 const SDValue *Ops, unsigned NumOps); 730 731 /// DAGUpdateListener - Clients of various APIs that cause global effects on 732 /// the DAG can optionally implement this interface. This allows the clients 733 /// to handle the various sorts of updates that happen. 734 class DAGUpdateListener { 735 public: 736 virtual ~DAGUpdateListener(); 737 738 /// NodeDeleted - The node N that was deleted and, if E is not null, an 739 /// equivalent node E that replaced it. 740 virtual void NodeDeleted(SDNode *N, SDNode *E) = 0; 741 742 /// NodeUpdated - The node N that was updated. 743 virtual void NodeUpdated(SDNode *N) = 0; 744 }; 745 746 /// RemoveDeadNode - Remove the specified node from the system. If any of its 747 /// operands then becomes dead, remove them as well. Inform UpdateListener 748 /// for each node deleted. 749 void RemoveDeadNode(SDNode *N, DAGUpdateListener *UpdateListener = 0); 750 751 /// RemoveDeadNodes - This method deletes the unreachable nodes in the 752 /// given list, and any nodes that become unreachable as a result. 753 void RemoveDeadNodes(SmallVectorImpl<SDNode *> &DeadNodes, 754 DAGUpdateListener *UpdateListener = 0); 755 756 /// ReplaceAllUsesWith - Modify anything using 'From' to use 'To' instead. 757 /// This can cause recursive merging of nodes in the DAG. Use the first 758 /// version if 'From' is known to have a single result, use the second 759 /// if you have two nodes with identical results, use the third otherwise. 760 /// 761 /// These methods all take an optional UpdateListener, which (if not null) is 762 /// informed about nodes that are deleted and modified due to recursive 763 /// changes in the dag. 764 /// 765 /// These functions only replace all existing uses. It's possible that as 766 /// these replacements are being performed, CSE may cause the From node 767 /// to be given new uses. These new uses of From are left in place, and 768 /// not automatically transfered to To. 769 /// 770 void ReplaceAllUsesWith(SDValue From, SDValue Op, 771 DAGUpdateListener *UpdateListener = 0); 772 void ReplaceAllUsesWith(SDNode *From, SDNode *To, 773 DAGUpdateListener *UpdateListener = 0); 774 void ReplaceAllUsesWith(SDNode *From, const SDValue *To, 775 DAGUpdateListener *UpdateListener = 0); 776 777 /// ReplaceAllUsesOfValueWith - Replace any uses of From with To, leaving 778 /// uses of other values produced by From.Val alone. 779 void ReplaceAllUsesOfValueWith(SDValue From, SDValue To, 780 DAGUpdateListener *UpdateListener = 0); 781 782 /// ReplaceAllUsesOfValuesWith - Like ReplaceAllUsesOfValueWith, but 783 /// for multiple values at once. This correctly handles the case where 784 /// there is an overlap between the From values and the To values. 785 void ReplaceAllUsesOfValuesWith(const SDValue *From, const SDValue *To, 786 unsigned Num, 787 DAGUpdateListener *UpdateListener = 0); 788 789 /// AssignTopologicalOrder - Topological-sort the AllNodes list and a 790 /// assign a unique node id for each node in the DAG based on their 791 /// topological order. Returns the number of nodes. 792 unsigned AssignTopologicalOrder(); 793 794 /// RepositionNode - Move node N in the AllNodes list to be immediately 795 /// before the given iterator Position. This may be used to update the 796 /// topological ordering when the list of nodes is modified. 797 void RepositionNode(allnodes_iterator Position, SDNode *N) { 798 AllNodes.insert(Position, AllNodes.remove(N)); 799 } 800 801 /// isCommutativeBinOp - Returns true if the opcode is a commutative binary 802 /// operation. 803 static bool isCommutativeBinOp(unsigned Opcode) { 804 // FIXME: This should get its info from the td file, so that we can include 805 // target info. 806 switch (Opcode) { 807 case ISD::ADD: 808 case ISD::MUL: 809 case ISD::MULHU: 810 case ISD::MULHS: 811 case ISD::SMUL_LOHI: 812 case ISD::UMUL_LOHI: 813 case ISD::FADD: 814 case ISD::FMUL: 815 case ISD::AND: 816 case ISD::OR: 817 case ISD::XOR: 818 case ISD::ADDC: 819 case ISD::ADDE: return true; 820 default: return false; 821 } 822 } 823 824 void dump() const; 825 826 /// CreateStackTemporary - Create a stack temporary, suitable for holding the 827 /// specified value type. If minAlign is specified, the slot size will have 828 /// at least that alignment. 829 SDValue CreateStackTemporary(MVT VT, unsigned minAlign = 1); 830 831 /// CreateStackTemporary - Create a stack temporary suitable for holding 832 /// either of the specified value types. 833 SDValue CreateStackTemporary(MVT VT1, MVT VT2); 834 835 /// FoldConstantArithmetic - 836 SDValue FoldConstantArithmetic(unsigned Opcode, 837 MVT VT, 838 ConstantSDNode *Cst1, 839 ConstantSDNode *Cst2); 840 841 /// FoldSetCC - Constant fold a setcc to true or false. 842 SDValue FoldSetCC(MVT VT, SDValue N1, 843 SDValue N2, ISD::CondCode Cond, DebugLoc dl); 844 845 /// SignBitIsZero - Return true if the sign bit of Op is known to be zero. We 846 /// use this predicate to simplify operations downstream. 847 bool SignBitIsZero(SDValue Op, unsigned Depth = 0) const; 848 849 /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero. We 850 /// use this predicate to simplify operations downstream. Op and Mask are 851 /// known to be the same type. 852 bool MaskedValueIsZero(SDValue Op, const APInt &Mask, unsigned Depth = 0) 853 const; 854 855 /// ComputeMaskedBits - Determine which of the bits specified in Mask are 856 /// known to be either zero or one and return them in the KnownZero/KnownOne 857 /// bitsets. This code only analyzes bits in Mask, in order to short-circuit 858 /// processing. Targets can implement the computeMaskedBitsForTargetNode 859 /// method in the TargetLowering class to allow target nodes to be understood. 860 void ComputeMaskedBits(SDValue Op, const APInt &Mask, APInt &KnownZero, 861 APInt &KnownOne, unsigned Depth = 0) const; 862 863 /// ComputeNumSignBits - Return the number of times the sign bit of the 864 /// register is replicated into the other bits. We know that at least 1 bit 865 /// is always equal to the sign bit (itself), but other cases can give us 866 /// information. For example, immediately after an "SRA X, 2", we know that 867 /// the top 3 bits are all equal to each other, so we return 3. Targets can 868 /// implement the ComputeNumSignBitsForTarget method in the TargetLowering 869 /// class to allow target nodes to be understood. 870 unsigned ComputeNumSignBits(SDValue Op, unsigned Depth = 0) const; 871 872 /// isVerifiedDebugInfoDesc - Returns true if the specified SDValue has 873 /// been verified as a debug information descriptor. 874 bool isVerifiedDebugInfoDesc(SDValue Op) const; 875 876 /// getShuffleScalarElt - Returns the scalar element that will make up the ith 877 /// element of the result of the vector shuffle. 878 SDValue getShuffleScalarElt(const SDNode *N, unsigned Idx); 879 880private: 881 bool RemoveNodeFromCSEMaps(SDNode *N); 882 void AddModifiedNodeToCSEMaps(SDNode *N, DAGUpdateListener *UpdateListener); 883 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op, void *&InsertPos); 884 SDNode *FindModifiedNodeSlot(SDNode *N, SDValue Op1, SDValue Op2, 885 void *&InsertPos); 886 SDNode *FindModifiedNodeSlot(SDNode *N, const SDValue *Ops, unsigned NumOps, 887 void *&InsertPos); 888 889 void DeleteNodeNotInCSEMaps(SDNode *N); 890 void DeallocateNode(SDNode *N); 891 892 unsigned getMVTAlignment(MVT MemoryVT) const; 893 894 void allnodes_clear(); 895 896 /// VTList - List of non-single value types. 897 std::vector<SDVTList> VTList; 898 899 /// CondCodeNodes - Maps to auto-CSE operations. 900 std::vector<CondCodeSDNode*> CondCodeNodes; 901 902 std::vector<SDNode*> ValueTypeNodes; 903 std::map<MVT, SDNode*, MVT::compareRawBits> ExtendedValueTypeNodes; 904 StringMap<SDNode*> ExternalSymbols; 905 StringMap<SDNode*> TargetExternalSymbols; 906}; 907 908template <> struct GraphTraits<SelectionDAG*> : public GraphTraits<SDNode*> { 909 typedef SelectionDAG::allnodes_iterator nodes_iterator; 910 static nodes_iterator nodes_begin(SelectionDAG *G) { 911 return G->allnodes_begin(); 912 } 913 static nodes_iterator nodes_end(SelectionDAG *G) { 914 return G->allnodes_end(); 915 } 916}; 917 918} // end namespace llvm 919 920#endif 921