blob: b29d84a9144f60334d2e786322d2e2603905c18b [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
Olivier Houchardbba1a262019-09-24 14:55:28 +020041#include <proto/fd.h>
42
Willy Tarreaud0a201b2009-03-08 15:53:06 +010043/* Principle of the wait queue.
44 *
45 * We want to be able to tell whether an expiration date is before of after the
46 * current time <now>. We KNOW that expiration dates are never too far apart,
47 * because they are measured in ticks (milliseconds). We also know that almost
48 * all dates will be in the future, and that a very small part of them will be
49 * in the past, they are the ones which have expired since last time we checked
50 * them. Using ticks, we know if a date is in the future or in the past, but we
51 * cannot use that to store sorted information because that reference changes
52 * all the time.
53 *
Willy Tarreaue35c94a2009-03-21 10:01:42 +010054 * We'll use the fact that the time wraps to sort timers. Timers above <now>
55 * are in the future, timers below <now> are in the past. Here, "above" and
56 * "below" are to be considered modulo 2^31.
Willy Tarreaud0a201b2009-03-08 15:53:06 +010057 *
Willy Tarreaue35c94a2009-03-21 10:01:42 +010058 * Timers are stored sorted in an ebtree. We use the new ability for ebtrees to
59 * lookup values starting from X to only expire tasks between <now> - 2^31 and
60 * <now>. If the end of the tree is reached while walking over it, we simply
61 * loop back to the beginning. That way, we have no problem keeping sorted
62 * wrapping timers in a tree, between (now - 24 days) and (now + 24 days). The
63 * keys in the tree always reflect their real position, none can be infinite.
64 * This reduces the number of checks to be performed.
Willy Tarreaud0a201b2009-03-08 15:53:06 +010065 *
66 * Another nice optimisation is to allow a timer to stay at an old place in the
67 * queue as long as it's not further than the real expiration date. That way,
68 * we use the tree as a place holder for a minorant of the real expiration
69 * date. Since we have a very low chance of hitting a timeout anyway, we can
70 * bounce the nodes to their right place when we scan the tree if we encounter
71 * a misplaced node once in a while. This even allows us not to remove the
72 * infinite timers from the wait queue.
73 *
74 * So, to summarize, we have :
75 * - node->key always defines current position in the wait queue
76 * - timer is the real expiration date (possibly infinite)
Willy Tarreaue35c94a2009-03-21 10:01:42 +010077 * - node->key is always before or equal to timer
Willy Tarreaud0a201b2009-03-08 15:53:06 +010078 *
79 * The run queue works similarly to the wait queue except that the current date
80 * is replaced by an insertion counter which can also wrap without any problem.
81 */
82
Willy Tarreaue35c94a2009-03-21 10:01:42 +010083/* The farthest we can look back in a timer tree */
84#define TIMER_LOOK_BACK (1U << 31)
Willy Tarreaud0a201b2009-03-08 15:53:06 +010085
86/* a few exported variables */
Willy Tarreaua4613182009-03-21 18:13:21 +010087extern unsigned int nb_tasks; /* total number of tasks */
Willy Tarreauaa1e1be2019-05-16 17:37:27 +020088extern volatile unsigned long global_tasks_mask; /* Mask of threads with tasks in the global runqueue */
Christopher Faulet34c5cc92016-12-06 09:15:30 +010089extern unsigned int tasks_run_queue; /* run queue size */
90extern unsigned int tasks_run_queue_cur;
Willy Tarreauc7bdf092009-03-21 18:33:52 +010091extern unsigned int nb_tasks_cur;
Willy Tarreau91e99932008-06-30 07:51:00 +020092extern unsigned int niced_tasks; /* number of niced tasks in the run queue */
Willy Tarreaubafbe012017-11-24 17:34:44 +010093extern struct pool_head *pool_head_task;
Olivier Houchardb0bdae72018-05-18 18:45:28 +020094extern struct pool_head *pool_head_tasklet;
Willy Tarreaubafbe012017-11-24 17:34:44 +010095extern struct pool_head *pool_head_notification;
Willy Tarreaud022e9c2019-09-24 08:25:15 +020096extern THREAD_LOCAL struct task_per_thread *sched; /* current's thread scheduler context */
Olivier Houchardb1ca58b2018-06-06 14:22:03 +020097#ifdef USE_THREAD
Willy Tarreaub20aa9e2018-10-15 14:52:21 +020098extern struct eb_root timers; /* sorted timers tree, global */
Olivier Houchardf6e6dc12018-05-18 18:38:23 +020099extern struct eb_root rqueue; /* tree constituting the run queue */
Olivier Houchard77551ee2018-07-26 15:59:38 +0200100extern int global_rqueue_size; /* Number of element sin the global runqueue */
Olivier Houchardb1ca58b2018-06-06 14:22:03 +0200101#endif
Olivier Houchard77551ee2018-07-26 15:59:38 +0200102
Willy Tarreau8d8747a2018-10-15 16:12:48 +0200103extern struct task_per_thread task_per_thread[MAX_THREADS];
Christopher Faulet9dcf9b62017-11-13 10:34:01 +0100104
105__decl_hathreads(extern HA_SPINLOCK_T rq_lock); /* spin lock related to run queue */
Willy Tarreauef28dc12019-05-28 18:48:07 +0200106__decl_hathreads(extern HA_RWLOCK_T wq_lock); /* RW lock related to the wait queue */
Willy Tarreauc6ca1a02007-05-13 19:43:47 +0200107
Olivier Houchard5d187182018-08-01 15:58:44 +0200108
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 Tarreaud022e9c2019-09-24 08:25:15 +0200137 root = &sched->rqueue;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200138 else
139 root = &rqueue;
140#else
Willy Tarreaud022e9c2019-09-24 08:25:15 +0200141 struct eb_root *root = &sched->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 Tarreauef28dc12019-05-28 18:48:07 +0200182 HA_RWLOCK_WRLOCK(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 Tarreauef28dc12019-05-28 18:48:07 +0200185 HA_RWLOCK_WRUNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200186 }
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 Tarreaud022e9c2019-09-24 08:25:15 +0200206 sched->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{
Willy Tarreau8cdc1672019-10-18 06:43:53 +0200231 if (likely(tl->tid < 0)) {
232 /* this tasklet runs on the caller thread */
Olivier Houchard06910462019-10-11 16:35:01 +0200233 if (LIST_ISEMPTY(&tl->list)) {
Willy Tarreau8cdc1672019-10-18 06:43:53 +0200234 LIST_ADDQ(&task_per_thread[tid].task_list, &tl->list);
Olivier Houchard06910462019-10-11 16:35:01 +0200235 _HA_ATOMIC_ADD(&tasks_run_queue, 1);
236 }
237 } else {
Willy Tarreau8cdc1672019-10-18 06:43:53 +0200238 /* this tasklet runs on a specific thread */
Olivier Houchard06910462019-10-11 16:35:01 +0200239 if (MT_LIST_ADDQ(&task_per_thread[tl->tid].shared_tasklet_list, (struct mt_list *)&tl->list) == 1) {
240 _HA_ATOMIC_ADD(&tasks_run_queue, 1);
Willy Tarreau891b5ef2019-10-18 08:45:41 +0200241 if (sleeping_thread_mask & (1UL << tl->tid)) {
242 _HA_ATOMIC_AND(&sleeping_thread_mask, ~(1UL << tl->tid));
Olivier Houchard06910462019-10-11 16:35:01 +0200243 wake_thread(tl->tid);
244 }
Olivier Houchardbba1a262019-09-24 14:55:28 +0200245 }
246 }
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200247
248}
249
Willy Tarreaubd20a9d2019-06-14 18:05:54 +0200250/* Insert a tasklet into the tasklet list. If used with a plain task instead,
251 * the caller must update the task_list_size.
252 */
253static inline void tasklet_insert_into_tasklet_list(struct tasklet *tl)
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200254{
Olivier Houchard06910462019-10-11 16:35:01 +0200255 _HA_ATOMIC_ADD(&tasks_run_queue, 1);
256 LIST_ADDQ(&sched->task_list, &tl->list);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200257}
258
Willy Tarreaubd20a9d2019-06-14 18:05:54 +0200259/* Remove the tasklet from the tasklet list. The tasklet MUST already be there.
260 * If unsure, use tasklet_remove_from_tasklet_list() instead. If used with a
261 * plain task, the caller must update the task_list_size.
Olivier Houchard06910462019-10-11 16:35:01 +0200262 * This should only be used by the thread that owns the tasklet, any other
263 * thread should use tasklet_cancel().
Willy Tarreaue73256f2019-03-25 18:02:54 +0100264 */
Willy Tarreau86eded62019-06-14 14:47:49 +0200265static inline void __tasklet_remove_from_tasklet_list(struct tasklet *t)
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200266{
Olivier Houchard06910462019-10-11 16:35:01 +0200267 LIST_DEL_INIT(&t->list);
268 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200269}
270
Willy Tarreau86eded62019-06-14 14:47:49 +0200271static inline void tasklet_remove_from_tasklet_list(struct tasklet *t)
Willy Tarreaue73256f2019-03-25 18:02:54 +0100272{
Olivier Houchard7031e3d2019-11-08 15:41:55 +0100273 if (MT_LIST_DEL((struct mt_list *)&t->list))
274 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Willy Tarreaue73256f2019-03-25 18:02:54 +0100275}
276
Willy Tarreauce44f122008-07-05 18:16:19 +0200277/*
Willy Tarreaua4613182009-03-21 18:13:21 +0100278 * Initialize a new task. The bare minimum is performed (queue pointers and
279 * state). The task is returned. This function should not be used outside of
280 * task_new().
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200281 */
Emeric Brunc60def82017-09-27 14:59:38 +0200282static inline struct task *task_init(struct task *t, unsigned long thread_mask)
Willy Tarreau9789f7b2008-06-24 08:17:16 +0200283{
Willy Tarreau4726f532009-03-07 17:25:21 +0100284 t->wq.node.leaf_p = NULL;
285 t->rq.node.leaf_p = NULL;
Olivier Houchardf6e6dc12018-05-18 18:38:23 +0200286 t->state = TASK_SLEEPING;
Willy Tarreauf65610a2017-10-31 16:06:06 +0100287 t->thread_mask = thread_mask;
Willy Tarreau91e99932008-06-30 07:51:00 +0200288 t->nice = 0;
Willy Tarreau3884cba2009-03-28 17:54:35 +0100289 t->calls = 0;
Willy Tarreau9efd7452018-05-31 14:48:54 +0200290 t->call_date = 0;
291 t->cpu_time = 0;
292 t->lat_time = 0;
Willy Tarreauf4219992017-07-24 17:52:58 +0200293 t->expire = TICK_ETERNITY;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200294 return t;
295}
296
Willy Tarreau8cdc1672019-10-18 06:43:53 +0200297/* Initialize a new tasklet. It's identified as a tasklet by ->nice=-32768. It
298 * is expected to run on the calling thread by default, it's up to the caller
299 * to change ->tid if it wants to own it.
300 */
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200301static inline void tasklet_init(struct tasklet *t)
302{
303 t->nice = -32768;
304 t->calls = 0;
305 t->state = 0;
Olivier Houchard9ddaf792018-07-19 16:02:16 +0200306 t->process = NULL;
Willy Tarreau8cdc1672019-10-18 06:43:53 +0200307 t->tid = -1;
Olivier Houchard06910462019-10-11 16:35:01 +0200308 LIST_INIT(&t->list);
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200309}
310
Willy Tarreau8cdc1672019-10-18 06:43:53 +0200311/* Allocate and initialize a new tasklet, local to the thread by default. The
312 * caller may assing its tid if it wants to own the tasklet.
313 */
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200314static inline struct tasklet *tasklet_new(void)
315{
316 struct tasklet *t = pool_alloc(pool_head_tasklet);
317
318 if (t) {
319 tasklet_init(t);
320 }
321 return t;
322}
323
Willy Tarreaubaaee002006-06-26 02:48:02 +0200324/*
Willy Tarreaua4613182009-03-21 18:13:21 +0100325 * Allocate and initialise a new task. The new task is returned, or NULL in
326 * case of lack of memory. The task count is incremented. Tasks should only
327 * be allocated this way, and must be freed using task_free().
328 */
Emeric Brunc60def82017-09-27 14:59:38 +0200329static inline struct task *task_new(unsigned long thread_mask)
Willy Tarreaua4613182009-03-21 18:13:21 +0100330{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100331 struct task *t = pool_alloc(pool_head_task);
Willy Tarreaua4613182009-03-21 18:13:21 +0100332 if (t) {
Olivier Houchard4c2832852019-03-08 18:48:47 +0100333 _HA_ATOMIC_ADD(&nb_tasks, 1);
Emeric Brunc60def82017-09-27 14:59:38 +0200334 task_init(t, thread_mask);
Willy Tarreaua4613182009-03-21 18:13:21 +0100335 }
336 return t;
337}
338
339/*
Willy Tarreau29bf96d2019-05-17 14:16:51 +0200340 * Free a task. Its context must have been freed since it will be lost. The
341 * task count is decremented. It it is the current task, this one is reset.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200342 */
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200343static inline void __task_free(struct task *t)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200344{
Willy Tarreaud022e9c2019-09-24 08:25:15 +0200345 if (t == sched->current) {
346 sched->current = NULL;
Willy Tarreau29bf96d2019-05-17 14:16:51 +0200347 __ha_barrier_store();
348 }
Willy Tarreaubafbe012017-11-24 17:34:44 +0100349 pool_free(pool_head_task, t);
Willy Tarreaueb118892014-11-13 16:57:19 +0100350 if (unlikely(stopping))
Willy Tarreaubafbe012017-11-24 17:34:44 +0100351 pool_flush(pool_head_task);
Olivier Houchard4c2832852019-03-08 18:48:47 +0100352 _HA_ATOMIC_SUB(&nb_tasks, 1);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200353}
354
Willy Tarreauf6562792019-05-07 19:05:35 +0200355/* Destroys a task : it's unlinked from the wait queues and is freed if it's
356 * the current task or not queued otherwise it's marked to be freed by the
357 * scheduler. It does nothing if <t> is NULL.
358 */
Olivier Houchard3f795f72019-04-17 22:51:06 +0200359static inline void task_destroy(struct task *t)
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200360{
Dragan Dosen75bc6d32019-05-07 15:25:25 +0200361 if (!t)
362 return;
363
Olivier Houchard3f795f72019-04-17 22:51:06 +0200364 task_unlink_wq(t);
365 /* We don't have to explicitely remove from the run queue.
366 * If we are in the runqueue, the test below will set t->process
367 * to NULL, and the task will be free'd when it'll be its turn
368 * to run.
369 */
370
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200371 /* There's no need to protect t->state with a lock, as the task
372 * has to run on the current thread.
373 */
Willy Tarreaud022e9c2019-09-24 08:25:15 +0200374 if (t == sched->current || !(t->state & (TASK_QUEUED | TASK_RUNNING)))
Olivier Houchard9b36cb42018-05-04 15:46:16 +0200375 __task_free(t);
376 else
377 t->process = NULL;
378}
379
Olivier Houchard06910462019-10-11 16:35:01 +0200380/* Should only be called by the thread responsible for the tasklet */
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200381static inline void tasklet_free(struct tasklet *tl)
382{
Olivier Houchard06910462019-10-11 16:35:01 +0200383 if (!LIST_ISEMPTY(&tl->list)) {
384 LIST_DEL(&tl->list);
385 _HA_ATOMIC_SUB(&tasks_run_queue, 1);
Olivier Houchard09e498f2018-12-24 14:03:10 +0100386 }
Olivier Houcharddcd6f3a2018-06-08 17:08:19 +0200387
Olivier Houchardb0bdae72018-05-18 18:45:28 +0200388 pool_free(pool_head_tasklet, tl);
389 if (unlikely(stopping))
390 pool_flush(pool_head_tasklet);
391}
392
Olivier Houchardff1e9f32019-09-20 17:18:35 +0200393static inline void tasklet_set_tid(struct tasklet *tl, int tid)
394{
395 tl->tid = tid;
396}
397
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200398void __task_queue(struct task *task, struct eb_root *wq);
399
Willy Tarreau4726f532009-03-07 17:25:21 +0100400/* Place <task> into the wait queue, where it may already be. If the expiration
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100401 * timer is infinite, do nothing and rely on wake_expired_task to clean up.
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200402 * If the task is bound to a single thread, it's assumed to be bound to the
403 * current thread's queue and is queued without locking. Otherwise it's queued
404 * into the global wait queue, protected by locks.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200405 */
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100406static inline void task_queue(struct task *task)
407{
408 /* If we already have a place in the wait queue no later than the
409 * timeout we're trying to set, we'll stay there, because it is very
410 * unlikely that we will reach the timeout anyway. If the timeout
411 * has been disabled, it's useless to leave the queue as well. We'll
412 * rely on wake_expired_tasks() to catch the node and move it to the
413 * proper place should it ever happen. Finally we only add the task
414 * to the queue if it was not there or if it was further than what
415 * we want.
416 */
417 if (!tick_isset(task->expire))
418 return;
419
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200420#ifdef USE_THREAD
421 if (atleast2(task->thread_mask)) {
Willy Tarreauef28dc12019-05-28 18:48:07 +0200422 HA_RWLOCK_WRLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200423 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
424 __task_queue(task, &timers);
Willy Tarreauef28dc12019-05-28 18:48:07 +0200425 HA_RWLOCK_WRUNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200426 } else
427#endif
428 {
429 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
Willy Tarreaud022e9c2019-09-24 08:25:15 +0200430 __task_queue(task, &sched->timers);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200431 }
Willy Tarreau531cf0c2009-03-08 16:35:27 +0100432}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200433
Willy Tarreau26e48812011-07-25 14:30:42 +0200434/* Ensure <task> will be woken up at most at <when>. If the task is already in
435 * the run queue (but not running), nothing is done. It may be used that way
436 * with a delay : task_schedule(task, tick_add(now_ms, delay));
437 */
438static inline void task_schedule(struct task *task, int when)
439{
Emeric Brunc60def82017-09-27 14:59:38 +0200440 /* TODO: mthread, check if there is no tisk with this test */
Willy Tarreau26e48812011-07-25 14:30:42 +0200441 if (task_in_rq(task))
442 return;
443
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200444#ifdef USE_THREAD
445 if (atleast2(task->thread_mask)) {
Willy Tarreauef28dc12019-05-28 18:48:07 +0200446 /* FIXME: is it really needed to lock the WQ during the check ? */
447 HA_RWLOCK_WRLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200448 if (task_in_wq(task))
449 when = tick_first(when, task->expire);
450
451 task->expire = when;
452 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
453 __task_queue(task, &timers);
Willy Tarreauef28dc12019-05-28 18:48:07 +0200454 HA_RWLOCK_WRUNLOCK(TASK_WQ_LOCK, &wq_lock);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200455 } else
456#endif
457 {
458 if (task_in_wq(task))
459 when = tick_first(when, task->expire);
Willy Tarreau26e48812011-07-25 14:30:42 +0200460
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200461 task->expire = when;
462 if (!task_in_wq(task) || tick_is_lt(task->expire, task->wq.key))
Willy Tarreaud022e9c2019-09-24 08:25:15 +0200463 __task_queue(task, &sched->timers);
Willy Tarreaub20aa9e2018-10-15 14:52:21 +0200464 }
Willy Tarreau26e48812011-07-25 14:30:42 +0200465}
466
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200467/* This function register a new signal. "lua" is the current lua
468 * execution context. It contains a pointer to the associated task.
469 * "link" is a list head attached to an other task that must be wake
470 * the lua task if an event occurs. This is useful with external
471 * events like TCP I/O or sleep functions. This funcion allocate
472 * memory for the signal.
473 */
474static inline struct notification *notification_new(struct list *purge, struct list *event, struct task *wakeup)
475{
Willy Tarreaubafbe012017-11-24 17:34:44 +0100476 struct notification *com = pool_alloc(pool_head_notification);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200477 if (!com)
478 return NULL;
479 LIST_ADDQ(purge, &com->purge_me);
480 LIST_ADDQ(event, &com->wake_me);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100481 HA_SPIN_INIT(&com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200482 com->task = wakeup;
483 return com;
484}
485
486/* This function purge all the pending signals when the LUA execution
487 * is finished. This prevent than a coprocess try to wake a deleted
488 * task. This function remove the memory associated to the signal.
Thierry FOURNIERd5b79832017-12-10 17:14:07 +0100489 * The purge list is not locked because it is owned by only one
490 * process. before browsing this list, the caller must ensure to be
491 * the only one browser.
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200492 */
493static inline void notification_purge(struct list *purge)
494{
495 struct notification *com, *back;
496
497 /* Delete all pending communication signals. */
498 list_for_each_entry_safe(com, back, purge, purge_me) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100499 HA_SPIN_LOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200500 LIST_DEL(&com->purge_me);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200501 if (!com->task) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100502 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100503 pool_free(pool_head_notification, com);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200504 continue;
505 }
506 com->task = NULL;
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100507 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200508 }
509}
510
Thierry FOURNIERcb146882017-12-10 17:10:57 +0100511/* In some cases, the disconnected notifications must be cleared.
512 * This function just release memory blocs. The purge list is not
513 * locked because it is owned by only one process. Before browsing
514 * this list, the caller must ensure to be the only one browser.
515 * The "com" is not locked because when com->task is NULL, the
516 * notification is no longer used.
517 */
518static inline void notification_gc(struct list *purge)
519{
520 struct notification *com, *back;
521
522 /* Delete all pending communication signals. */
523 list_for_each_entry_safe (com, back, purge, purge_me) {
524 if (com->task)
525 continue;
526 LIST_DEL(&com->purge_me);
527 pool_free(pool_head_notification, com);
528 }
529}
530
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200531/* This function sends signals. It wakes all the tasks attached
532 * to a list head, and remove the signal, and free the used
Thierry FOURNIERd5b79832017-12-10 17:14:07 +0100533 * memory. The wake list is not locked because it is owned by
534 * only one process. before browsing this list, the caller must
535 * ensure to be the only one browser.
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200536 */
537static inline void notification_wake(struct list *wake)
538{
539 struct notification *com, *back;
540
541 /* Wake task and delete all pending communication signals. */
542 list_for_each_entry_safe(com, back, wake, wake_me) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100543 HA_SPIN_LOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200544 LIST_DEL(&com->wake_me);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200545 if (!com->task) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100546 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100547 pool_free(pool_head_notification, com);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200548 continue;
549 }
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200550 task_wakeup(com->task, TASK_WOKEN_MSG);
Thierry FOURNIER738a6d72017-07-17 00:14:07 +0200551 com->task = NULL;
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100552 HA_SPIN_UNLOCK(NOTIF_LOCK, &com->lock);
Thierry FOURNIERd6975962017-07-12 14:31:10 +0200553 }
554}
555
Thierry FOURNIER9d5422a2018-05-30 11:40:08 +0200556/* This function returns true is some notification are pending
557 */
558static inline int notification_registered(struct list *wake)
559{
560 return !LIST_ISEMPTY(wake);
561}
562
Olivier Houchardcfbb3e62019-05-29 19:22:43 +0200563static inline int thread_has_tasks(void)
564{
565 return (!!(global_tasks_mask & tid_bit) |
Willy Tarreaud022e9c2019-09-24 08:25:15 +0200566 (sched->rqueue_size > 0) |
Olivier Houchard06910462019-10-11 16:35:01 +0200567 !LIST_ISEMPTY(&sched->task_list) | !MT_LIST_ISEMPTY(&sched->shared_tasklet_list));
Olivier Houchardcfbb3e62019-05-29 19:22:43 +0200568}
569
Willy Tarreau64e60122019-07-12 08:31:17 +0200570/* adds list item <item> to work list <work> and wake up the associated task */
Olivier Houchard859dc802019-08-08 15:47:21 +0200571static inline void work_list_add(struct work_list *work, struct mt_list *item)
Willy Tarreau64e60122019-07-12 08:31:17 +0200572{
Olivier Houchard859dc802019-08-08 15:47:21 +0200573 MT_LIST_ADDQ(&work->head, item);
Willy Tarreau64e60122019-07-12 08:31:17 +0200574 task_wakeup(work->task, TASK_WOKEN_OTHER);
575}
576
577struct work_list *work_list_create(int nbthread,
578 struct task *(*fct)(struct task *, void *, unsigned short),
579 void *arg);
580
581void work_list_destroy(struct work_list *work, int nbthread);
582
Willy Tarreaubaaee002006-06-26 02:48:02 +0200583/*
Willy Tarreau918ff602011-07-25 16:33:49 +0200584 * This does 3 things :
Willy Tarreaubaaee002006-06-26 02:48:02 +0200585 * - wake up all expired tasks
586 * - call all runnable tasks
Willy Tarreaud825eef2007-05-12 22:35:00 +0200587 * - return the date of next event in <next> or eternity.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200588 */
589
Thierry FOURNIER9cf7c4b2014-12-15 13:26:01 +0100590void process_runnable_tasks();
Willy Tarreaubaaee002006-06-26 02:48:02 +0200591
Willy Tarreau58b458d2008-06-29 22:40:23 +0200592/*
593 * Extract all expired timers from the timer queue, and wakes up all
594 * associated tasks. Returns the date of next event (or eternity).
595 */
Thierry FOURNIER9cf7c4b2014-12-15 13:26:01 +0100596int wake_expired_tasks();
Willy Tarreau58b458d2008-06-29 22:40:23 +0200597
William Lallemand27f3fa52018-12-06 14:05:20 +0100598/*
599 * Delete every tasks before running the master polling loop
600 */
601void mworker_cleantasks();
602
Willy Tarreaubaaee002006-06-26 02:48:02 +0200603#endif /* _PROTO_TASK_H */
604
605/*
606 * Local variables:
607 * c-indent-level: 8
608 * c-basic-offset: 8
609 * End:
610 */