Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 : #ifndef INCLUDED_OSL_DIAGNOSE_HXX
20 : #define INCLUDED_OSL_DIAGNOSE_HXX
21 :
22 : /// @cond INTERNAL
23 :
24 : #include <sal/config.h>
25 :
26 : #include <functional>
27 : #include <typeinfo>
28 :
29 : #include <boost/unordered_set.hpp>
30 : #include <osl/diagnose.h>
31 : #include <osl/interlck.h>
32 : #include <osl/mutex.hxx>
33 : #include <rtl/instance.hxx>
34 : #include <sal/log.hxx>
35 : #include <sal/saldllapi.h>
36 : #include <sal/types.h>
37 :
38 : namespace osl {
39 : namespace detail {
40 :
41 : struct ObjectRegistryData;
42 :
43 : } // namespace detail
44 : } // namespace osl
45 :
46 : extern "C" {
47 :
48 : SAL_DLLPUBLIC bool SAL_CALL osl_detail_ObjectRegistry_storeAddresses(
49 : char const* pName )
50 : SAL_THROW_EXTERN_C();
51 :
52 : SAL_DLLPUBLIC bool SAL_CALL osl_detail_ObjectRegistry_checkObjectCount(
53 : ::osl::detail::ObjectRegistryData const& rData, ::std::size_t nExpected )
54 : SAL_THROW_EXTERN_C();
55 :
56 : SAL_DLLPUBLIC void SAL_CALL osl_detail_ObjectRegistry_registerObject(
57 : ::osl::detail::ObjectRegistryData & rData, void const* pObj )
58 : SAL_THROW_EXTERN_C();
59 :
60 : SAL_DLLPUBLIC void SAL_CALL osl_detail_ObjectRegistry_revokeObject(
61 : ::osl::detail::ObjectRegistryData & rData, void const* pObj )
62 : SAL_THROW_EXTERN_C();
63 :
64 : // These functions presumably should not be extern "C", but changing
65 : // that would break binary compatibility.
66 : #ifdef __clang__
67 : #pragma clang diagnostic push
68 : // Guard against slightly older clang versions that don't have
69 : // -Wreturn-type-c-linkage...
70 : #pragma clang diagnostic ignored "-Wunknown-pragmas"
71 : #pragma clang diagnostic ignored "-Wreturn-type-c-linkage"
72 : #endif
73 :
74 : SAL_DLLPUBLIC ::osl::Mutex & SAL_CALL osl_detail_ObjectRegistry_getMutex()
75 : SAL_THROW_EXTERN_C();
76 :
77 : #ifdef __clang__
78 : #pragma clang diagnostic pop
79 : #endif
80 :
81 : } // extern "C"
82 :
83 : namespace osl {
84 :
85 : namespace detail {
86 :
87 : struct VoidPtrHash : ::std::unary_function<void const*, ::std::size_t> {
88 0 : ::std::size_t operator()( void const* p ) const {
89 : ::std::size_t const d = static_cast< ::std::size_t >(
90 0 : reinterpret_cast< ::std::ptrdiff_t >(p) );
91 0 : return d + (d >> 3);
92 : }
93 : };
94 :
95 : typedef ::boost::unordered_set<void const*, VoidPtrHash, ::std::equal_to<void const*> > VoidPointerSet;
96 :
97 : struct ObjectRegistryData {
98 : ObjectRegistryData( ::std::type_info const& rTypeInfo )
99 : : m_pName(rTypeInfo.name()), m_nCount(0), m_addresses(),
100 : m_bStoreAddresses(osl_detail_ObjectRegistry_storeAddresses(m_pName)){}
101 :
102 : char const* const m_pName;
103 : oslInterlockedCount m_nCount;
104 : VoidPointerSet m_addresses;
105 : bool const m_bStoreAddresses;
106 : };
107 :
108 : template <typename T>
109 : class ObjectRegistry
110 : {
111 : public:
112 : ObjectRegistry() : m_data( typeid(T) ) {}
113 : ~ObjectRegistry() { checkObjectCount(0); }
114 :
115 : bool checkObjectCount( ::std::size_t nExpected ) const {
116 : bool const bRet = osl_detail_ObjectRegistry_checkObjectCount(
117 : m_data, nExpected );
118 : if (!bRet && m_data.m_bStoreAddresses) {
119 : MutexGuard const guard( osl_detail_ObjectRegistry_getMutex() );
120 : // following loop is for debugging purposes, iterating over map:
121 : VoidPointerSet::const_iterator iPos(m_data.m_addresses.begin());
122 : VoidPointerSet::const_iterator const iEnd(m_data.m_addresses.end());
123 : for ( ; iPos != iEnd; ++iPos ) {
124 : SAL_WARN_IF( *iPos == 0, "sal.debug", "null pointer" );
125 : }
126 : }
127 : return bRet;
128 : }
129 :
130 : void registerObject( void const* pObj ) {
131 : osl_detail_ObjectRegistry_registerObject(m_data, pObj);
132 : }
133 :
134 : void revokeObject( void const* pObj ) {
135 : osl_detail_ObjectRegistry_revokeObject(m_data, pObj);
136 : }
137 :
138 : private:
139 : // not impl:
140 : ObjectRegistry( ObjectRegistry const& );
141 : ObjectRegistry const& operator=( ObjectRegistry const& );
142 :
143 : ObjectRegistryData m_data;
144 : };
145 :
146 : } // namespace detail
147 :
148 : /** Helper class which indicates leaking object(s) of a particular class in
149 : non-pro builds; use e.g.
150 :
151 : <pre>
152 : class MyClass : private osl::DebugBase<MyClass> {...};
153 : </pre>
154 :
155 : Using the environment variable
156 :
157 : OSL_DEBUGBASE_STORE_ADDRESSES=MyClass;YourClass;...
158 :
159 : you can specify a ';'-separated list of strings matching to class names
160 : (or "all" for all classes), for which DebugBase stores addresses to created
161 : objects instead of just counting them. This enables you to iterate over
162 : leaking objects in your debugger.
163 :
164 : @tparam InheritingClassT binds the template instance to that class
165 : @attention Use at own risk.
166 : For now this is just public (yet unpublished) API and may change
167 : in the future!
168 : */
169 : template <typename InheritingClassT>
170 108042 : class DebugBase
171 : {
172 : public:
173 : #if OSL_DEBUG_LEVEL <= 0
174 : static bool checkObjectCount( ::std::size_t = 0 ) { return true; }
175 : #else // OSL_DEBUG_LEVEL > 0
176 : /** @return whether the expected number of objects is alive,
177 : else this function SAL_WARNs
178 : */
179 : static bool checkObjectCount( ::std::size_t nExpected = 0 ) {
180 : return StaticObjectRegistry::get().checkObjectCount(nExpected);
181 : }
182 :
183 : protected:
184 : DebugBase() {
185 : StaticObjectRegistry::get().registerObject( this );
186 : }
187 : ~DebugBase() {
188 : StaticObjectRegistry::get().revokeObject( this );
189 : }
190 :
191 : private:
192 : struct StaticObjectRegistry
193 : : ::rtl::Static<detail::ObjectRegistry<InheritingClassT>,
194 : StaticObjectRegistry> {};
195 : #endif
196 : };
197 :
198 : } // namespace osl
199 :
200 : /// @endcond
201 :
202 : #endif // ! defined( INCLUDED_OSL_DIAGNOSE_HXX)
203 :
204 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
