chiark / gitweb /
warn if a PHYSEDV* key, the "device" link, or a parent attribute is used
[elogind.git] / udev_rules_parse.c
index 488b7a7ff0c31b258fcb749eb9e744d90afda39d..bc16f72e2c2cd662bea30d806719c59586e999ea 100644 (file)
@@ -1,8 +1,6 @@
 /*
- * udev_rules_parse.c
- *
  * Copyright (C) 2003,2004 Greg Kroah-Hartman <greg@kroah.com>
- * Copyright (C) 2003-2005 Kay Sievers <kay.sievers@vrfy.org>
+ * Copyright (C) 2003-2006 Kay Sievers <kay.sievers@vrfy.org>
  *
  *     This program is free software; you can redistribute it and/or modify it
  *     under the terms of the GNU General Public License as published by the
@@ -15,7 +13,7 @@
  * 
  *     You should have received a copy of the GNU General Public License along
  *     with this program; if not, write to the Free Software Foundation, Inc.,
- *     675 Mass Ave, Cambridge, MA 02139, USA.
+ *     51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
 
 #include <sys/stat.h>
 #include <errno.h>
 
-#include "udev_libc_wrapper.h"
 #include "udev.h"
-#include "udev_utils.h"
-#include "logging.h"
 #include "udev_rules.h"
 
 
@@ -222,7 +217,7 @@ static int add_rule_key_pair(struct udev_rule *rule, struct key_pairs *pairs,
        size_t key_len = strnlen(key, PATH_SIZE);
 
        if (pairs->count >= PAIRS_MAX) {
-               err("skip, too many keys in a single rule");
+               err("skip, too many keys of the same type in a single rule");
                return -1;
        }
 
@@ -238,7 +233,7 @@ static int add_rule_key_pair(struct udev_rule *rule, struct key_pairs *pairs,
        return 0;
 }
 
-static int add_to_rules(struct udev_rules *rules, char *line)
+static int add_to_rules(struct udev_rules *rules, char *line, const char *filename, unsigned int lineno)
 {
        struct udev_rule *rule;
        size_t rule_size;
@@ -266,84 +261,158 @@ static int add_to_rules(struct udev_rules *rules, char *line)
                if (retval)
                        break;
 
-               if (strcasecmp(key, "LABEL") == 0) {
-                       add_rule_key(rule, &rule->label, operation, value);
+               if (strcasecmp(key, "ACTION") == 0) {
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid ACTION operation");
+                               goto invalid;
+                       }
+                       add_rule_key(rule, &rule->action, operation, value);
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "GOTO") == 0) {
-                       add_rule_key(rule, &rule->goto_label, operation, value);
+               if (strcasecmp(key, "DEVPATH") == 0) {
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid DEVPATH operation");
+                               goto invalid;
+                       }
+                       add_rule_key(rule, &rule->devpath, operation, value);
                        valid = 1;
                        continue;
                }
 
                if (strcasecmp(key, "KERNEL") == 0) {
-                       add_rule_key(rule, &rule->kernel_name, operation, value);
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid KERNEL operation");
+                               goto invalid;
+                       }
+                       add_rule_key(rule, &rule->kernel, operation, value);
                        valid = 1;
                        continue;
                }
 
                if (strcasecmp(key, "SUBSYSTEM") == 0) {
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid SUBSYSTEM operation");
+                               goto invalid;
+                       }
                        add_rule_key(rule, &rule->subsystem, operation, value);
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "ACTION") == 0) {
-                       add_rule_key(rule, &rule->action, operation, value);
+               if (strcasecmp(key, "DRIVER") == 0) {
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid DRIVER operation");
+                               goto invalid;
+                       }
+                       err("DRIVER== will change in a future relase, "
+                           "please use DRIVERS== in %s:%u", filename, lineno);
+                       /* FIXME: this should be rule->driver to match only the event device */
+                       add_rule_key(rule, &rule->drivers, operation, value);
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "DEVPATH") == 0) {
-                       add_rule_key(rule, &rule->devpath, operation, value);
+               if (strncasecmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
+                       attr = get_key_attribute(key + sizeof("ATTR")-1);
+                       if (attr == NULL) {
+                               err("error parsing ATTR attribute");
+                               goto invalid;
+                       }
+                       if (add_rule_key_pair(rule, &rule->attr, operation, attr, value) != 0)
+                               goto invalid;
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "BUS") == 0) {
-                       add_rule_key(rule, &rule->bus, operation, value);
+               if (strcasecmp(key, "KERNELS") == 0 ||
+                   strcasecmp(key, "ID") == 0) {
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid KERNELS operation");
+                               goto invalid;
+                       }
+                       add_rule_key(rule, &rule->kernels, operation, value);
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "ID") == 0) {
-                       add_rule_key(rule, &rule->id, operation, value);
+               if (strcasecmp(key, "SUBSYSTEMS") == 0 ||
+                   strcasecmp(key, "BUS") == 0) {
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid SUBSYSTEMS operation");
+                               goto invalid;
+                       }
+                       add_rule_key(rule, &rule->subsystems, operation, value);
                        valid = 1;
                        continue;
                }
 
-               if (strncasecmp(key, "SYSFS", sizeof("SYSFS")-1) == 0) {
-                       attr = get_key_attribute(key + sizeof("SYSFS")-1);
-                       if (attr == NULL) {
-                               err("error parsing SYSFS attribute in '%s'", line);
-                               continue;
+               if (strcasecmp(key, "DRIVERS") == 0) {
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid DRIVERS operation");
+                               goto invalid;
                        }
-                       add_rule_key_pair(rule, &rule->sysfs, operation, attr, value);
+                       add_rule_key(rule, &rule->drivers, operation, value);
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
-                       add_rule_key(rule, &rule->wait_for_sysfs, operation, value);
+               if (strncasecmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0 ||
+                   strncasecmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
+                       attr = get_key_attribute(key + sizeof("ATTRS")-1);
+                       if (attr == NULL) {
+                               err("error parsing ATTRS attribute");
+                               goto invalid;
+                       }
+                       if (strncmp(attr, "device/", 7) == 0)
+                               err("the 'device' link is deprecated and will be removed from a future kernel, "
+                                   "please fix it in %s:%u", filename, lineno);
+                       else if (strchr(attr, '/') != NULL)
+                               err("do not reference parent sysfs directories directly, that may break with a future kernel, "
+                                   "please fix it in %s:%u", filename, lineno);
+                       if (add_rule_key_pair(rule, &rule->attrs, operation, attr, value) != 0)
+                               goto invalid;
                        valid = 1;
                        continue;
                }
 
-               if (strncasecmp(key, "ENV", sizeof("ENV")-1) == 0) {
+               if (strncasecmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
                        attr = get_key_attribute(key + sizeof("ENV")-1);
                        if (attr == NULL) {
                                err("error parsing ENV attribute");
-                               continue;
+                               goto invalid;
                        }
-                       add_rule_key_pair(rule, &rule->env, operation, attr, value);
+                       if (strncmp(attr, "PHYSDEV", 7) == 0)
+                               err("PHYSDEV* values are deprected and will be removed from a future kernel, "
+                                   "please fix it in %s:%u", filename, lineno);
+                       if (add_rule_key_pair(rule, &rule->env, operation, attr, value) != 0)
+                               goto invalid;
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "MODALIAS") == 0) {
-                       add_rule_key(rule, &rule->modalias, operation, value);
+               if (strcasecmp(key, "PROGRAM") == 0) {
+                       add_rule_key(rule, &rule->program, operation, value);
+                       valid = 1;
+                       continue;
+               }
+
+               if (strcasecmp(key, "RESULT") == 0) {
+                       if (operation != KEY_OP_MATCH &&
+                           operation != KEY_OP_NOMATCH) {
+                               err("invalid RESULT operation");
+                               goto invalid;
+                       }
+                       add_rule_key(rule, &rule->result, operation, value);
                        valid = 1;
                        continue;
                }
@@ -369,6 +438,16 @@ static int add_to_rules(struct udev_rules *rules, char *line)
                                pos = strchr(file, ' ');
                                if (pos)
                                        pos[0] = '\0';
+
+                               /* allow programs in /lib/udev called without the path */
+                               if (strchr(file, '/') == NULL) {
+                                       strlcpy(file, "/lib/udev/", sizeof(file));
+                                       strlcat(file, value, sizeof(file));
+                                       pos = strchr(file, ' ');
+                                       if (pos)
+                                               pos[0] = '\0';
+                               }
+
                                dbg("IMPORT auto mode for '%s'", file);
                                if (!lstat(file, &stats) && (stats.st_mode & S_IXUSR)) {
                                        dbg("IMPORT is executable, will be executed (autotype)");
@@ -383,20 +462,26 @@ static int add_to_rules(struct udev_rules *rules, char *line)
                        continue;
                }
 
-               if (strcasecmp(key, "DRIVER") == 0) {
-                       add_rule_key(rule, &rule->driver, operation, value);
+               if (strcasecmp(key, "RUN") == 0) {
+                       add_rule_key(rule, &rule->run, operation, value);
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "RESULT") == 0) {
-                       add_rule_key(rule, &rule->result, operation, value);
+               if (strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
+                       add_rule_key(rule, &rule->wait_for_sysfs, operation, value);
                        valid = 1;
                        continue;
                }
 
-               if (strcasecmp(key, "PROGRAM") == 0) {
-                       add_rule_key(rule, &rule->program, operation, value);
+               if (strcasecmp(key, "LABEL") == 0) {
+                       add_rule_key(rule, &rule->label, operation, value);
+                       valid = 1;
+                       continue;
+               }
+
+               if (strcasecmp(key, "GOTO") == 0) {
+                       add_rule_key(rule, &rule->goto_label, operation, value);
                        valid = 1;
                        continue;
                }
@@ -413,12 +498,9 @@ static int add_to_rules(struct udev_rules *rules, char *line)
                                        rule->ignore_remove = 1;
                                }
                        }
-                       if (value[0] == '\0') {
-                               dbg("name empty device should be ignored");
-                               rule->name.operation = operation;
-                               rule->ignore_device = 1;
-                       } else
-                               add_rule_key(rule, &rule->name, operation, value);
+                       if (value[0] == '\0')
+                               dbg("name empty, node creation supressed");
+                       add_rule_key(rule, &rule->name, operation, value);
                        continue;
                }
 
@@ -437,7 +519,7 @@ static int add_to_rules(struct udev_rules *rules, char *line)
                                        char owner[32];
                                        uid_t uid = lookup_user(value);
                                        dbg("replacing username='%s' by id=%i", value, uid);
-                                       sprintf(owner, "%li", uid);
+                                       sprintf(owner, "%u", (unsigned int) uid);
                                        add_rule_key(rule, &rule->owner, operation, owner);
                                        continue;
                                }
@@ -456,7 +538,7 @@ static int add_to_rules(struct udev_rules *rules, char *line)
                                        char group[32];
                                        gid_t gid = lookup_group(value);
                                        dbg("replacing groupname='%s' by id=%i", value, gid);
-                                       sprintf(group, "%li", gid);
+                                       sprintf(group, "%u", (unsigned int) gid);
                                        add_rule_key(rule, &rule->group, operation, group);
                                        continue;
                                }
@@ -473,12 +555,6 @@ static int add_to_rules(struct udev_rules *rules, char *line)
                        continue;
                }
 
-               if (strcasecmp(key, "RUN") == 0) {
-                       add_rule_key(rule, &rule->run, operation, value);
-                       valid = 1;
-                       continue;
-               }
-
                if (strcasecmp(key, "OPTIONS") == 0) {
                        if (strstr(value, "last_rule") != NULL) {
                                dbg("last rule to be applied");
@@ -500,14 +576,12 @@ static int add_to_rules(struct udev_rules *rules, char *line)
                        continue;
                }
 
-               err("unknown key '%s', in '%s'", key, line);
+               err("unknown key '%s' in %s:%u", key, filename, lineno);
        }
 
        /* skip line if not any valid key was found */
-       if (!valid) {
-               err("invalid rule '%s'", line);
-               goto exit;
-       }
+       if (!valid)
+               goto invalid;
 
        /* grow buffer and add rule */
        rule_size = sizeof(struct udev_rule) + rule->bufsize;
@@ -527,13 +601,18 @@ static int add_to_rules(struct udev_rules *rules, char *line)
 exit:
        free(rule);
        return 0;
+
+invalid:
+       free(rule);
+       err("invalid rule '%s:%u'", filename, lineno);
+       return -1;
 }
 
 static int parse_file(struct udev_rules *rules, const char *filename)
 {
        char line[LINE_SIZE];
        char *bufline;
-       int lineno;
+       unsigned int lineno;
        char *buf;
        size_t bufsize;
        size_t cur;
@@ -541,7 +620,7 @@ static int parse_file(struct udev_rules *rules, const char *filename)
        int retval = 0;
 
        if (file_map(filename, &buf, &bufsize) != 0) {
-               err("can't open '%s' as rules file", filename);
+               err("can't open '%s' as rules file: %s", filename, strerror(errno));
                return -1;
        }
        dbg("reading '%s' as rules file", filename);
@@ -557,11 +636,6 @@ static int parse_file(struct udev_rules *rules, const char *filename)
                cur += count+1;
                lineno++;
 
-               if (count >= sizeof(line)) {
-                       info("line too long, rule skipped %s, line %d", filename, lineno);
-                       continue;
-               }
-
                /* eat the whitespace */
                while ((count > 0) && isspace(bufline[0])) {
                        bufline++;
@@ -574,7 +648,12 @@ static int parse_file(struct udev_rules *rules, const char *filename)
                if (bufline[0] == COMMENT_CHARACTER)
                        continue;
 
-               /* skip backslash and newline from multi line rules */
+               if (count >= sizeof(line)) {
+                       err("line too long, rule skipped '%s:%u'", filename, lineno);
+                       continue;
+               }
+
+               /* skip backslash and newline from multiline rules */
                for (i = j = 0; i < count; i++) {
                        if (bufline[i] == '\\' && bufline[i+1] == '\n')
                                continue;
@@ -584,49 +663,21 @@ static int parse_file(struct udev_rules *rules, const char *filename)
                line[j] = '\0';
 
                dbg("read '%s'", line);
-               add_to_rules(rules, line);
+               add_to_rules(rules, line, filename, lineno);
        }
 
        file_unmap(buf, bufsize);
        return retval;
 }
 
-static int rules_map(struct udev_rules *rules, const char *filename)
+int udev_rules_init(struct udev_rules *rules, int resolve_names)
 {
-       if (file_map(filename, &rules->buf, &rules->bufsize)) {
-               rules->buf = NULL;
-               return -1;
-       }
-       if (rules->bufsize == 0) {
-               file_unmap(rules->buf, rules->bufsize);
-               rules->buf = NULL;
-               return -1;
-       }
-       rules->mapped = 1;
-
-       return 0;
-}
-
-int udev_rules_init(struct udev_rules *rules, int read_compiled, int resolve_names)
-{
-       char comp[PATH_SIZE];
        struct stat stats;
        int retval;
 
        memset(rules, 0x00, sizeof(struct udev_rules));
        rules->resolve_names = resolve_names;
 
-       /* check for precompiled rules */
-       if (read_compiled) {
-               strlcpy(comp, udev_rules_filename, sizeof(comp));
-               strlcat(comp, ".compiled", sizeof(comp));
-               if (stat(comp, &stats) == 0) {
-                       dbg("map compiled rules '%s'", comp);
-                       if (rules_map(rules, comp) == 0)
-                               return 0;
-               }
-       }
-
        /* parse rules file or all matching files in directory */
        if (stat(udev_rules_filename, &stats) != 0)
                return -1;
@@ -642,7 +693,13 @@ int udev_rules_init(struct udev_rules *rules, int read_compiled, int resolve_nam
                retval = add_matching_files(&name_list, udev_rules_filename, RULEFILE_SUFFIX);
 
                list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
-                       parse_file(rules, name_loop->name);
+                       if (stat(name_loop->name, &stats) == 0) {
+                               if (stats.st_size)
+                                       parse_file(rules, name_loop->name);
+                               else
+                                       dbg("empty rules file '%s'", name_loop->name);
+                       } else
+                               err("could not read '%s': %s", name_loop->name, strerror(errno));
                        list_del(&name_loop->node);
                        free(name_loop);
                }
@@ -651,14 +708,10 @@ int udev_rules_init(struct udev_rules *rules, int read_compiled, int resolve_nam
        return retval;
 }
 
-void udev_rules_close(struct udev_rules *rules)
+void udev_rules_cleanup(struct udev_rules *rules)
 {
        if (rules->buf) {
-               if (rules->mapped) {
-                       rules->mapped = 0;
-                       file_unmap(rules->buf, rules->bufsize);
-               } else
-                       free(rules->buf);
+               free(rules->buf);
                rules->buf = NULL;
        }
 }