Ogre代码事例:调试跟踪器

在很多时候，程序百分之八十的效率浪费到百分之二十的代码中，在优化效率的时候，针对这些瓶颈函数的改良就显得至关重要。这里提供了一个简单的工具，用于跟踪函数的调用次序和时间花费，并打印出结果提供参考。

OgreDebugTrace.h

1.     #ifndef OgreDebugTrace_H_
2.     #define OgreDebugTrace_H_
4.     #ifdef _DEBUG
5.     #define OGRE_DEBUG_TRACE DebugTrace ____(__FILE__, __LINE__, __FUNCTION__);
6.     #else
7.     #define OGRE_DEBUG_TRACE
8.     #endif
10.     #include <Ogre.h>
11.     namespace Ogre
12.     {
13.     class DebugTraceManager: public Ogre::Singleton<DebugTraceManager>
14.     {
16.         typedef HashMap<Ogre::String, unsigned long> LogMsgMap;
17.     public:
18.         
19.         DebugTraceManager(Ogre::Log * log);
20.         ~DebugTraceManager(void);
21.         void print(const char * file, long line, const char * function, size_t layer);
22.         void log(const Ogre::String & name,size_t time, size_t layer);
23.         void printAll();
24.         unsigned long getTime();
25.     private:
26.         Ogre::Timer _timer;
27.         LogMsgMap _logMsg;
28.         Ogre::Log * _log;
29.         unsigned long _time;
30.     };
32.     class DebugTrace
33.     {
34.     public:
35.         DebugTrace(const char * file, long line, const char * function);
36.         ~DebugTrace();
37.     private:
38.         static size_t layer;
39.         unsigned long _time;
40.         Ogre::String _name;
41.     };
44.     }
46.     #endif

OgreDebugTrace.cpp

1. #include "OgreDebugTrace.h"
2. namespace Ogre
3. {
4.     template<> DebugTraceManager* Singleton<DebugTraceManager>::ms_Singleton = 0;
6.     size_t DebugTrace::layer = 0;
9.     DebugTraceManager::DebugTraceManager(Ogre::Log * log):_log(log)
10.     {
11.         _time = getTime();
12.     }
14.     DebugTraceManager::~DebugTraceManager(void)
15.     {
16.         printAll();
17.     }
18.     void DebugTraceManager::print(const char * file, long line, const char * function, size_t layer)
19.     {
20.         std::stringstream ss;
21.         while(layer--)
22.         {
23.             ss<<"   ";
24.         }
25.         ss<<"Trace begin"<<function<<", in "<<file<<" line:"<<line<<".";
26.         _log->logMessage(ss.str());
27.     
28.     }
29.     void DebugTraceManager::log(const Ogre::String & name,size_t time, size_t layer)
30.     {
31.         std::stringstream ss;
32.         while(layer--)
33.         {
34.             ss<<"   ";
35.         }
36.         ss<<"Trace over, cost:"<<time;
37.         
38.         _log->logMessage(ss.str());
39.         LogMsgMap::iterator it = _logMsg.find(name);
40.         if(it == _logMsg.end())
41.         {
42.             _logMsg.insert(std::make_pair(name, time));
43.         }
44.         else
45.         {
46.             it->second += time; 
47.         }
48.     }
49.     void DebugTraceManager::printAll()
50.     {
51.         LogMsgMap::iterator it;
53.         _time = getTime()-_time;
54.     
55.         std::stringstream ss;
56.         
57.         ss<<"in total cost:"<<_time<<std::endl;
59.         for(it = _logMsg.begin(); it != _logMsg.end(); ++it)
60.         {
61.             ss<<it->first<<"Cost:"<<it->second
62.                 <<"("<<(float(it->second)/float(_time) *100.0f)<<"%)."
63.                 <<std::endl;
64.         }
65.         _log->logMessage(ss.str());
66.     }
67.     unsigned long DebugTraceManager::getTime()
68.     {
69.         return _timer.getMicroseconds();
70.     }
73.     DebugTrace::DebugTrace(const char * file, long line, const char * function):_name(function)
74.     {
75.         DebugTraceManager::getSingleton().print(file, line, function, layer);
76.         _time = DebugTraceManager::getSingleton().getTime();
77.         ++layer;
78.         
79.     }
80.     DebugTrace::~DebugTrace()
81.     {
82.         _time = DebugTraceManager::getSingleton().getTime() - _time;
83.         --layer;
84.         DebugTraceManager::getSingleton().log(_name, _time, layer);
85.     }
86. }

在初始化Ogre之后加入下面的代码，开始跟踪调试：

#ifdef _DEBUG
_log = Ogre::LogManager::getSingleton().createLog("trace.log");
_traceManager = new DebugTraceManager(_log);
#endif

在每个要跟踪的函数开始的地方加入宏：

OGRE_DEBUG_TRACE 

在程序最后，通过下面的代码清理：

#ifdef _DEGUG
if(_traceManager)
	delete _traceManager;
Ogre::LogManager::getSingleton().destroyLog(_log);
#endif

局限：因为上面提供的代码是基于Ogre日志管理而实现的，所以只能在构建Ogre之后进行跟踪记录，但是可以很容易根据需要通过std::stream来代替Ogre::Log来实现相同功能的模块，这样就可以跟踪Ogre之外的代码了。

取自" http://ogre3d.cn/index.php?title=%E4%BB%A3%E7%A0%81%E4%BA%8B%E4%BE%8B:%E8%B0%83%E8%AF%95%E8%B7%9F%E8%B8%AA%E5%99%A8"