blob: 5445c99067a8e2980495f6c99ee7948d7a296ace [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 */
95extern THREAD_LOCAL struct eb32sc_node *rq_next; /* Next task to be potentially run */
Olivier Houchardb1ca58b2018-06-06 14:22:03 +020096#ifdef USE_THREAD
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
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200101extern struct eb_root rqueue_local[MAX_THREADS]; /* tree constituting the per-thread run queue */
Olivier Houchard77551ee2018-07-26 15:59:38 +0200102extern int rqueue_size[MAX_THREADS]; /* Number of elements in the per-thread run queue */
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200103extern struct list task_list[MAX_THREADS]; /* List of tasks to be run, mixing tasks and tasklets */
104extern int task_list_size[MAX_THREADS]; /* Number of task sin the task_list */
Christopher Faulet9dcf9b62017-11-13 10:34:01 +0100105
106__decl_hathreads(extern HA_SPINLOCK_T rq_lock); /* spin lock related to run queue */
107__decl_hathreads(extern HA_SPINLOCK_T wq_lock); /* spin lock related to wait queue */
Willy Tarreauc6ca1a02007-05-13 19:43:47 +0200108
Olivier Houchard5d187182018-08-01 15:58:44 +0200109
110static inline void task_insert_into_tasklet_list(struct task *t);
111
Willy Tarreau4726f532009-03-07 17:25:21 +0100112/* return 0 if task is in run queue, otherwise non-zero */
113static inline int task_in_rq(struct task *t)
114{
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200115 /* Check if leaf_p is NULL, in case he's not in the runqueue, and if
116 * it's not 0x1, which would mean it's in the tasklet list.
117 */
118 return t->rq.node.leaf_p != NULL && t->rq.node.leaf_p != (void *)0x1;
Willy Tarreau4726f532009-03-07 17:25:21 +0100119}
120
121/* return 0 if task is in wait queue, otherwise non-zero */
122static inline int task_in_wq(struct task *t)
123{
124 return t->wq.node.leaf_p != NULL;
125}
126
Willy Tarreaufdccded2008-08-29 18:19:04 +0200127/* puts the task <t> in run queue with reason flags <f>, and returns <t> */
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200128/* This will put the task in the local runqueue if the task is only runnable
129 * by the current thread, in the global runqueue otherwies.
130 */
131void __task_wakeup(struct task *t, struct eb_root *);
132static inline void task_wakeup(struct task *t, unsigned int f)
Willy Tarreau4df82062008-08-29 15:26:14 +0200133{
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200134 unsigned short state;
Emeric Brunc60def82017-09-27 14:59:38 +0200135
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200136#ifdef USE_THREAD
137 struct eb_root *root;
Emeric Brunc60def82017-09-27 14:59:38 +0200138
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200139 if (t->thread_mask == tid_bit || global.nbthread == 1)
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200140 root = &rqueue_local[tid];
141 else
142 root = &rqueue;
143#else
Olivier Houcharde13ab8b2018-06-06 14:01:08 +0200144 struct eb_root *root = &rqueue_local[tid];
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200145#endif
146
147 state = HA_ATOMIC_OR(&t->state, f);
148 if (!(state & TASK_RUNNING))
149 __task_wakeup(t, root);
Willy Tarreau4df82062008-08-29 15:26:14 +0200150}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200151
Willy Tarreauf65610a2017-10-31 16:06:06 +0100152/* change the thread affinity of a task to <thread_mask> */
Emeric Brunc60def82017-09-27 14:59:38 +0200153static inline void task_set_affinity(struct task *t, unsigned long thread_mask)
154{
Willy Tarreauf65610a2017-10-31 16:06:06 +0100155 t->thread_mask = thread_mask;
Emeric Brunc60def82017-09-27 14:59:38 +0200156}
Willy Tarreauf65610a2017-10-31 16:06:06 +0100157
Willy Tarreau4726f532009-03-07 17:25:21 +0100158/*
159 * Unlink the task from the wait queue, and possibly update the last_timer
160 * pointer. A pointer to the task itself is returned. The task *must* already
161 * be in the wait queue before calling this function. If unsure, use the safer
162 * task_unlink_wq() function.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200163 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100164static inline struct task *__task_unlink_wq(struct task *t)
165{
166 eb32_delete(&t->wq);
Willy Tarreau4726f532009-03-07 17:25:21 +0100167 return t;
168}
169
170static inline struct task *task_unlink_wq(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200171{
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100172 HA_SPIN_LOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreau4726f532009-03-07 17:25:21 +0100173 if (likely(task_in_wq(t)))
174 __task_unlink_wq(t);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100175 HA_SPIN_UNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreau96bcfd72007-04-29 10:41:56 +0200176 return t;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200177}
178
179/*
Christopher Faulet34c5cc92016-12-06 09:15:30 +0100180 * Unlink the task from the run queue. The tasks_run_queue size and number of
181 * niced tasks are updated too. A pointer to the task itself is returned. The
182 * task *must* already be in the run queue before calling this function. If
183 * unsure, use the safer task_unlink_rq() function. Note that the pointer to the
184 * next run queue entry is neither checked nor updated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200185 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100186static inline struct task *__task_unlink_rq(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200187{
Olivier Houchard09eeb762018-05-28 13:51:06 +0200188 HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchard77551ee2018-07-26 15:59:38 +0200189#ifdef USE_THREAD
190 if (t->state & TASK_GLOBAL) {
Olivier Houchard76e45182018-07-26 16:19:58 +0200191 HA_ATOMIC_AND(&t->state, ~TASK_GLOBAL);
Olivier Houchard77551ee2018-07-26 15:59:38 +0200192 global_rqueue_size--;
193 } else
194#endif
195 rqueue_size[tid]--;
196 eb32sc_delete(&t->rq);
Willy Tarreau4726f532009-03-07 17:25:21 +0100197 if (likely(t->nice))
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200198 HA_ATOMIC_SUB(&niced_tasks, 1);
Willy Tarreauce44f122008-07-05 18:16:19 +0200199 return t;
200}
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200201
Willy Tarreau501260b2015-02-23 16:07:01 +0100202/* This function unlinks task <t> from the run queue if it is in it. It also
203 * takes care of updating the next run queue task if it was this task.
204 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100205static inline struct task *task_unlink_rq(struct task *t)
206{
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200207 if (t->thread_mask != tid_bit)
208 HA_SPIN_LOCK(TASK_RQ_LOCK, &rq_lock);
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200209 if (likely(task_in_rq(t))) {
210 if (&t->rq == rq_next)
211 rq_next = eb32sc_next(rq_next, tid_bit);
Willy Tarreau4726f532009-03-07 17:25:21 +0100212 __task_unlink_rq(t);
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200213 }
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200214 if (t->thread_mask != tid_bit)
215 HA_SPIN_UNLOCK(TASK_RQ_LOCK, &rq_lock);
Willy Tarreau4726f532009-03-07 17:25:21 +0100216 return t;
217}
218
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200219static inline void tasklet_wakeup(struct tasklet *tl)
220{
Olivier Houchard5d187182018-08-01 15:58:44 +0200221 if (!TASK_IS_TASKLET(tl)) {
222 task_insert_into_tasklet_list((struct task *)tl);
223 return;
224 }
Olivier Houcharde17c2d32018-07-17 18:29:22 +0200225 if (!LIST_ISEMPTY(&tl->list))
226 return;
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200227 LIST_ADDQ(&task_list[tid], &tl->list);
228 task_list_size[tid]++;
Olivier Houchardabedf5f2018-08-17 18:57:51 +0200229 HA_ATOMIC_OR(&active_tasks_mask, tid_bit);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200230 HA_ATOMIC_ADD(&tasks_run_queue, 1);
231
232}
233
234static inline void task_insert_into_tasklet_list(struct task *t)
235{
236 struct tasklet *tl;
237 void *expected = NULL;
238
239 /* Protect ourself against anybody trying to insert the task into
240 * another runqueue. We set leaf_p to 0x1 to indicate that the node is
241 * not in a tree but that it's in the tasklet list. See task_in_rq().
242 */
David Carliercaa8a372018-06-01 14:32:39 +0200243 if (unlikely(!HA_ATOMIC_CAS(&t->rq.node.leaf_p, &expected, (void *)0x1)))
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200244 return;
Olivier Houchard09eeb762018-05-28 13:51:06 +0200245 HA_ATOMIC_ADD(&tasks_run_queue, 1);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200246 task_list_size[tid]++;
247 tl = (struct tasklet *)t;
248 LIST_ADDQ(&task_list[tid], &tl->list);
249}
250
251static inline void task_remove_from_task_list(struct task *t)
252{
253 LIST_DEL(&((struct tasklet *)t)->list);
Olivier Houcharddcd6f3a2018-06-08 17:08:19 +0200254 LIST_INIT(&((struct tasklet *)t)->list);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200255 task_list_size[tid]--;
256 HA_ATOMIC_SUB(&tasks_run_queue, 1);
257 if (!TASK_IS_TASKLET(t)) {
258 t->rq.node.leaf_p = NULL; // was 0x1
259 __ha_barrier_store();
260 }
261}
262
Willy Tarreauce44f122008-07-05 18:16:19 +0200263/*
264 * Unlinks the task and adjusts run queue stats.
265 * A pointer to the task itself is returned.
266 */
267static inline struct task *task_delete(struct task *t)
268{
Willy Tarreau4726f532009-03-07 17:25:21 +0100269 task_unlink_wq(t);
270 task_unlink_rq(t);
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200271 return t;
272}
273
274/*
Willy Tarreaua4613182009-03-21 18:13:21 +0100275 * Initialize a new task. The bare minimum is performed (queue pointers and
276 * state). The task is returned. This function should not be used outside of
277 * task_new().
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200278 */
Emeric Brunc60def82017-09-27 14:59:38 +0200279static inline struct task *task_init(struct task *t, unsigned long thread_mask)
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200280{
Willy Tarreau4726f532009-03-07 17:25:21 +0100281 t->wq.node.leaf_p = NULL;
282 t->rq.node.leaf_p = NULL;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200283 t->state = TASK_SLEEPING;
Willy Tarreauf65610a2017-10-31 16:06:06 +0100284 t->thread_mask = thread_mask;
Willy Tarreau91e99932008-06-30 07:51:00 +0200285 t->nice = 0;
Willy Tarreau3884cba2009-03-28 17:54:35 +0100286 t->calls = 0;
Willy Tarreauf4219992017-07-24 17:52:58 +0200287 t->expire = TICK_ETERNITY;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200288 return t;
289}
290
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200291static inline void tasklet_init(struct tasklet *t)
292{
293 t->nice = -32768;
294 t->calls = 0;
295 t->state = 0;
Olivier Houchard9ddaf792018-07-19 16:02:16 +0200296 t->process = NULL;
Olivier Houcharddcd6f3a2018-06-08 17:08:19 +0200297 LIST_INIT(&t->list);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200298}
299
300static inline struct tasklet *tasklet_new(void)
301{
302 struct tasklet *t = pool_alloc(pool_head_tasklet);
303
304 if (t) {
305 tasklet_init(t);
306 }
307 return t;
308}
309
Willy Tarreaubaaee002006-06-26 02:48:02 +0200310/*
Willy Tarreaua4613182009-03-21 18:13:21 +0100311 * Allocate and initialise a new task. The new task is returned, or NULL in
312 * case of lack of memory. The task count is incremented. Tasks should only
313 * be allocated this way, and must be freed using task_free().
314 */
Emeric Brunc60def82017-09-27 14:59:38 +0200315static inline struct task *task_new(unsigned long thread_mask)
Willy Tarreaua4613182009-03-21 18:13:21 +0100316{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100317 struct task *t = pool_alloc(pool_head_task);
Willy Tarreaua4613182009-03-21 18:13:21 +0100318 if (t) {
Emeric Brunc60def82017-09-27 14:59:38 +0200319 HA_ATOMIC_ADD(&nb_tasks, 1);
320 task_init(t, thread_mask);
Willy Tarreaua4613182009-03-21 18:13:21 +0100321 }
322 return t;
323}
324
325/*
326 * Free a task. Its context must have been freed since it will be lost.
327 * The task count is decremented.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200328 */
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200329static inline void __task_free(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200330{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100331 pool_free(pool_head_task, t);
Willy Tarreaueb118892014-11-13 16:57:19 +0100332 if (unlikely(stopping))
Willy Tarreaubafbe012017-11-24 17:34:44 +0100333 pool_flush(pool_head_task);
Emeric Brunc60def82017-09-27 14:59:38 +0200334 HA_ATOMIC_SUB(&nb_tasks, 1);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200335}
336
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200337static inline void task_free(struct task *t)
338{
339 /* There's no need to protect t->state with a lock, as the task
340 * has to run on the current thread.
341 */
342 if (t == curr_task || !(t->state & TASK_RUNNING))
343 __task_free(t);
344 else
345 t->process = NULL;
346}
347
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200348static inline void tasklet_free(struct tasklet *tl)
349{
Olivier Houchard931624a2018-09-12 14:55:03 +0200350 if (!LIST_ISEMPTY(&tl->list))
351 task_list_size[tid]--;
Olivier Houcharddcd6f3a2018-06-08 17:08:19 +0200352 LIST_DEL(&tl->list);
353
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200354 pool_free(pool_head_tasklet, tl);
355 if (unlikely(stopping))
356 pool_flush(pool_head_tasklet);
357}
358
Willy Tarreau4726f532009-03-07 17:25:21 +0100359/* Place <task> into the wait queue, where it may already be. If the expiration
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100360 * timer is infinite, do nothing and rely on wake_expired_task to clean up.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200361 */
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100362void __task_queue(struct task *task);
363static inline void task_queue(struct task *task)
364{
365 /* If we already have a place in the wait queue no later than the
366 * timeout we're trying to set, we'll stay there, because it is very
367 * unlikely that we will reach the timeout anyway. If the timeout
368 * has been disabled, it's useless to leave the queue as well. We'll
369 * rely on wake_expired_tasks() to catch the node and move it to the
370 * proper place should it ever happen. Finally we only add the task
371 * to the queue if it was not there or if it was further than what
372 * we want.
373 */
374 if (!tick_isset(task->expire))
375 return;
376
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100377 HA_SPIN_LOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaue35c94a2009-03-21 10:01:42 +0100378 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100379 __task_queue(task);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100380 HA_SPIN_UNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100381}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200382
Willy Tarreau26e48812011-07-25 14:30:42 +0200383/* Ensure <task> will be woken up at most at <when>. If the task is already in
384 * the run queue (but not running), nothing is done. It may be used that way
385 * with a delay : task_schedule(task, tick_add(now_ms, delay));
386 */
387static inline void task_schedule(struct task *task, int when)
388{
Emeric Brunc60def82017-09-27 14:59:38 +0200389 /* TODO: mthread, check if there is no tisk with this test */
Willy Tarreau26e48812011-07-25 14:30:42 +0200390 if (task_in_rq(task))
391 return;
392
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100393 HA_SPIN_LOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreau26e48812011-07-25 14:30:42 +0200394 if (task_in_wq(task))
395 when = tick_first(when, task->expire);
396
397 task->expire = when;
398 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
399 __task_queue(task);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100400 HA_SPIN_UNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreau26e48812011-07-25 14:30:42 +0200401}
402
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200403/* This function register a new signal. "lua" is the current lua
404 * execution context. It contains a pointer to the associated task.
405 * "link" is a list head attached to an other task that must be wake
406 * the lua task if an event occurs. This is useful with external
407 * events like TCP I/O or sleep functions. This funcion allocate
408 * memory for the signal.
409 */
410static inline struct notification *notification_new(struct list *purge, struct list *event, struct task *wakeup)
411{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100412 struct notification *com = pool_alloc(pool_head_notification);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200413 if (!com)
414 return NULL;
415 LIST_ADDQ(purge, &com->purge_me);
416 LIST_ADDQ(event, &com->wake_me);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100417 HA_SPIN_INIT(&com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200418 com->task = wakeup;
419 return com;
420}
421
422/* This function purge all the pending signals when the LUA execution
423 * is finished. This prevent than a coprocess try to wake a deleted
424 * task. This function remove the memory associated to the signal.
Thierry FOURNIERd5b79832017-12-10 17:14:07 +0100425 * The purge list is not locked because it is owned by only one
426 * process. before browsing this list, the caller must ensure to be
427 * the only one browser.
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200428 */
429static inline void notification_purge(struct list *purge)
430{
431 struct notification *com, *back;
432
433 /* Delete all pending communication signals. */
434 list_for_each_entry_safe(com, back, purge, purge_me) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100435 HA_SPIN_LOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200436 LIST_DEL(&com->purge_me);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200437 if (!com->task) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100438 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100439 pool_free(pool_head_notification, com);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200440 continue;
441 }
442 com->task = NULL;
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100443 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200444 }
445}
446
Thierry FOURNIERcb146882017-12-10 17:10:57 +0100447/* In some cases, the disconnected notifications must be cleared.
448 * This function just release memory blocs. The purge list is not
449 * locked because it is owned by only one process. Before browsing
450 * this list, the caller must ensure to be the only one browser.
451 * The "com" is not locked because when com->task is NULL, the
452 * notification is no longer used.
453 */
454static inline void notification_gc(struct list *purge)
455{
456 struct notification *com, *back;
457
458 /* Delete all pending communication signals. */
459 list_for_each_entry_safe (com, back, purge, purge_me) {
460 if (com->task)
461 continue;
462 LIST_DEL(&com->purge_me);
463 pool_free(pool_head_notification, com);
464 }
465}
466
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200467/* This function sends signals. It wakes all the tasks attached
468 * to a list head, and remove the signal, and free the used
Thierry FOURNIERd5b79832017-12-10 17:14:07 +0100469 * memory. The wake list is not locked because it is owned by
470 * only one process. before browsing this list, the caller must
471 * ensure to be the only one browser.
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200472 */
473static inline void notification_wake(struct list *wake)
474{
475 struct notification *com, *back;
476
477 /* Wake task and delete all pending communication signals. */
478 list_for_each_entry_safe(com, back, wake, wake_me) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100479 HA_SPIN_LOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200480 LIST_DEL(&com->wake_me);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200481 if (!com->task) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100482 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100483 pool_free(pool_head_notification, com);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200484 continue;
485 }
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200486 task_wakeup(com->task, TASK_WOKEN_MSG);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200487 com->task = NULL;
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100488 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200489 }
490}
491
Thierry FOURNIER9d5422a2018-05-30 11:40:08 +0200492/* This function returns true is some notification are pending
493 */
494static inline int notification_registered(struct list *wake)
495{
496 return !LIST_ISEMPTY(wake);
497}
498
Willy Tarreaubaaee002006-06-26 02:48:02 +0200499/*
Willy Tarreau918ff602011-07-25 16:33:49 +0200500 * This does 3 things :
Willy Tarreaubaaee002006-06-26 02:48:02 +0200501 * - wake up all expired tasks
502 * - call all runnable tasks
Willy Tarreaud825eef2007-05-12 22:35:00 +0200503 * - return the date of next event in <next> or eternity.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200504 */
505
Thierry FOURNIER9cf7c4b2014-12-15 13:26:01 +0100506void process_runnable_tasks();
Willy Tarreaubaaee002006-06-26 02:48:02 +0200507
Willy Tarreau58b458d2008-06-29 22:40:23 +0200508/*
509 * Extract all expired timers from the timer queue, and wakes up all
510 * associated tasks. Returns the date of next event (or eternity).
511 */
Thierry FOURNIER9cf7c4b2014-12-15 13:26:01 +0100512int wake_expired_tasks();
Willy Tarreau58b458d2008-06-29 22:40:23 +0200513
Willy Tarreaud0a201b2009-03-08 15:53:06 +0100514/* Perform minimal initializations, report 0 in case of error, 1 if OK. */
515int init_task();
Willy Tarreaubaaee002006-06-26 02:48:02 +0200516
517#endif /* _PROTO_TASK_H */
518
519/*
520 * Local variables:
521 * c-indent-level: 8
522 * c-basic-offset: 8
523 * End:
524 */