____call_usermodehelper: don't flush_signals()
[linux-2.6.git] / kernel / kmod.c
1 /*
2         kmod, the new module loader (replaces kerneld)
3         Kirk Petersen
4
5         Reorganized not to be a daemon by Adam Richter, with guidance
6         from Greg Zornetzer.
7
8         Modified to avoid chroot and file sharing problems.
9         Mikael Pettersson
10
11         Limit the concurrent number of kmod modprobes to catch loops from
12         "modprobe needs a service that is in a module".
13         Keith Owens <kaos@ocs.com.au> December 1999
14
15         Unblock all signals when we exec a usermode process.
16         Shuu Yamaguchi <shuu@wondernetworkresources.com> December 2000
17
18         call_usermodehelper wait flag, and remove exec_usermodehelper.
19         Rusty Russell <rusty@rustcorp.com.au>  Jan 2003
20 */
21 #include <linux/module.h>
22 #include <linux/sched.h>
23 #include <linux/syscalls.h>
24 #include <linux/unistd.h>
25 #include <linux/kmod.h>
26 #include <linux/slab.h>
27 #include <linux/mnt_namespace.h>
28 #include <linux/completion.h>
29 #include <linux/file.h>
30 #include <linux/workqueue.h>
31 #include <linux/security.h>
32 #include <linux/mount.h>
33 #include <linux/kernel.h>
34 #include <linux/init.h>
35 #include <linux/resource.h>
36 #include <asm/uaccess.h>
37
38 extern int max_threads;
39
40 static struct workqueue_struct *khelper_wq;
41
42 #ifdef CONFIG_KMOD
43
44 /*
45         modprobe_path is set via /proc/sys.
46 */
47 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
48
49 /**
50  * request_module - try to load a kernel module
51  * @fmt:     printf style format string for the name of the module
52  * @varargs: arguements as specified in the format string
53  *
54  * Load a module using the user mode module loader. The function returns
55  * zero on success or a negative errno code on failure. Note that a
56  * successful module load does not mean the module did not then unload
57  * and exit on an error of its own. Callers must check that the service
58  * they requested is now available not blindly invoke it.
59  *
60  * If module auto-loading support is disabled then this function
61  * becomes a no-operation.
62  */
63 int request_module(const char *fmt, ...)
64 {
65         va_list args;
66         char module_name[MODULE_NAME_LEN];
67         unsigned int max_modprobes;
68         int ret;
69         char *argv[] = { modprobe_path, "-q", "--", module_name, NULL };
70         static char *envp[] = { "HOME=/",
71                                 "TERM=linux",
72                                 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
73                                 NULL };
74         static atomic_t kmod_concurrent = ATOMIC_INIT(0);
75 #define MAX_KMOD_CONCURRENT 50  /* Completely arbitrary value - KAO */
76         static int kmod_loop_msg;
77
78         va_start(args, fmt);
79         ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
80         va_end(args);
81         if (ret >= MODULE_NAME_LEN)
82                 return -ENAMETOOLONG;
83
84         /* If modprobe needs a service that is in a module, we get a recursive
85          * loop.  Limit the number of running kmod threads to max_threads/2 or
86          * MAX_KMOD_CONCURRENT, whichever is the smaller.  A cleaner method
87          * would be to run the parents of this process, counting how many times
88          * kmod was invoked.  That would mean accessing the internals of the
89          * process tables to get the command line, proc_pid_cmdline is static
90          * and it is not worth changing the proc code just to handle this case. 
91          * KAO.
92          *
93          * "trace the ppid" is simple, but will fail if someone's
94          * parent exits.  I think this is as good as it gets. --RR
95          */
96         max_modprobes = min(max_threads/2, MAX_KMOD_CONCURRENT);
97         atomic_inc(&kmod_concurrent);
98         if (atomic_read(&kmod_concurrent) > max_modprobes) {
99                 /* We may be blaming an innocent here, but unlikely */
100                 if (kmod_loop_msg++ < 5)
101                         printk(KERN_ERR
102                                "request_module: runaway loop modprobe %s\n",
103                                module_name);
104                 atomic_dec(&kmod_concurrent);
105                 return -ENOMEM;
106         }
107
108         ret = call_usermodehelper(modprobe_path, argv, envp, 1);
109         atomic_dec(&kmod_concurrent);
110         return ret;
111 }
112 EXPORT_SYMBOL(request_module);
113 #endif /* CONFIG_KMOD */
114
115 struct subprocess_info {
116         struct work_struct work;
117         struct completion *complete;
118         char *path;
119         char **argv;
120         char **envp;
121         struct key *ring;
122         int wait;
123         int retval;
124         struct file *stdin;
125 };
126
127 /*
128  * This is the task which runs the usermode application
129  */
130 static int ____call_usermodehelper(void *data)
131 {
132         struct subprocess_info *sub_info = data;
133         struct key *new_session, *old_session;
134         int retval;
135
136         /* Unblock all signals and set the session keyring. */
137         new_session = key_get(sub_info->ring);
138         spin_lock_irq(&current->sighand->siglock);
139         old_session = __install_session_keyring(current, new_session);
140         flush_signal_handlers(current, 1);
141         sigemptyset(&current->blocked);
142         recalc_sigpending();
143         spin_unlock_irq(&current->sighand->siglock);
144
145         key_put(old_session);
146
147         /* Install input pipe when needed */
148         if (sub_info->stdin) {
149                 struct files_struct *f = current->files;
150                 struct fdtable *fdt;
151                 /* no races because files should be private here */
152                 sys_close(0);
153                 fd_install(0, sub_info->stdin);
154                 spin_lock(&f->file_lock);
155                 fdt = files_fdtable(f);
156                 FD_SET(0, fdt->open_fds);
157                 FD_CLR(0, fdt->close_on_exec);
158                 spin_unlock(&f->file_lock);
159
160                 /* and disallow core files too */
161                 current->signal->rlim[RLIMIT_CORE] = (struct rlimit){0, 0};
162         }
163
164         /* We can run anywhere, unlike our parent keventd(). */
165         set_cpus_allowed(current, CPU_MASK_ALL);
166
167         /*
168          * Our parent is keventd, which runs with elevated scheduling priority.
169          * Avoid propagating that into the userspace child.
170          */
171         set_user_nice(current, 0);
172
173         retval = -EPERM;
174         if (current->fs->root)
175                 retval = kernel_execve(sub_info->path,
176                                 sub_info->argv, sub_info->envp);
177
178         /* Exec failed? */
179         sub_info->retval = retval;
180         do_exit(0);
181 }
182
183 /* Keventd can't block, but this (a child) can. */
184 static int wait_for_helper(void *data)
185 {
186         struct subprocess_info *sub_info = data;
187         pid_t pid;
188         struct k_sigaction sa;
189
190         /* Install a handler: if SIGCLD isn't handled sys_wait4 won't
191          * populate the status, but will return -ECHILD. */
192         sa.sa.sa_handler = SIG_IGN;
193         sa.sa.sa_flags = 0;
194         siginitset(&sa.sa.sa_mask, sigmask(SIGCHLD));
195         do_sigaction(SIGCHLD, &sa, NULL);
196         allow_signal(SIGCHLD);
197
198         pid = kernel_thread(____call_usermodehelper, sub_info, SIGCHLD);
199         if (pid < 0) {
200                 sub_info->retval = pid;
201         } else {
202                 int ret;
203
204                 /*
205                  * Normally it is bogus to call wait4() from in-kernel because
206                  * wait4() wants to write the exit code to a userspace address.
207                  * But wait_for_helper() always runs as keventd, and put_user()
208                  * to a kernel address works OK for kernel threads, due to their
209                  * having an mm_segment_t which spans the entire address space.
210                  *
211                  * Thus the __user pointer cast is valid here.
212                  */
213                 sys_wait4(pid, (int __user *)&ret, 0, NULL);
214
215                 /*
216                  * If ret is 0, either ____call_usermodehelper failed and the
217                  * real error code is already in sub_info->retval or
218                  * sub_info->retval is 0 anyway, so don't mess with it then.
219                  */
220                 if (ret)
221                         sub_info->retval = ret;
222         }
223
224         if (sub_info->wait < 0)
225                 kfree(sub_info);
226         else
227                 complete(sub_info->complete);
228         return 0;
229 }
230
231 /* This is run by khelper thread  */
232 static void __call_usermodehelper(struct work_struct *work)
233 {
234         struct subprocess_info *sub_info =
235                 container_of(work, struct subprocess_info, work);
236         pid_t pid;
237         int wait = sub_info->wait;
238
239         /* CLONE_VFORK: wait until the usermode helper has execve'd
240          * successfully We need the data structures to stay around
241          * until that is done.  */
242         if (wait)
243                 pid = kernel_thread(wait_for_helper, sub_info,
244                                     CLONE_FS | CLONE_FILES | SIGCHLD);
245         else
246                 pid = kernel_thread(____call_usermodehelper, sub_info,
247                                     CLONE_VFORK | SIGCHLD);
248
249         if (wait < 0)
250                 return;
251
252         if (pid < 0) {
253                 sub_info->retval = pid;
254                 complete(sub_info->complete);
255         } else if (!wait)
256                 complete(sub_info->complete);
257 }
258
259 /**
260  * call_usermodehelper_keys - start a usermode application
261  * @path: pathname for the application
262  * @argv: null-terminated argument list
263  * @envp: null-terminated environment list
264  * @session_keyring: session keyring for process (NULL for an empty keyring)
265  * @wait: wait for the application to finish and return status.
266  *        when -1 don't wait at all, but you get no useful error back when
267  *        the program couldn't be exec'ed. This makes it safe to call
268  *        from interrupt context.
269  *
270  * Runs a user-space application.  The application is started
271  * asynchronously if wait is not set, and runs as a child of keventd.
272  * (ie. it runs with full root capabilities).
273  *
274  * Must be called from process context.  Returns a negative error code
275  * if program was not execed successfully, or 0.
276  */
277 int call_usermodehelper_keys(char *path, char **argv, char **envp,
278                              struct key *session_keyring, int wait)
279 {
280         DECLARE_COMPLETION_ONSTACK(done);
281         struct subprocess_info *sub_info;
282         int retval;
283
284         if (!khelper_wq)
285                 return -EBUSY;
286
287         if (path[0] == '\0')
288                 return 0;
289
290         sub_info = kzalloc(sizeof(struct subprocess_info),  GFP_ATOMIC);
291         if (!sub_info)
292                 return -ENOMEM;
293
294         INIT_WORK(&sub_info->work, __call_usermodehelper);
295         sub_info->complete = &done;
296         sub_info->path = path;
297         sub_info->argv = argv;
298         sub_info->envp = envp;
299         sub_info->ring = session_keyring;
300         sub_info->wait = wait;
301
302         queue_work(khelper_wq, &sub_info->work);
303         if (wait < 0) /* task has freed sub_info */
304                 return 0;
305         wait_for_completion(&done);
306         retval = sub_info->retval;
307         kfree(sub_info);
308         return retval;
309 }
310 EXPORT_SYMBOL(call_usermodehelper_keys);
311
312 int call_usermodehelper_pipe(char *path, char **argv, char **envp,
313                              struct file **filp)
314 {
315         DECLARE_COMPLETION(done);
316         struct subprocess_info sub_info = {
317                 .work           = __WORK_INITIALIZER(sub_info.work,
318                                                      __call_usermodehelper),
319                 .complete       = &done,
320                 .path           = path,
321                 .argv           = argv,
322                 .envp           = envp,
323                 .retval         = 0,
324         };
325         struct file *f;
326
327         if (!khelper_wq)
328                 return -EBUSY;
329
330         if (path[0] == '\0')
331                 return 0;
332
333         f = create_write_pipe();
334         if (IS_ERR(f))
335                 return PTR_ERR(f);
336         *filp = f;
337
338         f = create_read_pipe(f);
339         if (IS_ERR(f)) {
340                 free_write_pipe(*filp);
341                 return PTR_ERR(f);
342         }
343         sub_info.stdin = f;
344
345         queue_work(khelper_wq, &sub_info.work);
346         wait_for_completion(&done);
347         return sub_info.retval;
348 }
349 EXPORT_SYMBOL(call_usermodehelper_pipe);
350
351 void __init usermodehelper_init(void)
352 {
353         khelper_wq = create_singlethread_workqueue("khelper");
354         BUG_ON(!khelper_wq);
355 }