include/llvm/CodeGen/CalcSpillWeights.h

   1 //===---------------- lib/CodeGen/CalcSpillWeights.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
  11 #ifndef LLVM_CODEGEN_CALCSPILLWEIGHTS_H
  12 #define LLVM_CODEGEN_CALCSPILLWEIGHTS_H
  13
  14 #include "llvm/CodeGen/MachineFunctionPass.h"
  15 #include "llvm/ADT/DenseMap.h"
  16
  17 namespace llvm {
  18
  19   class LiveInterval;
  20   class LiveIntervals;
  21   class MachineLoopInfo;
  22
  23   /// normalizeSpillWeight - The spill weight of a live interval is computed as:
  24   ///
  25   ///   (sum(use freq) + sum(def freq)) / (K + size)
  26   ///
  27   /// @param UseDefFreq Expected number of executed use and def instructions
  28   ///                   per function call. Derived from block frequencies.
  29   /// @param Size       Size of live interval as returnexd by getSize()
  30   ///
  31   static inline float normalizeSpillWeight(float UseDefFreq, unsigned Size) {
  32     // The magic constant 200 corresponds to approx. 25 instructions since
  33     // SlotIndexes allocate 8 slots per instruction.
  34     //
  35     // The constant is added to avoid depending too much on accidental SlotIndex
  36     // gaps for small intervals. The effect is that small intervals have a spill
  37     // weight that is mostly proportional to the number of uses, while large
  38     // intervals get a spill weight that is closer to a use density.
  39     //
  40     return UseDefFreq / (Size + 200);
  41   }
  42
  43   /// VirtRegAuxInfo - Calculate auxiliary information for a virtual
  44   /// register such as its spill weight and allocation hint.
  45   class VirtRegAuxInfo {
  46     MachineFunction &mf_;
  47     LiveIntervals &lis_;
  48     const MachineLoopInfo &loops_;
  49     DenseMap<unsigned, float> hint_;
  50   public:
  51     VirtRegAuxInfo(MachineFunction &mf, LiveIntervals &lis,
  52                    const MachineLoopInfo &loops) :
  53       mf_(mf), lis_(lis), loops_(loops) {}
  54
  55     /// CalculateRegClass - recompute the register class for reg from its uses.
  56     /// Since the register class can affect the allocation hint, this function
  57     /// should be called before CalculateWeightAndHint if both are called.
  58     void CalculateRegClass(unsigned reg);
  59
  60     /// CalculateWeightAndHint - (re)compute li's spill weight and allocation
  61     /// hint.
  62     void CalculateWeightAndHint(LiveInterval &li);
  63   };
  64
  65   /// CalculateSpillWeights - Compute spill weights for all virtual register
  66   /// live intervals.
  67   class CalculateSpillWeights : public MachineFunctionPass {
  68   public:
  69     static char ID;
  70
  71     CalculateSpillWeights() : MachineFunctionPass(ID) {
  72       initializeCalculateSpillWeightsPass(*PassRegistry::getPassRegistry());
  73     }
  74
  75     virtual void getAnalysisUsage(AnalysisUsage &au) const;
  76
  77     virtual bool runOnMachineFunction(MachineFunction &fn);
  78
  79   private:
  80     /// Returns true if the given live interval is zero length.
  81     bool isZeroLengthInterval(LiveInterval *li) const;
  82   };
  83
  84 }
  85
  86 #endif // LLVM_CODEGEN_CALCSPILLWEIGHTS_H