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 //TODO: use zeroing version of xrealloc_vector?
274 modinfo[cur].pathname = xstrdup(pathname);
275 modinfo[cur].aliases = NULL;
276 modinfo[cur+1].pathname = NULL;
278 if (!pathname_matches_modname(fname, modname_to_match)) {
279 dbg1_error_msg("'%s' module name doesn't match", pathname);
280 return TRUE; /* module name doesn't match, continue search */
283 dbg1_error_msg("'%s' module name matches", pathname);
284 module_found_idx = cur;
285 parse_module(&modinfo[cur], pathname);
287 if (!(option_mask32 & OPT_r)) {
288 if (load_module(pathname, module_load_options) == 0) {
289 /* Load was successful, there is nothing else to do.
290 * This can happen ONLY for "top-level" module load,
291 * not a dep, because deps dont do dirscan. */
299 static int load_dep_bb(void)
302 FILE *fp = fopen_for_read(DEPFILE_BB);
308 dbg1_error_msg("loading "DEPFILE_BB);
310 /* Why? There is a rare scenario: we did not find modprobe.dep.bb,
311 * we scanned the dir and found no module by name, then we search
312 * for alias (full scan), and we decided to generate modprobe.dep.bb.
313 * But we see modprobe.dep.bb.new! Other modprobe is at work!
314 * We wait and other modprobe renames it to modprobe.dep.bb.
316 * But we already have modinfo[] filled, and "module_count = 0"
317 * makes us start anew. Yes, we leak modinfo[].xxx pointers -
318 * there is not much of data there anyway. */
320 memset(&modinfo[0], 0, sizeof(modinfo[0]));
322 while ((line = xmalloc_fgetline(fp)) != NULL) {
330 space = strchrnul(line, ' ');
331 cur = module_count++;
332 modinfo = xrealloc_vector(modinfo, 12, cur);
333 //TODO: use zeroing version of xrealloc_vector?
334 modinfo[cur+1].pathname = NULL;
335 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
338 modinfo[cur].aliases = space;
339 modinfo[cur].deps = xmalloc_fgetline(fp) ? : xzalloc(1);
340 if (modinfo[cur].deps[0]) {
341 /* deps are not "", so next line must be empty */
342 line = xmalloc_fgetline(fp);
343 /* Refuse to work with damaged config file */
345 bb_error_msg_and_die("error in %s at '%s'", DEPFILE_BB, line);
352 static int start_dep_bb_writeout(void)
356 /* depmod -n: write result to stdout */
357 if (applet_name[0] == 'd' && (option_mask32 & 1))
358 return STDOUT_FILENO;
360 fd = open(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
362 if (errno == EEXIST) {
364 dbg1_error_msg(DEPFILE_BB".new exists, waiting for "DEPFILE_BB);
366 usleep(1000*1000 / 20);
368 dbg1_error_msg(DEPFILE_BB" appeared");
369 return -2; /* magic number */
374 bb_error_msg("deleting stale %s", DEPFILE_BB".new");
375 fd = open_or_warn(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC);
378 dbg1_error_msg("opened "DEPFILE_BB".new:%d", fd);
382 static void write_out_dep_bb(int fd)
387 /* We want good error reporting. fdprintf is not good enough. */
388 fp = fdopen(fd, "w");
394 while (modinfo[i].pathname) {
395 fprintf(fp, "%s%s%s\n" "%s%s\n",
396 modinfo[i].pathname, modinfo[i].aliases[0] ? " " : "", modinfo[i].aliases,
397 modinfo[i].deps, modinfo[i].deps[0] ? "\n" : "");
400 /* Badly formatted depfile is a no-no. Be paranoid. */
402 if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
405 if (fd == STDOUT_FILENO) /* it was depmod -n */
408 if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
410 bb_perror_msg("can't create %s", DEPFILE_BB);
411 unlink(DEPFILE_BB".new");
415 dbg1_error_msg("created "DEPFILE_BB);
419 static module_info* find_alias(const char *alias)
424 dbg1_error_msg("find_alias('%s')", alias);
427 /* First try to find by name (cheaper) */
429 while (modinfo[i].pathname) {
430 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
431 dbg1_error_msg("found '%s' in module '%s'",
432 alias, modinfo[i].pathname);
433 if (!modinfo[i].aliases) {
434 parse_module(&modinfo[i], modinfo[i].pathname);
441 /* Ok, we definitely have to scan module bodies. This is a good
442 * moment to generate modprobe.dep.bb, if it does not exist yet */
443 dep_bb_fd = dep_bb_seen ? -1 : start_dep_bb_writeout();
444 if (dep_bb_fd == -2) /* modprobe.dep.bb appeared? */
447 /* Scan all module bodies, extract modinfo (it contains aliases) */
450 while (modinfo[i].pathname) {
452 if (!modinfo[i].aliases) {
453 parse_module(&modinfo[i], modinfo[i].pathname);
457 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
458 desc = str_2_list(modinfo[i].aliases);
459 /* Does matching substring exist? */
460 for (s = desc; *s; s += strlen(s) + 1) {
461 /* Aliases in module bodies can be defined with
462 * shell patterns. Example:
463 * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
464 * Plain strcmp() won't catch that */
465 if (fnmatch(s, alias, 0) == 0) {
466 dbg1_error_msg("found alias '%s' in module '%s'",
467 alias, modinfo[i].pathname);
468 result = &modinfo[i];
473 if (result && dep_bb_fd < 0)
478 /* Create module.dep.bb if needed */
479 if (dep_bb_fd >= 0) {
480 write_out_dep_bb(dep_bb_fd);
483 dbg1_error_msg("find_alias '%s' returns %p", alias, result);
487 #if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
488 // TODO: open only once, invent config_rewind()
489 static int already_loaded(const char *name)
493 parser_t *parser = config_open2("/proc/modules", xfopen_for_read);
494 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY)) {
495 if (strcmp(s, name) == 0) {
500 config_close(parser);
504 #define already_loaded(name) is_rmmod
508 * Given modules definition and module name (or alias, or symbol)
509 * load/remove the module respecting dependencies.
510 * NB: also called by depmod with bogus name "/",
511 * just in order to force modprobe.dep.bb creation.
513 #if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
514 #define process_module(a,b) process_module(a)
515 #define cmdline_options ""
517 static void process_module(char *name, const char *cmdline_options)
519 char *s, *deps, *options;
521 int is_rmmod = (option_mask32 & OPT_r) != 0;
522 dbg1_error_msg("process_module('%s','%s')", name, cmdline_options);
524 replace(name, '-', '_');
526 dbg1_error_msg("already_loaded:%d is_rmmod:%d", already_loaded(name), is_rmmod);
527 if (already_loaded(name) != is_rmmod) {
528 dbg1_error_msg("nothing to do for '%s'", name);
534 char *opt_filename = xasprintf("/etc/modules/%s", name);
535 options = xmalloc_open_read_close(opt_filename, NULL);
537 replace(options, '\n', ' ');
538 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
539 if (cmdline_options) {
540 /* NB: cmdline_options always have one leading ' '
541 * (see main()), we remove it here */
542 char *op = xasprintf(options ? "%s %s" : "%s %s" + 3,
543 cmdline_options + 1, options);
549 module_load_options = options;
550 dbg1_error_msg("process_module('%s'): options:'%s'", name, options);
554 /* Scan module directory. This is done only once.
555 * It will attempt module load, and will exit(EXIT_SUCCESS)
557 module_found_idx = -1;
558 recursive_action(".",
559 ACTION_RECURSE, /* flags */
560 fileAction, /* file action */
561 NULL, /* dir action */
562 name, /* user data */
564 dbg1_error_msg("dirscan complete");
565 /* Module was not found, or load failed, or is_rmmod */
566 if (module_found_idx >= 0) { /* module was found */
567 info = &modinfo[module_found_idx];
568 } else { /* search for alias, not a plain module name */
569 info = find_alias(name);
572 info = find_alias(name);
575 /* rmmod? unload it by name */
577 if (delete_module(name, O_NONBLOCK | O_EXCL) != 0
578 && !(option_mask32 & OPT_q)
580 bb_perror_msg("remove '%s'", name);
583 /* N.B. we do not stop here -
584 * continue to unload modules on which the module depends:
585 * "-r --remove: option causes modprobe to remove a module.
586 * If the modules it depends on are also unused, modprobe
587 * will try to remove them, too." */
591 /* both dirscan and find_alias found nothing */
592 if (applet_name[0] != 'd') /* it wasn't depmod */
593 bb_error_msg("module '%s' not found", name);
598 /* Iterate thru dependencies, trying to (un)load them */
599 deps = str_2_list(info->deps);
600 for (s = deps; *s; s += strlen(s) + 1) {
601 //if (strcmp(name, s) != 0) // N.B. do loops exist?
602 dbg1_error_msg("recurse on dep '%s'", s);
603 process_module(s, NULL);
604 dbg1_error_msg("recurse on dep '%s' done", s);
608 /* insmod -> load it */
611 if (load_module(info->pathname, options) != 0) {
612 if (EEXIST != errno) {
613 bb_error_msg("'%s': %s",
617 dbg1_error_msg("'%s': %s",
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 a 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 dependancy 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 Use an image of a module tree.
674 --filesyms kernelsyms Use the file instead of the
675 current kernel symbols.
678 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
679 int modprobe_main(int argc UNUSED_PARAM, char **argv)
682 char applet0 = applet_name[0];
683 USE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
685 /* are we lsmod? -> just dump /proc/modules */
686 if ('l' == applet0) {
687 xprint_and_close_file(xfopen_for_read("/proc/modules"));
693 /* Prevent ugly corner cases with no modules at all */
694 modinfo = xzalloc(sizeof(modinfo[0]));
696 /* Goto modules directory */
697 xchdir(CONFIG_DEFAULT_MODULES_DIR);
698 uname(&uts); /* never fails */
701 if ('d' == applet0) {
703 * -n: print result to stdout
704 * -a: process all modules (default)
705 * optional VERSION parameter
707 * -A: do work only if a module is newer than depfile
708 * -e: report any symbols which a module needs
709 * which are not supplied by other modules or the kernel
710 * -F FILE: System.map (symbols for -e)
713 * -b BASEDIR: (TODO!) modules are in
714 * $BASEDIR/lib/modules/$VERSION
715 * -v: human readable deps to stdout
716 * -V: version (don't want to support it - people may depend
717 * on it as an indicator of "standard" depmod)
718 * -h: help (well duh)
719 * module1.o module2.o parameters (just ignored for now)
721 getopt32(argv, "na" "AeF:qru" /* "b:vV", NULL */, NULL);
723 /* if (argv[0] && argv[1]) bb_show_usage(); */
724 /* Goto $VERSION directory */
725 xchdir(argv[0] ? argv[0] : uts.release);
726 /* Force full module scan by asking to find a bogus module.
727 * This will generate modules.dep.bb as a side effect. */
728 process_module((char*)"/", NULL);
729 return !wrote_dep_bb_ok;
732 /* insmod, modprobe, rmmod require at least one argument */
733 opt_complementary = "-1";
734 /* only -q (quiet) and -r (rmmod),
735 * the rest are accepted and ignored (compat) */
736 getopt32(argv, "qrfsvw");
739 /* are we rmmod? -> simulate modprobe -r */
740 if ('r' == applet0) {
741 option_mask32 |= OPT_r;
744 /* Goto $VERSION directory */
747 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
748 /* If not rmmod, parse possible module options given on command line.
749 * insmod/modprobe takes one module name, the rest are parameters. */
751 if ('r' != applet0) {
754 /* Enclose options in quotes */
756 options = xasprintf("%s \"%s\"", s ? s : "", *arg);
766 /* Try to load modprobe.dep.bb */
769 /* Load/remove modules.
770 * Only rmmod loops here, insmod/modprobe has only argv[0] */
772 process_module(*argv++, options);
775 if (ENABLE_FEATURE_CLEAN_UP) {
776 USE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)