include/llvm/Analysis/ProfileInfo.h

   1 //===- llvm/Analysis/ProfileInfo.h - Profile Info Interface -----*- 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 // 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.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #ifndef LLVM_ANALYSIS_PROFILEINFO_H
  22 #define LLVM_ANALYSIS_PROFILEINFO_H
  23
  24 #include <string>
  25 #include <map>
  26
  27 namespace llvm {
  28   class BasicBlock;
  29   class Pass;
  30
  31   /// createProfileLoaderPass - This function returns a Pass that loads the
  32   /// profiling information for the module from the specified filename, making
  33   /// it available to the optimizers.
  34   Pass *createProfileLoaderPass(const std::string &Filename);
  35
  36   class ProfileInfo {
  37   protected:
  38     std::map<BasicBlock*, unsigned> ExecutionCounts;
  39   public:
  40     virtual ~ProfileInfo();  // We want to be subclassed
  41
  42     //===------------------------------------------------------------------===//
  43     /// Profile Information Queries
  44     ///
  45     unsigned getExecutionCount(BasicBlock *BB) {
  46       std::map<BasicBlock*, unsigned>::iterator I = ExecutionCounts.find(BB);
  47       return I != ExecutionCounts.end() ? I->second : 0;
  48     }
  49
  50     //===------------------------------------------------------------------===//
  51     /// Analysis Update Methods
  52     ///
  53
  54   };
  55
  56 } // End llvm namespace
  57
  58 #endif