brctl: fixing stp parameters incompatibility
[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 GPL version 2, see file LICENSE in this tarball for details.
9  */
10 #include "libbb.h"
11 #include "xregex.h"
12
13 /* "mdev -s" scans /sys/class/xxx, looking for directories which have dev
14  * file (it is of the form "M:m\n"). Example: /sys/class/tty/tty0/dev
15  * contains "4:0\n". Directory name is taken as device name, path component
16  * directly after /sys/class/ as subsystem. In this example, "tty0" and "tty".
17  * Then mdev creates the /dev/device_name node.
18  * If /sys/class/.../dev file does not exist, mdev still may act
19  * on this device: see "@|$|*command args..." parameter in config file.
20  *
21  * mdev w/o parameters is called as hotplug helper. It takes device
22  * and subsystem names from $DEVPATH and $SUBSYSTEM, extracts
23  * maj,min from "/sys/$DEVPATH/dev" and also examines
24  * $ACTION ("add"/"delete") and $FIRMWARE.
25  *
26  * If action is "add", mdev creates /dev/device_name similarly to mdev -s.
27  * (todo: explain "delete" and $FIRMWARE)
28  *
29  * If /etc/mdev.conf exists, it may modify /dev/device_name's properties.
30  * /etc/mdev.conf file format:
31  *
32  * [-][subsystem/]device  user:grp  mode  [>|=path] [@|$|*command args...]
33  * [-]@maj,min[-min2]     user:grp  mode  [>|=path] [@|$|*command args...]
34  * [-]$envvar=val         user:grp  mode  [>|=path] [@|$|*command args...]
35  *
36  * Leading minus in 1st field means "don't stop on this line", otherwise
37  * search is stopped after the matching line is encountered.
38  *
39  * The device name or "subsystem/device" combo is matched against 1st field
40  * (which is a regex), or maj,min is matched against 1st field,
41  * or specified environment variable (as regex) is matched against 1st field.
42  *
43  * $envvar=val format is useful for loading modules for hot-plugged devices
44  * which do not have driver loaded yet. In this case /sys/class/.../dev
45  * does not exist, but $MODALIAS is set to needed module's name
46  * (actually, an alias to it) by kernel. This rule instructs mdev
47  * to load the module and exit:
48  *    $MODALIAS=.* 0:0 660 @modprobe "$MODALIAS"
49  * The kernel will generate another hotplug event when /sys/class/.../dev
50  * file appears.
51  *
52  * When line matches, the device node is created, chmod'ed and chown'ed,
53  * moved to path, and if >path, a symlink to moved node is created,
54  * all this if /sys/class/.../dev exists.
55  *    Examples:
56  *    =loop/      - moves to /dev/loop
57  *    >disk/sda%1 - moves to /dev/disk/sdaN, makes /dev/sdaN a symlink
58  *
59  * Then "command args..." is executed (via sh -c 'command args...').
60  * @:execute on creation, $:on deletion, *:on both.
61  * This happens regardless of /sys/class/.../dev existence.
62  */
63
64 struct globals {
65         int root_major, root_minor;
66         char *subsystem;
67 } FIX_ALIASING;
68 #define G (*(struct globals*)&bb_common_bufsiz1)
69
70 /* Prevent infinite loops in /sys symlinks */
71 #define MAX_SYSFS_DEPTH 3
72
73 /* We use additional 64+ bytes in make_device() */
74 #define SCRATCH_SIZE 80
75
76 /* Builds an alias path.
77  * This function potentionally reallocates the alias parameter.
78  * Only used for ENABLE_FEATURE_MDEV_RENAME
79  */
80 static char *build_alias(char *alias, const char *device_name)
81 {
82         char *dest;
83
84         /* ">bar/": rename to bar/device_name */
85         /* ">bar[/]baz": rename to bar[/]baz */
86         dest = strrchr(alias, '/');
87         if (dest) { /* ">bar/[baz]" ? */
88                 *dest = '\0'; /* mkdir bar */
89                 bb_make_directory(alias, 0755, FILEUTILS_RECUR);
90                 *dest = '/';
91                 if (dest[1] == '\0') { /* ">bar/" => ">bar/device_name" */
92                         dest = alias;
93                         alias = concat_path_file(alias, device_name);
94                         free(dest);
95                 }
96         }
97
98         return alias;
99 }
100
101 /* mknod in /dev based on a path like "/sys/block/hda/hda1"
102  * NB1: path parameter needs to have SCRATCH_SIZE scratch bytes
103  * after NUL, but we promise to not mangle (IOW: to restore if needed)
104  * path string.
105  * NB2: "mdev -s" may call us many times, do not leak memory/fds!
106  */
107 static void make_device(char *path, int delete)
108 {
109         char *device_name, *subsystem_slash_devname;
110         int major, minor, type, len;
111         mode_t mode;
112         parser_t *parser;
113
114         /* Try to read major/minor string.  Note that the kernel puts \n after
115          * the data, so we don't need to worry about null terminating the string
116          * because sscanf() will stop at the first nondigit, which \n is.
117          * We also depend on path having writeable space after it.
118          */
119         major = -1;
120         if (!delete) {
121                 char *dev_maj_min = path + strlen(path);
122
123                 strcpy(dev_maj_min, "/dev");
124                 len = open_read_close(path, dev_maj_min + 1, 64);
125                 *dev_maj_min = '\0';
126                 if (len < 1) {
127                         if (!ENABLE_FEATURE_MDEV_EXEC)
128                                 return;
129                         /* no "dev" file, but we can still run scripts
130                          * based on device name */
131                 } else if (sscanf(++dev_maj_min, "%u:%u", &major, &minor) != 2) {
132                         major = -1;
133                 }
134         }
135
136         /* Determine device name, type, major and minor */
137         device_name = (char*) bb_basename(path);
138         /* http://kernel.org/doc/pending/hotplug.txt says that only
139          * "/sys/block/..." is for block devices. "/sys/bus" etc is not.
140          * But since 2.6.25 block devices are also in /sys/class/block.
141          * We use strstr("/block/") to forestall future surprises. */
142         type = S_IFCHR;
143         if (strstr(path, "/block/") || (G.subsystem && strncmp(G.subsystem, "block", 5) == 0))
144                 type = S_IFBLK;
145
146         /* Make path point to "subsystem/device_name" */
147         subsystem_slash_devname = NULL;
148         /* Check for coldplug invocations first */
149         if (strncmp(path, "/sys/block/", 11) == 0) /* legacy case */
150                 path += sizeof("/sys/") - 1;
151         else if (strncmp(path, "/sys/class/", 11) == 0)
152                 path += sizeof("/sys/class/") - 1;
153         else {
154                 /* Example of a hotplug invocation:
155                  * SUBSYSTEM="block"
156                  * DEVPATH="/sys" + "/devices/virtual/mtd/mtd3/mtdblock3"
157                  * ("/sys" is added by mdev_main)
158                  * - path does not contain subsystem
159                  */
160                 subsystem_slash_devname = concat_path_file(G.subsystem, device_name);
161                 path = subsystem_slash_devname;
162         }
163
164         /* If we have config file, look up user settings */
165         if (ENABLE_FEATURE_MDEV_CONF)
166                 parser = config_open2("/etc/mdev.conf", fopen_for_read);
167
168         do {
169                 int keep_matching;
170                 struct bb_uidgid_t ugid;
171                 char *tokens[4];
172                 char *command = NULL;
173                 char *alias = NULL;
174                 char aliaslink = aliaslink; /* for compiler */
175
176                 /* Defaults in case we won't match any line */
177                 ugid.uid = ugid.gid = 0;
178                 keep_matching = 0;
179                 mode = 0660;
180
181                 if (ENABLE_FEATURE_MDEV_CONF
182                  && config_read(parser, tokens, 4, 3, "# \t", PARSE_NORMAL)
183                 ) {
184                         char *val;
185                         char *str_to_match;
186                         regmatch_t off[1 + 9 * ENABLE_FEATURE_MDEV_RENAME_REGEXP];
187
188                         val = tokens[0];
189                         keep_matching = ('-' == val[0]);
190                         val += keep_matching; /* swallow leading dash */
191
192                         /* Match against either "subsystem/device_name"
193                          * or "device_name" alone */
194                         str_to_match = strchr(val, '/') ? path : device_name;
195
196                         /* Fields: regex uid:gid mode [alias] [cmd] */
197
198                         if (val[0] == '@') {
199                                 /* @major,minor[-minor2] */
200                                 /* (useful when name is ambiguous:
201                                  * "/sys/class/usb/lp0" and
202                                  * "/sys/class/printer/lp0") */
203                                 int cmaj, cmin0, cmin1, sc;
204                                 if (major < 0)
205                                         continue; /* no dev, no match */
206                                 sc = sscanf(val, "@%u,%u-%u", &cmaj, &cmin0, &cmin1);
207                                 if (sc < 1 || major != cmaj
208                                  || (sc == 2 && minor != cmin0)
209                                  || (sc == 3 && (minor < cmin0 || minor > cmin1))
210                                 ) {
211                                         continue; /* this line doesn't match */
212                                 }
213                                 goto line_matches;
214                         }
215                         if (val[0] == '$') {
216                                 /* regex to match an environment variable */
217                                 char *eq = strchr(++val, '=');
218                                 if (!eq)
219                                         continue;
220                                 *eq = '\0';
221                                 str_to_match = getenv(val);
222                                 if (!str_to_match)
223                                         continue;
224                                 str_to_match -= strlen(val) + 1;
225                                 *eq = '=';
226                         }
227                         /* else: regex to match [subsystem/]device_name */
228
229                         {
230                                 regex_t match;
231                                 int result;
232
233                                 xregcomp(&match, val, REG_EXTENDED);
234                                 result = regexec(&match, str_to_match, ARRAY_SIZE(off), off, 0);
235                                 regfree(&match);
236                                 //bb_error_msg("matches:");
237                                 //for (int i = 0; i < ARRAY_SIZE(off); i++) {
238                                 //      if (off[i].rm_so < 0) continue;
239                                 //      bb_error_msg("match %d: '%.*s'\n", i,
240                                 //              (int)(off[i].rm_eo - off[i].rm_so),
241                                 //              device_name + off[i].rm_so);
242                                 //}
243
244                                 /* If no match, skip rest of line */
245                                 /* (regexec returns whole pattern as "range" 0) */
246                                 if (result || off[0].rm_so
247                                  || ((int)off[0].rm_eo != (int)strlen(str_to_match))
248                                 ) {
249                                         continue; /* this line doesn't match */
250                                 }
251                         }
252  line_matches:
253                         /* This line matches. Stop parsing after parsing
254                          * the rest the line unless keep_matching == 1 */
255
256                         /* 2nd field: uid:gid - device ownership */
257                         if (get_uidgid(&ugid, tokens[1], 1) == 0)
258                                 bb_error_msg("unknown user/group %s on line %d", tokens[1], parser->lineno);
259
260                         /* 3rd field: mode - device permissions */
261                         /* mode = strtoul(tokens[2], NULL, 8); */
262                         bb_parse_mode(tokens[2], &mode);
263
264                         val = tokens[3];
265                         /* 4th field (opt): >|=alias */
266
267                         if (ENABLE_FEATURE_MDEV_RENAME && val) {
268                                 aliaslink = val[0];
269                                 if (aliaslink == '>' || aliaslink == '=') {
270                                         char *a, *s, *st;
271                                         char *p;
272                                         unsigned i, n;
273
274                                         a = val;
275                                         s = strchrnul(val, ' ');
276                                         st = strchrnul(val, '\t');
277                                         if (st < s)
278                                                 s = st;
279                                         val = (s[0] && s[1]) ? s+1 : NULL;
280                                         s[0] = '\0';
281
282                                         if (ENABLE_FEATURE_MDEV_RENAME_REGEXP) {
283                                                 /* substitute %1..9 with off[1..9], if any */
284                                                 n = 0;
285                                                 s = a;
286                                                 while (*s)
287                                                         if (*s++ == '%')
288                                                                 n++;
289
290                                                 p = alias = xzalloc(strlen(a) + n * strlen(str_to_match));
291                                                 s = a + 1;
292                                                 while (*s) {
293                                                         *p = *s;
294                                                         if ('%' == *s) {
295                                                                 i = (s[1] - '0');
296                                                                 if (i <= 9 && off[i].rm_so >= 0) {
297                                                                         n = off[i].rm_eo - off[i].rm_so;
298                                                                         strncpy(p, str_to_match + off[i].rm_so, n);
299                                                                         p += n - 1;
300                                                                         s++;
301                                                                 }
302                                                         }
303                                                         p++;
304                                                         s++;
305                                                 }
306                                         } else {
307                                                 alias = xstrdup(a + 1);
308                                         }
309                                 }
310                         }
311
312                         if (ENABLE_FEATURE_MDEV_EXEC && val) {
313                                 const char *s = "$@*";
314                                 const char *s2 = strchr(s, val[0]);
315
316                                 if (!s2) {
317                                         bb_error_msg("bad line %u", parser->lineno);
318                                         if (ENABLE_FEATURE_MDEV_RENAME)
319                                                 free(alias);
320                                         continue;
321                                 }
322
323                                 /* Are we running this command now?
324                                  * Run $cmd on delete, @cmd on create, *cmd on both
325                                  */
326                                 if (s2-s != delete)
327                                         command = xstrdup(val + 1);
328                         }
329                 }
330
331                 /* End of field parsing */
332
333                 /* "Execute" the line we found */
334                 {
335                         const char *node_name;
336
337                         node_name = device_name;
338                         if (ENABLE_FEATURE_MDEV_RENAME && alias)
339                                 node_name = alias = build_alias(alias, device_name);
340
341                         if (!delete && major >= 0) {
342                                 if (mknod(node_name, mode | type, makedev(major, minor)) && errno != EEXIST)
343                                         bb_perror_msg("can't create %s", node_name);
344                                 if (major == G.root_major && minor == G.root_minor)
345                                         symlink(node_name, "root");
346                                 if (ENABLE_FEATURE_MDEV_CONF) {
347                                         chmod(node_name, mode);
348                                         chown(node_name, ugid.uid, ugid.gid);
349                                 }
350                                 if (ENABLE_FEATURE_MDEV_RENAME && alias) {
351                                         if (aliaslink == '>')
352                                                 symlink(node_name, device_name);
353                                 }
354                         }
355
356                         if (ENABLE_FEATURE_MDEV_EXEC && command) {
357                                 /* setenv will leak memory, use putenv/unsetenv/free */
358                                 char *s = xasprintf("%s=%s", "MDEV", node_name);
359                                 char *s1 = xasprintf("%s=%s", "SUBSYSTEM", G.subsystem);
360                                 putenv(s);
361                                 putenv(s1);
362                                 if (system(command) == -1)
363                                         bb_perror_msg("can't run '%s'", command);
364                                 unsetenv("SUBSYSTEM");
365                                 free(s1);
366                                 unsetenv("MDEV");
367                                 free(s);
368                                 free(command);
369                         }
370
371                         if (delete) {
372                                 if (ENABLE_FEATURE_MDEV_RENAME && alias) {
373                                         if (aliaslink == '>')
374                                                 unlink(device_name);
375                                 }
376                                 unlink(node_name);
377                         }
378
379                         if (ENABLE_FEATURE_MDEV_RENAME)
380                                 free(alias);
381                 }
382
383                 /* We found matching line.
384                  * Stop unless it was prefixed with '-' */
385                 if (ENABLE_FEATURE_MDEV_CONF && !keep_matching)
386                         break;
387
388         /* end of "while line is read from /etc/mdev.conf" */
389         } while (ENABLE_FEATURE_MDEV_CONF);
390
391         if (ENABLE_FEATURE_MDEV_CONF)
392                 config_close(parser);
393         free(subsystem_slash_devname);
394 }
395
396 /* File callback for /sys/ traversal */
397 static int FAST_FUNC fileAction(const char *fileName,
398                 struct stat *statbuf UNUSED_PARAM,
399                 void *userData,
400                 int depth UNUSED_PARAM)
401 {
402         size_t len = strlen(fileName) - 4; /* can't underflow */
403         char *scratch = userData;
404
405         /* len check is for paranoid reasons */
406         if (strcmp(fileName + len, "/dev") != 0 || len >= PATH_MAX)
407                 return FALSE;
408
409         strcpy(scratch, fileName);
410         scratch[len] = '\0';
411         make_device(scratch, /*delete:*/ 0);
412
413         return TRUE;
414 }
415
416 /* Directory callback for /sys/ traversal */
417 static int FAST_FUNC dirAction(const char *fileName UNUSED_PARAM,
418                 struct stat *statbuf UNUSED_PARAM,
419                 void *userData UNUSED_PARAM,
420                 int depth)
421 {
422         /* Extract device subsystem -- the name of the directory
423          * under /sys/class/ */
424         if (1 == depth) {
425                 free(G.subsystem);
426                 G.subsystem = strrchr(fileName, '/');
427                 if (G.subsystem)
428                         G.subsystem = xstrdup(G.subsystem + 1);
429         }
430
431         return (depth >= MAX_SYSFS_DEPTH ? SKIP : TRUE);
432 }
433
434 /* For the full gory details, see linux/Documentation/firmware_class/README
435  *
436  * Firmware loading works like this:
437  * - kernel sets FIRMWARE env var
438  * - userspace checks /lib/firmware/$FIRMWARE
439  * - userspace waits for /sys/$DEVPATH/loading to appear
440  * - userspace writes "1" to /sys/$DEVPATH/loading
441  * - userspace copies /lib/firmware/$FIRMWARE into /sys/$DEVPATH/data
442  * - userspace writes "0" (worked) or "-1" (failed) to /sys/$DEVPATH/loading
443  * - kernel loads firmware into device
444  */
445 static void load_firmware(const char *firmware, const char *sysfs_path)
446 {
447         int cnt;
448         int firmware_fd, loading_fd, data_fd;
449
450         /* check for /lib/firmware/$FIRMWARE */
451         xchdir("/lib/firmware");
452         firmware_fd = xopen(firmware, O_RDONLY);
453
454         /* in case we goto out ... */
455         data_fd = -1;
456
457         /* check for /sys/$DEVPATH/loading ... give 30 seconds to appear */
458         xchdir(sysfs_path);
459         for (cnt = 0; cnt < 30; ++cnt) {
460                 loading_fd = open("loading", O_WRONLY);
461                 if (loading_fd != -1)
462                         goto loading;
463                 sleep(1);
464         }
465         goto out;
466
467  loading:
468         /* tell kernel we're loading by "echo 1 > /sys/$DEVPATH/loading" */
469         if (full_write(loading_fd, "1", 1) != 1)
470                 goto out;
471
472         /* load firmware into /sys/$DEVPATH/data */
473         data_fd = open("data", O_WRONLY);
474         if (data_fd == -1)
475                 goto out;
476         cnt = bb_copyfd_eof(firmware_fd, data_fd);
477
478         /* tell kernel result by "echo [0|-1] > /sys/$DEVPATH/loading" */
479         if (cnt > 0)
480                 full_write(loading_fd, "0", 1);
481         else
482                 full_write(loading_fd, "-1", 2);
483
484  out:
485         if (ENABLE_FEATURE_CLEAN_UP) {
486                 close(firmware_fd);
487                 close(loading_fd);
488                 close(data_fd);
489         }
490 }
491
492 int mdev_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
493 int mdev_main(int argc UNUSED_PARAM, char **argv)
494 {
495         RESERVE_CONFIG_BUFFER(temp, PATH_MAX + SCRATCH_SIZE);
496
497         /* We can be called as hotplug helper */
498         /* Kernel cannot provide suitable stdio fds for us, do it ourself */
499         bb_sanitize_stdio();
500
501         /* Force the configuration file settings exactly */
502         umask(0);
503
504         xchdir("/dev");
505
506         if (argv[1] && strcmp(argv[1], "-s") == 0) {
507                 /* Scan:
508                  * mdev -s
509                  */
510                 struct stat st;
511
512                 xstat("/", &st);
513                 G.root_major = major(st.st_dev);
514                 G.root_minor = minor(st.st_dev);
515
516                 /* ACTION_FOLLOWLINKS is needed since in newer kernels
517                  * /sys/block/loop* (for example) are symlinks to dirs,
518                  * not real directories.
519                  * (kernel's CONFIG_SYSFS_DEPRECATED makes them real dirs,
520                  * but we can't enforce that on users)
521                  */
522                 if (access("/sys/class/block", F_OK) != 0) {
523                         /* Scan obsolete /sys/block only if /sys/class/block
524                          * doesn't exist. Otherwise we'll have dupes.
525                          * Also, do not complain if it doesn't exist.
526                          * Some people configure kernel to have no blockdevs.
527                          */
528                         recursive_action("/sys/block",
529                                 ACTION_RECURSE | ACTION_FOLLOWLINKS | ACTION_QUIET,
530                                 fileAction, dirAction, temp, 0);
531                 }
532                 recursive_action("/sys/class",
533                         ACTION_RECURSE | ACTION_FOLLOWLINKS,
534                         fileAction, dirAction, temp, 0);
535         } else {
536                 char *fw;
537                 char *seq;
538                 char *action;
539                 char *env_path;
540                 static const char keywords[] ALIGN1 = "remove\0add\0";
541                 enum { OP_remove = 0, OP_add };
542                 smalluint op;
543
544                 /* Hotplug:
545                  * env ACTION=... DEVPATH=... SUBSYSTEM=... [SEQNUM=...] mdev
546                  * ACTION can be "add" or "remove"
547                  * DEVPATH is like "/block/sda" or "/class/input/mice"
548                  */
549                 action = getenv("ACTION");
550                 env_path = getenv("DEVPATH");
551                 G.subsystem = getenv("SUBSYSTEM");
552                 if (!action || !env_path /*|| !G.subsystem*/)
553                         bb_show_usage();
554                 fw = getenv("FIRMWARE");
555                 op = index_in_strings(keywords, action);
556                 /* If it exists, does /dev/mdev.seq match $SEQNUM?
557                  * If it does not match, earlier mdev is running
558                  * in parallel, and we need to wait */
559                 seq = getenv("SEQNUM");
560                 if (seq) {
561                         int timeout = 2000 / 32; /* 2000 msec */
562                         do {
563                                 int seqlen;
564                                 char seqbuf[sizeof(int)*3 + 2];
565
566                                 seqlen = open_read_close("mdev.seq", seqbuf, sizeof(seqbuf-1));
567                                 if (seqlen < 0) {
568                                         seq = NULL;
569                                         break;
570                                 }
571                                 seqbuf[seqlen] = '\0';
572                                 if (seqbuf[0] == '\n' /* seed file? */
573                                  || strcmp(seq, seqbuf) == 0 /* correct idx? */
574                                 ) {
575                                         break;
576                                 }
577                                 usleep(32*1000);
578                         } while (--timeout);
579                 }
580
581                 snprintf(temp, PATH_MAX, "/sys%s", env_path);
582                 if (op == OP_remove) {
583                         /* Ignoring "remove firmware". It was reported
584                          * to happen and to cause erroneous deletion
585                          * of device nodes. */
586                         if (!fw)
587                                 make_device(temp, /*delete:*/ 1);
588                 }
589                 else if (op == OP_add) {
590                         make_device(temp, /*delete:*/ 0);
591                         if (ENABLE_FEATURE_MDEV_LOAD_FIRMWARE) {
592                                 if (fw)
593                                         load_firmware(fw, temp);
594                         }
595                 }
596
597                 if (seq) {
598                         xopen_xwrite_close("mdev.seq", utoa(xatou(seq) + 1));
599                 }
600         }
601
602         if (ENABLE_FEATURE_CLEAN_UP)
603                 RELEASE_CONFIG_BUFFER(temp);
604
605         return EXIT_SUCCESS;
606 }