Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef _LINUX_KTHREAD_H |
3 | #define _LINUX_KTHREAD_H | |
4 | /* Simple interface for creating and stopping kernel threads without mess. */ | |
5 | #include <linux/err.h> | |
6 | #include <linux/sched.h> | |
05e3db95 | 7 | #include <linux/cgroup.h> |
1da177e4 | 8 | |
b9075fa9 | 9 | __printf(4, 5) |
207205a2 ED |
10 | struct task_struct *kthread_create_on_node(int (*threadfn)(void *data), |
11 | void *data, | |
12 | int node, | |
b9075fa9 | 13 | const char namefmt[], ...); |
207205a2 | 14 | |
e154ccc8 JC |
15 | /** |
16 | * kthread_create - create a kthread on the current node | |
17 | * @threadfn: the function to run in the thread | |
18 | * @data: data pointer for @threadfn() | |
19 | * @namefmt: printf-style format string for the thread name | |
d16977f3 | 20 | * @arg...: arguments for @namefmt. |
e154ccc8 JC |
21 | * |
22 | * This macro will create a kthread on the current node, leaving it in | |
23 | * the stopped state. This is just a helper for kthread_create_on_node(); | |
24 | * see the documentation there for more details. | |
25 | */ | |
207205a2 | 26 | #define kthread_create(threadfn, data, namefmt, arg...) \ |
e9f06986 | 27 | kthread_create_on_node(threadfn, data, NUMA_NO_NODE, namefmt, ##arg) |
207205a2 | 28 | |
1da177e4 | 29 | |
2a1d4460 TG |
30 | struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data), |
31 | void *data, | |
32 | unsigned int cpu, | |
33 | const char *namefmt); | |
34 | ||
1da177e4 | 35 | /** |
9e37bd30 | 36 | * kthread_run - create and wake a thread. |
1da177e4 LT |
37 | * @threadfn: the function to run until signal_pending(current). |
38 | * @data: data ptr for @threadfn. | |
39 | * @namefmt: printf-style name for the thread. | |
40 | * | |
41 | * Description: Convenient wrapper for kthread_create() followed by | |
9e37bd30 RD |
42 | * wake_up_process(). Returns the kthread or ERR_PTR(-ENOMEM). |
43 | */ | |
1da177e4 LT |
44 | #define kthread_run(threadfn, data, namefmt, ...) \ |
45 | ({ \ | |
46 | struct task_struct *__k \ | |
47 | = kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \ | |
48 | if (!IS_ERR(__k)) \ | |
49 | wake_up_process(__k); \ | |
50 | __k; \ | |
51 | }) | |
52 | ||
1da5c46f | 53 | void free_kthread_struct(struct task_struct *k); |
1da177e4 | 54 | void kthread_bind(struct task_struct *k, unsigned int cpu); |
25834c73 | 55 | void kthread_bind_mask(struct task_struct *k, const struct cpumask *mask); |
1da177e4 | 56 | int kthread_stop(struct task_struct *k); |
2a1d4460 TG |
57 | bool kthread_should_stop(void); |
58 | bool kthread_should_park(void); | |
0121805d | 59 | bool __kthread_should_park(struct task_struct *k); |
8a32c441 | 60 | bool kthread_freezable_should_stop(bool *was_frozen); |
82805ab7 | 61 | void *kthread_data(struct task_struct *k); |
e700591a | 62 | void *kthread_probe_data(struct task_struct *k); |
2a1d4460 TG |
63 | int kthread_park(struct task_struct *k); |
64 | void kthread_unpark(struct task_struct *k); | |
65 | void kthread_parkme(void); | |
1da177e4 | 66 | |
73c27992 EB |
67 | int kthreadd(void *unused); |
68 | extern struct task_struct *kthreadd_task; | |
207205a2 | 69 | extern int tsk_fork_get_node(struct task_struct *tsk); |
73c27992 | 70 | |
b56c0d89 TH |
71 | /* |
72 | * Simple work processor based on kthread. | |
73 | * | |
74 | * This provides easier way to make use of kthreads. A kthread_work | |
3989144f | 75 | * can be queued and flushed using queue/kthread_flush_work() |
b56c0d89 TH |
76 | * respectively. Queued kthread_works are processed by a kthread |
77 | * running kthread_worker_fn(). | |
b56c0d89 TH |
78 | */ |
79 | struct kthread_work; | |
80 | typedef void (*kthread_work_func_t)(struct kthread_work *work); | |
fe5c3b69 | 81 | void kthread_delayed_work_timer_fn(struct timer_list *t); |
b56c0d89 | 82 | |
dbf52682 PM |
83 | enum { |
84 | KTW_FREEZABLE = 1 << 0, /* freeze during suspend */ | |
85 | }; | |
86 | ||
b56c0d89 | 87 | struct kthread_worker { |
dbf52682 | 88 | unsigned int flags; |
fe99a4f4 | 89 | raw_spinlock_t lock; |
b56c0d89 | 90 | struct list_head work_list; |
22597dc3 | 91 | struct list_head delayed_work_list; |
b56c0d89 | 92 | struct task_struct *task; |
46f3d976 | 93 | struct kthread_work *current_work; |
b56c0d89 TH |
94 | }; |
95 | ||
96 | struct kthread_work { | |
97 | struct list_head node; | |
98 | kthread_work_func_t func; | |
46f3d976 | 99 | struct kthread_worker *worker; |
37be45d4 PM |
100 | /* Number of canceling calls that are running at the moment. */ |
101 | int canceling; | |
b56c0d89 TH |
102 | }; |
103 | ||
22597dc3 PM |
104 | struct kthread_delayed_work { |
105 | struct kthread_work work; | |
106 | struct timer_list timer; | |
107 | }; | |
108 | ||
b56c0d89 | 109 | #define KTHREAD_WORKER_INIT(worker) { \ |
fe99a4f4 | 110 | .lock = __RAW_SPIN_LOCK_UNLOCKED((worker).lock), \ |
b56c0d89 | 111 | .work_list = LIST_HEAD_INIT((worker).work_list), \ |
22597dc3 | 112 | .delayed_work_list = LIST_HEAD_INIT((worker).delayed_work_list),\ |
b56c0d89 TH |
113 | } |
114 | ||
115 | #define KTHREAD_WORK_INIT(work, fn) { \ | |
116 | .node = LIST_HEAD_INIT((work).node), \ | |
117 | .func = (fn), \ | |
b56c0d89 TH |
118 | } |
119 | ||
22597dc3 PM |
120 | #define KTHREAD_DELAYED_WORK_INIT(dwork, fn) { \ |
121 | .work = KTHREAD_WORK_INIT((dwork).work, (fn)), \ | |
841b86f3 | 122 | .timer = __TIMER_INITIALIZER(kthread_delayed_work_timer_fn,\ |
22597dc3 PM |
123 | TIMER_IRQSAFE), \ |
124 | } | |
125 | ||
b56c0d89 TH |
126 | #define DEFINE_KTHREAD_WORKER(worker) \ |
127 | struct kthread_worker worker = KTHREAD_WORKER_INIT(worker) | |
128 | ||
129 | #define DEFINE_KTHREAD_WORK(work, fn) \ | |
130 | struct kthread_work work = KTHREAD_WORK_INIT(work, fn) | |
131 | ||
22597dc3 PM |
132 | #define DEFINE_KTHREAD_DELAYED_WORK(dwork, fn) \ |
133 | struct kthread_delayed_work dwork = \ | |
134 | KTHREAD_DELAYED_WORK_INIT(dwork, fn) | |
135 | ||
4f32e9b1 | 136 | /* |
95847e1b LJ |
137 | * kthread_worker.lock needs its own lockdep class key when defined on |
138 | * stack with lockdep enabled. Use the following macros in such cases. | |
4f32e9b1 YZ |
139 | */ |
140 | #ifdef CONFIG_LOCKDEP | |
141 | # define KTHREAD_WORKER_INIT_ONSTACK(worker) \ | |
3989144f | 142 | ({ kthread_init_worker(&worker); worker; }) |
4f32e9b1 YZ |
143 | # define DEFINE_KTHREAD_WORKER_ONSTACK(worker) \ |
144 | struct kthread_worker worker = KTHREAD_WORKER_INIT_ONSTACK(worker) | |
4f32e9b1 YZ |
145 | #else |
146 | # define DEFINE_KTHREAD_WORKER_ONSTACK(worker) DEFINE_KTHREAD_WORKER(worker) | |
4f32e9b1 YZ |
147 | #endif |
148 | ||
3989144f | 149 | extern void __kthread_init_worker(struct kthread_worker *worker, |
4f32e9b1 YZ |
150 | const char *name, struct lock_class_key *key); |
151 | ||
3989144f | 152 | #define kthread_init_worker(worker) \ |
4f32e9b1 YZ |
153 | do { \ |
154 | static struct lock_class_key __key; \ | |
3989144f | 155 | __kthread_init_worker((worker), "("#worker")->lock", &__key); \ |
4f32e9b1 YZ |
156 | } while (0) |
157 | ||
3989144f | 158 | #define kthread_init_work(work, fn) \ |
4f32e9b1 YZ |
159 | do { \ |
160 | memset((work), 0, sizeof(struct kthread_work)); \ | |
161 | INIT_LIST_HEAD(&(work)->node); \ | |
162 | (work)->func = (fn); \ | |
4f32e9b1 | 163 | } while (0) |
b56c0d89 | 164 | |
22597dc3 PM |
165 | #define kthread_init_delayed_work(dwork, fn) \ |
166 | do { \ | |
167 | kthread_init_work(&(dwork)->work, (fn)); \ | |
ad01423a SAS |
168 | timer_setup(&(dwork)->timer, \ |
169 | kthread_delayed_work_timer_fn, 0); \ | |
22597dc3 PM |
170 | } while (0) |
171 | ||
b56c0d89 TH |
172 | int kthread_worker_fn(void *worker_ptr); |
173 | ||
dbf52682 | 174 | __printf(2, 3) |
fbae2d44 | 175 | struct kthread_worker * |
dbf52682 | 176 | kthread_create_worker(unsigned int flags, const char namefmt[], ...); |
fbae2d44 | 177 | |
c0b942a7 | 178 | __printf(3, 4) struct kthread_worker * |
dbf52682 PM |
179 | kthread_create_worker_on_cpu(int cpu, unsigned int flags, |
180 | const char namefmt[], ...); | |
fbae2d44 | 181 | |
3989144f | 182 | bool kthread_queue_work(struct kthread_worker *worker, |
b56c0d89 | 183 | struct kthread_work *work); |
22597dc3 PM |
184 | |
185 | bool kthread_queue_delayed_work(struct kthread_worker *worker, | |
186 | struct kthread_delayed_work *dwork, | |
187 | unsigned long delay); | |
188 | ||
9a6b06c8 PM |
189 | bool kthread_mod_delayed_work(struct kthread_worker *worker, |
190 | struct kthread_delayed_work *dwork, | |
191 | unsigned long delay); | |
192 | ||
3989144f PM |
193 | void kthread_flush_work(struct kthread_work *work); |
194 | void kthread_flush_worker(struct kthread_worker *worker); | |
b56c0d89 | 195 | |
37be45d4 PM |
196 | bool kthread_cancel_work_sync(struct kthread_work *work); |
197 | bool kthread_cancel_delayed_work_sync(struct kthread_delayed_work *work); | |
198 | ||
35033fe9 PM |
199 | void kthread_destroy_worker(struct kthread_worker *worker); |
200 | ||
0b508bc9 | 201 | #ifdef CONFIG_BLK_CGROUP |
05e3db95 SL |
202 | void kthread_associate_blkcg(struct cgroup_subsys_state *css); |
203 | struct cgroup_subsys_state *kthread_blkcg(void); | |
204 | #else | |
205 | static inline void kthread_associate_blkcg(struct cgroup_subsys_state *css) { } | |
206 | static inline struct cgroup_subsys_state *kthread_blkcg(void) | |
207 | { | |
208 | return NULL; | |
209 | } | |
210 | #endif | |
1da177e4 | 211 | #endif /* _LINUX_KTHREAD_H */ |