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 struct mod_opt_t { /* one-way list of options to pass to a module */
20 struct mod_opt_t * m_next;
23 struct dep_t { /* one-way list of dependency rules */
24 /* a dependency rule */
25 char * m_name; /* the module name*/
26 char * m_path; /* the module file path */
27 struct mod_opt_t * m_options; /* the module options */
29 int m_isalias : 1; /* the module is an alias */
30 int m_reserved : 15; /* stuffin' */
32 int m_depcnt : 16; /* the number of dependable module(s) */
33 char ** m_deparr; /* the list of dependable module(s) */
35 struct dep_t * m_next; /* the next dependency rule */
38 struct mod_list_t { /* two-way list of modules to process */
39 /* a module description */
42 struct mod_opt_t * m_options;
44 struct mod_list_t * m_prev;
45 struct mod_list_t * m_next;
49 static struct dep_t *depend;
51 #define main_options "acdklnqrst:vVC:"
52 #define INSERT_ALL 1 /* a */
53 #define DUMP_CONF_EXIT 2 /* c */
54 #define D_OPT_IGNORED 4 /* d */
55 #define AUTOCLEAN_FLG 8 /* k */
56 #define LIST_ALL 16 /* l */
57 #define SHOW_ONLY 32 /* n */
58 #define QUIET 64 /* q */
59 #define REMOVE_OPT 128 /* r */
60 #define DO_SYSLOG 256 /* s */
61 #define RESTRICT_DIR 512 /* t */
62 #define VERBOSE 1024 /* v */
63 #define VERSION_ONLY 2048 /* V */
64 #define CONFIG_FILE 4096 /* C */
66 #define autoclean (main_opts & AUTOCLEAN_FLG)
67 #define show_only (main_opts & SHOW_ONLY)
68 #define quiet (main_opts & QUIET)
69 #define remove_opt (main_opts & REMOVE_OPT)
70 #define do_syslog (main_opts & DO_SYSLOG)
71 #define verbose (main_opts & VERBOSE)
75 static int parse_tag_value(char *buffer, char **ptag, char **pvalue)
79 buffer = skip_whitespace(buffer);
81 while (!isspace(*value))
82 if (!*value) return 0;
85 value = skip_whitespace(value);
86 if (!*value) return 0;
95 * This function appends an option to a list
97 static struct mod_opt_t *append_option(struct mod_opt_t *opt_list, char *opt)
99 struct mod_opt_t *ol = opt_list;
105 ol->m_next = xmalloc(sizeof(struct mod_opt_t));
108 ol = opt_list = xmalloc(sizeof(struct mod_opt_t));
111 ol->m_opt_val = xstrdup(opt);
117 #if ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS
118 /* static char* parse_command_string(char* src, char **dst);
119 * src: pointer to string containing argument
120 * dst: pointer to where to store the parsed argument
121 * return value: the pointer to the first char after the parsed argument,
122 * NULL if there was no argument parsed (only trailing spaces).
123 * Note that memory is allocated with xstrdup when a new argument was
124 * parsed. Don't forget to free it!
126 #define ARG_EMPTY 0x00
127 #define ARG_IN_DQUOTES 0x01
128 #define ARG_IN_SQUOTES 0x02
129 static char *parse_command_string(char *src, char **dst)
131 int opt_status = ARG_EMPTY;
134 /* Dumb you, I have nothing to do... */
135 if (src == NULL) return src;
137 /* Skip leading spaces */
138 while (*src == ' ') {
141 /* Is the end of string reached? */
145 /* Reached the start of an argument
146 * By the way, we duplicate a little too much
147 * here but what is too much is freed later. */
148 *dst = tmp_str = xstrdup(src);
149 /* Get to the end of that argument */
150 while (*tmp_str != '\0'
151 && (*tmp_str != ' ' || (opt_status & (ARG_IN_DQUOTES | ARG_IN_SQUOTES)))
155 if (opt_status & ARG_IN_DQUOTES) {
156 /* Already in double quotes, keep current char as is */
158 /* shift left 1 char, until end of string: get rid of the opening/closing quotes */
159 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
160 /* mark me: we enter or leave single quotes */
161 opt_status ^= ARG_IN_SQUOTES;
162 /* Back one char, as we need to re-scan the new char there. */
167 if (opt_status & ARG_IN_SQUOTES) {
168 /* Already in single quotes, keep current char as is */
170 /* shift left 1 char, until end of string: get rid of the opening/closing quotes */
171 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
172 /* mark me: we enter or leave double quotes */
173 opt_status ^= ARG_IN_DQUOTES;
174 /* Back one char, as we need to re-scan the new char there. */
179 if (opt_status & ARG_IN_SQUOTES) {
180 /* Between single quotes: keep as is. */
182 switch (*(tmp_str+1)) {
191 /* We escaped a special character. For now, keep
192 * both the back-slash and the following char. */
196 /* We escaped a space or a single or double quote,
197 * or a back-slash, or a non-escapable char. Remove
198 * the '\' and keep the new current char as is. */
199 memmove(tmp_str, tmp_str + 1, strlen(tmp_str));
204 /* Any other char that is special shall appear here.
205 * Example: $ starts a variable
207 do_variable_expansion();
211 /* any other char is kept as is. */
214 tmp_str++; /* Go to next char */
215 src++; /* Go to next char to find the end of the argument. */
217 /* End of string, but still no ending quote */
218 if (opt_status & (ARG_IN_DQUOTES | ARG_IN_SQUOTES)) {
219 bb_error_msg_and_die("unterminated (single or double) quote in options list: %s", src);
222 *dst = xrealloc(*dst, (tmp_str - *dst));
226 #define parse_command_string(src, dst) (0)
227 #endif /* ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS */
230 * This function reads aliases and default module options from a configuration file
231 * (/etc/modprobe.conf syntax). It supports includes (only files, no directories).
233 static void include_conf(struct dep_t **first, struct dep_t **current, char *buffer, int buflen, int fd)
235 int continuation_line = 0;
237 // alias parsing is not 100% correct (no correct handling of continuation lines within an alias)!
239 while (reads(fd, buffer, buflen)) {
243 p = strchr(buffer, '#');
249 while (l && isspace(buffer[l-1])) {
255 continuation_line = 0;
259 if (!continuation_line) {
260 if ((strncmp(buffer, "alias", 5) == 0) && isspace(buffer[5])) {
263 if (parse_tag_value(buffer + 6, &alias, &mod)) {
264 /* handle alias as a module dependent on the aliased module */
266 (*first) = (*current) = xzalloc(sizeof(struct dep_t));
268 (*current)->m_next = xzalloc(sizeof(struct dep_t));
269 (*current) = (*current)->m_next;
271 (*current)->m_name = xstrdup(alias);
272 (*current)->m_isalias = 1;
274 if ((strcmp(mod, "off") == 0) || (strcmp(mod, "null") == 0)) {
275 (*current)->m_depcnt = 0;
276 (*current)->m_deparr = 0;
278 (*current)->m_depcnt = 1;
279 (*current)->m_deparr = xmalloc(1 * sizeof(char *));
280 (*current)->m_deparr[0] = xstrdup(mod);
282 (*current)->m_next = 0;
284 } else if ((strncmp(buffer, "options", 7) == 0) && isspace(buffer[7])) {
287 /* split the line in the module/alias name, and options */
288 if (parse_tag_value(buffer + 8, &mod, &opt)) {
291 /* find the corresponding module */
292 for (dt = *first; dt; dt = dt->m_next) {
293 if (strcmp(dt->m_name, mod) == 0)
297 if (ENABLE_FEATURE_MODPROBE_MULTIPLE_OPTIONS) {
298 char* new_opt = NULL;
299 while ((opt = parse_command_string(opt, &new_opt))) {
300 dt->m_options = append_option(dt->m_options, new_opt);
303 dt->m_options = append_option(dt->m_options, opt);
307 } else if ((strncmp(buffer, "include", 7) == 0) && isspace(buffer[7])) {
308 int fdi; char *filename;
310 filename = skip_whitespace(buffer + 8);
312 if ((fdi = open(filename, O_RDONLY)) >= 0) {
313 include_conf(first, current, buffer, buflen, fdi);
322 * This function builds a list of dependency rules from /lib/modules/`uname -r`/modules.dep.
323 * It then fills every modules and aliases with their default options, found by parsing
324 * modprobe.conf (or modules.conf, or conf.modules).
326 static struct dep_t *build_dep(void)
330 struct dep_t *first = 0;
331 struct dep_t *current = 0;
334 int continuation_line = 0;
338 bb_error_msg_and_die("can't determine kernel version");
341 if (un.release[0] == '2') {
342 k_version = un.release[2] - '0';
345 filename = xasprintf("/lib/modules/%s/modules.dep", un.release);
346 fd = open(filename, O_RDONLY);
347 if (ENABLE_FEATURE_CLEAN_UP)
350 /* Ok, that didn't work. Fall back to looking in /lib/modules */
351 fd = open("/lib/modules/modules.dep", O_RDONLY);
357 while (reads(fd, buffer, sizeof(buffer))) {
358 int l = strlen(buffer);
361 while (l > 0 && isspace(buffer[l-1])) {
367 continuation_line = 0;
371 /* Is this a new module dep description? */
372 if (!continuation_line) {
373 /* find the dep beginning */
374 char *col = strchr(buffer, ':');
378 /* This line is a dep description */
383 /* Find the beginning of the module file name */
385 mods = bb_basename(buffer);
387 /* find the path of the module */
388 modpath = strchr(buffer, '/'); /* ... and this is the path */
390 modpath = buffer; /* module with no path */
391 /* find the end of the module name in the file name */
392 if (ENABLE_FEATURE_2_6_MODULES &&
393 (k_version > 4) && (*(col-3) == '.') &&
394 (*(col-2) == 'k') && (*(col-1) == 'o'))
397 if ((*(col-2) == '.') && (*(col-1) == 'o'))
400 mod = xstrndup(mods, dot - mods);
402 /* enqueue new module */
404 first = current = xmalloc(sizeof(struct dep_t));
406 current->m_next = xmalloc(sizeof(struct dep_t));
407 current = current->m_next;
409 current->m_name = mod;
410 current->m_path = xstrdup(modpath);
411 current->m_options = NULL;
412 current->m_isalias = 0;
413 current->m_depcnt = 0;
414 current->m_deparr = 0;
419 /* this line is not a dep description */
422 /* It's a dep description continuation */
425 while (p && *p && isblank(*p))
428 /* p points to the first dependable module; if NULL, no dependable module */
430 char *end = &buffer[l-1];
436 while (isblank(*end) || (*end == '\\'))
440 /* search the end of the dependency */
441 next = strchr(p, ' ');
448 /* find the beginning of the module file name */
449 deps = bb_basename(p);
451 while (isblank(*deps))
455 /* find the end of the module name in the file name */
456 if (ENABLE_FEATURE_2_6_MODULES
457 && (k_version > 4) && (*(next-2) == '.')
458 && (*(next-1) == 'k') && (*next == 'o'))
461 if ((*(next-1) == '.') && (*next == 'o'))
464 /* Cope with blank lines */
465 if ((next-deps-ext+1) <= 0)
467 dep = xstrndup(deps, next - deps - ext + 1);
469 /* Add the new dependable module name */
471 current->m_deparr = xrealloc(current->m_deparr,
472 sizeof(char *) * current->m_depcnt);
473 current->m_deparr[current->m_depcnt - 1] = dep;
476 } while (next < end);
479 /* is there other dependable module(s) ? */
480 if (buffer[l-1] == '\\')
481 continuation_line = 1;
483 continuation_line = 0;
488 * First parse system-specific options and aliases
489 * as they take precedence over the kernel ones.
490 * >=2.6: we only care about modprobe.conf
491 * <=2.4: we care about modules.conf and conf.modules
493 if (ENABLE_FEATURE_2_6_MODULES
494 && (fd = open("/etc/modprobe.conf", O_RDONLY)) < 0)
495 if (ENABLE_FEATURE_2_4_MODULES
496 && (fd = open("/etc/modules.conf", O_RDONLY)) < 0)
497 if (ENABLE_FEATURE_2_4_MODULES)
498 fd = open("/etc/conf.modules", O_RDONLY);
501 include_conf(&first, ¤t, buffer, sizeof(buffer), fd);
505 /* Only 2.6 has a modules.alias file */
506 if (ENABLE_FEATURE_2_6_MODULES) {
507 /* Parse kernel-declared module aliases */
508 filename = xasprintf("/lib/modules/%s/modules.alias", un.release);
509 fd = open(filename, O_RDONLY);
511 /* Ok, that didn't work. Fall back to looking in /lib/modules */
512 fd = open("/lib/modules/modules.alias", O_RDONLY);
514 if (ENABLE_FEATURE_CLEAN_UP)
518 include_conf(&first, ¤t, buffer, sizeof(buffer), fd);
522 /* Parse kernel-declared symbol aliases */
523 filename = xasprintf("/lib/modules/%s/modules.symbols", un.release);
524 fd = open(filename, O_RDONLY);
526 /* Ok, that didn't work. Fall back to looking in /lib/modules */
527 fd = open("/lib/modules/modules.symbols", O_RDONLY);
529 if (ENABLE_FEATURE_CLEAN_UP)
533 include_conf(&first, ¤t, buffer, sizeof(buffer), fd);
541 /* return 1 = loaded, 0 = not loaded, -1 = can't tell */
542 static int already_loaded(const char *name)
547 fd = open("/proc/modules", O_RDONLY);
551 while (reads(fd, buffer, sizeof(buffer))) {
554 p = strchr (buffer, ' ');
558 // Truncate buffer at first space and check for matches, with
559 // the idiosyncrasy that _ and - are interchangeable because the
560 // 2.6 kernel does weird things.
563 for (p = buffer, n = name; ; p++, n++) {
565 if ((*p == '_' || *p == '-') && (*n == '_' || *n == '-'))
569 // If we made it to the end, that's a match.
582 static int mod_process(const struct mod_list_t *list, int do_insert)
586 struct mod_opt_t *opts;
587 int argc_malloc; /* never used when CONFIG_FEATURE_CLEAN_UP not defined */
592 if (ENABLE_FEATURE_CLEAN_UP)
594 /* If CONFIG_FEATURE_CLEAN_UP is not defined, then we leak memory
595 * each time we allocate memory for argv.
596 * But it is (quite) small amounts of memory that leak each
597 * time a module is loaded, and it is reclaimed when modprobe
598 * exits anyway (even when standalone shell?).
599 * This could become a problem when loading a module with LOTS of
600 * dependencies, with LOTS of options for each dependencies, with
601 * very little memory on the target... But in that case, the module
602 * would not load because there is no more memory, so there's no
604 /* enough for minimal insmod (5 args + NULL) or rmmod (3 args + NULL) */
605 argv = xmalloc(6 * sizeof(char*));
607 if (already_loaded(list->m_name) != 1) {
608 argv[argc++] = (char*)"insmod";
609 if (ENABLE_FEATURE_2_4_MODULES) {
611 argv[argc++] = (char*)"-s";
613 argv[argc++] = (char*)"-k";
615 argv[argc++] = (char*)"-q";
616 else if (verbose) /* verbose and quiet are mutually exclusive */
617 argv[argc++] = (char*)"-v";
619 argv[argc++] = list->m_path;
620 if (ENABLE_FEATURE_CLEAN_UP)
622 opts = list->m_options;
624 /* Add one more option */
626 argv = xrealloc(argv,(argc + 1)* sizeof(char*));
627 argv[argc-1] = opts->m_opt_val;
632 /* modutils uses short name for removal */
633 if (already_loaded(list->m_name) != 0) {
634 argv[argc++] = (char*)"rmmod";
636 argv[argc++] = (char*)"-s";
637 argv[argc++] = (char*)list->m_name;
638 if (ENABLE_FEATURE_CLEAN_UP)
646 printf("%s module %s\n", do_insert?"Loading":"Unloading", list->m_name);
649 int rc2 = wait4pid(spawn(argv));
652 rc = rc2; /* only last module matters */
654 rc = 0; /* success if remove any mod */
657 if (ENABLE_FEATURE_CLEAN_UP) {
658 /* the last value in the array has index == argc, but
659 * it is the terminating NULL, so we must not free it. */
660 while (argc_malloc < argc) {
661 free(argv[argc_malloc++]);
665 if (ENABLE_FEATURE_CLEAN_UP) {
669 list = do_insert ? list->m_prev : list->m_next;
671 return (show_only) ? 0 : rc;
675 * Check the matching between a pattern and a module name.
676 * We need this as *_* is equivalent to *-*, even in pattern matching.
678 static int check_pattern(const char* pat_src, const char* mod_src)
682 if (ENABLE_FEATURE_MODPROBE_FANCY_ALIAS) {
687 pat = xstrdup(pat_src);
688 mod = xstrdup(mod_src);
690 for (p = pat; (p = strchr(p, '-')); *p++ = '_');
691 for (p = mod; (p = strchr(p, '-')); *p++ = '_');
693 ret = fnmatch(pat, mod, 0);
695 if (ENABLE_FEATURE_CLEAN_UP) {
702 return fnmatch(pat_src, mod_src, 0);
707 * Builds the dependency list (aka stack) of a module.
708 * head: the highest module in the stack (last to insmod, first to rmmod)
709 * tail: the lowest module in the stack (first to insmod, last to rmmod)
711 static void check_dep(char *mod, struct mod_list_t **head, struct mod_list_t **tail)
713 struct mod_list_t *find;
715 struct mod_opt_t *opt = 0;
718 /* Search for the given module name amongst all dependency rules.
719 * The module name in a dependency rule can be a shell pattern,
720 * so try to match the given module name against such a pattern.
721 * Of course if the name in the dependency rule is a plain string,
722 * then we consider it a pattern, and matching will still work. */
723 for (dt = depend; dt; dt = dt->m_next) {
724 if (check_pattern(dt->m_name, mod) == 0) {
730 bb_error_msg("module %s not found", mod);
734 // resolve alias names
735 while (dt->m_isalias) {
736 if (dt->m_depcnt == 1) {
739 for (adt = depend; adt; adt = adt->m_next) {
740 if (check_pattern(adt->m_name, dt->m_deparr[0]) == 0)
744 /* This is the module we are aliased to */
745 struct mod_opt_t *opts = dt->m_options;
746 /* Option of the alias are appended to the options of the module */
748 adt->m_options = append_option(adt->m_options, opts->m_opt_val);
753 bb_error_msg("module %s not found", mod);
757 bb_error_msg("bad alias %s", dt->m_name);
766 // search for duplicates
767 for (find = *head; find; find = find->m_next) {
768 if (!strcmp(mod, find->m_name)) {
769 // found ->dequeue it
772 find->m_prev->m_next = find->m_next;
774 *head = find->m_next;
777 find->m_next->m_prev = find->m_prev;
779 *tail = find->m_prev;
781 break; // there can be only one duplicate
785 if (!find) { // did not find a duplicate
786 find = xmalloc(sizeof(struct mod_list_t));
789 find->m_options = opt;
794 (*tail)->m_next = find;
795 find->m_prev = *tail;
805 /* Add all dependable module for that new module */
806 for (i = 0; i < dt->m_depcnt; i++)
807 check_dep(dt->m_deparr[i], head, tail);
811 static int mod_insert(char *mod, int argc, char **argv)
813 struct mod_list_t *tail = NULL;
814 struct mod_list_t *head = NULL;
817 // get dep list for module mod
818 check_dep(mod, &head, &tail);
824 // append module args
825 for (i = 0; i < argc; i++)
826 head->m_options = append_option(head->m_options, argv[i]);
829 // process tail ---> head
830 rc = mod_process(tail, 1);
833 * In case of using udev, multiple instances of modprobe can be
834 * spawned to load the same module (think of two same usb devices,
835 * for example; or cold-plugging at boot time). Thus we shouldn't
836 * fail if the module was loaded, and not by us.
838 if (already_loaded(mod))
845 static int mod_remove(char *mod)
848 static const struct mod_list_t rm_a_dummy = { "-a", NULL, NULL, NULL, NULL };
850 struct mod_list_t *head = NULL;
851 struct mod_list_t *tail = NULL;
854 check_dep(mod, &head, &tail);
856 head = tail = (struct mod_list_t*) &rm_a_dummy;
860 rc = mod_process(head, 0); // process head ---> tail
864 int modprobe_main(int argc, char** argv);
865 int modprobe_main(int argc, char** argv)
867 int rc = EXIT_SUCCESS;
870 opt_complementary = "?V-:q-v:v-q";
871 main_opts = getopt32(argv, "acdklnqrst:vVC:",
873 if (main_opts & (DUMP_CONF_EXIT | LIST_ALL))
875 if (main_opts & (RESTRICT_DIR | CONFIG_FILE))
876 bb_error_msg_and_die("-t and -C not supported");
878 depend = build_dep();
881 bb_error_msg_and_die("cannot parse modules.dep");
885 if (mod_remove(optind < argc ?
886 argv[optind] : NULL)) {
887 bb_error_msg("failed to remove module %s",
891 } while (++optind < argc);
894 bb_error_msg_and_die("no module or pattern provided");
896 if (mod_insert(argv[optind], argc - optind - 1, argv + optind + 1))
897 bb_error_msg_and_die("failed to load module %s", argv[optind]);
900 /* Here would be a good place to free up memory allocated during the dependencies build. */