Commit 9ee6a740 by Benjamin Kosnik Committed by Benjamin Kosnik

bitset: Tweak doxygen markup.

2009-11-17  Benjamin Kosnik  <bkoz@redhat.com>

	* include/profile/bitset: Tweak doxygen markup.
	* include/profile/deque: Same.
	* include/profile/list: Same.
	* include/profile/map.h: Same.
	* include/profile/multimap.h: Same.
	* include/profile/multiset.h: Same.
	* include/profile/set.h: Same.
	* include/profile/unordered_map: Same.
	* include/profile/vector: Same.

	* include/profile/impl/profiler_container_size.h: Use namespace
	__gnu_profile instead of __cxxprof_impl.
	* include/profile/impl/profiler.h: Same.
	(_GLIBCXX_PROFILE_IMPL_REENTRANCE_GUARD): To
	_GLIBCXX_PROFILE_REENTRANCE_GUARD.
	Remove namespace __cxxprof_guard.
	(__reentrance_guard): De-templatize.
	(__reentrance_guard::__inside_cxxprof_impl): To
	__reentrance_guard::_S_get_in.

	* include/profile/impl/profiler_hash_func.h: Use namespace
	__gnu_profile instead of __cxxprof_impl.
	* include/profile/impl/profiler_hashtable_size.h: Same.
	* include/profile/impl/profiler_map_to_unordered_map.h: Same.
	* include/profile/impl/profiler_node.h: Same.
	* include/profile/impl/profiler_state.h: Same.
	* include/profile/impl/profiler_trace.h: Same.
	* include/profile/impl/profiler_vector_size.h: Same.
	* include/profile/impl/profiler_vector_to_list.h: Same.
	* doc/xml/manual/profile_mode.xml: Update.

From-SVN: r154269
parent 1ceb9e06
2009-11-17 Benjamin Kosnik <bkoz@redhat.com> 2009-11-17 Benjamin Kosnik <bkoz@redhat.com>
* include/profile/bitset: Tweak doxygen markup.
* include/profile/deque: Same.
* include/profile/list: Same.
* include/profile/map.h: Same.
* include/profile/multimap.h: Same.
* include/profile/multiset.h: Same.
* include/profile/set.h: Same.
* include/profile/unordered_map: Same.
* include/profile/vector: Same.
* include/profile/impl/profiler_container_size.h: Use namespace
__gnu_profile instead of __cxxprof_impl.
* include/profile/impl/profiler.h: Same.
(_GLIBCXX_PROFILE_IMPL_REENTRANCE_GUARD): To
_GLIBCXX_PROFILE_REENTRANCE_GUARD.
Remove namespace __cxxprof_guard.
(__reentrance_guard): De-templatize.
(__reentrance_guard::__inside_cxxprof_impl): To
__reentrance_guard::_S_get_in.
* include/profile/impl/profiler_hash_func.h: Use namespace
__gnu_profile instead of __cxxprof_impl.
* include/profile/impl/profiler_hashtable_size.h: Same.
* include/profile/impl/profiler_map_to_unordered_map.h: Same.
* include/profile/impl/profiler_node.h: Same.
* include/profile/impl/profiler_state.h: Same.
* include/profile/impl/profiler_trace.h: Same.
* include/profile/impl/profiler_vector_size.h: Same.
* include/profile/impl/profiler_vector_to_list.h: Same.
* doc/xml/manual/profile_mode.xml: Update.
2009-11-17 Benjamin Kosnik <bkoz@redhat.com>
* include/debug/bitset: Add doxygen markup. * include/debug/bitset: Add doxygen markup.
* include/debug/deque: Same. * include/debug/deque: Same.
* include/debug/list: Same. * include/debug/list: Same.
......
...@@ -640,10 +640,10 @@ it helps the user focus on the key problems and ignore the uninteresting ones. ...@@ -640,10 +640,10 @@ it helps the user focus on the key problems and ignore the uninteresting ones.
Hook names must start with <code>__profcxx_</code>. Hook names must start with <code>__profcxx_</code>.
Make sure they transform Make sure they transform
in no code with <code>-D_NO_GLBICXX_PROFILE_MAGIC</code>. in no code with <code>-D_NO_GLBICXX_PROFILE_MAGIC</code>.
Make sure all calls to any method in namespace <code>__cxxprof_impl</code> Make sure all calls to any method in namespace <code>__gnu_profile</code>
is protected against reentrance using macro is protected against reentrance using macro
<code>_GLIBCXX_PROFILE_IMPL_REENTRANCE_GUARD</code>. <code>_GLIBCXX_PROFILE_REENTRANCE_GUARD</code>.
All names of methods in namespace <code>__cxxprof_impl</code> called from All names of methods in namespace <code>__gnu_profile</code> called from
<code>profiler.h</code> must start with <code>__trace_magic_</code>. <code>profiler.h</code> must start with <code>__trace_magic_</code>.
</para> </para>
......
...@@ -35,7 +35,7 @@ namespace std ...@@ -35,7 +35,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief Bitset wrapper with performance instrumentation. */ /// Class std::bitset wrapper with performance instrumentation.
template<size_t _Nb> template<size_t _Nb>
class bitset class bitset
: public _GLIBCXX_STD_D::bitset<_Nb> : public _GLIBCXX_STD_D::bitset<_Nb>
......
...@@ -35,7 +35,7 @@ namespace std ...@@ -35,7 +35,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief Deque wrapper with performance instrumentation. */ /// Class std::deque wrapper with performance instrumentation.
template<typename _Tp, typename _Allocator = std::allocator<_Tp> > template<typename _Tp, typename _Allocator = std::allocator<_Tp> >
class deque class deque
: public _GLIBCXX_STD_D::deque<_Tp, _Allocator> : public _GLIBCXX_STD_D::deque<_Tp, _Allocator>
......
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
#include "profile/impl/profiler_node.h" #include "profile/impl/profiler_node.h"
#include "profile/impl/profiler_trace.h" #include "profile/impl/profiler_trace.h"
namespace __cxxprof_impl namespace __gnu_profile
{ {
/** @brief A container size instrumentation line in the object table. */ /** @brief A container size instrumentation line in the object table. */
...@@ -246,5 +246,5 @@ inline void __trace_container_size::__resize(const void* __obj, int __from, ...@@ -246,5 +246,5 @@ inline void __trace_container_size::__resize(const void* __obj, int __from,
__object_info->__resize(__from, __to); __object_info->__resize(__from, __to);
} }
} // namespace __cxxprof_impl } // namespace __gnu_profile
#endif /* PROFCXX_PROFILER_CONTAINER_SIZE_H__ */ #endif /* PROFCXX_PROFILER_CONTAINER_SIZE_H__ */
...@@ -50,7 +50,7 @@ ...@@ -50,7 +50,7 @@
#include "profile/impl/profiler_node.h" #include "profile/impl/profiler_node.h"
#include "profile/impl/profiler_trace.h" #include "profile/impl/profiler_trace.h"
namespace __cxxprof_impl namespace __gnu_profile
{ {
/** @brief A hash performance instrumentation line in the object table. */ /** @brief A hash performance instrumentation line in the object table. */
...@@ -188,5 +188,5 @@ inline void __trace_hash_func_destruct(const void* __obj, size_t __chain, ...@@ -188,5 +188,5 @@ inline void __trace_hash_func_destruct(const void* __obj, size_t __chain,
__tables<0>::_S_hash_func->__destruct(__obj, __chain, __accesses, __hops); __tables<0>::_S_hash_func->__destruct(__obj, __chain, __accesses, __hops);
} }
} // namespace __cxxprof_impl } // namespace __gnu_profile
#endif /* PROFCXX_PROFILER_HASH_FUNC_H__ */ #endif /* PROFCXX_PROFILER_HASH_FUNC_H__ */
...@@ -52,7 +52,7 @@ ...@@ -52,7 +52,7 @@
#include "profile/impl/profiler_state.h" #include "profile/impl/profiler_state.h"
#include "profile/impl/profiler_container_size.h" #include "profile/impl/profiler_container_size.h"
namespace __cxxprof_impl namespace __gnu_profile
{ {
/** @brief Hashtable size instrumentation trace producer. */ /** @brief Hashtable size instrumentation trace producer. */
...@@ -110,6 +110,6 @@ inline void __trace_hashtable_size_resize(const void* __obj, size_t __from, ...@@ -110,6 +110,6 @@ inline void __trace_hashtable_size_resize(const void* __obj, size_t __from,
__tables<0>::_S_hashtable_size->__resize(__obj, __from, __to); __tables<0>::_S_hashtable_size->__resize(__obj, __from, __to);
} }
} // namespace __cxxprof_impl } // namespace __gnu_profile
#endif /* PROFCXX_PROFILER_HASHTABLE_SIZE_H__ */ #endif /* PROFCXX_PROFILER_HASHTABLE_SIZE_H__ */
...@@ -50,7 +50,7 @@ ...@@ -50,7 +50,7 @@
#include "profile/impl/profiler_node.h" #include "profile/impl/profiler_node.h"
#include "profile/impl/profiler_trace.h" #include "profile/impl/profiler_trace.h"
namespace __cxxprof_impl namespace __gnu_profile
{ {
// Cost model. XXX: this must be taken from the machine model instead. // Cost model. XXX: this must be taken from the machine model instead.
...@@ -301,5 +301,5 @@ inline void __trace_map_to_unordered_map_invalidate(const void* __obj) ...@@ -301,5 +301,5 @@ inline void __trace_map_to_unordered_map_invalidate(const void* __obj)
if (__info) __info->__record_invalidate(); if (__info) __info->__record_invalidate();
} }
} // namespace __cxxprof_impl } // namespace __gnu_profile
#endif /* PROFCXX_PROFILER_MAP_TO_UNORDERED_MAP_H__ */ #endif /* PROFCXX_PROFILER_MAP_TO_UNORDERED_MAP_H__ */
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
#include <execinfo.h> #include <execinfo.h>
#endif #endif
namespace __cxxprof_impl namespace __gnu_profile
{ {
typedef const void* __object_t; typedef const void* __object_t;
typedef void* __instruction_address_t; typedef void* __instruction_address_t;
...@@ -168,5 +168,5 @@ class __stack_info_base ...@@ -168,5 +168,5 @@ class __stack_info_base
virtual const char* __get_id() const = 0; virtual const char* __get_id() const = 0;
}; };
} // namespace __cxxprof_impl } // namespace __gnu_profile
#endif /* PROFCXX_PROFILER_NODE_H__ */ #endif /* PROFCXX_PROFILER_NODE_H__ */
...@@ -43,7 +43,7 @@ ...@@ -43,7 +43,7 @@
#include <stdio.h> #include <stdio.h>
#endif #endif
namespace __cxxprof_impl namespace __gnu_profile
{ {
/** @brief Profiling mode on/off state. */ /** @brief Profiling mode on/off state. */
...@@ -103,5 +103,5 @@ inline void __turn_off() ...@@ -103,5 +103,5 @@ inline void __turn_off()
__state<0>::_S_diag_state->__turn_off(); __state<0>::_S_diag_state->__turn_off();
} }
} // end namespace __cxxprof_impl } // end namespace __gnu_profile
#endif /* PROFCXX_PROFILER_STATE_H__ */ #endif /* PROFCXX_PROFILER_STATE_H__ */
...@@ -63,7 +63,7 @@ ...@@ -63,7 +63,7 @@
#include "profile/impl/profiler_state.h" #include "profile/impl/profiler_state.h"
#include "profile/impl/profiler_node.h" #include "profile/impl/profiler_node.h"
namespace __cxxprof_impl namespace __gnu_profile
{ {
#if defined _GLIBCXX_PROFILE_THREADS && defined HAVE_TLS #if defined _GLIBCXX_PROFILE_THREADS && defined HAVE_TLS
...@@ -367,7 +367,7 @@ void __trace_base<__object_info, __stack_info>::__write(FILE* __f) ...@@ -367,7 +367,7 @@ void __trace_base<__object_info, __stack_info>::__write(FILE* __f)
if (__it->second.__is_valid()) { if (__it->second.__is_valid()) {
fprintf(__f, __id); fprintf(__f, __id);
fprintf(__f, "|"); fprintf(__f, "|");
__cxxprof_impl::__write(__f, __it->first); __gnu_profile::__write(__f, __it->first);
fprintf(__f, "|"); fprintf(__f, "|");
__it->second.__write(__f); __it->second.__write(__f);
} }
...@@ -428,7 +428,7 @@ struct __warn ...@@ -428,7 +428,7 @@ struct __warn
fprintf(__file, __info.__warning_id); fprintf(__file, __info.__warning_id);
fprintf(__file, ": improvement = %d", __log_magnitude(__info.__magnitude)); fprintf(__file, ": improvement = %d", __log_magnitude(__info.__magnitude));
fprintf(__file, ": call stack = "); fprintf(__file, ": call stack = ");
__cxxprof_impl::__write(__file, __info.__context); __gnu_profile::__write(__file, __info.__context);
fprintf(__file, ": advice = %s\n", __info.__warning_message); fprintf(__file, ": advice = %s\n", __info.__warning_message);
} }
}; };
...@@ -457,7 +457,7 @@ inline FILE* __open_output_file(const char* extension) ...@@ -457,7 +457,7 @@ inline FILE* __open_output_file(const char* extension)
* This can also be called directly by user code, including signal handlers. * This can also be called directly by user code, including signal handlers.
* It is protected against deadlocks by the reentrance guard in profiler.h. * It is protected against deadlocks by the reentrance guard in profiler.h.
* However, when called from a signal handler that triggers while within * However, when called from a signal handler that triggers while within
* __cxxprof_impl (under the guarded zone), no output will be produced. * __gnu_profile (under the guarded zone), no output will be produced.
*/ */
inline void __report(void) inline void __report(void)
{ {
...@@ -559,6 +559,6 @@ inline bool __profcxx_init(void) ...@@ -559,6 +559,6 @@ inline bool __profcxx_init(void)
return __is_on(); return __is_on();
} }
} // namespace __cxxprof_impl } // namespace __gnu_profile
#endif /* PROFCXX_PROFILER_TRACE_H__ */ #endif /* PROFCXX_PROFILER_TRACE_H__ */
...@@ -52,7 +52,7 @@ ...@@ -52,7 +52,7 @@
#include "profile/impl/profiler_state.h" #include "profile/impl/profiler_state.h"
#include "profile/impl/profiler_container_size.h" #include "profile/impl/profiler_container_size.h"
namespace __cxxprof_impl namespace __gnu_profile
{ {
/** @brief Hashtable size instrumentation trace producer. */ /** @brief Hashtable size instrumentation trace producer. */
...@@ -107,6 +107,6 @@ inline void __trace_vector_size_resize(const void* __obj, size_t __from, ...@@ -107,6 +107,6 @@ inline void __trace_vector_size_resize(const void* __obj, size_t __from,
__tables<0>::_S_vector_size->__resize(__obj, __from, __to); __tables<0>::_S_vector_size->__resize(__obj, __from, __to);
} }
} // namespace __cxxprof_impl } // namespace __gnu_profile
#endif /* PROFCXX_PROFILER_VECTOR_SIZE_H__ */ #endif /* PROFCXX_PROFILER_VECTOR_SIZE_H__ */
...@@ -50,7 +50,7 @@ ...@@ -50,7 +50,7 @@
#include "profile/impl/profiler_node.h" #include "profile/impl/profiler_node.h"
#include "profile/impl/profiler_trace.h" #include "profile/impl/profiler_trace.h"
namespace __cxxprof_impl namespace __gnu_profile
{ {
/** @brief A vector-to-list instrumentation line in the object table. */ /** @brief A vector-to-list instrumentation line in the object table. */
...@@ -314,5 +314,5 @@ inline void __trace_vector_to_list_resize(const void* __obj, ...@@ -314,5 +314,5 @@ inline void __trace_vector_to_list_resize(const void* __obj,
__tables<0>::_S_vector_to_list->__resize(__obj, __from, __to); __tables<0>::_S_vector_to_list->__resize(__obj, __from, __to);
} }
} // namespace __cxxprof_impl } // namespace __gnu_profile
#endif /* PROFCXX_PROFILER_VECTOR_TO_LIST_H__ */ #endif /* PROFCXX_PROFILER_VECTOR_TO_LIST_H__ */
...@@ -35,7 +35,7 @@ namespace std ...@@ -35,7 +35,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief List wrapper with performance instrumentation. */ /// Class std::list wrapper with performance instrumentation.
template<typename _Tp, typename _Allocator = std::allocator<_Tp> > template<typename _Tp, typename _Allocator = std::allocator<_Tp> >
class list class list
: public _GLIBCXX_STD_D::list<_Tp, _Allocator> : public _GLIBCXX_STD_D::list<_Tp, _Allocator>
......
...@@ -41,7 +41,7 @@ namespace std ...@@ -41,7 +41,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief Map wrapper with performance instrumentation. */ /// Class std::map wrapper with performance instrumentation.
template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>,
typename _Allocator = std::allocator<std::pair<const _Key, _Tp> > > typename _Allocator = std::allocator<std::pair<const _Key, _Tp> > >
class map class map
......
...@@ -35,7 +35,7 @@ namespace std ...@@ -35,7 +35,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief Multimap wrapper with performance instrumentation. */ /// Class std::multimap wrapper with performance instrumentation.
template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>,
typename _Allocator = std::allocator<std::pair<const _Key, _Tp> > > typename _Allocator = std::allocator<std::pair<const _Key, _Tp> > >
class multimap class multimap
......
...@@ -35,7 +35,7 @@ namespace std ...@@ -35,7 +35,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief Multiset wrapper with performance instrumentation. */ /// Class std::multiset wrapper with performance instrumentation.
template<typename _Key, typename _Compare = std::less<_Key>, template<typename _Key, typename _Compare = std::less<_Key>,
typename _Allocator = std::allocator<_Key> > typename _Allocator = std::allocator<_Key> >
class multiset class multiset
......
...@@ -35,7 +35,7 @@ namespace std ...@@ -35,7 +35,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief Set wrapper with performance instrumentation. */ /// Class std::set wrapper with performance instrumentation.
template<typename _Key, typename _Compare = std::less<_Key>, template<typename _Key, typename _Compare = std::less<_Key>,
typename _Allocator = std::allocator<_Key> > typename _Allocator = std::allocator<_Key> >
class set class set
......
...@@ -51,7 +51,7 @@ namespace std ...@@ -51,7 +51,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief Unordered_map wrapper with performance instrumentation. */ /// Class std::unordered_map wrapper with performance instrumentation.
template<typename _Key, typename _Tp, template<typename _Key, typename _Tp,
typename _Hash = std::hash<_Key>, typename _Hash = std::hash<_Key>,
typename _Pred = std::equal_to<_Key>, typename _Pred = std::equal_to<_Key>,
...@@ -275,12 +275,13 @@ namespace __profile ...@@ -275,12 +275,13 @@ namespace __profile
unordered_map<_Key, _Tp, _Hash, _Pred, _Alloc>& __y) unordered_map<_Key, _Tp, _Hash, _Pred, _Alloc>& __y)
{ __x.swap(__y); } { __x.swap(__y); }
#undef _GLIBCXX_BASE #undef _GLIBCXX_BASE
#undef _GLIBCXX_STD_BASE #undef _GLIBCXX_STD_BASE
#define _GLIBCXX_BASE unordered_multimap<_Key, _Tp, _Hash, _Pred, _Alloc> #define _GLIBCXX_BASE unordered_multimap<_Key, _Tp, _Hash, _Pred, _Alloc>
#define _GLIBCXX_STD_BASE _GLIBCXX_STD_PR::_GLIBCXX_BASE #define _GLIBCXX_STD_BASE _GLIBCXX_STD_PR::_GLIBCXX_BASE
/** @brief Unordered_multimap wrapper with performance instrumentation. */ /// Class std::unordered_multimap wrapper with performance instrumentation.
template<typename _Key, typename _Tp, template<typename _Key, typename _Tp,
typename _Hash = std::hash<_Key>, typename _Hash = std::hash<_Key>,
typename _Pred = std::equal_to<_Key>, typename _Pred = std::equal_to<_Key>,
...@@ -371,7 +372,8 @@ namespace __profile ...@@ -371,7 +372,8 @@ namespace __profile
~unordered_multimap() ~unordered_multimap()
{ {
__profcxx_hashtable_destruct(this, _Base::bucket_count(), _Base::size()); __profcxx_hashtable_destruct(this, _Base::bucket_count(),
_Base::size());
_M_profile_destruct(); _M_profile_destruct();
} }
...@@ -385,7 +387,8 @@ namespace __profile ...@@ -385,7 +387,8 @@ namespace __profile
void void
clear() clear()
{ {
__profcxx_hashtable_destruct(this, _Base::bucket_count(), _Base::size()); __profcxx_hashtable_destruct(this, _Base::bucket_count(),
_Base::size());
_M_profile_destruct(); _M_profile_destruct();
_Base::clear(); _Base::clear();
} }
......
...@@ -42,7 +42,7 @@ namespace std ...@@ -42,7 +42,7 @@ namespace std
{ {
namespace __profile namespace __profile
{ {
/** @brief Vector wrapper with performance instrumentation. */ /// Class std::vector wrapper with performance instrumentation.
template<typename _Tp, template<typename _Tp,
typename _Allocator = std::allocator<_Tp> > typename _Allocator = std::allocator<_Tp> >
class vector class vector
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment