jobs: Refactor exiting jobs
[src/app-framework-binder.git] / src / jobs.c
1 /*
2  * Copyright (C) 2016-2019 "IoT.bzh"
3  * Author José Bollo <jose.bollo@iot.bzh>
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #define _GNU_SOURCE
19
20 #include <stdlib.h>
21 #include <stdint.h>
22 #include <unistd.h>
23 #include <signal.h>
24 #include <string.h>
25 #include <time.h>
26 #include <sys/syscall.h>
27 #include <pthread.h>
28 #include <errno.h>
29 #include <assert.h>
30 #include <sys/eventfd.h>
31
32 #include <systemd/sd-event.h>
33
34 #include "jobs.h"
35 #include "evmgr.h"
36 #include "sig-monitor.h"
37 #include "verbose.h"
38 #include "systemd.h"
39
40 #define EVENT_TIMEOUT_TOP       ((uint64_t)-1)
41 #define EVENT_TIMEOUT_CHILD     ((uint64_t)10000)
42
43 struct thread;
44
45 /** Internal shortcut for callback */
46 typedef void (*job_cb_t)(int, void*);
47
48 /** Description of a pending job */
49 struct job
50 {
51         struct job *next;    /**< link to the next job enqueued */
52         const void *group;   /**< group of the request */
53         job_cb_t callback;   /**< processing callback */
54         void *arg;           /**< argument */
55         int timeout;         /**< timeout in second for processing the request */
56         unsigned blocked: 1; /**< is an other request blocking this one ? */
57         unsigned dropped: 1; /**< is removed ? */
58 };
59
60 /** Description of threads */
61 struct thread
62 {
63         struct thread *next;   /**< next thread of the list */
64         struct thread *upper;  /**< upper same thread */
65         struct thread *nholder;/**< next holder for evloop */
66         pthread_cond_t *cwhold;/**< condition wait for holding */
67         struct job *job;       /**< currently processed job */
68         pthread_t tid;         /**< the thread id */
69         volatile unsigned stop: 1;      /**< stop requested */
70         volatile unsigned waits: 1;     /**< is waiting? */
71         volatile unsigned leaved: 1;    /**< was leaved? */
72 };
73
74 /**
75  * Description of synchronous callback
76  */
77 struct sync
78 {
79         struct thread thread;   /**< thread loop data */
80         union {
81                 void (*callback)(int, void*);   /**< the synchronous callback */
82                 void (*enter)(int signum, void *closure, struct jobloop *jobloop);
83                                 /**< the entering synchronous routine */
84         };
85         void *arg;              /**< the argument of the callback */
86 };
87
88 /* synchronisation of threads */
89 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
90 static pthread_cond_t  cond = PTHREAD_COND_INITIALIZER;
91
92 /* count allowed, started and running threads */
93 static int allowed = 0; /** allowed count of threads */
94 static int started = 0; /** started count of threads */
95 static int running = 0; /** running count of threads */
96 static int remains = 0; /** allowed count of waiting jobs */
97
98 /* list of threads */
99 static struct thread *threads;
100 static _Thread_local struct thread *current_thread;
101
102 /* queue of pending jobs */
103 static struct job *first_job;
104 static struct job *free_jobs;
105
106 /* event loop */
107 static struct evmgr *evmgr;
108
109 static void (*exit_handler)();
110
111 /**
112  * Create a new job with the given parameters
113  * @param group    the group of the job
114  * @param timeout  the timeout of the job (0 if none)
115  * @param callback the function that achieves the job
116  * @param arg      the argument of the callback
117  * @return the created job unblock or NULL when no more memory
118  */
119 static struct job *job_create(
120                 const void *group,
121                 int timeout,
122                 job_cb_t callback,
123                 void *arg)
124 {
125         struct job *job;
126
127         /* try recyle existing job */
128         job = free_jobs;
129         if (job)
130                 free_jobs = job->next;
131         else {
132                 /* allocation without blocking */
133                 pthread_mutex_unlock(&mutex);
134                 job = malloc(sizeof *job);
135                 pthread_mutex_lock(&mutex);
136                 if (!job) {
137                         ERROR("out of memory");
138                         errno = ENOMEM;
139                         goto end;
140                 }
141         }
142         /* initialises the job */
143         job->group = group;
144         job->timeout = timeout;
145         job->callback = callback;
146         job->arg = arg;
147         job->blocked = 0;
148         job->dropped = 0;
149 end:
150         return job;
151 }
152
153 /**
154  * Adds 'job' at the end of the list of jobs, marking it
155  * as blocked if an other job with the same group is pending.
156  * @param job the job to add
157  */
158 static void job_add(struct job *job)
159 {
160         const void *group;
161         struct job *ijob, **pjob;
162
163         /* prepare to add */
164         group = job->group;
165         job->next = NULL;
166
167         /* search end and blockers */
168         pjob = &first_job;
169         ijob = first_job;
170         while (ijob) {
171                 if (group && ijob->group == group)
172                         job->blocked = 1;
173                 pjob = &ijob->next;
174                 ijob = ijob->next;
175         }
176
177         /* queue the jobs */
178         *pjob = job;
179         remains--;
180 }
181
182 /**
183  * Get the next job to process or NULL if none.
184  * @return the first job that isn't blocked or NULL
185  */
186 static inline struct job *job_get()
187 {
188         struct job *job = first_job;
189         while (job && job->blocked)
190                 job = job->next;
191         if (job)
192                 remains++;
193         return job;
194 }
195
196 /**
197  * Releases the processed 'job': removes it
198  * from the list of jobs and unblock the first
199  * pending job of the same group if any.
200  * @param job the job to release
201  */
202 static inline void job_release(struct job *job)
203 {
204         struct job *ijob, **pjob;
205         const void *group;
206
207         /* first unqueue the job */
208         pjob = &first_job;
209         ijob = first_job;
210         while (ijob != job) {
211                 pjob = &ijob->next;
212                 ijob = ijob->next;
213         }
214         *pjob = job->next;
215
216         /* then unblock jobs of the same group */
217         group = job->group;
218         if (group) {
219                 ijob = job->next;
220                 while (ijob && ijob->group != group)
221                         ijob = ijob->next;
222                 if (ijob)
223                         ijob->blocked = 0;
224         }
225
226         /* recycle the job */
227         job->next = free_jobs;
228         free_jobs = job;
229 }
230
231 /**
232  * Monitored cancel callback for a job.
233  * This function is called by the monitor
234  * to cancel the job when the safe environment
235  * is set.
236  * @param signum 0 on normal flow or the number
237  *               of the signal that interrupted the normal
238  *               flow, isn't used
239  * @param arg    the job to run
240  */
241 __attribute__((unused))
242 static void job_cancel(int signum, void *arg)
243 {
244         struct job *job = arg;
245         job->callback(SIGABRT, job->arg);
246 }
247
248 /**
249  * wakeup the event loop if needed by sending
250  * an event.
251  */
252 static void evloop_wakeup()
253 {
254         if (evmgr)
255                 evmgr_wakeup(evmgr);
256 }
257
258 /**
259  * Release the currently held event loop
260  */
261 static void evloop_release()
262 {
263         struct thread *nh, *ct = current_thread;
264
265         if (ct && evmgr && evmgr_release_if(evmgr, ct)) {
266                 nh = ct->nholder;
267                 ct->nholder = 0;
268                 if (nh) {
269                         evmgr_try_hold(evmgr, nh);
270                         pthread_cond_signal(nh->cwhold);
271                 }
272         }
273 }
274
275 /**
276  * get the eventloop for the current thread
277  */
278 static int evloop_get()
279 {
280         return evmgr && evmgr_try_hold(evmgr, current_thread);
281 }
282
283 /**
284  * acquire the eventloop for the current thread
285  */
286 static void evloop_acquire()
287 {
288         struct thread *pwait, *ct;
289         pthread_cond_t cond;
290
291         /* try to get the evloop */
292         if (!evloop_get()) {
293                 /* failed, init waiting state */
294                 ct = current_thread;
295                 ct->nholder = NULL;
296                 ct->cwhold = &cond;
297                 pthread_cond_init(&cond, NULL);
298
299                 /* queue current thread in holder list */
300                 pwait = evmgr_holder(evmgr);
301                 while (pwait->nholder)
302                         pwait = pwait->nholder;
303                 pwait->nholder = ct;
304
305                 /* wake up the evloop */
306                 evloop_wakeup();
307
308                 /* wait to acquire the evloop */
309                 pthread_cond_wait(&cond, &mutex);
310                 pthread_cond_destroy(&cond);
311         }
312 }
313
314 /**
315  * Enter the thread
316  * @param me the description of the thread to enter
317  */
318 static void thread_enter(volatile struct thread *me)
319 {
320         evloop_release();
321         /* initialize description of itself and link it in the list */
322         me->tid = pthread_self();
323         me->stop = 0;
324         me->waits = 0;
325         me->leaved = 0;
326         me->nholder = 0;
327         me->upper = current_thread;
328         me->next = threads;
329         threads = (struct thread*)me;
330         current_thread = (struct thread*)me;
331 }
332
333 /**
334  * leave the thread
335  * @param me the description of the thread to leave
336  */
337 static void thread_leave()
338 {
339         struct thread **prv, *me;
340
341         /* unlink the current thread and cleanup */
342         me = current_thread;
343         prv = &threads;
344         while (*prv != me)
345                 prv = &(*prv)->next;
346         *prv = me->next;
347
348         current_thread = me->upper;
349 }
350
351 /**
352  * Main processing loop of internal threads with processing jobs.
353  * The loop must be called with the mutex locked
354  * and it returns with the mutex locked.
355  * @param me the description of the thread to use
356  * TODO: how are timeout handled when reentering?
357  */
358 static void thread_run_internal(volatile struct thread *me)
359 {
360         struct job *job;
361
362         /* enter thread */
363         thread_enter(me);
364
365         /* loop until stopped */
366         while (!me->stop) {
367                 /* release the current event loop */
368                 evloop_release();
369
370                 /* get a job */
371                 job = job_get();
372                 if (job) {
373                         /* prepare running the job */
374                         job->blocked = 1; /* mark job as blocked */
375                         me->job = job; /* record the job (only for terminate) */
376
377                         /* run the job */
378                         pthread_mutex_unlock(&mutex);
379                         sig_monitor(job->timeout, job->callback, job->arg);
380                         pthread_mutex_lock(&mutex);
381
382                         /* release the run job */
383                         job_release(job);
384                 /* no job, check event loop wait */
385                 } else if (evloop_get()) {
386                         if (!evmgr_can_run(evmgr)) {
387                                 /* busy ? */
388                                 CRITICAL("Can't enter dispatch while in dispatch!");
389                                 abort();
390                         }
391                         /* run the events */
392                         pthread_mutex_unlock(&mutex);
393                         sig_monitor(0, (void(*)(int,void*))evmgr_job_run, evmgr);
394                         pthread_mutex_lock(&mutex);
395                 } else {
396                         /* no job and no event loop */
397                         running--;
398                         if (!running)
399                                 ERROR("Entering job deep sleep! Check your bindings.");
400                         me->waits = 1;
401                         pthread_cond_wait(&cond, &mutex);
402                         me->waits = 0;
403                         running++;
404                 }
405         }
406         /* cleanup */
407         evloop_release();
408         thread_leave();
409 }
410
411 /**
412  * Main processing loop of external threads.
413  * The loop must be called with the mutex locked
414  * and it returns with the mutex locked.
415  * @param me the description of the thread to use
416  */
417 static void thread_run_external(volatile struct thread *me)
418 {
419         /* enter thread */
420         thread_enter(me);
421
422         /* loop until stopped */
423         me->waits = 1;
424         while (!me->stop)
425                 pthread_cond_wait(&cond, &mutex);
426         me->waits = 0;
427         thread_leave();
428 }
429
430 /**
431  * Root for created threads.
432  */
433 static void thread_main()
434 {
435         struct thread me;
436
437         running++;
438         started++;
439         sig_monitor_init_timeouts();
440         thread_run_internal(&me);
441         sig_monitor_clean_timeouts();
442         started--;
443         running--;
444 }
445
446 /**
447  * Entry point for created threads.
448  * @param data not used
449  * @return NULL
450  */
451 static void *thread_starter(void *data)
452 {
453         pthread_mutex_lock(&mutex);
454         thread_main();
455         pthread_mutex_unlock(&mutex);
456         return NULL;
457 }
458
459 /**
460  * Starts a new thread
461  * @return 0 in case of success or -1 in case of error
462  */
463 static int start_one_thread()
464 {
465         pthread_t tid;
466         int rc;
467
468         rc = pthread_create(&tid, NULL, thread_starter, NULL);
469         if (rc != 0) {
470                 /* errno = rc; */
471                 WARNING("not able to start thread: %m");
472                 rc = -1;
473         }
474         return rc;
475 }
476
477 /**
478  * Queues a new asynchronous job represented by 'callback' and 'arg'
479  * for the 'group' and the 'timeout'.
480  * Jobs are queued FIFO and are possibly executed in parallel
481  * concurrently except for job of the same group that are
482  * executed sequentially in FIFO order.
483  * @param group    The group of the job or NULL when no group.
484  * @param timeout  The maximum execution time in seconds of the job
485  *                 or 0 for unlimited time.
486  * @param callback The function to execute for achieving the job.
487  *                 Its first parameter is either 0 on normal flow
488  *                 or the signal number that broke the normal flow.
489  *                 The remaining parameter is the parameter 'arg1'
490  *                 given here.
491  * @param arg      The second argument for 'callback'
492  * @param start    Allow to start a thread if not zero
493  * @return 0 in case of success or -1 in case of error
494  */
495 static int queue_job(
496                 const void *group,
497                 int timeout,
498                 void (*callback)(int, void*),
499                 void *arg,
500                 int start)
501 {
502         struct job *job;
503         int rc;
504
505         pthread_mutex_lock(&mutex);
506
507         /* allocates the job */
508         job = job_create(group, timeout, callback, arg);
509         if (!job)
510                 goto error;
511
512         /* check availability */
513         if (remains <= 0) {
514                 ERROR("can't process job with threads: too many jobs");
515                 errno = EBUSY;
516                 goto error2;
517         }
518
519         /* start a thread if needed */
520         if (start && running == started && started < allowed) {
521                 /* all threads are busy and a new can be started */
522                 rc = start_one_thread();
523                 if (rc < 0 && started == 0) {
524                         ERROR("can't start initial thread: %m");
525                         goto error2;
526                 }
527         }
528
529         /* queues the job */
530         job_add(job);
531
532         /* signal an existing job */
533         pthread_cond_signal(&cond);
534         pthread_mutex_unlock(&mutex);
535         return 0;
536
537 error2:
538         job->next = free_jobs;
539         free_jobs = job;
540 error:
541         pthread_mutex_unlock(&mutex);
542         return -1;
543 }
544
545 /**
546  * Queues a new asynchronous job represented by 'callback' and 'arg'
547  * for the 'group' and the 'timeout'.
548  * Jobs are queued FIFO and are possibly executed in parallel
549  * concurrently except for job of the same group that are
550  * executed sequentially in FIFO order.
551  * @param group    The group of the job or NULL when no group.
552  * @param timeout  The maximum execution time in seconds of the job
553  *                 or 0 for unlimited time.
554  * @param callback The function to execute for achieving the job.
555  *                 Its first parameter is either 0 on normal flow
556  *                 or the signal number that broke the normal flow.
557  *                 The remaining parameter is the parameter 'arg1'
558  *                 given here.
559  * @param arg      The second argument for 'callback'
560  * @return 0 in case of success or -1 in case of error
561  */
562 int jobs_queue(
563                 const void *group,
564                 int timeout,
565                 void (*callback)(int, void*),
566                 void *arg)
567 {
568         return queue_job(group, timeout, callback, arg, 1);
569 }
570
571 /**
572  * Internal helper function for 'jobs_enter'.
573  * @see jobs_enter, jobs_leave
574  */
575 static void enter_cb(int signum, void *closure)
576 {
577         struct sync *sync = closure;
578         sync->enter(signum, sync->arg, (void*)&sync->thread);
579 }
580
581 /**
582  * Internal helper function for 'jobs_call'.
583  * @see jobs_call
584  */
585 static void call_cb(int signum, void *closure)
586 {
587         struct sync *sync = closure;
588         sync->callback(signum, sync->arg);
589         jobs_leave((void*)&sync->thread);
590 }
591
592 /**
593  * Internal helper for synchronous jobs. It enters
594  * a new thread loop for evaluating the given job
595  * as recorded by the couple 'sync_cb' and 'sync'.
596  * @see jobs_call, jobs_enter, jobs_leave
597  */
598 static int do_sync(
599                 const void *group,
600                 int timeout,
601                 void (*sync_cb)(int signum, void *closure),
602                 struct sync *sync
603 )
604 {
605         struct job *job;
606
607         pthread_mutex_lock(&mutex);
608
609         /* allocates the job */
610         job = job_create(group, timeout, sync_cb, sync);
611         if (!job) {
612                 pthread_mutex_unlock(&mutex);
613                 return -1;
614         }
615
616         /* queues the job */
617         job_add(job);
618
619         /* run until stopped */
620         if (current_thread)
621                 thread_run_internal(&sync->thread);
622         else
623                 thread_run_external(&sync->thread);
624         pthread_mutex_unlock(&mutex);
625         if (sync->thread.leaved)
626                 return 0;
627         errno = EINTR;
628         return -1;
629 }
630
631 /**
632  * Enter a synchronisation point: activates the job given by 'callback'
633  * and 'closure' using 'group' and 'timeout' to control sequencing and
634  * execution time.
635  * @param group the group for sequencing jobs
636  * @param timeout the time in seconds allocated to the job
637  * @param callback the callback that will handle the job.
638  *                 it receives 3 parameters: 'signum' that will be 0
639  *                 on normal flow or the catched signal number in case
640  *                 of interrupted flow, the context 'closure' as given and
641  *                 a 'jobloop' reference that must be used when the job is
642  *                 terminated to unlock the current execution flow.
643  * @param closure the argument to the callback
644  * @return 0 on success or -1 in case of error
645  */
646 int jobs_enter(
647                 const void *group,
648                 int timeout,
649                 void (*callback)(int signum, void *closure, struct jobloop *jobloop),
650                 void *closure
651 )
652 {
653         struct sync sync;
654
655         sync.enter = callback;
656         sync.arg = closure;
657         return do_sync(group, timeout, enter_cb, &sync);
658 }
659
660 /**
661  * Unlocks the execution flow designed by 'jobloop'.
662  * @param jobloop indication of the flow to unlock
663  * @return 0 in case of success of -1 on error
664  */
665 int jobs_leave(struct jobloop *jobloop)
666 {
667         struct thread *t;
668
669         pthread_mutex_lock(&mutex);
670         t = threads;
671         while (t && t != (struct thread*)jobloop)
672                 t = t->next;
673         if (!t) {
674                 errno = EINVAL;
675         } else {
676                 t->leaved = 1;
677                 t->stop = 1;
678                 if (t->waits)
679                         pthread_cond_broadcast(&cond);
680                 else
681                         evloop_wakeup();
682         }
683         pthread_mutex_unlock(&mutex);
684         return -!t;
685 }
686
687 /**
688  * Calls synchronously the job represented by 'callback' and 'arg1'
689  * for the 'group' and the 'timeout' and waits for its completion.
690  * @param group    The group of the job or NULL when no group.
691  * @param timeout  The maximum execution time in seconds of the job
692  *                 or 0 for unlimited time.
693  * @param callback The function to execute for achieving the job.
694  *                 Its first parameter is either 0 on normal flow
695  *                 or the signal number that broke the normal flow.
696  *                 The remaining parameter is the parameter 'arg1'
697  *                 given here.
698  * @param arg      The second argument for 'callback'
699  * @return 0 in case of success or -1 in case of error
700  */
701 int jobs_call(
702                 const void *group,
703                 int timeout,
704                 void (*callback)(int, void*),
705                 void *arg)
706 {
707         struct sync sync;
708
709         sync.callback = callback;
710         sync.arg = arg;
711
712         return do_sync(group, timeout, call_cb, &sync);
713 }
714
715 /**
716  * Ensure that the current running thread can control the event loop.
717  */
718 void jobs_acquire_event_manager()
719 {
720         struct thread lt;
721
722         /* ensure an existing thread environment */
723         if (!current_thread) {
724                 memset(&lt, 0, sizeof lt);
725                 current_thread = &lt;
726         }
727
728         /* lock */
729         pthread_mutex_lock(&mutex);
730
731         /* creates the evloop on need */
732         if (!evmgr)
733                 evmgr_create(&evmgr);
734
735         /* acquire the event loop under lock */
736         if (evmgr)
737                 evloop_acquire();
738
739         /* unlock */
740         pthread_mutex_unlock(&mutex);
741
742         /* release the faked thread environment if needed */
743         if (current_thread == &lt) {
744                 /*
745                  * Releasing it is needed because there is no way to guess
746                  * when it has to be released really. But here is where it is
747                  * hazardous: if the caller modifies the eventloop when it
748                  * is waiting, there is no way to make the change effective.
749                  * A workaround to achieve that goal is for the caller to
750                  * require the event loop a second time after having modified it.
751                  */
752                 NOTICE("Requiring event manager/loop from outside of binder's callback is hazardous!");
753                 if (verbose_wants(Log_Level_Info))
754                         sig_monitor_dumpstack();
755                 evloop_release();
756                 current_thread = NULL;
757         }
758 }
759
760 /**
761  * Enter the jobs processing loop.
762  * @param allowed_count Maximum count of thread for jobs including this one
763  * @param start_count   Count of thread to start now, must be lower.
764  * @param waiter_count  Maximum count of jobs that can be waiting.
765  * @param start         The start routine to activate (can't be NULL)
766  * @return 0 in case of success or -1 in case of error.
767  */
768 int jobs_start(int allowed_count, int start_count, int waiter_count, void (*start)(int signum, void* arg), void *arg)
769 {
770         int rc, launched;
771         struct job *job;
772
773         assert(allowed_count >= 1);
774         assert(start_count >= 0);
775         assert(waiter_count > 0);
776         assert(start_count <= allowed_count);
777
778         rc = -1;
779         pthread_mutex_lock(&mutex);
780
781         /* check whether already running */
782         if (current_thread || allowed) {
783                 ERROR("thread already started");
784                 errno = EINVAL;
785                 goto error;
786         }
787
788         /* records the allowed count */
789         allowed = allowed_count;
790         started = 0;
791         running = 0;
792         remains = waiter_count;
793
794         /* start at least one thread: the current one */
795         launched = 1;
796         while (launched < start_count) {
797                 if (start_one_thread() != 0) {
798                         ERROR("Not all threads can be started");
799                         goto error;
800                 }
801                 launched++;
802         }
803
804         /* queue the start job */
805         job = job_create(NULL, 0, start, arg);
806         if (!job)
807                 goto error;
808         job_add(job);
809
810         /* run until end */
811         thread_main();
812         rc = 0;
813 error:
814         pthread_mutex_unlock(&mutex);
815         if (exit_handler)
816                 exit_handler();
817         return rc;
818 }
819
820 /**
821  * Exit jobs threads and call handler if not NULL.
822  */
823 void jobs_exit(void (*handler)())
824 {
825         struct thread *t;
826
827         /* request all threads to stop */
828         pthread_mutex_lock(&mutex);
829
830         /* set the handler */
831         exit_handler = handler;
832
833         /* stops the threads */
834         t = threads;
835         while (t) {
836                 t->stop = 1;
837                 t = t->next;
838         }
839
840         /* wait the threads */
841         pthread_cond_broadcast(&cond);
842
843         /* leave */
844         pthread_mutex_unlock(&mutex);
845 }