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