Workqueues

include/thread/defer.h

struct work_args

Member Type	Member Name
void	*arg1
void	*arg2

struct deferred_event

Member Type	Member Name
size_t	timer
uint64_t	timestamp_ms
work_function	callback
struct work_args	args
struct deferred_event	*next

struct work

Member Type	Member Name
work_function	func
struct work_args	args
struct list_head	list_node
atomic_bool	enqueued
atomic_bool	active
uint64_t	seq

struct worker

Member Type	Member Name
struct thread	*thread
struct workqueue	*workqueue
time_t	last_active
time_t	inactivity_check_period
time_t	start_idle
bool	timeout_ran
bool	should_exit
bool	is_permanent
bool	present
bool	idle
enum worker_next_action	next_action
struct list_head	list_node

struct worklist

Member Type	Member Name
enum worklist_state	state
struct list_head	list
time_t	creation_time
struct spinlock	lock
enum worklist_flags	flags
refcount_t	refcount

struct workqueue_stats

Member Type	Member Name
uint64_t	total_tasks_added
uint64_t	total_tasks_executed
uint64_t	total_workers_spawned
uint64_t	total_worker_exits
uint64_t	max_queue_length
uint64_t	current_queue_length
uint64_t	total_spawn_attempts
uint64_t	total_spawn_failures
uint64_t	num_idle_workers
uint64_t	num_active_workers

struct workqueue_attributes

Member Type	Member Name
size_t	min_workers
size_t	max_workers
size_t	capacity
time_t	spawn_delay
nice_t	worker_niceness
struct { uint64_t min; uint64_t max; }	idle_check
enum workqueue_flags	flags
struct cpu_mask	worker_cpu_mask

struct workqueue

Member Type	Member Name
char	*name
atomic_bool	ignore_timeouts
struct spinlock	work_lock
struct spinlock	worker_lock
struct spinlock	worker_array_lock
struct spinlock	lock
struct condvar	queue_cv
struct work	*oneshot_works
struct list_head	workers
struct list_head	works
struct worker	*worker_array
uint64_t	head
uint64_t	tail
atomic_bool	spawn_pending
uint32_t	num_tasks
uint32_t	num_workers
uint32_t	idle_workers
core_t	core
time_t	last_spawn_attempt
atomic_flag	spawner_flag_internal
struct workqueue_attributes	attrs
enum workqueue_state	state
struct thread_request	*request
refcount_t	refcount

enum worker_next_action

Name	Value
WORKER_NEXT_ACTION_RUN	None
WORKER_NEXT_ACTION_EXIT	None

enum worklist_state

Name	Value
WORKLIST_STATE_EMPTY	0
WORKLIST_STATE_READY	1
WORKLIST_STATE_RUNNING	2
WORKLIST_STATE_DESTROYING	3
WORKLIST_STATE_DEAD	4

enum worklist_flags

Name	Value
WORKLIST_FLAG_UNBOUND	1

enum workqueue_flags

Name	Value
WORKQUEUE_FLAG_PERMANENT	1 << 1
WORKQUEUE_FLAG_AUTO_SPAWN	1 << 2
WORKQUEUE_FLAG_UNMIGRATABLE_WORKERS	1 << 3
WORKQUEUE_FLAG_NAMED	1 << 4
WORKQUEUE_FLAG_SPAWN_VIA_REQUEST	1 << 5
WORKQUEUE_FLAG_STATIC_WORKERS	1 << 6
WORKQUEUE_FLAG_NO_WORKER_GC	1 << 7
WORKQUEUE_FLAG_NO_AUTO_SPAWN	0
WORKQUEUE_FLAG_MIGRATABLE_WORKERS	0
WORKQUEUE_FLAG_ON_DEMAND	0
WORKQUEUE_FLAG_NAMELESS	0
WORKQUEUE_FLAG_SPAWN_NORMALLY	0
WORKQUEUE_FLAG_NON_STATIC_WORKERS	0
WORKQUEUE_FLAG_WORKER_GC	0
WORKQUEUE_FLAG_DEFAULTS	`WORKQUEUE_FLAG_AUTO_SPAWN

enum workqueue_state

Name	Value
WORKQUEUE_STATE_DEAD	None
WORKQUEUE_STATE_DESTROYING	None
WORKQUEUE_STATE_ACTIVE	None

enum workqueue_error

Name	Value
WORKQUEUE_ERROR_NEED_NEW_WORKER	4
WORKQUEUE_ERROR_NEED_NEW_WQ	3
WORKQUEUE_ERROR_OK	0
WORKQUEUE_ERROR_FULL	-1
WORKQUEUE_ERROR_WLIST_EXECUTING	-2
WORKQUEUE_ERROR_UNUSABLE	-3
WORKQUEUE_ERROR_WORK_EXECUTING	-4

type alias

(*work_function) : void (void *arg, void *arg2)

• void defer_init(void)
• bool defer_enqueue(work_function func,struct work_args args,uint64_t delay_ms)
• void workqueues_permanent_init(void)
• struct workqueue *workqueue_create(struct workqueue_attributes *attrs,char *fmt)
• struct work *work_create(work_function func,struct work_args args)
• struct work *work_init(struct work *work,work_function fn,struct work_args args)
• void workqueue_free(struct workqueue *queue)
• enum workqueue_errorworkqueue_enqueue_oneshot(struct workqueue *queue,work_function func,struct work_args args)
• enum workqueue_errorworkqueue_enqueue(struct workqueue *queue,struct work *work)
• enum workqueue_errorworkqueue_add_oneshot(work_function func,struct work_args args)
• enum workqueue_errorworkqueue_add_remote_oneshot(work_function func,struct work_args args)
• enum workqueue_errorworkqueue_add_local_oneshot(work_function func,struct work_args args)
• enum workqueue_errorworkqueue_add_fast_oneshot(work_function func,struct work_args args)
• enum workqueue_errorworkqueue_add(struct work *work)
• enum workqueue_errorworkqueue_add_remote(struct work *work)
• enum workqueue_errorworkqueue_add_local(struct work *work)
• enum workqueue_errorworkqueue_add_fast(struct work *work)
• void work_execute(struct work *task)
• bool workqueue_should_spawn_worker(struct workqueue *queue)
• struct worklist *worklist_create(enum worklist_flags)
• void worklist_free(struct worklist *wlist)
• void workqueue_kick(struct workqueue *queue)
• void workqueue_destroy(struct workqueue *queue)
• void worker_main(void *)
• static inline bool work_active(struct work *work)

Defines

• WORKQUEUE_DEFAULT_CAPACITY: 512
• WORKQUEUE_DEFAULT_MAX_WORKERS: 16
• WORKQUEUE_DEFAULT_SPAWN_DELAY: 150
• WORKQUEUE_DEFAULT_MIN_IDLE_CHECK: SECONDS_TO_MS(2)
• WORKQUEUE_DEFAULT_MAX_IDLE_CHECK: SECONDS_TO_MS(40)

---