kthread: detect when a kthread work is used by more workers
[deliverable/linux.git] / kernel / kthread.c
CommitLineData
1da177e4
LT
1/* Kernel thread helper functions.
2 * Copyright (C) 2004 IBM Corporation, Rusty Russell.
3 *
73c27992 4 * Creation is done via kthreadd, so that we get a clean environment
1da177e4
LT
5 * even if we're invoked from userspace (think modprobe, hotplug cpu,
6 * etc.).
7 */
8#include <linux/sched.h>
9#include <linux/kthread.h>
10#include <linux/completion.h>
11#include <linux/err.h>
58568d2a 12#include <linux/cpuset.h>
1da177e4
LT
13#include <linux/unistd.h>
14#include <linux/file.h>
9984de1a 15#include <linux/export.h>
97d1f15b 16#include <linux/mutex.h>
b56c0d89
TH
17#include <linux/slab.h>
18#include <linux/freezer.h>
a74fb73c 19#include <linux/ptrace.h>
cd42d559 20#include <linux/uaccess.h>
ad8d75ff 21#include <trace/events/sched.h>
1da177e4 22
73c27992
EB
23static DEFINE_SPINLOCK(kthread_create_lock);
24static LIST_HEAD(kthread_create_list);
25struct task_struct *kthreadd_task;
1da177e4
LT
26
27struct kthread_create_info
28{
73c27992 29 /* Information passed to kthread() from kthreadd. */
1da177e4
LT
30 int (*threadfn)(void *data);
31 void *data;
207205a2 32 int node;
1da177e4 33
73c27992 34 /* Result passed back to kthread_create() from kthreadd. */
1da177e4 35 struct task_struct *result;
786235ee 36 struct completion *done;
65f27f38 37
73c27992 38 struct list_head list;
1da177e4
LT
39};
40
63706172 41struct kthread {
2a1d4460
TG
42 unsigned long flags;
43 unsigned int cpu;
82805ab7 44 void *data;
2a1d4460 45 struct completion parked;
63706172 46 struct completion exited;
1da177e4
LT
47};
48
2a1d4460
TG
49enum KTHREAD_BITS {
50 KTHREAD_IS_PER_CPU = 0,
51 KTHREAD_SHOULD_STOP,
52 KTHREAD_SHOULD_PARK,
53 KTHREAD_IS_PARKED,
54};
55
4ecdafc8
ON
56#define __to_kthread(vfork) \
57 container_of(vfork, struct kthread, exited)
58
59static inline struct kthread *to_kthread(struct task_struct *k)
60{
61 return __to_kthread(k->vfork_done);
62}
63
64static struct kthread *to_live_kthread(struct task_struct *k)
65{
66 struct completion *vfork = ACCESS_ONCE(k->vfork_done);
67 if (likely(vfork))
68 return __to_kthread(vfork);
69 return NULL;
70}
1da177e4 71
9e37bd30
RD
72/**
73 * kthread_should_stop - should this kthread return now?
74 *
72fd4a35 75 * When someone calls kthread_stop() on your kthread, it will be woken
9e37bd30
RD
76 * and this will return true. You should then return, and your return
77 * value will be passed through to kthread_stop().
78 */
2a1d4460 79bool kthread_should_stop(void)
1da177e4 80{
2a1d4460 81 return test_bit(KTHREAD_SHOULD_STOP, &to_kthread(current)->flags);
1da177e4
LT
82}
83EXPORT_SYMBOL(kthread_should_stop);
84
2a1d4460
TG
85/**
86 * kthread_should_park - should this kthread park now?
87 *
88 * When someone calls kthread_park() on your kthread, it will be woken
89 * and this will return true. You should then do the necessary
90 * cleanup and call kthread_parkme()
91 *
92 * Similar to kthread_should_stop(), but this keeps the thread alive
93 * and in a park position. kthread_unpark() "restarts" the thread and
94 * calls the thread function again.
95 */
96bool kthread_should_park(void)
97{
98 return test_bit(KTHREAD_SHOULD_PARK, &to_kthread(current)->flags);
99}
18896451 100EXPORT_SYMBOL_GPL(kthread_should_park);
2a1d4460 101
8a32c441
TH
102/**
103 * kthread_freezable_should_stop - should this freezable kthread return now?
104 * @was_frozen: optional out parameter, indicates whether %current was frozen
105 *
106 * kthread_should_stop() for freezable kthreads, which will enter
107 * refrigerator if necessary. This function is safe from kthread_stop() /
108 * freezer deadlock and freezable kthreads should use this function instead
109 * of calling try_to_freeze() directly.
110 */
111bool kthread_freezable_should_stop(bool *was_frozen)
112{
113 bool frozen = false;
114
115 might_sleep();
116
117 if (unlikely(freezing(current)))
118 frozen = __refrigerator(true);
119
120 if (was_frozen)
121 *was_frozen = frozen;
122
123 return kthread_should_stop();
124}
125EXPORT_SYMBOL_GPL(kthread_freezable_should_stop);
126
82805ab7
TH
127/**
128 * kthread_data - return data value specified on kthread creation
129 * @task: kthread task in question
130 *
131 * Return the data value specified when kthread @task was created.
132 * The caller is responsible for ensuring the validity of @task when
133 * calling this function.
134 */
135void *kthread_data(struct task_struct *task)
136{
137 return to_kthread(task)->data;
138}
139
cd42d559 140/**
fcc12192 141 * kthread_probe_data - speculative version of kthread_data()
cd42d559
TH
142 * @task: possible kthread task in question
143 *
144 * @task could be a kthread task. Return the data value specified when it
145 * was created if accessible. If @task isn't a kthread task or its data is
146 * inaccessible for any reason, %NULL is returned. This function requires
147 * that @task itself is safe to dereference.
148 */
fcc12192 149void *kthread_probe_data(struct task_struct *task)
cd42d559
TH
150{
151 struct kthread *kthread = to_kthread(task);
152 void *data = NULL;
153
154 probe_kernel_read(&data, &kthread->data, sizeof(data));
155 return data;
156}
157
2a1d4460
TG
158static void __kthread_parkme(struct kthread *self)
159{
f2530dc7 160 __set_current_state(TASK_PARKED);
2a1d4460
TG
161 while (test_bit(KTHREAD_SHOULD_PARK, &self->flags)) {
162 if (!test_and_set_bit(KTHREAD_IS_PARKED, &self->flags))
163 complete(&self->parked);
164 schedule();
f2530dc7 165 __set_current_state(TASK_PARKED);
2a1d4460
TG
166 }
167 clear_bit(KTHREAD_IS_PARKED, &self->flags);
168 __set_current_state(TASK_RUNNING);
169}
170
171void kthread_parkme(void)
172{
173 __kthread_parkme(to_kthread(current));
174}
18896451 175EXPORT_SYMBOL_GPL(kthread_parkme);
2a1d4460 176
1da177e4
LT
177static int kthread(void *_create)
178{
63706172 179 /* Copy data: it's on kthread's stack */
1da177e4 180 struct kthread_create_info *create = _create;
63706172
ON
181 int (*threadfn)(void *data) = create->threadfn;
182 void *data = create->data;
786235ee 183 struct completion *done;
63706172
ON
184 struct kthread self;
185 int ret;
1da177e4 186
2a1d4460 187 self.flags = 0;
82805ab7 188 self.data = data;
63706172 189 init_completion(&self.exited);
2a1d4460 190 init_completion(&self.parked);
63706172 191 current->vfork_done = &self.exited;
1da177e4 192
786235ee
TH
193 /* If user was SIGKILLed, I release the structure. */
194 done = xchg(&create->done, NULL);
195 if (!done) {
196 kfree(create);
197 do_exit(-EINTR);
198 }
1da177e4 199 /* OK, tell user we're spawned, wait for stop or wakeup */
a076e4bc 200 __set_current_state(TASK_UNINTERRUPTIBLE);
3217ab97 201 create->result = current;
786235ee 202 complete(done);
1da177e4
LT
203 schedule();
204
63706172 205 ret = -EINTR;
1da177e4 206
2a1d4460
TG
207 if (!test_bit(KTHREAD_SHOULD_STOP, &self.flags)) {
208 __kthread_parkme(&self);
209 ret = threadfn(data);
210 }
63706172
ON
211 /* we can't just return, we must preserve "self" on stack */
212 do_exit(ret);
1da177e4
LT
213}
214
207205a2
ED
215/* called from do_fork() to get node information for about to be created task */
216int tsk_fork_get_node(struct task_struct *tsk)
217{
218#ifdef CONFIG_NUMA
219 if (tsk == kthreadd_task)
220 return tsk->pref_node_fork;
221#endif
81c98869 222 return NUMA_NO_NODE;
207205a2
ED
223}
224
73c27992 225static void create_kthread(struct kthread_create_info *create)
1da177e4 226{
1da177e4
LT
227 int pid;
228
207205a2
ED
229#ifdef CONFIG_NUMA
230 current->pref_node_fork = create->node;
231#endif
1da177e4
LT
232 /* We want our own signal handler (we take no signals by default). */
233 pid = kernel_thread(kthread, create, CLONE_FS | CLONE_FILES | SIGCHLD);
cdd140bd 234 if (pid < 0) {
786235ee
TH
235 /* If user was SIGKILLed, I release the structure. */
236 struct completion *done = xchg(&create->done, NULL);
237
238 if (!done) {
239 kfree(create);
240 return;
241 }
1da177e4 242 create->result = ERR_PTR(pid);
786235ee 243 complete(done);
cdd140bd 244 }
1da177e4
LT
245}
246
1ceae44b
PM
247static struct task_struct *__kthread_create_on_node(int (*threadfn)(void *data),
248 void *data, int node,
249 const char namefmt[],
250 va_list args)
1da177e4 251{
786235ee
TH
252 DECLARE_COMPLETION_ONSTACK(done);
253 struct task_struct *task;
254 struct kthread_create_info *create = kmalloc(sizeof(*create),
255 GFP_KERNEL);
256
257 if (!create)
258 return ERR_PTR(-ENOMEM);
259 create->threadfn = threadfn;
260 create->data = data;
261 create->node = node;
262 create->done = &done;
73c27992
EB
263
264 spin_lock(&kthread_create_lock);
786235ee 265 list_add_tail(&create->list, &kthread_create_list);
73c27992
EB
266 spin_unlock(&kthread_create_lock);
267
cbd9b67b 268 wake_up_process(kthreadd_task);
786235ee
TH
269 /*
270 * Wait for completion in killable state, for I might be chosen by
271 * the OOM killer while kthreadd is trying to allocate memory for
272 * new kernel thread.
273 */
274 if (unlikely(wait_for_completion_killable(&done))) {
275 /*
276 * If I was SIGKILLed before kthreadd (or new kernel thread)
277 * calls complete(), leave the cleanup of this structure to
278 * that thread.
279 */
280 if (xchg(&create->done, NULL))
8fe6929c 281 return ERR_PTR(-EINTR);
786235ee
TH
282 /*
283 * kthreadd (or new kernel thread) will call complete()
284 * shortly.
285 */
286 wait_for_completion(&done);
287 }
288 task = create->result;
289 if (!IS_ERR(task)) {
c9b5f501 290 static const struct sched_param param = { .sched_priority = 0 };
1c99315b 291
786235ee 292 vsnprintf(task->comm, sizeof(task->comm), namefmt, args);
1c99315b
ON
293 /*
294 * root may have changed our (kthreadd's) priority or CPU mask.
295 * The kernel thread should not inherit these properties.
296 */
786235ee
TH
297 sched_setscheduler_nocheck(task, SCHED_NORMAL, &param);
298 set_cpus_allowed_ptr(task, cpu_all_mask);
1da177e4 299 }
786235ee
TH
300 kfree(create);
301 return task;
1da177e4 302}
1ceae44b
PM
303
304/**
305 * kthread_create_on_node - create a kthread.
306 * @threadfn: the function to run until signal_pending(current).
307 * @data: data ptr for @threadfn.
308 * @node: task and thread structures for the thread are allocated on this node
309 * @namefmt: printf-style name for the thread.
310 *
311 * Description: This helper function creates and names a kernel
312 * thread. The thread will be stopped: use wake_up_process() to start
313 * it. See also kthread_run(). The new thread has SCHED_NORMAL policy and
314 * is affine to all CPUs.
315 *
316 * If thread is going to be bound on a particular cpu, give its node
317 * in @node, to get NUMA affinity for kthread stack, or else give NUMA_NO_NODE.
318 * When woken, the thread will run @threadfn() with @data as its
319 * argument. @threadfn() can either call do_exit() directly if it is a
320 * standalone thread for which no one will call kthread_stop(), or
321 * return when 'kthread_should_stop()' is true (which means
322 * kthread_stop() has been called). The return value should be zero
323 * or a negative error number; it will be passed to kthread_stop().
324 *
325 * Returns a task_struct or ERR_PTR(-ENOMEM) or ERR_PTR(-EINTR).
326 */
327struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
328 void *data, int node,
329 const char namefmt[],
330 ...)
331{
332 struct task_struct *task;
333 va_list args;
334
335 va_start(args, namefmt);
336 task = __kthread_create_on_node(threadfn, data, node, namefmt, args);
337 va_end(args);
338
339 return task;
340}
207205a2 341EXPORT_SYMBOL(kthread_create_on_node);
1da177e4 342
25834c73 343static void __kthread_bind_mask(struct task_struct *p, const struct cpumask *mask, long state)
2a1d4460 344{
25834c73
PZ
345 unsigned long flags;
346
f2530dc7
TG
347 if (!wait_task_inactive(p, state)) {
348 WARN_ON(1);
349 return;
350 }
25834c73 351
2a1d4460 352 /* It's safe because the task is inactive. */
25834c73
PZ
353 raw_spin_lock_irqsave(&p->pi_lock, flags);
354 do_set_cpus_allowed(p, mask);
14a40ffc 355 p->flags |= PF_NO_SETAFFINITY;
25834c73
PZ
356 raw_spin_unlock_irqrestore(&p->pi_lock, flags);
357}
358
359static void __kthread_bind(struct task_struct *p, unsigned int cpu, long state)
360{
361 __kthread_bind_mask(p, cpumask_of(cpu), state);
362}
363
364void kthread_bind_mask(struct task_struct *p, const struct cpumask *mask)
365{
366 __kthread_bind_mask(p, mask, TASK_UNINTERRUPTIBLE);
2a1d4460
TG
367}
368
881232b7
PZ
369/**
370 * kthread_bind - bind a just-created kthread to a cpu.
371 * @p: thread created by kthread_create().
372 * @cpu: cpu (might not be online, must be possible) for @k to run on.
373 *
374 * Description: This function is equivalent to set_cpus_allowed(),
375 * except that @cpu doesn't need to be online, and the thread must be
376 * stopped (i.e., just returned from kthread_create()).
377 */
378void kthread_bind(struct task_struct *p, unsigned int cpu)
379{
f2530dc7 380 __kthread_bind(p, cpu, TASK_UNINTERRUPTIBLE);
881232b7
PZ
381}
382EXPORT_SYMBOL(kthread_bind);
383
2a1d4460
TG
384/**
385 * kthread_create_on_cpu - Create a cpu bound kthread
386 * @threadfn: the function to run until signal_pending(current).
387 * @data: data ptr for @threadfn.
388 * @cpu: The cpu on which the thread should be bound,
389 * @namefmt: printf-style name for the thread. Format is restricted
390 * to "name.*%u". Code fills in cpu number.
391 *
392 * Description: This helper function creates and names a kernel thread
393 * The thread will be woken and put into park mode.
394 */
395struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data),
396 void *data, unsigned int cpu,
397 const char *namefmt)
398{
399 struct task_struct *p;
400
10922838 401 p = kthread_create_on_node(threadfn, data, cpu_to_node(cpu), namefmt,
2a1d4460
TG
402 cpu);
403 if (IS_ERR(p))
404 return p;
e7616668
PM
405 kthread_bind(p, cpu);
406 /* CPU hotplug need to bind once again when unparking the thread. */
2a1d4460
TG
407 set_bit(KTHREAD_IS_PER_CPU, &to_kthread(p)->flags);
408 to_kthread(p)->cpu = cpu;
2a1d4460
TG
409 return p;
410}
411
f2530dc7
TG
412static void __kthread_unpark(struct task_struct *k, struct kthread *kthread)
413{
414 clear_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
415 /*
416 * We clear the IS_PARKED bit here as we don't wait
417 * until the task has left the park code. So if we'd
418 * park before that happens we'd see the IS_PARKED bit
419 * which might be about to be cleared.
420 */
421 if (test_and_clear_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
e7616668
PM
422 /*
423 * Newly created kthread was parked when the CPU was offline.
424 * The binding was lost and we need to set it again.
425 */
f2530dc7
TG
426 if (test_bit(KTHREAD_IS_PER_CPU, &kthread->flags))
427 __kthread_bind(k, kthread->cpu, TASK_PARKED);
428 wake_up_state(k, TASK_PARKED);
429 }
430}
431
2a1d4460
TG
432/**
433 * kthread_unpark - unpark a thread created by kthread_create().
434 * @k: thread created by kthread_create().
435 *
436 * Sets kthread_should_park() for @k to return false, wakes it, and
437 * waits for it to return. If the thread is marked percpu then its
438 * bound to the cpu again.
439 */
440void kthread_unpark(struct task_struct *k)
441{
b5c5442b 442 struct kthread *kthread = to_live_kthread(k);
2a1d4460 443
f2530dc7
TG
444 if (kthread)
445 __kthread_unpark(k, kthread);
2a1d4460 446}
18896451 447EXPORT_SYMBOL_GPL(kthread_unpark);
2a1d4460
TG
448
449/**
450 * kthread_park - park a thread created by kthread_create().
451 * @k: thread created by kthread_create().
452 *
453 * Sets kthread_should_park() for @k to return true, wakes it, and
454 * waits for it to return. This can also be called after kthread_create()
455 * instead of calling wake_up_process(): the thread will park without
456 * calling threadfn().
457 *
458 * Returns 0 if the thread is parked, -ENOSYS if the thread exited.
459 * If called by the kthread itself just the park bit is set.
460 */
461int kthread_park(struct task_struct *k)
462{
b5c5442b 463 struct kthread *kthread = to_live_kthread(k);
2a1d4460
TG
464 int ret = -ENOSYS;
465
466 if (kthread) {
467 if (!test_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
468 set_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
469 if (k != current) {
470 wake_up_process(k);
471 wait_for_completion(&kthread->parked);
472 }
473 }
474 ret = 0;
475 }
2a1d4460
TG
476 return ret;
477}
18896451 478EXPORT_SYMBOL_GPL(kthread_park);
2a1d4460 479
9e37bd30
RD
480/**
481 * kthread_stop - stop a thread created by kthread_create().
482 * @k: thread created by kthread_create().
483 *
484 * Sets kthread_should_stop() for @k to return true, wakes it, and
9ae26027
ON
485 * waits for it to exit. This can also be called after kthread_create()
486 * instead of calling wake_up_process(): the thread will exit without
487 * calling threadfn().
488 *
489 * If threadfn() may call do_exit() itself, the caller must ensure
490 * task_struct can't go away.
9e37bd30
RD
491 *
492 * Returns the result of threadfn(), or %-EINTR if wake_up_process()
493 * was never called.
494 */
1da177e4
LT
495int kthread_stop(struct task_struct *k)
496{
b5c5442b 497 struct kthread *kthread;
1da177e4
LT
498 int ret;
499
0a16b607 500 trace_sched_kthread_stop(k);
b5c5442b
ON
501
502 get_task_struct(k);
503 kthread = to_live_kthread(k);
2a1d4460
TG
504 if (kthread) {
505 set_bit(KTHREAD_SHOULD_STOP, &kthread->flags);
f2530dc7 506 __kthread_unpark(k, kthread);
63706172
ON
507 wake_up_process(k);
508 wait_for_completion(&kthread->exited);
509 }
510 ret = k->exit_code;
1da177e4 511 put_task_struct(k);
0a16b607 512
b5c5442b 513 trace_sched_kthread_stop_ret(ret);
1da177e4
LT
514 return ret;
515}
52e92e57 516EXPORT_SYMBOL(kthread_stop);
1da177e4 517
e804a4a4 518int kthreadd(void *unused)
1da177e4 519{
73c27992 520 struct task_struct *tsk = current;
1da177e4 521
e804a4a4 522 /* Setup a clean context for our children to inherit. */
73c27992 523 set_task_comm(tsk, "kthreadd");
10ab825b 524 ignore_signals(tsk);
1a2142af 525 set_cpus_allowed_ptr(tsk, cpu_all_mask);
aee4faa4 526 set_mems_allowed(node_states[N_MEMORY]);
73c27992 527
34b087e4 528 current->flags |= PF_NOFREEZE;
73c27992
EB
529
530 for (;;) {
531 set_current_state(TASK_INTERRUPTIBLE);
532 if (list_empty(&kthread_create_list))
533 schedule();
534 __set_current_state(TASK_RUNNING);
535
536 spin_lock(&kthread_create_lock);
537 while (!list_empty(&kthread_create_list)) {
538 struct kthread_create_info *create;
539
540 create = list_entry(kthread_create_list.next,
541 struct kthread_create_info, list);
542 list_del_init(&create->list);
543 spin_unlock(&kthread_create_lock);
544
545 create_kthread(create);
546
547 spin_lock(&kthread_create_lock);
548 }
549 spin_unlock(&kthread_create_lock);
550 }
551
552 return 0;
553}
b56c0d89 554
8c03cbe6 555void __kthread_init_worker(struct kthread_worker *worker,
4f32e9b1
YZ
556 const char *name,
557 struct lock_class_key *key)
558{
559 spin_lock_init(&worker->lock);
560 lockdep_set_class_and_name(&worker->lock, key, name);
561 INIT_LIST_HEAD(&worker->work_list);
562 worker->task = NULL;
563}
8c03cbe6 564EXPORT_SYMBOL_GPL(__kthread_init_worker);
4f32e9b1 565
b56c0d89
TH
566/**
567 * kthread_worker_fn - kthread function to process kthread_worker
568 * @worker_ptr: pointer to initialized kthread_worker
569 *
04555f91
PM
570 * This function implements the main cycle of kthread worker. It processes
571 * work_list until it is stopped with kthread_stop(). It sleeps when the queue
572 * is empty.
b56c0d89 573 *
04555f91
PM
574 * The works are not allowed to keep any locks, disable preemption or interrupts
575 * when they finish. There is defined a safe point for freezing when one work
576 * finishes and before a new one is started.
98c787c8
PM
577 *
578 * Also the works must not be handled by more than one worker at the same time,
579 * see also kthread_queue_work().
b56c0d89
TH
580 */
581int kthread_worker_fn(void *worker_ptr)
582{
583 struct kthread_worker *worker = worker_ptr;
584 struct kthread_work *work;
585
04555f91
PM
586 /*
587 * FIXME: Update the check and remove the assignment when all kthread
588 * worker users are created using kthread_create_worker*() functions.
589 */
590 WARN_ON(worker->task && worker->task != current);
b56c0d89
TH
591 worker->task = current;
592repeat:
593 set_current_state(TASK_INTERRUPTIBLE); /* mb paired w/ kthread_stop */
594
595 if (kthread_should_stop()) {
596 __set_current_state(TASK_RUNNING);
597 spin_lock_irq(&worker->lock);
598 worker->task = NULL;
599 spin_unlock_irq(&worker->lock);
600 return 0;
601 }
602
603 work = NULL;
604 spin_lock_irq(&worker->lock);
605 if (!list_empty(&worker->work_list)) {
606 work = list_first_entry(&worker->work_list,
607 struct kthread_work, node);
608 list_del_init(&work->node);
609 }
46f3d976 610 worker->current_work = work;
b56c0d89
TH
611 spin_unlock_irq(&worker->lock);
612
613 if (work) {
614 __set_current_state(TASK_RUNNING);
615 work->func(work);
b56c0d89
TH
616 } else if (!freezing(current))
617 schedule();
618
619 try_to_freeze();
620 goto repeat;
621}
622EXPORT_SYMBOL_GPL(kthread_worker_fn);
623
04555f91
PM
624static struct kthread_worker *
625__kthread_create_worker(int cpu, const char namefmt[], va_list args)
626{
627 struct kthread_worker *worker;
628 struct task_struct *task;
629
630 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
631 if (!worker)
632 return ERR_PTR(-ENOMEM);
633
634 kthread_init_worker(worker);
635
636 if (cpu >= 0) {
637 char name[TASK_COMM_LEN];
638
639 /*
640 * kthread_create_worker_on_cpu() allows to pass a generic
641 * namefmt in compare with kthread_create_on_cpu. We need
642 * to format it here.
643 */
644 vsnprintf(name, sizeof(name), namefmt, args);
645 task = kthread_create_on_cpu(kthread_worker_fn, worker,
646 cpu, name);
647 } else {
648 task = __kthread_create_on_node(kthread_worker_fn, worker,
649 -1, namefmt, args);
650 }
651
652 if (IS_ERR(task))
653 goto fail_task;
654
655 worker->task = task;
656 wake_up_process(task);
657 return worker;
658
659fail_task:
660 kfree(worker);
661 return ERR_CAST(task);
662}
663
664/**
665 * kthread_create_worker - create a kthread worker
666 * @namefmt: printf-style name for the kthread worker (task).
667 *
668 * Returns a pointer to the allocated worker on success, ERR_PTR(-ENOMEM)
669 * when the needed structures could not get allocated, and ERR_PTR(-EINTR)
670 * when the worker was SIGKILLed.
671 */
672struct kthread_worker *
673kthread_create_worker(const char namefmt[], ...)
674{
675 struct kthread_worker *worker;
676 va_list args;
677
678 va_start(args, namefmt);
679 worker = __kthread_create_worker(-1, namefmt, args);
680 va_end(args);
681
682 return worker;
683}
684EXPORT_SYMBOL(kthread_create_worker);
685
686/**
687 * kthread_create_worker_on_cpu - create a kthread worker and bind it
688 * it to a given CPU and the associated NUMA node.
689 * @cpu: CPU number
690 * @namefmt: printf-style name for the kthread worker (task).
691 *
692 * Use a valid CPU number if you want to bind the kthread worker
693 * to the given CPU and the associated NUMA node.
694 *
695 * A good practice is to add the cpu number also into the worker name.
696 * For example, use kthread_create_worker_on_cpu(cpu, "helper/%d", cpu).
697 *
698 * Returns a pointer to the allocated worker on success, ERR_PTR(-ENOMEM)
699 * when the needed structures could not get allocated, and ERR_PTR(-EINTR)
700 * when the worker was SIGKILLed.
701 */
702struct kthread_worker *
703kthread_create_worker_on_cpu(int cpu, const char namefmt[], ...)
704{
705 struct kthread_worker *worker;
706 va_list args;
707
708 va_start(args, namefmt);
709 worker = __kthread_create_worker(cpu, namefmt, args);
710 va_end(args);
711
712 return worker;
713}
714EXPORT_SYMBOL(kthread_create_worker_on_cpu);
715
98c787c8
PM
716static void kthread_insert_work_sanity_check(struct kthread_worker *worker,
717 struct kthread_work *work)
718{
719 lockdep_assert_held(&worker->lock);
720 WARN_ON_ONCE(!list_empty(&work->node));
721 /* Do not use a work with >1 worker, see kthread_queue_work() */
722 WARN_ON_ONCE(work->worker && work->worker != worker);
723}
724
9a2e03d8 725/* insert @work before @pos in @worker */
8c03cbe6 726static void kthread_insert_work(struct kthread_worker *worker,
98c787c8
PM
727 struct kthread_work *work,
728 struct list_head *pos)
9a2e03d8 729{
98c787c8 730 kthread_insert_work_sanity_check(worker, work);
9a2e03d8
TH
731
732 list_add_tail(&work->node, pos);
46f3d976 733 work->worker = worker;
ed1403ec 734 if (!worker->current_work && likely(worker->task))
9a2e03d8
TH
735 wake_up_process(worker->task);
736}
737
b56c0d89 738/**
8c03cbe6 739 * kthread_queue_work - queue a kthread_work
b56c0d89
TH
740 * @worker: target kthread_worker
741 * @work: kthread_work to queue
742 *
743 * Queue @work to work processor @task for async execution. @task
744 * must have been created with kthread_worker_create(). Returns %true
745 * if @work was successfully queued, %false if it was already pending.
98c787c8
PM
746 *
747 * Reinitialize the work if it needs to be used by another worker.
748 * For example, when the worker was stopped and started again.
b56c0d89 749 */
8c03cbe6 750bool kthread_queue_work(struct kthread_worker *worker,
b56c0d89
TH
751 struct kthread_work *work)
752{
753 bool ret = false;
754 unsigned long flags;
755
756 spin_lock_irqsave(&worker->lock, flags);
757 if (list_empty(&work->node)) {
8c03cbe6 758 kthread_insert_work(worker, work, &worker->work_list);
b56c0d89
TH
759 ret = true;
760 }
761 spin_unlock_irqrestore(&worker->lock, flags);
762 return ret;
763}
8c03cbe6 764EXPORT_SYMBOL_GPL(kthread_queue_work);
b56c0d89 765
9a2e03d8
TH
766struct kthread_flush_work {
767 struct kthread_work work;
768 struct completion done;
769};
770
771static void kthread_flush_work_fn(struct kthread_work *work)
772{
773 struct kthread_flush_work *fwork =
774 container_of(work, struct kthread_flush_work, work);
775 complete(&fwork->done);
776}
777
b56c0d89 778/**
8c03cbe6 779 * kthread_flush_work - flush a kthread_work
b56c0d89
TH
780 * @work: work to flush
781 *
782 * If @work is queued or executing, wait for it to finish execution.
783 */
8c03cbe6 784void kthread_flush_work(struct kthread_work *work)
b56c0d89 785{
46f3d976
TH
786 struct kthread_flush_work fwork = {
787 KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
788 COMPLETION_INITIALIZER_ONSTACK(fwork.done),
789 };
790 struct kthread_worker *worker;
791 bool noop = false;
792
46f3d976
TH
793 worker = work->worker;
794 if (!worker)
795 return;
b56c0d89 796
46f3d976 797 spin_lock_irq(&worker->lock);
98c787c8
PM
798 /* Work must not be used with >1 worker, see kthread_queue_work(). */
799 WARN_ON_ONCE(work->worker != worker);
b56c0d89 800
46f3d976 801 if (!list_empty(&work->node))
8c03cbe6 802 kthread_insert_work(worker, &fwork.work, work->node.next);
46f3d976 803 else if (worker->current_work == work)
8c03cbe6
PM
804 kthread_insert_work(worker, &fwork.work,
805 worker->work_list.next);
46f3d976
TH
806 else
807 noop = true;
b56c0d89 808
46f3d976 809 spin_unlock_irq(&worker->lock);
b56c0d89 810
46f3d976
TH
811 if (!noop)
812 wait_for_completion(&fwork.done);
b56c0d89 813}
8c03cbe6 814EXPORT_SYMBOL_GPL(kthread_flush_work);
b56c0d89 815
b56c0d89 816/**
8c03cbe6 817 * kthread_flush_worker - flush all current works on a kthread_worker
b56c0d89
TH
818 * @worker: worker to flush
819 *
820 * Wait until all currently executing or pending works on @worker are
821 * finished.
822 */
8c03cbe6 823void kthread_flush_worker(struct kthread_worker *worker)
b56c0d89
TH
824{
825 struct kthread_flush_work fwork = {
826 KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
827 COMPLETION_INITIALIZER_ONSTACK(fwork.done),
828 };
829
8c03cbe6 830 kthread_queue_work(worker, &fwork.work);
b56c0d89
TH
831 wait_for_completion(&fwork.done);
832}
8c03cbe6 833EXPORT_SYMBOL_GPL(kthread_flush_worker);
c5999abe
PM
834
835/**
836 * kthread_destroy_worker - destroy a kthread worker
837 * @worker: worker to be destroyed
838 *
839 * Flush and destroy @worker. The simple flush is enough because the kthread
840 * worker API is used only in trivial scenarios. There are no multi-step state
841 * machines needed.
842 */
843void kthread_destroy_worker(struct kthread_worker *worker)
844{
845 struct task_struct *task;
846
847 task = worker->task;
848 if (WARN_ON(!task))
849 return;
850
851 kthread_flush_worker(worker);
852 kthread_stop(task);
853 WARN_ON(!list_empty(&worker->work_list));
854 kfree(worker);
855}
856EXPORT_SYMBOL(kthread_destroy_worker);
This page took 0.813775 seconds and 5 git commands to generate.