lib/CodeGen/AllocationOrder.h

   1 //===-- llvm/CodeGen/AllocationOrder.h - Allocation Order -*- 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 implements an allocation order for virtual registers.
  11 //
  12 // The preferred allocation order for a virtual register depends on allocation
  13 // hints and target hooks. The AllocationOrder class encapsulates all of that.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_CODEGEN_ALLOCATIONORDER_H
  18 #define LLVM_CODEGEN_ALLOCATIONORDER_H
  19
  20 #include "llvm/MC/MCRegisterInfo.h"
  21
  22 namespace llvm {
  23
  24 class RegisterClassInfo;
  25 class VirtRegMap;
  26
  27 class AllocationOrder {
  28   const MCPhysReg *Begin;
  29   const MCPhysReg *End;
  30   const MCPhysReg *Pos;
  31   const RegisterClassInfo &RCI;
  32   unsigned Hint;
  33   bool OwnedBegin;
  34 public:
  35
  36   /// AllocationOrder - Create a new AllocationOrder for VirtReg.
  37   /// @param VirtReg      Virtual register to allocate for.
  38   /// @param VRM          Virtual register map for function.
  39   /// @param RegClassInfo Information about reserved and allocatable registers.
  40   AllocationOrder(unsigned VirtReg,
  41                   const VirtRegMap &VRM,
  42                   const RegisterClassInfo &RegClassInfo);
  43
  44   ~AllocationOrder();
  45
  46   /// next - Return the next physical register in the allocation order, or 0.
  47   /// It is safe to call next again after it returned 0.
  48   /// It will keep returning 0 until rewind() is called.
  49   unsigned next() {
  50     // First take the hint.
  51     if (!Pos) {
  52       Pos = Begin;
  53       if (Hint)
  54         return Hint;
  55     }
  56     // Then look at the order from TRI.
  57     while (Pos != End) {
  58       unsigned Reg = *Pos++;
  59       if (Reg != Hint)
  60         return Reg;
  61     }
  62     return 0;
  63   }
  64
  65   /// rewind - Start over from the beginning.
  66   void rewind() { Pos = 0; }
  67
  68   /// isHint - Return true if PhysReg is a preferred register.
  69   bool isHint(unsigned PhysReg) const { return PhysReg == Hint; }
  70 };
  71
  72 } // end namespace llvm
  73
  74 #endif