blob: c08efc1e4bdd4968a7035e0eac43d22faf52da2d [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"
Owen Anderson50895512009-07-06 18:42:36 +000036#include "llvm/LLVMContext.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000037#include "llvm/Module.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000038#include "llvm/Instructions.h"
39#include "llvm/Constants.h"
40#include "llvm/DerivedTypes.h"
Duncan Sandse2c43042008-04-07 13:45:04 +000041#include "llvm/Intrinsics.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000042#include "llvm/Transforms/Scalar.h"
43#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000044#include "llvm/Support/CommandLine.h"
45#include "llvm/Support/Debug.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000046#include "llvm/Support/ErrorHandling.h"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +000047#include "llvm/Support/raw_ostream.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000048#include "llvm/Transforms/Instrumentation.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000049#include "RSProfiling.h"
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000050#include <set>
51#include <map>
52#include <queue>
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000053using namespace llvm;
54
55namespace {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000056 enum RandomMeth {
57 GBV, GBVO, HOSTCC
58 };
Dan Gohman844731a2008-05-13 00:00:25 +000059}
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000060
Dan Gohman844731a2008-05-13 00:00:25 +000061static cl::opt<RandomMeth> RandomMethod("profile-randomness",
62 cl::desc("How to randomly choose to profile:"),
63 cl::values(
64 clEnumValN(GBV, "global", "global counter"),
65 clEnumValN(GBVO, "ra_global",
66 "register allocated global counter"),
67 clEnumValN(HOSTCC, "rdcc", "cycle counter"),
68 clEnumValEnd));
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000069
Dan Gohman844731a2008-05-13 00:00:25 +000070namespace {
Andrew Lenharth8dc2d502005-11-28 18:10:59 +000071 /// NullProfilerRS - The basic profiler that does nothing. It is the default
72 /// profiler and thus terminates RSProfiler chains. It is useful for
73 /// measuring framework overhead
Nick Lewycky6726b6d2009-10-25 06:33:48 +000074 class NullProfilerRS : public RSProfilers {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000075 public:
Nick Lewyckyecd94c82007-05-06 13:37:16 +000076 static char ID; // Pass identification, replacement for typeid
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000077 bool isProfiling(Value* v) {
78 return false;
79 }
80 bool runOnModule(Module &M) {
81 return false;
82 }
83 void getAnalysisUsage(AnalysisUsage &AU) const {
84 AU.setPreservesAll();
85 }
86 };
Dan Gohman844731a2008-05-13 00:00:25 +000087}
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000088
Dan Gohman844731a2008-05-13 00:00:25 +000089static RegisterAnalysisGroup<RSProfilers> A("Profiling passes");
90static RegisterPass<NullProfilerRS> NP("insert-null-profiling-rs",
91 "Measure profiling framework overhead");
92static RegisterAnalysisGroup<RSProfilers, true> NPT(NP);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000093
Dan Gohman844731a2008-05-13 00:00:25 +000094namespace {
Andrew Lenharth8dc2d502005-11-28 18:10:59 +000095 /// Chooser - Something that chooses when to make a sample of the profiled code
Nick Lewycky6726b6d2009-10-25 06:33:48 +000096 class Chooser {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +000097 public:
Andrew Lenharth8dc2d502005-11-28 18:10:59 +000098 /// ProcessChoicePoint - is called for each basic block inserted to choose
99 /// between normal and sample code
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000100 virtual void ProcessChoicePoint(BasicBlock*) = 0;
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000101 /// PrepFunction - is called once per function before other work is done.
102 /// This gives the opertunity to insert new allocas and such.
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000103 virtual void PrepFunction(Function*) = 0;
104 virtual ~Chooser() {}
105 };
106
107 //Things that implement sampling policies
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000108 //A global value that is read-mod-stored to choose when to sample.
109 //A sample is taken when the global counter hits 0
Nick Lewycky6726b6d2009-10-25 06:33:48 +0000110 class GlobalRandomCounter : public Chooser {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000111 GlobalVariable* Counter;
112 Value* ResetValue;
Dan Gohman6de29f82009-06-15 22:12:54 +0000113 const IntegerType* T;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000114 public:
Dan Gohman6de29f82009-06-15 22:12:54 +0000115 GlobalRandomCounter(Module& M, const IntegerType* t, uint64_t resetval);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000116 virtual ~GlobalRandomCounter();
117 virtual void PrepFunction(Function* F);
118 virtual void ProcessChoicePoint(BasicBlock* bb);
119 };
120
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000121 //Same is GRC, but allow register allocation of the global counter
Nick Lewycky6726b6d2009-10-25 06:33:48 +0000122 class GlobalRandomCounterOpt : public Chooser {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000123 GlobalVariable* Counter;
124 Value* ResetValue;
125 AllocaInst* AI;
Dan Gohman6de29f82009-06-15 22:12:54 +0000126 const IntegerType* T;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000127 public:
Dan Gohman6de29f82009-06-15 22:12:54 +0000128 GlobalRandomCounterOpt(Module& M, const IntegerType* t, uint64_t resetval);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000129 virtual ~GlobalRandomCounterOpt();
130 virtual void PrepFunction(Function* F);
131 virtual void ProcessChoicePoint(BasicBlock* bb);
132 };
133
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000134 //Use the cycle counter intrinsic as a source of pseudo randomness when
135 //deciding when to sample.
Nick Lewycky6726b6d2009-10-25 06:33:48 +0000136 class CycleCounter : public Chooser {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000137 uint64_t rm;
Chris Lattnerfebe5f12007-01-07 07:22:20 +0000138 Constant *F;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000139 public:
140 CycleCounter(Module& m, uint64_t resetmask);
141 virtual ~CycleCounter();
142 virtual void PrepFunction(Function* F);
143 virtual void ProcessChoicePoint(BasicBlock* bb);
144 };
145
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000146 /// ProfilerRS - Insert the random sampling framework
Nick Lewycky6726b6d2009-10-25 06:33:48 +0000147 struct ProfilerRS : public FunctionPass {
Nick Lewyckyecd94c82007-05-06 13:37:16 +0000148 static char ID; // Pass identification, replacement for typeid
Dan Gohmanae73dc12008-09-04 17:05:41 +0000149 ProfilerRS() : FunctionPass(&ID) {}
Devang Patel794fd752007-05-01 21:15:47 +0000150
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000151 std::map<Value*, Value*> TransCache;
152 std::set<BasicBlock*> ChoicePoints;
153 Chooser* c;
154
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000155 //Translate and duplicate values for the new profile free version of stuff
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000156 Value* Translate(Value* v);
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000157 //Duplicate an entire function (with out profiling)
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000158 void Duplicate(Function& F, RSProfilers& LI);
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000159 //Called once for each backedge, handle the insertion of choice points and
160 //the interconection of the two versions of the code
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000161 void ProcessBackEdge(BasicBlock* src, BasicBlock* dst, Function& F);
162 bool runOnFunction(Function& F);
163 bool doInitialization(Module &M);
164 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
165 };
Chris Lattnerd74ea2b2006-05-24 17:04:05 +0000166}
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000167
Dan Gohman844731a2008-05-13 00:00:25 +0000168static RegisterPass<ProfilerRS>
169X("insert-rs-profiling-framework",
170 "Insert random sampling instrumentation framework");
171
Devang Patel19974732007-05-03 01:11:54 +0000172char RSProfilers::ID = 0;
173char NullProfilerRS::ID = 0;
174char ProfilerRS::ID = 0;
Lauro Ramos Venancioc7182882007-05-02 20:37:47 +0000175
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000176//Local utilities
177static void ReplacePhiPred(BasicBlock* btarget,
178 BasicBlock* bold, BasicBlock* bnew);
179
180static void CollapsePhi(BasicBlock* btarget, BasicBlock* bsrc);
181
182template<class T>
183static void recBackEdge(BasicBlock* bb, T& BackEdges,
184 std::map<BasicBlock*, int>& color,
185 std::map<BasicBlock*, int>& depth,
186 std::map<BasicBlock*, int>& finish,
187 int& time);
188
189//find the back edges and where they go to
190template<class T>
191static void getBackEdges(Function& F, T& BackEdges);
192
193
194///////////////////////////////////////
195// Methods of choosing when to profile
196///////////////////////////////////////
197
Dan Gohman6de29f82009-06-15 22:12:54 +0000198GlobalRandomCounter::GlobalRandomCounter(Module& M, const IntegerType* t,
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000199 uint64_t resetval) : T(t) {
Owen Andersoneed707b2009-07-24 23:12:02 +0000200 ConstantInt* Init = ConstantInt::get(T, resetval);
Reid Spencerb83eb642006-10-20 07:07:24 +0000201 ResetValue = Init;
Owen Andersone9b11b42009-07-08 19:03:57 +0000202 Counter = new GlobalVariable(M, T, false, GlobalValue::InternalLinkage,
203 Init, "RandomSteeringCounter");
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000204}
205
206GlobalRandomCounter::~GlobalRandomCounter() {}
207
208void GlobalRandomCounter::PrepFunction(Function* F) {}
209
210void GlobalRandomCounter::ProcessChoicePoint(BasicBlock* bb) {
211 BranchInst* t = cast<BranchInst>(bb->getTerminator());
212
213 //decrement counter
214 LoadInst* l = new LoadInst(Counter, "counter", t);
215
Owen Anderson333c4002009-07-09 23:48:35 +0000216 ICmpInst* s = new ICmpInst(t, ICmpInst::ICMP_EQ, l,
Owen Andersoneed707b2009-07-24 23:12:02 +0000217 ConstantInt::get(T, 0),
Owen Anderson333c4002009-07-09 23:48:35 +0000218 "countercc");
Reid Spencere4d87aa2006-12-23 06:05:41 +0000219
Owen Andersoneed707b2009-07-24 23:12:02 +0000220 Value* nv = BinaryOperator::CreateSub(l, ConstantInt::get(T, 1),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000221 "counternew", t);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000222 new StoreInst(nv, Counter, t);
223 t->setCondition(s);
224
225 //reset counter
226 BasicBlock* oldnext = t->getSuccessor(0);
Owen Anderson1d0be152009-08-13 21:58:54 +0000227 BasicBlock* resetblock = BasicBlock::Create(bb->getContext(),
228 "reset", oldnext->getParent(),
Gabor Greif051a9502008-04-06 20:25:17 +0000229 oldnext);
230 TerminatorInst* t2 = BranchInst::Create(oldnext, resetblock);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000231 t->setSuccessor(0, resetblock);
232 new StoreInst(ResetValue, Counter, t2);
233 ReplacePhiPred(oldnext, bb, resetblock);
234}
235
Dan Gohman6de29f82009-06-15 22:12:54 +0000236GlobalRandomCounterOpt::GlobalRandomCounterOpt(Module& M, const IntegerType* t,
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000237 uint64_t resetval)
238 : AI(0), T(t) {
Owen Andersoneed707b2009-07-24 23:12:02 +0000239 ConstantInt* Init = ConstantInt::get(T, resetval);
Reid Spencerb83eb642006-10-20 07:07:24 +0000240 ResetValue = Init;
Owen Andersone9b11b42009-07-08 19:03:57 +0000241 Counter = new GlobalVariable(M, T, false, GlobalValue::InternalLinkage,
242 Init, "RandomSteeringCounter");
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000243}
244
245GlobalRandomCounterOpt::~GlobalRandomCounterOpt() {}
246
247void GlobalRandomCounterOpt::PrepFunction(Function* F) {
248 //make a local temporary to cache the global
249 BasicBlock& bb = F->getEntryBlock();
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000250 BasicBlock::iterator InsertPt = bb.begin();
Owen Anderson50dead02009-07-15 23:53:25 +0000251 AI = new AllocaInst(T, 0, "localcounter", InsertPt);
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000252 LoadInst* l = new LoadInst(Counter, "counterload", InsertPt);
253 new StoreInst(l, AI, InsertPt);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000254
Andrew Lenharth8dc2d502005-11-28 18:10:59 +0000255 //modify all functions and return values to restore the local variable to/from
256 //the global variable
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000257 for(Function::iterator fib = F->begin(), fie = F->end();
258 fib != fie; ++fib)
259 for(BasicBlock::iterator bib = fib->begin(), bie = fib->end();
260 bib != bie; ++bib)
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000261 if (isa<CallInst>(bib)) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000262 LoadInst* l = new LoadInst(AI, "counter", bib);
263 new StoreInst(l, Counter, bib);
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000264 l = new LoadInst(Counter, "counter", ++bib);
265 new StoreInst(l, AI, bib--);
266 } else if (isa<InvokeInst>(bib)) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000267 LoadInst* l = new LoadInst(AI, "counter", bib);
268 new StoreInst(l, Counter, bib);
269
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000270 BasicBlock* bb = cast<InvokeInst>(bib)->getNormalDest();
Dan Gohman02dea8b2008-05-23 21:05:58 +0000271 BasicBlock::iterator i = bb->getFirstNonPHI();
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000272 l = new LoadInst(Counter, "counter", i);
273
Chris Lattnera0e1b0e2007-04-17 17:51:03 +0000274 bb = cast<InvokeInst>(bib)->getUnwindDest();
Dan Gohman02dea8b2008-05-23 21:05:58 +0000275 i = bb->getFirstNonPHI();
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
Owen Anderson333c4002009-07-09 23:48:35 +0000290 ICmpInst* s = new ICmpInst(t, ICmpInst::ICMP_EQ, l,
Owen Andersoneed707b2009-07-24 23:12:02 +0000291 ConstantInt::get(T, 0),
Owen Anderson333c4002009-07-09 23:48:35 +0000292 "countercc");
Reid Spencere4d87aa2006-12-23 06:05:41 +0000293
Owen Andersoneed707b2009-07-24 23:12:02 +0000294 Value* nv = BinaryOperator::CreateSub(l, ConstantInt::get(T, 1),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000295 "counternew", t);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000296 new StoreInst(nv, AI, t);
297 t->setCondition(s);
298
299 //reset counter
300 BasicBlock* oldnext = t->getSuccessor(0);
Owen Anderson1d0be152009-08-13 21:58:54 +0000301 BasicBlock* resetblock = BasicBlock::Create(bb->getContext(),
302 "reset", oldnext->getParent(),
Gabor Greif051a9502008-04-06 20:25:17 +0000303 oldnext);
304 TerminatorInst* t2 = BranchInst::Create(oldnext, resetblock);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000305 t->setSuccessor(0, resetblock);
306 new StoreInst(ResetValue, AI, t2);
307 ReplacePhiPred(oldnext, bb, resetblock);
308}
309
310
311CycleCounter::CycleCounter(Module& m, uint64_t resetmask) : rm(resetmask) {
Duncan Sandse2c43042008-04-07 13:45:04 +0000312 F = Intrinsic::getDeclaration(&m, Intrinsic::readcyclecounter);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000313}
314
315CycleCounter::~CycleCounter() {}
316
317void CycleCounter::PrepFunction(Function* F) {}
318
319void CycleCounter::ProcessChoicePoint(BasicBlock* bb) {
320 BranchInst* t = cast<BranchInst>(bb->getTerminator());
321
Gabor Greif051a9502008-04-06 20:25:17 +0000322 CallInst* c = CallInst::Create(F, "rdcc", t);
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000323 BinaryOperator* b =
Owen Anderson1d0be152009-08-13 21:58:54 +0000324 BinaryOperator::CreateAnd(c,
325 ConstantInt::get(Type::getInt64Ty(bb->getContext()), rm),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000326 "mrdcc", t);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000327
Owen Anderson333c4002009-07-09 23:48:35 +0000328 ICmpInst *s = new ICmpInst(t, ICmpInst::ICMP_EQ, b,
Owen Anderson1d0be152009-08-13 21:58:54 +0000329 ConstantInt::get(Type::getInt64Ty(bb->getContext()), 0),
Owen Anderson333c4002009-07-09 23:48:35 +0000330 "mrdccc");
Reid Spencere4d87aa2006-12-23 06:05:41 +0000331
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000332 t->setCondition(s);
333}
334
335///////////////////////////////////////
336// Profiling:
337///////////////////////////////////////
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000338bool RSProfilers_std::isProfiling(Value* v) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000339 if (profcode.find(v) != profcode.end())
340 return true;
341 //else
342 RSProfilers& LI = getAnalysis<RSProfilers>();
343 return LI.isProfiling(v);
344}
345
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000346void RSProfilers_std::IncrementCounterInBlock(BasicBlock *BB, unsigned CounterNum,
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000347 GlobalValue *CounterArray) {
348 // Insert the increment after any alloca or PHI instructions...
Dan Gohman02dea8b2008-05-23 21:05:58 +0000349 BasicBlock::iterator InsertPos = BB->getFirstNonPHI();
350 while (isa<AllocaInst>(InsertPos))
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000351 ++InsertPos;
352
353 // Create the getelementptr constant expression
354 std::vector<Constant*> Indices(2);
Owen Anderson1d0be152009-08-13 21:58:54 +0000355 Indices[0] = Constant::getNullValue(Type::getInt32Ty(BB->getContext()));
356 Indices[1] = ConstantInt::get(Type::getInt32Ty(BB->getContext()), CounterNum);
Owen Andersonbaf3c402009-07-29 18:55:55 +0000357 Constant *ElementPtr =ConstantExpr::getGetElementPtr(CounterArray,
Chris Lattnerec1f7522007-02-19 07:34:47 +0000358 &Indices[0], 2);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000359
360 // Load, increment and store the value back.
361 Value *OldVal = new LoadInst(ElementPtr, "OldCounter", InsertPos);
362 profcode.insert(OldVal);
Gabor Greif7cbd8a32008-05-16 19:29:10 +0000363 Value *NewVal = BinaryOperator::CreateAdd(OldVal,
Owen Anderson1d0be152009-08-13 21:58:54 +0000364 ConstantInt::get(Type::getInt32Ty(BB->getContext()), 1),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000365 "NewCounter", InsertPos);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000366 profcode.insert(NewVal);
367 profcode.insert(new StoreInst(NewVal, ElementPtr, InsertPos));
368}
369
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000370void RSProfilers_std::getAnalysisUsage(AnalysisUsage &AU) const {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000371 //grab any outstanding profiler, or get the null one
372 AU.addRequired<RSProfilers>();
373}
374
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000375///////////////////////////////////////
376// RS Framework
377///////////////////////////////////////
378
379Value* ProfilerRS::Translate(Value* v) {
380 if(TransCache[v])
381 return TransCache[v];
382
383 if (BasicBlock* bb = dyn_cast<BasicBlock>(v)) {
384 if (bb == &bb->getParent()->getEntryBlock())
385 TransCache[bb] = bb; //don't translate entry block
386 else
Owen Anderson1d0be152009-08-13 21:58:54 +0000387 TransCache[bb] = BasicBlock::Create(v->getContext(),
388 "dup_" + bb->getName(),
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000389 bb->getParent(), NULL);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000390 return TransCache[bb];
391 } else if (Instruction* i = dyn_cast<Instruction>(v)) {
392 //we have already translated this
393 //do not translate entry block allocas
394 if(&i->getParent()->getParent()->getEntryBlock() == i->getParent()) {
395 TransCache[i] = i;
396 return i;
397 } else {
398 //translate this
Nick Lewycky67760642009-09-27 07:38:41 +0000399 Instruction* i2 = i->clone();
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000400 if (i->hasName())
401 i2->setName("dup_" + i->getName());
402 TransCache[i] = i2;
403 //NumNewInst++;
404 for (unsigned x = 0; x < i2->getNumOperands(); ++x)
405 i2->setOperand(x, Translate(i2->getOperand(x)));
406 return i2;
407 }
408 } else if (isa<Function>(v) || isa<Constant>(v) || isa<Argument>(v)) {
409 TransCache[v] = v;
410 return v;
411 }
Torok Edwinc23197a2009-07-14 16:55:14 +0000412 llvm_unreachable("Value not handled");
Jeff Cohen3523f6e2005-11-28 06:45:57 +0000413 return 0;
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000414}
415
416void ProfilerRS::Duplicate(Function& F, RSProfilers& LI)
417{
418 //perform a breadth first search, building up a duplicate of the code
419 std::queue<BasicBlock*> worklist;
420 std::set<BasicBlock*> seen;
421
422 //This loop ensures proper BB order, to help performance
423 for (Function::iterator fib = F.begin(), fie = F.end(); fib != fie; ++fib)
424 worklist.push(fib);
425 while (!worklist.empty()) {
426 Translate(worklist.front());
427 worklist.pop();
428 }
429
430 //remember than reg2mem created a new entry block we don't want to duplicate
431 worklist.push(F.getEntryBlock().getTerminator()->getSuccessor(0));
432 seen.insert(&F.getEntryBlock());
433
434 while (!worklist.empty()) {
435 BasicBlock* bb = worklist.front();
436 worklist.pop();
437 if(seen.find(bb) == seen.end()) {
438 BasicBlock* bbtarget = cast<BasicBlock>(Translate(bb));
439 BasicBlock::InstListType& instlist = bbtarget->getInstList();
440 for (BasicBlock::iterator iib = bb->begin(), iie = bb->end();
441 iib != iie; ++iib) {
442 //NumOldInst++;
443 if (!LI.isProfiling(&*iib)) {
444 Instruction* i = cast<Instruction>(Translate(iib));
445 instlist.insert(bbtarget->end(), i);
446 }
447 }
448 //updated search state;
449 seen.insert(bb);
450 TerminatorInst* ti = bb->getTerminator();
451 for (unsigned x = 0; x < ti->getNumSuccessors(); ++x) {
452 BasicBlock* bbs = ti->getSuccessor(x);
453 if (seen.find(bbs) == seen.end()) {
454 worklist.push(bbs);
455 }
456 }
457 }
458 }
459}
460
461void ProfilerRS::ProcessBackEdge(BasicBlock* src, BasicBlock* dst, Function& F) {
462 //given a backedge from B -> A, and translations A' and B',
463 //a: insert C and C'
464 //b: add branches in C to A and A' and in C' to A and A'
465 //c: mod terminators@B, replace A with C
466 //d: mod terminators@B', replace A' with C'
467 //e: mod phis@A for pred B to be pred C
468 // if multiple entries, simplify to one
469 //f: mod phis@A' for pred B' to be pred C'
470 // if multiple entries, simplify to one
471 //g: for all phis@A with pred C using x
472 // add in edge from C' using x'
473 // add in edge from C using x in A'
474
475 //a:
Chris Lattnere24c92a2007-04-17 17:54:12 +0000476 Function::iterator BBN = src; ++BBN;
Owen Anderson1d0be152009-08-13 21:58:54 +0000477 BasicBlock* bbC = BasicBlock::Create(F.getContext(), "choice", &F, BBN);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000478 //ChoicePoints.insert(bbC);
Chris Lattnere24c92a2007-04-17 17:54:12 +0000479 BBN = cast<BasicBlock>(Translate(src));
Owen Anderson1d0be152009-08-13 21:58:54 +0000480 BasicBlock* bbCp = BasicBlock::Create(F.getContext(), "choice", &F, ++BBN);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000481 ChoicePoints.insert(bbCp);
482
483 //b:
Gabor Greif051a9502008-04-06 20:25:17 +0000484 BranchInst::Create(cast<BasicBlock>(Translate(dst)), bbC);
485 BranchInst::Create(dst, cast<BasicBlock>(Translate(dst)),
Owen Anderson1d0be152009-08-13 21:58:54 +0000486 ConstantInt::get(Type::getInt1Ty(src->getContext()), true), bbCp);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000487 //c:
488 {
489 TerminatorInst* iB = src->getTerminator();
490 for (unsigned x = 0; x < iB->getNumSuccessors(); ++x)
491 if (iB->getSuccessor(x) == dst)
492 iB->setSuccessor(x, bbC);
493 }
494 //d:
495 {
496 TerminatorInst* iBp = cast<TerminatorInst>(Translate(src->getTerminator()));
497 for (unsigned x = 0; x < iBp->getNumSuccessors(); ++x)
498 if (iBp->getSuccessor(x) == cast<BasicBlock>(Translate(dst)))
499 iBp->setSuccessor(x, bbCp);
500 }
501 //e:
502 ReplacePhiPred(dst, src, bbC);
503 //src could be a switch, in which case we are replacing several edges with one
504 //thus collapse those edges int the Phi
505 CollapsePhi(dst, bbC);
506 //f:
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000507 ReplacePhiPred(cast<BasicBlock>(Translate(dst)),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000508 cast<BasicBlock>(Translate(src)),bbCp);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000509 CollapsePhi(cast<BasicBlock>(Translate(dst)), bbCp);
510 //g:
511 for(BasicBlock::iterator ib = dst->begin(), ie = dst->end(); ib != ie;
512 ++ib)
513 if (PHINode* phi = dyn_cast<PHINode>(&*ib)) {
514 for(unsigned x = 0; x < phi->getNumIncomingValues(); ++x)
515 if(bbC == phi->getIncomingBlock(x)) {
516 phi->addIncoming(Translate(phi->getIncomingValue(x)), bbCp);
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000517 cast<PHINode>(Translate(phi))->addIncoming(phi->getIncomingValue(x),
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000518 bbC);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000519 }
520 phi->removeIncomingValue(bbC);
521 }
522}
523
524bool ProfilerRS::runOnFunction(Function& F) {
Reid Spencer5cbf9852007-01-30 20:08:39 +0000525 if (!F.isDeclaration()) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000526 std::set<std::pair<BasicBlock*, BasicBlock*> > BackEdges;
527 RSProfilers& LI = getAnalysis<RSProfilers>();
528
529 getBackEdges(F, BackEdges);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000530 Duplicate(F, LI);
531 //assume that stuff worked. now connect the duplicated basic blocks
532 //with the originals in such a way as to preserve ssa. yuk!
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000533 for (std::set<std::pair<BasicBlock*, BasicBlock*> >::iterator
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000534 ib = BackEdges.begin(), ie = BackEdges.end(); ib != ie; ++ib)
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000535 ProcessBackEdge(ib->first, ib->second, F);
536
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000537 //oh, and add the edge from the reg2mem created entry node to the
538 //duplicated second node
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000539 TerminatorInst* T = F.getEntryBlock().getTerminator();
Gabor Greif051a9502008-04-06 20:25:17 +0000540 ReplaceInstWithInst(T, BranchInst::Create(T->getSuccessor(0),
541 cast<BasicBlock>(
Owen Anderson1d0be152009-08-13 21:58:54 +0000542 Translate(T->getSuccessor(0))),
543 ConstantInt::get(Type::getInt1Ty(F.getContext()), true)));
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000544
545 //do whatever is needed now that the function is duplicated
546 c->PrepFunction(&F);
547
548 //add entry node to choice points
549 ChoicePoints.insert(&F.getEntryBlock());
550
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000551 for (std::set<BasicBlock*>::iterator
Anton Korobeynikovbed29462007-04-16 18:10:23 +0000552 ii = ChoicePoints.begin(), ie = ChoicePoints.end(); ii != ie; ++ii)
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000553 c->ProcessChoicePoint(*ii);
554
555 ChoicePoints.clear();
556 TransCache.clear();
557
558 return true;
559 }
560 return false;
561}
562
563bool ProfilerRS::doInitialization(Module &M) {
564 switch (RandomMethod) {
565 case GBV:
Owen Anderson1d0be152009-08-13 21:58:54 +0000566 c = new GlobalRandomCounter(M, Type::getInt32Ty(M.getContext()),
567 (1 << 14) - 1);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000568 break;
569 case GBVO:
Owen Anderson1d0be152009-08-13 21:58:54 +0000570 c = new GlobalRandomCounterOpt(M, Type::getInt32Ty(M.getContext()),
571 (1 << 14) - 1);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000572 break;
573 case HOSTCC:
574 c = new CycleCounter(M, (1 << 14) - 1);
575 break;
576 };
577 return true;
578}
579
580void ProfilerRS::getAnalysisUsage(AnalysisUsage &AU) const {
581 AU.addRequired<RSProfilers>();
582 AU.addRequiredID(DemoteRegisterToMemoryID);
583}
584
585///////////////////////////////////////
586// Utilities:
587///////////////////////////////////////
588static void ReplacePhiPred(BasicBlock* btarget,
589 BasicBlock* bold, BasicBlock* bnew) {
590 for(BasicBlock::iterator ib = btarget->begin(), ie = btarget->end();
591 ib != ie; ++ib)
592 if (PHINode* phi = dyn_cast<PHINode>(&*ib)) {
593 for(unsigned x = 0; x < phi->getNumIncomingValues(); ++x)
594 if(bold == phi->getIncomingBlock(x))
595 phi->setIncomingBlock(x, bnew);
596 }
597}
598
599static void CollapsePhi(BasicBlock* btarget, BasicBlock* bsrc) {
600 for(BasicBlock::iterator ib = btarget->begin(), ie = btarget->end();
601 ib != ie; ++ib)
602 if (PHINode* phi = dyn_cast<PHINode>(&*ib)) {
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000603 std::map<BasicBlock*, Value*> counter;
604 for(unsigned i = 0; i < phi->getNumIncomingValues(); ) {
605 if (counter[phi->getIncomingBlock(i)]) {
Andrew Lenharthbb227c12005-11-28 18:00:38 +0000606 assert(phi->getIncomingValue(i) == counter[phi->getIncomingBlock(i)]);
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000607 phi->removeIncomingValue(i, false);
608 } else {
609 counter[phi->getIncomingBlock(i)] = phi->getIncomingValue(i);
610 ++i;
611 }
612 }
613 }
614}
615
616template<class T>
617static void recBackEdge(BasicBlock* bb, T& BackEdges,
618 std::map<BasicBlock*, int>& color,
619 std::map<BasicBlock*, int>& depth,
620 std::map<BasicBlock*, int>& finish,
621 int& time)
622{
623 color[bb] = 1;
624 ++time;
625 depth[bb] = time;
626 TerminatorInst* t= bb->getTerminator();
627 for(unsigned i = 0; i < t->getNumSuccessors(); ++i) {
628 BasicBlock* bbnew = t->getSuccessor(i);
629 if (color[bbnew] == 0)
630 recBackEdge(bbnew, BackEdges, color, depth, finish, time);
631 else if (color[bbnew] == 1) {
632 BackEdges.insert(std::make_pair(bb, bbnew));
633 //NumBackEdges++;
634 }
635 }
636 color[bb] = 2;
637 ++time;
638 finish[bb] = time;
639}
640
641
642
643//find the back edges and where they go to
644template<class T>
645static void getBackEdges(Function& F, T& BackEdges) {
646 std::map<BasicBlock*, int> color;
647 std::map<BasicBlock*, int> depth;
648 std::map<BasicBlock*, int> finish;
649 int time = 0;
650 recBackEdge(&F.getEntryBlock(), BackEdges, color, depth, finish, time);
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000651 DEBUG(errs() << F.getName() << " " << BackEdges.size() << "\n");
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000652}
653
654
655//Creation functions
Andrew Lenharth701f5ac2005-11-28 00:58:09 +0000656ModulePass* llvm::createNullProfilerRSPass() {
657 return new NullProfilerRS();
658}
659
660FunctionPass* llvm::createRSProfilingPass() {
661 return new ProfilerRS();
662}