service/fw example: do not ruin $if[], use different name
[oweals/busybox.git] / modutils / depmod.c
index 34483dc07e4f14fc83ab60959bf6d37e4c5775af..e5f0e3d2b48e5d34fbe206003a90bdd27d9b2de6 100644 (file)
 /* vi: set sw=4 ts=4: */
 /*
  * depmod - generate modules.dep
- * Copyright (c) 2008 Bernhard Fischer
+ * Copyright (c) 2008 Bernhard Reutner-Fischer
+ * Copyrihgt (c) 2008 Timo Teras <timo.teras@iki.fi>
+ * Copyright (c) 2008 Vladimir Dronnikov
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
-#undef _GNU_SOURCE
-#define _GNU_SOURCE
-#include <libbb.h>
+//applet:IF_DEPMOD(APPLET(depmod, BB_DIR_SBIN, BB_SUID_DROP))
+
+#include "libbb.h"
+#include "modutils.h"
 #include <sys/utsname.h> /* uname() */
 
-#ifndef DEFAULT_MODULES_DIR
-#define DEFAULT_MODULES_DIR "/lib/modules"
-#endif
-#ifndef DEFAULT_DEPMOD_FILE
-#define DEFAULT_DEPMOD_FILE "modules.dep"
-#endif
 /*
  * Theory of operation:
  * - iterate over all modules and record their full path
  * - iterate over all modules looking for "depends=" entries
  *   for each depends, look through our list of full paths and emit if found
  */
-struct globals {
-       llist_t *lst;
-};
-#define G (*(struct globals*)&bb_common_bufsiz1)
-/* We have to zero it out because of NOEXEC */
-#define INIT_G() memset(&G, 0, sizeof(G))
 
-static int fill_lst(const char *modulename, struct stat ATTRIBUTE_UNUSED *sb,
-                                       void ATTRIBUTE_UNUSED *data, int ATTRIBUTE_UNUSED depth)
+static int FAST_FUNC parse_module(const char *fname, struct stat *sb UNUSED_PARAM,
+                               void *data, int depth UNUSED_PARAM)
 {
-       llist_add_to(&G.lst, xstrdup(modulename));
+       module_db *modules = data;
+       char *image, *ptr;
+       module_entry *e;
+
+       /* Arbitrary. Was sb->st_size, but that breaks .gz etc */
+       size_t len = (64*1024*1024 - 4096);
+
+       if (strrstr(fname, ".ko") == NULL)
+               return TRUE;
+
+       image = xmalloc_open_zipped_read_close(fname, &len);
+
+       e = moddb_get_or_create(modules, bb_get_last_path_component_nostrip(fname));
+       e->name = xstrdup(fname + 2); /* skip "./" */
+
+       for (ptr = image; ptr < image + len - 10; ptr++) {
+               if (is_prefixed_with(ptr, "depends=")) {
+                       char *u;
+
+                       ptr += 8;
+                       for (u = ptr; *u; u++)
+                               if (*u == '-')
+                                       *u = '_';
+                       ptr += string_to_llist(ptr, &e->deps, ",");
+               } else if (ENABLE_FEATURE_MODUTILS_ALIAS
+                && is_prefixed_with(ptr, "alias=")
+               ) {
+                       llist_add_to(&e->aliases, xstrdup(ptr + 6));
+                       ptr += strlen(ptr);
+               } else if (ENABLE_FEATURE_MODUTILS_SYMBOLS
+                && is_prefixed_with(ptr, "__ksymtab_")
+               ) {
+                       ptr += 10;
+                       if (is_prefixed_with(ptr, "gpl")
+                        || strcmp(ptr, "strings") == 0
+                       ) {
+                               continue;
+                       }
+                       llist_add_to(&e->symbols, xstrdup(ptr));
+                       ptr += strlen(ptr);
+               }
+       }
+       free(image);
+
        return TRUE;
 }
 
-static int fileAction(const char *fname, struct stat *sb,
-                                       void *data, int ATTRIBUTE_UNUSED depth)
+static void order_dep_list(module_db *modules, module_entry *start, llist_t *add)
 {
-       size_t len = sb->st_size;
-       void *the_module, *ptr;
-       int fd;
-       char *depends, *deps;
-
-/*XXX: FIXME: does not handle compressed modules!
- * There should be a function that looks at the extension and sets up
- * open_transformer for us.
- */
-       if (last_char_is(fname, 'o') == NULL) /* not a module */
-               goto skip;
+       module_entry *m;
+       llist_t *n;
 
-       fd = xopen(fname, O_RDONLY);
-       the_module = mmap(NULL, len, PROT_READ, MAP_SHARED
-#if defined MAP_POPULATE
-                                               |MAP_POPULATE
-#endif
-                                               , fd, 0);
-       close(fd);
-       if (the_module == MAP_FAILED)
-               bb_perror_msg_and_die("mmap");
-
-       ptr = the_module;
-
-       fprintf((FILE*)data, "\n%s:", fname);
-//bb_info_msg("fname='%s'", fname);
-       do {
-               /* search for a 'd' */
-               ptr = memchr(ptr, 'd', len);
-               if (ptr == NULL) /* no d left, done */
-                       goto done;
-               if (memcmp(ptr, "depends=", sizeof("depends=")-1) == 0)
-                       break;
-               len -= ++ptr - the_module;
-       } while (1);
-       deps = depends = xstrdup (ptr + sizeof("depends=")-1);
-//bb_info_msg(" depends='%s'", depends);
-       while (*deps) {
-               llist_t * _lst = G.lst;
-               char *buf1;
-
-               ptr = strchr(deps, ',');
-               if (ptr != NULL)
-                       *(char*)ptr = '\0';
-               /* remember the length of the current dependency plus eventual 0 byte */
-               len = strlen(deps) + (ptr != NULL);
-               buf1 = xmalloc(len + 3);
-               sprintf(buf1, "/%s.", deps); /* make sure we match the correct file */
-               while (_lst) {
-                       ptr = strstr(_lst->data, buf1);
-                       if (ptr != NULL)
-                               break; /* found it */
-                       _lst = _lst->link;
-               }
-               free(buf1);
-               if (_lst /*&& _lst->data*/) {
-//bb_info_msg("[%s] -> '%s'", deps, _lst->data);
-                       fprintf((FILE*)data, " %s", _lst->data);
-                       deps += len;
-               }
+       for (n = add; n != NULL; n = n->link) {
+               m = moddb_get(modules, n->data);
+               if (m == NULL)
+                       continue;
+
+               /* unlink current entry */
+               m->dnext->dprev = m->dprev;
+               m->dprev->dnext = m->dnext;
+
+               /* and add it to tail */
+               m->dnext = start;
+               m->dprev = start->dprev;
+               start->dprev->dnext = m;
+               start->dprev = m;
+
+               /* recurse */
+               order_dep_list(modules, start, m->deps);
        }
-       free(depends);
-done:
-       munmap(the_module, sb->st_size);
-skip:
-       return TRUE;
 }
 
+static void xfreopen_write(const char *file, FILE *f)
+{
+       if (freopen(file, "w", f) == NULL)
+               bb_perror_msg_and_die("can't open '%s'", file);
+}
+
+//usage:#if !ENABLE_MODPROBE_SMALL
+//usage:#define depmod_trivial_usage "[-n] [-b BASE] [VERSION] [MODFILES]..."
+//usage:#define depmod_full_usage "\n\n"
+//usage:       "Generate modules.dep, alias, and symbols files"
+//usage:     "\n"
+//usage:     "\n       -b BASE Use BASE/lib/modules/VERSION"
+//usage:     "\n       -n      Dry run: print files to stdout"
+//usage:#endif
+
+/* Upstream usage:
+ * [-aAenv] [-C FILE or DIR] [-b BASE] [-F System.map] [VERSION] [MODFILES]...
+ *     -a --all
+ *             Probe all modules. Default if no MODFILES.
+ *     -A --quick
+ *             Check modules.dep's mtime against module files' mtimes.
+ *     -b --basedir BASE
+ *             Use $BASE/lib/modules/VERSION
+ *     -C --config FILE or DIR
+ *             Path to /etc/depmod.conf or /etc/depmod.d/
+ *     -e --errsyms
+ *             When combined with the -F option, this reports any symbols
+ *             which are not supplied by other modules or kernel.
+ *     -F --filesyms System.map
+ *     -n --dry-run
+ *             Print modules.dep etc to standard output
+ *     -v --verbose
+ *             Print to stdout all the symbols each module depends on
+ *             and the module's file name which provides that symbol.
+ *     -r      No-op
+ *     -u      No-op
+ *     -q      No-op
+ *
+ * So far we only support: [-n] [-b BASE] [VERSION] [MODFILES]...
+ * Accepted but ignored:
+ * -aAe
+ * -F System.map
+ * -C FILE/DIR
+ *
+ * Not accepted: -v
+ */
+enum {
+       //OPT_a = (1 << 0), /* All modules, ignore mods in argv */
+       //OPT_A = (1 << 1), /* Only emit .ko that are newer than modules.dep file */
+       OPT_b = (1 << 2), /* base directory when modules are in staging area */
+       //OPT_e = (1 << 3), /* with -F, print unresolved symbols */
+       //OPT_F = (1 << 4), /* System.map that contains the symbols */
+       OPT_n = (1 << 5), /* dry-run, print to stdout only */
+       OPT_r = (1 << 6), /* Compat dummy. Linux Makefile uses it */
+       OPT_u = (1 << 7), /* -u,--unresolved-error: ignored */
+       OPT_q = (1 << 8), /* -q,--quiet: ignored */
+       OPT_C = (1 << 9), /* -C,--config etc_modules_conf: ignored */
+};
+
 int depmod_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
-int depmod_main(int ATTRIBUTE_UNUSED argc, char **argv)
+int depmod_main(int argc UNUSED_PARAM, char **argv)
 {
-       int retval = EXIT_SUCCESS;
-       char *moddir_base = NULL, *moddir, *system_map, *chp;
-       FILE *filedes = stdout;
-       enum {
-               ARG_a = (1<<0), /* All modules, ignore mods in argv */
-               ARG_A = (1<<1), /* Only emit .ko that are newer than modules.dep file */
-               ARG_b = (1<<2), /* not /lib/modules/$(uname -r)/ but this base-dir */
-               ARG_e = (1<<3), /* with -F, print unresolved symbols */
-               ARG_F = (1<<4), /* System.map that contains the symbols */
-               ARG_n = (1<<5)  /* dry-run, print to stdout only */
-       };
-
-       getopt32(argv, "aAb:eF:n", &moddir_base, &system_map);
+       module_db modules;
+       module_entry *m, *dep;
+       const char *moddir_base = "/";
+       char *moddir, *version;
+       struct utsname uts;
+       unsigned i;
+       int tmp;
+
+       getopt32(argv, "aAb:eF:nruqC:", &moddir_base, NULL, NULL);
        argv += optind;
-       if (*argv) {/* got a version to use? */
-               chp = *argv++;
-//             if (memchr(chp, '/', strlen(chp)) != NULL) /* XXX: drop this */
-//                     bb_show_usage();
+
+       /* goto modules location */
+       xchdir(moddir_base);
+
+       /* If a version is provided, then that kernel version's module directory
+        * is used, rather than the current kernel version (as returned by
+        * "uname -r").  */
+       if (*argv && sscanf(*argv, "%u.%u.%u", &tmp, &tmp, &tmp) == 3) {
+               version = *argv++;
        } else {
-               struct utsname uts;
-               if (uname(&uts) < 0)
-                       bb_simple_perror_msg_and_die("uname");
-               chp = xstrdup(uts.release);
-       }
-       /* if no modules are given on the command-line, -a is on per default */
-       option_mask32 |= *argv == NULL;
-
-       moddir = concat_path_file(DEFAULT_MODULES_DIR, chp);
-//     if (ENABLE_FEATURE_CLEAN_UP)
-//             free(chp);
-       if (option_mask32 & ARG_b) {
-               char *old_moddir = moddir;
-               moddir = concat_path_file(moddir_base, moddir);
-               if (ENABLE_FEATURE_CLEAN_UP)
-                       free(old_moddir);
+               uname(&uts);
+               version = uts.release;
        }
+       moddir = concat_path_file(&CONFIG_DEFAULT_MODULES_DIR[1], version);
+       xchdir(moddir);
+       if (ENABLE_FEATURE_CLEAN_UP)
+               free(moddir);
 
-       if (!(option_mask32 & ARG_n)) { /* --dry-run */
-               chp = concat_path_file(moddir, DEFAULT_DEPMOD_FILE);
-               filedes = xfopen(chp, "w");
-               if (ENABLE_FEATURE_CLEAN_UP)
-                       free(chp);
+       /* Scan modules */
+       memset(&modules, 0, sizeof(modules));
+       if (*argv) {
+               do {
+                       parse_module(*argv, /*sb (unused):*/ NULL, &modules, 0);
+               } while (*++argv);
+       } else {
+               recursive_action(".", ACTION_RECURSE,
+                               parse_module, NULL, &modules, 0);
        }
-       /* have to do a full walk to collect all needed data */
-       if (!recursive_action(moddir,
-                       ACTION_RECURSE, /* flags */
-                       fill_lst, /* file action */
-                       NULL, /* dir action */
-                       NULL, /* user data */
-                       0)) {
-               retval = EXIT_FAILURE;
-       } else
-       do {
-               chp = concat_path_file(option_mask32 & ARG_a ?  moddir : moddir_base,
-                               option_mask32 & ARG_a ? "" : *argv++);
-
-               if (!recursive_action(chp,
-                               ACTION_RECURSE, /* flags */
-                               fileAction, /* file action */
-                               NULL, /* dir action */
-                               (void*)filedes, /* user data */
-                               0)) { /* depth */
-                       retval = EXIT_FAILURE;
+
+       /* Generate dependency and alias files */
+       if (!(option_mask32 & OPT_n))
+               xfreopen_write(CONFIG_DEFAULT_DEPMOD_FILE, stdout);
+
+       moddb_foreach_module(&modules, m, i) {
+               printf("%s:", m->name);
+
+               order_dep_list(&modules, m, m->deps);
+               while (m->dnext != m) {
+                       dep = m->dnext;
+                       printf(" %s", dep->name);
+
+                       /* unlink current entry */
+                       dep->dnext->dprev = dep->dprev;
+                       dep->dprev->dnext = dep->dnext;
+                       dep->dnext = dep->dprev = dep;
                }
-               if (ENABLE_FEATURE_CLEAN_UP)
-                       free(chp);
-       } while (!(option_mask32 & ARG_a) && *argv);
+               bb_putchar('\n');
+       }
 
-       if (ENABLE_FEATURE_CLEAN_UP) {
-               fclose(filedes);
-               llist_free(G.lst, free);
-               free(moddir);
+#if ENABLE_FEATURE_MODUTILS_ALIAS
+       if (!(option_mask32 & OPT_n))
+               xfreopen_write("modules.alias", stdout);
+       moddb_foreach_module(&modules, m, i) {
+               while (m->aliases) {
+                       /*
+                        * Last word used to be a basename
+                        * (filename with path and .ko.* stripped)
+                        * at the time of module-init-tools 3.4.
+                        * kmod v.12 uses module name, i.e., s/-/_/g.
+                        */
+                       printf("alias %s %s\n",
+                               (char*)llist_pop(&m->aliases),
+                               m->modname);
+               }
        }
-       return retval;
+#endif
+#if ENABLE_FEATURE_MODUTILS_SYMBOLS
+       if (!(option_mask32 & OPT_n))
+               xfreopen_write("modules.symbols", stdout);
+       moddb_foreach_module(&modules, m, i) {
+               while (m->symbols) {
+                       printf("alias symbol:%s %s\n",
+                               (char*)llist_pop(&m->symbols),
+                               m->modname);
+               }
+       }
+#endif
+
+       if (ENABLE_FEATURE_CLEAN_UP)
+               moddb_free(&modules);
+
+       return EXIT_SUCCESS;
 }