worker.h

Go to the documentation of this file.

#ifndef HTILS_WORKER_H
#define HTILS_WORKER_H
 
#ifndef HTILS_THREAD_SAFE
#error "htils workers are only available on thread-safe builds of htils"
#else
 
/***********************************/
 
#include <stdatomic.h>
#include <threads.h>
 
#include <htils/arena.h>
#include <htils/atomic_types.h>
#include <htils/basictypes.h>
 
/***********************************/

typedef enum {
  HTILS_WORKER_CONTINUE, 
  HTILS_WORKER_DONE,     
} htils_worker_step_t;

typedef void (*htils_worker_fn_t)(void *userdata, arena_t *scratch);

typedef htils_worker_step_t (*htils_worker_task_t)(void *userdata,
                                                   arena_t *scratch);

typedef struct htils_worker_config {
  b32 detach;
} htils_worker_config_t;

typedef struct htils_worker {
  thrd_t thread;
  arena_t *scratch;
  atomic_b32 running;
  atomic_b32 pause;
  b32 detached;
  htils_worker_fn_t fn;
  htils_worker_task_t task;
  void *userdata;
  mtx_t pause_mtx; // guards pause awaits
  cnd_t pause_cnd; // signals on resume/stop
  b32 primitives_init;
} htils_worker_t;
 
//
//
//

htils_worker_config_t htils_worker_config_default(void);
 
//
//
//

b32 htils_worker_spawn(htils_worker_t *worker,
                       const htils_worker_config_t *config,
                       htils_worker_fn_t fn, void *userdata);
 
//
//
//

b32 htils_worker_spawn_task(htils_worker_t *worker,
                            const htils_worker_config_t *config,
                            htils_worker_task_t task, void *userdata);
 
//
//
//

void htils_worker_request_stop(htils_worker_t *worker);
 
//
//
//

void htils_worker_set_paused(htils_worker_t *worker, b32 paused);
 
//
//
//

b32 htils_worker_running(const htils_worker_t *worker);
 
//
//
//

b32 htils_worker_paused(const htils_worker_t *worker);
 
//
//
//

b32 htils_worker_should_stop(const htils_worker_t *worker);
 
//
//
//

void htils_worker_join(htils_worker_t *worker);
 
#endif // !HTILS_THREAD_SAFE
#endif // !HTILS_WORKER_H