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 #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/slab.h>
  27 #include <linux/completion.h>
  28 #include <linux/cred.h>
  29 #include <linux/file.h>
  30 #include <linux/fdtable.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 <linux/notifier.h>
  38 #include <linux/suspend.h>
  39 #include <asm/uaccess.h>
  40
  41 #include <trace/events/module.h>
  42
  43 extern int max_threads;
  44
  45 static struct workqueue_struct *khelper_wq;
  46
  47 #define CAP_BSET        (void *)1
  48 #define CAP_PI          (void *)2
  49
  50 static kernel_cap_t usermodehelper_bset = CAP_FULL_SET;
  51 static kernel_cap_t usermodehelper_inheritable = CAP_FULL_SET;
  52 static DEFINE_SPINLOCK(umh_sysctl_lock);
  53
  54 #ifdef CONFIG_MODULES
  55
  56 /*
  57         modprobe_path is set via /proc/sys.
  58 */
  59 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
  60
  61 /**
  62  * __request_module - try to load a kernel module
  63  * @wait: wait (or not) for the operation to complete
  64  * @fmt: printf style format string for the name of the module
  65  * @...: arguments as specified in the format string
  66  *
  67  * Load a module using the user mode module loader. The function returns
  68  * zero on success or a negative errno code on failure. Note that a
  69  * successful module load does not mean the module did not then unload
  70  * and exit on an error of its own. Callers must check that the service
  71  * they requested is now available not blindly invoke it.
  72  *
  73  * If module auto-loading support is disabled then this function
  74  * becomes a no-operation.
  75  */
  76 int __request_module(bool wait, const char *fmt, ...)
  77 {
  78         va_list args;
  79         char module_name[MODULE_NAME_LEN];
  80         unsigned int max_modprobes;
  81         int ret;
  82         char *argv[] = { modprobe_path, "-q", "--", module_name, NULL };
  83         static char *envp[] = { "HOME=/",
  84                                 "TERM=linux",
  85                                 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
  86                                 NULL };
  87         static atomic_t kmod_concurrent = ATOMIC_INIT(0);
  88 #define MAX_KMOD_CONCURRENT 50  /* Completely arbitrary value - KAO */
  89         static int kmod_loop_msg;
  90
  91         va_start(args, fmt);
  92         ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
  93         va_end(args);
  94         if (ret >= MODULE_NAME_LEN)
  95                 return -ENAMETOOLONG;
  96
  97         ret = security_kernel_module_request(module_name);
  98         if (ret)
  99                 return ret;
 100
 101         /* If modprobe needs a service that is in a module, we get a recursive
 102          * loop.  Limit the number of running kmod threads to max_threads/2 or
 103          * MAX_KMOD_CONCURRENT, whichever is the smaller.  A cleaner method
 104          * would be to run the parents of this process, counting how many times
 105          * kmod was invoked.  That would mean accessing the internals of the
 106          * process tables to get the command line, proc_pid_cmdline is static
 107          * and it is not worth changing the proc code just to handle this case.
 108          * KAO.
 109          *
 110          * "trace the ppid" is simple, but will fail if someone's
 111          * parent exits.  I think this is as good as it gets. --RR
 112          */
 113         max_modprobes = min(max_threads/2, MAX_KMOD_CONCURRENT);
 114         atomic_inc(&kmod_concurrent);
 115         if (atomic_read(&kmod_concurrent) > max_modprobes) {
 116                 /* We may be blaming an innocent here, but unlikely */
 117                 if (kmod_loop_msg++ < 5)
 118                         printk(KERN_ERR
 119                                "request_module: runaway loop modprobe %s\n",
 120                                module_name);
 121                 atomic_dec(&kmod_concurrent);
 122                 return -ENOMEM;
 123         }
 124
 125         trace_module_request(module_name, wait, _RET_IP_);
 126
 127         ret = call_usermodehelper_fns(modprobe_path, argv, envp,
 128                         wait ? UMH_WAIT_PROC : UMH_WAIT_EXEC,
 129                         NULL, NULL, NULL);
 130
 131         atomic_dec(&kmod_concurrent);
 132         return ret;
 133 }
 134 EXPORT_SYMBOL(__request_module);
 135 #endif /* CONFIG_MODULES */
 136
 137 /*
 138  * This is the task which runs the usermode application
 139  */
 140 static int ____call_usermodehelper(void *data)
 141 {
 142         struct subprocess_info *sub_info = data;
 143         struct cred *new;
 144         int retval;
 145
 146         spin_lock_irq(&current->sighand->siglock);
 147         flush_signal_handlers(current, 1);
 148         spin_unlock_irq(&current->sighand->siglock);
 149
 150         /* We can run anywhere, unlike our parent keventd(). */
 151         set_cpus_allowed_ptr(current, cpu_all_mask);
 152
 153         /*
 154          * Our parent is keventd, which runs with elevated scheduling priority.
 155          * Avoid propagating that into the userspace child.
 156          */
 157         set_user_nice(current, 0);
 158
 159         if (sub_info->init) {
 160                 retval = sub_info->init(sub_info);
 161                 if (retval)
 162                         goto fail;
 163         }
 164
 165         retval = -ENOMEM;
 166         new = prepare_kernel_cred(current);
 167         if (!new)
 168                 goto fail;
 169
 170         spin_lock(&umh_sysctl_lock);
 171         new->cap_bset = cap_intersect(usermodehelper_bset, new->cap_bset);
 172         new->cap_inheritable = cap_intersect(usermodehelper_inheritable,
 173                                              new->cap_inheritable);
 174         spin_unlock(&umh_sysctl_lock);
 175
 176         commit_creds(new);
 177
 178         retval = kernel_execve(sub_info->path,
 179                                (const char *const *)sub_info->argv,
 180                                (const char *const *)sub_info->envp);
 181
 182         /* Exec failed? */
 183 fail:
 184         sub_info->retval = retval;
 185         do_exit(0);
 186 }
 187
 188 void call_usermodehelper_freeinfo(struct subprocess_info *info)
 189 {
 190         if (info->cleanup)
 191                 (*info->cleanup)(info);
 192         kfree(info);
 193 }
 194 EXPORT_SYMBOL(call_usermodehelper_freeinfo);
 195
 196 /* Keventd can't block, but this (a child) can. */
 197 static int wait_for_helper(void *data)
 198 {
 199         struct subprocess_info *sub_info = data;
 200         pid_t pid;
 201
 202         /* If SIGCLD is ignored sys_wait4 won't populate the status. */
 203         spin_lock_irq(&current->sighand->siglock);
 204         current->sighand->action[SIGCHLD-1].sa.sa_handler = SIG_DFL;
 205         spin_unlock_irq(&current->sighand->siglock);
 206
 207         pid = kernel_thread(____call_usermodehelper, sub_info, SIGCHLD);
 208         if (pid < 0) {
 209                 sub_info->retval = pid;
 210         } else {
 211                 int ret = -ECHILD;
 212                 /*
 213                  * Normally it is bogus to call wait4() from in-kernel because
 214                  * wait4() wants to write the exit code to a userspace address.
 215                  * But wait_for_helper() always runs as keventd, and put_user()
 216                  * to a kernel address works OK for kernel threads, due to their
 217                  * having an mm_segment_t which spans the entire address space.
 218                  *
 219                  * Thus the __user pointer cast is valid here.
 220                  */
 221                 sys_wait4(pid, (int __user *)&ret, 0, NULL);
 222
 223                 /*
 224                  * If ret is 0, either ____call_usermodehelper failed and the
 225                  * real error code is already in sub_info->retval or
 226                  * sub_info->retval is 0 anyway, so don't mess with it then.
 227                  */
 228                 if (ret)
 229                         sub_info->retval = ret;
 230         }
 231
 232         complete(sub_info->complete);
 233         return 0;
 234 }
 235
 236 /* This is run by khelper thread  */
 237 static void __call_usermodehelper(struct work_struct *work)
 238 {
 239         struct subprocess_info *sub_info =
 240                 container_of(work, struct subprocess_info, work);
 241         enum umh_wait wait = sub_info->wait;
 242         pid_t pid;
 243
 244         /* CLONE_VFORK: wait until the usermode helper has execve'd
 245          * successfully We need the data structures to stay around
 246          * until that is done.  */
 247         if (wait == UMH_WAIT_PROC)
 248                 pid = kernel_thread(wait_for_helper, sub_info,
 249                                     CLONE_FS | CLONE_FILES | SIGCHLD);
 250         else
 251                 pid = kernel_thread(____call_usermodehelper, sub_info,
 252                                     CLONE_VFORK | SIGCHLD);
 253
 254         switch (wait) {
 255         case UMH_NO_WAIT:
 256                 call_usermodehelper_freeinfo(sub_info);
 257                 break;
 258
 259         case UMH_WAIT_PROC:
 260                 if (pid > 0)
 261                         break;
 262                 /* FALLTHROUGH */
 263         case UMH_WAIT_EXEC:
 264                 if (pid < 0)
 265                         sub_info->retval = pid;
 266                 complete(sub_info->complete);
 267         }
 268 }
 269
 270 /*
 271  * If set, call_usermodehelper_exec() will exit immediately returning -EBUSY
 272  * (used for preventing user land processes from being created after the user
 273  * land has been frozen during a system-wide hibernation or suspend operation).
 274  */
 275 static int usermodehelper_disabled;
 276
 277 /* Number of helpers running */
 278 static atomic_t running_helpers = ATOMIC_INIT(0);
 279
 280 /*
 281  * Wait queue head used by usermodehelper_pm_callback() to wait for all running
 282  * helpers to finish.
 283  */
 284 static DECLARE_WAIT_QUEUE_HEAD(running_helpers_waitq);
 285
 286 /*
 287  * Time to wait for running_helpers to become zero before the setting of
 288  * usermodehelper_disabled in usermodehelper_pm_callback() fails
 289  */
 290 #define RUNNING_HELPERS_TIMEOUT (5 * HZ)
 291
 292 /**
 293  * usermodehelper_disable - prevent new helpers from being started
 294  */
 295 int usermodehelper_disable(void)
 296 {
 297         long retval;
 298
 299         usermodehelper_disabled = 1;
 300         smp_mb();
 301         /*
 302          * From now on call_usermodehelper_exec() won't start any new
 303          * helpers, so it is sufficient if running_helpers turns out to
 304          * be zero at one point (it may be increased later, but that
 305          * doesn't matter).
 306          */
 307         retval = wait_event_timeout(running_helpers_waitq,
 308                                         atomic_read(&running_helpers) == 0,
 309                                         RUNNING_HELPERS_TIMEOUT);
 310         if (retval)
 311                 return 0;
 312
 313         usermodehelper_disabled = 0;
 314         return -EAGAIN;
 315 }
 316
 317 /**
 318  * usermodehelper_enable - allow new helpers to be started again
 319  */
 320 void usermodehelper_enable(void)
 321 {
 322         usermodehelper_disabled = 0;
 323 }
 324
 325 /**
 326  * usermodehelper_is_disabled - check if new helpers are allowed to be started
 327  */
 328 bool usermodehelper_is_disabled(void)
 329 {
 330         return usermodehelper_disabled;
 331 }
 332 EXPORT_SYMBOL_GPL(usermodehelper_is_disabled);
 333
 334 static void helper_lock(void)
 335 {
 336         atomic_inc(&running_helpers);
 337         smp_mb__after_atomic_inc();
 338 }
 339
 340 static void helper_unlock(void)
 341 {
 342         if (atomic_dec_and_test(&running_helpers))
 343                 wake_up(&running_helpers_waitq);
 344 }
 345
 346 /**
 347  * call_usermodehelper_setup - prepare to call a usermode helper
 348  * @path: path to usermode executable
 349  * @argv: arg vector for process
 350  * @envp: environment for process
 351  * @gfp_mask: gfp mask for memory allocation
 352  *
 353  * Returns either %NULL on allocation failure, or a subprocess_info
 354  * structure.  This should be passed to call_usermodehelper_exec to
 355  * exec the process and free the structure.
 356  */
 357 struct subprocess_info *call_usermodehelper_setup(char *path, char **argv,
 358                                                   char **envp, gfp_t gfp_mask)
 359 {
 360         struct subprocess_info *sub_info;
 361         sub_info = kzalloc(sizeof(struct subprocess_info), gfp_mask);
 362         if (!sub_info)
 363                 goto out;
 364
 365         INIT_WORK(&sub_info->work, __call_usermodehelper);
 366         sub_info->path = path;
 367         sub_info->argv = argv;
 368         sub_info->envp = envp;
 369   out:
 370         return sub_info;
 371 }
 372 EXPORT_SYMBOL(call_usermodehelper_setup);
 373
 374 /**
 375  * call_usermodehelper_setfns - set a cleanup/init function
 376  * @info: a subprocess_info returned by call_usermodehelper_setup
 377  * @cleanup: a cleanup function
 378  * @init: an init function
 379  * @data: arbitrary context sensitive data
 380  *
 381  * The init function is used to customize the helper process prior to
 382  * exec.  A non-zero return code causes the process to error out, exit,
 383  * and return the failure to the calling process
 384  *
 385  * The cleanup function is just before ethe subprocess_info is about to
 386  * be freed.  This can be used for freeing the argv and envp.  The
 387  * Function must be runnable in either a process context or the
 388  * context in which call_usermodehelper_exec is called.
 389  */
 390 void call_usermodehelper_setfns(struct subprocess_info *info,
 391                     int (*init)(struct subprocess_info *info),
 392                     void (*cleanup)(struct subprocess_info *info),
 393                     void *data)
 394 {
 395         info->cleanup = cleanup;
 396         info->init = init;
 397         info->data = data;
 398 }
 399 EXPORT_SYMBOL(call_usermodehelper_setfns);
 400
 401 /**
 402  * call_usermodehelper_exec - start a usermode application
 403  * @sub_info: information about the subprocessa
 404  * @wait: wait for the application to finish and return status.
 405  *        when -1 don't wait at all, but you get no useful error back when
 406  *        the program couldn't be exec'ed. This makes it safe to call
 407  *        from interrupt context.
 408  *
 409  * Runs a user-space application.  The application is started
 410  * asynchronously if wait is not set, and runs as a child of keventd.
 411  * (ie. it runs with full root capabilities).
 412  */
 413 int call_usermodehelper_exec(struct subprocess_info *sub_info,
 414                              enum umh_wait wait)
 415 {
 416         DECLARE_COMPLETION_ONSTACK(done);
 417         int retval = 0;
 418
 419         helper_lock();
 420         if (sub_info->path[0] == '\0')
 421                 goto out;
 422
 423         if (!khelper_wq || usermodehelper_disabled) {
 424                 retval = -EBUSY;
 425                 goto out;
 426         }
 427
 428         sub_info->complete = &done;
 429         sub_info->wait = wait;
 430
 431         queue_work(khelper_wq, &sub_info->work);
 432         if (wait == UMH_NO_WAIT)        /* task has freed sub_info */
 433                 goto unlock;
 434         wait_for_completion(&done);
 435         retval = sub_info->retval;
 436
 437 out:
 438         call_usermodehelper_freeinfo(sub_info);
 439 unlock:
 440         helper_unlock();
 441         return retval;
 442 }
 443 EXPORT_SYMBOL(call_usermodehelper_exec);
 444
 445 static int proc_cap_handler(struct ctl_table *table, int write,
 446                          void __user *buffer, size_t *lenp, loff_t *ppos)
 447 {
 448         struct ctl_table t;
 449         unsigned long cap_array[_KERNEL_CAPABILITY_U32S];
 450         kernel_cap_t new_cap;
 451         int err, i;
 452
 453         if (write && (!capable(CAP_SETPCAP) ||
 454                       !capable(CAP_SYS_MODULE)))
 455                 return -EPERM;
 456
 457         /*
 458          * convert from the global kernel_cap_t to the ulong array to print to
 459          * userspace if this is a read.
 460          */
 461         spin_lock(&umh_sysctl_lock);
 462         for (i = 0; i < _KERNEL_CAPABILITY_U32S; i++)  {
 463                 if (table->data == CAP_BSET)
 464                         cap_array[i] = usermodehelper_bset.cap[i];
 465                 else if (table->data == CAP_PI)
 466                         cap_array[i] = usermodehelper_inheritable.cap[i];
 467                 else
 468                         BUG();
 469         }
 470         spin_unlock(&umh_sysctl_lock);
 471
 472         t = *table;
 473         t.data = &cap_array;
 474
 475         /*
 476          * actually read or write and array of ulongs from userspace.  Remember
 477          * these are least significant 32 bits first
 478          */
 479         err = proc_doulongvec_minmax(&t, write, buffer, lenp, ppos);
 480         if (err < 0)
 481                 return err;
 482
 483         /*
 484          * convert from the sysctl array of ulongs to the kernel_cap_t
 485          * internal representation
 486          */
 487         for (i = 0; i < _KERNEL_CAPABILITY_U32S; i++)
 488                 new_cap.cap[i] = cap_array[i];
 489
 490         /*
 491          * Drop everything not in the new_cap (but don't add things)
 492          */
 493         spin_lock(&umh_sysctl_lock);
 494         if (write) {
 495                 if (table->data == CAP_BSET)
 496                         usermodehelper_bset = cap_intersect(usermodehelper_bset, new_cap);
 497                 if (table->data == CAP_PI)
 498                         usermodehelper_inheritable = cap_intersect(usermodehelper_inheritable, new_cap);
 499         }
 500         spin_unlock(&umh_sysctl_lock);
 501
 502         return 0;
 503 }
 504
 505 struct ctl_table usermodehelper_table[] = {
 506         {
 507                 .procname       = "bset",
 508                 .data           = CAP_BSET,
 509                 .maxlen         = _KERNEL_CAPABILITY_U32S * sizeof(unsigned long),
 510                 .mode           = 0600,
 511                 .proc_handler   = proc_cap_handler,
 512         },
 513         {
 514                 .procname       = "inheritable",
 515                 .data           = CAP_PI,
 516                 .maxlen         = _KERNEL_CAPABILITY_U32S * sizeof(unsigned long),
 517                 .mode           = 0600,
 518                 .proc_handler   = proc_cap_handler,
 519         },
 520         { }
 521 };
 522
 523 void __init usermodehelper_init(void)
 524 {
 525         khelper_wq = create_singlethread_workqueue("khelper");
 526         BUG_ON(!khelper_wq);
 527 }