summaryrefslogtreecommitdiffhomepage
path: root/dev/lib/memory/tracked_ptr.hpp
blob: 0ea0e329720b1ebc43103a3c3fec0bd264968e0f (plain)
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/*
 * File: memory/tracked_ptr.hpp
 * Purpose: Custom smart pointer implementation in C++
 * Author: Amlal El Mahrouss (amlal@nekernel.org)
 * Copyright 2025, Amlal El Mahrouss, licensed under the Boost Software License.
 */

#pragma once

#include <cstddef>
#include <utility>
#include <new>
#include <atomic>

#include <sys/types.h>
#include <unistd.h>
#include <signal.h>

namespace ocl::memory
{
	template <typename T>
	class tracked_allocator;

	template <typename T>
	class tracked_mgr;

	template <typename T, typename Mgr>
	class tracked_ptr;

	template <typename T>
	class tracked_allocator
	{
	public:
		std::atomic<size_t> allocated_count_   = 0;
		std::atomic<size_t> deallocated_count_ = 0;

	public:
		explicit tracked_allocator() = default;
		virtual ~tracked_allocator() = default;

		tracked_allocator& operator=(const tracked_allocator&) = default;
		tracked_allocator(const tracked_allocator&)			   = default;

	public:
		template <typename... U>
		void retain(T*& ptr, U&&... args)
		{
			ptr = new T(std::forward<U>(args)...);

			if (ptr)
			{
				++allocated_count_;
				return;
			}

			throw std::bad_alloc();
		}

		template <typename... U>
		void must_retain(T*& ptr, U&&... args) noexcept
		{
			this->retain(ptr, args...);
		}

		void dispose(T*& ptr) noexcept
		{
			if (ptr)
			{
				if (allocated_count_)
					--allocated_count_;

				++deallocated_count_;

				delete ptr;
				ptr = nullptr;
			}
		}
	};

	template <typename T>
	class tracked_mgr
	{
	private:
		tracked_allocator<T> allocator_;

	public:
		explicit tracked_mgr() = default;
		virtual ~tracked_mgr() = default;

		tracked_mgr& operator=(const tracked_mgr&) = default;
		tracked_mgr(const tracked_mgr&)			   = default;

	public:
		const tracked_allocator<T>& allocator() noexcept
		{
			return allocator_;
		}

		template <typename... U>
		T* retain(U&&... args)
		{
			T* ptr = nullptr;
			allocator_.retain(ptr, std::forward<U>(args)...);

			return ptr;
		}

		template <typename... U>
		T* must_retain(U&&... args) noexcept
		{
			return this->retain(std::forward<U>(args)...);
		}

		void dispose(T*& ptr) noexcept
		{
			allocator_.dispose(ptr);
		}
	};

	template <typename T, typename Mgr = tracked_mgr<T>>
	class tracked_ptr
	{
	public:
		static Mgr& manager() noexcept
		{
			static Mgr mgr;
			return mgr;
		}

	public:
		template <typename... U>
		tracked_ptr(U&&... args)
			: ptr_(nullptr)
		{
			ptr_ = tracked_ptr::manager().retain(std::forward<U>(args)...);
		}

		virtual ~tracked_ptr() noexcept
		{
			this->reset();
		}

		tracked_ptr(const tracked_ptr&)			   = delete;
		tracked_ptr& operator=(const tracked_ptr&) = delete;

	public:
		void reset()
		{
			if (ptr_)
			{
				tracked_ptr::manager().dispose(ptr_);
			}
		}

		T* get() const
		{
			return ptr_;
		}

		T* data()
		{
			return ptr_;
		}

		T& operator*() const
		{
			return *ptr_;
		}

		T* operator->() const
		{
			return ptr_;
		}

		explicit operator bool() const
		{
			return ptr_ != nullptr;
		}

		void swap(tracked_ptr& other)
		{
			std::swap(ptr_, other.ptr_);
		}

	public:
		tracked_ptr(tracked_ptr&& other) noexcept
			: ptr_(other.ptr_)
		{
			other.ptr_ = nullptr;
		}

		tracked_ptr& operator=(tracked_ptr&& other) noexcept
		{
			if (this != &other)
			{
				this->reset();
				ptr_	   = other.ptr_;
				other.ptr_ = nullptr;
			}

			return *this;
		}

	private:
		T* ptr_{nullptr};
	};

	template <typename T>
	inline auto make_tracked() -> tracked_ptr<T>
	{
		return tracked_ptr<T>();
	}

	template <typename U, typename... T>
	inline auto make_tracked(T&&... arg) -> tracked_ptr<U>
	{
		return tracked_ptr<U>(std::forward<T>(arg)...);
	}

	template <typename T>
	inline void swap(tracked_ptr<T>& a, tracked_ptr<T>& b)
	{
		a.swap(b);
	}

	/// @brief a Must Pass function is a standard way to verify a container' validity, inspired from NeKernel/VMKernel.
	template <typename T, typename error_handler>
	inline void must_pass(tracked_ptr<T>& ptr, error_handler handler)
	{
		if (ptr.manager().allocator().allocated_count_ < ptr.manager().allocator().deallocated_count_)
		{
			handler.template error<true>("Invalid TrackedPtr detected: Deallocated count exceeds allocated count.");
		}
	}
} // namespace ocl::memory