blob: 652ff4dfa984ec0e4792be91f0efbe3842de4a0e [file] [log] [blame]
Denis Vlasenko671691c2008-07-04 10:25:44 +00001/* vi: set sw=4 ts=4: */
2/*
3 * simplified modprobe
4 *
5 * Copyright (c) 2008 Vladimir Dronnikov
Bernhard Reutner-Fischer6c4dade2008-09-25 12:13:34 +00006 * Copyright (c) 2008 Bernhard Reutner-Fischer (initial depmod code)
Denis Vlasenko671691c2008-07-04 10:25:44 +00007 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02008 * Licensed under GPLv2, see file LICENSE in this source tree.
Denis Vlasenko671691c2008-07-04 10:25:44 +00009 */
Denys Vlasenko326edc32016-12-22 14:36:49 +010010
11/* config MODPROBE_SMALL is defined in Config.src to ensure better "make config" order */
12
Denys Vlasenkoe32b64c2016-11-23 07:54:52 +010013//config:config FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
14//config: bool "Accept module options on modprobe command line"
15//config: default y
16//config: depends on MODPROBE_SMALL
17//config: select PLATFORM_LINUX
18//config: help
19//config: Allow insmod and modprobe take module options from command line.
20//config:
21//config:config FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
22//config: bool "Skip loading of already loaded modules"
23//config: default y
24//config: depends on MODPROBE_SMALL
25//config: help
26//config: Check if the module is already loaded.
Denis Vlasenko671691c2008-07-04 10:25:44 +000027
Denys Vlasenkoa1cd0d92016-12-23 15:12:27 +010028//applet:IF_MODPROBE(IF_MODPROBE_SMALL(APPLET(modprobe, BB_DIR_SBIN, BB_SUID_DROP)))
29//applet:IF_DEPMOD(IF_MODPROBE_SMALL(APPLET_ODDNAME(depmod, modprobe, BB_DIR_SBIN, BB_SUID_DROP, depmod)))
30//applet:IF_INSMOD(IF_MODPROBE_SMALL(APPLET_ODDNAME(insmod, modprobe, BB_DIR_SBIN, BB_SUID_DROP, insmod)))
31//applet:IF_LSMOD(IF_MODPROBE_SMALL(APPLET_ODDNAME(lsmod, modprobe, BB_DIR_SBIN, BB_SUID_DROP, lsmod)))
32//applet:IF_RMMOD(IF_MODPROBE_SMALL(APPLET_ODDNAME(rmmod, modprobe, BB_DIR_SBIN, BB_SUID_DROP, rmmod)))
Denys Vlasenkoc15613c2010-10-15 11:29:02 +020033
Denys Vlasenkoe32b64c2016-11-23 07:54:52 +010034//kbuild:lib-$(CONFIG_MODPROBE_SMALL) += modprobe-small.o
35
Denis Vlasenko671691c2008-07-04 10:25:44 +000036#include "libbb.h"
Denys Vlasenko043b1e52009-09-06 12:47:55 +020037/* After libbb.h, since it needs sys/types.h on some systems */
Denis Vlasenko671691c2008-07-04 10:25:44 +000038#include <sys/utsname.h> /* uname() */
39#include <fnmatch.h>
Mike Frysinger3a45b872016-09-15 12:16:33 +020040#include <sys/syscall.h>
Denis Vlasenko671691c2008-07-04 10:25:44 +000041
Denis Vlasenko24a131e2008-07-09 15:30:57 +000042extern int init_module(void *module, unsigned long len, const char *options);
43extern int delete_module(const char *module, unsigned flags);
Mike Frysinger3a45b872016-09-15 12:16:33 +020044#ifdef __NR_finit_module
45# define finit_module(fd, uargs, flags) syscall(__NR_finit_module, fd, uargs, flags)
46#endif
Denys Vlasenko07e55552014-04-21 16:59:36 +020047/* linux/include/linux/module.h has limit of 64 chars on module names */
48#undef MODULE_NAME_LEN
49#define MODULE_NAME_LEN 64
Denis Vlasenko24a131e2008-07-09 15:30:57 +000050
51
Denys Vlasenko5b3151c2010-09-25 14:37:06 +020052#if 1
53# define dbg1_error_msg(...) ((void)0)
54# define dbg2_error_msg(...) ((void)0)
55#else
56# define dbg1_error_msg(...) bb_error_msg(__VA_ARGS__)
57# define dbg2_error_msg(...) bb_error_msg(__VA_ARGS__)
58#endif
Denis Vlasenko671691c2008-07-04 10:25:44 +000059
Denis Vlasenko24a131e2008-07-09 15:30:57 +000060#define DEPFILE_BB CONFIG_DEFAULT_DEPMOD_FILE".bb"
Denis Vlasenko671691c2008-07-04 10:25:44 +000061
62enum {
63 OPT_q = (1 << 0), /* be quiet */
64 OPT_r = (1 << 1), /* module removal instead of loading */
65};
66
67typedef struct module_info {
68 char *pathname;
Denis Vlasenko78436992008-07-10 14:14:20 +000069 char *aliases;
70 char *deps;
Denys Vlasenko5c3e0602016-06-20 10:59:06 +020071 smallint open_read_failed;
Denis Vlasenko671691c2008-07-04 10:25:44 +000072} module_info;
73
74/*
75 * GLOBALS
76 */
77struct globals {
78 module_info *modinfo;
79 char *module_load_options;
Denis Vlasenko7f950a92008-07-10 14:14:45 +000080 smallint dep_bb_seen;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +000081 smallint wrote_dep_bb_ok;
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020082 unsigned module_count;
Denis Vlasenko671691c2008-07-04 10:25:44 +000083 int module_found_idx;
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020084 unsigned stringbuf_idx;
85 unsigned stringbuf_size;
86 char *stringbuf; /* some modules have lots of stuff */
Denis Vlasenko671691c2008-07-04 10:25:44 +000087 /* for example, drivers/media/video/saa7134/saa7134.ko */
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020088 /* therefore having a fixed biggish buffer is not wise */
Denis Vlasenko671691c2008-07-04 10:25:44 +000089};
90#define G (*ptr_to_globals)
91#define modinfo (G.modinfo )
Denis Vlasenko7f950a92008-07-10 14:14:45 +000092#define dep_bb_seen (G.dep_bb_seen )
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +000093#define wrote_dep_bb_ok (G.wrote_dep_bb_ok )
Denis Vlasenko671691c2008-07-04 10:25:44 +000094#define module_count (G.module_count )
95#define module_found_idx (G.module_found_idx )
96#define module_load_options (G.module_load_options)
97#define stringbuf_idx (G.stringbuf_idx )
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020098#define stringbuf_size (G.stringbuf_size )
Denis Vlasenko671691c2008-07-04 10:25:44 +000099#define stringbuf (G.stringbuf )
100#define INIT_G() do { \
101 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
102} while (0)
103
Denys Vlasenko0c6914e2009-09-07 02:38:26 +0200104static void append(const char *s)
105{
106 unsigned len = strlen(s);
107 if (stringbuf_idx + len + 15 > stringbuf_size) {
108 stringbuf_size = stringbuf_idx + len + 127;
109 dbg2_error_msg("grow stringbuf to %u", stringbuf_size);
110 stringbuf = xrealloc(stringbuf, stringbuf_size);
111 }
112 memcpy(stringbuf + stringbuf_idx, s, len);
113 stringbuf_idx += len;
114}
Denis Vlasenko671691c2008-07-04 10:25:44 +0000115
116static void appendc(char c)
117{
Denys Vlasenko0c6914e2009-09-07 02:38:26 +0200118 /* We appendc() only after append(), + 15 trick in append()
119 * makes it unnecessary to check for overflow here */
120 stringbuf[stringbuf_idx++] = c;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000121}
122
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000123static void bksp(void)
124{
125 if (stringbuf_idx)
126 stringbuf_idx--;
127}
128
Denis Vlasenko671691c2008-07-04 10:25:44 +0000129static void reset_stringbuf(void)
130{
131 stringbuf_idx = 0;
132}
133
134static char* copy_stringbuf(void)
135{
Denys Vlasenko0c6914e2009-09-07 02:38:26 +0200136 char *copy = xzalloc(stringbuf_idx + 1); /* terminating NUL */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000137 return memcpy(copy, stringbuf, stringbuf_idx);
138}
139
140static char* find_keyword(char *ptr, size_t len, const char *word)
141{
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000142 if (!ptr) /* happens if xmalloc_open_zipped_read_close cannot read it */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000143 return NULL;
144
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100145 len -= strlen(word) - 1;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000146 while ((ssize_t)len > 0) {
147 char *old = ptr;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100148 char *after_word;
149
Denis Vlasenko671691c2008-07-04 10:25:44 +0000150 /* search for the first char in word */
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100151 ptr = memchr(ptr, word[0], len);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000152 if (ptr == NULL) /* no occurance left, done */
153 break;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100154 after_word = is_prefixed_with(ptr, word);
155 if (after_word)
156 return after_word; /* found, return ptr past it */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000157 ++ptr;
158 len -= (ptr - old);
159 }
160 return NULL;
161}
162
163static void replace(char *s, char what, char with)
164{
165 while (*s) {
166 if (what == *s)
167 *s = with;
168 ++s;
169 }
170}
171
Denys Vlasenko07e55552014-04-21 16:59:36 +0200172static char *filename2modname(const char *filename, char *modname)
173{
174 int i;
Denys Vlasenko78854522015-01-01 19:02:40 +0100175 const char *from;
Denys Vlasenko07e55552014-04-21 16:59:36 +0200176
Denys Vlasenko78854522015-01-01 19:02:40 +0100177 // Disabled since otherwise "modprobe dir/name" would work
178 // as if it is "modprobe name". It is unclear why
179 // 'basenamization' was here in the first place.
180 //from = bb_get_last_path_component_nostrip(filename);
181 from = filename;
Denys Vlasenko07e55552014-04-21 16:59:36 +0200182 for (i = 0; i < (MODULE_NAME_LEN-1) && from[i] != '\0' && from[i] != '.'; i++)
183 modname[i] = (from[i] == '-') ? '_' : from[i];
184 modname[i] = '\0';
185
186 return modname;
187}
188
Denys Vlasenko1b671532015-01-11 17:46:56 +0100189static int pathname_matches_modname(const char *pathname, const char *modname)
190{
191 int r;
192 char name[MODULE_NAME_LEN];
193 filename2modname(bb_get_last_path_component_nostrip(pathname), name);
194 r = (strcmp(name, modname) == 0);
195 return r;
196}
197
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000198/* Take "word word", return malloced "word",NUL,"word",NUL,NUL */
199static char* str_2_list(const char *str)
200{
201 int len = strlen(str) + 1;
202 char *dst = xmalloc(len + 1);
203
204 dst[len] = '\0';
205 memcpy(dst, str, len);
206//TODO: protect against 2+ spaces: "word word"
207 replace(dst, ' ', '\0');
208 return dst;
209}
210
Denis Vlasenko671691c2008-07-04 10:25:44 +0000211/* We use error numbers in a loose translation... */
212static const char *moderror(int err)
213{
214 switch (err) {
215 case ENOEXEC:
216 return "invalid module format";
217 case ENOENT:
218 return "unknown symbol in module or invalid parameter";
219 case ESRCH:
220 return "module has wrong symbol version";
221 case EINVAL: /* "invalid parameter" */
222 return "unknown symbol in module or invalid parameter"
223 + sizeof("unknown symbol in module or");
224 default:
225 return strerror(err);
226 }
227}
228
229static int load_module(const char *fname, const char *options)
230{
231#if 1
232 int r;
233 size_t len = MAXINT(ssize_t);
234 char *module_image;
Mike Frysinger3a45b872016-09-15 12:16:33 +0200235
236 if (!options)
237 options = "";
238
Denis Vlasenko671691c2008-07-04 10:25:44 +0000239 dbg1_error_msg("load_module('%s','%s')", fname, options);
240
Mike Frysinger3a45b872016-09-15 12:16:33 +0200241 /*
242 * First we try finit_module if available. Some kernels are configured
243 * to only allow loading of modules off of secure storage (like a read-
244 * only rootfs) which needs the finit_module call. If it fails, we fall
245 * back to normal module loading to support compressed modules.
246 */
247 r = 1;
248# ifdef __NR_finit_module
249 {
250 int fd = open(fname, O_RDONLY | O_CLOEXEC);
251 if (fd >= 0) {
252 r = finit_module(fd, options, 0) != 0;
253 close(fd);
254 }
255 }
256# endif
257 if (r != 0) {
258 module_image = xmalloc_open_zipped_read_close(fname, &len);
259 r = (!module_image || init_module(module_image, len, options) != 0);
260 free(module_image);
261 }
262
Denis Vlasenko671691c2008-07-04 10:25:44 +0000263 dbg1_error_msg("load_module:%d", r);
264 return r; /* 0 = success */
265#else
266 /* For testing */
267 dbg1_error_msg("load_module('%s','%s')", fname, options);
268 return 1;
269#endif
270}
271
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200272/* Returns !0 if open/read was unsuccessful */
273static int parse_module(module_info *info, const char *pathname)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000274{
275 char *module_image;
276 char *ptr;
277 size_t len;
278 size_t pos;
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000279 dbg1_error_msg("parse_module('%s')", pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000280
281 /* Read (possibly compressed) module */
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200282 errno = 0;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000283 len = 64 * 1024 * 1024; /* 64 Mb at most */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000284 module_image = xmalloc_open_zipped_read_close(pathname, &len);
Denys Vlasenko094cc512011-01-17 14:58:27 +0100285 /* module_image == NULL is ok here, find_keyword handles it */
Denis Vlasenko78436992008-07-10 14:14:20 +0000286//TODO: optimize redundant module body reads
Denis Vlasenko671691c2008-07-04 10:25:44 +0000287
Denis Vlasenko78436992008-07-10 14:14:20 +0000288 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000289 reset_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000290 pos = 0;
291 while (1) {
Denys Vlasenko6116cb22014-04-19 16:17:27 +0200292 unsigned start = stringbuf_idx;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000293 ptr = find_keyword(module_image + pos, len - pos, "alias=");
294 if (!ptr) {
295 ptr = find_keyword(module_image + pos, len - pos, "__ksymtab_");
296 if (!ptr)
297 break;
298 /* DOCME: __ksymtab_gpl and __ksymtab_strings occur
299 * in many modules. What do they mean? */
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000300 if (strcmp(ptr, "gpl") == 0 || strcmp(ptr, "strings") == 0)
301 goto skip;
302 dbg2_error_msg("alias:'symbol:%s'", ptr);
303 append("symbol:");
Denis Vlasenko671691c2008-07-04 10:25:44 +0000304 } else {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000305 dbg2_error_msg("alias:'%s'", ptr);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000306 }
307 append(ptr);
308 appendc(' ');
Denys Vlasenko6116cb22014-04-19 16:17:27 +0200309 /*
310 * Don't add redundant aliases, such as:
311 * libcrc32c.ko symbol:crc32c symbol:crc32c
312 */
313 if (start) { /* "if we aren't the first alias" */
314 char *found, *last;
315 stringbuf[stringbuf_idx] = '\0';
316 last = stringbuf + start;
317 /*
318 * String at last-1 is " symbol:crc32c "
319 * (with both leading and trailing spaces).
320 */
321 if (strncmp(stringbuf, last, stringbuf_idx - start) == 0)
322 /* First alias matches us */
323 found = stringbuf;
324 else
325 /* Does any other alias match? */
326 found = strstr(stringbuf, last-1);
327 if (found < last-1) {
328 /* There is absolutely the same string before us */
329 dbg2_error_msg("redundant:'%s'", last);
330 stringbuf_idx = start;
331 goto skip;
332 }
333 }
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000334 skip:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000335 pos = (ptr - module_image);
336 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000337 bksp(); /* remove last ' ' */
Denis Vlasenko78436992008-07-10 14:14:20 +0000338 info->aliases = copy_stringbuf();
Denys Vlasenkof9c814b2009-09-07 02:37:19 +0200339 replace(info->aliases, '-', '_');
Denis Vlasenko671691c2008-07-04 10:25:44 +0000340
Denis Vlasenko78436992008-07-10 14:14:20 +0000341 /* "dependency1 depandency2" */
342 reset_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000343 ptr = find_keyword(module_image, len, "depends=");
344 if (ptr && *ptr) {
345 replace(ptr, ',', ' ');
346 replace(ptr, '-', '_');
347 dbg2_error_msg("dep:'%s'", ptr);
348 append(ptr);
349 }
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200350 free(module_image);
Denis Vlasenko78436992008-07-10 14:14:20 +0000351 info->deps = copy_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000352
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200353 info->open_read_failed = (module_image == NULL);
354 return info->open_read_failed;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000355}
356
Denis Vlasenko671691c2008-07-04 10:25:44 +0000357static FAST_FUNC int fileAction(const char *pathname,
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000358 struct stat *sb UNUSED_PARAM,
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000359 void *modname_to_match,
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000360 int depth UNUSED_PARAM)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000361{
362 int cur;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000363 const char *fname;
364
365 pathname += 2; /* skip "./" */
366 fname = bb_get_last_path_component_nostrip(pathname);
367 if (!strrstr(fname, ".ko")) {
368 dbg1_error_msg("'%s' is not a module", pathname);
369 return TRUE; /* not a module, continue search */
370 }
371
372 cur = module_count++;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000373 modinfo = xrealloc_vector(modinfo, 12, cur);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000374 modinfo[cur].pathname = xstrdup(pathname);
Denis Vlasenko27842282008-08-04 13:20:36 +0000375 /*modinfo[cur].aliases = NULL; - xrealloc_vector did it */
376 /*modinfo[cur+1].pathname = NULL;*/
Denis Vlasenko671691c2008-07-04 10:25:44 +0000377
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000378 if (!pathname_matches_modname(fname, modname_to_match)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000379 dbg1_error_msg("'%s' module name doesn't match", pathname);
380 return TRUE; /* module name doesn't match, continue search */
381 }
382
383 dbg1_error_msg("'%s' module name matches", pathname);
384 module_found_idx = cur;
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200385 if (parse_module(&modinfo[cur], pathname) != 0)
386 return TRUE; /* failed to open/read it, no point in trying loading */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000387
388 if (!(option_mask32 & OPT_r)) {
389 if (load_module(pathname, module_load_options) == 0) {
390 /* Load was successful, there is nothing else to do.
391 * This can happen ONLY for "top-level" module load,
392 * not a dep, because deps dont do dirscan. */
393 exit(EXIT_SUCCESS);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000394 }
395 }
396
Denis Vlasenko671691c2008-07-04 10:25:44 +0000397 return TRUE;
398}
399
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000400static int load_dep_bb(void)
Denis Vlasenko78436992008-07-10 14:14:20 +0000401{
402 char *line;
Denis Vlasenko5415c852008-07-21 23:05:26 +0000403 FILE *fp = fopen_for_read(DEPFILE_BB);
Denis Vlasenko78436992008-07-10 14:14:20 +0000404
405 if (!fp)
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000406 return 0;
407
408 dep_bb_seen = 1;
409 dbg1_error_msg("loading "DEPFILE_BB);
410
411 /* Why? There is a rare scenario: we did not find modprobe.dep.bb,
412 * we scanned the dir and found no module by name, then we search
413 * for alias (full scan), and we decided to generate modprobe.dep.bb.
414 * But we see modprobe.dep.bb.new! Other modprobe is at work!
415 * We wait and other modprobe renames it to modprobe.dep.bb.
416 * Now we can use it.
417 * But we already have modinfo[] filled, and "module_count = 0"
418 * makes us start anew. Yes, we leak modinfo[].xxx pointers -
419 * there is not much of data there anyway. */
420 module_count = 0;
421 memset(&modinfo[0], 0, sizeof(modinfo[0]));
Denis Vlasenko78436992008-07-10 14:14:20 +0000422
423 while ((line = xmalloc_fgetline(fp)) != NULL) {
424 char* space;
Denys Vlasenko90a99042009-09-06 02:36:23 +0200425 char* linebuf;
Denis Vlasenko78436992008-07-10 14:14:20 +0000426 int cur;
427
428 if (!line[0]) {
429 free(line);
430 continue;
431 }
432 space = strchrnul(line, ' ');
433 cur = module_count++;
434 modinfo = xrealloc_vector(modinfo, 12, cur);
Denis Vlasenko27842282008-08-04 13:20:36 +0000435 /*modinfo[cur+1].pathname = NULL; - xrealloc_vector did it */
Denis Vlasenko78436992008-07-10 14:14:20 +0000436 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
437 if (*space)
438 *space++ = '\0';
439 modinfo[cur].aliases = space;
Denys Vlasenko90a99042009-09-06 02:36:23 +0200440 linebuf = xmalloc_fgetline(fp);
441 modinfo[cur].deps = linebuf ? linebuf : xzalloc(1);
Denis Vlasenko78436992008-07-10 14:14:20 +0000442 if (modinfo[cur].deps[0]) {
443 /* deps are not "", so next line must be empty */
444 line = xmalloc_fgetline(fp);
445 /* Refuse to work with damaged config file */
446 if (line && line[0])
447 bb_error_msg_and_die("error in %s at '%s'", DEPFILE_BB, line);
448 free(line);
449 }
450 }
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000451 return 1;
452}
453
454static int start_dep_bb_writeout(void)
455{
456 int fd;
457
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000458 /* depmod -n: write result to stdout */
459 if (applet_name[0] == 'd' && (option_mask32 & 1))
460 return STDOUT_FILENO;
461
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000462 fd = open(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
463 if (fd < 0) {
464 if (errno == EEXIST) {
465 int count = 5 * 20;
466 dbg1_error_msg(DEPFILE_BB".new exists, waiting for "DEPFILE_BB);
467 while (1) {
468 usleep(1000*1000 / 20);
469 if (load_dep_bb()) {
470 dbg1_error_msg(DEPFILE_BB" appeared");
471 return -2; /* magic number */
472 }
473 if (!--count)
474 break;
475 }
476 bb_error_msg("deleting stale %s", DEPFILE_BB".new");
477 fd = open_or_warn(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC);
478 }
479 }
480 dbg1_error_msg("opened "DEPFILE_BB".new:%d", fd);
481 return fd;
482}
483
484static void write_out_dep_bb(int fd)
485{
486 int i;
487 FILE *fp;
488
489 /* We want good error reporting. fdprintf is not good enough. */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100490 fp = xfdopen_for_write(fd);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000491 i = 0;
492 while (modinfo[i].pathname) {
493 fprintf(fp, "%s%s%s\n" "%s%s\n",
494 modinfo[i].pathname, modinfo[i].aliases[0] ? " " : "", modinfo[i].aliases,
495 modinfo[i].deps, modinfo[i].deps[0] ? "\n" : "");
496 i++;
497 }
498 /* Badly formatted depfile is a no-no. Be paranoid. */
499 errno = 0;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000500 if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000501 goto err;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000502
503 if (fd == STDOUT_FILENO) /* it was depmod -n */
504 goto ok;
505
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000506 if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
507 err:
Denys Vlasenko651a2692010-03-23 16:25:17 +0100508 bb_perror_msg("can't create '%s'", DEPFILE_BB);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000509 unlink(DEPFILE_BB".new");
510 } else {
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000511 ok:
512 wrote_dep_bb_ok = 1;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000513 dbg1_error_msg("created "DEPFILE_BB);
514 }
Denis Vlasenko78436992008-07-10 14:14:20 +0000515}
516
Denys Vlasenko07e55552014-04-21 16:59:36 +0200517static module_info** find_alias(const char *alias)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000518{
519 int i;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000520 int dep_bb_fd;
Denys Vlasenko07e55552014-04-21 16:59:36 +0200521 int infoidx;
522 module_info **infovec;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000523 dbg1_error_msg("find_alias('%s')", alias);
524
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000525 try_again:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000526 /* First try to find by name (cheaper) */
527 i = 0;
528 while (modinfo[i].pathname) {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000529 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000530 dbg1_error_msg("found '%s' in module '%s'",
531 alias, modinfo[i].pathname);
Denis Vlasenko78436992008-07-10 14:14:20 +0000532 if (!modinfo[i].aliases) {
533 parse_module(&modinfo[i], modinfo[i].pathname);
534 }
Denys Vlasenko07e55552014-04-21 16:59:36 +0200535 infovec = xzalloc(2 * sizeof(infovec[0]));
536 infovec[0] = &modinfo[i];
537 return infovec;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000538 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000539 i++;
540 }
541
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000542 /* Ok, we definitely have to scan module bodies. This is a good
543 * moment to generate modprobe.dep.bb, if it does not exist yet */
544 dep_bb_fd = dep_bb_seen ? -1 : start_dep_bb_writeout();
545 if (dep_bb_fd == -2) /* modprobe.dep.bb appeared? */
546 goto try_again;
547
Denis Vlasenko671691c2008-07-04 10:25:44 +0000548 /* Scan all module bodies, extract modinfo (it contains aliases) */
549 i = 0;
Denys Vlasenko07e55552014-04-21 16:59:36 +0200550 infoidx = 0;
551 infovec = NULL;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000552 while (modinfo[i].pathname) {
553 char *desc, *s;
Denis Vlasenko78436992008-07-10 14:14:20 +0000554 if (!modinfo[i].aliases) {
555 parse_module(&modinfo[i], modinfo[i].pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000556 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000557 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
Denis Vlasenko78436992008-07-10 14:14:20 +0000558 desc = str_2_list(modinfo[i].aliases);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000559 /* Does matching substring exist? */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000560 for (s = desc; *s; s += strlen(s) + 1) {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000561 /* Aliases in module bodies can be defined with
Denis Vlasenko58f59a22008-07-06 11:52:23 +0000562 * shell patterns. Example:
563 * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
564 * Plain strcmp() won't catch that */
565 if (fnmatch(s, alias, 0) == 0) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000566 dbg1_error_msg("found alias '%s' in module '%s'",
567 alias, modinfo[i].pathname);
Denys Vlasenko07e55552014-04-21 16:59:36 +0200568 infovec = xrealloc_vector(infovec, 1, infoidx);
569 infovec[infoidx++] = &modinfo[i];
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000570 break;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000571 }
572 }
573 free(desc);
574 i++;
575 }
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000576
577 /* Create module.dep.bb if needed */
578 if (dep_bb_fd >= 0) {
579 write_out_dep_bb(dep_bb_fd);
580 }
581
Denys Vlasenko07e55552014-04-21 16:59:36 +0200582 dbg1_error_msg("find_alias '%s' returns %d results", alias, infoidx);
583 return infovec;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000584}
585
586#if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000587// TODO: open only once, invent config_rewind()
Denis Vlasenko671691c2008-07-04 10:25:44 +0000588static int already_loaded(const char *name)
589{
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100590 int ret;
Denys Vlasenko1fd84422015-02-12 16:18:39 +0100591 char *line;
592 FILE *fp;
593
594 ret = 5 * 2;
595 again:
596 fp = fopen_for_read("/proc/modules");
597 if (!fp)
598 return 0;
Denys Vlasenko1fd84422015-02-12 16:18:39 +0100599 while ((line = xmalloc_fgetline(fp)) != NULL) {
600 char *live;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100601 char *after_name;
Denys Vlasenko1fd84422015-02-12 16:18:39 +0100602
603 // Examples from kernel 3.14.6:
604 //pcspkr 12718 0 - Live 0xffffffffa017e000
605 //snd_timer 28690 2 snd_seq,snd_pcm, Live 0xffffffffa025e000
606 //i915 801405 2 - Live 0xffffffffa0096000
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100607 after_name = is_prefixed_with(line, name);
608 if (!after_name || *after_name != ' ') {
Denys Vlasenko1fd84422015-02-12 16:18:39 +0100609 free(line);
610 continue;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000611 }
Denys Vlasenko1fd84422015-02-12 16:18:39 +0100612 live = strstr(line, " Live");
613 free(line);
614 if (!live) {
615 /* State can be Unloading, Loading, or Live.
616 * modprobe must not return prematurely if we see "Loading":
617 * it can cause further programs to assume load completed,
618 * but it did not (yet)!
619 * Wait up to 5*20 ms for it to resolve.
620 */
621 ret -= 2;
622 if (ret == 0)
623 break; /* huh? report as "not loaded" */
624 fclose(fp);
625 usleep(20*1000);
626 goto again;
627 }
628 ret = 1;
629 break;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000630 }
Denys Vlasenko1fd84422015-02-12 16:18:39 +0100631 fclose(fp);
632
Denys Vlasenko402afe12015-02-13 11:53:33 +0100633 return ret & 1;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000634}
635#else
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100636#define already_loaded(name) 0
Denis Vlasenko671691c2008-07-04 10:25:44 +0000637#endif
638
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100639static int rmmod(const char *filename)
640{
641 int r;
642 char modname[MODULE_NAME_LEN];
643
644 filename2modname(filename, modname);
645 r = delete_module(modname, O_NONBLOCK | O_EXCL);
646 dbg1_error_msg("delete_module('%s', O_NONBLOCK | O_EXCL):%d", modname, r);
647 if (r != 0 && !(option_mask32 & OPT_q)) {
648 bb_perror_msg("remove '%s'", modname);
649 }
650 return r;
651}
652
Denis Vlasenko671691c2008-07-04 10:25:44 +0000653/*
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000654 * Given modules definition and module name (or alias, or symbol)
655 * load/remove the module respecting dependencies.
656 * NB: also called by depmod with bogus name "/",
657 * just in order to force modprobe.dep.bb creation.
Denis Vlasenko671691c2008-07-04 10:25:44 +0000658*/
659#if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
660#define process_module(a,b) process_module(a)
661#define cmdline_options ""
662#endif
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200663static int process_module(char *name, const char *cmdline_options)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000664{
665 char *s, *deps, *options;
Denys Vlasenko07e55552014-04-21 16:59:36 +0200666 module_info **infovec;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000667 module_info *info;
Denys Vlasenko07e55552014-04-21 16:59:36 +0200668 int infoidx;
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100669 int is_remove = (option_mask32 & OPT_r) != 0;
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200670 int exitcode = EXIT_SUCCESS;
Denys Vlasenko07e55552014-04-21 16:59:36 +0200671
Denis Vlasenko671691c2008-07-04 10:25:44 +0000672 dbg1_error_msg("process_module('%s','%s')", name, cmdline_options);
673
674 replace(name, '-', '_');
675
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100676 dbg1_error_msg("already_loaded:%d is_remove:%d", already_loaded(name), is_remove);
677
678 if (applet_name[0] == 'r') {
679 /* rmmod.
680 * Does not remove dependencies, no need to scan, just remove.
681 * (compat note: this allows and strips .ko suffix)
682 */
683 rmmod(name);
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200684 return EXIT_SUCCESS;
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100685 }
686
Denys Vlasenko07e55552014-04-21 16:59:36 +0200687 /*
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100688 * We used to have "is_remove != already_loaded(name)" check here, but
Denys Vlasenko07e55552014-04-21 16:59:36 +0200689 * modprobe -r pci:v00008086d00007010sv00000000sd00000000bc01sc01i80
690 * won't unload modules (there are more than one)
691 * which have this alias.
692 */
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100693 if (!is_remove && already_loaded(name)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000694 dbg1_error_msg("nothing to do for '%s'", name);
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200695 return EXIT_SUCCESS;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000696 }
697
698 options = NULL;
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100699 if (!is_remove) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000700 char *opt_filename = xasprintf("/etc/modules/%s", name);
701 options = xmalloc_open_read_close(opt_filename, NULL);
702 if (options)
703 replace(options, '\n', ' ');
704#if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
705 if (cmdline_options) {
706 /* NB: cmdline_options always have one leading ' '
707 * (see main()), we remove it here */
708 char *op = xasprintf(options ? "%s %s" : "%s %s" + 3,
709 cmdline_options + 1, options);
710 free(options);
711 options = op;
712 }
713#endif
714 free(opt_filename);
715 module_load_options = options;
716 dbg1_error_msg("process_module('%s'): options:'%s'", name, options);
717 }
718
719 if (!module_count) {
720 /* Scan module directory. This is done only once.
721 * It will attempt module load, and will exit(EXIT_SUCCESS)
Denys Vlasenko07e55552014-04-21 16:59:36 +0200722 * on success.
723 */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000724 module_found_idx = -1;
725 recursive_action(".",
726 ACTION_RECURSE, /* flags */
727 fileAction, /* file action */
728 NULL, /* dir action */
729 name, /* user data */
Denys Vlasenko07e55552014-04-21 16:59:36 +0200730 0 /* depth */
731 );
Denis Vlasenko671691c2008-07-04 10:25:44 +0000732 dbg1_error_msg("dirscan complete");
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100733 /* Module was not found, or load failed, or is_remove */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000734 if (module_found_idx >= 0) { /* module was found */
Denys Vlasenko07e55552014-04-21 16:59:36 +0200735 infovec = xzalloc(2 * sizeof(infovec[0]));
736 infovec[0] = &modinfo[module_found_idx];
Denis Vlasenko671691c2008-07-04 10:25:44 +0000737 } else { /* search for alias, not a plain module name */
Denys Vlasenko07e55552014-04-21 16:59:36 +0200738 infovec = find_alias(name);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000739 }
740 } else {
Denys Vlasenko07e55552014-04-21 16:59:36 +0200741 infovec = find_alias(name);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000742 }
743
Denys Vlasenko3c75b1c2015-01-11 17:40:30 +0100744 if (!infovec) {
745 /* both dirscan and find_alias found nothing */
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100746 if (!is_remove && applet_name[0] != 'd') /* it wasn't rmmod or depmod */
Denys Vlasenko3c75b1c2015-01-11 17:40:30 +0100747 bb_error_msg("module '%s' not found", name);
748//TODO: _and_die()? or should we continue (un)loading modules listed on cmdline?
749 goto ret;
750 }
751
Denys Vlasenko07e55552014-04-21 16:59:36 +0200752 /* There can be more than one module for the given alias. For example,
753 * "pci:v00008086d00007010sv00000000sd00000000bc01sc01i80" matches
754 * ata_piix because it has alias "pci:v00008086d00007010sv*sd*bc*sc*i*"
755 * and ata_generic, it has alias "pci:v*d*sv*sd*bc01sc01i*"
756 * Standard modprobe loads them both. We achieve it by returning
757 * a *list* of modinfo pointers from find_alias().
758 */
Denys Vlasenko63321512009-10-08 22:54:41 +0200759
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100760 /* modprobe -r? unload module(s) */
761 if (is_remove) {
Denys Vlasenko07e55552014-04-21 16:59:36 +0200762 infoidx = 0;
763 while ((info = infovec[infoidx++]) != NULL) {
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100764 int r = rmmod(bb_get_last_path_component_nostrip(info->pathname));
Denys Vlasenko07e55552014-04-21 16:59:36 +0200765 if (r != 0) {
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100766 goto ret; /* error */
Denys Vlasenko07e55552014-04-21 16:59:36 +0200767 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000768 }
Denys Vlasenko06a98e32012-09-25 20:37:38 +0200769 /* modprobe -r: we do not stop here -
Denis Vlasenko671691c2008-07-04 10:25:44 +0000770 * continue to unload modules on which the module depends:
771 * "-r --remove: option causes modprobe to remove a module.
772 * If the modules it depends on are also unused, modprobe
Denys Vlasenko06a98e32012-09-25 20:37:38 +0200773 * will try to remove them, too."
774 */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000775 }
776
Denys Vlasenko07e55552014-04-21 16:59:36 +0200777 infoidx = 0;
778 while ((info = infovec[infoidx++]) != NULL) {
779 /* Iterate thru dependencies, trying to (un)load them */
780 deps = str_2_list(info->deps);
781 for (s = deps; *s; s += strlen(s) + 1) {
782 //if (strcmp(name, s) != 0) // N.B. do loops exist?
783 dbg1_error_msg("recurse on dep '%s'", s);
784 process_module(s, NULL);
785 dbg1_error_msg("recurse on dep '%s' done", s);
786 }
787 free(deps);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000788
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100789 if (is_remove)
Denys Vlasenko07e55552014-04-21 16:59:36 +0200790 continue;
791
792 /* We are modprobe: load it */
793 if (options && strstr(options, "blacklist")) {
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000794 dbg1_error_msg("'%s': blacklisted", info->pathname);
Denys Vlasenko07e55552014-04-21 16:59:36 +0200795 continue;
796 }
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200797 if (info->open_read_failed) {
798 /* We already tried it, didn't work. Don't try load again */
799 exitcode = EXIT_FAILURE;
800 continue;
801 }
Denys Vlasenko07e55552014-04-21 16:59:36 +0200802 errno = 0;
803 if (load_module(info->pathname, options) != 0) {
804 if (EEXIST != errno) {
805 bb_error_msg("'%s': %s",
806 info->pathname,
807 moderror(errno));
808 } else {
809 dbg1_error_msg("'%s': %s",
810 info->pathname,
811 moderror(errno));
812 }
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200813 exitcode = EXIT_FAILURE;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000814 }
815 }
816 ret:
Denys Vlasenko07e55552014-04-21 16:59:36 +0200817 free(infovec);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000818 free(options);
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200819
820 return exitcode;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000821}
822#undef cmdline_options
823
824
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000825/* For reference, module-init-tools v3.4 options:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000826
827# insmod
828Usage: insmod filename [args]
829
830# rmmod --help
831Usage: rmmod [-fhswvV] modulename ...
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000832 -f (or --force) forces a module unload, and may crash your
833 machine. This requires the Forced Module Removal option
834 when the kernel was compiled.
835 -h (or --help) prints this help text
Denis Vlasenko671691c2008-07-04 10:25:44 +0000836 -s (or --syslog) says use syslog, not stderr
837 -v (or --verbose) enables more messages
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000838 -V (or --version) prints the version code
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000839 -w (or --wait) begins module removal even if it is used
Denis Vlasenko671691c2008-07-04 10:25:44 +0000840 and will stop new users from accessing the module (so it
841 should eventually fall to zero).
842
843# modprobe
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000844Usage: modprobe [-v] [-V] [-C config-file] [-n] [-i] [-q] [-b]
845 [-o <modname>] [ --dump-modversions ] <modname> [parameters...]
846modprobe -r [-n] [-i] [-v] <modulename> ...
847modprobe -l -t <dirname> [ -a <modulename> ...]
Denis Vlasenko671691c2008-07-04 10:25:44 +0000848
849# depmod --help
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000850depmod 3.4 -- part of module-init-tools
851depmod -[aA] [-n -e -v -q -V -r -u]
852 [-b basedirectory] [forced_version]
853depmod [-n -e -v -q -r -u] [-F kernelsyms] module1.ko module2.ko ...
854If no arguments (except options) are given, "depmod -a" is assumed.
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +0200855depmod will output a dependency list suitable for the modprobe utility.
Denis Vlasenko671691c2008-07-04 10:25:44 +0000856Options:
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000857 -a, --all Probe all modules
858 -A, --quick Only does the work if there's a new module
859 -n, --show Write the dependency file on stdout only
860 -e, --errsyms Report not supplied symbols
861 -V, --version Print the release version
862 -v, --verbose Enable verbose mode
863 -h, --help Print this usage message
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000864The following options are useful for people managing distributions:
865 -b basedirectory
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000866 --basedir basedirectory
867 Use an image of a module tree
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000868 -F kernelsyms
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000869 --filesyms kernelsyms
870 Use the file instead of the current kernel symbols
Denis Vlasenko671691c2008-07-04 10:25:44 +0000871*/
872
Pascal Bellardb82b34e2010-06-07 01:16:45 +0200873//usage:#if ENABLE_MODPROBE_SMALL
Denys Vlasenko1a5e11c2010-10-16 01:56:41 +0200874
875//usage:#define depmod_trivial_usage NOUSAGE_STR
876//usage:#define depmod_full_usage ""
877
878//usage:#define lsmod_trivial_usage
879//usage: ""
880//usage:#define lsmod_full_usage "\n\n"
881//usage: "List the currently loaded kernel modules"
882
883//usage:#define insmod_trivial_usage
884//usage: IF_FEATURE_2_4_MODULES("[OPTIONS] MODULE ")
885//usage: IF_NOT_FEATURE_2_4_MODULES("FILE ")
886//usage: "[SYMBOL=VALUE]..."
887//usage:#define insmod_full_usage "\n\n"
Denys Vlasenko5fd3ddf2014-04-19 15:04:39 +0200888//usage: "Load kernel module"
Denys Vlasenko1a5e11c2010-10-16 01:56:41 +0200889//usage: IF_FEATURE_2_4_MODULES( "\n"
Denys Vlasenko1a5e11c2010-10-16 01:56:41 +0200890//usage: "\n -f Force module to load into the wrong kernel version"
891//usage: "\n -k Make module autoclean-able"
892//usage: "\n -v Verbose"
893//usage: "\n -q Quiet"
894//usage: "\n -L Lock: prevent simultaneous loads"
895//usage: IF_FEATURE_INSMOD_LOAD_MAP(
896//usage: "\n -m Output load map to stdout"
897//usage: )
898//usage: "\n -x Don't export externs"
899//usage: )
900
901//usage:#define rmmod_trivial_usage
902//usage: "[-wfa] [MODULE]..."
903//usage:#define rmmod_full_usage "\n\n"
904//usage: "Unload kernel modules\n"
Denys Vlasenko1a5e11c2010-10-16 01:56:41 +0200905//usage: "\n -w Wait until the module is no longer used"
906//usage: "\n -f Force unload"
907//usage: "\n -a Remove all unused modules (recursively)"
908//usage:
909//usage:#define rmmod_example_usage
910//usage: "$ rmmod tulip\n"
911
Pascal Bellardb82b34e2010-06-07 01:16:45 +0200912//usage:#define modprobe_trivial_usage
Denys Vlasenko5fd3ddf2014-04-19 15:04:39 +0200913//usage: "[-qfwrsv] MODULE [SYMBOL=VALUE]..."
Pascal Bellardb82b34e2010-06-07 01:16:45 +0200914//usage:#define modprobe_full_usage "\n\n"
Denys Vlasenko66426762011-06-05 03:58:28 +0200915//usage: " -r Remove MODULE (stacks) or do autoclean"
Pascal Bellardb82b34e2010-06-07 01:16:45 +0200916//usage: "\n -q Quiet"
917//usage: "\n -v Verbose"
918//usage: "\n -f Force"
919//usage: "\n -w Wait for unload"
920//usage: "\n -s Report via syslog instead of stderr"
Denys Vlasenko1a5e11c2010-10-16 01:56:41 +0200921
922//usage:#endif
Pascal Bellardb82b34e2010-06-07 01:16:45 +0200923
Denis Vlasenko671691c2008-07-04 10:25:44 +0000924int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000925int modprobe_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000926{
Denys Vlasenko5c3e0602016-06-20 10:59:06 +0200927 int exitcode;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000928 struct utsname uts;
929 char applet0 = applet_name[0];
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000930 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000931
Denis Vlasenko671691c2008-07-04 10:25:44 +0000932 /* are we lsmod? -> just dump /proc/modules */
Denys Vlasenkoa1cd0d92016-12-23 15:12:27 +0100933 if (ENABLE_LSMOD && 'l' == applet0) {
Denis Vlasenko5415c852008-07-21 23:05:26 +0000934 xprint_and_close_file(xfopen_for_read("/proc/modules"));
Denis Vlasenko671691c2008-07-04 10:25:44 +0000935 return EXIT_SUCCESS;
936 }
937
938 INIT_G();
939
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000940 /* Prevent ugly corner cases with no modules at all */
941 modinfo = xzalloc(sizeof(modinfo[0]));
942
Denys Vlasenkoa1cd0d92016-12-23 15:12:27 +0100943 if (!ENABLE_INSMOD || 'i' != applet0) { /* not insmod */
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000944 /* Goto modules directory */
945 xchdir(CONFIG_DEFAULT_MODULES_DIR);
946 }
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000947 uname(&uts); /* never fails */
948
949 /* depmod? */
Denys Vlasenkoa1cd0d92016-12-23 15:12:27 +0100950 if (ENABLE_DEPMOD && 'd' == applet0) {
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000951 /* Supported:
952 * -n: print result to stdout
953 * -a: process all modules (default)
954 * optional VERSION parameter
955 * Ignored:
956 * -A: do work only if a module is newer than depfile
957 * -e: report any symbols which a module needs
958 * which are not supplied by other modules or the kernel
959 * -F FILE: System.map (symbols for -e)
960 * -q, -r, -u: noop?
961 * Not supported:
962 * -b BASEDIR: (TODO!) modules are in
963 * $BASEDIR/lib/modules/$VERSION
964 * -v: human readable deps to stdout
965 * -V: version (don't want to support it - people may depend
966 * on it as an indicator of "standard" depmod)
967 * -h: help (well duh)
968 * module1.o module2.o parameters (just ignored for now)
969 */
970 getopt32(argv, "na" "AeF:qru" /* "b:vV", NULL */, NULL);
971 argv += optind;
972 /* if (argv[0] && argv[1]) bb_show_usage(); */
973 /* Goto $VERSION directory */
974 xchdir(argv[0] ? argv[0] : uts.release);
975 /* Force full module scan by asking to find a bogus module.
976 * This will generate modules.dep.bb as a side effect. */
977 process_module((char*)"/", NULL);
978 return !wrote_dep_bb_ok;
979 }
980
Denis Vlasenko671691c2008-07-04 10:25:44 +0000981 /* insmod, modprobe, rmmod require at least one argument */
982 opt_complementary = "-1";
983 /* only -q (quiet) and -r (rmmod),
984 * the rest are accepted and ignored (compat) */
Felipe Contreras428bd2d2012-01-31 14:55:15 +0100985 getopt32(argv, "qrfsvwb");
Denis Vlasenko671691c2008-07-04 10:25:44 +0000986 argv += optind;
987
988 /* are we rmmod? -> simulate modprobe -r */
Denys Vlasenkoa1cd0d92016-12-23 15:12:27 +0100989 if (ENABLE_RMMOD && 'r' == applet0) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000990 option_mask32 |= OPT_r;
991 }
992
Denys Vlasenkoa1cd0d92016-12-23 15:12:27 +0100993 if (!ENABLE_INSMOD || 'i' != applet0) { /* not insmod */
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000994 /* Goto $VERSION directory */
995 xchdir(uts.release);
996 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000997
998#if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
Denys Vlasenko68c048f2015-02-07 20:44:46 +0100999 /* If not rmmod/-r, parse possible module options given on command line.
Denis Vlasenko671691c2008-07-04 10:25:44 +00001000 * insmod/modprobe takes one module name, the rest are parameters. */
1001 options = NULL;
Denys Vlasenko68c048f2015-02-07 20:44:46 +01001002 if (!(option_mask32 & OPT_r)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +00001003 char **arg = argv;
1004 while (*++arg) {
1005 /* Enclose options in quotes */
1006 char *s = options;
1007 options = xasprintf("%s \"%s\"", s ? s : "", *arg);
1008 free(s);
1009 *arg = NULL;
1010 }
1011 }
1012#else
Denys Vlasenko68c048f2015-02-07 20:44:46 +01001013 if (!(option_mask32 & OPT_r))
Denis Vlasenko671691c2008-07-04 10:25:44 +00001014 argv[1] = NULL;
1015#endif
1016
Denys Vlasenkoa1cd0d92016-12-23 15:12:27 +01001017 if (ENABLE_INSMOD && 'i' == applet0) { /* insmod */
Denis Vlasenko1c781cc2008-09-06 14:14:01 +00001018 size_t len;
1019 void *map;
1020
1021 len = MAXINT(ssize_t);
Denys Vlasenkoe9d12b52011-01-09 20:57:52 +01001022 map = xmalloc_open_zipped_read_close(*argv, &len);
Denys Vlasenko094cc512011-01-17 14:58:27 +01001023 if (!map)
1024 bb_perror_msg_and_die("can't read '%s'", *argv);
Denis Vlasenko1c781cc2008-09-06 14:14:01 +00001025 if (init_module(map, len,
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001026 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(options ? options : "")
1027 IF_NOT_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE("")
Denys Vlasenkoe9d12b52011-01-09 20:57:52 +01001028 ) != 0
1029 ) {
Denis Vlasenko1f632292009-04-13 02:25:40 +00001030 bb_error_msg_and_die("can't insert '%s': %s",
Denis Vlasenko1c781cc2008-09-06 14:14:01 +00001031 *argv, moderror(errno));
Denys Vlasenkoe9d12b52011-01-09 20:57:52 +01001032 }
Denys Vlasenko5c3e0602016-06-20 10:59:06 +02001033 return EXIT_SUCCESS;
Denis Vlasenko1c781cc2008-09-06 14:14:01 +00001034 }
1035
Denis Vlasenko7f950a92008-07-10 14:14:45 +00001036 /* Try to load modprobe.dep.bb */
Denys Vlasenkoa1cd0d92016-12-23 15:12:27 +01001037 if (!ENABLE_RMMOD || 'r' != applet0) { /* not rmmod */
Denys Vlasenko68c048f2015-02-07 20:44:46 +01001038 load_dep_bb();
Denys Vlasenko5c3e0602016-06-20 10:59:06 +02001039 }
Denis Vlasenko78436992008-07-10 14:14:20 +00001040
Denis Vlasenko671691c2008-07-04 10:25:44 +00001041 /* Load/remove modules.
Denys Vlasenko68c048f2015-02-07 20:44:46 +01001042 * Only rmmod/modprobe -r loops here, insmod/modprobe has only argv[0] */
Denys Vlasenko5c3e0602016-06-20 10:59:06 +02001043 exitcode = EXIT_SUCCESS;
Denis Vlasenko671691c2008-07-04 10:25:44 +00001044 do {
Denys Vlasenko5c3e0602016-06-20 10:59:06 +02001045 exitcode |= process_module(*argv, options);
Denys Vlasenko5b3151c2010-09-25 14:37:06 +02001046 } while (*++argv);
Denis Vlasenko671691c2008-07-04 10:25:44 +00001047
1048 if (ENABLE_FEATURE_CLEAN_UP) {
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001049 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)
Denis Vlasenko671691c2008-07-04 10:25:44 +00001050 }
Denys Vlasenko5c3e0602016-06-20 10:59:06 +02001051 return exitcode;
Denis Vlasenko671691c2008-07-04 10:25:44 +00001052}