Move shell descriptions to the config system
[oweals/busybox.git] / modutils / modprobe.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Modprobe written from scratch for BusyBox
4  *
5  * Copyright (c) 2002 by Robert Griebl, griebl@gmx.de
6  * Copyright (c) 2003 by Andrew Dennison, andrew.dennison@motec.com.au
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21  *
22 */
23
24 #include <sys/utsname.h>
25 #include <getopt.h>
26 #include <stdlib.h>
27 #include <unistd.h>
28 #include <syslog.h>
29 #include <string.h>
30 #include <ctype.h>
31 #include <fcntl.h>
32 #include "busybox.h"
33
34
35
36 struct dep_t {
37         char *  m_module;
38         char *  m_options;
39         
40         int     m_isalias  : 1;
41         int     m_reserved : 15;
42         
43         int     m_depcnt   : 16;        
44         char ** m_deparr;
45         
46         struct dep_t * m_next;
47 };
48
49 struct mod_list_t {
50         char *  m_module;
51         char *  m_options;
52         
53         struct mod_list_t * m_prev;
54         struct mod_list_t * m_next;
55 };
56
57
58 static struct dep_t *depend;
59 static int autoclean, show_only, quiet, do_syslog, verbose;
60
61 int parse_tag_value ( char *buffer, char **ptag, char **pvalue )
62 {
63         char *tag, *value;
64
65         while ( isspace ( *buffer ))
66                 buffer++;                       
67         tag = value = buffer;
68         while ( !isspace ( *value ))
69                 value++;
70         *value++ = 0;
71         while ( isspace ( *value ))
72                 value++;
73
74         *ptag = tag;
75         *pvalue = value;
76         
77         return bb_strlen( tag ) && bb_strlen( value );
78 }
79
80 /* Jump through hoops to simulate how fgets() grabs just one line at a
81  * time... Don't use any stdio since modprobe gets called from a kernel
82  * thread and stdio junk can overflow the limited stack... 
83  */
84 static char *reads ( int fd, char *buffer, size_t len )
85 {
86         int n = read ( fd, buffer, len );
87         
88         if ( n > 0 ) {
89                 char *p;
90         
91                 buffer [len-1] = 0;
92                 p = strchr ( buffer, '\n' );
93                 
94                 if ( p ) {
95                         off_t offset;
96                         
97                         offset = lseek ( fd, 0L, SEEK_CUR );               // Get the current file descriptor offset 
98                         lseek ( fd, offset-n + (p-buffer) + 1, SEEK_SET ); // Set the file descriptor offset to right after the \n
99
100                         p[1] = 0;
101                 }
102                 return buffer;
103         }
104         
105         else
106                 return 0;
107 }
108
109 static struct dep_t *build_dep ( void )
110 {
111         int fd;
112         struct utsname un;
113         struct dep_t *first = 0;
114         struct dep_t *current = 0;
115         char buffer[256];
116         char *filename = buffer;
117         int continuation_line = 0;
118         
119         if ( uname ( &un ))
120                 return 0;
121                 
122         // check for buffer overflow in following code
123         if ( bb_strlen ( un.release ) > ( sizeof( buffer ) - 64 )) {
124                 return 0;
125         }
126                                 
127         strcpy ( filename, "/lib/modules/" );
128         strcat ( filename, un.release );
129         strcat ( filename, "/modules.dep" );
130
131         if (( fd = open ( filename, O_RDONLY )) < 0 ) {
132
133                 /* Ok, that didn't work.  Fall back to looking in /lib/modules */
134                 if (( fd = open ( "/lib/modules/modules.dep", O_RDONLY )) < 0 ) {
135                         return 0;
136                 }
137         }
138
139         while ( reads ( fd, buffer, sizeof( buffer ))) {
140                 int l = bb_strlen ( buffer );
141                 char *p = 0;
142                 
143                 while ( isspace ( buffer [l-1] )) {
144                         buffer [l-1] = 0;
145                         l--;
146                 }
147                 
148                 if ( l == 0 ) {
149                         continuation_line = 0;
150                         continue;
151                 }
152                 
153                 if ( !continuation_line ) {             
154                         char *col = strchr ( buffer, ':' );
155                 
156                         if ( col ) {
157                                 char *mods;
158                                 char *mod;
159                                 int ext = 0;
160                                 
161                                 *col = 0;
162                                 mods = strrchr ( buffer, '/' );
163                                 
164                                 if ( !mods )
165                                         mods = buffer;
166                                 else
167                                         mods++;
168                                         
169                                 if (( *(col-2) == '.' ) && ( *(col-1) == 'o' ))
170                                         ext = 2;
171                                 
172                                 mod = bb_xstrndup ( mods, col - mods - ext );
173                                         
174                                 if ( !current ) {
175                                         first = current = (struct dep_t *) xmalloc ( sizeof ( struct dep_t ));
176                                 }
177                                 else {
178                                         current-> m_next = (struct dep_t *) xmalloc ( sizeof ( struct dep_t ));
179                                         current = current-> m_next;
180                                 }
181                                 current-> m_module  = mod;
182                                 current-> m_options = 0;
183                                 current-> m_isalias = 0;
184                                 current-> m_depcnt  = 0;
185                                 current-> m_deparr  = 0;
186                                 current-> m_next    = 0;
187                                                 
188                                 //printf ( "%s:\n", mod );
189                                                 
190                                 p = col + 1;            
191                         }
192                         else
193                                 p = 0;
194                 }
195                 else
196                         p = buffer;
197                         
198                 if ( p && *p ) {
199                         char *end = &buffer [l-1];
200                         char *deps = strrchr ( end, '/' );
201                         char *dep;
202                         int ext = 0;
203                         
204                         while ( isblank ( *end ) || ( *end == '\\' ))
205                                 end--;
206                                 
207                         deps = strrchr ( p, '/' );
208                         
209                         if ( !deps || ( deps < p )) {
210                                 deps = p;
211                 
212                                 while ( isblank ( *deps ))
213                                         deps++;
214                         }
215                         else
216                                 deps++;
217                         
218                         if (( *(end-1) == '.' ) && ( *end == 'o' ))
219                                 ext = 2;
220
221                         /* Cope with blank lines */
222                         if ((end-deps-ext+1) <= 0)
223                                 continue;
224                         
225                         dep = bb_xstrndup ( deps, end - deps - ext + 1 );
226                         
227                         current-> m_depcnt++;
228                         current-> m_deparr = (char **) xrealloc ( current-> m_deparr, sizeof ( char *) * current-> m_depcnt );
229                         current-> m_deparr [current-> m_depcnt - 1] = dep;              
230                         
231                         //printf ( "    %d) %s\n", current-> m_depcnt, current-> m_deparr [current-> m_depcnt -1] );
232                 }
233         
234                 if ( buffer [l-1] == '\\' )
235                         continuation_line = 1;
236                 else
237                         continuation_line = 0;
238         }
239         close ( fd );
240
241         // alias parsing is not 100% correct (no correct handling of continuation lines within an alias) !
242
243         if (( fd = open ( "/etc/modules.conf", O_RDONLY )) < 0 )
244                 if (( fd = open ( "/etc/conf.modules", O_RDONLY )) < 0 )
245                         return first;
246         
247         continuation_line = 0;
248         while ( reads ( fd, buffer, sizeof( buffer ))) {
249                 int l;
250                 char *p;
251                 
252                 p = strchr ( buffer, '#' );     
253                 if ( p )
254                         *p = 0;
255                         
256                 l = bb_strlen ( buffer );
257         
258                 while ( l && isspace ( buffer [l-1] )) {
259                         buffer [l-1] = 0;
260                         l--;
261                 }
262                 
263                 if ( l == 0 ) {
264                         continuation_line = 0;
265                         continue;
266                 }
267                 
268                 if ( !continuation_line ) {             
269                         if (( strncmp ( buffer, "alias", 5 ) == 0 ) && isspace ( buffer [5] )) {
270                                 char *alias, *mod;
271
272                                 if ( parse_tag_value ( buffer + 6, &alias, &mod )) {
273                                         // fprintf ( stderr, "ALIAS: '%s' -> '%s'\n", alias, mod );
274                                 
275                                         if ( !current ) {
276                                                 first = current = (struct dep_t *) xmalloc ( sizeof ( struct dep_t ));
277                                         }
278                                         else {
279                                                 current-> m_next = (struct dep_t *) xmalloc ( sizeof ( struct dep_t ));
280                                                 current = current-> m_next;
281                                         }
282                                         current-> m_module  = bb_xstrdup ( alias );
283                                         current-> m_isalias = 1;
284                                         
285                                         if (( strcmp ( alias, "off" ) == 0 ) || ( strcmp ( alias, "null" ) == 0 )) {
286                                                 current-> m_depcnt = 0;
287                                                 current-> m_deparr = 0;
288                                         }
289                                         else {
290                                                 current-> m_depcnt  = 1;
291                                                 current-> m_deparr  = xmalloc ( 1 * sizeof( char * ));
292                                                 current-> m_deparr[0] = bb_xstrdup ( mod );
293                                         }
294                                         current-> m_next    = 0;                                        
295                                 }
296                         }                               
297                         else if (( strncmp ( buffer, "options", 7 ) == 0 ) && isspace ( buffer [7] )) { 
298                                 char *mod, *opt;
299                                 
300                                 if ( parse_tag_value ( buffer + 8, &mod, &opt )) {
301                                         struct dep_t *dt;
302         
303                                         for ( dt = first; dt; dt = dt-> m_next ) {
304                                                 if ( strcmp ( dt-> m_module, mod ) == 0 ) 
305                                                         break;
306                                         }
307                                         if ( dt ) {
308                                                 dt-> m_options = xrealloc ( dt-> m_options, bb_strlen( opt ) + 1 );
309                                                 strcpy ( dt-> m_options, opt );
310                                                 
311                                                 // fprintf ( stderr, "OPTION: '%s' -> '%s'\n", dt-> m_module, dt-> m_options );
312                                         }
313                                 }
314                         }
315                 }
316         }
317         close ( fd );
318         
319         return first;
320 }
321
322
323 static int mod_process ( struct mod_list_t *list, int do_insert )
324 {
325         char lcmd [256];
326         int rc = 1;
327
328         while ( list ) {
329                 if ( do_insert )
330                         snprintf ( lcmd, sizeof( lcmd ) - 1, "insmod %s %s %s %s %s 2>/dev/null", do_syslog ? "-s" : "", autoclean ? "-k" : "", quiet ? "-q" : "", list-> m_module, list-> m_options ? list-> m_options : "" );
331                 else
332                         snprintf ( lcmd, sizeof( lcmd ) - 1, "rmmod %s %s 2>/dev/null", do_syslog ? "-s" : "", list-> m_module );
333                 
334                 if ( verbose )
335                         printf ( "%s\n", lcmd );
336                 if ( !show_only ) {
337                         int rc2 = system ( lcmd );
338                         if (do_insert) rc = rc2; /* only last module matters */
339                         else if (!rc2) rc = 0; /* success if remove any mod */
340                 }
341                         
342                 list = do_insert ? list-> m_prev : list-> m_next;
343         }
344         return (show_only) ? 0 : rc;
345 }
346
347 static void check_dep ( char *mod, struct mod_list_t **head, struct mod_list_t **tail )
348 {
349         struct mod_list_t *find;
350         struct dep_t *dt;
351         char *opt = 0;
352         int lm;
353
354         // remove .o extension
355         lm = bb_strlen ( mod );
356         if (( mod [lm-2] == '.' ) && ( mod [lm-1] == 'o' ))
357                 mod [lm-2] = 0;
358
359         // check dependencies
360         for ( dt = depend; dt; dt = dt-> m_next ) {
361                 if ( strcmp ( dt-> m_module, mod ) == 0 ) {
362                         opt = dt-> m_options;
363                         break;
364                 }
365         }
366         
367         // resolve alias names
368         while ( dt && dt-> m_isalias ) {
369                 if ( dt-> m_depcnt == 1 ) {
370                         struct dep_t *adt;
371                 
372                         for ( adt = depend; adt; adt = adt-> m_next ) {
373                                 if ( strcmp ( adt-> m_module, dt-> m_deparr [0] ) == 0 )
374                                         break;
375                         }
376                         if ( adt ) {
377                                 dt = adt;                       
378                                 mod = dt-> m_module;
379                                 if ( !opt )
380                                         opt = dt-> m_options;
381                         }
382                         else
383                                 return;
384                 }
385                 else
386                         return;                 
387         }
388         
389         // search for duplicates
390         for ( find = *head; find; find = find-> m_next ) {
391                 if ( !strcmp ( mod, find-> m_module )) {
392                         // found -> dequeue it
393
394                         if ( find-> m_prev )
395                                 find-> m_prev-> m_next = find-> m_next;
396                         else
397                                 *head = find-> m_next;
398                                         
399                         if ( find-> m_next )
400                                 find-> m_next-> m_prev = find-> m_prev;
401                         else
402                                 *tail = find-> m_prev;
403                                         
404                         break; // there can be only one duplicate
405                 }                               
406         }
407
408         if ( !find ) { // did not find a duplicate
409                 find = (struct mod_list_t *) xmalloc ( sizeof(struct mod_list_t));              
410                 find-> m_module = mod;
411                 find-> m_options = opt;
412         }
413
414         // enqueue at tail      
415         if ( *tail )
416                 (*tail)-> m_next = find;
417         find-> m_prev   = *tail;
418         find-> m_next   = 0;
419
420         if ( !*head )
421                 *head = find;
422         *tail = find;
423                 
424         if ( dt ) {     
425                 int i;
426                 
427                 for ( i = 0; i < dt-> m_depcnt; i++ )
428                         check_dep ( dt-> m_deparr [i], head, tail );
429         }
430 }
431
432
433
434 static int mod_insert ( char *mod, int argc, char **argv )
435 {
436         struct mod_list_t *tail = 0;
437         struct mod_list_t *head = 0;    
438         int rc;
439         
440         // get dep list for module mod
441         check_dep ( mod, &head, &tail );
442         
443         if ( head && tail ) {
444                 if ( argc ) {
445                         int i;          
446                         int l = 0;
447         
448                         // append module args
449                         for ( i = 0; i < argc; i++ ) 
450                                 l += ( bb_strlen ( argv [i] ) + 1 );
451                 
452                         head-> m_options = xrealloc ( head-> m_options, l + 1 );
453                         head-> m_options [0] = 0;
454                 
455                         for ( i = 0; i < argc; i++ ) {
456                                 strcat ( head-> m_options, argv [i] );
457                                 strcat ( head-> m_options, " " );
458                         }
459                 }
460                 
461                 // process tail ---> head
462                 rc = mod_process ( tail, 1 );
463         }
464         else
465                 rc = 1;
466         
467         return rc;
468 }
469
470 static int mod_remove ( char *mod )
471 {
472         int rc;
473         static struct mod_list_t rm_a_dummy = { "-a", 0, 0 }; 
474         
475         struct mod_list_t *head = 0;
476         struct mod_list_t *tail = 0;
477         
478         if ( mod )
479                 check_dep ( mod, &head, &tail );
480         else  // autoclean
481                 head = tail = &rm_a_dummy;
482         
483         if ( head && tail )
484                 rc = mod_process ( head, 0 );  // process head ---> tail
485         else
486                 rc = 1;
487         return rc;
488         
489 }
490
491
492
493 extern int modprobe_main(int argc, char** argv)
494 {
495         int     opt;
496         int remove_opt = 0;
497
498         autoclean = show_only = quiet = do_syslog = verbose = 0;
499
500         while ((opt = getopt(argc, argv, "acdklnqrst:vVC:")) != -1) {
501                 switch(opt) {
502                 case 'c': // no config used
503                 case 'l': // no pattern matching
504                         return EXIT_SUCCESS;
505                         break;
506                 case 'C': // no config used
507                 case 't': // no pattern matching
508                         bb_error_msg_and_die("-t and -C not supported");
509
510                 case 'a': // ignore
511                 case 'd': // ignore
512                         break;
513                 case 'k':
514                         autoclean++;
515                         break;
516                 case 'n':
517                         show_only++;
518                         break;
519                 case 'q':
520                         quiet++;
521                         break;
522                 case 'r':
523                         remove_opt++;
524                         break;
525                 case 's':
526                         do_syslog++;
527                         break;
528                 case 'v':
529                         verbose++;
530                         break;
531                 case 'V':
532                 default:
533                         bb_show_usage();
534                         break;
535                 }
536         }
537         
538         depend = build_dep ( ); 
539
540         if ( !depend ) 
541                 bb_error_msg_and_die ( "could not parse modules.dep\n" );
542         
543         if (remove_opt) {
544                 int rc = EXIT_SUCCESS;
545                 do {
546                         if (mod_remove ( optind < argc ?
547                                          bb_xstrdup (argv [optind]) : NULL )) {
548                                 bb_error_msg ("failed to remove module %s",
549                                         argv [optind] );
550                                 rc = EXIT_FAILURE;
551                         }
552                 } while ( ++optind < argc );
553                 
554                 return rc;
555         }
556
557         if (optind >= argc) 
558                 bb_error_msg_and_die ( "No module or pattern provided\n" );
559         
560         if ( mod_insert ( bb_xstrdup ( argv [optind] ), argc - optind - 1, argv + optind + 1 )) 
561                 bb_error_msg_and_die ( "failed to load module %s", argv [optind] );
562         
563         return EXIT_SUCCESS;
564 }
565
566