2 The software in this package is distributed under the GNU General
3 Public License version 2 (with a special exception described below).
5 A copy of GNU General Public License (GPL) is included in this distribution,
6 in the file COPYING.GPL.
8 As a special exception, if other files instantiate templates or use macros
9 or inline functions from this file, or you compile this file and link it
10 with other works to produce a work based on this file, this file
11 does not by itself cause the resulting work to be covered
12 by the GNU General Public License.
14 However the source code for this file must still be made available
15 in accordance with section (3) of the GNU General Public License.
17 This exception does not invalidate any other reasons why a work based
18 on this file might be covered by the GNU General Public License.
21 * @brief implementation of tracing functionality.
23 * @copyright © Copyright 2008,2011 by Intra2net AG
25 * Every thread gets its' own ScopeTracker stack via TLS (thread local storage)
29 #include "tracefunc.hpp"
34 #include <boost/thread/tss.hpp>
36 #include <stringfunc.hxx>
43 using Logger::GlobalLogger;
45 class PerThreadContainer
48 typedef std::vector< ScopeTracker* > ScopeTrackerList;
50 /// List of currently active scope trackers
51 ScopeTrackerList scope_tracker_list;
53 /// Precomputed indent levels
54 std::vector< std::string > indents;
60 /// Internal TLS (thread local storage) data container
61 boost::thread_specific_ptr<PerThreadContainer> thread_container;
64 * Helper function to retrieve TLS pointer.
65 * Initializes the pointer if called for the first time.
66 * @return Pointer to the per thread container
68 static PerThreadContainer *TLS_get_container()
70 // First call? Construct options container
71 if (thread_container.get() == NULL)
72 thread_container.reset(new PerThreadContainer());
74 PerThreadContainer *per_thread = thread_container.get();
80 * @brief ensures indent level string to exist up to the desired level.
81 * @param level the desired indent level.
83 static void ensure_indent_level(PerThreadContainer *per_thread, unsigned int level)
85 // First initialization?
86 if (per_thread->indents.empty())
88 per_thread->indents.reserve(10);
92 per_thread->indents.push_back("");
95 while (per_thread->indents.size() <= level)
97 per_thread->indents.push_back( per_thread->indents.back() + " " );
99 } // eo ensure_indent_level(int)
101 } // eo namespace <anonymous>
105 ** implementation of ScopeTracker
109 * @brief constructor. initializes object with a source location and emits a ENTER message.
110 * @param loc the source location.
112 * the message is indented according to the current depth of nested ScopeTracker instances.
114 ScopeTracker::ScopeTracker(
115 const SourceLocation& loc)
119 , PerThread(TLS_get_container())
121 if (!PerThread->scope_tracker_list.empty())
123 ScopeTracker* last_tracker= PerThread->scope_tracker_list.back();
126 if (last_tracker->Location
127 && last_tracker->Location.File == Location.File
128 && last_tracker->Location.FunctionName == Location.FunctionName)
130 FuncDepth= last_tracker->FuncDepth+1;
133 Depth= last_tracker->Depth + 1;
135 ensure_indent_level(PerThread, Depth);
136 PerThread->scope_tracker_list.push_back(this);
139 if (Logger::has_log_level(Logger::LogLevel::Debug))
141 GlobalLogger.debug() << PerThread->indents[Depth] << "ENTER " << get_tag();
143 } // eo ScopeTrcaker::ScopeTracker(const SourceLocation&)
147 * @brief create Tag if empty; return reference to it
149 * Moved this from constructor into own function to avoid creating Tag if it is
150 * not required (i.e. log level is not DEBUG) but still create it only once and
151 * ensure it is available if log level changes inside tracked function
153 std::string& ScopeTracker::get_tag()
157 if (Location.FunctionName.empty())
159 Tag = "<unknown> (global scope?)";
163 std::ostringstream ostr;
164 ostr << shorten_stl_types(Location.FunctionName);
167 ostr << "#" << FuncDepth+1;
177 * @brief destructor. emits a LEAVE message.
181 ScopeTracker::~ScopeTracker()
184 if (Logger::has_log_level(Logger::LogLevel::Debug))
186 GlobalLogger.debug() << PerThread->indents[Depth] << "LEAVE " << get_tag();
188 if (PerThread->scope_tracker_list.empty())
192 if (PerThread->scope_tracker_list.back() == this)
194 PerThread->scope_tracker_list.pop_back();
198 // oh hell, this should never be the case!
200 GlobalLogger.error() << "inconsistency detected in scope tracker";
202 } // eo ScopeTracker::~ScopeTracker()
207 } // eo namespace Tracer
208 } // eo namespace I2n