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 › Io › Threaded › groupAsync Private Function groupAsync Doc Source Private Function std.Io.Threaded.groupAsync
fn groupAsync (
userdata : ?*anyopaque ,
type_erased : *Io .Group ,
context : []const u8 ,
context_alignment : Alignment ,
start : *const fn (context : *const anyopaque ) void ,
) void Params userdata : ?*anyopaque type_erased : *Io .Group context : []const u8 context_alignment : Alignment start : *const fn (context : *const anyopaque ) void File Io/Threaded.zig: 2167
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221 fn groupAsync (
userdata : ?*anyopaque ,
type_erased : *Io .Group ,
context : []const u8 ,
context_alignment : Alignment ,
start : *const fn (context : *const anyopaque ) void ,
) void {
const t : *Threaded = @ptrCast (@alignCast (userdata ));
const g : Group = .{ .ptr = type_erased };
if (builtin .single_threaded ) return groupAsyncEager (start , context .ptr );
const gpa = t .allocator ;
const task = Group .Task .create (gpa , g , context , context_alignment , start ) catch |err | switch (err ) {
error .OutOfMemory => return groupAsyncEager (start , context .ptr ),
};
mutexLock (&t .mutex );
const busy_count = t .busy_count ;
if (busy_count >= @backingInt (t .async_limit )) {
mutexUnlock (&t .mutex );
task .destroy (gpa );
return groupAsyncEager (start , context .ptr );
}
t .busy_count = busy_count + 1 ;
const pool_size = t .wait_group .value ();
if (pool_size - busy_count == 0 ) {
t .wait_group .start ();
const thread = std .Thread .spawn (.{ .stack_size = t .stack_size }, worker , .{t }) catch {
t .wait_group .finish ();
t .busy_count = busy_count ;
mutexUnlock (&t .mutex );
task .destroy (gpa );
return groupAsyncEager (start , context .ptr );
};
thread .detach ();
}
// TODO: if this logic is changed to be lock-free, this `fetchAdd` must be released by the queue
// prepend so that the task doesn't finish without observing this and try to decrement the count
// below zero.
_ = g .status ().fetchAdd (.{
.num_running = 1 ,
.have_awaiter = false ,
.canceled = false ,
}, .monotonic );
t .run_queue .prepend (&task .runnable .node );
mutexUnlock (&t .mutex );
condSignal (&t .cond );
}