jobs: Fix possible race condition
[src/app-framework-binder.git] / src / jobs.c
index 8725d00..e3df8f5 100644 (file)
@@ -26,6 +26,7 @@
 #include <pthread.h>
 #include <errno.h>
 #include <assert.h>
+#include <sys/eventfd.h>
 
 #include <systemd/sd-event.h>
 
@@ -50,7 +51,7 @@ typedef void (*job_cb_t)(int, void*);
 struct job
 {
        struct job *next;    /**< link to the next job enqueued */
-       void *group;         /**< group of the request */
+       const void *group;   /**< group of the request */
        job_cb_t callback;   /**< processing callback */
        void *arg;           /**< argument */
        int timeout;         /**< timeout in second for processing the request */
@@ -59,24 +60,26 @@ struct job
 };
 
 /** Description of handled event loops */
-struct events
+struct evloop
 {
-       struct events *next;
-       struct sd_event *event;
-       uint64_t timeout;
-       unsigned runs: 1;
+       unsigned state;        /**< encoded state */
+       int efd;               /**< event notification */
+       struct sd_event *sdev; /**< the systemd event loop */
+       pthread_cond_t  cond;  /**< condition */
 };
 
+#define EVLOOP_STATE_WAIT           1U
+#define EVLOOP_STATE_RUN            2U
+#define EVLOOP_STATE_LOCK           4U
+
 /** Description of threads */
 struct thread
 {
        struct thread *next;   /**< next thread of the list */
        struct thread *upper;  /**< upper same thread */
        struct job *job;       /**< currently processed job */
-       struct events *events; /**< currently processed job */
        pthread_t tid;         /**< the thread id */
        unsigned stop: 1;      /**< stop requested */
-       unsigned lowered: 1;   /**< has a lower same thread */
        unsigned waits: 1;     /**< is waiting? */
 };
 
@@ -99,22 +102,24 @@ struct sync
 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
 static pthread_cond_t  cond = PTHREAD_COND_INITIALIZER;
 
-/* count allowed, started and waiting threads */
+/* count allowed, started and running threads */
 static int allowed = 0; /** allowed count of threads */
 static int started = 0; /** started count of threads */
-static int waiting = 0; /** waiting count of threads */
+static int running = 0; /** running count of threads */
 static int remains = 0; /** allowed count of waiting jobs */
-static int nevents = 0; /** count of events */
 
 /* list of threads */
 static struct thread *threads;
-static _Thread_local struct thread *current;
+static _Thread_local struct thread *current_thread;
+static _Thread_local struct evloop *current_evloop;
 
 /* queue of pending jobs */
 static struct job *first_job;
-static struct events *first_events;
 static struct job *free_jobs;
 
+/* event loop */
+static struct evloop evloop[1];
+
 /**
  * Create a new job with the given parameters
  * @param group    the group of the job
@@ -124,7 +129,7 @@ static struct job *free_jobs;
  * @return the created job unblock or NULL when no more memory
  */
 static struct job *job_create(
-               void *group,
+               const void *group,
                int timeout,
                job_cb_t callback,
                void *arg)
@@ -163,7 +168,7 @@ end:
  */
 static void job_add(struct job *job)
 {
-       void *group;
+       const void *group;
        struct job *ijob, **pjob;
 
        /* prepare to add */
@@ -196,18 +201,6 @@ static inline struct job *job_get()
        return job;
 }
 
-/**
- * Get the next events to process or NULL if none.
- * @return the first events that isn't running or NULL
- */
-static inline struct events *events_get()
-{
-       struct events *events = first_events;
-       while (events && events->runs)
-               events = events->next;
-       return events;
-}
-
 /**
  * Releases the processed 'job': removes it
  * from the list of jobs and unblock the first
@@ -217,7 +210,7 @@ static inline struct events *events_get()
 static inline void job_release(struct job *job)
 {
        struct job *ijob, **pjob;
-       void *group;
+       const void *group;
 
        /* first unqueue the job */
        pjob = &first_job;
@@ -269,13 +262,41 @@ static void job_cancel(int signum, void *arg)
  *               flow
  * @param arg     the events to run
  */
-static void events_call(int signum, void *arg)
+static void evloop_run(int signum, void *arg)
 {
-       struct events *events = arg;
-       if (!signum)
-               sd_event_run(events->event, events->timeout);
+       int rc;
+       struct sd_event *se;
+       struct evloop *el = arg;
+
+       if (!signum) {
+               se = el->sdev;
+               rc = sd_event_prepare(se);
+               if (rc < 0) {
+                       errno = -rc;
+                       ERROR("sd_event_prepare returned an error (state: %d): %m", sd_event_get_state(se));
+               } else {
+                       if (rc == 0) {
+                               rc = sd_event_wait(se, (uint64_t)(int64_t)-1);
+                               if (rc < 0) {
+                                       errno = -rc;
+                                       ERROR("sd_event_wait returned an error (state: %d): %m", sd_event_get_state(se));
+                               }
+                       }
+                       el->state &= ~(EVLOOP_STATE_WAIT);
+
+                       if (rc > 0) {
+                               rc = sd_event_dispatch(se);
+                               if (rc < 0) {
+                                       errno = -rc;
+                                       ERROR("sd_event_dispatch returned an error (state: %d): %m", sd_event_get_state(se));
+                               }
+                       }
+               }
+       }
+       el->state &= ~(EVLOOP_STATE_WAIT|EVLOOP_STATE_RUN);
 }
 
+
 /**
  * Main processing loop of threads processing jobs.
  * The loop must be called with the mutex locked
@@ -287,30 +308,29 @@ static void thread_run(volatile struct thread *me)
 {
        struct thread **prv;
        struct job *job;
-       struct events *events;
-       uint64_t evto;
+       struct evloop *el;
 
        /* initialize description of itself and link it in the list */
        me->tid = pthread_self();
        me->stop = 0;
-       me->lowered = 0;
        me->waits = 0;
-       me->upper = current;
-       if (current) {
-               current->lowered = 1;
-               evto = EVENT_TIMEOUT_CHILD;
-       } else {
+       me->upper = current_thread;
+       if (!current_thread) {
                started++;
                sig_monitor_init_timeouts();
-               evto = EVENT_TIMEOUT_TOP;
        }
        me->next = threads;
        threads = (struct thread*)me;
-       current = (struct thread*)me;
+       current_thread = (struct thread*)me;
 
        /* loop until stopped */
-       me->events = NULL;
        while (!me->stop) {
+               /* release the event loop */
+               if (current_evloop && !(current_evloop->state & EVLOOP_STATE_RUN)) {
+                       current_evloop->state -= EVLOOP_STATE_LOCK;
+                       current_evloop = NULL;
+               }
+
                /* get a job */
                job = job_get(first_job);
                if (job) {
@@ -326,33 +346,25 @@ static void thread_run(volatile struct thread *me)
 
                        /* release the run job */
                        job_release(job);
-
-                       /* release event if any */
-                       events = me->events;
-                       if (events) {
-                               events->runs = 0;
-                               me->events = NULL;
-                       }
                } else {
                        /* no job, check events */
-                       events = events_get();
-                       if (events) {
+                       el = &evloop[0];
+                       if (el->sdev && !el->state) {
                                /* run the events */
-                               events->runs = 1;
-                               events->timeout = evto;
-                               me->events = events;
+                               el->state = EVLOOP_STATE_LOCK|EVLOOP_STATE_RUN|EVLOOP_STATE_WAIT;
+                               current_evloop = el;
                                pthread_mutex_unlock(&mutex);
-                               sig_monitor(0, events_call, events);
+                               sig_monitor(0, evloop_run, el);
                                pthread_mutex_lock(&mutex);
-                               events->runs = 0;
-                               me->events = NULL;
                        } else {
                                /* no job and not events */
-                               waiting++;
+                               running--;
+                               if (!running)
+                                       ERROR("Entering job deep sleep! Check your bindings.");
                                me->waits = 1;
                                pthread_cond_wait(&cond, &mutex);
                                me->waits = 0;
-                               waiting--;
+                               running++;
                        }
                }
        }
@@ -362,10 +374,8 @@ static void thread_run(volatile struct thread *me)
        while (*prv != me)
                prv = &(*prv)->next;
        *prv = me->next;
-       current = me->upper;
-       if (current) {
-               current->lowered = 0;
-       } else {
+       current_thread = me->upper;
+       if (!current_thread) {
                sig_monitor_clean_timeouts();
                started--;
        }
@@ -381,7 +391,9 @@ static void *thread_main(void *data)
        struct thread me;
 
        pthread_mutex_lock(&mutex);
+       running++;
        thread_run(&me);
+       running--;
        pthread_mutex_unlock(&mutex);
        return NULL;
 }
@@ -422,7 +434,7 @@ static int start_one_thread()
  * @return 0 in case of success or -1 in case of error
  */
 int jobs_queue(
-               void *group,
+               const void *group,
                int timeout,
                void (*callback)(int, void*),
                void *arg)
@@ -449,7 +461,7 @@ int jobs_queue(
        }
 
        /* start a thread if needed */
-       if (waiting == 0 && started < allowed) {
+       if (running == started && started < allowed) {
                /* all threads are busy and a new can be started */
                rc = start_one_thread();
                if (rc < 0 && started == 0) {
@@ -504,7 +516,7 @@ static void call_cb(int signum, void *closure)
  * @see jobs_call, jobs_enter, jobs_leave
  */
 static int do_sync(
-               void *group,
+               const void *group,
                int timeout,
                void (*sync_cb)(int signum, void *closure),
                struct sync *sync
@@ -548,7 +560,7 @@ static int do_sync(
  * @return 0 on success or -1 in case of error
  */
 int jobs_enter(
-               void *group,
+               const void *group,
                int timeout,
                void (*callback)(int signum, void *closure, struct jobloop *jobloop),
                void *closure
@@ -600,7 +612,7 @@ int jobs_leave(struct jobloop *jobloop)
  * @return 0 in case of success or -1 in case of error
  */
 int jobs_call(
-               void *group,
+               const void *group,
                int timeout,
                void (*callback)(int, void*),
                void *arg)
@@ -613,72 +625,83 @@ int jobs_call(
        return do_sync(group, timeout, call_cb, &sync);
 }
 
+/**
+ * Internal callback for evloop management.
+ * The effect of this function is hidden: it exits
+ * the waiting poll if any. Then it wakes up a thread
+ * awaiting the evloop using signal.
+ */
+static int on_evloop_efd(sd_event_source *s, int fd, uint32_t revents, void *userdata)
+{
+       uint64_t x;
+       struct evloop *evloop = userdata;
+       read(evloop->efd, &x, sizeof x);
+       pthread_mutex_lock(&mutex);
+       pthread_cond_broadcast(&evloop->cond);  
+       pthread_mutex_unlock(&mutex);
+       return 1;
+}
+
 /**
  * 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;
+       struct evloop *el;
+       uint64_t x;
        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");
-                                               errno = ENOMEM;
-                                       } else {
-                                               free(events);
-                                               ERROR("creation of sd_event failed: %m");
-                                               events = NULL;
-                                               errno = -rc;
-                                       } 
-                               }
-                       }
+       /* creates the evloop on need */
+       el = &evloop[0];
+       if (!el->sdev) {
+               /* creates the eventfd for waking up polls */
+               el->efd = eventfd(0, EFD_CLOEXEC);
+               if (el->efd < 0) {
+                       ERROR("can't make eventfd for events");
+                       goto error1;
                }
-               if (events) {
-                       /* */
-                       me = current;
-                       if (me) {
-                               events->runs = 1;
-                               me->events = events;
-                       } else {
-                               WARNING("event returned for unknown thread!");
-                       }
+               /* create the systemd event loop */
+               rc = sd_event_new(&el->sdev);
+               if (rc < 0) {
+                       ERROR("can't make new event loop");
+                       goto error2;
+               }
+               /* put the eventfd in the event loop */
+               rc = sd_event_add_io(el->sdev, NULL, el->efd, EPOLLIN, on_evloop_efd, el);
+               if (rc < 0) {
+                       ERROR("can't register eventfd");
+                       sd_event_unref(el->sdev);
+                       el->sdev = NULL;
+error2:
+                       close(el->efd);
+error1:
+                       pthread_mutex_unlock(&mutex);
+                       return NULL;
                }
+               /* terminate creation */
+               el->state = 0;
        }
+
+       /* attach the event loop to the current thread */
+       if (current_evloop != el) {
+               if (current_evloop)
+                       current_evloop->state -= EVLOOP_STATE_LOCK;
+               current_evloop = el;
+               el->state += EVLOOP_STATE_LOCK;
+       }
+
+       /* wait for a modifiable event loop */
+       while (el->state & EVLOOP_STATE_WAIT) {
+               x = 1;
+               write(el->efd, &x, sizeof x);
+               pthread_cond_wait(&el->cond, &mutex);
+       }
+
        pthread_mutex_unlock(&mutex);
-       return events ? events->event : NULL;
+       return el->sdev;
 }
 
 /**
@@ -689,7 +712,7 @@ struct sd_event *jobs_get_sd_event()
  * @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_start(int allowed_count, int start_count, int waiter_count, void (*start)())
+int jobs_start(int allowed_count, int start_count, int waiter_count, void (*start)(int signum))
 {
        int rc, launched;
        struct thread me;
@@ -704,7 +727,7 @@ int jobs_start(int allowed_count, int start_count, int waiter_count, void (*star
        pthread_mutex_lock(&mutex);
 
        /* check whether already running */
-       if (current || allowed) {
+       if (current_thread || allowed) {
                ERROR("thread already started");
                errno = EINVAL;
                goto error;
@@ -719,7 +742,7 @@ int jobs_start(int allowed_count, int start_count, int waiter_count, void (*star
        /* records the allowed count */
        allowed = allowed_count;
        started = 0;
-       waiting = 0;
+       running = 0;
        remains = waiter_count;
 
        /* start at least one thread */
@@ -811,7 +834,7 @@ void jobs_terminate()
                head = job->next;
 
                /* search if job is stacked for current */
-               t = current;
+               t = current_thread;
                while (t && t->job != job)
                        t = t->upper;
                if (t) {