-// $Id$
-//***************************************************************************
-// File:
-// PhyRegAlloc.cpp
+//===-- PhyRegAlloc.cpp ---------------------------------------------------===//
//
-// Purpose:
-// Register allocation for LLVM.
-//
-// History:
-// 9/10/01 - Ruchira Sasanka - created.
-//**************************************************************************/
+// Register allocation for LLVM.
+//
+//===----------------------------------------------------------------------===//
#include "llvm/CodeGen/RegisterAllocation.h"
+#include "llvm/CodeGen/RegAllocCommon.h"
#include "llvm/CodeGen/PhyRegAlloc.h"
#include "llvm/CodeGen/MachineInstr.h"
#include "llvm/CodeGen/MachineInstrAnnot.h"
-#include "llvm/CodeGen/MachineCodeForMethod.h"
+#include "llvm/CodeGen/MachineFunction.h"
#include "llvm/Analysis/LiveVar/FunctionLiveVarInfo.h"
#include "llvm/Analysis/LoopInfo.h"
#include "llvm/Target/TargetMachine.h"
#include "llvm/Target/MachineFrameInfo.h"
-#include "llvm/BasicBlock.h"
+#include "llvm/Target/MachineInstrInfo.h"
#include "llvm/Function.h"
#include "llvm/Type.h"
#include "llvm/iOther.h"
-#include "llvm/CodeGen/RegAllocCommon.h"
+#include "Support/STLExtras.h"
#include "Support/CommandLine.h"
-#include <iostream>
#include <math.h>
using std::cerr;
+using std::vector;
RegAllocDebugLevel_t DEBUG_RA;
-static cl::Enum<RegAllocDebugLevel_t> DEBUG_RA_c(DEBUG_RA, "dregalloc",
- cl::Hidden,
- "enable register allocation debugging information",
- clEnumValN(RA_DEBUG_None , "n", "disable debug output"),
- clEnumValN(RA_DEBUG_Normal , "y", "enable debug output"),
- clEnumValN(RA_DEBUG_Verbose, "v", "enable extra debug output"), 0);
+static cl::opt<RegAllocDebugLevel_t, true>
+DRA_opt("dregalloc", cl::Hidden, cl::location(DEBUG_RA),
+ cl::desc("enable register allocation debugging information"),
+ cl::values(
+ clEnumValN(RA_DEBUG_None , "n", "disable debug output"),
+ clEnumValN(RA_DEBUG_Results, "y", "debug output for allocation results"),
+ clEnumValN(RA_DEBUG_Coloring, "c", "debug output for graph coloring step"),
+ clEnumValN(RA_DEBUG_Interference,"ig","debug output for interference graphs"),
+ clEnumValN(RA_DEBUG_LiveRanges , "lr","debug output for live ranges"),
+ clEnumValN(RA_DEBUG_Verbose, "v", "extra debug output"),
+ 0));
//----------------------------------------------------------------------------
// RegisterAllocation pass front end...
}
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
- AU.addRequired(LoopInfo::ID);
- AU.addRequired(FunctionLiveVarInfo::ID);
+ AU.addRequired<LoopInfo>();
+ AU.addRequired<FunctionLiveVarInfo>();
}
};
}
//----------------------------------------------------------------------------
PhyRegAlloc::PhyRegAlloc(Function *F, const TargetMachine& tm,
FunctionLiveVarInfo *Lvi, LoopInfo *LDC)
- : TM(tm), Meth(F),
- mcInfo(MachineCodeForMethod::get(F)),
- LVI(Lvi), LRI(F, tm, RegClassList),
- MRI(tm.getRegInfo()),
- NumOfRegClasses(MRI.getNumOfRegClasses()),
- LoopDepthCalc(LDC) {
+ : TM(tm), Fn(F), MF(MachineFunction::get(F)), LVI(Lvi),
+ LRI(F, tm, RegClassList), MRI(tm.getRegInfo()),
+ NumOfRegClasses(MRI.getNumOfRegClasses()), LoopDepthCalc(LDC) {
// create each RegisterClass and put in RegClassList
//
- for (unsigned rc=0; rc < NumOfRegClasses; rc++)
+ for (unsigned rc=0; rc != NumOfRegClasses; rc++)
RegClassList.push_back(new RegClass(F, MRI.getMachineRegClass(rc),
&ResColList));
}
// and IGNodeList (one in each IG). The actual nodes will be pushed later.
//----------------------------------------------------------------------------
void PhyRegAlloc::createIGNodeListsAndIGs() {
- if (DEBUG_RA) cerr << "Creating LR lists ...\n";
+ if (DEBUG_RA >= RA_DEBUG_LiveRanges) cerr << "Creating LR lists ...\n";
// hash map iterator
LiveRangeMapType::const_iterator HMI = LRI.getLiveRangeMap()->begin();
if (HMI->first) {
LiveRange *L = HMI->second; // get the LiveRange
if (!L) {
- if (DEBUG_RA) {
- cerr << "\n*?!?Warning: Null liver range found for: "
- << RAV(HMI->first) << "\n";
- }
+ if (DEBUG_RA)
+ cerr << "\n**** ?!?WARNING: NULL LIVE RANGE FOUND FOR: "
+ << RAV(HMI->first) << "****\n";
continue;
}
- // if the Value * is not null, and LR
- // is not yet written to the IGNodeList
+
+ // if the Value * is not null, and LR is not yet written to the IGNodeList
if (!(L->getUserIGNode()) ) {
RegClass *const RC = // RegClass of first value in the LR
RegClassList[ L->getRegClass()->getID() ];
-
RC->addLRToIG(L); // add this LR to an IG
}
}
for ( unsigned rc=0; rc < NumOfRegClasses ; rc++)
RegClassList[rc]->createInterferenceGraph();
- if (DEBUG_RA)
- cerr << "LRLists Created!\n";
+ if (DEBUG_RA >= RA_DEBUG_LiveRanges) cerr << "LRLists Created!\n";
}
-
-
//----------------------------------------------------------------------------
// This method will add all interferences at for a given instruction.
// Interence occurs only if the LR of Def (Inst or Arg) is of the same reg
// class as that of live var. The live var passed to this function is the
// LVset AFTER the instruction
//----------------------------------------------------------------------------
+
void PhyRegAlloc::addInterference(const Value *Def,
const ValueSet *LVSet,
bool isCallInst) {
//
for ( ; LIt != LVSet->end(); ++LIt) {
- if (DEBUG_RA > 1)
+ if (DEBUG_RA >= RA_DEBUG_Verbose)
cerr << "< Def=" << RAV(Def) << ", Lvar=" << RAV(*LIt) << "> ";
// get the live range corresponding to live var
- //
+ //
LiveRange *LROfVar = LRI.getLiveRangeForValue(*LIt);
// LROfVar can be null if it is a const since a const
// doesn't have a dominating def - see Assumptions above
//
- if (LROfVar) {
- if (LROfDef == LROfVar) // do not set interf for same LR
- continue;
-
- // if 2 reg classes are the same set interference
- //
- if (RCOfDef == LROfVar->getRegClass()) {
- RCOfDef->setInterference( LROfDef, LROfVar);
- } else if (DEBUG_RA > 1) {
- // we will not have LRs for values not explicitly allocated in the
- // instruction stream (e.g., constants)
- cerr << " warning: no live range for " << RAV(*LIt) << "\n";
- }
- }
+ if (LROfVar)
+ if (LROfDef != LROfVar) // do not set interf for same LR
+ if (RCOfDef == LROfVar->getRegClass()) // 2 reg classes are the same
+ RCOfDef->setInterference( LROfDef, LROfVar);
}
}
void PhyRegAlloc::setCallInterferences(const MachineInstr *MInst,
const ValueSet *LVSetAft) {
- if (DEBUG_RA)
+ if (DEBUG_RA >= RA_DEBUG_Interference)
cerr << "\n For call inst: " << *MInst;
ValueSet::const_iterator LIt = LVSetAft->begin();
//
LiveRange *const LR = LRI.getLiveRangeForValue(*LIt );
- if (LR && DEBUG_RA) {
- cerr << "\n\tLR Aft Call: ";
- printSet(*LR);
- }
-
// LR can be null if it is a const since a const
// doesn't have a dominating def - see Assumptions above
//
- if (LR ) {
+ if (LR ) {
+ if (DEBUG_RA >= RA_DEBUG_Interference) {
+ cerr << "\n\tLR after Call: ";
+ printSet(*LR);
+ }
LR->setCallInterference();
- if (DEBUG_RA) {
- cerr << "\n ++Added call interf for LR: " ;
+ if (DEBUG_RA >= RA_DEBUG_Interference) {
+ cerr << "\n ++After adding call interference for LR: " ;
printSet(*LR);
}
}
void PhyRegAlloc::buildInterferenceGraphs()
{
- if (DEBUG_RA) cerr << "Creating interference graphs ...\n";
+ if (DEBUG_RA >= RA_DEBUG_Interference)
+ cerr << "Creating interference graphs ...\n";
unsigned BBLoopDepthCost;
- for (Function::const_iterator BBI = Meth->begin(), BBE = Meth->end();
+ for (MachineFunction::iterator BBI = MF.begin(), BBE = MF.end();
BBI != BBE; ++BBI) {
+ const MachineBasicBlock &MBB = *BBI;
+ const BasicBlock *BB = MBB.getBasicBlock();
// find the 10^(loop_depth) of this BB
//
- BBLoopDepthCost = (unsigned)pow(10.0, LoopDepthCalc->getLoopDepth(BBI));
+ BBLoopDepthCost = (unsigned)pow(10.0, LoopDepthCalc->getLoopDepth(BB));
// get the iterator for machine instructions
//
- const MachineCodeForBasicBlock& MIVec = BBI->getMachineInstrVec();
- MachineCodeForBasicBlock::const_iterator MII = MIVec.begin();
+ MachineBasicBlock::const_iterator MII = MBB.begin();
// iterate over all the machine instructions in BB
//
- for ( ; MII != MIVec.end(); ++MII) {
-
- const MachineInstr *MInst = *MII;
+ for ( ; MII != MBB.end(); ++MII) {
+ const MachineInstr *MInst = *MII;
// get the LV set after the instruction
//
- const ValueSet &LVSetAI = LVI->getLiveVarSetAfterMInst(MInst, BBI);
-
- const bool isCallInst = TM.getInstrInfo().isCall(MInst->getOpCode());
+ const ValueSet &LVSetAI = LVI->getLiveVarSetAfterMInst(MInst, BB);
+ bool isCallInst = TM.getInstrInfo().isCall(MInst->getOpCode());
if (isCallInst ) {
// set the isCallInterference flag of each live range wich extends
setCallInterferences(MInst, &LVSetAI);
}
-
// iterate over all MI operands to find defs
//
for (MachineInstr::const_val_op_iterator OpI = MInst->begin(),
//
addInterferencesForArgs();
- if (DEBUG_RA)
- cerr << "Interference graphs calculted!\n";
-
+ if (DEBUG_RA >= RA_DEBUG_Interference)
+ cerr << "Interference graphs calculated!\n";
}
//----------------------------------------------------------------------------
// This method will add interferences for incoming arguments to a function.
//----------------------------------------------------------------------------
+
void PhyRegAlloc::addInterferencesForArgs() {
// get the InSet of root BB
- const ValueSet &InSet = LVI->getInSetOfBB(&Meth->front());
+ const ValueSet &InSet = LVI->getInSetOfBB(&Fn->front());
- for (Function::const_aiterator AI = Meth->abegin(); AI != Meth->aend(); ++AI) {
+ for (Function::const_aiterator AI = Fn->abegin(); AI != Fn->aend(); ++AI) {
// add interferences between args and LVars at start
addInterference(AI, &InSet, false);
- if (DEBUG_RA > 1)
+ if (DEBUG_RA >= RA_DEBUG_Interference)
cerr << " - %% adding interference for argument " << RAV(AI) << "\n";
}
}
//-----------------------------
// Utility functions used below
//-----------------------------
+inline void
+InsertBefore(MachineInstr* newMI,
+ MachineBasicBlock& MBB,
+ MachineBasicBlock::iterator& MII)
+{
+ MII = MBB.insert(MII, newMI);
+ ++MII;
+}
+
+inline void
+InsertAfter(MachineInstr* newMI,
+ MachineBasicBlock& MBB,
+ MachineBasicBlock::iterator& MII)
+{
+ ++MII; // insert before the next instruction
+ MII = MBB.insert(MII, newMI);
+}
+
+inline void
+SubstituteInPlace(MachineInstr* newMI,
+ MachineBasicBlock& MBB,
+ MachineBasicBlock::iterator MII)
+{
+ *MII = newMI;
+}
+
inline void
PrependInstructions(vector<MachineInstr *> &IBef,
- MachineCodeForBasicBlock& MIVec,
- MachineCodeForBasicBlock::iterator& MII,
+ MachineBasicBlock& MBB,
+ MachineBasicBlock::iterator& MII,
const std::string& msg)
{
if (!IBef.empty())
for (AdIt = IBef.begin(); AdIt != IBef.end() ; ++AdIt)
{
if (DEBUG_RA) {
- if (OrigMI) cerr << "For MInst: " << *OrigMI;
- cerr << msg << " PREPENDed instr: " << **AdIt << "\n";
+ if (OrigMI) cerr << "For MInst:\n " << *OrigMI;
+ cerr << msg << "PREPENDed instr:\n " << **AdIt << "\n";
}
- MII = MIVec.insert(MII, *AdIt);
- ++MII;
+ InsertBefore(*AdIt, MBB, MII);
}
}
}
inline void
AppendInstructions(std::vector<MachineInstr *> &IAft,
- MachineCodeForBasicBlock& MIVec,
- MachineCodeForBasicBlock::iterator& MII,
+ MachineBasicBlock& MBB,
+ MachineBasicBlock::iterator& MII,
const std::string& msg)
{
if (!IAft.empty())
for ( AdIt = IAft.begin(); AdIt != IAft.end() ; ++AdIt )
{
if (DEBUG_RA) {
- if (OrigMI) cerr << "For MInst: " << *OrigMI;
- cerr << msg << " APPENDed instr: " << **AdIt << "\n";
+ if (OrigMI) cerr << "For MInst:\n " << *OrigMI;
+ cerr << msg << "APPENDed instr:\n " << **AdIt << "\n";
}
- ++MII; // insert before the next instruction
- MII = MIVec.insert(MII, *AdIt);
+ InsertAfter(*AdIt, MBB, MII);
}
}
}
-void PhyRegAlloc::updateMachineCode()
-{
- MachineCodeForBasicBlock& MIVec = Meth->getEntryNode().getMachineInstrVec();
-
+void PhyRegAlloc::updateMachineCode() {
// Insert any instructions needed at method entry
- MachineCodeForBasicBlock::iterator MII = MIVec.begin();
- PrependInstructions(AddedInstrAtEntry.InstrnsBefore, MIVec, MII,
+ MachineBasicBlock::iterator MII = MF.front().begin();
+ PrependInstructions(AddedInstrAtEntry.InstrnsBefore, MF.front(), MII,
"At function entry: \n");
assert(AddedInstrAtEntry.InstrnsAfter.empty() &&
"InstrsAfter should be unnecessary since we are just inserting at "
"the function entry point here.");
- for (Function::const_iterator BBI = Meth->begin(), BBE = Meth->end();
+ for (MachineFunction::iterator BBI = MF.begin(), BBE = MF.end();
BBI != BBE; ++BBI) {
-
+
// iterate over all the machine instructions in BB
- MachineCodeForBasicBlock &MIVec = BBI->getMachineInstrVec();
- for (MachineCodeForBasicBlock::iterator MII = MIVec.begin();
- MII != MIVec.end(); ++MII) {
-
+ MachineBasicBlock &MBB = *BBI;
+ for (MachineBasicBlock::iterator MII = MBB.begin();
+ MII != MBB.end(); ++MII) {
+
MachineInstr *MInst = *MII;
-
unsigned Opcode = MInst->getOpCode();
// do not process Phis
if (TM.getInstrInfo().isDummyPhiInstr(Opcode))
continue;
+ // Reset tmp stack positions so they can be reused for each machine instr.
+ MF.popAllTempValues(TM);
+
// Now insert speical instructions (if necessary) for call/return
// instructions.
//
if (TM.getInstrInfo().isCall(Opcode) ||
- TM.getInstrInfo().isReturn(Opcode)) {
-
- AddedInstrns &AI = AddedInstrMap[MInst];
-
- // Tmp stack poistions are needed by some calls that have spilled args
- // So reset it before we call each such method
- //
- mcInfo.popAllTempValues(TM);
+ TM.getInstrInfo().isReturn(Opcode)) {
+ AddedInstrns &AI = AddedInstrMap[MInst];
- if (TM.getInstrInfo().isCall(Opcode))
- MRI.colorCallArgs(MInst, LRI, &AI, *this, BBI);
- else if (TM.getInstrInfo().isReturn(Opcode))
- MRI.colorRetValue(MInst, LRI, &AI);
+ if (TM.getInstrInfo().isCall(Opcode))
+ MRI.colorCallArgs(MInst, LRI, &AI, *this, MBB.getBasicBlock());
+ else if (TM.getInstrInfo().isReturn(Opcode))
+ MRI.colorRetValue(MInst, LRI, &AI);
}
-
- /* -- Using above code instead of this
-
- // if this machine instr is call, insert caller saving code
-
- if ((TM.getInstrInfo()).isCall( MInst->getOpCode()) )
- MRI.insertCallerSavingCode(MInst, *BBI, *this );
-
- */
-
-
- // reset the stack offset for temporary variables since we may
- // need that to spill
- // mcInfo.popAllTempValues(TM);
- // TODO ** : do later
-
- //for (MachineInstr::val_const_op_iterator OpI(MInst);!OpI.done();++OpI) {
-
-
- // Now replace set the registers for operands in the machine instruction
- //
- for (unsigned OpNum=0; OpNum < MInst->getNumOperands(); ++OpNum) {
-
- MachineOperand& Op = MInst->getOperand(OpNum);
-
- if (Op.getOperandType() == MachineOperand::MO_VirtualRegister ||
- Op.getOperandType() == MachineOperand::MO_CCRegister) {
-
- const Value *const Val = Op.getVRegValue();
-
- // delete this condition checking later (must assert if Val is null)
- if (!Val) {
- if (DEBUG_RA)
- cerr << "Warning: NULL Value found for operand\n";
- continue;
- }
- assert( Val && "Value is NULL");
-
- LiveRange *const LR = LRI.getLiveRangeForValue(Val);
-
- if (!LR ) {
-
- // nothing to worry if it's a const or a label
-
- if (DEBUG_RA) {
- cerr << "*NO LR for operand : " << Op ;
- cerr << " [reg:" << Op.getAllocatedRegNum() << "]";
- cerr << " in inst:\t" << *MInst << "\n";
+ // Set the registers for operands in the machine instruction
+ // if a register was successfully allocated. If not, insert
+ // code to spill the register value.
+ //
+ for (unsigned OpNum=0; OpNum < MInst->getNumOperands(); ++OpNum)
+ {
+ MachineOperand& Op = MInst->getOperand(OpNum);
+ if (Op.getType() == MachineOperand::MO_VirtualRegister ||
+ Op.getType() == MachineOperand::MO_CCRegister)
+ {
+ const Value *const Val = Op.getVRegValue();
+
+ LiveRange *const LR = LRI.getLiveRangeForValue(Val);
+ if (!LR) // consts or labels will have no live range
+ {
+ // if register is not allocated, mark register as invalid
+ if (Op.getAllocatedRegNum() == -1)
+ MInst->SetRegForOperand(OpNum, MRI.getInvalidRegNum());
+ continue;
+ }
+
+ if (LR->hasColor())
+ MInst->SetRegForOperand(OpNum,
+ MRI.getUnifiedRegNum(LR->getRegClass()->getID(),
+ LR->getColor()));
+ else
+ // LR did NOT receive a color (register). Insert spill code.
+ insertCode4SpilledLR(LR, MInst, MBB.getBasicBlock(), OpNum);
}
-
- // if register is not allocated, mark register as invalid
- if (Op.getAllocatedRegNum() == -1)
- Op.setRegForValue( MRI.getInvalidRegNum());
-
-
- continue;
- }
-
- unsigned RCID = (LR->getRegClass())->getID();
-
- if (LR->hasColor() ) {
- Op.setRegForValue( MRI.getUnifiedRegNum(RCID, LR->getColor()) );
- }
- else {
-
- // LR did NOT receive a color (register). Now, insert spill code
- // for spilled opeands in this machine instruction
-
- //assert(0 && "LR must be spilled");
- insertCode4SpilledLR(LR, MInst, BBI, OpNum );
-
- }
- }
-
- } // for each operand
-
+ } // for each operand
// Now add instructions that the register allocator inserts before/after
// this machine instructions (done only for calls/rets/incoming args)
// We do this here, to ensure that spill for an instruction is inserted
// closest as possible to an instruction (see above insertCode4Spill...)
//
+ // First, if the instruction in the delay slot of a branch needs
+ // instructions inserted, move it out of the delay slot and before the
+ // branch because putting code before or after it would be VERY BAD!
+ //
+ unsigned bumpIteratorBy = 0;
+ if (MII != MBB.begin())
+ if (unsigned predDelaySlots =
+ TM.getInstrInfo().getNumDelaySlots((*(MII-1))->getOpCode()))
+ {
+ assert(predDelaySlots==1 && "Not handling multiple delay slots!");
+ if (TM.getInstrInfo().isBranch((*(MII-1))->getOpCode())
+ && (AddedInstrMap.count(MInst) ||
+ AddedInstrMap[MInst].InstrnsAfter.size() > 0))
+ {
+ // Current instruction is in the delay slot of a branch and it
+ // needs spill code inserted before or after it.
+ // Move it before the preceding branch.
+ InsertBefore(MInst, MBB, --MII);
+ MachineInstr* nopI =
+ new MachineInstr(TM.getInstrInfo().getNOPOpCode());
+ SubstituteInPlace(nopI, MBB, MII+1); // replace orig with NOP
+ --MII; // point to MInst in new location
+ bumpIteratorBy = 2; // later skip the branch and the NOP!
+ }
+ }
+
// If there are instructions to be added, *before* this machine
// instruction, add them now.
//
if (AddedInstrMap.count(MInst)) {
- PrependInstructions(AddedInstrMap[MInst].InstrnsBefore, MIVec, MII,"");
+ PrependInstructions(AddedInstrMap[MInst].InstrnsBefore, MBB, MII,"");
}
// If there are instructions to be added *after* this machine
// added after it must really go after the delayed instruction(s)
// So, we move the InstrAfter of the current instruction to the
// corresponding delayed instruction
-
- unsigned delay;
- if ((delay=TM.getInstrInfo().getNumDelaySlots(MInst->getOpCode())) >0){
- move2DelayedInstr(MInst, *(MII+delay) );
+ if (unsigned delay =
+ TM.getInstrInfo().getNumDelaySlots(MInst->getOpCode())) {
+
+ // Delayed instructions are typically branches or calls. Let's make
+ // sure this is not a branch, otherwise "insert-after" is meaningless,
+ // and should never happen for any reason (spill code, register
+ // restores, etc.).
+ assert(! TM.getInstrInfo().isBranch(MInst->getOpCode()) &&
+ ! TM.getInstrInfo().isReturn(MInst->getOpCode()) &&
+ "INTERNAL ERROR: Register allocator should not be inserting "
+ "any code after a branch or return!");
- if (DEBUG_RA) cerr<< "\nMoved an added instr after the delay slot";
+ move2DelayedInstr(MInst, *(MII+delay) );
}
-
else {
// Here we can add the "instructions after" to the current
// instruction since there are no delay slots for this instruction
- AppendInstructions(AddedInstrMap[MInst].InstrnsAfter, MIVec, MII,"");
+ AppendInstructions(AddedInstrMap[MInst].InstrnsAfter, MBB, MII,"");
} // if not delay
-
}
-
+
+ // If we mucked with the instruction order above, adjust the loop iterator
+ if (bumpIteratorBy)
+ MII = MII + bumpIteratorBy;
+
} // for each machine instruction
}
}
const BasicBlock *BB,
const unsigned OpNum) {
- assert(! TM.getInstrInfo().isCall(MInst->getOpCode()) &&
- (! TM.getInstrInfo().isReturn(MInst->getOpCode())) &&
- "Arg of a call/ret must be handled elsewhere");
+ assert((! TM.getInstrInfo().isCall(MInst->getOpCode()) || OpNum == 0) &&
+ "Outgoing arg of a call must be handled elsewhere (func arg ok)");
+ assert(! TM.getInstrInfo().isReturn(MInst->getOpCode()) &&
+ "Return value of a ret must be handled elsewhere");
MachineOperand& Op = MInst->getOperand(OpNum);
bool isDef = MInst->operandIsDefined(OpNum);
+ bool isDefAndUse = MInst->operandIsDefinedAndUsed(OpNum);
unsigned RegType = MRI.getRegType( LR );
int SpillOff = LR->getSpillOffFromFP();
RegClass *RC = LR->getRegClass();
const ValueSet &LVSetBef = LVI->getLiveVarSetBeforeMInst(MInst, BB);
- mcInfo.pushTempValue(TM, MRI.getSpilledRegSize(RegType) );
+ MF.pushTempValue(TM, MRI.getSpilledRegSize(RegType) );
- MachineInstr *MIBef=NULL, *MIAft=NULL;
+ vector<MachineInstr*> MIBef, MIAft;
vector<MachineInstr*> AdIMid;
- int TmpRegU = getUsableUniRegAtMI(RC, RegType, MInst,&LVSetBef, MIBef, MIAft);
+ // Choose a register to hold the spilled value. This may insert code
+ // before and after MInst to free up the value. If so, this code should
+ // be first and last in the spill sequence before/after MInst.
+ int TmpRegU = getUsableUniRegAtMI(RegType, &LVSetBef, MInst, MIBef, MIAft);
+
+ // Set the operand first so that it this register does not get used
+ // as a scratch register for later calls to getUsableUniRegAtMI below
+ MInst->SetRegForOperand(OpNum, TmpRegU);
- // get the added instructions for this instruciton
+ // get the added instructions for this instruction
AddedInstrns &AI = AddedInstrMap[MInst];
-
- if (!isDef) {
+
+ // We may need a scratch register to copy the spilled value to/from memory.
+ // This may itself have to insert code to free up a scratch register.
+ // Any such code should go before (after) the spill code for a load (store).
+ int scratchRegType = -1;
+ int scratchReg = -1;
+ if (MRI.regTypeNeedsScratchReg(RegType, scratchRegType))
+ {
+ scratchReg = getUsableUniRegAtMI(scratchRegType, &LVSetBef,
+ MInst, MIBef, MIAft);
+ assert(scratchReg != MRI.getInvalidRegNum());
+ MInst->insertUsedReg(scratchReg);
+ }
+
+ if (!isDef || isDefAndUse) {
// for a USE, we have to load the value of LR from stack to a TmpReg
// and use the TmpReg as one operand of instruction
-
- // actual loading instruction
- MRI.cpMem2RegMI(MRI.getFramePointer(), SpillOff, TmpRegU,RegType, AdIMid);
- AI.InstrnsBefore.insert(AI.InstrnsBefore.end(),
- AdIMid.begin(), AdIMid.end());
- if (MIBef)
- AI.InstrnsBefore.push_back(MIBef);
-
- if (MIAft)
- AI.InstrnsAfter.insert(AI.InstrnsAfter.begin(), MIAft);
+ // actual loading instruction(s)
+ MRI.cpMem2RegMI(AdIMid, MRI.getFramePointer(), SpillOff, TmpRegU, RegType,
+ scratchReg);
- } else { // if this is a Def
+ // the actual load should be after the instructions to free up TmpRegU
+ MIBef.insert(MIBef.end(), AdIMid.begin(), AdIMid.end());
+ AdIMid.clear();
+ }
+
+ if (isDef) { // if this is a Def
// for a DEF, we have to store the value produced by this instruction
// on the stack position allocated for this LR
-
- // actual storing instruction
- MRI.cpReg2MemMI(TmpRegU, MRI.getFramePointer(), SpillOff,RegType, AdIMid);
- if (MIBef)
- AI.InstrnsBefore.push_back(MIBef);
+ // actual storing instruction(s)
+ MRI.cpReg2MemMI(AdIMid, TmpRegU, MRI.getFramePointer(), SpillOff, RegType,
+ scratchReg);
- AI.InstrnsAfter.insert(AI.InstrnsAfter.begin(),
- AdIMid.begin(), AdIMid.end());
-
- if (MIAft)
- AI.InstrnsAfter.insert(AI.InstrnsAfter.begin(), MIAft);
-
+ MIAft.insert(MIAft.begin(), AdIMid.begin(), AdIMid.end());
} // if !DEF
+ // Finally, insert the entire spill code sequences before/after MInst
+ AI.InstrnsBefore.insert(AI.InstrnsBefore.end(), MIBef.begin(), MIBef.end());
+ AI.InstrnsAfter.insert(AI.InstrnsAfter.begin(), MIAft.begin(), MIAft.end());
+
if (DEBUG_RA) {
- cerr << "\nFor Inst " << *MInst;
- cerr << " - SPILLED LR: "; printSet(*LR);
- cerr << "\n - Added Instructions:";
- if (MIBef) cerr << *MIBef;
- for (vector<MachineInstr*>::const_iterator II=AdIMid.begin();
- II != AdIMid.end(); ++II)
- cerr << **II;
- if (MIAft) cerr << *MIAft;
+ cerr << "\nFor Inst:\n " << *MInst;
+ cerr << "SPILLED LR# " << LR->getUserIGNode()->getIndex();
+ cerr << "; added Instructions:";
+ for_each(MIBef.begin(), MIBef.end(), std::mem_fun(&MachineInstr::dump));
+ for_each(MIAft.begin(), MIAft.end(), std::mem_fun(&MachineInstr::dump));
}
-
- Op.setRegForValue(TmpRegU); // set the opearnd
}
-
//----------------------------------------------------------------------------
// We can use the following method to get a temporary register to be used
// BEFORE any given machine instruction. If there is a register available,
// Returned register number is the UNIFIED register number
//----------------------------------------------------------------------------
-int PhyRegAlloc::getUsableUniRegAtMI(RegClass *RC,
- const int RegType,
- const MachineInstr *MInst,
- const ValueSet *LVSetBef,
- MachineInstr *&MIBef,
- MachineInstr *&MIAft) {
-
+int PhyRegAlloc::getUsableUniRegAtMI(const int RegType,
+ const ValueSet *LVSetBef,
+ MachineInstr *MInst,
+ std::vector<MachineInstr*>& MIBef,
+ std::vector<MachineInstr*>& MIAft) {
+
+ RegClass* RC = getRegClassByID(MRI.getRegClassIDOfRegType(RegType));
+
int RegU = getUnusedUniRegAtMI(RC, MInst, LVSetBef);
-
-
- if (RegU != -1) {
- // we found an unused register, so we can simply use it
- MIBef = MIAft = NULL;
- }
- else {
+
+ if (RegU == -1) {
// we couldn't find an unused register. Generate code to free up a reg by
// saving it on stack and restoring after the instruction
-
- int TmpOff = mcInfo.pushTempValue(TM, MRI.getSpilledRegSize(RegType) );
- RegU = getUniRegNotUsedByThisInst(RC, MInst);
-
- vector<MachineInstr*> mvec;
+ int TmpOff = MF.pushTempValue(TM, MRI.getSpilledRegSize(RegType) );
- MRI.cpReg2MemMI(RegU, MRI.getFramePointer(), TmpOff, RegType, mvec);
- assert(mvec.size() == 1 && "Need to return a vector here too");
- MIBef = * mvec.begin();
+ RegU = getUniRegNotUsedByThisInst(RC, MInst);
- MRI.cpMem2RegMI(MRI.getFramePointer(), TmpOff, RegU, RegType, mvec);
- assert(mvec.size() == 1 && "Need to return a vector here too");
- MIAft = * mvec.begin();
+ // Check if we need a scratch register to copy this register to memory.
+ int scratchRegType = -1;
+ if (MRI.regTypeNeedsScratchReg(RegType, scratchRegType))
+ {
+ int scratchReg = getUsableUniRegAtMI(scratchRegType, LVSetBef,
+ MInst, MIBef, MIAft);
+ assert(scratchReg != MRI.getInvalidRegNum());
+
+ // We may as well hold the value in the scratch register instead
+ // of copying it to memory and back. But we have to mark the
+ // register as used by this instruction, so it does not get used
+ // as a scratch reg. by another operand or anyone else.
+ MInst->insertUsedReg(scratchReg);
+ MRI.cpReg2RegMI(MIBef, RegU, scratchReg, RegType);
+ MRI.cpReg2RegMI(MIAft, scratchReg, RegU, RegType);
+ }
+ else
+ { // the register can be copied directly to/from memory so do it.
+ MRI.cpReg2MemMI(MIBef, RegU, MRI.getFramePointer(), TmpOff, RegType);
+ MRI.cpMem2RegMI(MIAft, MRI.getFramePointer(), TmpOff, RegU, RegType);
+ }
}
-
+
return RegU;
}
for (unsigned c=0; c < NumAvailRegs; c++) // find first unused color
if (!IsColorUsedArr[c])
return MRI.getUnifiedRegNum(RC->getID(), c);
-
+
return -1;
}
vector<bool> &IsColorUsedArr = RC->getIsColorUsedArr();
unsigned NumAvailRegs = RC->getNumOfAvailRegs();
-
for (unsigned i=0; i < NumAvailRegs ; i++) // Reset array
IsColorUsedArr[i] = false;
// instructions. Both explicit and implicit operands are set.
//----------------------------------------------------------------------------
void PhyRegAlloc::setRelRegsUsedByThisInst(RegClass *RC,
- const MachineInstr *MInst ) {
+ const MachineInstr *MInst ) {
- vector<bool> &IsColorUsedArr = RC->getIsColorUsedArr();
+ vector<bool> &IsColorUsedArr = RC->getIsColorUsedArr();
- for (unsigned OpNum=0; OpNum < MInst->getNumOperands(); ++OpNum) {
-
- const MachineOperand& Op = MInst->getOperand(OpNum);
-
- if (Op.getOperandType() == MachineOperand::MO_VirtualRegister ||
- Op.getOperandType() == MachineOperand::MO_CCRegister ) {
-
- const Value *const Val = Op.getVRegValue();
-
- if (Val )
- if (MRI.getRegClassIDOfValue(Val) == RC->getID() ) {
- int Reg;
- if ((Reg=Op.getAllocatedRegNum()) != -1) {
- IsColorUsedArr[Reg] = true;
- }
- else {
- // it is possilbe that this operand still is not marked with
- // a register but it has a LR and that received a color
-
- LiveRange *LROfVal = LRI.getLiveRangeForValue(Val);
- if (LROfVal)
- if (LROfVal->hasColor() )
- IsColorUsedArr[LROfVal->getColor()] = true;
- }
-
- } // if reg classes are the same
+ // Add the registers already marked as used by the instruction.
+ // This should include any scratch registers that are used to save
+ // values across the instruction (e.g., for saving state register values).
+ const vector<bool> ®sUsed = MInst->getRegsUsed();
+ for (unsigned i = 0, e = regsUsed.size(); i != e; ++i)
+ if (regsUsed[i]) {
+ unsigned classId = 0;
+ int classRegNum = MRI.getClassRegNum(i, classId);
+ if (RC->getID() == classId)
+ {
+ assert(classRegNum < (int) IsColorUsedArr.size() &&
+ "Illegal register number for this reg class?");
+ IsColorUsedArr[classRegNum] = true;
+ }
}
- else if (Op.getOperandType() == MachineOperand::MO_MachineRegister) {
- assert((unsigned)Op.getMachineRegNum() < IsColorUsedArr.size());
- IsColorUsedArr[Op.getMachineRegNum()] = true;
+
+ // Now add registers allocated to the live ranges of values used in
+ // the instruction. These are not yet recorded in the instruction.
+ for (unsigned OpNum=0; OpNum < MInst->getNumOperands(); ++OpNum)
+ {
+ const MachineOperand& Op = MInst->getOperand(OpNum);
+
+ if (MInst->getOperandType(OpNum) == MachineOperand::MO_VirtualRegister ||
+ MInst->getOperandType(OpNum) == MachineOperand::MO_CCRegister)
+ if (const Value* Val = Op.getVRegValue())
+ if (MRI.getRegClassIDOfValue(Val) == RC->getID())
+ if (Op.getAllocatedRegNum() == -1)
+ if (LiveRange *LROfVal = LRI.getLiveRangeForValue(Val))
+ if (LROfVal->hasColor() )
+ // this operand is in a LR that received a color
+ IsColorUsedArr[LROfVal->getColor()] = true;
}
- }
-
- // If there are implicit references, mark them as well
-
- for (unsigned z=0; z < MInst->getNumImplicitRefs(); z++) {
-
- LiveRange *const LRofImpRef =
- LRI.getLiveRangeForValue( MInst->getImplicitRef(z) );
-
- if (LRofImpRef && LRofImpRef->hasColor())
- IsColorUsedArr[LRofImpRef->getColor()] = true;
- }
+
+ // If there are implicit references, mark their allocated regs as well
+ //
+ for (unsigned z=0; z < MInst->getNumImplicitRefs(); z++)
+ if (const LiveRange*
+ LRofImpRef = LRI.getLiveRangeForValue(MInst->getImplicitRef(z)))
+ if (LRofImpRef->hasColor())
+ // this implicit reference is in a LR that received a color
+ IsColorUsedArr[LRofImpRef->getColor()] = true;
}
-
-
-
-
-
-
//----------------------------------------------------------------------------
// If there are delay slots for an instruction, the instructions
// added after it must really go after the delayed instruction(s).
void PhyRegAlloc::printMachineCode()
{
- cerr << "\n;************** Function " << Meth->getName()
+ cerr << "\n;************** Function " << Fn->getName()
<< " *****************\n";
- for (Function::const_iterator BBI = Meth->begin(), BBE = Meth->end();
+ for (MachineFunction::iterator BBI = MF.begin(), BBE = MF.end();
BBI != BBE; ++BBI) {
- cerr << "\n"; printLabel(BBI); cerr << ": ";
+ cerr << "\n"; printLabel(BBI->getBasicBlock()); cerr << ": ";
// get the iterator for machine instructions
- MachineCodeForBasicBlock& MIVec = BBI->getMachineInstrVec();
- MachineCodeForBasicBlock::iterator MII = MIVec.begin();
+ MachineBasicBlock& MBB = *BBI;
+ MachineBasicBlock::iterator MII = MBB.begin();
// iterate over all the machine instructions in BB
- for ( ; MII != MIVec.end(); ++MII) {
+ for ( ; MII != MBB.end(); ++MII) {
MachineInstr *const MInst = *MII;
cerr << "\n\t";
for (unsigned OpNum=0; OpNum < MInst->getNumOperands(); ++OpNum) {
MachineOperand& Op = MInst->getOperand(OpNum);
- if (Op.getOperandType() == MachineOperand::MO_VirtualRegister ||
- Op.getOperandType() == MachineOperand::MO_CCRegister /*||
- Op.getOperandType() == MachineOperand::MO_PCRelativeDisp*/ ) {
+ if (Op.getType() == MachineOperand::MO_VirtualRegister ||
+ Op.getType() == MachineOperand::MO_CCRegister /*||
+ Op.getType() == MachineOperand::MO_PCRelativeDisp*/ ) {
const Value *const Val = Op.getVRegValue () ;
// ****this code is temporary till NULL Values are fixed
}
}
- else if (Op.getOperandType() == MachineOperand::MO_MachineRegister) {
+ else if (Op.getType() == MachineOperand::MO_MachineRegister) {
cerr << "\t" << "%" << MRI.getUnifiedRegName(Op.getMachineRegNum());
}
}
-#if 0
-
-//----------------------------------------------------------------------------
-//
-//----------------------------------------------------------------------------
-
-void PhyRegAlloc::colorCallRetArgs()
-{
-
- CallRetInstrListType &CallRetInstList = LRI.getCallRetInstrList();
- CallRetInstrListType::const_iterator It = CallRetInstList.begin();
-
- for ( ; It != CallRetInstList.end(); ++It ) {
-
- const MachineInstr *const CRMI = *It;
- unsigned OpCode = CRMI->getOpCode();
-
- // get the added instructions for this Call/Ret instruciton
- AddedInstrns &AI = AddedInstrMap[CRMI];
-
- // Tmp stack positions are needed by some calls that have spilled args
- // So reset it before we call each such method
- //mcInfo.popAllTempValues(TM);
-
-
- if (TM.getInstrInfo().isCall(OpCode))
- MRI.colorCallArgs(CRMI, LRI, &AI, *this);
- else if (TM.getInstrInfo().isReturn(OpCode))
- MRI.colorRetValue(CRMI, LRI, &AI);
- else
- assert(0 && "Non Call/Ret instrn in CallRetInstrList\n");
- }
-}
-
-#endif
-
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
void PhyRegAlloc::colorIncomingArgs()
{
- const BasicBlock &FirstBB = Meth->front();
- const MachineInstr *FirstMI = FirstBB.getMachineInstrVec().front();
- assert(FirstMI && "No machine instruction in entry BB");
-
- MRI.colorMethodArgs(Meth, LRI, &AddedInstrAtEntry);
+ MRI.colorMethodArgs(Fn, LRI, &AddedInstrAtEntry);
}
//----------------------------------------------------------------------------
// Used to generate a label for a basic block
//----------------------------------------------------------------------------
-void PhyRegAlloc::printLabel(const Value *const Val) {
+void PhyRegAlloc::printLabel(const Value *Val) {
if (Val->hasName())
cerr << Val->getName();
else
- cerr << "Label" << Val;
+ cerr << "Label" << Val;
}
void PhyRegAlloc::markUnusableSugColors()
{
- if (DEBUG_RA ) cerr << "\nmarking unusable suggested colors ...\n";
-
// hash map iterator
LiveRangeMapType::const_iterator HMI = (LRI.getLiveRangeMap())->begin();
LiveRangeMapType::const_iterator HMIEnd = (LRI.getLiveRangeMap())->end();
//----------------------------------------------------------------------------
void PhyRegAlloc::allocateStackSpace4SpilledLRs() {
- if (DEBUG_RA) cerr << "\nsetting LR stack offsets ...\n";
+ if (DEBUG_RA) cerr << "\nSetting LR stack offsets for spills...\n";
LiveRangeMapType::const_iterator HMI = LRI.getLiveRangeMap()->begin();
LiveRangeMapType::const_iterator HMIEnd = LRI.getLiveRangeMap()->end();
for ( ; HMI != HMIEnd ; ++HMI) {
if (HMI->first && HMI->second) {
LiveRange *L = HMI->second; // get the LiveRange
- if (!L->hasColor()) // NOTE: ** allocating the size of long Type **
- L->setSpillOffFromFP(mcInfo.allocateSpilledValue(TM, Type::LongTy));
+ if (!L->hasColor()) { // NOTE: ** allocating the size of long Type **
+ int stackOffset = MF.allocateSpilledValue(TM, Type::LongTy);
+ L->setSpillOffFromFP(stackOffset);
+ if (DEBUG_RA)
+ cerr << " LR# " << L->getUserIGNode()->getIndex()
+ << ": stack-offset = " << stackOffset << "\n";
+ }
}
} // for all LR's in hash map
}
//
LRI.constructLiveRanges(); // create LR info
- if (DEBUG_RA)
+ if (DEBUG_RA >= RA_DEBUG_LiveRanges)
LRI.printLiveRanges();
createIGNodeListsAndIGs(); // create IGNode list and IGs
buildInterferenceGraphs(); // build IGs in all reg classes
- if (DEBUG_RA) {
+ if (DEBUG_RA >= RA_DEBUG_LiveRanges) {
// print all LRs in all reg classes
for ( unsigned rc=0; rc < NumOfRegClasses ; rc++)
RegClassList[rc]->printIGNodeList();
for ( unsigned rc=0; rc < NumOfRegClasses ; rc++)
RegClassList[rc]->printIG();
}
-
LRI.coalesceLRs(); // coalesce all live ranges
-
- if (DEBUG_RA) {
+ if (DEBUG_RA >= RA_DEBUG_LiveRanges) {
// print all LRs in all reg classes
- for ( unsigned rc=0; rc < NumOfRegClasses ; rc++)
- RegClassList[ rc ]->printIGNodeList();
+ for (unsigned rc=0; rc < NumOfRegClasses; rc++)
+ RegClassList[rc]->printIGNodeList();
// print IGs in all register classes
- for ( unsigned rc=0; rc < NumOfRegClasses ; rc++)
- RegClassList[ rc ]->printIG();
+ for (unsigned rc=0; rc < NumOfRegClasses; rc++)
+ RegClassList[rc]->printIG();
}
// color all register classes using the graph coloring algo
for (unsigned rc=0; rc < NumOfRegClasses ; rc++)
- RegClassList[ rc ]->colorAllRegs();
+ RegClassList[rc]->colorAllRegs();
// Atter grpah coloring, if some LRs did not receive a color (i.e, spilled)
// a poistion for such spilled LRs
//
allocateStackSpace4SpilledLRs();
- mcInfo.popAllTempValues(TM); // TODO **Check
+ MF.popAllTempValues(TM); // TODO **Check
// color incoming args - if the correct color was not received
// insert code to copy to the correct register
updateMachineCode();
if (DEBUG_RA) {
- MachineCodeForMethod::get(Meth).dump();
- printMachineCode(); // only for DEBUGGING
+ cerr << "\n**** Machine Code After Register Allocation:\n\n";
+ MF.dump();
}
}