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