Line data Source code
1 :
2 : /* Copyright (c) 2005-2014, Stefan Eilemann <eile@equalizergraphics.com>
3 : *
4 : * This library is free software; you can redistribute it and/or modify it under
5 : * the terms of the GNU Lesser General Public License version 2.1 as published
6 : * by the Free Software Foundation.
7 : *
8 : * This library is distributed in the hope that it will be useful, but WITHOUT
9 : * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10 : * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
11 : * details.
12 : *
13 : * You should have received a copy of the GNU Lesser General Public License
14 : * along with this library; if not, write to the Free Software Foundation, Inc.,
15 : * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 : */
17 :
18 : #ifndef LUNCHBOX_REFERENCED_H
19 : #define LUNCHBOX_REFERENCED_H
20 :
21 : #include <lunchbox/api.h> // for LUNCHBOX_API
22 : #include <lunchbox/atomic.h> // member
23 : #include <lunchbox/debug.h> // for LBERROR
24 :
25 : //#define LUNCHBOX_REFERENCED_DEBUG
26 : #ifdef LUNCHBOX_REFERENCED_DEBUG
27 : #include <lunchbox/clock.h>
28 : #include <lunchbox/hash.h>
29 : #include <lunchbox/lockable.h>
30 : #include <lunchbox/scopedMutex.h>
31 : #include <lunchbox/spinLock.h>
32 : #endif
33 :
34 : namespace lunchbox
35 : {
36 : /**
37 : * Base class for referenced objects.
38 : *
39 : * Implements reference-counted objects which destroy themselves once they are
40 : * no longer referenced. Uses an Atomic variable to keep the reference count
41 : * access thread-safe and efficient.
42 : *
43 : * @sa RefPtr
44 : */
45 : class Referenced
46 : {
47 : public:
48 : /** Increase the reference count. @version 1.0 .*/
49 14556049 : void ref(const void* holder LB_UNUSED = 0) const
50 : {
51 : #ifndef NDEBUG
52 14556049 : LBASSERT(!_hasBeenDeleted);
53 : #endif
54 13698027 : ++_refCount;
55 :
56 : #ifdef LUNCHBOX_REFERENCED_DEBUG
57 : if (holder)
58 : {
59 : std::stringstream cs;
60 : cs << "Thread " << Log::instance().getThreadName() << " @ "
61 : << Log::instance().getClock().getTime64() << " rc " << _refCount
62 : << " from " << backtrace;
63 : ScopedFastWrite mutex(_holders);
64 : HolderHash::iterator i = _holders->find(holder);
65 : LBASSERTINFO(i == _holders->end(), i->second);
66 : _holders.data[holder] = cs.str();
67 : }
68 : #endif
69 15634751 : }
70 :
71 : /**
72 : * Decrease the reference count.
73 : *
74 : * The object is deleted when the reference count reaches 0.
75 : * @version 1.0
76 : * @return true if the reference count went to 0, false otherwise.
77 : */
78 14252468 : bool unref(const void* holder LB_UNUSED = 0) const
79 : {
80 : #ifndef NDEBUG
81 14252468 : LBASSERT(!_hasBeenDeleted);
82 : #endif
83 14486531 : LBASSERT(_refCount > 0);
84 16960844 : const bool last = (--_refCount == 0);
85 :
86 : #ifdef LUNCHBOX_REFERENCED_DEBUG
87 : if (holder)
88 : {
89 : ScopedFastWrite mutex(_holders);
90 : HolderHash::iterator i = _holders->find(holder);
91 : LBASSERT(i != _holders->end());
92 : _holders->erase(i);
93 : LBASSERT(_holders->find(holder) == _holders->end());
94 : }
95 : #endif
96 :
97 17364990 : if (last)
98 2000009 : const_cast<Referenced*>(this)->notifyFree();
99 18370662 : return last;
100 : }
101 :
102 : /** @return the current reference count. @version 1.0 */
103 4 : int32_t getRefCount() const { return _refCount; }
104 : /** @internal print holders of this if debugging is enabled. */
105 : #ifdef LUNCHBOX_REFERENCED_DEBUG
106 : void printHolders(std::ostream& os) const
107 : {
108 : os << disableFlush << disableHeader << std::endl;
109 : {
110 : ScopedFastRead mutex(_holders);
111 : for (HolderHash::const_iterator i = _holders->begin();
112 : i != _holders->end(); ++i)
113 : {
114 : os << "Holder " << i->first << ": " << i->second << std::endl;
115 : }
116 : }
117 : os << enableHeader << enableFlush;
118 : }
119 : #else
120 : void printHolders(std::ostream&) const {}
121 : #endif
122 :
123 : protected:
124 : /** Construct a new reference-counted object. @version 1.0 */
125 : LUNCHBOX_API Referenced();
126 :
127 : /** Construct a new copy of a reference-counted object. @version 1.0 */
128 : Referenced(const Referenced&)
129 : : _refCount(0)
130 : , _hasBeenDeleted(false)
131 : #ifdef LUNCHBOX_REFERENCED_DEBUG
132 : , _holders()
133 : #endif
134 : {
135 : }
136 :
137 : /** Destruct a reference-counted object. @version 1.0 */
138 : LUNCHBOX_API virtual ~Referenced();
139 :
140 : /** Assign another object to this object. @version 1.1.3 */
141 : // cppcheck-suppress operatorEqVarError
142 : Referenced& operator=(const Referenced& /*rhs*/) { return *this; }
143 : LUNCHBOX_API virtual void notifyFree();
144 :
145 : private:
146 : mutable a_int32_t _refCount;
147 : bool _hasBeenDeleted;
148 :
149 : #ifdef LUNCHBOX_REFERENCED_DEBUG
150 : typedef PtrHash<const void*, std::string> HolderHash;
151 : mutable Lockable<HolderHash, SpinLock> _holders;
152 : #endif
153 : };
154 : }
155 :
156 : namespace boost
157 : {
158 : /** Allow creation of boost::intrusive_ptr from RefPtr or Referenced. */
159 5879679 : inline void intrusive_ptr_add_ref(lunchbox::Referenced* referenced)
160 : {
161 5879679 : referenced->ref();
162 7106352 : }
163 :
164 : /** Allow creation of boost::intrusive_ptr from RefPtr or Referenced. */
165 6247399 : inline void intrusive_ptr_release(lunchbox::Referenced* referenced)
166 : {
167 6247399 : referenced->unref();
168 8248757 : }
169 : }
170 :
171 : #endif // LUNCHBOX_REFERENCED_H
|
