2 * Copyright (C) 2003,2004 Greg Kroah-Hartman <greg@kroah.com>
3 * Copyright (C) 2003-2006 Kay Sievers <kay.sievers@vrfy.org>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 #include "udev_rules.h"
33 void udev_rules_iter_init(struct udev_rules *rules)
35 dbg("bufsize=%zi", rules->bufsize);
39 struct udev_rule *udev_rules_iter_next(struct udev_rules *rules)
41 static struct udev_rule *rule;
46 dbg("current=%zi", rules->current);
47 if (rules->current >= rules->bufsize) {
53 rule = (struct udev_rule *) (rules->buf + rules->current);
54 rules->current += sizeof(struct udev_rule) + rule->bufsize;
59 struct udev_rule *udev_rules_iter_label(struct udev_rules *rules, const char *label)
61 static struct udev_rule *rule;
64 dbg("current=%zi", rules->current);
65 if (rules->current >= rules->bufsize) {
69 rule = (struct udev_rule *) (rules->buf + rules->current);
71 if (strcmp(&rule->buf[rule->label.val_off], label) != 0) {
72 dbg("moving forward, looking for label '%s'", label);
73 rules->current += sizeof(struct udev_rule) + rule->bufsize;
77 dbg("found label '%s'", label);
81 static int get_key(char **line, char **key, enum key_operation *operation, char **value)
87 if (linepos == NULL && linepos[0] == '\0')
91 while (isspace(linepos[0]) || linepos[0] == ',')
95 if (linepos[0] == '\0')
101 if (linepos[0] == '\0')
103 if (isspace(linepos[0]))
105 if (linepos[0] == '=')
107 if (linepos[0] == '+')
109 if (linepos[0] == '!')
111 if (linepos[0] == ':')
115 /* remember end of key */
118 /* skip whitespace after key */
119 while (isspace(linepos[0]))
121 if (linepos[0] == '\0')
124 /* get operation type */
125 if (linepos[0] == '=' && linepos[1] == '=') {
126 *operation = KEY_OP_MATCH;
128 dbg("operator=match");
129 } else if (linepos[0] == '!' && linepos[1] == '=') {
130 *operation = KEY_OP_NOMATCH;
132 dbg("operator=nomatch");
133 } else if (linepos[0] == '+' && linepos[1] == '=') {
134 *operation = KEY_OP_ADD;
137 } else if (linepos[0] == '=') {
138 *operation = KEY_OP_ASSIGN;
140 dbg("operator=assign");
141 } else if (linepos[0] == ':' && linepos[1] == '=') {
142 *operation = KEY_OP_ASSIGN_FINAL;
144 dbg("operator=assign_final");
150 dbg("key='%s'", *key);
152 /* skip whitespace after operator */
153 while (isspace(linepos[0]))
155 if (linepos[0] == '\0')
159 if (linepos[0] == '"')
165 temp = strchr(linepos, '"');
170 dbg("value='%s'", *value);
172 /* move line to next key */
178 /* extract possible KEY{attr} */
179 static char *get_key_attribute(char *str)
184 attr = strchr(str, '{');
187 pos = strchr(attr, '}');
189 err("missing closing brace for format");
193 dbg("attribute='%s'", attr);
200 static int add_rule_key(struct udev_rule *rule, struct key *key,
201 enum key_operation operation, const char *value)
203 size_t val_len = strnlen(value, PATH_SIZE);
205 key->operation = operation;
207 key->val_off = rule->bufsize;
208 strlcpy(rule->buf + rule->bufsize, value, val_len+1);
209 rule->bufsize += val_len+1;
214 static int add_rule_key_pair(struct udev_rule *rule, struct key_pairs *pairs,
215 enum key_operation operation, const char *key, const char *value)
217 size_t key_len = strnlen(key, PATH_SIZE);
219 if (pairs->count >= PAIRS_MAX) {
220 err("skip, too many keys of the same type in a single rule");
224 add_rule_key(rule, &pairs->keys[pairs->count].key, operation, value);
226 /* add the key-name of the pair */
227 pairs->keys[pairs->count].key_name_off = rule->bufsize;
228 strlcpy(rule->buf + rule->bufsize, key, key_len+1);
229 rule->bufsize += key_len+1;
236 static int add_to_rules(struct udev_rules *rules, char *line, const char *filename, unsigned int lineno)
238 struct udev_rule *rule;
247 /* get all the keys */
248 rule = calloc(1, sizeof (struct udev_rule) + LINE_SIZE);
250 err("malloc failed");
259 enum key_operation operation = KEY_OP_UNSET;
261 retval = get_key(&linepos, &key, &operation, &value);
265 if (strcasecmp(key, "ACTION") == 0) {
266 if (operation != KEY_OP_MATCH &&
267 operation != KEY_OP_NOMATCH) {
268 err("invalid ACTION operation");
271 add_rule_key(rule, &rule->action, operation, value);
276 if (strcasecmp(key, "DEVPATH") == 0) {
277 if (operation != KEY_OP_MATCH &&
278 operation != KEY_OP_NOMATCH) {
279 err("invalid DEVPATH operation");
282 add_rule_key(rule, &rule->devpath, operation, value);
287 if (strcasecmp(key, "KERNEL") == 0) {
288 if (operation != KEY_OP_MATCH &&
289 operation != KEY_OP_NOMATCH) {
290 err("invalid KERNEL operation");
293 add_rule_key(rule, &rule->kernel, operation, value);
298 if (strcasecmp(key, "SUBSYSTEM") == 0) {
299 if (operation != KEY_OP_MATCH &&
300 operation != KEY_OP_NOMATCH) {
301 err("invalid SUBSYSTEM operation");
304 add_rule_key(rule, &rule->subsystem, operation, value);
309 if (strcasecmp(key, "DRIVER") == 0) {
310 if (operation != KEY_OP_MATCH &&
311 operation != KEY_OP_NOMATCH) {
312 err("invalid DRIVER operation");
315 err("DRIVER== will change in a future relase, "
316 "please use DRIVERS== in %s:%u", filename, lineno);
317 /* FIXME: this should be rule->driver to match only the event device */
318 add_rule_key(rule, &rule->drivers, operation, value);
323 if (strncasecmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
324 attr = get_key_attribute(key + sizeof("ATTR")-1);
326 err("error parsing ATTR attribute");
329 if (add_rule_key_pair(rule, &rule->attr, operation, attr, value) != 0)
335 if (strcasecmp(key, "KERNELS") == 0 ||
336 strcasecmp(key, "ID") == 0) {
337 if (operation != KEY_OP_MATCH &&
338 operation != KEY_OP_NOMATCH) {
339 err("invalid KERNELS operation");
342 add_rule_key(rule, &rule->kernels, operation, value);
347 if (strcasecmp(key, "SUBSYSTEMS") == 0 ||
348 strcasecmp(key, "BUS") == 0) {
349 if (operation != KEY_OP_MATCH &&
350 operation != KEY_OP_NOMATCH) {
351 err("invalid SUBSYSTEMS operation");
354 add_rule_key(rule, &rule->subsystems, operation, value);
359 if (strcasecmp(key, "DRIVERS") == 0) {
360 if (operation != KEY_OP_MATCH &&
361 operation != KEY_OP_NOMATCH) {
362 err("invalid DRIVERS operation");
365 add_rule_key(rule, &rule->drivers, operation, value);
370 if (strncasecmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0 ||
371 strncasecmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
372 attr = get_key_attribute(key + sizeof("ATTRS")-1);
374 err("error parsing ATTRS attribute");
377 if (strncmp(attr, "device/", 7) == 0)
378 err("the 'device' link is deprecated and will be removed from a future kernel, "
379 "please fix it in %s:%u", filename, lineno);
380 else if (strchr(attr, '/') != NULL)
381 err("do not reference parent sysfs directories directly, that may break with a future kernel, "
382 "please fix it in %s:%u", filename, lineno);
383 if (add_rule_key_pair(rule, &rule->attrs, operation, attr, value) != 0)
389 if (strncasecmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
390 attr = get_key_attribute(key + sizeof("ENV")-1);
392 err("error parsing ENV attribute");
395 if (strncmp(attr, "PHYSDEV", 7) == 0)
397 if (add_rule_key_pair(rule, &rule->env, operation, attr, value) != 0)
403 if (strcasecmp(key, "PROGRAM") == 0) {
404 add_rule_key(rule, &rule->program, operation, value);
409 if (strcasecmp(key, "RESULT") == 0) {
410 if (operation != KEY_OP_MATCH &&
411 operation != KEY_OP_NOMATCH) {
412 err("invalid RESULT operation");
415 add_rule_key(rule, &rule->result, operation, value);
420 if (strncasecmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
421 attr = get_key_attribute(key + sizeof("IMPORT")-1);
422 if (attr && strstr(attr, "program")) {
423 dbg("IMPORT will be executed");
424 rule->import_type = IMPORT_PROGRAM;
425 } else if (attr && strstr(attr, "file")) {
426 dbg("IMPORT will be included as file");
427 rule->import_type = IMPORT_FILE;
428 } else if (attr && strstr(attr, "parent")) {
429 dbg("IMPORT will include the parent values");
430 rule->import_type = IMPORT_PARENT;
432 /* figure it out if it is executable */
433 char file[PATH_SIZE];
437 strlcpy(file, value, sizeof(file));
438 pos = strchr(file, ' ');
442 /* allow programs in /lib/udev called without the path */
443 if (strchr(file, '/') == NULL) {
444 strlcpy(file, "/lib/udev/", sizeof(file));
445 strlcat(file, value, sizeof(file));
446 pos = strchr(file, ' ');
451 dbg("IMPORT auto mode for '%s'", file);
452 if (!lstat(file, &stats) && (stats.st_mode & S_IXUSR)) {
453 dbg("IMPORT is executable, will be executed (autotype)");
454 rule->import_type = IMPORT_PROGRAM;
456 dbg("IMPORT is not executable, will be included as file (autotype)");
457 rule->import_type = IMPORT_FILE;
460 add_rule_key(rule, &rule->import, operation, value);
465 if (strcasecmp(key, "RUN") == 0) {
466 add_rule_key(rule, &rule->run, operation, value);
471 if (strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
472 add_rule_key(rule, &rule->wait_for_sysfs, operation, value);
477 if (strcasecmp(key, "LABEL") == 0) {
478 add_rule_key(rule, &rule->label, operation, value);
483 if (strcasecmp(key, "GOTO") == 0) {
484 add_rule_key(rule, &rule->goto_label, operation, value);
489 if (strncasecmp(key, "NAME", sizeof("NAME")-1) == 0) {
490 attr = get_key_attribute(key + sizeof("NAME")-1);
492 if (strstr(attr, "all_partitions") != NULL) {
493 dbg("creation of partition nodes requested");
494 rule->partitions = DEFAULT_PARTITIONS_COUNT;
496 if (strstr(attr, "ignore_remove") != NULL) {
497 dbg("remove event should be ignored");
498 rule->ignore_remove = 1;
501 if (value[0] == '\0')
502 dbg("name empty, node creation supressed");
503 add_rule_key(rule, &rule->name, operation, value);
507 if (strcasecmp(key, "SYMLINK") == 0) {
508 add_rule_key(rule, &rule->symlink, operation, value);
513 if (strcasecmp(key, "OWNER") == 0) {
515 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
517 strtoul(value, &endptr, 10);
518 if (endptr[0] != '\0') {
520 uid_t uid = lookup_user(value);
521 dbg("replacing username='%s' by id=%i", value, uid);
522 sprintf(owner, "%u", (unsigned int) uid);
523 add_rule_key(rule, &rule->owner, operation, owner);
528 add_rule_key(rule, &rule->owner, operation, value);
532 if (strcasecmp(key, "GROUP") == 0) {
534 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
536 strtoul(value, &endptr, 10);
537 if (endptr[0] != '\0') {
539 gid_t gid = lookup_group(value);
540 dbg("replacing groupname='%s' by id=%i", value, gid);
541 sprintf(group, "%u", (unsigned int) gid);
542 add_rule_key(rule, &rule->group, operation, group);
547 add_rule_key(rule, &rule->group, operation, value);
551 if (strcasecmp(key, "MODE") == 0) {
552 rule->mode = strtol(value, NULL, 8);
553 rule->mode_operation = operation;
558 if (strcasecmp(key, "OPTIONS") == 0) {
559 if (strstr(value, "last_rule") != NULL) {
560 dbg("last rule to be applied");
563 if (strstr(value, "ignore_device") != NULL) {
564 dbg("device should be ignored");
565 rule->ignore_device = 1;
567 if (strstr(value, "ignore_remove") != NULL) {
568 dbg("remove event should be ignored");
569 rule->ignore_remove = 1;
571 if (strstr(value, "all_partitions") != NULL) {
572 dbg("creation of partition nodes requested");
573 rule->partitions = DEFAULT_PARTITIONS_COUNT;
579 err("unknown key '%s' in %s:%u", key, filename, lineno);
582 if (physdev && rule->wait_for_sysfs.operation == KEY_OP_UNSET)
583 err("PHYSDEV* values are deprecated and will be removed from a future kernel, "
584 "please fix it in %s:%u", filename, lineno);
586 /* skip line if not any valid key was found */
590 /* grow buffer and add rule */
591 rule_size = sizeof(struct udev_rule) + rule->bufsize;
592 padding = (sizeof(size_t) - rule_size % sizeof(size_t)) % sizeof(size_t);
593 dbg("add %zi padding bytes", padding);
594 rule_size += padding;
595 rule->bufsize += padding;
597 rules->buf = realloc(rules->buf, rules->bufsize + rule_size);
599 err("realloc failed");
602 dbg("adding rule to offset %zi", rules->bufsize);
603 memcpy(rules->buf + rules->bufsize, rule, rule_size);
604 rules->bufsize += rule_size;
611 err("invalid rule '%s:%u'", filename, lineno);
615 static int parse_file(struct udev_rules *rules, const char *filename)
617 char line[LINE_SIZE];
626 if (file_map(filename, &buf, &bufsize) != 0) {
627 err("can't open '%s' as rules file: %s", filename, strerror(errno));
630 info("reading '%s' as rules file", filename);
632 /* loop through the whole file */
635 while (cur < bufsize) {
638 count = buf_get_line(buf, bufsize, cur);
643 /* eat the whitespace */
644 while ((count > 0) && isspace(bufline[0])) {
651 /* see if this is a comment */
652 if (bufline[0] == COMMENT_CHARACTER)
655 if (count >= sizeof(line)) {
656 err("line too long, rule skipped '%s:%u'", filename, lineno);
660 /* skip backslash and newline from multiline rules */
661 for (i = j = 0; i < count; i++) {
662 if (bufline[i] == '\\' && bufline[i+1] == '\n')
665 line[j++] = bufline[i];
669 dbg("read '%s'", line);
670 add_to_rules(rules, line, filename, lineno);
673 file_unmap(buf, bufsize);
677 int udev_rules_init(struct udev_rules *rules, int resolve_names)
682 memset(rules, 0x00, sizeof(struct udev_rules));
683 rules->resolve_names = resolve_names;
685 /* parse rules file or all matching files in directory */
686 if (stat(udev_rules_dir, &stats) != 0)
689 if ((stats.st_mode & S_IFMT) != S_IFDIR) {
690 dbg("parse single rules file '%s'", udev_rules_dir);
691 retval = parse_file(rules, udev_rules_dir);
693 struct name_entry *name_loop, *name_tmp;
694 LIST_HEAD(name_list);
696 dbg("parse rules directory '%s'", udev_rules_dir);
697 retval = add_matching_files(&name_list, udev_rules_dir, RULESFILE_SUFFIX);
699 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
700 if (stat(name_loop->name, &stats) == 0) {
702 parse_file(rules, name_loop->name);
704 dbg("empty rules file '%s'", name_loop->name);
706 err("could not read '%s': %s", name_loop->name, strerror(errno));
707 list_del(&name_loop->node);
715 void udev_rules_cleanup(struct udev_rules *rules)