1 /* Kernel thread helper functions.
2 * Copyright (C) 2004 IBM Corporation, Rusty Russell.
4 * Creation is done via kthreadd, so that we get a clean environment
5 * even if we're invoked from userspace (think modprobe, hotplug cpu,
8 #include <linux/sched.h>
9 #include <linux/kthread.h>
10 #include <linux/completion.h>
11 #include <linux/err.h>
12 #include <linux/cpuset.h>
13 #include <linux/unistd.h>
14 #include <linux/file.h>
15 #include <linux/export.h>
16 #include <linux/mutex.h>
17 #include <linux/slab.h>
18 #include <linux/freezer.h>
19 #include <linux/ptrace.h>
20 #include <linux/uaccess.h>
21 #include <trace/events/sched.h>
23 static DEFINE_SPINLOCK(kthread_create_lock);
24 static LIST_HEAD(kthread_create_list);
25 struct task_struct *kthreadd_task;
27 struct kthread_create_info
29 /* Information passed to kthread() from kthreadd. */
30 int (*threadfn)(void *data);
34 /* Result passed back to kthread_create() from kthreadd. */
35 struct task_struct *result;
36 struct completion *done;
38 struct list_head list;
45 struct completion parked;
46 struct completion exited;
50 KTHREAD_IS_PER_CPU = 0,
56 #define __to_kthread(vfork) \
57 container_of(vfork, struct kthread, exited)
59 static inline struct kthread *to_kthread(struct task_struct *k)
61 return __to_kthread(k->vfork_done);
64 static struct kthread *to_live_kthread(struct task_struct *k)
66 struct completion *vfork = ACCESS_ONCE(k->vfork_done);
68 return __to_kthread(vfork);
73 * kthread_should_stop - should this kthread return now?
75 * When someone calls kthread_stop() on your kthread, it will be woken
76 * and this will return true. You should then return, and your return
77 * value will be passed through to kthread_stop().
79 bool kthread_should_stop(void)
81 return test_bit(KTHREAD_SHOULD_STOP, &to_kthread(current)->flags);
83 EXPORT_SYMBOL(kthread_should_stop);
86 * kthread_should_park - should this kthread park now?
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()
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.
96 bool kthread_should_park(void)
98 return test_bit(KTHREAD_SHOULD_PARK, &to_kthread(current)->flags);
100 EXPORT_SYMBOL_GPL(kthread_should_park);
103 * kthread_freezable_should_stop - should this freezable kthread return now?
104 * @was_frozen: optional out parameter, indicates whether %current was frozen
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.
111 bool kthread_freezable_should_stop(bool *was_frozen)
117 if (unlikely(freezing(current)))
118 frozen = __refrigerator(true);
121 *was_frozen = frozen;
123 return kthread_should_stop();
125 EXPORT_SYMBOL_GPL(kthread_freezable_should_stop);
128 * kthread_data - return data value specified on kthread creation
129 * @task: kthread task in question
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.
135 void *kthread_data(struct task_struct *task)
137 return to_kthread(task)->data;
141 * probe_kthread_data - speculative version of kthread_data()
142 * @task: possible kthread task in question
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.
149 void *probe_kthread_data(struct task_struct *task)
151 struct kthread *kthread = to_kthread(task);
154 probe_kernel_read(&data, &kthread->data, sizeof(data));
158 static void __kthread_parkme(struct kthread *self)
160 __set_current_state(TASK_PARKED);
161 while (test_bit(KTHREAD_SHOULD_PARK, &self->flags)) {
162 if (!test_and_set_bit(KTHREAD_IS_PARKED, &self->flags))
163 complete(&self->parked);
165 __set_current_state(TASK_PARKED);
167 clear_bit(KTHREAD_IS_PARKED, &self->flags);
168 __set_current_state(TASK_RUNNING);
171 void kthread_parkme(void)
173 __kthread_parkme(to_kthread(current));
175 EXPORT_SYMBOL_GPL(kthread_parkme);
177 static int kthread(void *_create)
179 /* Copy data: it's on kthread's stack */
180 struct kthread_create_info *create = _create;
181 int (*threadfn)(void *data) = create->threadfn;
182 void *data = create->data;
183 struct completion *done;
189 init_completion(&self.exited);
190 init_completion(&self.parked);
191 current->vfork_done = &self.exited;
193 /* If user was SIGKILLed, I release the structure. */
194 done = xchg(&create->done, NULL);
199 /* OK, tell user we're spawned, wait for stop or wakeup */
200 __set_current_state(TASK_UNINTERRUPTIBLE);
201 create->result = current;
207 if (!test_bit(KTHREAD_SHOULD_STOP, &self.flags)) {
208 __kthread_parkme(&self);
209 ret = threadfn(data);
211 /* we can't just return, we must preserve "self" on stack */
215 /* called from do_fork() to get node information for about to be created task */
216 int tsk_fork_get_node(struct task_struct *tsk)
219 if (tsk == kthreadd_task)
220 return tsk->pref_node_fork;
225 static void create_kthread(struct kthread_create_info *create)
230 current->pref_node_fork = create->node;
232 /* We want our own signal handler (we take no signals by default). */
233 pid = kernel_thread(kthread, create, CLONE_FS | CLONE_FILES | SIGCHLD);
235 /* If user was SIGKILLed, I release the structure. */
236 struct completion *done = xchg(&create->done, NULL);
242 create->result = ERR_PTR(pid);
248 * kthread_create_on_node - create a kthread.
249 * @threadfn: the function to run until signal_pending(current).
250 * @data: data ptr for @threadfn.
251 * @node: task and thread structures for the thread are allocated on this node
252 * @namefmt: printf-style name for the thread.
254 * Description: This helper function creates and names a kernel
255 * thread. The thread will be stopped: use wake_up_process() to start
256 * it. See also kthread_run(). The new thread has SCHED_NORMAL policy and
257 * is affine to all CPUs.
259 * If thread is going to be bound on a particular cpu, give its node
260 * in @node, to get NUMA affinity for kthread stack, or else give NUMA_NO_NODE.
261 * When woken, the thread will run @threadfn() with @data as its
262 * argument. @threadfn() can either call do_exit() directly if it is a
263 * standalone thread for which no one will call kthread_stop(), or
264 * return when 'kthread_should_stop()' is true (which means
265 * kthread_stop() has been called). The return value should be zero
266 * or a negative error number; it will be passed to kthread_stop().
268 * Returns a task_struct or ERR_PTR(-ENOMEM) or ERR_PTR(-EINTR).
270 struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
271 void *data, int node,
272 const char namefmt[],
275 DECLARE_COMPLETION_ONSTACK(done);
276 struct task_struct *task;
277 struct kthread_create_info *create = kmalloc(sizeof(*create),
281 return ERR_PTR(-ENOMEM);
282 create->threadfn = threadfn;
285 create->done = &done;
287 spin_lock(&kthread_create_lock);
288 list_add_tail(&create->list, &kthread_create_list);
289 spin_unlock(&kthread_create_lock);
291 wake_up_process(kthreadd_task);
293 * Wait for completion in killable state, for I might be chosen by
294 * the OOM killer while kthreadd is trying to allocate memory for
297 if (unlikely(wait_for_completion_killable(&done))) {
299 * If I was SIGKILLed before kthreadd (or new kernel thread)
300 * calls complete(), leave the cleanup of this structure to
303 if (xchg(&create->done, NULL))
304 return ERR_PTR(-EINTR);
306 * kthreadd (or new kernel thread) will call complete()
309 wait_for_completion(&done);
311 task = create->result;
313 static const struct sched_param param = { .sched_priority = 0 };
316 va_start(args, namefmt);
317 vsnprintf(task->comm, sizeof(task->comm), namefmt, args);
320 * root may have changed our (kthreadd's) priority or CPU mask.
321 * The kernel thread should not inherit these properties.
323 sched_setscheduler_nocheck(task, SCHED_NORMAL, ¶m);
324 set_cpus_allowed_ptr(task, cpu_all_mask);
329 EXPORT_SYMBOL(kthread_create_on_node);
331 static void __kthread_bind_mask(struct task_struct *p, const struct cpumask *mask, long state)
335 if (!wait_task_inactive(p, state)) {
340 /* It's safe because the task is inactive. */
341 raw_spin_lock_irqsave(&p->pi_lock, flags);
342 do_set_cpus_allowed(p, mask);
343 p->flags |= PF_NO_SETAFFINITY;
344 raw_spin_unlock_irqrestore(&p->pi_lock, flags);
347 static void __kthread_bind(struct task_struct *p, unsigned int cpu, long state)
349 __kthread_bind_mask(p, cpumask_of(cpu), state);
352 void kthread_bind_mask(struct task_struct *p, const struct cpumask *mask)
354 __kthread_bind_mask(p, mask, TASK_UNINTERRUPTIBLE);
358 * kthread_bind - bind a just-created kthread to a cpu.
359 * @p: thread created by kthread_create().
360 * @cpu: cpu (might not be online, must be possible) for @k to run on.
362 * Description: This function is equivalent to set_cpus_allowed(),
363 * except that @cpu doesn't need to be online, and the thread must be
364 * stopped (i.e., just returned from kthread_create()).
366 void kthread_bind(struct task_struct *p, unsigned int cpu)
368 __kthread_bind(p, cpu, TASK_UNINTERRUPTIBLE);
370 EXPORT_SYMBOL(kthread_bind);
373 * kthread_create_on_cpu - Create a cpu bound kthread
374 * @threadfn: the function to run until signal_pending(current).
375 * @data: data ptr for @threadfn.
376 * @cpu: The cpu on which the thread should be bound,
377 * @namefmt: printf-style name for the thread. Format is restricted
378 * to "name.*%u". Code fills in cpu number.
380 * Description: This helper function creates and names a kernel thread
381 * The thread will be woken and put into park mode.
383 struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data),
384 void *data, unsigned int cpu,
387 struct task_struct *p;
389 p = kthread_create_on_node(threadfn, data, cpu_to_node(cpu), namefmt,
393 set_bit(KTHREAD_IS_PER_CPU, &to_kthread(p)->flags);
394 to_kthread(p)->cpu = cpu;
395 /* Park the thread to get it out of TASK_UNINTERRUPTIBLE state */
400 static void __kthread_unpark(struct task_struct *k, struct kthread *kthread)
402 clear_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
404 * We clear the IS_PARKED bit here as we don't wait
405 * until the task has left the park code. So if we'd
406 * park before that happens we'd see the IS_PARKED bit
407 * which might be about to be cleared.
409 if (test_and_clear_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
410 if (test_bit(KTHREAD_IS_PER_CPU, &kthread->flags))
411 __kthread_bind(k, kthread->cpu, TASK_PARKED);
412 wake_up_state(k, TASK_PARKED);
417 * kthread_unpark - unpark a thread created by kthread_create().
418 * @k: thread created by kthread_create().
420 * Sets kthread_should_park() for @k to return false, wakes it, and
421 * waits for it to return. If the thread is marked percpu then its
422 * bound to the cpu again.
424 void kthread_unpark(struct task_struct *k)
426 struct kthread *kthread = to_live_kthread(k);
429 __kthread_unpark(k, kthread);
431 EXPORT_SYMBOL_GPL(kthread_unpark);
434 * kthread_park - park a thread created by kthread_create().
435 * @k: thread created by kthread_create().
437 * Sets kthread_should_park() for @k to return true, wakes it, and
438 * waits for it to return. This can also be called after kthread_create()
439 * instead of calling wake_up_process(): the thread will park without
440 * calling threadfn().
442 * Returns 0 if the thread is parked, -ENOSYS if the thread exited.
443 * If called by the kthread itself just the park bit is set.
445 int kthread_park(struct task_struct *k)
447 struct kthread *kthread = to_live_kthread(k);
451 if (!test_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
452 set_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
455 wait_for_completion(&kthread->parked);
462 EXPORT_SYMBOL_GPL(kthread_park);
465 * kthread_stop - stop a thread created by kthread_create().
466 * @k: thread created by kthread_create().
468 * Sets kthread_should_stop() for @k to return true, wakes it, and
469 * waits for it to exit. This can also be called after kthread_create()
470 * instead of calling wake_up_process(): the thread will exit without
471 * calling threadfn().
473 * If threadfn() may call do_exit() itself, the caller must ensure
474 * task_struct can't go away.
476 * Returns the result of threadfn(), or %-EINTR if wake_up_process()
479 int kthread_stop(struct task_struct *k)
481 struct kthread *kthread;
484 trace_sched_kthread_stop(k);
487 kthread = to_live_kthread(k);
489 set_bit(KTHREAD_SHOULD_STOP, &kthread->flags);
490 __kthread_unpark(k, kthread);
492 wait_for_completion(&kthread->exited);
497 trace_sched_kthread_stop_ret(ret);
500 EXPORT_SYMBOL(kthread_stop);
502 int kthreadd(void *unused)
504 struct task_struct *tsk = current;
506 /* Setup a clean context for our children to inherit. */
507 set_task_comm(tsk, "kthreadd");
509 set_cpus_allowed_ptr(tsk, cpu_all_mask);
510 set_mems_allowed(node_states[N_MEMORY]);
512 current->flags |= PF_NOFREEZE;
515 set_current_state(TASK_INTERRUPTIBLE);
516 if (list_empty(&kthread_create_list))
518 __set_current_state(TASK_RUNNING);
520 spin_lock(&kthread_create_lock);
521 while (!list_empty(&kthread_create_list)) {
522 struct kthread_create_info *create;
524 create = list_entry(kthread_create_list.next,
525 struct kthread_create_info, list);
526 list_del_init(&create->list);
527 spin_unlock(&kthread_create_lock);
529 create_kthread(create);
531 spin_lock(&kthread_create_lock);
533 spin_unlock(&kthread_create_lock);
539 void __init_kthread_worker(struct kthread_worker *worker,
541 struct lock_class_key *key)
543 spin_lock_init(&worker->lock);
544 lockdep_set_class_and_name(&worker->lock, key, name);
545 INIT_LIST_HEAD(&worker->work_list);
548 EXPORT_SYMBOL_GPL(__init_kthread_worker);
551 * kthread_worker_fn - kthread function to process kthread_worker
552 * @worker_ptr: pointer to initialized kthread_worker
554 * This function can be used as @threadfn to kthread_create() or
555 * kthread_run() with @worker_ptr argument pointing to an initialized
556 * kthread_worker. The started kthread will process work_list until
557 * the it is stopped with kthread_stop(). A kthread can also call
558 * this function directly after extra initialization.
560 * Different kthreads can be used for the same kthread_worker as long
561 * as there's only one kthread attached to it at any given time. A
562 * kthread_worker without an attached kthread simply collects queued
565 int kthread_worker_fn(void *worker_ptr)
567 struct kthread_worker *worker = worker_ptr;
568 struct kthread_work *work;
570 WARN_ON(worker->task);
571 worker->task = current;
573 set_current_state(TASK_INTERRUPTIBLE); /* mb paired w/ kthread_stop */
575 if (kthread_should_stop()) {
576 __set_current_state(TASK_RUNNING);
577 spin_lock_irq(&worker->lock);
579 spin_unlock_irq(&worker->lock);
584 spin_lock_irq(&worker->lock);
585 if (!list_empty(&worker->work_list)) {
586 work = list_first_entry(&worker->work_list,
587 struct kthread_work, node);
588 list_del_init(&work->node);
590 worker->current_work = work;
591 spin_unlock_irq(&worker->lock);
594 __set_current_state(TASK_RUNNING);
596 } else if (!freezing(current))
602 EXPORT_SYMBOL_GPL(kthread_worker_fn);
604 /* insert @work before @pos in @worker */
605 static void insert_kthread_work(struct kthread_worker *worker,
606 struct kthread_work *work,
607 struct list_head *pos)
609 lockdep_assert_held(&worker->lock);
611 list_add_tail(&work->node, pos);
612 work->worker = worker;
613 if (!worker->current_work && likely(worker->task))
614 wake_up_process(worker->task);
618 * queue_kthread_work - queue a kthread_work
619 * @worker: target kthread_worker
620 * @work: kthread_work to queue
622 * Queue @work to work processor @task for async execution. @task
623 * must have been created with kthread_worker_create(). Returns %true
624 * if @work was successfully queued, %false if it was already pending.
626 bool queue_kthread_work(struct kthread_worker *worker,
627 struct kthread_work *work)
632 spin_lock_irqsave(&worker->lock, flags);
633 if (list_empty(&work->node)) {
634 insert_kthread_work(worker, work, &worker->work_list);
637 spin_unlock_irqrestore(&worker->lock, flags);
640 EXPORT_SYMBOL_GPL(queue_kthread_work);
642 struct kthread_flush_work {
643 struct kthread_work work;
644 struct completion done;
647 static void kthread_flush_work_fn(struct kthread_work *work)
649 struct kthread_flush_work *fwork =
650 container_of(work, struct kthread_flush_work, work);
651 complete(&fwork->done);
655 * flush_kthread_work - flush a kthread_work
656 * @work: work to flush
658 * If @work is queued or executing, wait for it to finish execution.
660 void flush_kthread_work(struct kthread_work *work)
662 struct kthread_flush_work fwork = {
663 KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
664 COMPLETION_INITIALIZER_ONSTACK(fwork.done),
666 struct kthread_worker *worker;
670 worker = work->worker;
674 spin_lock_irq(&worker->lock);
675 if (work->worker != worker) {
676 spin_unlock_irq(&worker->lock);
680 if (!list_empty(&work->node))
681 insert_kthread_work(worker, &fwork.work, work->node.next);
682 else if (worker->current_work == work)
683 insert_kthread_work(worker, &fwork.work, worker->work_list.next);
687 spin_unlock_irq(&worker->lock);
690 wait_for_completion(&fwork.done);
692 EXPORT_SYMBOL_GPL(flush_kthread_work);
695 * flush_kthread_worker - flush all current works on a kthread_worker
696 * @worker: worker to flush
698 * Wait until all currently executing or pending works on @worker are
701 void flush_kthread_worker(struct kthread_worker *worker)
703 struct kthread_flush_work fwork = {
704 KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
705 COMPLETION_INITIALIZER_ONSTACK(fwork.done),
708 queue_kthread_work(worker, &fwork.work);
709 wait_for_completion(&fwork.done);
711 EXPORT_SYMBOL_GPL(flush_kthread_worker);