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 tarball for details.
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.
13 * Older versions would only export the direct dependency list.
17 #include <sys/utsname.h>
20 //#define DBG(fmt, ...) bb_error_msg("%s: " fmt, __func__, ## __VA_ARGS__)
21 #define DBG(...) ((void)0)
23 #define MODULE_FLAG_LOADED 0x0001
24 #define MODULE_FLAG_NEED_DEPS 0x0002
25 /* "was seen in modules.dep": */
26 #define MODULE_FLAG_FOUND_IN_MODDEP 0x0004
27 #define MODULE_FLAG_BLACKLISTED 0x0008
29 struct module_entry { /* I'll call it ME. */
31 char *modname; /* stripped of /path/, .ext and s/-/_/g */
32 const char *probed_name; /* verbatim as seen on cmdline */
33 char *options; /* options from config files */
34 llist_t *realnames; /* strings. if this module is an alias, */
35 /* real module name is one of these. */
36 //Can there really be more than one? Example from real kernel?
37 llist_t *deps; /* strings. modules we depend on */
40 /* NB: INSMOD_OPT_SILENT bit suppresses ONLY non-existent modules,
41 * not deleted ones (those are still listed in modules.dep).
42 * module-init-tools version 3.4:
44 * FATAL: Module bogus not found. [exitcode 1]
45 * # modprobe -q bogus [silent, exitcode still 1]
47 * # rm kernel/drivers/net/dummy.ko
49 * FATAL: Could not open '/lib/modules/xxx/kernel/drivers/net/dummy.ko': No such file or directory
52 #define MODPROBE_OPTS "acdlnrt:VC:" IF_FEATURE_MODPROBE_BLACKLIST("b")
54 MODPROBE_OPT_INSERT_ALL = (INSMOD_OPT_UNUSED << 0), /* a */
55 MODPROBE_OPT_DUMP_ONLY = (INSMOD_OPT_UNUSED << 1), /* c */
56 MODPROBE_OPT_D = (INSMOD_OPT_UNUSED << 2), /* d */
57 MODPROBE_OPT_LIST_ONLY = (INSMOD_OPT_UNUSED << 3), /* l */
58 MODPROBE_OPT_SHOW_ONLY = (INSMOD_OPT_UNUSED << 4), /* n */
59 MODPROBE_OPT_REMOVE = (INSMOD_OPT_UNUSED << 5), /* r */
60 MODPROBE_OPT_RESTRICT = (INSMOD_OPT_UNUSED << 6), /* t */
61 MODPROBE_OPT_VERONLY = (INSMOD_OPT_UNUSED << 7), /* V */
62 MODPROBE_OPT_CONFIGFILE = (INSMOD_OPT_UNUSED << 8), /* C */
63 MODPROBE_OPT_BLACKLIST = (INSMOD_OPT_UNUSED << 9) * ENABLE_FEATURE_MODPROBE_BLACKLIST,
67 llist_t *db; /* MEs of all modules ever seen (caching for speed) */
68 llist_t *probes; /* MEs of module(s) requested on cmdline */
69 char *cmdline_mopts; /* module options from cmdline */
70 int num_unresolved_deps;
71 /* bool. "Did we have 'symbol:FOO' requested on cmdline?" */
72 smallint need_symbols;
74 #define G (*(struct globals*)&bb_common_bufsiz1)
75 #define INIT_G() do { } while (0)
78 static int read_config(const char *path);
80 static char *gather_options_str(char *opts, const char *append)
82 /* Speed-optimized. We call gather_options_str many times. */
85 opts = xstrdup(append);
87 int optlen = strlen(opts);
88 opts = xrealloc(opts, optlen + strlen(append) + 2);
89 sprintf(opts + optlen, " %s", append);
95 static struct module_entry *helper_get_module(const char *module, int create)
97 char modname[MODULE_NAME_LEN];
98 struct module_entry *e;
101 filename2modname(module, modname);
102 for (l = G.db; l != NULL; l = l->link) {
103 e = (struct module_entry *) l->data;
104 if (strcmp(e->modname, modname) == 0)
110 e = xzalloc(sizeof(*e));
111 e->modname = xstrdup(modname);
112 llist_add_to(&G.db, e);
116 static struct module_entry *get_or_add_modentry(const char *module)
118 return helper_get_module(module, 1);
120 static struct module_entry *get_modentry(const char *module)
122 return helper_get_module(module, 0);
125 static void add_probe(const char *name)
127 struct module_entry *m;
129 m = get_or_add_modentry(name);
130 if (!(option_mask32 & MODPROBE_OPT_REMOVE)
131 && (m->flags & MODULE_FLAG_LOADED)
133 DBG("skipping %s, it is already loaded", name);
137 DBG("queuing %s", name);
138 m->probed_name = name;
139 m->flags |= MODULE_FLAG_NEED_DEPS;
140 llist_add_to_end(&G.probes, m);
141 G.num_unresolved_deps++;
142 if (ENABLE_FEATURE_MODUTILS_SYMBOLS
143 && strncmp(m->modname, "symbol:", 7) == 0
149 static int FAST_FUNC config_file_action(const char *filename,
150 struct stat *statbuf UNUSED_PARAM,
151 void *userdata UNUSED_PARAM,
152 int depth UNUSED_PARAM)
156 struct module_entry *m;
159 if (bb_basename(filename)[0] == '.')
162 p = config_open2(filename, fopen_for_read);
168 while (config_read(p, tokens, 3, 2, "# \t", PARSE_NORMAL)) {
169 //Use index_in_strings?
170 if (strcmp(tokens[0], "alias") == 0) {
171 /* alias <wildcard> <modulename> */
173 char wildcard[MODULE_NAME_LEN];
176 if (tokens[2] == NULL)
178 filename2modname(tokens[1], wildcard);
180 for (l = G.probes; l != NULL; l = l->link) {
181 m = (struct module_entry *) l->data;
182 if (fnmatch(wildcard, m->modname, 0) != 0)
184 rmod = filename2modname(tokens[2], NULL);
185 llist_add_to(&m->realnames, rmod);
187 if (m->flags & MODULE_FLAG_NEED_DEPS) {
188 m->flags &= ~MODULE_FLAG_NEED_DEPS;
189 G.num_unresolved_deps--;
192 m = get_or_add_modentry(rmod);
193 if (!(m->flags & MODULE_FLAG_NEED_DEPS)) {
194 m->flags |= MODULE_FLAG_NEED_DEPS;
195 G.num_unresolved_deps++;
198 } else if (strcmp(tokens[0], "options") == 0) {
199 /* options <modulename> <option...> */
200 if (tokens[2] == NULL)
202 m = get_or_add_modentry(tokens[1]);
203 m->options = gather_options_str(m->options, tokens[2]);
204 } else if (strcmp(tokens[0], "include") == 0) {
205 /* include <filename> */
206 read_config(tokens[1]);
207 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST
208 && strcmp(tokens[0], "blacklist") == 0
210 /* blacklist <modulename> */
211 get_or_add_modentry(tokens[1])->flags |= MODULE_FLAG_BLACKLISTED;
219 static int read_config(const char *path)
221 return recursive_action(path, ACTION_RECURSE | ACTION_QUIET,
222 config_file_action, NULL, NULL, 1);
225 static const char *humanly_readable_name(struct module_entry *m)
227 /* probed_name may be NULL. modname always exists. */
228 return m->probed_name ? m->probed_name : m->modname;
231 /* Return: similar to bb_init_module:
233 * -errno on open/read error,
234 * errno on init_module() error
236 static int do_modprobe(struct module_entry *m)
238 struct module_entry *m2 = m2; /* for compiler */
243 if (!(m->flags & MODULE_FLAG_FOUND_IN_MODDEP)) {
244 if (!(option_mask32 & INSMOD_OPT_SILENT))
245 bb_error_msg("module %s not found in modules.dep",
246 humanly_readable_name(m));
249 DBG("do_modprob'ing %s", m->modname);
251 if (!(option_mask32 & MODPROBE_OPT_REMOVE))
252 m->deps = llist_rev(m->deps);
254 for (l = m->deps; l != NULL; l = l->link)
255 DBG("dep: %s", l->data);
261 fn = llist_pop(&m->deps); /* we leak it */
262 m2 = get_or_add_modentry(fn);
264 if (option_mask32 & MODPROBE_OPT_REMOVE) {
266 if (m2->flags & MODULE_FLAG_LOADED) {
267 rc = bb_delete_module(m2->modname, O_EXCL);
270 bb_error_msg("failed to unload module %s: %s",
271 humanly_readable_name(m2),
276 m2->flags &= ~MODULE_FLAG_LOADED;
279 /* do not error out if *deps* fail to unload */
284 if (m2->flags & MODULE_FLAG_LOADED) {
285 DBG("%s is already loaded, skipping", fn);
289 options = m2->options;
292 options = gather_options_str(options, G.cmdline_mopts);
293 rc = bb_init_module(fn, options);
294 DBG("loaded %s '%s', rc:%d", fn, options, rc);
299 bb_error_msg("failed to load module %s (%s): %s",
300 humanly_readable_name(m2),
306 m2->flags |= MODULE_FLAG_LOADED;
312 static void load_modules_dep(void)
314 struct module_entry *m;
315 char *colon, *tokens[2];
318 /* Modprobe does not work at all without modules.dep,
319 * even if the full module name is given. Returning error here
320 * was making us later confuse user with this message:
321 * "module /full/path/to/existing/file/module.ko not found".
322 * It's better to die immediately, with good message.
323 * xfopen_for_read provides that. */
324 p = config_open2(CONFIG_DEFAULT_DEPMOD_FILE, xfopen_for_read);
326 while (G.num_unresolved_deps
327 && config_read(p, tokens, 2, 1, "# \t", PARSE_NORMAL)
329 colon = last_char_is(tokens[0], ':');
334 m = get_modentry(tokens[0]);
338 /* Optimization... */
339 if ((m->flags & MODULE_FLAG_LOADED)
340 && !(option_mask32 & MODPROBE_OPT_REMOVE)
342 DBG("skip deps of %s, it's already loaded", tokens[0]);
346 m->flags |= MODULE_FLAG_FOUND_IN_MODDEP;
347 if ((m->flags & MODULE_FLAG_NEED_DEPS) && (m->deps == NULL)) {
348 G.num_unresolved_deps--;
349 llist_add_to(&m->deps, xstrdup(tokens[0]));
351 string_to_llist(tokens[1], &m->deps, " \t");
353 DBG("skipping dep line");
358 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
359 int modprobe_main(int argc UNUSED_PARAM, char **argv)
364 struct module_entry *me;
366 opt_complementary = "q-v:v-q";
367 opt = getopt32(argv, INSMOD_OPTS MODPROBE_OPTS INSMOD_ARGS, NULL, NULL);
370 if (opt & (MODPROBE_OPT_DUMP_ONLY | MODPROBE_OPT_LIST_ONLY |
371 MODPROBE_OPT_SHOW_ONLY))
372 bb_error_msg_and_die("not supported");
375 if (opt & MODPROBE_OPT_REMOVE) {
376 /* "modprobe -r" (w/o params).
377 * "If name is NULL, all unused modules marked
378 * autoclean will be removed".
380 if (bb_delete_module(NULL, O_NONBLOCK | O_EXCL) != 0)
381 bb_perror_msg_and_die("rmmod");
386 /* Goto modules location */
387 xchdir(CONFIG_DEFAULT_MODULES_DIR);
391 /* Retrieve module names of already loaded modules */
394 parser_t *parser = config_open2("/proc/modules", fopen_for_read);
395 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY))
396 get_or_add_modentry(s)->flags |= MODULE_FLAG_LOADED;
397 config_close(parser);
400 if (opt & (MODPROBE_OPT_INSERT_ALL | MODPROBE_OPT_REMOVE)) {
401 /* Each argument is a module name */
403 DBG("adding module %s", *argv);
407 /* First argument is module name, rest are parameters */
408 DBG("probing just module %s", *argv);
410 G.cmdline_mopts = parse_cmdline_module_options(argv);
413 /* Happens if all requested modules are already loaded */
414 if (G.probes == NULL)
417 read_config("/etc/modprobe.conf");
418 read_config("/etc/modprobe.d");
419 if (ENABLE_FEATURE_MODUTILS_SYMBOLS && G.need_symbols)
420 read_config("modules.symbols");
422 if (ENABLE_FEATURE_MODUTILS_ALIAS && G.num_unresolved_deps) {
423 read_config("modules.alias");
428 while ((me = llist_pop(&G.probes)) != NULL) {
429 if (me->realnames == NULL) {
430 DBG("probing by module name");
431 /* This is not an alias. Literal names are blacklisted
432 * only if '-b' is given.
434 if (!(opt & MODPROBE_OPT_BLACKLIST)
435 || !(me->flags & MODULE_FLAG_BLACKLISTED)
437 rc |= do_modprobe(me);
442 /* Probe all real names for the alias */
444 char *realname = llist_pop(&me->realnames);
445 struct module_entry *m2;
447 DBG("probing alias %s by realname %s", me->modname, realname);
448 m2 = get_or_add_modentry(realname);
449 if (!(m2->flags & MODULE_FLAG_BLACKLISTED)
450 && (!(m2->flags & MODULE_FLAG_LOADED)
451 || (opt & MODPROBE_OPT_REMOVE))
453 //TODO: we can pass "me" as 2nd param to do_modprobe,
454 //and make do_modprobe emit more meaningful error messages
455 //with alias name included, not just module name alias resolves to.
456 rc |= do_modprobe(m2);
459 } while (me->realnames != NULL);