/** Lightweight profiler library for c++ Copyright(C) 2016 Sergey Yagovtsev, Victor Zarubkin This program is free software : you can redistribute it and / or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program.If not, see . **/ #ifndef ____PROFILER____H_______ #define ____PROFILER____H_______ #define TOKEN_JOIN(x, y) x ## y #define TOKEN_CONCATENATE(x, y) TOKEN_JOIN(x, y) #if defined ( WIN32 ) #define __func__ __FUNCTION__ #endif #ifndef FULL_DISABLE_PROFILER /** \defgroup profiler Profiler */ /** Macro of beginning of block with custom name and default identification \code #include "profiler/profiler.h" void foo() { // some code ... if(something){ PROFILER_BEGIN_BLOCK("Calling someThirdPartyLongFunction()"); someThirdPartyLongFunction(); return; } } \endcode Block will be automatically completed by destructor \ingroup profiler */ #define PROFILER_BEGIN_BLOCK(name)\ static const profiler::BlockSourceInfo TOKEN_CONCATENATE(unique_profiler_source_name_,__LINE__)(__FILE__, __LINE__);\ profiler::Block TOKEN_CONCATENATE(unique_profiler_mark_name_,__LINE__)(name,profiler::colors::Clay,profiler::BLOCK_TYPE_BLOCK,\ TOKEN_CONCATENATE(unique_profiler_source_name_,__LINE__).id());\ profiler::beginBlock(TOKEN_CONCATENATE(unique_profiler_mark_name_,__LINE__)); /** Macro of beginning of block with custom name and custom identification \code #include "profiler/profiler.h" void foo() { // some code ... if(something){ PROFILER_BEGIN_BLOCK("Calling someThirdPartyLongFunction()",profiler::colors::Red); someThirdPartyLongFunction(); return; } } \endcode Block will be automatically completed by destructor \ingroup profiler */ #define PROFILER_BEGIN_BLOCK_GROUPED(name,block_group)\ static const profiler::BlockSourceInfo TOKEN_CONCATENATE(unique_profiler_source_name_,__LINE__)(__FILE__, __LINE__);\ profiler::Block TOKEN_CONCATENATE(unique_profiler_mark_name_,__LINE__)(name,block_group,profiler::BLOCK_TYPE_BLOCK,\ TOKEN_CONCATENATE(unique_profiler_source_name_,__LINE__).id());\ profiler::beginBlock(TOKEN_CONCATENATE(unique_profiler_mark_name_,__LINE__)); /** Macro of beginning of function block with default identification \code #include "profiler/profiler.h" void foo() { PROFILER_BEGIN_FUNCTION_BLOCK; //some code... } \endcode Name of block automatically created with function name \ingroup profiler */ #define PROFILER_BEGIN_FUNCTION_BLOCK PROFILER_BEGIN_BLOCK(__func__) /** Macro of beginning of function block with custom identification \code #include "profiler/profiler.h" void foo() { PROFILER_BEGIN_FUNCTION_BLOCK_GROUPED(profiler::colors::Red); //some code... } \endcode Name of block automatically created with function name \ingroup profiler */ #define PROFILER_BEGIN_FUNCTION_BLOCK_GROUPED(block_color) PROFILER_BEGIN_BLOCK_GROUPED(__func__,block_color) /** Macro of completion of last nearest open block \code #include "profiler/profiler.h" void foo() { // some code ... int sum = 0; PROFILER_BEGIN_BLOCK("Calculating summ"); for(int i = 0; i < 10; i++){ sum += i; } PROFILER_END_BLOCK; } \endcode \ingroup profiler */ #define PROFILER_END_BLOCK profiler::endBlock(); #define PROFILER_ADD_EVENT(name) \ static const profiler::BlockSourceInfo TOKEN_CONCATENATE(unique_profiler_source_name_,__LINE__)(__FILE__, __LINE__);\ profiler::Block TOKEN_CONCATENATE(unique_profiler_mark_name_,__LINE__)(name,0,profiler::BLOCK_TYPE_EVENT,\ TOKEN_CONCATENATE(unique_profiler_source_name_,__LINE__).id());\ profiler::beginBlock(TOKEN_CONCATENATE(unique_profiler_mark_name_,__LINE__)); #define PROFILER_ADD_EVENT_GROUPED(name,block_group)\ static const profiler::BlockSourceInfo TOKEN_CONCATENATE(unique_profiler_source_name_,__LINE__)(__FILE__, __LINE__);\ profiler::Block TOKEN_CONCATENATE(unique_profiler_mark_name_,__LINE__)(name,block_group,profiler::BLOCK_TYPE_EVENT,\ TOKEN_CONCATENATE(unique_profiler_source_name_,__LINE__).id());\ profiler::beginBlock(TOKEN_CONCATENATE(unique_profiler_mark_name_,__LINE__)); /** Macro enabling profiler \ingroup profiler */ #define PROFILER_ENABLE profiler::setEnabled(true); /** Macro disabling profiler \ingroup profiler */ #define PROFILER_DISABLE profiler::setEnabled(false); #ifdef WIN32 #define PROFILER_SET_THREAD_NAME(name) profiler::setThreadName(name); #else #define PROFILER_SET_THREAD_NAME(name) thread_local static const profiler::ThreadNameSetter TOKEN_CONCATENATE(unique_profiler_thread_name_setter_,__LINE__)(name); #endif #define PROFILER_SET_MAIN_THREAD PROFILER_SET_THREAD_NAME("Main") #else #define PROFILER_ADD_MARK(name) #define PROFILER_ADD_MARK_GROUPED(name,block_group) #define PROFILER_BEGIN_BLOCK(name) #define PROFILER_BEGIN_BLOCK_GROUPED(name,block_group) #define PROFILER_BEGIN_FUNCTION_BLOCK PROFILER_BEGIN_BLOCK(__func__) #define PROFILER_BEGIN_FUNCTION_BLOCK_GROUPED(block_group) PROFILER_BEGIN_BLOCK_GROUPED(__func__,block_group) #define PROFILER_END_BLOCK profiler::endBlock(); #define PROFILER_ENABLE profiler::setEnabled(true); #define PROFILER_DISABLE profiler::setEnabled(false); #define PROFILER_ADD_EVENT(name) #define PROFILER_ADD_EVENT_GROUPED(name,block_group) #define PROFILER_SET_THREAD_NAME(name) #define PROFILER_SET_MAIN_THREAD #endif #include #include #ifdef _WIN32 #ifdef _BUILD_PROFILER #define PROFILER_API __declspec(dllexport) #else #define PROFILER_API __declspec(dllimport) #endif #else #define PROFILER_API #endif class ProfileManager; namespace profiler { typedef uint8_t color_t; //RRR-GGG-BB namespace colors{ const color_t Black = 0x00; const color_t Lightgray = 0x6E; const color_t Darkgray = 0x25; const color_t White = 0xFF; const color_t Red = 0xE0; const color_t Green = 0x1C; const color_t Blue = 0x03; const color_t Magenta = (Red | Blue); const color_t Cyan = (Green | Blue); const color_t Yellow = (Red | Green); const color_t Darkred = 0x60; const color_t Darkgreen = 0x0C; const color_t Darkblue = 0x01; const color_t Darkmagenta = (Darkred | Darkblue); const color_t Darkcyan = (Darkgreen | Darkblue); const color_t Darkyellow = (Darkred | Darkgreen); const color_t Navy = 0x02; const color_t Teal = 0x12; const color_t Maroon = 0x80; const color_t Purple = 0x82; const color_t Olive = 0x90; const color_t Grey = 0x92; const color_t Silver = 0xDB; const color_t Orange = 0xF4; const color_t Coral = 0xF6; const color_t Brick = 0xED; const color_t Clay = 0xD6; const color_t Skin = 0xFA; const color_t Palegold = 0xFE; inline int get_red(color_t color){ return (color >> 5) * 0x20; } inline int get_green(color_t color){ return ((color & 0x1C) >> 2) * 0x20; } inline int get_blue(color_t color){ return (color & 3) * 0x40; } inline int convert_to_rgb(color_t color){ return ((get_red(color) & 0xFF) << 16) | ((get_green(color) & 0xFF) << 8) | (get_blue(color) & 0xFF); } } class Block; class BlockSourceInfo; extern "C"{ void PROFILER_API beginBlock(Block& _block); void PROFILER_API endBlock(); void PROFILER_API setEnabled(bool isEnable); unsigned int PROFILER_API dumpBlocksToFile(const char* filename); void PROFILER_API setThreadName(const char* name); } typedef uint8_t block_type_t; typedef uint64_t timestamp_t; typedef uint32_t thread_id_t; typedef uint32_t source_id_t; const block_type_t BLOCK_TYPE_EVENT = 1; const block_type_t BLOCK_TYPE_BLOCK = 2; const block_type_t BLOCK_TYPE_THREAD_SIGN = 3; #define EASY_USE_OLD_FILE_FORMAT #pragma pack(push,1) class PROFILER_API BaseBlockData { protected: #ifdef EASY_USE_OLD_FILE_FORMAT block_type_t type; color_t color; timestamp_t begin; timestamp_t end; thread_id_t thread_id; #else timestamp_t begin; timestamp_t end; thread_id_t thread_id; source_id_t source_id; block_type_t type; color_t color; #endif void tick(timestamp_t& stamp); public: BaseBlockData(source_id_t _source_id, color_t _color, block_type_t _type, thread_id_t _thread_id = 0); inline block_type_t getType() const { return type; } inline color_t getColor() const { return color; } inline timestamp_t getBegin() const { return begin; } inline thread_id_t getThreadId() const { return thread_id; } #ifdef EASY_USE_OLD_FILE_FORMAT inline source_id_t getSourceId() const { return -1; } #else inline source_id_t getSourceId() const { return source_id; } #endif inline timestamp_t getEnd() const { return end; } inline bool isFinished() const { return end != 0; } inline bool isCleared() const { return end >= begin; } inline void finish(){ tick(end); } timestamp_t duration() const { return (end - begin); } inline bool startsEarlierThan(const BaseBlockData& another) const {return this->begin < another.begin;} inline bool endsEarlierThan(const BaseBlockData& another) const {return this->end < another.end;} inline bool startsLaterThan(const BaseBlockData& another) const {return !this->startsEarlierThan(another);} inline bool endsLaterThan(const BaseBlockData& another) const {return !this->endsEarlierThan(another);} }; #pragma pack(pop) class PROFILER_API Block final : public BaseBlockData { const char* m_name; public: Block(const char* _name, color_t _color, block_type_t _type, source_id_t _source_id); Block(const char* _name, thread_id_t _thread_id, color_t _color, block_type_t _type, source_id_t _source_id); ~Block(); inline const char* getName() const { return m_name; } }; class PROFILER_API SourceBlock final { const char* m_filename; int m_line; public: SourceBlock(const char* _filename, int _line); const char* file() const { return m_filename; } int line() const { return m_line; } }; class PROFILER_API SerializedBlock final : public BaseBlockData { friend ::ProfileManager; public: ///< Deprecated. For backward compatibility. inline const BaseBlockData* block() const { return this; } inline const char* data() const { return reinterpret_cast(this); } inline const char* getName() const { return data() + sizeof(BaseBlockData); } private: static SerializedBlock* create(const Block &block, uint64_t& memory_size); static void destroy(SerializedBlock* that); SerializedBlock(const profiler::Block& block, uint16_t name_length); SerializedBlock(const SerializedBlock&) = delete; SerializedBlock& operator = (const SerializedBlock&) = delete; ~SerializedBlock() = delete; }; struct PROFILER_API ThreadNameSetter final { ThreadNameSetter(const char* _name) { setThreadName(_name); } }; class PROFILER_API BlockSourceInfo final { unsigned int m_id; public: BlockSourceInfo(const char* _filename, int _linenumber); unsigned int id() const { return m_id; } }; } // END of namespace profiler. #endif