kernel/kmod.c

   1 /*
   2  * kmod - the kernel module loader
   3  */
   4 #include <linux/module.h>
   5 #include <linux/sched.h>
   6 #include <linux/sched/task.h>
   7 #include <linux/binfmts.h>
   8 #include <linux/syscalls.h>
   9 #include <linux/unistd.h>
  10 #include <linux/kmod.h>
  11 #include <linux/slab.h>
  12 #include <linux/completion.h>
  13 #include <linux/cred.h>
  14 #include <linux/file.h>
  15 #include <linux/fdtable.h>
  16 #include <linux/workqueue.h>
  17 #include <linux/security.h>
  18 #include <linux/mount.h>
  19 #include <linux/kernel.h>
  20 #include <linux/init.h>
  21 #include <linux/resource.h>
  22 #include <linux/notifier.h>
  23 #include <linux/suspend.h>
  24 #include <linux/rwsem.h>
  25 #include <linux/ptrace.h>
  26 #include <linux/async.h>
  27 #include <linux/uaccess.h>
  28
  29 #include <trace/events/module.h>
  30
  31 #ifdef CONFIG_MODULES
  32 /*
  33  * Assuming:
  34  *
  35  * threads = div64_u64((u64) totalram_pages * (u64) PAGE_SIZE,
  36  *                     (u64) THREAD_SIZE * 8UL);
  37  *
  38  * If you need less than 50 threads would mean we're dealing with systems
  39  * smaller than 3200 pages. This assuems you are capable of having ~13M memory,
  40  * and this would only be an be an upper limit, after which the OOM killer
  41  * would take effect. Systems like these are very unlikely if modules are
  42  * enabled.
  43  */
  44 #define MAX_KMOD_CONCURRENT 50
  45 static atomic_t kmod_concurrent_max = ATOMIC_INIT(MAX_KMOD_CONCURRENT);
  46 static DECLARE_WAIT_QUEUE_HEAD(kmod_wq);
  47
  48 /*
  49  * This is a restriction on having *all* MAX_KMOD_CONCURRENT threads
  50  * running at the same time without returning. When this happens we
  51  * believe you've somehow ended up with a recursive module dependency
  52  * creating a loop.
  53  *
  54  * We have no option but to fail.
  55  *
  56  * Userspace should proactively try to detect and prevent these.
  57  */
  58 #define MAX_KMOD_ALL_BUSY_TIMEOUT 5
  59
  60 /*
  61         modprobe_path is set via /proc/sys.
  62 */
  63 char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";
  64
  65 static void free_modprobe_argv(struct subprocess_info *info)
  66 {
  67         kfree(info->argv[3]); /* check call_modprobe() */
  68         kfree(info->argv);
  69 }
  70
  71 static int call_modprobe(char *module_name, int wait)
  72 {
  73         struct subprocess_info *info;
  74         static char *envp[] = {
  75                 "HOME=/",
  76                 "TERM=linux",
  77                 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
  78                 NULL
  79         };
  80
  81         char **argv = kmalloc(sizeof(char *[5]), GFP_KERNEL);
  82         if (!argv)
  83                 goto out;
  84
  85         module_name = kstrdup(module_name, GFP_KERNEL);
  86         if (!module_name)
  87                 goto free_argv;
  88
  89         argv[0] = modprobe_path;
  90         argv[1] = "-q";
  91         argv[2] = "--";
  92         argv[3] = module_name;  /* check free_modprobe_argv() */
  93         argv[4] = NULL;
  94
  95         info = call_usermodehelper_setup(modprobe_path, argv, envp, GFP_KERNEL,
  96                                          NULL, free_modprobe_argv, NULL);
  97         if (!info)
  98                 goto free_module_name;
  99
 100         return call_usermodehelper_exec(info, wait | UMH_KILLABLE);
 101
 102 free_module_name:
 103         kfree(module_name);
 104 free_argv:
 105         kfree(argv);
 106 out:
 107         return -ENOMEM;
 108 }
 109
 110 /**
 111  * __request_module - try to load a kernel module
 112  * @wait: wait (or not) for the operation to complete
 113  * @fmt: printf style format string for the name of the module
 114  * @...: arguments as specified in the format string
 115  *
 116  * Load a module using the user mode module loader. The function returns
 117  * zero on success or a negative errno code or positive exit code from
 118  * "modprobe" on failure. Note that a successful module load does not mean
 119  * the module did not then unload and exit on an error of its own. Callers
 120  * must check that the service they requested is now available not blindly
 121  * invoke it.
 122  *
 123  * If module auto-loading support is disabled then this function
 124  * becomes a no-operation.
 125  */
 126 int __request_module(bool wait, const char *fmt, ...)
 127 {
 128         va_list args;
 129         char module_name[MODULE_NAME_LEN];
 130         int ret;
 131
 132         /*
 133          * We don't allow synchronous module loading from async.  Module
 134          * init may invoke async_synchronize_full() which will end up
 135          * waiting for this task which already is waiting for the module
 136          * loading to complete, leading to a deadlock.
 137          */
 138         WARN_ON_ONCE(wait && current_is_async());
 139
 140         if (!modprobe_path[0])
 141                 return 0;
 142
 143         va_start(args, fmt);
 144         ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
 145         va_end(args);
 146         if (ret >= MODULE_NAME_LEN)
 147                 return -ENAMETOOLONG;
 148
 149         ret = security_kernel_module_request(module_name);
 150         if (ret)
 151                 return ret;
 152
 153         if (atomic_dec_if_positive(&kmod_concurrent_max) < 0) {
 154                 pr_warn_ratelimited("request_module: kmod_concurrent_max (%u) close to 0 (max_modprobes: %u), for module %s, throttling...",
 155                                     atomic_read(&kmod_concurrent_max),
 156                                     MAX_KMOD_CONCURRENT, module_name);
 157                 ret = wait_event_killable_timeout(kmod_wq,
 158                                                   atomic_dec_if_positive(&kmod_concurrent_max) >= 0,
 159                                                   MAX_KMOD_ALL_BUSY_TIMEOUT * HZ);
 160                 if (!ret) {
 161                         pr_warn_ratelimited("request_module: modprobe %s cannot be processed, kmod busy with %d threads for more than %d seconds now",
 162                                             module_name, MAX_KMOD_CONCURRENT, MAX_KMOD_ALL_BUSY_TIMEOUT);
 163                         return -ETIME;
 164                 } else if (ret == -ERESTARTSYS) {
 165                         pr_warn_ratelimited("request_module: sigkill sent for modprobe %s, giving up", module_name);
 166                         return ret;
 167                 }
 168         }
 169
 170         trace_module_request(module_name, wait, _RET_IP_);
 171
 172         ret = call_modprobe(module_name, wait ? UMH_WAIT_PROC : UMH_WAIT_EXEC);
 173
 174         atomic_inc(&kmod_concurrent_max);
 175         wake_up(&kmod_wq);
 176
 177         return ret;
 178 }
 179 EXPORT_SYMBOL(__request_module);
 180
 181 #endif /* CONFIG_MODULES */