Comment and whitespace tweaks.
[oweals/busybox.git] / util-linux / mdev.c
index c8d603bcfcc9875bab68d3a4f5beca7c5d479bfc..5ac8015551c6ebb4a299065487d7428cf84be7a7 100644 (file)
@@ -19,20 +19,37 @@ struct globals {
 #define root_major (G.root_major)
 #define root_minor (G.root_minor)
 
-#define MAX_SYSFS_DEPTH 3 /* prevent infinite loops in /sys symlinks */
+/* Prevent infinite loops in /sys symlinks */
+#define MAX_SYSFS_DEPTH 3
 
 /* We use additional 64+ bytes in make_device() */
 #define SCRATCH_SIZE 80
 
-static char *next_field(char *s)
+#if ENABLE_FEATURE_MDEV_RENAME
+/* Builds an alias path.
+ * This function potentionally reallocates the alias parameter.
+ */
+static char *build_alias(char *alias, const char *device_name)
 {
-       char *end = skip_non_whitespace(s);
-       s = skip_whitespace(end);
-       *end = '\0';
-       if (*s == '\0')
-               s = NULL;
-       return s;
+       char *dest;
+
+       /* ">bar/": rename to bar/device_name */
+       /* ">bar[/]baz": rename to bar[/]baz */
+       dest = strrchr(alias, '/');
+       if (dest) { /* ">bar/[baz]" ? */
+               *dest = '\0'; /* mkdir bar */
+               bb_make_directory(alias, 0755, FILEUTILS_RECUR);
+               *dest = '/';
+               if (dest[1] == '\0') { /* ">bar/" => ">bar/device_name" */
+                       dest = alias;
+                       alias = concat_path_file(alias, device_name);
+                       free(dest);
+               }
+       }
+
+       return alias;
 }
+#endif
 
 /* mknod in /dev based on a path like "/sys/block/hda/hda1" */
 /* NB: "mdev -s" may call us many times, do not leak memory/fds! */
@@ -41,20 +58,29 @@ static void make_device(char *path, int delete)
        const char *device_name;
        int major, minor, type, len;
        int mode = 0660;
-       uid_t uid = 0;
-       gid_t gid = 0;
-       char *dev_maj_min = path + strlen(path);
+#if ENABLE_FEATURE_MDEV_CONF
+       struct bb_uidgid_t ugid = { 0, 0 };
+       parser_t *parser;
+       char *tokens[5];
+#endif
+#if ENABLE_FEATURE_MDEV_EXEC
        char *command = NULL;
+#endif
+#if ENABLE_FEATURE_MDEV_RENAME
        char *alias = NULL;
+       char aliaslink = aliaslink; /* for compiler */
+#endif
+       char *dev_maj_min = path + strlen(path);
 
        /* Force the configuration file settings exactly. */
        umask(0);
 
        /* Try to read major/minor string.  Note that the kernel puts \n after
         * the data, so we don't need to worry about null terminating the string
-        * because sscanf() will stop at the first nondigit, which \n is.  We
-        * also depend on path having writeable space after it.
+        * because sscanf() will stop at the first nondigit, which \n is.
+        * We also depend on path having writeable space after it.
         */
+       major = -1;
        if (!delete) {
                strcpy(dev_maj_min, "/dev");
                len = open_read_close(path, dev_maj_min + 1, 64);
@@ -64,131 +90,157 @@ static void make_device(char *path, int delete)
                                return;
                        /* no "dev" file, so just try to run script */
                        *dev_maj_min = '\0';
+               } else if (sscanf(dev_maj_min, "%u:%u", &major, &minor) != 2) {
+                       major = -1;
                }
        }
 
        /* Determine device name, type, major and minor */
        device_name = bb_basename(path);
        /* http://kernel.org/doc/pending/hotplug.txt says that only
-        * "/sys/block/..." is for block devices. "sys/bus" etc is not! */
-       type = (strncmp(&path[5], "block/", 6) == 0 ? S_IFBLK : S_IFCHR);
-
-       if (ENABLE_FEATURE_MDEV_CONF) {
-               FILE *fp;
-               char *line, *val, *next;
-               unsigned lineno = 0;
-
-               /* If we have config file, look up user settings */
-               fp = fopen_or_warn("/etc/mdev.conf", "r");
-               if (!fp)
-                       goto end_parse;
-
-               while ((line = xmalloc_fgetline(fp)) != NULL) {
-                       ++lineno;
-                       trim(line);
-                       if (!line[0])
-                               goto next_line;
-
-                       /* Fields: regex uid:gid mode [alias] [cmd] */
-
-                       /* 1st field: regex to match this device */
-                       next = next_field(line);
-                       {
-                               regex_t match;
-                               regmatch_t off;
-                               int result;
-
-                               /* Is this it? */
-                               xregcomp(&match, line, REG_EXTENDED);
-                               result = regexec(&match, device_name, 1, &off, 0);
-                               regfree(&match);
-
-                               /* If not this device, skip rest of line */
-                               if (result || off.rm_so || off.rm_eo != strlen(device_name))
-                                       goto next_line;
+        * "/sys/block/..." is for block devices. "/sys/bus" etc is not.
+        * But since 2.6.25 block devices are also in /sys/class/block.
+        * We use strstr("/block/") to forestall future surprises. */
+        type = S_IFCHR;
+       if (strstr(path, "/block/"))
+               type = S_IFBLK;
+
+#if ENABLE_FEATURE_MDEV_CONF
+       parser = config_open2("/etc/mdev.conf", fopen_for_read);
+
+       /* If we have config file, look up user settings */
+       while (config_read(parser, tokens, 4, 3, "# \t", PARSE_NORMAL)) {
+               regmatch_t off[1 + 9*ENABLE_FEATURE_MDEV_RENAME_REGEXP];
+               char *val;
+
+               /* Fields: regex uid:gid mode [alias] [cmd] */
+
+               /* 1st field: @<numeric maj,min>... */
+               if (tokens[0][0] == '@') {
+                       /* @major,minor[-last] */
+                       /* (useful when name is ambiguous:
+                        * "/sys/class/usb/lp0" and
+                        * "/sys/class/printer/lp0") */
+                       int cmaj, cmin0, cmin1, sc;
+                       if (major < 0)
+                               continue; /* no dev, no match */
+                       sc = sscanf(tokens[0], "@%u,%u-%u", &cmaj, &cmin0, &cmin1);
+                       if (sc < 1 || major != cmaj
+                        || (sc == 2 && minor != cmin0)
+                        || (sc == 3 && (minor < cmin0 || minor > cmin1))
+                       ) {
+                               continue; /* no match */
                        }
-
-                       /* This line matches: stop parsing the file
-                        * after parsing the rest of fields */
-
-                       /* 2nd field: uid:gid - device ownership */
-                       if (!next) /* field must exist */
-                               bb_error_msg_and_die("bad line %u", lineno);
-                       val = next;
-                       next = next_field(val);
-                       {
-                               struct passwd *pass;
-                               struct group *grp;
-                               char *str_uid = val;
-                               char *str_gid = strchrnul(val, ':');
-
-                               if (*str_gid)
-                                       *str_gid++ = '\0';
-                               /* Parse UID */
-                               pass = getpwnam(str_uid);
-                               if (pass)
-                                       uid = pass->pw_uid;
-                               else
-                                       uid = strtoul(str_uid, NULL, 10);
-                               /* Parse GID */
-                               grp = getgrnam(str_gid);
-                               if (grp)
-                                       gid = grp->gr_gid;
-                               else
-                                       gid = strtoul(str_gid, NULL, 10);
+               } else { /* ... or regex to match device name */
+                       regex_t match;
+                       int result;
+
+                       /* Is this it? */
+                       xregcomp(&match, tokens[0], REG_EXTENDED);
+                       result = regexec(&match, device_name, ARRAY_SIZE(off), off, 0);
+                       regfree(&match);
+
+                       //bb_error_msg("matches:");
+                       //for (int i = 0; i < ARRAY_SIZE(off); i++) {
+                       //      if (off[i].rm_so < 0) continue;
+                       //      bb_error_msg("match %d: '%.*s'\n", i,
+                       //              (int)(off[i].rm_eo - off[i].rm_so),
+                       //              device_name + off[i].rm_so);
+                       //}
+
+                       /* If not this device, skip rest of line */
+                       /* (regexec returns whole pattern as "range" 0) */
+                       if (result || off[0].rm_so
+                        || ((int)off[0].rm_eo != (int)strlen(device_name))
+                       ) {
+                               continue;
                        }
+               }
 
-                       /* 3rd field: mode - device permissions */
-                       if (!next) /* field must exist */
-                               bb_error_msg_and_die("bad line %u", lineno);
-                       val = next;
-                       next = next_field(val);
-                       mode = strtoul(val, NULL, 8);
-
-                       /* 4th field (opt): >alias */
-                       if (ENABLE_FEATURE_MDEV_RENAME) {
-                               if (!next)
-                                       break;
-                               val = next;
-                               next = next_field(val);
-                               if (*val == '>') {
-                                       alias = xstrdup(val + 1);
+               /* This line matches: stop parsing the file
+                * after parsing the rest of fields */
+
+               /* 2nd field: uid:gid - device ownership */
+               parse_chown_usergroup_or_die(&ugid, tokens[1]);
+
+               /* 3rd field: mode - device permissions */
+               mode = strtoul(tokens[2], NULL, 8);
+
+               val = tokens[3];
+               /* 4th field (opt): >alias */
+#if ENABLE_FEATURE_MDEV_RENAME
+               if (!val)
+                       break;
+               aliaslink = *val;
+               if (aliaslink == '>' || aliaslink == '=') {
+                       char *s;
+#if ENABLE_FEATURE_MDEV_RENAME_REGEXP
+                       char *p;
+                       unsigned i, n;
+#endif
+                       char *a = val;
+                       s = strchr(val, ' ');
+                       val = (s && s[1]) ? s+1 : NULL;
+#if ENABLE_FEATURE_MDEV_RENAME_REGEXP
+                       /* substitute %1..9 with off[1..9], if any */
+                       n = 0;
+                       s = a;
+                       while (*s)
+                               if (*s++ == '%')
+                                       n++;
+
+                       p = alias = xzalloc(strlen(a) + n * strlen(device_name));
+                       s = a + 1;
+                       while (*s) {
+                               *p = *s;
+                               if ('%' == *s) {
+                                       i = (s[1] - '0');
+                                       if (i <= 9 && off[i].rm_so >= 0) {
+                                               n = off[i].rm_eo - off[i].rm_so;
+                                               strncpy(p, device_name + off[i].rm_so, n);
+                                               p += n - 1;
+                                               s++;
+                                       }
                                }
+                               p++;
+                               s++;
                        }
-
-                       /* The rest (opt): command to run */
-                       if (!next)
-                               break;
-                       val = next;
-                       if (ENABLE_FEATURE_MDEV_EXEC) {
-                               const char *s = "@$*";
-                               const char *s2 = strchr(s, *val);
-
-                               if (!s2)
-                                       bb_error_msg_and_die("bad line %u", lineno);
-
-                               /* Correlate the position in the "@$*" with the delete
-                                * step so that we get the proper behavior:
-                                * @cmd: run on create
-                                * $cmd: run on delete
-                                * *cmd: run on both
-                                */
-                               if ((s2 - s + 1) /*1/2/3*/ & /*1/2*/ (1 + delete)) {
-                                       command = xstrdup(val + 1);
-                               }
+#else
+                       alias = xstrdup(a + 1);
+#endif
+               }
+#endif /* ENABLE_FEATURE_MDEV_RENAME */
+
+#if ENABLE_FEATURE_MDEV_EXEC
+               /* The rest (opt): command to run */
+               if (!val)
+                       break;
+               {
+                       const char *s = "@$*";
+                       const char *s2 = strchr(s, *val);
+
+                       if (!s2)
+                               bb_error_msg_and_die("bad line %u", parser->lineno);
+
+                       /* Correlate the position in the "@$*" with the delete
+                        * step so that we get the proper behavior:
+                        * @cmd: run on create
+                        * $cmd: run on delete
+                        * *cmd: run on both
+                        */
+                       if ((s2 - s + 1) /*1/2/3*/ & /*1/2*/ (1 + delete)) {
+                               command = xstrdup(val + 1);
                        }
-                       /* end of field parsing */
-                       break; /* we found matching line, stop */
- next_line:
-                       free(line);
-               } /* end of "while line is read from /etc/mdev.conf" */
-
-               free(line); /* in case we used "break" to get here */
-               fclose(fp);
-       }
- end_parse:
+               }
+#endif
+               /* end of field parsing */
+               break; /* we found matching line, stop */
+       } /* end of "while line is read from /etc/mdev.conf" */
 
-       if (!delete && sscanf(dev_maj_min, "%u:%u", &major, &minor) == 2) {
+       config_close(parser);
+#endif /* ENABLE_FEATURE_MDEV_CONF */
+
+       if (!delete && major >= 0) {
 
                if (ENABLE_FEATURE_MDEV_RENAME)
                        unlink(device_name);
@@ -199,37 +251,26 @@ static void make_device(char *path, int delete)
                if (major == root_major && minor == root_minor)
                        symlink(device_name, "root");
 
-               if (ENABLE_FEATURE_MDEV_CONF) {
-                       chown(device_name, uid, gid);
-
-                       if (ENABLE_FEATURE_MDEV_RENAME && alias) {
-                               char *dest;
-
-                               /* ">bar/": rename to bar/device_name */
-                               /* ">bar[/]baz": rename to bar[/]baz */
-                               dest = strrchr(alias, '/');
-                               if (dest) { /* ">bar/[baz]" ? */
-                                       *dest = '\0'; /* mkdir bar */
-                                       bb_make_directory(alias, 0755, FILEUTILS_RECUR);
-                                       *dest = '/';
-                                       if (dest[1] == '\0') { /* ">bar/" => ">bar/device_name" */
-                                               dest = alias;
-                                               alias = concat_path_file(alias, device_name);
-                                               free(dest);
-                                       }
-                               }
+#if ENABLE_FEATURE_MDEV_CONF
+               chown(device_name, ugid.uid, ugid.gid);
 
-                               /* recreate device_name as a symlink to moved device node */
-                               if (rename(device_name, alias) == 0) {
-                                       symlink(alias, device_name);
-                               }
+#if ENABLE_FEATURE_MDEV_RENAME
+               if (alias) {
+                       alias = build_alias(alias, device_name);
 
-                               free(alias);
-                       }
+                       /* move the device, and optionally
+                        * make a symlink to moved device node */
+                       if (rename(device_name, alias) == 0 && aliaslink == '>')
+                               symlink(alias, device_name);
+
+                       free(alias);
                }
+#endif
+#endif
        }
 
-       if (ENABLE_FEATURE_MDEV_EXEC && command) {
+#if ENABLE_FEATURE_MDEV_EXEC
+       if (command) {
                /* setenv will leak memory, use putenv/unsetenv/free */
                char *s = xasprintf("MDEV=%s", device_name);
                putenv(s);
@@ -240,22 +281,33 @@ static void make_device(char *path, int delete)
                free(s);
                free(command);
        }
+#endif
 
-       if (delete)
+       if (delete) {
                unlink(device_name);
+               /* At creation time, device might have been moved
+                * and a symlink might have been created. Undo that. */
+#if ENABLE_FEATURE_MDEV_RENAME
+               if (alias) {
+                       alias = build_alias(alias, device_name);
+                       unlink(alias);
+                       free(alias);
+               }
+#endif
+       }
 }
 
 /* File callback for /sys/ traversal */
-static int fileAction(const char *fileName,
-                      struct stat *statbuf ATTRIBUTE_UNUSED,
-                      void *userData,
-                      int depth ATTRIBUTE_UNUSED)
+static int FAST_FUNC fileAction(const char *fileName,
+               struct stat *statbuf UNUSED_PARAM,
+               void *userData,
+               int depth UNUSED_PARAM)
 {
        size_t len = strlen(fileName) - 4; /* can't underflow */
        char *scratch = userData;
 
        /* len check is for paranoid reasons */
-       if (strcmp(fileName + len, "/dev") || len >= PATH_MAX)
+       if (strcmp(fileName + len, "/dev") != 0 || len >= PATH_MAX)
                return FALSE;
 
        strcpy(scratch, fileName);
@@ -266,10 +318,10 @@ static int fileAction(const char *fileName,
 }
 
 /* Directory callback for /sys/ traversal */
-static int dirAction(const char *fileName ATTRIBUTE_UNUSED,
-                      struct stat *statbuf ATTRIBUTE_UNUSED,
-                      void *userData ATTRIBUTE_UNUSED,
-                      int depth)
+static int FAST_FUNC dirAction(const char *fileName UNUSED_PARAM,
+               struct stat *statbuf UNUSED_PARAM,
+               void *userData UNUSED_PARAM,
+               int depth)
 {
        return (depth >= MAX_SYSFS_DEPTH ? SKIP : TRUE);
 }
@@ -333,15 +385,28 @@ static void load_firmware(const char *const firmware, const char *const sysfs_pa
 }
 
 int mdev_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
-int mdev_main(int argc, char **argv)
+int mdev_main(int argc UNUSED_PARAM, char **argv)
 {
-       char *action;
-       char *env_path;
        RESERVE_CONFIG_BUFFER(temp, PATH_MAX + SCRATCH_SIZE);
 
+       /* We can be called as hotplug helper */
+       /* Kernel cannot provide suitable stdio fds for us, do it ourself */
+#if 1
+       bb_sanitize_stdio();
+#else
+       /* Debug code */
+       /* Replace LOGFILE by other file or device name if you need */
+#define LOGFILE "/dev/console"
+       /* Just making sure fd 0 is not closed,
+        * we don't really intend to read from it */
+       xmove_fd(xopen("/", O_RDONLY), STDIN_FILENO);
+       xmove_fd(xopen(LOGFILE, O_WRONLY|O_APPEND), STDOUT_FILENO);
+       xmove_fd(xopen(LOGFILE, O_WRONLY|O_APPEND), STDERR_FILENO);
+#endif
+
        xchdir("/dev");
 
-       if (argc == 2 && !strcmp(argv[1], "-s")) {
+       if (argv[1] && !strcmp(argv[1], "-s")) {
                /* Scan:
                 * mdev -s
                 */
@@ -351,17 +416,26 @@ int mdev_main(int argc, char **argv)
                root_major = major(st.st_dev);
                root_minor = minor(st.st_dev);
 
+               /* ACTION_FOLLOWLINKS is needed since in newer kernels
+                * /sys/block/loop* (for example) are symlinks to dirs,
+                * not real directories.
+                * (kernel's CONFIG_SYSFS_DEPRECATED makes them real dirs,
+                * but we can't enforce that on users) */
                recursive_action("/sys/block",
                        ACTION_RECURSE | ACTION_FOLLOWLINKS,
                        fileAction, dirAction, temp, 0);
-
                recursive_action("/sys/class",
                        ACTION_RECURSE | ACTION_FOLLOWLINKS,
                        fileAction, dirAction, temp, 0);
-
        } else {
+               char *seq;
+               char *action;
+               char *env_path;
+               char seqbuf[sizeof(int)*3 + 2];
+               int seqlen = seqlen; /* for compiler */
+
                /* Hotplug:
-                * env ACTION=... DEVPATH=... mdev
+                * env ACTION=... DEVPATH=... [SEQNUM=...] mdev
                 * ACTION can be "add" or "remove"
                 * DEVPATH is like "/block/sda" or "/class/input/mice"
                 */
@@ -370,6 +444,23 @@ int mdev_main(int argc, char **argv)
                if (!action || !env_path)
                        bb_show_usage();
 
+               seq = getenv("SEQNUM");
+               if (seq) {
+                       int timeout = 2000 / 32;
+                       do {
+                               seqlen = open_read_close("mdev.seq", seqbuf, sizeof(seqbuf-1));
+                               if (seqlen < 0)
+                                       break;
+                               seqbuf[seqlen] = '\0';
+                               if (seqbuf[0] == '\n' /* seed file? */
+                                || strcmp(seq, seqbuf) == 0 /* correct idx? */
+                               ) {
+                                       break;
+                               }
+                               usleep(32*1000);
+                       } while (--timeout);
+               }
+
                snprintf(temp, PATH_MAX, "/sys%s", env_path);
                if (!strcmp(action, "remove"))
                        make_device(temp, 1);
@@ -382,6 +473,10 @@ int mdev_main(int argc, char **argv)
                                        load_firmware(fw, temp);
                        }
                }
+
+               if (seq && seqlen >= 0) {
+                       xopen_xwrite_close("mdev.seq", utoa(xatou(seq) + 1));
+               }
        }
 
        if (ENABLE_FEATURE_CLEAN_UP)