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;
51 struct include_conf_t {
53 struct dep_t *current;
56 static struct dep_t *depend;
58 #define MAIN_OPT_STR "acdklnqrst:vVC:"
59 #define INSERT_ALL 1 /* a */
60 #define DUMP_CONF_EXIT 2 /* c */
61 #define D_OPT_IGNORED 4 /* d */
62 #define AUTOCLEAN_FLG 8 /* k */
63 #define LIST_ALL 16 /* l */
64 #define SHOW_ONLY 32 /* n */
65 #define QUIET 64 /* q */
66 #define REMOVE_OPT 128 /* r */
67 #define DO_SYSLOG 256 /* s */
68 #define RESTRICT_DIR 512 /* t */
69 #define VERBOSE 1024 /* v */
70 #define VERSION_ONLY 2048 /* V */
71 #define CONFIG_FILE 4096 /* C */
73 #define autoclean (option_mask32 & AUTOCLEAN_FLG)
74 #define show_only (option_mask32 & SHOW_ONLY)
75 #define quiet (option_mask32 & QUIET)
76 #define remove_opt (option_mask32 & REMOVE_OPT)
77 #define do_syslog (option_mask32 & DO_SYSLOG)
78 #define verbose (option_mask32 & VERBOSE)
80 static int parse_tag_value(char *buffer, char **ptag, char **pvalue)
84 buffer = skip_whitespace(buffer);
86 while (!isspace(*value)) {
92 value = skip_whitespace(value);
103 * This function appends an option to a list
105 static struct mod_opt_t *append_option(struct mod_opt_t *opt_list, char *opt)
107 struct mod_opt_t *ol = opt_list;
113 ol->m_next = xzalloc(sizeof(struct mod_opt_t));
116 ol = opt_list = xzalloc(sizeof(struct mod_opt_t));
119 ol->m_opt_val = xstrdup(opt);
120 /*ol->m_next = NULL; - done by xzalloc*/
125 #if ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS
126 /* static char* parse_command_string(char* src, char **dst);
127 * src: pointer to string containing argument
128 * dst: pointer to where to store the parsed argument
129 * return value: the pointer to the first char after the parsed argument,
130 * NULL if there was no argument parsed (only trailing spaces).
131 * Note that memory is allocated with xstrdup when a new argument was
132 * parsed. Don't forget to free it!
134 #define ARG_EMPTY 0x00
135 #define ARG_IN_DQUOTES 0x01
136 #define ARG_IN_SQUOTES 0x02
137 static char *parse_command_string(char *src, char **dst)
139 int opt_status = ARG_EMPTY;
142 /* Dumb you, I have nothing to do... */
143 if (src == NULL) return src;
145 /* Skip leading spaces */
146 while (*src == ' ') {
149 /* Is the end of string reached? */
153 /* Reached the start of an argument
154 * By the way, we duplicate a little too much
155 * here but what is too much is freed later. */
156 *dst = tmp_str = xstrdup(src);
157 /* Get to the end of that argument */
158 while (*tmp_str != '\0'
159 && (*tmp_str != ' ' || (opt_status & (ARG_IN_DQUOTES | ARG_IN_SQUOTES)))
163 if (opt_status & ARG_IN_DQUOTES) {
164 /* Already in double quotes, keep current char as is */
166 /* shift left 1 char, until end of string: get rid of the opening/closing quotes */
167 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
168 /* mark me: we enter or leave single quotes */
169 opt_status ^= ARG_IN_SQUOTES;
170 /* Back one char, as we need to re-scan the new char there. */
175 if (opt_status & ARG_IN_SQUOTES) {
176 /* Already in single quotes, keep current char as is */
178 /* shift left 1 char, until end of string: get rid of the opening/closing quotes */
179 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
180 /* mark me: we enter or leave double quotes */
181 opt_status ^= ARG_IN_DQUOTES;
182 /* Back one char, as we need to re-scan the new char there. */
187 if (opt_status & ARG_IN_SQUOTES) {
188 /* Between single quotes: keep as is. */
190 switch (*(tmp_str+1)) {
199 /* We escaped a special character. For now, keep
200 * both the back-slash and the following char. */
205 /* We escaped a space or a single or double quote,
206 * or a back-slash, or a non-escapable char. Remove
207 * the '\' and keep the new current char as is. */
208 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
213 /* Any other char that is special shall appear here.
214 * Example: $ starts a variable
216 do_variable_expansion();
220 /* any other char is kept as is. */
223 tmp_str++; /* Go to next char */
224 src++; /* Go to next char to find the end of the argument. */
226 /* End of string, but still no ending quote */
227 if (opt_status & (ARG_IN_DQUOTES | ARG_IN_SQUOTES)) {
228 bb_error_msg_and_die("unterminated (single or double) quote in options list: %s", src);
231 *dst = xrealloc(*dst, (tmp_str - *dst));
235 #define parse_command_string(src, dst) (0)
236 #endif /* ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS */
238 static int is_conf_command(char *buffer, const char *command)
240 int len = strlen(command);
241 return ((strstr(buffer, command) == buffer) &&
242 isspace(buffer[len]));
246 * This function reads aliases and default module options from a configuration file
247 * (/etc/modprobe.conf syntax). It supports includes (only files, no directories).
250 static int FAST_FUNC include_conf_file_act(const char *filename,
251 struct stat *statbuf UNUSED_PARAM,
253 int depth UNUSED_PARAM);
255 static int FAST_FUNC include_conf_dir_act(const char *filename UNUSED_PARAM,
256 struct stat *statbuf UNUSED_PARAM,
257 void *userdata UNUSED_PARAM,
266 static int include_conf_recursive(struct include_conf_t *conf, const char *filename)
268 return recursive_action(filename, ACTION_RECURSE,
269 include_conf_file_act,
270 include_conf_dir_act,
274 static int FAST_FUNC include_conf_file_act(const char *filename,
275 struct stat *statbuf UNUSED_PARAM,
277 int depth UNUSED_PARAM)
279 struct include_conf_t *conf = (struct include_conf_t *) userdata;
280 struct dep_t **first = &conf->first;
281 struct dep_t **current = &conf->current;
282 int continuation_line = 0;
285 if (bb_basename(filename)[0] == '.')
288 f = fopen_for_read(filename);
292 // alias parsing is not 100% correct (no correct handling of continuation lines within an alias)!
294 while (fgets(line_buffer, sizeof(line_buffer), f)) {
297 *strchrnul(line_buffer, '#') = '\0';
299 l = strlen(line_buffer);
301 while (l && isspace(line_buffer[l-1])) {
302 line_buffer[l-1] = '\0';
307 continuation_line = 0;
311 if (continuation_line)
314 if (is_conf_command(line_buffer, "alias")) {
317 if (parse_tag_value(line_buffer + 6, &alias, &mod)) {
318 /* handle alias as a module dependent on the aliased module */
320 (*first) = (*current) = xzalloc(sizeof(struct dep_t));
322 (*current)->m_next = xzalloc(sizeof(struct dep_t));
323 (*current) = (*current)->m_next;
325 (*current)->m_name = xstrdup(alias);
326 (*current)->m_isalias = 1;
328 if ((strcmp(mod, "off") == 0) || (strcmp(mod, "null") == 0)) {
329 /*(*current)->m_depcnt = 0; - done by xzalloc */
330 /*(*current)->m_deparr = 0;*/
332 (*current)->m_depcnt = 1;
333 (*current)->m_deparr = xmalloc(sizeof(char *));
334 (*current)->m_deparr[0] = xstrdup(mod);
336 /*(*current)->m_next = NULL; - done by xzalloc */
338 } else if (is_conf_command(line_buffer, "options")) {
341 /* split the line in the module/alias name, and options */
342 if (parse_tag_value(line_buffer + 8, &mod, &opt)) {
345 /* find the corresponding module */
346 for (dt = *first; dt; dt = dt->m_next) {
347 if (strcmp(dt->m_name, mod) == 0)
351 if (ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS) {
352 char* new_opt = NULL;
353 while ((opt = parse_command_string(opt, &new_opt))) {
354 dt->m_options = append_option(dt->m_options, new_opt);
357 dt->m_options = append_option(dt->m_options, opt);
361 } else if (is_conf_command(line_buffer, "include")) {
364 includefile = skip_whitespace(line_buffer + 8);
365 include_conf_recursive(conf, includefile);
366 } else if (ENABLE_FEATURE_MODPROBE_BLACKLIST &&
367 (is_conf_command(line_buffer, "blacklist"))) {
371 mod = skip_whitespace(line_buffer + 10);
372 for (dt = *first; dt; dt = dt->m_next) {
373 if (strcmp(dt->m_name, mod) == 0)
377 dt->m_isblacklisted = 1;
379 } /* while (fgets(...)) */
385 static int include_conf_file(struct include_conf_t *conf,
386 const char *filename)
388 return include_conf_file_act(filename, NULL, conf, 0);
391 static int include_conf_file2(struct include_conf_t *conf,
392 const char *filename, const char *oldname)
394 if (include_conf_file(conf, filename) == TRUE)
396 return include_conf_file(conf, oldname);
400 * This function builds a list of dependency rules from /lib/modules/`uname -r`/modules.dep.
401 * It then fills every modules and aliases with their default options, found by parsing
402 * modprobe.conf (or modules.conf, or conf.modules).
404 static struct dep_t *build_dep(void)
408 struct include_conf_t conf = { NULL, NULL };
410 int continuation_line = 0;
413 uname(&un); /* never fails */
416 if (un.release[0] == '2') {
417 k_version = un.release[2] - '0';
420 filename = xasprintf(CONFIG_DEFAULT_MODULES_DIR"/%s/"CONFIG_DEFAULT_DEPMOD_FILE, un.release);
421 f = fopen_for_read(filename);
422 if (ENABLE_FEATURE_CLEAN_UP)
425 /* Ok, that didn't work. Fall back to looking in /lib/modules */
426 f = fopen_for_read(CONFIG_DEFAULT_MODULES_DIR"/"CONFIG_DEFAULT_DEPMOD_FILE);
428 bb_error_msg_and_die("cannot parse "CONFIG_DEFAULT_DEPMOD_FILE);
432 while (fgets(line_buffer, sizeof(line_buffer), f)) {
433 int l = strlen(line_buffer);
436 while (l > 0 && isspace(line_buffer[l-1])) {
437 line_buffer[l-1] = '\0';
442 continuation_line = 0;
446 /* Is this a new module dep description? */
447 if (!continuation_line) {
448 /* find the dep beginning */
449 char *col = strchr(line_buffer, ':');
453 /* This line is a dep description */
458 /* Find the beginning of the module file name */
460 mods = bb_basename(line_buffer);
462 /* find the path of the module */
463 modpath = strchr(line_buffer, '/'); /* ... and this is the path */
465 modpath = line_buffer; /* module with no path */
466 /* find the end of the module name in the file name */
467 if (ENABLE_FEATURE_2_6_MODULES &&
468 (k_version > 4) && (col[-3] == '.') &&
469 (col[-2] == 'k') && (col[-1] == 'o'))
471 else if ((col[-2] == '.') && (col[-1] == 'o'))
474 mod = xstrndup(mods, dot - mods);
476 /* enqueue new module */
478 conf.first = conf.current = xzalloc(sizeof(struct dep_t));
480 conf.current->m_next = xzalloc(sizeof(struct dep_t));
481 conf.current = conf.current->m_next;
483 conf.current->m_name = mod;
484 conf.current->m_path = xstrdup(modpath);
485 /*current->m_options = NULL; - xzalloc did it*/
486 /*current->m_isalias = 0;*/
487 /*current->m_depcnt = 0;*/
488 /*current->m_deparr = 0;*/
489 /*current->m_next = 0;*/
493 /* this line is not a dep description */
496 /* It's a dep description continuation */
499 /* p points to the first dependable module; if NULL, no dependable module */
500 if (p && (p = skip_whitespace(p))[0] != '\0') {
501 char *end = &line_buffer[l-1];
507 while (isblank(*end) || (*end == '\\'))
511 /* search the end of the dependency */
512 next = strchr(p, ' ');
519 /* find the beginning of the module file name */
520 deps = bb_basename(p);
522 deps = skip_whitespace(deps);
524 /* find the end of the module name in the file name */
525 if (ENABLE_FEATURE_2_6_MODULES
526 && (k_version > 4) && (next[-2] == '.')
527 && (next[-1] == 'k') && (next[0] == 'o'))
529 else if ((next[-1] == '.') && (next[0] == 'o'))
532 /* Cope with blank lines */
533 if ((next - deps - ext + 1) <= 0)
535 dep = xstrndup(deps, next - deps - ext + 1);
537 /* Add the new dependable module name */
538 conf.current->m_deparr = xrealloc_vector(conf.current->m_deparr, 2, conf.current->m_depcnt);
539 conf.current->m_deparr[conf.current->m_depcnt++] = dep;
542 } while (next < end);
545 /* is there other dependable module(s) ? */
546 continuation_line = (line_buffer[l-1] == '\\');
547 } /* while (fgets(...)) */
551 * First parse system-specific options and aliases
552 * as they take precedence over the kernel ones.
553 * >=2.6: we only care about modprobe.conf
554 * <=2.4: we care about modules.conf and conf.modules
559 if (ENABLE_FEATURE_2_6_MODULES) {
560 if (include_conf_file(&conf, "/etc/modprobe.conf"))
562 if (include_conf_recursive(&conf, "/etc/modprobe.d"))
565 if (ENABLE_FEATURE_2_4_MODULES && !r)
566 include_conf_file2(&conf,
568 "/etc/conf.modules");
571 /* Only 2.6 has a modules.alias file */
572 if (ENABLE_FEATURE_2_6_MODULES) {
573 /* Parse kernel-declared module aliases */
574 filename = xasprintf(CONFIG_DEFAULT_MODULES_DIR"/%s/modules.alias", un.release);
575 include_conf_file2(&conf,
577 CONFIG_DEFAULT_MODULES_DIR"/modules.alias");
578 if (ENABLE_FEATURE_CLEAN_UP)
581 /* Parse kernel-declared symbol aliases */
582 filename = xasprintf(CONFIG_DEFAULT_MODULES_DIR"/%s/modules.symbols", un.release);
583 include_conf_file2(&conf,
585 CONFIG_DEFAULT_MODULES_DIR"/modules.symbols");
586 if (ENABLE_FEATURE_CLEAN_UP)
593 /* return 1 = loaded, 0 = not loaded, -1 = can't tell */
594 static int already_loaded(const char *name)
599 f = fopen_for_read("/proc/modules");
604 while (fgets(line_buffer, sizeof(line_buffer), f)) {
605 char *p = line_buffer;
606 const char *n = name;
611 if (cp == ' ' || cp == '\0') {
613 ret = 1; /* match! */
616 break; /* no match on this line, take next one */
618 if (cn == '-') cn = '_';
619 if (cp == '-') cp = '_';
621 break; /* no match on this line, take next one */
631 static int mod_process(const struct mod_list_t *list, int do_insert)
635 struct mod_opt_t *opts;
636 int argc_malloc; /* never used when CONFIG_FEATURE_CLEAN_UP not defined */
641 if (ENABLE_FEATURE_CLEAN_UP)
643 /* If CONFIG_FEATURE_CLEAN_UP is not defined, then we leak memory
644 * each time we allocate memory for argv.
645 * But it is (quite) small amounts of memory that leak each
646 * time a module is loaded, and it is reclaimed when modprobe
647 * exits anyway (even when standalone shell? Yes --vda).
648 * This could become a problem when loading a module with LOTS of
649 * dependencies, with LOTS of options for each dependencies, with
650 * very little memory on the target... But in that case, the module
651 * would not load because there is no more memory, so there's no
653 /* enough for minimal insmod (5 args + NULL) or rmmod (3 args + NULL) */
654 argv = xmalloc(6 * sizeof(char*));
656 if (already_loaded(list->m_name) != 1) {
657 argv[argc++] = (char*)"insmod";
658 if (ENABLE_FEATURE_2_4_MODULES) {
660 argv[argc++] = (char*)"-s";
662 argv[argc++] = (char*)"-k";
664 argv[argc++] = (char*)"-q";
665 else if (verbose) /* verbose and quiet are mutually exclusive */
666 argv[argc++] = (char*)"-v";
668 argv[argc++] = list->m_path;
669 if (ENABLE_FEATURE_CLEAN_UP)
671 opts = list->m_options;
673 /* Add one more option */
675 argv = xrealloc(argv, (argc + 1) * sizeof(char*));
676 argv[argc-1] = opts->m_opt_val;
681 /* modutils uses short name for removal */
682 if (already_loaded(list->m_name) != 0) {
683 argv[argc++] = (char*)"rmmod";
685 argv[argc++] = (char*)"-s";
686 argv[argc++] = (char*)list->m_name;
687 if (ENABLE_FEATURE_CLEAN_UP)
695 printf("%s module %s\n", do_insert?"Loading":"Unloading", list->m_name);
698 int rc2 = wait4pid(spawn(argv));
701 rc = rc2; /* only last module matters */
703 rc = 0; /* success if remove any mod */
706 if (ENABLE_FEATURE_CLEAN_UP) {
707 /* the last value in the array has index == argc, but
708 * it is the terminating NULL, so we must not free it. */
709 while (argc_malloc < argc) {
710 free(argv[argc_malloc++]);
714 if (ENABLE_FEATURE_CLEAN_UP) {
718 list = do_insert ? list->m_prev : list->m_next;
720 return (show_only) ? 0 : rc;
724 * Check the matching between a pattern and a module name.
725 * We need this as *_* is equivalent to *-*, even in pattern matching.
727 static int check_pattern(const char* pat_src, const char* mod_src)
731 if (ENABLE_FEATURE_MODPROBE_FANCY_ALIAS) {
736 pat = xstrdup(pat_src);
737 mod = xstrdup(mod_src);
739 for (p = pat; (p = strchr(p, '-')); *p++ = '_');
740 for (p = mod; (p = strchr(p, '-')); *p++ = '_');
742 ret = fnmatch(pat, mod, 0);
744 if (ENABLE_FEATURE_CLEAN_UP) {
751 return fnmatch(pat_src, mod_src, 0);
755 * Builds the dependency list (aka stack) of a module.
756 * head: the highest module in the stack (last to insmod, first to rmmod)
757 * tail: the lowest module in the stack (first to insmod, last to rmmod)
759 static void check_dep(char *mod, struct mod_list_t **head, struct mod_list_t **tail)
761 struct mod_list_t *find;
763 struct mod_opt_t *opt = NULL;
766 /* Search for the given module name amongst all dependency rules.
767 * The module name in a dependency rule can be a shell pattern,
768 * so try to match the given module name against such a pattern.
769 * Of course if the name in the dependency rule is a plain string,
770 * then we consider it a pattern, and matching will still work. */
771 for (dt = depend; dt; dt = dt->m_next) {
772 if (check_pattern(dt->m_name, mod) == 0) {
778 bb_error_msg("module %s not found", mod);
782 // resolve alias names
783 while (dt->m_isalias) {
784 if (dt->m_depcnt == 1) {
787 for (adt = depend; adt; adt = adt->m_next) {
788 if (check_pattern(adt->m_name, dt->m_deparr[0]) == 0 &&
789 !(ENABLE_FEATURE_MODPROBE_BLACKLIST &&
790 adt->m_isblacklisted))
794 /* This is the module we are aliased to */
795 struct mod_opt_t *opts = dt->m_options;
796 /* Option of the alias are appended to the options of the module */
798 adt->m_options = append_option(adt->m_options, opts->m_opt_val);
803 bb_error_msg("module %s not found", mod);
807 bb_error_msg("bad alias %s", dt->m_name);
816 // search for duplicates
817 for (find = *head; find; find = find->m_next) {
818 if (strcmp(mod, find->m_name) == 0) {
819 // found -> dequeue it
822 find->m_prev->m_next = find->m_next;
824 *head = find->m_next;
827 find->m_next->m_prev = find->m_prev;
829 *tail = find->m_prev;
831 break; // there can be only one duplicate
835 if (!find) { // did not find a duplicate
836 find = xzalloc(sizeof(struct mod_list_t));
839 find->m_options = opt;
844 (*tail)->m_next = find;
845 find->m_prev = *tail;
846 find->m_next = NULL; /* possibly NOT done by xzalloc! */
855 /* Add all dependable module for that new module */
856 for (i = 0; i < dt->m_depcnt; i++)
857 check_dep(dt->m_deparr[i], head, tail);
861 static int mod_insert(char **argv)
863 struct mod_list_t *tail = NULL;
864 struct mod_list_t *head = NULL;
865 char *modname = *argv++;
868 // get dep list for module mod
869 check_dep(modname, &head, &tail);
874 head->m_options = append_option(head->m_options, *argv++);
876 // process tail ---> head
877 rc = mod_process(tail, 1);
880 * In case of using udev, multiple instances of modprobe can be
881 * spawned to load the same module (think of two same usb devices,
882 * for example; or cold-plugging at boot time). Thus we shouldn't
883 * fail if the module was loaded, and not by us.
885 if (already_loaded(modname))
892 static int mod_remove(char *modname)
894 static const struct mod_list_t rm_a_dummy = { "-a", NULL, NULL, NULL, NULL };
897 struct mod_list_t *head = NULL;
898 struct mod_list_t *tail = NULL;
901 check_dep(modname, &head, &tail);
903 head = tail = (struct mod_list_t*) &rm_a_dummy;
907 rc = mod_process(head, 0); // process head ---> tail
911 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
912 int modprobe_main(int argc UNUSED_PARAM, char **argv)
914 int rc = EXIT_SUCCESS;
918 opt_complementary = "q-v:v-q";
919 opt = getopt32(argv, MAIN_OPT_STR, &unused, &unused);
922 if (opt & (DUMP_CONF_EXIT | LIST_ALL))
924 if (opt & (RESTRICT_DIR | CONFIG_FILE))
925 bb_error_msg_and_die("-t and -C not supported");
927 depend = build_dep();
930 bb_error_msg_and_die("cannot parse "CONFIG_DEFAULT_DEPMOD_FILE);
934 /* (*argv) can be NULL here */
935 if (mod_remove(*argv)) {
936 bb_perror_msg("failed to %s module %s", "remove",
940 } while (*argv && *++argv);
943 bb_error_msg_and_die("no module or pattern provided");
945 if (mod_insert(argv))
946 bb_perror_msg_and_die("failed to %s module %s", "load", *argv);
949 /* Here would be a good place to free up memory allocated during the dependencies build. */