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 › ArenaAllocator › resize Private Function resize Doc Source Private Function std.heap.ArenaAllocator.resize
fn resize (ctx : *anyopaque , memory : []u8 , alignment : Alignment , new_len : usize , ret_addr : usize ) bool Params ctx : *anyopaque memory : []u8 alignment : Alignment new_len : usize ret_addr : usize File heap/ArenaAllocator.zig: 551
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602 fn resize (ctx : *anyopaque , memory : []u8 , alignment : Alignment , new_len : usize , ret_addr : usize ) bool {
const arena : *ArenaAllocator = @ptrCast (@alignCast (ctx ));
_ = alignment ;
_ = ret_addr ;
assert (memory .len > 0 );
assert (new_len > 0 );
const node = arena .loadFirstNode ().?;
const buf_ptr = @as ([*]u8 , @ptrCast (node )) + @sizeOf (Node );
const cur_end_index = @atomicLoad (usize , &node .end_index , .monotonic );
if (buf_ptr + cur_end_index != memory .ptr + memory .len ) {
// It's not the most recent allocation, so it cannot be expanded,
// but it's fine if they want to make it smaller.
return new_len <= memory .len ;
}
if (new_len <= memory .len ) {
const new_end_index = cur_end_index - (memory .len - new_len );
assert (buf_ptr + new_end_index == memory .ptr + new_len );
_ = @cmpxchgStrong (
usize ,
&node .end_index ,
cur_end_index ,
new_end_index ,
.release , // release freed memory
.monotonic ,
);
return true ; // Shrinking allocations should always succeed.
}
// Saturating arithmetic because `end_index` is not guaranteed to be `<= size`.
// The allocation we're trying to resize *could* belong to a different node!
if (node .loadBuf ().len -| cur_end_index >= new_len - memory .len ) {
const new_end_index = cur_end_index + (new_len - memory .len );
assert (buf_ptr + new_end_index == memory .ptr + new_len );
return null == @cmpxchgStrong (
usize ,
&node .end_index ,
cur_end_index ,
new_end_index ,
.acquire , // acquire any memory that may have been freed
.monotonic ,
);
}
return false ;
}