blob: b683615b83b9cb31ce6fdf87e904efe9df33b0cd (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
#pragma once
#include <library/cpp/yt/misc/port.h>
#include <library/cpp/yt/assert/assert.h>
#include <library/cpp/ytalloc/api/ytalloc.h>
#include <atomic>
namespace NYT {
////////////////////////////////////////////////////////////////////////////////
//! A technical base class for ref-counted objects and promise states.
class TRefCountedBase
{
public:
TRefCountedBase() = default;
// Make destructor protected
virtual ~TRefCountedBase() noexcept = default;
virtual void DestroyRefCounted() = 0;
private:
TRefCountedBase(const TRefCountedBase&) = delete;
TRefCountedBase(TRefCountedBase&&) = delete;
TRefCountedBase& operator=(const TRefCountedBase&) = delete;
TRefCountedBase& operator=(TRefCountedBase&&) = delete;
};
////////////////////////////////////////////////////////////////////////////////
template <class T, class = void>
struct TFreeMemory
{
static void Do(void* ptr)
{
NYTAlloc::FreeNonNull(ptr);
}
};
template <class T>
struct TFreeMemory<T, std::void_t<typename T::TAllocator>>
{
static void Do(void* ptr)
{
using TAllocator = typename T::TAllocator;
TAllocator::Free(ptr);
}
};
////////////////////////////////////////////////////////////////////////////////
class TRefCounter
{
public:
//! Returns current number of strong references to the object.
/*!
* Note that you should never ever use this method in production code.
* This method is mainly for debugging purposes.
*/
int GetRefCount() const noexcept;
//! Increments the strong reference counter.
void Ref() const noexcept;
//! Increments the strong reference counter if it is not null.
bool TryRef() const noexcept;
//! Decrements the strong reference counter.
bool Unref() const;
//! Returns current number of weak references to the object.
int GetWeakRefCount() const noexcept;
//! Increments the weak reference counter.
void WeakRef() const noexcept;
//! Decrements the weak reference counter.
bool WeakUnref() const;
private:
mutable std::atomic<int> StrongCount_ = 1;
mutable std::atomic<int> WeakCount_ = 1;
};
////////////////////////////////////////////////////////////////////////////////
template <class T>
const TRefCounter* GetRefCounter(const T* obj);
template <class T>
void DestroyRefCounted(const T* obj);
template <class T>
void DeallocateRefCounted(const T* obj);
////////////////////////////////////////////////////////////////////////////////
// API
template <class T>
void Ref(T* obj);
template <class T>
void Unref(T* obj);
////////////////////////////////////////////////////////////////////////////////
struct TRefCounted
: public TRefCountedBase
, public TRefCounter
{
void Unref() const;
void WeakUnref() const;
template <class T>
static void DestroyRefCountedImpl(T* ptr);
};
////////////////////////////////////////////////////////////////////////////////
// Forward declaration.
template <class T>
class TIntrusivePtr;
using TRefCountedPtr = TIntrusivePtr<TRefCounted>;
// A bunch of helpful macros that enable working with intrusive pointers to incomplete types.
/*
* Typically when you have a forward-declared type |T| and an instance
* of |TIntrusivePtr<T>| you need the complete definition of |T| to work with
* the pointer even if you're not actually using the members of |T|.
* E.g. the dtor of |TIntrusivePtr<T>|, should you ever need it, must be able
* to unref an instance of |T| and eventually destroy it.
* This may force #inclusion of way more headers than really seems necessary.
*
* |DECLARE_REFCOUNTED_STRUCT|, |DECLARE_REFCOUNTED_CLASS|, and |DEFINE_REFCOUNTED_TYPE|
* alleviate this issue by forcing TIntrusivePtr to work with the free-standing overloads
* of |Ref| and |Unref| instead of their template version.
* These overloads are declared together with the forward declaration of |T| and
* are subsequently defined afterwards.
*/
#define DECLARE_REFCOUNTED_TYPE(type) \
using type ## Ptr = ::NYT::TIntrusivePtr<type>; \
\
[[maybe_unused]] ATTRIBUTE_USED const ::NYT::TRefCounter* GetRefCounter(const type* obj); \
[[maybe_unused]] ATTRIBUTE_USED void DestroyRefCounted(const type* obj); \
[[maybe_unused]] ATTRIBUTE_USED void DeallocateRefCounted(const type* obj);
//! Forward-declares a class type, defines an intrusive pointer for it, and finally
//! declares Ref/Unref overloads. Use this macro in |public.h|-like files.
#define DECLARE_REFCOUNTED_CLASS(type) \
class type; \
DECLARE_REFCOUNTED_TYPE(type)
//! Forward-declares a struct type, defines an intrusive pointer for it, and finally
//! declares Ref/Unref overloads. Use this macro in |public.h|-like files.
#define DECLARE_REFCOUNTED_STRUCT(type) \
struct type; \
DECLARE_REFCOUNTED_TYPE(type)
//! Provides implementations for Ref/Unref overloads. Use this macro right
//! after the type's full definition.
#define DEFINE_REFCOUNTED_TYPE(type) \
[[maybe_unused]] ATTRIBUTE_USED Y_FORCE_INLINE const ::NYT::TRefCounter* GetRefCounter(const type* obj) \
{ \
return ::NYT::TRefCountedHelper<type>::GetRefCounter(obj); \
} \
[[maybe_unused]] ATTRIBUTE_USED Y_FORCE_INLINE void DestroyRefCounted(const type* obj) \
{ \
::NYT::TRefCountedHelper<type>::Destroy(obj); \
} \
[[maybe_unused]] ATTRIBUTE_USED Y_FORCE_INLINE void DeallocateRefCounted(const type* obj) \
{ \
::NYT::TRefCountedHelper<type>::Deallocate(obj); \
}
////////////////////////////////////////////////////////////////////////////////
} // namespace NYT
#define REF_COUNTED_INL_H_
#include "ref_counted-inl.h"
#undef REF_COUNTED_INL_H_
|
