include/llvm/Analysis/ProfileInfo.h

   1 //===- llvm/Analysis/ProfileInfo.h - Profile Info Interface -----*- C++ -*-===//
   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 file defines the generic ProfileInfo interface, which is used as the
  11 // common interface used by all clients of profiling information, and
  12 // implemented either by making static guestimations, or by actually reading in
  13 // profiling information gathered by running the program.
  14 //
  15 // Note that to be useful, all profile-based optimizations should preserve
  16 // ProfileInfo, which requires that they notify it when changes to the CFG are
  17 // made. (This is not implemented yet.)
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #ifndef LLVM_ANALYSIS_PROFILEINFO_H
  22 #define LLVM_ANALYSIS_PROFILEINFO_H
  23
  24 #include "llvm/BasicBlock.h"
  25 #include <cassert>
  26 #include <string>
  27 #include <map>
  28
  29 namespace llvm {
  30   class Function;
  31   class Pass;
  32   class raw_ostream;
  33
  34   /// ProfileInfo Class - This class holds and maintains profiling
  35   /// information for some unit of code.
  36   class ProfileInfo {
  37   public:
  38     // Types for handling profiling information.
  39     typedef std::pair<const BasicBlock*, const BasicBlock*> Edge;
  40     typedef std::pair<Edge, double> EdgeWeight;
  41     typedef std::map<Edge, double> EdgeWeights;
  42     typedef std::map<const BasicBlock*, double> BlockCounts;
  43
  44   protected:
  45     // EdgeInformation - Count the number of times a transition between two
  46     // blocks is executed. As a special case, we also hold an edge from the
  47     // null BasicBlock to the entry block to indicate how many times the
  48     // function was entered.
  49     std::map<const Function*, EdgeWeights> EdgeInformation;
  50
  51     // BlockInformation - Count the number of times a block is executed.
  52     std::map<const Function*, BlockCounts> BlockInformation;
  53
  54     // FunctionInformation - Count the number of times a function is executed.
  55     std::map<const Function*, double> FunctionInformation;
  56   public:
  57     static char ID; // Class identification, replacement for typeinfo
  58     virtual ~ProfileInfo();  // We want to be subclassed
  59
  60     // MissingValue - The value that is returned for execution counts in case
  61     // no value is available.
  62     static const double MissingValue;
  63
  64     // getFunction() - Returns the Function for an Edge, checking for validity.
  65     static const Function* getFunction(Edge e) {
  66       if (e.first) {
  67         return e.first->getParent();
  68       } else if (e.second) {
  69         return e.second->getParent();
  70       }
  71       assert(0 && "Invalid ProfileInfo::Edge");
  72       return (const Function*)0;
  73     }
  74
  75     // getEdge() - Creates an Edge from two BasicBlocks.
  76     static Edge getEdge(const BasicBlock *Src, const BasicBlock *Dest) {
  77       return std::make_pair(Src, Dest);
  78     }
  79
  80     //===------------------------------------------------------------------===//
  81     /// Profile Information Queries
  82     ///
  83     double getExecutionCount(const Function *F);
  84
  85     double getExecutionCount(const BasicBlock *BB);
  86
  87     double getEdgeWeight(Edge e) const {
  88       std::map<const Function*, EdgeWeights>::const_iterator J =
  89         EdgeInformation.find(getFunction(e));
  90       if (J == EdgeInformation.end()) return MissingValue;
  91
  92       EdgeWeights::const_iterator I = J->second.find(e);
  93       if (I == J->second.end()) return MissingValue;
  94
  95       return I->second;
  96     }
  97
  98     EdgeWeights &getEdgeWeights (const Function *F) {
  99       return EdgeInformation[F];
 100     }
 101
 102     //===------------------------------------------------------------------===//
 103     /// Analysis Update Methods
 104     ///
 105
 106   };
 107
 108   /// createProfileLoaderPass - This function returns a Pass that loads the
 109   /// profiling information for the module from the specified filename, making
 110   /// it available to the optimizers.
 111   Pass *createProfileLoaderPass(const std::string &Filename);
 112
 113   raw_ostream& operator<<(raw_ostream &O, ProfileInfo::Edge E);
 114
 115 } // End llvm namespace
 116
 117 #endif