[PATCH] Move pidmap to pspace.h
[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 #define __KERNEL_SYSCALLS__
22
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 <linux/resource.h>
39 #include <asm/uaccess.h>
40
41 extern int max_threads;
42
43 static struct workqueue_struct *khelper_wq;
44
45 #ifdef CONFIG_KMOD
46
47 /*
48         modprobe_path is set via /proc/sys.
49 */
50 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
51
52 /**
53  * request_module - try to load a kernel module
54  * @fmt:     printf style format string for the name of the module
55  * @varargs: arguements as specified in the format string
56  *
57  * Load a module using the user mode module loader. The function returns
58  * zero on success or a negative errno code on failure. Note that a
59  * successful module load does not mean the module did not then unload
60  * and exit on an error of its own. Callers must check that the service
61  * they requested is now available not blindly invoke it.
62  *
63  * If module auto-loading support is disabled then this function
64  * becomes a no-operation.
65  */
66 int request_module(const char *fmt, ...)
67 {
68         va_list args;
69         char module_name[MODULE_NAME_LEN];
70         unsigned int max_modprobes;
71         int ret;
72         char *argv[] = { modprobe_path, "-q", "--", module_name, NULL };
73         static char *envp[] = { "HOME=/",
74                                 "TERM=linux",
75                                 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
76                                 NULL };
77         static atomic_t kmod_concurrent = ATOMIC_INIT(0);
78 #define MAX_KMOD_CONCURRENT 50  /* Completely arbitrary value - KAO */
79         static int kmod_loop_msg;
80
81         va_start(args, fmt);
82         ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
83         va_end(args);
84         if (ret >= MODULE_NAME_LEN)
85                 return -ENAMETOOLONG;
86
87         /* If modprobe needs a service that is in a module, we get a recursive
88          * loop.  Limit the number of running kmod threads to max_threads/2 or
89          * MAX_KMOD_CONCURRENT, whichever is the smaller.  A cleaner method
90          * would be to run the parents of this process, counting how many times
91          * kmod was invoked.  That would mean accessing the internals of the
92          * process tables to get the command line, proc_pid_cmdline is static
93          * and it is not worth changing the proc code just to handle this case. 
94          * KAO.
95          *
96          * "trace the ppid" is simple, but will fail if someone's
97          * parent exits.  I think this is as good as it gets. --RR
98          */
99         max_modprobes = min(max_threads/2, MAX_KMOD_CONCURRENT);
100         atomic_inc(&kmod_concurrent);
101         if (atomic_read(&kmod_concurrent) > max_modprobes) {
102                 /* We may be blaming an innocent here, but unlikely */
103                 if (kmod_loop_msg++ < 5)
104                         printk(KERN_ERR
105                                "request_module: runaway loop modprobe %s\n",
106                                module_name);
107                 atomic_dec(&kmod_concurrent);
108                 return -ENOMEM;
109         }
110
111         ret = call_usermodehelper(modprobe_path, argv, envp, 1);
112         atomic_dec(&kmod_concurrent);
113         return ret;
114 }
115 EXPORT_SYMBOL(request_module);
116 #endif /* CONFIG_KMOD */
117
118 struct subprocess_info {
119         struct completion *complete;
120         char *path;
121         char **argv;
122         char **envp;
123         struct key *ring;
124         int wait;
125         int retval;
126         struct file *stdin;
127 };
128
129 /*
130  * This is the task which runs the usermode application
131  */
132 static int ____call_usermodehelper(void *data)
133 {
134         struct subprocess_info *sub_info = data;
135         struct key *new_session, *old_session;
136         int retval;
137
138         /* Unblock all signals and set the session keyring. */
139         new_session = key_get(sub_info->ring);
140         flush_signals(current);
141         spin_lock_irq(&current->sighand->siglock);
142         old_session = __install_session_keyring(current, new_session);
143         flush_signal_handlers(current, 1);
144         sigemptyset(&current->blocked);
145         recalc_sigpending();
146         spin_unlock_irq(&current->sighand->siglock);
147
148         key_put(old_session);
149
150         /* Install input pipe when needed */
151         if (sub_info->stdin) {
152                 struct files_struct *f = current->files;
153                 struct fdtable *fdt;
154                 /* no races because files should be private here */
155                 sys_close(0);
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);
162
163                 /* and disallow core files too */
164                 current->signal->rlim[RLIMIT_CORE] = (struct rlimit){0, 0};
165         }
166
167         /* We can run anywhere, unlike our parent keventd(). */
168         set_cpus_allowed(current, CPU_MASK_ALL);
169
170         retval = -EPERM;
171         if (current->fs->root)
172                 retval = execve(sub_info->path, sub_info->argv, sub_info->envp);
173
174         /* Exec failed? */
175         sub_info->retval = retval;
176         do_exit(0);
177 }
178
179 /* Keventd can't block, but this (a child) can. */
180 static int wait_for_helper(void *data)
181 {
182         struct subprocess_info *sub_info = data;
183         pid_t pid;
184         struct k_sigaction sa;
185
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;
189         sa.sa.sa_flags = 0;
190         siginitset(&sa.sa.sa_mask, sigmask(SIGCHLD));
191         do_sigaction(SIGCHLD, &sa, NULL);
192         allow_signal(SIGCHLD);
193
194         pid = kernel_thread(____call_usermodehelper, sub_info, SIGCHLD);
195         if (pid < 0) {
196                 sub_info->retval = pid;
197         } else {
198                 int ret;
199
200                 /*
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.
206                  *
207                  * Thus the __user pointer cast is valid here.
208                  */
209                 sys_wait4(pid, (int __user *)&ret, 0, NULL);
210
211                 /*
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.
215                  */
216                 if (ret)
217                         sub_info->retval = ret;
218         }
219
220         complete(sub_info->complete);
221         return 0;
222 }
223
224 /* This is run by khelper thread  */
225 static void __call_usermodehelper(void *data)
226 {
227         struct subprocess_info *sub_info = data;
228         pid_t pid;
229         int wait = sub_info->wait;
230
231         /* CLONE_VFORK: wait until the usermode helper has execve'd
232          * successfully We need the data structures to stay around
233          * until that is done.  */
234         if (wait)
235                 pid = kernel_thread(wait_for_helper, sub_info,
236                                     CLONE_FS | CLONE_FILES | SIGCHLD);
237         else
238                 pid = kernel_thread(____call_usermodehelper, sub_info,
239                                     CLONE_VFORK | SIGCHLD);
240
241         if (pid < 0) {
242                 sub_info->retval = pid;
243                 complete(sub_info->complete);
244         } else if (!wait)
245                 complete(sub_info->complete);
246 }
247
248 /**
249  * call_usermodehelper_keys - start a usermode application
250  * @path: pathname for the application
251  * @argv: null-terminated argument list
252  * @envp: null-terminated environment list
253  * @session_keyring: session keyring for process (NULL for an empty keyring)
254  * @wait: wait for the application to finish and return status.
255  *
256  * Runs a user-space application.  The application is started
257  * asynchronously if wait is not set, and runs as a child of keventd.
258  * (ie. it runs with full root capabilities).
259  *
260  * Must be called from process context.  Returns a negative error code
261  * if program was not execed successfully, or 0.
262  */
263 int call_usermodehelper_keys(char *path, char **argv, char **envp,
264                              struct key *session_keyring, int wait)
265 {
266         DECLARE_COMPLETION_ONSTACK(done);
267         struct subprocess_info sub_info = {
268                 .complete       = &done,
269                 .path           = path,
270                 .argv           = argv,
271                 .envp           = envp,
272                 .ring           = session_keyring,
273                 .wait           = wait,
274                 .retval         = 0,
275         };
276         DECLARE_WORK(work, __call_usermodehelper, &sub_info);
277
278         if (!khelper_wq)
279                 return -EBUSY;
280
281         if (path[0] == '\0')
282                 return 0;
283
284         queue_work(khelper_wq, &work);
285         wait_for_completion(&done);
286         return sub_info.retval;
287 }
288 EXPORT_SYMBOL(call_usermodehelper_keys);
289
290 int call_usermodehelper_pipe(char *path, char **argv, char **envp,
291                              struct file **filp)
292 {
293         DECLARE_COMPLETION(done);
294         struct subprocess_info sub_info = {
295                 .complete       = &done,
296                 .path           = path,
297                 .argv           = argv,
298                 .envp           = envp,
299                 .retval         = 0,
300         };
301         struct file *f;
302         DECLARE_WORK(work, __call_usermodehelper, &sub_info);
303
304         if (!khelper_wq)
305                 return -EBUSY;
306
307         if (path[0] == '\0')
308                 return 0;
309
310         f = create_write_pipe();
311         if (!f)
312                 return -ENOMEM;
313         *filp = f;
314
315         f = create_read_pipe(f);
316         if (!f) {
317                 free_write_pipe(*filp);
318                 return -ENOMEM;
319         }
320         sub_info.stdin = f;
321
322         queue_work(khelper_wq, &work);
323         wait_for_completion(&done);
324         return sub_info.retval;
325 }
326 EXPORT_SYMBOL(call_usermodehelper_pipe);
327
328 void __init usermodehelper_init(void)
329 {
330         khelper_wq = create_singlethread_workqueue("khelper");
331         BUG_ON(!khelper_wq);
332 }