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 tarball for details.
13 #include <sys/utsname.h> /* uname() */
16 extern int init_module(void *module, unsigned long len, const char *options);
17 extern int delete_module(const char *module, unsigned flags);
18 extern int query_module(const char *name, int which, void *buf, size_t bufsize, size_t *ret);
21 #define dbg1_error_msg(...) ((void)0)
22 #define dbg2_error_msg(...) ((void)0)
23 //#define dbg1_error_msg(...) bb_error_msg(__VA_ARGS__)
24 //#define dbg2_error_msg(...) bb_error_msg(__VA_ARGS__)
26 #define DEPFILE_BB CONFIG_DEFAULT_DEPMOD_FILE".bb"
29 OPT_q = (1 << 0), /* be quiet */
30 OPT_r = (1 << 1), /* module removal instead of loading */
33 typedef struct module_info {
44 char *module_load_options;
46 smallint wrote_dep_bb_ok;
50 char stringbuf[32 * 1024]; /* some modules have lots of stuff */
51 /* for example, drivers/media/video/saa7134/saa7134.ko */
53 #define G (*ptr_to_globals)
54 #define modinfo (G.modinfo )
55 #define dep_bb_seen (G.dep_bb_seen )
56 #define wrote_dep_bb_ok (G.wrote_dep_bb_ok )
57 #define module_count (G.module_count )
58 #define module_found_idx (G.module_found_idx )
59 #define module_load_options (G.module_load_options)
60 #define stringbuf_idx (G.stringbuf_idx )
61 #define stringbuf (G.stringbuf )
62 #define INIT_G() do { \
63 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
67 static void appendc(char c)
69 if (stringbuf_idx < sizeof(stringbuf))
70 stringbuf[stringbuf_idx++] = c;
73 static void bksp(void)
79 static void append(const char *s)
81 size_t len = strlen(s);
82 if (stringbuf_idx + len < sizeof(stringbuf)) {
83 memcpy(stringbuf + stringbuf_idx, s, len);
88 static void reset_stringbuf(void)
93 static char* copy_stringbuf(void)
95 char *copy = xmalloc(stringbuf_idx);
96 return memcpy(copy, stringbuf, stringbuf_idx);
99 static char* find_keyword(char *ptr, size_t len, const char *word)
103 if (!ptr) /* happens if xmalloc_open_zipped_read_close cannot read it */
108 while ((ssize_t)len > 0) {
110 /* search for the first char in word */
111 ptr = memchr(ptr, *word, len);
112 if (ptr == NULL) /* no occurance left, done */
114 if (strncmp(ptr, word, wlen) == 0)
115 return ptr + wlen; /* found, return ptr past it */
122 static void replace(char *s, char what, char with)
131 /* Take "word word", return malloced "word",NUL,"word",NUL,NUL */
132 static char* str_2_list(const char *str)
134 int len = strlen(str) + 1;
135 char *dst = xmalloc(len + 1);
138 memcpy(dst, str, len);
139 //TODO: protect against 2+ spaces: "word word"
140 replace(dst, ' ', '\0');
144 /* We use error numbers in a loose translation... */
145 static const char *moderror(int err)
149 return "invalid module format";
151 return "unknown symbol in module or invalid parameter";
153 return "module has wrong symbol version";
154 case EINVAL: /* "invalid parameter" */
155 return "unknown symbol in module or invalid parameter"
156 + sizeof("unknown symbol in module or");
158 return strerror(err);
162 static int load_module(const char *fname, const char *options)
166 size_t len = MAXINT(ssize_t);
168 dbg1_error_msg("load_module('%s','%s')", fname, options);
170 module_image = xmalloc_open_zipped_read_close(fname, &len);
171 r = (!module_image || init_module(module_image, len, options ? options : "") != 0);
173 dbg1_error_msg("load_module:%d", r);
174 return r; /* 0 = success */
177 dbg1_error_msg("load_module('%s','%s')", fname, options);
182 static void parse_module(module_info *info, const char *pathname)
188 dbg1_error_msg("parse_module('%s')", pathname);
190 /* Read (possibly compressed) module */
191 len = 64 * 1024 * 1024; /* 64 Mb at most */
192 module_image = xmalloc_open_zipped_read_close(pathname, &len);
193 //TODO: optimize redundant module body reads
195 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
199 ptr = find_keyword(module_image + pos, len - pos, "alias=");
201 ptr = find_keyword(module_image + pos, len - pos, "__ksymtab_");
204 /* DOCME: __ksymtab_gpl and __ksymtab_strings occur
205 * in many modules. What do they mean? */
206 if (strcmp(ptr, "gpl") == 0 || strcmp(ptr, "strings") == 0)
208 dbg2_error_msg("alias:'symbol:%s'", ptr);
211 dbg2_error_msg("alias:'%s'", ptr);
216 pos = (ptr - module_image);
218 bksp(); /* remove last ' ' */
220 info->aliases = copy_stringbuf();
222 /* "dependency1 depandency2" */
224 ptr = find_keyword(module_image, len, "depends=");
226 replace(ptr, ',', ' ');
227 replace(ptr, '-', '_');
228 dbg2_error_msg("dep:'%s'", ptr);
232 info->deps = copy_stringbuf();
237 static int pathname_matches_modname(const char *pathname, const char *modname)
239 const char *fname = bb_get_last_path_component_nostrip(pathname);
240 const char *suffix = strrstr(fname, ".ko");
241 //TODO: can do without malloc?
242 char *name = xstrndup(fname, suffix - fname);
244 replace(name, '-', '_');
245 r = (strcmp(name, modname) == 0);
250 static FAST_FUNC int fileAction(const char *pathname,
251 struct stat *sb UNUSED_PARAM,
252 void *modname_to_match,
253 int depth UNUSED_PARAM)
258 pathname += 2; /* skip "./" */
259 fname = bb_get_last_path_component_nostrip(pathname);
260 if (!strrstr(fname, ".ko")) {
261 dbg1_error_msg("'%s' is not a module", pathname);
262 return TRUE; /* not a module, continue search */
265 cur = module_count++;
266 modinfo = xrealloc_vector(modinfo, 12, cur);
267 modinfo[cur].pathname = xstrdup(pathname);
268 /*modinfo[cur].aliases = NULL; - xrealloc_vector did it */
269 /*modinfo[cur+1].pathname = NULL;*/
271 if (!pathname_matches_modname(fname, modname_to_match)) {
272 dbg1_error_msg("'%s' module name doesn't match", pathname);
273 return TRUE; /* module name doesn't match, continue search */
276 dbg1_error_msg("'%s' module name matches", pathname);
277 module_found_idx = cur;
278 parse_module(&modinfo[cur], pathname);
280 if (!(option_mask32 & OPT_r)) {
281 if (load_module(pathname, module_load_options) == 0) {
282 /* Load was successful, there is nothing else to do.
283 * This can happen ONLY for "top-level" module load,
284 * not a dep, because deps dont do dirscan. */
292 static int load_dep_bb(void)
295 FILE *fp = fopen_for_read(DEPFILE_BB);
301 dbg1_error_msg("loading "DEPFILE_BB);
303 /* Why? There is a rare scenario: we did not find modprobe.dep.bb,
304 * we scanned the dir and found no module by name, then we search
305 * for alias (full scan), and we decided to generate modprobe.dep.bb.
306 * But we see modprobe.dep.bb.new! Other modprobe is at work!
307 * We wait and other modprobe renames it to modprobe.dep.bb.
309 * But we already have modinfo[] filled, and "module_count = 0"
310 * makes us start anew. Yes, we leak modinfo[].xxx pointers -
311 * there is not much of data there anyway. */
313 memset(&modinfo[0], 0, sizeof(modinfo[0]));
315 while ((line = xmalloc_fgetline(fp)) != NULL) {
324 space = strchrnul(line, ' ');
325 cur = module_count++;
326 modinfo = xrealloc_vector(modinfo, 12, cur);
327 /*modinfo[cur+1].pathname = NULL; - xrealloc_vector did it */
328 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
331 modinfo[cur].aliases = space;
332 linebuf = xmalloc_fgetline(fp);
333 modinfo[cur].deps = linebuf ? linebuf : xzalloc(1);
334 if (modinfo[cur].deps[0]) {
335 /* deps are not "", so next line must be empty */
336 line = xmalloc_fgetline(fp);
337 /* Refuse to work with damaged config file */
339 bb_error_msg_and_die("error in %s at '%s'", DEPFILE_BB, line);
346 static int start_dep_bb_writeout(void)
350 /* depmod -n: write result to stdout */
351 if (applet_name[0] == 'd' && (option_mask32 & 1))
352 return STDOUT_FILENO;
354 fd = open(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
356 if (errno == EEXIST) {
358 dbg1_error_msg(DEPFILE_BB".new exists, waiting for "DEPFILE_BB);
360 usleep(1000*1000 / 20);
362 dbg1_error_msg(DEPFILE_BB" appeared");
363 return -2; /* magic number */
368 bb_error_msg("deleting stale %s", DEPFILE_BB".new");
369 fd = open_or_warn(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC);
372 dbg1_error_msg("opened "DEPFILE_BB".new:%d", fd);
376 static void write_out_dep_bb(int fd)
381 /* We want good error reporting. fdprintf is not good enough. */
382 fp = fdopen(fd, "w");
388 while (modinfo[i].pathname) {
389 fprintf(fp, "%s%s%s\n" "%s%s\n",
390 modinfo[i].pathname, modinfo[i].aliases[0] ? " " : "", modinfo[i].aliases,
391 modinfo[i].deps, modinfo[i].deps[0] ? "\n" : "");
394 /* Badly formatted depfile is a no-no. Be paranoid. */
396 if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
399 if (fd == STDOUT_FILENO) /* it was depmod -n */
402 if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
404 bb_perror_msg("can't create %s", DEPFILE_BB);
405 unlink(DEPFILE_BB".new");
409 dbg1_error_msg("created "DEPFILE_BB);
413 static module_info* find_alias(const char *alias)
418 dbg1_error_msg("find_alias('%s')", alias);
421 /* First try to find by name (cheaper) */
423 while (modinfo[i].pathname) {
424 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
425 dbg1_error_msg("found '%s' in module '%s'",
426 alias, modinfo[i].pathname);
427 if (!modinfo[i].aliases) {
428 parse_module(&modinfo[i], modinfo[i].pathname);
435 /* Ok, we definitely have to scan module bodies. This is a good
436 * moment to generate modprobe.dep.bb, if it does not exist yet */
437 dep_bb_fd = dep_bb_seen ? -1 : start_dep_bb_writeout();
438 if (dep_bb_fd == -2) /* modprobe.dep.bb appeared? */
441 /* Scan all module bodies, extract modinfo (it contains aliases) */
444 while (modinfo[i].pathname) {
446 if (!modinfo[i].aliases) {
447 parse_module(&modinfo[i], modinfo[i].pathname);
453 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
454 desc = str_2_list(modinfo[i].aliases);
455 /* Does matching substring exist? */
456 for (s = desc; *s; s += strlen(s) + 1) {
457 /* Aliases in module bodies can be defined with
458 * shell patterns. Example:
459 * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
460 * Plain strcmp() won't catch that */
461 if (fnmatch(s, alias, 0) == 0) {
462 dbg1_error_msg("found alias '%s' in module '%s'",
463 alias, modinfo[i].pathname);
464 result = &modinfo[i];
469 if (result && dep_bb_fd < 0)
474 /* Create module.dep.bb if needed */
475 if (dep_bb_fd >= 0) {
476 write_out_dep_bb(dep_bb_fd);
479 dbg1_error_msg("find_alias '%s' returns %p", alias, result);
483 #if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
484 // TODO: open only once, invent config_rewind()
485 static int already_loaded(const char *name)
489 parser_t *parser = config_open2("/proc/modules", xfopen_for_read);
490 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY)) {
491 if (strcmp(s, name) == 0) {
496 config_close(parser);
500 #define already_loaded(name) is_rmmod
504 * Given modules definition and module name (or alias, or symbol)
505 * load/remove the module respecting dependencies.
506 * NB: also called by depmod with bogus name "/",
507 * just in order to force modprobe.dep.bb creation.
509 #if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
510 #define process_module(a,b) process_module(a)
511 #define cmdline_options ""
513 static void process_module(char *name, const char *cmdline_options)
515 char *s, *deps, *options;
517 int is_rmmod = (option_mask32 & OPT_r) != 0;
518 dbg1_error_msg("process_module('%s','%s')", name, cmdline_options);
520 replace(name, '-', '_');
522 dbg1_error_msg("already_loaded:%d is_rmmod:%d", already_loaded(name), is_rmmod);
523 if (already_loaded(name) != is_rmmod) {
524 dbg1_error_msg("nothing to do for '%s'", name);
530 char *opt_filename = xasprintf("/etc/modules/%s", name);
531 options = xmalloc_open_read_close(opt_filename, NULL);
533 replace(options, '\n', ' ');
534 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
535 if (cmdline_options) {
536 /* NB: cmdline_options always have one leading ' '
537 * (see main()), we remove it here */
538 char *op = xasprintf(options ? "%s %s" : "%s %s" + 3,
539 cmdline_options + 1, options);
545 module_load_options = options;
546 dbg1_error_msg("process_module('%s'): options:'%s'", name, options);
550 /* Scan module directory. This is done only once.
551 * It will attempt module load, and will exit(EXIT_SUCCESS)
553 module_found_idx = -1;
554 recursive_action(".",
555 ACTION_RECURSE, /* flags */
556 fileAction, /* file action */
557 NULL, /* dir action */
558 name, /* user data */
560 dbg1_error_msg("dirscan complete");
561 /* Module was not found, or load failed, or is_rmmod */
562 if (module_found_idx >= 0) { /* module was found */
563 info = &modinfo[module_found_idx];
564 } else { /* search for alias, not a plain module name */
565 info = find_alias(name);
568 info = find_alias(name);
571 /* rmmod? unload it by name */
573 if (delete_module(name, O_NONBLOCK | O_EXCL) != 0
574 && !(option_mask32 & OPT_q)
576 bb_perror_msg("remove '%s'", name);
579 /* N.B. we do not stop here -
580 * continue to unload modules on which the module depends:
581 * "-r --remove: option causes modprobe to remove a module.
582 * If the modules it depends on are also unused, modprobe
583 * will try to remove them, too." */
587 /* both dirscan and find_alias found nothing */
588 if (applet_name[0] != 'd') /* it wasn't depmod */
589 bb_error_msg("module '%s' not found", name);
594 /* Iterate thru dependencies, trying to (un)load them */
595 deps = str_2_list(info->deps);
596 for (s = deps; *s; s += strlen(s) + 1) {
597 //if (strcmp(name, s) != 0) // N.B. do loops exist?
598 dbg1_error_msg("recurse on dep '%s'", s);
599 process_module(s, NULL);
600 dbg1_error_msg("recurse on dep '%s' done", s);
604 /* modprobe -> load it */
606 if (!options || strstr(options, "blacklist") == NULL) {
608 if (load_module(info->pathname, options) != 0) {
609 if (EEXIST != errno) {
610 bb_error_msg("'%s': %s",
614 dbg1_error_msg("'%s': %s",
620 dbg1_error_msg("'%s': blacklisted", info->pathname);
625 //TODO: return load attempt result from process_module.
626 //If dep didn't load ok, continuing makes little sense.
628 #undef cmdline_options
631 /* For reference, module-init-tools v3.4 options:
634 Usage: insmod filename [args]
637 Usage: rmmod [-fhswvV] modulename ...
638 -f (or --force) forces a module unload, and may crash your
639 machine. This requires the Forced Module Removal option
640 when the kernel was compiled.
641 -h (or --help) prints this help text
642 -s (or --syslog) says use syslog, not stderr
643 -v (or --verbose) enables more messages
644 -V (or --version) prints the version code
645 -w (or --wait) begins module removal even if it is used
646 and will stop new users from accessing the module (so it
647 should eventually fall to zero).
650 Usage: modprobe [-v] [-V] [-C config-file] [-n] [-i] [-q] [-b]
651 [-o <modname>] [ --dump-modversions ] <modname> [parameters...]
652 modprobe -r [-n] [-i] [-v] <modulename> ...
653 modprobe -l -t <dirname> [ -a <modulename> ...]
656 depmod 3.4 -- part of module-init-tools
657 depmod -[aA] [-n -e -v -q -V -r -u]
658 [-b basedirectory] [forced_version]
659 depmod [-n -e -v -q -r -u] [-F kernelsyms] module1.ko module2.ko ...
660 If no arguments (except options) are given, "depmod -a" is assumed.
661 depmod will output a dependency list suitable for the modprobe utility.
663 -a, --all Probe all modules
664 -A, --quick Only does the work if there's a new module
665 -n, --show Write the dependency file on stdout only
666 -e, --errsyms Report not supplied symbols
667 -V, --version Print the release version
668 -v, --verbose Enable verbose mode
669 -h, --help Print this usage message
670 The following options are useful for people managing distributions:
672 --basedir basedirectory
673 Use an image of a module tree
675 --filesyms kernelsyms
676 Use the file instead of the current kernel symbols
679 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
680 int modprobe_main(int argc UNUSED_PARAM, char **argv)
683 char applet0 = applet_name[0];
684 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
686 /* are we lsmod? -> just dump /proc/modules */
687 if ('l' == applet0) {
688 xprint_and_close_file(xfopen_for_read("/proc/modules"));
694 /* Prevent ugly corner cases with no modules at all */
695 modinfo = xzalloc(sizeof(modinfo[0]));
697 if ('i' != applet0) { /* not insmod */
698 /* Goto modules directory */
699 xchdir(CONFIG_DEFAULT_MODULES_DIR);
701 uname(&uts); /* never fails */
704 if ('d' == applet0) {
706 * -n: print result to stdout
707 * -a: process all modules (default)
708 * optional VERSION parameter
710 * -A: do work only if a module is newer than depfile
711 * -e: report any symbols which a module needs
712 * which are not supplied by other modules or the kernel
713 * -F FILE: System.map (symbols for -e)
716 * -b BASEDIR: (TODO!) modules are in
717 * $BASEDIR/lib/modules/$VERSION
718 * -v: human readable deps to stdout
719 * -V: version (don't want to support it - people may depend
720 * on it as an indicator of "standard" depmod)
721 * -h: help (well duh)
722 * module1.o module2.o parameters (just ignored for now)
724 getopt32(argv, "na" "AeF:qru" /* "b:vV", NULL */, NULL);
726 /* if (argv[0] && argv[1]) bb_show_usage(); */
727 /* Goto $VERSION directory */
728 xchdir(argv[0] ? argv[0] : uts.release);
729 /* Force full module scan by asking to find a bogus module.
730 * This will generate modules.dep.bb as a side effect. */
731 process_module((char*)"/", NULL);
732 return !wrote_dep_bb_ok;
735 /* insmod, modprobe, rmmod require at least one argument */
736 opt_complementary = "-1";
737 /* only -q (quiet) and -r (rmmod),
738 * the rest are accepted and ignored (compat) */
739 getopt32(argv, "qrfsvw");
742 /* are we rmmod? -> simulate modprobe -r */
743 if ('r' == applet0) {
744 option_mask32 |= OPT_r;
747 if ('i' != applet0) { /* not insmod */
748 /* Goto $VERSION directory */
752 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
753 /* If not rmmod, parse possible module options given on command line.
754 * insmod/modprobe takes one module name, the rest are parameters. */
756 if ('r' != applet0) {
759 /* Enclose options in quotes */
761 options = xasprintf("%s \"%s\"", s ? s : "", *arg);
771 if ('i' == applet0) { /* insmod */
775 len = MAXINT(ssize_t);
776 map = xmalloc_xopen_read_close(*argv, &len);
777 if (init_module(map, len,
778 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(options ? options : "")
779 IF_NOT_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE("")
781 bb_error_msg_and_die("can't insert '%s': %s",
782 *argv, moderror(errno));
786 /* Try to load modprobe.dep.bb */
789 /* Load/remove modules.
790 * Only rmmod loops here, modprobe has only argv[0] */
792 process_module(*argv++, options);
795 if (ENABLE_FEATURE_CLEAN_UP) {
796 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)