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.
10 //config:config MODPROBE
11 //config: bool "modprobe (29 kb)"
13 //config: select PLATFORM_LINUX
15 //config: Handle the loading of modules, and their dependencies on a high
18 //config:config FEATURE_MODPROBE_BLACKLIST
19 //config: bool "Blacklist support"
21 //config: depends on MODPROBE && !MODPROBE_SMALL
23 //config: Say 'y' here to enable support for the 'blacklist' command in
24 //config: modprobe.conf. This prevents the alias resolver to resolve
25 //config: blacklisted modules. This is useful if you want to prevent your
26 //config: hardware autodetection scripts to load modules like evdev, frame
27 //config: buffer drivers etc.
29 //applet:IF_MODPROBE(IF_NOT_MODPROBE_SMALL(APPLET_NOEXEC(modprobe, modprobe, BB_DIR_SBIN, BB_SUID_DROP, modprobe)))
31 //kbuild:ifneq ($(CONFIG_MODPROBE_SMALL),y)
32 //kbuild:lib-$(CONFIG_MODPROBE) += modprobe.o modutils.o
37 #include <sys/utsname.h>
41 #define DBG(...) ((void)0)
43 #define DBG(fmt, ...) bb_error_msg("%s: " fmt, __func__, ## __VA_ARGS__)
46 /* Note that unlike older versions of modules.dep/depmod (busybox and m-i-t),
47 * we expect the full dependency list to be specified in modules.dep.
48 * Older versions would only export the direct dependency list.
52 //usage:#if !ENABLE_MODPROBE_SMALL
53 //usage:#define modprobe_notes_usage
54 //usage: "modprobe can (un)load a stack of modules, passing each module options (when\n"
55 //usage: "loading). modprobe uses a configuration file to determine what option(s) to\n"
56 //usage: "pass each module it loads.\n"
58 //usage: "The configuration file is searched (in this order):\n"
60 //usage: " /etc/modprobe.conf (2.6 only)\n"
61 //usage: " /etc/modules.conf\n"
62 //usage: " /etc/conf.modules (deprecated)\n"
64 //usage: "They all have the same syntax (see below). If none is present, it is\n"
65 //usage: "_not_ an error; each loaded module is then expected to load without\n"
66 //usage: "options. Once a file is found, the others are tested for.\n"
68 //usage: "/etc/modules.conf entry format:\n"
70 //usage: " alias <alias_name> <mod_name>\n"
71 //usage: " Makes it possible to modprobe alias_name, when there is no such module.\n"
72 //usage: " It makes sense if your mod_name is long, or you want a more representative\n"
73 //usage: " name for that module (eg. 'scsi' in place of 'aha7xxx').\n"
74 //usage: " This makes it also possible to use a different set of options (below) for\n"
75 //usage: " the module and the alias.\n"
76 //usage: " A module can be aliased more than once.\n"
78 //usage: " options <mod_name|alias_name> <symbol=value...>\n"
79 //usage: " When loading module mod_name (or the module aliased by alias_name), pass\n"
80 //usage: " the \"symbol=value\" pairs as option to that module.\n"
82 //usage: "Sample /etc/modules.conf file:\n"
84 //usage: " options tulip irq=3\n"
85 //usage: " alias tulip tulip2\n"
86 //usage: " options tulip2 irq=4 io=0x308\n"
88 //usage: "Other functionality offered by 'classic' modprobe is not available in\n"
89 //usage: "this implementation.\n"
91 //usage: "If module options are present both in the config file, and on the command line,\n"
92 //usage: "then the options from the command line will be passed to the module _after_\n"
93 //usage: "the options from the config file. That way, you can have defaults in the config\n"
94 //usage: "file, and override them for a specific usage from the command line.\n"
95 //usage:#define modprobe_example_usage
96 //usage: "(with the above /etc/modules.conf):\n\n"
97 //usage: "$ modprobe tulip\n"
98 //usage: " will load the module 'tulip' with default option 'irq=3'\n\n"
99 //usage: "$ modprobe tulip irq=5\n"
100 //usage: " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n"
101 //usage: "$ modprobe tulip2\n"
102 //usage: " will load the module 'tulip' with default options 'irq=4 io=0x308',\n"
103 //usage: " which are the default for alias 'tulip2'\n\n"
104 //usage: "$ modprobe tulip2 irq=8\n"
105 //usage: " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n"
106 //usage: " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n"
107 //usage: " from the command line\n\n"
108 //usage: "$ modprobe tulip2 irq=2 io=0x210\n"
109 //usage: " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n"
110 //usage: " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n"
111 //usage: " from the command line\n"
113 //usage:#define modprobe_trivial_usage
114 //usage: "[-alrqvsD" IF_FEATURE_MODPROBE_BLACKLIST("b") "]"
115 //usage: " MODULE" IF_FEATURE_CMDLINE_MODULE_OPTIONS(" [SYMBOL=VALUE]...")
116 //usage:#define modprobe_full_usage "\n\n"
117 //usage: " -a Load multiple MODULEs"
118 //usage: "\n -l List (MODULE is a pattern)"
119 //usage: "\n -r Remove MODULE (stacks) or do autoclean"
120 //usage: "\n -q Quiet"
121 //usage: "\n -v Verbose"
122 //usage: "\n -s Log to syslog"
123 //usage: "\n -D Show dependencies"
124 //usage: IF_FEATURE_MODPROBE_BLACKLIST(
125 //usage: "\n -b Apply blacklist to module names too"
127 //usage:#endif /* !ENABLE_MODPROBE_SMALL */
129 /* Note: usage text doesn't document various 2.4 options
130 * we pull in through INSMOD_OPTS define
131 * Note2: -b is always accepted, but if !FEATURE_MODPROBE_BLACKLIST,
134 #define MODPROBE_OPTS "alrDb"
135 /* -a and -D _are_ in fact compatible */
136 #define MODPROBE_COMPLEMENTARY "q-v:v-q:l--arD:r--alD:a--lr:D--rl"
137 //#define MODPROBE_OPTS "acd:lnrt:C:b"
138 //#define MODPROBE_COMPLEMENTARY "q-v:v-q:l--acr:a--lr:r--al"
140 OPT_INSERT_ALL = (INSMOD_OPT_UNUSED << 0), /* a */
141 //OPT_DUMP_ONLY = (INSMOD_OPT_UNUSED << x), /* c */
142 //OPT_DIRNAME = (INSMOD_OPT_UNUSED << x), /* d */
143 OPT_LIST_ONLY = (INSMOD_OPT_UNUSED << 1), /* l */
144 //OPT_SHOW_ONLY = (INSMOD_OPT_UNUSED << x), /* n */
145 OPT_REMOVE = (INSMOD_OPT_UNUSED << 2), /* r */
146 //OPT_RESTRICT = (INSMOD_OPT_UNUSED << x), /* t */
147 //OPT_VERONLY = (INSMOD_OPT_UNUSED << x), /* V */
148 //OPT_CONFIGFILE = (INSMOD_OPT_UNUSED << x), /* C */
149 OPT_SHOW_DEPS = (INSMOD_OPT_UNUSED << 3), /* D */
150 OPT_BLACKLIST = (INSMOD_OPT_UNUSED << 4) * ENABLE_FEATURE_MODPROBE_BLACKLIST,
153 static const char modprobe_longopts[] ALIGN1 =
154 /* nobody asked for long opts (yet) */
155 // "all\0" No_argument "a"
156 // "list\0" No_argument "l"
157 // "remove\0" No_argument "r"
158 // "quiet\0" No_argument "q"
159 // "verbose\0" No_argument "v"
160 // "syslog\0" No_argument "s"
161 /* module-init-tools 3.11.1 has only long opt --show-depends
162 * but no short -D, we provide long opt for scripts which
163 * were written for 3.11.1: */
164 "show-depends\0" No_argument "D"
165 // "use-blacklist\0" No_argument "b"
169 #define MODULE_FLAG_LOADED 0x0001
170 #define MODULE_FLAG_NEED_DEPS 0x0002
171 /* "was seen in modules.dep": */
172 #define MODULE_FLAG_FOUND_IN_MODDEP 0x0004
173 #define MODULE_FLAG_BLACKLISTED 0x0008
174 #define MODULE_FLAG_BUILTIN 0x0010
177 llist_t *probes; /* MEs of module(s) requested on cmdline */
178 #if ENABLE_FEATURE_CMDLINE_MODULE_OPTIONS
179 char *cmdline_mopts; /* module options from cmdline */
181 int num_unresolved_deps;
182 /* bool. "Did we have 'symbol:FOO' requested on cmdline?" */
183 smallint need_symbols;
187 #define G (*ptr_to_globals)
188 #define INIT_G() do { \
189 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
193 static int read_config(const char *path);
195 static char *gather_options_str(char *opts, const char *append)
197 /* Speed-optimized. We call gather_options_str many times. */
200 opts = xstrdup(append);
202 int optlen = strlen(opts);
203 opts = xrealloc(opts, optlen + strlen(append) + 2);
204 sprintf(opts + optlen, " %s", append);
210 static struct module_entry *get_or_add_modentry(const char *module)
212 return moddb_get_or_create(&G.db, module);
215 static void add_probe(const char *name)
217 struct module_entry *m;
219 m = get_or_add_modentry(name);
220 if (!(option_mask32 & (OPT_REMOVE | OPT_SHOW_DEPS))
221 && (m->flags & (MODULE_FLAG_LOADED | MODULE_FLAG_BUILTIN))
223 DBG("skipping %s, it is already loaded", name);
227 DBG("queuing %s", name);
228 m->probed_name = name;
229 m->flags |= MODULE_FLAG_NEED_DEPS;
230 llist_add_to_end(&G.probes, m);
231 G.num_unresolved_deps++;
232 if (ENABLE_FEATURE_MODUTILS_SYMBOLS
233 && is_prefixed_with(m->modname, "symbol:")
239 static int FAST_FUNC config_file_action(const char *filename,
240 struct stat *statbuf UNUSED_PARAM,
241 void *userdata UNUSED_PARAM,
246 struct module_entry *m;
248 const char *base, *ext;
250 /* Skip files that begin with a "." */
251 base = bb_basename(filename);
255 /* "man modprobe.d" from kmod version 22 suggests
256 * that we shouldn't recurse into /etc/modprobe.d/dir/
260 return SKIP; /* stop recursing */
261 //TODO: instead, can use dirAction in recursive_action() to SKIP dirs
262 //on depth == 1 level. But that's more code...
264 /* In dir recursion, skip files that do not end with a ".conf"
265 * depth==0: read_config("modules.{symbols,alias}") must work,
266 * "include FILE_NOT_ENDING_IN_CONF" must work too.
269 ext = strrchr(base, '.');
270 if (ext == NULL || strcmp(ext + 1, "conf"))
274 p = config_open2(filename, fopen_for_read);
280 while (config_read(p, tokens, 3, 2, "# \t", PARSE_NORMAL)) {
281 //Use index_in_strings?
282 if (strcmp(tokens[0], "alias") == 0) {
283 /* alias <wildcard> <modulename> */
285 char wildcard[MODULE_NAME_LEN];
288 if (tokens[2] == NULL)
290 filename2modname(tokens[1], wildcard);
292 for (l = G.probes; l; l = l->link) {
293 m = (struct module_entry *) l->data;
294 if (fnmatch(wildcard, m->modname, 0) != 0)
296 rmod = filename2modname(tokens[2], NULL);
297 llist_add_to(&m->realnames, rmod);
299 if (m->flags & MODULE_FLAG_NEED_DEPS) {
300 m->flags &= ~MODULE_FLAG_NEED_DEPS;
301 G.num_unresolved_deps--;
304 m = get_or_add_modentry(rmod);
305 if (!(m->flags & MODULE_FLAG_NEED_DEPS)) {
306 m->flags |= MODULE_FLAG_NEED_DEPS;
307 G.num_unresolved_deps++;
310 } else if (strcmp(tokens[0], "options") == 0) {
311 /* options <modulename> <option...> */
312 if (tokens[2] == NULL)
314 m = get_or_add_modentry(tokens[1]);
315 m->options = gather_options_str(m->options, tokens[2]);
316 } else if (strcmp(tokens[0], "include") == 0) {
317 /* include <filename>/<dirname> (yes, directories also must work) */
318 read_config(tokens[1]);
319 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST
320 && strcmp(tokens[0], "blacklist") == 0
322 /* blacklist <modulename> */
323 get_or_add_modentry(tokens[1])->flags |= MODULE_FLAG_BLACKLISTED;
331 static int read_config(const char *path)
333 return recursive_action(path, ACTION_RECURSE | ACTION_QUIET,
334 config_file_action, NULL, NULL,
338 static const char *humanly_readable_name(struct module_entry *m)
340 /* probed_name may be NULL. modname always exists. */
341 return m->probed_name ? m->probed_name : m->modname;
344 /* Like strsep(&stringp, "\n\t ") but quoted text goes to single token
345 * even if it contains whitespace.
347 static char *strsep_quotes(char **stringp)
349 char *s, *start = *stringp;
354 for (s = start; ; s++) {
357 s = strchrnul(s + 1, '"'); /* find trailing quote */
359 s++; /* skip trailing quote */
376 static char *parse_and_add_kcmdline_module_options(char *options, const char *modulename)
382 kcmdline_buf = xmalloc_open_read_close("/proc/cmdline", NULL);
386 kcmdline = kcmdline_buf;
387 while ((kptr = strsep_quotes(&kcmdline)) != NULL) {
388 char *after_modulename = is_prefixed_with(kptr, modulename);
389 if (!after_modulename || *after_modulename != '.')
391 /* It is "modulename.xxxx" */
392 kptr = after_modulename + 1;
393 if (strchr(kptr, '=') != NULL) {
394 /* It is "modulename.opt=[val]" */
395 options = gather_options_str(options, kptr);
403 /* Return: similar to bb_init_module:
405 * -errno on open/read error,
406 * errno on init_module() error
408 /* NB: INSMOD_OPT_SILENT bit suppresses ONLY non-existent modules,
409 * not deleted ones (those are still listed in modules.dep).
410 * module-init-tools version 3.4:
412 * FATAL: Module bogus not found. [exitcode 1]
413 * # modprobe -q bogus [silent, exitcode still 1]
415 * # rm kernel/drivers/net/dummy.ko
416 * # modprobe -q dummy
417 * FATAL: Could not open '/lib/modules/xxx/kernel/drivers/net/dummy.ko': No such file or directory
420 static int do_modprobe(struct module_entry *m)
424 if (!(m->flags & MODULE_FLAG_FOUND_IN_MODDEP)) {
425 if (!(option_mask32 & INSMOD_OPT_SILENT))
426 bb_error_msg((m->flags & MODULE_FLAG_BUILTIN) ?
427 "module %s is builtin" :
428 "module %s not found in modules.dep",
429 humanly_readable_name(m));
432 DBG("do_modprob'ing %s", m->modname);
434 if (!(option_mask32 & OPT_REMOVE))
435 m->deps = llist_rev(m->deps);
439 for (l = m->deps; l; l = l->link)
440 DBG("dep: %s", l->data);
446 struct module_entry *m2;
450 fn = llist_pop(&m->deps); /* we leak it */
451 m2 = get_or_add_modentry(bb_get_last_path_component_nostrip(fn));
453 if (option_mask32 & OPT_REMOVE) {
455 if (m2->flags & MODULE_FLAG_LOADED) {
456 rc = bb_delete_module(m2->modname, O_EXCL);
459 bb_perror_msg("can't unload module '%s'",
460 humanly_readable_name(m2));
464 m2->flags &= ~MODULE_FLAG_LOADED;
467 /* do not error out if *deps* fail to unload */
472 options = m2->options;
474 options = parse_and_add_kcmdline_module_options(options, m2->modname);
475 #if ENABLE_FEATURE_CMDLINE_MODULE_OPTIONS
477 options = gather_options_str(options, G.cmdline_mopts);
480 if (option_mask32 & OPT_SHOW_DEPS) {
481 printf(options ? "insmod %s/%s/%s %s\n"
482 : "insmod %s/%s/%s\n",
483 CONFIG_DEFAULT_MODULES_DIR, G.uts.release, fn,
489 if (m2->flags & MODULE_FLAG_LOADED) {
490 DBG("%s is already loaded, skipping", fn);
495 rc = bb_init_module(fn, options);
496 DBG("loaded %s '%s', rc:%d", fn, options, rc);
501 bb_error_msg("can't load module %s (%s): %s",
502 humanly_readable_name(m2),
508 m2->flags |= MODULE_FLAG_LOADED;
514 static void load_modules_dep(void)
516 struct module_entry *m;
517 char *colon, *tokens[2];
520 /* Modprobe does not work at all without modules.dep,
521 * even if the full module name is given. Returning error here
522 * was making us later confuse user with this message:
523 * "module /full/path/to/existing/file/module.ko not found".
524 * It's better to die immediately, with good message.
525 * xfopen_for_read provides that. */
526 p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
528 while (G.num_unresolved_deps
529 && config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)
531 colon = last_char_is(tokens[0], ':');
536 m = moddb_get(&G.db, bb_get_last_path_component_nostrip(tokens[0]));
540 /* Optimization... */
541 if ((m->flags & MODULE_FLAG_LOADED)
542 && !(option_mask32 & (OPT_REMOVE | OPT_SHOW_DEPS))
544 DBG("skip deps of %s, it's already loaded", tokens[0]);
548 m->flags |= MODULE_FLAG_FOUND_IN_MODDEP;
549 if ((m->flags & MODULE_FLAG_NEED_DEPS) && (m->deps == NULL)) {
550 G.num_unresolved_deps--;
551 llist_add_to(&m->deps, xstrdup(tokens[0]));
553 string_to_llist(tokens[1], &m->deps, " \t");
555 DBG("skipping dep line");
560 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
561 int modprobe_main(int argc UNUSED_PARAM, char **argv)
565 struct module_entry *me;
569 opt = getopt32long(argv, "^" INSMOD_OPTS MODPROBE_OPTS "\0" MODPROBE_COMPLEMENTARY,
575 /* Goto modules location */
576 xchdir(CONFIG_DEFAULT_MODULES_DIR);
578 xchdir(G.uts.release);
580 if (opt & OPT_LIST_ONLY) {
582 char *colon, *tokens[2];
583 parser_t *p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
585 for (i = 0; argv[i]; i++)
586 replace(argv[i], '-', '_');
588 while (config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)) {
589 colon = last_char_is(tokens[0], ':');
596 char name[MODULE_NAME_LEN];
598 bb_get_last_path_component_nostrip(tokens[0]),
601 for (i = 0; argv[i]; i++) {
602 if (fnmatch(argv[i], name, 0) == 0) {
611 /* Yes, for some reason -l ignores -s... */
612 if (opt & INSMOD_OPT_SYSLOG)
613 logmode = LOGMODE_SYSLOG;
616 if (opt & OPT_REMOVE) {
617 /* "modprobe -r" (w/o params).
618 * "If name is NULL, all unused modules marked
619 * autoclean will be removed".
621 if (bb_delete_module(NULL, O_NONBLOCK | O_EXCL) != 0)
622 bb_perror_nomsg_and_die();
627 /* Retrieve module names of already loaded modules */
630 parser_t *parser = config_open2("/proc/modules", fopen_for_read);
631 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY))
632 get_or_add_modentry(s)->flags |= MODULE_FLAG_LOADED;
633 config_close(parser);
635 parser = config_open2("modules.builtin", fopen_for_read);
636 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL))
637 get_or_add_modentry(s)->flags |= MODULE_FLAG_BUILTIN;
638 config_close(parser);
641 if (opt & (OPT_INSERT_ALL | OPT_REMOVE)) {
642 /* Each argument is a module name */
644 DBG("adding module %s", *argv);
648 /* First argument is module name, rest are parameters */
649 DBG("probing just module %s", *argv);
651 #if ENABLE_FEATURE_CMDLINE_MODULE_OPTIONS
652 G.cmdline_mopts = parse_cmdline_module_options(argv, /*quote_spaces:*/ 1);
656 /* Happens if all requested modules are already loaded */
657 if (G.probes == NULL)
660 read_config("/etc/modprobe.conf");
661 read_config("/etc/modprobe.d");
662 if (ENABLE_FEATURE_MODUTILS_SYMBOLS && G.need_symbols)
663 read_config("modules.symbols");
665 if (ENABLE_FEATURE_MODUTILS_ALIAS && G.num_unresolved_deps) {
666 read_config("modules.alias");
671 while ((me = llist_pop(&G.probes)) != NULL) {
672 if (me->realnames == NULL) {
673 DBG("probing by module name");
674 /* This is not an alias. Literal names are blacklisted
675 * only if '-b' is given.
677 if (!(opt & OPT_BLACKLIST)
678 || !(me->flags & MODULE_FLAG_BLACKLISTED)
680 rc |= do_modprobe(me);
685 /* Probe all real names for the alias */
687 char *realname = llist_pop(&me->realnames);
688 struct module_entry *m2;
690 DBG("probing alias %s by realname %s", me->modname, realname);
691 m2 = get_or_add_modentry(realname);
692 if (!(m2->flags & MODULE_FLAG_BLACKLISTED)
693 && (!(m2->flags & MODULE_FLAG_LOADED)
694 || (opt & (OPT_REMOVE | OPT_SHOW_DEPS)))
696 //TODO: we can pass "me" as 2nd param to do_modprobe,
697 //and make do_modprobe emit more meaningful error messages
698 //with alias name included, not just module name alias resolves to.
699 rc |= do_modprobe(m2);
702 } while (me->realnames != NULL);
705 if (ENABLE_FEATURE_CLEAN_UP)