blob: 4044bd459c0c7b579061dc2221572f9d428d5cd3 [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 */
Willy Tarreauaa1e1be2019-05-16 17:37:27 +020086extern volatile unsigned long global_tasks_mask; /* Mask of threads with tasks in the global runqueue */
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 */
Willy Tarreauef28dc12019-05-28 18:48:07 +0200104__decl_hathreads(extern HA_RWLOCK_T wq_lock); /* RW lock related to the wait queue */
Willy Tarreauc6ca1a02007-05-13 19:43:47 +0200105
Olivier Houchard5d187182018-08-01 15:58:44 +0200106
Willy Tarreau4726f532009-03-07 17:25:21 +0100107/* return 0 if task is in run queue, otherwise non-zero */
108static inline int task_in_rq(struct task *t)
109{
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200110 /* Check if leaf_p is NULL, in case he's not in the runqueue, and if
111 * it's not 0x1, which would mean it's in the tasklet list.
112 */
Olivier Houchard4a1be0c2019-04-17 19:13:07 +0200113 return t->rq.node.leaf_p != NULL;
Willy Tarreau4726f532009-03-07 17:25:21 +0100114}
115
116/* return 0 if task is in wait queue, otherwise non-zero */
117static inline int task_in_wq(struct task *t)
118{
119 return t->wq.node.leaf_p != NULL;
120}
121
Willy Tarreaufdccded2008-08-29 18:19:04 +0200122/* puts the task <t> in run queue with reason flags <f>, and returns <t> */
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200123/* This will put the task in the local runqueue if the task is only runnable
124 * by the current thread, in the global runqueue otherwies.
125 */
126void __task_wakeup(struct task *t, struct eb_root *);
127static inline void task_wakeup(struct task *t, unsigned int f)
Willy Tarreau4df82062008-08-29 15:26:14 +0200128{
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200129 unsigned short state;
Emeric Brunc60def82017-09-27 14:59:38 +0200130
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200131#ifdef USE_THREAD
132 struct eb_root *root;
Emeric Brunc60def82017-09-27 14:59:38 +0200133
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200134 if (t->thread_mask == tid_bit || global.nbthread == 1)
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200135 root = &task_per_thread[tid].rqueue;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200136 else
137 root = &rqueue;
138#else
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200139 struct eb_root *root = &task_per_thread[tid].rqueue;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200140#endif
141
Willy Tarreaub0380072019-04-17 11:47:18 +0200142 state = _HA_ATOMIC_OR(&t->state, f);
143 while (!(state & (TASK_RUNNING | TASK_QUEUED))) {
Willy Tarreau8c12e2f2019-04-17 20:52:51 +0200144 if (_HA_ATOMIC_CAS(&t->state, &state, state | TASK_QUEUED)) {
145 __task_wakeup(t, root);
Willy Tarreaub0380072019-04-17 11:47:18 +0200146 break;
Willy Tarreau8c12e2f2019-04-17 20:52:51 +0200147 }
Willy Tarreaub0380072019-04-17 11:47:18 +0200148 }
Willy Tarreau4df82062008-08-29 15:26:14 +0200149}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200150
Willy Tarreauf65610a2017-10-31 16:06:06 +0100151/* change the thread affinity of a task to <thread_mask> */
Emeric Brunc60def82017-09-27 14:59:38 +0200152static inline void task_set_affinity(struct task *t, unsigned long thread_mask)
153{
Willy Tarreauf65610a2017-10-31 16:06:06 +0100154 t->thread_mask = thread_mask;
Emeric Brunc60def82017-09-27 14:59:38 +0200155}
Willy Tarreauf65610a2017-10-31 16:06:06 +0100156
Willy Tarreau4726f532009-03-07 17:25:21 +0100157/*
158 * Unlink the task from the wait queue, and possibly update the last_timer
159 * pointer. A pointer to the task itself is returned. The task *must* already
160 * be in the wait queue before calling this function. If unsure, use the safer
161 * task_unlink_wq() function.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200162 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100163static inline struct task *__task_unlink_wq(struct task *t)
164{
165 eb32_delete(&t->wq);
Willy Tarreau4726f532009-03-07 17:25:21 +0100166 return t;
167}
168
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200169/* remove a task from its wait queue. It may either be the local wait queue if
170 * the task is bound to a single thread (in which case there's no locking
171 * involved) or the global queue, with locking.
172 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100173static inline struct task *task_unlink_wq(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200174{
Richard Russobc9d9842019-02-20 12:43:45 -0800175 unsigned long locked;
176
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200177 if (likely(task_in_wq(t))) {
Richard Russobc9d9842019-02-20 12:43:45 -0800178 locked = atleast2(t->thread_mask);
179 if (locked)
Willy Tarreauef28dc12019-05-28 18:48:07 +0200180 HA_RWLOCK_WRLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreau4726f532009-03-07 17:25:21 +0100181 __task_unlink_wq(t);
Richard Russobc9d9842019-02-20 12:43:45 -0800182 if (locked)
Willy Tarreauef28dc12019-05-28 18:48:07 +0200183 HA_RWLOCK_WRUNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200184 }
Willy Tarreau96bcfd72007-04-29 10:41:56 +0200185 return t;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200186}
187
188/*
Christopher Faulet34c5cc92016-12-06 09:15:30 +0100189 * Unlink the task from the run queue. The tasks_run_queue size and number of
190 * niced tasks are updated too. A pointer to the task itself is returned. The
191 * task *must* already be in the run queue before calling this function. If
192 * unsure, use the safer task_unlink_rq() function. Note that the pointer to the
193 * next run queue entry is neither checked nor updated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200194 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100195static inline struct task *__task_unlink_rq(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200196{
Olivier Houchard4c2832852019-03-08 18:48:47 +0100197 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchard77551ee2018-07-26 15:59:38 +0200198#ifdef USE_THREAD
199 if (t->state & TASK_GLOBAL) {
Olivier Houchard4c2832852019-03-08 18:48:47 +0100200 _HA_ATOMIC_AND(&t->state, ~TASK_GLOBAL);
Olivier Houchard77551ee2018-07-26 15:59:38 +0200201 global_rqueue_size--;
202 } else
203#endif
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200204 task_per_thread[tid].rqueue_size--;
Olivier Houchard77551ee2018-07-26 15:59:38 +0200205 eb32sc_delete(&t->rq);
Willy Tarreau4726f532009-03-07 17:25:21 +0100206 if (likely(t->nice))
Olivier Houchard4c2832852019-03-08 18:48:47 +0100207 _HA_ATOMIC_SUB(&niced_tasks, 1);
Willy Tarreauce44f122008-07-05 18:16:19 +0200208 return t;
209}
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200210
Willy Tarreau501260b2015-02-23 16:07:01 +0100211/* This function unlinks task <t> from the run queue if it is in it. It also
212 * takes care of updating the next run queue task if it was this task.
213 */
Willy Tarreau4726f532009-03-07 17:25:21 +0100214static inline struct task *task_unlink_rq(struct task *t)
215{
Olivier Houchard1d7f37a2019-03-14 16:14:04 +0100216 int is_global = t->state & TASK_GLOBAL;
217
218 if (is_global)
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200219 HA_SPIN_LOCK(TASK_RQ_LOCK, &rq_lock);
Willy Tarreau24f382f2019-04-12 16:10:55 +0200220 if (likely(task_in_rq(t)))
Willy Tarreau4726f532009-03-07 17:25:21 +0100221 __task_unlink_rq(t);
Olivier Houchard1d7f37a2019-03-14 16:14:04 +0100222 if (is_global)
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200223 HA_SPIN_UNLOCK(TASK_RQ_LOCK, &rq_lock);
Willy Tarreau4726f532009-03-07 17:25:21 +0100224 return t;
225}
226
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200227static inline void tasklet_wakeup(struct tasklet *tl)
228{
Olivier Houcharde17c2d32018-07-17 18:29:22 +0200229 if (!LIST_ISEMPTY(&tl->list))
230 return;
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200231 LIST_ADDQ(&task_per_thread[tid].task_list, &tl->list);
Olivier Houchard4c2832852019-03-08 18:48:47 +0100232 _HA_ATOMIC_ADD(&tasks_run_queue, 1);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200233
234}
235
Willy Tarreaubd20a9d2019-06-14 18:05:54 +0200236/* Insert a tasklet into the tasklet list. If used with a plain task instead,
237 * the caller must update the task_list_size.
238 */
239static inline void tasklet_insert_into_tasklet_list(struct tasklet *tl)
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200240{
Olivier Houchard4c2832852019-03-08 18:48:47 +0100241 _HA_ATOMIC_ADD(&tasks_run_queue, 1);
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200242 LIST_ADDQ(&task_per_thread[tid].task_list, &tl->list);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200243}
244
Willy Tarreaubd20a9d2019-06-14 18:05:54 +0200245/* Remove the tasklet from the tasklet list. The tasklet MUST already be there.
246 * If unsure, use tasklet_remove_from_tasklet_list() instead. If used with a
247 * plain task, the caller must update the task_list_size.
Willy Tarreaue73256f2019-03-25 18:02:54 +0100248 */
Willy Tarreau86eded62019-06-14 14:47:49 +0200249static inline void __tasklet_remove_from_tasklet_list(struct tasklet *t)
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200250{
Willy Tarreau86eded62019-06-14 14:47:49 +0200251 LIST_DEL_INIT(&t->list);
Olivier Houchard4c2832852019-03-08 18:48:47 +0100252 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200253}
254
Willy Tarreau86eded62019-06-14 14:47:49 +0200255static inline void tasklet_remove_from_tasklet_list(struct tasklet *t)
Willy Tarreaue73256f2019-03-25 18:02:54 +0100256{
Willy Tarreau86eded62019-06-14 14:47:49 +0200257 if (likely(!LIST_ISEMPTY(&t->list)))
258 __tasklet_remove_from_tasklet_list(t);
Willy Tarreaue73256f2019-03-25 18:02:54 +0100259}
260
Willy Tarreauce44f122008-07-05 18:16:19 +0200261/*
Willy Tarreaua4613182009-03-21 18:13:21 +0100262 * Initialize a new task. The bare minimum is performed (queue pointers and
263 * state). The task is returned. This function should not be used outside of
264 * task_new().
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200265 */
Emeric Brunc60def82017-09-27 14:59:38 +0200266static inline struct task *task_init(struct task *t, unsigned long thread_mask)
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200267{
Willy Tarreau4726f532009-03-07 17:25:21 +0100268 t->wq.node.leaf_p = NULL;
269 t->rq.node.leaf_p = NULL;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200270 t->state = TASK_SLEEPING;
Willy Tarreauf65610a2017-10-31 16:06:06 +0100271 t->thread_mask = thread_mask;
Willy Tarreau91e99932008-06-30 07:51:00 +0200272 t->nice = 0;
Willy Tarreau3884cba2009-03-28 17:54:35 +0100273 t->calls = 0;
Willy Tarreau9efd7452018-05-31 14:48:54 +0200274 t->call_date = 0;
275 t->cpu_time = 0;
276 t->lat_time = 0;
Willy Tarreauf4219992017-07-24 17:52:58 +0200277 t->expire = TICK_ETERNITY;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200278 return t;
279}
280
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200281static inline void tasklet_init(struct tasklet *t)
282{
283 t->nice = -32768;
284 t->calls = 0;
285 t->state = 0;
Olivier Houchard9ddaf792018-07-19 16:02:16 +0200286 t->process = NULL;
Olivier Houcharddcd6f3a2018-06-08 17:08:19 +0200287 LIST_INIT(&t->list);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200288}
289
290static inline struct tasklet *tasklet_new(void)
291{
292 struct tasklet *t = pool_alloc(pool_head_tasklet);
293
294 if (t) {
295 tasklet_init(t);
296 }
297 return t;
298}
299
Willy Tarreaubaaee002006-06-26 02:48:02 +0200300/*
Willy Tarreaua4613182009-03-21 18:13:21 +0100301 * Allocate and initialise a new task. The new task is returned, or NULL in
302 * case of lack of memory. The task count is incremented. Tasks should only
303 * be allocated this way, and must be freed using task_free().
304 */
Emeric Brunc60def82017-09-27 14:59:38 +0200305static inline struct task *task_new(unsigned long thread_mask)
Willy Tarreaua4613182009-03-21 18:13:21 +0100306{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100307 struct task *t = pool_alloc(pool_head_task);
Willy Tarreaua4613182009-03-21 18:13:21 +0100308 if (t) {
Olivier Houchard4c2832852019-03-08 18:48:47 +0100309 _HA_ATOMIC_ADD(&nb_tasks, 1);
Emeric Brunc60def82017-09-27 14:59:38 +0200310 task_init(t, thread_mask);
Willy Tarreaua4613182009-03-21 18:13:21 +0100311 }
312 return t;
313}
314
315/*
Willy Tarreau29bf96d2019-05-17 14:16:51 +0200316 * Free a task. Its context must have been freed since it will be lost. The
317 * task count is decremented. It it is the current task, this one is reset.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200318 */
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200319static inline void __task_free(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200320{
Willy Tarreau29bf96d2019-05-17 14:16:51 +0200321 if (t == curr_task) {
322 curr_task = NULL;
323 __ha_barrier_store();
324 }
Willy Tarreaubafbe012017-11-24 17:34:44 +0100325 pool_free(pool_head_task, t);
Willy Tarreaueb118892014-11-13 16:57:19 +0100326 if (unlikely(stopping))
Willy Tarreaubafbe012017-11-24 17:34:44 +0100327 pool_flush(pool_head_task);
Olivier Houchard4c2832852019-03-08 18:48:47 +0100328 _HA_ATOMIC_SUB(&nb_tasks, 1);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200329}
330
Willy Tarreauf6562792019-05-07 19:05:35 +0200331/* Destroys a task : it's unlinked from the wait queues and is freed if it's
332 * the current task or not queued otherwise it's marked to be freed by the
333 * scheduler. It does nothing if <t> is NULL.
334 */
Olivier Houchard3f795f72019-04-17 22:51:06 +0200335static inline void task_destroy(struct task *t)
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200336{
Dragan Dosen75bc6d32019-05-07 15:25:25 +0200337 if (!t)
338 return;
339
Olivier Houchard3f795f72019-04-17 22:51:06 +0200340 task_unlink_wq(t);
341 /* We don't have to explicitely remove from the run queue.
342 * If we are in the runqueue, the test below will set t->process
343 * to NULL, and the task will be free'd when it'll be its turn
344 * to run.
345 */
346
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200347 /* There's no need to protect t->state with a lock, as the task
348 * has to run on the current thread.
349 */
Willy Tarreaua70bfaa2019-04-17 21:58:23 +0200350 if (t == curr_task || !(t->state & (TASK_QUEUED | TASK_RUNNING)))
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200351 __task_free(t);
352 else
353 t->process = NULL;
354}
355
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200356static inline void tasklet_free(struct tasklet *tl)
357{
Olivier Houchard09e498f2018-12-24 14:03:10 +0100358 if (!LIST_ISEMPTY(&tl->list)) {
Willy Tarreaua33d39a2019-03-25 18:10:53 +0100359 LIST_DEL(&tl->list);
Olivier Houchard4c2832852019-03-08 18:48:47 +0100360 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchard09e498f2018-12-24 14:03:10 +0100361 }
Olivier Houcharddcd6f3a2018-06-08 17:08:19 +0200362
Willy Tarreau29bf96d2019-05-17 14:16:51 +0200363 if ((struct task *)tl == curr_task) {
364 curr_task = NULL;
365 __ha_barrier_store();
366 }
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200367 pool_free(pool_head_tasklet, tl);
368 if (unlikely(stopping))
369 pool_flush(pool_head_tasklet);
370}
371
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200372void __task_queue(struct task *task, struct eb_root *wq);
373
Willy Tarreau4726f532009-03-07 17:25:21 +0100374/* Place <task> into the wait queue, where it may already be. If the expiration
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100375 * timer is infinite, do nothing and rely on wake_expired_task to clean up.
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200376 * If the task is bound to a single thread, it's assumed to be bound to the
377 * current thread's queue and is queued without locking. Otherwise it's queued
378 * into the global wait queue, protected by locks.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200379 */
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100380static inline void task_queue(struct task *task)
381{
382 /* If we already have a place in the wait queue no later than the
383 * timeout we're trying to set, we'll stay there, because it is very
384 * unlikely that we will reach the timeout anyway. If the timeout
385 * has been disabled, it's useless to leave the queue as well. We'll
386 * rely on wake_expired_tasks() to catch the node and move it to the
387 * proper place should it ever happen. Finally we only add the task
388 * to the queue if it was not there or if it was further than what
389 * we want.
390 */
391 if (!tick_isset(task->expire))
392 return;
393
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200394#ifdef USE_THREAD
395 if (atleast2(task->thread_mask)) {
Willy Tarreauef28dc12019-05-28 18:48:07 +0200396 HA_RWLOCK_WRLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200397 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
398 __task_queue(task, &timers);
Willy Tarreauef28dc12019-05-28 18:48:07 +0200399 HA_RWLOCK_WRUNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200400 } else
401#endif
402 {
403 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200404 __task_queue(task, &task_per_thread[tid].timers);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200405 }
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100406}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200407
Willy Tarreau26e48812011-07-25 14:30:42 +0200408/* Ensure <task> will be woken up at most at <when>. If the task is already in
409 * the run queue (but not running), nothing is done. It may be used that way
410 * with a delay : task_schedule(task, tick_add(now_ms, delay));
411 */
412static inline void task_schedule(struct task *task, int when)
413{
Emeric Brunc60def82017-09-27 14:59:38 +0200414 /* TODO: mthread, check if there is no tisk with this test */
Willy Tarreau26e48812011-07-25 14:30:42 +0200415 if (task_in_rq(task))
416 return;
417
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200418#ifdef USE_THREAD
419 if (atleast2(task->thread_mask)) {
Willy Tarreauef28dc12019-05-28 18:48:07 +0200420 /* FIXME: is it really needed to lock the WQ during the check ? */
421 HA_RWLOCK_WRLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200422 if (task_in_wq(task))
423 when = tick_first(when, task->expire);
424
425 task->expire = when;
426 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
427 __task_queue(task, &timers);
Willy Tarreauef28dc12019-05-28 18:48:07 +0200428 HA_RWLOCK_WRUNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200429 } else
430#endif
431 {
432 if (task_in_wq(task))
433 when = tick_first(when, task->expire);
Willy Tarreau26e48812011-07-25 14:30:42 +0200434
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200435 task->expire = when;
436 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200437 __task_queue(task, &task_per_thread[tid].timers);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200438 }
Willy Tarreau26e48812011-07-25 14:30:42 +0200439}
440
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200441/* This function register a new signal. "lua" is the current lua
442 * execution context. It contains a pointer to the associated task.
443 * "link" is a list head attached to an other task that must be wake
444 * the lua task if an event occurs. This is useful with external
445 * events like TCP I/O or sleep functions. This funcion allocate
446 * memory for the signal.
447 */
448static inline struct notification *notification_new(struct list *purge, struct list *event, struct task *wakeup)
449{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100450 struct notification *com = pool_alloc(pool_head_notification);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200451 if (!com)
452 return NULL;
453 LIST_ADDQ(purge, &com->purge_me);
454 LIST_ADDQ(event, &com->wake_me);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100455 HA_SPIN_INIT(&com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200456 com->task = wakeup;
457 return com;
458}
459
460/* This function purge all the pending signals when the LUA execution
461 * is finished. This prevent than a coprocess try to wake a deleted
462 * task. This function remove the memory associated to the signal.
Thierry FOURNIERd5b79832017-12-10 17:14:07 +0100463 * The purge list is not locked because it is owned by only one
464 * process. before browsing this list, the caller must ensure to be
465 * the only one browser.
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200466 */
467static inline void notification_purge(struct list *purge)
468{
469 struct notification *com, *back;
470
471 /* Delete all pending communication signals. */
472 list_for_each_entry_safe(com, back, purge, purge_me) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100473 HA_SPIN_LOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200474 LIST_DEL(&com->purge_me);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200475 if (!com->task) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100476 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100477 pool_free(pool_head_notification, com);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200478 continue;
479 }
480 com->task = NULL;
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100481 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200482 }
483}
484
Thierry FOURNIERcb146882017-12-10 17:10:57 +0100485/* In some cases, the disconnected notifications must be cleared.
486 * This function just release memory blocs. The purge list is not
487 * locked because it is owned by only one process. Before browsing
488 * this list, the caller must ensure to be the only one browser.
489 * The "com" is not locked because when com->task is NULL, the
490 * notification is no longer used.
491 */
492static inline void notification_gc(struct list *purge)
493{
494 struct notification *com, *back;
495
496 /* Delete all pending communication signals. */
497 list_for_each_entry_safe (com, back, purge, purge_me) {
498 if (com->task)
499 continue;
500 LIST_DEL(&com->purge_me);
501 pool_free(pool_head_notification, com);
502 }
503}
504
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200505/* This function sends signals. It wakes all the tasks attached
506 * to a list head, and remove the signal, and free the used
Thierry FOURNIERd5b79832017-12-10 17:14:07 +0100507 * memory. The wake list is not locked because it is owned by
508 * only one process. before browsing this list, the caller must
509 * ensure to be the only one browser.
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200510 */
511static inline void notification_wake(struct list *wake)
512{
513 struct notification *com, *back;
514
515 /* Wake task and delete all pending communication signals. */
516 list_for_each_entry_safe(com, back, wake, wake_me) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100517 HA_SPIN_LOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200518 LIST_DEL(&com->wake_me);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200519 if (!com->task) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100520 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100521 pool_free(pool_head_notification, com);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200522 continue;
523 }
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200524 task_wakeup(com->task, TASK_WOKEN_MSG);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200525 com->task = NULL;
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100526 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200527 }
528}
529
Thierry FOURNIER9d5422a2018-05-30 11:40:08 +0200530/* This function returns true is some notification are pending
531 */
532static inline int notification_registered(struct list *wake)
533{
534 return !LIST_ISEMPTY(wake);
535}
536
Olivier Houchardcfbb3e62019-05-29 19:22:43 +0200537static inline int thread_has_tasks(void)
538{
539 return (!!(global_tasks_mask & tid_bit) |
540 (task_per_thread[tid].rqueue_size > 0) |
541 !LIST_ISEMPTY(&task_per_thread[tid].task_list));
542}
543
Willy Tarreau42facc52019-07-12 08:31:17 +0200544/* adds list item <item> to work list <work> and wake up the associated task */
545static inline void work_list_add(struct work_list *work, struct list *item)
546{
547 LIST_ADDQ_LOCKED(&work->head, item);
548 task_wakeup(work->task, TASK_WOKEN_OTHER);
549}
550
551struct work_list *work_list_create(int nbthread,
552 struct task *(*fct)(struct task *, void *, unsigned short),
553 void *arg);
554
555void work_list_destroy(struct work_list *work, int nbthread);
556
Willy Tarreaubaaee002006-06-26 02:48:02 +0200557/*
Willy Tarreau918ff602011-07-25 16:33:49 +0200558 * This does 3 things :
Willy Tarreaubaaee002006-06-26 02:48:02 +0200559 * - wake up all expired tasks
560 * - call all runnable tasks
Willy Tarreaud825eef2007-05-12 22:35:00 +0200561 * - return the date of next event in <next> or eternity.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200562 */
563
Thierry FOURNIER9cf7c4b2014-12-15 13:26:01 +0100564void process_runnable_tasks();
Willy Tarreaubaaee002006-06-26 02:48:02 +0200565
Willy Tarreau58b458d2008-06-29 22:40:23 +0200566/*
567 * Extract all expired timers from the timer queue, and wakes up all
568 * associated tasks. Returns the date of next event (or eternity).
569 */
Thierry FOURNIER9cf7c4b2014-12-15 13:26:01 +0100570int wake_expired_tasks();
Willy Tarreau58b458d2008-06-29 22:40:23 +0200571
William Lallemand27f3fa52018-12-06 14:05:20 +0100572/*
573 * Delete every tasks before running the master polling loop
574 */
575void mworker_cleantasks();
576
Willy Tarreaubaaee002006-06-26 02:48:02 +0200577#endif /* _PROTO_TASK_H */
578
579/*
580 * Local variables:
581 * c-indent-level: 8
582 * c-basic-offset: 8
583 * End:
584 */