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 #define __KERNEL_SYSCALLS__
23 #include <linux/module.h>
24 #include <linux/sched.h>
25 #include <linux/syscalls.h>
26 #include <linux/unistd.h>
27 #include <linux/kmod.h>
28 #include <linux/smp_lock.h>
29 #include <linux/slab.h>
30 #include <linux/namespace.h>
31 #include <linux/completion.h>
32 #include <linux/file.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 <asm/uaccess.h>
40 extern int max_threads;
42 static struct workqueue_struct *khelper_wq;
47 modprobe_path is set via /proc/sys.
49 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
52 * request_module - try to load a kernel module
53 * @fmt: printf style format string for the name of the module
54 * @varargs: arguements as specified in the format string
56 * Load a module using the user mode module loader. The function returns
57 * zero on success or a negative errno code on failure. Note that a
58 * successful module load does not mean the module did not then unload
59 * and exit on an error of its own. Callers must check that the service
60 * they requested is now available not blindly invoke it.
62 * If module auto-loading support is disabled then this function
63 * becomes a no-operation.
65 int request_module(const char *fmt, ...)
68 char module_name[MODULE_NAME_LEN];
69 unsigned int max_modprobes;
71 char *argv[] = { modprobe_path, "-q", "--", module_name, NULL };
72 static char *envp[] = { "HOME=/",
74 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
76 static atomic_t kmod_concurrent = ATOMIC_INIT(0);
77 #define MAX_KMOD_CONCURRENT 50 /* Completely arbitrary value - KAO */
78 static int kmod_loop_msg;
81 ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
83 if (ret >= MODULE_NAME_LEN)
86 /* If modprobe needs a service that is in a module, we get a recursive
87 * loop. Limit the number of running kmod threads to max_threads/2 or
88 * MAX_KMOD_CONCURRENT, whichever is the smaller. A cleaner method
89 * would be to run the parents of this process, counting how many times
90 * kmod was invoked. That would mean accessing the internals of the
91 * process tables to get the command line, proc_pid_cmdline is static
92 * and it is not worth changing the proc code just to handle this case.
95 * "trace the ppid" is simple, but will fail if someone's
96 * parent exits. I think this is as good as it gets. --RR
98 max_modprobes = min(max_threads/2, MAX_KMOD_CONCURRENT);
99 atomic_inc(&kmod_concurrent);
100 if (atomic_read(&kmod_concurrent) > max_modprobes) {
101 /* We may be blaming an innocent here, but unlikely */
102 if (kmod_loop_msg++ < 5)
104 "request_module: runaway loop modprobe %s\n",
106 atomic_dec(&kmod_concurrent);
110 ret = call_usermodehelper(modprobe_path, argv, envp, 1);
111 atomic_dec(&kmod_concurrent);
114 EXPORT_SYMBOL(request_module);
115 #endif /* CONFIG_KMOD */
117 struct subprocess_info {
118 struct completion *complete;
128 * This is the task which runs the usermode application
131 __exec_usermodehelper(char *path, char **argv, char **envp, struct key *ring)
133 struct key *new_session, *old_session;
136 /* Unblock all signals and set the session keyring. */
137 new_session = key_get(ring);
138 flush_signals(current);
139 spin_lock_irq(¤t->sighand->siglock);
140 old_session = __install_session_keyring(current, new_session);
141 flush_signal_handlers(current, 1);
142 sigemptyset(¤t->blocked);
144 spin_unlock_irq(¤t->sighand->siglock);
146 key_put(old_session);
149 if (current->fs->root)
150 retval = execve(path, argv, envp);
155 EXPORT_SYMBOL_GPL(__exec_usermodehelper);
158 * This is the task which runs the usermode application
160 static int ____call_usermodehelper(void *data)
162 struct subprocess_info *sub_info = data;
165 /* We can run anywhere, unlike our parent keventd(). */
166 set_cpus_allowed(current, CPU_MASK_ALL);
168 retval = __exec_usermodehelper(sub_info->path,
169 sub_info->argv, sub_info->envp, sub_info->ring);
172 sub_info->retval = retval;
176 /* Keventd can't block, but this (a child) can. */
177 static int wait_for_helper(void *data)
179 struct subprocess_info *sub_info = data;
181 struct k_sigaction sa;
183 /* Install a handler: if SIGCLD isn't handled sys_wait4 won't
184 * populate the status, but will return -ECHILD. */
185 sa.sa.sa_handler = SIG_IGN;
187 siginitset(&sa.sa.sa_mask, sigmask(SIGCHLD));
188 do_sigaction(SIGCHLD, &sa, NULL);
189 allow_signal(SIGCHLD);
191 pid = kernel_thread(____call_usermodehelper, sub_info, SIGCHLD);
193 sub_info->retval = pid;
196 * Normally it is bogus to call wait4() from in-kernel because
197 * wait4() wants to write the exit code to a userspace address.
198 * But wait_for_helper() always runs as keventd, and put_user()
199 * to a kernel address works OK for kernel threads, due to their
200 * having an mm_segment_t which spans the entire address space.
202 * Thus the __user pointer cast is valid here.
204 sys_wait4(pid, (int __user *) &sub_info->retval, 0, NULL);
207 complete(sub_info->complete);
211 /* This is run by khelper thread */
212 static void __call_usermodehelper(void *data)
214 struct subprocess_info *sub_info = data;
216 int wait = sub_info->wait;
218 /* CLONE_VFORK: wait until the usermode helper has execve'd
219 * successfully We need the data structures to stay around
220 * until that is done. */
222 pid = kernel_thread(wait_for_helper, sub_info,
223 CLONE_FS | CLONE_FILES | SIGCHLD);
225 pid = kernel_thread(____call_usermodehelper, sub_info,
226 CLONE_VFORK | SIGCHLD);
229 sub_info->retval = pid;
230 complete(sub_info->complete);
232 complete(sub_info->complete);
236 * call_usermodehelper_keys - start a usermode application
237 * @path: pathname for the application
238 * @argv: null-terminated argument list
239 * @envp: null-terminated environment list
240 * @session_keyring: session keyring for process (NULL for an empty keyring)
241 * @wait: wait for the application to finish and return status.
243 * Runs a user-space application. The application is started
244 * asynchronously if wait is not set, and runs as a child of keventd.
245 * (ie. it runs with full root capabilities).
247 * Must be called from process context. Returns a negative error code
248 * if program was not execed successfully, or 0.
250 int call_usermodehelper_keys(char *path, char **argv, char **envp,
251 struct key *session_keyring, int wait)
253 DECLARE_COMPLETION_ONSTACK(done);
254 struct subprocess_info sub_info = {
259 .ring = session_keyring,
263 DECLARE_WORK(work, __call_usermodehelper, &sub_info);
271 queue_work(khelper_wq, &work);
272 wait_for_completion(&done);
273 return sub_info.retval;
275 EXPORT_SYMBOL(call_usermodehelper_keys);
277 void __init usermodehelper_init(void)
279 khelper_wq = create_singlethread_workqueue("khelper");