modutils/modprobe-small.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * simplified modprobe
   4  *
   5  * Copyright (c) 2008 Vladimir Dronnikov
   6  * Copyright (c) 2008 Bernhard Reutner-Fischer (initial depmod code)
   7  *
   8  * Licensed under GPLv2, see file LICENSE in this source tree.
   9  */
  10
  11 //applet:IF_MODPROBE_SMALL(APPLET(modprobe, BB_DIR_SBIN, BB_SUID_DROP))
  12 //applet:IF_MODPROBE_SMALL(APPLET_ODDNAME(depmod, modprobe, BB_DIR_SBIN, BB_SUID_DROP, depmod))
  13 //applet:IF_MODPROBE_SMALL(APPLET_ODDNAME(insmod, modprobe, BB_DIR_SBIN, BB_SUID_DROP, insmod))
  14 //applet:IF_MODPROBE_SMALL(APPLET_ODDNAME(lsmod, modprobe, BB_DIR_SBIN, BB_SUID_DROP, lsmod))
  15 //applet:IF_MODPROBE_SMALL(APPLET_ODDNAME(rmmod, modprobe, BB_DIR_SBIN, BB_SUID_DROP, rmmod))
  16
  17 #include "libbb.h"
  18 /* After libbb.h, since it needs sys/types.h on some systems */
  19 #include <sys/utsname.h> /* uname() */
  20 #include <fnmatch.h>
  21
  22 extern int init_module(void *module, unsigned long len, const char *options);
  23 extern int delete_module(const char *module, unsigned flags);
  24 extern int query_module(const char *name, int which, void *buf, size_t bufsize, size_t *ret);
  25 /* linux/include/linux/module.h has limit of 64 chars on module names */
  26 #undef MODULE_NAME_LEN
  27 #define MODULE_NAME_LEN 64
  28
  29
  30 #if 1
  31 # define dbg1_error_msg(...) ((void)0)
  32 # define dbg2_error_msg(...) ((void)0)
  33 #else
  34 # define dbg1_error_msg(...) bb_error_msg(__VA_ARGS__)
  35 # define dbg2_error_msg(...) bb_error_msg(__VA_ARGS__)
  36 #endif
  37
  38 #define DEPFILE_BB CONFIG_DEFAULT_DEPMOD_FILE".bb"
  39
  40 enum {
  41         OPT_q = (1 << 0), /* be quiet */
  42         OPT_r = (1 << 1), /* module removal instead of loading */
  43 };
  44
  45 typedef struct module_info {
  46         char *pathname;
  47         char *aliases;
  48         char *deps;
  49 } module_info;
  50
  51 /*
  52  * GLOBALS
  53  */
  54 struct globals {
  55         module_info *modinfo;
  56         char *module_load_options;
  57         smallint dep_bb_seen;
  58         smallint wrote_dep_bb_ok;
  59         unsigned module_count;
  60         int module_found_idx;
  61         unsigned stringbuf_idx;
  62         unsigned stringbuf_size;
  63         char *stringbuf; /* some modules have lots of stuff */
  64         /* for example, drivers/media/video/saa7134/saa7134.ko */
  65         /* therefore having a fixed biggish buffer is not wise */
  66 };
  67 #define G (*ptr_to_globals)
  68 #define modinfo             (G.modinfo            )
  69 #define dep_bb_seen         (G.dep_bb_seen        )
  70 #define wrote_dep_bb_ok     (G.wrote_dep_bb_ok    )
  71 #define module_count        (G.module_count       )
  72 #define module_found_idx    (G.module_found_idx   )
  73 #define module_load_options (G.module_load_options)
  74 #define stringbuf_idx       (G.stringbuf_idx      )
  75 #define stringbuf_size      (G.stringbuf_size     )
  76 #define stringbuf           (G.stringbuf          )
  77 #define INIT_G() do { \
  78         SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
  79 } while (0)
  80
  81 static void append(const char *s)
  82 {
  83         unsigned len = strlen(s);
  84         if (stringbuf_idx + len + 15 > stringbuf_size) {
  85                 stringbuf_size = stringbuf_idx + len + 127;
  86                 dbg2_error_msg("grow stringbuf to %u", stringbuf_size);
  87                 stringbuf = xrealloc(stringbuf, stringbuf_size);
  88         }
  89         memcpy(stringbuf + stringbuf_idx, s, len);
  90         stringbuf_idx += len;
  91 }
  92
  93 static void appendc(char c)
  94 {
  95         /* We appendc() only after append(), + 15 trick in append()
  96          * makes it unnecessary to check for overflow here */
  97         stringbuf[stringbuf_idx++] = c;
  98 }
  99
 100 static void bksp(void)
 101 {
 102         if (stringbuf_idx)
 103                 stringbuf_idx--;
 104 }
 105
 106 static void reset_stringbuf(void)
 107 {
 108         stringbuf_idx = 0;
 109 }
 110
 111 static char* copy_stringbuf(void)
 112 {
 113         char *copy = xzalloc(stringbuf_idx + 1); /* terminating NUL */
 114         return memcpy(copy, stringbuf, stringbuf_idx);
 115 }
 116
 117 static char* find_keyword(char *ptr, size_t len, const char *word)
 118 {
 119         int wlen;
 120
 121         if (!ptr) /* happens if xmalloc_open_zipped_read_close cannot read it */
 122                 return NULL;
 123
 124         wlen = strlen(word);
 125         len -= wlen - 1;
 126         while ((ssize_t)len > 0) {
 127                 char *old = ptr;
 128                 /* search for the first char in word */
 129                 ptr = memchr(ptr, *word, len);
 130                 if (ptr == NULL) /* no occurance left, done */
 131                         break;
 132                 if (strncmp(ptr, word, wlen) == 0)
 133                         return ptr + wlen; /* found, return ptr past it */
 134                 ++ptr;
 135                 len -= (ptr - old);
 136         }
 137         return NULL;
 138 }
 139
 140 static void replace(char *s, char what, char with)
 141 {
 142         while (*s) {
 143                 if (what == *s)
 144                         *s = with;
 145                 ++s;
 146         }
 147 }
 148
 149 static char *filename2modname(const char *filename, char *modname)
 150 {
 151         int i;
 152         const char *from;
 153
 154         // Disabled since otherwise "modprobe dir/name" would work
 155         // as if it is "modprobe name". It is unclear why
 156         // 'basenamization' was here in the first place.
 157         //from = bb_get_last_path_component_nostrip(filename);
 158         from = filename;
 159         for (i = 0; i < (MODULE_NAME_LEN-1) && from[i] != '\0' && from[i] != '.'; i++)
 160                 modname[i] = (from[i] == '-') ? '_' : from[i];
 161         modname[i] = '\0';
 162
 163         return modname;
 164 }
 165
 166 /* Take "word word", return malloced "word",NUL,"word",NUL,NUL */
 167 static char* str_2_list(const char *str)
 168 {
 169         int len = strlen(str) + 1;
 170         char *dst = xmalloc(len + 1);
 171
 172         dst[len] = '\0';
 173         memcpy(dst, str, len);
 174 //TODO: protect against 2+ spaces: "word  word"
 175         replace(dst, ' ', '\0');
 176         return dst;
 177 }
 178
 179 /* We use error numbers in a loose translation... */
 180 static const char *moderror(int err)
 181 {
 182         switch (err) {
 183         case ENOEXEC:
 184                 return "invalid module format";
 185         case ENOENT:
 186                 return "unknown symbol in module or invalid parameter";
 187         case ESRCH:
 188                 return "module has wrong symbol version";
 189         case EINVAL: /* "invalid parameter" */
 190                 return "unknown symbol in module or invalid parameter"
 191                 + sizeof("unknown symbol in module or");
 192         default:
 193                 return strerror(err);
 194         }
 195 }
 196
 197 static int load_module(const char *fname, const char *options)
 198 {
 199 #if 1
 200         int r;
 201         size_t len = MAXINT(ssize_t);
 202         char *module_image;
 203         dbg1_error_msg("load_module('%s','%s')", fname, options);
 204
 205         module_image = xmalloc_open_zipped_read_close(fname, &len);
 206         r = (!module_image || init_module(module_image, len, options ? options : "") != 0);
 207         free(module_image);
 208         dbg1_error_msg("load_module:%d", r);
 209         return r; /* 0 = success */
 210 #else
 211         /* For testing */
 212         dbg1_error_msg("load_module('%s','%s')", fname, options);
 213         return 1;
 214 #endif
 215 }
 216
 217 static void parse_module(module_info *info, const char *pathname)
 218 {
 219         char *module_image;
 220         char *ptr;
 221         size_t len;
 222         size_t pos;
 223         dbg1_error_msg("parse_module('%s')", pathname);
 224
 225         /* Read (possibly compressed) module */
 226         len = 64 * 1024 * 1024; /* 64 Mb at most */
 227         module_image = xmalloc_open_zipped_read_close(pathname, &len);
 228         /* module_image == NULL is ok here, find_keyword handles it */
 229 //TODO: optimize redundant module body reads
 230
 231         /* "alias1 symbol:sym1 alias2 symbol:sym2" */
 232         reset_stringbuf();
 233         pos = 0;
 234         while (1) {
 235                 unsigned start = stringbuf_idx;
 236                 ptr = find_keyword(module_image + pos, len - pos, "alias=");
 237                 if (!ptr) {
 238                         ptr = find_keyword(module_image + pos, len - pos, "__ksymtab_");
 239                         if (!ptr)
 240                                 break;
 241                         /* DOCME: __ksymtab_gpl and __ksymtab_strings occur
 242                          * in many modules. What do they mean? */
 243                         if (strcmp(ptr, "gpl") == 0 || strcmp(ptr, "strings") == 0)
 244                                 goto skip;
 245                         dbg2_error_msg("alias:'symbol:%s'", ptr);
 246                         append("symbol:");
 247                 } else {
 248                         dbg2_error_msg("alias:'%s'", ptr);
 249                 }
 250                 append(ptr);
 251                 appendc(' ');
 252                 /*
 253                  * Don't add redundant aliases, such as:
 254                  * libcrc32c.ko symbol:crc32c symbol:crc32c
 255                  */
 256                 if (start) { /* "if we aren't the first alias" */
 257                         char *found, *last;
 258                         stringbuf[stringbuf_idx] = '\0';
 259                         last = stringbuf + start;
 260                         /*
 261                          * String at last-1 is " symbol:crc32c "
 262                          * (with both leading and trailing spaces).
 263                          */
 264                         if (strncmp(stringbuf, last, stringbuf_idx - start) == 0)
 265                                 /* First alias matches us */
 266                                 found = stringbuf;
 267                         else
 268                                 /* Does any other alias match? */
 269                                 found = strstr(stringbuf, last-1);
 270                         if (found < last-1) {
 271                                 /* There is absolutely the same string before us */
 272                                 dbg2_error_msg("redundant:'%s'", last);
 273                                 stringbuf_idx = start;
 274                                 goto skip;
 275                         }
 276                 }
 277  skip:
 278                 pos = (ptr - module_image);
 279         }
 280         bksp(); /* remove last ' ' */
 281         info->aliases = copy_stringbuf();
 282         replace(info->aliases, '-', '_');
 283
 284         /* "dependency1 depandency2" */
 285         reset_stringbuf();
 286         ptr = find_keyword(module_image, len, "depends=");
 287         if (ptr && *ptr) {
 288                 replace(ptr, ',', ' ');
 289                 replace(ptr, '-', '_');
 290                 dbg2_error_msg("dep:'%s'", ptr);
 291                 append(ptr);
 292         }
 293         info->deps = copy_stringbuf();
 294
 295         free(module_image);
 296 }
 297
 298 static int pathname_matches_modname(const char *pathname, const char *modname)
 299 {
 300         int r;
 301         char name[MODULE_NAME_LEN];
 302         const char *fname = bb_get_last_path_component_nostrip(pathname);
 303         const char *suffix = strrstr(fname, ".ko");
 304         safe_strncpy(name, fname, suffix - fname + 1);
 305         replace(name, '-', '_');
 306         r = (strcmp(name, modname) == 0);
 307         return r;
 308 }
 309
 310 static FAST_FUNC int fileAction(const char *pathname,
 311                 struct stat *sb UNUSED_PARAM,
 312                 void *modname_to_match,
 313                 int depth UNUSED_PARAM)
 314 {
 315         int cur;
 316         const char *fname;
 317
 318         pathname += 2; /* skip "./" */
 319         fname = bb_get_last_path_component_nostrip(pathname);
 320         if (!strrstr(fname, ".ko")) {
 321                 dbg1_error_msg("'%s' is not a module", pathname);
 322                 return TRUE; /* not a module, continue search */
 323         }
 324
 325         cur = module_count++;
 326         modinfo = xrealloc_vector(modinfo, 12, cur);
 327         modinfo[cur].pathname = xstrdup(pathname);
 328         /*modinfo[cur].aliases = NULL; - xrealloc_vector did it */
 329         /*modinfo[cur+1].pathname = NULL;*/
 330
 331         if (!pathname_matches_modname(fname, modname_to_match)) {
 332                 dbg1_error_msg("'%s' module name doesn't match", pathname);
 333                 return TRUE; /* module name doesn't match, continue search */
 334         }
 335
 336         dbg1_error_msg("'%s' module name matches", pathname);
 337         module_found_idx = cur;
 338         parse_module(&modinfo[cur], pathname);
 339
 340         if (!(option_mask32 & OPT_r)) {
 341                 if (load_module(pathname, module_load_options) == 0) {
 342                         /* Load was successful, there is nothing else to do.
 343                          * This can happen ONLY for "top-level" module load,
 344                          * not a dep, because deps dont do dirscan. */
 345                         exit(EXIT_SUCCESS);
 346                 }
 347         }
 348
 349         return TRUE;
 350 }
 351
 352 static int load_dep_bb(void)
 353 {
 354         char *line;
 355         FILE *fp = fopen_for_read(DEPFILE_BB);
 356
 357         if (!fp)
 358                 return 0;
 359
 360         dep_bb_seen = 1;
 361         dbg1_error_msg("loading "DEPFILE_BB);
 362
 363         /* Why? There is a rare scenario: we did not find modprobe.dep.bb,
 364          * we scanned the dir and found no module by name, then we search
 365          * for alias (full scan), and we decided to generate modprobe.dep.bb.
 366          * But we see modprobe.dep.bb.new! Other modprobe is at work!
 367          * We wait and other modprobe renames it to modprobe.dep.bb.
 368          * Now we can use it.
 369          * But we already have modinfo[] filled, and "module_count = 0"
 370          * makes us start anew. Yes, we leak modinfo[].xxx pointers -
 371          * there is not much of data there anyway. */
 372         module_count = 0;
 373         memset(&modinfo[0], 0, sizeof(modinfo[0]));
 374
 375         while ((line = xmalloc_fgetline(fp)) != NULL) {
 376                 char* space;
 377                 char* linebuf;
 378                 int cur;
 379
 380                 if (!line[0]) {
 381                         free(line);
 382                         continue;
 383                 }
 384                 space = strchrnul(line, ' ');
 385                 cur = module_count++;
 386                 modinfo = xrealloc_vector(modinfo, 12, cur);
 387                 /*modinfo[cur+1].pathname = NULL; - xrealloc_vector did it */
 388                 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
 389                 if (*space)
 390                         *space++ = '\0';
 391                 modinfo[cur].aliases = space;
 392                 linebuf = xmalloc_fgetline(fp);
 393                 modinfo[cur].deps = linebuf ? linebuf : xzalloc(1);
 394                 if (modinfo[cur].deps[0]) {
 395                         /* deps are not "", so next line must be empty */
 396                         line = xmalloc_fgetline(fp);
 397                         /* Refuse to work with damaged config file */
 398                         if (line && line[0])
 399                                 bb_error_msg_and_die("error in %s at '%s'", DEPFILE_BB, line);
 400                         free(line);
 401                 }
 402         }
 403         return 1;
 404 }
 405
 406 static int start_dep_bb_writeout(void)
 407 {
 408         int fd;
 409
 410         /* depmod -n: write result to stdout */
 411         if (applet_name[0] == 'd' && (option_mask32 & 1))
 412                 return STDOUT_FILENO;
 413
 414         fd = open(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
 415         if (fd < 0) {
 416                 if (errno == EEXIST) {
 417                         int count = 5 * 20;
 418                         dbg1_error_msg(DEPFILE_BB".new exists, waiting for "DEPFILE_BB);
 419                         while (1) {
 420                                 usleep(1000*1000 / 20);
 421                                 if (load_dep_bb()) {
 422                                         dbg1_error_msg(DEPFILE_BB" appeared");
 423                                         return -2; /* magic number */
 424                                 }
 425                                 if (!--count)
 426                                         break;
 427                         }
 428                         bb_error_msg("deleting stale %s", DEPFILE_BB".new");
 429                         fd = open_or_warn(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC);
 430                 }
 431         }
 432         dbg1_error_msg("opened "DEPFILE_BB".new:%d", fd);
 433         return fd;
 434 }
 435
 436 static void write_out_dep_bb(int fd)
 437 {
 438         int i;
 439         FILE *fp;
 440
 441         /* We want good error reporting. fdprintf is not good enough. */
 442         fp = xfdopen_for_write(fd);
 443         i = 0;
 444         while (modinfo[i].pathname) {
 445                 fprintf(fp, "%s%s%s\n" "%s%s\n",
 446                         modinfo[i].pathname, modinfo[i].aliases[0] ? " " : "", modinfo[i].aliases,
 447                         modinfo[i].deps, modinfo[i].deps[0] ? "\n" : "");
 448                 i++;
 449         }
 450         /* Badly formatted depfile is a no-no. Be paranoid. */
 451         errno = 0;
 452         if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
 453                 goto err;
 454
 455         if (fd == STDOUT_FILENO) /* it was depmod -n */
 456                 goto ok;
 457
 458         if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
 459  err:
 460                 bb_perror_msg("can't create '%s'", DEPFILE_BB);
 461                 unlink(DEPFILE_BB".new");
 462         } else {
 463  ok:
 464                 wrote_dep_bb_ok = 1;
 465                 dbg1_error_msg("created "DEPFILE_BB);
 466         }
 467 }
 468
 469 static module_info** find_alias(const char *alias)
 470 {
 471         int i;
 472         int dep_bb_fd;
 473         int infoidx;
 474         module_info **infovec;
 475         dbg1_error_msg("find_alias('%s')", alias);
 476
 477  try_again:
 478         /* First try to find by name (cheaper) */
 479         i = 0;
 480         while (modinfo[i].pathname) {
 481                 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
 482                         dbg1_error_msg("found '%s' in module '%s'",
 483                                         alias, modinfo[i].pathname);
 484                         if (!modinfo[i].aliases) {
 485                                 parse_module(&modinfo[i], modinfo[i].pathname);
 486                         }
 487                         infovec = xzalloc(2 * sizeof(infovec[0]));
 488                         infovec[0] = &modinfo[i];
 489                         return infovec;
 490                 }
 491                 i++;
 492         }
 493
 494         /* Ok, we definitely have to scan module bodies. This is a good
 495          * moment to generate modprobe.dep.bb, if it does not exist yet */
 496         dep_bb_fd = dep_bb_seen ? -1 : start_dep_bb_writeout();
 497         if (dep_bb_fd == -2) /* modprobe.dep.bb appeared? */
 498                 goto try_again;
 499
 500         /* Scan all module bodies, extract modinfo (it contains aliases) */
 501         i = 0;
 502         infoidx = 0;
 503         infovec = NULL;
 504         while (modinfo[i].pathname) {
 505                 char *desc, *s;
 506                 if (!modinfo[i].aliases) {
 507                         parse_module(&modinfo[i], modinfo[i].pathname);
 508                 }
 509                 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
 510                 desc = str_2_list(modinfo[i].aliases);
 511                 /* Does matching substring exist? */
 512                 for (s = desc; *s; s += strlen(s) + 1) {
 513                         /* Aliases in module bodies can be defined with
 514                          * shell patterns. Example:
 515                          * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
 516                          * Plain strcmp() won't catch that */
 517                         if (fnmatch(s, alias, 0) == 0) {
 518                                 dbg1_error_msg("found alias '%s' in module '%s'",
 519                                                 alias, modinfo[i].pathname);
 520                                 infovec = xrealloc_vector(infovec, 1, infoidx);
 521                                 infovec[infoidx++] = &modinfo[i];
 522                                 break;
 523                         }
 524                 }
 525                 free(desc);
 526                 i++;
 527         }
 528
 529         /* Create module.dep.bb if needed */
 530         if (dep_bb_fd >= 0) {
 531                 write_out_dep_bb(dep_bb_fd);
 532         }
 533
 534         dbg1_error_msg("find_alias '%s' returns %d results", alias, infoidx);
 535         return infovec;
 536 }
 537
 538 #if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
 539 // TODO: open only once, invent config_rewind()
 540 static int already_loaded(const char *name)
 541 {
 542         int ret = 0;
 543         char *s;
 544         parser_t *parser = config_open2("/proc/modules", xfopen_for_read);
 545         while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY)) {
 546                 if (strcmp(s, name) == 0) {
 547                         ret = 1;
 548                         break;
 549                 }
 550         }
 551         config_close(parser);
 552         return ret;
 553 }
 554 #else
 555 #define already_loaded(name) is_rmmod
 556 #endif
 557
 558 /*
 559  * Given modules definition and module name (or alias, or symbol)
 560  * load/remove the module respecting dependencies.
 561  * NB: also called by depmod with bogus name "/",
 562  * just in order to force modprobe.dep.bb creation.
 563 */
 564 #if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
 565 #define process_module(a,b) process_module(a)
 566 #define cmdline_options ""
 567 #endif
 568 static void process_module(char *name, const char *cmdline_options)
 569 {
 570         char *s, *deps, *options;
 571         module_info **infovec;
 572         module_info *info;
 573         int infoidx;
 574         int is_rmmod = (option_mask32 & OPT_r) != 0;
 575
 576         dbg1_error_msg("process_module('%s','%s')", name, cmdline_options);
 577
 578         replace(name, '-', '_');
 579
 580         dbg1_error_msg("already_loaded:%d is_rmmod:%d", already_loaded(name), is_rmmod);
 581         /*
 582          * We used to have "is_rmmod != already_loaded(name)" check here, but
 583          *  modprobe -r pci:v00008086d00007010sv00000000sd00000000bc01sc01i80
 584          * won't unload modules (there are more than one)
 585          * which have this alias.
 586          */
 587         if (!is_rmmod && already_loaded(name)) {
 588                 dbg1_error_msg("nothing to do for '%s'", name);
 589                 return;
 590         }
 591
 592         options = NULL;
 593         if (!is_rmmod) {
 594                 char *opt_filename = xasprintf("/etc/modules/%s", name);
 595                 options = xmalloc_open_read_close(opt_filename, NULL);
 596                 if (options)
 597                         replace(options, '\n', ' ');
 598 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
 599                 if (cmdline_options) {
 600                         /* NB: cmdline_options always have one leading ' '
 601                          * (see main()), we remove it here */
 602                         char *op = xasprintf(options ? "%s %s" : "%s %s" + 3,
 603                                                 cmdline_options + 1, options);
 604                         free(options);
 605                         options = op;
 606                 }
 607 #endif
 608                 free(opt_filename);
 609                 module_load_options = options;
 610                 dbg1_error_msg("process_module('%s'): options:'%s'", name, options);
 611         }
 612
 613         if (!module_count) {
 614                 /* Scan module directory. This is done only once.
 615                  * It will attempt module load, and will exit(EXIT_SUCCESS)
 616                  * on success.
 617                  */
 618                 module_found_idx = -1;
 619                 recursive_action(".",
 620                         ACTION_RECURSE, /* flags */
 621                         fileAction, /* file action */
 622                         NULL, /* dir action */
 623                         name, /* user data */
 624                         0 /* depth */
 625                 );
 626                 dbg1_error_msg("dirscan complete");
 627                 /* Module was not found, or load failed, or is_rmmod */
 628                 if (module_found_idx >= 0) { /* module was found */
 629                         infovec = xzalloc(2 * sizeof(infovec[0]));
 630                         infovec[0] = &modinfo[module_found_idx];
 631                 } else { /* search for alias, not a plain module name */
 632                         infovec = find_alias(name);
 633                 }
 634         } else {
 635                 infovec = find_alias(name);
 636         }
 637
 638         if (!infovec) {
 639                 /* both dirscan and find_alias found nothing */
 640                 if (!is_rmmod && applet_name[0] != 'd') /* it wasn't rmmod or depmod */
 641                         bb_error_msg("module '%s' not found", name);
 642 //TODO: _and_die()? or should we continue (un)loading modules listed on cmdline?
 643                 goto ret;
 644         }
 645
 646         /* There can be more than one module for the given alias. For example,
 647          * "pci:v00008086d00007010sv00000000sd00000000bc01sc01i80" matches
 648          * ata_piix because it has alias "pci:v00008086d00007010sv*sd*bc*sc*i*"
 649          * and ata_generic, it has alias "pci:v*d*sv*sd*bc01sc01i*"
 650          * Standard modprobe loads them both. We achieve it by returning
 651          * a *list* of modinfo pointers from find_alias().
 652          */
 653
 654         /* rmmod or modprobe -r? unload module(s) */
 655         if (is_rmmod) {
 656                 infoidx = 0;
 657                 while ((info = infovec[infoidx++]) != NULL) {
 658                         int r;
 659                         char modname[MODULE_NAME_LEN];
 660
 661                         filename2modname(
 662                                 bb_get_last_path_component_nostrip(info->pathname), modname);
 663                         r = delete_module(modname, O_NONBLOCK | O_EXCL);
 664                         dbg1_error_msg("delete_module('%s', O_NONBLOCK | O_EXCL):%d", modname, r);
 665                         if (r != 0) {
 666                                 if (!(option_mask32 & OPT_q))
 667                                         bb_perror_msg("remove '%s'", modname);
 668                                 goto ret;
 669                         }
 670                 }
 671
 672                 if (applet_name[0] == 'r') {
 673                         /* rmmod: do not remove dependencies, exit */
 674                         goto ret;
 675                 }
 676
 677                 /* modprobe -r: we do not stop here -
 678                  * continue to unload modules on which the module depends:
 679                  * "-r --remove: option causes modprobe to remove a module.
 680                  * If the modules it depends on are also unused, modprobe
 681                  * will try to remove them, too."
 682                  */
 683         }
 684
 685         infoidx = 0;
 686         while ((info = infovec[infoidx++]) != NULL) {
 687                 /* Iterate thru dependencies, trying to (un)load them */
 688                 deps = str_2_list(info->deps);
 689                 for (s = deps; *s; s += strlen(s) + 1) {
 690                         //if (strcmp(name, s) != 0) // N.B. do loops exist?
 691                         dbg1_error_msg("recurse on dep '%s'", s);
 692                         process_module(s, NULL);
 693                         dbg1_error_msg("recurse on dep '%s' done", s);
 694                 }
 695                 free(deps);
 696
 697                 if (is_rmmod)
 698                         continue;
 699
 700                 /* We are modprobe: load it */
 701                 if (options && strstr(options, "blacklist")) {
 702                         dbg1_error_msg("'%s': blacklisted", info->pathname);
 703                         continue;
 704                 }
 705                 errno = 0;
 706                 if (load_module(info->pathname, options) != 0) {
 707                         if (EEXIST != errno) {
 708                                 bb_error_msg("'%s': %s",
 709                                         info->pathname,
 710                                         moderror(errno));
 711                         } else {
 712                                 dbg1_error_msg("'%s': %s",
 713                                         info->pathname,
 714                                         moderror(errno));
 715                         }
 716                 }
 717         }
 718  ret:
 719         free(infovec);
 720         free(options);
 721 //TODO: return load attempt result from process_module.
 722 //If dep didn't load ok, continuing makes little sense.
 723 }
 724 #undef cmdline_options
 725
 726
 727 /* For reference, module-init-tools v3.4 options:
 728
 729 # insmod
 730 Usage: insmod filename [args]
 731
 732 # rmmod --help
 733 Usage: rmmod [-fhswvV] modulename ...
 734  -f (or --force) forces a module unload, and may crash your
 735     machine. This requires the Forced Module Removal option
 736     when the kernel was compiled.
 737  -h (or --help) prints this help text
 738  -s (or --syslog) says use syslog, not stderr
 739  -v (or --verbose) enables more messages
 740  -V (or --version) prints the version code
 741  -w (or --wait) begins module removal even if it is used
 742     and will stop new users from accessing the module (so it
 743     should eventually fall to zero).
 744
 745 # modprobe
 746 Usage: modprobe [-v] [-V] [-C config-file] [-n] [-i] [-q] [-b]
 747     [-o <modname>] [ --dump-modversions ] <modname> [parameters...]
 748 modprobe -r [-n] [-i] [-v] <modulename> ...
 749 modprobe -l -t <dirname> [ -a <modulename> ...]
 750
 751 # depmod --help
 752 depmod 3.4 -- part of module-init-tools
 753 depmod -[aA] [-n -e -v -q -V -r -u]
 754       [-b basedirectory] [forced_version]
 755 depmod [-n -e -v -q -r -u] [-F kernelsyms] module1.ko module2.ko ...
 756 If no arguments (except options) are given, "depmod -a" is assumed.
 757 depmod will output a dependency list suitable for the modprobe utility.
 758 Options:
 759     -a, --all           Probe all modules
 760     -A, --quick         Only does the work if there's a new module
 761     -n, --show          Write the dependency file on stdout only
 762     -e, --errsyms       Report not supplied symbols
 763     -V, --version       Print the release version
 764     -v, --verbose       Enable verbose mode
 765     -h, --help          Print this usage message
 766 The following options are useful for people managing distributions:
 767     -b basedirectory
 768     --basedir basedirectory
 769                         Use an image of a module tree
 770     -F kernelsyms
 771     --filesyms kernelsyms
 772                         Use the file instead of the current kernel symbols
 773 */
 774
 775 //usage:#if ENABLE_MODPROBE_SMALL
 776
 777 //usage:#define depmod_trivial_usage NOUSAGE_STR
 778 //usage:#define depmod_full_usage ""
 779
 780 //usage:#define lsmod_trivial_usage
 781 //usage:       ""
 782 //usage:#define lsmod_full_usage "\n\n"
 783 //usage:       "List the currently loaded kernel modules"
 784
 785 //usage:#define insmod_trivial_usage
 786 //usage:        IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ")
 787 //usage:        IF_NOT_FEATURE_2_4_MODULES("FILE ")
 788 //usage:        "[SYMBOL=VALUE]..."
 789 //usage:#define insmod_full_usage "\n\n"
 790 //usage:       "Load kernel module"
 791 //usage:        IF_FEATURE_2_4_MODULES( "\n"
 792 //usage:     "\n        -f      Force module to load into the wrong kernel version"
 793 //usage:     "\n        -k      Make module autoclean-able"
 794 //usage:     "\n        -v      Verbose"
 795 //usage:     "\n        -q      Quiet"
 796 //usage:     "\n        -L      Lock: prevent simultaneous loads"
 797 //usage:        IF_FEATURE_INSMOD_LOAD_MAP(
 798 //usage:     "\n        -m      Output load map to stdout"
 799 //usage:        )
 800 //usage:     "\n        -x      Don't export externs"
 801 //usage:        )
 802
 803 //usage:#define rmmod_trivial_usage
 804 //usage:       "[-wfa] [MODULE]..."
 805 //usage:#define rmmod_full_usage "\n\n"
 806 //usage:       "Unload kernel modules\n"
 807 //usage:     "\n        -w      Wait until the module is no longer used"
 808 //usage:     "\n        -f      Force unload"
 809 //usage:     "\n        -a      Remove all unused modules (recursively)"
 810 //usage:
 811 //usage:#define rmmod_example_usage
 812 //usage:       "$ rmmod tulip\n"
 813
 814 //usage:#define modprobe_trivial_usage
 815 //usage:        "[-qfwrsv] MODULE [SYMBOL=VALUE]..."
 816 //usage:#define modprobe_full_usage "\n\n"
 817 //usage:       "        -r      Remove MODULE (stacks) or do autoclean"
 818 //usage:     "\n        -q      Quiet"
 819 //usage:     "\n        -v      Verbose"
 820 //usage:     "\n        -f      Force"
 821 //usage:     "\n        -w      Wait for unload"
 822 //usage:     "\n        -s      Report via syslog instead of stderr"
 823
 824 //usage:#endif
 825
 826 int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 827 int modprobe_main(int argc UNUSED_PARAM, char **argv)
 828 {
 829         struct utsname uts;
 830         char applet0 = applet_name[0];
 831         IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
 832
 833         /* are we lsmod? -> just dump /proc/modules */
 834         if ('l' == applet0) {
 835                 xprint_and_close_file(xfopen_for_read("/proc/modules"));
 836                 return EXIT_SUCCESS;
 837         }
 838
 839         INIT_G();
 840
 841         /* Prevent ugly corner cases with no modules at all */
 842         modinfo = xzalloc(sizeof(modinfo[0]));
 843
 844         if ('i' != applet0) { /* not insmod */
 845                 /* Goto modules directory */
 846                 xchdir(CONFIG_DEFAULT_MODULES_DIR);
 847         }
 848         uname(&uts); /* never fails */
 849
 850         /* depmod? */
 851         if ('d' == applet0) {
 852                 /* Supported:
 853                  * -n: print result to stdout
 854                  * -a: process all modules (default)
 855                  * optional VERSION parameter
 856                  * Ignored:
 857                  * -A: do work only if a module is newer than depfile
 858                  * -e: report any symbols which a module needs
 859                  *  which are not supplied by other modules or the kernel
 860                  * -F FILE: System.map (symbols for -e)
 861                  * -q, -r, -u: noop?
 862                  * Not supported:
 863                  * -b BASEDIR: (TODO!) modules are in
 864                  *  $BASEDIR/lib/modules/$VERSION
 865                  * -v: human readable deps to stdout
 866                  * -V: version (don't want to support it - people may depend
 867                  *  on it as an indicator of "standard" depmod)
 868                  * -h: help (well duh)
 869                  * module1.o module2.o parameters (just ignored for now)
 870                  */
 871                 getopt32(argv, "na" "AeF:qru" /* "b:vV", NULL */, NULL);
 872                 argv += optind;
 873                 /* if (argv[0] && argv[1]) bb_show_usage(); */
 874                 /* Goto $VERSION directory */
 875                 xchdir(argv[0] ? argv[0] : uts.release);
 876                 /* Force full module scan by asking to find a bogus module.
 877                  * This will generate modules.dep.bb as a side effect. */
 878                 process_module((char*)"/", NULL);
 879                 return !wrote_dep_bb_ok;
 880         }
 881
 882         /* insmod, modprobe, rmmod require at least one argument */
 883         opt_complementary = "-1";
 884         /* only -q (quiet) and -r (rmmod),
 885          * the rest are accepted and ignored (compat) */
 886         getopt32(argv, "qrfsvwb");
 887         argv += optind;
 888
 889         /* are we rmmod? -> simulate modprobe -r */
 890         if ('r' == applet0) {
 891                 option_mask32 |= OPT_r;
 892         }
 893
 894         if ('i' != applet0) { /* not insmod */
 895                 /* Goto $VERSION directory */
 896                 xchdir(uts.release);
 897         }
 898
 899 #if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
 900         /* If not rmmod, parse possible module options given on command line.
 901          * insmod/modprobe takes one module name, the rest are parameters. */
 902         options = NULL;
 903         if ('r' != applet0) {
 904                 char **arg = argv;
 905                 while (*++arg) {
 906                         /* Enclose options in quotes */
 907                         char *s = options;
 908                         options = xasprintf("%s \"%s\"", s ? s : "", *arg);
 909                         free(s);
 910                         *arg = NULL;
 911                 }
 912         }
 913 #else
 914         if ('r' != applet0)
 915                 argv[1] = NULL;
 916 #endif
 917
 918         if ('i' == applet0) { /* insmod */
 919                 size_t len;
 920                 void *map;
 921
 922                 len = MAXINT(ssize_t);
 923                 map = xmalloc_open_zipped_read_close(*argv, &len);
 924                 if (!map)
 925                         bb_perror_msg_and_die("can't read '%s'", *argv);
 926                 if (init_module(map, len,
 927                         IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(options ? options : "")
 928                         IF_NOT_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE("")
 929                         ) != 0
 930                 ) {
 931                         bb_error_msg_and_die("can't insert '%s': %s",
 932                                         *argv, moderror(errno));
 933                 }
 934                 return 0;
 935         }
 936
 937         /* Try to load modprobe.dep.bb */
 938         load_dep_bb();
 939
 940         /* Load/remove modules.
 941          * Only rmmod loops here, modprobe has only argv[0] */
 942         do {
 943                 process_module(*argv, options);
 944         } while (*++argv);
 945
 946         if (ENABLE_FEATURE_CLEAN_UP) {
 947                 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)
 948         }
 949         return EXIT_SUCCESS;
 950 }