modutils/modprobe.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Modprobe written from scratch for BusyBox
   4  *
   5  * Copyright (c) 2008 Timo Teras <timo.teras@iki.fi>
   6  * Copyright (c) 2008 Vladimir Dronnikov
   7  *
   8  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
   9  */
  10
  11 /* Note that unlike older versions of modules.dep/depmod (busybox and m-i-t),
  12  * we expect the full dependency list to be specified in modules.dep.
  13  * Older versions would only export the direct dependency list.
  14  */
  15 #include "libbb.h"
  16 #include "modutils.h"
  17 #include <sys/utsname.h>
  18 #include <fnmatch.h>
  19
  20 //#define DBG(fmt, ...) bb_error_msg("%s: " fmt, __func__, ## __VA_ARGS__)
  21 #define DBG(...) ((void)0)
  22
  23 #define MODULE_FLAG_LOADED              0x0001
  24 #define MODULE_FLAG_NEED_DEPS           0x0002
  25 /* "was seen in modules.dep": */
  26 #define MODULE_FLAG_FOUND_IN_MODDEP     0x0004
  27 #define MODULE_FLAG_BLACKLISTED         0x0008
  28
  29 struct module_entry { /* I'll call it ME. */
  30         unsigned flags;
  31         char *modname; /* stripped of /path/, .ext and s/-/_/g */
  32         const char *probed_name; /* verbatim as seen on cmdline */
  33         char *options; /* options from config files */
  34         llist_t *realnames; /* strings. if this module is an alias, */
  35         /* real module name is one of these. */
  36 //Can there really be more than one? Example from real kernel?
  37         llist_t *deps; /* strings. modules we depend on */
  38 };
  39
  40 /* NB: INSMOD_OPT_SILENT bit suppresses ONLY non-existent modules,
  41  * not deleted ones (those are still listed in modules.dep).
  42  * module-init-tools version 3.4:
  43  * # modprobe bogus
  44  * FATAL: Module bogus not found. [exitcode 1]
  45  * # modprobe -q bogus            [silent, exitcode still 1]
  46  * but:
  47  * # rm kernel/drivers/net/dummy.ko
  48  * # modprobe -q dummy
  49  * FATAL: Could not open '/lib/modules/xxx/kernel/drivers/net/dummy.ko': No such file or directory
  50  * [exitcode 1]
  51  */
  52 #define MODPROBE_OPTS  "acdlnrt:VC:" IF_FEATURE_MODPROBE_BLACKLIST("b")
  53 enum {
  54         MODPROBE_OPT_INSERT_ALL = (INSMOD_OPT_UNUSED << 0), /* a */
  55         MODPROBE_OPT_DUMP_ONLY  = (INSMOD_OPT_UNUSED << 1), /* c */
  56         MODPROBE_OPT_D          = (INSMOD_OPT_UNUSED << 2), /* d */
  57         MODPROBE_OPT_LIST_ONLY  = (INSMOD_OPT_UNUSED << 3), /* l */
  58         MODPROBE_OPT_SHOW_ONLY  = (INSMOD_OPT_UNUSED << 4), /* n */
  59         MODPROBE_OPT_REMOVE     = (INSMOD_OPT_UNUSED << 5), /* r */
  60         MODPROBE_OPT_RESTRICT   = (INSMOD_OPT_UNUSED << 6), /* t */
  61         MODPROBE_OPT_VERONLY    = (INSMOD_OPT_UNUSED << 7), /* V */
  62         MODPROBE_OPT_CONFIGFILE = (INSMOD_OPT_UNUSED << 8), /* C */
  63         MODPROBE_OPT_BLACKLIST  = (INSMOD_OPT_UNUSED << 9) * ENABLE_FEATURE_MODPROBE_BLACKLIST,
  64 };
  65
  66 struct globals {
  67         llist_t *db; /* MEs of all modules ever seen (caching for speed) */
  68         llist_t *probes; /* MEs of module(s) requested on cmdline */
  69         char *cmdline_mopts; /* module options from cmdline */
  70         int num_unresolved_deps;
  71         /* bool. "Did we have 'symbol:FOO' requested on cmdline?" */
  72         smallint need_symbols;
  73 } FIX_ALIASING;
  74 #define G (*(struct globals*)&bb_common_bufsiz1)
  75 #define INIT_G() do { } while (0)
  76
  77
  78 static int read_config(const char *path);
  79
  80 static char *gather_options_str(char *opts, const char *append)
  81 {
  82         /* Speed-optimized. We call gather_options_str many times. */
  83         if (append) {
  84                 if (opts == NULL) {
  85                         opts = xstrdup(append);
  86                 } else {
  87                         int optlen = strlen(opts);
  88                         opts = xrealloc(opts, optlen + strlen(append) + 2);
  89                         sprintf(opts + optlen, " %s", append);
  90                 }
  91         }
  92         return opts;
  93 }
  94
  95 static struct module_entry *helper_get_module(const char *module, int create)
  96 {
  97         char modname[MODULE_NAME_LEN];
  98         struct module_entry *e;
  99         llist_t *l;
 100
 101         filename2modname(module, modname);
 102         for (l = G.db; l != NULL; l = l->link) {
 103                 e = (struct module_entry *) l->data;
 104                 if (strcmp(e->modname, modname) == 0)
 105                         return e;
 106         }
 107         if (!create)
 108                 return NULL;
 109
 110         e = xzalloc(sizeof(*e));
 111         e->modname = xstrdup(modname);
 112         llist_add_to(&G.db, e);
 113
 114         return e;
 115 }
 116 static struct module_entry *get_or_add_modentry(const char *module)
 117 {
 118         return helper_get_module(module, 1);
 119 }
 120 static struct module_entry *get_modentry(const char *module)
 121 {
 122         return helper_get_module(module, 0);
 123 }
 124
 125 static void add_probe(const char *name)
 126 {
 127         struct module_entry *m;
 128
 129         m = get_or_add_modentry(name);
 130         if (!(option_mask32 & MODPROBE_OPT_REMOVE)
 131          && (m->flags & MODULE_FLAG_LOADED)
 132         ) {
 133                 DBG("skipping %s, it is already loaded", name);
 134                 return;
 135         }
 136
 137         DBG("queuing %s", name);
 138         m->probed_name = name;
 139         m->flags |= MODULE_FLAG_NEED_DEPS;
 140         llist_add_to_end(&G.probes, m);
 141         G.num_unresolved_deps++;
 142         if (ENABLE_FEATURE_MODUTILS_SYMBOLS
 143          && strncmp(m->modname, "symbol:", 7) == 0
 144         ) {
 145                 G.need_symbols = 1;
 146         }
 147 }
 148
 149 static int FAST_FUNC config_file_action(const char *filename,
 150                                         struct stat *statbuf UNUSED_PARAM,
 151                                         void *userdata UNUSED_PARAM,
 152                                         int depth UNUSED_PARAM)
 153 {
 154         char *tokens[3];
 155         parser_t *p;
 156         struct module_entry *m;
 157         int rc = TRUE;
 158
 159         if (bb_basename(filename)[0] == '.')
 160                 goto error;
 161
 162         p = config_open2(filename, fopen_for_read);
 163         if (p == NULL) {
 164                 rc = FALSE;
 165                 goto error;
 166         }
 167
 168         while (config_read(p, tokens, 3, 2, "# \t", PARSE_NORMAL)) {
 169 //Use index_in_strings?
 170                 if (strcmp(tokens[0], "alias") == 0) {
 171                         /* alias <wildcard> <modulename> */
 172                         llist_t *l;
 173                         char wildcard[MODULE_NAME_LEN];
 174                         char *rmod;
 175
 176                         if (tokens[2] == NULL)
 177                                 continue;
 178                         filename2modname(tokens[1], wildcard);
 179
 180                         for (l = G.probes; l != NULL; l = l->link) {
 181                                 m = (struct module_entry *) l->data;
 182                                 if (fnmatch(wildcard, m->modname, 0) != 0)
 183                                         continue;
 184                                 rmod = filename2modname(tokens[2], NULL);
 185                                 llist_add_to(&m->realnames, rmod);
 186
 187                                 if (m->flags & MODULE_FLAG_NEED_DEPS) {
 188                                         m->flags &= ~MODULE_FLAG_NEED_DEPS;
 189                                         G.num_unresolved_deps--;
 190                                 }
 191
 192                                 m = get_or_add_modentry(rmod);
 193                                 if (!(m->flags & MODULE_FLAG_NEED_DEPS)) {
 194                                         m->flags |= MODULE_FLAG_NEED_DEPS;
 195                                         G.num_unresolved_deps++;
 196                                 }
 197                         }
 198                 } else if (strcmp(tokens[0], "options") == 0) {
 199                         /* options <modulename> <option...> */
 200                         if (tokens[2] == NULL)
 201                                 continue;
 202                         m = get_or_add_modentry(tokens[1]);
 203                         m->options = gather_options_str(m->options, tokens[2]);
 204                 } else if (strcmp(tokens[0], "include") == 0) {
 205                         /* include <filename> */
 206                         read_config(tokens[1]);
 207                 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST
 208                  && strcmp(tokens[0], "blacklist") == 0
 209                 ) {
 210                         /* blacklist <modulename> */
 211                         get_or_add_modentry(tokens[1])->flags |= MODULE_FLAG_BLACKLISTED;
 212                 }
 213         }
 214         config_close(p);
 215  error:
 216         return rc;
 217 }
 218
 219 static int read_config(const char *path)
 220 {
 221         return recursive_action(path, ACTION_RECURSE | ACTION_QUIET,
 222                                 config_file_action, NULL, NULL, 1);
 223 }
 224
 225 static const char *humanly_readable_name(struct module_entry *m)
 226 {
 227         /* probed_name may be NULL. modname always exists. */
 228         return m->probed_name ? m->probed_name : m->modname;
 229 }
 230
 231 static char *parse_and_add_kcmdline_module_options(char *options, const char *modulename)
 232 {
 233         /* defined in arch/<architecture>/include/asm/setup.h
 234          * (maximum is 2048 for IA64 and SPARC) */
 235         char kcmdline_buf[2048];
 236         char *kcmdline;
 237         char *kptr;
 238         int len;
 239
 240         len = open_read_close("/proc/cmdline", kcmdline_buf, 2047);
 241         if (len <= 0)
 242                 return options;
 243         kcmdline_buf[len] = '\0';
 244
 245         len = strlen(modulename);
 246         kcmdline = kcmdline_buf;
 247         while ((kptr = strsep(&kcmdline, "\n\t ")) != NULL) {
 248                 if (strncmp(modulename, kptr, len) != 0)
 249                         continue;
 250                 kptr += len;
 251                 if (*kptr != '.')
 252                         continue;
 253                 /* It is "modulename.xxxx" */
 254                 kptr++;
 255                 if (strchr(kptr, '=') != NULL) {
 256                         /* It is "modulename.opt=[val]" */
 257                         options = gather_options_str(options, kptr);
 258                 }
 259         }
 260
 261         return options;
 262 }
 263
 264 /* Return: similar to bb_init_module:
 265  * 0 on success,
 266  * -errno on open/read error,
 267  * errno on init_module() error
 268  */
 269 static int do_modprobe(struct module_entry *m)
 270 {
 271         struct module_entry *m2 = m2; /* for compiler */
 272         char *fn, *options;
 273         int rc, first;
 274         llist_t *l;
 275
 276         if (!(m->flags & MODULE_FLAG_FOUND_IN_MODDEP)) {
 277                 if (!(option_mask32 & INSMOD_OPT_SILENT))
 278                         bb_error_msg("module %s not found in modules.dep",
 279                                 humanly_readable_name(m));
 280                 return -ENOENT;
 281         }
 282         DBG("do_modprob'ing %s", m->modname);
 283
 284         if (!(option_mask32 & MODPROBE_OPT_REMOVE))
 285                 m->deps = llist_rev(m->deps);
 286
 287         for (l = m->deps; l != NULL; l = l->link)
 288                 DBG("dep: %s", l->data);
 289
 290         first = 1;
 291         rc = 0;
 292         while (m->deps) {
 293                 rc = 0;
 294                 fn = llist_pop(&m->deps); /* we leak it */
 295                 m2 = get_or_add_modentry(fn);
 296
 297                 if (option_mask32 & MODPROBE_OPT_REMOVE) {
 298                         /* modprobe -r */
 299                         if (m2->flags & MODULE_FLAG_LOADED) {
 300                                 rc = bb_delete_module(m2->modname, O_EXCL);
 301                                 if (rc) {
 302                                         if (first) {
 303                                                 bb_error_msg("failed to unload module %s: %s",
 304                                                         humanly_readable_name(m2),
 305                                                         moderror(rc));
 306                                                 break;
 307                                         }
 308                                 } else {
 309                                         m2->flags &= ~MODULE_FLAG_LOADED;
 310                                 }
 311                         }
 312                         /* do not error out if *deps* fail to unload */
 313                         first = 0;
 314                         continue;
 315                 }
 316
 317                 if (m2->flags & MODULE_FLAG_LOADED) {
 318                         DBG("%s is already loaded, skipping", fn);
 319                         continue;
 320                 }
 321
 322                 options = m2->options;
 323                 m2->options = NULL;
 324                 options = parse_and_add_kcmdline_module_options(options, m2->modname);
 325                 if (m == m2)
 326                         options = gather_options_str(options, G.cmdline_mopts);
 327                 rc = bb_init_module(fn, options);
 328                 DBG("loaded %s '%s', rc:%d", fn, options, rc);
 329                 if (rc == EEXIST)
 330                         rc = 0;
 331                 free(options);
 332                 if (rc) {
 333                         bb_error_msg("failed to load module %s (%s): %s",
 334                                 humanly_readable_name(m2),
 335                                 fn,
 336                                 moderror(rc)
 337                         );
 338                         break;
 339                 }
 340                 m2->flags |= MODULE_FLAG_LOADED;
 341         }
 342
 343         return rc;
 344 }
 345
 346 static void load_modules_dep(void)
 347 {
 348         struct module_entry *m;
 349         char *colon, *tokens[2];
 350         parser_t *p;
 351
 352         /* Modprobe does not work at all without modules.dep,
 353          * even if the full module name is given. Returning error here
 354          * was making us later confuse user with this message:
 355          * "module /full/path/to/existing/file/module.ko not found".
 356          * It's better to die immediately, with good message.
 357          * xfopen_for_read provides that. */
 358         p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
 359
 360         while (G.num_unresolved_deps
 361          && config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)
 362         ) {
 363                 colon = last_char_is(tokens[0], ':');
 364                 if (colon == NULL)
 365                         continue;
 366                 *colon = 0;
 367
 368                 m = get_modentry(tokens[0]);
 369                 if (m == NULL)
 370                         continue;
 371
 372                 /* Optimization... */
 373                 if ((m->flags & MODULE_FLAG_LOADED)
 374                  && !(option_mask32 & MODPROBE_OPT_REMOVE)
 375                 ) {
 376                         DBG("skip deps of %s, it's already loaded", tokens[0]);
 377                         continue;
 378                 }
 379
 380                 m->flags |= MODULE_FLAG_FOUND_IN_MODDEP;
 381                 if ((m->flags & MODULE_FLAG_NEED_DEPS) && (m->deps == NULL)) {
 382                         G.num_unresolved_deps--;
 383                         llist_add_to(&m->deps, xstrdup(tokens[0]));
 384                         if (tokens[1])
 385                                 string_to_llist(tokens[1], &m->deps, " \t");
 386                 } else
 387                         DBG("skipping dep line");
 388         }
 389         config_close(p);
 390 }
 391
 392 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 393 int modprobe_main(int argc UNUSED_PARAM, char **argv)
 394 {
 395         struct utsname uts;
 396         int rc;
 397         unsigned opt;
 398         struct module_entry *me;
 399
 400         opt_complementary = "q-v:v-q";
 401         opt = getopt32(argv, INSMOD_OPTS MODPROBE_OPTS INSMOD_ARGS, NULL, NULL);
 402         argv += optind;
 403
 404         if (opt & (MODPROBE_OPT_DUMP_ONLY | MODPROBE_OPT_LIST_ONLY |
 405                                 MODPROBE_OPT_SHOW_ONLY))
 406                 bb_error_msg_and_die("not supported");
 407
 408         if (!argv[0]) {
 409                 if (opt & MODPROBE_OPT_REMOVE) {
 410                         /* "modprobe -r" (w/o params).
 411                          * "If name is NULL, all unused modules marked
 412                          * autoclean will be removed".
 413                          */
 414                         if (bb_delete_module(NULL, O_NONBLOCK | O_EXCL) != 0)
 415                                 bb_perror_msg_and_die("rmmod");
 416                 }
 417                 return EXIT_SUCCESS;
 418         }
 419
 420         /* Goto modules location */
 421         xchdir(CONFIG_DEFAULT_MODULES_DIR);
 422         uname(&uts);
 423         xchdir(uts.release);
 424
 425         /* Retrieve module names of already loaded modules */
 426         {
 427                 char *s;
 428                 parser_t *parser = config_open2("/proc/modules", fopen_for_read);
 429                 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY))
 430                         get_or_add_modentry(s)->flags |= MODULE_FLAG_LOADED;
 431                 config_close(parser);
 432         }
 433
 434         if (opt & (MODPROBE_OPT_INSERT_ALL | MODPROBE_OPT_REMOVE)) {
 435                 /* Each argument is a module name */
 436                 do {
 437                         DBG("adding module %s", *argv);
 438                         add_probe(*argv++);
 439                 } while (*argv);
 440         } else {
 441                 /* First argument is module name, rest are parameters */
 442                 DBG("probing just module %s", *argv);
 443                 add_probe(argv[0]);
 444                 G.cmdline_mopts = parse_cmdline_module_options(argv);
 445         }
 446
 447         /* Happens if all requested modules are already loaded */
 448         if (G.probes == NULL)
 449                 return EXIT_SUCCESS;
 450
 451         read_config("/etc/modprobe.conf");
 452         read_config("/etc/modprobe.d");
 453         if (ENABLE_FEATURE_MODUTILS_SYMBOLS && G.need_symbols)
 454                 read_config("modules.symbols");
 455         load_modules_dep();
 456         if (ENABLE_FEATURE_MODUTILS_ALIAS && G.num_unresolved_deps) {
 457                 read_config("modules.alias");
 458                 load_modules_dep();
 459         }
 460
 461         rc = 0;
 462         while ((me = llist_pop(&G.probes)) != NULL) {
 463                 if (me->realnames == NULL) {
 464                         DBG("probing by module name");
 465                         /* This is not an alias. Literal names are blacklisted
 466                          * only if '-b' is given.
 467                          */
 468                         if (!(opt & MODPROBE_OPT_BLACKLIST)
 469                          || !(me->flags & MODULE_FLAG_BLACKLISTED)
 470                         ) {
 471                                 rc |= do_modprobe(me);
 472                         }
 473                         continue;
 474                 }
 475
 476                 /* Probe all real names for the alias */
 477                 do {
 478                         char *realname = llist_pop(&me->realnames);
 479                         struct module_entry *m2;
 480
 481                         DBG("probing alias %s by realname %s", me->modname, realname);
 482                         m2 = get_or_add_modentry(realname);
 483                         if (!(m2->flags & MODULE_FLAG_BLACKLISTED)
 484                          && (!(m2->flags & MODULE_FLAG_LOADED)
 485                             || (opt & MODPROBE_OPT_REMOVE))
 486                         ) {
 487 //TODO: we can pass "me" as 2nd param to do_modprobe,
 488 //and make do_modprobe emit more meaningful error messages
 489 //with alias name included, not just module name alias resolves to.
 490                                 rc |= do_modprobe(m2);
 491                         }
 492                         free(realname);
 493                 } while (me->realnames != NULL);
 494         }
 495
 496         return (rc != 0);
 497 }