Merge tag 'v3.16' into p/abusse/merge_upgrade
[projects/modsched/linux.git] / kernel / kthread.c
1 /* Kernel thread helper functions.
2  *   Copyright (C) 2004 IBM Corporation, Rusty Russell.
3  *
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,
6  * etc.).
7  */
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>
22
23 static DEFINE_SPINLOCK(kthread_create_lock);
24 static LIST_HEAD(kthread_create_list);
25 struct task_struct *kthreadd_task;
26
27 struct kthread_create_info
28 {
29         /* Information passed to kthread() from kthreadd. */
30         int (*threadfn)(void *data);
31         void *data;
32         int node;
33
34         /* Result passed back to kthread_create() from kthreadd. */
35         struct task_struct *result;
36         struct completion *done;
37
38         struct list_head list;
39 };
40
41 struct kthread {
42         unsigned long flags;
43         unsigned int cpu;
44         void *data;
45         struct completion parked;
46         struct completion exited;
47 };
48
49 enum KTHREAD_BITS {
50         KTHREAD_IS_PER_CPU = 0,
51         KTHREAD_SHOULD_STOP,
52         KTHREAD_SHOULD_PARK,
53         KTHREAD_IS_PARKED,
54 };
55
56 #define __to_kthread(vfork)     \
57         container_of(vfork, struct kthread, exited)
58
59 static inline struct kthread *to_kthread(struct task_struct *k)
60 {
61         return __to_kthread(k->vfork_done);
62 }
63
64 static 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 }
71
72 /**
73  * kthread_should_stop - should this kthread return now?
74  *
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().
78  */
79 bool kthread_should_stop(void)
80 {
81         return test_bit(KTHREAD_SHOULD_STOP, &to_kthread(current)->flags);
82 }
83 EXPORT_SYMBOL(kthread_should_stop);
84
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  */
96 bool kthread_should_park(void)
97 {
98         return test_bit(KTHREAD_SHOULD_PARK, &to_kthread(current)->flags);
99 }
100
101 /**
102  * kthread_freezable_should_stop - should this freezable kthread return now?
103  * @was_frozen: optional out parameter, indicates whether %current was frozen
104  *
105  * kthread_should_stop() for freezable kthreads, which will enter
106  * refrigerator if necessary.  This function is safe from kthread_stop() /
107  * freezer deadlock and freezable kthreads should use this function instead
108  * of calling try_to_freeze() directly.
109  */
110 bool kthread_freezable_should_stop(bool *was_frozen)
111 {
112         bool frozen = false;
113
114         might_sleep();
115
116         if (unlikely(freezing(current)))
117                 frozen = __refrigerator(true);
118
119         if (was_frozen)
120                 *was_frozen = frozen;
121
122         return kthread_should_stop();
123 }
124 EXPORT_SYMBOL_GPL(kthread_freezable_should_stop);
125
126 /**
127  * kthread_data - return data value specified on kthread creation
128  * @task: kthread task in question
129  *
130  * Return the data value specified when kthread @task was created.
131  * The caller is responsible for ensuring the validity of @task when
132  * calling this function.
133  */
134 void *kthread_data(struct task_struct *task)
135 {
136         return to_kthread(task)->data;
137 }
138
139 /**
140  * probe_kthread_data - speculative version of kthread_data()
141  * @task: possible kthread task in question
142  *
143  * @task could be a kthread task.  Return the data value specified when it
144  * was created if accessible.  If @task isn't a kthread task or its data is
145  * inaccessible for any reason, %NULL is returned.  This function requires
146  * that @task itself is safe to dereference.
147  */
148 void *probe_kthread_data(struct task_struct *task)
149 {
150         struct kthread *kthread = to_kthread(task);
151         void *data = NULL;
152
153         probe_kernel_read(&data, &kthread->data, sizeof(data));
154         return data;
155 }
156
157 static void __kthread_parkme(struct kthread *self)
158 {
159         __set_current_state(TASK_PARKED);
160         while (test_bit(KTHREAD_SHOULD_PARK, &self->flags)) {
161                 if (!test_and_set_bit(KTHREAD_IS_PARKED, &self->flags))
162                         complete(&self->parked);
163                 schedule();
164                 __set_current_state(TASK_PARKED);
165         }
166         clear_bit(KTHREAD_IS_PARKED, &self->flags);
167         __set_current_state(TASK_RUNNING);
168 }
169
170 void kthread_parkme(void)
171 {
172         __kthread_parkme(to_kthread(current));
173 }
174
175 static int kthread(void *_create)
176 {
177         /* Copy data: it's on kthread's stack */
178         struct kthread_create_info *create = _create;
179         int (*threadfn)(void *data) = create->threadfn;
180         void *data = create->data;
181         struct completion *done;
182         struct kthread self;
183         int ret;
184
185         self.flags = 0;
186         self.data = data;
187         init_completion(&self.exited);
188         init_completion(&self.parked);
189         current->vfork_done = &self.exited;
190
191         /* If user was SIGKILLed, I release the structure. */
192         done = xchg(&create->done, NULL);
193         if (!done) {
194                 kfree(create);
195                 do_exit(-EINTR);
196         }
197         /* OK, tell user we're spawned, wait for stop or wakeup */
198         __set_current_state(TASK_UNINTERRUPTIBLE);
199         create->result = current;
200         complete(done);
201         schedule();
202
203         ret = -EINTR;
204
205         if (!test_bit(KTHREAD_SHOULD_STOP, &self.flags)) {
206                 __kthread_parkme(&self);
207                 ret = threadfn(data);
208         }
209
210         /* we can't just return, we must preserve "self" on stack */
211         do_exit(ret);
212 }
213
214 /* called from do_fork() to get node information for about to be created task */
215 int tsk_fork_get_node(struct task_struct *tsk)
216 {
217 #ifdef CONFIG_NUMA
218         if (tsk == kthreadd_task)
219                 return tsk->pref_node_fork;
220 #endif
221         return NUMA_NO_NODE;
222 }
223
224 static void create_kthread(struct kthread_create_info *create)
225 {
226         int pid;
227
228 #ifdef CONFIG_NUMA
229         current->pref_node_fork = create->node;
230 #endif
231         /* We want our own signal handler (we take no signals by default). */
232         pid = kernel_thread(kthread, create, CLONE_FS | CLONE_FILES | SIGCHLD);
233         if (pid < 0) {
234                 /* If user was SIGKILLed, I release the structure. */
235                 struct completion *done = xchg(&create->done, NULL);
236
237                 if (!done) {
238                         kfree(create);
239                         return;
240                 }
241                 create->result = ERR_PTR(pid);
242                 complete(done);
243         }
244 }
245
246 /**
247  * kthread_create_on_node - create a kthread.
248  * @threadfn: the function to run until signal_pending(current).
249  * @data: data ptr for @threadfn.
250  * @node: memory node number.
251  * @namefmt: printf-style name for the thread.
252  *
253  * Description: This helper function creates and names a kernel
254  * thread.  The thread will be stopped: use wake_up_process() to start
255  * it.  See also kthread_run().
256  *
257  * If thread is going to be bound on a particular cpu, give its node
258  * in @node, to get NUMA affinity for kthread stack, or else give -1.
259  * When woken, the thread will run @threadfn() with @data as its
260  * argument. @threadfn() can either call do_exit() directly if it is a
261  * standalone thread for which no one will call kthread_stop(), or
262  * return when 'kthread_should_stop()' is true (which means
263  * kthread_stop() has been called).  The return value should be zero
264  * or a negative error number; it will be passed to kthread_stop().
265  *
266  * Returns a task_struct or ERR_PTR(-ENOMEM) or ERR_PTR(-EINTR).
267  */
268 struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
269                                            void *data, int node,
270                                            const char namefmt[],
271                                            ...)
272 {
273         DECLARE_COMPLETION_ONSTACK(done);
274         struct task_struct *task;
275         struct kthread_create_info *create = kmalloc(sizeof(*create),
276                                                      GFP_KERNEL);
277
278         if (!create)
279                 return ERR_PTR(-ENOMEM);
280         create->threadfn = threadfn;
281         create->data = data;
282         create->node = node;
283         create->done = &done;
284
285         spin_lock(&kthread_create_lock);
286         list_add_tail(&create->list, &kthread_create_list);
287         spin_unlock(&kthread_create_lock);
288
289         wake_up_process(kthreadd_task);
290         /*
291          * Wait for completion in killable state, for I might be chosen by
292          * the OOM killer while kthreadd is trying to allocate memory for
293          * new kernel thread.
294          */
295         if (unlikely(wait_for_completion_killable(&done))) {
296                 /*
297                  * If I was SIGKILLed before kthreadd (or new kernel thread)
298                  * calls complete(), leave the cleanup of this structure to
299                  * that thread.
300                  */
301                 if (xchg(&create->done, NULL))
302                         return ERR_PTR(-EINTR);
303                 /*
304                  * kthreadd (or new kernel thread) will call complete()
305                  * shortly.
306                  */
307                 wait_for_completion(&done);
308         }
309         task = create->result;
310         if (!IS_ERR(task)) {
311                 static const struct sched_param param = { .sched_priority = 0 };
312                 va_list args;
313
314                 va_start(args, namefmt);
315                 vsnprintf(task->comm, sizeof(task->comm), namefmt, args);
316                 va_end(args);
317                 /*
318                  * root may have changed our (kthreadd's) priority or CPU mask.
319                  * The kernel thread should not inherit these properties.
320                  */
321                 sched_setscheduler_nocheck(task, SCHED_NORMAL, &param);
322                 set_cpus_allowed_ptr(task, cpu_all_mask);
323         }
324         kfree(create);
325         return task;
326 }
327 EXPORT_SYMBOL(kthread_create_on_node);
328
329 static void __kthread_bind(struct task_struct *p, unsigned int cpu, long state)
330 {
331         /* Must have done schedule() in kthread() before we set_task_cpu */
332         if (!wait_task_inactive(p, state)) {
333                 WARN_ON(1);
334                 return;
335         }
336
337         /* It's safe because the task is inactive. */
338         do_set_cpus_allowed(p, cpumask_of(cpu));
339         p->flags |= PF_NO_SETAFFINITY;
340 }
341
342 /**
343  * kthread_bind - bind a just-created kthread to a cpu.
344  * @p: thread created by kthread_create().
345  * @cpu: cpu (might not be online, must be possible) for @k to run on.
346  *
347  * Description: This function is equivalent to set_cpus_allowed(),
348  * except that @cpu doesn't need to be online, and the thread must be
349  * stopped (i.e., just returned from kthread_create()).
350  */
351 void kthread_bind(struct task_struct *p, unsigned int cpu)
352 {
353         __kthread_bind(p, cpu, TASK_UNINTERRUPTIBLE);
354 }
355 EXPORT_SYMBOL(kthread_bind);
356
357 /**
358  * kthread_create_on_cpu - Create a cpu bound kthread
359  * @threadfn: the function to run until signal_pending(current).
360  * @data: data ptr for @threadfn.
361  * @cpu: The cpu on which the thread should be bound,
362  * @namefmt: printf-style name for the thread. Format is restricted
363  *           to "name.*%u". Code fills in cpu number.
364  *
365  * Description: This helper function creates and names a kernel thread
366  * The thread will be woken and put into park mode.
367  */
368 struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data),
369                                           void *data, unsigned int cpu,
370                                           const char *namefmt)
371 {
372         struct task_struct *p;
373
374         p = kthread_create_on_node(threadfn, data, cpu_to_mem(cpu), namefmt,
375                                    cpu);
376         if (IS_ERR(p))
377                 return p;
378         set_bit(KTHREAD_IS_PER_CPU, &to_kthread(p)->flags);
379         to_kthread(p)->cpu = cpu;
380         /* Park the thread to get it out of TASK_UNINTERRUPTIBLE state */
381         kthread_park(p);
382         return p;
383 }
384
385 static void __kthread_unpark(struct task_struct *k, struct kthread *kthread)
386 {
387         clear_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
388         /*
389          * We clear the IS_PARKED bit here as we don't wait
390          * until the task has left the park code. So if we'd
391          * park before that happens we'd see the IS_PARKED bit
392          * which might be about to be cleared.
393          */
394         if (test_and_clear_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
395                 if (test_bit(KTHREAD_IS_PER_CPU, &kthread->flags))
396                         __kthread_bind(k, kthread->cpu, TASK_PARKED);
397                 wake_up_state(k, TASK_PARKED);
398         }
399 }
400
401 /**
402  * kthread_unpark - unpark a thread created by kthread_create().
403  * @k:          thread created by kthread_create().
404  *
405  * Sets kthread_should_park() for @k to return false, wakes it, and
406  * waits for it to return. If the thread is marked percpu then its
407  * bound to the cpu again.
408  */
409 void kthread_unpark(struct task_struct *k)
410 {
411         struct kthread *kthread = to_live_kthread(k);
412
413         if (kthread)
414                 __kthread_unpark(k, kthread);
415 }
416
417 /**
418  * kthread_park - park a thread created by kthread_create().
419  * @k: thread created by kthread_create().
420  *
421  * Sets kthread_should_park() for @k to return true, wakes it, and
422  * waits for it to return. This can also be called after kthread_create()
423  * instead of calling wake_up_process(): the thread will park without
424  * calling threadfn().
425  *
426  * Returns 0 if the thread is parked, -ENOSYS if the thread exited.
427  * If called by the kthread itself just the park bit is set.
428  */
429 int kthread_park(struct task_struct *k)
430 {
431         struct kthread *kthread = to_live_kthread(k);
432         int ret = -ENOSYS;
433
434         if (kthread) {
435                 if (!test_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
436                         set_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
437                         if (k != current) {
438                                 wake_up_process(k);
439                                 wait_for_completion(&kthread->parked);
440                         }
441                 }
442                 ret = 0;
443         }
444         return ret;
445 }
446
447 /**
448  * kthread_stop - stop a thread created by kthread_create().
449  * @k: thread created by kthread_create().
450  *
451  * Sets kthread_should_stop() for @k to return true, wakes it, and
452  * waits for it to exit. This can also be called after kthread_create()
453  * instead of calling wake_up_process(): the thread will exit without
454  * calling threadfn().
455  *
456  * If threadfn() may call do_exit() itself, the caller must ensure
457  * task_struct can't go away.
458  *
459  * Returns the result of threadfn(), or %-EINTR if wake_up_process()
460  * was never called.
461  */
462 int kthread_stop(struct task_struct *k)
463 {
464         struct kthread *kthread;
465         int ret;
466
467         trace_sched_kthread_stop(k);
468
469         get_task_struct(k);
470         kthread = to_live_kthread(k);
471         if (kthread) {
472                 set_bit(KTHREAD_SHOULD_STOP, &kthread->flags);
473                 __kthread_unpark(k, kthread);
474                 wake_up_process(k);
475                 wait_for_completion(&kthread->exited);
476         }
477         ret = k->exit_code;
478         put_task_struct(k);
479
480         trace_sched_kthread_stop_ret(ret);
481         return ret;
482 }
483 EXPORT_SYMBOL(kthread_stop);
484
485 int kthreadd(void *unused)
486 {
487         struct task_struct *tsk = current;
488
489         /* Setup a clean context for our children to inherit. */
490         set_task_comm(tsk, "kthreadd");
491         ignore_signals(tsk);
492         set_cpus_allowed_ptr(tsk, cpu_all_mask);
493         set_mems_allowed(node_states[N_MEMORY]);
494
495         current->flags |= PF_NOFREEZE;
496
497         for (;;) {
498                 set_current_state(TASK_INTERRUPTIBLE);
499                 if (list_empty(&kthread_create_list))
500                         schedule();
501                 __set_current_state(TASK_RUNNING);
502
503                 spin_lock(&kthread_create_lock);
504                 while (!list_empty(&kthread_create_list)) {
505                         struct kthread_create_info *create;
506
507                         create = list_entry(kthread_create_list.next,
508                                             struct kthread_create_info, list);
509                         list_del_init(&create->list);
510                         spin_unlock(&kthread_create_lock);
511
512                         create_kthread(create);
513
514                         spin_lock(&kthread_create_lock);
515                 }
516                 spin_unlock(&kthread_create_lock);
517         }
518
519         return 0;
520 }
521
522 void __init_kthread_worker(struct kthread_worker *worker,
523                                 const char *name,
524                                 struct lock_class_key *key)
525 {
526         spin_lock_init(&worker->lock);
527         lockdep_set_class_and_name(&worker->lock, key, name);
528         INIT_LIST_HEAD(&worker->work_list);
529         worker->task = NULL;
530 }
531 EXPORT_SYMBOL_GPL(__init_kthread_worker);
532
533 /**
534  * kthread_worker_fn - kthread function to process kthread_worker
535  * @worker_ptr: pointer to initialized kthread_worker
536  *
537  * This function can be used as @threadfn to kthread_create() or
538  * kthread_run() with @worker_ptr argument pointing to an initialized
539  * kthread_worker.  The started kthread will process work_list until
540  * the it is stopped with kthread_stop().  A kthread can also call
541  * this function directly after extra initialization.
542  *
543  * Different kthreads can be used for the same kthread_worker as long
544  * as there's only one kthread attached to it at any given time.  A
545  * kthread_worker without an attached kthread simply collects queued
546  * kthread_works.
547  */
548 int kthread_worker_fn(void *worker_ptr)
549 {
550         struct kthread_worker *worker = worker_ptr;
551         struct kthread_work *work;
552
553         WARN_ON(worker->task);
554         worker->task = current;
555 repeat:
556         set_current_state(TASK_INTERRUPTIBLE);  /* mb paired w/ kthread_stop */
557
558         if (kthread_should_stop()) {
559                 __set_current_state(TASK_RUNNING);
560                 spin_lock_irq(&worker->lock);
561                 worker->task = NULL;
562                 spin_unlock_irq(&worker->lock);
563                 return 0;
564         }
565
566         work = NULL;
567         spin_lock_irq(&worker->lock);
568         if (!list_empty(&worker->work_list)) {
569                 work = list_first_entry(&worker->work_list,
570                                         struct kthread_work, node);
571                 list_del_init(&work->node);
572         }
573         worker->current_work = work;
574         spin_unlock_irq(&worker->lock);
575
576         if (work) {
577                 __set_current_state(TASK_RUNNING);
578                 work->func(work);
579         } else if (!freezing(current))
580                 schedule();
581
582         try_to_freeze();
583         goto repeat;
584 }
585 EXPORT_SYMBOL_GPL(kthread_worker_fn);
586
587 /* insert @work before @pos in @worker */
588 static void insert_kthread_work(struct kthread_worker *worker,
589                                struct kthread_work *work,
590                                struct list_head *pos)
591 {
592         lockdep_assert_held(&worker->lock);
593
594         list_add_tail(&work->node, pos);
595         work->worker = worker;
596         if (likely(worker->task))
597                 wake_up_process(worker->task);
598 }
599
600 /**
601  * queue_kthread_work - queue a kthread_work
602  * @worker: target kthread_worker
603  * @work: kthread_work to queue
604  *
605  * Queue @work to work processor @task for async execution.  @task
606  * must have been created with kthread_worker_create().  Returns %true
607  * if @work was successfully queued, %false if it was already pending.
608  */
609 bool queue_kthread_work(struct kthread_worker *worker,
610                         struct kthread_work *work)
611 {
612         bool ret = false;
613         unsigned long flags;
614
615         spin_lock_irqsave(&worker->lock, flags);
616         if (list_empty(&work->node)) {
617                 insert_kthread_work(worker, work, &worker->work_list);
618                 ret = true;
619         }
620         spin_unlock_irqrestore(&worker->lock, flags);
621         return ret;
622 }
623 EXPORT_SYMBOL_GPL(queue_kthread_work);
624
625 struct kthread_flush_work {
626         struct kthread_work     work;
627         struct completion       done;
628 };
629
630 static void kthread_flush_work_fn(struct kthread_work *work)
631 {
632         struct kthread_flush_work *fwork =
633                 container_of(work, struct kthread_flush_work, work);
634         complete(&fwork->done);
635 }
636
637 /**
638  * flush_kthread_work - flush a kthread_work
639  * @work: work to flush
640  *
641  * If @work is queued or executing, wait for it to finish execution.
642  */
643 void flush_kthread_work(struct kthread_work *work)
644 {
645         struct kthread_flush_work fwork = {
646                 KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
647                 COMPLETION_INITIALIZER_ONSTACK(fwork.done),
648         };
649         struct kthread_worker *worker;
650         bool noop = false;
651
652 retry:
653         worker = work->worker;
654         if (!worker)
655                 return;
656
657         spin_lock_irq(&worker->lock);
658         if (work->worker != worker) {
659                 spin_unlock_irq(&worker->lock);
660                 goto retry;
661         }
662
663         if (!list_empty(&work->node))
664                 insert_kthread_work(worker, &fwork.work, work->node.next);
665         else if (worker->current_work == work)
666                 insert_kthread_work(worker, &fwork.work, worker->work_list.next);
667         else
668                 noop = true;
669
670         spin_unlock_irq(&worker->lock);
671
672         if (!noop)
673                 wait_for_completion(&fwork.done);
674 }
675 EXPORT_SYMBOL_GPL(flush_kthread_work);
676
677 /**
678  * flush_kthread_worker - flush all current works on a kthread_worker
679  * @worker: worker to flush
680  *
681  * Wait until all currently executing or pending works on @worker are
682  * finished.
683  */
684 void flush_kthread_worker(struct kthread_worker *worker)
685 {
686         struct kthread_flush_work fwork = {
687                 KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
688                 COMPLETION_INITIALIZER_ONSTACK(fwork.done),
689         };
690
691         queue_kthread_work(worker, &fwork.work);
692         wait_for_completion(&fwork.done);
693 }
694 EXPORT_SYMBOL_GPL(flush_kthread_worker);