include/llvm/Analysis/ProfileInfoLoader.h

   1 //===- ProfileInfoLoader.h - Load & convert profile information -*- C++ -*-===//
   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 // The ProfileInfoLoader class is used to load and represent profiling
  11 // information read in from the dump file.  If conversions between formats are
  12 // needed, it can also do this.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_ANALYSIS_PROFILEINFOLOADER_H
  17 #define LLVM_ANALYSIS_PROFILEINFOLOADER_H
  18
  19 #include <vector>
  20 #include <string>
  21 #include <utility>
  22
  23 namespace llvm {
  24
  25 class Module;
  26 class Function;
  27 class BasicBlock;
  28
  29 class ProfileInfoLoader {
  30   Module &M;
  31   std::vector<std::string> CommandLines;
  32   std::vector<unsigned>    FunctionCounts;
  33   std::vector<unsigned>    BlockCounts;
  34   std::vector<unsigned>    EdgeCounts;
  35   std::vector<unsigned>    BBTrace;
  36 public:
  37   // ProfileInfoLoader ctor - Read the specified profiling data file, exiting
  38   // the program if the file is invalid or broken.
  39   ProfileInfoLoader(const char *ToolName, const std::string &Filename,
  40                     Module &M);
  41
  42   unsigned getNumExecutions() const { return CommandLines.size(); }
  43   const std::string &getExecution(unsigned i) const { return CommandLines[i]; }
  44
  45   // getFunctionCounts - This method is used by consumers of function counting
  46   // information.  If we do not directly have function count information, we
  47   // compute it from other, more refined, types of profile information.
  48   //
  49   void getFunctionCounts(std::vector<std::pair<Function*, unsigned> > &Counts);
  50
  51   // hasAccurateBlockCounts - Return true if we can synthesize accurate block
  52   // frequency information from whatever we have.
  53   //
  54   bool hasAccurateBlockCounts() const {
  55     return !BlockCounts.empty() || !EdgeCounts.empty();
  56   }
  57
  58   // hasAccurateEdgeCounts - Return true if we can synthesize accurate edge
  59   // frequency information from whatever we have.
  60   //
  61   bool hasAccurateEdgeCounts() const {
  62     return !EdgeCounts.empty();
  63   }
  64
  65   // getBlockCounts - This method is used by consumers of block counting
  66   // information.  If we do not directly have block count information, we
  67   // compute it from other, more refined, types of profile information.
  68   //
  69   void getBlockCounts(std::vector<std::pair<BasicBlock*, unsigned> > &Counts);
  70
  71   // getEdgeCounts - This method is used by consumers of edge counting
  72   // information.  If we do not directly have edge count information, we compute
  73   // it from other, more refined, types of profile information.
  74   //
  75   // Edges are represented as a pair, where the first element is the basic block
  76   // and the second element is the successor number.
  77   //
  78   typedef std::pair<BasicBlock*, unsigned> Edge;
  79   void getEdgeCounts(std::vector<std::pair<Edge, unsigned> > &Counts);
  80
  81   // getBBTrace - This method is used by consumers of basic-block trace
  82   // information.
  83   //
  84   void getBBTrace(std::vector<BasicBlock *> &Trace);
  85 };
  86
  87 } // End llvm namespace
  88
  89 #endif