blob: f4f17e766385d256a5a6ed0995613ffb997eb8be [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 */
10
Denys Vlasenkoc15613c2010-10-15 11:29:02 +020011//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
Denis Vlasenko671691c2008-07-04 10:25:44 +000017#include "libbb.h"
Denys Vlasenko043b1e52009-09-06 12:47:55 +020018/* After libbb.h, since it needs sys/types.h on some systems */
Denis Vlasenko671691c2008-07-04 10:25:44 +000019#include <sys/utsname.h> /* uname() */
20#include <fnmatch.h>
21
Denis Vlasenko24a131e2008-07-09 15:30:57 +000022extern int init_module(void *module, unsigned long len, const char *options);
23extern int delete_module(const char *module, unsigned flags);
24extern int query_module(const char *name, int which, void *buf, size_t bufsize, size_t *ret);
25
26
Denys Vlasenko5b3151c2010-09-25 14:37:06 +020027#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
Denis Vlasenko671691c2008-07-04 10:25:44 +000034
Denis Vlasenko24a131e2008-07-09 15:30:57 +000035#define DEPFILE_BB CONFIG_DEFAULT_DEPMOD_FILE".bb"
Denis Vlasenko671691c2008-07-04 10:25:44 +000036
37enum {
38 OPT_q = (1 << 0), /* be quiet */
39 OPT_r = (1 << 1), /* module removal instead of loading */
40};
41
42typedef struct module_info {
43 char *pathname;
Denis Vlasenko78436992008-07-10 14:14:20 +000044 char *aliases;
45 char *deps;
Denis Vlasenko671691c2008-07-04 10:25:44 +000046} module_info;
47
48/*
49 * GLOBALS
50 */
51struct globals {
52 module_info *modinfo;
53 char *module_load_options;
Denis Vlasenko7f950a92008-07-10 14:14:45 +000054 smallint dep_bb_seen;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +000055 smallint wrote_dep_bb_ok;
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020056 unsigned module_count;
Denis Vlasenko671691c2008-07-04 10:25:44 +000057 int module_found_idx;
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020058 unsigned stringbuf_idx;
59 unsigned stringbuf_size;
60 char *stringbuf; /* some modules have lots of stuff */
Denis Vlasenko671691c2008-07-04 10:25:44 +000061 /* for example, drivers/media/video/saa7134/saa7134.ko */
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020062 /* therefore having a fixed biggish buffer is not wise */
Denis Vlasenko671691c2008-07-04 10:25:44 +000063};
64#define G (*ptr_to_globals)
65#define modinfo (G.modinfo )
Denis Vlasenko7f950a92008-07-10 14:14:45 +000066#define dep_bb_seen (G.dep_bb_seen )
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +000067#define wrote_dep_bb_ok (G.wrote_dep_bb_ok )
Denis Vlasenko671691c2008-07-04 10:25:44 +000068#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 )
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020072#define stringbuf_size (G.stringbuf_size )
Denis Vlasenko671691c2008-07-04 10:25:44 +000073#define stringbuf (G.stringbuf )
74#define INIT_G() do { \
75 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
76} while (0)
77
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020078static 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}
Denis Vlasenko671691c2008-07-04 10:25:44 +000089
90static void appendc(char c)
91{
Denys Vlasenko0c6914e2009-09-07 02:38:26 +020092 /* We appendc() only after append(), + 15 trick in append()
93 * makes it unnecessary to check for overflow here */
94 stringbuf[stringbuf_idx++] = c;
Denis Vlasenko671691c2008-07-04 10:25:44 +000095}
96
Denis Vlasenko24a131e2008-07-09 15:30:57 +000097static void bksp(void)
98{
99 if (stringbuf_idx)
100 stringbuf_idx--;
101}
102
Denis Vlasenko671691c2008-07-04 10:25:44 +0000103static void reset_stringbuf(void)
104{
105 stringbuf_idx = 0;
106}
107
108static char* copy_stringbuf(void)
109{
Denys Vlasenko0c6914e2009-09-07 02:38:26 +0200110 char *copy = xzalloc(stringbuf_idx + 1); /* terminating NUL */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000111 return memcpy(copy, stringbuf, stringbuf_idx);
112}
113
114static char* find_keyword(char *ptr, size_t len, const char *word)
115{
116 int wlen;
117
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000118 if (!ptr) /* happens if xmalloc_open_zipped_read_close cannot read it */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000119 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
137static void replace(char *s, char what, char with)
138{
139 while (*s) {
140 if (what == *s)
141 *s = with;
142 ++s;
143 }
144}
145
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000146/* Take "word word", return malloced "word",NUL,"word",NUL,NUL */
147static 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
Denis Vlasenko671691c2008-07-04 10:25:44 +0000159/* We use error numbers in a loose translation... */
160static 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
177static 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
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000185 module_image = xmalloc_open_zipped_read_close(fname, &len);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000186 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
Denis Vlasenko78436992008-07-10 14:14:20 +0000197static void parse_module(module_info *info, const char *pathname)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000198{
199 char *module_image;
200 char *ptr;
201 size_t len;
202 size_t pos;
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000203 dbg1_error_msg("parse_module('%s')", pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000204
205 /* Read (possibly compressed) module */
206 len = 64 * 1024 * 1024; /* 64 Mb at most */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000207 module_image = xmalloc_open_zipped_read_close(pathname, &len);
Denis Vlasenko78436992008-07-10 14:14:20 +0000208//TODO: optimize redundant module body reads
Denis Vlasenko671691c2008-07-04 10:25:44 +0000209
Denis Vlasenko78436992008-07-10 14:14:20 +0000210 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000211 reset_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000212 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? */
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000221 if (strcmp(ptr, "gpl") == 0 || strcmp(ptr, "strings") == 0)
222 goto skip;
223 dbg2_error_msg("alias:'symbol:%s'", ptr);
224 append("symbol:");
Denis Vlasenko671691c2008-07-04 10:25:44 +0000225 } else {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000226 dbg2_error_msg("alias:'%s'", ptr);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000227 }
228 append(ptr);
229 appendc(' ');
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000230 skip:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000231 pos = (ptr - module_image);
232 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000233 bksp(); /* remove last ' ' */
Denis Vlasenko78436992008-07-10 14:14:20 +0000234 info->aliases = copy_stringbuf();
Denys Vlasenkof9c814b2009-09-07 02:37:19 +0200235 replace(info->aliases, '-', '_');
Denis Vlasenko671691c2008-07-04 10:25:44 +0000236
Denis Vlasenko78436992008-07-10 14:14:20 +0000237 /* "dependency1 depandency2" */
238 reset_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000239 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 }
Denis Vlasenko78436992008-07-10 14:14:20 +0000246 info->deps = copy_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000247
248 free(module_image);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000249}
250
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000251static int pathname_matches_modname(const char *pathname, const char *modname)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000252{
253 const char *fname = bb_get_last_path_component_nostrip(pathname);
254 const char *suffix = strrstr(fname, ".ko");
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000255//TODO: can do without malloc?
Denis Vlasenko671691c2008-07-04 10:25:44 +0000256 char *name = xstrndup(fname, suffix - fname);
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000257 int r;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000258 replace(name, '-', '_');
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000259 r = (strcmp(name, modname) == 0);
260 free(name);
261 return r;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000262}
263
264static FAST_FUNC int fileAction(const char *pathname,
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000265 struct stat *sb UNUSED_PARAM,
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000266 void *modname_to_match,
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000267 int depth UNUSED_PARAM)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000268{
269 int cur;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000270 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++;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000280 modinfo = xrealloc_vector(modinfo, 12, cur);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000281 modinfo[cur].pathname = xstrdup(pathname);
Denis Vlasenko27842282008-08-04 13:20:36 +0000282 /*modinfo[cur].aliases = NULL; - xrealloc_vector did it */
283 /*modinfo[cur+1].pathname = NULL;*/
Denis Vlasenko671691c2008-07-04 10:25:44 +0000284
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000285 if (!pathname_matches_modname(fname, modname_to_match)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000286 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;
Denis Vlasenko78436992008-07-10 14:14:20 +0000292 parse_module(&modinfo[cur], pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000293
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);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000300 }
301 }
302
Denis Vlasenko671691c2008-07-04 10:25:44 +0000303 return TRUE;
304}
305
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000306static int load_dep_bb(void)
Denis Vlasenko78436992008-07-10 14:14:20 +0000307{
308 char *line;
Denis Vlasenko5415c852008-07-21 23:05:26 +0000309 FILE *fp = fopen_for_read(DEPFILE_BB);
Denis Vlasenko78436992008-07-10 14:14:20 +0000310
311 if (!fp)
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000312 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]));
Denis Vlasenko78436992008-07-10 14:14:20 +0000328
329 while ((line = xmalloc_fgetline(fp)) != NULL) {
330 char* space;
Denys Vlasenko90a99042009-09-06 02:36:23 +0200331 char* linebuf;
Denis Vlasenko78436992008-07-10 14:14:20 +0000332 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);
Denis Vlasenko27842282008-08-04 13:20:36 +0000341 /*modinfo[cur+1].pathname = NULL; - xrealloc_vector did it */
Denis Vlasenko78436992008-07-10 14:14:20 +0000342 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
343 if (*space)
344 *space++ = '\0';
345 modinfo[cur].aliases = space;
Denys Vlasenko90a99042009-09-06 02:36:23 +0200346 linebuf = xmalloc_fgetline(fp);
347 modinfo[cur].deps = linebuf ? linebuf : xzalloc(1);
Denis Vlasenko78436992008-07-10 14:14:20 +0000348 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 }
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000357 return 1;
358}
359
360static int start_dep_bb_writeout(void)
361{
362 int fd;
363
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000364 /* depmod -n: write result to stdout */
365 if (applet_name[0] == 'd' && (option_mask32 & 1))
366 return STDOUT_FILENO;
367
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000368 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
390static 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. */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100396 fp = xfdopen_for_write(fd);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000397 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;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000406 if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000407 goto err;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000408
409 if (fd == STDOUT_FILENO) /* it was depmod -n */
410 goto ok;
411
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000412 if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
413 err:
Denys Vlasenko651a2692010-03-23 16:25:17 +0100414 bb_perror_msg("can't create '%s'", DEPFILE_BB);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000415 unlink(DEPFILE_BB".new");
416 } else {
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000417 ok:
418 wrote_dep_bb_ok = 1;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000419 dbg1_error_msg("created "DEPFILE_BB);
420 }
Denis Vlasenko78436992008-07-10 14:14:20 +0000421}
422
Denis Vlasenko671691c2008-07-04 10:25:44 +0000423static module_info* find_alias(const char *alias)
424{
425 int i;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000426 int dep_bb_fd;
427 module_info *result;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000428 dbg1_error_msg("find_alias('%s')", alias);
429
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000430 try_again:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000431 /* First try to find by name (cheaper) */
432 i = 0;
433 while (modinfo[i].pathname) {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000434 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000435 dbg1_error_msg("found '%s' in module '%s'",
436 alias, modinfo[i].pathname);
Denis Vlasenko78436992008-07-10 14:14:20 +0000437 if (!modinfo[i].aliases) {
438 parse_module(&modinfo[i], modinfo[i].pathname);
439 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000440 return &modinfo[i];
441 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000442 i++;
443 }
444
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000445 /* 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
Denis Vlasenko671691c2008-07-04 10:25:44 +0000451 /* Scan all module bodies, extract modinfo (it contains aliases) */
452 i = 0;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000453 result = NULL;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000454 while (modinfo[i].pathname) {
455 char *desc, *s;
Denis Vlasenko78436992008-07-10 14:14:20 +0000456 if (!modinfo[i].aliases) {
457 parse_module(&modinfo[i], modinfo[i].pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000458 }
Denis Vlasenko8e804112008-08-06 09:41:09 +0000459 if (result) {
460 i++;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000461 continue;
Denis Vlasenko8e804112008-08-06 09:41:09 +0000462 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000463 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
Denis Vlasenko78436992008-07-10 14:14:20 +0000464 desc = str_2_list(modinfo[i].aliases);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000465 /* Does matching substring exist? */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000466 for (s = desc; *s; s += strlen(s) + 1) {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000467 /* Aliases in module bodies can be defined with
Denis Vlasenko58f59a22008-07-06 11:52:23 +0000468 * shell patterns. Example:
469 * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
470 * Plain strcmp() won't catch that */
471 if (fnmatch(s, alias, 0) == 0) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000472 dbg1_error_msg("found alias '%s' in module '%s'",
473 alias, modinfo[i].pathname);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000474 result = &modinfo[i];
475 break;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000476 }
477 }
478 free(desc);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000479 if (result && dep_bb_fd < 0)
480 return result;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000481 i++;
482 }
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000483
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;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000491}
492
493#if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000494// TODO: open only once, invent config_rewind()
Denis Vlasenko671691c2008-07-04 10:25:44 +0000495static int already_loaded(const char *name)
496{
497 int ret = 0;
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000498 char *s;
499 parser_t *parser = config_open2("/proc/modules", xfopen_for_read);
Denis Vlasenko084266e2008-07-26 23:08:31 +0000500 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY)) {
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000501 if (strcmp(s, name) == 0) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000502 ret = 1;
503 break;
504 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000505 }
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000506 config_close(parser);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000507 return ret;
508}
509#else
510#define already_loaded(name) is_rmmod
511#endif
512
513/*
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000514 * 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.
Denis Vlasenko671691c2008-07-04 10:25:44 +0000518*/
519#if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
520#define process_module(a,b) process_module(a)
521#define cmdline_options ""
522#endif
523static 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
Denys Vlasenko63321512009-10-08 22:54:41 +0200581// 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
Denis Vlasenko671691c2008-07-04 10:25:44 +0000589 /* rmmod? unload it by name */
590 if (is_rmmod) {
Denys Vlasenko5b3151c2010-09-25 14:37:06 +0200591 if (delete_module(name, O_NONBLOCK | O_EXCL) != 0) {
592 if (!(option_mask32 & OPT_q))
593 bb_perror_msg("remove '%s'", name);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000594 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
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000603 if (!info) {
604 /* both dirscan and find_alias found nothing */
Denys Vlasenko5b3151c2010-09-25 14:37:06 +0200605 if (!is_rmmod && applet_name[0] != 'd') /* it wasn't rmmod or depmod */
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000606 bb_error_msg("module '%s' not found", name);
Denys Vlasenko5b3151c2010-09-25 14:37:06 +0200607//TODO: _and_die()? or should we continue (un)loading modules listed on cmdline?
Denis Vlasenko671691c2008-07-04 10:25:44 +0000608 goto ret;
609 }
610
Denis Vlasenko671691c2008-07-04 10:25:44 +0000611 /* Iterate thru dependencies, trying to (un)load them */
Denis Vlasenko78436992008-07-10 14:14:20 +0000612 deps = str_2_list(info->deps);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000613 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
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000621 /* modprobe -> load it */
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000622 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",
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000628 info->pathname,
Denis Vlasenko671691c2008-07-04 10:25:44 +0000629 moderror(errno));
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000630 } else {
631 dbg1_error_msg("'%s': %s",
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000632 info->pathname,
Denis Vlasenko671691c2008-07-04 10:25:44 +0000633 moderror(errno));
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000634 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000635 }
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000636 } else {
637 dbg1_error_msg("'%s': blacklisted", info->pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000638 }
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
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000648/* For reference, module-init-tools v3.4 options:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000649
650# insmod
651Usage: insmod filename [args]
652
653# rmmod --help
654Usage: rmmod [-fhswvV] modulename ...
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000655 -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
Denis Vlasenko671691c2008-07-04 10:25:44 +0000659 -s (or --syslog) says use syslog, not stderr
660 -v (or --verbose) enables more messages
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000661 -V (or --version) prints the version code
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000662 -w (or --wait) begins module removal even if it is used
Denis Vlasenko671691c2008-07-04 10:25:44 +0000663 and will stop new users from accessing the module (so it
664 should eventually fall to zero).
665
666# modprobe
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000667Usage: modprobe [-v] [-V] [-C config-file] [-n] [-i] [-q] [-b]
668 [-o <modname>] [ --dump-modversions ] <modname> [parameters...]
669modprobe -r [-n] [-i] [-v] <modulename> ...
670modprobe -l -t <dirname> [ -a <modulename> ...]
Denis Vlasenko671691c2008-07-04 10:25:44 +0000671
672# depmod --help
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000673depmod 3.4 -- part of module-init-tools
674depmod -[aA] [-n -e -v -q -V -r -u]
675 [-b basedirectory] [forced_version]
676depmod [-n -e -v -q -r -u] [-F kernelsyms] module1.ko module2.ko ...
677If no arguments (except options) are given, "depmod -a" is assumed.
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +0200678depmod will output a dependency list suitable for the modprobe utility.
Denis Vlasenko671691c2008-07-04 10:25:44 +0000679Options:
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000680 -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
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000687The following options are useful for people managing distributions:
688 -b basedirectory
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000689 --basedir basedirectory
690 Use an image of a module tree
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000691 -F kernelsyms
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000692 --filesyms kernelsyms
693 Use the file instead of the current kernel symbols
Denis Vlasenko671691c2008-07-04 10:25:44 +0000694*/
695
Pascal Bellardb82b34e2010-06-07 01:16:45 +0200696//usage:#if ENABLE_MODPROBE_SMALL
Denys Vlasenko1a5e11c2010-10-16 01:56:41 +0200697
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
Pascal Bellardb82b34e2010-06-07 01:16:45 +0200737//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"
Denys Vlasenko1a5e11c2010-10-16 01:56:41 +0200747
748//usage:#endif
Pascal Bellardb82b34e2010-06-07 01:16:45 +0200749
Denis Vlasenko671691c2008-07-04 10:25:44 +0000750int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000751int modprobe_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000752{
753 struct utsname uts;
754 char applet0 = applet_name[0];
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000755 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000756
Denis Vlasenko671691c2008-07-04 10:25:44 +0000757 /* are we lsmod? -> just dump /proc/modules */
758 if ('l' == applet0) {
Denis Vlasenko5415c852008-07-21 23:05:26 +0000759 xprint_and_close_file(xfopen_for_read("/proc/modules"));
Denis Vlasenko671691c2008-07-04 10:25:44 +0000760 return EXIT_SUCCESS;
761 }
762
763 INIT_G();
764
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000765 /* Prevent ugly corner cases with no modules at all */
766 modinfo = xzalloc(sizeof(modinfo[0]));
767
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000768 if ('i' != applet0) { /* not insmod */
769 /* Goto modules directory */
770 xchdir(CONFIG_DEFAULT_MODULES_DIR);
771 }
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000772 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
Denis Vlasenko671691c2008-07-04 10:25:44 +0000806 /* 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
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000818 if ('i' != applet0) { /* not insmod */
819 /* Goto $VERSION directory */
820 xchdir(uts.release);
821 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000822
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
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000842 if ('i' == applet0) { /* insmod */
843 size_t len;
844 void *map;
845
846 len = MAXINT(ssize_t);
Denys Vlasenkoe9d12b52011-01-09 20:57:52 +0100847 map = xmalloc_open_zipped_read_close(*argv, &len);
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000848 if (init_module(map, len,
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000849 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(options ? options : "")
850 IF_NOT_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE("")
Denys Vlasenkoe9d12b52011-01-09 20:57:52 +0100851 ) != 0
852 ) {
Denis Vlasenko1f632292009-04-13 02:25:40 +0000853 bb_error_msg_and_die("can't insert '%s': %s",
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000854 *argv, moderror(errno));
Denys Vlasenkoe9d12b52011-01-09 20:57:52 +0100855 }
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000856 return 0;
857 }
858
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000859 /* Try to load modprobe.dep.bb */
Denis Vlasenko78436992008-07-10 14:14:20 +0000860 load_dep_bb();
861
Denis Vlasenko671691c2008-07-04 10:25:44 +0000862 /* Load/remove modules.
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000863 * Only rmmod loops here, modprobe has only argv[0] */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000864 do {
Denys Vlasenko5b3151c2010-09-25 14:37:06 +0200865 process_module(*argv, options);
866 } while (*++argv);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000867
868 if (ENABLE_FEATURE_CLEAN_UP) {
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000869 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000870 }
871 return EXIT_SUCCESS;
872}