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/smp_lock.h>
27 #include <linux/slab.h>
28 #include <linux/mnt_namespace.h>
29 #include <linux/completion.h>
30 #include <linux/file.h>
31 #include <linux/workqueue.h>
32 #include <linux/security.h>
33 #include <linux/mount.h>
34 #include <linux/kernel.h>
35 #include <linux/init.h>
36 #include <linux/resource.h>
37 #include <asm/uaccess.h>
39 extern int max_threads;
41 static struct workqueue_struct *khelper_wq;
46 modprobe_path is set via /proc/sys.
48 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
51 * request_module - try to load a kernel module
52 * @fmt: printf style format string for the name of the module
53 * @varargs: arguements as specified in the format string
55 * Load a module using the user mode module loader. The function returns
56 * zero on success or a negative errno code on failure. Note that a
57 * successful module load does not mean the module did not then unload
58 * and exit on an error of its own. Callers must check that the service
59 * they requested is now available not blindly invoke it.
61 * If module auto-loading support is disabled then this function
62 * becomes a no-operation.
64 int request_module(const char *fmt, ...)
67 char module_name[MODULE_NAME_LEN];
68 unsigned int max_modprobes;
70 char *argv[] = { modprobe_path, "-q", "--", module_name, NULL };
71 static char *envp[] = { "HOME=/",
73 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
75 static atomic_t kmod_concurrent = ATOMIC_INIT(0);
76 #define MAX_KMOD_CONCURRENT 50 /* Completely arbitrary value - KAO */
77 static int kmod_loop_msg;
80 ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
82 if (ret >= MODULE_NAME_LEN)
85 /* If modprobe needs a service that is in a module, we get a recursive
86 * loop. Limit the number of running kmod threads to max_threads/2 or
87 * MAX_KMOD_CONCURRENT, whichever is the smaller. A cleaner method
88 * would be to run the parents of this process, counting how many times
89 * kmod was invoked. That would mean accessing the internals of the
90 * process tables to get the command line, proc_pid_cmdline is static
91 * and it is not worth changing the proc code just to handle this case.
94 * "trace the ppid" is simple, but will fail if someone's
95 * parent exits. I think this is as good as it gets. --RR
97 max_modprobes = min(max_threads/2, MAX_KMOD_CONCURRENT);
98 atomic_inc(&kmod_concurrent);
99 if (atomic_read(&kmod_concurrent) > max_modprobes) {
100 /* We may be blaming an innocent here, but unlikely */
101 if (kmod_loop_msg++ < 5)
103 "request_module: runaway loop modprobe %s\n",
105 atomic_dec(&kmod_concurrent);
109 ret = call_usermodehelper(modprobe_path, argv, envp, 1);
110 atomic_dec(&kmod_concurrent);
113 EXPORT_SYMBOL(request_module);
114 #endif /* CONFIG_KMOD */
116 struct subprocess_info {
117 struct work_struct work;
118 struct completion *complete;
129 * This is the task which runs the usermode application
131 static int ____call_usermodehelper(void *data)
133 struct subprocess_info *sub_info = data;
134 struct key *new_session, *old_session;
137 /* Unblock all signals and set the session keyring. */
138 new_session = key_get(sub_info->ring);
139 flush_signals(current);
140 spin_lock_irq(¤t->sighand->siglock);
141 old_session = __install_session_keyring(current, new_session);
142 flush_signal_handlers(current, 1);
143 sigemptyset(¤t->blocked);
145 spin_unlock_irq(¤t->sighand->siglock);
147 key_put(old_session);
149 /* Install input pipe when needed */
150 if (sub_info->stdin) {
151 struct files_struct *f = current->files;
153 /* no races because files should be private here */
155 fd_install(0, sub_info->stdin);
156 spin_lock(&f->file_lock);
157 fdt = files_fdtable(f);
158 FD_SET(0, fdt->open_fds);
159 FD_CLR(0, fdt->close_on_exec);
160 spin_unlock(&f->file_lock);
162 /* and disallow core files too */
163 current->signal->rlim[RLIMIT_CORE] = (struct rlimit){0, 0};
166 /* We can run anywhere, unlike our parent keventd(). */
167 set_cpus_allowed(current, CPU_MASK_ALL);
170 if (current->fs->root)
171 retval = kernel_execve(sub_info->path,
172 sub_info->argv, sub_info->envp);
175 sub_info->retval = retval;
179 /* Keventd can't block, but this (a child) can. */
180 static int wait_for_helper(void *data)
182 struct subprocess_info *sub_info = data;
184 struct k_sigaction sa;
186 /* Install a handler: if SIGCLD isn't handled sys_wait4 won't
187 * populate the status, but will return -ECHILD. */
188 sa.sa.sa_handler = SIG_IGN;
190 siginitset(&sa.sa.sa_mask, sigmask(SIGCHLD));
191 do_sigaction(SIGCHLD, &sa, NULL);
192 allow_signal(SIGCHLD);
194 pid = kernel_thread(____call_usermodehelper, sub_info, SIGCHLD);
196 sub_info->retval = pid;
201 * Normally it is bogus to call wait4() from in-kernel because
202 * wait4() wants to write the exit code to a userspace address.
203 * But wait_for_helper() always runs as keventd, and put_user()
204 * to a kernel address works OK for kernel threads, due to their
205 * having an mm_segment_t which spans the entire address space.
207 * Thus the __user pointer cast is valid here.
209 sys_wait4(pid, (int __user *)&ret, 0, NULL);
212 * If ret is 0, either ____call_usermodehelper failed and the
213 * real error code is already in sub_info->retval or
214 * sub_info->retval is 0 anyway, so don't mess with it then.
217 sub_info->retval = ret;
220 if (sub_info->wait < 0)
223 complete(sub_info->complete);
227 /* This is run by khelper thread */
228 static void __call_usermodehelper(struct work_struct *work)
230 struct subprocess_info *sub_info =
231 container_of(work, struct subprocess_info, work);
233 int wait = sub_info->wait;
235 /* CLONE_VFORK: wait until the usermode helper has execve'd
236 * successfully We need the data structures to stay around
237 * until that is done. */
239 pid = kernel_thread(wait_for_helper, sub_info,
240 CLONE_FS | CLONE_FILES | SIGCHLD);
242 pid = kernel_thread(____call_usermodehelper, sub_info,
243 CLONE_VFORK | SIGCHLD);
249 sub_info->retval = pid;
250 complete(sub_info->complete);
252 complete(sub_info->complete);
256 * call_usermodehelper_keys - start a usermode application
257 * @path: pathname for the application
258 * @argv: null-terminated argument list
259 * @envp: null-terminated environment list
260 * @session_keyring: session keyring for process (NULL for an empty keyring)
261 * @wait: wait for the application to finish and return status.
262 * when -1 don't wait at all, but you get no useful error back when
263 * the program couldn't be exec'ed. This makes it safe to call
264 * from interrupt context.
266 * Runs a user-space application. The application is started
267 * asynchronously if wait is not set, and runs as a child of keventd.
268 * (ie. it runs with full root capabilities).
270 * Must be called from process context. Returns a negative error code
271 * if program was not execed successfully, or 0.
273 int call_usermodehelper_keys(char *path, char **argv, char **envp,
274 struct key *session_keyring, int wait)
276 DECLARE_COMPLETION_ONSTACK(done);
277 struct subprocess_info *sub_info;
286 sub_info = kzalloc(sizeof(struct subprocess_info), GFP_ATOMIC);
290 INIT_WORK(&sub_info->work, __call_usermodehelper);
291 sub_info->complete = &done;
292 sub_info->path = path;
293 sub_info->argv = argv;
294 sub_info->envp = envp;
295 sub_info->ring = session_keyring;
296 sub_info->wait = wait;
298 queue_work(khelper_wq, &sub_info->work);
299 if (wait < 0) /* task has freed sub_info */
301 wait_for_completion(&done);
302 retval = sub_info->retval;
306 EXPORT_SYMBOL(call_usermodehelper_keys);
308 int call_usermodehelper_pipe(char *path, char **argv, char **envp,
311 DECLARE_COMPLETION(done);
312 struct subprocess_info sub_info = {
313 .work = __WORK_INITIALIZER(sub_info.work,
314 __call_usermodehelper),
329 f = create_write_pipe();
334 f = create_read_pipe(f);
336 free_write_pipe(*filp);
341 queue_work(khelper_wq, &sub_info.work);
342 wait_for_completion(&done);
343 return sub_info.retval;
345 EXPORT_SYMBOL(call_usermodehelper_pipe);
347 void __init usermodehelper_init(void)
349 khelper_wq = create_singlethread_workqueue("khelper");