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.  Older
  13  * versions would only export the direct dependency list.
  14  */
  15
  16 #include "libbb.h"
  17 #include "modutils.h"
  18 #include <sys/utsname.h>
  19 #include <fnmatch.h>
  20
  21 //#define DBG(fmt, ...) bb_error_msg("%s: " fmt, __func__, ## __VA_ARGS__)
  22 #define DBG(...) ((void)0)
  23
  24 #define MODULE_FLAG_LOADED              0x0001
  25 #define MODULE_FLAG_NEED_DEPS           0x0002
  26 /* "was seen in modules.dep": */
  27 #define MODULE_FLAG_FOUND_IN_MODDEP     0x0004
  28 #define MODULE_FLAG_BLACKLISTED         0x0008
  29
  30 struct module_entry { /* I'll call it ME. */
  31         unsigned flags;
  32         char *modname; /* stripped of /path/, .ext and s/-/_/g */
  33         const char *probed_name; /* verbatim as seen on cmdline */
  34         char *options; /* options from config files */
  35         llist_t *realnames; /* strings. if this module is an alias, */
  36         /* real module name is one of these. */
  37 //Can there really be more than one? Example from real kernel?
  38         llist_t *deps; /* strings. modules we depend on */
  39 };
  40
  41 #define MODPROBE_OPTS  "acdlnrt:VC:" IF_FEATURE_MODPROBE_BLACKLIST("b")
  42 enum {
  43         MODPROBE_OPT_INSERT_ALL = (INSMOD_OPT_UNUSED << 0), /* a */
  44         MODPROBE_OPT_DUMP_ONLY  = (INSMOD_OPT_UNUSED << 1), /* c */
  45         MODPROBE_OPT_D          = (INSMOD_OPT_UNUSED << 2), /* d */
  46         MODPROBE_OPT_LIST_ONLY  = (INSMOD_OPT_UNUSED << 3), /* l */
  47         MODPROBE_OPT_SHOW_ONLY  = (INSMOD_OPT_UNUSED << 4), /* n */
  48         MODPROBE_OPT_REMOVE     = (INSMOD_OPT_UNUSED << 5), /* r */
  49         MODPROBE_OPT_RESTRICT   = (INSMOD_OPT_UNUSED << 6), /* t */
  50         MODPROBE_OPT_VERONLY    = (INSMOD_OPT_UNUSED << 7), /* V */
  51         MODPROBE_OPT_CONFIGFILE = (INSMOD_OPT_UNUSED << 8), /* C */
  52         MODPROBE_OPT_BLACKLIST  = (INSMOD_OPT_UNUSED << 9) * ENABLE_FEATURE_MODPROBE_BLACKLIST,
  53 };
  54
  55 struct globals {
  56         llist_t *db; /* MEs of all modules ever seen (caching for speed) */
  57         llist_t *probes; /* MEs of module(s) requested on cmdline */
  58         char *cmdline_mopts; /* module options from cmdline */
  59         int num_unresolved_deps;
  60         /* bool. "Did we have 'symbol:FOO' requested on cmdline?" */
  61         smallint need_symbols;
  62 };
  63 #define G (*(struct globals*)&bb_common_bufsiz1)
  64 #define INIT_G() do { } while (0)
  65
  66
  67 static int read_config(const char *path);
  68
  69 static char *gather_options_str(char *opts, const char *append)
  70 {
  71         /* Speed-optimized. We call gather_options_str many times. */
  72         if (opts == NULL) {
  73                 opts = xstrdup(append);
  74         } else {
  75                 int optlen = strlen(opts);
  76                 opts = xrealloc(opts, optlen + strlen(append) + 2);
  77                 sprintf(opts + optlen, " %s", append);
  78         }
  79         return opts;
  80 }
  81
  82 static struct module_entry *helper_get_module(const char *module, int create)
  83 {
  84         char modname[MODULE_NAME_LEN];
  85         struct module_entry *e;
  86         llist_t *l;
  87
  88         filename2modname(module, modname);
  89         for (l = G.db; l != NULL; l = l->link) {
  90                 e = (struct module_entry *) l->data;
  91                 if (strcmp(e->modname, modname) == 0)
  92                         return e;
  93         }
  94         if (!create)
  95                 return NULL;
  96
  97         e = xzalloc(sizeof(*e));
  98         e->modname = xstrdup(modname);
  99         llist_add_to(&G.db, e);
 100
 101         return e;
 102 }
 103 static struct module_entry *get_or_add_modentry(const char *module)
 104 {
 105         return helper_get_module(module, 1);
 106 }
 107 static struct module_entry *get_modentry(const char *module)
 108 {
 109         return helper_get_module(module, 0);
 110 }
 111
 112 static void add_probe(const char *name)
 113 {
 114         struct module_entry *m;
 115
 116         m = get_or_add_modentry(name);
 117         if (m->flags & MODULE_FLAG_LOADED) {
 118                 DBG("skipping %s, it is already loaded", name);
 119                 return;
 120         }
 121
 122         DBG("queuing %s", name);
 123         m->probed_name = name;
 124         m->flags |= MODULE_FLAG_NEED_DEPS;
 125         llist_add_to_end(&G.probes, m);
 126         G.num_unresolved_deps++;
 127         if (ENABLE_FEATURE_MODUTILS_SYMBOLS
 128          && strncmp(m->modname, "symbol:", 7) == 0
 129         ) {
 130                 G.need_symbols = 1;
 131         }
 132 }
 133
 134 static int FAST_FUNC config_file_action(const char *filename,
 135                                         struct stat *statbuf UNUSED_PARAM,
 136                                         void *userdata UNUSED_PARAM,
 137                                         int depth UNUSED_PARAM)
 138 {
 139         char *tokens[3];
 140         parser_t *p;
 141         struct module_entry *m;
 142         int rc = TRUE;
 143
 144         if (bb_basename(filename)[0] == '.')
 145                 goto error;
 146
 147         p = config_open2(filename, fopen_for_read);
 148         if (p == NULL) {
 149                 rc = FALSE;
 150                 goto error;
 151         }
 152
 153         while (config_read(p, tokens, 3, 2, "# \t", PARSE_NORMAL)) {
 154 //Use index_in_strings?
 155                 if (strcmp(tokens[0], "alias") == 0) {
 156                         /* alias <wildcard> <modulename> */
 157                         llist_t *l;
 158                         char wildcard[MODULE_NAME_LEN];
 159                         char *rmod;
 160
 161                         if (tokens[2] == NULL)
 162                                 continue;
 163                         filename2modname(tokens[1], wildcard);
 164
 165                         for (l = G.probes; l != NULL; l = l->link) {
 166                                 m = (struct module_entry *) l->data;
 167                                 if (fnmatch(wildcard, m->modname, 0) != 0)
 168                                         continue;
 169                                 rmod = filename2modname(tokens[2], NULL);
 170                                 llist_add_to(&m->realnames, rmod);
 171
 172                                 if (m->flags & MODULE_FLAG_NEED_DEPS) {
 173                                         m->flags &= ~MODULE_FLAG_NEED_DEPS;
 174                                         G.num_unresolved_deps--;
 175                                 }
 176
 177                                 m = get_or_add_modentry(rmod);
 178                                 if (!(m->flags & MODULE_FLAG_NEED_DEPS)) {
 179                                         m->flags |= MODULE_FLAG_NEED_DEPS;
 180                                         G.num_unresolved_deps++;
 181                                 }
 182                         }
 183                 } else if (strcmp(tokens[0], "options") == 0) {
 184                         /* options <modulename> <option...> */
 185                         if (tokens[2] == NULL)
 186                                 continue;
 187                         m = get_or_add_modentry(tokens[1]);
 188                         m->options = gather_options_str(m->options, tokens[2]);
 189                 } else if (strcmp(tokens[0], "include") == 0) {
 190                         /* include <filename> */
 191                         read_config(tokens[1]);
 192                 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST
 193                  && strcmp(tokens[0], "blacklist") == 0
 194                 ) {
 195                         /* blacklist <modulename> */
 196                         get_or_add_modentry(tokens[1])->flags |= MODULE_FLAG_BLACKLISTED;
 197                 }
 198         }
 199         config_close(p);
 200 error:
 201         return rc;
 202 }
 203
 204 static int read_config(const char *path)
 205 {
 206         return recursive_action(path, ACTION_RECURSE | ACTION_QUIET,
 207                                 config_file_action, NULL, NULL, 1);
 208 }
 209
 210 static int do_modprobe(struct module_entry *m)
 211 {
 212         struct module_entry *m2;
 213         char *fn, *options;
 214         int rc = -1;
 215         llist_t *l;
 216
 217         if (!(m->flags & MODULE_FLAG_FOUND_IN_MODDEP)) {
 218                 DBG("skipping %s, not found in modules.dep", m->modname);
 219                 return -ENOENT;
 220         }
 221         DBG("do_modprob'ing %s", m->modname);
 222
 223         if (!(option_mask32 & MODPROBE_OPT_REMOVE))
 224                 m->deps = llist_rev(m->deps);
 225
 226         for (l = m->deps; l != NULL; l = l->link)
 227                 DBG("dep: %s", l->data);
 228
 229         rc = 0;
 230         while (m->deps && rc == 0) {
 231                 fn = llist_pop(&m->deps);
 232                 m2 = get_or_add_modentry(fn);
 233                 if (option_mask32 & MODPROBE_OPT_REMOVE) {
 234                         if (bb_delete_module(m->modname, O_EXCL) != 0)
 235                                 rc = errno;
 236                 } else if (!(m2->flags & MODULE_FLAG_LOADED)) {
 237                         options = m2->options;
 238                         m2->options = NULL;
 239                         if (m == m2)
 240                                 options = gather_options_str(options, G.cmdline_mopts);
 241                         rc = bb_init_module(fn, options);
 242                         DBG("loaded %s '%s', rc:%d", fn, options, rc);
 243                         if (rc == 0)
 244                                 m2->flags |= MODULE_FLAG_LOADED;
 245                         free(options);
 246                 } else {
 247                         DBG("%s is already loaded, skipping", fn);
 248                 }
 249
 250                 free(fn);
 251         }
 252
 253 //FIXME: what if rc < 0?
 254         if (rc > 0 && !(option_mask32 & INSMOD_OPT_SILENT)) {
 255                 bb_error_msg("failed to %sload module %s: %s",
 256                         (option_mask32 & MODPROBE_OPT_REMOVE) ? "un" : "",
 257                         m->probed_name ? m->probed_name : m->modname,
 258                         moderror(rc)
 259                 );
 260         }
 261
 262         return rc;
 263 }
 264
 265 static void load_modules_dep(void)
 266 {
 267         struct module_entry *m;
 268         char *colon, *tokens[2];
 269         parser_t *p;
 270
 271         /* Modprobe does not work at all without modprobe.dep,
 272          * even if the full module name is given. Returning error here
 273          * was making us later confuse user with this message:
 274          * "module /full/path/to/existing/file/module.ko not found".
 275          * It's better to die immediately, with good message.
 276          * xfopen_for_read provides that. */
 277         p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
 278
 279         while (G.num_unresolved_deps
 280          && config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)
 281         ) {
 282                 colon = last_char_is(tokens[0], ':');
 283                 if (colon == NULL)
 284                         continue;
 285                 *colon = 0;
 286
 287                 m = get_modentry(tokens[0]);
 288                 if (m == NULL)
 289                         continue;
 290
 291                 /* Optimization... */
 292                 if ((m->flags & MODULE_FLAG_LOADED)
 293                  && !(option_mask32 & MODPROBE_OPT_REMOVE)
 294                 ) {
 295                         DBG("skip deps of %s, it's already loaded", tokens[0]);
 296                         continue;
 297                 }
 298
 299                 m->flags |= MODULE_FLAG_FOUND_IN_MODDEP;
 300                 if ((m->flags & MODULE_FLAG_NEED_DEPS) && (m->deps == NULL)) {
 301                         G.num_unresolved_deps--;
 302                         llist_add_to(&m->deps, xstrdup(tokens[0]));
 303                         if (tokens[1])
 304                                 string_to_llist(tokens[1], &m->deps, " ");
 305                 } else
 306                         DBG("skipping dep line");
 307         }
 308         config_close(p);
 309 }
 310
 311 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 312 int modprobe_main(int argc UNUSED_PARAM, char **argv)
 313 {
 314         struct utsname uts;
 315         int rc;
 316         unsigned opt;
 317         struct module_entry *me;
 318
 319         opt_complementary = "q-v:v-q";
 320         opt = getopt32(argv, INSMOD_OPTS MODPROBE_OPTS INSMOD_ARGS, NULL, NULL);
 321         argv += optind;
 322
 323         if (opt & (MODPROBE_OPT_DUMP_ONLY | MODPROBE_OPT_LIST_ONLY |
 324                                 MODPROBE_OPT_SHOW_ONLY))
 325                 bb_error_msg_and_die("not supported");
 326
 327         if (!argv[0]) {
 328                 if (opt & MODPROBE_OPT_REMOVE) {
 329                         /* "modprobe -r" (w/o params).
 330                          * "If name is NULL, all unused modules marked
 331                          * autoclean will be removed".
 332                          */
 333                         if (bb_delete_module(NULL, O_NONBLOCK|O_EXCL) != 0)
 334                                 bb_perror_msg_and_die("rmmod");
 335                 }
 336                 return EXIT_SUCCESS;
 337         }
 338
 339         /* Goto modules location */
 340         xchdir(CONFIG_DEFAULT_MODULES_DIR);
 341         uname(&uts);
 342         xchdir(uts.release);
 343
 344         /* Retrieve module names of already loaded modules */
 345         {
 346                 char *s;
 347                 parser_t *parser = config_open2("/proc/modules", fopen_for_read);
 348                 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY))
 349                         get_or_add_modentry(s)->flags |= MODULE_FLAG_LOADED;
 350                 config_close(parser);
 351         }
 352
 353         if (opt & MODPROBE_OPT_INSERT_ALL) {
 354                 /* Each argument is a module name */
 355                 do {
 356                         DBG("adding module %s", *argv);
 357                         add_probe(*argv++);
 358                 } while (*argv);
 359         } else {
 360                 /* First argument is module name, rest are parameters */
 361                 DBG("probing just module %s", *argv);
 362                 add_probe(argv[0]);
 363                 G.cmdline_mopts = parse_cmdline_module_options(argv);
 364         }
 365
 366         /* Happens if all requested modules are already loaded */
 367         if (G.probes == NULL)
 368                 return EXIT_SUCCESS;
 369
 370         read_config("/etc/modprobe.conf");
 371         read_config("/etc/modprobe.d");
 372         if (ENABLE_FEATURE_MODUTILS_SYMBOLS && G.need_symbols)
 373                 read_config("modules.symbols");
 374         load_modules_dep();
 375         if (ENABLE_FEATURE_MODUTILS_ALIAS && G.num_unresolved_deps) {
 376                 read_config("modules.alias");
 377                 load_modules_dep();
 378         }
 379
 380         while ((me = llist_pop(&G.probes)) != NULL) {
 381                 if (me->realnames == NULL) {
 382                         /* This is not an alias. Literal names are blacklisted
 383                          * only if '-b' is given.
 384                          */
 385                         if (!(opt & MODPROBE_OPT_BLACKLIST)
 386                          || !(me->flags & MODULE_FLAG_BLACKLISTED)
 387                         ) {
 388                                 rc = do_modprobe(me);
 389 //FIXME: what if rc > 0?
 390                                 if (rc < 0 && !(opt & INSMOD_OPT_SILENT))
 391                                         bb_error_msg("module %s not found",
 392                                                      me->probed_name);
 393                         }
 394                 } else {
 395                         /* Probe all realnames */
 396                         do {
 397                                 char *realname = llist_pop(&me->realnames);
 398                                 struct module_entry *m2;
 399
 400                                 DBG("probing %s by realname %s", me->modname, realname);
 401                                 m2 = get_or_add_modentry(realname);
 402                                 if (!(m2->flags & MODULE_FLAG_BLACKLISTED))
 403                                         do_modprobe(m2);
 404 //FIXME: error check?
 405                                 free(realname);
 406                         } while (me->realnames != NULL);
 407                 }
 408         }
 409
 410         return EXIT_SUCCESS;
 411 }