2 * Copyright (C) 2003,2004 Greg Kroah-Hartman <greg@kroah.com>
3 * Copyright (C) 2003-2008 Kay Sievers <kay.sievers@vrfy.org>
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #include "udev_rules.h"
32 void udev_rules_iter_init(struct udev_rules_iter *iter, struct udev_rules *rules)
34 dbg(rules->udev, "bufsize=%zi\n", rules->bufsize);
39 struct udev_rule *udev_rules_iter_next(struct udev_rules_iter *iter)
41 struct udev_rules *rules;
42 struct udev_rule *rule;
48 dbg(rules->udev, "current=%zi\n", iter->current);
49 if (iter->current >= rules->bufsize) {
50 dbg(rules->udev, "no more rules\n");
55 rule = (struct udev_rule *) (rules->buf + iter->current);
56 iter->current += sizeof(struct udev_rule) + rule->bufsize;
61 struct udev_rule *udev_rules_iter_goto(struct udev_rules_iter *iter, size_t rule_off)
63 struct udev_rules *rules = iter->rules;
64 struct udev_rule *rule;
66 dbg(rules->udev, "current=%zi\n", iter->current);
67 iter->current = rule_off;
68 rule = (struct udev_rule *) (rules->buf + iter->current);
73 static size_t find_label(const struct udev_rules_iter *iter, const char *label)
75 struct udev_rule *rule;
76 struct udev_rules *rules = iter->rules;
77 size_t current = iter->current;
80 dbg(rules->udev, "current=%zi\n", current);
81 if (current >= rules->bufsize) {
82 dbg(rules->udev, "LABEL='%s' not found\n", label);
85 rule = (struct udev_rule *) (rules->buf + current);
87 if (strcmp(&rule->buf[rule->label.val_off], label) != 0) {
88 dbg(rules->udev, "moving forward, looking for label '%s'\n", label);
89 current += sizeof(struct udev_rule) + rule->bufsize;
93 dbg(rules->udev, "found label '%s'\n", label);
97 static int get_key(struct udev_rules *rules, char **line, char **key, enum key_operation *operation, char **value)
103 if (linepos == NULL && linepos[0] == '\0')
106 /* skip whitespace */
107 while (isspace(linepos[0]) || linepos[0] == ',')
111 if (linepos[0] == '\0')
117 if (linepos[0] == '\0')
119 if (isspace(linepos[0]))
121 if (linepos[0] == '=')
123 if ((linepos[0] == '+') || (linepos[0] == '!') || (linepos[0] == ':'))
124 if (linepos[1] == '=')
128 /* remember end of key */
131 /* skip whitespace after key */
132 while (isspace(linepos[0]))
134 if (linepos[0] == '\0')
137 /* get operation type */
138 if (linepos[0] == '=' && linepos[1] == '=') {
139 *operation = KEY_OP_MATCH;
141 dbg(rules->udev, "operator=match\n");
142 } else if (linepos[0] == '!' && linepos[1] == '=') {
143 *operation = KEY_OP_NOMATCH;
145 dbg(rules->udev, "operator=nomatch\n");
146 } else if (linepos[0] == '+' && linepos[1] == '=') {
147 *operation = KEY_OP_ADD;
149 dbg(rules->udev, "operator=add\n");
150 } else if (linepos[0] == '=') {
151 *operation = KEY_OP_ASSIGN;
153 dbg(rules->udev, "operator=assign\n");
154 } else if (linepos[0] == ':' && linepos[1] == '=') {
155 *operation = KEY_OP_ASSIGN_FINAL;
157 dbg(rules->udev, "operator=assign_final\n");
163 dbg(rules->udev, "key='%s'\n", *key);
165 /* skip whitespace after operator */
166 while (isspace(linepos[0]))
168 if (linepos[0] == '\0')
172 if (linepos[0] == '"')
178 temp = strchr(linepos, '"');
183 dbg(rules->udev, "value='%s'\n", *value);
185 /* move line to next key */
191 /* extract possible KEY{attr} */
192 static char *get_key_attribute(struct udev_rules *rules, char *str)
197 attr = strchr(str, '{');
200 pos = strchr(attr, '}');
202 err(rules->udev, "missing closing brace for format\n");
206 dbg(rules->udev, "attribute='%s'\n", attr);
213 static int add_rule_key(struct udev_rule *rule, struct key *key,
214 enum key_operation operation, const char *value)
216 size_t val_len = strnlen(value, UTIL_PATH_SIZE);
218 key->operation = operation;
220 key->val_off = rule->bufsize;
221 util_strlcpy(rule->buf + rule->bufsize, value, val_len+1);
222 rule->bufsize += val_len+1;
227 static int add_rule_key_pair(struct udev_rules *rules, struct udev_rule *rule, struct key_pairs *pairs,
228 enum key_operation operation, const char *key, const char *value)
230 size_t key_len = strnlen(key, UTIL_PATH_SIZE);
232 if (pairs->count >= PAIRS_MAX) {
233 err(rules->udev, "skip, too many keys of the same type in a single rule\n");
237 add_rule_key(rule, &pairs->keys[pairs->count].key, operation, value);
239 /* add the key-name of the pair */
240 pairs->keys[pairs->count].key_name_off = rule->bufsize;
241 util_strlcpy(rule->buf + rule->bufsize, key, key_len+1);
242 rule->bufsize += key_len+1;
249 static int add_to_rules(struct udev_rules *rules, char *line, const char *filename, unsigned int lineno)
251 char buf[sizeof(struct udev_rule) + UTIL_LINE_SIZE];
252 struct udev_rule *rule;
261 memset(buf, 0x00, sizeof(buf));
262 rule = (struct udev_rule *) buf;
263 rule->event_timeout = -1;
267 /* get all the keys */
271 enum key_operation operation = KEY_OP_UNSET;
273 retval = get_key(rules, &linepos, &key, &operation, &value);
277 if (strcasecmp(key, "ACTION") == 0) {
278 if (operation != KEY_OP_MATCH &&
279 operation != KEY_OP_NOMATCH) {
280 err(rules->udev, "invalid ACTION operation\n");
283 add_rule_key(rule, &rule->action, operation, value);
288 if (strcasecmp(key, "DEVPATH") == 0) {
289 if (operation != KEY_OP_MATCH &&
290 operation != KEY_OP_NOMATCH) {
291 err(rules->udev, "invalid DEVPATH operation\n");
294 add_rule_key(rule, &rule->devpath, operation, value);
299 if (strcasecmp(key, "KERNEL") == 0) {
300 if (operation != KEY_OP_MATCH &&
301 operation != KEY_OP_NOMATCH) {
302 err(rules->udev, "invalid KERNEL operation\n");
305 add_rule_key(rule, &rule->kernel, operation, value);
310 if (strcasecmp(key, "SUBSYSTEM") == 0) {
311 if (operation != KEY_OP_MATCH &&
312 operation != KEY_OP_NOMATCH) {
313 err(rules->udev, "invalid SUBSYSTEM operation\n");
316 /* bus, class, subsystem events should all be the same */
317 if (strcmp(value, "subsystem") == 0 ||
318 strcmp(value, "bus") == 0 ||
319 strcmp(value, "class") == 0) {
320 if (strcmp(value, "bus") == 0 || strcmp(value, "class") == 0)
321 err(rules->udev, "'%s' must be specified as 'subsystem' \n"
322 "please fix it in %s:%u", value, filename, lineno);
323 add_rule_key(rule, &rule->subsystem, operation, "subsystem|class|bus");
325 add_rule_key(rule, &rule->subsystem, operation, value);
330 if (strcasecmp(key, "DRIVER") == 0) {
331 if (operation != KEY_OP_MATCH &&
332 operation != KEY_OP_NOMATCH) {
333 err(rules->udev, "invalid DRIVER operation\n");
336 add_rule_key(rule, &rule->driver, operation, value);
341 if (strncasecmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
342 attr = get_key_attribute(rules, key + sizeof("ATTR")-1);
344 err(rules->udev, "error parsing ATTR attribute\n");
347 if (add_rule_key_pair(rules, rule, &rule->attr, operation, attr, value) != 0)
353 if (strcasecmp(key, "KERNELS") == 0 ||
354 strcasecmp(key, "ID") == 0) {
355 if (operation != KEY_OP_MATCH &&
356 operation != KEY_OP_NOMATCH) {
357 err(rules->udev, "invalid KERNELS operation\n");
360 add_rule_key(rule, &rule->kernels, operation, value);
365 if (strcasecmp(key, "SUBSYSTEMS") == 0 ||
366 strcasecmp(key, "BUS") == 0) {
367 if (operation != KEY_OP_MATCH &&
368 operation != KEY_OP_NOMATCH) {
369 err(rules->udev, "invalid SUBSYSTEMS operation\n");
372 add_rule_key(rule, &rule->subsystems, operation, value);
377 if (strcasecmp(key, "DRIVERS") == 0) {
378 if (operation != KEY_OP_MATCH &&
379 operation != KEY_OP_NOMATCH) {
380 err(rules->udev, "invalid DRIVERS operation\n");
383 add_rule_key(rule, &rule->drivers, operation, value);
388 if (strncasecmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0 ||
389 strncasecmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
390 if (operation != KEY_OP_MATCH &&
391 operation != KEY_OP_NOMATCH) {
392 err(rules->udev, "invalid ATTRS operation\n");
395 attr = get_key_attribute(rules, key + sizeof("ATTRS")-1);
397 err(rules->udev, "error parsing ATTRS attribute\n");
400 if (strncmp(attr, "device/", 7) == 0)
401 err(rules->udev, "the 'device' link is deprecated and will be removed from a future kernel, \n"
402 "please fix it in %s:%u", filename, lineno);
403 else if (strstr(attr, "../") != NULL)
404 err(rules->udev, "do not reference parent sysfs directories directly, that may break with a future kernel, \n"
405 "please fix it in %s:%u", filename, lineno);
406 if (add_rule_key_pair(rules, rule, &rule->attrs, operation, attr, value) != 0)
412 if (strncasecmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
413 attr = get_key_attribute(rules, key + sizeof("ENV")-1);
415 err(rules->udev, "error parsing ENV attribute\n");
418 if (strncmp(attr, "PHYSDEV", 7) == 0)
420 if (add_rule_key_pair(rules, rule, &rule->env, operation, attr, value) != 0)
426 if (strcasecmp(key, "PROGRAM") == 0) {
427 add_rule_key(rule, &rule->program, operation, value);
432 if (strcasecmp(key, "RESULT") == 0) {
433 if (operation != KEY_OP_MATCH &&
434 operation != KEY_OP_NOMATCH) {
435 err(rules->udev, "invalid RESULT operation\n");
438 add_rule_key(rule, &rule->result, operation, value);
443 if (strncasecmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
444 attr = get_key_attribute(rules, key + sizeof("IMPORT")-1);
445 if (attr != NULL && strstr(attr, "program")) {
446 dbg(rules->udev, "IMPORT will be executed\n");
447 rule->import_type = IMPORT_PROGRAM;
448 } else if (attr != NULL && strstr(attr, "file")) {
449 dbg(rules->udev, "IMPORT will be included as file\n");
450 rule->import_type = IMPORT_FILE;
451 } else if (attr != NULL && strstr(attr, "parent")) {
452 dbg(rules->udev, "IMPORT will include the parent values\n");
453 rule->import_type = IMPORT_PARENT;
455 /* figure it out if it is executable */
456 char file[UTIL_PATH_SIZE];
460 util_strlcpy(file, value, sizeof(file));
461 pos = strchr(file, ' ');
465 /* allow programs in /lib/udev called without the path */
466 if (strchr(file, '/') == NULL) {
467 util_strlcpy(file, UDEV_PREFIX "/lib/udev/", sizeof(file));
468 util_strlcat(file, value, sizeof(file));
469 pos = strchr(file, ' ');
474 dbg(rules->udev, "IMPORT auto mode for '%s'\n", file);
475 if (!lstat(file, &statbuf) && (statbuf.st_mode & S_IXUSR)) {
476 dbg(rules->udev, "IMPORT is executable, will be executed (autotype)\n");
477 rule->import_type = IMPORT_PROGRAM;
479 dbg(rules->udev, "IMPORT is not executable, will be included as file (autotype)\n");
480 rule->import_type = IMPORT_FILE;
483 add_rule_key(rule, &rule->import, operation, value);
488 if (strncasecmp(key, "TEST", sizeof("TEST")-1) == 0) {
489 if (operation != KEY_OP_MATCH &&
490 operation != KEY_OP_NOMATCH) {
491 err(rules->udev, "invalid TEST operation\n");
494 attr = get_key_attribute(rules, key + sizeof("TEST")-1);
496 rule->test_mode_mask = strtol(attr, NULL, 8);
497 add_rule_key(rule, &rule->test, operation, value);
502 if (strncasecmp(key, "RUN", sizeof("RUN")-1) == 0) {
503 attr = get_key_attribute(rules, key + sizeof("RUN")-1);
505 if (strstr(attr, "ignore_error"))
506 rule->run_ignore_error = 1;
508 add_rule_key(rule, &rule->run, operation, value);
513 if (strcasecmp(key, "WAIT_FOR") == 0 || strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
514 add_rule_key(rule, &rule->wait_for, operation, value);
519 if (strcasecmp(key, "LABEL") == 0) {
520 add_rule_key(rule, &rule->label, operation, value);
525 if (strcasecmp(key, "GOTO") == 0) {
526 add_rule_key(rule, &rule->goto_label, operation, value);
531 if (strncasecmp(key, "NAME", sizeof("NAME")-1) == 0) {
532 attr = get_key_attribute(rules, key + sizeof("NAME")-1);
534 if (strstr(attr, "all_partitions") != NULL) {
535 dbg(rules->udev, "creation of partition nodes requested\n");
536 rule->partitions = DEFAULT_PARTITIONS_COUNT;
538 if (strstr(attr, "ignore_remove") != NULL) {
539 dbg(rules->udev, "remove event should be ignored\n");
540 rule->ignore_remove = 1;
543 if (value[0] == '\0')
544 dbg(rules->udev, "name empty, node creation supressed\n");
545 add_rule_key(rule, &rule->name, operation, value);
549 if (strcasecmp(key, "SYMLINK") == 0) {
550 if (operation == KEY_OP_MATCH ||
551 operation == KEY_OP_NOMATCH)
552 add_rule_key(rule, &rule->symlink_match, operation, value);
554 add_rule_key(rule, &rule->symlink, operation, value);
559 if (strcasecmp(key, "OWNER") == 0) {
561 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
563 strtoul(value, &endptr, 10);
564 if (endptr[0] != '\0') {
566 uid_t uid = lookup_user(rules->udev, value);
567 dbg(rules->udev, "replacing username='%s' by id=%i\n", value, uid);
568 sprintf(owner, "%u", (unsigned int) uid);
569 add_rule_key(rule, &rule->owner, operation, owner);
574 add_rule_key(rule, &rule->owner, operation, value);
578 if (strcasecmp(key, "GROUP") == 0) {
580 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
582 strtoul(value, &endptr, 10);
583 if (endptr[0] != '\0') {
585 gid_t gid = lookup_group(rules->udev, value);
586 dbg(rules->udev, "replacing groupname='%s' by id=%i\n", value, gid);
587 sprintf(group, "%u", (unsigned int) gid);
588 add_rule_key(rule, &rule->group, operation, group);
593 add_rule_key(rule, &rule->group, operation, value);
597 if (strcasecmp(key, "MODE") == 0) {
598 add_rule_key(rule, &rule->mode, operation, value);
603 if (strcasecmp(key, "OPTIONS") == 0) {
606 if (strstr(value, "last_rule") != NULL) {
607 dbg(rules->udev, "last rule to be applied\n");
610 if (strstr(value, "ignore_device") != NULL) {
611 dbg(rules->udev, "device should be ignored\n");
612 rule->ignore_device = 1;
614 if (strstr(value, "ignore_remove") != NULL) {
615 dbg(rules->udev, "remove event should be ignored\n");
616 rule->ignore_remove = 1;
618 pos = strstr(value, "link_priority=");
620 rule->link_priority = atoi(&pos[strlen("link_priority=")]);
621 dbg(rules->udev, "link priority=%i\n", rule->link_priority);
623 pos = strstr(value, "event_timeout=");
625 rule->event_timeout = atoi(&pos[strlen("event_timeout=")]);
626 dbg(rules->udev, "event timout=%i\n", rule->event_timeout);
628 pos = strstr(value, "string_escape=");
630 pos = &pos[strlen("string_escape=")];
631 if (strncmp(pos, "none", strlen("none")) == 0)
632 rule->string_escape = ESCAPE_NONE;
633 else if (strncmp(pos, "replace", strlen("replace")) == 0)
634 rule->string_escape = ESCAPE_REPLACE;
636 if (strstr(value, "all_partitions") != NULL) {
637 dbg(rules->udev, "creation of partition nodes requested\n");
638 rule->partitions = DEFAULT_PARTITIONS_COUNT;
644 err(rules->udev, "unknown key '%s' in %s:%u\n", key, filename, lineno);
647 if (physdev && rule->wait_for.operation == KEY_OP_UNSET)
648 err(rules->udev, "PHYSDEV* values are deprecated and will be removed from a future kernel, \n"
649 "please fix it in %s:%u", filename, lineno);
651 /* skip line if not any valid key was found */
655 /* grow buffer and add rule */
656 rule_size = sizeof(struct udev_rule) + rule->bufsize;
657 padding = (sizeof(size_t) - rule_size % sizeof(size_t)) % sizeof(size_t);
658 dbg(rules->udev, "add %zi padding bytes\n", padding);
659 rule_size += padding;
660 rule->bufsize += padding;
662 rules->buf = realloc(rules->buf, rules->bufsize + rule_size);
664 err(rules->udev, "realloc failed\n");
667 dbg(rules->udev, "adding rule to offset %zi\n", rules->bufsize);
668 memcpy(rules->buf + rules->bufsize, rule, rule_size);
669 rules->bufsize += rule_size;
674 err(rules->udev, "invalid rule '%s:%u'\n", filename, lineno);
678 static int parse_file(struct udev_rules *rules, const char *filename)
680 char line[UTIL_LINE_SIZE];
689 struct udev_rule *rule;
690 struct udev_rules_iter iter;
692 start = rules->bufsize;
694 if (file_map(filename, &buf, &bufsize) != 0) {
695 err(rules->udev, "can't open '%s' as rules file: %m\n", filename);
698 info(rules->udev, "reading '%s' as rules file\n", filename);
700 /* loop through the whole file */
703 while (cur < bufsize) {
706 count = buf_get_line(buf, bufsize, cur);
711 /* eat the whitespace */
712 while ((count > 0) && isspace(bufline[0])) {
719 /* see if this is a comment */
720 if (bufline[0] == '#')
723 if (count >= sizeof(line)) {
724 err(rules->udev, "line too long, rule skipped '%s:%u'\n", filename, lineno);
728 /* skip backslash and newline from multiline rules */
729 for (i = j = 0; i < count; i++) {
730 if (bufline[i] == '\\' && bufline[i+1] == '\n')
733 line[j++] = bufline[i];
737 dbg(rules->udev, "read '%s'\n", line);
738 add_to_rules(rules, line, filename, lineno);
741 /* Compute all goto targets within this file */
742 udev_rules_iter_init(&iter, rules);
743 udev_rules_iter_goto(&iter, start);
744 while((rule = udev_rules_iter_next(&iter))) {
745 if (rule->goto_label.operation != KEY_OP_UNSET) {
746 char *goto_label = &rule->buf[rule->goto_label.val_off];
748 dbg(rules->udev, "resolving goto label '%s'\n", goto_label);
749 rule->goto_rule_off = find_label(&iter, goto_label);
750 if (rule->goto_rule_off == 0) {
751 err(rules->udev, "ignore goto to nonexistent label '%s' in '%s'\n",
752 goto_label, filename);
753 rule->goto_rule_off = iter.current;
758 file_unmap(buf, bufsize);
762 int udev_rules_init(struct udev *udev, struct udev_rules *rules, int resolve_names)
765 char filename[PATH_MAX];
766 LIST_HEAD(name_list);
767 LIST_HEAD(sort_list);
768 struct name_entry *name_loop, *name_tmp;
769 struct name_entry *sort_loop, *sort_tmp;
772 memset(rules, 0x00, sizeof(struct udev_rules));
774 rules->resolve_names = resolve_names;
776 if (udev_get_rules_path(udev) != NULL) {
777 /* custom rules location for testing */
778 add_matching_files(udev, &name_list, udev_get_rules_path(udev), ".rules");
780 /* read user/custom rules */
781 add_matching_files(udev, &name_list, SYSCONFDIR "/udev/rules.d", ".rules");
783 /* read dynamic/temporary rules */
784 util_strlcpy(filename, udev_get_dev_path(udev), sizeof(filename));
785 util_strlcat(filename, "/.udev/rules.d", sizeof(filename));
786 if (stat(filename, &statbuf) != 0) {
787 create_path(udev, filename);
788 udev_selinux_setfscreatecon(udev, filename, S_IFDIR|0755);
789 mkdir(filename, 0755);
790 udev_selinux_resetfscreatecon(udev);
792 add_matching_files(udev, &sort_list, filename, ".rules");
794 /* read default rules */
795 add_matching_files(udev, &sort_list, UDEV_PREFIX "/lib/udev/rules.d", ".rules");
797 /* sort all rules files by basename into list of files */
798 list_for_each_entry_safe(sort_loop, sort_tmp, &sort_list, node) {
799 const char *sort_base = strrchr(sort_loop->name, '/');
801 if (sort_base == NULL)
804 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
805 const char *name_base = strrchr(name_loop->name, '/');
807 if (name_base == NULL)
810 if (strcmp(name_base, sort_base) == 0) {
811 info(udev, "rule file '%s' already added, ignoring '%s'\n",
812 name_loop->name, sort_loop->name);
813 list_del(&sort_loop->node);
819 if (strcmp(name_base, sort_base) > 0)
822 if (sort_loop != NULL)
823 list_move_tail(&sort_loop->node, &name_loop->node);
827 /* parse list of files */
828 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
829 if (stat(name_loop->name, &statbuf) == 0) {
831 parse_file(rules, name_loop->name);
833 dbg(udev, "empty rules file '%s'\n", name_loop->name);
835 err(udev, "could not read '%s': %m\n", name_loop->name);
836 list_del(&name_loop->node);
843 void udev_rules_cleanup(struct udev_rules *rules)