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