include/llvm/CodeGen/RegAllocPBQP.h

   1 //===-- RegAllocPBQP.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 PBQPBuilder interface, for classes which build PBQP
  11 // instances to represent register allocation problems, and the RegAllocPBQP
  12 // interface.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_CODEGEN_REGALLOCPBQP_H
  17 #define LLVM_CODEGEN_REGALLOCPBQP_H
  18
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/CodeGen/MachineFunctionPass.h"
  21 #include "llvm/CodeGen/PBQP/Graph.h"
  22 #include "llvm/CodeGen/PBQP/Solution.h"
  23
  24 #include <map>
  25 #include <set>
  26
  27 namespace llvm {
  28
  29   class LiveIntervals;
  30   class MachineFunction;
  31   class MachineLoopInfo;
  32   class TargetRegisterInfo;
  33
  34   /// This class wraps up a PBQP instance representing a register allocation
  35   /// problem, plus the structures necessary to map back from the PBQP solution
  36   /// to a register allocation solution. (i.e. The PBQP-node <--> vreg map,
  37   /// and the PBQP option <--> storage location map).
  38
  39   class PBQPRAProblem {
  40   public:
  41
  42     typedef SmallVector<unsigned, 16> AllowedSet;
  43
  44     PBQP::Graph& getGraph() { return graph; }
  45
  46     const PBQP::Graph& getGraph() const { return graph; }
  47
  48     /// Record the mapping between the given virtual register and PBQP node,
  49     /// and the set of allowed pregs for the vreg.
  50     ///
  51     /// If you are extending
  52     /// PBQPBuilder you are unlikely to need this: Nodes and options for all
  53     /// vregs will already have been set up for you by the base class.
  54     template <typename AllowedRegsItr>
  55     void recordVReg(unsigned vreg, PBQP::Graph::NodeItr node,
  56                     AllowedRegsItr arBegin, AllowedRegsItr arEnd) {
  57       assert(node2VReg.find(node) == node2VReg.end() && "Re-mapping node.");
  58       assert(vreg2Node.find(vreg) == vreg2Node.end() && "Re-mapping vreg.");
  59       assert(allowedSets[vreg].empty() && "vreg already has pregs.");
  60
  61       node2VReg[node] = vreg;
  62       vreg2Node[vreg] = node;
  63       std::copy(arBegin, arEnd, std::back_inserter(allowedSets[vreg]));
  64     }
  65
  66     /// Get the virtual register corresponding to the given PBQP node.
  67     unsigned getVRegForNode(PBQP::Graph::ConstNodeItr node) const;
  68
  69     /// Get the PBQP node corresponding to the given virtual register.
  70     PBQP::Graph::NodeItr getNodeForVReg(unsigned vreg) const;
  71
  72     /// Returns true if the given PBQP option represents a physical register,
  73     /// false otherwise.
  74     bool isPRegOption(unsigned vreg, unsigned option) const {
  75       // At present we only have spills or pregs, so anything that's not a
  76       // spill is a preg. (This might be extended one day to support remat).
  77       return !isSpillOption(vreg, option);
  78     }
  79
  80     /// Returns true if the given PBQP option represents spilling, false
  81     /// otherwise.
  82     bool isSpillOption(unsigned vreg, unsigned option) const {
  83       // We hardcode option zero as the spill option.
  84       return option == 0;
  85     }
  86
  87     /// Returns the allowed set for the given virtual register.
  88     const AllowedSet& getAllowedSet(unsigned vreg) const;
  89
  90     /// Get PReg for option.
  91     unsigned getPRegForOption(unsigned vreg, unsigned option) const;
  92
  93   private:
  94
  95     typedef std::map<PBQP::Graph::ConstNodeItr, unsigned,
  96                      PBQP::NodeItrComparator>  Node2VReg;
  97     typedef DenseMap<unsigned, PBQP::Graph::NodeItr> VReg2Node;
  98     typedef DenseMap<unsigned, AllowedSet> AllowedSetMap;
  99
 100     PBQP::Graph graph;
 101     Node2VReg node2VReg;
 102     VReg2Node vreg2Node;
 103
 104     AllowedSetMap allowedSets;
 105
 106   };
 107
 108   /// Builds PBQP instances to represent register allocation problems. Includes
 109   /// spill, interference and coalescing costs by default. You can extend this
 110   /// class to support additional constraints for your architecture.
 111   class PBQPBuilder {
 112   private:
 113     PBQPBuilder(const PBQPBuilder&) LLVM_DELETED_FUNCTION;
 114     void operator=(const PBQPBuilder&) LLVM_DELETED_FUNCTION;
 115   public:
 116
 117     typedef std::set<unsigned> RegSet;
 118
 119     /// Default constructor.
 120     PBQPBuilder() {}
 121
 122     /// Clean up a PBQPBuilder.
 123     virtual ~PBQPBuilder() {}
 124
 125     /// Build a PBQP instance to represent the register allocation problem for
 126     /// the given MachineFunction.
 127     virtual std::auto_ptr<PBQPRAProblem> build(
 128                                               MachineFunction *mf,
 129                                               const LiveIntervals *lis,
 130                                               const MachineLoopInfo *loopInfo,
 131                                               const RegSet &vregs);
 132   private:
 133
 134     void addSpillCosts(PBQP::Vector &costVec, PBQP::PBQPNum spillCost);
 135
 136     void addInterferenceCosts(PBQP::Matrix &costMat,
 137                               const PBQPRAProblem::AllowedSet &vr1Allowed,
 138                               const PBQPRAProblem::AllowedSet &vr2Allowed,
 139                               const TargetRegisterInfo *tri);
 140   };
 141
 142   /// Extended builder which adds coalescing constraints to a problem.
 143   class PBQPBuilderWithCoalescing : public PBQPBuilder {
 144   public:
 145
 146     /// Build a PBQP instance to represent the register allocation problem for
 147     /// the given MachineFunction.
 148     virtual std::auto_ptr<PBQPRAProblem> build(
 149                                               MachineFunction *mf,
 150                                               const LiveIntervals *lis,
 151                                               const MachineLoopInfo *loopInfo,
 152                                               const RegSet &vregs);
 153
 154   private:
 155
 156     void addPhysRegCoalesce(PBQP::Vector &costVec, unsigned pregOption,
 157                             PBQP::PBQPNum benefit);
 158
 159     void addVirtRegCoalesce(PBQP::Matrix &costMat,
 160                             const PBQPRAProblem::AllowedSet &vr1Allowed,
 161                             const PBQPRAProblem::AllowedSet &vr2Allowed,
 162                             PBQP::PBQPNum benefit);
 163   };
 164
 165   FunctionPass* createPBQPRegisterAllocator(std::auto_ptr<PBQPBuilder> builder,
 166                                             char *customPassID=0);
 167 }
 168
 169 #endif /* LLVM_CODEGEN_REGALLOCPBQP_H */