2011-01-06 01:21:53 +00:00
|
|
|
//===-- SpillPlacement.cpp - Optimal Spill Code Placement -----------------===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file implements the spill code placement analysis.
|
|
|
|
//
|
|
|
|
// Each edge bundle corresponds to a node in a Hopfield network. Constraints on
|
|
|
|
// basic blocks are weighted by the block frequency and added to become the node
|
|
|
|
// bias.
|
|
|
|
//
|
|
|
|
// Transparent basic blocks have the variable live through, but don't care if it
|
|
|
|
// is spilled or in a register. These blocks become connections in the Hopfield
|
|
|
|
// network, again weighted by block frequency.
|
|
|
|
//
|
|
|
|
// The Hopfield network minimizes (possibly locally) its energy function:
|
|
|
|
//
|
|
|
|
// E = -sum_n V_n * ( B_n + sum_{n, m linked by b} V_m * F_b )
|
|
|
|
//
|
|
|
|
// The energy function represents the expected spill code execution frequency,
|
|
|
|
// or the cost of spilling. This is a Lyapunov function which never increases
|
|
|
|
// when a node is updated. It is guaranteed to converge to a local minimum.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2011-01-19 23:14:59 +00:00
|
|
|
#define DEBUG_TYPE "spillplacement"
|
2011-01-06 01:21:53 +00:00
|
|
|
#include "SpillPlacement.h"
|
2013-03-18 23:45:45 +00:00
|
|
|
#include "llvm/ADT/BitVector.h"
|
2011-01-06 01:21:53 +00:00
|
|
|
#include "llvm/CodeGen/EdgeBundles.h"
|
|
|
|
#include "llvm/CodeGen/MachineBasicBlock.h"
|
2013-06-17 19:00:36 +00:00
|
|
|
#include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
|
2011-01-06 01:21:53 +00:00
|
|
|
#include "llvm/CodeGen/MachineFunction.h"
|
|
|
|
#include "llvm/CodeGen/MachineLoopInfo.h"
|
|
|
|
#include "llvm/CodeGen/Passes.h"
|
|
|
|
#include "llvm/Support/Debug.h"
|
|
|
|
#include "llvm/Support/Format.h"
|
|
|
|
|
|
|
|
using namespace llvm;
|
|
|
|
|
|
|
|
char SpillPlacement::ID = 0;
|
|
|
|
INITIALIZE_PASS_BEGIN(SpillPlacement, "spill-code-placement",
|
|
|
|
"Spill Code Placement Analysis", true, true)
|
|
|
|
INITIALIZE_PASS_DEPENDENCY(EdgeBundles)
|
|
|
|
INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
|
|
|
|
INITIALIZE_PASS_END(SpillPlacement, "spill-code-placement",
|
|
|
|
"Spill Code Placement Analysis", true, true)
|
|
|
|
|
|
|
|
char &llvm::SpillPlacementID = SpillPlacement::ID;
|
|
|
|
|
|
|
|
void SpillPlacement::getAnalysisUsage(AnalysisUsage &AU) const {
|
|
|
|
AU.setPreservesAll();
|
2013-06-17 19:00:36 +00:00
|
|
|
AU.addRequired<MachineBlockFrequencyInfo>();
|
2011-01-06 01:21:53 +00:00
|
|
|
AU.addRequiredTransitive<EdgeBundles>();
|
|
|
|
AU.addRequiredTransitive<MachineLoopInfo>();
|
|
|
|
MachineFunctionPass::getAnalysisUsage(AU);
|
|
|
|
}
|
|
|
|
|
2013-07-16 18:26:15 +00:00
|
|
|
/// Decision threshold. A node gets the output value 0 if the weighted sum of
|
|
|
|
/// its inputs falls in the open interval (-Threshold;Threshold).
|
|
|
|
static const BlockFrequency Threshold = 2;
|
|
|
|
|
2011-01-06 01:21:53 +00:00
|
|
|
/// Node - Each edge bundle corresponds to a Hopfield node.
|
|
|
|
///
|
|
|
|
/// The node contains precomputed frequency data that only depends on the CFG,
|
|
|
|
/// but Bias and Links are computed each time placeSpills is called.
|
|
|
|
///
|
|
|
|
/// The node Value is positive when the variable should be in a register. The
|
|
|
|
/// value can change when linked nodes change, but convergence is very fast
|
|
|
|
/// because all weights are positive.
|
|
|
|
///
|
|
|
|
struct SpillPlacement::Node {
|
2013-07-16 18:26:15 +00:00
|
|
|
/// BiasN - Sum of blocks that prefer a spill.
|
|
|
|
BlockFrequency BiasN;
|
|
|
|
/// BiasP - Sum of blocks that prefer a register.
|
|
|
|
BlockFrequency BiasP;
|
2011-01-06 01:21:53 +00:00
|
|
|
|
|
|
|
/// Value - Output value of this node computed from the Bias and links.
|
2013-07-16 18:26:15 +00:00
|
|
|
/// This is always on of the values {-1, 0, 1}. A positive number means the
|
|
|
|
/// variable should go in a register through this bundle.
|
|
|
|
int Value;
|
2011-01-06 01:21:53 +00:00
|
|
|
|
2013-07-16 18:26:15 +00:00
|
|
|
typedef SmallVector<std::pair<BlockFrequency, unsigned>, 4> LinkVector;
|
2011-01-06 01:21:53 +00:00
|
|
|
|
|
|
|
/// Links - (Weight, BundleNo) for all transparent blocks connecting to other
|
2013-07-16 18:26:15 +00:00
|
|
|
/// bundles. The weights are all positive block frequencies.
|
2011-01-06 01:21:53 +00:00
|
|
|
LinkVector Links;
|
|
|
|
|
2013-07-16 18:26:15 +00:00
|
|
|
/// SumLinkWeights - Cached sum of the weights of all links + ThresHold.
|
|
|
|
BlockFrequency SumLinkWeights;
|
|
|
|
|
2011-01-06 01:21:53 +00:00
|
|
|
/// preferReg - Return true when this node prefers to be in a register.
|
|
|
|
bool preferReg() const {
|
|
|
|
// Undecided nodes (Value==0) go on the stack.
|
|
|
|
return Value > 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// mustSpill - Return True if this node is so biased that it must spill.
|
|
|
|
bool mustSpill() const {
|
2013-07-16 18:26:15 +00:00
|
|
|
// We must spill if Bias < -sum(weights) or the MustSpill flag was set.
|
|
|
|
// BiasN is saturated when MustSpill is set, make sure this still returns
|
|
|
|
// true when the RHS saturates. Note that SumLinkWeights includes Threshold.
|
|
|
|
return BiasN >= BiasP + SumLinkWeights;
|
2011-01-06 01:21:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// clear - Reset per-query data, but preserve frequencies that only depend on
|
|
|
|
// the CFG.
|
|
|
|
void clear() {
|
2013-07-16 18:26:15 +00:00
|
|
|
BiasN = BiasP = Value = 0;
|
|
|
|
SumLinkWeights = Threshold;
|
2011-01-06 01:21:53 +00:00
|
|
|
Links.clear();
|
|
|
|
}
|
|
|
|
|
|
|
|
/// addLink - Add a link to bundle b with weight w.
|
2013-07-16 18:26:15 +00:00
|
|
|
void addLink(unsigned b, BlockFrequency w) {
|
|
|
|
// Update cached sum.
|
|
|
|
SumLinkWeights += w;
|
2011-01-06 01:21:53 +00:00
|
|
|
|
|
|
|
// There can be multiple links to the same bundle, add them up.
|
|
|
|
for (LinkVector::iterator I = Links.begin(), E = Links.end(); I != E; ++I)
|
|
|
|
if (I->second == b) {
|
|
|
|
I->first += w;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
// This must be the first link to b.
|
|
|
|
Links.push_back(std::make_pair(w, b));
|
|
|
|
}
|
|
|
|
|
2013-07-16 18:26:15 +00:00
|
|
|
/// addBias - Bias this node.
|
|
|
|
void addBias(BlockFrequency freq, BorderConstraint direction) {
|
|
|
|
switch (direction) {
|
|
|
|
default:
|
|
|
|
break;
|
|
|
|
case PrefReg:
|
|
|
|
BiasP += freq;
|
|
|
|
break;
|
|
|
|
case PrefSpill:
|
|
|
|
BiasN += freq;
|
|
|
|
break;
|
|
|
|
case MustSpill:
|
|
|
|
BiasN = BlockFrequency::getMaxFrequency();
|
|
|
|
break;
|
|
|
|
}
|
2011-01-06 01:21:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// update - Recompute Value from Bias and Links. Return true when node
|
|
|
|
/// preference changes.
|
|
|
|
bool update(const Node nodes[]) {
|
|
|
|
// Compute the weighted sum of inputs.
|
2013-07-16 18:26:15 +00:00
|
|
|
BlockFrequency SumN = BiasN;
|
|
|
|
BlockFrequency SumP = BiasP;
|
|
|
|
for (LinkVector::iterator I = Links.begin(), E = Links.end(); I != E; ++I) {
|
|
|
|
if (nodes[I->second].Value == -1)
|
|
|
|
SumN += I->first;
|
|
|
|
else if (nodes[I->second].Value == 1)
|
|
|
|
SumP += I->first;
|
|
|
|
}
|
2011-01-06 01:21:53 +00:00
|
|
|
|
2013-07-16 18:26:15 +00:00
|
|
|
// Each weighted sum is going to be less than the total frequency of the
|
|
|
|
// bundle. Ideally, we should simply set Value = sign(SumP - SumN), but we
|
|
|
|
// will add a dead zone around 0 for two reasons:
|
|
|
|
//
|
2011-01-06 01:21:53 +00:00
|
|
|
// 1. It avoids arbitrary bias when all links are 0 as is possible during
|
|
|
|
// initial iterations.
|
|
|
|
// 2. It helps tame rounding errors when the links nominally sum to 0.
|
2013-07-16 18:26:15 +00:00
|
|
|
//
|
2011-01-06 01:21:53 +00:00
|
|
|
bool Before = preferReg();
|
2013-07-16 18:26:15 +00:00
|
|
|
if (SumN >= SumP + Threshold)
|
2011-01-06 01:21:53 +00:00
|
|
|
Value = -1;
|
2013-07-16 18:26:15 +00:00
|
|
|
else if (SumP >= SumN + Threshold)
|
2011-01-06 01:21:53 +00:00
|
|
|
Value = 1;
|
|
|
|
else
|
|
|
|
Value = 0;
|
|
|
|
return Before != preferReg();
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
bool SpillPlacement::runOnMachineFunction(MachineFunction &mf) {
|
|
|
|
MF = &mf;
|
|
|
|
bundles = &getAnalysis<EdgeBundles>();
|
|
|
|
loops = &getAnalysis<MachineLoopInfo>();
|
|
|
|
|
|
|
|
assert(!nodes && "Leaking node array");
|
|
|
|
nodes = new Node[bundles->getNumBundles()];
|
|
|
|
|
|
|
|
// Compute total ingoing and outgoing block frequencies for all bundles.
|
2013-07-16 18:26:15 +00:00
|
|
|
BlockFrequencies.resize(mf.getNumBlockIDs());
|
2013-12-14 00:25:47 +00:00
|
|
|
MBFI = &getAnalysis<MachineBlockFrequencyInfo>();
|
2011-01-06 01:21:53 +00:00
|
|
|
for (MachineFunction::iterator I = mf.begin(), E = mf.end(); I != E; ++I) {
|
|
|
|
unsigned Num = I->getNumber();
|
2013-12-14 00:25:47 +00:00
|
|
|
BlockFrequencies[Num] = MBFI->getBlockFreq(I);
|
2011-01-06 01:21:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// We never change the function.
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
void SpillPlacement::releaseMemory() {
|
|
|
|
delete[] nodes;
|
|
|
|
nodes = 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// activate - mark node n as active if it wasn't already.
|
|
|
|
void SpillPlacement::activate(unsigned n) {
|
|
|
|
if (ActiveNodes->test(n))
|
|
|
|
return;
|
|
|
|
ActiveNodes->set(n);
|
|
|
|
nodes[n].clear();
|
2012-05-21 03:11:23 +00:00
|
|
|
|
|
|
|
// Very large bundles usually come from big switches, indirect branches,
|
|
|
|
// landing pads, or loops with many 'continue' statements. It is difficult to
|
|
|
|
// allocate registers when so many different blocks are involved.
|
|
|
|
//
|
2013-07-16 18:26:15 +00:00
|
|
|
// Give a small negative bias to large bundles such that a substantial
|
|
|
|
// fraction of the connected blocks need to be interested before we consider
|
|
|
|
// expanding the region through the bundle. This helps compile time by
|
|
|
|
// limiting the number of blocks visited and the number of links in the
|
|
|
|
// Hopfield network.
|
|
|
|
if (bundles->getBlocks(n).size() > 100) {
|
|
|
|
nodes[n].BiasP = 0;
|
2013-12-14 00:25:47 +00:00
|
|
|
nodes[n].BiasN = (MBFI->getEntryFrequency() / 16);
|
2013-07-16 18:26:15 +00:00
|
|
|
}
|
2011-01-06 01:21:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2011-04-06 19:13:57 +00:00
|
|
|
/// addConstraints - Compute node biases and weights from a set of constraints.
|
2011-01-06 01:21:53 +00:00
|
|
|
/// Set a bit in NodeMask for each active node.
|
2011-04-06 19:13:57 +00:00
|
|
|
void SpillPlacement::addConstraints(ArrayRef<BlockConstraint> LiveBlocks) {
|
|
|
|
for (ArrayRef<BlockConstraint>::iterator I = LiveBlocks.begin(),
|
2011-01-06 01:21:53 +00:00
|
|
|
E = LiveBlocks.end(); I != E; ++I) {
|
2013-07-16 18:26:15 +00:00
|
|
|
BlockFrequency Freq = BlockFrequencies[I->Number];
|
2011-01-06 01:21:53 +00:00
|
|
|
|
|
|
|
// Live-in to block?
|
|
|
|
if (I->Entry != DontCare) {
|
|
|
|
unsigned ib = bundles->getBundle(I->Number, 0);
|
|
|
|
activate(ib);
|
2013-07-16 18:26:15 +00:00
|
|
|
nodes[ib].addBias(Freq, I->Entry);
|
2011-01-06 01:21:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Live-out from block?
|
|
|
|
if (I->Exit != DontCare) {
|
|
|
|
unsigned ob = bundles->getBundle(I->Number, 1);
|
|
|
|
activate(ob);
|
2013-07-16 18:26:15 +00:00
|
|
|
nodes[ob].addBias(Freq, I->Exit);
|
2011-01-06 01:21:53 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-07-23 03:10:19 +00:00
|
|
|
/// addPrefSpill - Same as addConstraints(PrefSpill)
|
2011-08-03 23:09:38 +00:00
|
|
|
void SpillPlacement::addPrefSpill(ArrayRef<unsigned> Blocks, bool Strong) {
|
2011-07-23 03:10:19 +00:00
|
|
|
for (ArrayRef<unsigned>::iterator I = Blocks.begin(), E = Blocks.end();
|
|
|
|
I != E; ++I) {
|
2013-07-16 18:26:15 +00:00
|
|
|
BlockFrequency Freq = BlockFrequencies[*I];
|
2011-08-03 23:09:38 +00:00
|
|
|
if (Strong)
|
|
|
|
Freq += Freq;
|
2011-07-23 03:10:19 +00:00
|
|
|
unsigned ib = bundles->getBundle(*I, 0);
|
|
|
|
unsigned ob = bundles->getBundle(*I, 1);
|
|
|
|
activate(ib);
|
|
|
|
activate(ob);
|
2013-07-16 18:26:15 +00:00
|
|
|
nodes[ib].addBias(Freq, PrefSpill);
|
|
|
|
nodes[ob].addBias(Freq, PrefSpill);
|
2011-07-23 03:10:19 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-04-07 17:27:46 +00:00
|
|
|
void SpillPlacement::addLinks(ArrayRef<unsigned> Links) {
|
|
|
|
for (ArrayRef<unsigned>::iterator I = Links.begin(), E = Links.end(); I != E;
|
|
|
|
++I) {
|
|
|
|
unsigned Number = *I;
|
|
|
|
unsigned ib = bundles->getBundle(Number, 0);
|
|
|
|
unsigned ob = bundles->getBundle(Number, 1);
|
|
|
|
|
|
|
|
// Ignore self-loops.
|
|
|
|
if (ib == ob)
|
|
|
|
continue;
|
|
|
|
activate(ib);
|
|
|
|
activate(ob);
|
2011-04-09 02:59:09 +00:00
|
|
|
if (nodes[ib].Links.empty() && !nodes[ib].mustSpill())
|
|
|
|
Linked.push_back(ib);
|
|
|
|
if (nodes[ob].Links.empty() && !nodes[ob].mustSpill())
|
|
|
|
Linked.push_back(ob);
|
2013-07-16 18:26:15 +00:00
|
|
|
BlockFrequency Freq = BlockFrequencies[Number];
|
|
|
|
nodes[ib].addLink(ob, Freq);
|
|
|
|
nodes[ob].addLink(ib, Freq);
|
2011-04-07 17:27:46 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-04-09 02:59:09 +00:00
|
|
|
bool SpillPlacement::scanActiveBundles() {
|
|
|
|
Linked.clear();
|
|
|
|
RecentPositive.clear();
|
|
|
|
for (int n = ActiveNodes->find_first(); n>=0; n = ActiveNodes->find_next(n)) {
|
|
|
|
nodes[n].update(nodes);
|
|
|
|
// A node that must spill, or a node without any links is not going to
|
|
|
|
// change its value ever again, so exclude it from iterations.
|
|
|
|
if (nodes[n].mustSpill())
|
|
|
|
continue;
|
|
|
|
if (!nodes[n].Links.empty())
|
|
|
|
Linked.push_back(n);
|
|
|
|
if (nodes[n].preferReg())
|
|
|
|
RecentPositive.push_back(n);
|
|
|
|
}
|
|
|
|
return !RecentPositive.empty();
|
|
|
|
}
|
|
|
|
|
2011-01-06 01:21:53 +00:00
|
|
|
/// iterate - Repeatedly update the Hopfield nodes until stability or the
|
|
|
|
/// maximum number of iterations is reached.
|
|
|
|
/// @param Linked - Numbers of linked nodes that need updating.
|
2011-04-09 02:59:09 +00:00
|
|
|
void SpillPlacement::iterate() {
|
|
|
|
// First update the recently positive nodes. They have likely received new
|
|
|
|
// negative bias that will turn them off.
|
|
|
|
while (!RecentPositive.empty())
|
|
|
|
nodes[RecentPositive.pop_back_val()].update(nodes);
|
|
|
|
|
2011-01-06 01:21:53 +00:00
|
|
|
if (Linked.empty())
|
|
|
|
return;
|
|
|
|
|
|
|
|
// Run up to 10 iterations. The edge bundle numbering is closely related to
|
|
|
|
// basic block numbering, so there is a strong tendency towards chains of
|
|
|
|
// linked nodes with sequential numbers. By scanning the linked nodes
|
|
|
|
// backwards and forwards, we make it very likely that a single node can
|
|
|
|
// affect the entire network in a single iteration. That means very fast
|
|
|
|
// convergence, usually in a single iteration.
|
|
|
|
for (unsigned iteration = 0; iteration != 10; ++iteration) {
|
|
|
|
// Scan backwards, skipping the last node which was just updated.
|
|
|
|
bool Changed = false;
|
|
|
|
for (SmallVectorImpl<unsigned>::const_reverse_iterator I =
|
|
|
|
llvm::next(Linked.rbegin()), E = Linked.rend(); I != E; ++I) {
|
|
|
|
unsigned n = *I;
|
2011-04-09 02:59:09 +00:00
|
|
|
if (nodes[n].update(nodes)) {
|
|
|
|
Changed = true;
|
|
|
|
if (nodes[n].preferReg())
|
|
|
|
RecentPositive.push_back(n);
|
|
|
|
}
|
2011-01-06 01:21:53 +00:00
|
|
|
}
|
2011-04-09 02:59:09 +00:00
|
|
|
if (!Changed || !RecentPositive.empty())
|
2011-01-06 01:21:53 +00:00
|
|
|
return;
|
|
|
|
|
|
|
|
// Scan forwards, skipping the first node which was just updated.
|
|
|
|
Changed = false;
|
|
|
|
for (SmallVectorImpl<unsigned>::const_iterator I =
|
|
|
|
llvm::next(Linked.begin()), E = Linked.end(); I != E; ++I) {
|
|
|
|
unsigned n = *I;
|
2011-04-09 02:59:09 +00:00
|
|
|
if (nodes[n].update(nodes)) {
|
|
|
|
Changed = true;
|
|
|
|
if (nodes[n].preferReg())
|
|
|
|
RecentPositive.push_back(n);
|
|
|
|
}
|
2011-01-06 01:21:53 +00:00
|
|
|
}
|
2011-04-09 02:59:09 +00:00
|
|
|
if (!Changed || !RecentPositive.empty())
|
2011-01-06 01:21:53 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-04-06 19:13:57 +00:00
|
|
|
void SpillPlacement::prepare(BitVector &RegBundles) {
|
2011-04-09 02:59:09 +00:00
|
|
|
Linked.clear();
|
|
|
|
RecentPositive.clear();
|
2011-01-06 01:21:53 +00:00
|
|
|
// Reuse RegBundles as our ActiveNodes vector.
|
|
|
|
ActiveNodes = &RegBundles;
|
|
|
|
ActiveNodes->clear();
|
|
|
|
ActiveNodes->resize(bundles->getNumBundles());
|
2011-04-06 19:13:57 +00:00
|
|
|
}
|
2011-01-06 01:21:53 +00:00
|
|
|
|
2011-04-06 19:13:57 +00:00
|
|
|
bool
|
|
|
|
SpillPlacement::finish() {
|
|
|
|
assert(ActiveNodes && "Call prepare() first");
|
2011-01-06 01:21:53 +00:00
|
|
|
|
2011-04-06 19:13:57 +00:00
|
|
|
// Write preferences back to ActiveNodes.
|
2011-01-06 01:21:53 +00:00
|
|
|
bool Perfect = true;
|
2011-04-06 19:13:57 +00:00
|
|
|
for (int n = ActiveNodes->find_first(); n>=0; n = ActiveNodes->find_next(n))
|
2011-01-06 01:21:53 +00:00
|
|
|
if (!nodes[n].preferReg()) {
|
2011-04-06 19:13:57 +00:00
|
|
|
ActiveNodes->reset(n);
|
2011-01-06 01:21:53 +00:00
|
|
|
Perfect = false;
|
|
|
|
}
|
2011-04-06 19:13:57 +00:00
|
|
|
ActiveNodes = 0;
|
2011-01-06 01:21:53 +00:00
|
|
|
return Perfect;
|
|
|
|
}
|