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 › FixedBufferAllocator › threadSafeResize Private Function threadSafeResize Doc Source Private Function std.heap.FixedBufferAllocator.threadSafeResize
fn threadSafeResize (ctx : *anyopaque , memory : []u8 , alignment : mem .Alignment , new_len : usize , ret_addr : usize ) bool Params ctx : *anyopaque memory : []u8 alignment : mem .Alignment new_len : usize ret_addr : usize File heap/FixedBufferAllocator.zig: 152
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 fn threadSafeResize (ctx : *anyopaque , memory : []u8 , alignment : mem .Alignment , new_len : usize , ret_addr : usize ) bool {
const fba : *FixedBufferAllocator = @ptrCast (@alignCast (ctx ));
_ = alignment ;
_ = ret_addr ;
const cur_end_index = @atomicLoad (usize , &fba .end_index , .monotonic );
if (fba .buffer .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 (fba .buffer .ptr + new_end_index == memory .ptr + new_len );
_ = @cmpxchgStrong (
usize ,
&fba .end_index ,
cur_end_index ,
new_end_index ,
.release , // release freed memory
.monotonic ,
);
return true ; // Shrinking allocations should always succeed.
}
if (fba .buffer .len - cur_end_index >= new_len - memory .len ) {
const new_end_index = cur_end_index + (new_len - memory .len );
assert (fba .buffer .ptr + new_end_index == memory .ptr + new_len );
return null == @cmpxchgStrong (
usize ,
&fba .end_index ,
cur_end_index ,
new_end_index ,
.acquire , // acquire any memory that may have been freed
.monotonic ,
);
}
return false ;
}