Home | History | Annotate | Line # | Download | only in linux
workqueue.h revision 1.9 
      1 /*	$NetBSD: workqueue.h,v 1.9 2018/08/27 14:57:21 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 
     40 #define	INIT_DELAYED_WORK		linux_INIT_DELAYED_WORK
     41 #define	INIT_WORK			linux_INIT_WORK
     42 #define	alloc_ordered_workqueue		linux_alloc_ordered_workqueue
     43 #define	cancel_delayed_work		linux_cancel_delayed_work
     44 #define	cancel_delayed_work_sync	linux_cancel_delayed_work_sync
     45 #define	cancel_work			linux_cancel_work
     46 #define	cancel_work_sync		linux_cancel_work_sync
     47 #define	current_work			linux_current_work
     48 #define	destroy_workqueue		linux_destroy_workqueue
     49 #define	flush_delayed_work		linux_flush_delayed_work
     50 #define	flush_work			linux_flush_work
     51 #define	flush_workqueue			linux_flush_workqueue
     52 #define	queue_delayed_work		linux_queue_delayed_work
     53 #define	mod_delayed_work		linux_mod_delayed_work
     54 #define	queue_work			linux_queue_work
     55 #define	schedule_delayed_work		linux_schedule_delayed_work
     56 #define	schedule_work			linux_schedule_work
     57 #define	system_long_wq			linux_system_long_wq
     58 #define	system_power_efficient_wq	linux_system_power_efficient_wq
     59 #define	system_wq			linux_system_wq
     60 #define	to_delayed_work			linux_to_delayed_work
     61 
     62 struct workqueue_struct;
     63 
     64 struct work_struct {
     65 	struct workqueue_struct	*volatile work_queue;
     66 	TAILQ_ENTRY(work_struct)	work_entry;
     67 	void	(*func)(struct work_struct *); /* Linux API name */
     68 };
     69 
     70 struct delayed_work {
     71 	struct work_struct		work; /* Linux API name */
     72 	struct callout			dw_callout;
     73 	TAILQ_ENTRY(delayed_work)	dw_entry;
     74 	enum {
     75 		DELAYED_WORK_IDLE,
     76 		DELAYED_WORK_SCHEDULED,
     77 		DELAYED_WORK_RESCHEDULED,
     78 		DELAYED_WORK_CANCELLED,
     79 	}				dw_state;
     80 };
     81 
     82 static inline struct delayed_work *
     83 to_delayed_work(struct work_struct *work)
     84 {
     85 	return container_of(work, struct delayed_work, work);
     86 }
     87 
     88 extern struct workqueue_struct	*system_wq;
     89 extern struct workqueue_struct	*system_long_wq;
     90 extern struct workqueue_struct	*system_power_efficient_wq;
     91 
     92 int	linux_workqueue_init(void);
     93 void	linux_workqueue_fini(void);
     94 
     95 #define	create_singlethread_workqueue(name)				      \
     96 	alloc_ordered_workqueue((name), 0)
     97 
     98 struct workqueue_struct *
     99 	alloc_ordered_workqueue(const char *, int);
    100 void	destroy_workqueue(struct workqueue_struct *);
    101 void	flush_workqueue(struct workqueue_struct *);
    102 void	flush_scheduled_work(void);
    103 
    104 void	INIT_WORK(struct work_struct *, void (*)(struct work_struct *));
    105 bool	schedule_work(struct work_struct *);
    106 bool	queue_work(struct workqueue_struct *, struct work_struct *);
    107 bool	cancel_work(struct work_struct *);
    108 bool	cancel_work_sync(struct work_struct *);
    109 bool	flush_work(struct work_struct *);
    110 
    111 void	INIT_DELAYED_WORK(struct delayed_work *,
    112 	    void (*)(struct work_struct *));
    113 bool	schedule_delayed_work(struct delayed_work *, unsigned long);
    114 bool	queue_delayed_work(struct workqueue_struct *, struct delayed_work *,
    115 	    unsigned long ticks);
    116 bool	mod_delayed_work(struct workqueue_struct *, struct delayed_work *,
    117 	    unsigned long ticks);
    118 bool	cancel_delayed_work(struct delayed_work *);
    119 bool	cancel_delayed_work_sync(struct delayed_work *);
    120 bool	flush_delayed_work(struct delayed_work *);
    121 
    122 struct work_struct *
    123 	current_work(void);
    124 
    125 #define	INIT_WORK_ONSTACK		INIT_WORK
    126 
    127 static inline void
    128 destroy_work_on_stack(struct work_struct *work)
    129 {
    130 }
    131 
    132 #endif  /* _LINUX_WORKQUEUE_H_ */
    133