chiark / gitweb /
[PATCH] introduce OPTIONS=ignore_device, ignore_remove, all_partitions" key
[elogind.git] / namedev_parse.c
index 4b1377dc32a43b64f26b4cdee86afebdb055e7eb..981daa7b3b1d3e5e6a173c2e75e8b3d308d37ee3 100644 (file)
@@ -3,7 +3,8 @@
  *
  * Userspace devfs
  *
- * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
+ * Copyright (C) 2003,2004 Greg Kroah-Hartman <greg@kroah.com>
+ * Copyright (C) 2003-2005 Kay Sievers <kay.sievers@vrfy.org>
  *
  *
  *     This program is free software; you can redistribute it and/or modify it
  *
  */
 
-/* define this to enable parsing debugging */
+#ifdef DEBUG
+/* define this to enable parsing debugging also */
 /* #define DEBUG_PARSER */
+#endif
 
 #include <stddef.h>
 #include <stdlib.h>
 #include <string.h>
 #include <stdio.h>
-#include <fcntl.h>
 #include <ctype.h>
 #include <unistd.h>
+#include <sys/stat.h>
 #include <errno.h>
 
 #include "udev.h"
+#include "udev_utils.h"
+#include "logging.h"
 #include "namedev.h"
 
+LIST_HEAD(config_device_list);
+
 static int add_config_dev(struct config_device *new_dev)
 {
        struct config_device *tmp_dev;
@@ -49,70 +56,16 @@ static int add_config_dev(struct config_device *new_dev)
        return 0;
 }
 
-int get_pair(char **orig_string, char **left, char **right)
-{
-       char *temp;
-       char *string = *orig_string;
-
-       if (!string)
-               return -ENODEV;
-
-       /* eat any whitespace */
-       while (isspace(*string) || *string == ',')
-               ++string;
-
-       /* split based on '=' */
-       temp = strsep(&string, "=");
-       *left = temp;
-       if (!string)
-               return -ENODEV;
-
-       /* take the right side and strip off the '"' */
-       while (isspace(*string))
-               ++string;
-       if (*string == '"')
-               ++string;
-       else
-               return -ENODEV;
-
-       temp = strsep(&string, "\"");
-       if (!string || *temp == '\0')
-               return -ENODEV;
-       *right = temp;
-       *orig_string = string;
-       
-       return 0;
-}
-
 void dump_config_dev(struct config_device *dev)
 {
-       switch (dev->type) {
-       case KERNEL_NAME:
-               dbg_parse("KERNEL name='%s'", dev->name);
-               break;
-       case LABEL:
-               dbg_parse("LABEL name='%s', bus='%s', sysfs_file[0]='%s', sysfs_value[0]='%s'",
-                         dev->name, dev->bus, dev->sysfs_pair[0].file, dev->sysfs_pair[0].value);
-               break;
-       case NUMBER:
-               dbg_parse("NUMBER name='%s', bus='%s', id='%s'",
-                         dev->name, dev->bus, dev->id);
-               break;
-       case TOPOLOGY:
-               dbg_parse("TOPOLOGY name='%s', bus='%s', place='%s'",
-                         dev->name, dev->bus, dev->place);
-               break;
-       case REPLACE:
-               dbg_parse("REPLACE name='%s', kernel_name='%s'",
-                         dev->name, dev->kernel_name);
-               break;
-       case CALLOUT:
-               dbg_parse("CALLOUT name='%s', bus='%s', program='%s', id='%s'",
-                         dev->name, dev->bus, dev->exec_program, dev->id);
-               break;
-       default:
-               dbg_parse("unknown type of method");
-       }
+       dbg_parse("name='%s', symlink='%s', bus='%s', place='%s', id='%s', "
+                 "sysfs_file[0]='%s', sysfs_value[0]='%s', "
+                 "kernel='%s', program='%s', result='%s'"
+                 "owner='%s', group='%s', mode=%#o",
+                 dev->name, dev->symlink, dev->bus, dev->place, dev->id,
+                 dev->sysfs_pair[0].file, dev->sysfs_pair[0].value,
+                 dev->kernel, dev->program, dev->result,
+                 dev->owner, dev->group, dev->mode);
 }
 
 void dump_config_dev_list(void)
@@ -123,113 +76,116 @@ void dump_config_dev_list(void)
                dump_config_dev(dev);
 }
 
-void dump_perm_dev(struct perm_device *dev)
-{
-       dbg_parse("name='%s', owner='%s', group='%s', mode=%#o",
-                 dev->name, dev->owner, dev->group, dev->mode);
-}
-
-void dump_perm_dev_list(void)
+/* extract possible KEY{attr} */
+static char *get_key_attribute(char *str)
 {
-       struct perm_device *dev;
+       char *pos;
+       char *attr;
+
+       attr = strchr(str, '{');
+       if (attr != NULL) {
+               attr++;
+               pos = strchr(attr, '}');
+               if (pos == NULL) {
+                       dbg("missing closing brace for format");
+                       return NULL;
+               }
+               pos[0] = '\0';
+               dbg("attribute='%s'", attr);
+               return attr;
+       }
 
-       list_for_each_entry(dev, &perm_device_list, node)
-               dump_perm_dev(dev);
+       return NULL;
 }
 
-
-int namedev_init_rules(void)
+static int namedev_parse(const char *filename, void *data)
 {
-       char line[255];
+       char line[LINE_SIZE];
+       char *bufline;
        int lineno;
        char *temp;
        char *temp2;
        char *temp3;
-       FILE *fd;
+       char *attr;
+       char *buf;
+       size_t bufsize;
+       size_t cur;
+       size_t count;
+       int program_given = 0;
+       int valid;
        int retval = 0;
        struct config_device dev;
 
-       fd = fopen(udev_rules_filename, "r");
-       if (fd != NULL) {
-               dbg("reading '%s' as rules file", udev_rules_filename);
+       if (file_map(filename, &buf, &bufsize) == 0) {
+               dbg("reading '%s' as rules file", filename);
        } else {
-               dbg("can't open '%s' as a rules file", udev_rules_filename);
-               return -ENODEV;
+               dbg("can't open '%s' as rules file", filename);
+               return -1;
        }
 
        /* loop through the whole file */
+       cur = 0;
        lineno = 0;
-       while (1) {
-               /* get a line */
-               temp = fgets(line, sizeof(line), fd);
-               if (temp == NULL)
-                       goto exit;
-               lineno++;
-               dbg_parse("read '%s'", temp);
-
-               /* eat the whitespace */
-               while (isspace(*temp))
-                       ++temp;
+       while (cur < bufsize) {
+               unsigned int i, j;
 
-               /* empty line? */
-               if ((*temp == '\0') || (*temp == '\n'))
-                       continue;
+               count = buf_get_line(buf, bufsize, cur);
+               bufline = &buf[cur];
+               cur += count+1;
+               lineno++;
 
-               /* see if this is a comment */
-               if (*temp == COMMENT_CHARACTER)
+               if (count >= LINE_SIZE) {
+                       info("line too long, rule skipped %s, line %d", filename, lineno);
                        continue;
-
-               memset(&dev, 0x00, sizeof(struct config_device));
-
-               /* get the method */
-               temp2 = strsep(&temp, ",");
-
-               if (strcasecmp(temp2, TYPE_LABEL) == 0) {
-                       dev.type = LABEL;
-                       goto keys;
                }
 
-               if (strcasecmp(temp2, TYPE_NUMBER) == 0) {
-                       dev.type = NUMBER;
-                       goto keys;
+               /* eat the whitespace */
+               while ((count > 0) && isspace(bufline[0])) {
+                       bufline++;
+                       count--;
                }
+               if (count == 0)
+                       continue;
 
-               if (strcasecmp(temp2, TYPE_TOPOLOGY) == 0) {
-                       dev.type = TOPOLOGY;
-                       goto keys;
-               }
+               /* see if this is a comment */
+               if (bufline[0] == COMMENT_CHARACTER)
+                       continue;
 
-               if (strcasecmp(temp2, TYPE_REPLACE) == 0) {
-                       dev.type = REPLACE;
-                       goto keys;
-               }
+               /* skip backslash and newline from multi line rules */
+               for (i = j = 0; i < count; i++) {
+                       if (bufline[i] == '\\' || bufline[i] == '\n')
+                               continue;
 
-               if (strcasecmp(temp2, TYPE_CALLOUT) == 0) {
-                       dev.type = CALLOUT;
-                       goto keys;
+                       line[j++] = bufline[i];
                }
+               line[j] = '\0';
+               dbg_parse("read '%s'", line);
 
-               dbg_parse("unknown type of method '%s'", temp2);
-               goto error;
-keys:
                /* get all known keys */
+               memset(&dev, 0x00, sizeof(struct config_device));
+               temp = line;
+               valid = 0;
+
                while (1) {
-                       retval = get_pair(&temp, &temp2, &temp3);
+                       retval = parse_get_pair(&temp, &temp2, &temp3);
                        if (retval)
                                break;
 
                        if (strcasecmp(temp2, FIELD_BUS) == 0) {
                                strfieldcpy(dev.bus, temp3);
+                               valid = 1;
                                continue;
                        }
 
                        if (strcasecmp(temp2, FIELD_ID) == 0) {
                                strfieldcpy(dev.id, temp3);
+                               valid = 1;
                                continue;
                        }
 
                        if (strcasecmp(temp2, FIELD_PLACE) == 0) {
                                strfieldcpy(dev.place, temp3);
+                               valid = 1;
                                continue;
                        }
 
@@ -247,181 +203,168 @@ keys:
                                        ++pair;
                                }
                                if (pair) {
-                                       /* remove prepended 'SYSFS_' */
-                                       strfieldcpy(pair->file, temp2 + sizeof(FIELD_SYSFS)-1);
+                                       attr = get_key_attribute(temp2 + sizeof(FIELD_SYSFS)-1);
+                                       if (attr == NULL) {
+                                               dbg("error parsing " FIELD_SYSFS " attribute");
+                                               continue;
+                                       }
+                                       strfieldcpy(pair->file, attr);
                                        strfieldcpy(pair->value, temp3);
+                                       valid = 1;
                                }
                                continue;
                        }
 
                        if (strcasecmp(temp2, FIELD_KERNEL) == 0) {
-                               strfieldcpy(dev.kernel_name, temp3);
+                               strfieldcpy(dev.kernel, temp3);
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(temp2, FIELD_SUBSYSTEM) == 0) {
+                               strfieldcpy(dev.subsystem, temp3);
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(temp2, FIELD_DRIVER) == 0) {
+                               strfieldcpy(dev.driver, temp3);
+                               valid = 1;
                                continue;
                        }
 
                        if (strcasecmp(temp2, FIELD_PROGRAM) == 0) {
-                               strfieldcpy(dev.exec_program, temp3);
+                               program_given = 1;
+                               strfieldcpy(dev.program, temp3);
+                               valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_NAME) == 0) {
+                       if (strcasecmp(temp2, FIELD_RESULT) == 0) {
+                               strfieldcpy(dev.result, temp3);
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strncasecmp(temp2, FIELD_NAME, sizeof(FIELD_NAME)-1) == 0) {
+                               attr = get_key_attribute(temp2 + sizeof(FIELD_NAME)-1);
+                               /* FIXME: remove old style options and make OPTIONS= mandatory */
+                               if (attr != NULL) {
+                                       if (strstr(attr, ATTR_PARTITIONS) != NULL) {
+                                               dbg_parse("creation of partition nodes requested");
+                                               dev.partitions = DEFAULT_PARTITIONS_COUNT;
+                                       }
+                                       if (strstr(attr, ATTR_IGNORE_REMOVE) != NULL) {
+                                               dbg_parse("remove event should be ignored");
+                                               dev.ignore_remove = 1;
+                                       }
+                               }
                                strfieldcpy(dev.name, temp3);
+                               valid = 1;
                                continue;
                        }
 
                        if (strcasecmp(temp2, FIELD_SYMLINK) == 0) {
                                strfieldcpy(dev.symlink, temp3);
+                               valid = 1;
                                continue;
                        }
 
-                       dbg_parse("unknown type of field '%s'", temp2);
+                       if (strcasecmp(temp2, FIELD_OWNER) == 0) {
+                               strfieldcpy(dev.owner, temp3);
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(temp2, FIELD_GROUP) == 0) {
+                               strfieldcpy(dev.group, temp3);
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(temp2, FIELD_MODE) == 0) {
+                               dev.mode = strtol(temp3, NULL, 8);
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(temp2, FIELD_OPTIONS) == 0) {
+                               if (strstr(temp3, ATTR_IGNORE_DEVICE) != NULL) {
+                                       dbg_parse("device should be ignored");
+                                       dev.ignore_device = 1;
+                               }
+                               if (strstr(temp3, ATTR_IGNORE_REMOVE) != NULL) {
+                                       dbg_parse("remove event should be ignored");
+                                       dev.ignore_remove = 1;
+                               }
+                               if (strstr(temp3, ATTR_PARTITIONS) != NULL) {
+                                       dbg_parse("creation of partition nodes requested");
+                                       dev.partitions = DEFAULT_PARTITIONS_COUNT;
+                               }
+                               valid = 1;
+                               continue;
+                       }
+
+                       dbg("unknown type of field '%s'", temp2);
+                       goto error;
+               }
+
+               /* skip line if not any valid key was found */
+               if (!valid)
+                       goto error;
+
+               /* simple plausibility checks for given keys */
+               if ((dev.sysfs_pair[0].file[0] == '\0') ^
+                   (dev.sysfs_pair[0].value[0] == '\0')) {
+                       info("inconsistency in " FIELD_SYSFS " key");
+                       goto error;
                }
 
-               /* check presence of keys according to method type */
-               switch (dev.type) {
-               case LABEL:
-                       dbg_parse(TYPE_LABEL " name='%s', bus='%s', "
-                                 "sysfs_file[0]='%s', sysfs_value[0]='%s', symlink='%s'",
-                                 dev.name, dev.bus, dev.sysfs_pair[0].file,
-                                 dev.sysfs_pair[0].value, dev.symlink);
-                       if ((*dev.name == '\0') ||
-                           (*dev.sysfs_pair[0].file == '\0') ||
-                           (*dev.sysfs_pair[0].value == '\0'))
-                               goto error;
-                       break;
-               case NUMBER:
-                       dbg_parse(TYPE_NUMBER " name='%s', bus='%s', id='%s', symlink='%s'",
-                                 dev.name, dev.bus, dev.id, dev.symlink);
-                       if ((*dev.name == '\0') ||
-                           (*dev.bus == '\0') ||
-                           (*dev.id == '\0'))
-                               goto error;
-                       break;
-               case TOPOLOGY:
-                       dbg_parse(TYPE_TOPOLOGY " name='%s', bus='%s', "
-                                 "place='%s', symlink='%s'",
-                                 dev.name, dev.bus, dev.place, dev.symlink);
-                       if ((*dev.name == '\0') ||
-                           (*dev.bus == '\0') ||
-                           (*dev.place == '\0'))
-                               goto error;
-                       break;
-               case REPLACE:
-                       dbg_parse(TYPE_REPLACE " name='%s', kernel_name='%s', symlink='%s'",
-                                 dev.name, dev.kernel_name, dev.symlink);
-                       if ((*dev.name == '\0') ||
-                           (*dev.kernel_name == '\0'))
-                               goto error;
-                       break;
-               case CALLOUT:
-                       dbg_parse(TYPE_CALLOUT " name='%s', bus='%s', program='%s', "
-                                 "id='%s', symlink='%s'",
-                                 dev.name, dev.bus, dev.exec_program,
-                                 dev.id, dev.symlink);
-                       if ((*dev.name == '\0') ||
-                           (*dev.id == '\0') ||
-                           (*dev.exec_program == '\0'))
-                               goto error;
-                       break;
-               default:
-                       dbg_parse("unknown type of method");
+               if ((dev.result[0] != '\0') && (program_given == 0)) {
+                       info(FIELD_RESULT " is only useful when "
+                            FIELD_PROGRAM " is called in any rule before");
                        goto error;
                }
 
+               dev.config_line = lineno;
+               strfieldcpy(dev.config_file, filename);
                retval = add_config_dev(&dev);
                if (retval) {
                        dbg("add_config_dev returned with error %d", retval);
                        continue;
+error:
+                       info("parse error %s, line %d:%d, rule skipped",
+                            filename, lineno, temp - line);
                }
        }
-error:
-       dbg_parse("%s:%d:%Zd: field missing or parse error", udev_rules_filename,
-                 lineno, temp - line);
-exit:
-       fclose(fd);
+
+       file_unmap(buf, bufsize);
        return retval;
 }
 
-int namedev_init_permissions(void)
+int namedev_init(void)
 {
-       char line[255];
-       char *temp;
-       char *temp2;
-       FILE *fd;
-       int retval = 0;
-       struct perm_device dev;
-
-       fd = fopen(udev_permissions_filename, "r");
-       if (fd != NULL) {
-               dbg("reading '%s' as permissions file", udev_permissions_filename);
-       } else {
-               dbg("can't open '%s' as permissions file", udev_permissions_filename);
-               return -ENODEV;
-       }
-
-       /* loop through the whole file */
-       while (1) {
-               temp = fgets(line, sizeof(line), fd);
-               if (temp == NULL)
-                       break;
-
-               dbg_parse("read '%s'", temp);
+       struct stat stats;
+       int retval;
 
-               /* eat the whitespace at the beginning of the line */
-               while (isspace(*temp))
-                       ++temp;
+       if (stat(udev_rules_filename, &stats) != 0)
+               return -1;
 
-               /* empty line? */
-               if ((*temp == '\0') || (*temp == '\n'))
-                       continue;
-
-               /* see if this is a comment */
-               if (*temp == COMMENT_CHARACTER)
-                       continue;
-
-               memset(&dev, 0x00, sizeof(dev));
-
-               /* parse the line */
-               temp2 = strsep(&temp, ":");
-               if (!temp2) {
-                       dbg("cannot parse line '%s'", line);
-                       continue;
-               }
-               strncpy(dev.name, temp2, sizeof(dev.name));
-
-               temp2 = strsep(&temp, ":");
-               if (!temp2) {
-                       dbg("cannot parse line '%s'", line);
-                       continue;
-               }
-               strncpy(dev.owner, temp2, sizeof(dev.owner));
+       if ((stats.st_mode & S_IFMT) != S_IFDIR)
+               retval = namedev_parse(udev_rules_filename, NULL);
+       else
+               retval = call_foreach_file(namedev_parse, udev_rules_filename, RULEFILE_SUFFIX, NULL);
 
-               temp2 = strsep(&temp, ":");
-               if (!temp2) {
-                       dbg("cannot parse line '%s'", line);
-                       continue;
-               }
-               strncpy(dev.group, temp2, sizeof(dev.owner));
+       return retval;
+}
 
-               if (!temp) {
-                       dbg("cannot parse line: %s", line);
-                       continue;
-               }
-               dev.mode = strtol(temp, NULL, 8);
+void namedev_close(void)
+{
+       struct config_device *dev;
 
-               dbg_parse("name='%s', owner='%s', group='%s', mode=%#o",
-                         dev.name, dev.owner, dev.group,
-                         dev.mode);
-               retval = add_perm_dev(&dev);
-               if (retval) {
-                       dbg("add_perm_dev returned with error %d", retval);
-                       goto exit;
-               }
+       list_for_each_entry(dev, &config_device_list, node) {
+               list_del(&dev->node);
+               free(dev);
        }
-
-exit:
-       fclose(fd);
-       return retval;
-}      
-
+}