chiark / gitweb /
allow OPTIONS to be recognized for /sys/modules /sys/devices events
[elogind.git] / udev_rules_parse.c
index 4f431decf57acc6694e32beca9434a7e4048d8b6..929a5e6f4cca15e3107a1158a22462d048b5f31a 100644 (file)
 #include "logging.h"
 #include "udev_rules.h"
 
-LIST_HEAD(udev_rule_list);
+/* rules parsed from .rules files*/
+static LIST_HEAD(rules_list);
+static struct list_head *rules_list_current;
 
-static int add_config_dev(struct udev_rule *new_rule)
+/* mapped compiled rules stored on disk */
+static struct udev_rule *rules_array = NULL;
+static size_t rules_array_current;
+static size_t rules_array_size = 0;
+
+static size_t rules_count = 0;
+
+int udev_rules_iter_init(void)
+{
+       rules_list_current = rules_list.next;
+       rules_array_current = 0;
+
+       return 0;
+}
+
+struct udev_rule *udev_rules_iter_next(void)
+{
+       static struct udev_rule *rule;
+
+       if (rules_array) {
+               if (rules_array_current >= rules_count)
+                       return NULL;
+               rule = &rules_array[rules_array_current];
+               rules_array_current++;
+       } else {
+               dbg("head=%p current=%p next=%p", &rules_list, rules_list_current, rules_list_current->next);
+               if (rules_list_current == &rules_list)
+                       return NULL;
+               rule = list_entry(rules_list_current, struct udev_rule, node);
+               rules_list_current = rules_list_current->next;
+       }
+       return rule;
+}
+
+static int add_rule_to_list(struct udev_rule *rule)
 {
        struct udev_rule *tmp_rule;
 
        tmp_rule = malloc(sizeof(*tmp_rule));
        if (tmp_rule == NULL)
                return -ENOMEM;
-       memcpy(tmp_rule, new_rule, sizeof(*tmp_rule));
-       list_add_tail(&tmp_rule->node, &udev_rule_list);
-       udev_rule_dump(tmp_rule);
-
-       return 0;
-}
+       memcpy(tmp_rule, rule, sizeof(struct udev_rule));
+       list_add_tail(&tmp_rule->node, &rules_list);
 
-void udev_rule_dump(struct udev_rule *rule)
-{
        dbg("name='%s', symlink='%s', bus='%s', id='%s', "
            "sysfs_file[0]='%s', sysfs_value[0]='%s', "
-           "kernel='%s', program='%s', result='%s'"
-           "owner='%s', group='%s', mode=%#o",
+           "kernel='%s', program='%s', result='%s', "
+           "owner='%s', group='%s', mode=%#o, "
+           "all_partions=%u, ignore_remove=%u, ignore_device=%u, last_rule=%u",
            rule->name, rule->symlink, rule->bus, rule->id,
-           rule->sysfs_pair[0].file, rule->sysfs_pair[0].value,
-           rule->kernel, rule->program, rule->result,
-           rule->owner, rule->group, rule->mode);
+           rule->sysfs_pair[0].name, rule->sysfs_pair[0].value,
+           rule->kernel, rule->program, rule->result, rule->owner, rule->group, rule->mode,
+           rule->partitions, rule->ignore_remove, rule->ignore_device, rule->last_rule);
+
+       return 0;
 }
 
-void udev_rule_list_dump(void)
+static int get_key(char **line, char **key, enum key_operation *operation, char **value)
 {
-       struct udev_rule *rule;
+       char *linepos;
+       char *temp;
+
+       linepos = *line;
+       if (!linepos)
+               return -1;
 
-       list_for_each_entry(rule, &udev_rule_list, node)
-               udev_rule_dump(rule);
+       /* skip whitespace */
+       while (isspace(linepos[0]) || linepos[0] == ',')
+               linepos++;
+
+       /* get the key */
+       *key = linepos;
+       while (1) {
+               linepos++;
+               if (linepos[0] == '\0')
+                       return -1;
+               if (isspace(linepos[0]))
+                       break;
+               if (linepos[0] == '=')
+                       break;
+               if (linepos[0] == '+')
+                       break;
+               if (linepos[0] == '!')
+                       break;
+               if (linepos[0] == ':')
+                       break;
+       }
+
+       /* remember end of key */
+       temp = linepos;
+
+       /* skip whitespace after key */
+       while (isspace(linepos[0]))
+               linepos++;
+
+       /* get operation type */
+       if (linepos[0] == '=' && linepos[1] == '=') {
+               *operation = KEY_OP_MATCH;
+               linepos += 2;
+               dbg("operator=match");
+       } else if (linepos[0] == '!' && linepos[1] == '=') {
+               *operation = KEY_OP_NOMATCH;
+               linepos += 2;
+               dbg("operator=nomatch");
+       } else if (linepos[0] == '+' && linepos[1] == '=') {
+               *operation = KEY_OP_ADD;
+               linepos += 2;
+               dbg("operator=add");
+       } else if (linepos[0] == '=') {
+               *operation = KEY_OP_ASSIGN;
+               linepos++;
+               dbg("operator=assign");
+       } else if (linepos[0] == ':' && linepos[1] == '=') {
+               *operation = KEY_OP_ASSIGN_FINAL;
+               linepos += 2;
+               dbg("operator=assign_final");
+       } else
+               return -1;
+
+       /* terminate key */
+       temp[0] = '\0';
+       dbg("key='%s'", *key);
+
+       /* skip whitespace after operator */
+       while (isspace(linepos[0]))
+               linepos++;
+
+       /* get the value*/
+       if (linepos[0] == '"')
+               linepos++;
+       else
+               return -1;
+       *value = linepos;
+
+       temp = strchr(linepos, '"');
+       if (!temp)
+               return -1;
+       temp[0] = '\0';
+       temp++;
+       dbg("value='%s'", *value);
+
+       /* move line to next key */
+       *line = temp;
+
+       return 0;
 }
 
 /* extract possible KEY{attr} */
@@ -84,7 +199,7 @@ static char *get_key_attribute(char *str)
                attr++;
                pos = strchr(attr, '}');
                if (pos == NULL) {
-                       dbg("missing closing brace for format");
+                       err("missing closing brace for format");
                        return NULL;
                }
                pos[0] = '\0';
@@ -95,14 +210,12 @@ static char *get_key_attribute(char *str)
        return NULL;
 }
 
-static int rules_parse(struct udevice *udev, const char *filename)
+static int rules_parse(const char *filename)
 {
        char line[LINE_SIZE];
        char *bufline;
        int lineno;
-       char *temp;
-       char *temp2;
-       char *temp3;
+       char *linepos;
        char *attr;
        char *buf;
        size_t bufsize;
@@ -113,12 +226,11 @@ static int rules_parse(struct udevice *udev, const char *filename)
        int retval = 0;
        struct udev_rule rule;
 
-       if (file_map(filename, &buf, &bufsize) == 0) {
-               dbg("reading '%s' as rules file", filename);
-       } else {
-               dbg("can't open '%s' as rules file", filename);
+       if (file_map(filename, &buf, &bufsize) != 0) {
+               err("can't open '%s' as rules file", filename);
                return -1;
        }
+       dbg("reading '%s' as rules file", filename);
 
        /* loop through the whole file */
        cur = 0;
@@ -160,86 +272,162 @@ static int rules_parse(struct udevice *udev, const char *filename)
 
                /* get all known keys */
                memset(&rule, 0x00, sizeof(struct udev_rule));
-               temp = line;
+               linepos = line;
                valid = 0;
 
                while (1) {
-                       retval = parse_get_pair(&temp, &temp2, &temp3);
+                       char *key;
+                       char *value;
+                       enum key_operation operation = KEY_OP_UNSET;
+
+                       retval = get_key(&linepos, &key, &operation, &value);
                        if (retval)
                                break;
 
-                       if (strcasecmp(temp2, FIELD_KERNEL) == 0) {
-                               strlcpy(rule.kernel, temp3, sizeof(rule.kernel));
+                       if (strcasecmp(key, KEY_KERNEL) == 0) {
+                               strlcpy(rule.kernel, value, sizeof(rule.kernel));
+                               rule.kernel_operation = operation;
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(key, KEY_SUBSYSTEM) == 0) {
+                               strlcpy(rule.subsystem, value, sizeof(rule.subsystem));
+                               rule.subsystem_operation = operation;
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(key, KEY_ACTION) == 0) {
+                               strlcpy(rule.action, value, sizeof(rule.action));
+                               rule.action_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_SUBSYSTEM) == 0) {
-                               strlcpy(rule.subsystem, temp3, sizeof(rule.subsystem));
+                       if (strcasecmp(key, KEY_DEVPATH) == 0) {
+                               strlcpy(rule.devpath, value, sizeof(rule.devpath));
+                               rule.devpath_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_BUS) == 0) {
-                               strlcpy(rule.bus, temp3, sizeof(rule.bus));
+                       if (strcasecmp(key, KEY_BUS) == 0) {
+                               strlcpy(rule.bus, value, sizeof(rule.bus));
+                               rule.bus_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_ID) == 0) {
-                               strlcpy(rule.id, temp3, sizeof(rule.id));
+                       if (strcasecmp(key, KEY_ID) == 0) {
+                               strlcpy(rule.id, value, sizeof(rule.id));
+                               rule.id_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strncasecmp(temp2, FIELD_SYSFS, sizeof(FIELD_SYSFS)-1) == 0) {
-                               struct sysfs_pair *pair = &rule.sysfs_pair[0];
-                               int sysfs_pair_num = 0;
+                       if (strncasecmp(key, KEY_SYSFS, sizeof(KEY_SYSFS)-1) == 0) {
+                               struct key_pair *pair;
 
-                               /* find first unused pair */
-                               while (pair->file[0] != '\0') {
-                                       ++sysfs_pair_num;
-                                       if (sysfs_pair_num >= MAX_SYSFS_PAIRS) {
-                                               pair = NULL;
-                                               break;
-                                       }
-                                       ++pair;
+                               if (rule.sysfs_pair_count >= KEY_SYSFS_PAIRS_MAX) {
+                                       err("skip rule, to many " KEY_SYSFS " keys in a single rule");
+                                       goto error;
                                }
-                               if (pair) {
-                                       attr = get_key_attribute(temp2 + sizeof(FIELD_SYSFS)-1);
-                                       if (attr == NULL) {
-                                               dbg("error parsing " FIELD_SYSFS " attribute");
-                                               continue;
+                               pair = &rule.sysfs_pair[rule.sysfs_pair_count];
+                               attr = get_key_attribute(key + sizeof(KEY_SYSFS)-1);
+                               if (attr == NULL) {
+                                       err("error parsing " KEY_SYSFS " attribute");
+                                       goto error;
+                               }
+                               strlcpy(pair->name, attr, sizeof(pair->name));
+                               strlcpy(pair->value, value, sizeof(pair->value));
+                               pair->operation = operation;
+                               rule.sysfs_pair_count++;
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strncasecmp(key, KEY_ENV, sizeof(KEY_ENV)-1) == 0) {
+                               struct key_pair *pair;
+
+                               if (rule.env_pair_count >= KEY_ENV_PAIRS_MAX) {
+                                       err("skip rule, to many " KEY_ENV " keys in a single rule");
+                                       goto error;
+                               }
+                               pair = &rule.env_pair[rule.env_pair_count];
+                               attr = get_key_attribute(key + sizeof(KEY_ENV)-1);
+                               if (attr == NULL) {
+                                       err("error parsing " KEY_ENV " attribute");
+                                       continue;
+                               }
+                               strlcpy(pair->name, attr, sizeof(pair->name));
+                               strlcpy(pair->value, value, sizeof(pair->value));
+                               pair->operation = operation;
+                               rule.env_pair_count++;
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(key, KEY_MODALIAS) == 0) {
+                               strlcpy(rule.modalias, value, sizeof(rule.modalias));
+                               rule.modalias_operation = operation;
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strncasecmp(key, KEY_IMPORT, sizeof(KEY_IMPORT)-1) == 0) {
+                               attr = get_key_attribute(key + sizeof(KEY_IMPORT)-1);
+                               if (attr && strstr(attr, "program")) {
+                                       dbg(KEY_IMPORT" will be executed");
+                                       rule.import_exec = 1;
+                               } else if (attr && strstr(attr, "file")) {
+                                       dbg(KEY_IMPORT" will be included as file");
+                               } else {
+                                       /* figure it out if it is executable */
+                                       char file[PATH_SIZE];
+                                       char *pos;
+                                       struct stat stats;
+
+                                       strlcpy(file, value, sizeof(file));
+                                       pos = strchr(file, ' ');
+                                       if (pos)
+                                               pos[0] = '\0';
+                                       dbg(KEY_IMPORT" auto mode for '%s'", file);
+                                       if (!lstat(file, &stats) && (stats.st_mode & S_IXUSR)) {
+                                                       dbg(KEY_IMPORT" is executable, will be executed");
+                                                       rule.import_exec = 1;
                                        }
-                                       strlcpy(pair->file, attr, sizeof(pair->file));
-                                       strlcpy(pair->value, temp3, sizeof(pair->value));
-                                       valid = 1;
                                }
+                               strlcpy(rule.import, value, sizeof(rule.import));
+                               rule.import_operation = operation;
+                               valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_DRIVER) == 0) {
-                               strlcpy(rule.driver, temp3, sizeof(rule.driver));
+                       if (strcasecmp(key, KEY_DRIVER) == 0) {
+                               strlcpy(rule.driver, value, sizeof(rule.driver));
+                               rule.driver_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_PROGRAM) == 0) {
-                               program_given = 1;
-                               strlcpy(rule.program, temp3, sizeof(rule.program));
+                       if (strcasecmp(key, KEY_RESULT) == 0) {
+                               strlcpy(rule.result, value, sizeof(rule.result));
+                               rule.result_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_RESULT) == 0) {
-                               strlcpy(rule.result, temp3, sizeof(rule.result));
+                       if (strcasecmp(key, KEY_PROGRAM) == 0) {
+                               strlcpy(rule.program, value, sizeof(rule.program));
+                               rule.program_operation = operation;
+                               program_given = 1;
                                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 (strncasecmp(key, KEY_NAME, sizeof(KEY_NAME)-1) == 0) {
+                               attr = get_key_attribute(key + sizeof(KEY_NAME)-1);
                                if (attr != NULL) {
                                        if (strstr(attr, OPTION_PARTITIONS) != NULL) {
                                                dbg("creation of partition nodes requested");
@@ -250,48 +438,61 @@ static int rules_parse(struct udevice *udev, const char *filename)
                                                rule.ignore_remove = 1;
                                        }
                                }
-                               if (temp3[0] != '\0')
-                                       strlcpy(rule.name, temp3, sizeof(rule.name));
-                               else
-                                       rule.ignore_device = 1;
+                               rule.name_operation = operation;
+                               strlcpy(rule.name, value, sizeof(rule.name));
+                               valid = 1;
+                               continue;
+                       }
+
+                       if (strcasecmp(key, KEY_SYMLINK) == 0) {
+                               strlcpy(rule.symlink, value, sizeof(rule.symlink));
+                               rule.symlink_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_SYMLINK) == 0) {
-                               strlcpy(rule.symlink, temp3, sizeof(rule.symlink));
+                       if (strcasecmp(key, KEY_OWNER) == 0) {
+                               strlcpy(rule.owner, value, sizeof(rule.owner));
+                               rule.owner_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_OWNER) == 0) {
-                               strlcpy(rule.owner, temp3, sizeof(rule.owner));
+                       if (strcasecmp(key, KEY_GROUP) == 0) {
+                               strlcpy(rule.group, value, sizeof(rule.group));
+                               rule.group_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_GROUP) == 0) {
-                               strlcpy(rule.group, temp3, sizeof(rule.group));
+                       if (strcasecmp(key, KEY_MODE) == 0) {
+                               rule.mode = strtol(value, NULL, 8);
+                               rule.mode_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_MODE) == 0) {
-                               rule.mode = strtol(temp3, NULL, 8);
+                       if (strcasecmp(key, KEY_RUN) == 0) {
+                               strlcpy(rule.run, value, sizeof(rule.run));
+                               rule.run_operation = operation;
                                valid = 1;
                                continue;
                        }
 
-                       if (strcasecmp(temp2, FIELD_OPTIONS) == 0) {
-                               if (strstr(temp3, OPTION_IGNORE_DEVICE) != NULL) {
+                       if (strcasecmp(key, KEY_OPTIONS) == 0) {
+                               if (strstr(value, OPTION_LAST_RULE) != NULL) {
+                                       dbg("last rule to be applied");
+                                       rule.last_rule = 1;
+                               }
+                               if (strstr(value, OPTION_IGNORE_DEVICE) != NULL) {
                                        dbg("device should be ignored");
                                        rule.ignore_device = 1;
                                }
-                               if (strstr(temp3, OPTION_IGNORE_REMOVE) != NULL) {
+                               if (strstr(value, OPTION_IGNORE_REMOVE) != NULL) {
                                        dbg("remove event should be ignored");
                                        rule.ignore_remove = 1;
                                }
-                               if (strstr(temp3, OPTION_PARTITIONS) != NULL) {
+                               if (strstr(value, OPTION_PARTITIONS) != NULL) {
                                        dbg("creation of partition nodes requested");
                                        rule.partitions = DEFAULT_PARTITIONS_COUNT;
                                }
@@ -299,7 +500,7 @@ static int rules_parse(struct udevice *udev, const char *filename)
                                continue;
                        }
 
-                       dbg("unknown type of field '%s'", temp2);
+                       err("unknown key '%s'", key);
                        goto error;
                }
 
@@ -307,28 +508,20 @@ static int rules_parse(struct udevice *udev, const char *filename)
                if (!valid)
                        goto error;
 
-               /* simple plausibility checks for given keys */
-               if ((rule.sysfs_pair[0].file[0] == '\0') ^
-                   (rule.sysfs_pair[0].value[0] == '\0')) {
-                       info("inconsistency in " FIELD_SYSFS " key");
-                       goto error;
-               }
-
                if ((rule.result[0] != '\0') && (program_given == 0)) {
-                       info(FIELD_RESULT " is only useful when "
-                            FIELD_PROGRAM " is called in any rule before");
+                       info(KEY_RESULT " is only useful when " KEY_PROGRAM " is called in any rule before");
                        goto error;
                }
 
                rule.config_line = lineno;
                strlcpy(rule.config_file, filename, sizeof(rule.config_file));
-               retval = add_config_dev(&rule);
+               retval = add_rule_to_list(&rule);
                if (retval) {
-                       dbg("add_config_dev returned with error %d", retval);
+                       dbg("add_rule_to_list returned with error %d", retval);
                        continue;
 error:
-                       info("parse error %s, line %d:%d, rule skipped",
-                            filename, lineno, (int) (temp - line));
+                       err("parse error %s, line %d:%d, rule skipped",
+                            filename, lineno, (int) (linepos - line));
                }
        }
 
@@ -336,18 +529,54 @@ error:
        return retval;
 }
 
+static int rules_map(const char *filename)
+{
+       char *buf;
+       size_t size;
+
+       if (file_map(filename, &buf, &size))
+               return -1;
+       if (size == 0)
+               return -1;
+       rules_array = (struct udev_rule *) buf;
+       rules_array_size = size;
+       rules_count = size / sizeof(struct udev_rule);
+       dbg("found %zi compiled rules", rules_count);
+
+       return 0;
+}
+
 int udev_rules_init(void)
 {
+       char comp[PATH_SIZE];
        struct stat stats;
        int retval;
 
+       strlcpy(comp, udev_rules_filename, sizeof(comp));
+       strlcat(comp, ".compiled", sizeof(comp));
+       if (stat(comp, &stats) == 0) {
+               dbg("parse compiled rules '%s'", comp);
+               return rules_map(comp);
+       }
+
        if (stat(udev_rules_filename, &stats) != 0)
                return -1;
 
-       if ((stats.st_mode & S_IFMT) != S_IFDIR)
-               retval = rules_parse(NULL, udev_rules_filename);
-       else
-               retval = call_foreach_file(rules_parse, NULL, udev_rules_filename, RULEFILE_SUFFIX);
+       if ((stats.st_mode & S_IFMT) != S_IFDIR) {
+               dbg("parse single rules file '%s'", udev_rules_filename);
+               retval = rules_parse(udev_rules_filename);
+       } else {
+               struct name_entry *name_loop, *name_tmp;
+               LIST_HEAD(name_list);
+
+               dbg("parse rules directory '%s'", udev_rules_filename);
+               retval = add_matching_files(&name_list, udev_rules_filename, RULEFILE_SUFFIX);
+
+               list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
+                       rules_parse(name_loop->name);
+                       list_del(&name_loop->node);
+               }
+       }
 
        return retval;
 }
@@ -357,9 +586,11 @@ void udev_rules_close(void)
        struct udev_rule *rule;
        struct udev_rule *temp_rule;
 
-       list_for_each_entry_safe(rule, temp_rule, &udev_rule_list, node) {
-               list_del(&rule->node);
-               free(rule);
-       }
+       if (rules_array)
+               file_unmap(rules_array, rules_array_size);
+       else
+               list_for_each_entry_safe(rule, temp_rule, &rules_list, node) {
+                       list_del(&rule->node);
+                       free(rule);
+               }
 }
-