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