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/sched/task.h>
24 #include <linux/binfmts.h>
25 #include <linux/syscalls.h>
26 #include <linux/unistd.h>
27 #include <linux/kmod.h>
28 #include <linux/slab.h>
29 #include <linux/completion.h>
30 #include <linux/cred.h>
31 #include <linux/file.h>
32 #include <linux/fdtable.h>
33 #include <linux/workqueue.h>
34 #include <linux/security.h>
35 #include <linux/mount.h>
36 #include <linux/kernel.h>
37 #include <linux/init.h>
38 #include <linux/resource.h>
39 #include <linux/notifier.h>
40 #include <linux/suspend.h>
41 #include <linux/rwsem.h>
42 #include <linux/ptrace.h>
43 #include <linux/async.h>
44 #include <linux/uaccess.h>
46 #include <trace/events/module.h>
48 extern int max_threads;
50 #define CAP_BSET (void *)1
51 #define CAP_PI (void *)2
53 static kernel_cap_t usermodehelper_bset = CAP_FULL_SET;
54 static kernel_cap_t usermodehelper_inheritable = CAP_FULL_SET;
55 static DEFINE_SPINLOCK(umh_sysctl_lock);
56 static DECLARE_RWSEM(umhelper_sem);
61 modprobe_path is set via /proc/sys.
63 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
65 static void free_modprobe_argv(struct subprocess_info *info)
67 kfree(info->argv[3]); /* check call_modprobe() */
71 static int call_modprobe(char *module_name, int wait)
73 struct subprocess_info *info;
74 static char *envp[] = {
77 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
81 char **argv = kmalloc(sizeof(char *[5]), GFP_KERNEL);
85 module_name = kstrdup(module_name, GFP_KERNEL);
89 argv[0] = modprobe_path;
92 argv[3] = module_name; /* check free_modprobe_argv() */
95 info = call_usermodehelper_setup(modprobe_path, argv, envp, GFP_KERNEL,
96 NULL, free_modprobe_argv, NULL);
98 goto free_module_name;
100 return call_usermodehelper_exec(info, wait | UMH_KILLABLE);
111 * __request_module - try to load a kernel module
112 * @wait: wait (or not) for the operation to complete
113 * @fmt: printf style format string for the name of the module
114 * @...: arguments as specified in the format string
116 * Load a module using the user mode module loader. The function returns
117 * zero on success or a negative errno code or positive exit code from
118 * "modprobe" on failure. Note that a successful module load does not mean
119 * the module did not then unload and exit on an error of its own. Callers
120 * must check that the service they requested is now available not blindly
123 * If module auto-loading support is disabled then this function
124 * becomes a no-operation.
126 int __request_module(bool wait, const char *fmt, ...)
129 char module_name[MODULE_NAME_LEN];
130 unsigned int max_modprobes;
132 static atomic_t kmod_concurrent = ATOMIC_INIT(0);
133 #define MAX_KMOD_CONCURRENT 50 /* Completely arbitrary value - KAO */
134 static int kmod_loop_msg;
137 * We don't allow synchronous module loading from async. Module
138 * init may invoke async_synchronize_full() which will end up
139 * waiting for this task which already is waiting for the module
140 * loading to complete, leading to a deadlock.
142 WARN_ON_ONCE(wait && current_is_async());
144 if (!modprobe_path[0])
148 ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
150 if (ret >= MODULE_NAME_LEN)
151 return -ENAMETOOLONG;
153 ret = security_kernel_module_request(module_name);
157 /* If modprobe needs a service that is in a module, we get a recursive
158 * loop. Limit the number of running kmod threads to max_threads/2 or
159 * MAX_KMOD_CONCURRENT, whichever is the smaller. A cleaner method
160 * would be to run the parents of this process, counting how many times
161 * kmod was invoked. That would mean accessing the internals of the
162 * process tables to get the command line, proc_pid_cmdline is static
163 * and it is not worth changing the proc code just to handle this case.
166 * "trace the ppid" is simple, but will fail if someone's
167 * parent exits. I think this is as good as it gets. --RR
169 max_modprobes = min(max_threads/2, MAX_KMOD_CONCURRENT);
170 atomic_inc(&kmod_concurrent);
171 if (atomic_read(&kmod_concurrent) > max_modprobes) {
172 /* We may be blaming an innocent here, but unlikely */
173 if (kmod_loop_msg < 5) {
175 "request_module: runaway loop modprobe %s\n",
179 atomic_dec(&kmod_concurrent);
183 trace_module_request(module_name, wait, _RET_IP_);
185 ret = call_modprobe(module_name, wait ? UMH_WAIT_PROC : UMH_WAIT_EXEC);
187 atomic_dec(&kmod_concurrent);
190 EXPORT_SYMBOL(__request_module);
191 #endif /* CONFIG_MODULES */
193 static void call_usermodehelper_freeinfo(struct subprocess_info *info)
196 (*info->cleanup)(info);
200 static void umh_complete(struct subprocess_info *sub_info)
202 struct completion *comp = xchg(&sub_info->complete, NULL);
204 * See call_usermodehelper_exec(). If xchg() returns NULL
205 * we own sub_info, the UMH_KILLABLE caller has gone away
206 * or the caller used UMH_NO_WAIT.
211 call_usermodehelper_freeinfo(sub_info);
215 * This is the task which runs the usermode application
217 static int call_usermodehelper_exec_async(void *data)
219 struct subprocess_info *sub_info = data;
223 spin_lock_irq(¤t->sighand->siglock);
224 flush_signal_handlers(current, 1);
225 spin_unlock_irq(¤t->sighand->siglock);
228 * Our parent (unbound workqueue) runs with elevated scheduling
229 * priority. Avoid propagating that into the userspace child.
231 set_user_nice(current, 0);
234 new = prepare_kernel_cred(current);
238 spin_lock(&umh_sysctl_lock);
239 new->cap_bset = cap_intersect(usermodehelper_bset, new->cap_bset);
240 new->cap_inheritable = cap_intersect(usermodehelper_inheritable,
241 new->cap_inheritable);
242 spin_unlock(&umh_sysctl_lock);
244 if (sub_info->init) {
245 retval = sub_info->init(sub_info, new);
254 retval = do_execve(getname_kernel(sub_info->path),
255 (const char __user *const __user *)sub_info->argv,
256 (const char __user *const __user *)sub_info->envp);
258 sub_info->retval = retval;
260 * call_usermodehelper_exec_sync() will call umh_complete
263 if (!(sub_info->wait & UMH_WAIT_PROC))
264 umh_complete(sub_info);
270 /* Handles UMH_WAIT_PROC. */
271 static void call_usermodehelper_exec_sync(struct subprocess_info *sub_info)
275 /* If SIGCLD is ignored sys_wait4 won't populate the status. */
276 kernel_sigaction(SIGCHLD, SIG_DFL);
277 pid = kernel_thread(call_usermodehelper_exec_async, sub_info, SIGCHLD);
279 sub_info->retval = pid;
283 * Normally it is bogus to call wait4() from in-kernel because
284 * wait4() wants to write the exit code to a userspace address.
285 * But call_usermodehelper_exec_sync() always runs as kernel
286 * thread (workqueue) and put_user() to a kernel address works
287 * OK for kernel threads, due to their having an mm_segment_t
288 * which spans the entire address space.
290 * Thus the __user pointer cast is valid here.
292 sys_wait4(pid, (int __user *)&ret, 0, NULL);
295 * If ret is 0, either call_usermodehelper_exec_async failed and
296 * the real error code is already in sub_info->retval or
297 * sub_info->retval is 0 anyway, so don't mess with it then.
300 sub_info->retval = ret;
303 /* Restore default kernel sig handler */
304 kernel_sigaction(SIGCHLD, SIG_IGN);
306 umh_complete(sub_info);
310 * We need to create the usermodehelper kernel thread from a task that is affine
311 * to an optimized set of CPUs (or nohz housekeeping ones) such that they
312 * inherit a widest affinity irrespective of call_usermodehelper() callers with
313 * possibly reduced affinity (eg: per-cpu workqueues). We don't want
314 * usermodehelper targets to contend a busy CPU.
316 * Unbound workqueues provide such wide affinity and allow to block on
317 * UMH_WAIT_PROC requests without blocking pending request (up to some limit).
319 * Besides, workqueues provide the privilege level that caller might not have
320 * to perform the usermodehelper request.
323 static void call_usermodehelper_exec_work(struct work_struct *work)
325 struct subprocess_info *sub_info =
326 container_of(work, struct subprocess_info, work);
328 if (sub_info->wait & UMH_WAIT_PROC) {
329 call_usermodehelper_exec_sync(sub_info);
333 * Use CLONE_PARENT to reparent it to kthreadd; we do not
334 * want to pollute current->children, and we need a parent
335 * that always ignores SIGCHLD to ensure auto-reaping.
337 pid = kernel_thread(call_usermodehelper_exec_async, sub_info,
338 CLONE_PARENT | SIGCHLD);
340 sub_info->retval = pid;
341 umh_complete(sub_info);
347 * If set, call_usermodehelper_exec() will exit immediately returning -EBUSY
348 * (used for preventing user land processes from being created after the user
349 * land has been frozen during a system-wide hibernation or suspend operation).
350 * Should always be manipulated under umhelper_sem acquired for write.
352 static enum umh_disable_depth usermodehelper_disabled = UMH_DISABLED;
354 /* Number of helpers running */
355 static atomic_t running_helpers = ATOMIC_INIT(0);
358 * Wait queue head used by usermodehelper_disable() to wait for all running
361 static DECLARE_WAIT_QUEUE_HEAD(running_helpers_waitq);
364 * Used by usermodehelper_read_lock_wait() to wait for usermodehelper_disabled
367 static DECLARE_WAIT_QUEUE_HEAD(usermodehelper_disabled_waitq);
370 * Time to wait for running_helpers to become zero before the setting of
371 * usermodehelper_disabled in usermodehelper_disable() fails
373 #define RUNNING_HELPERS_TIMEOUT (5 * HZ)
375 int usermodehelper_read_trylock(void)
380 down_read(&umhelper_sem);
382 prepare_to_wait(&usermodehelper_disabled_waitq, &wait,
384 if (!usermodehelper_disabled)
387 if (usermodehelper_disabled == UMH_DISABLED)
390 up_read(&umhelper_sem);
398 down_read(&umhelper_sem);
400 finish_wait(&usermodehelper_disabled_waitq, &wait);
403 EXPORT_SYMBOL_GPL(usermodehelper_read_trylock);
405 long usermodehelper_read_lock_wait(long timeout)
412 down_read(&umhelper_sem);
414 prepare_to_wait(&usermodehelper_disabled_waitq, &wait,
415 TASK_UNINTERRUPTIBLE);
416 if (!usermodehelper_disabled)
419 up_read(&umhelper_sem);
421 timeout = schedule_timeout(timeout);
425 down_read(&umhelper_sem);
427 finish_wait(&usermodehelper_disabled_waitq, &wait);
430 EXPORT_SYMBOL_GPL(usermodehelper_read_lock_wait);
432 void usermodehelper_read_unlock(void)
434 up_read(&umhelper_sem);
436 EXPORT_SYMBOL_GPL(usermodehelper_read_unlock);
439 * __usermodehelper_set_disable_depth - Modify usermodehelper_disabled.
440 * @depth: New value to assign to usermodehelper_disabled.
442 * Change the value of usermodehelper_disabled (under umhelper_sem locked for
443 * writing) and wakeup tasks waiting for it to change.
445 void __usermodehelper_set_disable_depth(enum umh_disable_depth depth)
447 down_write(&umhelper_sem);
448 usermodehelper_disabled = depth;
449 wake_up(&usermodehelper_disabled_waitq);
450 up_write(&umhelper_sem);
454 * __usermodehelper_disable - Prevent new helpers from being started.
455 * @depth: New value to assign to usermodehelper_disabled.
457 * Set usermodehelper_disabled to @depth and wait for running helpers to exit.
459 int __usermodehelper_disable(enum umh_disable_depth depth)
466 down_write(&umhelper_sem);
467 usermodehelper_disabled = depth;
468 up_write(&umhelper_sem);
471 * From now on call_usermodehelper_exec() won't start any new
472 * helpers, so it is sufficient if running_helpers turns out to
473 * be zero at one point (it may be increased later, but that
476 retval = wait_event_timeout(running_helpers_waitq,
477 atomic_read(&running_helpers) == 0,
478 RUNNING_HELPERS_TIMEOUT);
482 __usermodehelper_set_disable_depth(UMH_ENABLED);
486 static void helper_lock(void)
488 atomic_inc(&running_helpers);
489 smp_mb__after_atomic();
492 static void helper_unlock(void)
494 if (atomic_dec_and_test(&running_helpers))
495 wake_up(&running_helpers_waitq);
499 * call_usermodehelper_setup - prepare to call a usermode helper
500 * @path: path to usermode executable
501 * @argv: arg vector for process
502 * @envp: environment for process
503 * @gfp_mask: gfp mask for memory allocation
504 * @cleanup: a cleanup function
505 * @init: an init function
506 * @data: arbitrary context sensitive data
508 * Returns either %NULL on allocation failure, or a subprocess_info
509 * structure. This should be passed to call_usermodehelper_exec to
510 * exec the process and free the structure.
512 * The init function is used to customize the helper process prior to
513 * exec. A non-zero return code causes the process to error out, exit,
514 * and return the failure to the calling process
516 * The cleanup function is just before ethe subprocess_info is about to
517 * be freed. This can be used for freeing the argv and envp. The
518 * Function must be runnable in either a process context or the
519 * context in which call_usermodehelper_exec is called.
521 struct subprocess_info *call_usermodehelper_setup(const char *path, char **argv,
522 char **envp, gfp_t gfp_mask,
523 int (*init)(struct subprocess_info *info, struct cred *new),
524 void (*cleanup)(struct subprocess_info *info),
527 struct subprocess_info *sub_info;
528 sub_info = kzalloc(sizeof(struct subprocess_info), gfp_mask);
532 INIT_WORK(&sub_info->work, call_usermodehelper_exec_work);
534 #ifdef CONFIG_STATIC_USERMODEHELPER
535 sub_info->path = CONFIG_STATIC_USERMODEHELPER_PATH;
537 sub_info->path = path;
539 sub_info->argv = argv;
540 sub_info->envp = envp;
542 sub_info->cleanup = cleanup;
543 sub_info->init = init;
544 sub_info->data = data;
548 EXPORT_SYMBOL(call_usermodehelper_setup);
551 * call_usermodehelper_exec - start a usermode application
552 * @sub_info: information about the subprocessa
553 * @wait: wait for the application to finish and return status.
554 * when UMH_NO_WAIT don't wait at all, but you get no useful error back
555 * when the program couldn't be exec'ed. This makes it safe to call
556 * from interrupt context.
558 * Runs a user-space application. The application is started
559 * asynchronously if wait is not set, and runs as a child of system workqueues.
560 * (ie. it runs with full root capabilities and optimized affinity).
562 int call_usermodehelper_exec(struct subprocess_info *sub_info, int wait)
564 DECLARE_COMPLETION_ONSTACK(done);
567 if (!sub_info->path) {
568 call_usermodehelper_freeinfo(sub_info);
572 if (usermodehelper_disabled) {
578 * If there is no binary for us to call, then just return and get out of
579 * here. This allows us to set STATIC_USERMODEHELPER_PATH to "" and
580 * disable all call_usermodehelper() calls.
582 if (strlen(sub_info->path) == 0)
586 * Set the completion pointer only if there is a waiter.
587 * This makes it possible to use umh_complete to free
588 * the data structure in case of UMH_NO_WAIT.
590 sub_info->complete = (wait == UMH_NO_WAIT) ? NULL : &done;
591 sub_info->wait = wait;
593 queue_work(system_unbound_wq, &sub_info->work);
594 if (wait == UMH_NO_WAIT) /* task has freed sub_info */
597 if (wait & UMH_KILLABLE) {
598 retval = wait_for_completion_killable(&done);
602 /* umh_complete() will see NULL and free sub_info */
603 if (xchg(&sub_info->complete, NULL))
605 /* fallthrough, umh_complete() was already called */
608 wait_for_completion(&done);
610 retval = sub_info->retval;
612 call_usermodehelper_freeinfo(sub_info);
617 EXPORT_SYMBOL(call_usermodehelper_exec);
620 * call_usermodehelper() - prepare and start a usermode application
621 * @path: path to usermode executable
622 * @argv: arg vector for process
623 * @envp: environment for process
624 * @wait: wait for the application to finish and return status.
625 * when UMH_NO_WAIT don't wait at all, but you get no useful error back
626 * when the program couldn't be exec'ed. This makes it safe to call
627 * from interrupt context.
629 * This function is the equivalent to use call_usermodehelper_setup() and
630 * call_usermodehelper_exec().
632 int call_usermodehelper(const char *path, char **argv, char **envp, int wait)
634 struct subprocess_info *info;
635 gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL;
637 info = call_usermodehelper_setup(path, argv, envp, gfp_mask,
642 return call_usermodehelper_exec(info, wait);
644 EXPORT_SYMBOL(call_usermodehelper);
646 static int proc_cap_handler(struct ctl_table *table, int write,
647 void __user *buffer, size_t *lenp, loff_t *ppos)
650 unsigned long cap_array[_KERNEL_CAPABILITY_U32S];
651 kernel_cap_t new_cap;
654 if (write && (!capable(CAP_SETPCAP) ||
655 !capable(CAP_SYS_MODULE)))
659 * convert from the global kernel_cap_t to the ulong array to print to
660 * userspace if this is a read.
662 spin_lock(&umh_sysctl_lock);
663 for (i = 0; i < _KERNEL_CAPABILITY_U32S; i++) {
664 if (table->data == CAP_BSET)
665 cap_array[i] = usermodehelper_bset.cap[i];
666 else if (table->data == CAP_PI)
667 cap_array[i] = usermodehelper_inheritable.cap[i];
671 spin_unlock(&umh_sysctl_lock);
677 * actually read or write and array of ulongs from userspace. Remember
678 * these are least significant 32 bits first
680 err = proc_doulongvec_minmax(&t, write, buffer, lenp, ppos);
685 * convert from the sysctl array of ulongs to the kernel_cap_t
686 * internal representation
688 for (i = 0; i < _KERNEL_CAPABILITY_U32S; i++)
689 new_cap.cap[i] = cap_array[i];
692 * Drop everything not in the new_cap (but don't add things)
694 spin_lock(&umh_sysctl_lock);
696 if (table->data == CAP_BSET)
697 usermodehelper_bset = cap_intersect(usermodehelper_bset, new_cap);
698 if (table->data == CAP_PI)
699 usermodehelper_inheritable = cap_intersect(usermodehelper_inheritable, new_cap);
701 spin_unlock(&umh_sysctl_lock);
706 struct ctl_table usermodehelper_table[] = {
710 .maxlen = _KERNEL_CAPABILITY_U32S * sizeof(unsigned long),
712 .proc_handler = proc_cap_handler,
715 .procname = "inheritable",
717 .maxlen = _KERNEL_CAPABILITY_U32S * sizeof(unsigned long),
719 .proc_handler = proc_cap_handler,