File: SimObjectMemPool.h

package info (click to toggle)
spring 104.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 47,512 kB
  • sloc: cpp: 391,093; ansic: 79,943; python: 12,356; java: 12,201; awk: 5,889; sh: 1,826; xml: 655; makefile: 486; perl: 405; php: 211; objc: 194; sed: 2
file content (205 lines) | stat: -rw-r--r-- 5,531 bytes parent folder | download
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
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

#ifndef SIMOBJECT_MEMPOOL_H
#define SIMOBJECT_MEMPOOL_H

#include <cassert>
#include <cstring> // memset
#include <array>
#include <deque>
#include <vector>

#include "System/UnorderedMap.hpp"
#include "System/ContainerUtil.h"
#include "System/SafeUtil.h"

template<size_t S> struct DynMemPool {
public:
	template<typename T, typename... A> T* alloc(A&&... a) {
		static_assert(sizeof(T) <= page_size(), "");
		// disabled, recursion is allowed
		// assert(!xtorCall());

		ctor_call_depth += 1;

		T* p = nullptr;
		uint8_t* m = nullptr;

		size_t i = 0;

		if (indcs.empty()) {
			pages.emplace_back();

			i = pages.size() - 1;
			m = pages[curr_page_index = i].data();
			p = new (m) T(std::forward<A>(a)...);
		} else {
			// must pop before ctor runs; objects can be created recursively
			i = spring::VectorBackPop(indcs);

			m = pages[curr_page_index = i].data();
			p = new (m) T(std::forward<A>(a)...);
		}

		table.emplace(p, i);

		ctor_call_depth -= 1;
		return p;
	}

	template<typename T> void free(T*& p) {
		assert(mapped(p));
		// assert(!xtorCall());

		dtor_call_depth += 1;

		const auto iter = table.find(p);
		const auto pair = std::pair<void*, size_t>{iter->first, iter->second};

		spring::SafeDestruct(p);
		std::memset(pages[pair.second].data(), 0, page_size());

		// must push after dtor runs, since that can trigger *another* ctor call
		// by proxy (~CUnit -> ~CObject -> DependentDied -> CommandAI::FinishCmd
		// -> CBuilderCAI::ExecBuildCmd -> UnitLoader::LoadUnit -> CUnit e.g.)
		indcs.push_back(pair.second);
		table.erase(pair.first);

		dtor_call_depth -= 1;
	}


	static constexpr size_t page_size() { return S; }

	size_t alloc_size() const { return (pages.size() * page_size()); } // size of total number of pages added over the pool's lifetime
	size_t freed_size() const { return (indcs.size() * page_size()); } // size of number of pages that were freed and are awaiting reuse

	bool mapped(void* p) const { return (table.find(p) != table.end()); }
	bool alloced(void* p) const { return ((curr_page_index < pages.size()) && (&pages[curr_page_index][0] == p)); }

	bool ctorCall() const { return (ctor_call_depth > 0); }
	bool dtorCall() const { return (dtor_call_depth > 0); }
	bool xtorCall() const { return (ctorCall() || dtorCall()); }

	void clear() {
		pages.clear();
		indcs.clear();
		table.clear();

		ctor_call_depth = 0;
		dtor_call_depth = 0;
		curr_page_index = 0;
	}
	void reserve(size_t n) {
		indcs.reserve(n);
		table.reserve(n);
	}

private:
	std::deque<std::array<uint8_t,S>> pages;
	std::vector<size_t> indcs;

	// <pointer, page index> (non-intrusive)
	spring::unsynced_map<void*, size_t> table;

	size_t ctor_call_depth = 0;
	size_t dtor_call_depth = 0;
	size_t curr_page_index = 0;
};



// fixed-size version
template<size_t N, size_t S> struct StaticMemPool {
public:
	StaticMemPool() { clear(); }

	template<typename T, typename... A> T* alloc(A&&... a) {
		static_assert(num_pages() != 0, "");
		static_assert(sizeof(T) <= page_size(), "");

		T* p = nullptr;
		uint8_t* m = nullptr;

		size_t i = 0;

		assert(can_alloc());
		ctor_call_depth += 1;

		if (free_page_count == 0) {
			i = used_page_count++;
			m = pages[curr_page_index = i].data();
			p = new (m) T(std::forward<A>(a)...);
		} else {
			i = indcs[--free_page_count];
			m = pages[curr_page_index = i].data();
			p = new (m) T(std::forward<A>(a)...);
		}

		ctor_call_depth -= 1;
		return p;
	}

	template<typename T> void free(T*& t) {
		uint8_t* m = reinterpret_cast<uint8_t*>(t);

		assert(can_free());
		assert(mapped(t));

		dtor_call_depth += 1;

		spring::SafeDestruct(t);
		std::memset(m, 0, page_size());

		// mark page as free
		indcs[free_page_count++] = base_offset(m) / page_size();

		dtor_call_depth -= 1;
	}


	static constexpr size_t num_pages() { return N; }
	static constexpr size_t page_size() { return S; }

	size_t alloc_size() const { return (used_page_count * page_size()); } // size of total number of pages added over the pool's lifetime
	size_t freed_size() const { return (free_page_count * page_size()); } // size of number of pages that were freed and are awaiting reuse
	size_t total_size() const { return (num_pages() * page_size()); }
	size_t base_offset(const void* p) const { return (reinterpret_cast<const uint8_t*>(p) - reinterpret_cast<const uint8_t*>(&pages[0][0])); }

	bool mapped(const void* p) const { return (((base_offset(p) / page_size()) < total_size()) && ((base_offset(p) % page_size()) == 0)); }
	bool alloced(const void* p) const { return (&pages[curr_page_index][0] == p); }

	bool can_alloc() const { return (used_page_count < num_pages() || free_page_count > 0); }
	bool can_free() const { return (free_page_count < num_pages()); }

	bool ctorCall() const { return (ctor_call_depth > 0); }
	bool dtorCall() const { return (dtor_call_depth > 0); }
	bool xtorCall() const { return (ctorCall() || dtorCall()); }

	void reserve(size_t) {} // no-op
	void clear() {
		std::memset(pages.data(), 0, total_size());
		std::memset(indcs.data(), 0, num_pages());

		used_page_count = 0;
		free_page_count = 0;
		curr_page_index = 0;

		ctor_call_depth = 0;
		dtor_call_depth = 0;
	}

private:
	std::array<std::array<uint8_t, S>, N> pages;
	std::array<size_t, N> indcs;

	size_t used_page_count = 0;
	size_t free_page_count = 0; // indcs[fpc-1] is the last recycled page
	size_t curr_page_index = 0;

	size_t ctor_call_depth = 0;
	size_t dtor_call_depth = 0;
};

#endif