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"
92 //usage: " -a Load multiple MODULEs"
93 //usage: "\n -l List (MODULE is a pattern)"
94 //usage: "\n -r Remove MODULE (stacks) or do autoclean"
95 //usage: "\n -q Quiet"
96 //usage: "\n -v Verbose"
97 //usage: "\n -s Log to syslog"
98 //usage: "\n -D Show dependencies"
99 //usage: IF_FEATURE_MODPROBE_BLACKLIST(
100 //usage: "\n -b Apply blacklist to module names too"
102 //usage:#endif /* !ENABLE_MODPROBE_SMALL */
104 /* Note: usage text doesn't document various 2.4 options
105 * we pull in through INSMOD_OPTS define
106 * Note2: -b is always accepted, but if !FEATURE_MODPROBE_BLACKLIST,
109 #define MODPROBE_OPTS "alrDb"
110 /* -a and -D _are_ in fact compatible */
111 #define MODPROBE_COMPLEMENTARY ("q-v:v-q:l--arD:r--alD:a--lr:D--rl")
112 //#define MODPROBE_OPTS "acd:lnrt:C:b"
113 //#define MODPROBE_COMPLEMENTARY "q-v:v-q:l--acr:a--lr:r--al"
115 OPT_INSERT_ALL = (INSMOD_OPT_UNUSED << 0), /* a */
116 //OPT_DUMP_ONLY = (INSMOD_OPT_UNUSED << x), /* c */
117 //OPT_DIRNAME = (INSMOD_OPT_UNUSED << x), /* d */
118 OPT_LIST_ONLY = (INSMOD_OPT_UNUSED << 1), /* l */
119 //OPT_SHOW_ONLY = (INSMOD_OPT_UNUSED << x), /* n */
120 OPT_REMOVE = (INSMOD_OPT_UNUSED << 2), /* r */
121 //OPT_RESTRICT = (INSMOD_OPT_UNUSED << x), /* t */
122 //OPT_VERONLY = (INSMOD_OPT_UNUSED << x), /* V */
123 //OPT_CONFIGFILE = (INSMOD_OPT_UNUSED << x), /* C */
124 OPT_SHOW_DEPS = (INSMOD_OPT_UNUSED << 3), /* D */
125 OPT_BLACKLIST = (INSMOD_OPT_UNUSED << 4) * ENABLE_FEATURE_MODPROBE_BLACKLIST,
128 static const char modprobe_longopts[] ALIGN1 =
129 /* nobody asked for long opts (yet) */
130 // "all\0" No_argument "a"
131 // "list\0" No_argument "l"
132 // "remove\0" No_argument "r"
133 // "quiet\0" No_argument "q"
134 // "verbose\0" No_argument "v"
135 // "syslog\0" No_argument "s"
136 /* module-init-tools 3.11.1 has only long opt --show-depends
137 * but no short -D, we provide long opt for scripts which
138 * were written for 3.11.1: */
139 "show-depends\0" No_argument "D"
140 // "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 */
161 #define DB_HASH_SIZE 256
164 llist_t *probes; /* MEs of module(s) requested on cmdline */
165 char *cmdline_mopts; /* module options from cmdline */
166 int num_unresolved_deps;
167 /* bool. "Did we have 'symbol:FOO' requested on cmdline?" */
168 smallint need_symbols;
170 llist_t *db[DB_HASH_SIZE]; /* MEs of all modules ever seen (caching for speed) */
172 #define G (*ptr_to_globals)
173 #define INIT_G() do { \
174 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
178 static int read_config(const char *path);
180 static char *gather_options_str(char *opts, const char *append)
182 /* Speed-optimized. We call gather_options_str many times. */
185 opts = xstrdup(append);
187 int optlen = strlen(opts);
188 opts = xrealloc(opts, optlen + strlen(append) + 2);
189 sprintf(opts + optlen, " %s", append);
195 /* These three functions called many times, optimizing for speed.
196 * Users reported minute-long delays when they runn iptables repeatedly
197 * (iptables use modprobe to install needed kernel modules).
199 static struct module_entry *helper_get_module(const char *module, int create)
201 char modname[MODULE_NAME_LEN];
202 struct module_entry *e;
207 filename2modname(module, modname);
210 for (i = 0; modname[i]; i++)
211 hash = ((hash << 5) + hash) + modname[i];
212 hash %= DB_HASH_SIZE;
214 for (l = G.db[hash]; l; l = l->link) {
215 e = (struct module_entry *) l->data;
216 if (strcmp(e->modname, modname) == 0)
222 e = xzalloc(sizeof(*e));
223 e->modname = xstrdup(modname);
224 llist_add_to(&G.db[hash], e);
228 static ALWAYS_INLINE struct module_entry *get_or_add_modentry(const char *module)
230 return helper_get_module(module, 1);
232 static ALWAYS_INLINE struct module_entry *get_modentry(const char *module)
234 return helper_get_module(module, 0);
237 static void add_probe(const char *name)
239 struct module_entry *m;
242 * get_or_add_modentry() strips path from name and works
243 * on remaining basename.
244 * This would make "rmmod dir/name" and "modprobe dir/name"
245 * to work like "rmmod name" and "modprobe name",
246 * which is wrong, and can be abused via implicit modprobing:
247 * "ifconfig /usbserial up" tries to modprobe netdev-/usbserial.
249 if (strchr(name, '/'))
250 bb_error_msg_and_die("malformed module name '%s'", name);
252 m = get_or_add_modentry(name);
253 if (!(option_mask32 & (OPT_REMOVE | OPT_SHOW_DEPS))
254 && (m->flags & MODULE_FLAG_LOADED)
256 DBG("skipping %s, it is already loaded", name);
260 DBG("queuing %s", name);
261 m->probed_name = name;
262 m->flags |= MODULE_FLAG_NEED_DEPS;
263 llist_add_to_end(&G.probes, m);
264 G.num_unresolved_deps++;
265 if (ENABLE_FEATURE_MODUTILS_SYMBOLS
266 && strncmp(m->modname, "symbol:", 7) == 0
272 static int FAST_FUNC config_file_action(const char *filename,
273 struct stat *statbuf UNUSED_PARAM,
274 void *userdata UNUSED_PARAM,
275 int depth UNUSED_PARAM)
279 struct module_entry *m;
282 if (bb_basename(filename)[0] == '.')
285 p = config_open2(filename, fopen_for_read);
291 while (config_read(p, tokens, 3, 2, "# \t", PARSE_NORMAL)) {
292 //Use index_in_strings?
293 if (strcmp(tokens[0], "alias") == 0) {
294 /* alias <wildcard> <modulename> */
296 char wildcard[MODULE_NAME_LEN];
299 if (tokens[2] == NULL)
301 filename2modname(tokens[1], wildcard);
303 for (l = G.probes; l; l = l->link) {
304 m = (struct module_entry *) l->data;
305 if (fnmatch(wildcard, m->modname, 0) != 0)
307 rmod = filename2modname(tokens[2], NULL);
308 llist_add_to(&m->realnames, rmod);
310 if (m->flags & MODULE_FLAG_NEED_DEPS) {
311 m->flags &= ~MODULE_FLAG_NEED_DEPS;
312 G.num_unresolved_deps--;
315 m = get_or_add_modentry(rmod);
316 if (!(m->flags & MODULE_FLAG_NEED_DEPS)) {
317 m->flags |= MODULE_FLAG_NEED_DEPS;
318 G.num_unresolved_deps++;
321 } else if (strcmp(tokens[0], "options") == 0) {
322 /* options <modulename> <option...> */
323 if (tokens[2] == NULL)
325 m = get_or_add_modentry(tokens[1]);
326 m->options = gather_options_str(m->options, tokens[2]);
327 } else if (strcmp(tokens[0], "include") == 0) {
328 /* include <filename> */
329 read_config(tokens[1]);
330 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST
331 && strcmp(tokens[0], "blacklist") == 0
333 /* blacklist <modulename> */
334 get_or_add_modentry(tokens[1])->flags |= MODULE_FLAG_BLACKLISTED;
342 static int read_config(const char *path)
344 return recursive_action(path, ACTION_RECURSE | ACTION_QUIET,
345 config_file_action, NULL, NULL, 1);
348 static const char *humanly_readable_name(struct module_entry *m)
350 /* probed_name may be NULL. modname always exists. */
351 return m->probed_name ? m->probed_name : m->modname;
354 static char *parse_and_add_kcmdline_module_options(char *options, const char *modulename)
361 kcmdline_buf = xmalloc_open_read_close("/proc/cmdline", NULL);
365 kcmdline = kcmdline_buf;
366 len = strlen(modulename);
367 while ((kptr = strsep(&kcmdline, "\n\t ")) != NULL) {
368 if (strncmp(modulename, kptr, len) != 0)
373 /* It is "modulename.xxxx" */
375 if (strchr(kptr, '=') != NULL) {
376 /* It is "modulename.opt=[val]" */
377 options = gather_options_str(options, kptr);
385 /* Return: similar to bb_init_module:
387 * -errno on open/read error,
388 * errno on init_module() error
390 /* NB: INSMOD_OPT_SILENT bit suppresses ONLY non-existent modules,
391 * not deleted ones (those are still listed in modules.dep).
392 * module-init-tools version 3.4:
394 * FATAL: Module bogus not found. [exitcode 1]
395 * # modprobe -q bogus [silent, exitcode still 1]
397 * # rm kernel/drivers/net/dummy.ko
398 * # modprobe -q dummy
399 * FATAL: Could not open '/lib/modules/xxx/kernel/drivers/net/dummy.ko': No such file or directory
402 static int do_modprobe(struct module_entry *m)
406 if (!(m->flags & MODULE_FLAG_FOUND_IN_MODDEP)) {
407 if (!(option_mask32 & INSMOD_OPT_SILENT))
408 bb_error_msg("module %s not found in modules.dep",
409 humanly_readable_name(m));
412 DBG("do_modprob'ing %s", m->modname);
414 if (!(option_mask32 & OPT_REMOVE))
415 m->deps = llist_rev(m->deps);
419 for (l = m->deps; l; l = l->link)
420 DBG("dep: %s", l->data);
426 struct module_entry *m2;
430 fn = llist_pop(&m->deps); /* we leak it */
431 m2 = get_or_add_modentry(fn);
433 if (option_mask32 & OPT_REMOVE) {
435 if (m2->flags & MODULE_FLAG_LOADED) {
436 rc = bb_delete_module(m2->modname, O_EXCL);
439 bb_error_msg("can't unload module %s: %s",
440 humanly_readable_name(m2),
445 m2->flags &= ~MODULE_FLAG_LOADED;
448 /* do not error out if *deps* fail to unload */
453 options = m2->options;
455 options = parse_and_add_kcmdline_module_options(options, m2->modname);
457 options = gather_options_str(options, G.cmdline_mopts);
459 if (option_mask32 & OPT_SHOW_DEPS) {
460 printf(options ? "insmod %s/%s/%s %s\n"
461 : "insmod %s/%s/%s\n",
462 CONFIG_DEFAULT_MODULES_DIR, G.uts.release, fn,
468 if (m2->flags & MODULE_FLAG_LOADED) {
469 DBG("%s is already loaded, skipping", fn);
474 rc = bb_init_module(fn, options);
475 DBG("loaded %s '%s', rc:%d", fn, options, rc);
480 bb_error_msg("can't load module %s (%s): %s",
481 humanly_readable_name(m2),
487 m2->flags |= MODULE_FLAG_LOADED;
493 static void load_modules_dep(void)
495 struct module_entry *m;
496 char *colon, *tokens[2];
499 /* Modprobe does not work at all without modules.dep,
500 * even if the full module name is given. Returning error here
501 * was making us later confuse user with this message:
502 * "module /full/path/to/existing/file/module.ko not found".
503 * It's better to die immediately, with good message.
504 * xfopen_for_read provides that. */
505 p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
507 while (G.num_unresolved_deps
508 && config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)
510 colon = last_char_is(tokens[0], ':');
515 m = get_modentry(tokens[0]);
519 /* Optimization... */
520 if ((m->flags & MODULE_FLAG_LOADED)
521 && !(option_mask32 & (OPT_REMOVE | OPT_SHOW_DEPS))
523 DBG("skip deps of %s, it's already loaded", tokens[0]);
527 m->flags |= MODULE_FLAG_FOUND_IN_MODDEP;
528 if ((m->flags & MODULE_FLAG_NEED_DEPS) && (m->deps == NULL)) {
529 G.num_unresolved_deps--;
530 llist_add_to(&m->deps, xstrdup(tokens[0]));
532 string_to_llist(tokens[1], &m->deps, " \t");
534 DBG("skipping dep line");
539 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
540 int modprobe_main(int argc UNUSED_PARAM, char **argv)
544 struct module_entry *me;
548 IF_LONG_OPTS(applet_long_options = modprobe_longopts;)
549 opt_complementary = MODPROBE_COMPLEMENTARY;
550 opt = getopt32(argv, INSMOD_OPTS MODPROBE_OPTS INSMOD_ARGS);
553 /* Goto modules location */
554 xchdir(CONFIG_DEFAULT_MODULES_DIR);
556 xchdir(G.uts.release);
558 if (opt & OPT_LIST_ONLY) {
560 char name[MODULE_NAME_LEN];
561 char *colon, *tokens[2];
562 parser_t *p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
564 for (i = 0; argv[i]; i++)
565 replace(argv[i], '-', '_');
567 while (config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)) {
568 colon = last_char_is(tokens[0], ':');
572 filename2modname(tokens[0], name);
576 for (i = 0; argv[i]; i++) {
577 if (fnmatch(argv[i], name, 0) == 0) {
586 /* Yes, for some reason -l ignores -s... */
587 if (opt & INSMOD_OPT_SYSLOG)
588 logmode = LOGMODE_SYSLOG;
591 if (opt & OPT_REMOVE) {
592 /* "modprobe -r" (w/o params).
593 * "If name is NULL, all unused modules marked
594 * autoclean will be removed".
596 if (bb_delete_module(NULL, O_NONBLOCK | O_EXCL) != 0)
597 bb_perror_msg_and_die("rmmod");
602 /* Retrieve module names of already loaded modules */
605 parser_t *parser = config_open2("/proc/modules", fopen_for_read);
606 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY))
607 get_or_add_modentry(s)->flags |= MODULE_FLAG_LOADED;
608 config_close(parser);
611 if (opt & (OPT_INSERT_ALL | OPT_REMOVE)) {
612 /* Each argument is a module name */
614 DBG("adding module %s", *argv);
618 /* First argument is module name, rest are parameters */
619 DBG("probing just module %s", *argv);
621 G.cmdline_mopts = parse_cmdline_module_options(argv, /*quote_spaces:*/ 1);
624 /* Happens if all requested modules are already loaded */
625 if (G.probes == NULL)
628 read_config("/etc/modprobe.conf");
629 read_config("/etc/modprobe.d");
630 if (ENABLE_FEATURE_MODUTILS_SYMBOLS && G.need_symbols)
631 read_config("modules.symbols");
633 if (ENABLE_FEATURE_MODUTILS_ALIAS && G.num_unresolved_deps) {
634 read_config("modules.alias");
639 while ((me = llist_pop(&G.probes)) != NULL) {
640 if (me->realnames == NULL) {
641 DBG("probing by module name");
642 /* This is not an alias. Literal names are blacklisted
643 * only if '-b' is given.
645 if (!(opt & OPT_BLACKLIST)
646 || !(me->flags & MODULE_FLAG_BLACKLISTED)
648 rc |= do_modprobe(me);
653 /* Probe all real names for the alias */
655 char *realname = llist_pop(&me->realnames);
656 struct module_entry *m2;
658 DBG("probing alias %s by realname %s", me->modname, realname);
659 m2 = get_or_add_modentry(realname);
660 if (!(m2->flags & MODULE_FLAG_BLACKLISTED)
661 && (!(m2->flags & MODULE_FLAG_LOADED)
662 || (opt & (OPT_REMOVE | OPT_SHOW_DEPS)))
664 //TODO: we can pass "me" as 2nd param to do_modprobe,
665 //and make do_modprobe emit more meaningful error messages
666 //with alias name included, not just module name alias resolves to.
667 rc |= do_modprobe(m2);
670 } while (me->realnames != NULL);