#define _GNU_SOURCE
#include <stdlib.h>
+#include <stdint.h>
#include <unistd.h>
#include <signal.h>
#include <time.h>
#define sig_monitor(to,cb,arg) (cb(0,arg))
#endif
+#define EVENT_TIMEOUT_TOP ((uint64_t)-1)
+#define EVENT_TIMEOUT_CHILD ((uint64_t)10000)
+
/** Internal shortcut for callback */
-typedef void (*job_cb_t)(int, void*, void *, void*);
+typedef void (*job_cb_t)(int, void*);
/** Description of a pending job */
struct job
struct job *next; /**< link to the next job enqueued */
void *group; /**< group of the request */
job_cb_t callback; /**< processing callback */
- void *arg1; /**< first arg */
- void *arg2; /**< second arg */
- void *arg3; /**< third arg */
+ void *arg; /**< argument */
int timeout; /**< timeout in second for processing the request */
unsigned blocked: 1; /**< is an other request blocking this one ? */
unsigned dropped: 1; /**< is removed ? */
{
struct events *next;
struct sd_event *event;
+ uint64_t timeout;
unsigned runs: 1;
};
unsigned waits: 1; /**< is waiting? */
};
+/**
+ * Description of synchonous callback
+ */
+struct sync
+{
+ struct thread thread; /**< thread loop data */
+ union {
+ void (*callback)(int, void*); /**< the synchronous callback */
+ void (*enter)(int signum, void *closure, struct jobloop *jobloop);
+ /**< the entering synchronous routine */
+ };
+ void *arg; /**< the argument of the callback */
+};
+
+
/* synchronisation of threads */
static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
static pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
* @param group the group of the job
* @param timeout the timeout of the job (0 if none)
* @param callback the function that achieves the job
- * @param arg1 the first argument of the callback
- * @param arg2 the second argument of the callback
- * @param arg3 the third argument of the callback
+ * @param arg the argument of the callback
* @return the created job unblock or NULL when no more memory
*/
static struct job *job_create(
void *group,
int timeout,
job_cb_t callback,
- void *arg1,
- void *arg2,
- void *arg3)
+ void *arg)
{
struct job *job;
job->group = group;
job->timeout = timeout;
job->callback = callback;
- job->arg1 = arg1;
- job->arg2 = arg2;
- job->arg3 = arg3;
+ job->arg = arg;
job->blocked = 0;
job->dropped = 0;
end:
}
/**
- * Adds 'job1' and 'job2' at the end of the list of jobs, marking it
+ * Adds 'job' at the end of the list of jobs, marking it
* as blocked if an other job with the same group is pending.
- * @param job1 the first job to add
- * @param job2 the second job to add or NULL
+ * @param job the job to add
*/
-static void job_add2(struct job *job1, struct job *job2)
+static void job_add(struct job *job)
{
- void *group1, *group2, *group;
+ void *group;
struct job *ijob, **pjob;
/* prepare to add */
- group1 = job1->group;
- job1->next = job2;
- if (!job2)
- group2 = NULL;
- else {
- job2->next = NULL;
- group2 = job2->group;
- if (group2 && group2 == group1)
- job2->blocked = 1;
- }
+ group = job->group;
+ job->next = NULL;
/* search end and blockers */
pjob = &first_job;
ijob = first_job;
while (ijob) {
- group = ijob->group;
- if (group) {
- if (group == group1)
- job1->blocked = 1;
- if (group == group2)
- job2->blocked = 1;
- }
+ if (group && ijob->group == group)
+ job->blocked = 1;
pjob = &ijob->next;
ijob = ijob->next;
}
/* queue the jobs */
- *pjob = job1;
+ *pjob = job;
}
/**
free_jobs = job;
}
-/**
- * Monitored normal callback for a job.
- * This function is called by the monitor
- * to run the job when the safe environment
- * is set.
- * @param signum 0 on normal flow or the number
- * of the signal that interrupted the normal
- * flow
- * @param arg the job to run
- */
-static void job_call(int signum, void *arg)
-{
- struct job *job = arg;
- job->callback(signum, job->arg1, job->arg2, job->arg3);
-}
-
/**
* Monitored cancel callback for a job.
* This function is called by the monitor
*/
static void job_cancel(int signum, void *arg)
{
- job_call(SIGABRT, arg);
+ struct job *job = arg;
+ job->callback(SIGABRT, job->arg);
}
/**
{
struct events *events = arg;
if (!signum)
- sd_event_run(events->event, (uint64_t) -1);
+ sd_event_run(events->event, events->timeout);
}
/**
struct thread **prv;
struct job *job;
struct events *events;
+ uint64_t evto;
/* initialize description of itself and link it in the list */
me->tid = pthread_self();
me->lowered = 0;
me->waits = 0;
me->upper = current;
- if (current)
+ if (current) {
current->lowered = 1;
- else
+ evto = EVENT_TIMEOUT_CHILD;
+ } else {
+ started++;
sig_monitor_init_timeouts();
- current = (struct thread*)me;
+ evto = EVENT_TIMEOUT_TOP;
+ }
me->next = threads;
threads = (struct thread*)me;
- started++;
+ current = (struct thread*)me;
/* loop until stopped */
me->events = NULL;
/* run the job */
pthread_mutex_unlock(&mutex);
- sig_monitor(job->timeout, job_call, job);
+ sig_monitor(job->timeout, job->callback, job->arg);
pthread_mutex_lock(&mutex);
/* release the run job */
if (events) {
/* run the events */
events->runs = 1;
+ events->timeout = evto;
me->events = events;
pthread_mutex_unlock(&mutex);
sig_monitor(0, events_call, events);
}
/* unlink the current thread and cleanup */
- started--;
prv = &threads;
while (*prv != me)
prv = &(*prv)->next;
*prv = me->next;
current = me->upper;
- if (current)
+ if (current) {
current->lowered = 0;
- else
+ } else {
sig_monitor_clean_timeouts();
+ started--;
+ }
}
/**
}
/**
- * Queues a new asynchronous job represented by 'callback'
- * for the 'group' and the 'timeout'.
- * Jobs are queued FIFO and are possibly executed in parallel
- * concurrently except for job of the same group that are
- * executed sequentially in FIFO order.
- * @param group The group of the job or NULL when no group.
- * @param timeout The maximum execution time in seconds of the job
- * or 0 for unlimited time.
- * @param callback The function to execute for achieving the job.
- * Its first parameter is either 0 on normal flow
- * or the signal number that broke the normal flow.
- * @return 0 in case of success or -1 in case of error
- */
-int jobs_queue0(
- void *group,
- int timeout,
- void (*callback)(int signum))
-{
- return jobs_queue3(group, timeout, (job_cb_t)callback, NULL, NULL, NULL);
-}
-
-/**
- * Queues a new asynchronous job represented by 'callback' and 'arg1'
+ * Queues a new asynchronous job represented by 'callback' and 'arg'
* for the 'group' and the 'timeout'.
* Jobs are queued FIFO and are possibly executed in parallel
* concurrently except for job of the same group that are
* or the signal number that broke the normal flow.
* The remaining parameter is the parameter 'arg1'
* given here.
- * @param arg1 The second argument for 'callback'
+ * @param arg The second argument for 'callback'
* @return 0 in case of success or -1 in case of error
*/
int jobs_queue(
int timeout,
void (*callback)(int, void*),
void *arg)
-{
- return jobs_queue3(group, timeout, (job_cb_t)callback, arg, NULL, NULL);
-}
-
-/**
- * Queues a new asynchronous job represented by 'callback' and 'arg[12]'
- * for the 'group' and the 'timeout'.
- * Jobs are queued FIFO and are possibly executed in parallel
- * concurrently except for job of the same group that are
- * executed sequentially in FIFO order.
- * @param group The group of the job or NULL when no group.
- * @param timeout The maximum execution time in seconds of the job
- * or 0 for unlimited time.
- * @param callback The function to execute for achieving the job.
- * Its first parameter is either 0 on normal flow
- * or the signal number that broke the normal flow.
- * The remaining parameters are the parameters 'arg[12]'
- * given here.
- * @param arg1 The second argument for 'callback'
- * @param arg2 The third argument for 'callback'
- * @return 0 in case of success or -1 in case of error
- */
-int jobs_queue2(
- void *group,
- int timeout,
- void (*callback)(int, void*, void*),
- void *arg1,
- void *arg2)
-{
- return jobs_queue3(group, timeout, (job_cb_t)callback, arg1, arg2, NULL);
-}
-
-/**
- * Queues a new asynchronous job represented by 'callback' and 'arg[123]'
- * for the 'group' and the 'timeout'.
- * Jobs are queued FIFO and are possibly executed in parallel
- * concurrently except for job of the same group that are
- * executed sequentially in FIFO order.
- * @param group The group of the job or NULL when no group.
- * @param timeout The maximum execution time in seconds of the job
- * or 0 for unlimited time.
- * @param callback The function to execute for achieving the job.
- * Its first parameter is either 0 on normal flow
- * or the signal number that broke the normal flow.
- * The remaining parameters are the parameters 'arg[123]'
- * given here.
- * @param arg1 The second argument for 'callback'
- * @param arg2 The third argument for 'callback'
- * @param arg3 The forth argument for 'callback'
- * @return 0 in case of success or -1 in case of error
- */
-int jobs_queue3(
- void *group,
- int timeout,
- void (*callback)(int, void*, void *, void*),
- void *arg1,
- void *arg2,
- void *arg3)
{
const char *info;
struct job *job;
pthread_mutex_lock(&mutex);
/* allocates the job */
- job = job_create(group, timeout, callback, arg1, arg2, arg3);
+ job = job_create(group, timeout, callback, arg);
if (!job) {
errno = ENOMEM;
info = "out of memory";
/* queues the job */
remains--;
- job_add2(job, NULL);
+ job_add(job);
/* signal an existing job */
pthread_cond_signal(&cond);
}
/**
- * Run a asynchronous job represented by 'callback'
- * with the 'timeout' but only returns after job completion.
- * @param timeout The maximum execution time in seconds of the job
- * or 0 for unlimited time.
- * @param callback The function to execute for achieving the job.
- * Its first parameter is either 0 on normal flow
- * or the signal number that broke the normal flow.
- * @return 0 in case of success or -1 in case of error
+ * Internal helper function for 'jobs_enter'.
+ * @see jobs_enter, jobs_leave
*/
-int jobs_invoke0(
- int timeout,
- void (*callback)(int signum))
+static void enter_cb(int signum, void *closure)
{
- return jobs_invoke3(timeout, (job_cb_t)callback, NULL, NULL, NULL);
+ struct sync *sync = closure;
+ sync->enter(signum, sync->arg, (void*)&sync->thread);
}
/**
- * Run a asynchronous job represented by 'callback' and 'arg1'
- * with the 'timeout' but only returns after job completion.
- * @param timeout The maximum execution time in seconds of the job
- * or 0 for unlimited time.
- * @param callback The function to execute for achieving the job.
- * Its first parameter is either 0 on normal flow
- * or the signal number that broke the normal flow.
- * The remaining parameter is the parameter 'arg1'
- * given here.
- * @param arg1 The second argument for 'callback'
- * @return 0 in case of success or -1 in case of error
+ * Internal helper function for 'jobs_call'.
+ * @see jobs_call
*/
-int jobs_invoke(
+static void call_cb(int signum, void *closure)
+{
+ struct sync *sync = closure;
+ sync->callback(signum, sync->arg);
+ jobs_leave((void*)&sync->thread);
+}
+
+/**
+ * Internal helper for synchronous jobs. It enters
+ * a new thread loop for evaluating the given job
+ * as recorded by the couple 'sync_cb' and 'sync'.
+ * @see jobs_call, jobs_enter, jobs_leave
+ */
+static int do_sync(
+ void *group,
int timeout,
- void (*callback)(int, void*),
- void *arg)
+ void (*sync_cb)(int signum, void *closure),
+ struct sync *sync
+)
{
- return jobs_invoke3(timeout, (job_cb_t)callback, arg, NULL, NULL);
+ struct job *job;
+
+ pthread_mutex_lock(&mutex);
+
+ /* allocates the job */
+ job = job_create(group, timeout, sync_cb, sync);
+ if (!job) {
+ ERROR("out of memory");
+ errno = ENOMEM;
+ pthread_mutex_unlock(&mutex);
+ return -1;
+ }
+
+ /* queues the job */
+ job_add(job);
+
+ /* run until stopped */
+ thread_run(&sync->thread);
+ pthread_mutex_unlock(&mutex);
+ return 0;
}
/**
- * Run a asynchronous job represented by 'callback' and 'arg[12]'
- * with the 'timeout' but only returns after job completion.
- * @param timeout The maximum execution time in seconds of the job
- * or 0 for unlimited time.
- * @param callback The function to execute for achieving the job.
- * Its first parameter is either 0 on normal flow
- * or the signal number that broke the normal flow.
- * The remaining parameters are the parameters 'arg[12]'
- * given here.
- * @param arg1 The second argument for 'callback'
- * @param arg2 The third argument for 'callback'
- * @return 0 in case of success or -1 in case of error
+ * Enter a synchronisation point: activates the job given by 'callback'
+ * and 'closure' using 'group' and 'timeout' to control sequencing and
+ * execution time.
+ * @param group the group for sequencing jobs
+ * @param timeout the time in seconds allocated to the job
+ * @param callback the callback that will handle the job.
+ * it receives 3 parameters: 'signum' that will be 0
+ * on normal flow or the catched signal number in case
+ * of interrupted flow, the context 'closure' as given and
+ * a 'jobloop' reference that must be used when the job is
+ * terminated to unlock the current execution flow.
+ * @param arg the argument to the callback
+ * @return 0 on success or -1 in case of error
*/
-int jobs_invoke2(
+int jobs_enter(
+ void *group,
int timeout,
- void (*callback)(int, void*, void*),
- void *arg1,
- void *arg2)
+ void (*callback)(int signum, void *closure, struct jobloop *jobloop),
+ void *closure
+)
{
- return jobs_invoke3(timeout, (job_cb_t)callback, arg1, arg2, NULL);
+ struct sync sync;
+
+ sync.enter = callback;
+ sync.arg = closure;
+ return do_sync(group, timeout, enter_cb, &sync);
}
/**
- * Stops the thread pointed by 'arg1'. Used with
- * invoke familly to return to the caller after completion.
- * @param signum Unused
- * @param arg1 The thread to stop
- * @param arg2 Unused
- * @param arg3 Unused
+ * Unlocks the execution flow designed by 'jobloop'.
+ * @param jobloop indication of the flow to unlock
+ * @return 0 in case of success of -1 on error
*/
-static void unlock_invoker(int signum, void *arg1, void *arg2, void *arg3)
+int jobs_leave(struct jobloop *jobloop)
{
- struct thread *t = arg1;
+ struct thread *t;
+
pthread_mutex_lock(&mutex);
- t->stop = 1;
- if (t->waits)
- pthread_cond_broadcast(&cond);
+ t = threads;
+ while (t && t != (struct thread*)jobloop)
+ t = t->next;
+ if (!t) {
+ errno = EINVAL;
+ } else {
+ t->stop = 1;
+ if (t->waits)
+ pthread_cond_broadcast(&cond);
+ }
pthread_mutex_unlock(&mutex);
+ return -!t;
}
/**
- * Run a asynchronous job represented by 'callback' and 'arg[123]'
- * with the 'timeout' but only returns after job completion.
+ * Calls synchronously the job represented by 'callback' and 'arg1'
+ * for the 'group' and the 'timeout' and waits for its completion.
+ * @param group The group of the job or NULL when no group.
* @param timeout The maximum execution time in seconds of the job
* or 0 for unlimited time.
* @param callback The function to execute for achieving the job.
* Its first parameter is either 0 on normal flow
* or the signal number that broke the normal flow.
- * The remaining parameters are the parameters 'arg[123]'
+ * The remaining parameter is the parameter 'arg1'
* given here.
- * @param arg1 The second argument for 'callback'
- * @param arg2 The third argument for 'callback'
- * @param arg3 The forth argument for 'callback'
+ * @param arg The second argument for 'callback'
* @return 0 in case of success or -1 in case of error
*/
-int jobs_invoke3(
+int jobs_call(
+ void *group,
int timeout,
- void (*callback)(int, void*, void *, void*),
- void *arg1,
- void *arg2,
- void *arg3)
+ void (*callback)(int, void*),
+ void *arg)
{
- struct job *job1, *job2;
- struct thread me;
-
+ struct sync sync;
+
+ sync.callback = callback;
+ sync.arg = arg;
+
+ return do_sync(group, timeout, call_cb, &sync);
+}
+
+/**
+ * Gets a sd_event item for the current thread.
+ * @return a sd_event or NULL in case of error
+ */
+struct sd_event *jobs_get_sd_event()
+{
+ struct events *events;
+ struct thread *me;
+ int rc;
+
pthread_mutex_lock(&mutex);
- /* allocates the job */
- job1 = job_create(&me, timeout, callback, arg1, arg2, arg3);
- job2 = job_create(&me, 0, unlock_invoker, &me, NULL, NULL);
- if (!job1 || !job2) {
- ERROR("out of memory");
- errno = ENOMEM;
- if (job1) {
- job1->next = free_jobs;
- free_jobs = job1;
+ /* search events on stack */
+ me = current;
+ while (me && !me->events)
+ me = me->upper;
+ if (me)
+ /* return the stacked events */
+ events = me->events;
+ else {
+ /* search an available events */
+ events = events_get();
+ if (!events) {
+ /* not found, check if creation possible */
+ if (nevents >= allowed) {
+ ERROR("not possible to add a new event");
+ events = NULL;
+ } else {
+ events = malloc(sizeof *events);
+ if (events && (rc = sd_event_new(&events->event)) >= 0) {
+ if (nevents < started || start_one_thread() >= 0) {
+ events->runs = 0;
+ events->next = first_events;
+ first_events = events;
+ } else {
+ ERROR("can't start thread for events");
+ sd_event_unref(events->event);
+ free(events);
+ events = NULL;
+ }
+ } else {
+ if (!events) {
+ ERROR("out of memory");
+ errno = ENOMEM;
+ } else {
+ free(events);
+ ERROR("creation of sd_event failed: %m");
+ events = NULL;
+ errno = -rc;
+ }
+ }
+ }
}
- if (job2) {
- job2->next = free_jobs;
- free_jobs = job2;
+ if (events) {
+ /* */
+ me = current;
+ if (me) {
+ events->runs = 1;
+ me->events = events;
+ } else {
+ WARNING("event returned for unknown thread!");
+ }
}
- pthread_mutex_unlock(&mutex);
- return -1;
}
-
- /* queues the job */
- job_add2(job1, job2);
-
- /* run until stopped */
- thread_run(&me);
pthread_mutex_unlock(&mutex);
- return 0;
+ return events ? events->event : NULL;
}
/**
- * Initialise the job stuff.
- * @param allowed_count Maximum count of thread for jobs (can be 0,
- * see 'jobs_add_me' for merging new threads)
+ * Enter the jobs processing loop.
+ * @param allowed_count Maximum count of thread for jobs including this one
* @param start_count Count of thread to start now, must be lower.
* @param waiter_count Maximum count of jobs that can be waiting.
+ * @param start The start routine to activate (can't be NULL)
* @return 0 in case of success or -1 in case of error.
*/
-int jobs_init(int allowed_count, int start_count, int waiter_count)
+int jobs_start(int allowed_count, int start_count, int waiter_count, void (*start)(int signum))
{
int rc, launched;
+ struct thread me;
+ struct job *job;
- assert(allowed_count >= 0);
+ assert(allowed_count >= 1);
assert(start_count >= 0);
assert(waiter_count > 0);
assert(start_count <= allowed_count);
+ rc = -1;
+ pthread_mutex_lock(&mutex);
+
+ /* check whether already running */
+ if (current || allowed) {
+ ERROR("thread already started");
+ errno = EINVAL;
+ goto error;
+ }
+
+ /* start */
+ if (sig_monitor_init() < 0) {
+ ERROR("failed to initialise signal handlers");
+ goto error;
+ }
+
/* records the allowed count */
allowed = allowed_count;
started = 0;
remains = waiter_count;
/* start at least one thread */
- pthread_mutex_lock(&mutex);
launched = 0;
- while (launched < start_count && start_one_thread() == 0)
+ while ((launched + 1) < start_count) {
+ if (start_one_thread() != 0) {
+ ERROR("Not all threads can be started");
+ goto error;
+ }
launched++;
- rc = -(launched != start_count);
- pthread_mutex_unlock(&mutex);
+ }
+
+ /* queue the start job */
+ job = job_create(NULL, 0, (job_cb_t)start, NULL);
+ if (!job) {
+ ERROR("out of memory");
+ errno = ENOMEM;
+ goto error;
+ }
+ job_add(job);
+ remains--;
- /* end */
- if (rc)
- ERROR("Not all threads can be started");
+ /* run until end */
+ thread_run(&me);
+ rc = 0;
+error:
+ pthread_mutex_unlock(&mutex);
return rc;
}
pthread_mutex_unlock(&mutex);
}
-/**
- * Adds the current thread to the pool of threads
- * processing the jobs. Returns normally when the threads are
- * terminated or immediately with an error if the thread is
- * already in the pool.
- * @return 0 in case of success or -1 in case of error
- */
-int jobs_add_me()
-{
- struct thread me;
-
- /* check whether already running */
- if (current) {
- ERROR("thread already running");
- errno = EINVAL;
- return -1;
- }
-
- /* allowed... */
- pthread_mutex_lock(&mutex);
- allowed++;
- thread_run(&me);
- allowed--;
- pthread_mutex_unlock(&mutex);
- return 0;
-}
-
-
-struct sd_event *jobs_get_sd_event()
-{
- struct events *events;
- struct thread *me;
- int rc;
-
- pthread_mutex_lock(&mutex);
-
- /* search events on stack */
- me = current;
- while (me && !me->events)
- me = me->upper;
- if (me)
- /* return the stacked events */
- events = me->events;
- else {
- /* search an available events */
- events = events_get();
- if (!events) {
- /* not found, check if creation possible */
- if (nevents >= allowed) {
- ERROR("not possible to add a new event");
- events = NULL;
- } else {
- events = malloc(sizeof *events);
- if (events && (rc = sd_event_new(&events->event)) >= 0) {
- if (nevents < started || start_one_thread() >= 0) {
- events->runs = 0;
- events->next = first_events;
- first_events = events;
- } else {
- ERROR("can't start thread for events");
- sd_event_unref(events->event);
- free(events);
- events = NULL;
- }
- } else {
- if (!events)
- ERROR("out of memory");
- else {
- free(events);
- ERROR("creation of sd_event failed: %m");
- events = NULL;
- errno = -rc;
- }
- }
- }
- }
- if (events) {
- /* */
- me = current;
- if (me) {
- events->runs = 1;
- me->events = events;
- } else {
- WARNING("event returned for unknown thread!");
- }
- }
- }
- pthread_mutex_unlock(&mutex);
- return events ? events->event : NULL;
-}
-
-/**
- * run the jobs as
- * @param allowed_count Maximum count of thread for jobs including this one
- * @param start_count Count of thread to start now, must be lower.
- * @param waiter_count Maximum count of jobs that can be waiting.
- * @param start The start routine to activate (can't be NULL)
- * @return 0 in case of success or -1 in case of error.
- */
-int jobs_enter(int allowed_count, int start_count, int waiter_count, void (*start)())
-{
- /* start */
- if (sig_monitor_init() < 0) {
- ERROR("failed to initialise signal handlers");
- return -1;
- }
-
- /* init job processing */
- if (jobs_init(allowed_count, start_count, waiter_count) < 0) {
- ERROR("failed to initialise threading");
- return -1;
- }
-
- /* queue the start job */
- if (jobs_queue0(NULL, 0, (void(*)(int))start) < 0) {
- ERROR("failed to start runnning jobs");
- return -1;
- }
-
- /* turn as processing thread */
- return jobs_add_me();
-};