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 add_rule_key(rule, &rule->driver, operation, value);
315 if (strncasecmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
316 attr = get_key_attribute(key + sizeof("ATTR")-1);
318 err("error parsing ATTR attribute");
321 if (add_rule_key_pair(rule, &rule->attr, operation, attr, value) != 0)
327 if (strcasecmp(key, "KERNELS") == 0 ||
328 strcasecmp(key, "ID") == 0) {
329 if (operation != KEY_OP_MATCH &&
330 operation != KEY_OP_NOMATCH) {
331 err("invalid KERNELS operation");
334 add_rule_key(rule, &rule->kernels, operation, value);
339 if (strcasecmp(key, "SUBSYSTEMS") == 0 ||
340 strcasecmp(key, "BUS") == 0) {
341 if (operation != KEY_OP_MATCH &&
342 operation != KEY_OP_NOMATCH) {
343 err("invalid SUBSYSTEMS operation");
346 add_rule_key(rule, &rule->subsystems, operation, value);
351 if (strcasecmp(key, "DRIVERS") == 0) {
352 if (operation != KEY_OP_MATCH &&
353 operation != KEY_OP_NOMATCH) {
354 err("invalid DRIVERS operation");
357 add_rule_key(rule, &rule->drivers, operation, value);
362 if (strncasecmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0 ||
363 strncasecmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
364 if (operation != KEY_OP_MATCH &&
365 operation != KEY_OP_NOMATCH) {
366 err("invalid ATTRS operation");
369 attr = get_key_attribute(key + sizeof("ATTRS")-1);
371 err("error parsing ATTRS attribute");
374 if (strncmp(attr, "device/", 7) == 0)
375 err("the 'device' link is deprecated and will be removed from a future kernel, "
376 "please fix it in %s:%u", filename, lineno);
377 else if (strchr(attr, '/') != NULL)
378 err("do not reference parent sysfs directories directly, that may break with a future kernel, "
379 "please fix it in %s:%u", filename, lineno);
380 if (add_rule_key_pair(rule, &rule->attrs, operation, attr, value) != 0)
386 if (strncasecmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
387 attr = get_key_attribute(key + sizeof("ENV")-1);
389 err("error parsing ENV attribute");
392 if (strncmp(attr, "PHYSDEV", 7) == 0)
394 if (add_rule_key_pair(rule, &rule->env, operation, attr, value) != 0)
400 if (strcasecmp(key, "PROGRAM") == 0) {
401 add_rule_key(rule, &rule->program, operation, value);
406 if (strcasecmp(key, "RESULT") == 0) {
407 if (operation != KEY_OP_MATCH &&
408 operation != KEY_OP_NOMATCH) {
409 err("invalid RESULT operation");
412 add_rule_key(rule, &rule->result, operation, value);
417 if (strncasecmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
418 attr = get_key_attribute(key + sizeof("IMPORT")-1);
419 if (attr && strstr(attr, "program")) {
420 dbg("IMPORT will be executed");
421 rule->import_type = IMPORT_PROGRAM;
422 } else if (attr && strstr(attr, "file")) {
423 dbg("IMPORT will be included as file");
424 rule->import_type = IMPORT_FILE;
425 } else if (attr && strstr(attr, "parent")) {
426 dbg("IMPORT will include the parent values");
427 rule->import_type = IMPORT_PARENT;
429 /* figure it out if it is executable */
430 char file[PATH_SIZE];
434 strlcpy(file, value, sizeof(file));
435 pos = strchr(file, ' ');
439 /* allow programs in /lib/udev called without the path */
440 if (strchr(file, '/') == NULL) {
441 strlcpy(file, "/lib/udev/", sizeof(file));
442 strlcat(file, value, sizeof(file));
443 pos = strchr(file, ' ');
448 dbg("IMPORT auto mode for '%s'", file);
449 if (!lstat(file, &stats) && (stats.st_mode & S_IXUSR)) {
450 dbg("IMPORT is executable, will be executed (autotype)");
451 rule->import_type = IMPORT_PROGRAM;
453 dbg("IMPORT is not executable, will be included as file (autotype)");
454 rule->import_type = IMPORT_FILE;
457 add_rule_key(rule, &rule->import, operation, value);
462 if (strcasecmp(key, "RUN") == 0) {
463 add_rule_key(rule, &rule->run, operation, value);
468 if (strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
469 add_rule_key(rule, &rule->wait_for_sysfs, operation, value);
474 if (strcasecmp(key, "LABEL") == 0) {
475 add_rule_key(rule, &rule->label, operation, value);
480 if (strcasecmp(key, "GOTO") == 0) {
481 add_rule_key(rule, &rule->goto_label, operation, value);
486 if (strncasecmp(key, "NAME", sizeof("NAME")-1) == 0) {
487 attr = get_key_attribute(key + sizeof("NAME")-1);
489 if (strstr(attr, "all_partitions") != NULL) {
490 dbg("creation of partition nodes requested");
491 rule->partitions = DEFAULT_PARTITIONS_COUNT;
493 if (strstr(attr, "ignore_remove") != NULL) {
494 dbg("remove event should be ignored");
495 rule->ignore_remove = 1;
498 if (value[0] == '\0')
499 dbg("name empty, node creation supressed");
500 add_rule_key(rule, &rule->name, operation, value);
504 if (strcasecmp(key, "SYMLINK") == 0) {
505 add_rule_key(rule, &rule->symlink, operation, value);
510 if (strcasecmp(key, "OWNER") == 0) {
512 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
514 strtoul(value, &endptr, 10);
515 if (endptr[0] != '\0') {
517 uid_t uid = lookup_user(value);
518 dbg("replacing username='%s' by id=%i", value, uid);
519 sprintf(owner, "%u", (unsigned int) uid);
520 add_rule_key(rule, &rule->owner, operation, owner);
525 add_rule_key(rule, &rule->owner, operation, value);
529 if (strcasecmp(key, "GROUP") == 0) {
531 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
533 strtoul(value, &endptr, 10);
534 if (endptr[0] != '\0') {
536 gid_t gid = lookup_group(value);
537 dbg("replacing groupname='%s' by id=%i", value, gid);
538 sprintf(group, "%u", (unsigned int) gid);
539 add_rule_key(rule, &rule->group, operation, group);
544 add_rule_key(rule, &rule->group, operation, value);
548 if (strcasecmp(key, "MODE") == 0) {
549 rule->mode = strtol(value, NULL, 8);
550 rule->mode_operation = operation;
555 if (strcasecmp(key, "OPTIONS") == 0) {
556 if (strstr(value, "last_rule") != NULL) {
557 dbg("last rule to be applied");
560 if (strstr(value, "ignore_device") != NULL) {
561 dbg("device should be ignored");
562 rule->ignore_device = 1;
564 if (strstr(value, "ignore_remove") != NULL) {
565 dbg("remove event should be ignored");
566 rule->ignore_remove = 1;
568 if (strstr(value, "all_partitions") != NULL) {
569 dbg("creation of partition nodes requested");
570 rule->partitions = DEFAULT_PARTITIONS_COUNT;
576 err("unknown key '%s' in %s:%u", key, filename, lineno);
579 if (physdev && rule->wait_for_sysfs.operation == KEY_OP_UNSET)
580 err("PHYSDEV* values are deprecated and will be removed from a future kernel, "
581 "please fix it in %s:%u", filename, lineno);
583 /* skip line if not any valid key was found */
587 /* grow buffer and add rule */
588 rule_size = sizeof(struct udev_rule) + rule->bufsize;
589 padding = (sizeof(size_t) - rule_size % sizeof(size_t)) % sizeof(size_t);
590 dbg("add %zi padding bytes", padding);
591 rule_size += padding;
592 rule->bufsize += padding;
594 rules->buf = realloc(rules->buf, rules->bufsize + rule_size);
596 err("realloc failed");
599 dbg("adding rule to offset %zi", rules->bufsize);
600 memcpy(rules->buf + rules->bufsize, rule, rule_size);
601 rules->bufsize += rule_size;
608 err("invalid rule '%s:%u'", filename, lineno);
612 static int parse_file(struct udev_rules *rules, const char *filename)
614 char line[LINE_SIZE];
623 if (file_map(filename, &buf, &bufsize) != 0) {
624 err("can't open '%s' as rules file: %s", filename, strerror(errno));
627 info("reading '%s' as rules file", filename);
629 /* loop through the whole file */
632 while (cur < bufsize) {
635 count = buf_get_line(buf, bufsize, cur);
640 /* eat the whitespace */
641 while ((count > 0) && isspace(bufline[0])) {
648 /* see if this is a comment */
649 if (bufline[0] == COMMENT_CHARACTER)
652 if (count >= sizeof(line)) {
653 err("line too long, rule skipped '%s:%u'", filename, lineno);
657 /* skip backslash and newline from multiline rules */
658 for (i = j = 0; i < count; i++) {
659 if (bufline[i] == '\\' && bufline[i+1] == '\n')
662 line[j++] = bufline[i];
666 dbg("read '%s'", line);
667 add_to_rules(rules, line, filename, lineno);
670 file_unmap(buf, bufsize);
674 int udev_rules_init(struct udev_rules *rules, int resolve_names)
679 memset(rules, 0x00, sizeof(struct udev_rules));
680 rules->resolve_names = resolve_names;
682 /* parse rules file or all matching files in directory */
683 if (stat(udev_rules_dir, &stats) != 0)
686 if ((stats.st_mode & S_IFMT) != S_IFDIR) {
687 dbg("parse single rules file '%s'", udev_rules_dir);
688 retval = parse_file(rules, udev_rules_dir);
690 struct name_entry *name_loop, *name_tmp;
691 LIST_HEAD(name_list);
693 dbg("parse rules directory '%s'", udev_rules_dir);
694 retval = add_matching_files(&name_list, udev_rules_dir, RULESFILE_SUFFIX);
696 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
697 if (stat(name_loop->name, &stats) == 0) {
699 parse_file(rules, name_loop->name);
701 dbg("empty rules file '%s'", name_loop->name);
703 err("could not read '%s': %s", name_loop->name, strerror(errno));
704 list_del(&name_loop->node);
712 void udev_rules_cleanup(struct udev_rules *rules)