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 /* So far this function always gets a module pathname, never an alias name.
233 * The crucial difference is that pathname needs dirname stripping,
234 * while alias name must NOT do it!
235 * Testcase where dirname stripping is likely to go wrong: "modprobe devname:snd/timer"
237 static ALWAYS_INLINE
struct module_entry
*get_modentry(const char *pathname
)
239 return helper_get_module(bb_get_last_path_component_nostrip(pathname
), 0);
242 static void add_probe(const char *name
)
244 struct module_entry
*m
;
246 m
= get_or_add_modentry(name
);
247 if (!(option_mask32
& (OPT_REMOVE
| OPT_SHOW_DEPS
))
248 && (m
->flags
& MODULE_FLAG_LOADED
)
250 DBG("skipping %s, it is already loaded", name
);
254 DBG("queuing %s", name
);
255 m
->probed_name
= name
;
256 m
->flags
|= MODULE_FLAG_NEED_DEPS
;
257 llist_add_to_end(&G
.probes
, m
);
258 G
.num_unresolved_deps
++;
259 if (ENABLE_FEATURE_MODUTILS_SYMBOLS
260 && strncmp(m
->modname
, "symbol:", 7) == 0
266 static int FAST_FUNC
config_file_action(const char *filename
,
267 struct stat
*statbuf UNUSED_PARAM
,
268 void *userdata UNUSED_PARAM
,
269 int depth UNUSED_PARAM
)
273 struct module_entry
*m
;
276 if (bb_basename(filename
)[0] == '.')
279 p
= config_open2(filename
, fopen_for_read
);
285 while (config_read(p
, tokens
, 3, 2, "# \t", PARSE_NORMAL
)) {
286 //Use index_in_strings?
287 if (strcmp(tokens
[0], "alias") == 0) {
288 /* alias <wildcard> <modulename> */
290 char wildcard
[MODULE_NAME_LEN
];
293 if (tokens
[2] == NULL
)
295 filename2modname(tokens
[1], wildcard
);
297 for (l
= G
.probes
; l
; l
= l
->link
) {
298 m
= (struct module_entry
*) l
->data
;
299 if (fnmatch(wildcard
, m
->modname
, 0) != 0)
301 rmod
= filename2modname(tokens
[2], NULL
);
302 llist_add_to(&m
->realnames
, rmod
);
304 if (m
->flags
& MODULE_FLAG_NEED_DEPS
) {
305 m
->flags
&= ~MODULE_FLAG_NEED_DEPS
;
306 G
.num_unresolved_deps
--;
309 m
= get_or_add_modentry(rmod
);
310 if (!(m
->flags
& MODULE_FLAG_NEED_DEPS
)) {
311 m
->flags
|= MODULE_FLAG_NEED_DEPS
;
312 G
.num_unresolved_deps
++;
315 } else if (strcmp(tokens
[0], "options") == 0) {
316 /* options <modulename> <option...> */
317 if (tokens
[2] == NULL
)
319 m
= get_or_add_modentry(tokens
[1]);
320 m
->options
= gather_options_str(m
->options
, tokens
[2]);
321 } else if (strcmp(tokens
[0], "include") == 0) {
322 /* include <filename> */
323 read_config(tokens
[1]);
324 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST
325 && strcmp(tokens
[0], "blacklist") == 0
327 /* blacklist <modulename> */
328 get_or_add_modentry(tokens
[1])->flags
|= MODULE_FLAG_BLACKLISTED
;
336 static int read_config(const char *path
)
338 return recursive_action(path
, ACTION_RECURSE
| ACTION_QUIET
,
339 config_file_action
, NULL
, NULL
, 1);
342 static const char *humanly_readable_name(struct module_entry
*m
)
344 /* probed_name may be NULL. modname always exists. */
345 return m
->probed_name
? m
->probed_name
: m
->modname
;
348 static char *parse_and_add_kcmdline_module_options(char *options
, const char *modulename
)
355 kcmdline_buf
= xmalloc_open_read_close("/proc/cmdline", NULL
);
359 kcmdline
= kcmdline_buf
;
360 len
= strlen(modulename
);
361 while ((kptr
= strsep(&kcmdline
, "\n\t ")) != NULL
) {
362 if (strncmp(modulename
, kptr
, len
) != 0)
367 /* It is "modulename.xxxx" */
369 if (strchr(kptr
, '=') != NULL
) {
370 /* It is "modulename.opt=[val]" */
371 options
= gather_options_str(options
, kptr
);
379 /* Return: similar to bb_init_module:
381 * -errno on open/read error,
382 * errno on init_module() error
384 /* NB: INSMOD_OPT_SILENT bit suppresses ONLY non-existent modules,
385 * not deleted ones (those are still listed in modules.dep).
386 * module-init-tools version 3.4:
388 * FATAL: Module bogus not found. [exitcode 1]
389 * # modprobe -q bogus [silent, exitcode still 1]
391 * # rm kernel/drivers/net/dummy.ko
392 * # modprobe -q dummy
393 * FATAL: Could not open '/lib/modules/xxx/kernel/drivers/net/dummy.ko': No such file or directory
396 static int do_modprobe(struct module_entry
*m
)
400 if (!(m
->flags
& MODULE_FLAG_FOUND_IN_MODDEP
)) {
401 if (!(option_mask32
& INSMOD_OPT_SILENT
))
402 bb_error_msg("module %s not found in modules.dep",
403 humanly_readable_name(m
));
406 DBG("do_modprob'ing %s", m
->modname
);
408 if (!(option_mask32
& OPT_REMOVE
))
409 m
->deps
= llist_rev(m
->deps
);
413 for (l
= m
->deps
; l
; l
= l
->link
)
414 DBG("dep: %s", l
->data
);
420 struct module_entry
*m2
;
424 fn
= llist_pop(&m
->deps
); /* we leak it */
425 m2
= get_or_add_modentry(bb_get_last_path_component_nostrip(fn
));
427 if (option_mask32
& OPT_REMOVE
) {
429 if (m2
->flags
& MODULE_FLAG_LOADED
) {
430 rc
= bb_delete_module(m2
->modname
, O_NONBLOCK
| O_EXCL
);
433 bb_error_msg("can't unload module %s: %s",
434 humanly_readable_name(m2
),
439 m2
->flags
&= ~MODULE_FLAG_LOADED
;
442 /* do not error out if *deps* fail to unload */
447 options
= m2
->options
;
449 options
= parse_and_add_kcmdline_module_options(options
, m2
->modname
);
451 options
= gather_options_str(options
, G
.cmdline_mopts
);
453 if (option_mask32
& OPT_SHOW_DEPS
) {
454 printf(options
? "insmod %s/%s/%s %s\n"
455 : "insmod %s/%s/%s\n",
456 CONFIG_DEFAULT_MODULES_DIR
, G
.uts
.release
, fn
,
462 if (m2
->flags
& MODULE_FLAG_LOADED
) {
463 DBG("%s is already loaded, skipping", fn
);
468 rc
= bb_init_module(fn
, options
);
469 DBG("loaded %s '%s', rc:%d", fn
, options
, rc
);
474 bb_error_msg("can't load module %s (%s): %s",
475 humanly_readable_name(m2
),
481 m2
->flags
|= MODULE_FLAG_LOADED
;
487 static void load_modules_dep(void)
489 struct module_entry
*m
;
490 char *colon
, *tokens
[2];
493 /* Modprobe does not work at all without modules.dep,
494 * even if the full module name is given. Returning error here
495 * was making us later confuse user with this message:
496 * "module /full/path/to/existing/file/module.ko not found".
497 * It's better to die immediately, with good message.
498 * xfopen_for_read provides that. */
499 p
= config_open2(CONFIG_DEFAULT_DEPMOD_FILE
, xfopen_for_read
);
501 while (G
.num_unresolved_deps
502 && config_read(p
, tokens
, 2, 1, "# \t", PARSE_NORMAL
)
504 colon
= last_char_is(tokens
[0], ':');
509 m
= get_modentry(tokens
[0]);
513 /* Optimization... */
514 if ((m
->flags
& MODULE_FLAG_LOADED
)
515 && !(option_mask32
& (OPT_REMOVE
| OPT_SHOW_DEPS
))
517 DBG("skip deps of %s, it's already loaded", tokens
[0]);
521 m
->flags
|= MODULE_FLAG_FOUND_IN_MODDEP
;
522 if ((m
->flags
& MODULE_FLAG_NEED_DEPS
) && (m
->deps
== NULL
)) {
523 G
.num_unresolved_deps
--;
524 llist_add_to(&m
->deps
, xstrdup(tokens
[0]));
526 string_to_llist(tokens
[1], &m
->deps
, " \t");
528 DBG("skipping dep line");
533 int modprobe_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
534 int modprobe_main(int argc UNUSED_PARAM
, char **argv
)
538 struct module_entry
*me
;
542 IF_LONG_OPTS(applet_long_options
= modprobe_longopts
;)
543 opt_complementary
= MODPROBE_COMPLEMENTARY
;
544 opt
= getopt32(argv
, INSMOD_OPTS MODPROBE_OPTS INSMOD_ARGS
);
547 /* Goto modules location */
548 xchdir(CONFIG_DEFAULT_MODULES_DIR
);
550 xchdir(G
.uts
.release
);
552 if (opt
& OPT_LIST_ONLY
) {
554 char *colon
, *tokens
[2];
555 parser_t
*p
= config_open2(CONFIG_DEFAULT_DEPMOD_FILE
, xfopen_for_read
);
557 for (i
= 0; argv
[i
]; i
++)
558 replace(argv
[i
], '-', '_');
560 while (config_read(p
, tokens
, 2, 1, "# \t", PARSE_NORMAL
)) {
561 colon
= last_char_is(tokens
[0], ':');
568 char name
[MODULE_NAME_LEN
];
570 bb_get_last_path_component_nostrip(tokens
[0]),
573 for (i
= 0; argv
[i
]; i
++) {
574 if (fnmatch(argv
[i
], name
, 0) == 0) {
583 /* Yes, for some reason -l ignores -s... */
584 if (opt
& INSMOD_OPT_SYSLOG
)
585 logmode
= LOGMODE_SYSLOG
;
588 if (opt
& OPT_REMOVE
) {
589 /* "modprobe -r" (w/o params).
590 * "If name is NULL, all unused modules marked
591 * autoclean will be removed".
593 if (bb_delete_module(NULL
, O_NONBLOCK
| O_EXCL
) != 0)
594 bb_perror_msg_and_die("rmmod");
599 /* Retrieve module names of already loaded modules */
602 parser_t
*parser
= config_open2("/proc/modules", fopen_for_read
);
603 while (config_read(parser
, &s
, 1, 1, "# \t", PARSE_NORMAL
& ~PARSE_GREEDY
))
604 get_or_add_modentry(s
)->flags
|= MODULE_FLAG_LOADED
;
605 config_close(parser
);
608 if (opt
& (OPT_INSERT_ALL
| OPT_REMOVE
)) {
609 /* Each argument is a module name */
611 DBG("adding module %s", *argv
);
615 /* First argument is module name, rest are parameters */
616 DBG("probing just module %s", *argv
);
618 G
.cmdline_mopts
= parse_cmdline_module_options(argv
, /*quote_spaces:*/ 1);
621 /* Happens if all requested modules are already loaded */
622 if (G
.probes
== NULL
)
625 read_config("/etc/modprobe.conf");
626 read_config("/etc/modprobe.d");
627 if (ENABLE_FEATURE_MODUTILS_SYMBOLS
&& G
.need_symbols
)
628 read_config("modules.symbols");
630 if (ENABLE_FEATURE_MODUTILS_ALIAS
&& G
.num_unresolved_deps
) {
631 read_config("modules.alias");
636 while ((me
= llist_pop(&G
.probes
)) != NULL
) {
637 if (me
->realnames
== NULL
) {
638 DBG("probing by module name");
639 /* This is not an alias. Literal names are blacklisted
640 * only if '-b' is given.
642 if (!(opt
& OPT_BLACKLIST
)
643 || !(me
->flags
& MODULE_FLAG_BLACKLISTED
)
645 rc
|= do_modprobe(me
);
650 /* Probe all real names for the alias */
652 char *realname
= llist_pop(&me
->realnames
);
653 struct module_entry
*m2
;
655 DBG("probing alias %s by realname %s", me
->modname
, realname
);
656 m2
= get_or_add_modentry(realname
);
657 if (!(m2
->flags
& MODULE_FLAG_BLACKLISTED
)
658 && (!(m2
->flags
& MODULE_FLAG_LOADED
)
659 || (opt
& (OPT_REMOVE
| OPT_SHOW_DEPS
)))
661 //TODO: we can pass "me" as 2nd param to do_modprobe,
662 //and make do_modprobe emit more meaningful error messages
663 //with alias name included, not just module name alias resolves to.
664 rc
|= do_modprobe(m2
);
667 } while (me
->realnames
!= NULL
);