modutils/*: move applet bits into corresponding *.c files
[oweals/busybox.git] / modutils / modprobe.c
index 218a898a8ea7f3b0a899108e77277ac0b2e6b376..a5cf4babf2aa31204d36099298e1bdf2b1e99f09 100644 (file)
  * Copyright (c) 2008 Timo Teras <timo.teras@iki.fi>
  * Copyright (c) 2008 Vladimir Dronnikov
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
+//applet:IF_MODPROBE(APPLET(modprobe, _BB_DIR_SBIN, _BB_SUID_DROP))
+
+//usage:#if !ENABLE_MODPROBE_SMALL
+//usage:#define modprobe_notes_usage
+//usage:       "modprobe can (un)load a stack of modules, passing each module options (when\n"
+//usage:       "loading). modprobe uses a configuration file to determine what option(s) to\n"
+//usage:       "pass each module it loads.\n"
+//usage:       "\n"
+//usage:       "The configuration file is searched (in this order):\n"
+//usage:       "\n"
+//usage:       "    /etc/modprobe.conf (2.6 only)\n"
+//usage:       "    /etc/modules.conf\n"
+//usage:       "    /etc/conf.modules (deprecated)\n"
+//usage:       "\n"
+//usage:       "They all have the same syntax (see below). If none is present, it is\n"
+//usage:       "_not_ an error; each loaded module is then expected to load without\n"
+//usage:       "options. Once a file is found, the others are tested for.\n"
+//usage:       "\n"
+//usage:       "/etc/modules.conf entry format:\n"
+//usage:       "\n"
+//usage:       "  alias <alias_name> <mod_name>\n"
+//usage:       "    Makes it possible to modprobe alias_name, when there is no such module.\n"
+//usage:       "    It makes sense if your mod_name is long, or you want a more representative\n"
+//usage:       "    name for that module (eg. 'scsi' in place of 'aha7xxx').\n"
+//usage:       "    This makes it also possible to use a different set of options (below) for\n"
+//usage:       "    the module and the alias.\n"
+//usage:       "    A module can be aliased more than once.\n"
+//usage:       "\n"
+//usage:       "  options <mod_name|alias_name> <symbol=value...>\n"
+//usage:       "    When loading module mod_name (or the module aliased by alias_name), pass\n"
+//usage:       "    the \"symbol=value\" pairs as option to that module.\n"
+//usage:       "\n"
+//usage:       "Sample /etc/modules.conf file:\n"
+//usage:       "\n"
+//usage:       "  options tulip irq=3\n"
+//usage:       "  alias tulip tulip2\n"
+//usage:       "  options tulip2 irq=4 io=0x308\n"
+//usage:       "\n"
+//usage:       "Other functionality offered by 'classic' modprobe is not available in\n"
+//usage:       "this implementation.\n"
+//usage:       "\n"
+//usage:       "If module options are present both in the config file, and on the command line,\n"
+//usage:       "then the options from the command line will be passed to the module _after_\n"
+//usage:       "the options from the config file. That way, you can have defaults in the config\n"
+//usage:       "file, and override them for a specific usage from the command line.\n"
+//usage:#define modprobe_example_usage
+//usage:       "(with the above /etc/modules.conf):\n\n"
+//usage:       "$ modprobe tulip\n"
+//usage:       "   will load the module 'tulip' with default option 'irq=3'\n\n"
+//usage:       "$ modprobe tulip irq=5\n"
+//usage:       "   will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n"
+//usage:       "$ modprobe tulip2\n"
+//usage:       "   will load the module 'tulip' with default options 'irq=4 io=0x308',\n"
+//usage:       "   which are the default for alias 'tulip2'\n\n"
+//usage:       "$ modprobe tulip2 irq=8\n"
+//usage:       "   will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n"
+//usage:       "   which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n"
+//usage:       "   from the command line\n\n"
+//usage:       "$ modprobe tulip2 irq=2 io=0x210\n"
+//usage:       "   will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n"
+//usage:       "   which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n"
+//usage:       "   from the command line\n"
+//usage:
+//usage:#define modprobe_trivial_usage
+//usage:       "[-alrqvs"
+//usage:       IF_FEATURE_MODPROBE_BLACKLIST("b")
+//usage:       "] MODULE [symbol=value]..."
+//usage:#define modprobe_full_usage "\n\n"
+//usage:       "Options:"
+//usage:     "\n       -a      Load multiple MODULEs"
+//usage:     "\n       -l      List (MODULE is a pattern)"
+//usage:     "\n       -r      Remove MODULE (stacks) or do autoclean"
+//usage:     "\n       -q      Quiet"
+//usage:     "\n       -v      Verbose"
+//usage:     "\n       -s      Log to syslog"
+//usage:       IF_FEATURE_MODPROBE_BLACKLIST(
+//usage:     "\n       -b      Apply blacklist to module names too"
+//usage:       )
+//usage:#endif /* !ENABLE_MODPROBE_SMALL */
+
 #include "libbb.h"
 #include "modutils.h"
 #include <sys/utsname.h>
 #include <fnmatch.h>
 
-//#define DBG(...) bb_error_msg(__VA_ARGS__)
+//#define DBG(fmt, ...) bb_error_msg("%s: " fmt, __func__, ## __VA_ARGS__)
 #define DBG(...) ((void)0)
 
-#define MODULE_FLAG_LOADED             0x0001
-#define MODULE_FLAG_NEED_DEPS          0x0002
+/* Note that unlike older versions of modules.dep/depmod (busybox and m-i-t),
+ * we expect the full dependency list to be specified in modules.dep.
+ * Older versions would only export the direct dependency list.
+ */
+
+/* Note that usage text doesn't document various 2.4 options
+ * we pull in through INSMOD_OPTS define */
+
+#define MODPROBE_COMPLEMENTARY "q-v:v-q:l--ar:a--lr:r--al"
+#define MODPROBE_OPTS  "alr" IF_FEATURE_MODPROBE_BLACKLIST("b")
+//#define MODPROBE_COMPLEMENTARY "q-v:v-q:l--acr:a--lr:r--al"
+//#define MODPROBE_OPTS  "acd:lnrt:C:" IF_FEATURE_MODPROBE_BLACKLIST("b")
+enum {
+       MODPROBE_OPT_INSERT_ALL = (INSMOD_OPT_UNUSED << 0), /* a */
+       //MODPROBE_OPT_DUMP_ONLY= (INSMOD_OPT_UNUSED << x), /* c */
+       //MODPROBE_OPT_DIRNAME  = (INSMOD_OPT_UNUSED << x), /* d */
+       MODPROBE_OPT_LIST_ONLY  = (INSMOD_OPT_UNUSED << 1), /* l */
+       //MODPROBE_OPT_SHOW_ONLY= (INSMOD_OPT_UNUSED << x), /* n */
+       MODPROBE_OPT_REMOVE     = (INSMOD_OPT_UNUSED << 2), /* r */
+       //MODPROBE_OPT_RESTRICT = (INSMOD_OPT_UNUSED << x), /* t */
+       //MODPROBE_OPT_VERONLY  = (INSMOD_OPT_UNUSED << x), /* V */
+       //MODPROBE_OPT_CONFIGFILE=(INSMOD_OPT_UNUSED << x), /* C */
+       MODPROBE_OPT_BLACKLIST  = (INSMOD_OPT_UNUSED << 3) * ENABLE_FEATURE_MODPROBE_BLACKLIST,
+};
+
+#define MODULE_FLAG_LOADED              0x0001
+#define MODULE_FLAG_NEED_DEPS           0x0002
 /* "was seen in modules.dep": */
-#define MODULE_FLAG_FOUND_IN_MODDEP    0x0004
-#define MODULE_FLAG_BLACKLISTED                0x0008
+#define MODULE_FLAG_FOUND_IN_MODDEP     0x0004
+#define MODULE_FLAG_BLACKLISTED         0x0008
 
 struct module_entry { /* I'll call it ME. */
        unsigned flags;
@@ -33,20 +138,6 @@ struct module_entry { /* I'll call it ME. */
        llist_t *deps; /* strings. modules we depend on */
 };
 
-#define MODPROBE_OPTS  "acdlnrt:VC:" USE_FEATURE_MODPROBE_BLACKLIST("b")
-enum {
-       MODPROBE_OPT_INSERT_ALL = (INSMOD_OPT_UNUSED << 0), /* a */
-       MODPROBE_OPT_DUMP_ONLY  = (INSMOD_OPT_UNUSED << 1), /* c */
-       MODPROBE_OPT_D          = (INSMOD_OPT_UNUSED << 2), /* d */
-       MODPROBE_OPT_LIST_ONLY  = (INSMOD_OPT_UNUSED << 3), /* l */
-       MODPROBE_OPT_SHOW_ONLY  = (INSMOD_OPT_UNUSED << 4), /* n */
-       MODPROBE_OPT_REMOVE     = (INSMOD_OPT_UNUSED << 5), /* r */
-       MODPROBE_OPT_RESTRICT   = (INSMOD_OPT_UNUSED << 6), /* t */
-       MODPROBE_OPT_VERONLY    = (INSMOD_OPT_UNUSED << 7), /* V */
-       MODPROBE_OPT_CONFIGFILE = (INSMOD_OPT_UNUSED << 8), /* C */
-       MODPROBE_OPT_BLACKLIST  = (INSMOD_OPT_UNUSED << 9) * ENABLE_FEATURE_MODPROBE_BLACKLIST,
-};
-
 struct globals {
        llist_t *db; /* MEs of all modules ever seen (caching for speed) */
        llist_t *probes; /* MEs of module(s) requested on cmdline */
@@ -54,7 +145,7 @@ struct globals {
        int num_unresolved_deps;
        /* bool. "Did we have 'symbol:FOO' requested on cmdline?" */
        smallint need_symbols;
-};
+} FIX_ALIASING;
 #define G (*(struct globals*)&bb_common_bufsiz1)
 #define INIT_G() do { } while (0)
 
@@ -64,12 +155,14 @@ static int read_config(const char *path);
 static char *gather_options_str(char *opts, const char *append)
 {
        /* Speed-optimized. We call gather_options_str many times. */
-       if (opts == NULL) {
-               opts = xstrdup(append);
-       } else {
-               int optlen = strlen(opts);
-               opts = xrealloc(opts, optlen + strlen(append) + 2);
-               sprintf(opts + optlen, " %s", append);
+       if (append) {
+               if (opts == NULL) {
+                       opts = xstrdup(append);
+               } else {
+                       int optlen = strlen(opts);
+                       opts = xrealloc(opts, optlen + strlen(append) + 2);
+                       sprintf(opts + optlen, " %s", append);
+               }
        }
        return opts;
 }
@@ -109,11 +202,14 @@ static void add_probe(const char *name)
        struct module_entry *m;
 
        m = get_or_add_modentry(name);
-       if (m->flags & MODULE_FLAG_LOADED) {
+       if (!(option_mask32 & MODPROBE_OPT_REMOVE)
+        && (m->flags & MODULE_FLAG_LOADED)
+       ) {
                DBG("skipping %s, it is already loaded", name);
                return;
        }
 
+       DBG("queuing %s", name);
        m->probed_name = name;
        m->flags |= MODULE_FLAG_NEED_DEPS;
        llist_add_to_end(&G.probes, m);
@@ -132,7 +228,7 @@ static int FAST_FUNC config_file_action(const char *filename,
 {
        char *tokens[3];
        parser_t *p;
-        struct module_entry *m;
+       struct module_entry *m;
        int rc = TRUE;
 
        if (bb_basename(filename)[0] == '.')
@@ -191,7 +287,7 @@ static int FAST_FUNC config_file_action(const char *filename,
                }
        }
        config_close(p);
-error:
+ error:
        return rc;
 }
 
@@ -201,14 +297,71 @@ static int read_config(const char *path)
                                config_file_action, NULL, NULL, 1);
 }
 
+static const char *humanly_readable_name(struct module_entry *m)
+{
+       /* probed_name may be NULL. modname always exists. */
+       return m->probed_name ? m->probed_name : m->modname;
+}
+
+static char *parse_and_add_kcmdline_module_options(char *options, const char *modulename)
+{
+       char *kcmdline_buf;
+       char *kcmdline;
+       char *kptr;
+       int len;
+
+       kcmdline_buf = xmalloc_open_read_close("/proc/cmdline", NULL);
+       if (!kcmdline_buf)
+               return options;
+
+       kcmdline = kcmdline_buf;
+       len = strlen(modulename);
+       while ((kptr = strsep(&kcmdline, "\n\t ")) != NULL) {
+               if (strncmp(modulename, kptr, len) != 0)
+                       continue;
+               kptr += len;
+               if (*kptr != '.')
+                       continue;
+               /* It is "modulename.xxxx" */
+               kptr++;
+               if (strchr(kptr, '=') != NULL) {
+                       /* It is "modulename.opt=[val]" */
+                       options = gather_options_str(options, kptr);
+               }
+       }
+       free(kcmdline_buf);
+
+       return options;
+}
+
+/* Return: similar to bb_init_module:
+ * 0 on success,
+ * -errno on open/read error,
+ * errno on init_module() error
+ */
+/* NB: INSMOD_OPT_SILENT bit suppresses ONLY non-existent modules,
+ * not deleted ones (those are still listed in modules.dep).
+ * module-init-tools version 3.4:
+ * # modprobe bogus
+ * FATAL: Module bogus not found. [exitcode 1]
+ * # modprobe -q bogus            [silent, exitcode still 1]
+ * but:
+ * # rm kernel/drivers/net/dummy.ko
+ * # modprobe -q dummy
+ * FATAL: Could not open '/lib/modules/xxx/kernel/drivers/net/dummy.ko': No such file or directory
+ * [exitcode 1]
+ */
 static int do_modprobe(struct module_entry *m)
 {
-       struct module_entry *m2;
+       struct module_entry *m2 = m2; /* for compiler */
        char *fn, *options;
-       int rc = -1;
+       int rc, first;
+       llist_t *l;
 
        if (!(m->flags & MODULE_FLAG_FOUND_IN_MODDEP)) {
-               DBG("skipping %s, not found in modules.dep", m->modname);
+               if (!(option_mask32 & INSMOD_OPT_SILENT))
+                       bb_error_msg("module %s not found in modules.dep",
+                               humanly_readable_name(m));
                return -ENOENT;
        }
        DBG("do_modprob'ing %s", m->modname);
@@ -216,37 +369,60 @@ static int do_modprobe(struct module_entry *m)
        if (!(option_mask32 & MODPROBE_OPT_REMOVE))
                m->deps = llist_rev(m->deps);
 
+       for (l = m->deps; l != NULL; l = l->link)
+               DBG("dep: %s", l->data);
+
+       first = 1;
        rc = 0;
-       while (m->deps && rc == 0) {
-               fn = llist_pop(&m->deps);
+       while (m->deps) {
+               rc = 0;
+               fn = llist_pop(&m->deps); /* we leak it */
                m2 = get_or_add_modentry(fn);
+
                if (option_mask32 & MODPROBE_OPT_REMOVE) {
-                       if (bb_delete_module(m->modname, O_EXCL) != 0)
-                               rc = errno;
-               } else if (!(m2->flags & MODULE_FLAG_LOADED)) {
-                       options = m2->options;
-                       m2->options = NULL;
-                       if (m == m2)
-                               options = gather_options_str(options, G.cmdline_mopts);
-                       rc = bb_init_module(fn, options);
-                       DBG("loaded %s '%s', rc:%d", fn, options, rc);
-                       if (rc == 0)
-                               m2->flags |= MODULE_FLAG_LOADED;
-                       free(options);
-               } else {
-                       DBG("%s is already loaded, skipping", fn);
+                       /* modprobe -r */
+                       if (m2->flags & MODULE_FLAG_LOADED) {
+                               rc = bb_delete_module(m2->modname, O_EXCL);
+                               if (rc) {
+                                       if (first) {
+                                               bb_error_msg("can't unload module %s: %s",
+                                                       humanly_readable_name(m2),
+                                                       moderror(rc));
+                                               break;
+                                       }
+                               } else {
+                                       m2->flags &= ~MODULE_FLAG_LOADED;
+                               }
+                       }
+                       /* do not error out if *deps* fail to unload */
+                       first = 0;
+                       continue;
                }
 
-               free(fn);
-       }
+               if (m2->flags & MODULE_FLAG_LOADED) {
+                       DBG("%s is already loaded, skipping", fn);
+                       continue;
+               }
 
-//FIXME: what if rc < 0?
-       if (rc > 0 && !(option_mask32 & INSMOD_OPT_SILENT)) {
-               bb_error_msg("failed to %sload module %s: %s",
-                       (option_mask32 & MODPROBE_OPT_REMOVE) ? "un" : "",
-                       m->probed_name ? m->probed_name : m->modname,
-                       moderror(rc)
-               );
+               options = m2->options;
+               m2->options = NULL;
+               options = parse_and_add_kcmdline_module_options(options, m2->modname);
+               if (m == m2)
+                       options = gather_options_str(options, G.cmdline_mopts);
+               rc = bb_init_module(fn, options);
+               DBG("loaded %s '%s', rc:%d", fn, options, rc);
+               if (rc == EEXIST)
+                       rc = 0;
+               free(options);
+               if (rc) {
+                       bb_error_msg("can't load module %s (%s): %s",
+                               humanly_readable_name(m2),
+                               fn,
+                               moderror(rc)
+                       );
+                       break;
+               }
+               m2->flags |= MODULE_FLAG_LOADED;
        }
 
        return rc;
@@ -258,7 +434,7 @@ static void load_modules_dep(void)
        char *colon, *tokens[2];
        parser_t *p;
 
-       /* Modprobe does not work at all without modprobe.dep,
+       /* Modprobe does not work at all without modules.dep,
         * even if the full module name is given. Returning error here
         * was making us later confuse user with this message:
         * "module /full/path/to/existing/file/module.ko not found".
@@ -291,8 +467,9 @@ static void load_modules_dep(void)
                        G.num_unresolved_deps--;
                        llist_add_to(&m->deps, xstrdup(tokens[0]));
                        if (tokens[1])
-                               string_to_llist(tokens[1], &m->deps, " ");
-               }
+                               string_to_llist(tokens[1], &m->deps, " \t");
+               } else
+                       DBG("skipping dep line");
        }
        config_close(p);
 }
@@ -305,13 +482,43 @@ int modprobe_main(int argc UNUSED_PARAM, char **argv)
        unsigned opt;
        struct module_entry *me;
 
-       opt_complementary = "q-v:v-q";
-       opt = getopt32(argv, INSMOD_OPTS MODPROBE_OPTS INSMOD_ARGS, NULL, NULL);
+       opt_complementary = MODPROBE_COMPLEMENTARY;
+       opt = getopt32(argv, INSMOD_OPTS MODPROBE_OPTS INSMOD_ARGS);
        argv += optind;
 
-       if (opt & (MODPROBE_OPT_DUMP_ONLY | MODPROBE_OPT_LIST_ONLY |
-                               MODPROBE_OPT_SHOW_ONLY))
-               bb_error_msg_and_die("not supported");
+       /* Goto modules location */
+       xchdir(CONFIG_DEFAULT_MODULES_DIR);
+       uname(&uts);
+       xchdir(uts.release);
+
+       if (opt & MODPROBE_OPT_LIST_ONLY) {
+               char name[MODULE_NAME_LEN];
+               char *colon, *tokens[2];
+               parser_t *p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
+
+               while (config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)) {
+                       colon = last_char_is(tokens[0], ':');
+                       if (!colon)
+                               continue;
+                       *colon = '\0';
+                       filename2modname(tokens[0], name);
+                       if (!argv[0])
+                               puts(tokens[0]);
+                       else {
+                               int i;
+                               for (i = 0; argv[i]; i++) {
+                                       if (fnmatch(argv[i], name, 0) == 0) {
+                                               puts(tokens[0]);
+                                       }
+                               }
+                       }
+               }
+               return EXIT_SUCCESS;
+       }
+
+       /* Yes, for some reason -l ignores -s... */
+       if (opt & INSMOD_OPT_SYSLOG)
+               logmode = LOGMODE_SYSLOG;
 
        if (!argv[0]) {
                if (opt & MODPROBE_OPT_REMOVE) {
@@ -319,17 +526,12 @@ int modprobe_main(int argc UNUSED_PARAM, char **argv)
                         * "If name is NULL, all unused modules marked
                         * autoclean will be removed".
                         */
-                       if (bb_delete_module(NULL, O_NONBLOCK|O_EXCL) != 0)
+                       if (bb_delete_module(NULL, O_NONBLOCK | O_EXCL) != 0)
                                bb_perror_msg_and_die("rmmod");
                }
                return EXIT_SUCCESS;
        }
 
-       /* Goto modules location */
-       xchdir(CONFIG_DEFAULT_MODULES_DIR);
-       uname(&uts);
-       xchdir(uts.release);
-
        /* Retrieve module names of already loaded modules */
        {
                char *s;
@@ -339,13 +541,15 @@ int modprobe_main(int argc UNUSED_PARAM, char **argv)
                config_close(parser);
        }
 
-       if (opt & MODPROBE_OPT_INSERT_ALL) {
+       if (opt & (MODPROBE_OPT_INSERT_ALL | MODPROBE_OPT_REMOVE)) {
                /* Each argument is a module name */
                do {
+                       DBG("adding module %s", *argv);
                        add_probe(*argv++);
                } while (*argv);
        } else {
                /* First argument is module name, rest are parameters */
+               DBG("probing just module %s", *argv);
                add_probe(argv[0]);
                G.cmdline_mopts = parse_cmdline_module_options(argv);
        }
@@ -364,35 +568,40 @@ int modprobe_main(int argc UNUSED_PARAM, char **argv)
                load_modules_dep();
        }
 
+       rc = 0;
        while ((me = llist_pop(&G.probes)) != NULL) {
                if (me->realnames == NULL) {
+                       DBG("probing by module name");
                        /* This is not an alias. Literal names are blacklisted
                         * only if '-b' is given.
                         */
                        if (!(opt & MODPROBE_OPT_BLACKLIST)
                         || !(me->flags & MODULE_FLAG_BLACKLISTED)
                        ) {
-                               rc = do_modprobe(me);
-//FIXME: what if rc > 0?
-                               if (rc < 0 && !(opt & INSMOD_OPT_SILENT))
-                                       bb_error_msg("module %s not found",
-                                                    me->probed_name);
+                               rc |= do_modprobe(me);
                        }
-               } else {
-                       /* Probe all realnames */
-                       do {
-                               char *realname = llist_pop(&me->realnames);
-                               struct module_entry *m2;
-
-                               DBG("probing %s by realname %s", me->modname, realname);
-                               m2 = get_or_add_modentry(realname);
-                               if (!(m2->flags & MODULE_FLAG_BLACKLISTED))
-                                       do_modprobe(m2);
-//FIXME: error check?
-                               free(realname);
-                       } while (me->realnames != NULL);
+                       continue;
                }
+
+               /* Probe all real names for the alias */
+               do {
+                       char *realname = llist_pop(&me->realnames);
+                       struct module_entry *m2;
+
+                       DBG("probing alias %s by realname %s", me->modname, realname);
+                       m2 = get_or_add_modentry(realname);
+                       if (!(m2->flags & MODULE_FLAG_BLACKLISTED)
+                        && (!(m2->flags & MODULE_FLAG_LOADED)
+                           || (opt & MODPROBE_OPT_REMOVE))
+                       ) {
+//TODO: we can pass "me" as 2nd param to do_modprobe,
+//and make do_modprobe emit more meaningful error messages
+//with alias name included, not just module name alias resolves to.
+                               rc |= do_modprobe(m2);
+                       }
+                       free(realname);
+               } while (me->realnames != NULL);
        }
 
-       return EXIT_SUCCESS;
+       return (rc != 0);
 }