1 //===- GCOVProfiling.cpp - Insert edge counters for gcov profiling --------===//
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 pass implements GCOV-style profiling. When this pass is run it emits
11 // "gcno" files next to the existing source, and instruments the code that runs
12 // to records the edges between blocks that run and emit a complementary "gcda"
15 //===----------------------------------------------------------------------===//
17 #define DEBUG_TYPE "insert-gcov-profiling"
19 #include "llvm/Transforms/Instrumentation.h"
20 #include "ProfilingUtils.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/STLExtras.h"
23 #include "llvm/ADT/Statistic.h"
24 #include "llvm/ADT/StringExtras.h"
25 #include "llvm/ADT/StringMap.h"
26 #include "llvm/ADT/UniqueVector.h"
27 #include "llvm/DebugInfo.h"
28 #include "llvm/IR/IRBuilder.h"
29 #include "llvm/IR/Instructions.h"
30 #include "llvm/IR/Module.h"
31 #include "llvm/Pass.h"
32 #include "llvm/Support/CommandLine.h"
33 #include "llvm/Support/Debug.h"
34 #include "llvm/Support/DebugLoc.h"
35 #include "llvm/Support/FileSystem.h"
36 #include "llvm/Support/InstIterator.h"
37 #include "llvm/Support/PathV2.h"
38 #include "llvm/Support/raw_ostream.h"
39 #include "llvm/Transforms/Utils/ModuleUtils.h"
44 static cl::opt<std::string>
45 DefaultGCOVVersion("default-gcov-version", cl::init("402*"), cl::Hidden,
48 GCOVOptions GCOVOptions::getDefault() {
50 Options.EmitNotes = true;
51 Options.EmitData = true;
52 Options.UseCfgChecksum = false;
53 Options.NoRedZone = false;
54 Options.FunctionNamesInData = true;
56 if (DefaultGCOVVersion.size() != 4) {
57 llvm::report_fatal_error(std::string("Invalid -default-gcov-version: ") +
60 memcpy(Options.Version, DefaultGCOVVersion.c_str(), 4);
65 class GCOVProfiler : public ModulePass {
68 GCOVProfiler() : ModulePass(ID), Options(GCOVOptions::getDefault()) {
69 ReversedVersion[0] = Options.Version[3];
70 ReversedVersion[1] = Options.Version[2];
71 ReversedVersion[2] = Options.Version[1];
72 ReversedVersion[3] = Options.Version[0];
73 ReversedVersion[4] = '\0';
74 initializeGCOVProfilerPass(*PassRegistry::getPassRegistry());
76 GCOVProfiler(const GCOVOptions &Options) : ModulePass(ID), Options(Options){
77 assert((Options.EmitNotes || Options.EmitData) &&
78 "GCOVProfiler asked to do nothing?");
79 ReversedVersion[0] = Options.Version[3];
80 ReversedVersion[1] = Options.Version[2];
81 ReversedVersion[2] = Options.Version[1];
82 ReversedVersion[3] = Options.Version[0];
83 ReversedVersion[4] = '\0';
84 initializeGCOVProfilerPass(*PassRegistry::getPassRegistry());
86 virtual const char *getPassName() const {
87 return "GCOV Profiler";
91 bool runOnModule(Module &M);
93 // Create the .gcno files for the Module based on DebugInfo.
94 void emitProfileNotes();
96 // Modify the program to track transitions along edges and call into the
97 // profiling runtime to emit .gcda files when run.
98 bool emitProfileArcs();
100 // Get pointers to the functions in the runtime library.
101 Constant *getStartFileFunc();
102 Constant *getIncrementIndirectCounterFunc();
103 Constant *getEmitFunctionFunc();
104 Constant *getEmitArcsFunc();
105 Constant *getDeleteWriteoutFunctionListFunc();
106 Constant *getDeleteFlushFunctionListFunc();
107 Constant *getEndFileFunc();
109 // Create or retrieve an i32 state value that is used to represent the
110 // pred block number for certain non-trivial edges.
111 GlobalVariable *getEdgeStateValue();
113 // Produce a table of pointers to counters, by predecessor and successor
115 GlobalVariable *buildEdgeLookupTable(Function *F,
116 GlobalVariable *Counter,
117 const UniqueVector<BasicBlock *>&Preds,
118 const UniqueVector<BasicBlock*>&Succs);
120 // Add the function to write out all our counters to the global destructor
122 Function *insertCounterWriteout(ArrayRef<std::pair<GlobalVariable*,
124 Function *insertFlush(ArrayRef<std::pair<GlobalVariable*, MDNode*> >);
125 void insertIndirectCounterIncrement();
127 std::string mangleName(DICompileUnit CU, const char *NewStem);
131 // Reversed, NUL-terminated copy of Options.Version.
132 char ReversedVersion[5];
139 char GCOVProfiler::ID = 0;
140 INITIALIZE_PASS(GCOVProfiler, "insert-gcov-profiling",
141 "Insert instrumentation for GCOV profiling", false, false)
143 ModulePass *llvm::createGCOVProfilerPass(const GCOVOptions &Options) {
144 return new GCOVProfiler(Options);
147 static std::string getFunctionName(DISubprogram SP) {
148 if (!SP.getLinkageName().empty())
149 return SP.getLinkageName();
156 static const char *LinesTag;
157 static const char *FunctionTag;
158 static const char *BlockTag;
159 static const char *EdgeTag;
163 void writeBytes(const char *Bytes, int Size) {
164 os->write(Bytes, Size);
167 void write(uint32_t i) {
168 writeBytes(reinterpret_cast<char*>(&i), 4);
171 // Returns the length measured in 4-byte blocks that will be used to
172 // represent this string in a GCOV file
173 unsigned lengthOfGCOVString(StringRef s) {
174 // A GCOV string is a length, followed by a NUL, then between 0 and 3 NULs
175 // padding out to the next 4-byte word. The length is measured in 4-byte
176 // words including padding, not bytes of actual string.
177 return (s.size() / 4) + 1;
180 void writeGCOVString(StringRef s) {
181 uint32_t Len = lengthOfGCOVString(s);
183 writeBytes(s.data(), s.size());
185 // Write 1 to 4 bytes of NUL padding.
186 assert((unsigned)(4 - (s.size() % 4)) > 0);
187 assert((unsigned)(4 - (s.size() % 4)) <= 4);
188 writeBytes("\0\0\0\0", 4 - (s.size() % 4));
193 const char *GCOVRecord::LinesTag = "\0\0\x45\x01";
194 const char *GCOVRecord::FunctionTag = "\0\0\0\1";
195 const char *GCOVRecord::BlockTag = "\0\0\x41\x01";
196 const char *GCOVRecord::EdgeTag = "\0\0\x43\x01";
201 // Constructed only by requesting it from a GCOVBlock, this object stores a
202 // list of line numbers and a single filename, representing lines that belong
204 class GCOVLines : public GCOVRecord {
206 void addLine(uint32_t Line) {
207 Lines.push_back(Line);
211 // Here 2 = 1 for string length + 1 for '0' id#.
212 return lengthOfGCOVString(Filename) + 2 + Lines.size();
217 writeGCOVString(Filename);
218 for (int i = 0, e = Lines.size(); i != e; ++i)
222 GCOVLines(StringRef F, raw_ostream *os)
229 SmallVector<uint32_t, 32> Lines;
232 // Represent a basic block in GCOV. Each block has a unique number in the
233 // function, number of lines belonging to each block, and a set of edges to
235 class GCOVBlock : public GCOVRecord {
237 GCOVLines &getFile(StringRef Filename) {
238 GCOVLines *&Lines = LinesByFile[Filename];
240 Lines = new GCOVLines(Filename, os);
245 void addEdge(GCOVBlock &Successor) {
246 OutEdges.push_back(&Successor);
251 for (StringMap<GCOVLines *>::iterator I = LinesByFile.begin(),
252 E = LinesByFile.end(); I != E; ++I) {
253 Len += I->second->length();
256 writeBytes(LinesTag, 4);
259 for (StringMap<GCOVLines *>::iterator I = LinesByFile.begin(),
260 E = LinesByFile.end(); I != E; ++I)
261 I->second->writeOut();
267 DeleteContainerSeconds(LinesByFile);
271 friend class GCOVFunction;
273 GCOVBlock(uint32_t Number, raw_ostream *os)
279 StringMap<GCOVLines *> LinesByFile;
280 SmallVector<GCOVBlock *, 4> OutEdges;
283 // A function has a unique identifier, a checksum (we leave as zero) and a
284 // set of blocks and a map of edges between blocks. This is the only GCOV
285 // object users can construct, the blocks and lines will be rooted here.
286 class GCOVFunction : public GCOVRecord {
288 GCOVFunction(DISubprogram SP, raw_ostream *os, uint32_t Ident,
289 bool UseCfgChecksum) {
292 Function *F = SP.getFunction();
293 DEBUG(dbgs() << "Function: " << F->getName() << "\n");
295 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
296 Blocks[BB] = new GCOVBlock(i++, os);
298 ReturnBlock = new GCOVBlock(i++, os);
300 writeBytes(FunctionTag, 4);
301 uint32_t BlockLen = 1 + 1 + 1 + lengthOfGCOVString(getFunctionName(SP)) +
302 1 + lengthOfGCOVString(SP.getFilename()) + 1;
307 write(0); // lineno checksum
309 write(0); // cfg checksum
310 writeGCOVString(getFunctionName(SP));
311 writeGCOVString(SP.getFilename());
312 write(SP.getLineNumber());
316 DeleteContainerSeconds(Blocks);
320 GCOVBlock &getBlock(BasicBlock *BB) {
324 GCOVBlock &getReturnBlock() {
329 // Emit count of blocks.
330 writeBytes(BlockTag, 4);
331 write(Blocks.size() + 1);
332 for (int i = 0, e = Blocks.size() + 1; i != e; ++i) {
333 write(0); // No flags on our blocks.
335 DEBUG(dbgs() << Blocks.size() << " blocks.\n");
337 // Emit edges between blocks.
338 for (DenseMap<BasicBlock *, GCOVBlock *>::iterator I = Blocks.begin(),
339 E = Blocks.end(); I != E; ++I) {
340 GCOVBlock &Block = *I->second;
341 if (Block.OutEdges.empty()) continue;
343 writeBytes(EdgeTag, 4);
344 write(Block.OutEdges.size() * 2 + 1);
346 for (int i = 0, e = Block.OutEdges.size(); i != e; ++i) {
347 DEBUG(dbgs() << Block.Number << " -> " << Block.OutEdges[i]->Number
349 write(Block.OutEdges[i]->Number);
350 write(0); // no flags
354 // Emit lines for each block.
355 for (DenseMap<BasicBlock *, GCOVBlock *>::iterator I = Blocks.begin(),
356 E = Blocks.end(); I != E; ++I) {
357 I->second->writeOut();
362 DenseMap<BasicBlock *, GCOVBlock *> Blocks;
363 GCOVBlock *ReturnBlock;
367 std::string GCOVProfiler::mangleName(DICompileUnit CU, const char *NewStem) {
368 if (NamedMDNode *GCov = M->getNamedMetadata("llvm.gcov")) {
369 for (int i = 0, e = GCov->getNumOperands(); i != e; ++i) {
370 MDNode *N = GCov->getOperand(i);
371 if (N->getNumOperands() != 2) continue;
372 MDString *GCovFile = dyn_cast<MDString>(N->getOperand(0));
373 MDNode *CompileUnit = dyn_cast<MDNode>(N->getOperand(1));
374 if (!GCovFile || !CompileUnit) continue;
375 if (CompileUnit == CU) {
376 SmallString<128> Filename = GCovFile->getString();
377 sys::path::replace_extension(Filename, NewStem);
378 return Filename.str();
383 SmallString<128> Filename = CU.getFilename();
384 sys::path::replace_extension(Filename, NewStem);
385 StringRef FName = sys::path::filename(Filename);
386 SmallString<128> CurPath;
387 if (sys::fs::current_path(CurPath)) return FName;
388 sys::path::append(CurPath, FName.str());
389 return CurPath.str();
392 bool GCOVProfiler::runOnModule(Module &M) {
394 Ctx = &M.getContext();
396 if (Options.EmitNotes) emitProfileNotes();
397 if (Options.EmitData) return emitProfileArcs();
401 void GCOVProfiler::emitProfileNotes() {
402 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
403 if (!CU_Nodes) return;
405 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
406 // Each compile unit gets its own .gcno file. This means that whether we run
407 // this pass over the original .o's as they're produced, or run it after
408 // LTO, we'll generate the same .gcno files.
410 DICompileUnit CU(CU_Nodes->getOperand(i));
411 std::string ErrorInfo;
412 raw_fd_ostream out(mangleName(CU, "gcno").c_str(), ErrorInfo,
413 raw_fd_ostream::F_Binary);
414 out.write("oncg", 4);
415 out.write(ReversedVersion, 4);
416 out.write("MVLL", 4);
418 DIArray SPs = CU.getSubprograms();
419 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
420 DISubprogram SP(SPs.getElement(i));
421 if (!SP.Verify()) continue;
423 Function *F = SP.getFunction();
425 GCOVFunction Func(SP, &out, i, Options.UseCfgChecksum);
427 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
428 GCOVBlock &Block = Func.getBlock(BB);
429 TerminatorInst *TI = BB->getTerminator();
430 if (int successors = TI->getNumSuccessors()) {
431 for (int i = 0; i != successors; ++i) {
432 Block.addEdge(Func.getBlock(TI->getSuccessor(i)));
434 } else if (isa<ReturnInst>(TI)) {
435 Block.addEdge(Func.getReturnBlock());
439 for (BasicBlock::iterator I = BB->begin(), IE = BB->end();
441 const DebugLoc &Loc = I->getDebugLoc();
442 if (Loc.isUnknown()) continue;
443 if (Line == Loc.getLine()) continue;
444 Line = Loc.getLine();
445 if (SP != getDISubprogram(Loc.getScope(*Ctx))) continue;
447 GCOVLines &Lines = Block.getFile(SP.getFilename());
448 Lines.addLine(Loc.getLine());
453 out.write("\0\0\0\0\0\0\0\0", 8); // EOF
458 bool GCOVProfiler::emitProfileArcs() {
459 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
460 if (!CU_Nodes) return false;
463 bool InsertIndCounterIncrCode = false;
464 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
465 DICompileUnit CU(CU_Nodes->getOperand(i));
466 DIArray SPs = CU.getSubprograms();
467 SmallVector<std::pair<GlobalVariable *, MDNode *>, 8> CountersBySP;
468 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
469 DISubprogram SP(SPs.getElement(i));
470 if (!SP.Verify()) continue;
471 Function *F = SP.getFunction();
473 if (!Result) Result = true;
475 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
476 TerminatorInst *TI = BB->getTerminator();
477 if (isa<ReturnInst>(TI))
480 Edges += TI->getNumSuccessors();
483 ArrayType *CounterTy =
484 ArrayType::get(Type::getInt64Ty(*Ctx), Edges);
485 GlobalVariable *Counters =
486 new GlobalVariable(*M, CounterTy, false,
487 GlobalValue::InternalLinkage,
488 Constant::getNullValue(CounterTy),
490 CountersBySP.push_back(std::make_pair(Counters, (MDNode*)SP));
492 UniqueVector<BasicBlock *> ComplexEdgePreds;
493 UniqueVector<BasicBlock *> ComplexEdgeSuccs;
496 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
497 TerminatorInst *TI = BB->getTerminator();
498 int Successors = isa<ReturnInst>(TI) ? 1 : TI->getNumSuccessors();
500 IRBuilder<> Builder(TI);
502 if (Successors == 1) {
503 Value *Counter = Builder.CreateConstInBoundsGEP2_64(Counters, 0,
505 Value *Count = Builder.CreateLoad(Counter);
506 Count = Builder.CreateAdd(Count, Builder.getInt64(1));
507 Builder.CreateStore(Count, Counter);
508 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
509 Value *Sel = Builder.CreateSelect(BI->getCondition(),
510 Builder.getInt64(Edge),
511 Builder.getInt64(Edge + 1));
512 SmallVector<Value *, 2> Idx;
513 Idx.push_back(Builder.getInt64(0));
515 Value *Counter = Builder.CreateInBoundsGEP(Counters, Idx);
516 Value *Count = Builder.CreateLoad(Counter);
517 Count = Builder.CreateAdd(Count, Builder.getInt64(1));
518 Builder.CreateStore(Count, Counter);
520 ComplexEdgePreds.insert(BB);
521 for (int i = 0; i != Successors; ++i)
522 ComplexEdgeSuccs.insert(TI->getSuccessor(i));
528 if (!ComplexEdgePreds.empty()) {
529 GlobalVariable *EdgeTable =
530 buildEdgeLookupTable(F, Counters,
531 ComplexEdgePreds, ComplexEdgeSuccs);
532 GlobalVariable *EdgeState = getEdgeStateValue();
534 for (int i = 0, e = ComplexEdgePreds.size(); i != e; ++i) {
535 IRBuilder<> Builder(ComplexEdgePreds[i+1]->getTerminator());
536 Builder.CreateStore(Builder.getInt32(i), EdgeState);
538 for (int i = 0, e = ComplexEdgeSuccs.size(); i != e; ++i) {
539 // call runtime to perform increment
540 BasicBlock::iterator InsertPt =
541 ComplexEdgeSuccs[i+1]->getFirstInsertionPt();
542 IRBuilder<> Builder(InsertPt);
543 Value *CounterPtrArray =
544 Builder.CreateConstInBoundsGEP2_64(EdgeTable, 0,
545 i * ComplexEdgePreds.size());
547 // Build code to increment the counter.
548 InsertIndCounterIncrCode = true;
549 Builder.CreateCall2(getIncrementIndirectCounterFunc(),
550 EdgeState, CounterPtrArray);
555 Function *WriteoutF = insertCounterWriteout(CountersBySP);
556 Function *FlushF = insertFlush(CountersBySP);
558 // Create a small bit of code that registers the "__llvm_gcov_writeout" to
559 // be executed at exit and the "__llvm_gcov_flush" function to be executed
560 // when "__gcov_flush" is called.
561 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
562 Function *F = Function::Create(FTy, GlobalValue::InternalLinkage,
563 "__llvm_gcov_init", M);
564 F->setUnnamedAddr(true);
565 F->setLinkage(GlobalValue::InternalLinkage);
566 F->addFnAttr(Attribute::NoInline);
567 if (Options.NoRedZone)
568 F->addFnAttr(Attribute::NoRedZone);
570 BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", F);
571 IRBuilder<> Builder(BB);
573 FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
575 PointerType::get(FTy, 0),
576 PointerType::get(FTy, 0)
578 FTy = FunctionType::get(Builder.getVoidTy(), Params, false);
580 // Inialize the environment and register the local writeout and flush
582 Constant *GCOVInit = M->getOrInsertFunction("llvm_gcov_init", FTy);
583 Builder.CreateCall2(GCOVInit, WriteoutF, FlushF);
584 Builder.CreateRetVoid();
586 appendToGlobalCtors(*M, F, 0);
589 if (InsertIndCounterIncrCode)
590 insertIndirectCounterIncrement();
595 // All edges with successors that aren't branches are "complex", because it
596 // requires complex logic to pick which counter to update.
597 GlobalVariable *GCOVProfiler::buildEdgeLookupTable(
599 GlobalVariable *Counters,
600 const UniqueVector<BasicBlock *> &Preds,
601 const UniqueVector<BasicBlock *> &Succs) {
602 // TODO: support invoke, threads. We rely on the fact that nothing can modify
603 // the whole-Module pred edge# between the time we set it and the time we next
604 // read it. Threads and invoke make this untrue.
606 // emit [(succs * preds) x i64*], logically [succ x [pred x i64*]].
607 size_t TableSize = Succs.size() * Preds.size();
608 Type *Int64PtrTy = Type::getInt64PtrTy(*Ctx);
609 ArrayType *EdgeTableTy = ArrayType::get(Int64PtrTy, TableSize);
611 OwningArrayPtr<Constant *> EdgeTable(new Constant*[TableSize]);
612 Constant *NullValue = Constant::getNullValue(Int64PtrTy);
613 for (size_t i = 0; i != TableSize; ++i)
614 EdgeTable[i] = NullValue;
617 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
618 TerminatorInst *TI = BB->getTerminator();
619 int Successors = isa<ReturnInst>(TI) ? 1 : TI->getNumSuccessors();
620 if (Successors > 1 && !isa<BranchInst>(TI) && !isa<ReturnInst>(TI)) {
621 for (int i = 0; i != Successors; ++i) {
622 BasicBlock *Succ = TI->getSuccessor(i);
623 IRBuilder<> Builder(Succ);
624 Value *Counter = Builder.CreateConstInBoundsGEP2_64(Counters, 0,
626 EdgeTable[((Succs.idFor(Succ)-1) * Preds.size()) +
627 (Preds.idFor(BB)-1)] = cast<Constant>(Counter);
633 ArrayRef<Constant*> V(&EdgeTable[0], TableSize);
634 GlobalVariable *EdgeTableGV =
636 *M, EdgeTableTy, true, GlobalValue::InternalLinkage,
637 ConstantArray::get(EdgeTableTy, V),
638 "__llvm_gcda_edge_table");
639 EdgeTableGV->setUnnamedAddr(true);
643 Constant *GCOVProfiler::getStartFileFunc() {
645 Type::getInt8PtrTy(*Ctx), // const char *orig_filename
646 Type::getInt8PtrTy(*Ctx), // const char version[4]
648 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), Args, false);
649 return M->getOrInsertFunction("llvm_gcda_start_file", FTy);
652 Constant *GCOVProfiler::getIncrementIndirectCounterFunc() {
653 Type *Int32Ty = Type::getInt32Ty(*Ctx);
654 Type *Int64Ty = Type::getInt64Ty(*Ctx);
656 Int32Ty->getPointerTo(), // uint32_t *predecessor
657 Int64Ty->getPointerTo()->getPointerTo() // uint64_t **counters
659 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), Args, false);
660 return M->getOrInsertFunction("__llvm_gcov_indirect_counter_increment", FTy);
663 Constant *GCOVProfiler::getEmitFunctionFunc() {
665 Type::getInt32Ty(*Ctx), // uint32_t ident
666 Type::getInt8PtrTy(*Ctx), // const char *function_name
667 Type::getInt8Ty(*Ctx), // uint8_t use_extra_checksum
669 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), Args, false);
670 return M->getOrInsertFunction("llvm_gcda_emit_function", FTy);
673 Constant *GCOVProfiler::getEmitArcsFunc() {
675 Type::getInt32Ty(*Ctx), // uint32_t num_counters
676 Type::getInt64PtrTy(*Ctx), // uint64_t *counters
678 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), Args, false);
679 return M->getOrInsertFunction("llvm_gcda_emit_arcs", FTy);
682 Constant *GCOVProfiler::getDeleteWriteoutFunctionListFunc() {
683 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
684 return M->getOrInsertFunction("llvm_delete_writeout_function_list", FTy);
687 Constant *GCOVProfiler::getDeleteFlushFunctionListFunc() {
688 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
689 return M->getOrInsertFunction("llvm_delete_flush_function_list", FTy);
692 Constant *GCOVProfiler::getEndFileFunc() {
693 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
694 return M->getOrInsertFunction("llvm_gcda_end_file", FTy);
697 GlobalVariable *GCOVProfiler::getEdgeStateValue() {
698 GlobalVariable *GV = M->getGlobalVariable("__llvm_gcov_global_state_pred");
700 GV = new GlobalVariable(*M, Type::getInt32Ty(*Ctx), false,
701 GlobalValue::InternalLinkage,
702 ConstantInt::get(Type::getInt32Ty(*Ctx),
704 "__llvm_gcov_global_state_pred");
705 GV->setUnnamedAddr(true);
710 Function *GCOVProfiler::insertCounterWriteout(
711 ArrayRef<std::pair<GlobalVariable *, MDNode *> > CountersBySP) {
712 FunctionType *WriteoutFTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
713 Function *WriteoutF = M->getFunction("__llvm_gcov_writeout");
715 WriteoutF = Function::Create(WriteoutFTy, GlobalValue::InternalLinkage,
716 "__llvm_gcov_writeout", M);
717 WriteoutF->setUnnamedAddr(true);
718 WriteoutF->addFnAttr(Attribute::NoInline);
719 if (Options.NoRedZone)
720 WriteoutF->addFnAttr(Attribute::NoRedZone);
722 BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", WriteoutF);
723 IRBuilder<> Builder(BB);
725 Constant *StartFile = getStartFileFunc();
726 Constant *EmitFunction = getEmitFunctionFunc();
727 Constant *EmitArcs = getEmitArcsFunc();
728 Constant *EndFile = getEndFileFunc();
730 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
732 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
733 DICompileUnit CU(CU_Nodes->getOperand(i));
734 std::string FilenameGcda = mangleName(CU, "gcda");
735 Builder.CreateCall2(StartFile,
736 Builder.CreateGlobalStringPtr(FilenameGcda),
737 Builder.CreateGlobalStringPtr(ReversedVersion));
738 for (unsigned j = 0, e = CountersBySP.size(); j != e; ++j) {
739 DISubprogram SP(CountersBySP[j].second);
741 EmitFunction, Builder.getInt32(j),
742 Options.FunctionNamesInData ?
743 Builder.CreateGlobalStringPtr(getFunctionName(SP)) :
744 Constant::getNullValue(Builder.getInt8PtrTy()),
745 Builder.getInt8(Options.UseCfgChecksum));
747 GlobalVariable *GV = CountersBySP[j].first;
749 cast<ArrayType>(GV->getType()->getElementType())->getNumElements();
750 Builder.CreateCall2(EmitArcs,
751 Builder.getInt32(Arcs),
752 Builder.CreateConstGEP2_64(GV, 0, 0));
754 Builder.CreateCall(EndFile);
758 Builder.CreateRetVoid();
762 void GCOVProfiler::insertIndirectCounterIncrement() {
764 cast<Function>(GCOVProfiler::getIncrementIndirectCounterFunc());
765 Fn->setUnnamedAddr(true);
766 Fn->setLinkage(GlobalValue::InternalLinkage);
767 Fn->addFnAttr(Attribute::NoInline);
768 if (Options.NoRedZone)
769 Fn->addFnAttr(Attribute::NoRedZone);
771 // Create basic blocks for function.
772 BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", Fn);
773 IRBuilder<> Builder(BB);
775 BasicBlock *PredNotNegOne = BasicBlock::Create(*Ctx, "", Fn);
776 BasicBlock *CounterEnd = BasicBlock::Create(*Ctx, "", Fn);
777 BasicBlock *Exit = BasicBlock::Create(*Ctx, "exit", Fn);
779 // uint32_t pred = *predecessor;
780 // if (pred == 0xffffffff) return;
781 Argument *Arg = Fn->arg_begin();
782 Arg->setName("predecessor");
783 Value *Pred = Builder.CreateLoad(Arg, "pred");
784 Value *Cond = Builder.CreateICmpEQ(Pred, Builder.getInt32(0xffffffff));
785 BranchInst::Create(Exit, PredNotNegOne, Cond, BB);
787 Builder.SetInsertPoint(PredNotNegOne);
789 // uint64_t *counter = counters[pred];
790 // if (!counter) return;
791 Value *ZExtPred = Builder.CreateZExt(Pred, Builder.getInt64Ty());
792 Arg = llvm::next(Fn->arg_begin());
793 Arg->setName("counters");
794 Value *GEP = Builder.CreateGEP(Arg, ZExtPred);
795 Value *Counter = Builder.CreateLoad(GEP, "counter");
796 Cond = Builder.CreateICmpEQ(Counter,
797 Constant::getNullValue(
798 Builder.getInt64Ty()->getPointerTo()));
799 Builder.CreateCondBr(Cond, Exit, CounterEnd);
802 Builder.SetInsertPoint(CounterEnd);
803 Value *Add = Builder.CreateAdd(Builder.CreateLoad(Counter),
804 Builder.getInt64(1));
805 Builder.CreateStore(Add, Counter);
806 Builder.CreateBr(Exit);
808 // Fill in the exit block.
809 Builder.SetInsertPoint(Exit);
810 Builder.CreateRetVoid();
813 Function *GCOVProfiler::
814 insertFlush(ArrayRef<std::pair<GlobalVariable*, MDNode*> > CountersBySP) {
815 FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
816 Function *FlushF = M->getFunction("__llvm_gcov_flush");
818 FlushF = Function::Create(FTy, GlobalValue::InternalLinkage,
819 "__llvm_gcov_flush", M);
821 FlushF->setLinkage(GlobalValue::InternalLinkage);
822 FlushF->setUnnamedAddr(true);
823 FlushF->addFnAttr(Attribute::NoInline);
824 if (Options.NoRedZone)
825 FlushF->addFnAttr(Attribute::NoRedZone);
827 BasicBlock *Entry = BasicBlock::Create(*Ctx, "entry", FlushF);
829 // Write out the current counters.
830 Constant *WriteoutF = M->getFunction("__llvm_gcov_writeout");
831 assert(WriteoutF && "Need to create the writeout function first!");
833 IRBuilder<> Builder(Entry);
834 Builder.CreateCall(WriteoutF);
836 // Zero out the counters.
837 for (ArrayRef<std::pair<GlobalVariable *, MDNode *> >::iterator
838 I = CountersBySP.begin(), E = CountersBySP.end();
840 GlobalVariable *GV = I->first;
841 Constant *Null = Constant::getNullValue(GV->getType()->getElementType());
842 Builder.CreateStore(Null, GV);
845 Type *RetTy = FlushF->getReturnType();
846 if (RetTy == Type::getVoidTy(*Ctx))
847 Builder.CreateRetVoid();
848 else if (RetTy->isIntegerTy())
849 // Used if __llvm_gcov_flush was implicitly declared.
850 Builder.CreateRet(ConstantInt::get(RetTy, 0));
852 report_fatal_error("invalid return type for __llvm_gcov_flush");