1 //===-- StackSlotColoring.cpp - Stack slot coloring pass. -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the stack slot coloring pass.
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "stackcoloring"
15 #include "llvm/Function.h"
16 #include "llvm/Module.h"
17 #include "llvm/CodeGen/Passes.h"
18 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
19 #include "llvm/CodeGen/LiveStackAnalysis.h"
20 #include "llvm/CodeGen/MachineFrameInfo.h"
21 #include "llvm/CodeGen/MachineInstrBuilder.h"
22 #include "llvm/CodeGen/MachineLoopInfo.h"
23 #include "llvm/CodeGen/MachineMemOperand.h"
24 #include "llvm/CodeGen/MachineRegisterInfo.h"
25 #include "llvm/CodeGen/PseudoSourceValue.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Target/TargetInstrInfo.h"
29 #include "llvm/Target/TargetMachine.h"
30 #include "llvm/ADT/BitVector.h"
31 #include "llvm/ADT/SmallSet.h"
32 #include "llvm/ADT/SmallVector.h"
33 #include "llvm/ADT/Statistic.h"
38 DisableSharing("no-stack-slot-sharing",
39 cl::init(false), cl::Hidden,
40 cl::desc("Suppress slot sharing during stack coloring"));
42 static cl::opt<int> DCELimit("ssc-dce-limit", cl::init(-1), cl::Hidden);
44 STATISTIC(NumEliminated, "Number of stack slots eliminated due to coloring");
45 STATISTIC(NumDead, "Number of trivially dead stack accesses eliminated");
48 class StackSlotColoring : public MachineFunctionPass {
51 MachineFrameInfo *MFI;
52 const TargetInstrInfo *TII;
53 const MachineLoopInfo *loopInfo;
55 // SSIntervals - Spill slot intervals.
56 std::vector<LiveInterval*> SSIntervals;
58 // SSRefs - Keep a list of frame index references for each spill slot.
59 SmallVector<SmallVector<MachineInstr*, 8>, 16> SSRefs;
61 // OrigAlignments - Alignments of stack objects before coloring.
62 SmallVector<unsigned, 16> OrigAlignments;
64 // OrigSizes - Sizess of stack objects before coloring.
65 SmallVector<unsigned, 16> OrigSizes;
67 // AllColors - If index is set, it's a spill slot, i.e. color.
68 // FIXME: This assumes PEI locate spill slot with smaller indices
69 // closest to stack pointer / frame pointer. Therefore, smaller
70 // index == better color.
73 // NextColor - Next "color" that's not yet used.
76 // UsedColors - "Colors" that have been assigned.
79 // Assignments - Color to intervals mapping.
80 SmallVector<SmallVector<LiveInterval*,4>, 16> Assignments;
83 static char ID; // Pass identification
85 MachineFunctionPass(ID), ColorWithRegs(false), NextColor(-1) {
86 initializeStackSlotColoringPass(*PassRegistry::getPassRegistry());
89 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
91 AU.addRequired<SlotIndexes>();
92 AU.addPreserved<SlotIndexes>();
93 AU.addRequired<LiveStacks>();
94 AU.addRequired<MachineLoopInfo>();
95 AU.addPreserved<MachineLoopInfo>();
96 AU.addPreservedID(MachineDominatorsID);
97 MachineFunctionPass::getAnalysisUsage(AU);
100 virtual bool runOnMachineFunction(MachineFunction &MF);
103 void InitializeSlots();
104 void ScanForSpillSlotRefs(MachineFunction &MF);
105 bool OverlapWithAssignments(LiveInterval *li, int Color) const;
106 int ColorSlot(LiveInterval *li);
107 bool ColorSlots(MachineFunction &MF);
108 void RewriteInstruction(MachineInstr *MI, int OldFI, int NewFI,
109 MachineFunction &MF);
110 bool RemoveDeadStores(MachineBasicBlock* MBB);
112 } // end anonymous namespace
114 char StackSlotColoring::ID = 0;
115 char &llvm::StackSlotColoringID = StackSlotColoring::ID;
117 INITIALIZE_PASS_BEGIN(StackSlotColoring, "stack-slot-coloring",
118 "Stack Slot Coloring", false, false)
119 INITIALIZE_PASS_DEPENDENCY(SlotIndexes)
120 INITIALIZE_PASS_DEPENDENCY(LiveStacks)
121 INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
122 INITIALIZE_PASS_END(StackSlotColoring, "stack-slot-coloring",
123 "Stack Slot Coloring", false, false)
126 // IntervalSorter - Comparison predicate that sort live intervals by
128 struct IntervalSorter {
129 bool operator()(LiveInterval* LHS, LiveInterval* RHS) const {
130 return LHS->weight > RHS->weight;
135 /// ScanForSpillSlotRefs - Scan all the machine instructions for spill slot
136 /// references and update spill slot weights.
137 void StackSlotColoring::ScanForSpillSlotRefs(MachineFunction &MF) {
138 SSRefs.resize(MFI->getObjectIndexEnd());
140 // FIXME: Need the equivalent of MachineRegisterInfo for frameindex operands.
141 for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
143 MachineBasicBlock *MBB = &*MBBI;
144 unsigned loopDepth = loopInfo->getLoopDepth(MBB);
145 for (MachineBasicBlock::iterator MII = MBB->begin(), EE = MBB->end();
147 MachineInstr *MI = &*MII;
148 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
149 MachineOperand &MO = MI->getOperand(i);
152 int FI = MO.getIndex();
155 if (!LS->hasInterval(FI))
157 LiveInterval &li = LS->getInterval(FI);
158 if (!MI->isDebugValue())
159 li.weight += LiveIntervals::getSpillWeight(false, true, loopDepth);
160 SSRefs[FI].push_back(MI);
166 /// InitializeSlots - Process all spill stack slot liveintervals and add them
167 /// to a sorted (by weight) list.
168 void StackSlotColoring::InitializeSlots() {
169 int LastFI = MFI->getObjectIndexEnd();
170 OrigAlignments.resize(LastFI);
171 OrigSizes.resize(LastFI);
172 AllColors.resize(LastFI);
173 UsedColors.resize(LastFI);
174 Assignments.resize(LastFI);
176 // Gather all spill slots into a list.
177 DEBUG(dbgs() << "Spill slot intervals:\n");
178 for (LiveStacks::iterator i = LS->begin(), e = LS->end(); i != e; ++i) {
179 LiveInterval &li = i->second;
181 int FI = TargetRegisterInfo::stackSlot2Index(li.reg);
182 if (MFI->isDeadObjectIndex(FI))
184 SSIntervals.push_back(&li);
185 OrigAlignments[FI] = MFI->getObjectAlignment(FI);
186 OrigSizes[FI] = MFI->getObjectSize(FI);
189 DEBUG(dbgs() << '\n');
191 // Sort them by weight.
192 std::stable_sort(SSIntervals.begin(), SSIntervals.end(), IntervalSorter());
194 // Get first "color".
195 NextColor = AllColors.find_first();
198 /// OverlapWithAssignments - Return true if LiveInterval overlaps with any
199 /// LiveIntervals that have already been assigned to the specified color.
201 StackSlotColoring::OverlapWithAssignments(LiveInterval *li, int Color) const {
202 const SmallVector<LiveInterval*,4> &OtherLIs = Assignments[Color];
203 for (unsigned i = 0, e = OtherLIs.size(); i != e; ++i) {
204 LiveInterval *OtherLI = OtherLIs[i];
205 if (OtherLI->overlaps(*li))
211 /// ColorSlot - Assign a "color" (stack slot) to the specified stack slot.
213 int StackSlotColoring::ColorSlot(LiveInterval *li) {
216 if (!DisableSharing) {
217 // Check if it's possible to reuse any of the used colors.
218 Color = UsedColors.find_first();
219 while (Color != -1) {
220 if (!OverlapWithAssignments(li, Color)) {
225 Color = UsedColors.find_next(Color);
229 // Assign it to the first available color (assumed to be the best) if it's
230 // not possible to share a used color with other objects.
232 assert(NextColor != -1 && "No more spill slots?");
234 UsedColors.set(Color);
235 NextColor = AllColors.find_next(NextColor);
238 // Record the assignment.
239 Assignments[Color].push_back(li);
240 int FI = TargetRegisterInfo::stackSlot2Index(li->reg);
241 DEBUG(dbgs() << "Assigning fi#" << FI << " to fi#" << Color << "\n");
243 // Change size and alignment of the allocated slot. If there are multiple
244 // objects sharing the same slot, then make sure the size and alignment
245 // are large enough for all.
246 unsigned Align = OrigAlignments[FI];
247 if (!Share || Align > MFI->getObjectAlignment(Color))
248 MFI->setObjectAlignment(Color, Align);
249 int64_t Size = OrigSizes[FI];
250 if (!Share || Size > MFI->getObjectSize(Color))
251 MFI->setObjectSize(Color, Size);
255 /// Colorslots - Color all spill stack slots and rewrite all frameindex machine
256 /// operands in the function.
257 bool StackSlotColoring::ColorSlots(MachineFunction &MF) {
258 unsigned NumObjs = MFI->getObjectIndexEnd();
259 SmallVector<int, 16> SlotMapping(NumObjs, -1);
260 SmallVector<float, 16> SlotWeights(NumObjs, 0.0);
261 SmallVector<SmallVector<int, 4>, 16> RevMap(NumObjs);
262 BitVector UsedColors(NumObjs);
264 DEBUG(dbgs() << "Color spill slot intervals:\n");
265 bool Changed = false;
266 for (unsigned i = 0, e = SSIntervals.size(); i != e; ++i) {
267 LiveInterval *li = SSIntervals[i];
268 int SS = TargetRegisterInfo::stackSlot2Index(li->reg);
269 int NewSS = ColorSlot(li);
270 assert(NewSS >= 0 && "Stack coloring failed?");
271 SlotMapping[SS] = NewSS;
272 RevMap[NewSS].push_back(SS);
273 SlotWeights[NewSS] += li->weight;
274 UsedColors.set(NewSS);
275 Changed |= (SS != NewSS);
278 DEBUG(dbgs() << "\nSpill slots after coloring:\n");
279 for (unsigned i = 0, e = SSIntervals.size(); i != e; ++i) {
280 LiveInterval *li = SSIntervals[i];
281 int SS = TargetRegisterInfo::stackSlot2Index(li->reg);
282 li->weight = SlotWeights[SS];
284 // Sort them by new weight.
285 std::stable_sort(SSIntervals.begin(), SSIntervals.end(), IntervalSorter());
288 for (unsigned i = 0, e = SSIntervals.size(); i != e; ++i)
289 DEBUG(SSIntervals[i]->dump());
290 DEBUG(dbgs() << '\n');
296 // Rewrite all MO_FrameIndex operands.
297 SmallVector<SmallSet<unsigned, 4>, 4> NewDefs(MF.getNumBlockIDs());
298 for (unsigned SS = 0, SE = SSRefs.size(); SS != SE; ++SS) {
299 int NewFI = SlotMapping[SS];
300 if (NewFI == -1 || (NewFI == (int)SS))
303 SmallVector<MachineInstr*, 8> &RefMIs = SSRefs[SS];
304 for (unsigned i = 0, e = RefMIs.size(); i != e; ++i)
305 RewriteInstruction(RefMIs[i], SS, NewFI, MF);
308 // Delete unused stack slots.
309 while (NextColor != -1) {
310 DEBUG(dbgs() << "Removing unused stack object fi#" << NextColor << "\n");
311 MFI->RemoveStackObject(NextColor);
312 NextColor = AllColors.find_next(NextColor);
318 /// RewriteInstruction - Rewrite specified instruction by replacing references
319 /// to old frame index with new one.
320 void StackSlotColoring::RewriteInstruction(MachineInstr *MI, int OldFI,
321 int NewFI, MachineFunction &MF) {
322 // Update the operands.
323 for (unsigned i = 0, ee = MI->getNumOperands(); i != ee; ++i) {
324 MachineOperand &MO = MI->getOperand(i);
327 int FI = MO.getIndex();
333 // Update the memory references. This changes the MachineMemOperands
334 // directly. They may be in use by multiple instructions, however all
335 // instructions using OldFI are being rewritten to use NewFI.
336 const Value *OldSV = PseudoSourceValue::getFixedStack(OldFI);
337 const Value *NewSV = PseudoSourceValue::getFixedStack(NewFI);
338 for (MachineInstr::mmo_iterator I = MI->memoperands_begin(),
339 E = MI->memoperands_end(); I != E; ++I)
340 if ((*I)->getValue() == OldSV)
341 (*I)->setValue(NewSV);
345 /// RemoveDeadStores - Scan through a basic block and look for loads followed
346 /// by stores. If they're both using the same stack slot, then the store is
347 /// definitely dead. This could obviously be much more aggressive (consider
348 /// pairs with instructions between them), but such extensions might have a
349 /// considerable compile time impact.
350 bool StackSlotColoring::RemoveDeadStores(MachineBasicBlock* MBB) {
351 // FIXME: This could be much more aggressive, but we need to investigate
352 // the compile time impact of doing so.
353 bool changed = false;
355 SmallVector<MachineInstr*, 4> toErase;
357 for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
359 if (DCELimit != -1 && (int)NumDead >= DCELimit)
362 MachineBasicBlock::iterator NextMI = llvm::next(I);
363 if (NextMI == MBB->end()) continue;
365 int FirstSS, SecondSS;
366 unsigned LoadReg = 0;
367 unsigned StoreReg = 0;
368 if (!(LoadReg = TII->isLoadFromStackSlot(I, FirstSS))) continue;
369 if (!(StoreReg = TII->isStoreToStackSlot(NextMI, SecondSS))) continue;
370 if (FirstSS != SecondSS || LoadReg != StoreReg || FirstSS == -1) continue;
375 if (NextMI->findRegisterUseOperandIdx(LoadReg, true, 0) != -1) {
377 toErase.push_back(I);
380 toErase.push_back(NextMI);
384 for (SmallVector<MachineInstr*, 4>::iterator I = toErase.begin(),
385 E = toErase.end(); I != E; ++I)
386 (*I)->eraseFromParent();
392 bool StackSlotColoring::runOnMachineFunction(MachineFunction &MF) {
394 dbgs() << "********** Stack Slot Coloring **********\n"
395 << "********** Function: "
396 << MF.getFunction()->getName() << '\n';
399 MFI = MF.getFrameInfo();
400 TII = MF.getTarget().getInstrInfo();
401 LS = &getAnalysis<LiveStacks>();
402 loopInfo = &getAnalysis<MachineLoopInfo>();
404 bool Changed = false;
406 unsigned NumSlots = LS->getNumIntervals();
411 // If there are calls to setjmp or sigsetjmp, don't perform stack slot
412 // coloring. The stack could be modified before the longjmp is executed,
413 // resulting in the wrong value being used afterwards. (See
414 // <rdar://problem/8007500>.)
415 if (MF.exposesReturnsTwice())
418 // Gather spill slot references
419 ScanForSpillSlotRefs(MF);
421 Changed = ColorSlots(MF);
425 for (unsigned i = 0, e = SSRefs.size(); i != e; ++i)
428 OrigAlignments.clear();
432 for (unsigned i = 0, e = Assignments.size(); i != e; ++i)
433 Assignments[i].clear();
437 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I)
438 Changed |= RemoveDeadStores(I);