kthreads: simplify the startup synchronization
[linux-2.6.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/module.h>
16 #include <linux/mutex.h>
17 #include <trace/events/sched.h>
18
19 #define KTHREAD_NICE_LEVEL (-5)
20
21 static DEFINE_SPINLOCK(kthread_create_lock);
22 static LIST_HEAD(kthread_create_list);
23 struct task_struct *kthreadd_task;
24
25 struct kthread_create_info
26 {
27         /* Information passed to kthread() from kthreadd. */
28         int (*threadfn)(void *data);
29         void *data;
30
31         /* Result passed back to kthread_create() from kthreadd. */
32         struct task_struct *result;
33         struct completion done;
34
35         struct list_head list;
36 };
37
38 struct kthread_stop_info
39 {
40         struct task_struct *k;
41         int err;
42         struct completion done;
43 };
44
45 /* Thread stopping is done by setthing this var: lock serializes
46  * multiple kthread_stop calls. */
47 static DEFINE_MUTEX(kthread_stop_lock);
48 static struct kthread_stop_info kthread_stop_info;
49
50 /**
51  * kthread_should_stop - should this kthread return now?
52  *
53  * When someone calls kthread_stop() on your kthread, it will be woken
54  * and this will return true.  You should then return, and your return
55  * value will be passed through to kthread_stop().
56  */
57 int kthread_should_stop(void)
58 {
59         return (kthread_stop_info.k == current);
60 }
61 EXPORT_SYMBOL(kthread_should_stop);
62
63 static int kthread(void *_create)
64 {
65         struct kthread_create_info *create = _create;
66         int (*threadfn)(void *data);
67         void *data;
68         int ret = -EINTR;
69
70         /* Copy data: it's on kthread's stack */
71         threadfn = create->threadfn;
72         data = create->data;
73
74         /* OK, tell user we're spawned, wait for stop or wakeup */
75         __set_current_state(TASK_UNINTERRUPTIBLE);
76         create->result = current;
77         complete(&create->done);
78         schedule();
79
80         if (!kthread_should_stop())
81                 ret = threadfn(data);
82
83         /* It might have exited on its own, w/o kthread_stop.  Check. */
84         if (kthread_should_stop()) {
85                 kthread_stop_info.err = ret;
86                 complete(&kthread_stop_info.done);
87         }
88         return 0;
89 }
90
91 static void create_kthread(struct kthread_create_info *create)
92 {
93         int pid;
94
95         /* We want our own signal handler (we take no signals by default). */
96         pid = kernel_thread(kthread, create, CLONE_FS | CLONE_FILES | SIGCHLD);
97         if (pid < 0) {
98                 create->result = ERR_PTR(pid);
99                 complete(&create->done);
100         }
101 }
102
103 /**
104  * kthread_create - create a kthread.
105  * @threadfn: the function to run until signal_pending(current).
106  * @data: data ptr for @threadfn.
107  * @namefmt: printf-style name for the thread.
108  *
109  * Description: This helper function creates and names a kernel
110  * thread.  The thread will be stopped: use wake_up_process() to start
111  * it.  See also kthread_run(), kthread_create_on_cpu().
112  *
113  * When woken, the thread will run @threadfn() with @data as its
114  * argument. @threadfn() can either call do_exit() directly if it is a
115  * standalone thread for which noone will call kthread_stop(), or
116  * return when 'kthread_should_stop()' is true (which means
117  * kthread_stop() has been called).  The return value should be zero
118  * or a negative error number; it will be passed to kthread_stop().
119  *
120  * Returns a task_struct or ERR_PTR(-ENOMEM).
121  */
122 struct task_struct *kthread_create(int (*threadfn)(void *data),
123                                    void *data,
124                                    const char namefmt[],
125                                    ...)
126 {
127         struct kthread_create_info create;
128
129         create.threadfn = threadfn;
130         create.data = data;
131         init_completion(&create.done);
132
133         spin_lock(&kthread_create_lock);
134         list_add_tail(&create.list, &kthread_create_list);
135         spin_unlock(&kthread_create_lock);
136
137         wake_up_process(kthreadd_task);
138         wait_for_completion(&create.done);
139
140         if (!IS_ERR(create.result)) {
141                 struct sched_param param = { .sched_priority = 0 };
142                 va_list args;
143
144                 va_start(args, namefmt);
145                 vsnprintf(create.result->comm, sizeof(create.result->comm),
146                           namefmt, args);
147                 va_end(args);
148                 /*
149                  * root may have changed our (kthreadd's) priority or CPU mask.
150                  * The kernel thread should not inherit these properties.
151                  */
152                 sched_setscheduler_nocheck(create.result, SCHED_NORMAL, &param);
153                 set_user_nice(create.result, KTHREAD_NICE_LEVEL);
154                 set_cpus_allowed_ptr(create.result, cpu_all_mask);
155         }
156         return create.result;
157 }
158 EXPORT_SYMBOL(kthread_create);
159
160 /**
161  * kthread_bind - bind a just-created kthread to a cpu.
162  * @k: thread created by kthread_create().
163  * @cpu: cpu (might not be online, must be possible) for @k to run on.
164  *
165  * Description: This function is equivalent to set_cpus_allowed(),
166  * except that @cpu doesn't need to be online, and the thread must be
167  * stopped (i.e., just returned from kthread_create()).
168  */
169 void kthread_bind(struct task_struct *k, unsigned int cpu)
170 {
171         /* Must have done schedule() in kthread() before we set_task_cpu */
172         if (!wait_task_inactive(k, TASK_UNINTERRUPTIBLE)) {
173                 WARN_ON(1);
174                 return;
175         }
176         set_task_cpu(k, cpu);
177         k->cpus_allowed = cpumask_of_cpu(cpu);
178         k->rt.nr_cpus_allowed = 1;
179         k->flags |= PF_THREAD_BOUND;
180 }
181 EXPORT_SYMBOL(kthread_bind);
182
183 /**
184  * kthread_stop - stop a thread created by kthread_create().
185  * @k: thread created by kthread_create().
186  *
187  * Sets kthread_should_stop() for @k to return true, wakes it, and
188  * waits for it to exit.  Your threadfn() must not call do_exit()
189  * itself if you use this function!  This can also be called after
190  * kthread_create() instead of calling wake_up_process(): the thread
191  * will exit without calling threadfn().
192  *
193  * Returns the result of threadfn(), or %-EINTR if wake_up_process()
194  * was never called.
195  */
196 int kthread_stop(struct task_struct *k)
197 {
198         int ret;
199
200         mutex_lock(&kthread_stop_lock);
201
202         /* It could exit after stop_info.k set, but before wake_up_process. */
203         get_task_struct(k);
204
205         trace_sched_kthread_stop(k);
206
207         /* Must init completion *before* thread sees kthread_stop_info.k */
208         init_completion(&kthread_stop_info.done);
209         smp_wmb();
210
211         /* Now set kthread_should_stop() to true, and wake it up. */
212         kthread_stop_info.k = k;
213         wake_up_process(k);
214         put_task_struct(k);
215
216         /* Once it dies, reset stop ptr, gather result and we're done. */
217         wait_for_completion(&kthread_stop_info.done);
218         kthread_stop_info.k = NULL;
219         ret = kthread_stop_info.err;
220         mutex_unlock(&kthread_stop_lock);
221
222         trace_sched_kthread_stop_ret(ret);
223
224         return ret;
225 }
226 EXPORT_SYMBOL(kthread_stop);
227
228 int kthreadd(void *unused)
229 {
230         struct task_struct *tsk = current;
231
232         /* Setup a clean context for our children to inherit. */
233         set_task_comm(tsk, "kthreadd");
234         ignore_signals(tsk);
235         set_user_nice(tsk, KTHREAD_NICE_LEVEL);
236         set_cpus_allowed_ptr(tsk, cpu_all_mask);
237         set_mems_allowed(node_possible_map);
238
239         current->flags |= PF_NOFREEZE | PF_FREEZER_NOSIG;
240
241         for (;;) {
242                 set_current_state(TASK_INTERRUPTIBLE);
243                 if (list_empty(&kthread_create_list))
244                         schedule();
245                 __set_current_state(TASK_RUNNING);
246
247                 spin_lock(&kthread_create_lock);
248                 while (!list_empty(&kthread_create_list)) {
249                         struct kthread_create_info *create;
250
251                         create = list_entry(kthread_create_list.next,
252                                             struct kthread_create_info, list);
253                         list_del_init(&create->list);
254                         spin_unlock(&kthread_create_lock);
255
256                         create_kthread(create);
257
258                         spin_lock(&kthread_create_lock);
259                 }
260                 spin_unlock(&kthread_create_lock);
261         }
262
263         return 0;
264 }