lib/Transforms/Instrumentation/GCOVProfiling.cpp

   1 //===- GCOVProfiling.cpp - Insert edge counters for gcov profiling --------===//
   2 //
   3 //                      The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This 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"
  13 // file on exit.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Transforms/Instrumentation.h"
  18 #include "llvm/ADT/DenseMap.h"
  19 #include "llvm/ADT/Hashing.h"
  20 #include "llvm/ADT/STLExtras.h"
  21 #include "llvm/ADT/Statistic.h"
  22 #include "llvm/ADT/StringExtras.h"
  23 #include "llvm/ADT/StringMap.h"
  24 #include "llvm/ADT/UniqueVector.h"
  25 #include "llvm/IR/DebugInfo.h"
  26 #include "llvm/IR/DebugLoc.h"
  27 #include "llvm/IR/IRBuilder.h"
  28 #include "llvm/IR/InstIterator.h"
  29 #include "llvm/IR/Instructions.h"
  30 #include "llvm/IR/IntrinsicInst.h"
  31 #include "llvm/IR/Module.h"
  32 #include "llvm/Pass.h"
  33 #include "llvm/Support/CommandLine.h"
  34 #include "llvm/Support/Debug.h"
  35 #include "llvm/Support/FileSystem.h"
  36 #include "llvm/Support/Path.h"
  37 #include "llvm/Support/raw_ostream.h"
  38 #include "llvm/Transforms/Utils/ModuleUtils.h"
  39 #include <algorithm>
  40 #include <memory>
  41 #include <string>
  42 #include <utility>
  43 using namespace llvm;
  44
  45 #define DEBUG_TYPE "insert-gcov-profiling"
  46
  47 static cl::opt<std::string>
  48 DefaultGCOVVersion("default-gcov-version", cl::init("402*"), cl::Hidden,
  49                    cl::ValueRequired);
  50
  51 GCOVOptions GCOVOptions::getDefault() {
  52   GCOVOptions Options;
  53   Options.EmitNotes = true;
  54   Options.EmitData = true;
  55   Options.UseCfgChecksum = false;
  56   Options.NoRedZone = false;
  57   Options.FunctionNamesInData = true;
  58
  59   if (DefaultGCOVVersion.size() != 4) {
  60     llvm::report_fatal_error(std::string("Invalid -default-gcov-version: ") +
  61                              DefaultGCOVVersion);
  62   }
  63   memcpy(Options.Version, DefaultGCOVVersion.c_str(), 4);
  64   return Options;
  65 }
  66
  67 namespace {
  68   class GCOVFunction;
  69
  70   class GCOVProfiler : public ModulePass {
  71   public:
  72     static char ID;
  73     GCOVProfiler() : ModulePass(ID), Options(GCOVOptions::getDefault()) {
  74       init();
  75     }
  76     GCOVProfiler(const GCOVOptions &Options) : ModulePass(ID), Options(Options){
  77       assert((Options.EmitNotes || Options.EmitData) &&
  78              "GCOVProfiler asked to do nothing?");
  79       init();
  80     }
  81     const char *getPassName() const override {
  82       return "GCOV Profiler";
  83     }
  84
  85   private:
  86     void init() {
  87       ReversedVersion[0] = Options.Version[3];
  88       ReversedVersion[1] = Options.Version[2];
  89       ReversedVersion[2] = Options.Version[1];
  90       ReversedVersion[3] = Options.Version[0];
  91       ReversedVersion[4] = '\0';
  92       initializeGCOVProfilerPass(*PassRegistry::getPassRegistry());
  93     }
  94     bool runOnModule(Module &M) override;
  95
  96     // Create the .gcno files for the Module based on DebugInfo.
  97     void emitProfileNotes();
  98
  99     // Modify the program to track transitions along edges and call into the
 100     // profiling runtime to emit .gcda files when run.
 101     bool emitProfileArcs();
 102
 103     // Get pointers to the functions in the runtime library.
 104     Constant *getStartFileFunc();
 105     Constant *getIncrementIndirectCounterFunc();
 106     Constant *getEmitFunctionFunc();
 107     Constant *getEmitArcsFunc();
 108     Constant *getSummaryInfoFunc();
 109     Constant *getDeleteWriteoutFunctionListFunc();
 110     Constant *getDeleteFlushFunctionListFunc();
 111     Constant *getEndFileFunc();
 112
 113     // Create or retrieve an i32 state value that is used to represent the
 114     // pred block number for certain non-trivial edges.
 115     GlobalVariable *getEdgeStateValue();
 116
 117     // Produce a table of pointers to counters, by predecessor and successor
 118     // block number.
 119     GlobalVariable *buildEdgeLookupTable(Function *F,
 120                                          GlobalVariable *Counter,
 121                                          const UniqueVector<BasicBlock *>&Preds,
 122                                          const UniqueVector<BasicBlock*>&Succs);
 123
 124     // Add the function to write out all our counters to the global destructor
 125     // list.
 126     Function *insertCounterWriteout(ArrayRef<std::pair<GlobalVariable*,
 127                                                        MDNode*> >);
 128     Function *insertFlush(ArrayRef<std::pair<GlobalVariable*, MDNode*> >);
 129     void insertIndirectCounterIncrement();
 130
 131     std::string mangleName(DICompileUnit CU, const char *NewStem);
 132
 133     GCOVOptions Options;
 134
 135     // Reversed, NUL-terminated copy of Options.Version.
 136     char ReversedVersion[5];
 137     // Checksum, produced by hash of EdgeDestinations
 138     SmallVector<uint32_t, 4> FileChecksums;
 139
 140     Module *M;
 141     LLVMContext *Ctx;
 142     SmallVector<std::unique_ptr<GCOVFunction>, 16> Funcs;
 143   };
 144 }
 145
 146 char GCOVProfiler::ID = 0;
 147 INITIALIZE_PASS(GCOVProfiler, "insert-gcov-profiling",
 148                 "Insert instrumentation for GCOV profiling", false, false)
 149
 150 ModulePass *llvm::createGCOVProfilerPass(const GCOVOptions &Options) {
 151   return new GCOVProfiler(Options);
 152 }
 153
 154 static StringRef getFunctionName(DISubprogram SP) {
 155   if (!SP.getLinkageName().empty())
 156     return SP.getLinkageName();
 157   return SP.getName();
 158 }
 159
 160 namespace {
 161   class GCOVRecord {
 162    protected:
 163     static const char *const LinesTag;
 164     static const char *const FunctionTag;
 165     static const char *const BlockTag;
 166     static const char *const EdgeTag;
 167
 168     GCOVRecord() {}
 169
 170     void writeBytes(const char *Bytes, int Size) {
 171       os->write(Bytes, Size);
 172     }
 173
 174     void write(uint32_t i) {
 175       writeBytes(reinterpret_cast<char*>(&i), 4);
 176     }
 177
 178     // Returns the length measured in 4-byte blocks that will be used to
 179     // represent this string in a GCOV file
 180     static unsigned lengthOfGCOVString(StringRef s) {
 181       // A GCOV string is a length, followed by a NUL, then between 0 and 3 NULs
 182       // padding out to the next 4-byte word. The length is measured in 4-byte
 183       // words including padding, not bytes of actual string.
 184       return (s.size() / 4) + 1;
 185     }
 186
 187     void writeGCOVString(StringRef s) {
 188       uint32_t Len = lengthOfGCOVString(s);
 189       write(Len);
 190       writeBytes(s.data(), s.size());
 191
 192       // Write 1 to 4 bytes of NUL padding.
 193       assert((unsigned)(4 - (s.size() % 4)) > 0);
 194       assert((unsigned)(4 - (s.size() % 4)) <= 4);
 195       writeBytes("\0\0\0\0", 4 - (s.size() % 4));
 196     }
 197
 198     raw_ostream *os;
 199   };
 200   const char *const GCOVRecord::LinesTag = "\0\0\x45\x01";
 201   const char *const GCOVRecord::FunctionTag = "\0\0\0\1";
 202   const char *const GCOVRecord::BlockTag = "\0\0\x41\x01";
 203   const char *const GCOVRecord::EdgeTag = "\0\0\x43\x01";
 204
 205   class GCOVFunction;
 206   class GCOVBlock;
 207
 208   // Constructed only by requesting it from a GCOVBlock, this object stores a
 209   // list of line numbers and a single filename, representing lines that belong
 210   // to the block.
 211   class GCOVLines : public GCOVRecord {
 212    public:
 213     void addLine(uint32_t Line) {
 214       assert(Line != 0 && "Line zero is not a valid real line number.");
 215       Lines.push_back(Line);
 216     }
 217
 218     uint32_t length() const {
 219       // Here 2 = 1 for string length + 1 for '0' id#.
 220       return lengthOfGCOVString(Filename) + 2 + Lines.size();
 221     }
 222
 223     void writeOut() {
 224       write(0);
 225       writeGCOVString(Filename);
 226       for (int i = 0, e = Lines.size(); i != e; ++i)
 227         write(Lines[i]);
 228     }
 229
 230     GCOVLines(StringRef F, raw_ostream *os)
 231       : Filename(F) {
 232       this->os = os;
 233     }
 234
 235    private:
 236     StringRef Filename;
 237     SmallVector<uint32_t, 32> Lines;
 238   };
 239
 240
 241   // Represent a basic block in GCOV. Each block has a unique number in the
 242   // function, number of lines belonging to each block, and a set of edges to
 243   // other blocks.
 244   class GCOVBlock : public GCOVRecord {
 245    public:
 246     GCOVLines &getFile(StringRef Filename) {
 247       GCOVLines *&Lines = LinesByFile[Filename];
 248       if (!Lines) {
 249         Lines = new GCOVLines(Filename, os);
 250       }
 251       return *Lines;
 252     }
 253
 254     void addEdge(GCOVBlock &Successor) {
 255       OutEdges.push_back(&Successor);
 256     }
 257
 258     void writeOut() {
 259       uint32_t Len = 3;
 260       SmallVector<StringMapEntry<GCOVLines *> *, 32> SortedLinesByFile;
 261       for (StringMap<GCOVLines *>::iterator I = LinesByFile.begin(),
 262                E = LinesByFile.end(); I != E; ++I) {
 263         Len += I->second->length();
 264         SortedLinesByFile.push_back(&*I);
 265       }
 266
 267       writeBytes(LinesTag, 4);
 268       write(Len);
 269       write(Number);
 270
 271       std::sort(SortedLinesByFile.begin(), SortedLinesByFile.end(),
 272                 [](StringMapEntry<GCOVLines *> *LHS,
 273                    StringMapEntry<GCOVLines *> *RHS) {
 274         return LHS->getKey() < RHS->getKey();
 275       });
 276       for (SmallVectorImpl<StringMapEntry<GCOVLines *> *>::iterator
 277                I = SortedLinesByFile.begin(), E = SortedLinesByFile.end();
 278            I != E; ++I)
 279         (*I)->getValue()->writeOut();
 280       write(0);
 281       write(0);
 282     }
 283
 284     ~GCOVBlock() {
 285       DeleteContainerSeconds(LinesByFile);
 286     }
 287
 288    private:
 289     friend class GCOVFunction;
 290
 291     GCOVBlock(uint32_t Number, raw_ostream *os)
 292         : Number(Number) {
 293       this->os = os;
 294     }
 295
 296     uint32_t Number;
 297     StringMap<GCOVLines *> LinesByFile;
 298     SmallVector<GCOVBlock *, 4> OutEdges;
 299   };
 300
 301   // A function has a unique identifier, a checksum (we leave as zero) and a
 302   // set of blocks and a map of edges between blocks. This is the only GCOV
 303   // object users can construct, the blocks and lines will be rooted here.
 304   class GCOVFunction : public GCOVRecord {
 305    public:
 306     GCOVFunction(DISubprogram SP, raw_ostream *os, uint32_t Ident,
 307                  bool UseCfgChecksum) :
 308         SP(SP), Ident(Ident), UseCfgChecksum(UseCfgChecksum), CfgChecksum(0) {
 309       this->os = os;
 310
 311       Function *F = SP.getFunction();
 312       DEBUG(dbgs() << "Function: " << getFunctionName(SP) << "\n");
 313       uint32_t i = 0;
 314       for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 315         Blocks[BB] = new GCOVBlock(i++, os);
 316       }
 317       ReturnBlock = new GCOVBlock(i++, os);
 318
 319       std::string FunctionNameAndLine;
 320       raw_string_ostream FNLOS(FunctionNameAndLine);
 321       FNLOS << getFunctionName(SP) << SP.getLineNumber();
 322       FNLOS.flush();
 323       FuncChecksum = hash_value(FunctionNameAndLine);
 324     }
 325
 326     ~GCOVFunction() {
 327       DeleteContainerSeconds(Blocks);
 328       delete ReturnBlock;
 329     }
 330
 331     GCOVBlock &getBlock(BasicBlock *BB) {
 332       return *Blocks[BB];
 333     }
 334
 335     GCOVBlock &getReturnBlock() {
 336       return *ReturnBlock;
 337     }
 338
 339     std::string getEdgeDestinations() {
 340       std::string EdgeDestinations;
 341       raw_string_ostream EDOS(EdgeDestinations);
 342       Function *F = Blocks.begin()->first->getParent();
 343       for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
 344         GCOVBlock &Block = *Blocks[I];
 345         for (int i = 0, e = Block.OutEdges.size(); i != e; ++i)
 346           EDOS << Block.OutEdges[i]->Number;
 347       }
 348       return EdgeDestinations;
 349     }
 350
 351     uint32_t getFuncChecksum() {
 352       return FuncChecksum;
 353     }
 354
 355     void setCfgChecksum(uint32_t Checksum) {
 356       CfgChecksum = Checksum;
 357     }
 358
 359     void writeOut() {
 360       writeBytes(FunctionTag, 4);
 361       uint32_t BlockLen = 1 + 1 + 1 + lengthOfGCOVString(getFunctionName(SP)) +
 362           1 + lengthOfGCOVString(SP.getFilename()) + 1;
 363       if (UseCfgChecksum)
 364         ++BlockLen;
 365       write(BlockLen);
 366       write(Ident);
 367       write(FuncChecksum);
 368       if (UseCfgChecksum)
 369         write(CfgChecksum);
 370       writeGCOVString(getFunctionName(SP));
 371       writeGCOVString(SP.getFilename());
 372       write(SP.getLineNumber());
 373
 374       // Emit count of blocks.
 375       writeBytes(BlockTag, 4);
 376       write(Blocks.size() + 1);
 377       for (int i = 0, e = Blocks.size() + 1; i != e; ++i) {
 378         write(0);  // No flags on our blocks.
 379       }
 380       DEBUG(dbgs() << Blocks.size() << " blocks.\n");
 381
 382       // Emit edges between blocks.
 383       if (Blocks.empty()) return;
 384       Function *F = Blocks.begin()->first->getParent();
 385       for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
 386         GCOVBlock &Block = *Blocks[I];
 387         if (Block.OutEdges.empty()) continue;
 388
 389         writeBytes(EdgeTag, 4);
 390         write(Block.OutEdges.size() * 2 + 1);
 391         write(Block.Number);
 392         for (int i = 0, e = Block.OutEdges.size(); i != e; ++i) {
 393           DEBUG(dbgs() << Block.Number << " -> " << Block.OutEdges[i]->Number
 394                        << "\n");
 395           write(Block.OutEdges[i]->Number);
 396           write(0);  // no flags
 397         }
 398       }
 399
 400       // Emit lines for each block.
 401       for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
 402         Blocks[I]->writeOut();
 403       }
 404     }
 405
 406    private:
 407     DISubprogram SP;
 408     uint32_t Ident;
 409     uint32_t FuncChecksum;
 410     bool UseCfgChecksum;
 411     uint32_t CfgChecksum;
 412     DenseMap<BasicBlock *, GCOVBlock *> Blocks;
 413     GCOVBlock *ReturnBlock;
 414   };
 415 }
 416
 417 std::string GCOVProfiler::mangleName(DICompileUnit CU, const char *NewStem) {
 418   if (NamedMDNode *GCov = M->getNamedMetadata("llvm.gcov")) {
 419     for (int i = 0, e = GCov->getNumOperands(); i != e; ++i) {
 420       MDNode *N = GCov->getOperand(i);
 421       if (N->getNumOperands() != 2) continue;
 422       MDString *GCovFile = dyn_cast<MDString>(N->getOperand(0));
 423       MDNode *CompileUnit = dyn_cast<MDNode>(N->getOperand(1));
 424       if (!GCovFile || !CompileUnit) continue;
 425       if (CompileUnit == CU) {
 426         SmallString<128> Filename = GCovFile->getString();
 427         sys::path::replace_extension(Filename, NewStem);
 428         return Filename.str();
 429       }
 430     }
 431   }
 432
 433   SmallString<128> Filename = CU.getFilename();
 434   sys::path::replace_extension(Filename, NewStem);
 435   StringRef FName = sys::path::filename(Filename);
 436   SmallString<128> CurPath;
 437   if (sys::fs::current_path(CurPath)) return FName;
 438   sys::path::append(CurPath, FName.str());
 439   return CurPath.str();
 440 }
 441
 442 bool GCOVProfiler::runOnModule(Module &M) {
 443   this->M = &M;
 444   Ctx = &M.getContext();
 445
 446   if (Options.EmitNotes) emitProfileNotes();
 447   if (Options.EmitData) return emitProfileArcs();
 448   return false;
 449 }
 450
 451 static bool functionHasLines(Function *F) {
 452   // Check whether this function actually has any source lines. Not only
 453   // do these waste space, they also can crash gcov.
 454   for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 455     for (BasicBlock::iterator I = BB->begin(), IE = BB->end();
 456          I != IE; ++I) {
 457       // Debug intrinsic locations correspond to the location of the
 458       // declaration, not necessarily any statements or expressions.
 459       if (isa<DbgInfoIntrinsic>(I)) continue;
 460
 461       const DebugLoc &Loc = I->getDebugLoc();
 462       if (Loc.isUnknown()) continue;
 463
 464       // Artificial lines such as calls to the global constructors.
 465       if (Loc.getLine() == 0) continue;
 466
 467       return true;
 468     }
 469   }
 470   return false;
 471 }
 472
 473 void GCOVProfiler::emitProfileNotes() {
 474   NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
 475   if (!CU_Nodes) return;
 476
 477   for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 478     // Each compile unit gets its own .gcno file. This means that whether we run
 479     // this pass over the original .o's as they're produced, or run it after
 480     // LTO, we'll generate the same .gcno files.
 481
 482     DICompileUnit CU(CU_Nodes->getOperand(i));
 483     std::error_code EC;
 484     raw_fd_ostream out(mangleName(CU, "gcno"), EC, sys::fs::F_None);
 485     std::string EdgeDestinations;
 486
 487     DIArray SPs = CU.getSubprograms();
 488     for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
 489       DISubprogram SP(SPs.getElement(i));
 490       assert((!SP || SP.isSubprogram()) &&
 491         "A MDNode in subprograms of a CU should be null or a DISubprogram.");
 492       if (!SP)
 493         continue;
 494
 495       Function *F = SP.getFunction();
 496       if (!F) continue;
 497       if (!functionHasLines(F)) continue;
 498
 499       // gcov expects every function to start with an entry block that has a
 500       // single successor, so split the entry block to make sure of that.
 501       BasicBlock &EntryBlock = F->getEntryBlock();
 502       BasicBlock::iterator It = EntryBlock.begin();
 503       while (isa<AllocaInst>(*It) || isa<DbgInfoIntrinsic>(*It))
 504         ++It;
 505       EntryBlock.splitBasicBlock(It);
 506
 507       Funcs.push_back(
 508           make_unique<GCOVFunction>(SP, &out, i, Options.UseCfgChecksum));
 509       GCOVFunction &Func = *Funcs.back();
 510
 511       for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 512         GCOVBlock &Block = Func.getBlock(BB);
 513         TerminatorInst *TI = BB->getTerminator();
 514         if (int successors = TI->getNumSuccessors()) {
 515           for (int i = 0; i != successors; ++i) {
 516             Block.addEdge(Func.getBlock(TI->getSuccessor(i)));
 517           }
 518         } else if (isa<ReturnInst>(TI)) {
 519           Block.addEdge(Func.getReturnBlock());
 520         }
 521
 522         uint32_t Line = 0;
 523         for (BasicBlock::iterator I = BB->begin(), IE = BB->end();
 524              I != IE; ++I) {
 525           // Debug intrinsic locations correspond to the location of the
 526           // declaration, not necessarily any statements or expressions.
 527           if (isa<DbgInfoIntrinsic>(I)) continue;
 528
 529           const DebugLoc &Loc = I->getDebugLoc();
 530           if (Loc.isUnknown()) continue;
 531
 532           // Artificial lines such as calls to the global constructors.
 533           if (Loc.getLine() == 0) continue;
 534
 535           if (Line == Loc.getLine()) continue;
 536           Line = Loc.getLine();
 537           if (SP != getDISubprogram(Loc.getScope(*Ctx))) continue;
 538
 539           GCOVLines &Lines = Block.getFile(SP.getFilename());
 540           Lines.addLine(Loc.getLine());
 541         }
 542       }
 543       EdgeDestinations += Func.getEdgeDestinations();
 544     }
 545
 546     FileChecksums.push_back(hash_value(EdgeDestinations));
 547     out.write("oncg", 4);
 548     out.write(ReversedVersion, 4);
 549     out.write(reinterpret_cast<char*>(&FileChecksums.back()), 4);
 550
 551     for (auto &Func : Funcs) {
 552       Func->setCfgChecksum(FileChecksums.back());
 553       Func->writeOut();
 554     }
 555
 556     out.write("\0\0\0\0\0\0\0\0", 8);  // EOF
 557     out.close();
 558   }
 559 }
 560
 561 bool GCOVProfiler::emitProfileArcs() {
 562   NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
 563   if (!CU_Nodes) return false;
 564
 565   bool Result = false;
 566   bool InsertIndCounterIncrCode = false;
 567   for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 568     DICompileUnit CU(CU_Nodes->getOperand(i));
 569     DIArray SPs = CU.getSubprograms();
 570     SmallVector<std::pair<GlobalVariable *, MDNode *>, 8> CountersBySP;
 571     for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
 572       DISubprogram SP(SPs.getElement(i));
 573       assert((!SP || SP.isSubprogram()) &&
 574         "A MDNode in subprograms of a CU should be null or a DISubprogram.");
 575       if (!SP)
 576         continue;
 577       Function *F = SP.getFunction();
 578       if (!F) continue;
 579       if (!functionHasLines(F)) continue;
 580       if (!Result) Result = true;
 581       unsigned Edges = 0;
 582       for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 583         TerminatorInst *TI = BB->getTerminator();
 584         if (isa<ReturnInst>(TI))
 585           ++Edges;
 586         else
 587           Edges += TI->getNumSuccessors();
 588       }
 589
 590       ArrayType *CounterTy =
 591         ArrayType::get(Type::getInt64Ty(*Ctx), Edges);
 592       GlobalVariable *Counters =
 593         new GlobalVariable(*M, CounterTy, false,
 594                            GlobalValue::InternalLinkage,
 595                            Constant::getNullValue(CounterTy),
 596                            "__llvm_gcov_ctr");
 597       CountersBySP.push_back(std::make_pair(Counters, (MDNode*)SP));
 598
 599       UniqueVector<BasicBlock *> ComplexEdgePreds;
 600       UniqueVector<BasicBlock *> ComplexEdgeSuccs;
 601
 602       unsigned Edge = 0;
 603       for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 604         TerminatorInst *TI = BB->getTerminator();
 605         int Successors = isa<ReturnInst>(TI) ? 1 : TI->getNumSuccessors();
 606         if (Successors) {
 607           if (Successors == 1) {
 608             IRBuilder<> Builder(BB->getFirstInsertionPt());
 609             Value *Counter = Builder.CreateConstInBoundsGEP2_64(Counters, 0,
 610                                                                 Edge);
 611             Value *Count = Builder.CreateLoad(Counter);
 612             Count = Builder.CreateAdd(Count, Builder.getInt64(1));
 613             Builder.CreateStore(Count, Counter);
 614           } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
 615             IRBuilder<> Builder(BI);
 616             Value *Sel = Builder.CreateSelect(BI->getCondition(),
 617                                               Builder.getInt64(Edge),
 618                                               Builder.getInt64(Edge + 1));
 619             SmallVector<Value *, 2> Idx;
 620             Idx.push_back(Builder.getInt64(0));
 621             Idx.push_back(Sel);
 622             Value *Counter = Builder.CreateInBoundsGEP(Counters, Idx);
 623             Value *Count = Builder.CreateLoad(Counter);
 624             Count = Builder.CreateAdd(Count, Builder.getInt64(1));
 625             Builder.CreateStore(Count, Counter);
 626           } else {
 627             ComplexEdgePreds.insert(BB);
 628             for (int i = 0; i != Successors; ++i)
 629               ComplexEdgeSuccs.insert(TI->getSuccessor(i));
 630           }
 631
 632           Edge += Successors;
 633         }
 634       }
 635
 636       if (!ComplexEdgePreds.empty()) {
 637         GlobalVariable *EdgeTable =
 638           buildEdgeLookupTable(F, Counters,
 639                                ComplexEdgePreds, ComplexEdgeSuccs);
 640         GlobalVariable *EdgeState = getEdgeStateValue();
 641
 642         for (int i = 0, e = ComplexEdgePreds.size(); i != e; ++i) {
 643           IRBuilder<> Builder(ComplexEdgePreds[i + 1]->getFirstInsertionPt());
 644           Builder.CreateStore(Builder.getInt32(i), EdgeState);
 645         }
 646
 647         for (int i = 0, e = ComplexEdgeSuccs.size(); i != e; ++i) {
 648           // Call runtime to perform increment.
 649           IRBuilder<> Builder(ComplexEdgeSuccs[i+1]->getFirstInsertionPt());
 650           Value *CounterPtrArray =
 651             Builder.CreateConstInBoundsGEP2_64(EdgeTable, 0,
 652                                                i * ComplexEdgePreds.size());
 653
 654           // Build code to increment the counter.
 655           InsertIndCounterIncrCode = true;
 656           Builder.CreateCall2(getIncrementIndirectCounterFunc(),
 657                               EdgeState, CounterPtrArray);
 658         }
 659       }
 660     }
 661
 662     Function *WriteoutF = insertCounterWriteout(CountersBySP);
 663     Function *FlushF = insertFlush(CountersBySP);
 664
 665     // Create a small bit of code that registers the "__llvm_gcov_writeout" to
 666     // be executed at exit and the "__llvm_gcov_flush" function to be executed
 667     // when "__gcov_flush" is called.
 668     FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
 669     Function *F = Function::Create(FTy, GlobalValue::InternalLinkage,
 670                                    "__llvm_gcov_init", M);
 671     F->setUnnamedAddr(true);
 672     F->setLinkage(GlobalValue::InternalLinkage);
 673     F->addFnAttr(Attribute::NoInline);
 674     if (Options.NoRedZone)
 675       F->addFnAttr(Attribute::NoRedZone);
 676
 677     BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", F);
 678     IRBuilder<> Builder(BB);
 679
 680     FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
 681     Type *Params[] = {
 682       PointerType::get(FTy, 0),
 683       PointerType::get(FTy, 0)
 684     };
 685     FTy = FunctionType::get(Builder.getVoidTy(), Params, false);
 686
 687     // Initialize the environment and register the local writeout and flush
 688     // functions.
 689     Constant *GCOVInit = M->getOrInsertFunction("llvm_gcov_init", FTy);
 690     Builder.CreateCall2(GCOVInit, WriteoutF, FlushF);
 691     Builder.CreateRetVoid();
 692
 693     appendToGlobalCtors(*M, F, 0);
 694   }
 695
 696   if (InsertIndCounterIncrCode)
 697     insertIndirectCounterIncrement();
 698
 699   return Result;
 700 }
 701
 702 // All edges with successors that aren't branches are "complex", because it
 703 // requires complex logic to pick which counter to update.
 704 GlobalVariable *GCOVProfiler::buildEdgeLookupTable(
 705     Function *F,
 706     GlobalVariable *Counters,
 707     const UniqueVector<BasicBlock *> &Preds,
 708     const UniqueVector<BasicBlock *> &Succs) {
 709   // TODO: support invoke, threads. We rely on the fact that nothing can modify
 710   // the whole-Module pred edge# between the time we set it and the time we next
 711   // read it. Threads and invoke make this untrue.
 712
 713   // emit [(succs * preds) x i64*], logically [succ x [pred x i64*]].
 714   size_t TableSize = Succs.size() * Preds.size();
 715   Type *Int64PtrTy = Type::getInt64PtrTy(*Ctx);
 716   ArrayType *EdgeTableTy = ArrayType::get(Int64PtrTy, TableSize);
 717
 718   std::unique_ptr<Constant * []> EdgeTable(new Constant *[TableSize]);
 719   Constant *NullValue = Constant::getNullValue(Int64PtrTy);
 720   for (size_t i = 0; i != TableSize; ++i)
 721     EdgeTable[i] = NullValue;
 722
 723   unsigned Edge = 0;
 724   for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 725     TerminatorInst *TI = BB->getTerminator();
 726     int Successors = isa<ReturnInst>(TI) ? 1 : TI->getNumSuccessors();
 727     if (Successors > 1 && !isa<BranchInst>(TI) && !isa<ReturnInst>(TI)) {
 728       for (int i = 0; i != Successors; ++i) {
 729         BasicBlock *Succ = TI->getSuccessor(i);
 730         IRBuilder<> Builder(Succ);
 731         Value *Counter = Builder.CreateConstInBoundsGEP2_64(Counters, 0,
 732                                                             Edge + i);
 733         EdgeTable[((Succs.idFor(Succ)-1) * Preds.size()) +
 734                   (Preds.idFor(BB)-1)] = cast<Constant>(Counter);
 735       }
 736     }
 737     Edge += Successors;
 738   }
 739
 740   GlobalVariable *EdgeTableGV =
 741       new GlobalVariable(
 742           *M, EdgeTableTy, true, GlobalValue::InternalLinkage,
 743           ConstantArray::get(EdgeTableTy,
 744                              makeArrayRef(&EdgeTable[0],TableSize)),
 745           "__llvm_gcda_edge_table");
 746   EdgeTableGV->setUnnamedAddr(true);
 747   return EdgeTableGV;
 748 }
 749
 750 Constant *GCOVProfiler::getStartFileFunc() {
 751   Type *Args[] = {
 752     Type::getInt8PtrTy(*Ctx),  // const char *orig_filename
 753     Type::getInt8PtrTy(*Ctx),  // const char version[4]
 754     Type::getInt32Ty(*Ctx),    // uint32_t checksum
 755   };
 756   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), Args, false);
 757   return M->getOrInsertFunction("llvm_gcda_start_file", FTy);
 758 }
 759
 760 Constant *GCOVProfiler::getIncrementIndirectCounterFunc() {
 761   Type *Int32Ty = Type::getInt32Ty(*Ctx);
 762   Type *Int64Ty = Type::getInt64Ty(*Ctx);
 763   Type *Args[] = {
 764     Int32Ty->getPointerTo(),                // uint32_t *predecessor
 765     Int64Ty->getPointerTo()->getPointerTo() // uint64_t **counters
 766   };
 767   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), Args, false);
 768   return M->getOrInsertFunction("__llvm_gcov_indirect_counter_increment", FTy);
 769 }
 770
 771 Constant *GCOVProfiler::getEmitFunctionFunc() {
 772   Type *Args[] = {
 773     Type::getInt32Ty(*Ctx),    // uint32_t ident
 774     Type::getInt8PtrTy(*Ctx),  // const char *function_name
 775     Type::getInt32Ty(*Ctx),    // uint32_t func_checksum
 776     Type::getInt8Ty(*Ctx),     // uint8_t use_extra_checksum
 777     Type::getInt32Ty(*Ctx),    // uint32_t cfg_checksum
 778   };
 779   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), Args, false);
 780   return M->getOrInsertFunction("llvm_gcda_emit_function", FTy);
 781 }
 782
 783 Constant *GCOVProfiler::getEmitArcsFunc() {
 784   Type *Args[] = {
 785     Type::getInt32Ty(*Ctx),     // uint32_t num_counters
 786     Type::getInt64PtrTy(*Ctx),  // uint64_t *counters
 787   };
 788   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), Args, false);
 789   return M->getOrInsertFunction("llvm_gcda_emit_arcs", FTy);
 790 }
 791
 792 Constant *GCOVProfiler::getSummaryInfoFunc() {
 793   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
 794   return M->getOrInsertFunction("llvm_gcda_summary_info", FTy);
 795 }
 796
 797 Constant *GCOVProfiler::getDeleteWriteoutFunctionListFunc() {
 798   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
 799   return M->getOrInsertFunction("llvm_delete_writeout_function_list", FTy);
 800 }
 801
 802 Constant *GCOVProfiler::getDeleteFlushFunctionListFunc() {
 803   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
 804   return M->getOrInsertFunction("llvm_delete_flush_function_list", FTy);
 805 }
 806
 807 Constant *GCOVProfiler::getEndFileFunc() {
 808   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
 809   return M->getOrInsertFunction("llvm_gcda_end_file", FTy);
 810 }
 811
 812 GlobalVariable *GCOVProfiler::getEdgeStateValue() {
 813   GlobalVariable *GV = M->getGlobalVariable("__llvm_gcov_global_state_pred");
 814   if (!GV) {
 815     GV = new GlobalVariable(*M, Type::getInt32Ty(*Ctx), false,
 816                             GlobalValue::InternalLinkage,
 817                             ConstantInt::get(Type::getInt32Ty(*Ctx),
 818                                              0xffffffff),
 819                             "__llvm_gcov_global_state_pred");
 820     GV->setUnnamedAddr(true);
 821   }
 822   return GV;
 823 }
 824
 825 Function *GCOVProfiler::insertCounterWriteout(
 826     ArrayRef<std::pair<GlobalVariable *, MDNode *> > CountersBySP) {
 827   FunctionType *WriteoutFTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
 828   Function *WriteoutF = M->getFunction("__llvm_gcov_writeout");
 829   if (!WriteoutF)
 830     WriteoutF = Function::Create(WriteoutFTy, GlobalValue::InternalLinkage,
 831                                  "__llvm_gcov_writeout", M);
 832   WriteoutF->setUnnamedAddr(true);
 833   WriteoutF->addFnAttr(Attribute::NoInline);
 834   if (Options.NoRedZone)
 835     WriteoutF->addFnAttr(Attribute::NoRedZone);
 836
 837   BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", WriteoutF);
 838   IRBuilder<> Builder(BB);
 839
 840   Constant *StartFile = getStartFileFunc();
 841   Constant *EmitFunction = getEmitFunctionFunc();
 842   Constant *EmitArcs = getEmitArcsFunc();
 843   Constant *SummaryInfo = getSummaryInfoFunc();
 844   Constant *EndFile = getEndFileFunc();
 845
 846   NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
 847   if (CU_Nodes) {
 848     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 849       DICompileUnit CU(CU_Nodes->getOperand(i));
 850       std::string FilenameGcda = mangleName(CU, "gcda");
 851       uint32_t CfgChecksum = FileChecksums.empty() ? 0 : FileChecksums[i];
 852       Builder.CreateCall3(StartFile,
 853                           Builder.CreateGlobalStringPtr(FilenameGcda),
 854                           Builder.CreateGlobalStringPtr(ReversedVersion),
 855                           Builder.getInt32(CfgChecksum));
 856       for (unsigned j = 0, e = CountersBySP.size(); j != e; ++j) {
 857         DISubprogram SP(CountersBySP[j].second);
 858         uint32_t FuncChecksum = Funcs.empty() ? 0 : Funcs[j]->getFuncChecksum();
 859         Builder.CreateCall5(
 860             EmitFunction, Builder.getInt32(j),
 861             Options.FunctionNamesInData ?
 862               Builder.CreateGlobalStringPtr(getFunctionName(SP)) :
 863               Constant::getNullValue(Builder.getInt8PtrTy()),
 864             Builder.getInt32(FuncChecksum),
 865             Builder.getInt8(Options.UseCfgChecksum),
 866             Builder.getInt32(CfgChecksum));
 867
 868         GlobalVariable *GV = CountersBySP[j].first;
 869         unsigned Arcs =
 870           cast<ArrayType>(GV->getType()->getElementType())->getNumElements();
 871         Builder.CreateCall2(EmitArcs,
 872                             Builder.getInt32(Arcs),
 873                             Builder.CreateConstGEP2_64(GV, 0, 0));
 874       }
 875       Builder.CreateCall(SummaryInfo);
 876       Builder.CreateCall(EndFile);
 877     }
 878   }
 879
 880   Builder.CreateRetVoid();
 881   return WriteoutF;
 882 }
 883
 884 void GCOVProfiler::insertIndirectCounterIncrement() {
 885   Function *Fn =
 886     cast<Function>(GCOVProfiler::getIncrementIndirectCounterFunc());
 887   Fn->setUnnamedAddr(true);
 888   Fn->setLinkage(GlobalValue::InternalLinkage);
 889   Fn->addFnAttr(Attribute::NoInline);
 890   if (Options.NoRedZone)
 891     Fn->addFnAttr(Attribute::NoRedZone);
 892
 893   // Create basic blocks for function.
 894   BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", Fn);
 895   IRBuilder<> Builder(BB);
 896
 897   BasicBlock *PredNotNegOne = BasicBlock::Create(*Ctx, "", Fn);
 898   BasicBlock *CounterEnd = BasicBlock::Create(*Ctx, "", Fn);
 899   BasicBlock *Exit = BasicBlock::Create(*Ctx, "exit", Fn);
 900
 901   // uint32_t pred = *predecessor;
 902   // if (pred == 0xffffffff) return;
 903   Argument *Arg = Fn->arg_begin();
 904   Arg->setName("predecessor");
 905   Value *Pred = Builder.CreateLoad(Arg, "pred");
 906   Value *Cond = Builder.CreateICmpEQ(Pred, Builder.getInt32(0xffffffff));
 907   BranchInst::Create(Exit, PredNotNegOne, Cond, BB);
 908
 909   Builder.SetInsertPoint(PredNotNegOne);
 910
 911   // uint64_t *counter = counters[pred];
 912   // if (!counter) return;
 913   Value *ZExtPred = Builder.CreateZExt(Pred, Builder.getInt64Ty());
 914   Arg = std::next(Fn->arg_begin());
 915   Arg->setName("counters");
 916   Value *GEP = Builder.CreateGEP(Arg, ZExtPred);
 917   Value *Counter = Builder.CreateLoad(GEP, "counter");
 918   Cond = Builder.CreateICmpEQ(Counter,
 919                               Constant::getNullValue(
 920                                   Builder.getInt64Ty()->getPointerTo()));
 921   Builder.CreateCondBr(Cond, Exit, CounterEnd);
 922
 923   // ++*counter;
 924   Builder.SetInsertPoint(CounterEnd);
 925   Value *Add = Builder.CreateAdd(Builder.CreateLoad(Counter),
 926                                  Builder.getInt64(1));
 927   Builder.CreateStore(Add, Counter);
 928   Builder.CreateBr(Exit);
 929
 930   // Fill in the exit block.
 931   Builder.SetInsertPoint(Exit);
 932   Builder.CreateRetVoid();
 933 }
 934
 935 Function *GCOVProfiler::
 936 insertFlush(ArrayRef<std::pair<GlobalVariable*, MDNode*> > CountersBySP) {
 937   FunctionType *FTy = FunctionType::get(Type::getVoidTy(*Ctx), false);
 938   Function *FlushF = M->getFunction("__llvm_gcov_flush");
 939   if (!FlushF)
 940     FlushF = Function::Create(FTy, GlobalValue::InternalLinkage,
 941                               "__llvm_gcov_flush", M);
 942   else
 943     FlushF->setLinkage(GlobalValue::InternalLinkage);
 944   FlushF->setUnnamedAddr(true);
 945   FlushF->addFnAttr(Attribute::NoInline);
 946   if (Options.NoRedZone)
 947     FlushF->addFnAttr(Attribute::NoRedZone);
 948
 949   BasicBlock *Entry = BasicBlock::Create(*Ctx, "entry", FlushF);
 950
 951   // Write out the current counters.
 952   Constant *WriteoutF = M->getFunction("__llvm_gcov_writeout");
 953   assert(WriteoutF && "Need to create the writeout function first!");
 954
 955   IRBuilder<> Builder(Entry);
 956   Builder.CreateCall(WriteoutF);
 957
 958   // Zero out the counters.
 959   for (ArrayRef<std::pair<GlobalVariable *, MDNode *> >::iterator
 960          I = CountersBySP.begin(), E = CountersBySP.end();
 961        I != E; ++I) {
 962     GlobalVariable *GV = I->first;
 963     Constant *Null = Constant::getNullValue(GV->getType()->getElementType());
 964     Builder.CreateStore(Null, GV);
 965   }
 966
 967   Type *RetTy = FlushF->getReturnType();
 968   if (RetTy == Type::getVoidTy(*Ctx))
 969     Builder.CreateRetVoid();
 970   else if (RetTy->isIntegerTy())
 971     // Used if __llvm_gcov_flush was implicitly declared.
 972     Builder.CreateRet(ConstantInt::get(RetTy, 0));
 973   else
 974     report_fatal_error("invalid return type for __llvm_gcov_flush");
 975
 976   return FlushF;
 977 }