Home | History | Annotate | Line # | Download | only in linux
linux_work.c revision 1.53
      1  1.53  riastrad /*	$NetBSD: linux_work.c,v 1.53 2021/12/19 11:38:03 riastradh Exp $	*/
      2   1.1     skrll 
      3   1.1     skrll /*-
      4  1.12  riastrad  * Copyright (c) 2018 The NetBSD Foundation, Inc.
      5   1.1     skrll  * All rights reserved.
      6   1.1     skrll  *
      7   1.1     skrll  * This code is derived from software contributed to The NetBSD Foundation
      8   1.1     skrll  * by Taylor R. Campbell.
      9   1.1     skrll  *
     10   1.1     skrll  * Redistribution and use in source and binary forms, with or without
     11   1.1     skrll  * modification, are permitted provided that the following conditions
     12   1.1     skrll  * are met:
     13   1.1     skrll  * 1. Redistributions of source code must retain the above copyright
     14   1.1     skrll  *    notice, this list of conditions and the following disclaimer.
     15   1.1     skrll  * 2. Redistributions in binary form must reproduce the above copyright
     16   1.1     skrll  *    notice, this list of conditions and the following disclaimer in the
     17   1.1     skrll  *    documentation and/or other materials provided with the distribution.
     18   1.1     skrll  *
     19   1.1     skrll  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20   1.1     skrll  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21   1.1     skrll  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22   1.1     skrll  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23   1.1     skrll  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24   1.1     skrll  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25   1.1     skrll  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26   1.1     skrll  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27   1.1     skrll  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28   1.1     skrll  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29   1.1     skrll  * POSSIBILITY OF SUCH DAMAGE.
     30   1.1     skrll  */
     31   1.1     skrll 
     32   1.1     skrll #include <sys/cdefs.h>
     33  1.53  riastrad __KERNEL_RCSID(0, "$NetBSD: linux_work.c,v 1.53 2021/12/19 11:38:03 riastradh Exp $");
     34   1.1     skrll 
     35   1.1     skrll #include <sys/types.h>
     36   1.1     skrll #include <sys/atomic.h>
     37   1.1     skrll #include <sys/callout.h>
     38   1.1     skrll #include <sys/condvar.h>
     39   1.1     skrll #include <sys/errno.h>
     40   1.1     skrll #include <sys/kmem.h>
     41  1.12  riastrad #include <sys/kthread.h>
     42  1.12  riastrad #include <sys/lwp.h>
     43   1.1     skrll #include <sys/mutex.h>
     44  1.44       ryo #ifndef _MODULE
     45  1.44       ryo #include <sys/once.h>
     46  1.44       ryo #endif
     47   1.1     skrll #include <sys/queue.h>
     48  1.41  riastrad #include <sys/sdt.h>
     49   1.1     skrll 
     50   1.1     skrll #include <linux/workqueue.h>
     51   1.1     skrll 
     52  1.39  riastrad TAILQ_HEAD(work_head, work_struct);
     53  1.39  riastrad TAILQ_HEAD(dwork_head, delayed_work);
     54  1.39  riastrad 
     55   1.1     skrll struct workqueue_struct {
     56  1.39  riastrad 	kmutex_t		wq_lock;
     57  1.39  riastrad 	kcondvar_t		wq_cv;
     58  1.39  riastrad 	struct dwork_head	wq_delayed; /* delayed work scheduled */
     59  1.39  riastrad 	struct work_head	wq_queue;   /* work to run */
     60  1.39  riastrad 	struct work_head	wq_dqueue;  /* delayed work to run now */
     61  1.39  riastrad 	struct work_struct	*wq_current_work;
     62  1.39  riastrad 	int			wq_flags;
     63  1.39  riastrad 	bool			wq_dying;
     64  1.39  riastrad 	uint64_t		wq_gen;
     65  1.39  riastrad 	struct lwp		*wq_lwp;
     66  1.50  riastrad 	const char		*wq_name;
     67   1.1     skrll };
     68   1.1     skrll 
     69  1.12  riastrad static void __dead	linux_workqueue_thread(void *);
     70  1.12  riastrad static void		linux_workqueue_timeout(void *);
     71  1.39  riastrad static bool		work_claimed(struct work_struct *,
     72  1.39  riastrad 			    struct workqueue_struct *);
     73  1.17  riastrad static struct workqueue_struct *
     74  1.39  riastrad 			work_queue(struct work_struct *);
     75  1.39  riastrad static bool		acquire_work(struct work_struct *,
     76  1.17  riastrad 			    struct workqueue_struct *);
     77  1.17  riastrad static void		release_work(struct work_struct *,
     78  1.17  riastrad 			    struct workqueue_struct *);
     79  1.33  riastrad static void		wait_for_current_work(struct work_struct *,
     80  1.33  riastrad 			    struct workqueue_struct *);
     81  1.30  riastrad static void		dw_callout_init(struct workqueue_struct *,
     82  1.30  riastrad 			    struct delayed_work *);
     83  1.31  riastrad static void		dw_callout_destroy(struct workqueue_struct *,
     84  1.31  riastrad 			    struct delayed_work *);
     85  1.23  riastrad static void		cancel_delayed_work_done(struct workqueue_struct *,
     86  1.23  riastrad 			    struct delayed_work *);
     87  1.12  riastrad 
     88  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, acquire,
     89  1.41  riastrad     "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
     90  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, release,
     91  1.41  riastrad     "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
     92  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, queue,
     93  1.41  riastrad     "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
     94  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, cancel,
     95  1.41  riastrad     "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
     96  1.41  riastrad SDT_PROBE_DEFINE3(sdt, linux, work, schedule,
     97  1.41  riastrad     "struct delayed_work *"/*dw*/, "struct workqueue_struct *"/*wq*/,
     98  1.41  riastrad     "unsigned long"/*ticks*/);
     99  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, timer,
    100  1.41  riastrad     "struct delayed_work *"/*dw*/, "struct workqueue_struct *"/*wq*/);
    101  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, wait__start,
    102  1.41  riastrad     "struct delayed_work *"/*dw*/, "struct workqueue_struct *"/*wq*/);
    103  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, wait__done,
    104  1.41  riastrad     "struct delayed_work *"/*dw*/, "struct workqueue_struct *"/*wq*/);
    105  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, run,
    106  1.41  riastrad     "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
    107  1.41  riastrad SDT_PROBE_DEFINE2(sdt, linux, work, done,
    108  1.41  riastrad     "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
    109  1.41  riastrad SDT_PROBE_DEFINE1(sdt, linux, work, batch__start,
    110  1.41  riastrad     "struct workqueue_struct *"/*wq*/);
    111  1.41  riastrad SDT_PROBE_DEFINE1(sdt, linux, work, batch__done,
    112  1.41  riastrad     "struct workqueue_struct *"/*wq*/);
    113  1.41  riastrad SDT_PROBE_DEFINE1(sdt, linux, work, flush__start,
    114  1.41  riastrad     "struct workqueue_struct *"/*wq*/);
    115  1.41  riastrad SDT_PROBE_DEFINE1(sdt, linux, work, flush__done,
    116  1.41  riastrad     "struct workqueue_struct *"/*wq*/);
    117  1.41  riastrad 
    118  1.12  riastrad static specificdata_key_t workqueue_key __read_mostly;
    119  1.12  riastrad 
    120  1.53  riastrad struct workqueue_struct	*system_highpri_wq __read_mostly;
    121  1.12  riastrad struct workqueue_struct	*system_long_wq __read_mostly;
    122  1.12  riastrad struct workqueue_struct	*system_power_efficient_wq __read_mostly;
    123  1.47  riastrad struct workqueue_struct	*system_unbound_wq __read_mostly;
    124  1.53  riastrad struct workqueue_struct	*system_wq __read_mostly;
    125   1.3  riastrad 
    126  1.39  riastrad static inline uintptr_t
    127  1.39  riastrad atomic_cas_uintptr(volatile uintptr_t *p, uintptr_t old, uintptr_t new)
    128  1.39  riastrad {
    129  1.39  riastrad 
    130  1.39  riastrad 	return (uintptr_t)atomic_cas_ptr(p, (void *)old, (void *)new);
    131  1.39  riastrad }
    132  1.39  riastrad 
    133  1.36  riastrad /*
    134  1.36  riastrad  * linux_workqueue_init()
    135  1.36  riastrad  *
    136  1.36  riastrad  *	Initialize the Linux workqueue subsystem.  Return 0 on success,
    137  1.36  riastrad  *	NetBSD error on failure.
    138  1.36  riastrad  */
    139  1.44       ryo static int
    140  1.44       ryo linux_workqueue_init0(void)
    141   1.1     skrll {
    142  1.12  riastrad 	int error;
    143   1.3  riastrad 
    144  1.12  riastrad 	error = lwp_specific_key_create(&workqueue_key, NULL);
    145  1.12  riastrad 	if (error)
    146  1.53  riastrad 		goto out;
    147   1.1     skrll 
    148  1.53  riastrad 	system_highpri_wq = alloc_ordered_workqueue("lnxhipwq", 0);
    149  1.53  riastrad 	if (system_highpri_wq == NULL) {
    150  1.12  riastrad 		error = ENOMEM;
    151  1.53  riastrad 		goto out;
    152  1.12  riastrad 	}
    153   1.2  riastrad 
    154   1.2  riastrad 	system_long_wq = alloc_ordered_workqueue("lnxlngwq", 0);
    155  1.12  riastrad 	if (system_long_wq == NULL) {
    156  1.12  riastrad 		error = ENOMEM;
    157  1.53  riastrad 		goto out;
    158  1.12  riastrad 	}
    159   1.1     skrll 
    160   1.6  riastrad 	system_power_efficient_wq = alloc_ordered_workqueue("lnxpwrwq", 0);
    161  1.46  riastrad 	if (system_power_efficient_wq == NULL) {
    162  1.12  riastrad 		error = ENOMEM;
    163  1.53  riastrad 		goto out;
    164  1.12  riastrad 	}
    165   1.6  riastrad 
    166  1.47  riastrad 	system_unbound_wq = alloc_ordered_workqueue("lnxubdwq", 0);
    167  1.47  riastrad 	if (system_unbound_wq == NULL) {
    168  1.47  riastrad 		error = ENOMEM;
    169  1.53  riastrad 		goto out;
    170  1.47  riastrad 	}
    171  1.47  riastrad 
    172  1.53  riastrad 	system_wq = alloc_ordered_workqueue("lnxsyswq", 0);
    173  1.53  riastrad 	if (system_wq == NULL) {
    174  1.53  riastrad 		error = ENOMEM;
    175  1.53  riastrad 		goto out;
    176  1.53  riastrad 	}
    177  1.53  riastrad 
    178  1.53  riastrad 	/* Success!  */
    179  1.53  riastrad 	error = 0;
    180  1.53  riastrad 
    181  1.53  riastrad out:	if (error) {
    182  1.53  riastrad 		if (system_highpri_wq)
    183  1.53  riastrad 			destroy_workqueue(system_highpri_wq);
    184  1.53  riastrad 		if (system_long_wq)
    185  1.53  riastrad 			destroy_workqueue(system_long_wq);
    186  1.53  riastrad 		if (system_power_efficient_wq)
    187  1.53  riastrad 			destroy_workqueue(system_power_efficient_wq);
    188  1.53  riastrad 		if (system_unbound_wq)
    189  1.53  riastrad 			destroy_workqueue(system_unbound_wq);
    190  1.53  riastrad 		if (system_wq)
    191  1.53  riastrad 			destroy_workqueue(system_wq);
    192  1.53  riastrad 		if (workqueue_key)
    193  1.53  riastrad 			lwp_specific_key_delete(workqueue_key);
    194  1.53  riastrad 	}
    195   1.2  riastrad 
    196  1.12  riastrad 	return error;
    197   1.1     skrll }
    198   1.1     skrll 
    199  1.36  riastrad /*
    200  1.36  riastrad  * linux_workqueue_fini()
    201  1.36  riastrad  *
    202  1.36  riastrad  *	Destroy the Linux workqueue subsystem.  Never fails.
    203  1.36  riastrad  */
    204  1.44       ryo static void
    205  1.44       ryo linux_workqueue_fini0(void)
    206   1.1     skrll {
    207   1.2  riastrad 
    208  1.12  riastrad 	destroy_workqueue(system_power_efficient_wq);
    209   1.2  riastrad 	destroy_workqueue(system_long_wq);
    210   1.1     skrll 	destroy_workqueue(system_wq);
    211  1.12  riastrad 	lwp_specific_key_delete(workqueue_key);
    212   1.1     skrll }
    213  1.44       ryo 
    214  1.44       ryo #ifndef _MODULE
    215  1.44       ryo static ONCE_DECL(linux_workqueue_init_once);
    216  1.44       ryo #endif
    217  1.44       ryo 
    218  1.44       ryo int
    219  1.44       ryo linux_workqueue_init(void)
    220  1.44       ryo {
    221  1.44       ryo #ifdef _MODULE
    222  1.44       ryo 	return linux_workqueue_init0();
    223  1.44       ryo #else
    224  1.44       ryo 	return INIT_ONCE(&linux_workqueue_init_once, &linux_workqueue_init0);
    225  1.44       ryo #endif
    226  1.44       ryo }
    227  1.44       ryo 
    228  1.44       ryo void
    229  1.44       ryo linux_workqueue_fini(void)
    230  1.44       ryo {
    231  1.44       ryo #ifdef _MODULE
    232  1.44       ryo 	return linux_workqueue_fini0();
    233  1.44       ryo #else
    234  1.44       ryo 	return FINI_ONCE(&linux_workqueue_init_once, &linux_workqueue_fini0);
    235  1.44       ryo #endif
    236  1.44       ryo }
    237   1.1     skrll 
    238   1.1     skrll /*
    240   1.1     skrll  * Workqueues
    241   1.1     skrll  */
    242  1.36  riastrad 
    243  1.52  riastrad /*
    244  1.36  riastrad  * alloc_workqueue(name, flags, max_active)
    245  1.52  riastrad  *
    246  1.52  riastrad  *	Create a workqueue of the given name.  max_active is the
    247  1.52  riastrad  *	maximum number of work items in flight, or 0 for the default.
    248  1.52  riastrad  *	Return NULL on failure, pointer to struct workqueue_struct
    249  1.36  riastrad  *	object on success.
    250   1.1     skrll  */
    251  1.52  riastrad struct workqueue_struct *
    252   1.1     skrll alloc_workqueue(const char *name, int flags, unsigned max_active)
    253   1.1     skrll {
    254   1.1     skrll 	struct workqueue_struct *wq;
    255   1.1     skrll 	int error;
    256  1.52  riastrad 
    257   1.1     skrll 	KASSERT(max_active == 0 || max_active == 1);
    258  1.25  riastrad 
    259   1.1     skrll 	wq = kmem_zalloc(sizeof(*wq), KM_SLEEP);
    260  1.43  riastrad 
    261   1.1     skrll 	mutex_init(&wq->wq_lock, MUTEX_DEFAULT, IPL_VM);
    262   1.1     skrll 	cv_init(&wq->wq_cv, name);
    263  1.12  riastrad 	TAILQ_INIT(&wq->wq_delayed);
    264  1.39  riastrad 	TAILQ_INIT(&wq->wq_queue);
    265   1.1     skrll 	TAILQ_INIT(&wq->wq_dqueue);
    266  1.25  riastrad 	wq->wq_current_work = NULL;
    267  1.25  riastrad 	wq->wq_flags = 0;
    268  1.37  riastrad 	wq->wq_dying = false;
    269  1.37  riastrad 	wq->wq_gen = 0;
    270  1.50  riastrad 	wq->wq_lwp = NULL;
    271   1.1     skrll 	wq->wq_name = name;
    272  1.12  riastrad 
    273  1.12  riastrad 	error = kthread_create(PRI_NONE,
    274  1.12  riastrad 	    KTHREAD_MPSAFE|KTHREAD_TS|KTHREAD_MUSTJOIN, NULL,
    275  1.12  riastrad 	    &linux_workqueue_thread, wq, &wq->wq_lwp, "%s", name);
    276  1.12  riastrad 	if (error)
    277   1.3  riastrad 		goto fail0;
    278   1.1     skrll 
    279  1.12  riastrad 	return wq;
    280  1.39  riastrad 
    281  1.39  riastrad fail0:	KASSERT(TAILQ_EMPTY(&wq->wq_dqueue));
    282  1.12  riastrad 	KASSERT(TAILQ_EMPTY(&wq->wq_queue));
    283  1.12  riastrad 	KASSERT(TAILQ_EMPTY(&wq->wq_delayed));
    284  1.12  riastrad 	cv_destroy(&wq->wq_cv);
    285  1.12  riastrad 	mutex_destroy(&wq->wq_lock);
    286  1.12  riastrad 	kmem_free(wq, sizeof(*wq));
    287   1.1     skrll 	return NULL;
    288   1.1     skrll }
    289  1.36  riastrad 
    290  1.52  riastrad /*
    291  1.52  riastrad  * alloc_ordered_workqueue(name, flags)
    292  1.52  riastrad  *
    293  1.52  riastrad  *	Same as alloc_workqueue(name, flags, 1).
    294  1.52  riastrad  */
    295  1.52  riastrad struct workqueue_struct *
    296  1.52  riastrad alloc_ordered_workqueue(const char *name, int flags)
    297  1.52  riastrad {
    298  1.52  riastrad 
    299  1.52  riastrad 	return alloc_workqueue(name, flags, 1);
    300  1.52  riastrad }
    301  1.52  riastrad 
    302  1.36  riastrad /*
    303  1.36  riastrad  * destroy_workqueue(wq)
    304  1.36  riastrad  *
    305  1.36  riastrad  *	Destroy a workqueue created with wq.  Cancel any pending
    306  1.36  riastrad  *	delayed work.  Wait for all queued work to complete.
    307  1.36  riastrad  *
    308  1.36  riastrad  *	May sleep.
    309   1.1     skrll  */
    310   1.1     skrll void
    311   1.1     skrll destroy_workqueue(struct workqueue_struct *wq)
    312   1.1     skrll {
    313   1.1     skrll 
    314  1.12  riastrad 	/*
    315  1.12  riastrad 	 * Cancel all delayed work.  We do this first because any
    316  1.12  riastrad 	 * delayed work that that has already timed out, which we can't
    317   1.1     skrll 	 * cancel, may have queued new work.
    318  1.26  riastrad 	 */
    319  1.26  riastrad 	mutex_enter(&wq->wq_lock);
    320  1.26  riastrad 	while (!TAILQ_EMPTY(&wq->wq_delayed)) {
    321   1.1     skrll 		struct delayed_work *const dw = TAILQ_FIRST(&wq->wq_delayed);
    322  1.39  riastrad 
    323  1.26  riastrad 		KASSERT(work_queue(&dw->work) == wq);
    324  1.26  riastrad 		KASSERTMSG((dw->dw_state == DELAYED_WORK_SCHEDULED ||
    325  1.26  riastrad 			dw->dw_state == DELAYED_WORK_RESCHEDULED ||
    326  1.26  riastrad 			dw->dw_state == DELAYED_WORK_CANCELLED),
    327  1.26  riastrad 		    "delayed work %p in bad state: %d",
    328  1.26  riastrad 		    dw, dw->dw_state);
    329  1.26  riastrad 
    330  1.26  riastrad 		/*
    331  1.26  riastrad 		 * Mark it cancelled and try to stop the callout before
    332  1.26  riastrad 		 * it starts.
    333  1.26  riastrad 		 *
    334  1.26  riastrad 		 * If it's too late and the callout has already begun
    335  1.26  riastrad 		 * to execute, then it will notice that we asked to
    336  1.26  riastrad 		 * cancel it and remove itself from the queue before
    337  1.26  riastrad 		 * returning.
    338  1.26  riastrad 		 *
    339  1.26  riastrad 		 * If we stopped the callout before it started,
    340  1.26  riastrad 		 * however, then we can safely destroy the callout and
    341  1.26  riastrad 		 * dissociate it from the workqueue ourselves.
    342  1.41  riastrad 		 */
    343  1.26  riastrad 		SDT_PROBE2(sdt, linux, work, cancel,  &dw->work, wq);
    344  1.26  riastrad 		dw->dw_state = DELAYED_WORK_CANCELLED;
    345  1.26  riastrad 		if (!callout_halt(&dw->dw_callout, &wq->wq_lock))
    346  1.26  riastrad 			cancel_delayed_work_done(wq, dw);
    347  1.26  riastrad 	}
    348   1.1     skrll 	mutex_exit(&wq->wq_lock);
    349  1.26  riastrad 
    350  1.26  riastrad 	/*
    351  1.26  riastrad 	 * At this point, no new work can be put on the queue.
    352   1.1     skrll 	 */
    353  1.12  riastrad 
    354  1.12  riastrad 	/* Tell the thread to exit.  */
    355  1.12  riastrad 	mutex_enter(&wq->wq_lock);
    356  1.12  riastrad 	wq->wq_dying = true;
    357  1.12  riastrad 	cv_broadcast(&wq->wq_cv);
    358  1.12  riastrad 	mutex_exit(&wq->wq_lock);
    359  1.12  riastrad 
    360  1.12  riastrad 	/* Wait for it to exit.  */
    361  1.12  riastrad 	(void)kthread_join(wq->wq_lwp);
    362  1.25  riastrad 
    363  1.25  riastrad 	KASSERT(wq->wq_dying);
    364   1.1     skrll 	KASSERT(wq->wq_flags == 0);
    365  1.39  riastrad 	KASSERT(wq->wq_current_work == NULL);
    366  1.12  riastrad 	KASSERT(TAILQ_EMPTY(&wq->wq_dqueue));
    367  1.12  riastrad 	KASSERT(TAILQ_EMPTY(&wq->wq_queue));
    368   1.1     skrll 	KASSERT(TAILQ_EMPTY(&wq->wq_delayed));
    369   1.1     skrll 	cv_destroy(&wq->wq_cv);
    370   1.1     skrll 	mutex_destroy(&wq->wq_lock);
    371   1.1     skrll 
    372   1.1     skrll 	kmem_free(wq, sizeof(*wq));
    373   1.1     skrll }
    374   1.1     skrll 
    375  1.12  riastrad /*
    377   1.1     skrll  * Work thread and callout
    378  1.36  riastrad  */
    379  1.36  riastrad 
    380  1.36  riastrad /*
    381  1.36  riastrad  * linux_workqueue_thread(cookie)
    382  1.36  riastrad  *
    383  1.36  riastrad  *	Main function for a workqueue's worker thread.  Waits until
    384  1.36  riastrad  *	there is work queued, grabs a batch of work off the queue,
    385  1.36  riastrad  *	executes it all, bumps the generation number, and repeats,
    386  1.12  riastrad  *	until dying.
    387  1.12  riastrad  */
    388   1.1     skrll static void __dead
    389  1.12  riastrad linux_workqueue_thread(void *cookie)
    390  1.45  riastrad {
    391  1.45  riastrad 	struct workqueue_struct *const wq = cookie;
    392  1.39  riastrad 	struct work_head *const q[2] = { &wq->wq_queue, &wq->wq_dqueue };
    393   1.1     skrll 	struct work_struct marker, *work;
    394  1.12  riastrad 	unsigned i;
    395   1.1     skrll 
    396  1.12  riastrad 	lwp_setspecific(workqueue_key, wq);
    397  1.12  riastrad 
    398  1.26  riastrad 	mutex_enter(&wq->wq_lock);
    399  1.26  riastrad 	for (;;) {
    400  1.26  riastrad 		/*
    401  1.26  riastrad 		 * Wait until there's activity.  If there's no work and
    402  1.42  riastrad 		 * we're dying, stop here.
    403  1.42  riastrad 		 */
    404  1.42  riastrad 		if (TAILQ_EMPTY(&wq->wq_queue) &&
    405  1.42  riastrad 		    TAILQ_EMPTY(&wq->wq_dqueue)) {
    406  1.12  riastrad 			if (wq->wq_dying)
    407  1.42  riastrad 				break;
    408  1.26  riastrad 			cv_wait(&wq->wq_cv, &wq->wq_lock);
    409   1.1     skrll 			continue;
    410  1.45  riastrad 		}
    411  1.45  riastrad 
    412  1.45  riastrad 		/*
    413  1.45  riastrad 		 * Start a batch of work.  Use a marker to delimit when
    414  1.45  riastrad 		 * the batch ends so we can advance the generation
    415  1.41  riastrad 		 * after the batch.
    416  1.39  riastrad 		 */
    417  1.45  riastrad 		SDT_PROBE1(sdt, linux, work, batch__start,  wq);
    418  1.45  riastrad 		for (i = 0; i < 2; i++) {
    419  1.45  riastrad 			if (TAILQ_EMPTY(q[i]))
    420  1.45  riastrad 				continue;
    421  1.39  riastrad 			TAILQ_INSERT_TAIL(q[i], &marker, work_entry);
    422  1.39  riastrad 			while ((work = TAILQ_FIRST(q[i])) != &marker) {
    423  1.39  riastrad 				void (*func)(struct work_struct *);
    424  1.39  riastrad 
    425  1.45  riastrad 				KASSERT(work_queue(work) == wq);
    426  1.39  riastrad 				KASSERT(work_claimed(work, wq));
    427  1.39  riastrad 				KASSERTMSG((q[i] != &wq->wq_dqueue ||
    428  1.39  riastrad 					container_of(work, struct delayed_work,
    429  1.39  riastrad 					    work)->dw_state ==
    430  1.39  riastrad 					DELAYED_WORK_IDLE),
    431  1.39  riastrad 				    "delayed work %p queued and scheduled",
    432  1.39  riastrad 				    work);
    433  1.39  riastrad 
    434  1.39  riastrad 				TAILQ_REMOVE(q[i], work, work_entry);
    435  1.39  riastrad 				KASSERT(wq->wq_current_work == NULL);
    436  1.39  riastrad 				wq->wq_current_work = work;
    437  1.39  riastrad 				func = work->func;
    438  1.12  riastrad 				release_work(work, wq);
    439  1.39  riastrad 				/* Can't dereference work after this point.  */
    440  1.41  riastrad 
    441  1.39  riastrad 				mutex_exit(&wq->wq_lock);
    442  1.41  riastrad 				SDT_PROBE2(sdt, linux, work, run,  work, wq);
    443  1.39  riastrad 				(*func)(work);
    444  1.39  riastrad 				SDT_PROBE2(sdt, linux, work, done,  work, wq);
    445  1.39  riastrad 				mutex_enter(&wq->wq_lock);
    446  1.39  riastrad 
    447  1.39  riastrad 				KASSERT(wq->wq_current_work == work);
    448  1.39  riastrad 				wq->wq_current_work = NULL;
    449  1.45  riastrad 				cv_broadcast(&wq->wq_cv);
    450  1.12  riastrad 			}
    451   1.1     skrll 			TAILQ_REMOVE(q[i], &marker, work_entry);
    452  1.12  riastrad 		}
    453  1.12  riastrad 
    454  1.12  riastrad 		/* Notify flush that we've completed a batch of work.  */
    455  1.41  riastrad 		wq->wq_gen++;
    456   1.1     skrll 		cv_broadcast(&wq->wq_cv);
    457  1.12  riastrad 		SDT_PROBE1(sdt, linux, work, batch__done,  wq);
    458   1.1     skrll 	}
    459  1.12  riastrad 	mutex_exit(&wq->wq_lock);
    460   1.1     skrll 
    461   1.1     skrll 	kthread_exit(0);
    462  1.36  riastrad }
    463  1.36  riastrad 
    464  1.36  riastrad /*
    465  1.36  riastrad  * linux_workqueue_timeout(cookie)
    466  1.36  riastrad  *
    467  1.36  riastrad  *	Delayed work timeout callback.
    468  1.36  riastrad  *
    469  1.36  riastrad  *	- If scheduled, queue it.
    470  1.36  riastrad  *	- If rescheduled, callout_schedule ourselves again.
    471  1.36  riastrad  *	- If cancelled, destroy the callout and release the work from
    472   1.1     skrll  *        the workqueue.
    473  1.12  riastrad  */
    474   1.1     skrll static void
    475  1.12  riastrad linux_workqueue_timeout(void *cookie)
    476  1.39  riastrad {
    477   1.1     skrll 	struct delayed_work *const dw = cookie;
    478  1.39  riastrad 	struct workqueue_struct *const wq = work_queue(&dw->work);
    479  1.39  riastrad 
    480  1.39  riastrad 	KASSERTMSG(wq != NULL,
    481  1.14  riastrad 	    "delayed work %p state %d resched %d",
    482  1.41  riastrad 	    dw, dw->dw_state, dw->dw_resched);
    483  1.41  riastrad 
    484  1.12  riastrad 	SDT_PROBE2(sdt, linux, work, timer,  dw, wq);
    485  1.39  riastrad 
    486  1.12  riastrad 	mutex_enter(&wq->wq_lock);
    487  1.12  riastrad 	KASSERT(work_queue(&dw->work) == wq);
    488  1.12  riastrad 	switch (dw->dw_state) {
    489  1.12  riastrad 	case DELAYED_WORK_IDLE:
    490  1.31  riastrad 		panic("delayed work callout uninitialized: %p", dw);
    491  1.39  riastrad 	case DELAYED_WORK_SCHEDULED:
    492  1.12  riastrad 		dw_callout_destroy(wq, dw);
    493  1.41  riastrad 		TAILQ_INSERT_TAIL(&wq->wq_dqueue, &dw->work, work_entry);
    494  1.12  riastrad 		cv_broadcast(&wq->wq_cv);
    495  1.12  riastrad 		SDT_PROBE2(sdt, linux, work, queue,  &dw->work, wq);
    496  1.35  riastrad 		break;
    497  1.35  riastrad 	case DELAYED_WORK_RESCHEDULED:
    498  1.12  riastrad 		KASSERT(dw->dw_resched >= 0);
    499  1.35  riastrad 		callout_schedule(&dw->dw_callout, dw->dw_resched);
    500  1.12  riastrad 		dw->dw_state = DELAYED_WORK_SCHEDULED;
    501  1.12  riastrad 		dw->dw_resched = -1;
    502  1.23  riastrad 		break;
    503  1.39  riastrad 	case DELAYED_WORK_CANCELLED:
    504  1.22  riastrad 		cancel_delayed_work_done(wq, dw);
    505  1.12  riastrad 		/* Can't dereference dw after this point.  */
    506  1.12  riastrad 		goto out;
    507  1.12  riastrad 	default:
    508  1.15  riastrad 		panic("delayed work callout in bad state: %p", dw);
    509  1.15  riastrad 	}
    510  1.22  riastrad 	KASSERT(dw->dw_state == DELAYED_WORK_IDLE ||
    511   1.1     skrll 	    dw->dw_state == DELAYED_WORK_SCHEDULED);
    512   1.1     skrll out:	mutex_exit(&wq->wq_lock);
    513  1.36  riastrad }
    514  1.36  riastrad 
    515  1.36  riastrad /*
    516  1.36  riastrad  * current_work()
    517  1.36  riastrad  *
    518  1.36  riastrad  *	If in a workqueue worker thread, return the work it is
    519  1.12  riastrad  *	currently executing.  Otherwise return NULL.
    520  1.12  riastrad  */
    521   1.1     skrll struct work_struct *
    522  1.12  riastrad current_work(void)
    523   1.1     skrll {
    524  1.12  riastrad 	struct workqueue_struct *wq = lwp_getspecific(workqueue_key);
    525  1.12  riastrad 
    526  1.12  riastrad 	/* If we're not a workqueue thread, then there's no work.  */
    527   1.1     skrll 	if (wq == NULL)
    528  1.12  riastrad 		return NULL;
    529  1.12  riastrad 
    530  1.12  riastrad 	/*
    531  1.12  riastrad 	 * Otherwise, this should be possible only while work is in
    532  1.12  riastrad 	 * progress.  Return the current work item.
    533  1.12  riastrad 	 */
    534   1.1     skrll 	KASSERT(wq->wq_current_work != NULL);
    535   1.1     skrll 	return wq->wq_current_work;
    536   1.1     skrll }
    537   1.1     skrll 
    538   1.1     skrll /*
    540  1.36  riastrad  * Work
    541  1.36  riastrad  */
    542  1.36  riastrad 
    543  1.36  riastrad /*
    544  1.36  riastrad  * INIT_WORK(work, fn)
    545  1.36  riastrad  *
    546   1.1     skrll  *	Initialize work for use with a workqueue to call fn in a worker
    547   1.1     skrll  *	thread.  There is no corresponding destruction operation.
    548   1.1     skrll  */
    549   1.1     skrll void
    550  1.39  riastrad INIT_WORK(struct work_struct *work, void (*fn)(struct work_struct *))
    551   1.4  riastrad {
    552   1.1     skrll 
    553   1.1     skrll 	work->work_owner = 0;
    554  1.36  riastrad 	work->func = fn;
    555  1.39  riastrad }
    556  1.39  riastrad 
    557  1.39  riastrad /*
    558  1.39  riastrad  * work_claimed(work, wq)
    559  1.39  riastrad  *
    560  1.39  riastrad  *	True if work is currently claimed by a workqueue, meaning it is
    561  1.39  riastrad  *	either on the queue or scheduled in a callout.  The workqueue
    562  1.39  riastrad  *	must be wq, and caller must hold wq's lock.
    563  1.39  riastrad  */
    564  1.39  riastrad static bool
    565  1.39  riastrad work_claimed(struct work_struct *work, struct workqueue_struct *wq)
    566  1.39  riastrad {
    567  1.39  riastrad 
    568  1.39  riastrad 	KASSERT(work_queue(work) == wq);
    569  1.39  riastrad 	KASSERT(mutex_owned(&wq->wq_lock));
    570  1.39  riastrad 
    571  1.39  riastrad 	return work->work_owner & 1;
    572  1.49  riastrad }
    573  1.49  riastrad 
    574  1.49  riastrad /*
    575  1.49  riastrad  * work_pending(work)
    576  1.49  riastrad  *
    577  1.49  riastrad  *	True if work is currently claimed by any workqueue, scheduled
    578  1.51  riastrad  *	to run on that workqueue.
    579  1.49  riastrad  */
    580  1.49  riastrad bool
    581  1.49  riastrad work_pending(const struct work_struct *work)
    582  1.49  riastrad {
    583  1.49  riastrad 
    584  1.49  riastrad 	return work->work_owner & 1;
    585  1.39  riastrad }
    586  1.39  riastrad 
    587  1.39  riastrad /*
    588  1.39  riastrad  * work_queue(work)
    589  1.39  riastrad  *
    590  1.39  riastrad  *	Return the last queue that work was queued on, or NULL if it
    591  1.39  riastrad  *	was never queued.
    592  1.39  riastrad  */
    593  1.39  riastrad static struct workqueue_struct *
    594  1.39  riastrad work_queue(struct work_struct *work)
    595  1.39  riastrad {
    596  1.39  riastrad 
    597  1.39  riastrad 	return (struct workqueue_struct *)(work->work_owner & ~(uintptr_t)1);
    598  1.36  riastrad }
    599  1.36  riastrad 
    600  1.39  riastrad /*
    601  1.39  riastrad  * acquire_work(work, wq)
    602  1.39  riastrad  *
    603  1.39  riastrad  *	Try to claim work for wq.  If work is already claimed, it must
    604  1.36  riastrad  *	be claimed by wq; return false.  If work is not already
    605  1.36  riastrad  *	claimed, claim it, issue a memory barrier to match any prior
    606  1.36  riastrad  *	release_work, and return true.
    607  1.39  riastrad  *
    608  1.17  riastrad  *	Caller must hold wq's lock.
    609  1.17  riastrad  */
    610  1.39  riastrad static bool
    611  1.17  riastrad acquire_work(struct work_struct *work, struct workqueue_struct *wq)
    612  1.17  riastrad {
    613  1.39  riastrad 	uintptr_t owner0, owner;
    614  1.17  riastrad 
    615  1.39  riastrad 	KASSERT(mutex_owned(&wq->wq_lock));
    616  1.39  riastrad 	KASSERT(((uintptr_t)wq & 1) == 0);
    617  1.39  riastrad 
    618  1.39  riastrad 	owner = (uintptr_t)wq | 1;
    619  1.39  riastrad 	do {
    620  1.39  riastrad 		owner0 = work->work_owner;
    621  1.39  riastrad 		if (owner0 & 1) {
    622  1.39  riastrad 			KASSERT((owner0 & ~(uintptr_t)1) == (uintptr_t)wq);
    623  1.39  riastrad 			return false;
    624  1.39  riastrad 		}
    625  1.39  riastrad 		KASSERT(owner0 == (uintptr_t)NULL || owner0 == (uintptr_t)wq);
    626  1.39  riastrad 	} while (atomic_cas_uintptr(&work->work_owner, owner0, owner) !=
    627  1.39  riastrad 	    owner0);
    628  1.41  riastrad 
    629  1.39  riastrad 	KASSERT(work_queue(work) == wq);
    630  1.17  riastrad 	membar_enter();
    631  1.17  riastrad 	SDT_PROBE2(sdt, linux, work, acquire,  work, wq);
    632  1.36  riastrad 	return true;
    633  1.36  riastrad }
    634  1.36  riastrad 
    635  1.36  riastrad /*
    636  1.36  riastrad  * release_work(work, wq)
    637  1.36  riastrad  *
    638  1.36  riastrad  *	Issue a memory barrier to match any subsequent acquire_work and
    639  1.36  riastrad  *	dissociate work from wq.
    640  1.17  riastrad  *
    641  1.17  riastrad  *	Caller must hold wq's lock and work must be associated with wq.
    642  1.17  riastrad  */
    643  1.17  riastrad static void
    644  1.39  riastrad release_work(struct work_struct *work, struct workqueue_struct *wq)
    645  1.17  riastrad {
    646  1.17  riastrad 
    647  1.41  riastrad 	KASSERT(work_queue(work) == wq);
    648  1.17  riastrad 	KASSERT(mutex_owned(&wq->wq_lock));
    649  1.39  riastrad 
    650  1.39  riastrad 	SDT_PROBE2(sdt, linux, work, release,  work, wq);
    651  1.39  riastrad 	membar_exit();
    652  1.39  riastrad 
    653  1.39  riastrad 	/*
    654  1.39  riastrad 	 * Non-interlocked r/m/w is safe here because nobody else can
    655  1.39  riastrad 	 * write to this while the claimed bit is setand the workqueue
    656  1.17  riastrad 	 * lock is held.
    657  1.17  riastrad 	 */
    658  1.36  riastrad 	work->work_owner &= ~(uintptr_t)1;
    659  1.36  riastrad }
    660  1.36  riastrad 
    661  1.36  riastrad /*
    662  1.36  riastrad  * schedule_work(work)
    663  1.36  riastrad  *
    664  1.36  riastrad  *	If work is not already queued on system_wq, queue it to be run
    665  1.36  riastrad  *	by system_wq's worker thread when it next can.  True if it was
    666  1.36  riastrad  *	newly queued, false if it was already queued.  If the work was
    667  1.36  riastrad  *	already running, queue it to run again.
    668  1.36  riastrad  *
    669   1.1     skrll  *	Caller must ensure work is not queued to run on a different
    670   1.1     skrll  *	workqueue.
    671   1.1     skrll  */
    672  1.12  riastrad bool
    673   1.1     skrll schedule_work(struct work_struct *work)
    674   1.1     skrll {
    675   1.1     skrll 
    676  1.36  riastrad 	return queue_work(system_wq, work);
    677  1.36  riastrad }
    678  1.36  riastrad 
    679  1.36  riastrad /*
    680  1.36  riastrad  * queue_work(wq, work)
    681  1.36  riastrad  *
    682  1.36  riastrad  *	If work is not already queued on wq, queue it to be run by wq's
    683  1.36  riastrad  *	worker thread when it next can.  True if it was newly queued,
    684  1.36  riastrad  *	false if it was already queued.  If the work was already
    685  1.36  riastrad  *	running, queue it to run again.
    686  1.36  riastrad  *
    687   1.1     skrll  *	Caller must ensure work is not queued to run on a different
    688   1.1     skrll  *	workqueue.
    689   1.1     skrll  */
    690   1.1     skrll bool
    691   1.1     skrll queue_work(struct workqueue_struct *wq, struct work_struct *work)
    692   1.1     skrll {
    693   1.1     skrll 	bool newly_queued;
    694  1.12  riastrad 
    695  1.39  riastrad 	KASSERT(wq != NULL);
    696  1.29  riastrad 
    697  1.29  riastrad 	mutex_enter(&wq->wq_lock);
    698  1.29  riastrad 	if (__predict_true(acquire_work(work, wq))) {
    699  1.29  riastrad 		/*
    700  1.29  riastrad 		 * It wasn't on any workqueue at all.  Put it on this
    701  1.12  riastrad 		 * one, and signal the worker thread that there is work
    702  1.39  riastrad 		 * to do.
    703  1.41  riastrad 		 */
    704   1.1     skrll 		TAILQ_INSERT_TAIL(&wq->wq_queue, work, work_entry);
    705  1.12  riastrad 		cv_broadcast(&wq->wq_cv);
    706  1.29  riastrad 		SDT_PROBE2(sdt, linux, work, queue,  work, wq);
    707  1.39  riastrad 		newly_queued = true;
    708  1.39  riastrad 	} else {
    709  1.29  riastrad 		/*
    710  1.39  riastrad 		 * It was already on this workqueue.  Nothing to do
    711   1.1     skrll 		 * since it is already queued.
    712  1.12  riastrad 		 */
    713   1.1     skrll 		newly_queued = false;
    714   1.1     skrll 	}
    715   1.1     skrll 	mutex_exit(&wq->wq_lock);
    716   1.1     skrll 
    717  1.36  riastrad 	return newly_queued;
    718  1.36  riastrad }
    719  1.36  riastrad 
    720  1.36  riastrad /*
    721  1.39  riastrad  * cancel_work(work)
    722  1.39  riastrad  *
    723  1.36  riastrad  *	If work was queued, remove it from the queue and return true.
    724   1.1     skrll  *	If work was not queued, return false.  Work may still be
    725  1.12  riastrad  *	running when this returns.
    726   1.1     skrll  */
    727  1.12  riastrad bool
    728   1.1     skrll cancel_work(struct work_struct *work)
    729   1.1     skrll {
    730  1.13  riastrad 	struct workqueue_struct *wq;
    731  1.39  riastrad 	bool cancelled_p = false;
    732  1.13  riastrad 
    733  1.13  riastrad 	/* If there's no workqueue, nothing to cancel.   */
    734  1.12  riastrad 	if ((wq = work_queue(work)) == NULL)
    735  1.39  riastrad 		goto out;
    736  1.29  riastrad 
    737  1.29  riastrad 	mutex_enter(&wq->wq_lock);
    738  1.29  riastrad 	if (__predict_false(work_queue(work) != wq)) {
    739  1.29  riastrad 		/*
    740  1.29  riastrad 		 * It has finished execution or been cancelled by
    741  1.12  riastrad 		 * another thread, and has been moved off the
    742  1.12  riastrad 		 * workqueue, so it's too to cancel.
    743  1.39  riastrad 		 */
    744  1.39  riastrad 		cancelled_p = false;
    745  1.39  riastrad 	} else {
    746  1.39  riastrad 		/* Check whether it's on the queue.  */
    747  1.39  riastrad 		if (work_claimed(work, wq)) {
    748  1.39  riastrad 			/*
    749  1.39  riastrad 			 * It is still on the queue.  Take it off the
    750  1.41  riastrad 			 * queue and report successful cancellation.
    751  1.39  riastrad 			 */
    752  1.39  riastrad 			TAILQ_REMOVE(&wq->wq_queue, work, work_entry);
    753  1.39  riastrad 			SDT_PROBE2(sdt, linux, work, cancel,  work, wq);
    754  1.39  riastrad 			release_work(work, wq);
    755  1.39  riastrad 			/* Can't dereference work after this point.  */
    756  1.39  riastrad 			cancelled_p = true;
    757  1.39  riastrad 		} else {
    758   1.1     skrll 			/* Not on the queue.  Couldn't cancel it.  */
    759  1.12  riastrad 			cancelled_p = false;
    760   1.1     skrll 		}
    761  1.13  riastrad 	}
    762   1.1     skrll 	mutex_exit(&wq->wq_lock);
    763   1.1     skrll 
    764  1.36  riastrad out:	return cancelled_p;
    765  1.36  riastrad }
    766  1.36  riastrad 
    767  1.36  riastrad /*
    768  1.39  riastrad  * cancel_work_sync(work)
    769  1.36  riastrad  *
    770  1.36  riastrad  *	If work was queued, remove it from the queue and return true.
    771  1.36  riastrad  *	If work was not queued, return false.  Either way, if work is
    772  1.36  riastrad  *	currently running, wait for it to complete.
    773  1.12  riastrad  *
    774  1.12  riastrad  *	May sleep.
    775   1.1     skrll  */
    776   1.1     skrll bool
    777  1.12  riastrad cancel_work_sync(struct work_struct *work)
    778   1.1     skrll {
    779  1.13  riastrad 	struct workqueue_struct *wq;
    780  1.39  riastrad 	bool cancelled_p = false;
    781  1.13  riastrad 
    782  1.13  riastrad 	/* If there's no workqueue, nothing to cancel.   */
    783   1.1     skrll 	if ((wq = work_queue(work)) == NULL)
    784  1.39  riastrad 		goto out;
    785  1.29  riastrad 
    786  1.29  riastrad 	mutex_enter(&wq->wq_lock);
    787  1.29  riastrad 	if (__predict_false(work_queue(work) != wq)) {
    788  1.39  riastrad 		/*
    789  1.29  riastrad 		 * It has finished execution or been cancelled by
    790  1.12  riastrad 		 * another thread, and has been moved off the
    791  1.12  riastrad 		 * workqueue, so it's too late to cancel.
    792  1.39  riastrad 		 */
    793  1.39  riastrad 		cancelled_p = false;
    794  1.39  riastrad 	} else {
    795  1.39  riastrad 		/* Check whether it's on the queue.  */
    796  1.39  riastrad 		if (work_claimed(work, wq)) {
    797  1.39  riastrad 			/*
    798  1.39  riastrad 			 * It is still on the queue.  Take it off the
    799  1.41  riastrad 			 * queue and report successful cancellation.
    800  1.39  riastrad 			 */
    801  1.39  riastrad 			TAILQ_REMOVE(&wq->wq_queue, work, work_entry);
    802  1.39  riastrad 			SDT_PROBE2(sdt, linux, work, cancel,  work, wq);
    803  1.39  riastrad 			release_work(work, wq);
    804  1.39  riastrad 			/* Can't dereference work after this point.  */
    805  1.39  riastrad 			cancelled_p = true;
    806  1.39  riastrad 		} else {
    807  1.39  riastrad 			/* Not on the queue.  Couldn't cancel it.  */
    808  1.39  riastrad 			cancelled_p = false;
    809  1.39  riastrad 		}
    810  1.12  riastrad 		/* If it's still running, wait for it to complete.  */
    811   1.1     skrll 		if (wq->wq_current_work == work)
    812   1.1     skrll 			wait_for_current_work(work, wq);
    813  1.13  riastrad 	}
    814   1.1     skrll 	mutex_exit(&wq->wq_lock);
    815  1.33  riastrad 
    816  1.33  riastrad out:	return cancelled_p;
    817  1.33  riastrad }
    818  1.33  riastrad 
    819  1.33  riastrad /*
    820  1.39  riastrad  * wait_for_current_work(work, wq)
    821  1.39  riastrad  *
    822  1.33  riastrad  *	wq must be currently executing work.  Wait for it to finish.
    823  1.33  riastrad  *
    824  1.33  riastrad  *	Does not dereference work.
    825  1.33  riastrad  */
    826  1.33  riastrad static void
    827  1.33  riastrad wait_for_current_work(struct work_struct *work, struct workqueue_struct *wq)
    828  1.33  riastrad {
    829  1.33  riastrad 	uint64_t gen;
    830  1.33  riastrad 
    831  1.33  riastrad 	KASSERT(mutex_owned(&wq->wq_lock));
    832  1.41  riastrad 	KASSERT(wq->wq_current_work == work);
    833  1.33  riastrad 
    834  1.33  riastrad 	/* Wait only one generation in case it gets requeued quickly.  */
    835  1.33  riastrad 	SDT_PROBE2(sdt, linux, work, wait__start,  work, wq);
    836  1.33  riastrad 	gen = wq->wq_gen;
    837  1.41  riastrad 	do {
    838  1.33  riastrad 		cv_wait(&wq->wq_cv, &wq->wq_lock);
    839   1.1     skrll 	} while (wq->wq_current_work == work && wq->wq_gen == gen);
    840   1.1     skrll 	SDT_PROBE2(sdt, linux, work, wait__done,  work, wq);
    841   1.1     skrll }
    842   1.1     skrll 
    843   1.1     skrll /*
    845  1.36  riastrad  * Delayed work
    846  1.36  riastrad  */
    847  1.36  riastrad 
    848  1.36  riastrad /*
    849  1.36  riastrad  * INIT_DELAYED_WORK(dw, fn)
    850  1.36  riastrad  *
    851   1.1     skrll  *	Initialize dw for use with a workqueue to call fn in a worker
    852   1.1     skrll  *	thread after a delay.  There is no corresponding destruction
    853   1.1     skrll  *	operation.
    854  1.12  riastrad  */
    855   1.1     skrll void
    856  1.12  riastrad INIT_DELAYED_WORK(struct delayed_work *dw, void (*fn)(struct work_struct *))
    857  1.35  riastrad {
    858  1.12  riastrad 
    859  1.12  riastrad 	INIT_WORK(&dw->work, fn);
    860  1.12  riastrad 	dw->dw_state = DELAYED_WORK_IDLE;
    861  1.12  riastrad 	dw->dw_resched = -1;
    862  1.12  riastrad 
    863  1.12  riastrad 	/*
    864  1.12  riastrad 	 * Defer callout_init until we are going to schedule the
    865   1.1     skrll 	 * callout, which can then callout_destroy it, because
    866   1.1     skrll 	 * otherwise since there's no DESTROY_DELAYED_WORK or anything
    867  1.36  riastrad 	 * we have no opportunity to call callout_destroy.
    868  1.36  riastrad 	 */
    869  1.36  riastrad }
    870  1.36  riastrad 
    871  1.36  riastrad /*
    872  1.36  riastrad  * schedule_delayed_work(dw, ticks)
    873  1.36  riastrad  *
    874  1.36  riastrad  *	If it is not currently scheduled, schedule dw to run after
    875  1.36  riastrad  *	ticks on system_wq.  If currently executing and not already
    876  1.36  riastrad  *	rescheduled, reschedule it.  True if it was newly scheduled,
    877  1.36  riastrad  *	false if it was already scheduled.
    878   1.1     skrll  *
    879   1.1     skrll  *	If ticks == 0, queue it to run as soon as the worker can,
    880   1.1     skrll  *	without waiting for the next callout tick to run.
    881  1.12  riastrad  */
    882   1.1     skrll bool
    883   1.1     skrll schedule_delayed_work(struct delayed_work *dw, unsigned long ticks)
    884   1.1     skrll {
    885  1.29  riastrad 
    886  1.30  riastrad 	return queue_delayed_work(system_wq, dw, ticks);
    887  1.30  riastrad }
    888  1.30  riastrad 
    889  1.30  riastrad /*
    890  1.30  riastrad  * dw_callout_init(wq, dw)
    891  1.30  riastrad  *
    892  1.30  riastrad  *	Initialize the callout of dw and transition to
    893  1.30  riastrad  *	DELAYED_WORK_SCHEDULED.  Caller must use callout_schedule.
    894  1.30  riastrad  */
    895  1.30  riastrad static void
    896  1.39  riastrad dw_callout_init(struct workqueue_struct *wq, struct delayed_work *dw)
    897  1.30  riastrad {
    898  1.30  riastrad 
    899  1.30  riastrad 	KASSERT(mutex_owned(&wq->wq_lock));
    900  1.30  riastrad 	KASSERT(work_queue(&dw->work) == wq);
    901  1.30  riastrad 	KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
    902  1.30  riastrad 
    903  1.30  riastrad 	callout_init(&dw->dw_callout, CALLOUT_MPSAFE);
    904  1.30  riastrad 	callout_setfunc(&dw->dw_callout, &linux_workqueue_timeout, dw);
    905  1.30  riastrad 	TAILQ_INSERT_HEAD(&wq->wq_delayed, dw, dw_entry);
    906  1.31  riastrad 	dw->dw_state = DELAYED_WORK_SCHEDULED;
    907  1.31  riastrad }
    908  1.31  riastrad 
    909  1.31  riastrad /*
    910  1.31  riastrad  * dw_callout_destroy(wq, dw)
    911  1.31  riastrad  *
    912  1.31  riastrad  *	Destroy the callout of dw and transition to DELAYED_WORK_IDLE.
    913  1.31  riastrad  */
    914  1.31  riastrad static void
    915  1.39  riastrad dw_callout_destroy(struct workqueue_struct *wq, struct delayed_work *dw)
    916  1.31  riastrad {
    917  1.31  riastrad 
    918  1.31  riastrad 	KASSERT(mutex_owned(&wq->wq_lock));
    919  1.31  riastrad 	KASSERT(work_queue(&dw->work) == wq);
    920  1.31  riastrad 	KASSERT(dw->dw_state == DELAYED_WORK_SCHEDULED ||
    921  1.31  riastrad 	    dw->dw_state == DELAYED_WORK_RESCHEDULED ||
    922  1.35  riastrad 	    dw->dw_state == DELAYED_WORK_CANCELLED);
    923  1.31  riastrad 
    924  1.31  riastrad 	TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
    925  1.31  riastrad 	callout_destroy(&dw->dw_callout);
    926  1.31  riastrad 	dw->dw_resched = -1;
    927  1.29  riastrad 	dw->dw_state = DELAYED_WORK_IDLE;
    928  1.29  riastrad }
    929  1.29  riastrad 
    930  1.29  riastrad /*
    931  1.39  riastrad  * cancel_delayed_work_done(wq, dw)
    932  1.29  riastrad  *
    933  1.23  riastrad  *	Complete cancellation of a delayed work: transition from
    934  1.23  riastrad  *	DELAYED_WORK_CANCELLED to DELAYED_WORK_IDLE and off the
    935  1.23  riastrad  *	workqueue.  Caller must not dereference dw after this returns.
    936  1.23  riastrad  */
    937  1.23  riastrad static void
    938  1.39  riastrad cancel_delayed_work_done(struct workqueue_struct *wq, struct delayed_work *dw)
    939  1.23  riastrad {
    940  1.31  riastrad 
    941  1.31  riastrad 	KASSERT(mutex_owned(&wq->wq_lock));
    942  1.23  riastrad 	KASSERT(work_queue(&dw->work) == wq);
    943  1.39  riastrad 	KASSERT(dw->dw_state == DELAYED_WORK_CANCELLED);
    944  1.23  riastrad 
    945  1.23  riastrad 	dw_callout_destroy(wq, dw);
    946  1.29  riastrad 	release_work(&dw->work, wq);
    947  1.29  riastrad 	/* Can't dereference dw after this point.  */
    948  1.29  riastrad }
    949  1.29  riastrad 
    950  1.39  riastrad /*
    951  1.39  riastrad  * queue_delayed_work(wq, dw, ticks)
    952  1.36  riastrad  *
    953  1.36  riastrad  *	If it is not currently scheduled, schedule dw to run after
    954  1.36  riastrad  *	ticks on wq.  If currently queued, remove it from the queue
    955  1.29  riastrad  *	first.
    956  1.12  riastrad  *
    957  1.12  riastrad  *	If ticks == 0, queue it to run as soon as the worker can,
    958  1.12  riastrad  *	without waiting for the next callout tick to run.
    959  1.12  riastrad  */
    960  1.12  riastrad bool
    961   1.1     skrll queue_delayed_work(struct workqueue_struct *wq, struct delayed_work *dw,
    962  1.12  riastrad     unsigned long ticks)
    963  1.39  riastrad {
    964  1.29  riastrad 	bool newly_queued;
    965  1.29  riastrad 
    966  1.29  riastrad 	mutex_enter(&wq->wq_lock);
    967  1.29  riastrad 	if (__predict_true(acquire_work(&dw->work, wq))) {
    968  1.12  riastrad 		/*
    969  1.29  riastrad 		 * It wasn't on any workqueue at all.  Schedule it to
    970  1.39  riastrad 		 * run on this one.
    971  1.29  riastrad 		 */
    972  1.29  riastrad 		KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
    973  1.41  riastrad 		if (ticks == 0) {
    974  1.29  riastrad 			TAILQ_INSERT_TAIL(&wq->wq_dqueue, &dw->work,
    975  1.29  riastrad 			    work_entry);
    976  1.29  riastrad 			cv_broadcast(&wq->wq_cv);
    977  1.29  riastrad 			SDT_PROBE2(sdt, linux, work, queue,  &dw->work, wq);
    978  1.29  riastrad 		} else {
    979  1.30  riastrad 			/*
    980  1.29  riastrad 			 * Initialize a callout and schedule to run
    981  1.41  riastrad 			 * after a delay.
    982  1.29  riastrad 			 */
    983  1.12  riastrad 			dw_callout_init(wq, dw);
    984  1.12  riastrad 			callout_schedule(&dw->dw_callout, MIN(INT_MAX, ticks));
    985  1.39  riastrad 			SDT_PROBE3(sdt, linux, work, schedule,  dw, wq, ticks);
    986  1.39  riastrad 		}
    987  1.39  riastrad 		newly_queued = true;
    988  1.39  riastrad 	} else {
    989  1.39  riastrad 		/* It was already on this workqueue.  */
    990  1.39  riastrad 		switch (dw->dw_state) {
    991  1.39  riastrad 		case DELAYED_WORK_IDLE:
    992  1.39  riastrad 		case DELAYED_WORK_SCHEDULED:
    993  1.39  riastrad 		case DELAYED_WORK_RESCHEDULED:
    994  1.29  riastrad 			/* On the queue or already scheduled.  Leave it.  */
    995  1.39  riastrad 			newly_queued = false;
    996  1.39  riastrad 			break;
    997  1.29  riastrad 		case DELAYED_WORK_CANCELLED:
    998  1.40  riastrad 			/*
    999  1.40  riastrad 			 * Scheduled and the callout began, but it was
   1000  1.41  riastrad 			 * cancelled.  Reschedule it.
   1001  1.41  riastrad 			 */
   1002  1.40  riastrad 			if (ticks == 0) {
   1003  1.40  riastrad 				dw->dw_state = DELAYED_WORK_SCHEDULED;
   1004  1.40  riastrad 				SDT_PROBE2(sdt, linux, work, queue,
   1005  1.41  riastrad 				    &dw->work, wq);
   1006  1.41  riastrad 			} else {
   1007  1.40  riastrad 				dw->dw_state = DELAYED_WORK_RESCHEDULED;
   1008  1.39  riastrad 				dw->dw_resched = MIN(INT_MAX, ticks);
   1009  1.39  riastrad 				SDT_PROBE3(sdt, linux, work, schedule,
   1010  1.39  riastrad 				    dw, wq, ticks);
   1011  1.39  riastrad 			}
   1012  1.39  riastrad 			newly_queued = true;
   1013  1.29  riastrad 			break;
   1014   1.1     skrll 		default:
   1015  1.12  riastrad 			panic("invalid delayed work state: %d",
   1016   1.1     skrll 			    dw->dw_state);
   1017   1.1     skrll 		}
   1018   1.1     skrll 	}
   1019   1.1     skrll 	mutex_exit(&wq->wq_lock);
   1020  1.29  riastrad 
   1021  1.29  riastrad 	return newly_queued;
   1022  1.29  riastrad }
   1023  1.39  riastrad 
   1024  1.39  riastrad /*
   1025  1.36  riastrad  * mod_delayed_work(wq, dw, ticks)
   1026  1.36  riastrad  *
   1027  1.36  riastrad  *	Schedule dw to run after ticks.  If scheduled or queued,
   1028  1.29  riastrad  *	reschedule.  If ticks == 0, run without delay.
   1029   1.1     skrll  *
   1030   1.1     skrll  *	True if it modified the timer of an already scheduled work,
   1031   1.1     skrll  *	false if it newly scheduled the work.
   1032   1.1     skrll  */
   1033   1.1     skrll bool
   1034   1.1     skrll mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dw,
   1035  1.12  riastrad     unsigned long ticks)
   1036  1.39  riastrad {
   1037  1.29  riastrad 	bool timer_modified;
   1038  1.29  riastrad 
   1039  1.29  riastrad 	mutex_enter(&wq->wq_lock);
   1040  1.29  riastrad 	if (acquire_work(&dw->work, wq)) {
   1041  1.12  riastrad 		/*
   1042  1.29  riastrad 		 * It wasn't on any workqueue at all.  Schedule it to
   1043  1.29  riastrad 		 * run on this one.
   1044  1.29  riastrad 		 */
   1045  1.29  riastrad 		KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
   1046  1.29  riastrad 		if (ticks == 0) {
   1047  1.39  riastrad 			/*
   1048  1.29  riastrad 			 * Run immediately: put it on the queue and
   1049  1.29  riastrad 			 * signal the worker thread.
   1050  1.41  riastrad 			 */
   1051  1.29  riastrad 			TAILQ_INSERT_TAIL(&wq->wq_dqueue, &dw->work,
   1052  1.29  riastrad 			    work_entry);
   1053  1.29  riastrad 			cv_broadcast(&wq->wq_cv);
   1054  1.29  riastrad 			SDT_PROBE2(sdt, linux, work, queue,  &dw->work, wq);
   1055  1.29  riastrad 		} else {
   1056  1.30  riastrad 			/*
   1057  1.30  riastrad 			 * Initialize a callout and schedule to run
   1058  1.41  riastrad 			 * after a delay.
   1059  1.29  riastrad 			 */
   1060  1.12  riastrad 			dw_callout_init(wq, dw);
   1061  1.12  riastrad 			callout_schedule(&dw->dw_callout, MIN(INT_MAX, ticks));
   1062  1.39  riastrad 			SDT_PROBE3(sdt, linux, work, schedule,  dw, wq, ticks);
   1063  1.12  riastrad 		}
   1064  1.12  riastrad 		timer_modified = false;
   1065  1.39  riastrad 	} else {
   1066  1.39  riastrad 		/* It was already on this workqueue.  */
   1067  1.39  riastrad 		switch (dw->dw_state) {
   1068  1.41  riastrad 		case DELAYED_WORK_IDLE:
   1069  1.41  riastrad 			/* On the queue.  */
   1070  1.41  riastrad 			if (ticks == 0) {
   1071  1.41  riastrad 				/* Leave it be.  */
   1072  1.29  riastrad 				SDT_PROBE2(sdt, linux, work, cancel,
   1073  1.39  riastrad 				    &dw->work, wq);
   1074  1.39  riastrad 				SDT_PROBE2(sdt, linux, work, queue,
   1075  1.39  riastrad 				    &dw->work, wq);
   1076  1.39  riastrad 			} else {
   1077  1.39  riastrad 				/* Remove from the queue and schedule.  */
   1078  1.39  riastrad 				TAILQ_REMOVE(&wq->wq_dqueue, &dw->work,
   1079  1.41  riastrad 				    work_entry);
   1080  1.41  riastrad 				dw_callout_init(wq, dw);
   1081  1.41  riastrad 				callout_schedule(&dw->dw_callout,
   1082  1.41  riastrad 				    MIN(INT_MAX, ticks));
   1083  1.12  riastrad 				SDT_PROBE2(sdt, linux, work, cancel,
   1084  1.39  riastrad 				    &dw->work, wq);
   1085  1.12  riastrad 				SDT_PROBE3(sdt, linux, work, schedule,
   1086  1.12  riastrad 				    dw, wq, ticks);
   1087  1.29  riastrad 			}
   1088  1.29  riastrad 			timer_modified = true;
   1089  1.29  riastrad 			break;
   1090  1.29  riastrad 		case DELAYED_WORK_SCHEDULED:
   1091  1.29  riastrad 			/*
   1092  1.29  riastrad 			 * It is scheduled to run after a delay.  Try
   1093  1.12  riastrad 			 * to stop it and reschedule it; if we can't,
   1094  1.29  riastrad 			 * either reschedule it or cancel it to put it
   1095  1.29  riastrad 			 * on the queue, and inform the callout.
   1096  1.29  riastrad 			 */
   1097  1.29  riastrad 			if (callout_stop(&dw->dw_callout)) {
   1098  1.29  riastrad 				/* Can't stop, callout has begun.  */
   1099  1.29  riastrad 				if (ticks == 0) {
   1100  1.29  riastrad 					/*
   1101  1.29  riastrad 					 * We don't actually need to do
   1102  1.41  riastrad 					 * anything.  The callout will
   1103  1.41  riastrad 					 * queue it as soon as it gets
   1104  1.41  riastrad 					 * the lock.
   1105  1.41  riastrad 					 */
   1106  1.29  riastrad 					SDT_PROBE2(sdt, linux, work, cancel,
   1107  1.35  riastrad 					    &dw->work, wq);
   1108  1.29  riastrad 					SDT_PROBE2(sdt, linux, work, queue,
   1109  1.35  riastrad 					    &dw->work, wq);
   1110  1.41  riastrad 				} else {
   1111  1.41  riastrad 					/* Ask the callout to reschedule.  */
   1112  1.41  riastrad 					dw->dw_state = DELAYED_WORK_RESCHEDULED;
   1113  1.41  riastrad 					dw->dw_resched = MIN(INT_MAX, ticks);
   1114  1.29  riastrad 					SDT_PROBE2(sdt, linux, work, cancel,
   1115  1.12  riastrad 					    &dw->work, wq);
   1116  1.35  riastrad 					SDT_PROBE3(sdt, linux, work, schedule,
   1117  1.29  riastrad 					    dw, wq, ticks);
   1118  1.29  riastrad 				}
   1119  1.29  riastrad 			} else {
   1120  1.29  riastrad 				/* We stopped the callout before it began.  */
   1121  1.29  riastrad 				if (ticks == 0) {
   1122  1.29  riastrad 					/*
   1123  1.29  riastrad 					 * Run immediately: destroy the
   1124  1.31  riastrad 					 * callout, put it on the
   1125  1.39  riastrad 					 * queue, and signal the worker
   1126  1.29  riastrad 					 * thread.
   1127  1.29  riastrad 					 */
   1128  1.41  riastrad 					dw_callout_destroy(wq, dw);
   1129  1.41  riastrad 					TAILQ_INSERT_TAIL(&wq->wq_dqueue,
   1130  1.41  riastrad 					    &dw->work, work_entry);
   1131  1.41  riastrad 					cv_broadcast(&wq->wq_cv);
   1132  1.29  riastrad 					SDT_PROBE2(sdt, linux, work, cancel,
   1133  1.29  riastrad 					    &dw->work, wq);
   1134  1.29  riastrad 					SDT_PROBE2(sdt, linux, work, queue,
   1135  1.29  riastrad 					    &dw->work, wq);
   1136  1.29  riastrad 				} else {
   1137  1.29  riastrad 					/*
   1138  1.29  riastrad 					 * Reschedule the callout.  No
   1139  1.41  riastrad 					 * state change.
   1140  1.41  riastrad 					 */
   1141  1.41  riastrad 					callout_schedule(&dw->dw_callout,
   1142  1.41  riastrad 					    MIN(INT_MAX, ticks));
   1143  1.29  riastrad 					SDT_PROBE2(sdt, linux, work, cancel,
   1144  1.12  riastrad 					    &dw->work, wq);
   1145  1.12  riastrad 					SDT_PROBE3(sdt, linux, work, schedule,
   1146  1.12  riastrad 					    dw, wq, ticks);
   1147  1.12  riastrad 				}
   1148  1.35  riastrad 			}
   1149  1.35  riastrad 			timer_modified = true;
   1150  1.35  riastrad 			break;
   1151  1.35  riastrad 		case DELAYED_WORK_RESCHEDULED:
   1152  1.35  riastrad 			/*
   1153  1.35  riastrad 			 * Someone rescheduled it after the callout
   1154  1.35  riastrad 			 * started but before the poor thing even had a
   1155  1.35  riastrad 			 * chance to acquire the lock.
   1156  1.35  riastrad 			 */
   1157  1.35  riastrad 			if (ticks == 0) {
   1158  1.35  riastrad 				/*
   1159  1.35  riastrad 				 * We can just switch back to
   1160  1.35  riastrad 				 * DELAYED_WORK_SCHEDULED so that the
   1161  1.35  riastrad 				 * callout will queue the work as soon
   1162  1.41  riastrad 				 * as it gets the lock.
   1163  1.41  riastrad 				 */
   1164  1.41  riastrad 				dw->dw_state = DELAYED_WORK_SCHEDULED;
   1165  1.41  riastrad 				dw->dw_resched = -1;
   1166  1.35  riastrad 				SDT_PROBE2(sdt, linux, work, cancel,
   1167  1.35  riastrad 				    &dw->work, wq);
   1168  1.35  riastrad 				SDT_PROBE2(sdt, linux, work, queue,
   1169  1.41  riastrad 				    &dw->work, wq);
   1170  1.41  riastrad 			} else {
   1171  1.41  riastrad 				/* Change the rescheduled time.  */
   1172  1.41  riastrad 				dw->dw_resched = ticks;
   1173  1.35  riastrad 				SDT_PROBE2(sdt, linux, work, cancel,
   1174  1.35  riastrad 				    &dw->work, wq);
   1175  1.35  riastrad 				SDT_PROBE3(sdt, linux, work, schedule,
   1176  1.12  riastrad 				    dw, wq, ticks);
   1177  1.12  riastrad 			}
   1178  1.35  riastrad 			timer_modified = true;
   1179  1.35  riastrad 			break;
   1180  1.35  riastrad 		case DELAYED_WORK_CANCELLED:
   1181  1.12  riastrad 			/*
   1182  1.29  riastrad 			 * Someone cancelled it after the callout
   1183  1.29  riastrad 			 * started but before the poor thing even had a
   1184  1.29  riastrad 			 * chance to acquire the lock.
   1185  1.29  riastrad 			 */
   1186  1.29  riastrad 			if (ticks == 0) {
   1187  1.29  riastrad 				/*
   1188  1.29  riastrad 				 * We can just switch back to
   1189  1.29  riastrad 				 * DELAYED_WORK_SCHEDULED so that the
   1190  1.41  riastrad 				 * callout will queue the work as soon
   1191  1.41  riastrad 				 * as it gets the lock.
   1192  1.29  riastrad 				 */
   1193  1.39  riastrad 				dw->dw_state = DELAYED_WORK_SCHEDULED;
   1194  1.29  riastrad 				SDT_PROBE2(sdt, linux, work, queue,
   1195  1.35  riastrad 				    &dw->work, wq);
   1196  1.41  riastrad 			} else {
   1197  1.41  riastrad 				/* Ask it to reschedule.  */
   1198  1.29  riastrad 				dw->dw_state = DELAYED_WORK_RESCHEDULED;
   1199  1.39  riastrad 				dw->dw_resched = MIN(INT_MAX, ticks);
   1200  1.12  riastrad 				SDT_PROBE3(sdt, linux, work, schedule,
   1201  1.12  riastrad 				    dw, wq, ticks);
   1202  1.29  riastrad 			}
   1203   1.1     skrll 			timer_modified = false;
   1204   1.1     skrll 			break;
   1205  1.12  riastrad 		default:
   1206   1.1     skrll 			panic("invalid delayed work state: %d", dw->dw_state);
   1207   1.1     skrll 		}
   1208   1.1     skrll 	}
   1209   1.1     skrll 	mutex_exit(&wq->wq_lock);
   1210  1.36  riastrad 
   1211  1.36  riastrad 	return timer_modified;
   1212  1.36  riastrad }
   1213  1.36  riastrad 
   1214  1.36  riastrad /*
   1215  1.36  riastrad  * cancel_delayed_work(dw)
   1216  1.36  riastrad  *
   1217  1.36  riastrad  *	If work was scheduled or queued, remove it from the schedule or
   1218  1.36  riastrad  *	queue and return true.  If work was not scheduled or queued,
   1219  1.36  riastrad  *	return false.  Note that work may already be running; if it
   1220   1.1     skrll  *	hasn't been rescheduled or requeued, then cancel_delayed_work
   1221   1.1     skrll  *	will return false, and either way, cancel_delayed_work will NOT
   1222   1.1     skrll  *	wait for the work to complete.
   1223  1.12  riastrad  */
   1224  1.12  riastrad bool
   1225   1.1     skrll cancel_delayed_work(struct delayed_work *dw)
   1226  1.14  riastrad {
   1227  1.39  riastrad 	struct workqueue_struct *wq;
   1228  1.14  riastrad 	bool cancelled_p;
   1229  1.14  riastrad 
   1230  1.12  riastrad 	/* If there's no workqueue, nothing to cancel.   */
   1231  1.39  riastrad 	if ((wq = work_queue(&dw->work)) == NULL)
   1232  1.12  riastrad 		return false;
   1233  1.12  riastrad 
   1234  1.12  riastrad 	mutex_enter(&wq->wq_lock);
   1235  1.12  riastrad 	if (__predict_false(work_queue(&dw->work) != wq)) {
   1236  1.35  riastrad 		cancelled_p = false;
   1237  1.35  riastrad 	} else {
   1238  1.35  riastrad 		switch (dw->dw_state) {
   1239  1.35  riastrad 		case DELAYED_WORK_IDLE:
   1240  1.39  riastrad 			/*
   1241  1.39  riastrad 			 * It is either on the queue or already running
   1242  1.39  riastrad 			 * or both.
   1243  1.12  riastrad 			 */
   1244  1.41  riastrad 			if (work_claimed(&dw->work, wq)) {
   1245  1.41  riastrad 				/* On the queue.  Remove and release.  */
   1246  1.39  riastrad 				TAILQ_REMOVE(&wq->wq_dqueue, &dw->work,
   1247  1.39  riastrad 				    work_entry);
   1248  1.12  riastrad 				SDT_PROBE2(sdt, linux, work, cancel,
   1249  1.35  riastrad 				    &dw->work, wq);
   1250  1.39  riastrad 				release_work(&dw->work, wq);
   1251  1.35  riastrad 				/* Can't dereference dw after this point.  */
   1252  1.12  riastrad 				cancelled_p = true;
   1253  1.12  riastrad 			} else {
   1254  1.12  riastrad 				/* Not on the queue, so didn't cancel.  */
   1255  1.21  riastrad 				cancelled_p = false;
   1256  1.21  riastrad 			}
   1257  1.21  riastrad 			break;
   1258  1.21  riastrad 		case DELAYED_WORK_SCHEDULED:
   1259  1.21  riastrad 			/*
   1260  1.21  riastrad 			 * If it is scheduled, mark it cancelled and
   1261  1.21  riastrad 			 * try to stop the callout before it starts.
   1262  1.21  riastrad 			 *
   1263  1.21  riastrad 			 * If it's too late and the callout has already
   1264  1.21  riastrad 			 * begun to execute, tough.
   1265  1.21  riastrad 			 *
   1266  1.21  riastrad 			 * If we stopped the callout before it started,
   1267  1.12  riastrad 			 * however, then destroy the callout and
   1268  1.41  riastrad 			 * dissociate it from the workqueue ourselves.
   1269  1.27  riastrad 			 */
   1270  1.27  riastrad 			dw->dw_state = DELAYED_WORK_CANCELLED;
   1271  1.16  riastrad 			cancelled_p = true;
   1272  1.34  riastrad 			SDT_PROBE2(sdt, linux, work, cancel,  &dw->work, wq);
   1273  1.34  riastrad 			if (!callout_stop(&dw->dw_callout))
   1274  1.34  riastrad 				cancel_delayed_work_done(wq, dw);
   1275  1.34  riastrad 			break;
   1276  1.34  riastrad 		case DELAYED_WORK_RESCHEDULED:
   1277  1.34  riastrad 			/*
   1278  1.35  riastrad 			 * If it is being rescheduled, the callout has
   1279  1.34  riastrad 			 * already fired.  We must ask it to cancel.
   1280  1.41  riastrad 			 */
   1281  1.34  riastrad 			dw->dw_state = DELAYED_WORK_CANCELLED;
   1282  1.34  riastrad 			dw->dw_resched = -1;
   1283  1.34  riastrad 			cancelled_p = true;
   1284  1.34  riastrad 			SDT_PROBE2(sdt, linux, work, cancel,  &dw->work, wq);
   1285  1.34  riastrad 			break;
   1286  1.34  riastrad 		case DELAYED_WORK_CANCELLED:
   1287  1.34  riastrad 			/*
   1288  1.34  riastrad 			 * If it is being cancelled, the callout has
   1289  1.34  riastrad 			 * already fired.  There is nothing more for us
   1290  1.34  riastrad 			 * to do.  Someone else claims credit for
   1291  1.12  riastrad 			 * cancelling it.
   1292  1.12  riastrad 			 */
   1293  1.12  riastrad 			cancelled_p = false;
   1294  1.12  riastrad 			break;
   1295   1.1     skrll 		default:
   1296  1.12  riastrad 			panic("invalid delayed work state: %d",
   1297   1.1     skrll 			    dw->dw_state);
   1298   1.1     skrll 		}
   1299   1.1     skrll 	}
   1300   1.1     skrll 	mutex_exit(&wq->wq_lock);
   1301  1.36  riastrad 
   1302  1.36  riastrad 	return cancelled_p;
   1303  1.36  riastrad }
   1304  1.36  riastrad 
   1305  1.36  riastrad /*
   1306  1.36  riastrad  * cancel_delayed_work_sync(dw)
   1307  1.36  riastrad  *
   1308  1.36  riastrad  *	If work was scheduled or queued, remove it from the schedule or
   1309  1.36  riastrad  *	queue and return true.  If work was not scheduled or queued,
   1310   1.1     skrll  *	return false.  Note that work may already be running; if it
   1311   1.1     skrll  *	hasn't been rescheduled or requeued, then cancel_delayed_work
   1312   1.1     skrll  *	will return false; either way, wait for it to complete.
   1313  1.12  riastrad  */
   1314  1.24  riastrad bool
   1315   1.1     skrll cancel_delayed_work_sync(struct delayed_work *dw)
   1316  1.24  riastrad {
   1317  1.39  riastrad 	struct workqueue_struct *wq;
   1318  1.24  riastrad 	bool cancelled_p;
   1319  1.14  riastrad 
   1320  1.12  riastrad 	/* If there's no workqueue, nothing to cancel.  */
   1321  1.39  riastrad 	if ((wq = work_queue(&dw->work)) == NULL)
   1322  1.12  riastrad 		return false;
   1323  1.12  riastrad 
   1324  1.20  riastrad 	mutex_enter(&wq->wq_lock);
   1325  1.12  riastrad 	if (__predict_false(work_queue(&dw->work) != wq)) {
   1326  1.35  riastrad 		cancelled_p = false;
   1327  1.35  riastrad 	} else {
   1328  1.35  riastrad 		switch (dw->dw_state) {
   1329  1.35  riastrad 		case DELAYED_WORK_IDLE:
   1330  1.39  riastrad 			/*
   1331  1.39  riastrad 			 * It is either on the queue or already running
   1332  1.39  riastrad 			 * or both.
   1333  1.12  riastrad 			 */
   1334  1.41  riastrad 			if (work_claimed(&dw->work, wq)) {
   1335  1.41  riastrad 				/* On the queue.  Remove and release.  */
   1336  1.39  riastrad 				TAILQ_REMOVE(&wq->wq_dqueue, &dw->work,
   1337  1.39  riastrad 				    work_entry);
   1338  1.12  riastrad 				SDT_PROBE2(sdt, linux, work, cancel,
   1339  1.39  riastrad 				    &dw->work, wq);
   1340  1.39  riastrad 				release_work(&dw->work, wq);
   1341  1.39  riastrad 				/* Can't dereference dw after this point.  */
   1342  1.12  riastrad 				cancelled_p = true;
   1343  1.39  riastrad 			} else {
   1344  1.39  riastrad 				/* Not on the queue, so didn't cancel. */
   1345  1.39  riastrad 				cancelled_p = false;
   1346  1.12  riastrad 			}
   1347  1.12  riastrad 			/* If it's still running, wait for it to complete.  */
   1348  1.12  riastrad 			if (wq->wq_current_work == &dw->work)
   1349  1.20  riastrad 				wait_for_current_work(&dw->work, wq);
   1350  1.20  riastrad 			break;
   1351  1.20  riastrad 		case DELAYED_WORK_SCHEDULED:
   1352  1.20  riastrad 			/*
   1353  1.20  riastrad 			 * If it is scheduled, mark it cancelled and
   1354  1.24  riastrad 			 * try to stop the callout before it starts.
   1355  1.24  riastrad 			 *
   1356  1.24  riastrad 			 * If it's too late and the callout has already
   1357  1.20  riastrad 			 * begun to execute, we must wait for it to
   1358  1.20  riastrad 			 * complete.  But we got in soon enough to ask
   1359  1.35  riastrad 			 * the callout not to run, so we successfully
   1360  1.20  riastrad 			 * cancelled it in that case.
   1361  1.12  riastrad 			 *
   1362  1.12  riastrad 			 * If we stopped the callout before it started,
   1363  1.41  riastrad 			 * then we must destroy the callout and
   1364  1.27  riastrad 			 * dissociate it from the workqueue ourselves.
   1365  1.27  riastrad 			 */
   1366  1.34  riastrad 			dw->dw_state = DELAYED_WORK_CANCELLED;
   1367  1.34  riastrad 			SDT_PROBE2(sdt, linux, work, cancel,  &dw->work, wq);
   1368  1.34  riastrad 			if (!callout_halt(&dw->dw_callout, &wq->wq_lock))
   1369  1.34  riastrad 				cancel_delayed_work_done(wq, dw);
   1370  1.34  riastrad 			cancelled_p = true;
   1371  1.34  riastrad 			break;
   1372  1.34  riastrad 		case DELAYED_WORK_RESCHEDULED:
   1373  1.34  riastrad 			/*
   1374  1.34  riastrad 			 * If it is being rescheduled, the callout has
   1375  1.35  riastrad 			 * already fired.  We must ask it to cancel and
   1376  1.41  riastrad 			 * wait for it to complete.
   1377  1.34  riastrad 			 */
   1378  1.34  riastrad 			dw->dw_state = DELAYED_WORK_CANCELLED;
   1379  1.34  riastrad 			dw->dw_resched = -1;
   1380  1.34  riastrad 			SDT_PROBE2(sdt, linux, work, cancel,  &dw->work, wq);
   1381  1.34  riastrad 			(void)callout_halt(&dw->dw_callout, &wq->wq_lock);
   1382  1.34  riastrad 			cancelled_p = true;
   1383  1.34  riastrad 			break;
   1384  1.34  riastrad 		case DELAYED_WORK_CANCELLED:
   1385  1.34  riastrad 			/*
   1386  1.34  riastrad 			 * If it is being cancelled, the callout has
   1387  1.34  riastrad 			 * already fired.  We need only wait for it to
   1388  1.34  riastrad 			 * complete.  Someone else, however, claims
   1389  1.20  riastrad 			 * credit for cancelling it.
   1390  1.12  riastrad 			 */
   1391  1.12  riastrad 			(void)callout_halt(&dw->dw_callout, &wq->wq_lock);
   1392  1.12  riastrad 			cancelled_p = false;
   1393  1.12  riastrad 			break;
   1394   1.1     skrll 		default:
   1395  1.12  riastrad 			panic("invalid delayed work state: %d",
   1396   1.1     skrll 			    dw->dw_state);
   1397   1.1     skrll 		}
   1398   1.1     skrll 	}
   1399  1.12  riastrad 	mutex_exit(&wq->wq_lock);
   1400  1.12  riastrad 
   1401  1.12  riastrad 	return cancelled_p;
   1402  1.12  riastrad }
   1403   1.1     skrll 
   1404  1.36  riastrad /*
   1406  1.36  riastrad  * Flush
   1407  1.36  riastrad  */
   1408  1.36  riastrad 
   1409  1.36  riastrad /*
   1410   1.5  riastrad  * flush_scheduled_work()
   1411  1.12  riastrad  *
   1412   1.5  riastrad  *	Wait for all work queued on system_wq to complete.  This does
   1413   1.5  riastrad  *	not include delayed work.
   1414  1.12  riastrad  */
   1415   1.5  riastrad void
   1416   1.5  riastrad flush_scheduled_work(void)
   1417  1.36  riastrad {
   1418  1.36  riastrad 
   1419  1.36  riastrad 	flush_workqueue(system_wq);
   1420  1.36  riastrad }
   1421  1.50  riastrad 
   1422  1.50  riastrad /*
   1423  1.36  riastrad  * flush_workqueue_locked(wq)
   1424  1.36  riastrad  *
   1425  1.36  riastrad  *	Wait for all work queued on wq to complete.  This does not
   1426  1.50  riastrad  *	include delayed work.  True if there was work to be flushed,
   1427  1.28  riastrad  *	false it the queue was empty.
   1428  1.28  riastrad  *
   1429  1.28  riastrad  *	Caller must hold wq's lock.
   1430  1.50  riastrad  */
   1431  1.28  riastrad static bool
   1432  1.28  riastrad flush_workqueue_locked(struct workqueue_struct *wq)
   1433  1.28  riastrad {
   1434  1.28  riastrad 	uint64_t gen;
   1435  1.28  riastrad 	bool work_queued = false;
   1436  1.28  riastrad 
   1437  1.28  riastrad 	KASSERT(mutex_owned(&wq->wq_lock));
   1438  1.28  riastrad 
   1439  1.28  riastrad 	/* Get the current generation number.  */
   1440  1.28  riastrad 	gen = wq->wq_gen;
   1441  1.50  riastrad 
   1442  1.28  riastrad 	/*
   1443  1.50  riastrad 	 * If there's a batch of work in progress, we must wait for the
   1444  1.50  riastrad 	 * worker thread to finish that batch.
   1445  1.28  riastrad 	 */
   1446  1.28  riastrad 	if (wq->wq_current_work != NULL) {
   1447  1.28  riastrad 		gen++;
   1448  1.28  riastrad 		work_queued = true;
   1449  1.28  riastrad 	}
   1450  1.28  riastrad 
   1451  1.50  riastrad 	/*
   1452  1.28  riastrad 	 * If there's any work yet to be claimed from the queue by the
   1453  1.50  riastrad 	 * worker thread, we must wait for it to finish one more batch
   1454  1.50  riastrad 	 * too.
   1455  1.28  riastrad 	 */
   1456  1.28  riastrad 	if (!TAILQ_EMPTY(&wq->wq_queue) || !TAILQ_EMPTY(&wq->wq_dqueue)) {
   1457  1.41  riastrad 		gen++;
   1458  1.28  riastrad 		work_queued = true;
   1459  1.28  riastrad 	}
   1460  1.41  riastrad 
   1461  1.50  riastrad 	/* Wait until the generation number has caught up.  */
   1462  1.50  riastrad 	SDT_PROBE1(sdt, linux, work, flush__start,  wq);
   1463  1.50  riastrad 	while (wq->wq_gen < gen)
   1464  1.28  riastrad 		cv_wait(&wq->wq_cv, &wq->wq_lock);
   1465  1.28  riastrad 	SDT_PROBE1(sdt, linux, work, flush__done,  wq);
   1466  1.36  riastrad 
   1467  1.36  riastrad 	/* Return whether we had to wait for anything.  */
   1468  1.36  riastrad 	return work_queued;
   1469  1.36  riastrad }
   1470  1.36  riastrad 
   1471  1.36  riastrad /*
   1472  1.12  riastrad  * flush_workqueue(wq)
   1473  1.12  riastrad  *
   1474   1.1     skrll  *	Wait for all work queued on wq to complete.  This does not
   1475   1.1     skrll  *	include delayed work.
   1476  1.12  riastrad  */
   1477  1.50  riastrad void
   1478  1.50  riastrad flush_workqueue(struct workqueue_struct *wq)
   1479  1.50  riastrad {
   1480  1.50  riastrad 
   1481  1.50  riastrad 	mutex_enter(&wq->wq_lock);
   1482  1.50  riastrad 	(void)flush_workqueue_locked(wq);
   1483  1.50  riastrad 	mutex_exit(&wq->wq_lock);
   1484  1.50  riastrad }
   1485  1.50  riastrad 
   1486  1.50  riastrad /*
   1487  1.50  riastrad  * drain_workqueue(wq)
   1488  1.50  riastrad  *
   1489  1.50  riastrad  *	Repeatedly flush wq until there is no more work.
   1490  1.50  riastrad  */
   1491  1.50  riastrad void
   1492  1.50  riastrad drain_workqueue(struct workqueue_struct *wq)
   1493  1.50  riastrad {
   1494  1.50  riastrad 	unsigned ntries = 0;
   1495  1.50  riastrad 
   1496  1.50  riastrad 	mutex_enter(&wq->wq_lock);
   1497  1.50  riastrad 	while (flush_workqueue_locked(wq)) {
   1498  1.12  riastrad 		if (ntries++ == 10 || (ntries % 100) == 0)
   1499   1.1     skrll 			printf("linux workqueue %s"
   1500   1.1     skrll 			    ": still clogged after %u flushes",
   1501  1.36  riastrad 			    wq->wq_name, ntries);
   1502  1.36  riastrad 	}
   1503  1.36  riastrad 	mutex_exit(&wq->wq_lock);
   1504  1.36  riastrad }
   1505  1.36  riastrad 
   1506  1.48  riastrad /*
   1507  1.48  riastrad  * flush_work(work)
   1508  1.48  riastrad  *
   1509  1.36  riastrad  *	If work is queued or currently executing, wait for it to
   1510  1.48  riastrad  *	complete.
   1511  1.12  riastrad  *
   1512   1.1     skrll  *	Return true if we waited to flush it, false if it was already
   1513  1.14  riastrad  *	idle.
   1514   1.1     skrll  */
   1515  1.14  riastrad bool
   1516  1.39  riastrad flush_work(struct work_struct *work)
   1517  1.48  riastrad {
   1518   1.1     skrll 	struct workqueue_struct *wq;
   1519  1.12  riastrad 
   1520  1.48  riastrad 	/* If there's no workqueue, nothing to flush.  */
   1521   1.1     skrll 	if ((wq = work_queue(work)) == NULL)
   1522   1.1     skrll 		return false;
   1523  1.36  riastrad 
   1524  1.36  riastrad 	flush_workqueue(wq);
   1525  1.36  riastrad 	return true;
   1526  1.38  riastrad }
   1527  1.38  riastrad 
   1528  1.38  riastrad /*
   1529  1.36  riastrad  * flush_delayed_work(dw)
   1530  1.48  riastrad  *
   1531  1.12  riastrad  *	If dw is scheduled to run after a delay, queue it immediately
   1532   1.1     skrll  *	instead.  Then, if dw is queued or currently executing, wait
   1533  1.14  riastrad  *	for it to complete.
   1534  1.48  riastrad  */
   1535   1.1     skrll bool
   1536  1.14  riastrad flush_delayed_work(struct delayed_work *dw)
   1537  1.39  riastrad {
   1538  1.48  riastrad 	struct workqueue_struct *wq;
   1539   1.1     skrll 	bool waited = false;
   1540   1.1     skrll 
   1541  1.39  riastrad 	/* If there's no workqueue, nothing to flush.  */
   1542  1.38  riastrad 	if ((wq = work_queue(&dw->work)) == NULL)
   1543  1.38  riastrad 		return false;
   1544  1.38  riastrad 
   1545  1.38  riastrad 	mutex_enter(&wq->wq_lock);
   1546  1.38  riastrad 	if (__predict_false(work_queue(&dw->work) != wq)) {
   1547  1.48  riastrad 		/*
   1548  1.38  riastrad 		 * Moved off the queue already (and possibly to another
   1549  1.28  riastrad 		 * queue, though that would be ill-advised), so it must
   1550  1.12  riastrad 		 * have completed, and we have nothing more to do.
   1551  1.28  riastrad 		 */
   1552  1.28  riastrad 		waited = false;
   1553  1.28  riastrad 	} else {
   1554  1.38  riastrad 		switch (dw->dw_state) {
   1555  1.38  riastrad 		case DELAYED_WORK_IDLE:
   1556  1.28  riastrad 			/*
   1557  1.12  riastrad 			 * It has a workqueue assigned and the callout
   1558  1.12  riastrad 			 * is idle, so it must be in progress or on the
   1559  1.35  riastrad 			 * queue.  In that case, we'll wait for it to
   1560  1.35  riastrad 			 * complete.
   1561  1.35  riastrad 			 */
   1562  1.38  riastrad 			break;
   1563  1.38  riastrad 		case DELAYED_WORK_SCHEDULED:
   1564  1.38  riastrad 		case DELAYED_WORK_RESCHEDULED:
   1565  1.38  riastrad 		case DELAYED_WORK_CANCELLED:
   1566  1.38  riastrad 			/*
   1567  1.38  riastrad 			 * The callout is scheduled, and may have even
   1568  1.38  riastrad 			 * started.  Mark it as scheduled so that if
   1569  1.35  riastrad 			 * the callout has fired it will queue the work
   1570  1.38  riastrad 			 * itself.  Try to stop the callout -- if we
   1571  1.38  riastrad 			 * can, queue the work now; if we can't, wait
   1572  1.38  riastrad 			 * for the callout to complete, which entails
   1573  1.38  riastrad 			 * queueing it.
   1574  1.38  riastrad 			 */
   1575  1.38  riastrad 			dw->dw_state = DELAYED_WORK_SCHEDULED;
   1576  1.38  riastrad 			if (!callout_halt(&dw->dw_callout, &wq->wq_lock)) {
   1577  1.38  riastrad 				/*
   1578  1.38  riastrad 				 * We stopped it before it ran.  No
   1579  1.38  riastrad 				 * state change in the interim is
   1580  1.38  riastrad 				 * possible.  Destroy the callout and
   1581  1.39  riastrad 				 * queue it ourselves.
   1582  1.38  riastrad 				 */
   1583  1.38  riastrad 				KASSERT(dw->dw_state ==
   1584  1.41  riastrad 				    DELAYED_WORK_SCHEDULED);
   1585  1.41  riastrad 				dw_callout_destroy(wq, dw);
   1586  1.38  riastrad 				TAILQ_INSERT_TAIL(&wq->wq_dqueue, &dw->work,
   1587  1.35  riastrad 				    work_entry);
   1588  1.12  riastrad 				cv_broadcast(&wq->wq_cv);
   1589  1.38  riastrad 				SDT_PROBE2(sdt, linux, work, queue,
   1590  1.12  riastrad 				    &dw->work, wq);
   1591  1.38  riastrad 			}
   1592  1.38  riastrad 			break;
   1593  1.38  riastrad 		default:
   1594  1.38  riastrad 			panic("invalid delayed work state: %d", dw->dw_state);
   1595  1.50  riastrad 		}
   1596  1.48  riastrad 		/*
   1597   1.1     skrll 		 * Waiting for the whole queue to flush is overkill,
   1598  1.12  riastrad 		 * but doesn't hurt.
   1599  1.48  riastrad 		 */
   1600  1.48  riastrad 		(void)flush_workqueue_locked(wq);
   1601   1.1     skrll 		waited = true;
   1602  1.49  riastrad 	}
   1603  1.49  riastrad 	mutex_exit(&wq->wq_lock);
   1604  1.49  riastrad 
   1605  1.49  riastrad 	return waited;
   1606  1.49  riastrad }
   1607  1.49  riastrad 
   1608  1.49  riastrad /*
   1609  1.51  riastrad  * delayed_work_pending(dw)
   1610  1.49  riastrad  *
   1611  1.49  riastrad  *	True if dw is currently scheduled to execute, false if not.
   1612  1.49  riastrad  */
   1613  1.49  riastrad bool
   1614                 delayed_work_pending(const struct delayed_work *dw)
   1615                 {
   1616                 
   1617                 	return work_pending(&dw->work);
   1618                 }
   1619