1 /* vi: set sw=4 ts=4: */
5 * Copyright (c) 2008 Vladimir Dronnikov
6 * Copyright (c) 2008 Bernhard Reutner-Fischer (initial depmod code)
8 * Licensed under GPLv2, see file LICENSE in this source tree.
11 //applet:IF_MODPROBE_SMALL(APPLET(modprobe, _BB_DIR_SBIN, _BB_SUID_DROP))
12 //applet:IF_MODPROBE_SMALL(APPLET_ODDNAME(depmod, modprobe, _BB_DIR_SBIN, _BB_SUID_DROP, modprobe))
13 //applet:IF_MODPROBE_SMALL(APPLET_ODDNAME(insmod, modprobe, _BB_DIR_SBIN, _BB_SUID_DROP, modprobe))
14 //applet:IF_MODPROBE_SMALL(APPLET_ODDNAME(lsmod, modprobe, _BB_DIR_SBIN, _BB_SUID_DROP, modprobe))
15 //applet:IF_MODPROBE_SMALL(APPLET_ODDNAME(rmmod, modprobe, _BB_DIR_SBIN, _BB_SUID_DROP, modprobe))
18 /* After libbb.h, since it needs sys/types.h on some systems */
19 #include <sys/utsname.h> /* uname() */
22 extern int init_module(void *module, unsigned long len, const char *options);
23 extern int delete_module(const char *module, unsigned flags);
24 extern int query_module(const char *name, int which, void *buf, size_t bufsize, size_t *ret);
28 # define dbg1_error_msg(...) ((void)0)
29 # define dbg2_error_msg(...) ((void)0)
31 # define dbg1_error_msg(...) bb_error_msg(__VA_ARGS__)
32 # define dbg2_error_msg(...) bb_error_msg(__VA_ARGS__)
35 #define DEPFILE_BB CONFIG_DEFAULT_DEPMOD_FILE".bb"
38 OPT_q = (1 << 0), /* be quiet */
39 OPT_r = (1 << 1), /* module removal instead of loading */
42 typedef struct module_info {
53 char *module_load_options;
55 smallint wrote_dep_bb_ok;
56 unsigned module_count;
58 unsigned stringbuf_idx;
59 unsigned stringbuf_size;
60 char *stringbuf; /* some modules have lots of stuff */
61 /* for example, drivers/media/video/saa7134/saa7134.ko */
62 /* therefore having a fixed biggish buffer is not wise */
64 #define G (*ptr_to_globals)
65 #define modinfo (G.modinfo )
66 #define dep_bb_seen (G.dep_bb_seen )
67 #define wrote_dep_bb_ok (G.wrote_dep_bb_ok )
68 #define module_count (G.module_count )
69 #define module_found_idx (G.module_found_idx )
70 #define module_load_options (G.module_load_options)
71 #define stringbuf_idx (G.stringbuf_idx )
72 #define stringbuf_size (G.stringbuf_size )
73 #define stringbuf (G.stringbuf )
74 #define INIT_G() do { \
75 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
78 static void append(const char *s)
80 unsigned len = strlen(s);
81 if (stringbuf_idx + len + 15 > stringbuf_size) {
82 stringbuf_size = stringbuf_idx + len + 127;
83 dbg2_error_msg("grow stringbuf to %u", stringbuf_size);
84 stringbuf = xrealloc(stringbuf, stringbuf_size);
86 memcpy(stringbuf + stringbuf_idx, s, len);
90 static void appendc(char c)
92 /* We appendc() only after append(), + 15 trick in append()
93 * makes it unnecessary to check for overflow here */
94 stringbuf[stringbuf_idx++] = c;
97 static void bksp(void)
103 static void reset_stringbuf(void)
108 static char* copy_stringbuf(void)
110 char *copy = xzalloc(stringbuf_idx + 1); /* terminating NUL */
111 return memcpy(copy, stringbuf, stringbuf_idx);
114 static char* find_keyword(char *ptr, size_t len, const char *word)
118 if (!ptr) /* happens if xmalloc_open_zipped_read_close cannot read it */
123 while ((ssize_t)len > 0) {
125 /* search for the first char in word */
126 ptr = memchr(ptr, *word, len);
127 if (ptr == NULL) /* no occurance left, done */
129 if (strncmp(ptr, word, wlen) == 0)
130 return ptr + wlen; /* found, return ptr past it */
137 static void replace(char *s, char what, char with)
146 /* Take "word word", return malloced "word",NUL,"word",NUL,NUL */
147 static char* str_2_list(const char *str)
149 int len = strlen(str) + 1;
150 char *dst = xmalloc(len + 1);
153 memcpy(dst, str, len);
154 //TODO: protect against 2+ spaces: "word word"
155 replace(dst, ' ', '\0');
159 /* We use error numbers in a loose translation... */
160 static const char *moderror(int err)
164 return "invalid module format";
166 return "unknown symbol in module or invalid parameter";
168 return "module has wrong symbol version";
169 case EINVAL: /* "invalid parameter" */
170 return "unknown symbol in module or invalid parameter"
171 + sizeof("unknown symbol in module or");
173 return strerror(err);
177 static int load_module(const char *fname, const char *options)
181 size_t len = MAXINT(ssize_t);
183 dbg1_error_msg("load_module('%s','%s')", fname, options);
185 module_image = xmalloc_open_zipped_read_close(fname, &len);
186 r = (!module_image || init_module(module_image, len, options ? options : "") != 0);
188 dbg1_error_msg("load_module:%d", r);
189 return r; /* 0 = success */
192 dbg1_error_msg("load_module('%s','%s')", fname, options);
197 static void parse_module(module_info *info, const char *pathname)
203 dbg1_error_msg("parse_module('%s')", pathname);
205 /* Read (possibly compressed) module */
206 len = 64 * 1024 * 1024; /* 64 Mb at most */
207 module_image = xmalloc_open_zipped_read_close(pathname, &len);
208 //TODO: optimize redundant module body reads
210 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
214 ptr = find_keyword(module_image + pos, len - pos, "alias=");
216 ptr = find_keyword(module_image + pos, len - pos, "__ksymtab_");
219 /* DOCME: __ksymtab_gpl and __ksymtab_strings occur
220 * in many modules. What do they mean? */
221 if (strcmp(ptr, "gpl") == 0 || strcmp(ptr, "strings") == 0)
223 dbg2_error_msg("alias:'symbol:%s'", ptr);
226 dbg2_error_msg("alias:'%s'", ptr);
231 pos = (ptr - module_image);
233 bksp(); /* remove last ' ' */
234 info->aliases = copy_stringbuf();
235 replace(info->aliases, '-', '_');
237 /* "dependency1 depandency2" */
239 ptr = find_keyword(module_image, len, "depends=");
241 replace(ptr, ',', ' ');
242 replace(ptr, '-', '_');
243 dbg2_error_msg("dep:'%s'", ptr);
246 info->deps = copy_stringbuf();
251 static int pathname_matches_modname(const char *pathname, const char *modname)
253 const char *fname = bb_get_last_path_component_nostrip(pathname);
254 const char *suffix = strrstr(fname, ".ko");
255 //TODO: can do without malloc?
256 char *name = xstrndup(fname, suffix - fname);
258 replace(name, '-', '_');
259 r = (strcmp(name, modname) == 0);
264 static FAST_FUNC int fileAction(const char *pathname,
265 struct stat *sb UNUSED_PARAM,
266 void *modname_to_match,
267 int depth UNUSED_PARAM)
272 pathname += 2; /* skip "./" */
273 fname = bb_get_last_path_component_nostrip(pathname);
274 if (!strrstr(fname, ".ko")) {
275 dbg1_error_msg("'%s' is not a module", pathname);
276 return TRUE; /* not a module, continue search */
279 cur = module_count++;
280 modinfo = xrealloc_vector(modinfo, 12, cur);
281 modinfo[cur].pathname = xstrdup(pathname);
282 /*modinfo[cur].aliases = NULL; - xrealloc_vector did it */
283 /*modinfo[cur+1].pathname = NULL;*/
285 if (!pathname_matches_modname(fname, modname_to_match)) {
286 dbg1_error_msg("'%s' module name doesn't match", pathname);
287 return TRUE; /* module name doesn't match, continue search */
290 dbg1_error_msg("'%s' module name matches", pathname);
291 module_found_idx = cur;
292 parse_module(&modinfo[cur], pathname);
294 if (!(option_mask32 & OPT_r)) {
295 if (load_module(pathname, module_load_options) == 0) {
296 /* Load was successful, there is nothing else to do.
297 * This can happen ONLY for "top-level" module load,
298 * not a dep, because deps dont do dirscan. */
306 static int load_dep_bb(void)
309 FILE *fp = fopen_for_read(DEPFILE_BB);
315 dbg1_error_msg("loading "DEPFILE_BB);
317 /* Why? There is a rare scenario: we did not find modprobe.dep.bb,
318 * we scanned the dir and found no module by name, then we search
319 * for alias (full scan), and we decided to generate modprobe.dep.bb.
320 * But we see modprobe.dep.bb.new! Other modprobe is at work!
321 * We wait and other modprobe renames it to modprobe.dep.bb.
323 * But we already have modinfo[] filled, and "module_count = 0"
324 * makes us start anew. Yes, we leak modinfo[].xxx pointers -
325 * there is not much of data there anyway. */
327 memset(&modinfo[0], 0, sizeof(modinfo[0]));
329 while ((line = xmalloc_fgetline(fp)) != NULL) {
338 space = strchrnul(line, ' ');
339 cur = module_count++;
340 modinfo = xrealloc_vector(modinfo, 12, cur);
341 /*modinfo[cur+1].pathname = NULL; - xrealloc_vector did it */
342 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
345 modinfo[cur].aliases = space;
346 linebuf = xmalloc_fgetline(fp);
347 modinfo[cur].deps = linebuf ? linebuf : xzalloc(1);
348 if (modinfo[cur].deps[0]) {
349 /* deps are not "", so next line must be empty */
350 line = xmalloc_fgetline(fp);
351 /* Refuse to work with damaged config file */
353 bb_error_msg_and_die("error in %s at '%s'", DEPFILE_BB, line);
360 static int start_dep_bb_writeout(void)
364 /* depmod -n: write result to stdout */
365 if (applet_name[0] == 'd' && (option_mask32 & 1))
366 return STDOUT_FILENO;
368 fd = open(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
370 if (errno == EEXIST) {
372 dbg1_error_msg(DEPFILE_BB".new exists, waiting for "DEPFILE_BB);
374 usleep(1000*1000 / 20);
376 dbg1_error_msg(DEPFILE_BB" appeared");
377 return -2; /* magic number */
382 bb_error_msg("deleting stale %s", DEPFILE_BB".new");
383 fd = open_or_warn(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC);
386 dbg1_error_msg("opened "DEPFILE_BB".new:%d", fd);
390 static void write_out_dep_bb(int fd)
395 /* We want good error reporting. fdprintf is not good enough. */
396 fp = xfdopen_for_write(fd);
398 while (modinfo[i].pathname) {
399 fprintf(fp, "%s%s%s\n" "%s%s\n",
400 modinfo[i].pathname, modinfo[i].aliases[0] ? " " : "", modinfo[i].aliases,
401 modinfo[i].deps, modinfo[i].deps[0] ? "\n" : "");
404 /* Badly formatted depfile is a no-no. Be paranoid. */
406 if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
409 if (fd == STDOUT_FILENO) /* it was depmod -n */
412 if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
414 bb_perror_msg("can't create '%s'", DEPFILE_BB);
415 unlink(DEPFILE_BB".new");
419 dbg1_error_msg("created "DEPFILE_BB);
423 static module_info* find_alias(const char *alias)
428 dbg1_error_msg("find_alias('%s')", alias);
431 /* First try to find by name (cheaper) */
433 while (modinfo[i].pathname) {
434 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
435 dbg1_error_msg("found '%s' in module '%s'",
436 alias, modinfo[i].pathname);
437 if (!modinfo[i].aliases) {
438 parse_module(&modinfo[i], modinfo[i].pathname);
445 /* Ok, we definitely have to scan module bodies. This is a good
446 * moment to generate modprobe.dep.bb, if it does not exist yet */
447 dep_bb_fd = dep_bb_seen ? -1 : start_dep_bb_writeout();
448 if (dep_bb_fd == -2) /* modprobe.dep.bb appeared? */
451 /* Scan all module bodies, extract modinfo (it contains aliases) */
454 while (modinfo[i].pathname) {
456 if (!modinfo[i].aliases) {
457 parse_module(&modinfo[i], modinfo[i].pathname);
463 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
464 desc = str_2_list(modinfo[i].aliases);
465 /* Does matching substring exist? */
466 for (s = desc; *s; s += strlen(s) + 1) {
467 /* Aliases in module bodies can be defined with
468 * shell patterns. Example:
469 * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
470 * Plain strcmp() won't catch that */
471 if (fnmatch(s, alias, 0) == 0) {
472 dbg1_error_msg("found alias '%s' in module '%s'",
473 alias, modinfo[i].pathname);
474 result = &modinfo[i];
479 if (result && dep_bb_fd < 0)
484 /* Create module.dep.bb if needed */
485 if (dep_bb_fd >= 0) {
486 write_out_dep_bb(dep_bb_fd);
489 dbg1_error_msg("find_alias '%s' returns %p", alias, result);
493 #if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
494 // TODO: open only once, invent config_rewind()
495 static int already_loaded(const char *name)
499 parser_t *parser = config_open2("/proc/modules", xfopen_for_read);
500 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY)) {
501 if (strcmp(s, name) == 0) {
506 config_close(parser);
510 #define already_loaded(name) is_rmmod
514 * Given modules definition and module name (or alias, or symbol)
515 * load/remove the module respecting dependencies.
516 * NB: also called by depmod with bogus name "/",
517 * just in order to force modprobe.dep.bb creation.
519 #if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
520 #define process_module(a,b) process_module(a)
521 #define cmdline_options ""
523 static void process_module(char *name, const char *cmdline_options)
525 char *s, *deps, *options;
527 int is_rmmod = (option_mask32 & OPT_r) != 0;
528 dbg1_error_msg("process_module('%s','%s')", name, cmdline_options);
530 replace(name, '-', '_');
532 dbg1_error_msg("already_loaded:%d is_rmmod:%d", already_loaded(name), is_rmmod);
533 if (already_loaded(name) != is_rmmod) {
534 dbg1_error_msg("nothing to do for '%s'", name);
540 char *opt_filename = xasprintf("/etc/modules/%s", name);
541 options = xmalloc_open_read_close(opt_filename, NULL);
543 replace(options, '\n', ' ');
544 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
545 if (cmdline_options) {
546 /* NB: cmdline_options always have one leading ' '
547 * (see main()), we remove it here */
548 char *op = xasprintf(options ? "%s %s" : "%s %s" + 3,
549 cmdline_options + 1, options);
555 module_load_options = options;
556 dbg1_error_msg("process_module('%s'): options:'%s'", name, options);
560 /* Scan module directory. This is done only once.
561 * It will attempt module load, and will exit(EXIT_SUCCESS)
563 module_found_idx = -1;
564 recursive_action(".",
565 ACTION_RECURSE, /* flags */
566 fileAction, /* file action */
567 NULL, /* dir action */
568 name, /* user data */
570 dbg1_error_msg("dirscan complete");
571 /* Module was not found, or load failed, or is_rmmod */
572 if (module_found_idx >= 0) { /* module was found */
573 info = &modinfo[module_found_idx];
574 } else { /* search for alias, not a plain module name */
575 info = find_alias(name);
578 info = find_alias(name);
581 // Problem here: there can be more than one module
582 // for the given alias. For example,
583 // "pci:v00008086d00007010sv00000000sd00000000bc01sc01i80" matches
584 // ata_piix because it has an alias "pci:v00008086d00007010sv*sd*bc*sc*i*"
585 // and ata_generic, it has an alias "alias=pci:v*d*sv*sd*bc01sc01i*"
586 // Standard modprobe would load them both.
587 // In this code, find_alias() returns only the first matching module.
589 /* rmmod? unload it by name */
591 if (delete_module(name, O_NONBLOCK | O_EXCL) != 0) {
592 if (!(option_mask32 & OPT_q))
593 bb_perror_msg("remove '%s'", name);
596 /* N.B. we do not stop here -
597 * continue to unload modules on which the module depends:
598 * "-r --remove: option causes modprobe to remove a module.
599 * If the modules it depends on are also unused, modprobe
600 * will try to remove them, too." */
604 /* both dirscan and find_alias found nothing */
605 if (!is_rmmod && applet_name[0] != 'd') /* it wasn't rmmod or depmod */
606 bb_error_msg("module '%s' not found", name);
607 //TODO: _and_die()? or should we continue (un)loading modules listed on cmdline?
611 /* Iterate thru dependencies, trying to (un)load them */
612 deps = str_2_list(info->deps);
613 for (s = deps; *s; s += strlen(s) + 1) {
614 //if (strcmp(name, s) != 0) // N.B. do loops exist?
615 dbg1_error_msg("recurse on dep '%s'", s);
616 process_module(s, NULL);
617 dbg1_error_msg("recurse on dep '%s' done", s);
621 /* modprobe -> load it */
623 if (!options || strstr(options, "blacklist") == NULL) {
625 if (load_module(info->pathname, options) != 0) {
626 if (EEXIST != errno) {
627 bb_error_msg("'%s': %s",
631 dbg1_error_msg("'%s': %s",
637 dbg1_error_msg("'%s': blacklisted", info->pathname);
642 //TODO: return load attempt result from process_module.
643 //If dep didn't load ok, continuing makes little sense.
645 #undef cmdline_options
648 /* For reference, module-init-tools v3.4 options:
651 Usage: insmod filename [args]
654 Usage: rmmod [-fhswvV] modulename ...
655 -f (or --force) forces a module unload, and may crash your
656 machine. This requires the Forced Module Removal option
657 when the kernel was compiled.
658 -h (or --help) prints this help text
659 -s (or --syslog) says use syslog, not stderr
660 -v (or --verbose) enables more messages
661 -V (or --version) prints the version code
662 -w (or --wait) begins module removal even if it is used
663 and will stop new users from accessing the module (so it
664 should eventually fall to zero).
667 Usage: modprobe [-v] [-V] [-C config-file] [-n] [-i] [-q] [-b]
668 [-o <modname>] [ --dump-modversions ] <modname> [parameters...]
669 modprobe -r [-n] [-i] [-v] <modulename> ...
670 modprobe -l -t <dirname> [ -a <modulename> ...]
673 depmod 3.4 -- part of module-init-tools
674 depmod -[aA] [-n -e -v -q -V -r -u]
675 [-b basedirectory] [forced_version]
676 depmod [-n -e -v -q -r -u] [-F kernelsyms] module1.ko module2.ko ...
677 If no arguments (except options) are given, "depmod -a" is assumed.
678 depmod will output a dependency list suitable for the modprobe utility.
680 -a, --all Probe all modules
681 -A, --quick Only does the work if there's a new module
682 -n, --show Write the dependency file on stdout only
683 -e, --errsyms Report not supplied symbols
684 -V, --version Print the release version
685 -v, --verbose Enable verbose mode
686 -h, --help Print this usage message
687 The following options are useful for people managing distributions:
689 --basedir basedirectory
690 Use an image of a module tree
692 --filesyms kernelsyms
693 Use the file instead of the current kernel symbols
696 //usage:#if ENABLE_MODPROBE_SMALL
697 //usage:#define modprobe_trivial_usage
698 //usage: "[-qfwrsv] MODULE [symbol=value]..."
699 //usage:#define modprobe_full_usage "\n\n"
701 //usage: "\n -r Remove MODULE (stacks) or do autoclean"
702 //usage: "\n -q Quiet"
703 //usage: "\n -v Verbose"
704 //usage: "\n -f Force"
705 //usage: "\n -w Wait for unload"
706 //usage: "\n -s Report via syslog instead of stderr"
707 //usage:#endif /* ENABLE_MODPROBE_SMALL */
709 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
710 int modprobe_main(int argc UNUSED_PARAM, char **argv)
713 char applet0 = applet_name[0];
714 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
716 /* are we lsmod? -> just dump /proc/modules */
717 if ('l' == applet0) {
718 xprint_and_close_file(xfopen_for_read("/proc/modules"));
724 /* Prevent ugly corner cases with no modules at all */
725 modinfo = xzalloc(sizeof(modinfo[0]));
727 if ('i' != applet0) { /* not insmod */
728 /* Goto modules directory */
729 xchdir(CONFIG_DEFAULT_MODULES_DIR);
731 uname(&uts); /* never fails */
734 if ('d' == applet0) {
736 * -n: print result to stdout
737 * -a: process all modules (default)
738 * optional VERSION parameter
740 * -A: do work only if a module is newer than depfile
741 * -e: report any symbols which a module needs
742 * which are not supplied by other modules or the kernel
743 * -F FILE: System.map (symbols for -e)
746 * -b BASEDIR: (TODO!) modules are in
747 * $BASEDIR/lib/modules/$VERSION
748 * -v: human readable deps to stdout
749 * -V: version (don't want to support it - people may depend
750 * on it as an indicator of "standard" depmod)
751 * -h: help (well duh)
752 * module1.o module2.o parameters (just ignored for now)
754 getopt32(argv, "na" "AeF:qru" /* "b:vV", NULL */, NULL);
756 /* if (argv[0] && argv[1]) bb_show_usage(); */
757 /* Goto $VERSION directory */
758 xchdir(argv[0] ? argv[0] : uts.release);
759 /* Force full module scan by asking to find a bogus module.
760 * This will generate modules.dep.bb as a side effect. */
761 process_module((char*)"/", NULL);
762 return !wrote_dep_bb_ok;
765 /* insmod, modprobe, rmmod require at least one argument */
766 opt_complementary = "-1";
767 /* only -q (quiet) and -r (rmmod),
768 * the rest are accepted and ignored (compat) */
769 getopt32(argv, "qrfsvw");
772 /* are we rmmod? -> simulate modprobe -r */
773 if ('r' == applet0) {
774 option_mask32 |= OPT_r;
777 if ('i' != applet0) { /* not insmod */
778 /* Goto $VERSION directory */
782 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
783 /* If not rmmod, parse possible module options given on command line.
784 * insmod/modprobe takes one module name, the rest are parameters. */
786 if ('r' != applet0) {
789 /* Enclose options in quotes */
791 options = xasprintf("%s \"%s\"", s ? s : "", *arg);
801 if ('i' == applet0) { /* insmod */
805 len = MAXINT(ssize_t);
806 map = xmalloc_xopen_read_close(*argv, &len);
807 if (init_module(map, len,
808 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(options ? options : "")
809 IF_NOT_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE("")
811 bb_error_msg_and_die("can't insert '%s': %s",
812 *argv, moderror(errno));
816 /* Try to load modprobe.dep.bb */
819 /* Load/remove modules.
820 * Only rmmod loops here, modprobe has only argv[0] */
822 process_module(*argv, options);
825 if (ENABLE_FEATURE_CLEAN_UP) {
826 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)