Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › heap › debug_allocator › DebugAllocator › BucketHeader Private Struct BucketHeader Doc Source Private Struct std.heap.debug_allocator.DebugAllocator.BucketHeader
const BucketHeader = struct Fields Functions fn fromPage (page_addr : usize , slot_count : usize ) *BucketHeader fn usedBits (bucket : *BucketHeader , index : usize ) *usize fn requestedSizes (bucket : *BucketHeader , slot_count : usize ) []LargestSizeClassInt fn log2PtrAligns (bucket : *BucketHeader , slot_count : usize ) []mem .Alignment fn stackTracePtr (bucket : *BucketHeader , slot_count : usize , slot_index : SlotIndex , trace_kind : TraceKind ) *[stack_n ]usize fn captureStackTrace (bucket : *BucketHeader , ret_addr : usize , slot_count : usize , slot_index : SlotIndex , trace_kind : TraceKind ) void File heap/debug_allocator.zig: 261
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316 const BucketHeader = struct {
allocated_count : SlotIndex ,
freed_count : SlotIndex ,
prev : ?*BucketHeader ,
next : ?*BucketHeader ,
canary : usize = config .canary ,
fn fromPage (page_addr : usize , slot_count : usize ) *BucketHeader {
const unaligned = page_addr +% page_size -% bucketSize (slot_count );
return @ptrFromInt (unaligned & ~(@as (usize , @alignOf (BucketHeader )) - 1 ));
}
fn usedBits (bucket : *BucketHeader , index : usize ) *usize {
const ptr : [*]u8 = @ptrCast (bucket );
const bits : [*]usize = @ptrCast (@alignCast (ptr + @sizeOf (BucketHeader )));
return &bits [index ];
}
fn requestedSizes (bucket : *BucketHeader , slot_count : usize ) []LargestSizeClassInt {
if (!config .safety ) @compileError ("requested size is only stored when safety is enabled" );
const start_ptr = @as ([*]u8 , @ptrCast (bucket )) + bucketRequestedSizesStart (slot_count );
const sizes = @as ([*]LargestSizeClassInt , @ptrCast (@alignCast (start_ptr )));
return sizes [0 ..slot_count ];
}
fn log2PtrAligns (bucket : *BucketHeader , slot_count : usize ) []mem .Alignment {
if (!config .safety ) @compileError ("requested size is only stored when safety is enabled" );
const aligns_ptr = @as ([*]u8 , @ptrCast (bucket )) + bucketAlignsStart (slot_count );
return @ptrCast (aligns_ptr [0 ..slot_count ]);
}
fn stackTracePtr (
bucket : *BucketHeader ,
slot_count : usize ,
slot_index : SlotIndex ,
trace_kind : TraceKind ,
) *[stack_n ]usize {
const start_ptr = @as ([*]u8 , @ptrCast (bucket )) + bucketStackFramesStart (slot_count );
const addr = start_ptr + one_trace_size * traces_per_slot * slot_index +
@backingInt (trace_kind ) * @as (usize , one_trace_size );
return @ptrCast (@alignCast (addr ));
}
fn captureStackTrace (
bucket : *BucketHeader ,
ret_addr : usize ,
slot_count : usize ,
slot_index : SlotIndex ,
trace_kind : TraceKind ,
) void {
// Initialize them to 0. When determining the count we must look
// for non zero addresses.
const stack_addresses = bucket .stackTracePtr (slot_count , slot_index , trace_kind );
collectStackTrace (ret_addr , stack_addresses );
}
}
Bucket: In memory, in order: