blob: 02d8fbd40e49bb7ce8d7afbffe71c7301c1b2629 [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();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000221
Denis Vlasenko78436992008-07-10 14:14:20 +0000222 /* "dependency1 depandency2" */
223 reset_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000224 ptr = find_keyword(module_image, len, "depends=");
225 if (ptr && *ptr) {
226 replace(ptr, ',', ' ');
227 replace(ptr, '-', '_');
228 dbg2_error_msg("dep:'%s'", ptr);
229 append(ptr);
230 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000231 appendc('\0');
Denis Vlasenko78436992008-07-10 14:14:20 +0000232 info->deps = copy_stringbuf();
Denis Vlasenko671691c2008-07-04 10:25:44 +0000233
234 free(module_image);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000235}
236
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000237static int pathname_matches_modname(const char *pathname, const char *modname)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000238{
239 const char *fname = bb_get_last_path_component_nostrip(pathname);
240 const char *suffix = strrstr(fname, ".ko");
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000241//TODO: can do without malloc?
Denis Vlasenko671691c2008-07-04 10:25:44 +0000242 char *name = xstrndup(fname, suffix - fname);
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000243 int r;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000244 replace(name, '-', '_');
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000245 r = (strcmp(name, modname) == 0);
246 free(name);
247 return r;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000248}
249
250static FAST_FUNC int fileAction(const char *pathname,
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000251 struct stat *sb UNUSED_PARAM,
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000252 void *modname_to_match,
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000253 int depth UNUSED_PARAM)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000254{
255 int cur;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000256 const char *fname;
257
258 pathname += 2; /* skip "./" */
259 fname = bb_get_last_path_component_nostrip(pathname);
260 if (!strrstr(fname, ".ko")) {
261 dbg1_error_msg("'%s' is not a module", pathname);
262 return TRUE; /* not a module, continue search */
263 }
264
265 cur = module_count++;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000266 modinfo = xrealloc_vector(modinfo, 12, cur);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000267 modinfo[cur].pathname = xstrdup(pathname);
Denis Vlasenko27842282008-08-04 13:20:36 +0000268 /*modinfo[cur].aliases = NULL; - xrealloc_vector did it */
269 /*modinfo[cur+1].pathname = NULL;*/
Denis Vlasenko671691c2008-07-04 10:25:44 +0000270
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000271 if (!pathname_matches_modname(fname, modname_to_match)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000272 dbg1_error_msg("'%s' module name doesn't match", pathname);
273 return TRUE; /* module name doesn't match, continue search */
274 }
275
276 dbg1_error_msg("'%s' module name matches", pathname);
277 module_found_idx = cur;
Denis Vlasenko78436992008-07-10 14:14:20 +0000278 parse_module(&modinfo[cur], pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000279
280 if (!(option_mask32 & OPT_r)) {
281 if (load_module(pathname, module_load_options) == 0) {
282 /* Load was successful, there is nothing else to do.
283 * This can happen ONLY for "top-level" module load,
284 * not a dep, because deps dont do dirscan. */
285 exit(EXIT_SUCCESS);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000286 }
287 }
288
Denis Vlasenko671691c2008-07-04 10:25:44 +0000289 return TRUE;
290}
291
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000292static int load_dep_bb(void)
Denis Vlasenko78436992008-07-10 14:14:20 +0000293{
294 char *line;
Denis Vlasenko5415c852008-07-21 23:05:26 +0000295 FILE *fp = fopen_for_read(DEPFILE_BB);
Denis Vlasenko78436992008-07-10 14:14:20 +0000296
297 if (!fp)
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000298 return 0;
299
300 dep_bb_seen = 1;
301 dbg1_error_msg("loading "DEPFILE_BB);
302
303 /* Why? There is a rare scenario: we did not find modprobe.dep.bb,
304 * we scanned the dir and found no module by name, then we search
305 * for alias (full scan), and we decided to generate modprobe.dep.bb.
306 * But we see modprobe.dep.bb.new! Other modprobe is at work!
307 * We wait and other modprobe renames it to modprobe.dep.bb.
308 * Now we can use it.
309 * But we already have modinfo[] filled, and "module_count = 0"
310 * makes us start anew. Yes, we leak modinfo[].xxx pointers -
311 * there is not much of data there anyway. */
312 module_count = 0;
313 memset(&modinfo[0], 0, sizeof(modinfo[0]));
Denis Vlasenko78436992008-07-10 14:14:20 +0000314
315 while ((line = xmalloc_fgetline(fp)) != NULL) {
316 char* space;
Denys Vlasenko90a99042009-09-06 02:36:23 +0200317 char* linebuf;
Denis Vlasenko78436992008-07-10 14:14:20 +0000318 int cur;
319
320 if (!line[0]) {
321 free(line);
322 continue;
323 }
324 space = strchrnul(line, ' ');
325 cur = module_count++;
326 modinfo = xrealloc_vector(modinfo, 12, cur);
Denis Vlasenko27842282008-08-04 13:20:36 +0000327 /*modinfo[cur+1].pathname = NULL; - xrealloc_vector did it */
Denis Vlasenko78436992008-07-10 14:14:20 +0000328 modinfo[cur].pathname = line; /* we take ownership of malloced block here */
329 if (*space)
330 *space++ = '\0';
331 modinfo[cur].aliases = space;
Denys Vlasenko90a99042009-09-06 02:36:23 +0200332 linebuf = xmalloc_fgetline(fp);
333 modinfo[cur].deps = linebuf ? linebuf : xzalloc(1);
Denis Vlasenko78436992008-07-10 14:14:20 +0000334 if (modinfo[cur].deps[0]) {
335 /* deps are not "", so next line must be empty */
336 line = xmalloc_fgetline(fp);
337 /* Refuse to work with damaged config file */
338 if (line && line[0])
339 bb_error_msg_and_die("error in %s at '%s'", DEPFILE_BB, line);
340 free(line);
341 }
342 }
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000343 return 1;
344}
345
346static int start_dep_bb_writeout(void)
347{
348 int fd;
349
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000350 /* depmod -n: write result to stdout */
351 if (applet_name[0] == 'd' && (option_mask32 & 1))
352 return STDOUT_FILENO;
353
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000354 fd = open(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
355 if (fd < 0) {
356 if (errno == EEXIST) {
357 int count = 5 * 20;
358 dbg1_error_msg(DEPFILE_BB".new exists, waiting for "DEPFILE_BB);
359 while (1) {
360 usleep(1000*1000 / 20);
361 if (load_dep_bb()) {
362 dbg1_error_msg(DEPFILE_BB" appeared");
363 return -2; /* magic number */
364 }
365 if (!--count)
366 break;
367 }
368 bb_error_msg("deleting stale %s", DEPFILE_BB".new");
369 fd = open_or_warn(DEPFILE_BB".new", O_WRONLY | O_CREAT | O_TRUNC);
370 }
371 }
372 dbg1_error_msg("opened "DEPFILE_BB".new:%d", fd);
373 return fd;
374}
375
376static void write_out_dep_bb(int fd)
377{
378 int i;
379 FILE *fp;
380
381 /* We want good error reporting. fdprintf is not good enough. */
382 fp = fdopen(fd, "w");
383 if (!fp) {
384 close(fd);
385 goto err;
386 }
387 i = 0;
388 while (modinfo[i].pathname) {
389 fprintf(fp, "%s%s%s\n" "%s%s\n",
390 modinfo[i].pathname, modinfo[i].aliases[0] ? " " : "", modinfo[i].aliases,
391 modinfo[i].deps, modinfo[i].deps[0] ? "\n" : "");
392 i++;
393 }
394 /* Badly formatted depfile is a no-no. Be paranoid. */
395 errno = 0;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000396 if (ferror(fp) | fclose(fp)) /* | instead of || is intended */
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000397 goto err;
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000398
399 if (fd == STDOUT_FILENO) /* it was depmod -n */
400 goto ok;
401
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000402 if (rename(DEPFILE_BB".new", DEPFILE_BB) != 0) {
403 err:
404 bb_perror_msg("can't create %s", DEPFILE_BB);
405 unlink(DEPFILE_BB".new");
406 } else {
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000407 ok:
408 wrote_dep_bb_ok = 1;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000409 dbg1_error_msg("created "DEPFILE_BB);
410 }
Denis Vlasenko78436992008-07-10 14:14:20 +0000411}
412
Denis Vlasenko671691c2008-07-04 10:25:44 +0000413static module_info* find_alias(const char *alias)
414{
415 int i;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000416 int dep_bb_fd;
417 module_info *result;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000418 dbg1_error_msg("find_alias('%s')", alias);
419
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000420 try_again:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000421 /* First try to find by name (cheaper) */
422 i = 0;
423 while (modinfo[i].pathname) {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000424 if (pathname_matches_modname(modinfo[i].pathname, alias)) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000425 dbg1_error_msg("found '%s' in module '%s'",
426 alias, modinfo[i].pathname);
Denis Vlasenko78436992008-07-10 14:14:20 +0000427 if (!modinfo[i].aliases) {
428 parse_module(&modinfo[i], modinfo[i].pathname);
429 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000430 return &modinfo[i];
431 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000432 i++;
433 }
434
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000435 /* Ok, we definitely have to scan module bodies. This is a good
436 * moment to generate modprobe.dep.bb, if it does not exist yet */
437 dep_bb_fd = dep_bb_seen ? -1 : start_dep_bb_writeout();
438 if (dep_bb_fd == -2) /* modprobe.dep.bb appeared? */
439 goto try_again;
440
Denis Vlasenko671691c2008-07-04 10:25:44 +0000441 /* Scan all module bodies, extract modinfo (it contains aliases) */
442 i = 0;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000443 result = NULL;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000444 while (modinfo[i].pathname) {
445 char *desc, *s;
Denis Vlasenko78436992008-07-10 14:14:20 +0000446 if (!modinfo[i].aliases) {
447 parse_module(&modinfo[i], modinfo[i].pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000448 }
Denis Vlasenko8e804112008-08-06 09:41:09 +0000449 if (result) {
450 i++;
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000451 continue;
Denis Vlasenko8e804112008-08-06 09:41:09 +0000452 }
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000453 /* "alias1 symbol:sym1 alias2 symbol:sym2" */
Denis Vlasenko78436992008-07-10 14:14:20 +0000454 desc = str_2_list(modinfo[i].aliases);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000455 /* Does matching substring exist? */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000456 for (s = desc; *s; s += strlen(s) + 1) {
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000457 /* Aliases in module bodies can be defined with
Denis Vlasenko58f59a22008-07-06 11:52:23 +0000458 * shell patterns. Example:
459 * "pci:v000010DEd000000D9sv*sd*bc*sc*i*".
460 * Plain strcmp() won't catch that */
461 if (fnmatch(s, alias, 0) == 0) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000462 dbg1_error_msg("found alias '%s' in module '%s'",
463 alias, modinfo[i].pathname);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000464 result = &modinfo[i];
465 break;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000466 }
467 }
468 free(desc);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000469 if (result && dep_bb_fd < 0)
470 return result;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000471 i++;
472 }
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000473
474 /* Create module.dep.bb if needed */
475 if (dep_bb_fd >= 0) {
476 write_out_dep_bb(dep_bb_fd);
477 }
478
479 dbg1_error_msg("find_alias '%s' returns %p", alias, result);
480 return result;
Denis Vlasenko671691c2008-07-04 10:25:44 +0000481}
482
483#if ENABLE_FEATURE_MODPROBE_SMALL_CHECK_ALREADY_LOADED
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000484// TODO: open only once, invent config_rewind()
Denis Vlasenko671691c2008-07-04 10:25:44 +0000485static int already_loaded(const char *name)
486{
487 int ret = 0;
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000488 char *s;
489 parser_t *parser = config_open2("/proc/modules", xfopen_for_read);
Denis Vlasenko084266e2008-07-26 23:08:31 +0000490 while (config_read(parser, &s, 1, 1, "# \t", PARSE_NORMAL & ~PARSE_GREEDY)) {
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000491 if (strcmp(s, name) == 0) {
Denis Vlasenko671691c2008-07-04 10:25:44 +0000492 ret = 1;
493 break;
494 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000495 }
Denis Vlasenko0f99d492008-07-24 23:38:04 +0000496 config_close(parser);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000497 return ret;
498}
499#else
500#define already_loaded(name) is_rmmod
501#endif
502
503/*
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000504 * Given modules definition and module name (or alias, or symbol)
505 * load/remove the module respecting dependencies.
506 * NB: also called by depmod with bogus name "/",
507 * just in order to force modprobe.dep.bb creation.
Denis Vlasenko671691c2008-07-04 10:25:44 +0000508*/
509#if !ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
510#define process_module(a,b) process_module(a)
511#define cmdline_options ""
512#endif
513static void process_module(char *name, const char *cmdline_options)
514{
515 char *s, *deps, *options;
516 module_info *info;
517 int is_rmmod = (option_mask32 & OPT_r) != 0;
518 dbg1_error_msg("process_module('%s','%s')", name, cmdline_options);
519
520 replace(name, '-', '_');
521
522 dbg1_error_msg("already_loaded:%d is_rmmod:%d", already_loaded(name), is_rmmod);
523 if (already_loaded(name) != is_rmmod) {
524 dbg1_error_msg("nothing to do for '%s'", name);
525 return;
526 }
527
528 options = NULL;
529 if (!is_rmmod) {
530 char *opt_filename = xasprintf("/etc/modules/%s", name);
531 options = xmalloc_open_read_close(opt_filename, NULL);
532 if (options)
533 replace(options, '\n', ' ');
534#if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
535 if (cmdline_options) {
536 /* NB: cmdline_options always have one leading ' '
537 * (see main()), we remove it here */
538 char *op = xasprintf(options ? "%s %s" : "%s %s" + 3,
539 cmdline_options + 1, options);
540 free(options);
541 options = op;
542 }
543#endif
544 free(opt_filename);
545 module_load_options = options;
546 dbg1_error_msg("process_module('%s'): options:'%s'", name, options);
547 }
548
549 if (!module_count) {
550 /* Scan module directory. This is done only once.
551 * It will attempt module load, and will exit(EXIT_SUCCESS)
552 * on success. */
553 module_found_idx = -1;
554 recursive_action(".",
555 ACTION_RECURSE, /* flags */
556 fileAction, /* file action */
557 NULL, /* dir action */
558 name, /* user data */
559 0); /* depth */
560 dbg1_error_msg("dirscan complete");
561 /* Module was not found, or load failed, or is_rmmod */
562 if (module_found_idx >= 0) { /* module was found */
563 info = &modinfo[module_found_idx];
564 } else { /* search for alias, not a plain module name */
565 info = find_alias(name);
566 }
567 } else {
568 info = find_alias(name);
569 }
570
571 /* rmmod? unload it by name */
572 if (is_rmmod) {
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000573 if (delete_module(name, O_NONBLOCK | O_EXCL) != 0
Denis Vlasenko671691c2008-07-04 10:25:44 +0000574 && !(option_mask32 & OPT_q)
575 ) {
576 bb_perror_msg("remove '%s'", name);
577 goto ret;
578 }
579 /* N.B. we do not stop here -
580 * continue to unload modules on which the module depends:
581 * "-r --remove: option causes modprobe to remove a module.
582 * If the modules it depends on are also unused, modprobe
583 * will try to remove them, too." */
584 }
585
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000586 if (!info) {
587 /* both dirscan and find_alias found nothing */
588 if (applet_name[0] != 'd') /* it wasn't depmod */
589 bb_error_msg("module '%s' not found", name);
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000590//TODO: _and_die()?
Denis Vlasenko671691c2008-07-04 10:25:44 +0000591 goto ret;
592 }
593
Denis Vlasenko671691c2008-07-04 10:25:44 +0000594 /* Iterate thru dependencies, trying to (un)load them */
Denis Vlasenko78436992008-07-10 14:14:20 +0000595 deps = str_2_list(info->deps);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000596 for (s = deps; *s; s += strlen(s) + 1) {
597 //if (strcmp(name, s) != 0) // N.B. do loops exist?
598 dbg1_error_msg("recurse on dep '%s'", s);
599 process_module(s, NULL);
600 dbg1_error_msg("recurse on dep '%s' done", s);
601 }
602 free(deps);
603
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000604 /* modprobe -> load it */
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000605 if (!is_rmmod) {
606 if (!options || strstr(options, "blacklist") == NULL) {
607 errno = 0;
608 if (load_module(info->pathname, options) != 0) {
609 if (EEXIST != errno) {
610 bb_error_msg("'%s': %s",
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000611 info->pathname,
Denis Vlasenko671691c2008-07-04 10:25:44 +0000612 moderror(errno));
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000613 } else {
614 dbg1_error_msg("'%s': %s",
Denis Vlasenko24a131e2008-07-09 15:30:57 +0000615 info->pathname,
Denis Vlasenko671691c2008-07-04 10:25:44 +0000616 moderror(errno));
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000617 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000618 }
Denis Vlasenko1ad4db12008-11-12 00:09:58 +0000619 } else {
620 dbg1_error_msg("'%s': blacklisted", info->pathname);
Denis Vlasenko671691c2008-07-04 10:25:44 +0000621 }
622 }
623 ret:
624 free(options);
625//TODO: return load attempt result from process_module.
626//If dep didn't load ok, continuing makes little sense.
627}
628#undef cmdline_options
629
630
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000631/* For reference, module-init-tools v3.4 options:
Denis Vlasenko671691c2008-07-04 10:25:44 +0000632
633# insmod
634Usage: insmod filename [args]
635
636# rmmod --help
637Usage: rmmod [-fhswvV] modulename ...
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000638 -f (or --force) forces a module unload, and may crash your
639 machine. This requires the Forced Module Removal option
640 when the kernel was compiled.
641 -h (or --help) prints this help text
Denis Vlasenko671691c2008-07-04 10:25:44 +0000642 -s (or --syslog) says use syslog, not stderr
643 -v (or --verbose) enables more messages
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000644 -V (or --version) prints the version code
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000645 -w (or --wait) begins module removal even if it is used
Denis Vlasenko671691c2008-07-04 10:25:44 +0000646 and will stop new users from accessing the module (so it
647 should eventually fall to zero).
648
649# modprobe
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000650Usage: modprobe [-v] [-V] [-C config-file] [-n] [-i] [-q] [-b]
651 [-o <modname>] [ --dump-modversions ] <modname> [parameters...]
652modprobe -r [-n] [-i] [-v] <modulename> ...
653modprobe -l -t <dirname> [ -a <modulename> ...]
Denis Vlasenko671691c2008-07-04 10:25:44 +0000654
655# depmod --help
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000656depmod 3.4 -- part of module-init-tools
657depmod -[aA] [-n -e -v -q -V -r -u]
658 [-b basedirectory] [forced_version]
659depmod [-n -e -v -q -r -u] [-F kernelsyms] module1.ko module2.ko ...
660If no arguments (except options) are given, "depmod -a" is assumed.
Denys Vlasenkobf2af9a2009-05-25 04:15:37 +0200661depmod will output a dependency list suitable for the modprobe utility.
Denis Vlasenko671691c2008-07-04 10:25:44 +0000662Options:
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000663 -a, --all Probe all modules
664 -A, --quick Only does the work if there's a new module
665 -n, --show Write the dependency file on stdout only
666 -e, --errsyms Report not supplied symbols
667 -V, --version Print the release version
668 -v, --verbose Enable verbose mode
669 -h, --help Print this usage message
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000670The following options are useful for people managing distributions:
671 -b basedirectory
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000672 --basedir basedirectory
673 Use an image of a module tree
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000674 -F kernelsyms
Denis Vlasenko35d8c472008-08-05 07:59:25 +0000675 --filesyms kernelsyms
676 Use the file instead of the current kernel symbols
Denis Vlasenko671691c2008-07-04 10:25:44 +0000677*/
678
679int modprobe_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000680int modprobe_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000681{
682 struct utsname uts;
683 char applet0 = applet_name[0];
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000684 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(char *options;)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000685
Denis Vlasenko671691c2008-07-04 10:25:44 +0000686 /* are we lsmod? -> just dump /proc/modules */
687 if ('l' == applet0) {
Denis Vlasenko5415c852008-07-21 23:05:26 +0000688 xprint_and_close_file(xfopen_for_read("/proc/modules"));
Denis Vlasenko671691c2008-07-04 10:25:44 +0000689 return EXIT_SUCCESS;
690 }
691
692 INIT_G();
693
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000694 /* Prevent ugly corner cases with no modules at all */
695 modinfo = xzalloc(sizeof(modinfo[0]));
696
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000697 if ('i' != applet0) { /* not insmod */
698 /* Goto modules directory */
699 xchdir(CONFIG_DEFAULT_MODULES_DIR);
700 }
Denis Vlasenko0e2c93f2008-07-10 14:16:11 +0000701 uname(&uts); /* never fails */
702
703 /* depmod? */
704 if ('d' == applet0) {
705 /* Supported:
706 * -n: print result to stdout
707 * -a: process all modules (default)
708 * optional VERSION parameter
709 * Ignored:
710 * -A: do work only if a module is newer than depfile
711 * -e: report any symbols which a module needs
712 * which are not supplied by other modules or the kernel
713 * -F FILE: System.map (symbols for -e)
714 * -q, -r, -u: noop?
715 * Not supported:
716 * -b BASEDIR: (TODO!) modules are in
717 * $BASEDIR/lib/modules/$VERSION
718 * -v: human readable deps to stdout
719 * -V: version (don't want to support it - people may depend
720 * on it as an indicator of "standard" depmod)
721 * -h: help (well duh)
722 * module1.o module2.o parameters (just ignored for now)
723 */
724 getopt32(argv, "na" "AeF:qru" /* "b:vV", NULL */, NULL);
725 argv += optind;
726 /* if (argv[0] && argv[1]) bb_show_usage(); */
727 /* Goto $VERSION directory */
728 xchdir(argv[0] ? argv[0] : uts.release);
729 /* Force full module scan by asking to find a bogus module.
730 * This will generate modules.dep.bb as a side effect. */
731 process_module((char*)"/", NULL);
732 return !wrote_dep_bb_ok;
733 }
734
Denis Vlasenko671691c2008-07-04 10:25:44 +0000735 /* insmod, modprobe, rmmod require at least one argument */
736 opt_complementary = "-1";
737 /* only -q (quiet) and -r (rmmod),
738 * the rest are accepted and ignored (compat) */
739 getopt32(argv, "qrfsvw");
740 argv += optind;
741
742 /* are we rmmod? -> simulate modprobe -r */
743 if ('r' == applet0) {
744 option_mask32 |= OPT_r;
745 }
746
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000747 if ('i' != applet0) { /* not insmod */
748 /* Goto $VERSION directory */
749 xchdir(uts.release);
750 }
Denis Vlasenko671691c2008-07-04 10:25:44 +0000751
752#if ENABLE_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE
753 /* If not rmmod, parse possible module options given on command line.
754 * insmod/modprobe takes one module name, the rest are parameters. */
755 options = NULL;
756 if ('r' != applet0) {
757 char **arg = argv;
758 while (*++arg) {
759 /* Enclose options in quotes */
760 char *s = options;
761 options = xasprintf("%s \"%s\"", s ? s : "", *arg);
762 free(s);
763 *arg = NULL;
764 }
765 }
766#else
767 if ('r' != applet0)
768 argv[1] = NULL;
769#endif
770
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000771 if ('i' == applet0) { /* insmod */
772 size_t len;
773 void *map;
774
775 len = MAXINT(ssize_t);
776 map = xmalloc_xopen_read_close(*argv, &len);
777 if (init_module(map, len,
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000778 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(options ? options : "")
779 IF_NOT_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE("")
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000780 ) != 0)
Denis Vlasenko1f632292009-04-13 02:25:40 +0000781 bb_error_msg_and_die("can't insert '%s': %s",
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000782 *argv, moderror(errno));
783 return 0;
784 }
785
Denis Vlasenko7f950a92008-07-10 14:14:45 +0000786 /* Try to load modprobe.dep.bb */
Denis Vlasenko78436992008-07-10 14:14:20 +0000787 load_dep_bb();
788
Denis Vlasenko671691c2008-07-04 10:25:44 +0000789 /* Load/remove modules.
Denis Vlasenko1c781cc2008-09-06 14:14:01 +0000790 * Only rmmod loops here, modprobe has only argv[0] */
Denis Vlasenko671691c2008-07-04 10:25:44 +0000791 do {
792 process_module(*argv++, options);
793 } while (*argv);
794
795 if (ENABLE_FEATURE_CLEAN_UP) {
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000796 IF_FEATURE_MODPROBE_SMALL_OPTIONS_ON_CMDLINE(free(options);)
Denis Vlasenko671691c2008-07-04 10:25:44 +0000797 }
798 return EXIT_SUCCESS;
799}