blob: 62c9ddd6b2c2024c68c2744213bb9ce3ca41ca1c [file] [log] [blame]
Andrew Lenharth701f5ac2005-11-28 00:58:09 +00001//===- RSProfiling.cpp - Various profiling using random sampling ----------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Andrew Lenharth701f5ac2005-11-28 00:58:09 +00007//
8//===----------------------------------------------------------------------===//
9//
10// These passes implement a random sampling based profiling. Different methods
11// of choosing when to sample are supported, as well as different types of
12// profiling. This is done as two passes. The first is a sequence of profiling
Andrew Lenharthbb227c12005-11-28 18:00:38 +000013// passes which insert profiling into the program, and remember what they
14// inserted.
15//
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000016// The second stage duplicates all instructions in a function, ignoring the
17// profiling code, then connects the two versions togeather at the entry and at
18// backedges. At each connection point a choice is made as to whether to jump
19// to the profiled code (take a sample) or execute the unprofiled code.
20//
Gordon Henriksen55cbec32007-10-26 03:03:51 +000021// It is highly recommended that after this pass one runs mem2reg and adce
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000022// (instcombine load-vn gdce dse also are good to run afterwards)
23//
24// This design is intended to make the profiling passes independent of the RS
25// framework, but any profiling pass that implements the RSProfiling interface
26// is compatible with the rs framework (and thus can be sampled)
27//
28// TODO: obviously the block and function profiling are almost identical to the
29// existing ones, so they can be unified (esp since these passes are valid
30// without the rs framework).
31// TODO: Fix choice code so that frequency is not hard coded
32//
33//===----------------------------------------------------------------------===//
34
35#include "llvm/Pass.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000036#include "llvm/Module.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000037#include "llvm/Instructions.h"
38#include "llvm/Constants.h"
39#include "llvm/DerivedTypes.h"
Duncan Sandse2c43042008-04-07 13:45:04 +000040#include "llvm/Intrinsics.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000041#include "llvm/Transforms/Scalar.h"
42#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000043#include "llvm/Support/CommandLine.h"
Reid Spencer9133fe22007-02-05 23:32:05 +000044#include "llvm/Support/Compiler.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000045#include "llvm/Support/Debug.h"
46#include "llvm/Transforms/Instrumentation.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000047#include "RSProfiling.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000048#include <set>
49#include <map>
50#include <queue>
51#include <list>
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000052using namespace llvm;
53
54namespace {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000055 enum RandomMeth {
56 GBV, GBVO, HOSTCC
57 };
Dan Gohman844731a2008-05-13 00:00:25 +000058}
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000059
Dan Gohman844731a2008-05-13 00:00:25 +000060static cl::opt<RandomMeth> RandomMethod("profile-randomness",
61 cl::desc("How to randomly choose to profile:"),
62 cl::values(
63 clEnumValN(GBV, "global", "global counter"),
64 clEnumValN(GBVO, "ra_global",
65 "register allocated global counter"),
66 clEnumValN(HOSTCC, "rdcc", "cycle counter"),
67 clEnumValEnd));
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000068
Dan Gohman844731a2008-05-13 00:00:25 +000069namespace {
Andrew Lenharth8dc2d502005-11-28 18:10:59 +000070 /// NullProfilerRS - The basic profiler that does nothing. It is the default
71 /// profiler and thus terminates RSProfiler chains. It is useful for
72 /// measuring framework overhead
Reid Spencer9133fe22007-02-05 23:32:05 +000073 class VISIBILITY_HIDDEN NullProfilerRS : public RSProfilers {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000074 public:
Nick Lewyckyecd94c82007-05-06 13:37:16 +000075 static char ID; // Pass identification, replacement for typeid
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000076 bool isProfiling(Value* v) {
77 return false;
78 }
79 bool runOnModule(Module &M) {
80 return false;
81 }
82 void getAnalysisUsage(AnalysisUsage &AU) const {
83 AU.setPreservesAll();
84 }
85 };
Dan Gohman844731a2008-05-13 00:00:25 +000086}
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000087
Dan Gohman844731a2008-05-13 00:00:25 +000088static RegisterAnalysisGroup<RSProfilers> A("Profiling passes");
89static RegisterPass<NullProfilerRS> NP("insert-null-profiling-rs",
90 "Measure profiling framework overhead");
91static RegisterAnalysisGroup<RSProfilers, true> NPT(NP);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000092
Dan Gohman844731a2008-05-13 00:00:25 +000093namespace {
Andrew Lenharth8dc2d502005-11-28 18:10:59 +000094 /// Chooser - Something that chooses when to make a sample of the profiled code
Reid Spencer9133fe22007-02-05 23:32:05 +000095 class VISIBILITY_HIDDEN Chooser {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000096 public:
Andrew Lenharth8dc2d502005-11-28 18:10:59 +000097 /// ProcessChoicePoint - is called for each basic block inserted to choose
98 /// between normal and sample code
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000099 virtual void ProcessChoicePoint(BasicBlock*) = 0;
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000100 /// PrepFunction - is called once per function before other work is done.
101 /// This gives the opertunity to insert new allocas and such.
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000102 virtual void PrepFunction(Function*) = 0;
103 virtual ~Chooser() {}
104 };
105
106 //Things that implement sampling policies
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000107 //A global value that is read-mod-stored to choose when to sample.
108 //A sample is taken when the global counter hits 0
Reid Spencer9133fe22007-02-05 23:32:05 +0000109 class VISIBILITY_HIDDEN GlobalRandomCounter : public Chooser {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000110 GlobalVariable* Counter;
111 Value* ResetValue;
112 const Type* T;
113 public:
114 GlobalRandomCounter(Module& M, const Type* t, uint64_t resetval);
115 virtual ~GlobalRandomCounter();
116 virtual void PrepFunction(Function* F);
117 virtual void ProcessChoicePoint(BasicBlock* bb);
118 };
119
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000120 //Same is GRC, but allow register allocation of the global counter
Reid Spencer9133fe22007-02-05 23:32:05 +0000121 class VISIBILITY_HIDDEN GlobalRandomCounterOpt : public Chooser {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000122 GlobalVariable* Counter;
123 Value* ResetValue;
124 AllocaInst* AI;
125 const Type* T;
126 public:
127 GlobalRandomCounterOpt(Module& M, const Type* t, uint64_t resetval);
128 virtual ~GlobalRandomCounterOpt();
129 virtual void PrepFunction(Function* F);
130 virtual void ProcessChoicePoint(BasicBlock* bb);
131 };
132
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000133 //Use the cycle counter intrinsic as a source of pseudo randomness when
134 //deciding when to sample.
Reid Spencer9133fe22007-02-05 23:32:05 +0000135 class VISIBILITY_HIDDEN CycleCounter : public Chooser {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000136 uint64_t rm;
Chris Lattnerfebe5f12007-01-07 07:22:20 +0000137 Constant *F;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000138 public:
139 CycleCounter(Module& m, uint64_t resetmask);
140 virtual ~CycleCounter();
141 virtual void PrepFunction(Function* F);
142 virtual void ProcessChoicePoint(BasicBlock* bb);
143 };
144
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000145 /// ProfilerRS - Insert the random sampling framework
Reid Spencer9133fe22007-02-05 23:32:05 +0000146 struct VISIBILITY_HIDDEN ProfilerRS : public FunctionPass {
Nick Lewyckyecd94c82007-05-06 13:37:16 +0000147 static char ID; // Pass identification, replacement for typeid
Devang Patel794fd752007-05-01 21:15:47 +0000148 ProfilerRS() : FunctionPass((intptr_t)&ID) {}
149
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000150 std::map<Value*, Value*> TransCache;
151 std::set<BasicBlock*> ChoicePoints;
152 Chooser* c;
153
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000154 //Translate and duplicate values for the new profile free version of stuff
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000155 Value* Translate(Value* v);
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000156 //Duplicate an entire function (with out profiling)
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000157 void Duplicate(Function& F, RSProfilers& LI);
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000158 //Called once for each backedge, handle the insertion of choice points and
159 //the interconection of the two versions of the code
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000160 void ProcessBackEdge(BasicBlock* src, BasicBlock* dst, Function& F);
161 bool runOnFunction(Function& F);
162 bool doInitialization(Module &M);
163 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
164 };
Chris Lattnerd74ea2b2006-05-24 17:04:05 +0000165}
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000166
Dan Gohman844731a2008-05-13 00:00:25 +0000167static RegisterPass<ProfilerRS>
168X("insert-rs-profiling-framework",
169 "Insert random sampling instrumentation framework");
170
Devang Patel19974732007-05-03 01:11:54 +0000171char RSProfilers::ID = 0;
172char NullProfilerRS::ID = 0;
173char ProfilerRS::ID = 0;
Lauro Ramos Venancioc7182882007-05-02 20:37:47 +0000174
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000175//Local utilities
176static void ReplacePhiPred(BasicBlock* btarget,
177 BasicBlock* bold, BasicBlock* bnew);
178
179static void CollapsePhi(BasicBlock* btarget, BasicBlock* bsrc);
180
181template<class T>
182static void recBackEdge(BasicBlock* bb, T& BackEdges,
183 std::map<BasicBlock*, int>& color,
184 std::map<BasicBlock*, int>& depth,
185 std::map<BasicBlock*, int>& finish,
186 int& time);
187
188//find the back edges and where they go to
189template<class T>
190static void getBackEdges(Function& F, T& BackEdges);
191
192
193///////////////////////////////////////
194// Methods of choosing when to profile
195///////////////////////////////////////
196
197GlobalRandomCounter::GlobalRandomCounter(Module& M, const Type* t,
198 uint64_t resetval) : T(t) {
Reid Spencerb83eb642006-10-20 07:07:24 +0000199 ConstantInt* Init = ConstantInt::get(T, resetval);
200 ResetValue = Init;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000201 Counter = new GlobalVariable(T, false, GlobalValue::InternalLinkage,
Reid Spencerb83eb642006-10-20 07:07:24 +0000202 Init, "RandomSteeringCounter", &M);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000203}
204
205GlobalRandomCounter::~GlobalRandomCounter() {}
206
207void GlobalRandomCounter::PrepFunction(Function* F) {}
208
209void GlobalRandomCounter::ProcessChoicePoint(BasicBlock* bb) {
210 BranchInst* t = cast<BranchInst>(bb->getTerminator());
211
212 //decrement counter
213 LoadInst* l = new LoadInst(Counter, "counter", t);
214
Reid Spencere4d87aa2006-12-23 06:05:41 +0000215 ICmpInst* s = new ICmpInst(ICmpInst::ICMP_EQ, l, ConstantInt::get(T, 0),
216 "countercc", t);
217
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000218 Value* nv = BinaryOperator::createSub(l, ConstantInt::get(T, 1),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000219 "counternew", t);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000220 new StoreInst(nv, Counter, t);
221 t->setCondition(s);
222
223 //reset counter
224 BasicBlock* oldnext = t->getSuccessor(0);
Gabor Greif051a9502008-04-06 20:25:17 +0000225 BasicBlock* resetblock = BasicBlock::Create("reset", oldnext->getParent(),
226 oldnext);
227 TerminatorInst* t2 = BranchInst::Create(oldnext, resetblock);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000228 t->setSuccessor(0, resetblock);
229 new StoreInst(ResetValue, Counter, t2);
230 ReplacePhiPred(oldnext, bb, resetblock);
231}
232
233GlobalRandomCounterOpt::GlobalRandomCounterOpt(Module& M, const Type* t,
234 uint64_t resetval)
235 : AI(0), T(t) {
Reid Spencerb83eb642006-10-20 07:07:24 +0000236 ConstantInt* Init = ConstantInt::get(T, resetval);
237 ResetValue = Init;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000238 Counter = new GlobalVariable(T, false, GlobalValue::InternalLinkage,
Reid Spencerb83eb642006-10-20 07:07:24 +0000239 Init, "RandomSteeringCounter", &M);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000240}
241
242GlobalRandomCounterOpt::~GlobalRandomCounterOpt() {}
243
244void GlobalRandomCounterOpt::PrepFunction(Function* F) {
245 //make a local temporary to cache the global
246 BasicBlock& bb = F->getEntryBlock();
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000247 BasicBlock::iterator InsertPt = bb.begin();
248 AI = new AllocaInst(T, 0, "localcounter", InsertPt);
249 LoadInst* l = new LoadInst(Counter, "counterload", InsertPt);
250 new StoreInst(l, AI, InsertPt);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000251
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000252 //modify all functions and return values to restore the local variable to/from
253 //the global variable
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000254 for(Function::iterator fib = F->begin(), fie = F->end();
255 fib != fie; ++fib)
256 for(BasicBlock::iterator bib = fib->begin(), bie = fib->end();
257 bib != bie; ++bib)
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000258 if (isa<CallInst>(bib)) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000259 LoadInst* l = new LoadInst(AI, "counter", bib);
260 new StoreInst(l, Counter, bib);
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000261 l = new LoadInst(Counter, "counter", ++bib);
262 new StoreInst(l, AI, bib--);
263 } else if (isa<InvokeInst>(bib)) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000264 LoadInst* l = new LoadInst(AI, "counter", bib);
265 new StoreInst(l, Counter, bib);
266
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000267 BasicBlock* bb = cast<InvokeInst>(bib)->getNormalDest();
268 BasicBlock::iterator i = bb->begin();
269 while (isa<PHINode>(i))
270 ++i;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000271 l = new LoadInst(Counter, "counter", i);
272
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000273 bb = cast<InvokeInst>(bib)->getUnwindDest();
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000274 i = bb->begin();
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000275 while (isa<PHINode>(i)) ++i;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000276 l = new LoadInst(Counter, "counter", i);
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000277 new StoreInst(l, AI, i);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000278 } else if (isa<UnwindInst>(&*bib) || isa<ReturnInst>(&*bib)) {
279 LoadInst* l = new LoadInst(AI, "counter", bib);
280 new StoreInst(l, Counter, bib);
281 }
282}
283
284void GlobalRandomCounterOpt::ProcessChoicePoint(BasicBlock* bb) {
285 BranchInst* t = cast<BranchInst>(bb->getTerminator());
286
287 //decrement counter
288 LoadInst* l = new LoadInst(AI, "counter", t);
289
Reid Spencere4d87aa2006-12-23 06:05:41 +0000290 ICmpInst* s = new ICmpInst(ICmpInst::ICMP_EQ, l, ConstantInt::get(T, 0),
291 "countercc", t);
292
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000293 Value* nv = BinaryOperator::createSub(l, ConstantInt::get(T, 1),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000294 "counternew", t);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000295 new StoreInst(nv, AI, t);
296 t->setCondition(s);
297
298 //reset counter
299 BasicBlock* oldnext = t->getSuccessor(0);
Gabor Greif051a9502008-04-06 20:25:17 +0000300 BasicBlock* resetblock = BasicBlock::Create("reset", oldnext->getParent(),
301 oldnext);
302 TerminatorInst* t2 = BranchInst::Create(oldnext, resetblock);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000303 t->setSuccessor(0, resetblock);
304 new StoreInst(ResetValue, AI, t2);
305 ReplacePhiPred(oldnext, bb, resetblock);
306}
307
308
309CycleCounter::CycleCounter(Module& m, uint64_t resetmask) : rm(resetmask) {
Duncan Sandse2c43042008-04-07 13:45:04 +0000310 F = Intrinsic::getDeclaration(&m, Intrinsic::readcyclecounter);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000311}
312
313CycleCounter::~CycleCounter() {}
314
315void CycleCounter::PrepFunction(Function* F) {}
316
317void CycleCounter::ProcessChoicePoint(BasicBlock* bb) {
318 BranchInst* t = cast<BranchInst>(bb->getTerminator());
319
Gabor Greif051a9502008-04-06 20:25:17 +0000320 CallInst* c = CallInst::Create(F, "rdcc", t);
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000321 BinaryOperator* b =
Reid Spencerc5b206b2006-12-31 05:48:39 +0000322 BinaryOperator::createAnd(c, ConstantInt::get(Type::Int64Ty, rm),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000323 "mrdcc", t);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000324
Reid Spencere4d87aa2006-12-23 06:05:41 +0000325 ICmpInst *s = new ICmpInst(ICmpInst::ICMP_EQ, b,
Reid Spencerc5b206b2006-12-31 05:48:39 +0000326 ConstantInt::get(Type::Int64Ty, 0),
Reid Spencere4d87aa2006-12-23 06:05:41 +0000327 "mrdccc", t);
328
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000329 t->setCondition(s);
330}
331
332///////////////////////////////////////
333// Profiling:
334///////////////////////////////////////
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000335bool RSProfilers_std::isProfiling(Value* v) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000336 if (profcode.find(v) != profcode.end())
337 return true;
338 //else
339 RSProfilers& LI = getAnalysis<RSProfilers>();
340 return LI.isProfiling(v);
341}
342
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000343void RSProfilers_std::IncrementCounterInBlock(BasicBlock *BB, unsigned CounterNum,
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000344 GlobalValue *CounterArray) {
345 // Insert the increment after any alloca or PHI instructions...
346 BasicBlock::iterator InsertPos = BB->begin();
347 while (isa<AllocaInst>(InsertPos) || isa<PHINode>(InsertPos))
348 ++InsertPos;
349
350 // Create the getelementptr constant expression
351 std::vector<Constant*> Indices(2);
Reid Spencerc5b206b2006-12-31 05:48:39 +0000352 Indices[0] = Constant::getNullValue(Type::Int32Ty);
353 Indices[1] = ConstantInt::get(Type::Int32Ty, CounterNum);
Chris Lattnerec1f7522007-02-19 07:34:47 +0000354 Constant *ElementPtr = ConstantExpr::getGetElementPtr(CounterArray,
355 &Indices[0], 2);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000356
357 // Load, increment and store the value back.
358 Value *OldVal = new LoadInst(ElementPtr, "OldCounter", InsertPos);
359 profcode.insert(OldVal);
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000360 Value *NewVal = BinaryOperator::createAdd(OldVal,
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000361 ConstantInt::get(Type::Int32Ty, 1),
362 "NewCounter", InsertPos);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000363 profcode.insert(NewVal);
364 profcode.insert(new StoreInst(NewVal, ElementPtr, InsertPos));
365}
366
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000367void RSProfilers_std::getAnalysisUsage(AnalysisUsage &AU) const {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000368 //grab any outstanding profiler, or get the null one
369 AU.addRequired<RSProfilers>();
370}
371
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000372///////////////////////////////////////
373// RS Framework
374///////////////////////////////////////
375
376Value* ProfilerRS::Translate(Value* v) {
377 if(TransCache[v])
378 return TransCache[v];
379
380 if (BasicBlock* bb = dyn_cast<BasicBlock>(v)) {
381 if (bb == &bb->getParent()->getEntryBlock())
382 TransCache[bb] = bb; //don't translate entry block
383 else
Gabor Greif051a9502008-04-06 20:25:17 +0000384 TransCache[bb] = BasicBlock::Create("dup_" + bb->getName(), bb->getParent(),
385 NULL);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000386 return TransCache[bb];
387 } else if (Instruction* i = dyn_cast<Instruction>(v)) {
388 //we have already translated this
389 //do not translate entry block allocas
390 if(&i->getParent()->getParent()->getEntryBlock() == i->getParent()) {
391 TransCache[i] = i;
392 return i;
393 } else {
394 //translate this
395 Instruction* i2 = i->clone();
396 if (i->hasName())
397 i2->setName("dup_" + i->getName());
398 TransCache[i] = i2;
399 //NumNewInst++;
400 for (unsigned x = 0; x < i2->getNumOperands(); ++x)
401 i2->setOperand(x, Translate(i2->getOperand(x)));
402 return i2;
403 }
404 } else if (isa<Function>(v) || isa<Constant>(v) || isa<Argument>(v)) {
405 TransCache[v] = v;
406 return v;
407 }
408 assert(0 && "Value not handled");
Jeff Cohen3523f6e2005-11-28 06:45:57 +0000409 return 0;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000410}
411
412void ProfilerRS::Duplicate(Function& F, RSProfilers& LI)
413{
414 //perform a breadth first search, building up a duplicate of the code
415 std::queue<BasicBlock*> worklist;
416 std::set<BasicBlock*> seen;
417
418 //This loop ensures proper BB order, to help performance
419 for (Function::iterator fib = F.begin(), fie = F.end(); fib != fie; ++fib)
420 worklist.push(fib);
421 while (!worklist.empty()) {
422 Translate(worklist.front());
423 worklist.pop();
424 }
425
426 //remember than reg2mem created a new entry block we don't want to duplicate
427 worklist.push(F.getEntryBlock().getTerminator()->getSuccessor(0));
428 seen.insert(&F.getEntryBlock());
429
430 while (!worklist.empty()) {
431 BasicBlock* bb = worklist.front();
432 worklist.pop();
433 if(seen.find(bb) == seen.end()) {
434 BasicBlock* bbtarget = cast<BasicBlock>(Translate(bb));
435 BasicBlock::InstListType& instlist = bbtarget->getInstList();
436 for (BasicBlock::iterator iib = bb->begin(), iie = bb->end();
437 iib != iie; ++iib) {
438 //NumOldInst++;
439 if (!LI.isProfiling(&*iib)) {
440 Instruction* i = cast<Instruction>(Translate(iib));
441 instlist.insert(bbtarget->end(), i);
442 }
443 }
444 //updated search state;
445 seen.insert(bb);
446 TerminatorInst* ti = bb->getTerminator();
447 for (unsigned x = 0; x < ti->getNumSuccessors(); ++x) {
448 BasicBlock* bbs = ti->getSuccessor(x);
449 if (seen.find(bbs) == seen.end()) {
450 worklist.push(bbs);
451 }
452 }
453 }
454 }
455}
456
457void ProfilerRS::ProcessBackEdge(BasicBlock* src, BasicBlock* dst, Function& F) {
458 //given a backedge from B -> A, and translations A' and B',
459 //a: insert C and C'
460 //b: add branches in C to A and A' and in C' to A and A'
461 //c: mod terminators@B, replace A with C
462 //d: mod terminators@B', replace A' with C'
463 //e: mod phis@A for pred B to be pred C
464 // if multiple entries, simplify to one
465 //f: mod phis@A' for pred B' to be pred C'
466 // if multiple entries, simplify to one
467 //g: for all phis@A with pred C using x
468 // add in edge from C' using x'
469 // add in edge from C using x in A'
470
471 //a:
Chris Lattnere24c92a2007-04-17 17:54:12 +0000472 Function::iterator BBN = src; ++BBN;
Gabor Greif051a9502008-04-06 20:25:17 +0000473 BasicBlock* bbC = BasicBlock::Create("choice", &F, BBN);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000474 //ChoicePoints.insert(bbC);
Chris Lattnere24c92a2007-04-17 17:54:12 +0000475 BBN = cast<BasicBlock>(Translate(src));
Gabor Greif051a9502008-04-06 20:25:17 +0000476 BasicBlock* bbCp = BasicBlock::Create("choice", &F, ++BBN);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000477 ChoicePoints.insert(bbCp);
478
479 //b:
Gabor Greif051a9502008-04-06 20:25:17 +0000480 BranchInst::Create(cast<BasicBlock>(Translate(dst)), bbC);
481 BranchInst::Create(dst, cast<BasicBlock>(Translate(dst)),
482 ConstantInt::get(Type::Int1Ty, true), bbCp);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000483 //c:
484 {
485 TerminatorInst* iB = src->getTerminator();
486 for (unsigned x = 0; x < iB->getNumSuccessors(); ++x)
487 if (iB->getSuccessor(x) == dst)
488 iB->setSuccessor(x, bbC);
489 }
490 //d:
491 {
492 TerminatorInst* iBp = cast<TerminatorInst>(Translate(src->getTerminator()));
493 for (unsigned x = 0; x < iBp->getNumSuccessors(); ++x)
494 if (iBp->getSuccessor(x) == cast<BasicBlock>(Translate(dst)))
495 iBp->setSuccessor(x, bbCp);
496 }
497 //e:
498 ReplacePhiPred(dst, src, bbC);
499 //src could be a switch, in which case we are replacing several edges with one
500 //thus collapse those edges int the Phi
501 CollapsePhi(dst, bbC);
502 //f:
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000503 ReplacePhiPred(cast<BasicBlock>(Translate(dst)),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000504 cast<BasicBlock>(Translate(src)),bbCp);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000505 CollapsePhi(cast<BasicBlock>(Translate(dst)), bbCp);
506 //g:
507 for(BasicBlock::iterator ib = dst->begin(), ie = dst->end(); ib != ie;
508 ++ib)
509 if (PHINode* phi = dyn_cast<PHINode>(&*ib)) {
510 for(unsigned x = 0; x < phi->getNumIncomingValues(); ++x)
511 if(bbC == phi->getIncomingBlock(x)) {
512 phi->addIncoming(Translate(phi->getIncomingValue(x)), bbCp);
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000513 cast<PHINode>(Translate(phi))->addIncoming(phi->getIncomingValue(x),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000514 bbC);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000515 }
516 phi->removeIncomingValue(bbC);
517 }
518}
519
520bool ProfilerRS::runOnFunction(Function& F) {
Reid Spencer5cbf9852007-01-30 20:08:39 +0000521 if (!F.isDeclaration()) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000522 std::set<std::pair<BasicBlock*, BasicBlock*> > BackEdges;
523 RSProfilers& LI = getAnalysis<RSProfilers>();
524
525 getBackEdges(F, BackEdges);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000526 Duplicate(F, LI);
527 //assume that stuff worked. now connect the duplicated basic blocks
528 //with the originals in such a way as to preserve ssa. yuk!
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000529 for (std::set<std::pair<BasicBlock*, BasicBlock*> >::iterator
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000530 ib = BackEdges.begin(), ie = BackEdges.end(); ib != ie; ++ib)
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000531 ProcessBackEdge(ib->first, ib->second, F);
532
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000533 //oh, and add the edge from the reg2mem created entry node to the
534 //duplicated second node
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000535 TerminatorInst* T = F.getEntryBlock().getTerminator();
Gabor Greif051a9502008-04-06 20:25:17 +0000536 ReplaceInstWithInst(T, BranchInst::Create(T->getSuccessor(0),
537 cast<BasicBlock>(
538 Translate(T->getSuccessor(0))),
539 ConstantInt::get(Type::Int1Ty,
540 true)));
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000541
542 //do whatever is needed now that the function is duplicated
543 c->PrepFunction(&F);
544
545 //add entry node to choice points
546 ChoicePoints.insert(&F.getEntryBlock());
547
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000548 for (std::set<BasicBlock*>::iterator
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000549 ii = ChoicePoints.begin(), ie = ChoicePoints.end(); ii != ie; ++ii)
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000550 c->ProcessChoicePoint(*ii);
551
552 ChoicePoints.clear();
553 TransCache.clear();
554
555 return true;
556 }
557 return false;
558}
559
560bool ProfilerRS::doInitialization(Module &M) {
561 switch (RandomMethod) {
562 case GBV:
Reid Spencerc5b206b2006-12-31 05:48:39 +0000563 c = new GlobalRandomCounter(M, Type::Int32Ty, (1 << 14) - 1);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000564 break;
565 case GBVO:
Reid Spencerc5b206b2006-12-31 05:48:39 +0000566 c = new GlobalRandomCounterOpt(M, Type::Int32Ty, (1 << 14) - 1);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000567 break;
568 case HOSTCC:
569 c = new CycleCounter(M, (1 << 14) - 1);
570 break;
571 };
572 return true;
573}
574
575void ProfilerRS::getAnalysisUsage(AnalysisUsage &AU) const {
576 AU.addRequired<RSProfilers>();
577 AU.addRequiredID(DemoteRegisterToMemoryID);
578}
579
580///////////////////////////////////////
581// Utilities:
582///////////////////////////////////////
583static void ReplacePhiPred(BasicBlock* btarget,
584 BasicBlock* bold, BasicBlock* bnew) {
585 for(BasicBlock::iterator ib = btarget->begin(), ie = btarget->end();
586 ib != ie; ++ib)
587 if (PHINode* phi = dyn_cast<PHINode>(&*ib)) {
588 for(unsigned x = 0; x < phi->getNumIncomingValues(); ++x)
589 if(bold == phi->getIncomingBlock(x))
590 phi->setIncomingBlock(x, bnew);
591 }
592}
593
594static void CollapsePhi(BasicBlock* btarget, BasicBlock* bsrc) {
595 for(BasicBlock::iterator ib = btarget->begin(), ie = btarget->end();
596 ib != ie; ++ib)
597 if (PHINode* phi = dyn_cast<PHINode>(&*ib)) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000598 std::map<BasicBlock*, Value*> counter;
599 for(unsigned i = 0; i < phi->getNumIncomingValues(); ) {
600 if (counter[phi->getIncomingBlock(i)]) {
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000601 assert(phi->getIncomingValue(i) == counter[phi->getIncomingBlock(i)]);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000602 phi->removeIncomingValue(i, false);
603 } else {
604 counter[phi->getIncomingBlock(i)] = phi->getIncomingValue(i);
605 ++i;
606 }
607 }
608 }
609}
610
611template<class T>
612static void recBackEdge(BasicBlock* bb, T& BackEdges,
613 std::map<BasicBlock*, int>& color,
614 std::map<BasicBlock*, int>& depth,
615 std::map<BasicBlock*, int>& finish,
616 int& time)
617{
618 color[bb] = 1;
619 ++time;
620 depth[bb] = time;
621 TerminatorInst* t= bb->getTerminator();
622 for(unsigned i = 0; i < t->getNumSuccessors(); ++i) {
623 BasicBlock* bbnew = t->getSuccessor(i);
624 if (color[bbnew] == 0)
625 recBackEdge(bbnew, BackEdges, color, depth, finish, time);
626 else if (color[bbnew] == 1) {
627 BackEdges.insert(std::make_pair(bb, bbnew));
628 //NumBackEdges++;
629 }
630 }
631 color[bb] = 2;
632 ++time;
633 finish[bb] = time;
634}
635
636
637
638//find the back edges and where they go to
639template<class T>
640static void getBackEdges(Function& F, T& BackEdges) {
641 std::map<BasicBlock*, int> color;
642 std::map<BasicBlock*, int> depth;
643 std::map<BasicBlock*, int> finish;
644 int time = 0;
645 recBackEdge(&F.getEntryBlock(), BackEdges, color, depth, finish, time);
Bill Wendling62c804a2006-11-26 09:17:06 +0000646 DOUT << F.getName() << " " << BackEdges.size() << "\n";
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000647}
648
649
650//Creation functions
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000651ModulePass* llvm::createNullProfilerRSPass() {
652 return new NullProfilerRS();
653}
654
655FunctionPass* llvm::createRSProfilingPass() {
656 return new ProfilerRS();
657}