2 * Copyright (C) 2003-2009 Kay Sievers <kay.sievers@vrfy.org>
3 * Copyright (C) 2008 Alan Jenkins <alan-jenkins@tuffmail.co.uk>
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/>.
35 #define PREALLOC_TOKEN 2048
36 #define PREALLOC_STRBUF 32 * 1024
37 #define PREALLOC_TRIE 256
40 unsigned int name_off;
48 /* this node's first child */
49 unsigned int child_idx;
50 /* the next child of our parent node's child list */
51 unsigned int next_child_idx;
52 /* this node's last child (shortcut for append) */
53 unsigned int last_child_idx;
54 unsigned int value_off;
55 unsigned short value_len;
63 /* every key in the rules file becomes a token */
65 unsigned int token_cur;
66 unsigned int token_max;
68 /* all key strings are copied to a single string buffer */
72 unsigned int buf_count;
74 /* during rule parsing, strings are indexed to find duplicates */
75 struct trie_node *trie_nodes;
76 unsigned int trie_nodes_cur;
77 unsigned int trie_nodes_max;
79 /* during rule parsing, uid/gid lookup results are cached */
81 unsigned int uids_cur;
82 unsigned int uids_max;
84 unsigned int gids_cur;
85 unsigned int gids_max;
88 /* KEY=="", KEY!="", KEY+="", KEY="", KEY:="" */
101 enum string_glob_type {
103 GL_PLAIN, /* no special chars */
104 GL_GLOB, /* shell globs ?,*,[] */
105 GL_SPLIT, /* multi-value A|B */
106 GL_SPLIT_GLOB, /* multi-value with glob A*|B* */
107 GL_SOMETHING, /* commonly used "?*" */
110 enum string_subst_type {
117 /* tokens of a rule are sorted/handled in this order */
122 TK_M_ACTION, /* val */
123 TK_M_DEVPATH, /* val */
124 TK_M_KERNEL, /* val */
125 TK_M_DEVLINK, /* val */
127 TK_M_ENV, /* val, attr */
128 TK_M_SUBSYSTEM, /* val */
129 TK_M_DRIVER, /* val */
130 TK_M_WAITFOR, /* val */
131 TK_M_ATTR, /* val, attr */
134 TK_M_KERNELS, /* val */
135 TK_M_SUBSYSTEMS, /* val */
136 TK_M_DRIVERS, /* val */
137 TK_M_ATTRS, /* val, attr */
140 TK_M_TEST, /* val, mode_t */
141 TK_M_PROGRAM, /* val */
142 TK_M_IMPORT_FILE, /* val */
143 TK_M_IMPORT_PROG, /* val */
144 TK_M_IMPORT_PARENT, /* val */
145 TK_M_RESULT, /* val */
148 TK_A_STRING_ESCAPE_NONE,
149 TK_A_STRING_ESCAPE_REPLACE,
150 TK_A_INOTIFY_WATCH, /* int */
151 TK_A_NUM_FAKE_PART, /* int */
152 TK_A_DEVLINK_PRIO, /* int */
153 TK_A_OWNER, /* val */
154 TK_A_GROUP, /* val */
156 TK_A_OWNER_ID, /* uid_t */
157 TK_A_GROUP_ID, /* gid_t */
158 TK_A_MODE_ID, /* mode_t */
159 TK_A_ENV, /* val, attr */
161 TK_A_DEVLINK, /* val */
162 TK_A_EVENT_TIMEOUT, /* int */
164 TK_A_ATTR, /* val, attr */
165 TK_A_RUN, /* val, bool */
166 TK_A_GOTO, /* size_t */
171 /* we try to pack stuff in a way that we take only 12 bytes per token */
174 unsigned char type; /* same as in rule and key */
176 enum token_type type:8;
177 unsigned int flags:8;
178 unsigned short token_count;
179 unsigned int label_off;
180 unsigned short filename_off;
181 unsigned short filename_line;
184 enum token_type type:8;
185 enum operation_type op:8;
186 enum string_glob_type glob:8;
187 enum string_subst_type subst:4;
188 enum string_subst_type attrsubst:4;
189 unsigned int value_off;
191 unsigned int attr_off;
194 unsigned int rule_goto;
209 struct udev_rules *rules;
211 struct token token[MAX_TK];
212 unsigned int token_cur;
216 static const char *operation_str(enum operation_type type)
218 static const char *operation_strs[] = {
219 [OP_UNSET] = "UNSET",
220 [OP_MATCH] = "match",
221 [OP_NOMATCH] = "nomatch",
222 [OP_MATCH_MAX] = "MATCH_MAX",
225 [OP_ASSIGN] = "assign",
226 [OP_ASSIGN_FINAL] = "assign-final",
229 return operation_strs[type];
232 static const char *string_glob_str(enum string_glob_type type)
234 static const char *string_glob_strs[] = {
235 [GL_UNSET] = "UNSET",
236 [GL_PLAIN] = "plain",
238 [GL_SPLIT] = "split",
239 [GL_SPLIT_GLOB] = "split-glob",
240 [GL_SOMETHING] = "split-glob",
243 return string_glob_strs[type];
246 static const char *token_str(enum token_type type)
248 static const char *token_strs[] = {
249 [TK_UNSET] = "UNSET",
252 [TK_M_ACTION] = "M ACTION",
253 [TK_M_DEVPATH] = "M DEVPATH",
254 [TK_M_KERNEL] = "M KERNEL",
255 [TK_M_DEVLINK] = "M DEVLINK",
256 [TK_M_NAME] = "M NAME",
257 [TK_M_ENV] = "M ENV",
258 [TK_M_SUBSYSTEM] = "M SUBSYSTEM",
259 [TK_M_DRIVER] = "M DRIVER",
260 [TK_M_WAITFOR] = "M WAITFOR",
261 [TK_M_ATTR] = "M ATTR",
263 [TK_M_PARENTS_MIN] = "M PARENTS_MIN",
264 [TK_M_KERNELS] = "M KERNELS",
265 [TK_M_SUBSYSTEMS] = "M SUBSYSTEMS",
266 [TK_M_DRIVERS] = "M DRIVERS",
267 [TK_M_ATTRS] = "M ATTRS",
268 [TK_M_PARENTS_MAX] = "M PARENTS_MAX",
270 [TK_M_TEST] = "M TEST",
271 [TK_M_PROGRAM] = "M PROGRAM",
272 [TK_M_IMPORT_FILE] = "M IMPORT_FILE",
273 [TK_M_IMPORT_PROG] = "M IMPORT_PROG",
274 [TK_M_IMPORT_PARENT] = "M IMPORT_PARENT",
275 [TK_M_RESULT] = "M RESULT",
276 [TK_M_MAX] = "M MAX",
278 [TK_A_STRING_ESCAPE_NONE] = "A STRING_ESCAPE_NONE",
279 [TK_A_STRING_ESCAPE_REPLACE] = "A STRING_ESCAPE_REPLACE",
280 [TK_A_INOTIFY_WATCH] = "A INOTIFY_WATCH",
281 [TK_A_NUM_FAKE_PART] = "A NUM_FAKE_PART",
282 [TK_A_DEVLINK_PRIO] = "A DEVLINK_PRIO",
283 [TK_A_OWNER] = "A OWNER",
284 [TK_A_GROUP] = "A GROUP",
285 [TK_A_MODE] = "A MODE",
286 [TK_A_OWNER_ID] = "A OWNER_ID",
287 [TK_A_GROUP_ID] = "A GROUP_ID",
288 [TK_A_MODE_ID] = "A MODE_ID",
289 [TK_A_ENV] = "A ENV",
290 [TK_A_NAME] = "A NAME",
291 [TK_A_DEVLINK] = "A DEVLINK",
292 [TK_A_EVENT_TIMEOUT] = "A EVENT_TIMEOUT",
293 [TK_A_IGNORE_REMOVE] = "A IGNORE_REMOVE",
294 [TK_A_ATTR] = "A ATTR",
295 [TK_A_RUN] = "A RUN",
296 [TK_A_GOTO] = "A GOTO",
301 return token_strs[type];
304 static void dump_token(struct udev_rules *rules, struct token *token)
306 enum token_type type = token->type;
307 enum operation_type op = token->key.op;
308 enum string_glob_type glob = token->key.glob;
309 const char *value = &rules->buf[token->key.value_off];
310 const char *attr = &rules->buf[token->key.attr_off];
315 const char *tks_ptr = (char *)rules->tokens;
316 const char *tk_ptr = (char *)token;
317 unsigned int idx = (tk_ptr - tks_ptr) / sizeof(struct token);
319 dbg(rules->udev, "* RULE %s:%u, token: %u, count: %u, label: '%s', flags: 0x%02x\n",
320 &rules->buf[token->rule.filename_off], token->rule.filename_line,
321 idx, token->rule.token_count,
322 &rules->buf[token->rule.label_off],
335 case TK_M_SUBSYSTEMS:
338 case TK_M_IMPORT_FILE:
339 case TK_M_IMPORT_PROG:
340 case TK_M_IMPORT_PARENT:
348 dbg(rules->udev, "%s %s '%s'(%s)\n",
349 token_str(type), operation_str(op), value, string_glob_str(glob));
356 dbg(rules->udev, "%s %s '%s' '%s'(%s)\n",
357 token_str(type), operation_str(op), attr, value, string_glob_str(glob));
359 case TK_A_STRING_ESCAPE_NONE:
360 case TK_A_STRING_ESCAPE_REPLACE:
361 case TK_A_IGNORE_REMOVE:
362 dbg(rules->udev, "%s\n", token_str(type));
365 dbg(rules->udev, "%s %s '%s'(%s) %#o\n",
366 token_str(type), operation_str(op), value, string_glob_str(glob), token->key.mode);
368 case TK_A_INOTIFY_WATCH:
369 dbg(rules->udev, "%s %u\n", token_str(type), token->key.watch);
371 case TK_A_NUM_FAKE_PART:
372 dbg(rules->udev, "%s %u\n", token_str(type), token->key.num_fake_part);
374 case TK_A_DEVLINK_PRIO:
375 dbg(rules->udev, "%s %s %u\n", token_str(type), operation_str(op), token->key.devlink_prio);
378 dbg(rules->udev, "%s %s %u\n", token_str(type), operation_str(op), token->key.uid);
381 dbg(rules->udev, "%s %s %u\n", token_str(type), operation_str(op), token->key.gid);
384 dbg(rules->udev, "%s %s %#o\n", token_str(type), operation_str(op), token->key.mode);
386 case TK_A_EVENT_TIMEOUT:
387 dbg(rules->udev, "%s %s %u\n", token_str(type), operation_str(op), token->key.event_timeout);
390 dbg(rules->udev, "%s '%s' %u\n", token_str(type), value, token->key.rule_goto);
393 dbg(rules->udev, "* %s\n", token_str(type));
395 case TK_M_PARENTS_MIN:
396 case TK_M_PARENTS_MAX:
399 dbg(rules->udev, "unknown type %u\n", type);
404 static void dump_rules(struct udev_rules *rules)
408 dbg(rules->udev, "dumping %u (%zu bytes) tokens, %u (%zu bytes) strings\n",
410 rules->token_cur * sizeof(struct token),
413 for(i = 0; i < rules->token_cur; i++)
414 dump_token(rules, &rules->tokens[i]);
417 static inline const char *operation_str(enum operation_type type) { return NULL; }
418 static inline const char *token_str(enum token_type type) { return NULL; }
419 static inline void dump_token(struct udev_rules *rules, struct token *token) {}
420 static inline void dump_rules(struct udev_rules *rules) {}
421 #endif /* ENABLE_DEBUG */
423 static int add_new_string(struct udev_rules *rules, const char *str, size_t bytes)
427 /* grow buffer if needed */
428 if (rules->buf_cur + bytes+1 >= rules->buf_max) {
432 /* double the buffer size */
433 add = rules->buf_max;
437 buf = realloc(rules->buf, rules->buf_max + add);
440 dbg(rules->udev, "extend buffer from %zu to %zu\n", rules->buf_max, rules->buf_max + add);
442 rules->buf_max += add;
444 off = rules->buf_cur;
445 memcpy(&rules->buf[rules->buf_cur], str, bytes);
446 rules->buf_cur += bytes;
451 static int add_string(struct udev_rules *rules, const char *str)
453 unsigned int node_idx;
454 struct trie_node *new_node;
455 unsigned int new_node_idx;
460 struct trie_node *parent;
462 /* walk trie, start from last character of str to find matching tails */
466 for (depth = 0; depth <= len; depth++) {
467 struct trie_node *node;
468 unsigned int child_idx;
470 node = &rules->trie_nodes[node_idx];
471 off = node->value_off + node->value_len - len;
473 /* match against current node */
474 if (depth == len || (node->value_len >= len && memcmp(&rules->buf[off], str, len) == 0))
477 /* lookup child node */
478 key = str[len - 1 - depth];
479 child_idx = node->child_idx;
480 while (child_idx > 0) {
481 struct trie_node *child;
483 child = &rules->trie_nodes[child_idx];
484 if (child->key == key)
486 child_idx = child->next_child_idx;
490 node_idx = child_idx;
493 /* string not found, add it */
494 off = add_new_string(rules, str, len + 1);
496 /* grow trie nodes if needed */
497 if (rules->trie_nodes_cur >= rules->trie_nodes_max) {
498 struct trie_node *nodes;
501 /* double the buffer size */
502 add = rules->trie_nodes_max;
506 nodes = realloc(rules->trie_nodes, (rules->trie_nodes_max + add) * sizeof(struct trie_node));
509 dbg(rules->udev, "extend trie nodes from %u to %u\n",
510 rules->trie_nodes_max, rules->trie_nodes_max + add);
511 rules->trie_nodes = nodes;
512 rules->trie_nodes_max += add;
516 new_node_idx = rules->trie_nodes_cur;
517 rules->trie_nodes_cur++;
518 new_node = &rules->trie_nodes[new_node_idx];
519 memset(new_node, 0x00, sizeof(struct trie_node));
520 new_node->value_off = off;
521 new_node->value_len = len;
524 /* join the parent's child list */
525 parent = &rules->trie_nodes[node_idx];
526 if (parent->child_idx == 0) {
527 parent->child_idx = new_node_idx;
529 struct trie_node *last_child;
531 last_child = &rules->trie_nodes[parent->last_child_idx];
532 last_child->next_child_idx = new_node_idx;
534 parent->last_child_idx = new_node_idx;
538 static int add_token(struct udev_rules *rules, struct token *token)
540 /* grow buffer if needed */
541 if (rules->token_cur+1 >= rules->token_max) {
542 struct token *tokens;
545 /* double the buffer size */
546 add = rules->token_max;
550 tokens = realloc(rules->tokens, (rules->token_max + add ) * sizeof(struct token));
553 dbg(rules->udev, "extend tokens from %u to %u\n", rules->token_max, rules->token_max + add);
554 rules->tokens = tokens;
555 rules->token_max += add;
557 memcpy(&rules->tokens[rules->token_cur], token, sizeof(struct token));
562 static uid_t add_uid(struct udev_rules *rules, const char *owner)
568 /* lookup, if we know it already */
569 for (i = 0; i < rules->uids_cur; i++) {
570 off = rules->uids[i].name_off;
571 if (strcmp(&rules->buf[off], owner) == 0) {
572 uid = rules->uids[i].uid;
573 dbg(rules->udev, "return existing %u for '%s'\n", uid, owner);
577 uid = util_lookup_user(rules->udev, owner);
579 /* grow buffer if needed */
580 if (rules->uids_cur+1 >= rules->uids_max) {
581 struct uid_gid *uids;
584 /* double the buffer size */
585 add = rules->uids_max;
589 uids = realloc(rules->uids, (rules->uids_max + add ) * sizeof(struct uid_gid));
592 dbg(rules->udev, "extend uids from %u to %u\n", rules->uids_max, rules->uids_max + add);
594 rules->uids_max += add;
596 rules->uids[rules->uids_cur].uid = uid;
597 off = add_string(rules, owner);
600 rules->uids[rules->uids_cur].name_off = off;
605 static gid_t add_gid(struct udev_rules *rules, const char *group)
611 /* lookup, if we know it already */
612 for (i = 0; i < rules->gids_cur; i++) {
613 off = rules->gids[i].name_off;
614 if (strcmp(&rules->buf[off], group) == 0) {
615 gid = rules->gids[i].gid;
616 dbg(rules->udev, "return existing %u for '%s'\n", gid, group);
620 gid = util_lookup_group(rules->udev, group);
622 /* grow buffer if needed */
623 if (rules->gids_cur+1 >= rules->gids_max) {
624 struct uid_gid *gids;
627 /* double the buffer size */
628 add = rules->gids_max;
632 gids = realloc(rules->gids, (rules->gids_max + add ) * sizeof(struct uid_gid));
635 dbg(rules->udev, "extend gids from %u to %u\n", rules->gids_max, rules->gids_max + add);
637 rules->gids_max += add;
639 rules->gids[rules->gids_cur].gid = gid;
640 off = add_string(rules, group);
643 rules->gids[rules->gids_cur].name_off = off;
648 static int import_property_from_string(struct udev_device *dev, char *line)
650 struct udev *udev = udev_device_get_udev(dev);
657 while (isspace(key[0]))
660 /* comment or empty line */
661 if (key[0] == '#' || key[0] == '\0')
664 /* split key/value */
665 val = strchr(key, '=');
672 while (isspace(val[0]))
679 while (isspace(key[len-1]))
683 /* terminate value */
687 while (isspace(val[len-1]))
695 if (val[0] == '"' || val[0] == '\'') {
696 if (val[len-1] != val[0]) {
697 info(udev, "inconsistent quoting: '%s', skip\n", line);
704 dbg(udev, "adding '%s'='%s'\n", key, val);
706 /* handle device, renamed by external tool, returning new path */
707 if (strcmp(key, "DEVPATH") == 0) {
708 char syspath[UTIL_PATH_SIZE];
710 info(udev, "updating devpath from '%s' to '%s'\n",
711 udev_device_get_devpath(dev), val);
712 util_strscpyl(syspath, sizeof(syspath), udev_get_sys_path(udev), val, NULL);
713 udev_device_set_syspath(dev, syspath);
715 struct udev_list_entry *entry;
717 entry = udev_device_add_property(dev, key, val);
718 /* store in db, skip private keys */
720 udev_list_entry_set_flag(entry, 1);
725 static int import_file_into_properties(struct udev_device *dev, const char *filename)
728 char line[UTIL_LINE_SIZE];
730 f = fopen(filename, "r");
733 while (fgets(line, sizeof(line), f) != NULL)
734 import_property_from_string(dev, line);
739 static int import_program_into_properties(struct udev_device *dev, const char *program)
741 struct udev *udev = udev_device_get_udev(dev);
747 envp = udev_device_get_properties_envp(dev);
748 if (util_run_program(udev, program, envp, result, sizeof(result), &reslen, NULL) != 0)
752 while (line != NULL) {
755 pos = strchr(line, '\n');
760 import_property_from_string(dev, line);
766 static int import_parent_into_properties(struct udev_device *dev, const char *filter)
768 struct udev *udev = udev_device_get_udev(dev);
769 struct udev_device *dev_parent;
770 struct udev_list_entry *list_entry;
772 dev_parent = udev_device_get_parent(dev);
773 if (dev_parent == NULL)
776 dbg(udev, "found parent '%s', get the node name\n", udev_device_get_syspath(dev_parent));
777 udev_list_entry_foreach(list_entry, udev_device_get_properties_list_entry(dev_parent)) {
778 const char *key = udev_list_entry_get_name(list_entry);
779 const char *val = udev_list_entry_get_value(list_entry);
781 if (fnmatch(filter, key, 0) == 0) {
782 struct udev_list_entry *entry;
784 dbg(udev, "import key '%s=%s'\n", key, val);
785 entry = udev_device_add_property(dev, key, val);
786 /* store in db, skip private keys */
788 udev_list_entry_set_flag(entry, 1);
794 #define WAIT_LOOP_PER_SECOND 50
795 static int wait_for_file(struct udev_device *dev, const char *file, int timeout)
797 struct udev *udev = udev_device_get_udev(dev);
798 char filepath[UTIL_PATH_SIZE];
799 char devicepath[UTIL_PATH_SIZE];
801 int loop = timeout * WAIT_LOOP_PER_SECOND;
803 /* a relative path is a device attribute */
804 devicepath[0] = '\0';
805 if (file[0] != '/') {
806 util_strscpyl(devicepath, sizeof(devicepath),
807 udev_get_sys_path(udev), udev_device_get_devpath(dev), NULL);
808 util_strscpyl(filepath, sizeof(filepath), devicepath, "/", file, NULL);
812 dbg(udev, "will wait %i sec for '%s'\n", timeout, file);
814 const struct timespec duration = { 0, 1000 * 1000 * 1000 / WAIT_LOOP_PER_SECOND };
817 if (stat(file, &stats) == 0) {
818 info(udev, "file '%s' appeared after %i loops\n", file, (timeout * WAIT_LOOP_PER_SECOND) - loop-1);
821 /* make sure, the device did not disappear in the meantime */
822 if (devicepath[0] != '\0' && stat(devicepath, &stats) != 0) {
823 info(udev, "device disappeared while waiting for '%s'\n", file);
826 info(udev, "wait for '%s' for %i mseconds\n", file, 1000 / WAIT_LOOP_PER_SECOND);
827 nanosleep(&duration, NULL);
829 info(udev, "waiting for '%s' failed\n", file);
833 static int attr_subst_subdir(char *attr, size_t len)
837 if (strstr(attr, "/*/")) {
839 char dirname[UTIL_PATH_SIZE];
843 util_strscpy(dirname, sizeof(dirname), attr);
844 pos = strstr(dirname, "/*/");
849 dir = opendir(dirname);
853 for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
856 if (dent->d_name[0] == '.')
858 util_strscpyl(attr, len, dirname, "/", dent->d_name, tail, NULL);
859 if (stat(attr, &stats) == 0) {
871 static int get_key(struct udev *udev, char **line, char **key, enum operation_type *op, char **value)
877 if (linepos == NULL || linepos[0] == '\0')
880 /* skip whitespace */
881 while (isspace(linepos[0]) || linepos[0] == ',')
885 if (linepos[0] == '\0')
891 if (linepos[0] == '\0')
893 if (isspace(linepos[0]))
895 if (linepos[0] == '=')
897 if ((linepos[0] == '+') || (linepos[0] == '!') || (linepos[0] == ':'))
898 if (linepos[1] == '=')
902 /* remember end of key */
905 /* skip whitespace after key */
906 while (isspace(linepos[0]))
908 if (linepos[0] == '\0')
911 /* get operation type */
912 if (linepos[0] == '=' && linepos[1] == '=') {
915 } else if (linepos[0] == '!' && linepos[1] == '=') {
918 } else if (linepos[0] == '+' && linepos[1] == '=') {
921 } else if (linepos[0] == '=') {
924 } else if (linepos[0] == ':' && linepos[1] == '=') {
925 *op = OP_ASSIGN_FINAL;
933 /* skip whitespace after operator */
934 while (isspace(linepos[0]))
936 if (linepos[0] == '\0')
940 if (linepos[0] == '"')
947 temp = strchr(linepos, '"');
952 dbg(udev, "%s '%s'-'%s'\n", operation_str(*op), *key, *value);
954 /* move line to next key */
959 /* extract possible KEY{attr} */
960 static char *get_key_attribute(struct udev *udev, char *str)
965 attr = strchr(str, '{');
968 pos = strchr(attr, '}');
970 err(udev, "missing closing brace for format\n");
974 dbg(udev, "attribute='%s'\n", attr);
980 static int rule_add_key(struct rule_tmp *rule_tmp, enum token_type type,
981 enum operation_type op,
982 const char *value, const void *data)
984 struct token *token = &rule_tmp->token[rule_tmp->token_cur];
985 const char *attr = NULL;
987 memset(token, 0x00, sizeof(struct token));
999 case TK_M_SUBSYSTEMS:
1002 case TK_M_IMPORT_FILE:
1003 case TK_M_IMPORT_PROG:
1004 case TK_M_IMPORT_PARENT:
1011 token->key.value_off = add_string(rule_tmp->rules, value);
1019 token->key.value_off = add_string(rule_tmp->rules, value);
1020 token->key.attr_off = add_string(rule_tmp->rules, attr);
1023 token->key.value_off = add_string(rule_tmp->rules, value);
1024 token->key.devlink_unique = *(int *)data;
1027 token->key.value_off = add_string(rule_tmp->rules, value);
1029 token->key.mode = *(mode_t *)data;
1031 case TK_A_STRING_ESCAPE_NONE:
1032 case TK_A_STRING_ESCAPE_REPLACE:
1033 case TK_A_IGNORE_REMOVE:
1036 token->key.value_off = add_string(rule_tmp->rules, value);
1037 token->key.fail_on_error = *(int *)data;
1039 case TK_A_INOTIFY_WATCH:
1040 case TK_A_NUM_FAKE_PART:
1041 case TK_A_DEVLINK_PRIO:
1042 token->key.devlink_prio = *(int *)data;
1045 token->key.uid = *(uid_t *)data;
1048 token->key.gid = *(gid_t *)data;
1051 token->key.mode = *(mode_t *)data;
1053 case TK_A_EVENT_TIMEOUT:
1054 token->key.event_timeout = *(int *)data;
1057 case TK_M_PARENTS_MIN:
1058 case TK_M_PARENTS_MAX:
1062 err(rule_tmp->rules->udev, "wrong type %u\n", type);
1066 if (value != NULL && type < TK_M_MAX) {
1067 /* check if we need to split or call fnmatch() while matching rules */
1068 enum string_glob_type glob;
1072 has_split = (strchr(value, '|') != NULL);
1073 has_glob = (strchr(value, '*') != NULL || strchr(value, '?') != NULL || strchr(value, '[') != NULL);
1074 if (has_split && has_glob) {
1075 glob = GL_SPLIT_GLOB;
1076 } else if (has_split) {
1078 } else if (has_glob) {
1079 if (strcmp(value, "?*") == 0)
1080 glob = GL_SOMETHING;
1086 token->key.glob = glob;
1089 if (value != NULL && type > TK_M_MAX) {
1090 /* check if assigned value has substitution chars */
1091 if (value[0] == '[')
1092 token->key.subst = SB_SUBSYS;
1093 else if (strchr(value, '%') != NULL || strchr(value, '$') != NULL)
1094 token->key.subst = SB_FORMAT;
1096 token->key.subst = SB_NONE;
1100 /* check if property/attribut name has substitution chars */
1102 token->key.attrsubst = SB_SUBSYS;
1103 else if (strchr(attr, '%') != NULL || strchr(attr, '$') != NULL)
1104 token->key.attrsubst = SB_FORMAT;
1106 token->key.attrsubst = SB_NONE;
1109 token->key.type = type;
1111 rule_tmp->token_cur++;
1112 if (rule_tmp->token_cur >= ARRAY_SIZE(rule_tmp->token)) {
1113 err(rule_tmp->rules->udev, "temporary rule array too small\n");
1119 static int sort_token(struct udev_rules *rules, struct rule_tmp *rule_tmp)
1122 unsigned int start = 0;
1123 unsigned int end = rule_tmp->token_cur;
1125 for (i = 0; i < rule_tmp->token_cur; i++) {
1126 enum token_type next_val = TK_UNSET;
1127 unsigned int next_idx = 0;
1130 /* find smallest value */
1131 for (j = start; j < end; j++) {
1132 if (rule_tmp->token[j].type == TK_UNSET)
1134 if (next_val == TK_UNSET || rule_tmp->token[j].type < next_val) {
1135 next_val = rule_tmp->token[j].type;
1140 /* add token and mark done */
1141 if (add_token(rules, &rule_tmp->token[next_idx]) != 0)
1143 rule_tmp->token[next_idx].type = TK_UNSET;
1146 if (next_idx == start)
1148 if (next_idx+1 == end)
1154 static int add_rule(struct udev_rules *rules, char *line,
1155 const char *filename, unsigned int filename_off, unsigned int lineno)
1159 struct rule_tmp rule_tmp;
1160 bool bus_warn = false;
1161 bool sysfs_warn = false;
1162 bool id_warn = false;
1164 memset(&rule_tmp, 0x00, sizeof(struct rule_tmp));
1165 rule_tmp.rules = rules;
1166 rule_tmp.rule.type = TK_RULE;
1167 rule_tmp.rule.rule.filename_off = filename_off;
1168 rule_tmp.rule.rule.filename_line = lineno;
1174 enum operation_type op;
1176 if (get_key(rules->udev, &linepos, &key, &op, &value) != 0)
1179 if (strcmp(key, "ACTION") == 0) {
1180 if (op > OP_MATCH_MAX) {
1181 err(rules->udev, "invalid ACTION operation\n");
1184 rule_add_key(&rule_tmp, TK_M_ACTION, op, value, NULL);
1188 if (strcmp(key, "DEVPATH") == 0) {
1189 if (op > OP_MATCH_MAX) {
1190 err(rules->udev, "invalid DEVPATH operation\n");
1193 rule_add_key(&rule_tmp, TK_M_DEVPATH, op, value, NULL);
1197 if (strcmp(key, "KERNEL") == 0) {
1198 if (op > OP_MATCH_MAX) {
1199 err(rules->udev, "invalid KERNEL operation\n");
1202 rule_add_key(&rule_tmp, TK_M_KERNEL, op, value, NULL);
1206 if (strcmp(key, "SUBSYSTEM") == 0) {
1207 if (op > OP_MATCH_MAX) {
1208 err(rules->udev, "invalid SUBSYSTEM operation\n");
1211 /* bus, class, subsystem events should all be the same */
1212 if (strcmp(value, "subsystem") == 0 ||
1213 strcmp(value, "bus") == 0 ||
1214 strcmp(value, "class") == 0) {
1215 if (strcmp(value, "bus") == 0 || strcmp(value, "class") == 0)
1216 err(rules->udev, "'%s' must be specified as 'subsystem' \n"
1217 "please fix it in %s:%u", value, filename, lineno);
1218 rule_add_key(&rule_tmp, TK_M_SUBSYSTEM, op, "subsystem|class|bus", NULL);
1220 rule_add_key(&rule_tmp, TK_M_SUBSYSTEM, op, value, NULL);
1224 if (strcmp(key, "DRIVER") == 0) {
1225 if (op > OP_MATCH_MAX) {
1226 err(rules->udev, "invalid DRIVER operation\n");
1229 rule_add_key(&rule_tmp, TK_M_DRIVER, op, value, NULL);
1233 if (strncmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
1234 attr = get_key_attribute(rules->udev, key + sizeof("ATTR")-1);
1236 err(rules->udev, "error parsing ATTR attribute\n");
1239 if (op < OP_MATCH_MAX) {
1240 rule_add_key(&rule_tmp, TK_M_ATTR, op, value, attr);
1242 rule_add_key(&rule_tmp, TK_A_ATTR, op, value, attr);
1247 if (strcmp(key, "KERNELS") == 0) {
1248 if (op > OP_MATCH_MAX) {
1249 err(rules->udev, "invalid KERNELS operation\n");
1252 rule_add_key(&rule_tmp, TK_M_KERNELS, op, value, NULL);
1256 if (strcmp(key, "ID") == 0) {
1259 err(rules->udev, "ID= will be removed in a future udev version, "
1260 "please use KERNEL= to match the event device, or KERNELS= "
1261 "to match a parent device, in %s:%u\n", filename, lineno);
1263 if (op > OP_MATCH_MAX) {
1264 err(rules->udev, "invalid KERNELS operation\n");
1267 rule_add_key(&rule_tmp, TK_M_KERNELS, op, value, NULL);
1271 if (strcmp(key, "SUBSYSTEMS") == 0) {
1272 if (op > OP_MATCH_MAX) {
1273 err(rules->udev, "invalid SUBSYSTEMS operation\n");
1276 rule_add_key(&rule_tmp, TK_M_SUBSYSTEMS, op, value, NULL);
1280 if (strcmp(key, "BUS") == 0) {
1283 err(rules->udev, "BUS= will be removed in a future udev version, "
1284 "please use SUBSYSTEM= to match the event device, or SUBSYSTEMS= "
1285 "to match a parent device, in %s:%u\n", filename, lineno);
1287 if (op > OP_MATCH_MAX) {
1288 err(rules->udev, "invalid SUBSYSTEMS operation\n");
1291 rule_add_key(&rule_tmp, TK_M_SUBSYSTEMS, op, value, NULL);
1295 if (strcmp(key, "DRIVERS") == 0) {
1296 if (op > OP_MATCH_MAX) {
1297 err(rules->udev, "invalid DRIVERS operation\n");
1300 rule_add_key(&rule_tmp, TK_M_DRIVERS, op, value, NULL);
1304 if (strncmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0) {
1305 if (op > OP_MATCH_MAX) {
1306 err(rules->udev, "invalid ATTRS operation\n");
1309 attr = get_key_attribute(rules->udev, key + sizeof("ATTRS")-1);
1311 err(rules->udev, "error parsing ATTRS attribute\n");
1314 if (strncmp(attr, "device/", 7) == 0)
1315 err(rules->udev, "the 'device' link may not be available in a future kernel, "
1316 "please fix it in %s:%u", filename, lineno);
1317 else if (strstr(attr, "../") != NULL)
1318 err(rules->udev, "do not reference parent sysfs directories directly, "
1319 "it may break with a future kernel, please fix it in %s:%u", filename, lineno);
1320 rule_add_key(&rule_tmp, TK_M_ATTRS, op, value, attr);
1324 if (strncmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
1327 err(rules->udev, "SYSFS{}= will be removed in a future udev version, "
1328 "please use ATTR{}= to match the event device, or ATTRS{}= "
1329 "to match a parent device, in %s:%u\n", filename, lineno);
1331 if (op > OP_MATCH_MAX) {
1332 err(rules->udev, "invalid ATTRS operation\n");
1335 attr = get_key_attribute(rules->udev, key + sizeof("ATTRS")-1);
1337 err(rules->udev, "error parsing ATTRS attribute\n");
1340 rule_add_key(&rule_tmp, TK_M_ATTRS, op, value, attr);
1344 if (strncmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
1345 attr = get_key_attribute(rules->udev, key + sizeof("ENV")-1);
1347 err(rules->udev, "error parsing ENV attribute\n");
1350 if (op < OP_MATCH_MAX) {
1351 if (rule_add_key(&rule_tmp, TK_M_ENV, op, value, attr) != 0)
1354 if (rule_add_key(&rule_tmp, TK_A_ENV, op, value, attr) != 0)
1360 if (strcmp(key, "PROGRAM") == 0) {
1361 rule_add_key(&rule_tmp, TK_M_PROGRAM, op, value, NULL);
1365 if (strcmp(key, "RESULT") == 0) {
1366 if (op > OP_MATCH_MAX) {
1367 err(rules->udev, "invalid RESULT operation\n");
1370 rule_add_key(&rule_tmp, TK_M_RESULT, op, value, NULL);
1374 if (strncmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
1375 attr = get_key_attribute(rules->udev, key + sizeof("IMPORT")-1);
1376 if (attr != NULL && strstr(attr, "program")) {
1377 dbg(rules->udev, "IMPORT will be executed\n");
1378 rule_add_key(&rule_tmp, TK_M_IMPORT_PROG, op, value, NULL);
1379 } else if (attr != NULL && strstr(attr, "file")) {
1380 dbg(rules->udev, "IMPORT will be included as file\n");
1381 rule_add_key(&rule_tmp, TK_M_IMPORT_FILE, op, value, NULL);
1382 } else if (attr != NULL && strstr(attr, "parent")) {
1383 dbg(rules->udev, "IMPORT will include the parent values\n");
1384 rule_add_key(&rule_tmp, TK_M_IMPORT_PARENT, op, value, NULL);
1386 /* figure it out if it is executable */
1387 char file[UTIL_PATH_SIZE];
1389 struct stat statbuf;
1391 /* allow programs in /lib/udev called without the path */
1392 if (value[0] != '/')
1393 util_strscpyl(file, sizeof(file), LIBEXECDIR "/", value, NULL);
1395 util_strscpy(file, sizeof(file), value);
1396 pos = strchr(file, ' ');
1399 dbg(rules->udev, "IMPORT auto mode for '%s'\n", file);
1400 if (stat(file, &statbuf) == 0 && (statbuf.st_mode & S_IXUSR)) {
1401 dbg(rules->udev, "IMPORT will be executed (autotype)\n");
1402 rule_add_key(&rule_tmp, TK_M_IMPORT_PROG, op, value, NULL);
1404 dbg(rules->udev, "IMPORT will be included as file (autotype)\n");
1405 rule_add_key(&rule_tmp, TK_M_IMPORT_FILE, op, value, NULL);
1411 if (strncmp(key, "TEST", sizeof("TEST")-1) == 0) {
1414 if (op > OP_MATCH_MAX) {
1415 err(rules->udev, "invalid TEST operation\n");
1418 attr = get_key_attribute(rules->udev, key + sizeof("TEST")-1);
1420 mode = strtol(attr, NULL, 8);
1421 rule_add_key(&rule_tmp, TK_M_TEST, op, value, &mode);
1423 rule_add_key(&rule_tmp, TK_M_TEST, op, value, NULL);
1428 if (strncmp(key, "RUN", sizeof("RUN")-1) == 0) {
1431 attr = get_key_attribute(rules->udev, key + sizeof("RUN")-1);
1432 if (attr != NULL && strstr(attr, "fail_event_on_error"))
1434 rule_add_key(&rule_tmp, TK_A_RUN, op, value, &flag);
1438 if (strcmp(key, "WAIT_FOR") == 0 || strcmp(key, "WAIT_FOR_SYSFS") == 0) {
1439 rule_add_key(&rule_tmp, TK_M_WAITFOR, 0, value, NULL);
1443 if (strcmp(key, "LABEL") == 0) {
1444 rule_tmp.rule.rule.label_off = add_string(rules, value);
1448 if (strcmp(key, "GOTO") == 0) {
1449 rule_add_key(&rule_tmp, TK_A_GOTO, 0, value, NULL);
1453 if (strncmp(key, "NAME", sizeof("NAME")-1) == 0) {
1454 if (op < OP_MATCH_MAX) {
1455 rule_add_key(&rule_tmp, TK_M_NAME, op, value, NULL);
1457 if (value[0] == '\0')
1458 info(rules->udev, "name empty, node creation suppressed\n");
1459 else if (strcmp(value, "%k") == 0)
1460 err(rules->udev, "NAME=\"%%k\" is superfluous and breaks "
1461 "kernel supplied names, please remove it from %s:%u\n", filename, lineno);
1462 rule_add_key(&rule_tmp, TK_A_NAME, op, value, NULL);
1463 attr = get_key_attribute(rules->udev, key + sizeof("NAME")-1);
1465 if (strstr(attr, "all_partitions") != NULL) {
1466 int num = DEFAULT_FAKE_PARTITIONS_COUNT;
1468 dbg(rules->udev, "creation of partition nodes requested\n");
1469 rule_add_key(&rule_tmp, TK_A_NUM_FAKE_PART, 0, NULL, &num);
1471 if (strstr(attr, "ignore_remove") != NULL) {
1472 dbg(rules->udev, "remove event should be ignored\n");
1473 rule_add_key(&rule_tmp, TK_A_IGNORE_REMOVE, 0, NULL, NULL);
1477 rule_tmp.rule.rule.flags = 1;
1481 if (strncmp(key, "SYMLINK", sizeof("SYMLINK")-1) == 0) {
1482 if (op < OP_MATCH_MAX) {
1483 rule_add_key(&rule_tmp, TK_M_DEVLINK, op, value, NULL);
1487 attr = get_key_attribute(rules->udev, key + sizeof("SYMLINK")-1);
1488 if (attr != NULL && strstr(attr, "unique") != NULL)
1490 rule_add_key(&rule_tmp, TK_A_DEVLINK, op, value, &flag);
1492 rule_tmp.rule.rule.flags = 1;
1496 if (strcmp(key, "OWNER") == 0) {
1500 uid = strtoul(value, &endptr, 10);
1501 if (endptr[0] == '\0') {
1502 rule_add_key(&rule_tmp, TK_A_OWNER_ID, op, NULL, &uid);
1503 } else if ((rules->resolve_names > 0) && strchr("$%", value[0]) == NULL) {
1504 uid = add_uid(rules, value);
1505 rule_add_key(&rule_tmp, TK_A_OWNER_ID, op, NULL, &uid);
1506 } else if (rules->resolve_names >= 0) {
1507 rule_add_key(&rule_tmp, TK_A_OWNER, op, value, NULL);
1509 rule_tmp.rule.rule.flags = 1;
1513 if (strcmp(key, "GROUP") == 0) {
1517 gid = strtoul(value, &endptr, 10);
1518 if (endptr[0] == '\0') {
1519 rule_add_key(&rule_tmp, TK_A_GROUP_ID, op, NULL, &gid);
1520 } else if ((rules->resolve_names > 0) && strchr("$%", value[0]) == NULL) {
1521 gid = add_gid(rules, value);
1522 rule_add_key(&rule_tmp, TK_A_GROUP_ID, op, NULL, &gid);
1523 } else if (rules->resolve_names >= 0) {
1524 rule_add_key(&rule_tmp, TK_A_GROUP, op, value, NULL);
1526 rule_tmp.rule.rule.flags = 1;
1530 if (strcmp(key, "MODE") == 0) {
1534 mode = strtol(value, &endptr, 8);
1535 if (endptr[0] == '\0')
1536 rule_add_key(&rule_tmp, TK_A_MODE_ID, op, NULL, &mode);
1538 rule_add_key(&rule_tmp, TK_A_MODE, op, value, NULL);
1539 rule_tmp.rule.rule.flags = 1;
1543 if (strcmp(key, "OPTIONS") == 0) {
1546 if (strstr(value, "ignore_remove") != NULL) {
1547 dbg(rules->udev, "remove event should be ignored\n");
1548 rule_add_key(&rule_tmp, TK_A_IGNORE_REMOVE, 0, NULL, NULL);
1550 pos = strstr(value, "link_priority=");
1552 int prio = atoi(&pos[strlen("link_priority=")]);
1554 rule_add_key(&rule_tmp, TK_A_DEVLINK_PRIO, 0, NULL, &prio);
1555 dbg(rules->udev, "link priority=%i\n", prio);
1557 pos = strstr(value, "event_timeout=");
1559 int tout = atoi(&pos[strlen("event_timeout=")]);
1561 rule_add_key(&rule_tmp, TK_A_EVENT_TIMEOUT, 0, NULL, &tout);
1562 dbg(rules->udev, "event timeout=%i\n", tout);
1564 pos = strstr(value, "string_escape=");
1566 pos = &pos[strlen("string_escape=")];
1567 if (strncmp(pos, "none", strlen("none")) == 0)
1568 rule_add_key(&rule_tmp, TK_A_STRING_ESCAPE_NONE, 0, NULL, NULL);
1569 else if (strncmp(pos, "replace", strlen("replace")) == 0)
1570 rule_add_key(&rule_tmp, TK_A_STRING_ESCAPE_REPLACE, 0, NULL, NULL);
1572 if (strstr(value, "all_partitions") != NULL) {
1573 int num = DEFAULT_FAKE_PARTITIONS_COUNT;
1575 rule_add_key(&rule_tmp, TK_A_NUM_FAKE_PART, 0, NULL, &num);
1576 dbg(rules->udev, "creation of partition nodes requested\n");
1578 pos = strstr(value, "nowatch");
1582 rule_add_key(&rule_tmp, TK_A_INOTIFY_WATCH, 0, NULL, &off);
1583 dbg(rules->udev, "inotify watch of device disabled\n");
1585 pos = strstr(value, "watch");
1589 rule_add_key(&rule_tmp, TK_A_INOTIFY_WATCH, 0, NULL, &on);
1590 dbg(rules->udev, "inotify watch of device requested\n");
1595 err(rules->udev, "unknown key '%s' in %s:%u\n", key, filename, lineno);
1598 /* add rule token */
1599 rule_tmp.rule.rule.token_count = 1 + rule_tmp.token_cur;
1600 if (add_token(rules, &rule_tmp.rule) != 0)
1603 /* add tokens to list, sorted by type */
1604 if (sort_token(rules, &rule_tmp) != 0)
1609 err(rules->udev, "invalid rule '%s:%u'\n", filename, lineno);
1613 static int parse_file(struct udev_rules *rules, const char *filename, unsigned short filename_off)
1616 unsigned int first_token;
1617 char line[UTIL_LINE_SIZE];
1621 info(rules->udev, "reading '%s' as rules file\n", filename);
1623 f = fopen(filename, "r");
1627 first_token = rules->token_cur;
1629 while (fgets(line, sizeof(line), f) != NULL) {
1633 /* skip whitespace */
1636 while (isspace(key[0]))
1647 /* continue reading if backslash+newline is found */
1648 while (line[len-2] == '\\') {
1649 if (fgets(&line[len-2], (sizeof(line)-len)+2, f) == NULL)
1651 if (strlen(&line[len-2]) < 2)
1657 if (len+1 >= sizeof(line)) {
1658 err(rules->udev, "line too long '%s':%u, ignored\n", filename, line_nr);
1661 add_rule(rules, key, filename, filename_off, line_nr);
1665 /* link GOTOs to LABEL rules in this file to be able to fast-forward */
1666 for (i = first_token+1; i < rules->token_cur; i++) {
1667 if (rules->tokens[i].type == TK_A_GOTO) {
1668 char *label = &rules->buf[rules->tokens[i].key.value_off];
1671 for (j = i+1; j < rules->token_cur; j++) {
1672 if (rules->tokens[j].type != TK_RULE)
1674 if (rules->tokens[j].rule.label_off == 0)
1676 if (strcmp(label, &rules->buf[rules->tokens[j].rule.label_off]) != 0)
1678 rules->tokens[i].key.rule_goto = j;
1681 if (rules->tokens[i].key.rule_goto == 0)
1682 err(rules->udev, "GOTO '%s' has no matching label in: '%s'\n", label, filename);
1688 static int add_matching_files(struct udev *udev, struct udev_list_node *file_list, const char *dirname, const char *suffix)
1691 char filename[UTIL_PATH_SIZE];
1693 dbg(udev, "open directory '%s'\n", dirname);
1694 dir = opendir(dirname);
1696 info(udev, "unable to open '%s': %m\n", dirname);
1701 struct dirent *dent;
1703 dent = readdir(dir);
1704 if (dent == NULL || dent->d_name[0] == '\0')
1707 if (dent->d_name[0] == '.')
1710 /* look for file matching with specified suffix */
1711 if (suffix != NULL) {
1714 ext = strrchr(dent->d_name, '.');
1717 if (strcmp(ext, suffix) != 0)
1720 util_strscpyl(filename, sizeof(filename), dirname, "/", dent->d_name, NULL);
1721 dbg(udev, "put file '%s' into list\n", filename);
1722 udev_list_entry_add(udev, file_list, filename, NULL, 1, 1);
1729 struct udev_rules *udev_rules_new(struct udev *udev, int resolve_names)
1731 struct udev_rules *rules;
1732 struct stat statbuf;
1733 struct udev_list_node file_list;
1734 struct udev_list_entry *file_loop, *file_tmp;
1735 struct token end_token;
1737 rules = malloc(sizeof(struct udev_rules));
1740 memset(rules, 0x00, sizeof(struct udev_rules));
1742 rules->resolve_names = resolve_names;
1743 udev_list_init(&file_list);
1745 /* init token array and string buffer */
1746 rules->tokens = malloc(PREALLOC_TOKEN * sizeof(struct token));
1747 if (rules->tokens == NULL)
1749 rules->token_max = PREALLOC_TOKEN;
1751 rules->buf = malloc(PREALLOC_STRBUF);
1752 if (rules->buf == NULL)
1754 rules->buf_max = PREALLOC_STRBUF;
1755 /* offset 0 is always '\0' */
1756 rules->buf[0] = '\0';
1758 dbg(udev, "prealloc %zu bytes tokens (%u * %zu bytes), %zu bytes buffer\n",
1759 rules->token_max * sizeof(struct token), rules->token_max, sizeof(struct token), rules->buf_max);
1761 rules->trie_nodes = malloc(PREALLOC_TRIE * sizeof(struct trie_node));
1762 if (rules->trie_nodes == NULL)
1764 rules->trie_nodes_max = PREALLOC_TRIE;
1765 /* offset 0 is the trie root, with an empty string */
1766 memset(rules->trie_nodes, 0x00, sizeof(struct trie_node));
1767 rules->trie_nodes_cur = 1;
1769 if (udev_get_rules_path(udev) != NULL) {
1770 /* custom rules location for testing */
1771 add_matching_files(udev, &file_list, udev_get_rules_path(udev), ".rules");
1773 char filename[PATH_MAX];
1774 struct udev_list_node sort_list;
1775 struct udev_list_entry *sort_loop, *sort_tmp;
1777 /* read user/custom rules */
1778 add_matching_files(udev, &file_list, SYSCONFDIR "/udev/rules.d", ".rules");
1780 /* read dynamic/temporary rules */
1781 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(udev), "/.udev/rules.d", NULL);
1782 udev_list_init(&sort_list);
1783 add_matching_files(udev, &sort_list, filename, ".rules");
1785 /* read default rules */
1786 add_matching_files(udev, &sort_list, LIBEXECDIR "/rules.d", ".rules");
1788 /* sort all rules files by basename into list of files */
1789 udev_list_entry_foreach_safe(sort_loop, sort_tmp, udev_list_get_entry(&sort_list)) {
1790 const char *sort_name = udev_list_entry_get_name(sort_loop);
1791 const char *sort_base = strrchr(sort_name, '/');
1793 if (sort_base == NULL)
1795 /* sort entry into existing list */
1796 udev_list_entry_foreach_safe(file_loop, file_tmp, udev_list_get_entry(&file_list)) {
1797 const char *file_name = udev_list_entry_get_name(file_loop);
1798 const char *file_base = strrchr(file_name, '/');
1800 if (file_base == NULL)
1802 if (strcmp(file_base, sort_base) == 0) {
1803 info(udev, "rule file basename '%s' already added, ignoring '%s'\n",
1804 file_name, sort_name);
1805 udev_list_entry_delete(sort_loop);
1809 if (strcmp(file_base, sort_base) > 0) {
1810 /* found later file, insert before */
1811 udev_list_entry_remove(sort_loop);
1812 udev_list_entry_insert_before(sort_loop, file_loop);
1817 /* current file already handled */
1818 if (sort_loop == NULL)
1820 /* no later file, append to end of list */
1821 udev_list_entry_remove(sort_loop);
1822 udev_list_entry_append(sort_loop, &file_list);
1826 /* add all filenames to the string buffer */
1827 udev_list_entry_foreach(file_loop, udev_list_get_entry(&file_list)) {
1828 const char *filename = udev_list_entry_get_name(file_loop);
1829 unsigned int filename_off;
1831 filename_off = add_string(rules, filename);
1832 /* the offset in the rule is limited to unsigned short */
1833 if (filename_off < USHRT_MAX)
1834 udev_list_entry_set_flag(file_loop, filename_off);
1837 /* parse list of files */
1838 udev_list_entry_foreach_safe(file_loop, file_tmp, udev_list_get_entry(&file_list)) {
1839 const char *filename = udev_list_entry_get_name(file_loop);
1840 unsigned int filename_off = udev_list_entry_get_flag(file_loop);
1842 if (stat(filename, &statbuf) == 0 && statbuf.st_size > 0)
1843 parse_file(rules, filename, filename_off);
1845 err(udev, "can not read '%s'\n", filename);
1846 udev_list_entry_delete(file_loop);
1849 memset(&end_token, 0x00, sizeof(struct token));
1850 end_token.type = TK_END;
1851 add_token(rules, &end_token);
1853 /* shrink allocated token and string buffer */
1854 if (rules->token_cur < rules->token_max) {
1855 struct token *tokens;
1857 tokens = realloc(rules->tokens, rules->token_cur * sizeof(struct token));
1858 if (tokens != NULL || rules->token_cur == 0) {
1859 rules->tokens = tokens;
1860 rules->token_max = rules->token_cur;
1863 if (rules->buf_cur < rules->buf_max) {
1866 buf = realloc(rules->buf, rules->buf_cur);
1867 if (buf != NULL || rules->buf_cur == 0) {
1869 rules->buf_max = rules->buf_cur;
1872 info(udev, "rules use %zu bytes tokens (%u * %zu bytes), %zu bytes buffer\n",
1873 rules->token_max * sizeof(struct token), rules->token_max, sizeof(struct token), rules->buf_max);
1874 info(udev, "temporary index used %zu bytes (%u * %zu bytes)\n",
1875 rules->trie_nodes_cur * sizeof(struct trie_node),
1876 rules->trie_nodes_cur, sizeof(struct trie_node));
1879 free(rules->trie_nodes);
1880 rules->trie_nodes = NULL;
1881 rules->trie_nodes_cur = 0;
1882 rules->trie_nodes_max = 0;
1884 /* cleanup uid/gid cache */
1887 rules->uids_cur = 0;
1888 rules->uids_max = 0;
1891 rules->gids_cur = 0;
1892 rules->gids_max = 0;
1898 void udev_rules_unref(struct udev_rules *rules)
1902 free(rules->tokens);
1904 free(rules->trie_nodes);
1910 static int match_key(struct udev_rules *rules, struct token *token, const char *val)
1912 char *key_value = &rules->buf[token->key.value_off];
1919 switch (token->key.glob) {
1921 match = (strcmp(key_value, val) == 0);
1924 match = (fnmatch(key_value, val, 0) == 0);
1931 split = &rules->buf[token->key.value_off];
1936 next = strchr(split, '|');
1938 size_t matchlen = (size_t)(next - split);
1940 match = (matchlen == len && strncmp(split, val, matchlen) == 0);
1944 match = (strcmp(split, val) == 0);
1953 char value[UTIL_PATH_SIZE];
1955 util_strscpy(value, sizeof(value), &rules->buf[token->key.value_off]);
1957 while (key_value != NULL) {
1958 pos = strchr(key_value, '|');
1963 dbg(rules->udev, "match %s '%s' <-> '%s'\n", token_str(token->type), key_value, val);
1964 match = (fnmatch(key_value, val, 0) == 0);
1972 match = (val[0] != '\0');
1978 if (match && (token->key.op == OP_MATCH)) {
1979 dbg(rules->udev, "%s is true (matching value)\n", token_str(token->type));
1982 if (!match && (token->key.op == OP_NOMATCH)) {
1983 dbg(rules->udev, "%s is true (non-matching value)\n", token_str(token->type));
1986 dbg(rules->udev, "%s is not true\n", token_str(token->type));
1990 static int match_attr(struct udev_rules *rules, struct udev_device *dev, struct udev_event *event, struct token *cur)
1993 char nbuf[UTIL_NAME_SIZE];
1995 char vbuf[UTIL_NAME_SIZE];
1998 name = &rules->buf[cur->key.attr_off];
1999 switch (cur->key.attrsubst) {
2001 udev_event_apply_format(event, name, nbuf, sizeof(nbuf));
2005 value = udev_device_get_sysattr_value(dev, name);
2010 if (util_resolve_subsys_kernel(event->udev, name, vbuf, sizeof(vbuf), 1) != 0)
2018 /* remove trailing whitespace, if not asked to match for it */
2019 len = strlen(value);
2020 if (len > 0 && isspace(value[len-1])) {
2021 const char *key_value;
2024 key_value = &rules->buf[cur->key.value_off];
2025 klen = strlen(key_value);
2026 if (klen > 0 && !isspace(key_value[klen-1])) {
2027 if (value != vbuf) {
2028 util_strscpy(vbuf, sizeof(vbuf), value);
2031 while (len > 0 && isspace(vbuf[--len]))
2033 dbg(rules->udev, "removed trailing whitespace from '%s'\n", value);
2037 return match_key(rules, cur, value);
2046 int udev_rules_apply_to_event(struct udev_rules *rules, struct udev_event *event)
2050 enum escape_type esc = ESCAPE_UNSET;
2053 if (rules->tokens == NULL)
2056 can_set_name = ((strcmp(udev_device_get_action(event->dev), "add") == 0 ||
2057 strcmp(udev_device_get_action(event->dev), "change") == 0) &&
2058 (major(udev_device_get_devnum(event->dev)) > 0 ||
2059 strcmp(udev_device_get_subsystem(event->dev), "net") == 0));
2061 /* loop through token list, match, run actions or forward to next rule */
2062 cur = &rules->tokens[0];
2065 dump_token(rules, cur);
2066 switch (cur->type) {
2070 /* possibly skip rules which want to set NAME, SYMLINK, OWNER, GROUP, MODE */
2071 if (!can_set_name && rule->rule.flags)
2076 if (match_key(rules, cur, udev_device_get_action(event->dev)) != 0)
2080 if (match_key(rules, cur, udev_device_get_devpath(event->dev)) != 0)
2084 if (match_key(rules, cur, udev_device_get_sysname(event->dev)) != 0)
2089 size_t devlen = strlen(udev_get_dev_path(event->udev))+1;
2090 struct udev_list_entry *list_entry;
2093 udev_list_entry_foreach(list_entry, udev_device_get_devlinks_list_entry(event->dev)) {
2094 const char *devlink;
2096 devlink = &udev_list_entry_get_name(list_entry)[devlen];
2097 if (match_key(rules, cur, devlink) == 0) {
2107 if (match_key(rules, cur, event->name) != 0)
2112 const char *key_name = &rules->buf[cur->key.attr_off];
2115 value = udev_device_get_property_value(event->dev, key_name);
2116 if (value == NULL) {
2117 dbg(event->udev, "ENV{%s} is not set, treat as empty\n", key_name);
2120 if (match_key(rules, cur, value))
2124 case TK_M_SUBSYSTEM:
2125 if (match_key(rules, cur, udev_device_get_subsystem(event->dev)) != 0)
2129 if (match_key(rules, cur, udev_device_get_driver(event->dev)) != 0)
2134 char filename[UTIL_PATH_SIZE];
2137 udev_event_apply_format(event, &rules->buf[cur->key.value_off], filename, sizeof(filename));
2138 found = (wait_for_file(event->dev, filename, 10) == 0);
2139 if (!found && (cur->key.op != OP_NOMATCH))
2144 if (match_attr(rules, event->dev, event, cur) != 0)
2148 case TK_M_SUBSYSTEMS:
2154 /* get whole sequence of parent matches */
2156 while (next->type > TK_M_PARENTS_MIN && next->type < TK_M_PARENTS_MAX)
2159 /* loop over parents */
2160 event->dev_parent = event->dev;
2164 dbg(event->udev, "parent: '%s'\n", udev_device_get_syspath(event->dev_parent));
2165 /* loop over sequence of parent match keys */
2166 for (key = cur; key < next; key++ ) {
2167 dump_token(rules, key);
2170 if (match_key(rules, key, udev_device_get_sysname(event->dev_parent)) != 0)
2173 case TK_M_SUBSYSTEMS:
2174 if (match_key(rules, key, udev_device_get_subsystem(event->dev_parent)) != 0)
2178 if (match_key(rules, key, udev_device_get_driver(event->dev_parent)) != 0)
2182 if (match_attr(rules, event->dev_parent, event, key) != 0)
2188 dbg(event->udev, "parent key matched\n");
2190 dbg(event->udev, "all parent keys matched\n");
2191 /* all keys matched */
2195 event->dev_parent = udev_device_get_parent(event->dev_parent);
2196 if (event->dev_parent == NULL)
2199 /* move behind our sequence of parent match keys */
2205 char filename[UTIL_PATH_SIZE];
2206 struct stat statbuf;
2209 udev_event_apply_format(event, &rules->buf[cur->key.value_off], filename, sizeof(filename));
2210 if (util_resolve_subsys_kernel(event->udev, filename, filename, sizeof(filename), 0) != 0) {
2211 if (filename[0] != '/') {
2212 char tmp[UTIL_PATH_SIZE];
2214 util_strscpy(tmp, sizeof(tmp), filename);
2215 util_strscpyl(filename, sizeof(filename),
2216 udev_device_get_syspath(event->dev), "/", tmp, NULL);
2219 attr_subst_subdir(filename, sizeof(filename));
2221 match = (stat(filename, &statbuf) == 0);
2222 dbg(event->udev, "'%s' %s", filename, match ? "exists\n" : "does not exist\n");
2223 if (match && cur->key.mode > 0) {
2224 match = ((statbuf.st_mode & cur->key.mode) > 0);
2225 dbg(event->udev, "'%s' has mode=%#o and %s %#o\n", filename, statbuf.st_mode,
2226 match ? "matches" : "does not match", cur->key.mode);
2228 if (match && cur->key.op == OP_NOMATCH)
2230 if (!match && cur->key.op == OP_MATCH)
2236 char program[UTIL_PATH_SIZE];
2238 char result[UTIL_PATH_SIZE];
2240 free(event->program_result);
2241 event->program_result = NULL;
2242 udev_event_apply_format(event, &rules->buf[cur->key.value_off], program, sizeof(program));
2243 envp = udev_device_get_properties_envp(event->dev);
2244 info(event->udev, "PROGRAM '%s' %s:%u\n",
2246 &rules->buf[rule->rule.filename_off],
2247 rule->rule.filename_line);
2248 if (util_run_program(event->udev, program, envp, result, sizeof(result), NULL, NULL) != 0) {
2249 if (cur->key.op != OP_NOMATCH)
2254 util_remove_trailing_chars(result, '\n');
2255 if (esc == ESCAPE_UNSET || esc == ESCAPE_REPLACE) {
2256 count = udev_util_replace_chars(result, UDEV_ALLOWED_CHARS_INPUT);
2258 info(event->udev, "%i character(s) replaced\n" , count);
2260 event->program_result = strdup(result);
2261 dbg(event->udev, "storing result '%s'\n", event->program_result);
2262 if (cur->key.op == OP_NOMATCH)
2267 case TK_M_IMPORT_FILE:
2269 char import[UTIL_PATH_SIZE];
2271 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2272 if (import_file_into_properties(event->dev, import) != 0)
2273 if (cur->key.op != OP_NOMATCH)
2277 case TK_M_IMPORT_PROG:
2279 char import[UTIL_PATH_SIZE];
2281 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2282 info(event->udev, "IMPORT '%s' %s:%u\n",
2284 &rules->buf[rule->rule.filename_off],
2285 rule->rule.filename_line);
2286 if (import_program_into_properties(event->dev, import) != 0)
2287 if (cur->key.op != OP_NOMATCH)
2291 case TK_M_IMPORT_PARENT:
2293 char import[UTIL_PATH_SIZE];
2295 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2296 if (import_parent_into_properties(event->dev, import) != 0)
2297 if (cur->key.op != OP_NOMATCH)
2302 if (match_key(rules, cur, event->program_result) != 0)
2305 case TK_A_STRING_ESCAPE_NONE:
2308 case TK_A_STRING_ESCAPE_REPLACE:
2309 esc = ESCAPE_REPLACE;
2311 case TK_A_NUM_FAKE_PART:
2312 if (strcmp(udev_device_get_subsystem(event->dev), "block") != 0)
2314 if (udev_device_get_sysnum(event->dev) != NULL)
2316 udev_device_set_num_fake_partitions(event->dev, cur->key.num_fake_part);
2318 case TK_A_INOTIFY_WATCH:
2319 event->inotify_watch = cur->key.watch;
2321 case TK_A_DEVLINK_PRIO:
2322 udev_device_set_devlink_priority(event->dev, cur->key.devlink_prio);
2326 char owner[UTIL_NAME_SIZE];
2328 if (event->owner_final)
2330 if (cur->key.op == OP_ASSIGN_FINAL)
2331 event->owner_final = 1;
2332 udev_event_apply_format(event, &rules->buf[cur->key.value_off], owner, sizeof(owner));
2333 event->uid = util_lookup_user(event->udev, owner);
2334 info(event->udev, "OWNER %u %s:%u\n",
2336 &rules->buf[rule->rule.filename_off],
2337 rule->rule.filename_line);
2342 char group[UTIL_NAME_SIZE];
2344 if (event->group_final)
2346 if (cur->key.op == OP_ASSIGN_FINAL)
2347 event->group_final = 1;
2348 udev_event_apply_format(event, &rules->buf[cur->key.value_off], group, sizeof(group));
2349 event->gid = util_lookup_group(event->udev, group);
2350 info(event->udev, "GROUP %u %s:%u\n",
2352 &rules->buf[rule->rule.filename_off],
2353 rule->rule.filename_line);
2358 char mode[UTIL_NAME_SIZE];
2361 if (event->mode_final)
2363 if (cur->key.op == OP_ASSIGN_FINAL)
2364 event->mode_final = 1;
2365 udev_event_apply_format(event, &rules->buf[cur->key.value_off], mode, sizeof(mode));
2366 event->mode = strtol(mode, &endptr, 8);
2367 if (endptr[0] != '\0') {
2368 err(event->udev, "invalide mode '%s' set default mode 0660\n", mode);
2371 info(event->udev, "MODE %#o %s:%u\n",
2373 &rules->buf[rule->rule.filename_off],
2374 rule->rule.filename_line);
2378 if (event->owner_final)
2380 if (cur->key.op == OP_ASSIGN_FINAL)
2381 event->owner_final = 1;
2382 event->uid = cur->key.uid;
2383 info(event->udev, "OWNER %u %s:%u\n",
2385 &rules->buf[rule->rule.filename_off],
2386 rule->rule.filename_line);
2389 if (event->group_final)
2391 if (cur->key.op == OP_ASSIGN_FINAL)
2392 event->group_final = 1;
2393 event->gid = cur->key.gid;
2394 info(event->udev, "GROUP %u %s:%u\n",
2396 &rules->buf[rule->rule.filename_off],
2397 rule->rule.filename_line);
2400 if (event->mode_final)
2402 if (cur->key.op == OP_ASSIGN_FINAL)
2403 event->mode_final = 1;
2404 event->mode = cur->key.mode;
2405 info(event->udev, "MODE %#o %s:%u\n",
2407 &rules->buf[rule->rule.filename_off],
2408 rule->rule.filename_line);
2412 const char *name = &rules->buf[cur->key.attr_off];
2413 char *value = &rules->buf[cur->key.value_off];
2415 if (value[0] != '\0') {
2416 char temp_value[UTIL_NAME_SIZE];
2417 struct udev_list_entry *entry;
2419 udev_event_apply_format(event, value, temp_value, sizeof(temp_value));
2420 entry = udev_device_add_property(event->dev, name, temp_value);
2421 /* store in db, skip private keys */
2423 udev_list_entry_set_flag(entry, 1);
2425 udev_device_add_property(event->dev, name, NULL);
2431 const char *name = &rules->buf[cur->key.value_off];
2432 char name_str[UTIL_PATH_SIZE];
2435 if (event->name_final)
2437 if (cur->key.op == OP_ASSIGN_FINAL)
2438 event->name_final = 1;
2439 udev_event_apply_format(event, name, name_str, sizeof(name_str));
2440 if (esc == ESCAPE_UNSET || esc == ESCAPE_REPLACE) {
2441 count = udev_util_replace_chars(name_str, "/");
2443 info(event->udev, "%i character(s) replaced\n", count);
2446 event->name = strdup(name_str);
2447 info(event->udev, "NAME '%s' %s:%u\n",
2449 &rules->buf[rule->rule.filename_off],
2450 rule->rule.filename_line);
2455 char temp[UTIL_PATH_SIZE];
2456 char filename[UTIL_PATH_SIZE];
2460 if (event->devlink_final)
2462 if (major(udev_device_get_devnum(event->dev)) == 0)
2464 if (cur->key.op == OP_ASSIGN_FINAL)
2465 event->devlink_final = 1;
2466 if (cur->key.op == OP_ASSIGN || cur->key.op == OP_ASSIGN_FINAL)
2467 udev_device_cleanup_devlinks_list(event->dev);
2469 /* allow multiple symlinks separated by spaces */
2470 udev_event_apply_format(event, &rules->buf[cur->key.value_off], temp, sizeof(temp));
2471 if (esc == ESCAPE_UNSET)
2472 count = udev_util_replace_chars(temp, "/ ");
2473 else if (esc == ESCAPE_REPLACE)
2474 count = udev_util_replace_chars(temp, "/");
2476 info(event->udev, "%i character(s) replaced\n" , count);
2477 dbg(event->udev, "rule applied, added symlink(s) '%s'\n", temp);
2479 while (isspace(pos[0]))
2481 next = strchr(pos, ' ');
2482 while (next != NULL) {
2484 info(event->udev, "LINK '%s' %s:%u\n", pos,
2485 &rules->buf[rule->rule.filename_off], rule->rule.filename_line);
2486 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(event->udev), "/", pos, NULL);
2487 udev_device_add_devlink(event->dev, filename, cur->key.devlink_unique);
2488 while (isspace(next[1]))
2491 next = strchr(pos, ' ');
2493 if (pos[0] != '\0') {
2494 info(event->udev, "LINK '%s' %s:%u\n", pos,
2495 &rules->buf[rule->rule.filename_off], rule->rule.filename_line);
2496 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(event->udev), "/", pos, NULL);
2497 udev_device_add_devlink(event->dev, filename, cur->key.devlink_unique);
2501 case TK_A_EVENT_TIMEOUT:
2502 udev_device_set_event_timeout(event->dev, cur->key.event_timeout);
2504 case TK_A_IGNORE_REMOVE:
2505 udev_device_set_ignore_remove(event->dev, 1);
2509 const char *key_name = &rules->buf[cur->key.attr_off];
2510 char attr[UTIL_PATH_SIZE];
2511 char value[UTIL_NAME_SIZE];
2514 if (util_resolve_subsys_kernel(event->udev, key_name, attr, sizeof(attr), 0) != 0)
2515 util_strscpyl(attr, sizeof(attr), udev_device_get_syspath(event->dev), "/", key_name, NULL);
2516 attr_subst_subdir(attr, sizeof(attr));
2518 udev_event_apply_format(event, &rules->buf[cur->key.value_off], value, sizeof(value));
2519 info(event->udev, "ATTR '%s' writing '%s' %s:%u\n", attr, value,
2520 &rules->buf[rule->rule.filename_off],
2521 rule->rule.filename_line);
2522 f = fopen(attr, "w");
2524 if (fprintf(f, "%s", value) <= 0)
2525 err(event->udev, "error writing ATTR{%s}: %m\n", attr);
2528 err(event->udev, "error opening ATTR{%s} for writing: %m\n", attr);
2534 struct udev_list_entry *list_entry;
2536 if (cur->key.op == OP_ASSIGN || cur->key.op == OP_ASSIGN_FINAL)
2537 udev_list_cleanup_entries(event->udev, &event->run_list);
2538 info(event->udev, "RUN '%s' %s:%u\n",
2539 &rules->buf[cur->key.value_off],
2540 &rules->buf[rule->rule.filename_off],
2541 rule->rule.filename_line);
2542 list_entry = udev_list_entry_add(event->udev, &event->run_list,
2543 &rules->buf[cur->key.value_off], NULL, 1, 0);
2544 if (cur->key.fail_on_error)
2545 udev_list_entry_set_flag(list_entry, 1);
2549 if (cur->key.rule_goto == 0)
2551 cur = &rules->tokens[cur->key.rule_goto];
2556 case TK_M_PARENTS_MIN:
2557 case TK_M_PARENTS_MAX:
2560 err(rules->udev, "wrong type %u\n", cur->type);
2567 /* fast-forward to next rule */
2568 cur = rule + rule->rule.token_count;
2569 dbg(rules->udev, "forward to rule: %u\n",
2570 (unsigned int) (cur - rules->tokens));