1
2#ifndef _LINUX_KTHREAD_H
3#define _LINUX_KTHREAD_H
4
5#include <linux/err.h>
6#include <linux/sched.h>
7
8struct mm_struct;
9
10__printf(4, 5)
11struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
12 void *data,
13 int node,
14 const char namefmt[], ...);
15
16
17
18
19
20
21
22
23
24
25
26
27#define kthread_create(threadfn, data, namefmt, arg...) \
28 kthread_create_on_node(threadfn, data, NUMA_NO_NODE, namefmt, ##arg)
29
30
31struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data),
32 void *data,
33 unsigned int cpu,
34 const char *namefmt);
35
36
37
38
39
40
41
42
43
44
45#define kthread_run(threadfn, data, namefmt, ...) \
46({ \
47 struct task_struct *__k \
48 = kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \
49 if (!IS_ERR(__k)) \
50 wake_up_process(__k); \
51 __k; \
52})
53
54void free_kthread_struct(struct task_struct *k);
55void kthread_bind(struct task_struct *k, unsigned int cpu);
56void kthread_bind_mask(struct task_struct *k, const struct cpumask *mask);
57int kthread_stop(struct task_struct *k);
58bool kthread_should_stop(void);
59bool kthread_should_park(void);
60bool __kthread_should_park(struct task_struct *k);
61bool kthread_freezable_should_stop(bool *was_frozen);
62void *kthread_func(struct task_struct *k);
63void *kthread_data(struct task_struct *k);
64void *kthread_probe_data(struct task_struct *k);
65int kthread_park(struct task_struct *k);
66void kthread_unpark(struct task_struct *k);
67void kthread_parkme(void);
68
69int kthreadd(void *unused);
70extern struct task_struct *kthreadd_task;
71extern int tsk_fork_get_node(struct task_struct *tsk);
72
73
74
75
76
77
78
79
80
81struct kthread_work;
82typedef void (*kthread_work_func_t)(struct kthread_work *work);
83void kthread_delayed_work_timer_fn(struct timer_list *t);
84
85enum {
86 KTW_FREEZABLE = 1 << 0,
87};
88
89struct kthread_worker {
90 unsigned int flags;
91 raw_spinlock_t lock;
92 struct list_head work_list;
93 struct list_head delayed_work_list;
94 struct task_struct *task;
95 struct kthread_work *current_work;
96};
97
98struct kthread_work {
99 struct list_head node;
100 kthread_work_func_t func;
101 struct kthread_worker *worker;
102
103 int canceling;
104};
105
106struct kthread_delayed_work {
107 struct kthread_work work;
108 struct timer_list timer;
109};
110
111#define KTHREAD_WORKER_INIT(worker) { \
112 .lock = __RAW_SPIN_LOCK_UNLOCKED((worker).lock), \
113 .work_list = LIST_HEAD_INIT((worker).work_list), \
114 .delayed_work_list = LIST_HEAD_INIT((worker).delayed_work_list),\
115 }
116
117#define KTHREAD_WORK_INIT(work, fn) { \
118 .node = LIST_HEAD_INIT((work).node), \
119 .func = (fn), \
120 }
121
122#define KTHREAD_DELAYED_WORK_INIT(dwork, fn) { \
123 .work = KTHREAD_WORK_INIT((dwork).work, (fn)), \
124 .timer = __TIMER_INITIALIZER(kthread_delayed_work_timer_fn,\
125 TIMER_IRQSAFE), \
126 }
127
128#define DEFINE_KTHREAD_WORKER(worker) \
129 struct kthread_worker worker = KTHREAD_WORKER_INIT(worker)
130
131#define DEFINE_KTHREAD_WORK(work, fn) \
132 struct kthread_work work = KTHREAD_WORK_INIT(work, fn)
133
134#define DEFINE_KTHREAD_DELAYED_WORK(dwork, fn) \
135 struct kthread_delayed_work dwork = \
136 KTHREAD_DELAYED_WORK_INIT(dwork, fn)
137
138
139
140
141
142#ifdef CONFIG_LOCKDEP
143# define KTHREAD_WORKER_INIT_ONSTACK(worker) \
144 ({ kthread_init_worker(&worker); worker; })
145# define DEFINE_KTHREAD_WORKER_ONSTACK(worker) \
146 struct kthread_worker worker = KTHREAD_WORKER_INIT_ONSTACK(worker)
147#else
148# define DEFINE_KTHREAD_WORKER_ONSTACK(worker) DEFINE_KTHREAD_WORKER(worker)
149#endif
150
151extern void __kthread_init_worker(struct kthread_worker *worker,
152 const char *name, struct lock_class_key *key);
153
154#define kthread_init_worker(worker) \
155 do { \
156 static struct lock_class_key __key; \
157 __kthread_init_worker((worker), "("#worker")->lock", &__key); \
158 } while (0)
159
160#define kthread_init_work(work, fn) \
161 do { \
162 memset((work), 0, sizeof(struct kthread_work)); \
163 INIT_LIST_HEAD(&(work)->node); \
164 (work)->func = (fn); \
165 } while (0)
166
167#define kthread_init_delayed_work(dwork, fn) \
168 do { \
169 kthread_init_work(&(dwork)->work, (fn)); \
170 timer_setup(&(dwork)->timer, \
171 kthread_delayed_work_timer_fn, \
172 TIMER_IRQSAFE); \
173 } while (0)
174
175int kthread_worker_fn(void *worker_ptr);
176
177__printf(2, 3)
178struct kthread_worker *
179kthread_create_worker(unsigned int flags, const char namefmt[], ...);
180
181__printf(3, 4) struct kthread_worker *
182kthread_create_worker_on_cpu(int cpu, unsigned int flags,
183 const char namefmt[], ...);
184
185bool kthread_queue_work(struct kthread_worker *worker,
186 struct kthread_work *work);
187
188bool kthread_queue_delayed_work(struct kthread_worker *worker,
189 struct kthread_delayed_work *dwork,
190 unsigned long delay);
191
192bool kthread_mod_delayed_work(struct kthread_worker *worker,
193 struct kthread_delayed_work *dwork,
194 unsigned long delay);
195
196void kthread_flush_work(struct kthread_work *work);
197void kthread_flush_worker(struct kthread_worker *worker);
198
199bool kthread_cancel_work_sync(struct kthread_work *work);
200bool kthread_cancel_delayed_work_sync(struct kthread_delayed_work *work);
201
202void kthread_destroy_worker(struct kthread_worker *worker);
203
204void kthread_use_mm(struct mm_struct *mm);
205void kthread_unuse_mm(struct mm_struct *mm);
206
207struct cgroup_subsys_state;
208
209#ifdef CONFIG_BLK_CGROUP
210void kthread_associate_blkcg(struct cgroup_subsys_state *css);
211struct cgroup_subsys_state *kthread_blkcg(void);
212#else
213static inline void kthread_associate_blkcg(struct cgroup_subsys_state *css) { }
214static inline struct cgroup_subsys_state *kthread_blkcg(void)
215{
216 return NULL;
217}
218#endif
219#endif
220