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/>.
31 #include "udev_rules.h"
34 void udev_rules_iter_init(struct udev_rules_iter *iter, struct udev_rules *rules)
36 dbg(iter->rules->udev, "bufsize=%zi\n", rules->bufsize);
41 struct udev_rule *udev_rules_iter_next(struct udev_rules_iter *iter)
43 struct udev_rules *rules;
44 struct udev_rule *rule;
50 dbg(iter->rules->udev, "current=%zi\n", iter->current);
51 if (iter->current >= rules->bufsize) {
52 dbg(iter->rules->udev, "no more rules\n");
57 rule = (struct udev_rule *) (rules->buf + iter->current);
58 iter->current += sizeof(struct udev_rule) + rule->bufsize;
63 struct udev_rule *udev_rules_iter_label(struct udev_rules_iter *iter, const char *label)
65 struct udev_rule *rule;
66 struct udev_rules *rules = iter->rules;
67 size_t start = iter->current;
70 dbg(iter->rules->udev, "current=%zi\n", iter->current);
71 if (iter->current >= rules->bufsize) {
72 err(rules->udev, "LABEL='%s' not found, GOTO will be ignored\n", label);
73 iter->current = start;
76 rule = (struct udev_rule *) (rules->buf + iter->current);
78 if (strcmp(&rule->buf[rule->label.val_off], label) != 0) {
79 dbg(rules->udev, "moving forward, looking for label '%s'\n", label);
80 iter->current += sizeof(struct udev_rule) + rule->bufsize;
84 dbg(rules->udev, "found label '%s'\n", label);
88 static int get_key(struct udev_rules *rules, char **line, char **key, enum key_operation *operation, char **value)
94 if (linepos == NULL && linepos[0] == '\0')
98 while (isspace(linepos[0]) || linepos[0] == ',')
102 if (linepos[0] == '\0')
108 if (linepos[0] == '\0')
110 if (isspace(linepos[0]))
112 if (linepos[0] == '=')
114 if ((linepos[0] == '+') || (linepos[0] == '!') || (linepos[0] == ':'))
115 if (linepos[1] == '=')
119 /* remember end of key */
122 /* skip whitespace after key */
123 while (isspace(linepos[0]))
125 if (linepos[0] == '\0')
128 /* get operation type */
129 if (linepos[0] == '=' && linepos[1] == '=') {
130 *operation = KEY_OP_MATCH;
132 dbg(rules->udev, "operator=match\n");
133 } else if (linepos[0] == '!' && linepos[1] == '=') {
134 *operation = KEY_OP_NOMATCH;
136 dbg(rules->udev, "operator=nomatch\n");
137 } else if (linepos[0] == '+' && linepos[1] == '=') {
138 *operation = KEY_OP_ADD;
140 dbg(rules->udev, "operator=add\n");
141 } else if (linepos[0] == '=') {
142 *operation = KEY_OP_ASSIGN;
144 dbg(rules->udev, "operator=assign\n");
145 } else if (linepos[0] == ':' && linepos[1] == '=') {
146 *operation = KEY_OP_ASSIGN_FINAL;
148 dbg(rules->udev, "operator=assign_final\n");
154 dbg(rules->udev, "key='%s'\n", *key);
156 /* skip whitespace after operator */
157 while (isspace(linepos[0]))
159 if (linepos[0] == '\0')
163 if (linepos[0] == '"')
169 temp = strchr(linepos, '"');
174 dbg(rules->udev, "value='%s'\n", *value);
176 /* move line to next key */
182 /* extract possible KEY{attr} */
183 static char *get_key_attribute(struct udev_rules *rules, char *str)
188 attr = strchr(str, '{');
191 pos = strchr(attr, '}');
193 err(rules->udev, "missing closing brace for format\n");
197 dbg(rules->udev, "attribute='%s'\n", attr);
204 static int add_rule_key(struct udev_rule *rule, struct key *key,
205 enum key_operation operation, const char *value)
207 size_t val_len = strnlen(value, UTIL_PATH_SIZE);
209 key->operation = operation;
211 key->val_off = rule->bufsize;
212 util_strlcpy(rule->buf + rule->bufsize, value, val_len+1);
213 rule->bufsize += val_len+1;
218 static int add_rule_key_pair(struct udev_rules *rules, struct udev_rule *rule, struct key_pairs *pairs,
219 enum key_operation operation, const char *key, const char *value)
221 size_t key_len = strnlen(key, UTIL_PATH_SIZE);
223 if (pairs->count >= PAIRS_MAX) {
224 err(rules->udev, "skip, too many keys of the same type in a single rule\n");
228 add_rule_key(rule, &pairs->keys[pairs->count].key, operation, value);
230 /* add the key-name of the pair */
231 pairs->keys[pairs->count].key_name_off = rule->bufsize;
232 util_strlcpy(rule->buf + rule->bufsize, key, key_len+1);
233 rule->bufsize += key_len+1;
240 static int add_to_rules(struct udev_rules *rules, char *line, const char *filename, unsigned int lineno)
242 char buf[sizeof(struct udev_rule) + UTIL_LINE_SIZE];
243 struct udev_rule *rule;
252 memset(buf, 0x00, sizeof(buf));
253 rule = (struct udev_rule *) buf;
254 rule->event_timeout = -1;
258 /* get all the keys */
262 enum key_operation operation = KEY_OP_UNSET;
264 retval = get_key(rules, &linepos, &key, &operation, &value);
268 if (strcasecmp(key, "ACTION") == 0) {
269 if (operation != KEY_OP_MATCH &&
270 operation != KEY_OP_NOMATCH) {
271 err(rules->udev, "invalid ACTION operation\n");
274 add_rule_key(rule, &rule->action, operation, value);
279 if (strcasecmp(key, "DEVPATH") == 0) {
280 if (operation != KEY_OP_MATCH &&
281 operation != KEY_OP_NOMATCH) {
282 err(rules->udev, "invalid DEVPATH operation\n");
285 add_rule_key(rule, &rule->devpath, operation, value);
290 if (strcasecmp(key, "KERNEL") == 0) {
291 if (operation != KEY_OP_MATCH &&
292 operation != KEY_OP_NOMATCH) {
293 err(rules->udev, "invalid KERNEL operation\n");
296 add_rule_key(rule, &rule->kernel, operation, value);
301 if (strcasecmp(key, "SUBSYSTEM") == 0) {
302 if (operation != KEY_OP_MATCH &&
303 operation != KEY_OP_NOMATCH) {
304 err(rules->udev, "invalid SUBSYSTEM operation\n");
307 /* bus, class, subsystem events should all be the same */
308 if (strcmp(value, "subsystem") == 0 ||
309 strcmp(value, "bus") == 0 ||
310 strcmp(value, "class") == 0) {
311 if (strcmp(value, "bus") == 0 || strcmp(value, "class") == 0)
312 err(rules->udev, "'%s' must be specified as 'subsystem' \n"
313 "please fix it in %s:%u", value, filename, lineno);
314 add_rule_key(rule, &rule->subsystem, operation, "subsystem|class|bus");
316 add_rule_key(rule, &rule->subsystem, operation, value);
321 if (strcasecmp(key, "DRIVER") == 0) {
322 if (operation != KEY_OP_MATCH &&
323 operation != KEY_OP_NOMATCH) {
324 err(rules->udev, "invalid DRIVER operation\n");
327 add_rule_key(rule, &rule->driver, operation, value);
332 if (strncasecmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
333 attr = get_key_attribute(rules, key + sizeof("ATTR")-1);
335 err(rules->udev, "error parsing ATTR attribute\n");
338 if (add_rule_key_pair(rules, rule, &rule->attr, operation, attr, value) != 0)
344 if (strcasecmp(key, "KERNELS") == 0 ||
345 strcasecmp(key, "ID") == 0) {
346 if (operation != KEY_OP_MATCH &&
347 operation != KEY_OP_NOMATCH) {
348 err(rules->udev, "invalid KERNELS operation\n");
351 add_rule_key(rule, &rule->kernels, operation, value);
356 if (strcasecmp(key, "SUBSYSTEMS") == 0 ||
357 strcasecmp(key, "BUS") == 0) {
358 if (operation != KEY_OP_MATCH &&
359 operation != KEY_OP_NOMATCH) {
360 err(rules->udev, "invalid SUBSYSTEMS operation\n");
363 add_rule_key(rule, &rule->subsystems, operation, value);
368 if (strcasecmp(key, "DRIVERS") == 0) {
369 if (operation != KEY_OP_MATCH &&
370 operation != KEY_OP_NOMATCH) {
371 err(rules->udev, "invalid DRIVERS operation\n");
374 add_rule_key(rule, &rule->drivers, operation, value);
379 if (strncasecmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0 ||
380 strncasecmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
381 if (operation != KEY_OP_MATCH &&
382 operation != KEY_OP_NOMATCH) {
383 err(rules->udev, "invalid ATTRS operation\n");
386 attr = get_key_attribute(rules, key + sizeof("ATTRS")-1);
388 err(rules->udev, "error parsing ATTRS attribute\n");
391 if (strncmp(attr, "device/", 7) == 0)
392 err(rules->udev, "the 'device' link is deprecated and will be removed from a future kernel, \n"
393 "please fix it in %s:%u", filename, lineno);
394 else if (strstr(attr, "../") != NULL)
395 err(rules->udev, "do not reference parent sysfs directories directly, that may break with a future kernel, \n"
396 "please fix it in %s:%u", filename, lineno);
397 if (add_rule_key_pair(rules, rule, &rule->attrs, operation, attr, value) != 0)
403 if (strncasecmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
404 attr = get_key_attribute(rules, key + sizeof("ENV")-1);
406 err(rules->udev, "error parsing ENV attribute\n");
409 if (strncmp(attr, "PHYSDEV", 7) == 0)
411 if (add_rule_key_pair(rules, rule, &rule->env, operation, attr, value) != 0)
417 if (strcasecmp(key, "PROGRAM") == 0) {
418 add_rule_key(rule, &rule->program, operation, value);
423 if (strcasecmp(key, "RESULT") == 0) {
424 if (operation != KEY_OP_MATCH &&
425 operation != KEY_OP_NOMATCH) {
426 err(rules->udev, "invalid RESULT operation\n");
429 add_rule_key(rule, &rule->result, operation, value);
434 if (strncasecmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
435 attr = get_key_attribute(rules, key + sizeof("IMPORT")-1);
436 if (attr != NULL && strstr(attr, "program")) {
437 dbg(rules->udev, "IMPORT will be executed\n");
438 rule->import_type = IMPORT_PROGRAM;
439 } else if (attr != NULL && strstr(attr, "file")) {
440 dbg(rules->udev, "IMPORT will be included as file\n");
441 rule->import_type = IMPORT_FILE;
442 } else if (attr != NULL && strstr(attr, "parent")) {
443 dbg(rules->udev, "IMPORT will include the parent values\n");
444 rule->import_type = IMPORT_PARENT;
446 /* figure it out if it is executable */
447 char file[UTIL_PATH_SIZE];
451 util_strlcpy(file, value, sizeof(file));
452 pos = strchr(file, ' ');
456 /* allow programs in /lib/udev called without the path */
457 if (strchr(file, '/') == NULL) {
458 util_strlcpy(file, UDEV_PREFIX "/lib/udev/", sizeof(file));
459 util_strlcat(file, value, sizeof(file));
460 pos = strchr(file, ' ');
465 dbg(rules->udev, "IMPORT auto mode for '%s'\n", file);
466 if (!lstat(file, &statbuf) && (statbuf.st_mode & S_IXUSR)) {
467 dbg(rules->udev, "IMPORT is executable, will be executed (autotype)\n");
468 rule->import_type = IMPORT_PROGRAM;
470 dbg(rules->udev, "IMPORT is not executable, will be included as file (autotype)\n");
471 rule->import_type = IMPORT_FILE;
474 add_rule_key(rule, &rule->import, operation, value);
479 if (strncasecmp(key, "TEST", sizeof("TEST")-1) == 0) {
480 if (operation != KEY_OP_MATCH &&
481 operation != KEY_OP_NOMATCH) {
482 err(rules->udev, "invalid TEST operation\n");
485 attr = get_key_attribute(rules, key + sizeof("TEST")-1);
487 rule->test_mode_mask = strtol(attr, NULL, 8);
488 add_rule_key(rule, &rule->test, operation, value);
493 if (strncasecmp(key, "RUN", sizeof("RUN")-1) == 0) {
494 attr = get_key_attribute(rules, key + sizeof("RUN")-1);
496 if (strstr(attr, "ignore_error"))
497 rule->run_ignore_error = 1;
499 add_rule_key(rule, &rule->run, operation, value);
504 if (strcasecmp(key, "WAIT_FOR") == 0 || strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
505 add_rule_key(rule, &rule->wait_for, operation, value);
510 if (strcasecmp(key, "LABEL") == 0) {
511 add_rule_key(rule, &rule->label, operation, value);
516 if (strcasecmp(key, "GOTO") == 0) {
517 add_rule_key(rule, &rule->goto_label, operation, value);
522 if (strncasecmp(key, "NAME", sizeof("NAME")-1) == 0) {
523 attr = get_key_attribute(rules, key + sizeof("NAME")-1);
525 if (strstr(attr, "all_partitions") != NULL) {
526 dbg(rules->udev, "creation of partition nodes requested\n");
527 rule->partitions = DEFAULT_PARTITIONS_COUNT;
529 if (strstr(attr, "ignore_remove") != NULL) {
530 dbg(rules->udev, "remove event should be ignored\n");
531 rule->ignore_remove = 1;
534 if (value[0] == '\0')
535 dbg(rules->udev, "name empty, node creation supressed\n");
536 add_rule_key(rule, &rule->name, operation, value);
540 if (strcasecmp(key, "SYMLINK") == 0) {
541 if (operation == KEY_OP_MATCH ||
542 operation == KEY_OP_NOMATCH)
543 add_rule_key(rule, &rule->symlink_match, operation, value);
545 add_rule_key(rule, &rule->symlink, operation, value);
550 if (strcasecmp(key, "OWNER") == 0) {
552 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
554 strtoul(value, &endptr, 10);
555 if (endptr[0] != '\0') {
557 uid_t uid = lookup_user(rules->udev, value);
558 dbg(rules->udev, "replacing username='%s' by id=%i\n", value, uid);
559 sprintf(owner, "%u", (unsigned int) uid);
560 add_rule_key(rule, &rule->owner, operation, owner);
565 add_rule_key(rule, &rule->owner, operation, value);
569 if (strcasecmp(key, "GROUP") == 0) {
571 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
573 strtoul(value, &endptr, 10);
574 if (endptr[0] != '\0') {
576 gid_t gid = lookup_group(rules->udev, value);
577 dbg(rules->udev, "replacing groupname='%s' by id=%i\n", value, gid);
578 sprintf(group, "%u", (unsigned int) gid);
579 add_rule_key(rule, &rule->group, operation, group);
584 add_rule_key(rule, &rule->group, operation, value);
588 if (strcasecmp(key, "MODE") == 0) {
589 add_rule_key(rule, &rule->mode, operation, value);
594 if (strcasecmp(key, "OPTIONS") == 0) {
597 if (strstr(value, "last_rule") != NULL) {
598 dbg(rules->udev, "last rule to be applied\n");
601 if (strstr(value, "ignore_device") != NULL) {
602 dbg(rules->udev, "device should be ignored\n");
603 rule->ignore_device = 1;
605 if (strstr(value, "ignore_remove") != NULL) {
606 dbg(rules->udev, "remove event should be ignored\n");
607 rule->ignore_remove = 1;
609 pos = strstr(value, "link_priority=");
611 rule->link_priority = atoi(&pos[strlen("link_priority=")]);
612 dbg(rules->udev, "link priority=%i\n", rule->link_priority);
614 pos = strstr(value, "event_timeout=");
616 rule->event_timeout = atoi(&pos[strlen("event_timeout=")]);
617 dbg(rules->udev, "event timout=%i\n", rule->event_timeout);
619 pos = strstr(value, "string_escape=");
621 pos = &pos[strlen("string_escape=")];
622 if (strncmp(pos, "none", strlen("none")) == 0)
623 rule->string_escape = ESCAPE_NONE;
624 else if (strncmp(pos, "replace", strlen("replace")) == 0)
625 rule->string_escape = ESCAPE_REPLACE;
627 if (strstr(value, "all_partitions") != NULL) {
628 dbg(rules->udev, "creation of partition nodes requested\n");
629 rule->partitions = DEFAULT_PARTITIONS_COUNT;
635 err(rules->udev, "unknown key '%s' in %s:%u\n", key, filename, lineno);
638 if (physdev && rule->wait_for.operation == KEY_OP_UNSET)
639 err(rules->udev, "PHYSDEV* values are deprecated and will be removed from a future kernel, \n"
640 "please fix it in %s:%u", filename, lineno);
642 /* skip line if not any valid key was found */
646 /* grow buffer and add rule */
647 rule_size = sizeof(struct udev_rule) + rule->bufsize;
648 padding = (sizeof(size_t) - rule_size % sizeof(size_t)) % sizeof(size_t);
649 dbg(rules->udev, "add %zi padding bytes\n", padding);
650 rule_size += padding;
651 rule->bufsize += padding;
653 rules->buf = realloc(rules->buf, rules->bufsize + rule_size);
655 err(rules->udev, "realloc failed\n");
658 dbg(rules->udev, "adding rule to offset %zi\n", rules->bufsize);
659 memcpy(rules->buf + rules->bufsize, rule, rule_size);
660 rules->bufsize += rule_size;
665 err(rules->udev, "invalid rule '%s:%u'\n", filename, lineno);
669 static int parse_file(struct udev_rules *rules, const char *filename)
671 char line[UTIL_LINE_SIZE];
680 if (file_map(filename, &buf, &bufsize) != 0) {
681 err(rules->udev, "can't open '%s' as rules file: %s\n", filename, strerror(errno));
684 info(rules->udev, "reading '%s' as rules file\n", filename);
686 /* loop through the whole file */
689 while (cur < bufsize) {
692 count = buf_get_line(buf, bufsize, cur);
697 /* eat the whitespace */
698 while ((count > 0) && isspace(bufline[0])) {
705 /* see if this is a comment */
706 if (bufline[0] == '#')
709 if (count >= sizeof(line)) {
710 err(rules->udev, "line too long, rule skipped '%s:%u'\n", filename, lineno);
714 /* skip backslash and newline from multiline rules */
715 for (i = j = 0; i < count; i++) {
716 if (bufline[i] == '\\' && bufline[i+1] == '\n')
719 line[j++] = bufline[i];
723 dbg(rules->udev, "read '%s'\n", line);
724 add_to_rules(rules, line, filename, lineno);
727 file_unmap(buf, bufsize);
731 int udev_rules_init(struct udev *udev, struct udev_rules *rules, int resolve_names)
734 char filename[PATH_MAX];
735 LIST_HEAD(name_list);
736 LIST_HEAD(sort_list);
737 struct name_entry *name_loop, *name_tmp;
738 struct name_entry *sort_loop, *sort_tmp;
741 memset(rules, 0x00, sizeof(struct udev_rules));
743 rules->resolve_names = resolve_names;
745 if (udev_get_rules_path(udev) != NULL) {
746 /* custom rules location for testing */
747 add_matching_files(udev, &name_list, udev_get_rules_path(udev), ".rules");
749 /* read user/custom rules */
750 add_matching_files(udev, &name_list, SYSCONFDIR "/udev/rules.d", ".rules");
752 /* read dynamic/temporary rules */
753 util_strlcpy(filename, udev_get_dev_path(udev), sizeof(filename));
754 util_strlcat(filename, "/.udev/rules.d", sizeof(filename));
755 if (stat(filename, &statbuf) != 0) {
756 create_path(udev, filename);
757 udev_selinux_setfscreatecon(udev, filename, S_IFDIR|0755);
758 mkdir(filename, 0755);
759 udev_selinux_resetfscreatecon(udev);
761 add_matching_files(udev, &sort_list, filename, ".rules");
763 /* read default rules */
764 add_matching_files(udev, &sort_list, UDEV_PREFIX "/lib/udev/rules.d", ".rules");
766 /* sort all rules files by basename into list of files */
767 list_for_each_entry_safe(sort_loop, sort_tmp, &sort_list, node) {
768 const char *sort_base = strrchr(sort_loop->name, '/');
770 if (sort_base == NULL)
773 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
774 const char *name_base = strrchr(name_loop->name, '/');
776 if (name_base == NULL)
779 if (strcmp(name_base, sort_base) == 0) {
780 info(udev, "rule file '%s' already added, ignoring '%s'\n",
781 name_loop->name, sort_loop->name);
782 list_del(&sort_loop->node);
788 if (strcmp(name_base, sort_base) > 0)
791 if (sort_loop != NULL)
792 list_move_tail(&sort_loop->node, &name_loop->node);
796 /* parse list of files */
797 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
798 if (stat(name_loop->name, &statbuf) == 0) {
800 parse_file(rules, name_loop->name);
802 dbg(udev, "empty rules file '%s'\n", name_loop->name);
804 err(udev, "could not read '%s': %s\n", name_loop->name, strerror(errno));
805 list_del(&name_loop->node);
812 void udev_rules_cleanup(struct udev_rules *rules)