blob: bc80723fad87df16dcfa4a769ec45dee18c090b2 [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 *
8 * Licensed under GPLv2, see file LICENSE in this tarball for details.
9 */
10
11#include "libbb.h"
Denys Vlasenko043b1e52009-09-06 12:47:55 +020012/* After libbb.h, since it needs sys/types.h on some systems */
Denis Vlasenko671691c2008-07-04 10:25:44 +000013#include <sys/utsname.h> /* uname() */
14#include <fnmatch.h>
15
Denis Vlasenko24a131e2008-07-09 15:30:57 +000016extern int init_module(void *module, unsigned long len, const char *options);
17extern int delete_module(const char *module, unsigned flags);
18extern int query_module(const char *name, int which, void *buf, size_t bufsize, size_t *ret);
19
20
Denis Vlasenkocee0dfc2008-07-06 11:11:35 +000021#define dbg1_error_msg(...) ((void)0)
22#define dbg2_error_msg(...) ((void)0)
23//#define dbg1_error_msg(...) bb_error_msg(__VA_ARGS__)
24//#define dbg2_error_msg(...) bb_error_msg(__VA_ARGS__)
Denis Vlasenko671691c2008-07-04 10:25:44 +000025
Denis Vlasenko24a131e2008-07-09 15:30:57 +000026#define DEPFILE_BB CONFIG_DEFAULT_DEPMOD_FILE".bb"
Denis Vlasenko671691c2008-07-04 10:25:44 +000027
28enum {
29 OPT_q = (1 << 0), /* be quiet */
30 OPT_r = (1 << 1), /* module removal instead of loading */
31};
32
33typedef struct module_info {
34 char *pathname;
Denis Vlasenko78436992008-07-10 14:14:20 +000035 char *aliases;
36 char *deps;
Denis Vlasenko671691c2008-07-04 10:25:44 +000037} module_info;
38
39/*
40 * GLOBALS
41 */
42struct globals {
43 module_info *modinfo;
44 char *module_load_options;
Denis Vlasenko7f950a92008-07-10 14:14:45 +000045 smallint dep_bb_seen;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +000046 smallint wrote_dep_bb_ok;
Denis Vlasenko671691c2008-07-04 10:25:44 +000047 int module_count;
48 int module_found_idx;
49 int stringbuf_idx;
50 char stringbuf[32 * 1024]; /* some modules have lots of stuff */
51 /* for example, drivers/media/video/saa7134/saa7134.ko */
52};
53#define G (*ptr_to_globals)
54#define modinfo (G.modinfo )
Denis Vlasenko7f950a92008-07-10 14:14:45 +000055#define dep_bb_seen (G.dep_bb_seen )
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +000056#define wrote_dep_bb_ok (G.wrote_dep_bb_ok )
Denis Vlasenko671691c2008-07-04 10:25:44 +000057#define module_count (G.module_count )
58#define module_found_idx (G.module_found_idx )
59#define module_load_options (G.module_load_options)
60#define stringbuf_idx (G.stringbuf_idx )
61#define stringbuf (G.stringbuf )
62#define INIT_G() do { \
63 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
64} while (0)
65
66
67static void appendc(char c)
68{
69 if (stringbuf_idx < sizeof(stringbuf))
70 stringbuf[stringbuf_idx++] = c;
71}
72
Denis Vlasenko24a131e2008-07-09 15:30:57 +000073static void bksp(void)
74{
75 if (stringbuf_idx)
76 stringbuf_idx--;
77}
78
Denis Vlasenko671691c2008-07-04 10:25:44 +000079static void append(const char *s)
80{
81 size_t len = strlen(s);
82 if (stringbuf_idx + len < sizeof(stringbuf)) {
83 memcpy(stringbuf + stringbuf_idx, s, len);
84 stringbuf_idx += len;
85 }
86}
87
88static void reset_stringbuf(void)
89{
90 stringbuf_idx = 0;
91}
92
93static char* copy_stringbuf(void)
94{
95 char *copy = xmalloc(stringbuf_idx);
96 return memcpy(copy, stringbuf, stringbuf_idx);
97}
98
99static char* find_keyword(char *ptr, size_t len, const char *word)
100{
101 int wlen;
102
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000103 if (!ptr) /* happens if xmalloc_open_zipped_read_close cannot read it */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000104 return NULL;
105
106 wlen = strlen(word);
107 len -= wlen - 1;
108 while ((ssize_t)len > 0) {
109 char *old = ptr;
110 /* search for the first char in word */
111 ptr = memchr(ptr, *word, len);
112 if (ptr == NULL) /* no occurance left, done */
113 break;
114 if (strncmp(ptr, word, wlen) == 0)
115 return ptr + wlen; /* found, return ptr past it */
116 ++ptr;
117 len -= (ptr - old);
118 }
119 return NULL;
120}
121
122static void replace(char *s, char what, char with)
123{
124 while (*s) {
125 if (what == *s)
126 *s = with;
127 ++s;
128 }
129}
130
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000131/* Take "word word", return malloced "word",NUL,"word",NUL,NUL */
132static char* str_2_list(const char *str)
133{
134 int len = strlen(str) + 1;
135 char *dst = xmalloc(len + 1);
136
137 dst[len] = '\0';
138 memcpy(dst, str, len);
139//TODO: protect against 2+ spaces: "word word"
140 replace(dst, ' ', '\0');
141 return dst;
142}
143
Denis Vlasenko671691c2008-07-04 10:25:44 +0000144/* We use error numbers in a loose translation... */
145static const char *moderror(int err)
146{
147 switch (err) {
148 case ENOEXEC:
149 return "invalid module format";
150 case ENOENT:
151 return "unknown symbol in module or invalid parameter";
152 case ESRCH:
153 return "module has wrong symbol version";
154 case EINVAL: /* "invalid parameter" */
155 return "unknown symbol in module or invalid parameter"
156 + sizeof("unknown symbol in module or");
157 default:
158 return strerror(err);
159 }
160}
161
162static int load_module(const char *fname, const char *options)
163{
164#if 1
165 int r;
166 size_t len = MAXINT(ssize_t);
167 char *module_image;
168 dbg1_error_msg("load_module('%s','%s')", fname, options);
169
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000170 module_image = xmalloc_open_zipped_read_close(fname, &len);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000171 r = (!module_image || init_module(module_image, len, options ? options : "") != 0);
172 free(module_image);
173 dbg1_error_msg("load_module:%d", r);
174 return r; /* 0 = success */
175#else
176 /* For testing */
177 dbg1_error_msg("load_module('%s','%s')", fname, options);
178 return 1;
179#endif
180}
181
Denis Vlasenko78436992008-07-10 14:14:20 +0000182static void parse_module(module_info *info, const char *pathname)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000183{
184 char *module_image;
185 char *ptr;
186 size_t len;
187 size_t pos;
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000188 dbg1_error_msg("parse_module('%s')", pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000189
190 /* Read (possibly compressed) module */
191 len = 64 * 1024 * 1024; /* 64 Mb at most */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000192 module_image = xmalloc_open_zipped_read_close(pathname, &len);
Denis Vlasenko78436992008-07-10 14:14:20 +0000193//TODO: optimize redundant module body reads
Denis Vlasenko671691c2008-07-04 10:25:44 +0000194
Denis Vlasenko78436992008-07-10 14:14:20 +0000195 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000196 reset_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000197 pos = 0;
198 while (1) {
199 ptr = find_keyword(module_image + pos, len - pos, "alias=");
200 if (!ptr) {
201 ptr = find_keyword(module_image + pos, len - pos, "__ksymtab_");
202 if (!ptr)
203 break;
204 /* DOCME: __ksymtab_gpl and __ksymtab_strings occur
205 * in many modules. What do they mean? */
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000206 if (strcmp(ptr, "gpl") == 0 || strcmp(ptr, "strings") == 0)
207 goto skip;
208 dbg2_error_msg("alias:'symbol:%s'", ptr);
209 append("symbol:");
Denis Vlasenko671691c2008-07-04 10:25:44 +0000210 } else {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000211 dbg2_error_msg("alias:'%s'", ptr);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000212 }
213 append(ptr);
214 appendc(' ');
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000215 skip:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000216 pos = (ptr - module_image);
217 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000218 bksp(); /* remove last ' ' */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000219 appendc('\0');
Denis Vlasenko78436992008-07-10 14:14:20 +0000220 info->aliases = copy_stringbuf();
Denys Vlasenkof9c814b2009-09-07 02:37:19 +0200221 replace(info->aliases, '-', '_');
Denis Vlasenko671691c2008-07-04 10:25:44 +0000222
Denis Vlasenko78436992008-07-10 14:14:20 +0000223 /* "dependency1 depandency2" */
224 reset_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000225 ptr = find_keyword(module_image, len, "depends=");
226 if (ptr && *ptr) {
227 replace(ptr, ',', ' ');
228 replace(ptr, '-', '_');
229 dbg2_error_msg("dep:'%s'", ptr);
230 append(ptr);
231 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000232 appendc('\0');
Denis Vlasenko78436992008-07-10 14:14:20 +0000233 info->deps = copy_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000234
235 free(module_image);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000236}
237
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000238static int pathname_matches_modname(const char *pathname, const char *modname)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000239{
240 const char *fname = bb_get_last_path_component_nostrip(pathname);
241 const char *suffix = strrstr(fname, ".ko");
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000242//TODO: can do without malloc?
Denis Vlasenko671691c2008-07-04 10:25:44 +0000243 char *name = xstrndup(fname, suffix - fname);
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000244 int r;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000245 replace(name, '-', '_');
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000246 r = (strcmp(name, modname) == 0);
247 free(name);
248 return r;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000249}
250
251static FAST_FUNC int fileAction(const char *pathname,
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000252 struct stat *sb UNUSED_PARAM,
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000253 void *modname_to_match,
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000254 int depth UNUSED_PARAM)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000255{
256 int cur;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000257 const char *fname;
258
259 pathname += 2; /* skip "./" */
260 fname = bb_get_last_path_component_nostrip(pathname);
261 if (!strrstr(fname, ".ko")) {
262 dbg1_error_msg("'%s' is not a module", pathname);
263 return TRUE; /* not a module, continue search */
264 }
265
266 cur = module_count++;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000267 modinfo = xrealloc_vector(modinfo, 12, cur);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000268 modinfo[cur].pathname = xstrdup(pathname);
Denis Vlasenko27842282008-08-04 13:20:36 +0000269 /*modinfo[cur].aliases = NULL; - xrealloc_vector did it */
270 /*modinfo[cur+1].pathname = NULL;*/
Denis Vlasenko671691c2008-07-04 10:25:44 +0000271
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000272 if (!pathname_matches_modname(fname, modname_to_match)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000273 dbg1_error_msg("'%s' module name doesn't match", pathname);
274 return TRUE; /* module name doesn't match, continue search */
275 }
276
277 dbg1_error_msg("'%s' module name matches", pathname);
278 module_found_idx = cur;
Denis Vlasenko78436992008-07-10 14:14:20 +0000279 parse_module(&modinfo[cur], pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000280
281 if (!(option_mask32 & OPT_r)) {
282 if (load_module(pathname, module_load_options) == 0) {
283 /* Load was successful, there is nothing else to do.
284 * This can happen ONLY for "top-level" module load,
285 * not a dep, because deps dont do dirscan. */
286 exit(EXIT_SUCCESS);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000287 }
288 }
289
Denis Vlasenko671691c2008-07-04 10:25:44 +0000290 return TRUE;
291}
292
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000293static int load_dep_bb(void)
Denis Vlasenko78436992008-07-10 14:14:20 +0000294{
295 char *line;
Denis Vlasenko5415c852008-07-21 23:05:26 +0000296 FILE *fp = fopen_for_read(DEPFILE_BB);
Denis Vlasenko78436992008-07-10 14:14:20 +0000297
298 if (!fp)
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000299 return 0;
300
301 dep_bb_seen = 1;
302 dbg1_error_msg("loading "DEPFILE_BB);
303
304 /* Why? There is a rare scenario: we did not find modprobe.dep.bb,
305 * we scanned the dir and found no module by name, then we search
306 * for alias (full scan), and we decided to generate modprobe.dep.bb.
307 * But we see modprobe.dep.bb.new! Other modprobe is at work!
308 * We wait and other modprobe renames it to modprobe.dep.bb.
309 * Now we can use it.
310 * But we already have modinfo[] filled, and "module_count = 0"
311 * makes us start anew. Yes, we leak modinfo[].xxx pointers -
312 * there is not much of data there anyway. */
313 module_count = 0;
314 memset(&modinfo[0], 0, sizeof(modinfo[0]));
Denis Vlasenko78436992008-07-10 14:14:20 +0000315
316 while ((line = xmalloc_fgetline(fp)) != NULL) {
317 char* space;
Denys Vlasenko90a99042009-09-06 02:36:23 +0200318 char* linebuf;
Denis Vlasenko78436992008-07-10 14:14:20 +0000319 int cur;
320
321 if (!line[0]) {
322 free(line);
323 continue;
324 }
325 space = strchrnul(line, ' ');
326 cur = module_count++;
327 modinfo = xrealloc_vector(modinfo, 12, cur);
Denis Vlasenko27842282008-08-04 13:20:36 +0000328 /*modinfo[cur+1].pathname = NULL; - xrealloc_vector did it */
Denis Vlasenko78436992008-07-10 14:14:20 +0000329 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
330 if (*space)
331 *space++ = '\0';
332 modinfo[cur].aliases = space;
Denys Vlasenko90a99042009-09-06 02:36:23 +0200333 linebuf = xmalloc_fgetline(fp);
334 modinfo[cur].deps = linebuf ? linebuf : xzalloc(1);
Denis Vlasenko78436992008-07-10 14:14:20 +0000335 if (modinfo[cur].deps[0]) {
336 /* deps are not "", so next line must be empty */
337 line = xmalloc_fgetline(fp);
338 /* Refuse to work with damaged config file */
339 if (line && line[0])
340 bb_error_msg_and_die("error in %s at '%s'", DEPFILE_BB, line);
341 free(line);
342 }
343 }
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000344 return 1;
345}
346
347static int start_dep_bb_writeout(void)
348{
349 int fd;
350
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000351 /* depmod -n: write result to stdout */
352 if (applet_name[0] == 'd' && (option_mask32 & 1))
353 return STDOUT_FILENO;
354
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000355 fd = open(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
356 if (fd < 0) {
357 if (errno == EEXIST) {
358 int count = 5 * 20;
359 dbg1_error_msg(DEPFILE_BB".new exists, waiting for "DEPFILE_BB);
360 while (1) {
361 usleep(1000*1000 / 20);
362 if (load_dep_bb()) {
363 dbg1_error_msg(DEPFILE_BB" appeared");
364 return -2; /* magic number */
365 }
366 if (!--count)
367 break;
368 }
369 bb_error_msg("deleting stale %s", DEPFILE_BB".new");
370 fd = open_or_warn(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC);
371 }
372 }
373 dbg1_error_msg("opened "DEPFILE_BB".new:%d", fd);
374 return fd;
375}
376
377static void write_out_dep_bb(int fd)
378{
379 int i;
380 FILE *fp;
381
382 /* We want good error reporting. fdprintf is not good enough. */
383 fp = fdopen(fd, "w");
384 if (!fp) {
385 close(fd);
386 goto err;
387 }
388 i = 0;
389 while (modinfo[i].pathname) {
390 fprintf(fp, "%s%s%s\n" "%s%s\n",
391 modinfo[i].pathname, modinfo[i].aliases[0] ? " " : "", modinfo[i].aliases,
392 modinfo[i].deps, modinfo[i].deps[0] ? "\n" : "");
393 i++;
394 }
395 /* Badly formatted depfile is a no-no. Be paranoid. */
396 errno = 0;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000397 if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000398 goto err;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000399
400 if (fd == STDOUT_FILENO) /* it was depmod -n */
401 goto ok;
402
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000403 if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
404 err:
405 bb_perror_msg("can't create %s", DEPFILE_BB);
406 unlink(DEPFILE_BB".new");
407 } else {
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000408 ok:
409 wrote_dep_bb_ok = 1;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000410 dbg1_error_msg("created "DEPFILE_BB);
411 }
Denis Vlasenko78436992008-07-10 14:14:20 +0000412}
413
Denis Vlasenko671691c2008-07-04 10:25:44 +0000414static module_info* find_alias(const char *alias)
415{
416 int i;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000417 int dep_bb_fd;
418 module_info *result;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000419 dbg1_error_msg("find_alias('%s')", alias);
420
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000421 try_again:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000422 /* First try to find by name (cheaper) */
423 i = 0;
424 while (modinfo[i].pathname) {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000425 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000426 dbg1_error_msg("found '%s' in module '%s'",
427 alias, modinfo[i].pathname);
Denis Vlasenko78436992008-07-10 14:14:20 +0000428 if (!modinfo[i].aliases) {
429 parse_module(&modinfo[i], modinfo[i].pathname);
430 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000431 return &modinfo[i];
432 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000433 i++;
434 }
435
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000436 /* Ok, we definitely have to scan module bodies. This is a good
437 * moment to generate modprobe.dep.bb, if it does not exist yet */
438 dep_bb_fd = dep_bb_seen ? -1 : start_dep_bb_writeout();
439 if (dep_bb_fd == -2) /* modprobe.dep.bb appeared? */
440 goto try_again;
441
Denis Vlasenko671691c2008-07-04 10:25:44 +0000442 /* Scan all module bodies, extract modinfo (it contains aliases) */
443 i = 0;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000444 result = NULL;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000445 while (modinfo[i].pathname) {
446 char *desc, *s;
Denis Vlasenko78436992008-07-10 14:14:20 +0000447 if (!modinfo[i].aliases) {
448 parse_module(&modinfo[i], modinfo[i].pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000449 }
Denis Vlasenko8e804112008-08-06 09:41:09 +0000450 if (result) {
451 i++;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000452 continue;
Denis Vlasenko8e804112008-08-06 09:41:09 +0000453 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000454 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
Denis Vlasenko78436992008-07-10 14:14:20 +0000455 desc = str_2_list(modinfo[i].aliases);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000456 /* Does matching substring exist? */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000457 for (s = desc; *s; s += strlen(s) + 1) {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000458 /* Aliases in module bodies can be defined with
Denis Vlasenko58f59a22008-07-06 11:52:23 +0000459 * shell patterns. Example:
460 * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
461 * Plain strcmp() won't catch that */
462 if (fnmatch(s, alias, 0) == 0) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000463 dbg1_error_msg("found alias '%s' in module '%s'",
464 alias, modinfo[i].pathname);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000465 result = &modinfo[i];
466 break;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000467 }
468 }
469 free(desc);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000470 if (result && dep_bb_fd < 0)
471 return result;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000472 i++;
473 }
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000474
475 /* Create module.dep.bb if needed */
476 if (dep_bb_fd >= 0) {
477 write_out_dep_bb(dep_bb_fd);
478 }
479
480 dbg1_error_msg("find_alias '%s' returns %p", alias, result);
481 return result;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000482}
483
484#if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000485// TODO: open only once, invent config_rewind()
Denis Vlasenko671691c2008-07-04 10:25:44 +0000486static int already_loaded(const char *name)
487{
488 int ret = 0;
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000489 char *s;
490 parser_t *parser = config_open2("/proc/modules", xfopen_for_read);
Denis Vlasenko084266e2008-07-26 23:08:31 +0000491 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY)) {
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000492 if (strcmp(s, name) == 0) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000493 ret = 1;
494 break;
495 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000496 }
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000497 config_close(parser);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000498 return ret;
499}
500#else
501#define already_loaded(name) is_rmmod
502#endif
503
504/*
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000505 * Given modules definition and module name (or alias, or symbol)
506 * load/remove the module respecting dependencies.
507 * NB: also called by depmod with bogus name "/",
508 * just in order to force modprobe.dep.bb creation.
Denis Vlasenko671691c2008-07-04 10:25:44 +0000509*/
510#if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
511#define process_module(a,b) process_module(a)
512#define cmdline_options ""
513#endif
514static void process_module(char *name, const char *cmdline_options)
515{
516 char *s, *deps, *options;
517 module_info *info;
518 int is_rmmod = (option_mask32 & OPT_r) != 0;
519 dbg1_error_msg("process_module('%s','%s')", name, cmdline_options);
520
521 replace(name, '-', '_');
522
523 dbg1_error_msg("already_loaded:%d is_rmmod:%d", already_loaded(name), is_rmmod);
524 if (already_loaded(name) != is_rmmod) {
525 dbg1_error_msg("nothing to do for '%s'", name);
526 return;
527 }
528
529 options = NULL;
530 if (!is_rmmod) {
531 char *opt_filename = xasprintf("/etc/modules/%s", name);
532 options = xmalloc_open_read_close(opt_filename, NULL);
533 if (options)
534 replace(options, '\n', ' ');
535#if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
536 if (cmdline_options) {
537 /* NB: cmdline_options always have one leading ' '
538 * (see main()), we remove it here */
539 char *op = xasprintf(options ? "%s %s" : "%s %s" + 3,
540 cmdline_options + 1, options);
541 free(options);
542 options = op;
543 }
544#endif
545 free(opt_filename);
546 module_load_options = options;
547 dbg1_error_msg("process_module('%s'): options:'%s'", name, options);
548 }
549
550 if (!module_count) {
551 /* Scan module directory. This is done only once.
552 * It will attempt module load, and will exit(EXIT_SUCCESS)
553 * on success. */
554 module_found_idx = -1;
555 recursive_action(".",
556 ACTION_RECURSE, /* flags */
557 fileAction, /* file action */
558 NULL, /* dir action */
559 name, /* user data */
560 0); /* depth */
561 dbg1_error_msg("dirscan complete");
562 /* Module was not found, or load failed, or is_rmmod */
563 if (module_found_idx >= 0) { /* module was found */
564 info = &modinfo[module_found_idx];
565 } else { /* search for alias, not a plain module name */
566 info = find_alias(name);
567 }
568 } else {
569 info = find_alias(name);
570 }
571
572 /* rmmod? unload it by name */
573 if (is_rmmod) {
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000574 if (delete_module(name, O_NONBLOCK | O_EXCL) != 0
Denis Vlasenko671691c2008-07-04 10:25:44 +0000575 && !(option_mask32 & OPT_q)
576 ) {
577 bb_perror_msg("remove '%s'", name);
578 goto ret;
579 }
580 /* N.B. we do not stop here -
581 * continue to unload modules on which the module depends:
582 * "-r --remove: option causes modprobe to remove a module.
583 * If the modules it depends on are also unused, modprobe
584 * will try to remove them, too." */
585 }
586
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000587 if (!info) {
588 /* both dirscan and find_alias found nothing */
589 if (applet_name[0] != 'd') /* it wasn't depmod */
590 bb_error_msg("module '%s' not found", name);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000591//TODO: _and_die()?
Denis Vlasenko671691c2008-07-04 10:25:44 +0000592 goto ret;
593 }
594
Denis Vlasenko671691c2008-07-04 10:25:44 +0000595 /* Iterate thru dependencies, trying to (un)load them */
Denis Vlasenko78436992008-07-10 14:14:20 +0000596 deps = str_2_list(info->deps);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000597 for (s = deps; *s; s += strlen(s) + 1) {
598 //if (strcmp(name, s) != 0) // N.B. do loops exist?
599 dbg1_error_msg("recurse on dep '%s'", s);
600 process_module(s, NULL);
601 dbg1_error_msg("recurse on dep '%s' done", s);
602 }
603 free(deps);
604
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000605 /* modprobe -> load it */
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000606 if (!is_rmmod) {
607 if (!options || strstr(options, "blacklist") == NULL) {
608 errno = 0;
609 if (load_module(info->pathname, options) != 0) {
610 if (EEXIST != errno) {
611 bb_error_msg("'%s': %s",
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000612 info->pathname,
Denis Vlasenko671691c2008-07-04 10:25:44 +0000613 moderror(errno));
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000614 } else {
615 dbg1_error_msg("'%s': %s",
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000616 info->pathname,
Denis Vlasenko671691c2008-07-04 10:25:44 +0000617 moderror(errno));
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000618 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000619 }
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000620 } else {
621 dbg1_error_msg("'%s': blacklisted", info->pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000622 }
623 }
624 ret:
625 free(options);
626//TODO: return load attempt result from process_module.
627//If dep didn't load ok, continuing makes little sense.
628}
629#undef cmdline_options
630
631
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000632/* For reference, module-init-tools v3.4 options:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000633
634# insmod
635Usage: insmod filename [args]
636
637# rmmod --help
638Usage: rmmod [-fhswvV] modulename ...
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000639 -f (or --force) forces a module unload, and may crash your
640 machine. This requires the Forced Module Removal option
641 when the kernel was compiled.
642 -h (or --help) prints this help text
Denis Vlasenko671691c2008-07-04 10:25:44 +0000643 -s (or --syslog) says use syslog, not stderr
644 -v (or --verbose) enables more messages
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000645 -V (or --version) prints the version code
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000646 -w (or --wait) begins module removal even if it is used
Denis Vlasenko671691c2008-07-04 10:25:44 +0000647 and will stop new users from accessing the module (so it
648 should eventually fall to zero).
649
650# modprobe
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000651Usage: modprobe [-v] [-V] [-C config-file] [-n] [-i] [-q] [-b]
652 [-o <modname>] [ --dump-modversions ] <modname> [parameters...]
653modprobe -r [-n] [-i] [-v] <modulename> ...
654modprobe -l -t <dirname> [ -a <modulename> ...]
Denis Vlasenko671691c2008-07-04 10:25:44 +0000655
656# depmod --help
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000657depmod 3.4 -- part of module-init-tools
658depmod -[aA] [-n -e -v -q -V -r -u]
659 [-b basedirectory] [forced_version]
660depmod [-n -e -v -q -r -u] [-F kernelsyms] module1.ko module2.ko ...
661If no arguments (except options) are given, "depmod -a" is assumed.
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +0200662depmod will output a dependency list suitable for the modprobe utility.
Denis Vlasenko671691c2008-07-04 10:25:44 +0000663Options:
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000664 -a, --all Probe all modules
665 -A, --quick Only does the work if there's a new module
666 -n, --show Write the dependency file on stdout only
667 -e, --errsyms Report not supplied symbols
668 -V, --version Print the release version
669 -v, --verbose Enable verbose mode
670 -h, --help Print this usage message
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000671The following options are useful for people managing distributions:
672 -b basedirectory
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000673 --basedir basedirectory
674 Use an image of a module tree
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000675 -F kernelsyms
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000676 --filesyms kernelsyms
677 Use the file instead of the current kernel symbols
Denis Vlasenko671691c2008-07-04 10:25:44 +0000678*/
679
680int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000681int modprobe_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000682{
683 struct utsname uts;
684 char applet0 = applet_name[0];
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000685 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000686
Denis Vlasenko671691c2008-07-04 10:25:44 +0000687 /* are we lsmod? -> just dump /proc/modules */
688 if ('l' == applet0) {
Denis Vlasenko5415c852008-07-21 23:05:26 +0000689 xprint_and_close_file(xfopen_for_read("/proc/modules"));
Denis Vlasenko671691c2008-07-04 10:25:44 +0000690 return EXIT_SUCCESS;
691 }
692
693 INIT_G();
694
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000695 /* Prevent ugly corner cases with no modules at all */
696 modinfo = xzalloc(sizeof(modinfo[0]));
697
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000698 if ('i' != applet0) { /* not insmod */
699 /* Goto modules directory */
700 xchdir(CONFIG_DEFAULT_MODULES_DIR);
701 }
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000702 uname(&uts); /* never fails */
703
704 /* depmod? */
705 if ('d' == applet0) {
706 /* Supported:
707 * -n: print result to stdout
708 * -a: process all modules (default)
709 * optional VERSION parameter
710 * Ignored:
711 * -A: do work only if a module is newer than depfile
712 * -e: report any symbols which a module needs
713 * which are not supplied by other modules or the kernel
714 * -F FILE: System.map (symbols for -e)
715 * -q, -r, -u: noop?
716 * Not supported:
717 * -b BASEDIR: (TODO!) modules are in
718 * $BASEDIR/lib/modules/$VERSION
719 * -v: human readable deps to stdout
720 * -V: version (don't want to support it - people may depend
721 * on it as an indicator of "standard" depmod)
722 * -h: help (well duh)
723 * module1.o module2.o parameters (just ignored for now)
724 */
725 getopt32(argv, "na" "AeF:qru" /* "b:vV", NULL */, NULL);
726 argv += optind;
727 /* if (argv[0] && argv[1]) bb_show_usage(); */
728 /* Goto $VERSION directory */
729 xchdir(argv[0] ? argv[0] : uts.release);
730 /* Force full module scan by asking to find a bogus module.
731 * This will generate modules.dep.bb as a side effect. */
732 process_module((char*)"/", NULL);
733 return !wrote_dep_bb_ok;
734 }
735
Denis Vlasenko671691c2008-07-04 10:25:44 +0000736 /* insmod, modprobe, rmmod require at least one argument */
737 opt_complementary = "-1";
738 /* only -q (quiet) and -r (rmmod),
739 * the rest are accepted and ignored (compat) */
740 getopt32(argv, "qrfsvw");
741 argv += optind;
742
743 /* are we rmmod? -> simulate modprobe -r */
744 if ('r' == applet0) {
745 option_mask32 |= OPT_r;
746 }
747
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000748 if ('i' != applet0) { /* not insmod */
749 /* Goto $VERSION directory */
750 xchdir(uts.release);
751 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000752
753#if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
754 /* If not rmmod, parse possible module options given on command line.
755 * insmod/modprobe takes one module name, the rest are parameters. */
756 options = NULL;
757 if ('r' != applet0) {
758 char **arg = argv;
759 while (*++arg) {
760 /* Enclose options in quotes */
761 char *s = options;
762 options = xasprintf("%s \"%s\"", s ? s : "", *arg);
763 free(s);
764 *arg = NULL;
765 }
766 }
767#else
768 if ('r' != applet0)
769 argv[1] = NULL;
770#endif
771
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000772 if ('i' == applet0) { /* insmod */
773 size_t len;
774 void *map;
775
776 len = MAXINT(ssize_t);
777 map = xmalloc_xopen_read_close(*argv, &len);
778 if (init_module(map, len,
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000779 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(options ? options : "")
780 IF_NOT_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE("")
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000781 ) != 0)
Denis Vlasenko1f632292009-04-13 02:25:40 +0000782 bb_error_msg_and_die("can't insert '%s': %s",
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000783 *argv, moderror(errno));
784 return 0;
785 }
786
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000787 /* Try to load modprobe.dep.bb */
Denis Vlasenko78436992008-07-10 14:14:20 +0000788 load_dep_bb();
789
Denis Vlasenko671691c2008-07-04 10:25:44 +0000790 /* Load/remove modules.
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000791 * Only rmmod loops here, modprobe has only argv[0] */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000792 do {
793 process_module(*argv++, options);
794 } while (*argv);
795
796 if (ENABLE_FEATURE_CLEAN_UP) {
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000797 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000798 }
799 return EXIT_SUCCESS;
800}