Home | History | Annotate | Line # | Download | only in linux
workqueue.h revision 1.23
      1 /*	$NetBSD: workqueue.h,v 1.23 2021/12/19 11:10:17 riastradh Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2013, 2018 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Taylor R. Campbell.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _LINUX_WORKQUEUE_H_
     33 #define _LINUX_WORKQUEUE_H_
     34 
     35 #include <sys/queue.h>
     36 #include <sys/stdbool.h>
     37 
     38 #include <linux/kernel.h>	/* container_of */
     39 #include <linux/stringify.h>
     40 
     41 #define	INIT_DELAYED_WORK		linux_INIT_DELAYED_WORK
     42 #define	INIT_WORK			linux_INIT_WORK
     43 #define	alloc_workqueue			linux_alloc_workqueue
     44 #define	alloc_ordered_workqueue		linux_alloc_ordered_workqueue
     45 #define	cancel_delayed_work		linux_cancel_delayed_work
     46 #define	cancel_delayed_work_sync	linux_cancel_delayed_work_sync
     47 #define	cancel_work			linux_cancel_work
     48 #define	cancel_work_sync		linux_cancel_work_sync
     49 #define	current_work			linux_current_work
     50 #define	delayed_work_pending		linux_delayed_work_pending
     51 #define	destroy_workqueue		linux_destroy_workqueue
     52 #define	drain_workqueue			linux_drain_workqueue
     53 #define	flush_delayed_work		linux_flush_delayed_work
     54 #define	flush_scheduled_work		linux_flush_scheduled_work
     55 #define	flush_work			linux_flush_work
     56 #define	flush_workqueue			linux_flush_workqueue
     57 #define	queue_delayed_work		linux_queue_delayed_work
     58 #define	mod_delayed_work		linux_mod_delayed_work
     59 #define	queue_work			linux_queue_work
     60 #define	schedule_delayed_work		linux_schedule_delayed_work
     61 #define	schedule_work			linux_schedule_work
     62 #define	system_long_wq			linux_system_long_wq
     63 #define	system_power_efficient_wq	linux_system_power_efficient_wq
     64 #define	system_unbound_wq		linux_system_unbound_wq
     65 #define	system_wq			linux_system_wq
     66 #define	to_delayed_work			linux_to_delayed_work
     67 #define	work_pending			linux_work_pending
     68 
     69 struct workqueue_struct;
     70 
     71 struct work_struct {
     72 	volatile uintptr_t		work_owner;
     73 	TAILQ_ENTRY(work_struct)	work_entry;
     74 	void	(*func)(struct work_struct *); /* Linux API name */
     75 };
     76 
     77 struct delayed_work {
     78 	struct work_struct		work; /* Linux API name */
     79 	struct callout			dw_callout;
     80 	TAILQ_ENTRY(delayed_work)	dw_entry;
     81 	int				dw_resched;
     82 	enum {
     83 		DELAYED_WORK_IDLE,
     84 		DELAYED_WORK_SCHEDULED,
     85 		DELAYED_WORK_RESCHEDULED,
     86 		DELAYED_WORK_CANCELLED,
     87 	}				dw_state;
     88 };
     89 
     90 struct rcu_work {
     91 };
     92 
     93 #define	WQ_FREEZABLE		__BIT(0)
     94 #define	WQ_HIGHPRI		__BIT(1)
     95 #define	WQ_MEM_RECLAIM		__BIT(2)
     96 #define	WQ_UNBOUND		__BIT(3)
     97 
     98 static inline struct delayed_work *
     99 to_delayed_work(struct work_struct *work)
    100 {
    101 	return container_of(work, struct delayed_work, work);
    102 }
    103 
    104 extern struct workqueue_struct	*system_wq;
    105 extern struct workqueue_struct	*system_long_wq;
    106 extern struct workqueue_struct	*system_power_efficient_wq;
    107 extern struct workqueue_struct	*system_unbound_wq;
    108 
    109 int	linux_workqueue_init(void);
    110 void	linux_workqueue_fini(void);
    111 
    112 #define	create_singlethread_workqueue(name)				      \
    113 	alloc_ordered_workqueue((name), 0)
    114 
    115 struct workqueue_struct *
    116 	alloc_workqueue(const char *, int, unsigned);
    117 struct workqueue_struct *
    118 	alloc_ordered_workqueue(const char *, int);
    119 void	destroy_workqueue(struct workqueue_struct *);
    120 void	flush_workqueue(struct workqueue_struct *);
    121 void	drain_workqueue(struct workqueue_struct *);
    122 void	flush_scheduled_work(void);
    123 
    124 void	INIT_WORK(struct work_struct *, void (*)(struct work_struct *));
    125 bool	schedule_work(struct work_struct *);
    126 bool	queue_work(struct workqueue_struct *, struct work_struct *);
    127 bool	cancel_work(struct work_struct *);
    128 bool	cancel_work_sync(struct work_struct *);
    129 bool	flush_work(struct work_struct *);
    130 bool	work_pending(const struct work_struct *);
    131 
    132 void	INIT_DELAYED_WORK(struct delayed_work *,
    133 	    void (*)(struct work_struct *));
    134 bool	schedule_delayed_work(struct delayed_work *, unsigned long);
    135 bool	queue_delayed_work(struct workqueue_struct *, struct delayed_work *,
    136 	    unsigned long ticks);
    137 bool	mod_delayed_work(struct workqueue_struct *, struct delayed_work *,
    138 	    unsigned long ticks);
    139 bool	cancel_delayed_work(struct delayed_work *);
    140 bool	cancel_delayed_work_sync(struct delayed_work *);
    141 bool	flush_delayed_work(struct delayed_work *);
    142 bool	delayed_work_pending(const struct delayed_work *);
    143 
    144 struct work_struct *
    145 	current_work(void);
    146 
    147 #define	INIT_WORK_ONSTACK		INIT_WORK
    148 #define	INIT_DELAYED_WORK_ONSTACK	INIT_DELAYED_WORK
    149 #define	destroy_delayed_work_on_stack(dw)	__nothing
    150 
    151 static inline void
    152 destroy_work_on_stack(struct work_struct *work)
    153 {
    154 }
    155 
    156 #endif  /* _LINUX_WORKQUEUE_H_ */
    157