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
|
/*
* Copyright (C) 2018-2025 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#pragma once
#include "shared/source/helpers/debug_helpers.h"
#include "shared/source/helpers/non_copyable_or_moveable.h"
#include <atomic>
#include <memory>
namespace NEO {
template <typename CT = int32_t>
class RefCounter {
public:
RefCounter()
: val(0) {
}
CT peek() const {
CT curr = val.load();
DEBUG_BREAK_IF(curr < 0);
return curr;
}
void inc() {
[[maybe_unused]] CT curr = ++val;
DEBUG_BREAK_IF(curr < 1);
}
void dec() {
[[maybe_unused]] CT curr = --val;
DEBUG_BREAK_IF(curr < 0);
}
CT decAndReturnCurrent() {
return --val;
}
protected:
std::atomic<CT> val;
};
template <typename DerivedClass>
class ReferenceTrackedObject;
template <typename DataType>
class unique_ptr_if_unused : // NOLINT(readability-identifier-naming)
public std::unique_ptr<DataType, void (*)(DataType *)> {
using DeleterFuncType = void (*)(DataType *);
public:
unique_ptr_if_unused()
: std::unique_ptr<DataType, DeleterFuncType>(nullptr, dontDelete) {
}
unique_ptr_if_unused(DataType *ptr, bool unused, DeleterFuncType customDeleter = nullptr)
: std::unique_ptr<DataType, DeleterFuncType>(ptr, unused ? chooseDeleter(ptr, customDeleter) : dontDelete) {
}
bool isUnused() const {
return (this->get_deleter() != dontDelete);
}
private:
static DeleterFuncType chooseDeleter(DataType *inPtr, DeleterFuncType customDeleter) {
DeleterFuncType deleter = customDeleter;
if (customDeleter == nullptr) {
deleter = getObjDeleter(inPtr);
}
if (deleter == nullptr) {
deleter = &doDelete;
}
return deleter;
}
template <typename DT = DataType>
static typename std::enable_if_t<std::is_base_of_v<ReferenceTrackedObject<DataType>, DT>, DeleterFuncType> getObjDeleter(DataType *inPtr) {
if (inPtr != nullptr) {
return inPtr->getCustomDeleter();
}
return nullptr;
}
template <typename DT = DataType>
static typename std::enable_if_t<!std::is_base_of_v<ReferenceTrackedObject<DataType>, DT>, DeleterFuncType> getObjDeleter(DataType *inPtr) {
return nullptr;
}
static void doDelete(DataType *ptr) {
delete ptr; // NOLINT(clang-analyzer-cplusplus.NewDelete)
}
static void dontDelete(DataType *ptr) {
;
}
};
// This class is needed for having both internal and external (api)
// reference counters
// Note : we need both counters because an OCL app can release an OCL object
// while this object is still needed/valid (e.g. events with callbacks),
// so we need to have a way of tracking internal usage of these object.
// At the same time, we can't use one refcount for both internal and external
// (retain/release api) usage because an OCL application can query object's
// refcount (this refcount should not be contaminated by our internal usage models)
// Note : internal refcount accumulates also api refcounts (i.e. incrementing/decrementing
// api refcount will increment/decrement internal refcount as well) - so, object
// deletion is based on single/atomic decision "if(--internalRefcount == 0)"
template <typename DerivedClass>
class ReferenceTrackedObject {
public:
using DeleterFuncType = void (*)(DerivedClass *);
virtual ~ReferenceTrackedObject();
int32_t getRefInternalCount() const {
return refInternal.peek();
}
void incRefInternal() {
refInternal.inc();
}
unique_ptr_if_unused<DerivedClass> decRefInternal() {
auto customDeleter = tryGetCustomDeleter();
auto current = refInternal.decAndReturnCurrent();
bool unused = (current == 0);
UNRECOVERABLE_IF(current < 0);
return unique_ptr_if_unused<DerivedClass>(static_cast<DerivedClass *>(this), unused, customDeleter);
}
int32_t getRefApiCount() const {
return refApi.peek();
}
void incRefApi() {
refApi.inc();
refInternal.inc();
}
unique_ptr_if_unused<DerivedClass> decRefApi() {
refApi.dec();
return decRefInternal();
}
DeleterFuncType getCustomDeleter() const {
return nullptr;
}
private:
DeleterFuncType tryGetCustomDeleter() const {
const DerivedClass *asDerivedObj = static_cast<const DerivedClass *>(this);
return asDerivedObj->getCustomDeleter();
}
RefCounter<> refInternal;
RefCounter<> refApi;
};
template <typename DerivedClass>
inline ReferenceTrackedObject<DerivedClass>::~ReferenceTrackedObject() {
DEBUG_BREAK_IF(refInternal.peek() > 1);
}
template <typename RefTrackedObj>
class DecRefInternalAtScopeEnd final : NEO::NonCopyableAndNonMovableClass {
public:
DecRefInternalAtScopeEnd(RefTrackedObj &obj) : object{obj} {
}
~DecRefInternalAtScopeEnd() {
object.decRefInternal();
}
private:
RefTrackedObj &object;
};
} // namespace NEO
|
