MeVis/Foundation/Sources/MLProfilingManager/Include/mlTimeProfile.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------
// Class for collecting time profiling information.
//
// \file    mlTimeProfile.h
// \author  Marcus Barann
// \date    7/2009
//
//----------------------------------------------------------------------------------
#ifndef _ML_TIME_PROFILE_H_
#define _ML_TIME_PROFILE_H_

#include "mlProfilingManagerDllExport.h"

#include "../Include/mlCallGraph.h"

#include <boost/thread/thread.hpp>
#include <boost/shared_ptr.hpp>

#include <map>
#include <vector>

#define ML_TIME_PROFILE_CREATE_SCOPED_LOCK() \
    boost::mutex::scoped_lock callGraphMutexLock(MLTimeProfile::_callGraphMutex);

class MLMetaProfile;
class MLTimeProfile;
class MLCallGraphNode;

typedef boost::shared_ptr<MLCallGraphFunction> MLCallGraphFunctionPtr;

typedef std::vector<MLCallGraphNode*>                 MLCallGraphNodesVector;
typedef std::map<std::string, MLCallGraphNodesVector> MLCallGraphNodesByKeyMap;
typedef MLCallGraphNodesByKeyMap::iterator            MLCallGraphNodesByKeyMapIterator;
typedef std::map<MLCallGraphFunctionId, MLCallGraphFunctionPtr> MLCallGraphFunctionMap;
typedef std::vector<MLCallGraphFunctionPtr>                     MLCallGraphFunctionList;

typedef std::map<MLCallGraphFunctionId, MLTimeStatistics*> MLTimeStatisticsByFunctionMap;
typedef MLTimeStatisticsByFunctionMap::iterator       MLTimeStatisticsByFunctionMapIterator;


class MLPROFILINGMANAGER_EXPORT MLTimeProfileHandle
{
public:
  MLTimeProfileHandle();

private:
  MLTimeProfileHandle(MLCallGraphNode* callGraphNode);

  MLCallGraphNode* _callGraphNode;

  friend class MLTimeProfile;
  friend class ProfilingTest_TestCallGraphIsRecursive_Test;
  friend class ProfilingTest_TestProfileAccumulation_Test;
};


class MLPROFILINGMANAGER_EXPORT MLTimeProfile
{
public:
  MLTimeProfile(const MLMetaProfile* metaProfile = NULL);
  ~MLTimeProfile();

  MLTimeProfileHandle startMeasuring(const std::string& function,
                                     int userId,
                                     void* userData,
                                     const std::string& filename,
                                     int linenumber);

  void stopMeasuring(MLTimeProfileHandle& handle);

  void reset();

  const MLMetaProfile* metaProfile() const;

  MLProfilingTimeType allElapsedTime() const { return _allElapsedTime; }

  MLProfilingTimeType allConsumedTime() const { return _allConsumedTime; }

  static MLCallGraphNode& callGraph();

  const MLCallGraphFunctionMap& functionMap() const { return _functionMap; }

  static const MLCallGraphFunctionMap& globalFunctionMap() { return _globalFunctionMap; }

  static const MLCallGraphFunctionList& globalFunctionList() { return _globalFunctionList; }

  MLCallGraphFunctionId getFunctionId(const std::string& identifier) const;

  static MLCallGraphFunctionPtr getFunctionGlobal(const std::string& identifier);

  MLCallGraphFunctionPtr getFunction(MLCallGraphFunctionId functionId) const;

  static MLProfilingTimeType globalElapsedTime();

  static void setReduceCallGraph(bool reduceCallGraph) { _reduceCallGraph = reduceCallGraph; };

  static void initialize();

  static void deinitialize();

private:
  void deleteFunction(const MLCallGraphFunctionPtr& function);

  static void addGlobalFunction(const MLCallGraphFunctionPtr& function);

  static void deleteGlobalFunction(const MLCallGraphFunctionPtr& function);

  void removeCallGraphNode(MLCallGraphNode* node);

  void updateStatistics(MLTimeStatistics& statistics,
                        bool updateElapsedTime,
                        MLProfilingTimeType elapsedTime,
                        MLProfilingTimeType consumedTime);
  static void resetGlobalData();

public:
  static MLCallGraphFunctionPtr mainFunction;

private:
  MLCallGraphFunctionMap        _functionMap;

  MLProfilingTimeType _allElapsedTime;
  MLProfilingTimeType _allConsumedTime;

  const MLMetaProfile* _metaProfile;

  MLCallGraphNodesVector _callGraphNodes;

  static bool _reduceCallGraph;

  static MLCallGraphFunctionId         _lastFunctionId;
  static MLCallGraphFunctionMap        _globalFunctionMap;
  // duplicates the global function map values, but is required for performance reasons
  static MLCallGraphFunctionList _globalFunctionList;

  static MLCallGraphNode* _callGraph;
  static MLCallGraphNode* _lastCallGraphNode;
  static boost::mutex     _callGraphMutex;

  friend class MLAccumulatedProfile;
  friend class MLCallGraphNode;
  friend class MLProfilingManager;

  friend class MLABModuleProfile;
};


#endif // _ML_TIME_PROFILE_H_