1 /* vi: set sw=4 ts=4: */
3 * Modprobe written from scratch for BusyBox
5 * Copyright (c) 2008 Timo Teras <timo.teras@iki.fi>
6 * Copyright (c) 2008 Vladimir Dronnikov
8 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
11 //applet:IF_MODPROBE(APPLET(modprobe, _BB_DIR_SBIN, _BB_SUID_DROP))
15 #include <sys/utsname.h>
18 //#define DBG(fmt, ...) bb_error_msg("%s: " fmt, __func__, ## __VA_ARGS__)
19 #define DBG(...) ((void)0)
21 /* Note that unlike older versions of modules.dep/depmod (busybox and m-i-t),
22 * we expect the full dependency list to be specified in modules.dep.
23 * Older versions would only export the direct dependency list.
27 //usage:#if !ENABLE_MODPROBE_SMALL
28 //usage:#define modprobe_notes_usage
29 //usage: "modprobe can (un)load a stack of modules, passing each module options (when\n"
30 //usage: "loading). modprobe uses a configuration file to determine what option(s) to\n"
31 //usage: "pass each module it loads.\n"
33 //usage: "The configuration file is searched (in this order):\n"
35 //usage: " /etc/modprobe.conf (2.6 only)\n"
36 //usage: " /etc/modules.conf\n"
37 //usage: " /etc/conf.modules (deprecated)\n"
39 //usage: "They all have the same syntax (see below). If none is present, it is\n"
40 //usage: "_not_ an error; each loaded module is then expected to load without\n"
41 //usage: "options. Once a file is found, the others are tested for.\n"
43 //usage: "/etc/modules.conf entry format:\n"
45 //usage: " alias <alias_name> <mod_name>\n"
46 //usage: " Makes it possible to modprobe alias_name, when there is no such module.\n"
47 //usage: " It makes sense if your mod_name is long, or you want a more representative\n"
48 //usage: " name for that module (eg. 'scsi' in place of 'aha7xxx').\n"
49 //usage: " This makes it also possible to use a different set of options (below) for\n"
50 //usage: " the module and the alias.\n"
51 //usage: " A module can be aliased more than once.\n"
53 //usage: " options <mod_name|alias_name> <symbol=value...>\n"
54 //usage: " When loading module mod_name (or the module aliased by alias_name), pass\n"
55 //usage: " the \"symbol=value\" pairs as option to that module.\n"
57 //usage: "Sample /etc/modules.conf file:\n"
59 //usage: " options tulip irq=3\n"
60 //usage: " alias tulip tulip2\n"
61 //usage: " options tulip2 irq=4 io=0x308\n"
63 //usage: "Other functionality offered by 'classic' modprobe is not available in\n"
64 //usage: "this implementation.\n"
66 //usage: "If module options are present both in the config file, and on the command line,\n"
67 //usage: "then the options from the command line will be passed to the module _after_\n"
68 //usage: "the options from the config file. That way, you can have defaults in the config\n"
69 //usage: "file, and override them for a specific usage from the command line.\n"
70 //usage:#define modprobe_example_usage
71 //usage: "(with the above /etc/modules.conf):\n\n"
72 //usage: "$ modprobe tulip\n"
73 //usage: " will load the module 'tulip' with default option 'irq=3'\n\n"
74 //usage: "$ modprobe tulip irq=5\n"
75 //usage: " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n"
76 //usage: "$ modprobe tulip2\n"
77 //usage: " will load the module 'tulip' with default options 'irq=4 io=0x308',\n"
78 //usage: " which are the default for alias 'tulip2'\n\n"
79 //usage: "$ modprobe tulip2 irq=8\n"
80 //usage: " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n"
81 //usage: " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n"
82 //usage: " from the command line\n\n"
83 //usage: "$ modprobe tulip2 irq=2 io=0x210\n"
84 //usage: " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n"
85 //usage: " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n"
86 //usage: " from the command line\n"
88 //usage:#define modprobe_trivial_usage
89 //usage: "[-alrqvsD" IF_FEATURE_MODPROBE_BLACKLIST("b") "]"
90 //usage: " MODULE [symbol=value]..."
91 //usage:#define modprobe_full_usage "\n\n"
93 //usage: "\n -a Load multiple MODULEs"
94 //usage: "\n -l List (MODULE is a pattern)"
95 //usage: "\n -r Remove MODULE (stacks) or do autoclean"
96 //usage: "\n -q Quiet"
97 //usage: "\n -v Verbose"
98 //usage: "\n -s Log to syslog"
99 //usage: "\n -D Show dependencies"
100 //usage: IF_FEATURE_MODPROBE_BLACKLIST(
101 //usage: "\n -b Apply blacklist to module names too"
103 //usage:#endif /* !ENABLE_MODPROBE_SMALL */
105 /* Note that usage text doesn't document various 2.4 options
106 * we pull in through INSMOD_OPTS define */
107 #define MODPROBE_OPTS "alrD" IF_FEATURE_MODPROBE_BLACKLIST("b")
108 /* -a and -D _are_ in fact compatible */
109 #define MODPROBE_COMPLEMENTARY ("q-v:v-q:l--arD:r--alD:a--lr:D--rl")
110 //#define MODPROBE_OPTS "acd:lnrt:C:" IF_FEATURE_MODPROBE_BLACKLIST("b")
111 //#define MODPROBE_COMPLEMENTARY "q-v:v-q:l--acr:a--lr:r--al"
113 OPT_INSERT_ALL = (INSMOD_OPT_UNUSED << 0), /* a */
114 //OPT_DUMP_ONLY = (INSMOD_OPT_UNUSED << x), /* c */
115 //OPT_DIRNAME = (INSMOD_OPT_UNUSED << x), /* d */
116 OPT_LIST_ONLY = (INSMOD_OPT_UNUSED << 1), /* l */
117 //OPT_SHOW_ONLY = (INSMOD_OPT_UNUSED << x), /* n */
118 OPT_REMOVE = (INSMOD_OPT_UNUSED << 2), /* r */
119 //OPT_RESTRICT = (INSMOD_OPT_UNUSED << x), /* t */
120 //OPT_VERONLY = (INSMOD_OPT_UNUSED << x), /* V */
121 //OPT_CONFIGFILE = (INSMOD_OPT_UNUSED << x), /* C */
122 OPT_SHOW_DEPS = (INSMOD_OPT_UNUSED << 3), /* D */
123 OPT_BLACKLIST = (INSMOD_OPT_UNUSED << 4) * ENABLE_FEATURE_MODPROBE_BLACKLIST,
126 static const char modprobe_longopts[] ALIGN1 =
127 /* nobody asked for long opts (yet) */
128 // "all\0" No_argument "a"
129 // "list\0" No_argument "l"
130 // "remove\0" No_argument "r"
131 // "quiet\0" No_argument "q"
132 // "verbose\0" No_argument "v"
133 // "syslog\0" No_argument "s"
134 /* module-init-tools 3.11.1 has only long opt --show-depends
135 * but no short -D, we provide long opt for scripts which
136 * were written for 3.11.1: */
137 "show-depends\0" No_argument "D"
138 // IF_FEATURE_MODPROBE_BLACKLIST(
139 // "use-blacklist\0" No_argument "b"
144 #define MODULE_FLAG_LOADED 0x0001
145 #define MODULE_FLAG_NEED_DEPS 0x0002
146 /* "was seen in modules.dep": */
147 #define MODULE_FLAG_FOUND_IN_MODDEP 0x0004
148 #define MODULE_FLAG_BLACKLISTED 0x0008
150 struct module_entry { /* I'll call it ME. */
152 char *modname; /* stripped of /path/, .ext and s/-/_/g */
153 const char *probed_name; /* verbatim as seen on cmdline */
154 char *options; /* options from config files */
155 llist_t *realnames; /* strings. if this module is an alias, */
156 /* real module name is one of these. */
157 //Can there really be more than one? Example from real kernel?
158 llist_t *deps; /* strings. modules we depend on */
162 llist_t *db; /* MEs of all modules ever seen (caching for speed) */
163 llist_t *probes; /* MEs of module(s) requested on cmdline */
164 char *cmdline_mopts; /* module options from cmdline */
165 int num_unresolved_deps;
166 /* bool. "Did we have 'symbol:FOO' requested on cmdline?" */
167 smallint need_symbols;
170 #define G (*(struct globals*)&bb_common_bufsiz1)
171 #define INIT_G() do { } while (0)
172 struct BUG_G_too_big {
173 char BUG_G_too_big[sizeof(G) <= COMMON_BUFSIZE ? 1 : -1];
177 static int read_config(const char *path);
179 static char *gather_options_str(char *opts, const char *append)
181 /* Speed-optimized. We call gather_options_str many times. */
184 opts = xstrdup(append);
186 int optlen = strlen(opts);
187 opts = xrealloc(opts, optlen + strlen(append) + 2);
188 sprintf(opts + optlen, " %s", append);
194 static struct module_entry *helper_get_module(const char *module, int create)
196 char modname[MODULE_NAME_LEN];
197 struct module_entry *e;
200 filename2modname(module, modname);
201 for (l = G.db; l != NULL; l = l->link) {
202 e = (struct module_entry *) l->data;
203 if (strcmp(e->modname, modname) == 0)
209 e = xzalloc(sizeof(*e));
210 e->modname = xstrdup(modname);
211 llist_add_to(&G.db, e);
215 static struct module_entry *get_or_add_modentry(const char *module)
217 return helper_get_module(module, 1);
219 static struct module_entry *get_modentry(const char *module)
221 return helper_get_module(module, 0);
224 static void add_probe(const char *name)
226 struct module_entry *m;
228 m = get_or_add_modentry(name);
229 if (!(option_mask32 & (OPT_REMOVE | OPT_SHOW_DEPS))
230 && (m->flags & MODULE_FLAG_LOADED)
232 DBG("skipping %s, it is already loaded", name);
236 DBG("queuing %s", name);
237 m->probed_name = name;
238 m->flags |= MODULE_FLAG_NEED_DEPS;
239 llist_add_to_end(&G.probes, m);
240 G.num_unresolved_deps++;
241 if (ENABLE_FEATURE_MODUTILS_SYMBOLS
242 && strncmp(m->modname, "symbol:", 7) == 0
248 static int FAST_FUNC config_file_action(const char *filename,
249 struct stat *statbuf UNUSED_PARAM,
250 void *userdata UNUSED_PARAM,
251 int depth UNUSED_PARAM)
255 struct module_entry *m;
258 if (bb_basename(filename)[0] == '.')
261 p = config_open2(filename, fopen_for_read);
267 while (config_read(p, tokens, 3, 2, "# \t", PARSE_NORMAL)) {
268 //Use index_in_strings?
269 if (strcmp(tokens[0], "alias") == 0) {
270 /* alias <wildcard> <modulename> */
272 char wildcard[MODULE_NAME_LEN];
275 if (tokens[2] == NULL)
277 filename2modname(tokens[1], wildcard);
279 for (l = G.probes; l != NULL; l = l->link) {
280 m = (struct module_entry *) l->data;
281 if (fnmatch(wildcard, m->modname, 0) != 0)
283 rmod = filename2modname(tokens[2], NULL);
284 llist_add_to(&m->realnames, rmod);
286 if (m->flags & MODULE_FLAG_NEED_DEPS) {
287 m->flags &= ~MODULE_FLAG_NEED_DEPS;
288 G.num_unresolved_deps--;
291 m = get_or_add_modentry(rmod);
292 if (!(m->flags & MODULE_FLAG_NEED_DEPS)) {
293 m->flags |= MODULE_FLAG_NEED_DEPS;
294 G.num_unresolved_deps++;
297 } else if (strcmp(tokens[0], "options") == 0) {
298 /* options <modulename> <option...> */
299 if (tokens[2] == NULL)
301 m = get_or_add_modentry(tokens[1]);
302 m->options = gather_options_str(m->options, tokens[2]);
303 } else if (strcmp(tokens[0], "include") == 0) {
304 /* include <filename> */
305 read_config(tokens[1]);
306 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST
307 && strcmp(tokens[0], "blacklist") == 0
309 /* blacklist <modulename> */
310 get_or_add_modentry(tokens[1])->flags |= MODULE_FLAG_BLACKLISTED;
318 static int read_config(const char *path)
320 return recursive_action(path, ACTION_RECURSE | ACTION_QUIET,
321 config_file_action, NULL, NULL, 1);
324 static const char *humanly_readable_name(struct module_entry *m)
326 /* probed_name may be NULL. modname always exists. */
327 return m->probed_name ? m->probed_name : m->modname;
330 static char *parse_and_add_kcmdline_module_options(char *options, const char *modulename)
337 kcmdline_buf = xmalloc_open_read_close("/proc/cmdline", NULL);
341 kcmdline = kcmdline_buf;
342 len = strlen(modulename);
343 while ((kptr = strsep(&kcmdline, "\n\t ")) != NULL) {
344 if (strncmp(modulename, kptr, len) != 0)
349 /* It is "modulename.xxxx" */
351 if (strchr(kptr, '=') != NULL) {
352 /* It is "modulename.opt=[val]" */
353 options = gather_options_str(options, kptr);
361 /* Return: similar to bb_init_module:
363 * -errno on open/read error,
364 * errno on init_module() error
366 /* NB: INSMOD_OPT_SILENT bit suppresses ONLY non-existent modules,
367 * not deleted ones (those are still listed in modules.dep).
368 * module-init-tools version 3.4:
370 * FATAL: Module bogus not found. [exitcode 1]
371 * # modprobe -q bogus [silent, exitcode still 1]
373 * # rm kernel/drivers/net/dummy.ko
374 * # modprobe -q dummy
375 * FATAL: Could not open '/lib/modules/xxx/kernel/drivers/net/dummy.ko': No such file or directory
378 static int do_modprobe(struct module_entry *m)
383 if (!(m->flags & MODULE_FLAG_FOUND_IN_MODDEP)) {
384 if (!(option_mask32 & INSMOD_OPT_SILENT))
385 bb_error_msg("module %s not found in modules.dep",
386 humanly_readable_name(m));
389 DBG("do_modprob'ing %s", m->modname);
391 if (!(option_mask32 & OPT_REMOVE))
392 m->deps = llist_rev(m->deps);
394 for (l = m->deps; l != NULL; l = l->link)
395 DBG("dep: %s", l->data);
400 struct module_entry *m2;
404 fn = llist_pop(&m->deps); /* we leak it */
405 m2 = get_or_add_modentry(fn);
407 if (option_mask32 & OPT_REMOVE) {
409 if (m2->flags & MODULE_FLAG_LOADED) {
410 rc = bb_delete_module(m2->modname, O_EXCL);
413 bb_error_msg("can't unload module %s: %s",
414 humanly_readable_name(m2),
419 m2->flags &= ~MODULE_FLAG_LOADED;
422 /* do not error out if *deps* fail to unload */
427 options = m2->options;
429 options = parse_and_add_kcmdline_module_options(options, m2->modname);
431 options = gather_options_str(options, G.cmdline_mopts);
433 if (option_mask32 & OPT_SHOW_DEPS) {
434 printf(options ? "insmod %s/%s/%s %s\n"
435 : "insmod %s/%s/%s\n",
436 CONFIG_DEFAULT_MODULES_DIR, G.uts.release, fn,
442 if (m2->flags & MODULE_FLAG_LOADED) {
443 DBG("%s is already loaded, skipping", fn);
448 rc = bb_init_module(fn, options);
449 DBG("loaded %s '%s', rc:%d", fn, options, rc);
454 bb_error_msg("can't load module %s (%s): %s",
455 humanly_readable_name(m2),
461 m2->flags |= MODULE_FLAG_LOADED;
467 static void load_modules_dep(void)
469 struct module_entry *m;
470 char *colon, *tokens[2];
473 /* Modprobe does not work at all without modules.dep,
474 * even if the full module name is given. Returning error here
475 * was making us later confuse user with this message:
476 * "module /full/path/to/existing/file/module.ko not found".
477 * It's better to die immediately, with good message.
478 * xfopen_for_read provides that. */
479 p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
481 while (G.num_unresolved_deps
482 && config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)
484 colon = last_char_is(tokens[0], ':');
489 m = get_modentry(tokens[0]);
493 /* Optimization... */
494 if ((m->flags & MODULE_FLAG_LOADED)
495 && !(option_mask32 & (OPT_REMOVE | OPT_SHOW_DEPS))
497 DBG("skip deps of %s, it's already loaded", tokens[0]);
501 m->flags |= MODULE_FLAG_FOUND_IN_MODDEP;
502 if ((m->flags & MODULE_FLAG_NEED_DEPS) && (m->deps == NULL)) {
503 G.num_unresolved_deps--;
504 llist_add_to(&m->deps, xstrdup(tokens[0]));
506 string_to_llist(tokens[1], &m->deps, " \t");
508 DBG("skipping dep line");
513 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
514 int modprobe_main(int argc UNUSED_PARAM, char **argv)
518 struct module_entry *me;
522 IF_LONG_OPTS(applet_long_options = modprobe_longopts;)
523 opt_complementary = MODPROBE_COMPLEMENTARY;
524 opt = getopt32(argv, INSMOD_OPTS MODPROBE_OPTS INSMOD_ARGS);
527 /* Goto modules location */
528 xchdir(CONFIG_DEFAULT_MODULES_DIR);
530 xchdir(G.uts.release);
532 if (opt & OPT_LIST_ONLY) {
533 char name[MODULE_NAME_LEN];
534 char *colon, *tokens[2];
535 parser_t *p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
537 while (config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)) {
538 colon = last_char_is(tokens[0], ':');
542 filename2modname(tokens[0], name);
547 for (i = 0; argv[i]; i++) {
548 if (fnmatch(argv[i], name, 0) == 0) {
557 /* Yes, for some reason -l ignores -s... */
558 if (opt & INSMOD_OPT_SYSLOG)
559 logmode = LOGMODE_SYSLOG;
562 if (opt & OPT_REMOVE) {
563 /* "modprobe -r" (w/o params).
564 * "If name is NULL, all unused modules marked
565 * autoclean will be removed".
567 if (bb_delete_module(NULL, O_NONBLOCK | O_EXCL) != 0)
568 bb_perror_msg_and_die("rmmod");
573 /* Retrieve module names of already loaded modules */
576 parser_t *parser = config_open2("/proc/modules", fopen_for_read);
577 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY))
578 get_or_add_modentry(s)->flags |= MODULE_FLAG_LOADED;
579 config_close(parser);
582 if (opt & (OPT_INSERT_ALL | OPT_REMOVE)) {
583 /* Each argument is a module name */
585 DBG("adding module %s", *argv);
589 /* First argument is module name, rest are parameters */
590 DBG("probing just module %s", *argv);
592 G.cmdline_mopts = parse_cmdline_module_options(argv);
595 /* Happens if all requested modules are already loaded */
596 if (G.probes == NULL)
599 read_config("/etc/modprobe.conf");
600 read_config("/etc/modprobe.d");
601 if (ENABLE_FEATURE_MODUTILS_SYMBOLS && G.need_symbols)
602 read_config("modules.symbols");
604 if (ENABLE_FEATURE_MODUTILS_ALIAS && G.num_unresolved_deps) {
605 read_config("modules.alias");
610 while ((me = llist_pop(&G.probes)) != NULL) {
611 if (me->realnames == NULL) {
612 DBG("probing by module name");
613 /* This is not an alias. Literal names are blacklisted
614 * only if '-b' is given.
616 if (!(opt & OPT_BLACKLIST)
617 || !(me->flags & MODULE_FLAG_BLACKLISTED)
619 rc |= do_modprobe(me);
624 /* Probe all real names for the alias */
626 char *realname = llist_pop(&me->realnames);
627 struct module_entry *m2;
629 DBG("probing alias %s by realname %s", me->modname, realname);
630 m2 = get_or_add_modentry(realname);
631 if (!(m2->flags & MODULE_FLAG_BLACKLISTED)
632 && (!(m2->flags & MODULE_FLAG_LOADED)
633 || (opt & (OPT_REMOVE | OPT_SHOW_DEPS)))
635 //TODO: we can pass "me" as 2nd param to do_modprobe,
636 //and make do_modprobe emit more meaningful error messages
637 //with alias name included, not just module name alias resolves to.
638 rc |= do_modprobe(m2);
641 } while (me->realnames != NULL);