2 kmod, the new module loader (replaces kerneld)
5 Reorganized not to be a daemon by Adam Richter, with guidance
8 Modified to avoid chroot and file sharing problems.
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
15 Unblock all signals when we exec a usermode process.
16 Shuu Yamaguchi <shuu@wondernetworkresources.com> December 2000
18 call_usermodehelper wait flag, and remove exec_usermodehelper.
19 Rusty Russell <rusty@rustcorp.com.au> Jan 2003
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/completion.h>
28 #include <linux/file.h>
29 #include <linux/fdtable.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 <linux/notifier.h>
37 #include <linux/suspend.h>
38 #include <asm/uaccess.h>
40 #include <trace/events/module.h>
42 extern int max_threads;
44 static struct workqueue_struct *khelper_wq;
49 modprobe_path is set via /proc/sys.
51 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
54 * __request_module - try to load a kernel module
55 * @wait: wait (or not) for the operation to complete
56 * @fmt: printf style format string for the name of the module
57 * @...: arguments as specified in the format string
59 * Load a module using the user mode module loader. The function returns
60 * zero on success or a negative errno code on failure. Note that a
61 * successful module load does not mean the module did not then unload
62 * and exit on an error of its own. Callers must check that the service
63 * they requested is now available not blindly invoke it.
65 * If module auto-loading support is disabled then this function
66 * becomes a no-operation.
68 int __request_module(bool wait, const char *fmt, ...)
71 char module_name[MODULE_NAME_LEN];
72 unsigned int max_modprobes;
74 char *argv[] = { modprobe_path, "-q", "--", module_name, NULL };
75 static char *envp[] = { "HOME=/",
77 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
79 static atomic_t kmod_concurrent = ATOMIC_INIT(0);
80 #define MAX_KMOD_CONCURRENT 50 /* Completely arbitrary value - KAO */
81 static int kmod_loop_msg;
84 ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
86 if (ret >= MODULE_NAME_LEN)
89 ret = security_kernel_module_request(module_name);
93 /* If modprobe needs a service that is in a module, we get a recursive
94 * loop. Limit the number of running kmod threads to max_threads/2 or
95 * MAX_KMOD_CONCURRENT, whichever is the smaller. A cleaner method
96 * would be to run the parents of this process, counting how many times
97 * kmod was invoked. That would mean accessing the internals of the
98 * process tables to get the command line, proc_pid_cmdline is static
99 * and it is not worth changing the proc code just to handle this case.
102 * "trace the ppid" is simple, but will fail if someone's
103 * parent exits. I think this is as good as it gets. --RR
105 max_modprobes = min(max_threads/2, MAX_KMOD_CONCURRENT);
106 atomic_inc(&kmod_concurrent);
107 if (atomic_read(&kmod_concurrent) > max_modprobes) {
108 /* We may be blaming an innocent here, but unlikely */
109 if (kmod_loop_msg++ < 5)
111 "request_module: runaway loop modprobe %s\n",
113 atomic_dec(&kmod_concurrent);
117 trace_module_request(module_name, wait, _RET_IP_);
119 ret = call_usermodehelper_fns(modprobe_path, argv, envp,
120 wait ? UMH_WAIT_PROC : UMH_WAIT_EXEC,
123 atomic_dec(&kmod_concurrent);
126 EXPORT_SYMBOL(__request_module);
127 #endif /* CONFIG_MODULES */
130 * This is the task which runs the usermode application
132 static int ____call_usermodehelper(void *data)
134 struct subprocess_info *sub_info = data;
137 BUG_ON(atomic_read(&sub_info->cred->usage) != 1);
139 /* Unblock all signals */
140 spin_lock_irq(¤t->sighand->siglock);
141 flush_signal_handlers(current, 1);
142 sigemptyset(¤t->blocked);
144 spin_unlock_irq(¤t->sighand->siglock);
146 /* Install the credentials */
147 commit_creds(sub_info->cred);
148 sub_info->cred = NULL;
150 /* Install input pipe when needed */
151 if (sub_info->stdin) {
152 struct files_struct *f = current->files;
154 /* no races because files should be private here */
156 fd_install(0, sub_info->stdin);
157 spin_lock(&f->file_lock);
158 fdt = files_fdtable(f);
159 FD_SET(0, fdt->open_fds);
160 FD_CLR(0, fdt->close_on_exec);
161 spin_unlock(&f->file_lock);
163 /* and disallow core files too */
164 current->signal->rlim[RLIMIT_CORE] = (struct rlimit){0, 0};
167 /* We can run anywhere, unlike our parent keventd(). */
168 set_cpus_allowed_ptr(current, cpu_all_mask);
171 * Our parent is keventd, which runs with elevated scheduling priority.
172 * Avoid propagating that into the userspace child.
174 set_user_nice(current, 0);
176 if (sub_info->init) {
177 retval = sub_info->init(sub_info);
182 retval = kernel_execve(sub_info->path, sub_info->argv, sub_info->envp);
186 sub_info->retval = retval;
190 void call_usermodehelper_freeinfo(struct subprocess_info *info)
193 (*info->cleanup)(info);
195 put_cred(info->cred);
198 EXPORT_SYMBOL(call_usermodehelper_freeinfo);
200 /* Keventd can't block, but this (a child) can. */
201 static int wait_for_helper(void *data)
203 struct subprocess_info *sub_info = data;
206 /* Install a handler: if SIGCLD isn't handled sys_wait4 won't
207 * populate the status, but will return -ECHILD. */
208 allow_signal(SIGCHLD);
210 pid = kernel_thread(____call_usermodehelper, sub_info, SIGCHLD);
212 sub_info->retval = pid;
217 * Normally it is bogus to call wait4() from in-kernel because
218 * wait4() wants to write the exit code to a userspace address.
219 * But wait_for_helper() always runs as keventd, and put_user()
220 * to a kernel address works OK for kernel threads, due to their
221 * having an mm_segment_t which spans the entire address space.
223 * Thus the __user pointer cast is valid here.
225 sys_wait4(pid, (int __user *)&ret, 0, NULL);
228 * If ret is 0, either ____call_usermodehelper failed and the
229 * real error code is already in sub_info->retval or
230 * sub_info->retval is 0 anyway, so don't mess with it then.
233 sub_info->retval = ret;
236 if (sub_info->wait == UMH_NO_WAIT)
237 call_usermodehelper_freeinfo(sub_info);
239 complete(sub_info->complete);
243 /* This is run by khelper thread */
244 static void __call_usermodehelper(struct work_struct *work)
246 struct subprocess_info *sub_info =
247 container_of(work, struct subprocess_info, work);
249 enum umh_wait wait = sub_info->wait;
251 BUG_ON(atomic_read(&sub_info->cred->usage) != 1);
253 /* CLONE_VFORK: wait until the usermode helper has execve'd
254 * successfully We need the data structures to stay around
255 * until that is done. */
256 if (wait == UMH_WAIT_PROC || wait == UMH_NO_WAIT)
257 pid = kernel_thread(wait_for_helper, sub_info,
258 CLONE_FS | CLONE_FILES | SIGCHLD);
260 pid = kernel_thread(____call_usermodehelper, sub_info,
261 CLONE_VFORK | SIGCHLD);
270 sub_info->retval = pid;
274 complete(sub_info->complete);
278 #ifdef CONFIG_PM_SLEEP
280 * If set, call_usermodehelper_exec() will exit immediately returning -EBUSY
281 * (used for preventing user land processes from being created after the user
282 * land has been frozen during a system-wide hibernation or suspend operation).
284 static int usermodehelper_disabled;
286 /* Number of helpers running */
287 static atomic_t running_helpers = ATOMIC_INIT(0);
290 * Wait queue head used by usermodehelper_pm_callback() to wait for all running
293 static DECLARE_WAIT_QUEUE_HEAD(running_helpers_waitq);
296 * Time to wait for running_helpers to become zero before the setting of
297 * usermodehelper_disabled in usermodehelper_pm_callback() fails
299 #define RUNNING_HELPERS_TIMEOUT (5 * HZ)
302 * usermodehelper_disable - prevent new helpers from being started
304 int usermodehelper_disable(void)
308 usermodehelper_disabled = 1;
311 * From now on call_usermodehelper_exec() won't start any new
312 * helpers, so it is sufficient if running_helpers turns out to
313 * be zero at one point (it may be increased later, but that
316 retval = wait_event_timeout(running_helpers_waitq,
317 atomic_read(&running_helpers) == 0,
318 RUNNING_HELPERS_TIMEOUT);
322 usermodehelper_disabled = 0;
327 * usermodehelper_enable - allow new helpers to be started again
329 void usermodehelper_enable(void)
331 usermodehelper_disabled = 0;
334 static void helper_lock(void)
336 atomic_inc(&running_helpers);
337 smp_mb__after_atomic_inc();
340 static void helper_unlock(void)
342 if (atomic_dec_and_test(&running_helpers))
343 wake_up(&running_helpers_waitq);
345 #else /* CONFIG_PM_SLEEP */
346 #define usermodehelper_disabled 0
348 static inline void helper_lock(void) {}
349 static inline void helper_unlock(void) {}
350 #endif /* CONFIG_PM_SLEEP */
353 * call_usermodehelper_setup - prepare to call a usermode helper
354 * @path: path to usermode executable
355 * @argv: arg vector for process
356 * @envp: environment for process
357 * @gfp_mask: gfp mask for memory allocation
359 * Returns either %NULL on allocation failure, or a subprocess_info
360 * structure. This should be passed to call_usermodehelper_exec to
361 * exec the process and free the structure.
363 struct subprocess_info *call_usermodehelper_setup(char *path, char **argv,
364 char **envp, gfp_t gfp_mask)
366 struct subprocess_info *sub_info;
367 sub_info = kzalloc(sizeof(struct subprocess_info), gfp_mask);
371 INIT_WORK(&sub_info->work, __call_usermodehelper);
372 sub_info->path = path;
373 sub_info->argv = argv;
374 sub_info->envp = envp;
375 sub_info->cred = prepare_usermodehelper_creds();
376 if (!sub_info->cred) {
384 EXPORT_SYMBOL(call_usermodehelper_setup);
387 * call_usermodehelper_setkeys - set the session keys for usermode helper
388 * @info: a subprocess_info returned by call_usermodehelper_setup
389 * @session_keyring: the session keyring for the process
391 void call_usermodehelper_setkeys(struct subprocess_info *info,
392 struct key *session_keyring)
395 struct thread_group_cred *tgcred = info->cred->tgcred;
396 key_put(tgcred->session_keyring);
397 tgcred->session_keyring = key_get(session_keyring);
402 EXPORT_SYMBOL(call_usermodehelper_setkeys);
405 * call_usermodehelper_setfns - set a cleanup/init function
406 * @info: a subprocess_info returned by call_usermodehelper_setup
407 * @cleanup: a cleanup function
408 * @init: an init function
409 * @data: arbitrary context sensitive data
411 * The init function is used to customize the helper process prior to
412 * exec. A non-zero return code causes the process to error out, exit,
413 * and return the failure to the calling process
415 * The cleanup function is just before ethe subprocess_info is about to
416 * be freed. This can be used for freeing the argv and envp. The
417 * Function must be runnable in either a process context or the
418 * context in which call_usermodehelper_exec is called.
420 void call_usermodehelper_setfns(struct subprocess_info *info,
421 int (*init)(struct subprocess_info *info),
422 void (*cleanup)(struct subprocess_info *info),
425 info->cleanup = cleanup;
429 EXPORT_SYMBOL(call_usermodehelper_setfns);
432 * call_usermodehelper_stdinpipe - set up a pipe to be used for stdin
433 * @sub_info: a subprocess_info returned by call_usermodehelper_setup
434 * @filp: set to the write-end of a pipe
436 * This constructs a pipe, and sets the read end to be the stdin of the
437 * subprocess, and returns the write-end in *@filp.
439 int call_usermodehelper_stdinpipe(struct subprocess_info *sub_info,
444 f = create_write_pipe(0);
449 f = create_read_pipe(f, 0);
451 free_write_pipe(*filp);
458 EXPORT_SYMBOL(call_usermodehelper_stdinpipe);
461 * call_usermodehelper_exec - start a usermode application
462 * @sub_info: information about the subprocessa
463 * @wait: wait for the application to finish and return status.
464 * when -1 don't wait at all, but you get no useful error back when
465 * the program couldn't be exec'ed. This makes it safe to call
466 * from interrupt context.
468 * Runs a user-space application. The application is started
469 * asynchronously if wait is not set, and runs as a child of keventd.
470 * (ie. it runs with full root capabilities).
472 int call_usermodehelper_exec(struct subprocess_info *sub_info,
475 DECLARE_COMPLETION_ONSTACK(done);
478 BUG_ON(atomic_read(&sub_info->cred->usage) != 1);
479 validate_creds(sub_info->cred);
482 if (sub_info->path[0] == '\0')
485 if (!khelper_wq || usermodehelper_disabled) {
490 sub_info->complete = &done;
491 sub_info->wait = wait;
493 queue_work(khelper_wq, &sub_info->work);
494 if (wait == UMH_NO_WAIT) /* task has freed sub_info */
496 wait_for_completion(&done);
497 retval = sub_info->retval;
500 call_usermodehelper_freeinfo(sub_info);
505 EXPORT_SYMBOL(call_usermodehelper_exec);
508 * call_usermodehelper_pipe - call a usermode helper process with a pipe stdin
509 * @path: path to usermode executable
510 * @argv: arg vector for process
511 * @envp: environment for process
512 * @filp: set to the write-end of a pipe
514 * This is a simple wrapper which executes a usermode-helper function
515 * with a pipe as stdin. It is implemented entirely in terms of
516 * lower-level call_usermodehelper_* functions.
518 int call_usermodehelper_pipe(char *path, char **argv, char **envp,
521 struct subprocess_info *sub_info;
524 sub_info = call_usermodehelper_setup(path, argv, envp,
526 if (sub_info == NULL)
529 ret = call_usermodehelper_stdinpipe(sub_info, filp);
531 call_usermodehelper_freeinfo(sub_info);
535 ret = call_usermodehelper_exec(sub_info, UMH_WAIT_EXEC);
536 if (ret < 0) /* Failed to execute helper, close pipe */
537 filp_close(*filp, NULL);
541 EXPORT_SYMBOL(call_usermodehelper_pipe);
543 void __init usermodehelper_init(void)
545 khelper_wq = create_singlethread_workqueue("khelper");