lib/Transforms/Instrumentation/TraceBasicBlocks.cpp

   1 //===- TraceBasicBlocks.cpp - Insert basic-block trace instrumentation ----===//
   2 //
   3 //                      The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This pass instruments the specified program with calls into a runtime
  11 // library that cause it to output a trace of basic blocks as a side effect
  12 // of normal execution.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  21 #include "llvm/Transforms/Instrumentation.h"
  22 #include "llvm/Instructions.h"
  23 #include "ProfilingUtils.h"
  24 #include "llvm/Support/Debug.h"
  25 #include <set>
  26 #include <iostream>
  27 using namespace llvm;
  28
  29 namespace {
  30   class TraceBasicBlocks : public ModulePass {
  31     bool runOnModule(Module &M);
  32   };
  33
  34   RegisterPass<TraceBasicBlocks> X("trace-basic-blocks",
  35                               "Insert instrumentation for basic block tracing");
  36 }
  37
  38 ModulePass *llvm::createTraceBasicBlockPass()
  39 {
  40   return new TraceBasicBlocks();
  41 }
  42
  43 static void InsertInstrumentationCall (BasicBlock *BB,
  44                                        const std::string FnName,
  45                                        unsigned BBNumber) {
  46   DEBUG (std::cerr << "InsertInstrumentationCall (\"" << BB->getName ()
  47                    << "\", \"" << FnName << "\", " << BBNumber << ")\n");
  48   Module &M = *BB->getParent ()->getParent ();
  49   Function *InstrFn = M.getOrInsertFunction (FnName, Type::VoidTy,
  50                                              Type::UIntTy, (Type *)0);
  51   std::vector<Value*> Args (1);
  52   Args[0] = ConstantInt::get (Type::UIntTy, BBNumber);
  53
  54   // Insert the call after any alloca or PHI instructions...
  55   BasicBlock::iterator InsertPos = BB->begin();
  56   while (isa<AllocaInst>(InsertPos) || isa<PHINode>(InsertPos))
  57     ++InsertPos;
  58
  59   Instruction *InstrCall = new CallInst (InstrFn, Args, "", InsertPos);
  60 }
  61
  62 bool TraceBasicBlocks::runOnModule(Module &M) {
  63   Function *Main = M.getMainFunction();
  64   if (Main == 0) {
  65     std::cerr << "WARNING: cannot insert basic-block trace instrumentation"
  66               << " into a module with no main function!\n";
  67     return false;  // No main, no instrumentation!
  68   }
  69
  70   unsigned BBNumber = 0;
  71   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
  72     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
  73       InsertInstrumentationCall (BB, "llvm_trace_basic_block", BBNumber);
  74       ++BBNumber;
  75     }
  76
  77   // Add the initialization call to main.
  78   InsertProfilingInitCall(Main, "llvm_start_basic_block_tracing");
  79   return true;
  80 }
  81