1 /* vi: set sw=4 ts=4: */
3 * Modprobe written from scratch for BusyBox
5 * Copyright (c) 2002 by Robert Griebl, griebl@gmx.de
6 * Copyright (c) 2003 by Andrew Dennison, andrew.dennison@motec.com.au
7 * Copyright (c) 2005 by Jim Bauer, jfbauer@nfr.com
9 * Portions Copyright (c) 2005 by Yann E. MORIN, yann.morin.1998@anciens.enib.fr
11 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
15 #include <sys/utsname.h>
18 #define line_buffer bb_common_bufsiz1
20 struct mod_opt_t { /* one-way list of options to pass to a module */
22 struct mod_opt_t * m_next;
25 struct dep_t { /* one-way list of dependency rules */
26 /* a dependency rule */
27 char * m_name; /* the module name*/
28 char * m_path; /* the module file path */
29 struct mod_opt_t * m_options; /* the module options */
31 unsigned int m_isalias :1; /* the module is an alias */
32 unsigned int m_isblacklisted:1; /* the module is blacklisted */
33 unsigned int m_reserved :14; /* stuffin' */
35 unsigned int m_depcnt :16; /* the number of dependable module(s) */
36 char ** m_deparr; /* the list of dependable module(s) */
38 struct dep_t * m_next; /* the next dependency rule */
41 struct mod_list_t { /* two-way list of modules to process */
42 /* a module description */
45 struct mod_opt_t * m_options;
47 struct mod_list_t * m_prev;
48 struct mod_list_t * m_next;
52 static struct dep_t *depend;
54 #define MAIN_OPT_STR "acdklnqrst:vVC:"
55 #define INSERT_ALL 1 /* a */
56 #define DUMP_CONF_EXIT 2 /* c */
57 #define D_OPT_IGNORED 4 /* d */
58 #define AUTOCLEAN_FLG 8 /* k */
59 #define LIST_ALL 16 /* l */
60 #define SHOW_ONLY 32 /* n */
61 #define QUIET 64 /* q */
62 #define REMOVE_OPT 128 /* r */
63 #define DO_SYSLOG 256 /* s */
64 #define RESTRICT_DIR 512 /* t */
65 #define VERBOSE 1024 /* v */
66 #define VERSION_ONLY 2048 /* V */
67 #define CONFIG_FILE 4096 /* C */
69 #define autoclean (option_mask32 & AUTOCLEAN_FLG)
70 #define show_only (option_mask32 & SHOW_ONLY)
71 #define quiet (option_mask32 & QUIET)
72 #define remove_opt (option_mask32 & REMOVE_OPT)
73 #define do_syslog (option_mask32 & DO_SYSLOG)
74 #define verbose (option_mask32 & VERBOSE)
76 static int parse_tag_value(char *buffer, char **ptag, char **pvalue)
80 buffer = skip_whitespace(buffer);
82 while (!isspace(*value)) {
88 value = skip_whitespace(value);
99 * This function appends an option to a list
101 static struct mod_opt_t *append_option(struct mod_opt_t *opt_list, char *opt)
103 struct mod_opt_t *ol = opt_list;
109 ol->m_next = xzalloc(sizeof(struct mod_opt_t));
112 ol = opt_list = xzalloc(sizeof(struct mod_opt_t));
115 ol->m_opt_val = xstrdup(opt);
116 /*ol->m_next = NULL; - done by xzalloc*/
121 #if ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS
122 /* static char* parse_command_string(char* src, char **dst);
123 * src: pointer to string containing argument
124 * dst: pointer to where to store the parsed argument
125 * return value: the pointer to the first char after the parsed argument,
126 * NULL if there was no argument parsed (only trailing spaces).
127 * Note that memory is allocated with xstrdup when a new argument was
128 * parsed. Don't forget to free it!
130 #define ARG_EMPTY 0x00
131 #define ARG_IN_DQUOTES 0x01
132 #define ARG_IN_SQUOTES 0x02
133 static char *parse_command_string(char *src, char **dst)
135 int opt_status = ARG_EMPTY;
138 /* Dumb you, I have nothing to do... */
139 if (src == NULL) return src;
141 /* Skip leading spaces */
142 while (*src == ' ') {
145 /* Is the end of string reached? */
149 /* Reached the start of an argument
150 * By the way, we duplicate a little too much
151 * here but what is too much is freed later. */
152 *dst = tmp_str = xstrdup(src);
153 /* Get to the end of that argument */
154 while (*tmp_str != '\0'
155 && (*tmp_str != ' ' || (opt_status & (ARG_IN_DQUOTES | ARG_IN_SQUOTES)))
159 if (opt_status & ARG_IN_DQUOTES) {
160 /* Already in double quotes, keep current char as is */
162 /* shift left 1 char, until end of string: get rid of the opening/closing quotes */
163 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
164 /* mark me: we enter or leave single quotes */
165 opt_status ^= ARG_IN_SQUOTES;
166 /* Back one char, as we need to re-scan the new char there. */
171 if (opt_status & ARG_IN_SQUOTES) {
172 /* Already in single quotes, keep current char as is */
174 /* shift left 1 char, until end of string: get rid of the opening/closing quotes */
175 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
176 /* mark me: we enter or leave double quotes */
177 opt_status ^= ARG_IN_DQUOTES;
178 /* Back one char, as we need to re-scan the new char there. */
183 if (opt_status & ARG_IN_SQUOTES) {
184 /* Between single quotes: keep as is. */
186 switch (*(tmp_str+1)) {
195 /* We escaped a special character. For now, keep
196 * both the back-slash and the following char. */
201 /* We escaped a space or a single or double quote,
202 * or a back-slash, or a non-escapable char. Remove
203 * the '\' and keep the new current char as is. */
204 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
209 /* Any other char that is special shall appear here.
210 * Example: $ starts a variable
212 do_variable_expansion();
216 /* any other char is kept as is. */
219 tmp_str++; /* Go to next char */
220 src++; /* Go to next char to find the end of the argument. */
222 /* End of string, but still no ending quote */
223 if (opt_status & (ARG_IN_DQUOTES | ARG_IN_SQUOTES)) {
224 bb_error_msg_and_die("unterminated (single or double) quote in options list: %s", src);
227 *dst = xrealloc(*dst, (tmp_str - *dst));
231 #define parse_command_string(src, dst) (0)
232 #endif /* ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS */
234 static int is_conf_command(char *buffer, const char *command)
236 int len = strlen(command);
237 return ((strstr(buffer, command) == buffer) &&
238 isspace(buffer[len]));
242 * This function reads aliases and default module options from a configuration file
243 * (/etc/modprobe.conf syntax). It supports includes (only files, no directories).
245 static void include_conf(struct dep_t **first, struct dep_t **current, char *buffer, int buflen, int fd)
247 int continuation_line = 0;
249 // alias parsing is not 100% correct (no correct handling of continuation lines within an alias)!
251 while (reads(fd, buffer, buflen)) {
254 *strchrnul(buffer, '#') = '\0';
258 while (l && isspace(buffer[l-1])) {
264 continuation_line = 0;
268 if (continuation_line)
271 if (is_conf_command(buffer, "alias")) {
274 if (parse_tag_value(buffer + 6, &alias, &mod)) {
275 /* handle alias as a module dependent on the aliased module */
277 (*first) = (*current) = xzalloc(sizeof(struct dep_t));
279 (*current)->m_next = xzalloc(sizeof(struct dep_t));
280 (*current) = (*current)->m_next;
282 (*current)->m_name = xstrdup(alias);
283 (*current)->m_isalias = 1;
285 if ((strcmp(mod, "off") == 0) || (strcmp(mod, "null") == 0)) {
286 /*(*current)->m_depcnt = 0; - done by xzalloc */
287 /*(*current)->m_deparr = 0;*/
289 (*current)->m_depcnt = 1;
290 (*current)->m_deparr = xmalloc(sizeof(char *));
291 (*current)->m_deparr[0] = xstrdup(mod);
293 /*(*current)->m_next = NULL; - done by xzalloc */
295 } else if (is_conf_command(buffer, "options")) {
298 /* split the line in the module/alias name, and options */
299 if (parse_tag_value(buffer + 8, &mod, &opt)) {
302 /* find the corresponding module */
303 for (dt = *first; dt; dt = dt->m_next) {
304 if (strcmp(dt->m_name, mod) == 0)
308 if (ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS) {
309 char* new_opt = NULL;
310 while ((opt = parse_command_string(opt, &new_opt))) {
311 dt->m_options = append_option(dt->m_options, new_opt);
314 dt->m_options = append_option(dt->m_options, opt);
318 } else if (is_conf_command(buffer, "include")) {
322 filename = skip_whitespace(buffer + 8);
323 fdi = open(filename, O_RDONLY);
325 include_conf(first, current, buffer, buflen, fdi);
328 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST &&
329 (is_conf_command(buffer, "blacklist"))) {
333 mod = skip_whitespace(buffer + 10);
334 for (dt = *first; dt; dt = dt->m_next) {
335 if (strcmp(dt->m_name, mod) == 0)
339 dt->m_isblacklisted = 1;
341 } /* while (reads(...)) */
345 * This function builds a list of dependency rules from /lib/modules/`uname -r`/modules.dep.
346 * It then fills every modules and aliases with their default options, found by parsing
347 * modprobe.conf (or modules.conf, or conf.modules).
349 static struct dep_t *build_dep(void)
353 struct dep_t *first = NULL;
354 struct dep_t *current = NULL;
356 int continuation_line = 0;
360 bb_error_msg_and_die("can't determine kernel version");
363 if (un.release[0] == '2') {
364 k_version = un.release[2] - '0';
367 filename = xasprintf(CONFIG_DEFAULT_MODULES_DIR"/%s/"CONFIG_DEFAULT_DEPMOD_FILE, un.release);
368 fd = open(filename, O_RDONLY);
369 if (ENABLE_FEATURE_CLEAN_UP)
372 /* Ok, that didn't work. Fall back to looking in /lib/modules */
373 fd = open(CONFIG_DEFAULT_MODULES_DIR"/"CONFIG_DEFAULT_DEPMOD_FILE, O_RDONLY);
375 bb_error_msg_and_die("cannot parse " CONFIG_DEFAULT_DEPMOD_FILE);
379 while (reads(fd, line_buffer, sizeof(line_buffer))) {
380 int l = strlen(line_buffer);
383 while (l > 0 && isspace(line_buffer[l-1])) {
384 line_buffer[l-1] = '\0';
389 continuation_line = 0;
393 /* Is this a new module dep description? */
394 if (!continuation_line) {
395 /* find the dep beginning */
396 char *col = strchr(line_buffer, ':');
400 /* This line is a dep description */
405 /* Find the beginning of the module file name */
407 mods = bb_basename(line_buffer);
409 /* find the path of the module */
410 modpath = strchr(line_buffer, '/'); /* ... and this is the path */
412 modpath = line_buffer; /* module with no path */
413 /* find the end of the module name in the file name */
414 if (ENABLE_FEATURE_2_6_MODULES &&
415 (k_version > 4) && (col[-3] == '.') &&
416 (col[-2] == 'k') && (col[-1] == 'o'))
418 else if ((col[-2] == '.') && (col[-1] == 'o'))
421 mod = xstrndup(mods, dot - mods);
423 /* enqueue new module */
425 first = current = xzalloc(sizeof(struct dep_t));
427 current->m_next = xzalloc(sizeof(struct dep_t));
428 current = current->m_next;
430 current->m_name = mod;
431 current->m_path = xstrdup(modpath);
432 /*current->m_options = NULL; - xzalloc did it*/
433 /*current->m_isalias = 0;*/
434 /*current->m_depcnt = 0;*/
435 /*current->m_deparr = 0;*/
436 /*current->m_next = 0;*/
440 /* this line is not a dep description */
443 /* It's a dep description continuation */
446 while (p && *p && isblank(*p))
449 /* p points to the first dependable module; if NULL, no dependable module */
451 char *end = &line_buffer[l-1];
457 while (isblank(*end) || (*end == '\\'))
461 /* search the end of the dependency */
462 next = strchr(p, ' ');
469 /* find the beginning of the module file name */
470 deps = bb_basename(p);
472 while (isblank(*deps))
476 /* find the end of the module name in the file name */
477 if (ENABLE_FEATURE_2_6_MODULES
478 && (k_version > 4) && (next[-2] == '.')
479 && (next[-1] == 'k') && (next[0] == 'o'))
481 else if ((next[-1] == '.') && (next[0] == 'o'))
484 /* Cope with blank lines */
485 if ((next-deps-ext+1) <= 0)
487 dep = xstrndup(deps, next - deps - ext + 1);
489 /* Add the new dependable module name */
491 current->m_deparr = xrealloc(current->m_deparr,
492 sizeof(char *) * current->m_depcnt);
493 current->m_deparr[current->m_depcnt - 1] = dep;
496 } while (next < end);
499 /* is there other dependable module(s) ? */
500 continuation_line = (line_buffer[l-1] == '\\');
501 } /* while (reads(...)) */
505 * First parse system-specific options and aliases
506 * as they take precedence over the kernel ones.
507 * >=2.6: we only care about modprobe.conf
508 * <=2.4: we care about modules.conf and conf.modules
510 if (ENABLE_FEATURE_2_6_MODULES
511 && (fd = open("/etc/modprobe.conf", O_RDONLY)) < 0)
512 if (ENABLE_FEATURE_2_4_MODULES
513 && (fd = open("/etc/modules.conf", O_RDONLY)) < 0)
514 if (ENABLE_FEATURE_2_4_MODULES)
515 fd = open("/etc/conf.modules", O_RDONLY);
518 include_conf(&first, ¤t, line_buffer, sizeof(line_buffer), fd);
522 /* Only 2.6 has a modules.alias file */
523 if (ENABLE_FEATURE_2_6_MODULES) {
524 /* Parse kernel-declared module aliases */
525 filename = xasprintf(CONFIG_DEFAULT_MODULES_DIR"/%s/modules.alias", un.release);
526 fd = open(filename, O_RDONLY);
528 /* Ok, that didn't work. Fall back to looking in /lib/modules */
529 fd = open(CONFIG_DEFAULT_MODULES_DIR"/modules.alias", O_RDONLY);
531 if (ENABLE_FEATURE_CLEAN_UP)
535 include_conf(&first, ¤t, line_buffer, sizeof(line_buffer), fd);
539 /* Parse kernel-declared symbol aliases */
540 filename = xasprintf(CONFIG_DEFAULT_MODULES_DIR"/%s/modules.symbols", un.release);
541 fd = open(filename, O_RDONLY);
543 /* Ok, that didn't work. Fall back to looking in /lib/modules */
544 fd = open(CONFIG_DEFAULT_MODULES_DIR"/modules.symbols", O_RDONLY);
546 if (ENABLE_FEATURE_CLEAN_UP)
550 include_conf(&first, ¤t, line_buffer, sizeof(line_buffer), fd);
558 /* return 1 = loaded, 0 = not loaded, -1 = can't tell */
559 static int already_loaded(const char *name)
563 fd = open("/proc/modules", O_RDONLY);
567 while (reads(fd, line_buffer, sizeof(line_buffer))) {
570 p = strchr(line_buffer, ' ');
574 // Truncate buffer at first space and check for matches, with
575 // the idiosyncrasy that _ and - are interchangeable because the
576 // 2.6 kernel does weird things.
579 for (p = line_buffer, n = name; ; p++, n++) {
581 if ((*p == '_' || *p == '-') && (*n == '_' || *n == '-'))
585 // If we made it to the end, that's a match.
598 static int mod_process(const struct mod_list_t *list, int do_insert)
602 struct mod_opt_t *opts;
603 int argc_malloc; /* never used when CONFIG_FEATURE_CLEAN_UP not defined */
608 if (ENABLE_FEATURE_CLEAN_UP)
610 /* If CONFIG_FEATURE_CLEAN_UP is not defined, then we leak memory
611 * each time we allocate memory for argv.
612 * But it is (quite) small amounts of memory that leak each
613 * time a module is loaded, and it is reclaimed when modprobe
614 * exits anyway (even when standalone shell?).
615 * This could become a problem when loading a module with LOTS of
616 * dependencies, with LOTS of options for each dependencies, with
617 * very little memory on the target... But in that case, the module
618 * would not load because there is no more memory, so there's no
620 /* enough for minimal insmod (5 args + NULL) or rmmod (3 args + NULL) */
621 argv = xmalloc(6 * sizeof(char*));
623 if (already_loaded(list->m_name) != 1) {
624 argv[argc++] = (char*)"insmod";
625 if (ENABLE_FEATURE_2_4_MODULES) {
627 argv[argc++] = (char*)"-s";
629 argv[argc++] = (char*)"-k";
631 argv[argc++] = (char*)"-q";
632 else if (verbose) /* verbose and quiet are mutually exclusive */
633 argv[argc++] = (char*)"-v";
635 argv[argc++] = list->m_path;
636 if (ENABLE_FEATURE_CLEAN_UP)
638 opts = list->m_options;
640 /* Add one more option */
642 argv = xrealloc(argv, (argc + 1) * sizeof(char*));
643 argv[argc-1] = opts->m_opt_val;
648 /* modutils uses short name for removal */
649 if (already_loaded(list->m_name) != 0) {
650 argv[argc++] = (char*)"rmmod";
652 argv[argc++] = (char*)"-s";
653 argv[argc++] = (char*)list->m_name;
654 if (ENABLE_FEATURE_CLEAN_UP)
662 printf("%s module %s\n", do_insert?"Loading":"Unloading", list->m_name);
665 int rc2 = wait4pid(spawn(argv));
668 rc = rc2; /* only last module matters */
670 rc = 0; /* success if remove any mod */
673 if (ENABLE_FEATURE_CLEAN_UP) {
674 /* the last value in the array has index == argc, but
675 * it is the terminating NULL, so we must not free it. */
676 while (argc_malloc < argc) {
677 free(argv[argc_malloc++]);
681 if (ENABLE_FEATURE_CLEAN_UP) {
685 list = do_insert ? list->m_prev : list->m_next;
687 return (show_only) ? 0 : rc;
691 * Check the matching between a pattern and a module name.
692 * We need this as *_* is equivalent to *-*, even in pattern matching.
694 static int check_pattern(const char* pat_src, const char* mod_src)
698 if (ENABLE_FEATURE_MODPROBE_FANCY_ALIAS) {
703 pat = xstrdup(pat_src);
704 mod = xstrdup(mod_src);
706 for (p = pat; (p = strchr(p, '-')); *p++ = '_');
707 for (p = mod; (p = strchr(p, '-')); *p++ = '_');
709 ret = fnmatch(pat, mod, 0);
711 if (ENABLE_FEATURE_CLEAN_UP) {
718 return fnmatch(pat_src, mod_src, 0);
722 * Builds the dependency list (aka stack) of a module.
723 * head: the highest module in the stack (last to insmod, first to rmmod)
724 * tail: the lowest module in the stack (first to insmod, last to rmmod)
726 static void check_dep(char *mod, struct mod_list_t **head, struct mod_list_t **tail)
728 struct mod_list_t *find;
730 struct mod_opt_t *opt = NULL;
733 /* Search for the given module name amongst all dependency rules.
734 * The module name in a dependency rule can be a shell pattern,
735 * so try to match the given module name against such a pattern.
736 * Of course if the name in the dependency rule is a plain string,
737 * then we consider it a pattern, and matching will still work. */
738 for (dt = depend; dt; dt = dt->m_next) {
739 if (check_pattern(dt->m_name, mod) == 0) {
745 bb_error_msg("module %s not found", mod);
749 // resolve alias names
750 while (dt->m_isalias) {
751 if (dt->m_depcnt == 1) {
754 for (adt = depend; adt; adt = adt->m_next) {
755 if (check_pattern(adt->m_name, dt->m_deparr[0]) == 0 &&
756 !(ENABLE_FEATURE_MODPROBE_BLACKLIST &&
757 adt->m_isblacklisted))
761 /* This is the module we are aliased to */
762 struct mod_opt_t *opts = dt->m_options;
763 /* Option of the alias are appended to the options of the module */
765 adt->m_options = append_option(adt->m_options, opts->m_opt_val);
770 bb_error_msg("module %s not found", mod);
774 bb_error_msg("bad alias %s", dt->m_name);
783 // search for duplicates
784 for (find = *head; find; find = find->m_next) {
785 if (strcmp(mod, find->m_name) == 0) {
786 // found -> dequeue it
789 find->m_prev->m_next = find->m_next;
791 *head = find->m_next;
794 find->m_next->m_prev = find->m_prev;
796 *tail = find->m_prev;
798 break; // there can be only one duplicate
802 if (!find) { // did not find a duplicate
803 find = xzalloc(sizeof(struct mod_list_t));
806 find->m_options = opt;
811 (*tail)->m_next = find;
812 find->m_prev = *tail;
813 find->m_next = NULL; /* possibly NOT done by xzalloc! */
822 /* Add all dependable module for that new module */
823 for (i = 0; i < dt->m_depcnt; i++)
824 check_dep(dt->m_deparr[i], head, tail);
828 static int mod_insert(char *mod, int argc, char **argv)
830 struct mod_list_t *tail = NULL;
831 struct mod_list_t *head = NULL;
834 // get dep list for module mod
835 check_dep(mod, &head, &tail);
841 // append module args
842 for (i = 0; i < argc; i++)
843 head->m_options = append_option(head->m_options, argv[i]);
846 // process tail ---> head
847 rc = mod_process(tail, 1);
850 * In case of using udev, multiple instances of modprobe can be
851 * spawned to load the same module (think of two same usb devices,
852 * for example; or cold-plugging at boot time). Thus we shouldn't
853 * fail if the module was loaded, and not by us.
855 if (already_loaded(mod))
862 static int mod_remove(char *mod)
865 static const struct mod_list_t rm_a_dummy = { "-a", NULL, NULL, NULL, NULL };
867 struct mod_list_t *head = NULL;
868 struct mod_list_t *tail = NULL;
871 check_dep(mod, &head, &tail);
873 head = tail = (struct mod_list_t*) &rm_a_dummy;
877 rc = mod_process(head, 0); // process head ---> tail
881 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
882 int modprobe_main(int argc, char **argv)
884 int rc = EXIT_SUCCESS;
887 opt_complementary = "q-v:v-q";
888 getopt32(argv, MAIN_OPT_STR, &unused, &unused);
890 if (option_mask32 & (DUMP_CONF_EXIT | LIST_ALL))
892 if (option_mask32 & (RESTRICT_DIR | CONFIG_FILE))
893 bb_error_msg_and_die("-t and -C not supported");
895 depend = build_dep();
898 bb_error_msg_and_die("cannot parse "CONFIG_DEFAULT_DEPMOD_FILE);
902 /* argv[optind] can be NULL here */
903 if (mod_remove(argv[optind])) {
904 bb_error_msg("failed to remove module %s",
908 } while (++optind < argc);
911 bb_error_msg_and_die("no module or pattern provided");
913 if (mod_insert(argv[optind], argc - optind - 1, argv + optind + 1))
914 bb_error_msg_and_die("failed to load module %s", argv[optind]);
917 /* Here would be a good place to free up memory allocated during the dependencies build. */