modutils/depmod.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * depmod - generate modules.dep
   4  * Copyright (c) 2008 Bernhard Reutner-Fischer
   5  * Copyrihgt (c) 2008 Timo Teras <timo.teras@iki.fi>
   6  * Copyright (c) 2008 Vladimir Dronnikov
   7  *
   8  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   9  */
  10
  11 //applet:IF_DEPMOD(APPLET(depmod, BB_DIR_SBIN, BB_SUID_DROP))
  12
  13 #include "libbb.h"
  14 #include "modutils.h"
  15 #include <sys/utsname.h> /* uname() */
  16
  17 /*
  18  * Theory of operation:
  19  * - iterate over all modules and record their full path
  20  * - iterate over all modules looking for "depends=" entries
  21  *   for each depends, look through our list of full paths and emit if found
  22  */
  23
  24 typedef struct module_info {
  25         struct module_info *next;
  26         char *name, *modname;
  27         llist_t *dependencies;
  28         llist_t *aliases;
  29         llist_t *symbols;
  30         struct module_info *dnext, *dprev;
  31 } module_info;
  32
  33 static int FAST_FUNC parse_module(const char *fname, struct stat *sb UNUSED_PARAM,
  34                                 void *data, int depth UNUSED_PARAM)
  35 {
  36         char modname[MODULE_NAME_LEN];
  37         module_info **first = (module_info **) data;
  38         char *image, *ptr;
  39         module_info *info;
  40         /* Arbitrary. Was sb->st_size, but that breaks .gz etc */
  41         size_t len = (64*1024*1024 - 4096);
  42
  43         if (strrstr(fname, ".ko") == NULL)
  44                 return TRUE;
  45
  46         image = xmalloc_open_zipped_read_close(fname, &len);
  47         info = xzalloc(sizeof(*info));
  48
  49         info->next = *first;
  50         *first = info;
  51
  52         info->dnext = info->dprev = info;
  53         info->name = xstrdup(fname + 2); /* skip "./" */
  54         info->modname = xstrdup(filename2modname(fname, modname));
  55         for (ptr = image; ptr < image + len - 10; ptr++) {
  56                 if (strncmp(ptr, "depends=", 8) == 0) {
  57                         char *u;
  58
  59                         ptr += 8;
  60                         for (u = ptr; *u; u++)
  61                                 if (*u == '-')
  62                                         *u = '_';
  63                         ptr += string_to_llist(ptr, &info->dependencies, ",");
  64                 } else if (ENABLE_FEATURE_MODUTILS_ALIAS
  65                  && strncmp(ptr, "alias=", 6) == 0
  66                 ) {
  67                         llist_add_to(&info->aliases, xstrdup(ptr + 6));
  68                         ptr += strlen(ptr);
  69                 } else if (ENABLE_FEATURE_MODUTILS_SYMBOLS
  70                  && strncmp(ptr, "__ksymtab_", 10) == 0
  71                 ) {
  72                         ptr += 10;
  73                         if (strncmp(ptr, "gpl", 3) == 0
  74                          || strcmp(ptr, "strings") == 0
  75                         ) {
  76                                 continue;
  77                         }
  78                         llist_add_to(&info->symbols, xstrdup(ptr));
  79                         ptr += strlen(ptr);
  80                 }
  81         }
  82         free(image);
  83
  84         return TRUE;
  85 }
  86
  87 static module_info *find_module(module_info *modules, const char *modname)
  88 {
  89         module_info *m;
  90
  91         for (m = modules; m != NULL; m = m->next)
  92                 if (strcmp(m->modname, modname) == 0)
  93                         return m;
  94         return NULL;
  95 }
  96
  97 static void order_dep_list(module_info *modules, module_info *start,
  98                         llist_t *add)
  99 {
 100         module_info *m;
 101         llist_t *n;
 102
 103         for (n = add; n != NULL; n = n->link) {
 104                 m = find_module(modules, n->data);
 105                 if (m == NULL)
 106                         continue;
 107
 108                 /* unlink current entry */
 109                 m->dnext->dprev = m->dprev;
 110                 m->dprev->dnext = m->dnext;
 111
 112                 /* and add it to tail */
 113                 m->dnext = start;
 114                 m->dprev = start->dprev;
 115                 start->dprev->dnext = m;
 116                 start->dprev = m;
 117
 118                 /* recurse */
 119                 order_dep_list(modules, start, m->dependencies);
 120         }
 121 }
 122
 123 static void xfreopen_write(const char *file, FILE *f)
 124 {
 125         if (freopen(file, "w", f) == NULL)
 126                 bb_perror_msg_and_die("can't open '%s'", file);
 127 }
 128
 129 //usage:#if !ENABLE_MODPROBE_SMALL
 130 //usage:#define depmod_trivial_usage "[-n] [-b BASE] [VERSION] [MODFILES]..."
 131 //usage:#define depmod_full_usage "\n\n"
 132 //usage:       "Generate modules.dep, alias, and symbols files"
 133 //usage:     "\n"
 134 //usage:     "\n        -b BASE Use BASE/lib/modules/VERSION"
 135 //usage:     "\n        -n      Dry run: print files to stdout"
 136 //usage:#endif
 137
 138 /* Upstream usage:
 139  * [-aAenv] [-C FILE or DIR] [-b BASE] [-F System.map] [VERSION] [MODFILES]...
 140  *      -a --all
 141  *              Probe all modules. Default if no MODFILES.
 142  *      -A --quick
 143  *              Check modules.dep's mtime against module files' mtimes.
 144  *      -b --basedir BASE
 145  *              Use $BASE/lib/modules/VERSION
 146  *      -C --config FILE or DIR
 147  *              Path to /etc/depmod.conf or /etc/depmod.d/
 148  *      -e --errsyms
 149  *              When combined with the -F option, this reports any symbols
 150  *              which are not supplied by other modules or kernel.
 151  *      -F --filesyms System.map
 152  *      -n --dry-run
 153  *              Print modules.dep etc to standard output
 154  *      -v --verbose
 155  *              Print to stdout all the symbols each module depends on
 156  *              and the module's file name which provides that symbol.
 157  *      -r      No-op
 158  *      -u      No-op
 159  *      -q      No-op
 160  *
 161  * So far we only support: [-n] [-b BASE] [VERSION] [MODFILES]...
 162  * Accepted but ignored:
 163  * -aAe
 164  * -F System.map
 165  * -C FILE/DIR
 166  *
 167  * Not accepted: -v
 168  */
 169 enum {
 170         //OPT_a = (1 << 0), /* All modules, ignore mods in argv */
 171         //OPT_A = (1 << 1), /* Only emit .ko that are newer than modules.dep file */
 172         OPT_b = (1 << 2), /* base directory when modules are in staging area */
 173         //OPT_e = (1 << 3), /* with -F, print unresolved symbols */
 174         //OPT_F = (1 << 4), /* System.map that contains the symbols */
 175         OPT_n = (1 << 5), /* dry-run, print to stdout only */
 176         OPT_r = (1 << 6), /* Compat dummy. Linux Makefile uses it */
 177         OPT_u = (1 << 7), /* -u,--unresolved-error: ignored */
 178         OPT_q = (1 << 8), /* -q,--quiet: ignored */
 179         OPT_C = (1 << 9), /* -C,--config etc_modules_conf: ignored */
 180 };
 181
 182 int depmod_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 183 int depmod_main(int argc UNUSED_PARAM, char **argv)
 184 {
 185         module_info *modules, *m, *dep;
 186         const char *moddir_base = "/";
 187         char *moddir, *version;
 188         struct utsname uts;
 189         int tmp;
 190
 191         getopt32(argv, "aAb:eF:nruqC:", &moddir_base, NULL, NULL);
 192         argv += optind;
 193
 194         /* goto modules location */
 195         xchdir(moddir_base);
 196
 197         /* If a version is provided, then that kernel version's module directory
 198          * is used, rather than the current kernel version (as returned by
 199          * "uname -r").  */
 200         if (*argv && sscanf(*argv, "%u.%u.%u", &tmp, &tmp, &tmp) == 3) {
 201                 version = *argv++;
 202         } else {
 203                 uname(&uts);
 204                 version = uts.release;
 205         }
 206         moddir = concat_path_file(&CONFIG_DEFAULT_MODULES_DIR[1], version);
 207         xchdir(moddir);
 208         if (ENABLE_FEATURE_CLEAN_UP)
 209                 free(moddir);
 210
 211         /* Scan modules */
 212         modules = NULL;
 213         if (*argv) {
 214                 do {
 215                         parse_module(*argv, /*sb (unused):*/ NULL, &modules, 0);
 216                 } while (*++argv);
 217         } else {
 218                 recursive_action(".", ACTION_RECURSE,
 219                                 parse_module, NULL, &modules, 0);
 220         }
 221
 222         /* Generate dependency and alias files */
 223         if (!(option_mask32 & OPT_n))
 224                 xfreopen_write(CONFIG_DEFAULT_DEPMOD_FILE, stdout);
 225         for (m = modules; m != NULL; m = m->next) {
 226                 printf("%s:", m->name);
 227
 228                 order_dep_list(modules, m, m->dependencies);
 229                 while (m->dnext != m) {
 230                         dep = m->dnext;
 231                         printf(" %s", dep->name);
 232
 233                         /* unlink current entry */
 234                         dep->dnext->dprev = dep->dprev;
 235                         dep->dprev->dnext = dep->dnext;
 236                         dep->dnext = dep->dprev = dep;
 237                 }
 238                 bb_putchar('\n');
 239         }
 240
 241 #if ENABLE_FEATURE_MODUTILS_ALIAS
 242         if (!(option_mask32 & OPT_n))
 243                 xfreopen_write("modules.alias", stdout);
 244         for (m = modules; m != NULL; m = m->next) {
 245                 const char *fname = bb_basename(m->name);
 246                 int fnlen = strchrnul(fname, '.') - fname;
 247                 while (m->aliases) {
 248                         /* Last word can well be m->modname instead,
 249                          * but depmod from module-init-tools 3.4
 250                          * uses module basename, i.e., no s/-/_/g.
 251                          * (pathname and .ko.* are still stripped)
 252                          * Mimicking that... */
 253                         printf("alias %s %.*s\n",
 254                                 (char*)llist_pop(&m->aliases),
 255                                 fnlen, fname);
 256                 }
 257         }
 258 #endif
 259 #if ENABLE_FEATURE_MODUTILS_SYMBOLS
 260         if (!(option_mask32 & OPT_n))
 261                 xfreopen_write("modules.symbols", stdout);
 262         for (m = modules; m != NULL; m = m->next) {
 263                 const char *fname = bb_basename(m->name);
 264                 int fnlen = strchrnul(fname, '.') - fname;
 265                 while (m->symbols) {
 266                         printf("alias symbol:%s %.*s\n",
 267                                 (char*)llist_pop(&m->symbols),
 268                                 fnlen, fname);
 269                 }
 270         }
 271 #endif
 272
 273         if (ENABLE_FEATURE_CLEAN_UP) {
 274                 while (modules) {
 275                         module_info *old = modules;
 276                         modules = modules->next;
 277                         free(old->name);
 278                         free(old->modname);
 279                         free(old);
 280                 }
 281         }
 282
 283         return EXIT_SUCCESS;
 284 }