1 /* $NetBSD: workqueue.h,v 1.13 2018/08/27 15:06:02 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_scheduled_work linux_flush_scheduled_work 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_long_wq linux_system_long_wq 59 #define system_power_efficient_wq linux_system_power_efficient_wq 60 #define system_wq linux_system_wq 61 #define to_delayed_work linux_to_delayed_work 62 63 struct workqueue_struct; 64 65 struct work_struct { 66 volatile uintptr_t work_owner; 67 TAILQ_ENTRY(work_struct) work_entry; 68 void (*func)(struct work_struct *); /* Linux API name */ 69 }; 70 71 struct delayed_work { 72 struct work_struct work; /* Linux API name */ 73 struct callout dw_callout; 74 TAILQ_ENTRY(delayed_work) dw_entry; 75 int dw_resched; 76 enum { 77 DELAYED_WORK_IDLE, 78 DELAYED_WORK_SCHEDULED, 79 DELAYED_WORK_RESCHEDULED, 80 DELAYED_WORK_CANCELLED, 81 } dw_state; 82 }; 83 84 static inline struct delayed_work * 85 to_delayed_work(struct work_struct *work) 86 { 87 return container_of(work, struct delayed_work, work); 88 } 89 90 extern struct workqueue_struct *system_wq; 91 extern struct workqueue_struct *system_long_wq; 92 extern struct workqueue_struct *system_power_efficient_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(struct work_struct *); 110 bool cancel_work_sync(struct work_struct *); 111 void flush_work(struct work_struct *); 112 113 void INIT_DELAYED_WORK(struct delayed_work *, 114 void (*)(struct work_struct *)); 115 bool schedule_delayed_work(struct delayed_work *, unsigned long); 116 bool queue_delayed_work(struct workqueue_struct *, struct delayed_work *, 117 unsigned long ticks); 118 bool mod_delayed_work(struct workqueue_struct *, struct delayed_work *, 119 unsigned long ticks); 120 bool cancel_delayed_work(struct delayed_work *); 121 bool cancel_delayed_work_sync(struct delayed_work *); 122 void flush_delayed_work(struct delayed_work *); 123 124 struct work_struct * 125 current_work(void); 126 127 #define INIT_WORK_ONSTACK INIT_WORK 128 129 static inline void 130 destroy_work_on_stack(struct work_struct *work) 131 { 132 } 133 134 #endif /* _LINUX_WORKQUEUE_H_ */ 135