1 /* vi: set sw=4 ts=4: */
5 * Copyright (c) 2008 Vladimir Dronnikov
6 * Copyright (c) 2008 Bernhard 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 read_module 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 #if ENABLE_FEATURE_MODPROBE_SMALL_ZIPPED
145 # define read_module xmalloc_open_zipped_read_close
147 # define read_module xmalloc_open_read_close
150 /* We use error numbers in a loose translation... */
151 static const char *moderror(int err)
155 return "invalid module format";
157 return "unknown symbol in module or invalid parameter";
159 return "module has wrong symbol version";
160 case EINVAL: /* "invalid parameter" */
161 return "unknown symbol in module or invalid parameter"
162 + sizeof("unknown symbol in module or");
164 return strerror(err);
168 static int load_module(const char *fname, const char *options)
172 size_t len = MAXINT(ssize_t);
174 dbg1_error_msg("load_module('%s','%s')", fname, options);
176 module_image = read_module(fname, &len);
177 r = (!module_image || init_module(module_image, len, options ? options : "") != 0);
179 dbg1_error_msg("load_module:%d", r);
180 return r; /* 0 = success */
183 dbg1_error_msg("load_module('%s','%s')", fname, options);
188 static void parse_module(module_info *info, const char *pathname)
194 dbg1_error_msg("parse_module('%s')", pathname);
196 /* Read (possibly compressed) module */
197 len = 64 * 1024 * 1024; /* 64 Mb at most */
198 module_image = read_module(pathname, &len);
199 //TODO: optimize redundant module body reads
201 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
205 ptr = find_keyword(module_image + pos, len - pos, "alias=");
207 ptr = find_keyword(module_image + pos, len - pos, "__ksymtab_");
210 /* DOCME: __ksymtab_gpl and __ksymtab_strings occur
211 * in many modules. What do they mean? */
212 if (strcmp(ptr, "gpl") == 0 || strcmp(ptr, "strings") == 0)
214 dbg2_error_msg("alias:'symbol:%s'", ptr);
217 dbg2_error_msg("alias:'%s'", ptr);
222 pos = (ptr - module_image);
224 bksp(); /* remove last ' ' */
226 info->aliases = copy_stringbuf();
228 /* "dependency1 depandency2" */
230 ptr = find_keyword(module_image, len, "depends=");
232 replace(ptr, ',', ' ');
233 replace(ptr, '-', '_');
234 dbg2_error_msg("dep:'%s'", ptr);
238 info->deps = copy_stringbuf();
243 static int pathname_matches_modname(const char *pathname, const char *modname)
245 const char *fname = bb_get_last_path_component_nostrip(pathname);
246 const char *suffix = strrstr(fname, ".ko");
247 //TODO: can do without malloc?
248 char *name = xstrndup(fname, suffix - fname);
250 replace(name, '-', '_');
251 r = (strcmp(name, modname) == 0);
256 static FAST_FUNC int fileAction(const char *pathname,
257 struct stat *sb UNUSED_PARAM,
258 void *modname_to_match,
259 int depth UNUSED_PARAM)
264 pathname += 2; /* skip "./" */
265 fname = bb_get_last_path_component_nostrip(pathname);
266 if (!strrstr(fname, ".ko")) {
267 dbg1_error_msg("'%s' is not a module", pathname);
268 return TRUE; /* not a module, continue search */
271 cur = module_count++;
272 modinfo = xrealloc_vector(modinfo, 12, cur);
273 modinfo[cur].pathname = xstrdup(pathname);
274 /*modinfo[cur].aliases = NULL; - xrealloc_vector did it */
275 /*modinfo[cur+1].pathname = NULL;*/
277 if (!pathname_matches_modname(fname, modname_to_match)) {
278 dbg1_error_msg("'%s' module name doesn't match", pathname);
279 return TRUE; /* module name doesn't match, continue search */
282 dbg1_error_msg("'%s' module name matches", pathname);
283 module_found_idx = cur;
284 parse_module(&modinfo[cur], pathname);
286 if (!(option_mask32 & OPT_r)) {
287 if (load_module(pathname, module_load_options) == 0) {
288 /* Load was successful, there is nothing else to do.
289 * This can happen ONLY for "top-level" module load,
290 * not a dep, because deps dont do dirscan. */
298 static int load_dep_bb(void)
301 FILE *fp = fopen_for_read(DEPFILE_BB);
307 dbg1_error_msg("loading "DEPFILE_BB);
309 /* Why? There is a rare scenario: we did not find modprobe.dep.bb,
310 * we scanned the dir and found no module by name, then we search
311 * for alias (full scan), and we decided to generate modprobe.dep.bb.
312 * But we see modprobe.dep.bb.new! Other modprobe is at work!
313 * We wait and other modprobe renames it to modprobe.dep.bb.
315 * But we already have modinfo[] filled, and "module_count = 0"
316 * makes us start anew. Yes, we leak modinfo[].xxx pointers -
317 * there is not much of data there anyway. */
319 memset(&modinfo[0], 0, sizeof(modinfo[0]));
321 while ((line = xmalloc_fgetline(fp)) != NULL) {
329 space = strchrnul(line, ' ');
330 cur = module_count++;
331 modinfo = xrealloc_vector(modinfo, 12, cur);
332 /*modinfo[cur+1].pathname = NULL; - xrealloc_vector did it */
333 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
336 modinfo[cur].aliases = space;
337 modinfo[cur].deps = xmalloc_fgetline(fp) ? : xzalloc(1);
338 if (modinfo[cur].deps[0]) {
339 /* deps are not "", so next line must be empty */
340 line = xmalloc_fgetline(fp);
341 /* Refuse to work with damaged config file */
343 bb_error_msg_and_die("error in %s at '%s'", DEPFILE_BB, line);
350 static int start_dep_bb_writeout(void)
354 /* depmod -n: write result to stdout */
355 if (applet_name[0] == 'd' && (option_mask32 & 1))
356 return STDOUT_FILENO;
358 fd = open(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
360 if (errno == EEXIST) {
362 dbg1_error_msg(DEPFILE_BB".new exists, waiting for "DEPFILE_BB);
364 usleep(1000*1000 / 20);
366 dbg1_error_msg(DEPFILE_BB" appeared");
367 return -2; /* magic number */
372 bb_error_msg("deleting stale %s", DEPFILE_BB".new");
373 fd = open_or_warn(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC);
376 dbg1_error_msg("opened "DEPFILE_BB".new:%d", fd);
380 static void write_out_dep_bb(int fd)
385 /* We want good error reporting. fdprintf is not good enough. */
386 fp = fdopen(fd, "w");
392 while (modinfo[i].pathname) {
393 fprintf(fp, "%s%s%s\n" "%s%s\n",
394 modinfo[i].pathname, modinfo[i].aliases[0] ? " " : "", modinfo[i].aliases,
395 modinfo[i].deps, modinfo[i].deps[0] ? "\n" : "");
398 /* Badly formatted depfile is a no-no. Be paranoid. */
400 if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
403 if (fd == STDOUT_FILENO) /* it was depmod -n */
406 if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
408 bb_perror_msg("can't create %s", DEPFILE_BB);
409 unlink(DEPFILE_BB".new");
413 dbg1_error_msg("created "DEPFILE_BB);
417 static module_info* find_alias(const char *alias)
422 dbg1_error_msg("find_alias('%s')", alias);
425 /* First try to find by name (cheaper) */
427 while (modinfo[i].pathname) {
428 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
429 dbg1_error_msg("found '%s' in module '%s'",
430 alias, modinfo[i].pathname);
431 if (!modinfo[i].aliases) {
432 parse_module(&modinfo[i], modinfo[i].pathname);
439 /* Ok, we definitely have to scan module bodies. This is a good
440 * moment to generate modprobe.dep.bb, if it does not exist yet */
441 dep_bb_fd = dep_bb_seen ? -1 : start_dep_bb_writeout();
442 if (dep_bb_fd == -2) /* modprobe.dep.bb appeared? */
445 /* Scan all module bodies, extract modinfo (it contains aliases) */
448 while (modinfo[i].pathname) {
450 if (!modinfo[i].aliases) {
451 parse_module(&modinfo[i], modinfo[i].pathname);
455 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
456 desc = str_2_list(modinfo[i].aliases);
457 /* Does matching substring exist? */
458 for (s = desc; *s; s += strlen(s) + 1) {
459 /* Aliases in module bodies can be defined with
460 * shell patterns. Example:
461 * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
462 * Plain strcmp() won't catch that */
463 if (fnmatch(s, alias, 0) == 0) {
464 dbg1_error_msg("found alias '%s' in module '%s'",
465 alias, modinfo[i].pathname);
466 result = &modinfo[i];
471 if (result && dep_bb_fd < 0)
476 /* Create module.dep.bb if needed */
477 if (dep_bb_fd >= 0) {
478 write_out_dep_bb(dep_bb_fd);
481 dbg1_error_msg("find_alias '%s' returns %p", alias, result);
485 #if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
486 // TODO: open only once, invent config_rewind()
487 static int already_loaded(const char *name)
491 parser_t *parser = config_open2("/proc/modules", xfopen_for_read);
492 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY)) {
493 if (strcmp(s, name) == 0) {
498 config_close(parser);
502 #define already_loaded(name) is_rmmod
506 * Given modules definition and module name (or alias, or symbol)
507 * load/remove the module respecting dependencies.
508 * NB: also called by depmod with bogus name "/",
509 * just in order to force modprobe.dep.bb creation.
511 #if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
512 #define process_module(a,b) process_module(a)
513 #define cmdline_options ""
515 static void process_module(char *name, const char *cmdline_options)
517 char *s, *deps, *options;
519 int is_rmmod = (option_mask32 & OPT_r) != 0;
520 dbg1_error_msg("process_module('%s','%s')", name, cmdline_options);
522 replace(name, '-', '_');
524 dbg1_error_msg("already_loaded:%d is_rmmod:%d", already_loaded(name), is_rmmod);
525 if (already_loaded(name) != is_rmmod) {
526 dbg1_error_msg("nothing to do for '%s'", name);
532 char *opt_filename = xasprintf("/etc/modules/%s", name);
533 options = xmalloc_open_read_close(opt_filename, NULL);
535 replace(options, '\n', ' ');
536 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
537 if (cmdline_options) {
538 /* NB: cmdline_options always have one leading ' '
539 * (see main()), we remove it here */
540 char *op = xasprintf(options ? "%s %s" : "%s %s" + 3,
541 cmdline_options + 1, options);
547 module_load_options = options;
548 dbg1_error_msg("process_module('%s'): options:'%s'", name, options);
552 /* Scan module directory. This is done only once.
553 * It will attempt module load, and will exit(EXIT_SUCCESS)
555 module_found_idx = -1;
556 recursive_action(".",
557 ACTION_RECURSE, /* flags */
558 fileAction, /* file action */
559 NULL, /* dir action */
560 name, /* user data */
562 dbg1_error_msg("dirscan complete");
563 /* Module was not found, or load failed, or is_rmmod */
564 if (module_found_idx >= 0) { /* module was found */
565 info = &modinfo[module_found_idx];
566 } else { /* search for alias, not a plain module name */
567 info = find_alias(name);
570 info = find_alias(name);
573 /* rmmod? unload it by name */
575 if (delete_module(name, O_NONBLOCK | O_EXCL) != 0
576 && !(option_mask32 & OPT_q)
578 bb_perror_msg("remove '%s'", name);
581 /* N.B. we do not stop here -
582 * continue to unload modules on which the module depends:
583 * "-r --remove: option causes modprobe to remove a module.
584 * If the modules it depends on are also unused, modprobe
585 * will try to remove them, too." */
589 /* both dirscan and find_alias found nothing */
590 if (applet_name[0] != 'd') /* it wasn't depmod */
591 bb_error_msg("module '%s' not found", name);
596 /* Iterate thru dependencies, trying to (un)load them */
597 deps = str_2_list(info->deps);
598 for (s = deps; *s; s += strlen(s) + 1) {
599 //if (strcmp(name, s) != 0) // N.B. do loops exist?
600 dbg1_error_msg("recurse on dep '%s'", s);
601 process_module(s, NULL);
602 dbg1_error_msg("recurse on dep '%s' done", s);
606 /* insmod -> load it */
609 if (load_module(info->pathname, options) != 0) {
610 if (EEXIST != errno) {
611 bb_error_msg("'%s': %s",
615 dbg1_error_msg("'%s': %s",
623 //TODO: return load attempt result from process_module.
624 //If dep didn't load ok, continuing makes little sense.
626 #undef cmdline_options
629 /* For reference, module-init-tools v3.4 options:
632 Usage: insmod filename [args]
635 Usage: rmmod [-fhswvV] modulename ...
636 -f (or --force) forces a module unload, and may crash your
637 machine. This requires the Forced Module Removal option
638 when the kernel was compiled.
639 -h (or --help) prints this help text
640 -s (or --syslog) says use syslog, not stderr
641 -v (or --verbose) enables more messages
642 -V (or --version) prints the version code
643 -w (or --wait) begins a module removal even if it is used
644 and will stop new users from accessing the module (so it
645 should eventually fall to zero).
648 Usage: modprobe [-v] [-V] [-C config-file] [-n] [-i] [-q] [-b]
649 [-o <modname>] [ --dump-modversions ] <modname> [parameters...]
650 modprobe -r [-n] [-i] [-v] <modulename> ...
651 modprobe -l -t <dirname> [ -a <modulename> ...]
654 depmod 3.4 -- part of module-init-tools
655 depmod -[aA] [-n -e -v -q -V -r -u]
656 [-b basedirectory] [forced_version]
657 depmod [-n -e -v -q -r -u] [-F kernelsyms] module1.ko module2.ko ...
658 If no arguments (except options) are given, "depmod -a" is assumed.
659 depmod will output a dependancy list suitable for the modprobe utility.
661 -a, --all Probe all modules
662 -A, --quick Only does the work if there's a new module
663 -n, --show Write the dependency file on stdout only
664 -e, --errsyms Report not supplied symbols
665 -V, --version Print the release version
666 -v, --verbose Enable verbose mode
667 -h, --help Print this usage message
668 The following options are useful for people managing distributions:
670 --basedir basedirectory Use an image of a module tree.
672 --filesyms kernelsyms Use the file instead of the
673 current kernel symbols.
676 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
677 int modprobe_main(int argc UNUSED_PARAM, char **argv)
680 char applet0 = applet_name[0];
681 USE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
683 /* are we lsmod? -> just dump /proc/modules */
684 if ('l' == applet0) {
685 xprint_and_close_file(xfopen_for_read("/proc/modules"));
691 /* Prevent ugly corner cases with no modules at all */
692 modinfo = xzalloc(sizeof(modinfo[0]));
694 /* Goto modules directory */
695 xchdir(CONFIG_DEFAULT_MODULES_DIR);
696 uname(&uts); /* never fails */
699 if ('d' == applet0) {
701 * -n: print result to stdout
702 * -a: process all modules (default)
703 * optional VERSION parameter
705 * -A: do work only if a module is newer than depfile
706 * -e: report any symbols which a module needs
707 * which are not supplied by other modules or the kernel
708 * -F FILE: System.map (symbols for -e)
711 * -b BASEDIR: (TODO!) modules are in
712 * $BASEDIR/lib/modules/$VERSION
713 * -v: human readable deps to stdout
714 * -V: version (don't want to support it - people may depend
715 * on it as an indicator of "standard" depmod)
716 * -h: help (well duh)
717 * module1.o module2.o parameters (just ignored for now)
719 getopt32(argv, "na" "AeF:qru" /* "b:vV", NULL */, NULL);
721 /* if (argv[0] && argv[1]) bb_show_usage(); */
722 /* Goto $VERSION directory */
723 xchdir(argv[0] ? argv[0] : uts.release);
724 /* Force full module scan by asking to find a bogus module.
725 * This will generate modules.dep.bb as a side effect. */
726 process_module((char*)"/", NULL);
727 return !wrote_dep_bb_ok;
730 /* insmod, modprobe, rmmod require at least one argument */
731 opt_complementary = "-1";
732 /* only -q (quiet) and -r (rmmod),
733 * the rest are accepted and ignored (compat) */
734 getopt32(argv, "qrfsvw");
737 /* are we rmmod? -> simulate modprobe -r */
738 if ('r' == applet0) {
739 option_mask32 |= OPT_r;
742 /* Goto $VERSION directory */
745 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
746 /* If not rmmod, parse possible module options given on command line.
747 * insmod/modprobe takes one module name, the rest are parameters. */
749 if ('r' != applet0) {
752 /* Enclose options in quotes */
754 options = xasprintf("%s \"%s\"", s ? s : "", *arg);
764 /* Try to load modprobe.dep.bb */
767 /* Load/remove modules.
768 * Only rmmod loops here, insmod/modprobe has only argv[0] */
770 process_module(*argv++, options);
773 if (ENABLE_FEATURE_CLEAN_UP) {
774 USE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)