blob: a481f787dcb5b3bfcd4311b7920bf684148f17f0 [file] [log] [blame]
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +00001//===-- RegAllocFast.cpp - A fast register allocator for debug code -------===//
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 register allocator allocates registers to a basic block at a time,
11// attempting to keep values in registers and reusing registers as appropriate.
12//
13//===----------------------------------------------------------------------===//
14
15#define DEBUG_TYPE "regalloc"
16#include "llvm/BasicBlock.h"
17#include "llvm/CodeGen/MachineFunctionPass.h"
18#include "llvm/CodeGen/MachineInstr.h"
19#include "llvm/CodeGen/MachineFrameInfo.h"
20#include "llvm/CodeGen/MachineRegisterInfo.h"
21#include "llvm/CodeGen/Passes.h"
22#include "llvm/CodeGen/RegAllocRegistry.h"
23#include "llvm/Target/TargetInstrInfo.h"
24#include "llvm/Target/TargetMachine.h"
25#include "llvm/Support/CommandLine.h"
26#include "llvm/Support/Debug.h"
27#include "llvm/Support/ErrorHandling.h"
28#include "llvm/Support/raw_ostream.h"
29#include "llvm/ADT/DenseMap.h"
30#include "llvm/ADT/IndexedMap.h"
31#include "llvm/ADT/SmallSet.h"
32#include "llvm/ADT/SmallVector.h"
33#include "llvm/ADT/Statistic.h"
34#include "llvm/ADT/STLExtras.h"
35#include <algorithm>
36using namespace llvm;
37
38STATISTIC(NumStores, "Number of stores added");
39STATISTIC(NumLoads , "Number of loads added");
40
41static RegisterRegAlloc
42 fastRegAlloc("fast", "fast register allocator", createFastRegisterAllocator);
43
44namespace {
45 class RAFast : public MachineFunctionPass {
46 public:
47 static char ID;
48 RAFast() : MachineFunctionPass(&ID), StackSlotForVirtReg(-1) {}
49 private:
50 const TargetMachine *TM;
51 MachineFunction *MF;
52 const TargetRegisterInfo *TRI;
53 const TargetInstrInfo *TII;
54
55 // StackSlotForVirtReg - Maps virtual regs to the frame index where these
56 // values are spilled.
57 IndexedMap<int, VirtReg2IndexFunctor> StackSlotForVirtReg;
58
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +000059 // Everything we know about a live virtual register.
60 struct LiveReg {
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +000061 MachineInstr *LastUse; // Last instr to use reg.
62 unsigned PhysReg; // Currently held here.
63 unsigned short LastOpNum; // OpNum on LastUse.
64 bool Dirty; // Register needs spill.
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +000065
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +000066 LiveReg(unsigned p=0) : LastUse(0), PhysReg(p), LastOpNum(0),
67 Dirty(false) {
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +000068 assert(p && "Don't create LiveRegs without a PhysReg");
69 }
70 };
71
72 typedef DenseMap<unsigned, LiveReg> LiveRegMap;
73
74 // LiveVirtRegs - This map contains entries for each virtual register
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +000075 // that is currently available in a physical register.
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +000076 LiveRegMap LiveVirtRegs;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +000077
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +000078 // RegState - Track the state of a physical register.
79 enum RegState {
80 // A disabled register is not available for allocation, but an alias may
81 // be in use. A register can only be moved out of the disabled state if
82 // all aliases are disabled.
83 regDisabled,
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +000084
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +000085 // A free register is not currently in use and can be allocated
86 // immediately without checking aliases.
87 regFree,
88
89 // A reserved register has been assigned expolicitly (e.g., setting up a
90 // call parameter), and it remains reserved until it is used.
91 regReserved
92
93 // A register state may also be a virtual register number, indication that
94 // the physical register is currently allocated to a virtual register. In
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +000095 // that case, LiveVirtRegs contains the inverse mapping.
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +000096 };
97
98 // PhysRegState - One of the RegState enums, or a virtreg.
99 std::vector<unsigned> PhysRegState;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000100
101 // UsedInInstr - BitVector of physregs that are used in the current
102 // instruction, and so cannot be allocated.
103 BitVector UsedInInstr;
104
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000105 // ReservedRegs - vector of reserved physical registers.
106 BitVector ReservedRegs;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000107
108 public:
109 virtual const char *getPassName() const {
110 return "Fast Register Allocator";
111 }
112
113 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
114 AU.setPreservesCFG();
115 AU.addRequiredID(PHIEliminationID);
116 AU.addRequiredID(TwoAddressInstructionPassID);
117 MachineFunctionPass::getAnalysisUsage(AU);
118 }
119
120 private:
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000121 bool runOnMachineFunction(MachineFunction &Fn);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000122 void AllocateBasicBlock(MachineBasicBlock &MBB);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000123 int getStackSpaceFor(unsigned VirtReg, const TargetRegisterClass *RC);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000124 void killVirtReg(unsigned VirtReg);
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000125 void killVirtReg(LiveRegMap::iterator i);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000126 void spillVirtReg(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000127 unsigned VirtReg, bool isKill);
128 void killPhysReg(unsigned PhysReg);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000129 void spillPhysReg(MachineBasicBlock &MBB, MachineInstr *I,
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000130 unsigned PhysReg, bool isKill);
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000131 LiveRegMap::iterator assignVirtToPhysReg(unsigned VirtReg,
132 unsigned PhysReg);
133 LiveRegMap::iterator allocVirtReg(MachineBasicBlock &MBB, MachineInstr *MI,
134 unsigned VirtReg);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000135 unsigned defineVirtReg(MachineBasicBlock &MBB, MachineInstr *MI,
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000136 unsigned OpNum, unsigned VirtReg);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000137 unsigned reloadVirtReg(MachineBasicBlock &MBB, MachineInstr *MI,
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000138 unsigned OpNum, unsigned VirtReg);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000139 void reservePhysReg(MachineBasicBlock &MBB, MachineInstr *MI,
140 unsigned PhysReg);
141 void spillAll(MachineBasicBlock &MBB, MachineInstr *MI);
142 void setPhysReg(MachineOperand &MO, unsigned PhysReg);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000143 };
144 char RAFast::ID = 0;
145}
146
147/// getStackSpaceFor - This allocates space for the specified virtual register
148/// to be held on the stack.
149int RAFast::getStackSpaceFor(unsigned VirtReg, const TargetRegisterClass *RC) {
150 // Find the location Reg would belong...
151 int SS = StackSlotForVirtReg[VirtReg];
152 if (SS != -1)
153 return SS; // Already has space allocated?
154
155 // Allocate a new stack object for this spill location...
156 int FrameIdx = MF->getFrameInfo()->CreateSpillStackObject(RC->getSize(),
157 RC->getAlignment());
158
159 // Assign the slot.
160 StackSlotForVirtReg[VirtReg] = FrameIdx;
161 return FrameIdx;
162}
163
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000164/// killVirtReg - Mark virtreg as no longer available.
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000165void RAFast::killVirtReg(LiveRegMap::iterator i) {
166 assert(i != LiveVirtRegs.end() && "Killing unmapped virtual register");
167 unsigned VirtReg = i->first;
168 const LiveReg &LR = i->second;
169 assert(PhysRegState[LR.PhysReg] == VirtReg && "Broken RegState mapping");
170 PhysRegState[LR.PhysReg] = regFree;
171 if (LR.LastUse) {
172 MachineOperand &MO = LR.LastUse->getOperand(LR.LastOpNum);
173 if (MO.isUse()) MO.setIsKill();
174 else MO.setIsDead();
175 DEBUG(dbgs() << " - last seen here: " << *LR.LastUse);
176 }
177 LiveVirtRegs.erase(i);
178}
179
180/// killVirtReg - Mark virtreg as no longer available.
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000181void RAFast::killVirtReg(unsigned VirtReg) {
182 assert(TargetRegisterInfo::isVirtualRegister(VirtReg) &&
183 "killVirtReg needs a virtual register");
184 DEBUG(dbgs() << " Killing %reg" << VirtReg << "\n");
Jakob Stoklund Olesen1a1ad572010-05-12 00:11:19 +0000185 LiveRegMap::iterator lri = LiveVirtRegs.find(VirtReg);
186 if (lri != LiveVirtRegs.end())
187 killVirtReg(lri);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000188}
189
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000190/// spillVirtReg - This method spills the value specified by VirtReg into the
191/// corresponding stack slot if needed. If isKill is set, the register is also
192/// killed.
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000193void RAFast::spillVirtReg(MachineBasicBlock &MBB,
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000194 MachineBasicBlock::iterator MI,
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000195 unsigned VirtReg, bool isKill) {
196 assert(TargetRegisterInfo::isVirtualRegister(VirtReg) &&
197 "Spilling a physical register is illegal!");
Jakob Stoklund Olesen1a1ad572010-05-12 00:11:19 +0000198 LiveRegMap::iterator lri = LiveVirtRegs.find(VirtReg);
199 assert(lri != LiveVirtRegs.end() && "Spilling unmapped virtual register");
200 LiveReg &LR = lri->second;
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000201 assert(PhysRegState[LR.PhysReg] == VirtReg && "Broken RegState mapping");
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000202
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000203 // If this physreg is used by the instruction, we want to kill it on the
204 // instruction, not on the spill.
205 bool spillKill = isKill && LR.LastUse != MI;
206
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000207 if (LR.Dirty) {
208 LR.Dirty = false;
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000209 DEBUG(dbgs() << " Spilling register " << TRI->getName(LR.PhysReg)
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000210 << " containing %reg" << VirtReg);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000211 const TargetRegisterClass *RC = MF->getRegInfo().getRegClass(VirtReg);
212 int FrameIndex = getStackSpaceFor(VirtReg, RC);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000213 DEBUG(dbgs() << " to stack slot #" << FrameIndex << "\n");
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000214 TII->storeRegToStackSlot(MBB, MI, LR.PhysReg, spillKill,
215 FrameIndex, RC, TRI);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000216 ++NumStores; // Update statistics
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000217
218 if (spillKill)
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000219 LR.LastUse = 0; // Don't kill register again
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000220 else if (!isKill) {
221 MachineInstr *Spill = llvm::prior(MI);
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000222 LR.LastUse = Spill;
223 LR.LastOpNum = Spill->findRegisterUseOperandIdx(LR.PhysReg);
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000224 }
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000225 }
226
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000227 if (isKill)
Jakob Stoklund Olesen1a1ad572010-05-12 00:11:19 +0000228 killVirtReg(lri);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000229}
230
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000231/// spillAll - Spill all dirty virtregs without killing them.
232void RAFast::spillAll(MachineBasicBlock &MBB, MachineInstr *MI) {
233 SmallVector<unsigned, 16> Dirty;
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000234 for (LiveRegMap::iterator i = LiveVirtRegs.begin(),
235 e = LiveVirtRegs.end(); i != e; ++i)
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000236 if (i->second.Dirty)
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000237 Dirty.push_back(i->first);
238 for (unsigned i = 0, e = Dirty.size(); i != e; ++i)
239 spillVirtReg(MBB, MI, Dirty[i], false);
240}
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000241
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000242/// killPhysReg - Kill any virtual register aliased by PhysReg.
243void RAFast::killPhysReg(unsigned PhysReg) {
244 // Fast path for the normal case.
245 switch (unsigned VirtReg = PhysRegState[PhysReg]) {
246 case regDisabled:
247 break;
248 case regFree:
249 return;
250 case regReserved:
251 PhysRegState[PhysReg] = regFree;
252 return;
253 default:
254 killVirtReg(VirtReg);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000255 return;
256 }
257
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000258 // This is a disabled register, we have to check aliases.
259 for (const unsigned *AS = TRI->getAliasSet(PhysReg);
260 unsigned Alias = *AS; ++AS) {
261 switch (unsigned VirtReg = PhysRegState[Alias]) {
262 case regDisabled:
263 case regFree:
264 break;
265 case regReserved:
266 PhysRegState[Alias] = regFree;
267 break;
268 default:
269 killVirtReg(VirtReg);
270 break;
271 }
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000272 }
273}
274
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000275/// spillPhysReg - Spill any dirty virtual registers that aliases PhysReg. If
276/// isKill is set, they are also killed.
277void RAFast::spillPhysReg(MachineBasicBlock &MBB, MachineInstr *MI,
278 unsigned PhysReg, bool isKill) {
279 switch (unsigned VirtReg = PhysRegState[PhysReg]) {
280 case regDisabled:
281 break;
282 case regFree:
283 return;
284 case regReserved:
285 if (isKill)
286 PhysRegState[PhysReg] = regFree;
287 return;
288 default:
289 spillVirtReg(MBB, MI, VirtReg, isKill);
290 return;
291 }
292
293 // This is a disabled register, we have to check aliases.
294 for (const unsigned *AS = TRI->getAliasSet(PhysReg);
295 unsigned Alias = *AS; ++AS) {
296 switch (unsigned VirtReg = PhysRegState[Alias]) {
297 case regDisabled:
298 case regFree:
299 break;
300 case regReserved:
301 if (isKill)
302 PhysRegState[Alias] = regFree;
303 break;
304 default:
305 spillVirtReg(MBB, MI, VirtReg, isKill);
306 break;
307 }
308 }
309}
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000310
311/// assignVirtToPhysReg - This method updates local state so that we know
312/// that PhysReg is the proper container for VirtReg now. The physical
313/// register must not be used for anything else when this is called.
314///
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000315RAFast::LiveRegMap::iterator
316RAFast::assignVirtToPhysReg(unsigned VirtReg, unsigned PhysReg) {
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000317 DEBUG(dbgs() << " Assigning %reg" << VirtReg << " to "
318 << TRI->getName(PhysReg) << "\n");
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000319 PhysRegState[PhysReg] = VirtReg;
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000320 return LiveVirtRegs.insert(std::make_pair(VirtReg, PhysReg)).first;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000321}
322
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000323/// allocVirtReg - Allocate a physical register for VirtReg.
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000324RAFast::LiveRegMap::iterator RAFast::allocVirtReg(MachineBasicBlock &MBB,
325 MachineInstr *MI,
326 unsigned VirtReg) {
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000327 const unsigned spillCost = 100;
328 assert(TargetRegisterInfo::isVirtualRegister(VirtReg) &&
329 "Can only allocate virtual registers");
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000330
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000331 const TargetRegisterClass *RC = MF->getRegInfo().getRegClass(VirtReg);
332 TargetRegisterClass::iterator AOB = RC->allocation_order_begin(*MF);
333 TargetRegisterClass::iterator AOE = RC->allocation_order_end(*MF);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000334
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000335 // First try to find a completely free register.
336 unsigned BestCost = 0, BestReg = 0;
337 bool hasDisabled = false;
338 for (TargetRegisterClass::iterator I = AOB; I != AOE; ++I) {
339 unsigned PhysReg = *I;
340 switch(PhysRegState[PhysReg]) {
341 case regDisabled:
342 hasDisabled = true;
343 case regReserved:
344 continue;
345 case regFree:
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000346 if (!UsedInInstr.test(PhysReg))
347 return assignVirtToPhysReg(VirtReg, PhysReg);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000348 continue;
349 default:
350 // Grab the first spillable register we meet.
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000351 if (!BestReg && !UsedInInstr.test(PhysReg))
352 BestReg = PhysReg, BestCost = spillCost;
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000353 continue;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000354 }
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000355 }
356
357 DEBUG(dbgs() << " Allocating %reg" << VirtReg << " from " << RC->getName()
358 << " candidate=" << TRI->getName(BestReg) << "\n");
359
360 // Try to extend the working set for RC if there were any disabled registers.
361 if (hasDisabled && (!BestReg || BestCost >= spillCost)) {
362 for (TargetRegisterClass::iterator I = AOB; I != AOE; ++I) {
363 unsigned PhysReg = *I;
364 if (PhysRegState[PhysReg] != regDisabled || UsedInInstr.test(PhysReg))
365 continue;
366
367 // Calculate the cost of bringing PhysReg into the working set.
368 unsigned Cost=0;
369 bool Impossible = false;
370 for (const unsigned *AS = TRI->getAliasSet(PhysReg);
371 unsigned Alias = *AS; ++AS) {
372 if (UsedInInstr.test(Alias)) {
373 Impossible = true;
374 break;
375 }
376 switch (PhysRegState[Alias]) {
377 case regDisabled:
378 break;
379 case regReserved:
380 Impossible = true;
381 break;
382 case regFree:
383 Cost++;
384 break;
385 default:
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000386 Cost += spillCost;
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000387 break;
388 }
389 }
390 if (Impossible) continue;
391 DEBUG(dbgs() << " - candidate " << TRI->getName(PhysReg)
392 << " cost=" << Cost << "\n");
393 if (!BestReg || Cost < BestCost) {
394 BestReg = PhysReg;
395 BestCost = Cost;
396 if (Cost < spillCost) break;
397 }
398 }
399 }
400
401 if (BestReg) {
402 // BestCost is 0 when all aliases are already disabled.
403 if (BestCost) {
404 if (PhysRegState[BestReg] != regDisabled)
405 spillVirtReg(MBB, MI, PhysRegState[BestReg], true);
406 else {
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000407 // Make sure all aliases are disabled.
408 for (const unsigned *AS = TRI->getAliasSet(BestReg);
409 unsigned Alias = *AS; ++AS) {
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000410 switch (PhysRegState[Alias]) {
411 case regDisabled:
412 continue;
413 case regFree:
414 PhysRegState[Alias] = regDisabled;
415 break;
416 default:
417 spillVirtReg(MBB, MI, PhysRegState[Alias], true);
418 PhysRegState[Alias] = regDisabled;
419 break;
420 }
421 }
422 }
423 }
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000424 return assignVirtToPhysReg(VirtReg, BestReg);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000425 }
426
427 // Nothing we can do.
428 std::string msg;
429 raw_string_ostream Msg(msg);
430 Msg << "Ran out of registers during register allocation!";
431 if (MI->isInlineAsm()) {
432 Msg << "\nPlease check your inline asm statement for "
433 << "invalid constraints:\n";
434 MI->print(Msg, TM);
435 }
436 report_fatal_error(Msg.str());
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000437 return LiveVirtRegs.end();
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000438}
439
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000440/// defineVirtReg - Allocate a register for VirtReg and mark it as dirty.
441unsigned RAFast::defineVirtReg(MachineBasicBlock &MBB, MachineInstr *MI,
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000442 unsigned OpNum, unsigned VirtReg) {
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000443 assert(TargetRegisterInfo::isVirtualRegister(VirtReg) &&
444 "Not a virtual register");
Jakob Stoklund Olesen1a1ad572010-05-12 00:11:19 +0000445 LiveRegMap::iterator lri = LiveVirtRegs.find(VirtReg);
446 if (lri == LiveVirtRegs.end())
447 lri = allocVirtReg(MBB, MI, VirtReg);
448 LiveReg &LR = lri->second;
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000449 LR.LastUse = MI;
450 LR.LastOpNum = OpNum;
451 LR.Dirty = true;
452 UsedInInstr.set(LR.PhysReg);
453 return LR.PhysReg;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000454}
455
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000456/// reloadVirtReg - Make sure VirtReg is available in a physreg and return it.
457unsigned RAFast::reloadVirtReg(MachineBasicBlock &MBB, MachineInstr *MI,
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000458 unsigned OpNum, unsigned VirtReg) {
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000459 assert(TargetRegisterInfo::isVirtualRegister(VirtReg) &&
460 "Not a virtual register");
Jakob Stoklund Olesen1a1ad572010-05-12 00:11:19 +0000461 LiveRegMap::iterator lri = LiveVirtRegs.find(VirtReg);
462 if (lri == LiveVirtRegs.end()) {
463 lri = allocVirtReg(MBB, MI, VirtReg);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000464 const TargetRegisterClass *RC = MF->getRegInfo().getRegClass(VirtReg);
465 int FrameIndex = getStackSpaceFor(VirtReg, RC);
466 DEBUG(dbgs() << " Reloading %reg" << VirtReg << " into "
Jakob Stoklund Olesen1a1ad572010-05-12 00:11:19 +0000467 << TRI->getName(lri->second.PhysReg) << "\n");
468 TII->loadRegFromStackSlot(MBB, MI, lri->second.PhysReg, FrameIndex, RC,
469 TRI);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000470 ++NumLoads;
471 }
Jakob Stoklund Olesen1a1ad572010-05-12 00:11:19 +0000472 LiveReg &LR = lri->second;
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000473 LR.LastUse = MI;
474 LR.LastOpNum = OpNum;
475 UsedInInstr.set(LR.PhysReg);
476 return LR.PhysReg;
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000477}
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000478
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000479/// reservePhysReg - Mark PhysReg as reserved. This is very similar to
480/// defineVirtReg except the physreg is reverved instead of allocated.
481void RAFast::reservePhysReg(MachineBasicBlock &MBB, MachineInstr *MI,
482 unsigned PhysReg) {
Jakob Stoklund Olesen82b07dc2010-05-11 20:30:28 +0000483 UsedInInstr.set(PhysReg);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000484 switch (unsigned VirtReg = PhysRegState[PhysReg]) {
485 case regDisabled:
486 break;
487 case regFree:
488 PhysRegState[PhysReg] = regReserved;
489 return;
490 case regReserved:
491 return;
492 default:
493 spillVirtReg(MBB, MI, VirtReg, true);
494 PhysRegState[PhysReg] = regReserved;
495 return;
496 }
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000497
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000498 // This is a disabled register, disable all aliases.
499 for (const unsigned *AS = TRI->getAliasSet(PhysReg);
500 unsigned Alias = *AS; ++AS) {
Jakob Stoklund Olesen82b07dc2010-05-11 20:30:28 +0000501 UsedInInstr.set(Alias);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000502 switch (unsigned VirtReg = PhysRegState[Alias]) {
503 case regDisabled:
504 case regFree:
505 break;
506 case regReserved:
507 // is a super register already reserved?
508 if (TRI->isSuperRegister(PhysReg, Alias))
509 return;
510 break;
511 default:
512 spillVirtReg(MBB, MI, VirtReg, true);
513 break;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000514 }
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000515 PhysRegState[Alias] = regDisabled;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000516 }
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000517 PhysRegState[PhysReg] = regReserved;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000518}
519
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000520// setPhysReg - Change MO the refer the PhysReg, considering subregs.
521void RAFast::setPhysReg(MachineOperand &MO, unsigned PhysReg) {
522 if (unsigned Idx = MO.getSubReg()) {
523 MO.setReg(PhysReg ? TRI->getSubReg(PhysReg, Idx) : 0);
524 MO.setSubReg(0);
525 } else
526 MO.setReg(PhysReg);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000527}
528
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000529void RAFast::AllocateBasicBlock(MachineBasicBlock &MBB) {
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000530 DEBUG(dbgs() << "\nBB#" << MBB.getNumber() << ", "<< MBB.getName() << "\n");
531
532 PhysRegState.assign(TRI->getNumRegs(), regDisabled);
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000533 assert(LiveVirtRegs.empty() && "Mapping not cleared form last block?");
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000534
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000535 MachineBasicBlock::iterator MII = MBB.begin();
536
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000537 // Add live-in registers as live.
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000538 for (MachineBasicBlock::livein_iterator I = MBB.livein_begin(),
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000539 E = MBB.livein_end(); I != E; ++I)
540 reservePhysReg(MBB, MII, *I);
541
542 SmallVector<unsigned, 8> VirtKills, PhysKills, PhysDefs;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000543
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000544 // Otherwise, sequentially allocate each instruction in the MBB.
545 while (MII != MBB.end()) {
546 MachineInstr *MI = MII++;
547 const TargetInstrDesc &TID = MI->getDesc();
548 DEBUG({
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000549 dbgs() << "\nStarting RegAlloc of: " << *MI << "Working set:";
550 for (unsigned Reg = 1, E = TRI->getNumRegs(); Reg != E; ++Reg) {
551 if (PhysRegState[Reg] == regDisabled) continue;
552 dbgs() << " " << TRI->getName(Reg);
553 switch(PhysRegState[Reg]) {
554 case regFree:
555 break;
556 case regReserved:
557 dbgs() << "(resv)";
558 break;
559 default:
560 dbgs() << "=%reg" << PhysRegState[Reg];
Jakob Stoklund Olesen210e2af2010-05-11 23:24:47 +0000561 if (LiveVirtRegs[PhysRegState[Reg]].Dirty)
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000562 dbgs() << "*";
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000563 assert(LiveVirtRegs[PhysRegState[Reg]].PhysReg == Reg &&
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000564 "Bad inverse map");
565 break;
566 }
567 }
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000568 dbgs() << '\n';
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000569 // Check that LiveVirtRegs is the inverse.
570 for (LiveRegMap::iterator i = LiveVirtRegs.begin(),
571 e = LiveVirtRegs.end(); i != e; ++i) {
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000572 assert(TargetRegisterInfo::isVirtualRegister(i->first) &&
573 "Bad map key");
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000574 assert(TargetRegisterInfo::isPhysicalRegister(i->second.PhysReg) &&
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000575 "Bad map value");
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000576 assert(PhysRegState[i->second.PhysReg] == i->first &&
577 "Bad inverse map");
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000578 }
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000579 });
580
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000581 // Debug values are not allowed to change codegen in any way.
582 if (MI->isDebugValue()) {
583 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
584 MachineOperand &MO = MI->getOperand(i);
585 if (!MO.isReg()) continue;
586 unsigned Reg = MO.getReg();
587 if (!Reg || TargetRegisterInfo::isPhysicalRegister(Reg)) continue;
Jakob Stoklund Olesen1a1ad572010-05-12 00:11:19 +0000588 LiveRegMap::iterator lri = LiveVirtRegs.find(Reg);
589 if (lri != LiveVirtRegs.end())
590 setPhysReg(MO, lri->second.PhysReg);
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000591 else
592 MO.setReg(0); // We can't allocate a physreg for a DebugValue, sorry!
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000593 }
594 // Next instruction.
595 continue;
596 }
597
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000598 // Track registers used by instruction.
599 UsedInInstr.reset();
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000600 PhysDefs.clear();
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000601
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000602 // First scan.
603 // Mark physreg uses and early clobbers as used.
604 // Collect PhysKills.
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000605 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
606 MachineOperand &MO = MI->getOperand(i);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000607 if (!MO.isReg()) continue;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000608
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000609 // FIXME: For now, don't trust kill flags
610 if (MO.isUse()) MO.setIsKill(false);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000611
612 unsigned Reg = MO.getReg();
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000613 if (!Reg || !TargetRegisterInfo::isPhysicalRegister(Reg) ||
614 ReservedRegs.test(Reg)) continue;
615 if (MO.isUse()) {
616 PhysKills.push_back(Reg); // Any clean physreg use is a kill.
617 UsedInInstr.set(Reg);
618 } else if (MO.isEarlyClobber()) {
619 spillPhysReg(MBB, MI, Reg, true);
620 UsedInInstr.set(Reg);
621 PhysDefs.push_back(Reg);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000622 }
623 }
624
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000625 // Second scan.
626 // Allocate virtreg uses and early clobbers.
627 // Collect VirtKills
628 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
629 MachineOperand &MO = MI->getOperand(i);
630 if (!MO.isReg()) continue;
631 unsigned Reg = MO.getReg();
632 if (!Reg || TargetRegisterInfo::isPhysicalRegister(Reg)) continue;
633 if (MO.isUse()) {
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000634 setPhysReg(MO, reloadVirtReg(MBB, MI, i, Reg));
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000635 if (MO.isKill())
636 VirtKills.push_back(Reg);
637 } else if (MO.isEarlyClobber()) {
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000638 unsigned PhysReg = defineVirtReg(MBB, MI, i, Reg);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000639 setPhysReg(MO, PhysReg);
640 PhysDefs.push_back(PhysReg);
641 }
642 }
643
644 // Process virtreg kills
645 for (unsigned i = 0, e = VirtKills.size(); i != e; ++i)
646 killVirtReg(VirtKills[i]);
647 VirtKills.clear();
648
649 // Process physreg kills
650 for (unsigned i = 0, e = PhysKills.size(); i != e; ++i)
651 killPhysReg(PhysKills[i]);
652 PhysKills.clear();
653
Jakob Stoklund Olesen82b07dc2010-05-11 20:30:28 +0000654 MF->getRegInfo().addPhysRegsUsed(UsedInInstr);
655
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000656 // Track registers defined by instruction - early clobbers at this point.
657 UsedInInstr.reset();
658 for (unsigned i = 0, e = PhysDefs.size(); i != e; ++i) {
659 unsigned PhysReg = PhysDefs[i];
660 UsedInInstr.set(PhysReg);
661 for (const unsigned *AS = TRI->getAliasSet(PhysReg);
662 unsigned Alias = *AS; ++AS)
663 UsedInInstr.set(Alias);
664 }
665
666 // Third scan.
667 // Allocate defs and collect dead defs.
668 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
669 MachineOperand &MO = MI->getOperand(i);
670 if (!MO.isReg() || !MO.isDef() || !MO.getReg()) continue;
671 unsigned Reg = MO.getReg();
672
673 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
674 if (ReservedRegs.test(Reg)) continue;
675 if (MO.isImplicit())
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000676 spillPhysReg(MBB, MI, Reg, true);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000677 else
678 reservePhysReg(MBB, MI, Reg);
679 if (MO.isDead())
680 PhysKills.push_back(Reg);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000681 continue;
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000682 }
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000683 if (MO.isDead())
684 VirtKills.push_back(Reg);
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000685 setPhysReg(MO, defineVirtReg(MBB, MI, i, Reg));
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000686 }
687
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000688 // Spill all dirty virtregs before a call, in case of an exception.
689 if (TID.isCall()) {
690 DEBUG(dbgs() << " Spilling remaining registers before call.\n");
691 spillAll(MBB, MI);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000692 }
693
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000694 // Process virtreg deads.
695 for (unsigned i = 0, e = VirtKills.size(); i != e; ++i)
696 killVirtReg(VirtKills[i]);
697 VirtKills.clear();
698
699 // Process physreg deads.
700 for (unsigned i = 0, e = PhysKills.size(); i != e; ++i)
701 killPhysReg(PhysKills[i]);
702 PhysKills.clear();
Jakob Stoklund Olesen82b07dc2010-05-11 20:30:28 +0000703
704 MF->getRegInfo().addPhysRegsUsed(UsedInInstr);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000705 }
706
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000707 // Spill all physical registers holding virtual registers now.
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000708 DEBUG(dbgs() << "Killing live registers at end of block.\n");
709 MachineBasicBlock::iterator MI = MBB.getFirstTerminator();
Jakob Stoklund Olesen76b4d5a2010-05-11 23:24:45 +0000710 while (!LiveVirtRegs.empty())
711 spillVirtReg(MBB, MI, LiveVirtRegs.begin()->first, true);
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000712
713 DEBUG(MBB.dump());
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000714}
715
716/// runOnMachineFunction - Register allocate the whole function
717///
718bool RAFast::runOnMachineFunction(MachineFunction &Fn) {
719 DEBUG(dbgs() << "Machine Function\n");
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000720 DEBUG(Fn.dump());
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000721 MF = &Fn;
722 TM = &Fn.getTarget();
723 TRI = TM->getRegisterInfo();
724 TII = TM->getInstrInfo();
725
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000726 UsedInInstr.resize(TRI->getNumRegs());
Jakob Stoklund Olesenbbf33b32010-05-11 18:54:45 +0000727 ReservedRegs = TRI->getReservedRegs(*MF);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000728
729 // initialize the virtual->physical register map to have a 'null'
730 // mapping for all virtual registers
731 unsigned LastVirtReg = MF->getRegInfo().getLastVirtReg();
732 StackSlotForVirtReg.grow(LastVirtReg);
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000733
734 // Loop over all of the basic blocks, eliminating virtual register references
735 for (MachineFunction::iterator MBB = Fn.begin(), MBBe = Fn.end();
736 MBB != MBBe; ++MBB)
737 AllocateBasicBlock(*MBB);
738
Jakob Stoklund Olesen82b07dc2010-05-11 20:30:28 +0000739 // Make sure the set of used physregs is closed under subreg operations.
740 MF->getRegInfo().closePhysRegsUsed(*TRI);
741
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000742 StackSlotForVirtReg.clear();
Jakob Stoklund Olesen00207232010-04-21 18:02:42 +0000743 return true;
744}
745
746FunctionPass *llvm::createFastRegisterAllocator() {
747 return new RAFast();
748}