nc: don't redirect stderr to network in -e PROG mode
[oweals/busybox.git] / util-linux / mdev.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * mdev - Mini udev for busybox
4  *
5  * Copyright 2005 Rob Landley <rob@landley.net>
6  * Copyright 2005 Frank Sorenson <frank@tuxrocks.com>
7  *
8  * Licensed under GPLv2, see file LICENSE in this source tree.
9  */
10
11 //config:config MDEV
12 //config:       bool "mdev"
13 //config:       default y
14 //config:       select PLATFORM_LINUX
15 //config:       help
16 //config:         mdev is a mini-udev implementation for dynamically creating device
17 //config:         nodes in the /dev directory.
18 //config:
19 //config:         For more information, please see docs/mdev.txt
20 //config:
21 //config:config FEATURE_MDEV_CONF
22 //config:       bool "Support /etc/mdev.conf"
23 //config:       default y
24 //config:       depends on MDEV
25 //config:       help
26 //config:         Add support for the mdev config file to control ownership and
27 //config:         permissions of the device nodes.
28 //config:
29 //config:         For more information, please see docs/mdev.txt
30 //config:
31 //config:config FEATURE_MDEV_RENAME
32 //config:       bool "Support subdirs/symlinks"
33 //config:       default y
34 //config:       depends on FEATURE_MDEV_CONF
35 //config:       help
36 //config:         Add support for renaming devices and creating symlinks.
37 //config:
38 //config:         For more information, please see docs/mdev.txt
39 //config:
40 //config:config FEATURE_MDEV_RENAME_REGEXP
41 //config:       bool "Support regular expressions substitutions when renaming device"
42 //config:       default y
43 //config:       depends on FEATURE_MDEV_RENAME
44 //config:       help
45 //config:         Add support for regular expressions substitutions when renaming
46 //config:         device.
47 //config:
48 //config:config FEATURE_MDEV_EXEC
49 //config:       bool "Support command execution at device addition/removal"
50 //config:       default y
51 //config:       depends on FEATURE_MDEV_CONF
52 //config:       help
53 //config:         This adds support for an optional field to /etc/mdev.conf for
54 //config:         executing commands when devices are created/removed.
55 //config:
56 //config:         For more information, please see docs/mdev.txt
57 //config:
58 //config:config FEATURE_MDEV_LOAD_FIRMWARE
59 //config:       bool "Support loading of firmwares"
60 //config:       default y
61 //config:       depends on MDEV
62 //config:       help
63 //config:         Some devices need to load firmware before they can be usable.
64 //config:
65 //config:         These devices will request userspace look up the files in
66 //config:         /lib/firmware/ and if it exists, send it to the kernel for
67 //config:         loading into the hardware.
68
69 //applet:IF_MDEV(APPLET(mdev, BB_DIR_SBIN, BB_SUID_DROP))
70
71 //kbuild:lib-$(CONFIG_MDEV) += mdev.o
72
73 //usage:#define mdev_trivial_usage
74 //usage:       "[-s]"
75 //usage:#define mdev_full_usage "\n\n"
76 //usage:       "mdev -s is to be run during boot to scan /sys and populate /dev.\n"
77 //usage:       "\n"
78 //usage:       "Bare mdev is a kernel hotplug helper. To activate it:\n"
79 //usage:       "        echo /sbin/mdev >/proc/sys/kernel/hotplug\n"
80 //usage:        IF_FEATURE_MDEV_CONF(
81 //usage:       "\n"
82 //usage:       "It uses /etc/mdev.conf with lines\n"
83 //usage:       "        [-][ENV=regex;]...DEVNAME UID:GID PERM"
84 //usage:                        IF_FEATURE_MDEV_RENAME(" [>|=PATH]|[!]")
85 //usage:                        IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]")
86 //usage:       "\n"
87 //usage:       "where DEVNAME is device name regex, @major,minor[-minor2], or\n"
88 //usage:       "environment variable regex. A common use of the latter is\n"
89 //usage:       "to load modules for hotplugged devices:\n"
90 //usage:       "        $MODALIAS=.* 0:0 660 @modprobe \"$MODALIAS\"\n"
91 //usage:        )
92 //usage:       "\n"
93 //usage:       "If /dev/mdev.seq file exists, mdev will wait for its value\n"
94 //usage:       "to match $SEQNUM variable. This prevents plug/unplug races.\n"
95 //usage:       "To activate this feature, create empty /dev/mdev.seq at boot.\n"
96 //usage:       "\n"
97 //usage:       "If /dev/mdev.log file exists, debug log will be appended to it."
98
99 #include "libbb.h"
100 #include "xregex.h"
101
102 /* "mdev -s" scans /sys/class/xxx, looking for directories which have dev
103  * file (it is of the form "M:m\n"). Example: /sys/class/tty/tty0/dev
104  * contains "4:0\n". Directory name is taken as device name, path component
105  * directly after /sys/class/ as subsystem. In this example, "tty0" and "tty".
106  * Then mdev creates the /dev/device_name node.
107  * If /sys/class/.../dev file does not exist, mdev still may act
108  * on this device: see "@|$|*command args..." parameter in config file.
109  *
110  * mdev w/o parameters is called as hotplug helper. It takes device
111  * and subsystem names from $DEVPATH and $SUBSYSTEM, extracts
112  * maj,min from "/sys/$DEVPATH/dev" and also examines
113  * $ACTION ("add"/"delete") and $FIRMWARE.
114  *
115  * If action is "add", mdev creates /dev/device_name similarly to mdev -s.
116  * (todo: explain "delete" and $FIRMWARE)
117  *
118  * If /etc/mdev.conf exists, it may modify /dev/device_name's properties.
119  *
120  * Leading minus in 1st field means "don't stop on this line", otherwise
121  * search is stopped after the matching line is encountered.
122  *
123  * $envvar=regex format is useful for loading modules for hot-plugged devices
124  * which do not have driver loaded yet. In this case /sys/class/.../dev
125  * does not exist, but $MODALIAS is set to needed module's name
126  * (actually, an alias to it) by kernel. This rule instructs mdev
127  * to load the module and exit:
128  *    $MODALIAS=.* 0:0 660 @modprobe "$MODALIAS"
129  * The kernel will generate another hotplug event when /sys/class/.../dev
130  * file appears.
131  *
132  * When line matches, the device node is created, chmod'ed and chown'ed,
133  * moved to path, and if >path, a symlink to moved node is created,
134  * all this if /sys/class/.../dev exists.
135  *    Examples:
136  *    =loop/      - moves to /dev/loop
137  *    >disk/sda%1 - moves to /dev/disk/sdaN, makes /dev/sdaN a symlink
138  *
139  * Then "command args..." is executed (via sh -c 'command args...').
140  * @:execute on creation, $:on deletion, *:on both.
141  * This happens regardless of /sys/class/.../dev existence.
142  */
143
144 /* Kernel's hotplug environment constantly changes.
145  * Here are new cases I observed on 3.1.0:
146  *
147  * Case with $DEVNAME and $DEVICE, not just $DEVPATH:
148  * ACTION=add
149  * BUSNUM=001
150  * DEVICE=/proc/bus/usb/001/003
151  * DEVNAME=bus/usb/001/003
152  * DEVNUM=003
153  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5
154  * DEVTYPE=usb_device
155  * MAJOR=189
156  * MINOR=2
157  * PRODUCT=18d1/4e12/227
158  * SUBSYSTEM=usb
159  * TYPE=0/0/0
160  *
161  * Case with $DEVICE, but no $DEVNAME - apparenty, usb iface notification?
162  * "Please load me a module" thing?
163  * ACTION=add
164  * DEVICE=/proc/bus/usb/001/003
165  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5/1-5:1.0
166  * DEVTYPE=usb_interface
167  * INTERFACE=8/6/80
168  * MODALIAS=usb:v18D1p4E12d0227dc00dsc00dp00ic08isc06ip50
169  * PRODUCT=18d1/4e12/227
170  * SUBSYSTEM=usb
171  * TYPE=0/0/0
172  *
173  * ACTION=add
174  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5/1-5:1.0/host5
175  * DEVTYPE=scsi_host
176  * SUBSYSTEM=scsi
177  *
178  * ACTION=add
179  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5/1-5:1.0/host5/scsi_host/host5
180  * SUBSYSTEM=scsi_host
181  *
182  * ACTION=add
183  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5/1-5:1.0/host5/target5:0:0
184  * DEVTYPE=scsi_target
185  * SUBSYSTEM=scsi
186  *
187  * Case with strange $MODALIAS:
188  * ACTION=add
189  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5/1-5:1.0/host5/target5:0:0/5:0:0:0
190  * DEVTYPE=scsi_device
191  * MODALIAS=scsi:t-0x00
192  * SUBSYSTEM=scsi
193  *
194  * ACTION=add
195  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5/1-5:1.0/host5/target5:0:0/5:0:0:0/scsi_disk/5:0:0:0
196  * SUBSYSTEM=scsi_disk
197  *
198  * ACTION=add
199  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5/1-5:1.0/host5/target5:0:0/5:0:0:0/scsi_device/5:0:0:0
200  * SUBSYSTEM=scsi_device
201  *
202  * Case with explicit $MAJOR/$MINOR (no need to read /sys/$DEVPATH/dev?):
203  * ACTION=add
204  * DEVNAME=bsg/5:0:0:0
205  * DEVPATH=/devices/pci0000:00/0000:00:02.1/usb1/1-5/1-5:1.0/host5/target5:0:0/5:0:0:0/bsg/5:0:0:0
206  * MAJOR=253
207  * MINOR=1
208  * SUBSYSTEM=bsg
209  *
210  * ACTION=add
211  * DEVPATH=/devices/virtual/bdi/8:16
212  * SUBSYSTEM=bdi
213  *
214  * ACTION=add
215  * DEVNAME=sdb
216  * DEVPATH=/block/sdb
217  * DEVTYPE=disk
218  * MAJOR=8
219  * MINOR=16
220  * SUBSYSTEM=block
221  *
222  * Case with ACTION=change:
223  * ACTION=change
224  * DEVNAME=sdb
225  * DEVPATH=/block/sdb
226  * DEVTYPE=disk
227  * DISK_MEDIA_CHANGE=1
228  * MAJOR=8
229  * MINOR=16
230  * SUBSYSTEM=block
231  */
232
233 #define DEBUG_LVL 2
234
235 #if DEBUG_LVL >= 1
236 # define dbg1(...) do { if (G.verbose) bb_error_msg(__VA_ARGS__); } while(0)
237 #else
238 # define dbg1(...) ((void)0)
239 #endif
240 #if DEBUG_LVL >= 2
241 # define dbg2(...) do { if (G.verbose >= 2) bb_error_msg(__VA_ARGS__); } while(0)
242 #else
243 # define dbg2(...) ((void)0)
244 #endif
245 #if DEBUG_LVL >= 3
246 # define dbg3(...) do { if (G.verbose >= 3) bb_error_msg(__VA_ARGS__); } while(0)
247 #else
248 # define dbg3(...) ((void)0)
249 #endif
250
251
252 static const char keywords[] ALIGN1 = "add\0remove\0"; // "change\0"
253 enum { OP_add, OP_remove };
254
255 struct envmatch {
256         struct envmatch *next;
257         char *envname;
258         regex_t match;
259 };
260
261 struct rule {
262         bool keep_matching;
263         bool regex_compiled;
264         mode_t mode;
265         int maj, min0, min1;
266         struct bb_uidgid_t ugid;
267         char *envvar;
268         char *ren_mov;
269         IF_FEATURE_MDEV_EXEC(char *r_cmd;)
270         regex_t match;
271         struct envmatch *envmatch;
272 };
273
274 struct globals {
275         int root_major, root_minor;
276         smallint verbose;
277         char *subsystem;
278         char *subsys_env; /* for putenv("SUBSYSTEM=subsystem") */
279 #if ENABLE_FEATURE_MDEV_CONF
280         const char *filename;
281         parser_t *parser;
282         struct rule **rule_vec;
283         unsigned rule_idx;
284 #endif
285         struct rule cur_rule;
286         char timestr[sizeof("60.123456")];
287 } FIX_ALIASING;
288 #define G (*(struct globals*)&bb_common_bufsiz1)
289 #define INIT_G() do { \
290         IF_NOT_FEATURE_MDEV_CONF(G.cur_rule.maj = -1;) \
291         IF_NOT_FEATURE_MDEV_CONF(G.cur_rule.mode = 0660;) \
292 } while (0)
293
294
295 /* Prevent infinite loops in /sys symlinks */
296 #define MAX_SYSFS_DEPTH 3
297
298 /* We use additional 64+ bytes in make_device() */
299 #define SCRATCH_SIZE 80
300
301 #if ENABLE_FEATURE_MDEV_CONF
302
303 static void make_default_cur_rule(void)
304 {
305         memset(&G.cur_rule, 0, sizeof(G.cur_rule));
306         G.cur_rule.maj = -1; /* "not a @major,minor rule" */
307         G.cur_rule.mode = 0660;
308 }
309
310 static void clean_up_cur_rule(void)
311 {
312         struct envmatch *e;
313
314         free(G.cur_rule.envvar);
315         free(G.cur_rule.ren_mov);
316         if (G.cur_rule.regex_compiled)
317                 regfree(&G.cur_rule.match);
318         IF_FEATURE_MDEV_EXEC(free(G.cur_rule.r_cmd);)
319         e = G.cur_rule.envmatch;
320         while (e) {
321                 free(e->envname);
322                 regfree(&e->match);
323                 e = e->next;
324         }
325         make_default_cur_rule();
326 }
327
328 static char *parse_envmatch_pfx(char *val)
329 {
330         struct envmatch **nextp = &G.cur_rule.envmatch;
331
332         for (;;) {
333                 struct envmatch *e;
334                 char *semicolon;
335                 char *eq = strchr(val, '=');
336                 if (!eq /* || eq == val? */)
337                         return val;
338                 if (endofname(val) != eq)
339                         return val;
340                 semicolon = strchr(eq, ';');
341                 if (!semicolon)
342                         return val;
343                 /* ENVVAR=regex;... */
344                 *nextp = e = xzalloc(sizeof(*e));
345                 nextp = &e->next;
346                 e->envname = xstrndup(val, eq - val);
347                 *semicolon = '\0';
348                 xregcomp(&e->match, eq + 1, REG_EXTENDED);
349                 *semicolon = ';';
350                 val = semicolon + 1;
351         }
352 }
353
354 static void parse_next_rule(void)
355 {
356         /* Note: on entry, G.cur_rule is set to default */
357         while (1) {
358                 char *tokens[4];
359                 char *val;
360
361                 /* No PARSE_EOL_COMMENTS, because command may contain '#' chars */
362                 if (!config_read(G.parser, tokens, 4, 3, "# \t", PARSE_NORMAL & ~PARSE_EOL_COMMENTS))
363                         break;
364
365                 /* Fields: [-]regex uid:gid mode [alias] [cmd] */
366                 dbg3("token1:'%s'", tokens[1]);
367
368                 /* 1st field */
369                 val = tokens[0];
370                 G.cur_rule.keep_matching = ('-' == val[0]);
371                 val += G.cur_rule.keep_matching; /* swallow leading dash */
372                 val = parse_envmatch_pfx(val);
373                 if (val[0] == '@') {
374                         /* @major,minor[-minor2] */
375                         /* (useful when name is ambiguous:
376                          * "/sys/class/usb/lp0" and
377                          * "/sys/class/printer/lp0")
378                          */
379                         int sc = sscanf(val, "@%u,%u-%u", &G.cur_rule.maj, &G.cur_rule.min0, &G.cur_rule.min1);
380                         if (sc < 2 || G.cur_rule.maj < 0) {
381                                 bb_error_msg("bad @maj,min on line %d", G.parser->lineno);
382                                 goto next_rule;
383                         }
384                         if (sc == 2)
385                                 G.cur_rule.min1 = G.cur_rule.min0;
386                 } else {
387                         char *eq = strchr(val, '=');
388                         if (val[0] == '$') {
389                                 /* $ENVVAR=regex ... */
390                                 val++;
391                                 if (!eq) {
392                                         bb_error_msg("bad $envvar=regex on line %d", G.parser->lineno);
393                                         goto next_rule;
394                                 }
395                                 G.cur_rule.envvar = xstrndup(val, eq - val);
396                                 val = eq + 1;
397                         }
398                         xregcomp(&G.cur_rule.match, val, REG_EXTENDED);
399                         G.cur_rule.regex_compiled = 1;
400                 }
401
402                 /* 2nd field: uid:gid - device ownership */
403                 if (get_uidgid(&G.cur_rule.ugid, tokens[1], /*allow_numeric:*/ 1) == 0) {
404                         bb_error_msg("unknown user/group '%s' on line %d", tokens[1], G.parser->lineno);
405                         goto next_rule;
406                 }
407
408                 /* 3rd field: mode - device permissions */
409                 bb_parse_mode(tokens[2], &G.cur_rule.mode);
410
411                 /* 4th field (opt): ">|=alias" or "!" to not create the node */
412                 val = tokens[3];
413                 if (ENABLE_FEATURE_MDEV_RENAME && val && strchr(">=!", val[0])) {
414                         char *s = skip_non_whitespace(val);
415                         G.cur_rule.ren_mov = xstrndup(val, s - val);
416                         val = skip_whitespace(s);
417                 }
418
419                 if (ENABLE_FEATURE_MDEV_EXEC && val && val[0]) {
420                         const char *s = "$@*";
421                         const char *s2 = strchr(s, val[0]);
422                         if (!s2) {
423                                 bb_error_msg("bad line %u", G.parser->lineno);
424                                 goto next_rule;
425                         }
426                         IF_FEATURE_MDEV_EXEC(G.cur_rule.r_cmd = xstrdup(val);)
427                 }
428
429                 return;
430  next_rule:
431                 clean_up_cur_rule();
432         } /* while (config_read) */
433
434         dbg3("config_close(G.parser)");
435         config_close(G.parser);
436         G.parser = NULL;
437
438         return;
439 }
440
441 /* If mdev -s, we remember rules in G.rule_vec[].
442  * Otherwise, there is no point in doing it, and we just
443  * save only one parsed rule in G.cur_rule.
444  */
445 static const struct rule *next_rule(void)
446 {
447         struct rule *rule;
448
449         /* Open conf file if we didn't do it yet */
450         if (!G.parser && G.filename) {
451                 dbg3("config_open('%s')", G.filename);
452                 G.parser = config_open2(G.filename, fopen_for_read);
453                 G.filename = NULL;
454         }
455
456         if (G.rule_vec) {
457                 /* mdev -s */
458                 /* Do we have rule parsed already? */
459                 if (G.rule_vec[G.rule_idx]) {
460                         dbg3("< G.rule_vec[G.rule_idx:%d]=%p", G.rule_idx, G.rule_vec[G.rule_idx]);
461                         return G.rule_vec[G.rule_idx++];
462                 }
463                 make_default_cur_rule();
464         } else {
465                 /* not mdev -s */
466                 clean_up_cur_rule();
467         }
468
469         /* Parse one more rule if file isn't fully read */
470         rule = &G.cur_rule;
471         if (G.parser) {
472                 parse_next_rule();
473                 if (G.rule_vec) { /* mdev -s */
474                         rule = memcpy(xmalloc(sizeof(G.cur_rule)), &G.cur_rule, sizeof(G.cur_rule));
475                         G.rule_vec = xrealloc_vector(G.rule_vec, 4, G.rule_idx);
476                         G.rule_vec[G.rule_idx++] = rule;
477                         dbg3("> G.rule_vec[G.rule_idx:%d]=%p", G.rule_idx, G.rule_vec[G.rule_idx]);
478                 }
479         }
480
481         return rule;
482 }
483
484 static int env_matches(struct envmatch *e)
485 {
486         while (e) {
487                 int r;
488                 char *val = getenv(e->envname);
489                 if (!val)
490                         return 0;
491                 r = regexec(&e->match, val, /*size*/ 0, /*range[]*/ NULL, /*eflags*/ 0);
492                 if (r != 0) /* no match */
493                         return 0;
494                 e = e->next;
495         }
496         return 1;
497 }
498
499 #else
500
501 # define next_rule() (&G.cur_rule)
502
503 #endif
504
505 static void mkdir_recursive(char *name)
506 {
507         /* if name has many levels ("dir1/dir2"),
508          * bb_make_directory() will create dir1 according to umask,
509          * not according to its "mode" parameter.
510          * Since we run with umask=0, need to temporarily switch it.
511          */
512         umask(022); /* "dir1" (if any) will be 0755 too */
513         bb_make_directory(name, 0755, FILEUTILS_RECUR);
514         umask(0);
515 }
516
517 /* Builds an alias path.
518  * This function potentionally reallocates the alias parameter.
519  * Only used for ENABLE_FEATURE_MDEV_RENAME
520  */
521 static char *build_alias(char *alias, const char *device_name)
522 {
523         char *dest;
524
525         /* ">bar/": rename to bar/device_name */
526         /* ">bar[/]baz": rename to bar[/]baz */
527         dest = strrchr(alias, '/');
528         if (dest) { /* ">bar/[baz]" ? */
529                 *dest = '\0'; /* mkdir bar */
530                 mkdir_recursive(alias);
531                 *dest = '/';
532                 if (dest[1] == '\0') { /* ">bar/" => ">bar/device_name" */
533                         dest = alias;
534                         alias = concat_path_file(alias, device_name);
535                         free(dest);
536                 }
537         }
538
539         return alias;
540 }
541
542 /* mknod in /dev based on a path like "/sys/block/hda/hda1"
543  * NB1: path parameter needs to have SCRATCH_SIZE scratch bytes
544  * after NUL, but we promise to not mangle (IOW: to restore if needed)
545  * path string.
546  * NB2: "mdev -s" may call us many times, do not leak memory/fds!
547  *
548  * device_name = $DEVNAME (may be NULL)
549  * path        = /sys/$DEVPATH
550  */
551 static void make_device(char *device_name, char *path, int operation)
552 {
553         int major, minor, type, len;
554
555         /* Try to read major/minor string.  Note that the kernel puts \n after
556          * the data, so we don't need to worry about null terminating the string
557          * because sscanf() will stop at the first nondigit, which \n is.
558          * We also depend on path having writeable space after it.
559          */
560         major = -1;
561         if (operation == OP_add) {
562                 char *dev_maj_min = path + strlen(path);
563
564                 strcpy(dev_maj_min, "/dev");
565                 len = open_read_close(path, dev_maj_min + 1, 64);
566                 *dev_maj_min = '\0';
567                 if (len < 1) {
568                         if (!ENABLE_FEATURE_MDEV_EXEC)
569                                 return;
570                         /* no "dev" file, but we can still run scripts
571                          * based on device name */
572                 } else if (sscanf(++dev_maj_min, "%u:%u", &major, &minor) == 2) {
573                         dbg1("dev %u,%u", major, minor);
574                 } else {
575                         major = -1;
576                 }
577         }
578         /* else: for delete, -1 still deletes the node, but < -1 suppresses that */
579
580         /* Determine device name, type, major and minor */
581         if (!device_name)
582                 device_name = (char*) bb_basename(path);
583         /*
584          * http://kernel.org/doc/pending/hotplug.txt says that only
585          * "/sys/block/..." is for block devices. "/sys/bus" etc is not.
586          * But since 2.6.25 block devices are also in /sys/class/block.
587          * We use strstr("/block/") to forestall future surprises.
588          */
589         type = S_IFCHR;
590         if (strstr(path, "/block/") || (G.subsystem && strncmp(G.subsystem, "block", 5) == 0))
591                 type = S_IFBLK;
592
593 #if ENABLE_FEATURE_MDEV_CONF
594         G.rule_idx = 0; /* restart from the beginning (think mdev -s) */
595 #endif
596         for (;;) {
597                 const char *str_to_match;
598                 regmatch_t off[1 + 9 * ENABLE_FEATURE_MDEV_RENAME_REGEXP];
599                 char *command;
600                 char *alias;
601                 char aliaslink = aliaslink; /* for compiler */
602                 char *node_name;
603                 const struct rule *rule;
604
605                 str_to_match = device_name;
606
607                 rule = next_rule();
608
609 #if ENABLE_FEATURE_MDEV_CONF
610                 if (!env_matches(rule->envmatch))
611                         continue;
612                 if (rule->maj >= 0) {  /* @maj,min rule */
613                         if (major != rule->maj)
614                                 continue;
615                         if (minor < rule->min0 || minor > rule->min1)
616                                 continue;
617                         memset(off, 0, sizeof(off));
618                         goto rule_matches;
619                 }
620                 if (rule->envvar) { /* $envvar=regex rule */
621                         str_to_match = getenv(rule->envvar);
622                         dbg3("getenv('%s'):'%s'", rule->envvar, str_to_match);
623                         if (!str_to_match)
624                                 continue;
625                 }
626                 /* else: str_to_match = device_name */
627
628                 if (rule->regex_compiled) {
629                         int regex_match = regexec(&rule->match, str_to_match, ARRAY_SIZE(off), off, 0);
630                         dbg3("regex_match for '%s':%d", str_to_match, regex_match);
631                         //bb_error_msg("matches:");
632                         //for (int i = 0; i < ARRAY_SIZE(off); i++) {
633                         //      if (off[i].rm_so < 0) continue;
634                         //      bb_error_msg("match %d: '%.*s'\n", i,
635                         //              (int)(off[i].rm_eo - off[i].rm_so),
636                         //              device_name + off[i].rm_so);
637                         //}
638
639                         if (regex_match != 0
640                         /* regexec returns whole pattern as "range" 0 */
641                          || off[0].rm_so != 0
642                          || (int)off[0].rm_eo != (int)strlen(str_to_match)
643                         ) {
644                                 continue; /* this rule doesn't match */
645                         }
646                 }
647                 /* else: it's final implicit "match-all" rule */
648  rule_matches:
649 #endif
650                 dbg2("rule matched, line %d", G.parser ? G.parser->lineno : -1);
651
652                 /* Build alias name */
653                 alias = NULL;
654                 if (ENABLE_FEATURE_MDEV_RENAME && rule->ren_mov) {
655                         aliaslink = rule->ren_mov[0];
656                         if (aliaslink == '!') {
657                                 /* "!": suppress node creation/deletion */
658                                 major = -2;
659                         }
660                         else if (aliaslink == '>' || aliaslink == '=') {
661                                 if (ENABLE_FEATURE_MDEV_RENAME_REGEXP) {
662                                         char *s;
663                                         char *p;
664                                         unsigned n;
665
666                                         /* substitute %1..9 with off[1..9], if any */
667                                         n = 0;
668                                         s = rule->ren_mov;
669                                         while (*s)
670                                                 if (*s++ == '%')
671                                                         n++;
672
673                                         p = alias = xzalloc(strlen(rule->ren_mov) + n * strlen(str_to_match));
674                                         s = rule->ren_mov + 1;
675                                         while (*s) {
676                                                 *p = *s;
677                                                 if ('%' == *s) {
678                                                         unsigned i = (s[1] - '0');
679                                                         if (i <= 9 && off[i].rm_so >= 0) {
680                                                                 n = off[i].rm_eo - off[i].rm_so;
681                                                                 strncpy(p, str_to_match + off[i].rm_so, n);
682                                                                 p += n - 1;
683                                                                 s++;
684                                                         }
685                                                 }
686                                                 p++;
687                                                 s++;
688                                         }
689                                 } else {
690                                         alias = xstrdup(rule->ren_mov + 1);
691                                 }
692                         }
693                 }
694                 dbg3("alias:'%s'", alias);
695
696                 command = NULL;
697                 IF_FEATURE_MDEV_EXEC(command = rule->r_cmd;)
698                 if (command) {
699                         /* Are we running this command now?
700                          * Run @cmd on create, $cmd on delete, *cmd on any
701                          */
702                         if ((command[0] == '@' && operation == OP_add)
703                          || (command[0] == '$' && operation == OP_remove)
704                          || (command[0] == '*')
705                         ) {
706                                 command++;
707                         } else {
708                                 command = NULL;
709                         }
710                 }
711                 dbg3("command:'%s'", command);
712
713                 /* "Execute" the line we found */
714                 node_name = device_name;
715                 if (ENABLE_FEATURE_MDEV_RENAME && alias) {
716                         node_name = alias = build_alias(alias, device_name);
717                         dbg3("alias2:'%s'", alias);
718                 }
719
720                 if (operation == OP_add && major >= 0) {
721                         char *slash = strrchr(node_name, '/');
722                         if (slash) {
723                                 *slash = '\0';
724                                 mkdir_recursive(node_name);
725                                 *slash = '/';
726                         }
727                         if (ENABLE_FEATURE_MDEV_CONF) {
728                                 dbg1("mknod %s (%d,%d) %o"
729                                         " %u:%u",
730                                         node_name, major, minor, rule->mode | type,
731                                         rule->ugid.uid, rule->ugid.gid
732                                 );
733                         } else {
734                                 dbg1("mknod %s (%d,%d) %o",
735                                         node_name, major, minor, rule->mode | type
736                                 );
737                         }
738                         if (mknod(node_name, rule->mode | type, makedev(major, minor)) && errno != EEXIST)
739                                 bb_perror_msg("can't create '%s'", node_name);
740                         if (ENABLE_FEATURE_MDEV_CONF) {
741                                 chmod(node_name, rule->mode);
742                                 chown(node_name, rule->ugid.uid, rule->ugid.gid);
743                         }
744                         if (major == G.root_major && minor == G.root_minor)
745                                 symlink(node_name, "root");
746                         if (ENABLE_FEATURE_MDEV_RENAME && alias) {
747                                 if (aliaslink == '>') {
748 //TODO: on devtmpfs, device_name already exists and symlink() fails.
749 //End result is that instead of symlink, we have two nodes.
750 //What should be done?
751                                         dbg1("symlink: %s", device_name);
752                                         symlink(node_name, device_name);
753                                 }
754                         }
755                 }
756
757                 if (ENABLE_FEATURE_MDEV_EXEC && command) {
758                         /* setenv will leak memory, use putenv/unsetenv/free */
759                         char *s = xasprintf("%s=%s", "MDEV", node_name);
760                         putenv(s);
761                         dbg1("running: %s", command);
762                         if (system(command) == -1)
763                                 bb_perror_msg("can't run '%s'", command);
764                         bb_unsetenv_and_free(s);
765                 }
766
767                 if (operation == OP_remove && major >= -1) {
768                         if (ENABLE_FEATURE_MDEV_RENAME && alias) {
769                                 if (aliaslink == '>') {
770                                         dbg1("unlink: %s", device_name);
771                                         unlink(device_name);
772                                 }
773                         }
774                         dbg1("unlink: %s", node_name);
775                         unlink(node_name);
776                 }
777
778                 if (ENABLE_FEATURE_MDEV_RENAME)
779                         free(alias);
780
781                 /* We found matching line.
782                  * Stop unless it was prefixed with '-'
783                  */
784                 if (!ENABLE_FEATURE_MDEV_CONF || !rule->keep_matching)
785                         break;
786         } /* for (;;) */
787 }
788
789 /* File callback for /sys/ traversal */
790 static int FAST_FUNC fileAction(const char *fileName,
791                 struct stat *statbuf UNUSED_PARAM,
792                 void *userData,
793                 int depth UNUSED_PARAM)
794 {
795         size_t len = strlen(fileName) - 4; /* can't underflow */
796         char *scratch = userData;
797
798         /* len check is for paranoid reasons */
799         if (strcmp(fileName + len, "/dev") != 0 || len >= PATH_MAX)
800                 return FALSE;
801
802         strcpy(scratch, fileName);
803         scratch[len] = '\0';
804         make_device(/*DEVNAME:*/ NULL, scratch, OP_add);
805
806         return TRUE;
807 }
808
809 /* Directory callback for /sys/ traversal */
810 static int FAST_FUNC dirAction(const char *fileName UNUSED_PARAM,
811                 struct stat *statbuf UNUSED_PARAM,
812                 void *userData UNUSED_PARAM,
813                 int depth)
814 {
815         /* Extract device subsystem -- the name of the directory
816          * under /sys/class/ */
817         if (1 == depth) {
818                 free(G.subsystem);
819                 if (G.subsys_env) {
820                         bb_unsetenv_and_free(G.subsys_env);
821                         G.subsys_env = NULL;
822                 }
823                 G.subsystem = strrchr(fileName, '/');
824                 if (G.subsystem) {
825                         G.subsystem = xstrdup(G.subsystem + 1);
826                         G.subsys_env = xasprintf("%s=%s", "SUBSYSTEM", G.subsystem);
827                         putenv(G.subsys_env);
828                 }
829         }
830
831         return (depth >= MAX_SYSFS_DEPTH ? SKIP : TRUE);
832 }
833
834 /* For the full gory details, see linux/Documentation/firmware_class/README
835  *
836  * Firmware loading works like this:
837  * - kernel sets FIRMWARE env var
838  * - userspace checks /lib/firmware/$FIRMWARE
839  * - userspace waits for /sys/$DEVPATH/loading to appear
840  * - userspace writes "1" to /sys/$DEVPATH/loading
841  * - userspace copies /lib/firmware/$FIRMWARE into /sys/$DEVPATH/data
842  * - userspace writes "0" (worked) or "-1" (failed) to /sys/$DEVPATH/loading
843  * - kernel loads firmware into device
844  */
845 static void load_firmware(const char *firmware, const char *sysfs_path)
846 {
847         int cnt;
848         int firmware_fd, loading_fd;
849
850         /* check for /lib/firmware/$FIRMWARE */
851         xchdir("/lib/firmware");
852         firmware_fd = open(firmware, O_RDONLY); /* can fail */
853
854         /* check for /sys/$DEVPATH/loading ... give 30 seconds to appear */
855         xchdir(sysfs_path);
856         for (cnt = 0; cnt < 30; ++cnt) {
857                 loading_fd = open("loading", O_WRONLY);
858                 if (loading_fd >= 0)
859                         goto loading;
860                 sleep(1);
861         }
862         goto out;
863
864  loading:
865         cnt = 0;
866         if (firmware_fd >= 0) {
867                 int data_fd;
868
869                 /* tell kernel we're loading by "echo 1 > /sys/$DEVPATH/loading" */
870                 if (full_write(loading_fd, "1", 1) != 1)
871                         goto out;
872
873                 /* load firmware into /sys/$DEVPATH/data */
874                 data_fd = open("data", O_WRONLY);
875                 if (data_fd < 0)
876                         goto out;
877                 cnt = bb_copyfd_eof(firmware_fd, data_fd);
878                 if (ENABLE_FEATURE_CLEAN_UP)
879                         close(data_fd);
880         }
881
882         /* Tell kernel result by "echo [0|-1] > /sys/$DEVPATH/loading"
883          * Note: we emit -1 also if firmware file wasn't found.
884          * There are cases when otherwise kernel would wait for minutes
885          * before timing out.
886          */
887         if (cnt > 0)
888                 full_write(loading_fd, "0", 1);
889         else
890                 full_write(loading_fd, "-1", 2);
891
892  out:
893         xchdir("/dev");
894         if (ENABLE_FEATURE_CLEAN_UP) {
895                 close(firmware_fd);
896                 close(loading_fd);
897         }
898 }
899
900 static char *curtime(void)
901 {
902         struct timeval tv;
903         gettimeofday(&tv, NULL);
904         sprintf(G.timestr, "%u.%06u", (unsigned)tv.tv_sec % 60, (unsigned)tv.tv_usec);
905         return G.timestr;
906 }
907
908 static void open_mdev_log(const char *seq, unsigned my_pid)
909 {
910         int logfd = open("mdev.log", O_WRONLY | O_APPEND);
911         if (logfd >= 0) {
912                 xmove_fd(logfd, STDERR_FILENO);
913                 G.verbose = 2;
914                 applet_name = xasprintf("%s[%s]", applet_name, seq ? seq : utoa(my_pid));
915         }
916 }
917
918 /* If it exists, does /dev/mdev.seq match $SEQNUM?
919  * If it does not match, earlier mdev is running
920  * in parallel, and we need to wait.
921  * Active mdev pokes us with SIGCHLD to check the new file.
922  */
923 static int
924 wait_for_seqfile(const char *seq)
925 {
926         /* We time out after 2 sec */
927         static const struct timespec ts = { 0, 32*1000*1000 };
928         int timeout = 2000 / 32;
929         int seq_fd = -1;
930         int do_once = 1;
931         sigset_t set_CHLD;
932
933         sigemptyset(&set_CHLD);
934         sigaddset(&set_CHLD, SIGCHLD);
935         sigprocmask(SIG_BLOCK, &set_CHLD, NULL);
936
937         for (;;) {
938                 int seqlen;
939                 char seqbuf[sizeof(int)*3 + 2];
940
941                 if (seq_fd < 0) {
942                         seq_fd = open("mdev.seq", O_RDWR);
943                         if (seq_fd < 0)
944                                 break;
945                 }
946                 seqlen = pread(seq_fd, seqbuf, sizeof(seqbuf) - 1, 0);
947                 if (seqlen < 0) {
948                         close(seq_fd);
949                         seq_fd = -1;
950                         break;
951                 }
952                 seqbuf[seqlen] = '\0';
953                 if (seqbuf[0] == '\n') {
954                         /* seed file: write out seq ASAP */
955                         xwrite_str(seq_fd, seq);
956                         xlseek(seq_fd, 0, SEEK_SET);
957                         dbg2("first seq written");
958                         break;
959                 }
960                 if (strcmp(seq, seqbuf) == 0) {
961                         /* correct idx */
962                         break;
963                 }
964                 if (do_once) {
965                         dbg2("%s waiting for '%s'", curtime(), seqbuf);
966                         do_once = 0;
967                 }
968                 if (sigtimedwait(&set_CHLD, NULL, &ts) >= 0) {
969                         dbg3("woken up");
970                         continue; /* don't decrement timeout! */
971                 }
972                 if (--timeout == 0) {
973                         dbg1("%s waiting for '%s'", "timed out", seqbuf);
974                         break;
975                 }
976         }
977         sigprocmask(SIG_UNBLOCK, &set_CHLD, NULL);
978         return seq_fd;
979 }
980
981 static void signal_mdevs(unsigned my_pid)
982 {
983         procps_status_t* p = NULL;
984         while ((p = procps_scan(p, PSSCAN_ARGV0)) != NULL) {
985                 if (p->pid != my_pid
986                  && p->argv0
987                  && strcmp(bb_basename(p->argv0), "mdev") == 0
988                 ) {
989                         kill(p->pid, SIGCHLD);
990                 }
991         }
992 }
993
994 int mdev_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
995 int mdev_main(int argc UNUSED_PARAM, char **argv)
996 {
997         RESERVE_CONFIG_BUFFER(temp, PATH_MAX + SCRATCH_SIZE);
998
999         INIT_G();
1000
1001 #if ENABLE_FEATURE_MDEV_CONF
1002         G.filename = "/etc/mdev.conf";
1003 #endif
1004
1005         /* We can be called as hotplug helper */
1006         /* Kernel cannot provide suitable stdio fds for us, do it ourself */
1007         bb_sanitize_stdio();
1008
1009         /* Force the configuration file settings exactly */
1010         umask(0);
1011
1012         xchdir("/dev");
1013
1014         if (argv[1] && strcmp(argv[1], "-s") == 0) {
1015                 /*
1016                  * Scan: mdev -s
1017                  */
1018                 struct stat st;
1019
1020 #if ENABLE_FEATURE_MDEV_CONF
1021                 /* Same as xrealloc_vector(NULL, 4, 0): */
1022                 G.rule_vec = xzalloc((1 << 4) * sizeof(*G.rule_vec));
1023 #endif
1024                 xstat("/", &st);
1025                 G.root_major = major(st.st_dev);
1026                 G.root_minor = minor(st.st_dev);
1027
1028                 putenv((char*)"ACTION=add");
1029
1030                 /* ACTION_FOLLOWLINKS is needed since in newer kernels
1031                  * /sys/block/loop* (for example) are symlinks to dirs,
1032                  * not real directories.
1033                  * (kernel's CONFIG_SYSFS_DEPRECATED makes them real dirs,
1034                  * but we can't enforce that on users)
1035                  */
1036                 if (access("/sys/class/block", F_OK) != 0) {
1037                         /* Scan obsolete /sys/block only if /sys/class/block
1038                          * doesn't exist. Otherwise we'll have dupes.
1039                          * Also, do not complain if it doesn't exist.
1040                          * Some people configure kernel to have no blockdevs.
1041                          */
1042                         recursive_action("/sys/block",
1043                                 ACTION_RECURSE | ACTION_FOLLOWLINKS | ACTION_QUIET,
1044                                 fileAction, dirAction, temp, 0);
1045                 }
1046                 recursive_action("/sys/class",
1047                         ACTION_RECURSE | ACTION_FOLLOWLINKS,
1048                         fileAction, dirAction, temp, 0);
1049         } else {
1050                 char *fw;
1051                 char *seq;
1052                 char *action;
1053                 char *env_devname;
1054                 char *env_devpath;
1055                 unsigned my_pid;
1056                 int seq_fd;
1057                 smalluint op;
1058
1059                 /* Hotplug:
1060                  * env ACTION=... DEVPATH=... SUBSYSTEM=... [SEQNUM=...] mdev
1061                  * ACTION can be "add", "remove", "change"
1062                  * DEVPATH is like "/block/sda" or "/class/input/mice"
1063                  */
1064                 action = getenv("ACTION");
1065                 op = index_in_strings(keywords, action);
1066                 env_devname = getenv("DEVNAME"); /* can be NULL */
1067                 env_devpath = getenv("DEVPATH");
1068                 G.subsystem = getenv("SUBSYSTEM");
1069                 if (!action || !env_devpath /*|| !G.subsystem*/)
1070                         bb_show_usage();
1071                 fw = getenv("FIRMWARE");
1072                 seq = getenv("SEQNUM");
1073
1074                 my_pid = getpid();
1075                 open_mdev_log(seq, my_pid);
1076
1077                 seq_fd = seq ? wait_for_seqfile(seq) : -1;
1078
1079                 dbg1("%s "
1080                         "ACTION:%s SUBSYSTEM:%s DEVNAME:%s DEVPATH:%s"
1081                         "%s%s",
1082                         curtime(),
1083                         action, G.subsystem, env_devname, env_devpath,
1084                         fw ? " FW:" : "", fw ? fw : ""
1085                 );
1086
1087                 snprintf(temp, PATH_MAX, "/sys%s", env_devpath);
1088                 if (op == OP_remove) {
1089                         /* Ignoring "remove firmware". It was reported
1090                          * to happen and to cause erroneous deletion
1091                          * of device nodes. */
1092                         if (!fw)
1093                                 make_device(env_devname, temp, op);
1094                 }
1095                 else {
1096                         make_device(env_devname, temp, op);
1097                         if (ENABLE_FEATURE_MDEV_LOAD_FIRMWARE) {
1098                                 if (op == OP_add && fw)
1099                                         load_firmware(fw, temp);
1100                         }
1101                 }
1102
1103                 dbg1("%s exiting", curtime());
1104                 if (seq_fd >= 0) {
1105                         xwrite_str(seq_fd, utoa(xatou(seq) + 1));
1106                         signal_mdevs(my_pid);
1107                 }
1108         }
1109
1110         if (ENABLE_FEATURE_CLEAN_UP)
1111                 RELEASE_CONFIG_BUFFER(temp);
1112
1113         return EXIT_SUCCESS;
1114 }