SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 <asm/uaccess.h>
  39
  40 extern int max_threads;
  41
  42 static struct workqueue_struct *khelper_wq;
  43
  44 #ifdef CONFIG_KMOD
  45
  46 /*
  47         modprobe_path is set via /proc/sys.
  48 */
  49 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
  50
  51 /**
  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
  55  *
  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.
  61  *
  62  * If module auto-loading support is disabled then this function
  63  * becomes a no-operation.
  64  */
  65 int request_module(const char *fmt, ...)
  66 {
  67         va_list args;
  68         char module_name[MODULE_NAME_LEN];
  69         unsigned int max_modprobes;
  70         int ret;
  71         char *argv[] = { modprobe_path, "-q", "--", module_name, NULL };
  72         static char *envp[] = { "HOME=/",
  73                                 "TERM=linux",
  74                                 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
  75                                 NULL };
  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;
  79
  80         va_start(args, fmt);
  81         ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
  82         va_end(args);
  83         if (ret >= MODULE_NAME_LEN)
  84                 return -ENAMETOOLONG;
  85
  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.
  93          * KAO.
  94          *
  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
  97          */
  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)
 103                         printk(KERN_ERR
 104                                "request_module: runaway loop modprobe %s\n",
 105                                module_name);
 106                 atomic_dec(&kmod_concurrent);
 107                 return -ENOMEM;
 108         }
 109
 110         ret = call_usermodehelper(modprobe_path, argv, envp, 1);
 111         atomic_dec(&kmod_concurrent);
 112         return ret;
 113 }
 114 EXPORT_SYMBOL(request_module);
 115 #endif /* CONFIG_KMOD */
 116
 117 struct subprocess_info {
 118         struct completion *complete;
 119         char *path;
 120         char **argv;
 121         char **envp;
 122         struct key *ring;
 123         int wait;
 124         int retval;
 125         struct file *stdin;
 126 };
 127
 128 /*
 129  * This is the task which runs the usermode application
 130  */
 131 static int ____call_usermodehelper(void *data)
 132 {
 133         struct subprocess_info *sub_info = data;
 134         struct key *new_session, *old_session;
 135         int retval;
 136
 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(&current->sighand->siglock);
 141         old_session = __install_session_keyring(current, new_session);
 142         flush_signal_handlers(current, 1);
 143         sigemptyset(&current->blocked);
 144         recalc_sigpending();
 145         spin_unlock_irq(&current->sighand->siglock);
 146
 147         key_put(old_session);
 148
 149         /* Install input pipe when needed */
 150         if (sub_info->stdin) {
 151                 struct files_struct *f = current->files;
 152                 struct fdtable *fdt;
 153                 /* no races because files should be private here */
 154                 sys_close(0);
 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);
 161         }
 162
 163         /* We can run anywhere, unlike our parent keventd(). */
 164         set_cpus_allowed(current, CPU_MASK_ALL);
 165
 166         retval = -EPERM;
 167         if (current->fs->root)
 168                 retval = execve(sub_info->path, sub_info->argv, sub_info->envp);
 169
 170         /* Exec failed? */
 171         sub_info->retval = retval;
 172         do_exit(0);
 173 }
 174
 175 /* Keventd can't block, but this (a child) can. */
 176 static int wait_for_helper(void *data)
 177 {
 178         struct subprocess_info *sub_info = data;
 179         pid_t pid;
 180         struct k_sigaction sa;
 181
 182         /* Install a handler: if SIGCLD isn't handled sys_wait4 won't
 183          * populate the status, but will return -ECHILD. */
 184         sa.sa.sa_handler = SIG_IGN;
 185         sa.sa.sa_flags = 0;
 186         siginitset(&sa.sa.sa_mask, sigmask(SIGCHLD));
 187         do_sigaction(SIGCHLD, &sa, NULL);
 188         allow_signal(SIGCHLD);
 189
 190         pid = kernel_thread(____call_usermodehelper, sub_info, SIGCHLD);
 191         if (pid < 0) {
 192                 sub_info->retval = pid;
 193         } else {
 194                 int ret;
 195
 196                 /*
 197                  * Normally it is bogus to call wait4() from in-kernel because
 198                  * wait4() wants to write the exit code to a userspace address.
 199                  * But wait_for_helper() always runs as keventd, and put_user()
 200                  * to a kernel address works OK for kernel threads, due to their
 201                  * having an mm_segment_t which spans the entire address space.
 202                  *
 203                  * Thus the __user pointer cast is valid here.
 204                  */
 205                 sys_wait4(pid, (int __user *)&ret, 0, NULL);
 206
 207                 /*
 208                  * If ret is 0, either ____call_usermodehelper failed and the
 209                  * real error code is already in sub_info->retval or
 210                  * sub_info->retval is 0 anyway, so don't mess with it then.
 211                  */
 212                 if (ret)
 213                         sub_info->retval = ret;
 214         }
 215
 216         complete(sub_info->complete);
 217         return 0;
 218 }
 219
 220 /* This is run by khelper thread  */
 221 static void __call_usermodehelper(void *data)
 222 {
 223         struct subprocess_info *sub_info = data;
 224         pid_t pid;
 225         int wait = sub_info->wait;
 226
 227         /* CLONE_VFORK: wait until the usermode helper has execve'd
 228          * successfully We need the data structures to stay around
 229          * until that is done.  */
 230         if (wait)
 231                 pid = kernel_thread(wait_for_helper, sub_info,
 232                                     CLONE_FS | CLONE_FILES | SIGCHLD);
 233         else
 234                 pid = kernel_thread(____call_usermodehelper, sub_info,
 235                                     CLONE_VFORK | SIGCHLD);
 236
 237         if (pid < 0) {
 238                 sub_info->retval = pid;
 239                 complete(sub_info->complete);
 240         } else if (!wait)
 241                 complete(sub_info->complete);
 242 }
 243
 244 /**
 245  * call_usermodehelper_keys - start a usermode application
 246  * @path: pathname for the application
 247  * @argv: null-terminated argument list
 248  * @envp: null-terminated environment list
 249  * @session_keyring: session keyring for process (NULL for an empty keyring)
 250  * @wait: wait for the application to finish and return status.
 251  *
 252  * Runs a user-space application.  The application is started
 253  * asynchronously if wait is not set, and runs as a child of keventd.
 254  * (ie. it runs with full root capabilities).
 255  *
 256  * Must be called from process context.  Returns a negative error code
 257  * if program was not execed successfully, or 0.
 258  */
 259 int call_usermodehelper_keys(char *path, char **argv, char **envp,
 260                              struct key *session_keyring, int wait)
 261 {
 262         DECLARE_COMPLETION_ONSTACK(done);
 263         struct subprocess_info sub_info = {
 264                 .complete       = &done,
 265                 .path           = path,
 266                 .argv           = argv,
 267                 .envp           = envp,
 268                 .ring           = session_keyring,
 269                 .wait           = wait,
 270                 .retval         = 0,
 271         };
 272         DECLARE_WORK(work, __call_usermodehelper, &sub_info);
 273
 274         if (!khelper_wq)
 275                 return -EBUSY;
 276
 277         if (path[0] == '\0')
 278                 return 0;
 279
 280         queue_work(khelper_wq, &work);
 281         wait_for_completion(&done);
 282         return sub_info.retval;
 283 }
 284 EXPORT_SYMBOL(call_usermodehelper_keys);
 285
 286 int call_usermodehelper_pipe(char *path, char **argv, char **envp,
 287                              struct file **filp)
 288 {
 289         DECLARE_COMPLETION(done);
 290         struct subprocess_info sub_info = {
 291                 .complete       = &done,
 292                 .path           = path,
 293                 .argv           = argv,
 294                 .envp           = envp,
 295                 .retval         = 0,
 296         };
 297         struct file *f;
 298         DECLARE_WORK(work, __call_usermodehelper, &sub_info);
 299
 300         if (!khelper_wq)
 301                 return -EBUSY;
 302
 303         if (path[0] == '\0')
 304                 return 0;
 305
 306         f = create_write_pipe();
 307         if (!f)
 308                 return -ENOMEM;
 309         *filp = f;
 310
 311         f = create_read_pipe(f);
 312         if (!f) {
 313                 free_write_pipe(*filp);
 314                 return -ENOMEM;
 315         }
 316         sub_info.stdin = f;
 317
 318         queue_work(khelper_wq, &work);
 319         wait_for_completion(&done);
 320         return sub_info.retval;
 321 }
 322 EXPORT_SYMBOL(call_usermodehelper_pipe);
 323
 324 void __init usermodehelper_init(void)
 325 {
 326         khelper_wq = create_singlethread_workqueue("khelper");
 327         BUG_ON(!khelper_wq);
 328 }