authorgravatar for sachabarsayuracko@gmail.comsquidy239 <sachabarsayuracko@gmail.com> 2026-05-01 05:27:45+02:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2026-05-01 05:27:45+02:00
log1e9bae83f188c330975474dfe3346ccb11c7bab4
treeb175f11ba07c756d1523703eb855593988751fb5
parentf7a607ef68c96cb6c5b68cbf762e621aaed95caf

remove deprecated managed MemoryPool versions (#31483)

`MemoryPoolOptions` becomes `memory_pool.Options` `Managed`, `AlignedManaged`, and `ExtraManaged` removed progresses #31220 Reviewed-on: https://codeberg.org/ziglang/zig/pulls/31483 Reviewed-by: Andrew Kelley <andrew@ziglang.org>

2 files changed, 34 insertions(+), 204 deletions(-)

lib/std/heap.zig-7
......@@ -30,13 +30,6 @@ pub fn MemoryPool(comptime Item: type) type {
3030}
3131pub const memory_pool = @import("heap/memory_pool.zig");
3232
33/// Deprecated; use `memory_pool.Aligned`.
34pub const MemoryPoolAligned = memory_pool.Aligned;
35/// Deprecated; use `memory_pool.Extra`.
36pub const MemoryPoolExtra = memory_pool.Extra;
37/// Deprecated; use `memory_pool.Options`.
38pub const MemoryPoolOptions = memory_pool.Options;
39
4033/// comptime-known minimum page size of the target.
4134///
4235/// All pointers from `mmap` or `NtAllocateVirtualMemory` are aligned to at least
lib/std/heap/memory_pool.zig+34-197
......@@ -3,11 +3,6 @@ const Allocator = std.mem.Allocator;
33const Alignment = std.mem.Alignment;
44const MemoryPool = std.heap.MemoryPool;
55
6/// Deprecated.
7pub fn Managed(comptime Item: type) type {
8 return ExtraManaged(Item, .{ .alignment = null });
9}
10
116/// A memory pool that can allocate objects of a single type very quickly.
127/// Use this when you need to allocate a lot of objects of the same type,
138/// because it outperforms general purpose allocators.
......@@ -18,11 +13,6 @@ pub fn Aligned(comptime Item: type, comptime alignment: Alignment) type {
1813 return Extra(Item, .{ .alignment = alignment });
1914}
2015
21/// Deprecated.
22pub fn AlignedManaged(comptime Item: type, comptime alignment: Alignment) type {
23 return ExtraManaged(Item, .{ .alignment = alignment });
24}
25
2616pub const Options = struct {
2717 /// The alignment of the memory pool items. Use `null` for natural alignment.
2818 alignment: ?Alignment = null,
......@@ -83,13 +73,6 @@ pub fn Extra(comptime Item: type, comptime pool_options: Options) type {
8373 pool.* = undefined;
8474 }
8575
86 pub fn toManaged(pool: Pool, allocator: Allocator) ExtraManaged(Item, pool_options) {
87 return .{
88 .allocator = allocator,
89 .unmanaged = pool,
90 };
91 }
92
9376 /// Pre-allocates `num` items and adds them to the memory pool.
9477 /// This allows at least `num` active allocations before an
9578 /// `OutOfMemory` error might happen when calling `create()`.
......@@ -114,7 +97,7 @@ pub fn Extra(comptime Item: type, comptime pool_options: Options) type {
11497 /// NOTE: If `mode` is `free_all`, the function will always return `true`.
11598 pub fn reset(pool: *Pool, allocator: Allocator, mode: ResetMode) bool {
11699 // TODO: Potentially store all allocated objects in a list as well, allowing to
117 // just move them into the free list instead of actually releasing the memory.
100 // just move them into the free list instead of actually releasing the memory.
118101
119102 var arena = pool.arena_state.promote(allocator);
120103 defer pool.arena_state = arena.state;
......@@ -155,182 +138,56 @@ pub fn Extra(comptime Item: type, comptime pool_options: Options) type {
155138 };
156139}
157140
158/// Deprecated.
159pub fn ExtraManaged(comptime Item: type, comptime pool_options: Options) type {
160 if (pool_options.alignment) |a| {
161 if (a.compare(.eq, .of(Item))) {
162 var new_options = pool_options;
163 new_options.alignment = null;
164 return ExtraManaged(Item, new_options);
165 }
166 }
167 return struct {
168 const Pool = @This();
169
170 allocator: Allocator,
171 unmanaged: Unmanaged,
172
173 pub const Unmanaged = Extra(Item, pool_options);
174 pub const item_size = Unmanaged.item_size;
175 pub const item_alignment = Unmanaged.item_alignment;
176
177 const ItemPtr = Unmanaged.ItemPtr;
178
179 /// Creates a new memory pool.
180 pub fn init(allocator: Allocator) Pool {
181 return Unmanaged.empty.toManaged(allocator);
182 }
183
184 /// Creates a new memory pool and pre-allocates `num` items.
185 /// This allows up to `num` active allocations before an
186 /// `OutOfMemory` error might happen when calling `create()`.
187 pub fn initCapacity(allocator: Allocator, num: usize) Allocator.Error!Pool {
188 return (try Unmanaged.initCapacity(allocator, num)).toManaged(allocator);
189 }
190
191 /// Destroys the memory pool and frees all allocated memory.
192 pub fn deinit(pool: *Pool) void {
193 pool.unmanaged.deinit(pool.allocator);
194 pool.* = undefined;
195 }
196
197 /// Pre-allocates `num` items and adds them to the memory pool.
198 /// This allows at least `num` active allocations before an
199 /// `OutOfMemory` error might happen when calling `create()`.
200 pub fn addCapacity(pool: *Pool, num: usize) Allocator.Error!void {
201 return pool.unmanaged.addCapacity(pool.allocator, num);
202 }
203
204 pub const ResetMode = Unmanaged.ResetMode;
205
206 /// Resets the memory pool and destroys all allocated items.
207 /// This can be used to batch-destroy all objects without invalidating the memory pool.
208 ///
209 /// The function will return whether the reset operation was successful or not.
210 /// If the reallocation failed `false` is returned. The pool will still be fully
211 /// functional in that case, all memory is released. Future allocations just might
212 /// be slower.
213 ///
214 /// NOTE: If `mode` is `free_all`, the function will always return `true`.
215 pub fn reset(pool: *Pool, mode: ResetMode) bool {
216 return pool.unmanaged.reset(pool.allocator, mode);
217 }
218
219 /// Creates a new item and adds it to the memory pool.
220 pub fn create(pool: *Pool) Allocator.Error!ItemPtr {
221 return pool.unmanaged.create(pool.allocator);
222 }
223
224 /// Destroys a previously created item.
225 /// Only pass items to `ptr` that were previously created with `create()` of the same memory pool!
226 pub fn destroy(pool: *Pool, ptr: ItemPtr) void {
227 return pool.unmanaged.destroy(ptr);
228 }
229
230 fn allocNew(pool: *Pool) Allocator.Error!*align(item_alignment) [item_size]u8 {
231 return pool.unmanaged.allocNew(pool.allocator);
232 }
233 };
234}
235
236141test "basic" {
237142 const a = std.testing.allocator;
238143
239 {
240 var pool: MemoryPool(u32) = .empty;
241 defer pool.deinit(a);
242
243 const p1 = try pool.create(a);
244 const p2 = try pool.create(a);
245 const p3 = try pool.create(a);
246
247 // Assert uniqueness
248 try std.testing.expect(p1 != p2);
249 try std.testing.expect(p1 != p3);
250 try std.testing.expect(p2 != p3);
144 var pool: MemoryPool(u32) = .empty;
145 defer pool.deinit(a);
251146
252 pool.destroy(p2);
253 const p4 = try pool.create(a);
254
255 // Assert memory reuse
256 try std.testing.expect(p2 == p4);
257 }
147 const p1 = try pool.create(a);
148 const p2 = try pool.create(a);
149 const p3 = try pool.create(a);
258150
259 {
260 var pool: Managed(u32) = .init(std.testing.allocator);
261 defer pool.deinit();
151 // Assert uniqueness
152 try std.testing.expect(p1 != p2);
153 try std.testing.expect(p1 != p3);
154 try std.testing.expect(p2 != p3);
262155
263 const p1 = try pool.create();
264 const p2 = try pool.create();
265 const p3 = try pool.create();
156 pool.destroy(p2);
157 const p4 = try pool.create(a);
266158
267 // Assert uniqueness
268 try std.testing.expect(p1 != p2);
269 try std.testing.expect(p1 != p3);
270 try std.testing.expect(p2 != p3);
271
272 pool.destroy(p2);
273 const p4 = try pool.create();
274
275 // Assert memory reuse
276 try std.testing.expect(p2 == p4);
277 }
159 // Assert memory reuse
160 try std.testing.expect(p2 == p4);
278161}
279162
280163test "initCapacity (success)" {
281164 const a = std.testing.allocator;
282165
283 {
284 var pool: MemoryPool(u32) = try .initCapacity(a, 4);
285 defer pool.deinit(a);
286
287 _ = try pool.create(a);
288 _ = try pool.create(a);
289 _ = try pool.create(a);
290 }
291
292 {
293 var pool: Managed(u32) = try .initCapacity(a, 4);
294 defer pool.deinit();
166 var pool: MemoryPool(u32) = try .initCapacity(a, 4);
167 defer pool.deinit(a);
295168
296 _ = try pool.create();
297 _ = try pool.create();
298 _ = try pool.create();
299 }
169 _ = try pool.create(a);
170 _ = try pool.create(a);
171 _ = try pool.create(a);
300172}
301173
302174test "initCapacity (failure)" {
303175 const failer = std.testing.failing_allocator;
304176 try std.testing.expectError(error.OutOfMemory, MemoryPool(u32).initCapacity(failer, 5));
305 try std.testing.expectError(error.OutOfMemory, Managed(u32).initCapacity(failer, 5));
306177}
307178
308179test "growable" {
309180 const a = std.testing.allocator;
310181
311 {
312 var pool: Extra(u32, .{ .growable = false }) = try .initCapacity(a, 4);
313 defer pool.deinit(a);
314
315 _ = try pool.create(a);
316 _ = try pool.create(a);
317 _ = try pool.create(a);
318 _ = try pool.create(a);
319
320 try std.testing.expectError(error.OutOfMemory, pool.create(a));
321 }
322
323 {
324 var pool: ExtraManaged(u32, .{ .growable = false }) = try .initCapacity(a, 4);
325 defer pool.deinit();
182 var pool: Extra(u32, .{ .growable = false }) = try .initCapacity(a, 4);
183 defer pool.deinit(a);
326184
327 _ = try pool.create();
328 _ = try pool.create();
329 _ = try pool.create();
330 _ = try pool.create();
185 _ = try pool.create(a);
186 _ = try pool.create(a);
187 _ = try pool.create(a);
188 _ = try pool.create(a);
331189
332 try std.testing.expectError(error.OutOfMemory, pool.create());
333 }
190 try std.testing.expectError(error.OutOfMemory, pool.create(a));
334191}
335192
336193test "greater than pointer default alignment" {
......@@ -339,21 +196,11 @@ test "greater than pointer default alignment" {
339196 };
340197 const a = std.testing.allocator;
341198
342 {
343 var pool: MemoryPool(Foo) = .empty;
344 defer pool.deinit(a);
345
346 const foo: *Foo = try pool.create(a);
347 pool.destroy(foo);
348 }
349
350 {
351 var pool: Managed(Foo) = .init(a);
352 defer pool.deinit();
199 var pool: MemoryPool(Foo) = .empty;
200 defer pool.deinit(a);
353201
354 const foo: *Foo = try pool.create();
355 pool.destroy(foo);
356 }
202 const foo: *Foo = try pool.create(a);
203 pool.destroy(foo);
357204}
358205
359206test "greater than pointer manual alignment" {
......@@ -362,19 +209,9 @@ test "greater than pointer manual alignment" {
362209 };
363210 const a = std.testing.allocator;
364211
365 {
366 var pool: Aligned(Foo, .@"16") = .empty;
367 defer pool.deinit(a);
368
369 const foo: *align(16) Foo = try pool.create(a);
370 pool.destroy(foo);
371 }
212 var pool: Aligned(Foo, .@"16") = .empty;
213 defer pool.deinit(a);
372214
373 {
374 var pool: AlignedManaged(Foo, .@"16") = .init(a);
375 defer pool.deinit();
376
377 const foo: *align(16) Foo = try pool.create();
378 pool.destroy(foo);
379 }
215 const foo: *align(16) Foo = try pool.create(a);
216 pool.destroy(foo);
380217}