include/llvm/CodeGen/MachineRegisterInfo.h

   1 //===-- llvm/CodeGen/MachineRegisterInfo.h ----------------------*- 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 defines the MachineRegisterInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CODEGEN_MACHINEREGISTERINFO_H
  15 #define LLVM_CODEGEN_MACHINEREGISTERINFO_H
  16
  17 #include "llvm/ADT/BitVector.h"
  18 #include "llvm/ADT/IndexedMap.h"
  19 #include "llvm/ADT/iterator_range.h"
  20 #include "llvm/CodeGen/MachineFunction.h"
  21 #include "llvm/CodeGen/MachineInstrBundle.h"
  22 #include "llvm/Target/TargetRegisterInfo.h"
  23 #include "llvm/Target/TargetSubtargetInfo.h"
  24 #include <vector>
  25
  26 namespace llvm {
  27 class PSetIterator;
  28
  29 /// MachineRegisterInfo - Keep track of information for virtual and physical
  30 /// registers, including vreg register classes, use/def chains for registers,
  31 /// etc.
  32 class MachineRegisterInfo {
  33 public:
  34   class Delegate {
  35     virtual void anchor();
  36   public:
  37     virtual void MRI_NoteNewVirtualRegister(unsigned Reg) = 0;
  38
  39     virtual ~Delegate() {}
  40   };
  41
  42 private:
  43   const MachineFunction *MF;
  44   Delegate *TheDelegate;
  45
  46   /// IsSSA - True when the machine function is in SSA form and virtual
  47   /// registers have a single def.
  48   bool IsSSA;
  49
  50   /// TracksLiveness - True while register liveness is being tracked accurately.
  51   /// Basic block live-in lists, kill flags, and implicit defs may not be
  52   /// accurate when after this flag is cleared.
  53   bool TracksLiveness;
  54
  55   /// True if subregister liveness is tracked.
  56   bool TracksSubRegLiveness;
  57
  58   /// VRegInfo - Information we keep for each virtual register.
  59   ///
  60   /// Each element in this list contains the register class of the vreg and the
  61   /// start of the use/def list for the register.
  62   IndexedMap<std::pair<const TargetRegisterClass*, MachineOperand*>,
  63              VirtReg2IndexFunctor> VRegInfo;
  64
  65   /// RegAllocHints - This vector records register allocation hints for virtual
  66   /// registers. For each virtual register, it keeps a register and hint type
  67   /// pair making up the allocation hint. Hint type is target specific except
  68   /// for the value 0 which means the second value of the pair is the preferred
  69   /// register for allocation. For example, if the hint is <0, 1024>, it means
  70   /// the allocator should prefer the physical register allocated to the virtual
  71   /// register of the hint.
  72   IndexedMap<std::pair<unsigned, unsigned>, VirtReg2IndexFunctor> RegAllocHints;
  73
  74   /// PhysRegUseDefLists - This is an array of the head of the use/def list for
  75   /// physical registers.
  76   std::vector<MachineOperand *> PhysRegUseDefLists;
  77
  78   /// getRegUseDefListHead - Return the head pointer for the register use/def
  79   /// list for the specified virtual or physical register.
  80   MachineOperand *&getRegUseDefListHead(unsigned RegNo) {
  81     if (TargetRegisterInfo::isVirtualRegister(RegNo))
  82       return VRegInfo[RegNo].second;
  83     return PhysRegUseDefLists[RegNo];
  84   }
  85
  86   MachineOperand *getRegUseDefListHead(unsigned RegNo) const {
  87     if (TargetRegisterInfo::isVirtualRegister(RegNo))
  88       return VRegInfo[RegNo].second;
  89     return PhysRegUseDefLists[RegNo];
  90   }
  91
  92   /// Get the next element in the use-def chain.
  93   static MachineOperand *getNextOperandForReg(const MachineOperand *MO) {
  94     assert(MO && MO->isReg() && "This is not a register operand!");
  95     return MO->Contents.Reg.Next;
  96   }
  97
  98   /// UsedRegUnits - This is a bit vector that is computed and set by the
  99   /// register allocator, and must be kept up to date by passes that run after
 100   /// register allocation (though most don't modify this).  This is used
 101   /// so that the code generator knows which callee save registers to save and
 102   /// for other target specific uses.
 103   /// This vector has bits set for register units that are modified in the
 104   /// current function. It doesn't include registers clobbered by function
 105   /// calls with register mask operands.
 106   BitVector UsedRegUnits;
 107
 108   /// UsedPhysRegMask - Additional used physregs including aliases.
 109   /// This bit vector represents all the registers clobbered by function calls.
 110   /// It can model things that UsedRegUnits can't, such as function calls that
 111   /// clobber ymm7 but preserve the low half in xmm7.
 112   BitVector UsedPhysRegMask;
 113
 114   /// ReservedRegs - This is a bit vector of reserved registers.  The target
 115   /// may change its mind about which registers should be reserved.  This
 116   /// vector is the frozen set of reserved registers when register allocation
 117   /// started.
 118   BitVector ReservedRegs;
 119
 120   /// Keep track of the physical registers that are live in to the function.
 121   /// Live in values are typically arguments in registers.  LiveIn values are
 122   /// allowed to have virtual registers associated with them, stored in the
 123   /// second element.
 124   std::vector<std::pair<unsigned, unsigned> > LiveIns;
 125
 126   MachineRegisterInfo(const MachineRegisterInfo&) = delete;
 127   void operator=(const MachineRegisterInfo&) = delete;
 128 public:
 129   explicit MachineRegisterInfo(const MachineFunction *MF);
 130
 131   const TargetRegisterInfo *getTargetRegisterInfo() const {
 132     return MF->getSubtarget().getRegisterInfo();
 133   }
 134
 135   void resetDelegate(Delegate *delegate) {
 136     // Ensure another delegate does not take over unless the current
 137     // delegate first unattaches itself. If we ever need to multicast
 138     // notifications, we will need to change to using a list.
 139     assert(TheDelegate == delegate &&
 140            "Only the current delegate can perform reset!");
 141     TheDelegate = nullptr;
 142   }
 143
 144   void setDelegate(Delegate *delegate) {
 145     assert(delegate && !TheDelegate &&
 146            "Attempted to set delegate to null, or to change it without "
 147            "first resetting it!");
 148
 149     TheDelegate = delegate;
 150   }
 151
 152   //===--------------------------------------------------------------------===//
 153   // Function State
 154   //===--------------------------------------------------------------------===//
 155
 156   // isSSA - Returns true when the machine function is in SSA form. Early
 157   // passes require the machine function to be in SSA form where every virtual
 158   // register has a single defining instruction.
 159   //
 160   // The TwoAddressInstructionPass and PHIElimination passes take the machine
 161   // function out of SSA form when they introduce multiple defs per virtual
 162   // register.
 163   bool isSSA() const { return IsSSA; }
 164
 165   // leaveSSA - Indicates that the machine function is no longer in SSA form.
 166   void leaveSSA() { IsSSA = false; }
 167
 168   /// tracksLiveness - Returns true when tracking register liveness accurately.
 169   ///
 170   /// While this flag is true, register liveness information in basic block
 171   /// live-in lists and machine instruction operands is accurate. This means it
 172   /// can be used to change the code in ways that affect the values in
 173   /// registers, for example by the register scavenger.
 174   ///
 175   /// When this flag is false, liveness is no longer reliable.
 176   bool tracksLiveness() const { return TracksLiveness; }
 177
 178   /// invalidateLiveness - Indicates that register liveness is no longer being
 179   /// tracked accurately.
 180   ///
 181   /// This should be called by late passes that invalidate the liveness
 182   /// information.
 183   void invalidateLiveness() { TracksLiveness = false; }
 184
 185   /// Returns true if liveness for register class @p RC should be tracked at
 186   /// the subregister level.
 187   bool shouldTrackSubRegLiveness(const TargetRegisterClass &RC) const {
 188     return subRegLivenessEnabled() && RC.HasDisjunctSubRegs;
 189   }
 190   bool shouldTrackSubRegLiveness(unsigned VReg) const {
 191     assert(TargetRegisterInfo::isVirtualRegister(VReg) && "Must pass a VReg");
 192     return shouldTrackSubRegLiveness(*getRegClass(VReg));
 193   }
 194   bool subRegLivenessEnabled() const {
 195     return TracksSubRegLiveness;
 196   }
 197
 198   void enableSubRegLiveness(bool Enable = true) {
 199     TracksSubRegLiveness = Enable;
 200   }
 201
 202   //===--------------------------------------------------------------------===//
 203   // Register Info
 204   //===--------------------------------------------------------------------===//
 205
 206   // Strictly for use by MachineInstr.cpp.
 207   void addRegOperandToUseList(MachineOperand *MO);
 208
 209   // Strictly for use by MachineInstr.cpp.
 210   void removeRegOperandFromUseList(MachineOperand *MO);
 211
 212   // Strictly for use by MachineInstr.cpp.
 213   void moveOperands(MachineOperand *Dst, MachineOperand *Src, unsigned NumOps);
 214
 215   /// Verify the sanity of the use list for Reg.
 216   void verifyUseList(unsigned Reg) const;
 217
 218   /// Verify the use list of all registers.
 219   void verifyUseLists() const;
 220
 221   /// reg_begin/reg_end - Provide iteration support to walk over all definitions
 222   /// and uses of a register within the MachineFunction that corresponds to this
 223   /// MachineRegisterInfo object.
 224   template<bool Uses, bool Defs, bool SkipDebug,
 225            bool ByOperand, bool ByInstr, bool ByBundle>
 226   class defusechain_iterator;
 227   template<bool Uses, bool Defs, bool SkipDebug,
 228            bool ByOperand, bool ByInstr, bool ByBundle>
 229   class defusechain_instr_iterator;
 230
 231   // Make it a friend so it can access getNextOperandForReg().
 232   template<bool, bool, bool, bool, bool, bool>
 233     friend class defusechain_iterator;
 234   template<bool, bool, bool, bool, bool, bool>
 235     friend class defusechain_instr_iterator;
 236
 237
 238
 239   /// reg_iterator/reg_begin/reg_end - Walk all defs and uses of the specified
 240   /// register.
 241   typedef defusechain_iterator<true,true,false,true,false,false>
 242           reg_iterator;
 243   reg_iterator reg_begin(unsigned RegNo) const {
 244     return reg_iterator(getRegUseDefListHead(RegNo));
 245   }
 246   static reg_iterator reg_end() { return reg_iterator(nullptr); }
 247
 248   inline iterator_range<reg_iterator>  reg_operands(unsigned Reg) const {
 249     return iterator_range<reg_iterator>(reg_begin(Reg), reg_end());
 250   }
 251
 252   /// reg_instr_iterator/reg_instr_begin/reg_instr_end - Walk all defs and uses
 253   /// of the specified register, stepping by MachineInstr.
 254   typedef defusechain_instr_iterator<true,true,false,false,true,false>
 255           reg_instr_iterator;
 256   reg_instr_iterator reg_instr_begin(unsigned RegNo) const {
 257     return reg_instr_iterator(getRegUseDefListHead(RegNo));
 258   }
 259   static reg_instr_iterator reg_instr_end() {
 260     return reg_instr_iterator(nullptr);
 261   }
 262
 263   inline iterator_range<reg_instr_iterator>
 264   reg_instructions(unsigned Reg) const {
 265     return iterator_range<reg_instr_iterator>(reg_instr_begin(Reg),
 266                                               reg_instr_end());
 267   }
 268
 269   /// reg_bundle_iterator/reg_bundle_begin/reg_bundle_end - Walk all defs and uses
 270   /// of the specified register, stepping by bundle.
 271   typedef defusechain_instr_iterator<true,true,false,false,false,true>
 272           reg_bundle_iterator;
 273   reg_bundle_iterator reg_bundle_begin(unsigned RegNo) const {
 274     return reg_bundle_iterator(getRegUseDefListHead(RegNo));
 275   }
 276   static reg_bundle_iterator reg_bundle_end() {
 277     return reg_bundle_iterator(nullptr);
 278   }
 279
 280   inline iterator_range<reg_bundle_iterator> reg_bundles(unsigned Reg) const {
 281     return iterator_range<reg_bundle_iterator>(reg_bundle_begin(Reg),
 282                                                reg_bundle_end());
 283   }
 284
 285   /// reg_empty - Return true if there are no instructions using or defining the
 286   /// specified register (it may be live-in).
 287   bool reg_empty(unsigned RegNo) const { return reg_begin(RegNo) == reg_end(); }
 288
 289   /// reg_nodbg_iterator/reg_nodbg_begin/reg_nodbg_end - Walk all defs and uses
 290   /// of the specified register, skipping those marked as Debug.
 291   typedef defusechain_iterator<true,true,true,true,false,false>
 292           reg_nodbg_iterator;
 293   reg_nodbg_iterator reg_nodbg_begin(unsigned RegNo) const {
 294     return reg_nodbg_iterator(getRegUseDefListHead(RegNo));
 295   }
 296   static reg_nodbg_iterator reg_nodbg_end() {
 297     return reg_nodbg_iterator(nullptr);
 298   }
 299
 300   inline iterator_range<reg_nodbg_iterator>
 301   reg_nodbg_operands(unsigned Reg) const {
 302     return iterator_range<reg_nodbg_iterator>(reg_nodbg_begin(Reg),
 303                                               reg_nodbg_end());
 304   }
 305
 306   /// reg_instr_nodbg_iterator/reg_instr_nodbg_begin/reg_instr_nodbg_end - Walk
 307   /// all defs and uses of the specified register, stepping by MachineInstr,
 308   /// skipping those marked as Debug.
 309   typedef defusechain_instr_iterator<true,true,true,false,true,false>
 310           reg_instr_nodbg_iterator;
 311   reg_instr_nodbg_iterator reg_instr_nodbg_begin(unsigned RegNo) const {
 312     return reg_instr_nodbg_iterator(getRegUseDefListHead(RegNo));
 313   }
 314   static reg_instr_nodbg_iterator reg_instr_nodbg_end() {
 315     return reg_instr_nodbg_iterator(nullptr);
 316   }
 317
 318   inline iterator_range<reg_instr_nodbg_iterator>
 319   reg_nodbg_instructions(unsigned Reg) const {
 320     return iterator_range<reg_instr_nodbg_iterator>(reg_instr_nodbg_begin(Reg),
 321                                                     reg_instr_nodbg_end());
 322   }
 323
 324   /// reg_bundle_nodbg_iterator/reg_bundle_nodbg_begin/reg_bundle_nodbg_end - Walk
 325   /// all defs and uses of the specified register, stepping by bundle,
 326   /// skipping those marked as Debug.
 327   typedef defusechain_instr_iterator<true,true,true,false,false,true>
 328           reg_bundle_nodbg_iterator;
 329   reg_bundle_nodbg_iterator reg_bundle_nodbg_begin(unsigned RegNo) const {
 330     return reg_bundle_nodbg_iterator(getRegUseDefListHead(RegNo));
 331   }
 332   static reg_bundle_nodbg_iterator reg_bundle_nodbg_end() {
 333     return reg_bundle_nodbg_iterator(nullptr);
 334   }
 335
 336   inline iterator_range<reg_bundle_nodbg_iterator>
 337   reg_nodbg_bundles(unsigned Reg) const {
 338     return iterator_range<reg_bundle_nodbg_iterator>(reg_bundle_nodbg_begin(Reg),
 339                                                      reg_bundle_nodbg_end());
 340   }
 341
 342   /// reg_nodbg_empty - Return true if the only instructions using or defining
 343   /// Reg are Debug instructions.
 344   bool reg_nodbg_empty(unsigned RegNo) const {
 345     return reg_nodbg_begin(RegNo) == reg_nodbg_end();
 346   }
 347
 348   /// def_iterator/def_begin/def_end - Walk all defs of the specified register.
 349   typedef defusechain_iterator<false,true,false,true,false,false>
 350           def_iterator;
 351   def_iterator def_begin(unsigned RegNo) const {
 352     return def_iterator(getRegUseDefListHead(RegNo));
 353   }
 354   static def_iterator def_end() { return def_iterator(nullptr); }
 355
 356   inline iterator_range<def_iterator> def_operands(unsigned Reg) const {
 357     return iterator_range<def_iterator>(def_begin(Reg), def_end());
 358   }
 359
 360   /// def_instr_iterator/def_instr_begin/def_instr_end - Walk all defs of the
 361   /// specified register, stepping by MachineInst.
 362   typedef defusechain_instr_iterator<false,true,false,false,true,false>
 363           def_instr_iterator;
 364   def_instr_iterator def_instr_begin(unsigned RegNo) const {
 365     return def_instr_iterator(getRegUseDefListHead(RegNo));
 366   }
 367   static def_instr_iterator def_instr_end() {
 368     return def_instr_iterator(nullptr);
 369   }
 370
 371   inline iterator_range<def_instr_iterator>
 372   def_instructions(unsigned Reg) const {
 373     return iterator_range<def_instr_iterator>(def_instr_begin(Reg),
 374                                               def_instr_end());
 375   }
 376
 377   /// def_bundle_iterator/def_bundle_begin/def_bundle_end - Walk all defs of the
 378   /// specified register, stepping by bundle.
 379   typedef defusechain_instr_iterator<false,true,false,false,false,true>
 380           def_bundle_iterator;
 381   def_bundle_iterator def_bundle_begin(unsigned RegNo) const {
 382     return def_bundle_iterator(getRegUseDefListHead(RegNo));
 383   }
 384   static def_bundle_iterator def_bundle_end() {
 385     return def_bundle_iterator(nullptr);
 386   }
 387
 388   inline iterator_range<def_bundle_iterator> def_bundles(unsigned Reg) const {
 389     return iterator_range<def_bundle_iterator>(def_bundle_begin(Reg),
 390                                                def_bundle_end());
 391   }
 392
 393   /// def_empty - Return true if there are no instructions defining the
 394   /// specified register (it may be live-in).
 395   bool def_empty(unsigned RegNo) const { return def_begin(RegNo) == def_end(); }
 396
 397   /// hasOneDef - Return true if there is exactly one instruction defining the
 398   /// specified register.
 399   bool hasOneDef(unsigned RegNo) const {
 400     def_iterator DI = def_begin(RegNo);
 401     if (DI == def_end())
 402       return false;
 403     return ++DI == def_end();
 404   }
 405
 406   /// use_iterator/use_begin/use_end - Walk all uses of the specified register.
 407   typedef defusechain_iterator<true,false,false,true,false,false>
 408           use_iterator;
 409   use_iterator use_begin(unsigned RegNo) const {
 410     return use_iterator(getRegUseDefListHead(RegNo));
 411   }
 412   static use_iterator use_end() { return use_iterator(nullptr); }
 413
 414   inline iterator_range<use_iterator> use_operands(unsigned Reg) const {
 415     return iterator_range<use_iterator>(use_begin(Reg), use_end());
 416   }
 417
 418   /// use_instr_iterator/use_instr_begin/use_instr_end - Walk all uses of the
 419   /// specified register, stepping by MachineInstr.
 420   typedef defusechain_instr_iterator<true,false,false,false,true,false>
 421           use_instr_iterator;
 422   use_instr_iterator use_instr_begin(unsigned RegNo) const {
 423     return use_instr_iterator(getRegUseDefListHead(RegNo));
 424   }
 425   static use_instr_iterator use_instr_end() {
 426     return use_instr_iterator(nullptr);
 427   }
 428
 429   inline iterator_range<use_instr_iterator>
 430   use_instructions(unsigned Reg) const {
 431     return iterator_range<use_instr_iterator>(use_instr_begin(Reg),
 432                                               use_instr_end());
 433   }
 434
 435   /// use_bundle_iterator/use_bundle_begin/use_bundle_end - Walk all uses of the
 436   /// specified register, stepping by bundle.
 437   typedef defusechain_instr_iterator<true,false,false,false,false,true>
 438           use_bundle_iterator;
 439   use_bundle_iterator use_bundle_begin(unsigned RegNo) const {
 440     return use_bundle_iterator(getRegUseDefListHead(RegNo));
 441   }
 442   static use_bundle_iterator use_bundle_end() {
 443     return use_bundle_iterator(nullptr);
 444   }
 445
 446   inline iterator_range<use_bundle_iterator> use_bundles(unsigned Reg) const {
 447     return iterator_range<use_bundle_iterator>(use_bundle_begin(Reg),
 448                                                use_bundle_end());
 449   }
 450
 451   /// use_empty - Return true if there are no instructions using the specified
 452   /// register.
 453   bool use_empty(unsigned RegNo) const { return use_begin(RegNo) == use_end(); }
 454
 455   /// hasOneUse - Return true if there is exactly one instruction using the
 456   /// specified register.
 457   bool hasOneUse(unsigned RegNo) const {
 458     use_iterator UI = use_begin(RegNo);
 459     if (UI == use_end())
 460       return false;
 461     return ++UI == use_end();
 462   }
 463
 464   /// use_nodbg_iterator/use_nodbg_begin/use_nodbg_end - Walk all uses of the
 465   /// specified register, skipping those marked as Debug.
 466   typedef defusechain_iterator<true,false,true,true,false,false>
 467           use_nodbg_iterator;
 468   use_nodbg_iterator use_nodbg_begin(unsigned RegNo) const {
 469     return use_nodbg_iterator(getRegUseDefListHead(RegNo));
 470   }
 471   static use_nodbg_iterator use_nodbg_end() {
 472     return use_nodbg_iterator(nullptr);
 473   }
 474
 475   inline iterator_range<use_nodbg_iterator>
 476   use_nodbg_operands(unsigned Reg) const {
 477     return iterator_range<use_nodbg_iterator>(use_nodbg_begin(Reg),
 478                                               use_nodbg_end());
 479   }
 480
 481   /// use_instr_nodbg_iterator/use_instr_nodbg_begin/use_instr_nodbg_end - Walk
 482   /// all uses of the specified register, stepping by MachineInstr, skipping
 483   /// those marked as Debug.
 484   typedef defusechain_instr_iterator<true,false,true,false,true,false>
 485           use_instr_nodbg_iterator;
 486   use_instr_nodbg_iterator use_instr_nodbg_begin(unsigned RegNo) const {
 487     return use_instr_nodbg_iterator(getRegUseDefListHead(RegNo));
 488   }
 489   static use_instr_nodbg_iterator use_instr_nodbg_end() {
 490     return use_instr_nodbg_iterator(nullptr);
 491   }
 492
 493   inline iterator_range<use_instr_nodbg_iterator>
 494   use_nodbg_instructions(unsigned Reg) const {
 495     return iterator_range<use_instr_nodbg_iterator>(use_instr_nodbg_begin(Reg),
 496                                                     use_instr_nodbg_end());
 497   }
 498
 499   /// use_bundle_nodbg_iterator/use_bundle_nodbg_begin/use_bundle_nodbg_end - Walk
 500   /// all uses of the specified register, stepping by bundle, skipping
 501   /// those marked as Debug.
 502   typedef defusechain_instr_iterator<true,false,true,false,false,true>
 503           use_bundle_nodbg_iterator;
 504   use_bundle_nodbg_iterator use_bundle_nodbg_begin(unsigned RegNo) const {
 505     return use_bundle_nodbg_iterator(getRegUseDefListHead(RegNo));
 506   }
 507   static use_bundle_nodbg_iterator use_bundle_nodbg_end() {
 508     return use_bundle_nodbg_iterator(nullptr);
 509   }
 510
 511   inline iterator_range<use_bundle_nodbg_iterator>
 512   use_nodbg_bundles(unsigned Reg) const {
 513     return iterator_range<use_bundle_nodbg_iterator>(use_bundle_nodbg_begin(Reg),
 514                                                      use_bundle_nodbg_end());
 515   }
 516
 517   /// use_nodbg_empty - Return true if there are no non-Debug instructions
 518   /// using the specified register.
 519   bool use_nodbg_empty(unsigned RegNo) const {
 520     return use_nodbg_begin(RegNo) == use_nodbg_end();
 521   }
 522
 523   /// hasOneNonDBGUse - Return true if there is exactly one non-Debug
 524   /// instruction using the specified register.
 525   bool hasOneNonDBGUse(unsigned RegNo) const;
 526
 527   /// replaceRegWith - Replace all instances of FromReg with ToReg in the
 528   /// machine function.  This is like llvm-level X->replaceAllUsesWith(Y),
 529   /// except that it also changes any definitions of the register as well.
 530   ///
 531   /// Note that it is usually necessary to first constrain ToReg's register
 532   /// class to match the FromReg constraints using:
 533   ///
 534   ///   constrainRegClass(ToReg, getRegClass(FromReg))
 535   ///
 536   /// That function will return NULL if the virtual registers have incompatible
 537   /// constraints.
 538   ///
 539   /// Note that if ToReg is a physical register the function will replace and
 540   /// apply sub registers to ToReg in order to obtain a final/proper physical
 541   /// register.
 542   void replaceRegWith(unsigned FromReg, unsigned ToReg);
 543
 544   /// getVRegDef - Return the machine instr that defines the specified virtual
 545   /// register or null if none is found.  This assumes that the code is in SSA
 546   /// form, so there should only be one definition.
 547   MachineInstr *getVRegDef(unsigned Reg) const;
 548
 549   /// getUniqueVRegDef - Return the unique machine instr that defines the
 550   /// specified virtual register or null if none is found.  If there are
 551   /// multiple definitions or no definition, return null.
 552   MachineInstr *getUniqueVRegDef(unsigned Reg) const;
 553
 554   /// clearKillFlags - Iterate over all the uses of the given register and
 555   /// clear the kill flag from the MachineOperand. This function is used by
 556   /// optimization passes which extend register lifetimes and need only
 557   /// preserve conservative kill flag information.
 558   void clearKillFlags(unsigned Reg) const;
 559
 560 #ifndef NDEBUG
 561   void dumpUses(unsigned RegNo) const;
 562 #endif
 563
 564   /// isConstantPhysReg - Returns true if PhysReg is unallocatable and constant
 565   /// throughout the function.  It is safe to move instructions that read such
 566   /// a physreg.
 567   bool isConstantPhysReg(unsigned PhysReg, const MachineFunction &MF) const;
 568
 569   /// Get an iterator over the pressure sets affected by the given physical or
 570   /// virtual register. If RegUnit is physical, it must be a register unit (from
 571   /// MCRegUnitIterator).
 572   PSetIterator getPressureSets(unsigned RegUnit) const;
 573
 574   //===--------------------------------------------------------------------===//
 575   // Virtual Register Info
 576   //===--------------------------------------------------------------------===//
 577
 578   /// getRegClass - Return the register class of the specified virtual register.
 579   ///
 580   const TargetRegisterClass *getRegClass(unsigned Reg) const {
 581     return VRegInfo[Reg].first;
 582   }
 583
 584   /// setRegClass - Set the register class of the specified virtual register.
 585   ///
 586   void setRegClass(unsigned Reg, const TargetRegisterClass *RC);
 587
 588   /// constrainRegClass - Constrain the register class of the specified virtual
 589   /// register to be a common subclass of RC and the current register class,
 590   /// but only if the new class has at least MinNumRegs registers.  Return the
 591   /// new register class, or NULL if no such class exists.
 592   /// This should only be used when the constraint is known to be trivial, like
 593   /// GR32 -> GR32_NOSP. Beware of increasing register pressure.
 594   ///
 595   const TargetRegisterClass *constrainRegClass(unsigned Reg,
 596                                                const TargetRegisterClass *RC,
 597                                                unsigned MinNumRegs = 0);
 598
 599   /// recomputeRegClass - Try to find a legal super-class of Reg's register
 600   /// class that still satisfies the constraints from the instructions using
 601   /// Reg.  Returns true if Reg was upgraded.
 602   ///
 603   /// This method can be used after constraints have been removed from a
 604   /// virtual register, for example after removing instructions or splitting
 605   /// the live range.
 606   ///
 607   bool recomputeRegClass(unsigned Reg);
 608
 609   /// createVirtualRegister - Create and return a new virtual register in the
 610   /// function with the specified register class.
 611   ///
 612   unsigned createVirtualRegister(const TargetRegisterClass *RegClass);
 613
 614   /// getNumVirtRegs - Return the number of virtual registers created.
 615   ///
 616   unsigned getNumVirtRegs() const { return VRegInfo.size(); }
 617
 618   /// clearVirtRegs - Remove all virtual registers (after physreg assignment).
 619   void clearVirtRegs();
 620
 621   /// setRegAllocationHint - Specify a register allocation hint for the
 622   /// specified virtual register.
 623   void setRegAllocationHint(unsigned Reg, unsigned Type, unsigned PrefReg) {
 624     RegAllocHints[Reg].first  = Type;
 625     RegAllocHints[Reg].second = PrefReg;
 626   }
 627
 628   /// getRegAllocationHint - Return the register allocation hint for the
 629   /// specified virtual register.
 630   std::pair<unsigned, unsigned>
 631   getRegAllocationHint(unsigned Reg) const {
 632     return RegAllocHints[Reg];
 633   }
 634
 635   /// getSimpleHint - Return the preferred register allocation hint, or 0 if a
 636   /// standard simple hint (Type == 0) is not set.
 637   unsigned getSimpleHint(unsigned Reg) const {
 638     std::pair<unsigned, unsigned> Hint = getRegAllocationHint(Reg);
 639     return Hint.first ? 0 : Hint.second;
 640   }
 641
 642   /// markUsesInDebugValueAsUndef - Mark every DBG_VALUE referencing the
 643   /// specified register as undefined which causes the DBG_VALUE to be
 644   /// deleted during LiveDebugVariables analysis.
 645   void markUsesInDebugValueAsUndef(unsigned Reg) const;
 646
 647   //===--------------------------------------------------------------------===//
 648   // Physical Register Use Info
 649   //===--------------------------------------------------------------------===//
 650
 651   /// isPhysRegUsed - Return true if the specified register is used in this
 652   /// function. Also check for clobbered aliases and registers clobbered by
 653   /// function calls with register mask operands.
 654   ///
 655   /// This only works after register allocation. It is primarily used by
 656   /// PrologEpilogInserter to determine which callee-saved registers need
 657   /// spilling.
 658   bool isPhysRegUsed(unsigned Reg) const {
 659     if (UsedPhysRegMask.test(Reg))
 660       return true;
 661     for (MCRegUnitIterator Units(Reg, getTargetRegisterInfo());
 662          Units.isValid(); ++Units)
 663       if (UsedRegUnits.test(*Units))
 664         return true;
 665     return false;
 666   }
 667
 668   /// Mark the specified register unit as used in this function.
 669   /// This should only be called during and after register allocation.
 670   void setRegUnitUsed(unsigned RegUnit) {
 671     UsedRegUnits.set(RegUnit);
 672   }
 673
 674   /// setPhysRegUsed - Mark the specified register used in this function.
 675   /// This should only be called during and after register allocation.
 676   void setPhysRegUsed(unsigned Reg) {
 677     for (MCRegUnitIterator Units(Reg, getTargetRegisterInfo());
 678          Units.isValid(); ++Units)
 679       UsedRegUnits.set(*Units);
 680   }
 681
 682   /// addPhysRegsUsedFromRegMask - Mark any registers not in RegMask as used.
 683   /// This corresponds to the bit mask attached to register mask operands.
 684   void addPhysRegsUsedFromRegMask(const uint32_t *RegMask) {
 685     UsedPhysRegMask.setBitsNotInMask(RegMask);
 686   }
 687
 688   /// setPhysRegUnused - Mark the specified register unused in this function.
 689   /// This should only be called during and after register allocation.
 690   void setPhysRegUnused(unsigned Reg) {
 691     UsedPhysRegMask.reset(Reg);
 692     for (MCRegUnitIterator Units(Reg, getTargetRegisterInfo());
 693          Units.isValid(); ++Units)
 694       UsedRegUnits.reset(*Units);
 695   }
 696
 697
 698   //===--------------------------------------------------------------------===//
 699   // Reserved Register Info
 700   //===--------------------------------------------------------------------===//
 701   //
 702   // The set of reserved registers must be invariant during register
 703   // allocation.  For example, the target cannot suddenly decide it needs a
 704   // frame pointer when the register allocator has already used the frame
 705   // pointer register for something else.
 706   //
 707   // These methods can be used by target hooks like hasFP() to avoid changing
 708   // the reserved register set during register allocation.
 709
 710   /// freezeReservedRegs - Called by the register allocator to freeze the set
 711   /// of reserved registers before allocation begins.
 712   void freezeReservedRegs(const MachineFunction&);
 713
 714   /// reservedRegsFrozen - Returns true after freezeReservedRegs() was called
 715   /// to ensure the set of reserved registers stays constant.
 716   bool reservedRegsFrozen() const {
 717     return !ReservedRegs.empty();
 718   }
 719
 720   /// canReserveReg - Returns true if PhysReg can be used as a reserved
 721   /// register.  Any register can be reserved before freezeReservedRegs() is
 722   /// called.
 723   bool canReserveReg(unsigned PhysReg) const {
 724     return !reservedRegsFrozen() || ReservedRegs.test(PhysReg);
 725   }
 726
 727   /// getReservedRegs - Returns a reference to the frozen set of reserved
 728   /// registers. This method should always be preferred to calling
 729   /// TRI::getReservedRegs() when possible.
 730   const BitVector &getReservedRegs() const {
 731     assert(reservedRegsFrozen() &&
 732            "Reserved registers haven't been frozen yet. "
 733            "Use TRI::getReservedRegs().");
 734     return ReservedRegs;
 735   }
 736
 737   /// isReserved - Returns true when PhysReg is a reserved register.
 738   ///
 739   /// Reserved registers may belong to an allocatable register class, but the
 740   /// target has explicitly requested that they are not used.
 741   ///
 742   bool isReserved(unsigned PhysReg) const {
 743     return getReservedRegs().test(PhysReg);
 744   }
 745
 746   /// isAllocatable - Returns true when PhysReg belongs to an allocatable
 747   /// register class and it hasn't been reserved.
 748   ///
 749   /// Allocatable registers may show up in the allocation order of some virtual
 750   /// register, so a register allocator needs to track its liveness and
 751   /// availability.
 752   bool isAllocatable(unsigned PhysReg) const {
 753     return getTargetRegisterInfo()->isInAllocatableClass(PhysReg) &&
 754       !isReserved(PhysReg);
 755   }
 756
 757   //===--------------------------------------------------------------------===//
 758   // LiveIn Management
 759   //===--------------------------------------------------------------------===//
 760
 761   /// addLiveIn - Add the specified register as a live-in.  Note that it
 762   /// is an error to add the same register to the same set more than once.
 763   void addLiveIn(unsigned Reg, unsigned vreg = 0) {
 764     LiveIns.push_back(std::make_pair(Reg, vreg));
 765   }
 766
 767   // Iteration support for the live-ins set.  It's kept in sorted order
 768   // by register number.
 769   typedef std::vector<std::pair<unsigned,unsigned> >::const_iterator
 770   livein_iterator;
 771   livein_iterator livein_begin() const { return LiveIns.begin(); }
 772   livein_iterator livein_end()   const { return LiveIns.end(); }
 773   bool            livein_empty() const { return LiveIns.empty(); }
 774
 775   bool isLiveIn(unsigned Reg) const;
 776
 777   /// getLiveInPhysReg - If VReg is a live-in virtual register, return the
 778   /// corresponding live-in physical register.
 779   unsigned getLiveInPhysReg(unsigned VReg) const;
 780
 781   /// getLiveInVirtReg - If PReg is a live-in physical register, return the
 782   /// corresponding live-in physical register.
 783   unsigned getLiveInVirtReg(unsigned PReg) const;
 784
 785   /// EmitLiveInCopies - Emit copies to initialize livein virtual registers
 786   /// into the given entry block.
 787   void EmitLiveInCopies(MachineBasicBlock *EntryMBB,
 788                         const TargetRegisterInfo &TRI,
 789                         const TargetInstrInfo &TII);
 790
 791   /// Returns a mask covering all bits that can appear in lane masks of
 792   /// subregisters of the virtual register @p Reg.
 793   unsigned getMaxLaneMaskForVReg(unsigned Reg) const;
 794
 795   /// defusechain_iterator - This class provides iterator support for machine
 796   /// operands in the function that use or define a specific register.  If
 797   /// ReturnUses is true it returns uses of registers, if ReturnDefs is true it
 798   /// returns defs.  If neither are true then you are silly and it always
 799   /// returns end().  If SkipDebug is true it skips uses marked Debug
 800   /// when incrementing.
 801   template<bool ReturnUses, bool ReturnDefs, bool SkipDebug,
 802            bool ByOperand, bool ByInstr, bool ByBundle>
 803   class defusechain_iterator
 804     : public std::iterator<std::forward_iterator_tag, MachineInstr, ptrdiff_t> {
 805     MachineOperand *Op;
 806     explicit defusechain_iterator(MachineOperand *op) : Op(op) {
 807       // If the first node isn't one we're interested in, advance to one that
 808       // we are interested in.
 809       if (op) {
 810         if ((!ReturnUses && op->isUse()) ||
 811             (!ReturnDefs && op->isDef()) ||
 812             (SkipDebug && op->isDebug()))
 813           advance();
 814       }
 815     }
 816     friend class MachineRegisterInfo;
 817
 818     void advance() {
 819       assert(Op && "Cannot increment end iterator!");
 820       Op = getNextOperandForReg(Op);
 821
 822       // All defs come before the uses, so stop def_iterator early.
 823       if (!ReturnUses) {
 824         if (Op) {
 825           if (Op->isUse())
 826             Op = nullptr;
 827           else
 828             assert(!Op->isDebug() && "Can't have debug defs");
 829         }
 830       } else {
 831         // If this is an operand we don't care about, skip it.
 832         while (Op && ((!ReturnDefs && Op->isDef()) ||
 833                       (SkipDebug && Op->isDebug())))
 834           Op = getNextOperandForReg(Op);
 835       }
 836     }
 837   public:
 838     typedef std::iterator<std::forward_iterator_tag,
 839                           MachineInstr, ptrdiff_t>::reference reference;
 840     typedef std::iterator<std::forward_iterator_tag,
 841                           MachineInstr, ptrdiff_t>::pointer pointer;
 842
 843     defusechain_iterator() : Op(nullptr) {}
 844
 845     bool operator==(const defusechain_iterator &x) const {
 846       return Op == x.Op;
 847     }
 848     bool operator!=(const defusechain_iterator &x) const {
 849       return !operator==(x);
 850     }
 851
 852     /// atEnd - return true if this iterator is equal to reg_end() on the value.
 853     bool atEnd() const { return Op == nullptr; }
 854
 855     // Iterator traversal: forward iteration only
 856     defusechain_iterator &operator++() {          // Preincrement
 857       assert(Op && "Cannot increment end iterator!");
 858       if (ByOperand)
 859         advance();
 860       else if (ByInstr) {
 861         MachineInstr *P = Op->getParent();
 862         do {
 863           advance();
 864         } while (Op && Op->getParent() == P);
 865       } else if (ByBundle) {
 866         MachineInstr *P = getBundleStart(Op->getParent());
 867         do {
 868           advance();
 869         } while (Op && getBundleStart(Op->getParent()) == P);
 870       }
 871
 872       return *this;
 873     }
 874     defusechain_iterator operator++(int) {        // Postincrement
 875       defusechain_iterator tmp = *this; ++*this; return tmp;
 876     }
 877
 878     /// getOperandNo - Return the operand # of this MachineOperand in its
 879     /// MachineInstr.
 880     unsigned getOperandNo() const {
 881       assert(Op && "Cannot dereference end iterator!");
 882       return Op - &Op->getParent()->getOperand(0);
 883     }
 884
 885     // Retrieve a reference to the current operand.
 886     MachineOperand &operator*() const {
 887       assert(Op && "Cannot dereference end iterator!");
 888       return *Op;
 889     }
 890
 891     MachineOperand *operator->() const {
 892       assert(Op && "Cannot dereference end iterator!");
 893       return Op;
 894     }
 895   };
 896
 897   /// defusechain_iterator - This class provides iterator support for machine
 898   /// operands in the function that use or define a specific register.  If
 899   /// ReturnUses is true it returns uses of registers, if ReturnDefs is true it
 900   /// returns defs.  If neither are true then you are silly and it always
 901   /// returns end().  If SkipDebug is true it skips uses marked Debug
 902   /// when incrementing.
 903   template<bool ReturnUses, bool ReturnDefs, bool SkipDebug,
 904            bool ByOperand, bool ByInstr, bool ByBundle>
 905   class defusechain_instr_iterator
 906     : public std::iterator<std::forward_iterator_tag, MachineInstr, ptrdiff_t> {
 907     MachineOperand *Op;
 908     explicit defusechain_instr_iterator(MachineOperand *op) : Op(op) {
 909       // If the first node isn't one we're interested in, advance to one that
 910       // we are interested in.
 911       if (op) {
 912         if ((!ReturnUses && op->isUse()) ||
 913             (!ReturnDefs && op->isDef()) ||
 914             (SkipDebug && op->isDebug()))
 915           advance();
 916       }
 917     }
 918     friend class MachineRegisterInfo;
 919
 920     void advance() {
 921       assert(Op && "Cannot increment end iterator!");
 922       Op = getNextOperandForReg(Op);
 923
 924       // All defs come before the uses, so stop def_iterator early.
 925       if (!ReturnUses) {
 926         if (Op) {
 927           if (Op->isUse())
 928             Op = nullptr;
 929           else
 930             assert(!Op->isDebug() && "Can't have debug defs");
 931         }
 932       } else {
 933         // If this is an operand we don't care about, skip it.
 934         while (Op && ((!ReturnDefs && Op->isDef()) ||
 935                       (SkipDebug && Op->isDebug())))
 936           Op = getNextOperandForReg(Op);
 937       }
 938     }
 939   public:
 940     typedef std::iterator<std::forward_iterator_tag,
 941                           MachineInstr, ptrdiff_t>::reference reference;
 942     typedef std::iterator<std::forward_iterator_tag,
 943                           MachineInstr, ptrdiff_t>::pointer pointer;
 944
 945     defusechain_instr_iterator() : Op(nullptr) {}
 946
 947     bool operator==(const defusechain_instr_iterator &x) const {
 948       return Op == x.Op;
 949     }
 950     bool operator!=(const defusechain_instr_iterator &x) const {
 951       return !operator==(x);
 952     }
 953
 954     /// atEnd - return true if this iterator is equal to reg_end() on the value.
 955     bool atEnd() const { return Op == nullptr; }
 956
 957     // Iterator traversal: forward iteration only
 958     defusechain_instr_iterator &operator++() {          // Preincrement
 959       assert(Op && "Cannot increment end iterator!");
 960       if (ByOperand)
 961         advance();
 962       else if (ByInstr) {
 963         MachineInstr *P = Op->getParent();
 964         do {
 965           advance();
 966         } while (Op && Op->getParent() == P);
 967       } else if (ByBundle) {
 968         MachineInstr *P = getBundleStart(Op->getParent());
 969         do {
 970           advance();
 971         } while (Op && getBundleStart(Op->getParent()) == P);
 972       }
 973
 974       return *this;
 975     }
 976     defusechain_instr_iterator operator++(int) {        // Postincrement
 977       defusechain_instr_iterator tmp = *this; ++*this; return tmp;
 978     }
 979
 980     // Retrieve a reference to the current operand.
 981     MachineInstr &operator*() const {
 982       assert(Op && "Cannot dereference end iterator!");
 983       if (ByBundle) return *(getBundleStart(Op->getParent()));
 984       return *Op->getParent();
 985     }
 986
 987     MachineInstr *operator->() const {
 988       assert(Op && "Cannot dereference end iterator!");
 989       if (ByBundle) return getBundleStart(Op->getParent());
 990       return Op->getParent();
 991     }
 992   };
 993 };
 994
 995 /// Iterate over the pressure sets affected by the given physical or virtual
 996 /// register. If Reg is physical, it must be a register unit (from
 997 /// MCRegUnitIterator).
 998 class PSetIterator {
 999   const int *PSet;
1000   unsigned Weight;
1001 public:
1002   PSetIterator(): PSet(nullptr), Weight(0) {}
1003   PSetIterator(unsigned RegUnit, const MachineRegisterInfo *MRI) {
1004     const TargetRegisterInfo *TRI = MRI->getTargetRegisterInfo();
1005     if (TargetRegisterInfo::isVirtualRegister(RegUnit)) {
1006       const TargetRegisterClass *RC = MRI->getRegClass(RegUnit);
1007       PSet = TRI->getRegClassPressureSets(RC);
1008       Weight = TRI->getRegClassWeight(RC).RegWeight;
1009     }
1010     else {
1011       PSet = TRI->getRegUnitPressureSets(RegUnit);
1012       Weight = TRI->getRegUnitWeight(RegUnit);
1013     }
1014     if (*PSet == -1)
1015       PSet = nullptr;
1016   }
1017   bool isValid() const { return PSet; }
1018
1019   unsigned getWeight() const { return Weight; }
1020
1021   unsigned operator*() const { return *PSet; }
1022
1023   void operator++() {
1024     assert(isValid() && "Invalid PSetIterator.");
1025     ++PSet;
1026     if (*PSet == -1)
1027       PSet = nullptr;
1028   }
1029 };
1030
1031 inline PSetIterator MachineRegisterInfo::
1032 getPressureSets(unsigned RegUnit) const {
1033   return PSetIterator(RegUnit, this);
1034 }
1035
1036 } // End llvm namespace
1037
1038 #endif