Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* Kernel thread helper functions. |
| 2 | * Copyright (C) 2004 IBM Corporation, Rusty Russell. |
| 3 | * |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 4 | * Creation is done via kthreadd, so that we get a clean environment |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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/unistd.h> |
| 13 | #include <linux/file.h> |
| 14 | #include <linux/module.h> |
Arjan van de Ven | 97d1f15 | 2006-03-23 03:00:24 -0800 | [diff] [blame] | 15 | #include <linux/mutex.h> |
Steven Rostedt | ad8d75f | 2009-04-14 19:39:12 -0400 | [diff] [blame] | 16 | #include <trace/events/sched.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 17 | |
Michal Schmidt | 4f05b98 | 2008-01-25 21:08:33 +0100 | [diff] [blame] | 18 | #define KTHREAD_NICE_LEVEL (-5) |
| 19 | |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 20 | static DEFINE_SPINLOCK(kthread_create_lock); |
| 21 | static LIST_HEAD(kthread_create_list); |
| 22 | struct task_struct *kthreadd_task; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 23 | |
| 24 | struct kthread_create_info |
| 25 | { |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 26 | /* Information passed to kthread() from kthreadd. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | int (*threadfn)(void *data); |
| 28 | void *data; |
| 29 | struct completion started; |
| 30 | |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 31 | /* Result passed back to kthread_create() from kthreadd. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | struct task_struct *result; |
| 33 | struct completion done; |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 34 | |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 35 | struct list_head list; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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. */ |
Arjan van de Ven | 97d1f15 | 2006-03-23 03:00:24 -0800 | [diff] [blame] | 47 | static DEFINE_MUTEX(kthread_stop_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | static struct kthread_stop_info kthread_stop_info; |
| 49 | |
Randy Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 50 | /** |
| 51 | * kthread_should_stop - should this kthread return now? |
| 52 | * |
Robert P. J. Day | 72fd4a3 | 2007-02-10 01:45:59 -0800 | [diff] [blame] | 53 | * When someone calls kthread_stop() on your kthread, it will be woken |
Randy Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 54 | * and this will return true. You should then return, and your return |
| 55 | * value will be passed through to kthread_stop(). |
| 56 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | int kthread_should_stop(void) |
| 58 | { |
| 59 | return (kthread_stop_info.k == current); |
| 60 | } |
| 61 | EXPORT_SYMBOL(kthread_should_stop); |
| 62 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | static int kthread(void *_create) |
| 64 | { |
| 65 | struct kthread_create_info *create = _create; |
| 66 | int (*threadfn)(void *data); |
| 67 | void *data; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 68 | int ret = -EINTR; |
| 69 | |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 70 | /* Copy data: it's on kthread's stack */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 71 | threadfn = create->threadfn; |
| 72 | data = create->data; |
| 73 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 74 | /* OK, tell user we're spawned, wait for stop or wakeup */ |
Oleg Nesterov | a076e4b | 2007-05-23 13:57:27 -0700 | [diff] [blame] | 75 | __set_current_state(TASK_UNINTERRUPTIBLE); |
Vitaliy Gusev | 3217ab9 | 2009-04-09 09:50:35 -0600 | [diff] [blame] | 76 | create->result = current; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | complete(&create->started); |
| 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 | |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 91 | static void create_kthread(struct kthread_create_info *create) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 92 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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); |
Oleg Nesterov | 1c99315 | 2009-04-09 09:50:36 -0600 | [diff] [blame] | 97 | if (pid < 0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 98 | create->result = ERR_PTR(pid); |
Oleg Nesterov | 1c99315 | 2009-04-09 09:50:36 -0600 | [diff] [blame] | 99 | else |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | wait_for_completion(&create->started); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | complete(&create->done); |
| 102 | } |
| 103 | |
Randy Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 104 | /** |
| 105 | * kthread_create - create a kthread. |
| 106 | * @threadfn: the function to run until signal_pending(current). |
| 107 | * @data: data ptr for @threadfn. |
| 108 | * @namefmt: printf-style name for the thread. |
| 109 | * |
| 110 | * Description: This helper function creates and names a kernel |
| 111 | * thread. The thread will be stopped: use wake_up_process() to start |
| 112 | * it. See also kthread_run(), kthread_create_on_cpu(). |
| 113 | * |
| 114 | * When woken, the thread will run @threadfn() with @data as its |
Robert P. J. Day | 72fd4a3 | 2007-02-10 01:45:59 -0800 | [diff] [blame] | 115 | * argument. @threadfn() can either call do_exit() directly if it is a |
Randy Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 116 | * standalone thread for which noone will call kthread_stop(), or |
| 117 | * return when 'kthread_should_stop()' is true (which means |
| 118 | * kthread_stop() has been called). The return value should be zero |
| 119 | * or a negative error number; it will be passed to kthread_stop(). |
| 120 | * |
| 121 | * Returns a task_struct or ERR_PTR(-ENOMEM). |
| 122 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | struct task_struct *kthread_create(int (*threadfn)(void *data), |
| 124 | void *data, |
| 125 | const char namefmt[], |
| 126 | ...) |
| 127 | { |
| 128 | struct kthread_create_info create; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | |
| 130 | create.threadfn = threadfn; |
| 131 | create.data = data; |
| 132 | init_completion(&create.started); |
| 133 | init_completion(&create.done); |
| 134 | |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 135 | spin_lock(&kthread_create_lock); |
| 136 | list_add_tail(&create.list, &kthread_create_list); |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 137 | spin_unlock(&kthread_create_lock); |
| 138 | |
Dmitry Adamushko | cbd9b67 | 2008-04-29 00:59:23 -0700 | [diff] [blame] | 139 | wake_up_process(kthreadd_task); |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 140 | wait_for_completion(&create.done); |
| 141 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | if (!IS_ERR(create.result)) { |
Oleg Nesterov | 1c99315 | 2009-04-09 09:50:36 -0600 | [diff] [blame] | 143 | struct sched_param param = { .sched_priority = 0 }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | va_list args; |
Oleg Nesterov | 1c99315 | 2009-04-09 09:50:36 -0600 | [diff] [blame] | 145 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 146 | va_start(args, namefmt); |
| 147 | vsnprintf(create.result->comm, sizeof(create.result->comm), |
| 148 | namefmt, args); |
| 149 | va_end(args); |
Oleg Nesterov | 1c99315 | 2009-04-09 09:50:36 -0600 | [diff] [blame] | 150 | /* |
| 151 | * root may have changed our (kthreadd's) priority or CPU mask. |
| 152 | * The kernel thread should not inherit these properties. |
| 153 | */ |
| 154 | sched_setscheduler_nocheck(create.result, SCHED_NORMAL, ¶m); |
| 155 | set_user_nice(create.result, KTHREAD_NICE_LEVEL); |
| 156 | set_cpus_allowed_ptr(create.result, cpu_all_mask); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 157 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | return create.result; |
| 159 | } |
| 160 | EXPORT_SYMBOL(kthread_create); |
| 161 | |
Randy Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 162 | /** |
| 163 | * kthread_bind - bind a just-created kthread to a cpu. |
| 164 | * @k: thread created by kthread_create(). |
| 165 | * @cpu: cpu (might not be online, must be possible) for @k to run on. |
| 166 | * |
| 167 | * Description: This function is equivalent to set_cpus_allowed(), |
| 168 | * except that @cpu doesn't need to be online, and the thread must be |
Robert P. J. Day | 72fd4a3 | 2007-02-10 01:45:59 -0800 | [diff] [blame] | 169 | * stopped (i.e., just returned from kthread_create()). |
Randy Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 170 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | void kthread_bind(struct task_struct *k, unsigned int cpu) |
| 172 | { |
Oleg Nesterov | 293adee | 2008-10-18 20:28:24 -0700 | [diff] [blame] | 173 | /* Must have done schedule() in kthread() before we set_task_cpu */ |
| 174 | if (!wait_task_inactive(k, TASK_UNINTERRUPTIBLE)) { |
Oleg Nesterov | a076e4b | 2007-05-23 13:57:27 -0700 | [diff] [blame] | 175 | WARN_ON(1); |
| 176 | return; |
| 177 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 178 | set_task_cpu(k, cpu); |
| 179 | k->cpus_allowed = cpumask_of_cpu(cpu); |
Gregory Haskins | 9f0e738 | 2008-02-12 13:30:05 -0500 | [diff] [blame] | 180 | k->rt.nr_cpus_allowed = 1; |
David Rientjes | 9985b0b | 2008-06-05 12:57:11 -0700 | [diff] [blame] | 181 | k->flags |= PF_THREAD_BOUND; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | } |
| 183 | EXPORT_SYMBOL(kthread_bind); |
| 184 | |
Randy Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 185 | /** |
| 186 | * kthread_stop - stop a thread created by kthread_create(). |
| 187 | * @k: thread created by kthread_create(). |
| 188 | * |
| 189 | * Sets kthread_should_stop() for @k to return true, wakes it, and |
| 190 | * waits for it to exit. Your threadfn() must not call do_exit() |
| 191 | * itself if you use this function! This can also be called after |
| 192 | * kthread_create() instead of calling wake_up_process(): the thread |
| 193 | * will exit without calling threadfn(). |
| 194 | * |
| 195 | * Returns the result of threadfn(), or %-EINTR if wake_up_process() |
| 196 | * was never called. |
| 197 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 198 | int kthread_stop(struct task_struct *k) |
| 199 | { |
| 200 | int ret; |
| 201 | |
Arjan van de Ven | 97d1f15 | 2006-03-23 03:00:24 -0800 | [diff] [blame] | 202 | mutex_lock(&kthread_stop_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 203 | |
| 204 | /* It could exit after stop_info.k set, but before wake_up_process. */ |
| 205 | get_task_struct(k); |
| 206 | |
Mathieu Desnoyers | 0a16b60 | 2008-07-18 12:16:17 -0400 | [diff] [blame] | 207 | trace_sched_kthread_stop(k); |
| 208 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 209 | /* Must init completion *before* thread sees kthread_stop_info.k */ |
| 210 | init_completion(&kthread_stop_info.done); |
akpm@osdl.org | d59dd46 | 2005-05-01 08:58:47 -0700 | [diff] [blame] | 211 | smp_wmb(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 212 | |
| 213 | /* Now set kthread_should_stop() to true, and wake it up. */ |
| 214 | kthread_stop_info.k = k; |
Adrian Bunk | 52e92e5 | 2006-07-14 00:24:05 -0700 | [diff] [blame] | 215 | wake_up_process(k); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 216 | put_task_struct(k); |
| 217 | |
| 218 | /* Once it dies, reset stop ptr, gather result and we're done. */ |
| 219 | wait_for_completion(&kthread_stop_info.done); |
| 220 | kthread_stop_info.k = NULL; |
| 221 | ret = kthread_stop_info.err; |
Arjan van de Ven | 97d1f15 | 2006-03-23 03:00:24 -0800 | [diff] [blame] | 222 | mutex_unlock(&kthread_stop_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 223 | |
Mathieu Desnoyers | 0a16b60 | 2008-07-18 12:16:17 -0400 | [diff] [blame] | 224 | trace_sched_kthread_stop_ret(ret); |
| 225 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 226 | return ret; |
| 227 | } |
Adrian Bunk | 52e92e5 | 2006-07-14 00:24:05 -0700 | [diff] [blame] | 228 | EXPORT_SYMBOL(kthread_stop); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 229 | |
Satyam Sharma | e804a4a | 2007-07-31 00:39:16 -0700 | [diff] [blame] | 230 | int kthreadd(void *unused) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 231 | { |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 232 | struct task_struct *tsk = current; |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 233 | |
Satyam Sharma | e804a4a | 2007-07-31 00:39:16 -0700 | [diff] [blame] | 234 | /* Setup a clean context for our children to inherit. */ |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 235 | set_task_comm(tsk, "kthreadd"); |
Oleg Nesterov | 10ab825 | 2007-05-09 02:34:37 -0700 | [diff] [blame] | 236 | ignore_signals(tsk); |
Michal Schmidt | 4f05b98 | 2008-01-25 21:08:33 +0100 | [diff] [blame] | 237 | set_user_nice(tsk, KTHREAD_NICE_LEVEL); |
Rusty Russell | 1a2142a | 2009-03-30 22:05:10 -0600 | [diff] [blame] | 238 | set_cpus_allowed_ptr(tsk, cpu_all_mask); |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 239 | |
Rafael J. Wysocki | ebb12db | 2008-06-11 22:04:29 +0200 | [diff] [blame] | 240 | current->flags |= PF_NOFREEZE | PF_FREEZER_NOSIG; |
Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 241 | |
| 242 | for (;;) { |
| 243 | set_current_state(TASK_INTERRUPTIBLE); |
| 244 | if (list_empty(&kthread_create_list)) |
| 245 | schedule(); |
| 246 | __set_current_state(TASK_RUNNING); |
| 247 | |
| 248 | spin_lock(&kthread_create_lock); |
| 249 | while (!list_empty(&kthread_create_list)) { |
| 250 | struct kthread_create_info *create; |
| 251 | |
| 252 | create = list_entry(kthread_create_list.next, |
| 253 | struct kthread_create_info, list); |
| 254 | list_del_init(&create->list); |
| 255 | spin_unlock(&kthread_create_lock); |
| 256 | |
| 257 | create_kthread(create); |
| 258 | |
| 259 | spin_lock(&kthread_create_lock); |
| 260 | } |
| 261 | spin_unlock(&kthread_create_lock); |
| 262 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 263 | |
| 264 | return 0; |
| 265 | } |