blob: 859aea385b88f78b43405098f3699ef52ff129db [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreau24f4efa2010-08-27 17:56:48 +02002 * include/proto/task.h
3 * Functions for task management.
4 *
5 * Copyright (C) 2000-2010 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
Willy Tarreaubaaee002006-06-26 02:48:02 +020021
22#ifndef _PROTO_TASK_H
23#define _PROTO_TASK_H
24
25
26#include <sys/time.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020027
28#include <common/config.h>
Willy Tarreau2dd0d472006-06-29 17:53:05 +020029#include <common/memory.h>
Willy Tarreau96bcfd72007-04-29 10:41:56 +020030#include <common/mini-clist.h>
31#include <common/standard.h>
Willy Tarreaud0a201b2009-03-08 15:53:06 +010032#include <common/ticks.h>
Emeric Brunc60def82017-09-27 14:59:38 +020033#include <common/hathreads.h>
34
Willy Tarreau8d388052017-11-05 13:34:20 +010035#include <eb32sctree.h>
Willy Tarreau45cb4fb2009-10-26 21:10:04 +010036#include <eb32tree.h>
Willy Tarreau96bcfd72007-04-29 10:41:56 +020037
Willy Tarreaueb118892014-11-13 16:57:19 +010038#include <types/global.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020039#include <types/task.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020040
Willy Tarreaud0a201b2009-03-08 15:53:06 +010041/* Principle of the wait queue.
42 *
43 * We want to be able to tell whether an expiration date is before of after the
44 * current time <now>. We KNOW that expiration dates are never too far apart,
45 * because they are measured in ticks (milliseconds). We also know that almost
46 * all dates will be in the future, and that a very small part of them will be
47 * in the past, they are the ones which have expired since last time we checked
48 * them. Using ticks, we know if a date is in the future or in the past, but we
49 * cannot use that to store sorted information because that reference changes
50 * all the time.
51 *
Willy Tarreaue35c94a2009-03-21 10:01:42 +010052 * We'll use the fact that the time wraps to sort timers. Timers above <now>
53 * are in the future, timers below <now> are in the past. Here, "above" and
54 * "below" are to be considered modulo 2^31.
Willy Tarreaud0a201b2009-03-08 15:53:06 +010055 *
Willy Tarreaue35c94a2009-03-21 10:01:42 +010056 * Timers are stored sorted in an ebtree. We use the new ability for ebtrees to
57 * lookup values starting from X to only expire tasks between <now> - 2^31 and
58 * <now>. If the end of the tree is reached while walking over it, we simply
59 * loop back to the beginning. That way, we have no problem keeping sorted
60 * wrapping timers in a tree, between (now - 24 days) and (now + 24 days). The
61 * keys in the tree always reflect their real position, none can be infinite.
62 * This reduces the number of checks to be performed.
Willy Tarreaud0a201b2009-03-08 15:53:06 +010063 *
64 * Another nice optimisation is to allow a timer to stay at an old place in the
65 * queue as long as it's not further than the real expiration date. That way,
66 * we use the tree as a place holder for a minorant of the real expiration
67 * date. Since we have a very low chance of hitting a timeout anyway, we can
68 * bounce the nodes to their right place when we scan the tree if we encounter
69 * a misplaced node once in a while. This even allows us not to remove the
70 * infinite timers from the wait queue.
71 *
72 * So, to summarize, we have :
73 * - node->key always defines current position in the wait queue
74 * - timer is the real expiration date (possibly infinite)
Willy Tarreaue35c94a2009-03-21 10:01:42 +010075 * - node->key is always before or equal to timer
Willy Tarreaud0a201b2009-03-08 15:53:06 +010076 *
77 * The run queue works similarly to the wait queue except that the current date
78 * is replaced by an insertion counter which can also wrap without any problem.
79 */
80
Willy Tarreaue35c94a2009-03-21 10:01:42 +010081/* The farthest we can look back in a timer tree */
82#define TIMER_LOOK_BACK (1U << 31)
Willy Tarreaud0a201b2009-03-08 15:53:06 +010083
84/* a few exported variables */
Willy Tarreaua4613182009-03-21 18:13:21 +010085extern unsigned int nb_tasks; /* total number of tasks */
Olivier Houchard9b03c0c2018-07-26 18:45:22 +020086extern volatile unsigned long active_tasks_mask; /* Mask of threads with active tasks */
Christopher Faulet34c5cc92016-12-06 09:15:30 +010087extern unsigned int tasks_run_queue; /* run queue size */
88extern unsigned int tasks_run_queue_cur;
Willy Tarreauc7bdf092009-03-21 18:33:52 +010089extern unsigned int nb_tasks_cur;
Willy Tarreau91e99932008-06-30 07:51:00 +020090extern unsigned int niced_tasks; /* number of niced tasks in the run queue */
Willy Tarreaubafbe012017-11-24 17:34:44 +010091extern struct pool_head *pool_head_task;
Olivier Houchardb0bdae72018-05-18 18:45:28 +020092extern struct pool_head *pool_head_tasklet;
Willy Tarreaubafbe012017-11-24 17:34:44 +010093extern struct pool_head *pool_head_notification;
Olivier Houchard9b36cb42018-05-04 15:46:16 +020094extern THREAD_LOCAL struct task *curr_task; /* task currently running or NULL */
Olivier Houchardb1ca58b2018-06-06 14:22:03 +020095#ifdef USE_THREAD
Willy Tarreaub20aa9e2018-10-15 14:52:21 +020096extern struct eb_root timers; /* sorted timers tree, global */
Olivier Houchardf6e6dc12018-05-18 18:38:23 +020097extern struct eb_root rqueue; /* tree constituting the run queue */
Olivier Houchard77551ee2018-07-26 15:59:38 +020098extern int global_rqueue_size; /* Number of element sin the global runqueue */
Olivier Houchardb1ca58b2018-06-06 14:22:03 +020099#endif
Olivier Houchard77551ee2018-07-26 15:59:38 +0200100
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200101extern struct task_per_thread task_per_thread[MAX_THREADS];
Christopher Faulet9dcf9b62017-11-13 10:34:01 +0100102
103__decl_hathreads(extern HA_SPINLOCK_T rq_lock); /* spin lock related to run queue */
104__decl_hathreads(extern HA_SPINLOCK_T wq_lock); /* spin lock related to wait queue */
Willy Tarreauc6ca1a02007-05-13 19:43:47 +0200105
Olivier Houchard5d187182018-08-01 15:58:44 +0200106
107static inline void task_insert_into_tasklet_list(struct task *t);
108
Willy Tarreau4726f532009-03-07 17:25:21 +0100109/* return 0 if task is in run queue, otherwise non-zero */
110static inline int task_in_rq(struct task *t)
111{
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200112 /* Check if leaf_p is NULL, in case he's not in the runqueue, and if
113 * it's not 0x1, which would mean it's in the tasklet list.
114 */
Olivier Houchard4a1be0c2019-04-17 19:13:07 +0200115 return t->rq.node.leaf_p != NULL;
Willy Tarreau4726f532009-03-07 17:25:21 +0100116}
117
118/* return 0 if task is in wait queue, otherwise non-zero */
119static inline int task_in_wq(struct task *t)
120{
121 return t->wq.node.leaf_p != NULL;
122}
123
Willy Tarreaufdccded2008-08-29 18:19:04 +0200124/* puts the task <t> in run queue with reason flags <f>, and returns <t> */
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200125/* This will put the task in the local runqueue if the task is only runnable
126 * by the current thread, in the global runqueue otherwies.
127 */
128void __task_wakeup(struct task *t, struct eb_root *);
129static inline void task_wakeup(struct task *t, unsigned int f)
Willy Tarreau4df82062008-08-29 15:26:14 +0200130{
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200131 unsigned short state;
Emeric Brunc60def82017-09-27 14:59:38 +0200132
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200133#ifdef USE_THREAD
134 struct eb_root *root;
Emeric Brunc60def82017-09-27 14:59:38 +0200135
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200136 if (t->thread_mask == tid_bit || global.nbthread == 1)
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200137 root = &task_per_thread[tid].rqueue;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200138 else
139 root = &rqueue;
140#else
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200141 struct eb_root *root = &task_per_thread[tid].rqueue;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200142#endif
143
Willy Tarreaub0380072019-04-17 11:47:18 +0200144 state = _HA_ATOMIC_OR(&t->state, f);
145 while (!(state & (TASK_RUNNING | TASK_QUEUED))) {
Willy Tarreau8c12e2f2019-04-17 20:52:51 +0200146 if (_HA_ATOMIC_CAS(&t->state, &state, state | TASK_QUEUED)) {
147 __task_wakeup(t, root);
Willy Tarreaub0380072019-04-17 11:47:18 +0200148 break;
Willy Tarreau8c12e2f2019-04-17 20:52:51 +0200149 }
Willy Tarreaub0380072019-04-17 11:47:18 +0200150 }
Willy Tarreau4df82062008-08-29 15:26:14 +0200151}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200152
Willy Tarreauf65610a2017-10-31 16:06:06 +0100153/* change the thread affinity of a task to <thread_mask> */
Emeric Brunc60def82017-09-27 14:59:38 +0200154static inline void task_set_affinity(struct task *t, unsigned long thread_mask)
155{
Willy Tarreauf65610a2017-10-31 16:06:06 +0100156 t->thread_mask = thread_mask;
Emeric Brunc60def82017-09-27 14:59:38 +0200157}
Willy Tarreauf65610a2017-10-31 16:06:06 +0100158
Willy Tarreau4726f532009-03-07 17:25:21 +0100159/*
160 * Unlink the task from the wait queue, and possibly update the last_timer
161 * pointer. A pointer to the task itself is returned. The task *must* already
162 * be in the wait queue before calling this function. If unsure, use the safer
163 * task_unlink_wq() function.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200164 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100165static inline struct task *__task_unlink_wq(struct task *t)
166{
167 eb32_delete(&t->wq);
Willy Tarreau4726f532009-03-07 17:25:21 +0100168 return t;
169}
170
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200171/* remove a task from its wait queue. It may either be the local wait queue if
172 * the task is bound to a single thread (in which case there's no locking
173 * involved) or the global queue, with locking.
174 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100175static inline struct task *task_unlink_wq(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200176{
Richard Russobc9d9842019-02-20 12:43:45 -0800177 unsigned long locked;
178
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200179 if (likely(task_in_wq(t))) {
Richard Russobc9d9842019-02-20 12:43:45 -0800180 locked = atleast2(t->thread_mask);
181 if (locked)
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200182 HA_SPIN_LOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreau4726f532009-03-07 17:25:21 +0100183 __task_unlink_wq(t);
Richard Russobc9d9842019-02-20 12:43:45 -0800184 if (locked)
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200185 HA_SPIN_UNLOCK(TASK_WQ_LOCK, &wq_lock);
186 }
Willy Tarreau96bcfd72007-04-29 10:41:56 +0200187 return t;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200188}
189
190/*
Christopher Faulet34c5cc92016-12-06 09:15:30 +0100191 * Unlink the task from the run queue. The tasks_run_queue size and number of
192 * niced tasks are updated too. A pointer to the task itself is returned. The
193 * task *must* already be in the run queue before calling this function. If
194 * unsure, use the safer task_unlink_rq() function. Note that the pointer to the
195 * next run queue entry is neither checked nor updated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200196 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100197static inline struct task *__task_unlink_rq(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200198{
Olivier Houchard4c2832852019-03-08 18:48:47 +0100199 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchard77551ee2018-07-26 15:59:38 +0200200#ifdef USE_THREAD
201 if (t->state & TASK_GLOBAL) {
Olivier Houchard4c2832852019-03-08 18:48:47 +0100202 _HA_ATOMIC_AND(&t->state, ~TASK_GLOBAL);
Olivier Houchard77551ee2018-07-26 15:59:38 +0200203 global_rqueue_size--;
204 } else
205#endif
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200206 task_per_thread[tid].rqueue_size--;
Olivier Houchard77551ee2018-07-26 15:59:38 +0200207 eb32sc_delete(&t->rq);
Willy Tarreau4726f532009-03-07 17:25:21 +0100208 if (likely(t->nice))
Olivier Houchard4c2832852019-03-08 18:48:47 +0100209 _HA_ATOMIC_SUB(&niced_tasks, 1);
Willy Tarreauce44f122008-07-05 18:16:19 +0200210 return t;
211}
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200212
Willy Tarreau501260b2015-02-23 16:07:01 +0100213/* This function unlinks task <t> from the run queue if it is in it. It also
214 * takes care of updating the next run queue task if it was this task.
215 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100216static inline struct task *task_unlink_rq(struct task *t)
217{
Olivier Houchard1d7f37a2019-03-14 16:14:04 +0100218 int is_global = t->state & TASK_GLOBAL;
219
220 if (is_global)
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200221 HA_SPIN_LOCK(TASK_RQ_LOCK, &rq_lock);
Willy Tarreau24f382f2019-04-12 16:10:55 +0200222 if (likely(task_in_rq(t)))
Willy Tarreau4726f532009-03-07 17:25:21 +0100223 __task_unlink_rq(t);
Olivier Houchard1d7f37a2019-03-14 16:14:04 +0100224 if (is_global)
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200225 HA_SPIN_UNLOCK(TASK_RQ_LOCK, &rq_lock);
Willy Tarreau4726f532009-03-07 17:25:21 +0100226 return t;
227}
228
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200229static inline void tasklet_wakeup(struct tasklet *tl)
230{
Olivier Houcharde17c2d32018-07-17 18:29:22 +0200231 if (!LIST_ISEMPTY(&tl->list))
232 return;
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200233 LIST_ADDQ(&task_per_thread[tid].task_list, &tl->list);
234 task_per_thread[tid].task_list_size++;
Olivier Houchard4c2832852019-03-08 18:48:47 +0100235 _HA_ATOMIC_OR(&active_tasks_mask, tid_bit);
236 _HA_ATOMIC_ADD(&tasks_run_queue, 1);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200237
238}
239
240static inline void task_insert_into_tasklet_list(struct task *t)
241{
242 struct tasklet *tl;
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200243
Olivier Houchard4c2832852019-03-08 18:48:47 +0100244 _HA_ATOMIC_ADD(&tasks_run_queue, 1);
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200245 task_per_thread[tid].task_list_size++;
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200246 tl = (struct tasklet *)t;
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200247 LIST_ADDQ(&task_per_thread[tid].task_list, &tl->list);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200248}
249
Willy Tarreaue73256f2019-03-25 18:02:54 +0100250/* remove the task from the tasklet list. The task MUST already be there. If
251 * unsure, use task_remove_from_task_list() instead.
252 */
253static inline void __task_remove_from_tasklet_list(struct task *t)
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200254{
Willy Tarreaub238b122019-03-06 19:34:25 +0100255 LIST_DEL_INIT(&((struct tasklet *)t)->list);
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200256 task_per_thread[tid].task_list_size--;
Olivier Houchard4c2832852019-03-08 18:48:47 +0100257 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200258}
259
Willy Tarreaue73256f2019-03-25 18:02:54 +0100260static inline void task_remove_from_tasklet_list(struct task *t)
261{
262 if (likely(!LIST_ISEMPTY(&((struct tasklet *)t)->list)))
263 __task_remove_from_tasklet_list(t);
264}
265
Willy Tarreauce44f122008-07-05 18:16:19 +0200266/*
Willy Tarreaua4613182009-03-21 18:13:21 +0100267 * Initialize a new task. The bare minimum is performed (queue pointers and
268 * state). The task is returned. This function should not be used outside of
269 * task_new().
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200270 */
Emeric Brunc60def82017-09-27 14:59:38 +0200271static inline struct task *task_init(struct task *t, unsigned long thread_mask)
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200272{
Willy Tarreau4726f532009-03-07 17:25:21 +0100273 t->wq.node.leaf_p = NULL;
274 t->rq.node.leaf_p = NULL;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200275 t->state = TASK_SLEEPING;
Willy Tarreauf65610a2017-10-31 16:06:06 +0100276 t->thread_mask = thread_mask;
Willy Tarreau91e99932008-06-30 07:51:00 +0200277 t->nice = 0;
Willy Tarreau3884cba2009-03-28 17:54:35 +0100278 t->calls = 0;
Willy Tarreau9efd7452018-05-31 14:48:54 +0200279 t->call_date = 0;
280 t->cpu_time = 0;
281 t->lat_time = 0;
Willy Tarreauf4219992017-07-24 17:52:58 +0200282 t->expire = TICK_ETERNITY;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200283 return t;
284}
285
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200286static inline void tasklet_init(struct tasklet *t)
287{
288 t->nice = -32768;
289 t->calls = 0;
290 t->state = 0;
Olivier Houchard9ddaf792018-07-19 16:02:16 +0200291 t->process = NULL;
Olivier Houcharddcd6f3a2018-06-08 17:08:19 +0200292 LIST_INIT(&t->list);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200293}
294
295static inline struct tasklet *tasklet_new(void)
296{
297 struct tasklet *t = pool_alloc(pool_head_tasklet);
298
299 if (t) {
300 tasklet_init(t);
301 }
302 return t;
303}
304
Willy Tarreaubaaee002006-06-26 02:48:02 +0200305/*
Willy Tarreaua4613182009-03-21 18:13:21 +0100306 * Allocate and initialise a new task. The new task is returned, or NULL in
307 * case of lack of memory. The task count is incremented. Tasks should only
308 * be allocated this way, and must be freed using task_free().
309 */
Emeric Brunc60def82017-09-27 14:59:38 +0200310static inline struct task *task_new(unsigned long thread_mask)
Willy Tarreaua4613182009-03-21 18:13:21 +0100311{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100312 struct task *t = pool_alloc(pool_head_task);
Willy Tarreaua4613182009-03-21 18:13:21 +0100313 if (t) {
Olivier Houchard4c2832852019-03-08 18:48:47 +0100314 _HA_ATOMIC_ADD(&nb_tasks, 1);
Emeric Brunc60def82017-09-27 14:59:38 +0200315 task_init(t, thread_mask);
Willy Tarreaua4613182009-03-21 18:13:21 +0100316 }
317 return t;
318}
319
320/*
321 * Free a task. Its context must have been freed since it will be lost.
322 * The task count is decremented.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200323 */
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200324static inline void __task_free(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200325{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100326 pool_free(pool_head_task, t);
Willy Tarreaueb118892014-11-13 16:57:19 +0100327 if (unlikely(stopping))
Willy Tarreaubafbe012017-11-24 17:34:44 +0100328 pool_flush(pool_head_task);
Olivier Houchard4c2832852019-03-08 18:48:47 +0100329 _HA_ATOMIC_SUB(&nb_tasks, 1);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200330}
331
Olivier Houchard3f795f72019-04-17 22:51:06 +0200332static inline void task_destroy(struct task *t)
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200333{
Olivier Houchard3f795f72019-04-17 22:51:06 +0200334 task_unlink_wq(t);
335 /* We don't have to explicitely remove from the run queue.
336 * If we are in the runqueue, the test below will set t->process
337 * to NULL, and the task will be free'd when it'll be its turn
338 * to run.
339 */
340
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200341 /* There's no need to protect t->state with a lock, as the task
342 * has to run on the current thread.
343 */
Willy Tarreaua70bfaa2019-04-17 21:58:23 +0200344 if (t == curr_task || !(t->state & (TASK_QUEUED | TASK_RUNNING)))
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200345 __task_free(t);
346 else
347 t->process = NULL;
348}
349
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200350static inline void tasklet_free(struct tasklet *tl)
351{
Olivier Houchard09e498f2018-12-24 14:03:10 +0100352 if (!LIST_ISEMPTY(&tl->list)) {
Willy Tarreaua33d39a2019-03-25 18:10:53 +0100353 LIST_DEL(&tl->list);
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200354 task_per_thread[tid].task_list_size--;
Olivier Houchard4c2832852019-03-08 18:48:47 +0100355 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchard09e498f2018-12-24 14:03:10 +0100356 }
Olivier Houcharddcd6f3a2018-06-08 17:08:19 +0200357
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200358 pool_free(pool_head_tasklet, tl);
359 if (unlikely(stopping))
360 pool_flush(pool_head_tasklet);
361}
362
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200363void __task_queue(struct task *task, struct eb_root *wq);
364
Willy Tarreau4726f532009-03-07 17:25:21 +0100365/* Place <task> into the wait queue, where it may already be. If the expiration
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100366 * timer is infinite, do nothing and rely on wake_expired_task to clean up.
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200367 * If the task is bound to a single thread, it's assumed to be bound to the
368 * current thread's queue and is queued without locking. Otherwise it's queued
369 * into the global wait queue, protected by locks.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200370 */
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100371static inline void task_queue(struct task *task)
372{
373 /* If we already have a place in the wait queue no later than the
374 * timeout we're trying to set, we'll stay there, because it is very
375 * unlikely that we will reach the timeout anyway. If the timeout
376 * has been disabled, it's useless to leave the queue as well. We'll
377 * rely on wake_expired_tasks() to catch the node and move it to the
378 * proper place should it ever happen. Finally we only add the task
379 * to the queue if it was not there or if it was further than what
380 * we want.
381 */
382 if (!tick_isset(task->expire))
383 return;
384
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200385#ifdef USE_THREAD
386 if (atleast2(task->thread_mask)) {
387 HA_SPIN_LOCK(TASK_WQ_LOCK, &wq_lock);
388 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
389 __task_queue(task, &timers);
390 HA_SPIN_UNLOCK(TASK_WQ_LOCK, &wq_lock);
391 } else
392#endif
393 {
394 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200395 __task_queue(task, &task_per_thread[tid].timers);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200396 }
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100397}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200398
Willy Tarreau26e48812011-07-25 14:30:42 +0200399/* Ensure <task> will be woken up at most at <when>. If the task is already in
400 * the run queue (but not running), nothing is done. It may be used that way
401 * with a delay : task_schedule(task, tick_add(now_ms, delay));
402 */
403static inline void task_schedule(struct task *task, int when)
404{
Emeric Brunc60def82017-09-27 14:59:38 +0200405 /* TODO: mthread, check if there is no tisk with this test */
Willy Tarreau26e48812011-07-25 14:30:42 +0200406 if (task_in_rq(task))
407 return;
408
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200409#ifdef USE_THREAD
410 if (atleast2(task->thread_mask)) {
411 HA_SPIN_LOCK(TASK_WQ_LOCK, &wq_lock);
412 if (task_in_wq(task))
413 when = tick_first(when, task->expire);
414
415 task->expire = when;
416 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
417 __task_queue(task, &timers);
418 HA_SPIN_UNLOCK(TASK_WQ_LOCK, &wq_lock);
419 } else
420#endif
421 {
422 if (task_in_wq(task))
423 when = tick_first(when, task->expire);
Willy Tarreau26e48812011-07-25 14:30:42 +0200424
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200425 task->expire = when;
426 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200427 __task_queue(task, &task_per_thread[tid].timers);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200428 }
Willy Tarreau26e48812011-07-25 14:30:42 +0200429}
430
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200431/* This function register a new signal. "lua" is the current lua
432 * execution context. It contains a pointer to the associated task.
433 * "link" is a list head attached to an other task that must be wake
434 * the lua task if an event occurs. This is useful with external
435 * events like TCP I/O or sleep functions. This funcion allocate
436 * memory for the signal.
437 */
438static inline struct notification *notification_new(struct list *purge, struct list *event, struct task *wakeup)
439{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100440 struct notification *com = pool_alloc(pool_head_notification);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200441 if (!com)
442 return NULL;
443 LIST_ADDQ(purge, &com->purge_me);
444 LIST_ADDQ(event, &com->wake_me);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100445 HA_SPIN_INIT(&com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200446 com->task = wakeup;
447 return com;
448}
449
450/* This function purge all the pending signals when the LUA execution
451 * is finished. This prevent than a coprocess try to wake a deleted
452 * task. This function remove the memory associated to the signal.
Thierry FOURNIERd5b79832017-12-10 17:14:07 +0100453 * The purge list is not locked because it is owned by only one
454 * process. before browsing this list, the caller must ensure to be
455 * the only one browser.
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200456 */
457static inline void notification_purge(struct list *purge)
458{
459 struct notification *com, *back;
460
461 /* Delete all pending communication signals. */
462 list_for_each_entry_safe(com, back, purge, purge_me) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100463 HA_SPIN_LOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200464 LIST_DEL(&com->purge_me);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200465 if (!com->task) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100466 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100467 pool_free(pool_head_notification, com);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200468 continue;
469 }
470 com->task = NULL;
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100471 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200472 }
473}
474
Thierry FOURNIERcb146882017-12-10 17:10:57 +0100475/* In some cases, the disconnected notifications must be cleared.
476 * This function just release memory blocs. The purge list is not
477 * locked because it is owned by only one process. Before browsing
478 * this list, the caller must ensure to be the only one browser.
479 * The "com" is not locked because when com->task is NULL, the
480 * notification is no longer used.
481 */
482static inline void notification_gc(struct list *purge)
483{
484 struct notification *com, *back;
485
486 /* Delete all pending communication signals. */
487 list_for_each_entry_safe (com, back, purge, purge_me) {
488 if (com->task)
489 continue;
490 LIST_DEL(&com->purge_me);
491 pool_free(pool_head_notification, com);
492 }
493}
494
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200495/* This function sends signals. It wakes all the tasks attached
496 * to a list head, and remove the signal, and free the used
Thierry FOURNIERd5b79832017-12-10 17:14:07 +0100497 * memory. The wake list is not locked because it is owned by
498 * only one process. before browsing this list, the caller must
499 * ensure to be the only one browser.
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200500 */
501static inline void notification_wake(struct list *wake)
502{
503 struct notification *com, *back;
504
505 /* Wake task and delete all pending communication signals. */
506 list_for_each_entry_safe(com, back, wake, wake_me) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100507 HA_SPIN_LOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200508 LIST_DEL(&com->wake_me);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200509 if (!com->task) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100510 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100511 pool_free(pool_head_notification, com);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200512 continue;
513 }
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200514 task_wakeup(com->task, TASK_WOKEN_MSG);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200515 com->task = NULL;
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100516 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200517 }
518}
519
Thierry FOURNIER9d5422a2018-05-30 11:40:08 +0200520/* This function returns true is some notification are pending
521 */
522static inline int notification_registered(struct list *wake)
523{
524 return !LIST_ISEMPTY(wake);
525}
526
Willy Tarreaubaaee002006-06-26 02:48:02 +0200527/*
Willy Tarreau918ff602011-07-25 16:33:49 +0200528 * This does 3 things :
Willy Tarreaubaaee002006-06-26 02:48:02 +0200529 * - wake up all expired tasks
530 * - call all runnable tasks
Willy Tarreaud825eef2007-05-12 22:35:00 +0200531 * - return the date of next event in <next> or eternity.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200532 */
533
Thierry FOURNIER9cf7c4b2014-12-15 13:26:01 +0100534void process_runnable_tasks();
Willy Tarreaubaaee002006-06-26 02:48:02 +0200535
Willy Tarreau58b458d2008-06-29 22:40:23 +0200536/*
537 * Extract all expired timers from the timer queue, and wakes up all
538 * associated tasks. Returns the date of next event (or eternity).
539 */
Thierry FOURNIER9cf7c4b2014-12-15 13:26:01 +0100540int wake_expired_tasks();
Willy Tarreau58b458d2008-06-29 22:40:23 +0200541
William Lallemand27f3fa52018-12-06 14:05:20 +0100542/*
543 * Delete every tasks before running the master polling loop
544 */
545void mworker_cleantasks();
546
Willy Tarreaubaaee002006-06-26 02:48:02 +0200547#endif /* _PROTO_TASK_H */
548
549/*
550 * Local variables:
551 * c-indent-level: 8
552 * c-basic-offset: 8
553 * End:
554 */