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