Home | History | Annotate | Line # | Download | only in linux
workqueue.h revision 1.4 
      1 /*	$NetBSD: workqueue.h,v 1.4 2018/08/27 07:00:28 riastradh Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2013 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/types.h>
     36 #include <sys/callout.h>
     37 #include <sys/queue.h>
     38 #include <sys/workqueue.h>
     39 
     40 #include <linux/kernel.h>
     41 
     42 #define	INIT_DELAYED_WORK		linux_INIT_DELAYED_WORK
     43 #define	INIT_WORK			linux_INIT_WORK
     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	destroy_workqueue		linux_destroy_workqueue
     51 #define	flush_work			linux_flush_work
     52 #define	flush_workqueue			linux_flush_workqueue
     53 #define	queue_delayed_work		linux_queue_delayed_work
     54 #define	mod_delayed_work		linux_mod_delayed_work
     55 #define	queue_work			linux_queue_work
     56 #define	schedule_delayed_work		linux_schedule_delayed_work
     57 #define	schedule_work			linux_schedule_work
     58 #define	system_wq			linux_system_wq
     59 #define	to_delayed_work			linux_to_delayed_work
     60 
     61 struct workqueue_struct;
     62 
     63 struct work_struct {
     64 	struct work		w_wk;
     65 	__cpu_simple_lock_t	w_lock; /* XXX */
     66 	enum {
     67 		WORK_IDLE,
     68 		WORK_DELAYED,
     69 		WORK_PENDING,
     70 		WORK_INVOKED,
     71 		WORK_CANCELLED,
     72 		WORK_DELAYED_CANCELLED,
     73 	}			w_state;
     74 	struct workqueue_struct	*w_wq;
     75 	void			(*w_fn)(struct work_struct *);
     76 };
     77 
     78 struct delayed_work {
     79 	/* Not dw_work; name must match Linux.  */
     80 	struct work_struct		work;
     81 	struct callout			dw_callout;
     82 	TAILQ_ENTRY(delayed_work)	dw_entry;
     83 };
     84 
     85 static inline struct delayed_work *
     86 to_delayed_work(struct work_struct *work)
     87 {
     88 	return container_of(work, struct delayed_work, work);
     89 }
     90 
     91 extern struct workqueue_struct	*system_wq;
     92 extern struct workqueue_struct	*system_long_wq;
     93 
     94 int	linux_workqueue_init(void);
     95 void	linux_workqueue_fini(void);
     96 
     97 #define	create_singlethread_workqueue(name)				      \
     98 	alloc_ordered_workqueue((name), 0)
     99 
    100 struct workqueue_struct *
    101 	alloc_ordered_workqueue(const char *, int);
    102 void	destroy_workqueue(struct workqueue_struct *);
    103 void	flush_workqueue(struct workqueue_struct *);
    104 void	flush_scheduled_work(void);
    105 
    106 void	INIT_WORK(struct work_struct *, void (*)(struct work_struct *));
    107 bool	schedule_work(struct work_struct *);
    108 bool	queue_work(struct workqueue_struct *, struct work_struct *);
    109 bool	cancel_work_sync(struct work_struct *);
    110 void	flush_work(struct work_struct *);
    111 
    112 void	INIT_DELAYED_WORK(struct delayed_work *,
    113 	    void (*)(struct work_struct *));
    114 bool	schedule_delayed_work(struct delayed_work *, unsigned long);
    115 bool	queue_delayed_work(struct workqueue_struct *, struct delayed_work *,
    116 	    unsigned long ticks);
    117 bool	mod_delayed_work(struct workqueue_struct *, struct delayed_work *,
    118 	    unsigned long ticks);
    119 bool	cancel_delayed_work(struct delayed_work *);
    120 bool	cancel_delayed_work_sync(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