2 * Copyright (C) 2003-2010 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 */
129 TK_M_SUBSYSTEM, /* val */
130 TK_M_DRIVER, /* val */
131 TK_M_WAITFOR, /* val */
132 TK_M_ATTR, /* val, attr */
135 TK_M_KERNELS, /* val */
136 TK_M_SUBSYSTEMS, /* val */
137 TK_M_DRIVERS, /* val */
138 TK_M_ATTRS, /* val, attr */
142 TK_M_TEST, /* val, mode_t */
143 TK_M_EVENT_TIMEOUT, /* int */
144 TK_M_PROGRAM, /* val */
145 TK_M_IMPORT_FILE, /* val */
146 TK_M_IMPORT_PROG, /* val */
147 TK_M_IMPORT_BUILTIN, /* val */
148 TK_M_IMPORT_DB, /* val */
149 TK_M_IMPORT_CMDLINE, /* val */
150 TK_M_IMPORT_PARENT, /* val */
151 TK_M_RESULT, /* val */
154 TK_A_STRING_ESCAPE_NONE,
155 TK_A_STRING_ESCAPE_REPLACE,
157 TK_A_INOTIFY_WATCH, /* int */
158 TK_A_DEVLINK_PRIO, /* int */
159 TK_A_OWNER, /* val */
160 TK_A_GROUP, /* val */
162 TK_A_OWNER_ID, /* uid_t */
163 TK_A_GROUP_ID, /* gid_t */
164 TK_A_MODE_ID, /* mode_t */
165 TK_A_STATIC_NODE, /* val */
166 TK_A_ENV, /* val, attr */
169 TK_A_DEVLINK, /* val */
170 TK_A_ATTR, /* val, attr */
171 TK_A_RUN, /* val, bool */
172 TK_A_GOTO, /* size_t */
177 /* we try to pack stuff in a way that we take only 12 bytes per token */
180 unsigned char type; /* same in rule and key */
182 enum token_type type:8;
184 bool has_static_node:1;
185 unsigned int unused:6;
186 unsigned short token_count;
187 unsigned int label_off;
188 unsigned short filename_off;
189 unsigned short filename_line;
192 enum token_type type:8;
193 enum operation_type op:8;
194 enum string_glob_type glob:8;
195 enum string_subst_type subst:4;
196 enum string_subst_type attrsubst:4;
197 unsigned int value_off;
199 unsigned int attr_off;
201 unsigned int rule_goto;
208 enum udev_builtin_cmd builtin_cmd;
216 struct udev_rules *rules;
218 struct token token[MAX_TK];
219 unsigned int token_cur;
223 static const char *operation_str(enum operation_type type)
225 static const char *operation_strs[] = {
226 [OP_UNSET] = "UNSET",
227 [OP_MATCH] = "match",
228 [OP_NOMATCH] = "nomatch",
229 [OP_MATCH_MAX] = "MATCH_MAX",
232 [OP_ASSIGN] = "assign",
233 [OP_ASSIGN_FINAL] = "assign-final",
236 return operation_strs[type];
239 static const char *string_glob_str(enum string_glob_type type)
241 static const char *string_glob_strs[] = {
242 [GL_UNSET] = "UNSET",
243 [GL_PLAIN] = "plain",
245 [GL_SPLIT] = "split",
246 [GL_SPLIT_GLOB] = "split-glob",
247 [GL_SOMETHING] = "split-glob",
250 return string_glob_strs[type];
253 static const char *token_str(enum token_type type)
255 static const char *token_strs[] = {
256 [TK_UNSET] = "UNSET",
259 [TK_M_ACTION] = "M ACTION",
260 [TK_M_DEVPATH] = "M DEVPATH",
261 [TK_M_KERNEL] = "M KERNEL",
262 [TK_M_DEVLINK] = "M DEVLINK",
263 [TK_M_NAME] = "M NAME",
264 [TK_M_ENV] = "M ENV",
265 [TK_M_TAG] = "M TAG",
266 [TK_M_SUBSYSTEM] = "M SUBSYSTEM",
267 [TK_M_DRIVER] = "M DRIVER",
268 [TK_M_WAITFOR] = "M WAITFOR",
269 [TK_M_ATTR] = "M ATTR",
271 [TK_M_PARENTS_MIN] = "M PARENTS_MIN",
272 [TK_M_KERNELS] = "M KERNELS",
273 [TK_M_SUBSYSTEMS] = "M SUBSYSTEMS",
274 [TK_M_DRIVERS] = "M DRIVERS",
275 [TK_M_ATTRS] = "M ATTRS",
276 [TK_M_TAGS] = "M TAGS",
277 [TK_M_PARENTS_MAX] = "M PARENTS_MAX",
279 [TK_M_TEST] = "M TEST",
280 [TK_M_EVENT_TIMEOUT] = "M EVENT_TIMEOUT",
281 [TK_M_PROGRAM] = "M PROGRAM",
282 [TK_M_IMPORT_FILE] = "M IMPORT_FILE",
283 [TK_M_IMPORT_PROG] = "M IMPORT_PROG",
284 [TK_M_IMPORT_BUILTIN] = "M IMPORT_BUILTIN",
285 [TK_M_IMPORT_DB] = "M IMPORT_DB",
286 [TK_M_IMPORT_CMDLINE] = "M IMPORT_CMDLINE",
287 [TK_M_IMPORT_PARENT] = "M IMPORT_PARENT",
288 [TK_M_RESULT] = "M RESULT",
289 [TK_M_MAX] = "M MAX",
291 [TK_A_STRING_ESCAPE_NONE] = "A STRING_ESCAPE_NONE",
292 [TK_A_STRING_ESCAPE_REPLACE] = "A STRING_ESCAPE_REPLACE",
293 [TK_A_DB_PERSIST] = "A DB_PERSIST",
294 [TK_A_INOTIFY_WATCH] = "A INOTIFY_WATCH",
295 [TK_A_DEVLINK_PRIO] = "A DEVLINK_PRIO",
296 [TK_A_OWNER] = "A OWNER",
297 [TK_A_GROUP] = "A GROUP",
298 [TK_A_MODE] = "A MODE",
299 [TK_A_OWNER_ID] = "A OWNER_ID",
300 [TK_A_GROUP_ID] = "A GROUP_ID",
301 [TK_A_STATIC_NODE] = "A STATIC_NODE",
302 [TK_A_MODE_ID] = "A MODE_ID",
303 [TK_A_ENV] = "A ENV",
304 [TK_A_TAG] = "A ENV",
305 [TK_A_NAME] = "A NAME",
306 [TK_A_DEVLINK] = "A DEVLINK",
307 [TK_A_ATTR] = "A ATTR",
308 [TK_A_RUN] = "A RUN",
309 [TK_A_GOTO] = "A GOTO",
314 return token_strs[type];
317 static void dump_token(struct udev_rules *rules, struct token *token)
319 enum token_type type = token->type;
320 enum operation_type op = token->key.op;
321 enum string_glob_type glob = token->key.glob;
322 const char *value = &rules->buf[token->key.value_off];
323 const char *attr = &rules->buf[token->key.attr_off];
328 const char *tks_ptr = (char *)rules->tokens;
329 const char *tk_ptr = (char *)token;
330 unsigned int idx = (tk_ptr - tks_ptr) / sizeof(struct token);
332 log_debug("* RULE %s:%u, token: %u, count: %u, label: '%s'\n",
333 &rules->buf[token->rule.filename_off], token->rule.filename_line,
334 idx, token->rule.token_count,
335 &rules->buf[token->rule.label_off]);
347 case TK_M_SUBSYSTEMS:
351 case TK_M_IMPORT_FILE:
352 case TK_M_IMPORT_PROG:
354 case TK_M_IMPORT_CMDLINE:
355 case TK_M_IMPORT_PARENT:
363 log_debug("%s %s '%s'(%s)\n",
364 token_str(type), operation_str(op), value, string_glob_str(glob));
366 case TK_M_IMPORT_BUILTIN:
367 log_debug("%s %i '%s'\n", token_str(type), token->key.builtin_cmd, value);
374 log_debug("%s %s '%s' '%s'(%s)\n",
375 token_str(type), operation_str(op), attr, value, string_glob_str(glob));
379 log_debug("%s %s '%s'\n", token_str(type), operation_str(op), value);
381 case TK_A_STRING_ESCAPE_NONE:
382 case TK_A_STRING_ESCAPE_REPLACE:
383 case TK_A_DB_PERSIST:
384 log_debug("%s\n", token_str(type));
387 log_debug("%s %s '%s'(%s) %#o\n",
388 token_str(type), operation_str(op), value, string_glob_str(glob), token->key.mode);
390 case TK_A_INOTIFY_WATCH:
391 log_debug("%s %u\n", token_str(type), token->key.watch);
393 case TK_A_DEVLINK_PRIO:
394 log_debug("%s %u\n", token_str(type), token->key.devlink_prio);
397 log_debug("%s %s %u\n", token_str(type), operation_str(op), token->key.uid);
400 log_debug("%s %s %u\n", token_str(type), operation_str(op), token->key.gid);
403 log_debug("%s %s %#o\n", token_str(type), operation_str(op), token->key.mode);
405 case TK_A_STATIC_NODE:
406 log_debug("%s '%s'\n", token_str(type), value);
408 case TK_M_EVENT_TIMEOUT:
409 log_debug("%s %u\n", token_str(type), token->key.event_timeout);
412 log_debug("%s '%s' %u\n", token_str(type), value, token->key.rule_goto);
415 log_debug("* %s\n", token_str(type));
417 case TK_M_PARENTS_MIN:
418 case TK_M_PARENTS_MAX:
421 log_debug("unknown type %u\n", type);
426 static void dump_rules(struct udev_rules *rules)
430 log_debug("dumping %u (%zu bytes) tokens, %u (%zu bytes) strings\n",
432 rules->token_cur * sizeof(struct token),
435 for(i = 0; i < rules->token_cur; i++)
436 dump_token(rules, &rules->tokens[i]);
439 static inline const char *operation_str(enum operation_type type) { return NULL; }
440 static inline const char *token_str(enum token_type type) { return NULL; }
441 static inline void dump_token(struct udev_rules *rules, struct token *token) {}
442 static inline void dump_rules(struct udev_rules *rules) {}
445 static int add_new_string(struct udev_rules *rules, const char *str, size_t bytes)
449 /* grow buffer if needed */
450 if (rules->buf_cur + bytes+1 >= rules->buf_max) {
454 /* double the buffer size */
455 add = rules->buf_max;
459 buf = realloc(rules->buf, rules->buf_max + add);
463 rules->buf_max += add;
465 off = rules->buf_cur;
466 memcpy(&rules->buf[rules->buf_cur], str, bytes);
467 rules->buf_cur += bytes;
472 static int add_string(struct udev_rules *rules, const char *str)
474 unsigned int node_idx;
475 struct trie_node *new_node;
476 unsigned int new_node_idx;
481 struct trie_node *parent;
483 /* walk trie, start from last character of str to find matching tails */
487 for (depth = 0; depth <= len; depth++) {
488 struct trie_node *node;
489 unsigned int child_idx;
491 node = &rules->trie_nodes[node_idx];
492 off = node->value_off + node->value_len - len;
494 /* match against current node */
495 if (depth == len || (node->value_len >= len && memcmp(&rules->buf[off], str, len) == 0))
498 /* lookup child node */
499 key = str[len - 1 - depth];
500 child_idx = node->child_idx;
501 while (child_idx > 0) {
502 struct trie_node *child;
504 child = &rules->trie_nodes[child_idx];
505 if (child->key == key)
507 child_idx = child->next_child_idx;
511 node_idx = child_idx;
514 /* string not found, add it */
515 off = add_new_string(rules, str, len + 1);
517 /* grow trie nodes if needed */
518 if (rules->trie_nodes_cur >= rules->trie_nodes_max) {
519 struct trie_node *nodes;
522 /* double the buffer size */
523 add = rules->trie_nodes_max;
527 nodes = realloc(rules->trie_nodes, (rules->trie_nodes_max + add) * sizeof(struct trie_node));
530 rules->trie_nodes = nodes;
531 rules->trie_nodes_max += add;
535 new_node_idx = rules->trie_nodes_cur;
536 rules->trie_nodes_cur++;
537 new_node = &rules->trie_nodes[new_node_idx];
538 memset(new_node, 0x00, sizeof(struct trie_node));
539 new_node->value_off = off;
540 new_node->value_len = len;
543 /* join the parent's child list */
544 parent = &rules->trie_nodes[node_idx];
545 if (parent->child_idx == 0) {
546 parent->child_idx = new_node_idx;
548 struct trie_node *last_child;
550 last_child = &rules->trie_nodes[parent->last_child_idx];
551 last_child->next_child_idx = new_node_idx;
553 parent->last_child_idx = new_node_idx;
557 static int add_token(struct udev_rules *rules, struct token *token)
559 /* grow buffer if needed */
560 if (rules->token_cur+1 >= rules->token_max) {
561 struct token *tokens;
564 /* double the buffer size */
565 add = rules->token_max;
569 tokens = realloc(rules->tokens, (rules->token_max + add ) * sizeof(struct token));
572 rules->tokens = tokens;
573 rules->token_max += add;
575 memcpy(&rules->tokens[rules->token_cur], token, sizeof(struct token));
580 static uid_t add_uid(struct udev_rules *rules, const char *owner)
586 /* lookup, if we know it already */
587 for (i = 0; i < rules->uids_cur; i++) {
588 off = rules->uids[i].name_off;
589 if (strcmp(&rules->buf[off], owner) == 0) {
590 uid = rules->uids[i].uid;
594 uid = util_lookup_user(rules->udev, owner);
596 /* grow buffer if needed */
597 if (rules->uids_cur+1 >= rules->uids_max) {
598 struct uid_gid *uids;
601 /* double the buffer size */
602 add = rules->uids_max;
606 uids = realloc(rules->uids, (rules->uids_max + add ) * sizeof(struct uid_gid));
610 rules->uids_max += add;
612 rules->uids[rules->uids_cur].uid = uid;
613 off = add_string(rules, owner);
616 rules->uids[rules->uids_cur].name_off = off;
621 static gid_t add_gid(struct udev_rules *rules, const char *group)
627 /* lookup, if we know it already */
628 for (i = 0; i < rules->gids_cur; i++) {
629 off = rules->gids[i].name_off;
630 if (strcmp(&rules->buf[off], group) == 0) {
631 gid = rules->gids[i].gid;
635 gid = util_lookup_group(rules->udev, group);
637 /* grow buffer if needed */
638 if (rules->gids_cur+1 >= rules->gids_max) {
639 struct uid_gid *gids;
642 /* double the buffer size */
643 add = rules->gids_max;
647 gids = realloc(rules->gids, (rules->gids_max + add ) * sizeof(struct uid_gid));
651 rules->gids_max += add;
653 rules->gids[rules->gids_cur].gid = gid;
654 off = add_string(rules, group);
657 rules->gids[rules->gids_cur].name_off = off;
662 static int import_property_from_string(struct udev_device *dev, char *line)
664 struct udev *udev = udev_device_get_udev(dev);
671 while (isspace(key[0]))
674 /* comment or empty line */
675 if (key[0] == '#' || key[0] == '\0')
678 /* split key/value */
679 val = strchr(key, '=');
686 while (isspace(val[0]))
693 while (isspace(key[len-1]))
697 /* terminate value */
701 while (isspace(val[len-1]))
709 if (val[0] == '"' || val[0] == '\'') {
710 if (val[len-1] != val[0]) {
711 log_debug("inconsistent quoting: '%s', skip\n", line);
718 /* handle device, renamed by external tool, returning new path */
719 if (strcmp(key, "DEVPATH") == 0) {
720 char syspath[UTIL_PATH_SIZE];
722 log_debug("updating devpath from '%s' to '%s'\n",
723 udev_device_get_devpath(dev), val);
724 util_strscpyl(syspath, sizeof(syspath), udev_get_sys_path(udev), val, NULL);
725 udev_device_set_syspath(dev, syspath);
727 struct udev_list_entry *entry;
729 entry = udev_device_add_property(dev, key, val);
730 /* store in db, skip private keys */
732 udev_list_entry_set_num(entry, true);
737 static int import_file_into_properties(struct udev_device *dev, const char *filename)
740 char line[UTIL_LINE_SIZE];
742 f = fopen(filename, "r");
745 while (fgets(line, sizeof(line), f) != NULL)
746 import_property_from_string(dev, line);
751 static int import_program_into_properties(struct udev_event *event, const char *program, const sigset_t *sigmask)
753 struct udev_device *dev = event->dev;
755 char result[UTIL_LINE_SIZE];
759 envp = udev_device_get_properties_envp(dev);
760 err = udev_event_spawn(event, program, envp, sigmask, result, sizeof(result));
765 while (line != NULL) {
768 pos = strchr(line, '\n');
773 import_property_from_string(dev, line);
779 static int import_parent_into_properties(struct udev_device *dev, const char *filter)
781 struct udev *udev = udev_device_get_udev(dev);
782 struct udev_device *dev_parent;
783 struct udev_list_entry *list_entry;
785 dev_parent = udev_device_get_parent(dev);
786 if (dev_parent == NULL)
789 udev_list_entry_foreach(list_entry, udev_device_get_properties_list_entry(dev_parent)) {
790 const char *key = udev_list_entry_get_name(list_entry);
791 const char *val = udev_list_entry_get_value(list_entry);
793 if (fnmatch(filter, key, 0) == 0) {
794 struct udev_list_entry *entry;
796 entry = udev_device_add_property(dev, key, val);
797 /* store in db, skip private keys */
799 udev_list_entry_set_num(entry, true);
805 #define WAIT_LOOP_PER_SECOND 50
806 static int wait_for_file(struct udev_device *dev, const char *file, int timeout)
808 struct udev *udev = udev_device_get_udev(dev);
809 char filepath[UTIL_PATH_SIZE];
810 char devicepath[UTIL_PATH_SIZE];
812 int loop = timeout * WAIT_LOOP_PER_SECOND;
814 /* a relative path is a device attribute */
815 devicepath[0] = '\0';
816 if (file[0] != '/') {
817 util_strscpyl(devicepath, sizeof(devicepath),
818 udev_get_sys_path(udev), udev_device_get_devpath(dev), NULL);
819 util_strscpyl(filepath, sizeof(filepath), devicepath, "/", file, NULL);
824 const struct timespec duration = { 0, 1000 * 1000 * 1000 / WAIT_LOOP_PER_SECOND };
827 if (stat(file, &stats) == 0) {
828 log_debug("file '%s' appeared after %i loops\n", file, (timeout * WAIT_LOOP_PER_SECOND) - loop-1);
831 /* make sure, the device did not disappear in the meantime */
832 if (devicepath[0] != '\0' && stat(devicepath, &stats) != 0) {
833 log_debug("device disappeared while waiting for '%s'\n", file);
836 log_debug("wait for '%s' for %i mseconds\n", file, 1000 / WAIT_LOOP_PER_SECOND);
837 nanosleep(&duration, NULL);
839 log_debug("waiting for '%s' failed\n", file);
843 static int attr_subst_subdir(char *attr, size_t len)
847 if (strstr(attr, "/*/")) {
849 char dirname[UTIL_PATH_SIZE];
853 util_strscpy(dirname, sizeof(dirname), attr);
854 pos = strstr(dirname, "/*/");
859 dir = opendir(dirname);
863 for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
866 if (dent->d_name[0] == '.')
868 util_strscpyl(attr, len, dirname, "/", dent->d_name, tail, NULL);
869 if (stat(attr, &stats) == 0) {
881 static int get_key(struct udev *udev, char **line, char **key, enum operation_type *op, char **value)
887 if (linepos == NULL || linepos[0] == '\0')
890 /* skip whitespace */
891 while (isspace(linepos[0]) || linepos[0] == ',')
895 if (linepos[0] == '\0')
901 if (linepos[0] == '\0')
903 if (isspace(linepos[0]))
905 if (linepos[0] == '=')
907 if ((linepos[0] == '+') || (linepos[0] == '!') || (linepos[0] == ':'))
908 if (linepos[1] == '=')
912 /* remember end of key */
915 /* skip whitespace after key */
916 while (isspace(linepos[0]))
918 if (linepos[0] == '\0')
921 /* get operation type */
922 if (linepos[0] == '=' && linepos[1] == '=') {
925 } else if (linepos[0] == '!' && linepos[1] == '=') {
928 } else if (linepos[0] == '+' && linepos[1] == '=') {
931 } else if (linepos[0] == '=') {
934 } else if (linepos[0] == ':' && linepos[1] == '=') {
935 *op = OP_ASSIGN_FINAL;
943 /* skip whitespace after operator */
944 while (isspace(linepos[0]))
946 if (linepos[0] == '\0')
950 if (linepos[0] == '"')
957 temp = strchr(linepos, '"');
963 /* move line to next key */
968 /* extract possible KEY{attr} */
969 static char *get_key_attribute(struct udev *udev, char *str)
974 attr = strchr(str, '{');
977 pos = strchr(attr, '}');
979 log_error("missing closing brace for format\n");
988 static int rule_add_key(struct rule_tmp *rule_tmp, enum token_type type,
989 enum operation_type op,
990 const char *value, const void *data)
992 struct token *token = &rule_tmp->token[rule_tmp->token_cur];
993 const char *attr = NULL;
995 memset(token, 0x00, sizeof(struct token));
1001 case TK_M_SUBSYSTEM:
1007 case TK_M_SUBSYSTEMS:
1011 case TK_M_IMPORT_FILE:
1012 case TK_M_IMPORT_PROG:
1013 case TK_M_IMPORT_DB:
1014 case TK_M_IMPORT_CMDLINE:
1015 case TK_M_IMPORT_PARENT:
1024 token->key.value_off = add_string(rule_tmp->rules, value);
1026 case TK_M_IMPORT_BUILTIN:
1027 token->key.value_off = add_string(rule_tmp->rules, value);
1028 token->key.builtin_cmd = *(enum udev_builtin_cmd *)data;
1036 token->key.value_off = add_string(rule_tmp->rules, value);
1037 token->key.attr_off = add_string(rule_tmp->rules, attr);
1040 token->key.value_off = add_string(rule_tmp->rules, value);
1041 token->key.devlink_unique = *(int *)data;
1044 token->key.value_off = add_string(rule_tmp->rules, value);
1046 token->key.mode = *(mode_t *)data;
1048 case TK_A_STRING_ESCAPE_NONE:
1049 case TK_A_STRING_ESCAPE_REPLACE:
1050 case TK_A_DB_PERSIST:
1053 token->key.value_off = add_string(rule_tmp->rules, value);
1055 case TK_A_INOTIFY_WATCH:
1056 case TK_A_DEVLINK_PRIO:
1057 token->key.devlink_prio = *(int *)data;
1060 token->key.uid = *(uid_t *)data;
1063 token->key.gid = *(gid_t *)data;
1066 token->key.mode = *(mode_t *)data;
1068 case TK_A_STATIC_NODE:
1069 token->key.value_off = add_string(rule_tmp->rules, value);
1071 case TK_M_EVENT_TIMEOUT:
1072 token->key.event_timeout = *(int *)data;
1075 case TK_M_PARENTS_MIN:
1076 case TK_M_PARENTS_MAX:
1080 log_error("wrong type %u\n", type);
1084 if (value != NULL && type < TK_M_MAX) {
1085 /* check if we need to split or call fnmatch() while matching rules */
1086 enum string_glob_type glob;
1090 has_split = (strchr(value, '|') != NULL);
1091 has_glob = (strchr(value, '*') != NULL || strchr(value, '?') != NULL || strchr(value, '[') != NULL);
1092 if (has_split && has_glob) {
1093 glob = GL_SPLIT_GLOB;
1094 } else if (has_split) {
1096 } else if (has_glob) {
1097 if (strcmp(value, "?*") == 0)
1098 glob = GL_SOMETHING;
1104 token->key.glob = glob;
1107 if (value != NULL && type > TK_M_MAX) {
1108 /* check if assigned value has substitution chars */
1109 if (value[0] == '[')
1110 token->key.subst = SB_SUBSYS;
1111 else if (strchr(value, '%') != NULL || strchr(value, '$') != NULL)
1112 token->key.subst = SB_FORMAT;
1114 token->key.subst = SB_NONE;
1118 /* check if property/attribut name has substitution chars */
1120 token->key.attrsubst = SB_SUBSYS;
1121 else if (strchr(attr, '%') != NULL || strchr(attr, '$') != NULL)
1122 token->key.attrsubst = SB_FORMAT;
1124 token->key.attrsubst = SB_NONE;
1127 token->key.type = type;
1129 rule_tmp->token_cur++;
1130 if (rule_tmp->token_cur >= ARRAY_SIZE(rule_tmp->token)) {
1131 log_error("temporary rule array too small\n");
1137 static int sort_token(struct udev_rules *rules, struct rule_tmp *rule_tmp)
1140 unsigned int start = 0;
1141 unsigned int end = rule_tmp->token_cur;
1143 for (i = 0; i < rule_tmp->token_cur; i++) {
1144 enum token_type next_val = TK_UNSET;
1145 unsigned int next_idx = 0;
1148 /* find smallest value */
1149 for (j = start; j < end; j++) {
1150 if (rule_tmp->token[j].type == TK_UNSET)
1152 if (next_val == TK_UNSET || rule_tmp->token[j].type < next_val) {
1153 next_val = rule_tmp->token[j].type;
1158 /* add token and mark done */
1159 if (add_token(rules, &rule_tmp->token[next_idx]) != 0)
1161 rule_tmp->token[next_idx].type = TK_UNSET;
1164 if (next_idx == start)
1166 if (next_idx+1 == end)
1172 static int add_rule(struct udev_rules *rules, char *line,
1173 const char *filename, unsigned int filename_off, unsigned int lineno)
1177 struct rule_tmp rule_tmp;
1179 memset(&rule_tmp, 0x00, sizeof(struct rule_tmp));
1180 rule_tmp.rules = rules;
1181 rule_tmp.rule.type = TK_RULE;
1182 rule_tmp.rule.rule.filename_off = filename_off;
1183 rule_tmp.rule.rule.filename_line = lineno;
1189 enum operation_type op;
1191 if (get_key(rules->udev, &linepos, &key, &op, &value) != 0)
1194 if (strcmp(key, "ACTION") == 0) {
1195 if (op > OP_MATCH_MAX) {
1196 log_error("invalid ACTION operation\n");
1199 rule_add_key(&rule_tmp, TK_M_ACTION, op, value, NULL);
1203 if (strcmp(key, "DEVPATH") == 0) {
1204 if (op > OP_MATCH_MAX) {
1205 log_error("invalid DEVPATH operation\n");
1208 rule_add_key(&rule_tmp, TK_M_DEVPATH, op, value, NULL);
1212 if (strcmp(key, "KERNEL") == 0) {
1213 if (op > OP_MATCH_MAX) {
1214 log_error("invalid KERNEL operation\n");
1217 rule_add_key(&rule_tmp, TK_M_KERNEL, op, value, NULL);
1221 if (strcmp(key, "SUBSYSTEM") == 0) {
1222 if (op > OP_MATCH_MAX) {
1223 log_error("invalid SUBSYSTEM operation\n");
1226 /* bus, class, subsystem events should all be the same */
1227 if (strcmp(value, "subsystem") == 0 ||
1228 strcmp(value, "bus") == 0 ||
1229 strcmp(value, "class") == 0) {
1230 if (strcmp(value, "bus") == 0 || strcmp(value, "class") == 0)
1231 log_error("'%s' must be specified as 'subsystem' \n"
1232 "please fix it in %s:%u", value, filename, lineno);
1233 rule_add_key(&rule_tmp, TK_M_SUBSYSTEM, op, "subsystem|class|bus", NULL);
1235 rule_add_key(&rule_tmp, TK_M_SUBSYSTEM, op, value, NULL);
1239 if (strcmp(key, "DRIVER") == 0) {
1240 if (op > OP_MATCH_MAX) {
1241 log_error("invalid DRIVER operation\n");
1244 rule_add_key(&rule_tmp, TK_M_DRIVER, op, value, NULL);
1248 if (strncmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
1249 attr = get_key_attribute(rules->udev, key + sizeof("ATTR")-1);
1251 log_error("error parsing ATTR attribute\n");
1254 if (op < OP_MATCH_MAX) {
1255 rule_add_key(&rule_tmp, TK_M_ATTR, op, value, attr);
1257 rule_add_key(&rule_tmp, TK_A_ATTR, op, value, attr);
1262 if (strcmp(key, "KERNELS") == 0) {
1263 if (op > OP_MATCH_MAX) {
1264 log_error("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 log_error("invalid SUBSYSTEMS operation\n");
1276 rule_add_key(&rule_tmp, TK_M_SUBSYSTEMS, op, value, NULL);
1280 if (strcmp(key, "DRIVERS") == 0) {
1281 if (op > OP_MATCH_MAX) {
1282 log_error("invalid DRIVERS operation\n");
1285 rule_add_key(&rule_tmp, TK_M_DRIVERS, op, value, NULL);
1289 if (strncmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0) {
1290 if (op > OP_MATCH_MAX) {
1291 log_error("invalid ATTRS operation\n");
1294 attr = get_key_attribute(rules->udev, key + sizeof("ATTRS")-1);
1296 log_error("error parsing ATTRS attribute\n");
1299 if (strncmp(attr, "device/", 7) == 0)
1300 log_error("the 'device' link may not be available in a future kernel, "
1301 "please fix it in %s:%u", filename, lineno);
1302 else if (strstr(attr, "../") != NULL)
1303 log_error("do not reference parent sysfs directories directly, "
1304 "it may break with a future kernel, please fix it in %s:%u", filename, lineno);
1305 rule_add_key(&rule_tmp, TK_M_ATTRS, op, value, attr);
1309 if (strcmp(key, "TAGS") == 0) {
1310 if (op > OP_MATCH_MAX) {
1311 log_error("invalid TAGS operation\n");
1314 rule_add_key(&rule_tmp, TK_M_TAGS, op, value, NULL);
1318 if (strncmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
1319 attr = get_key_attribute(rules->udev, key + sizeof("ENV")-1);
1321 log_error("error parsing ENV attribute\n");
1324 if (op < OP_MATCH_MAX) {
1325 if (rule_add_key(&rule_tmp, TK_M_ENV, op, value, attr) != 0)
1328 static const char *blacklist[] = {
1343 for (i = 0; i < ARRAY_SIZE(blacklist); i++)
1344 if (strcmp(attr, blacklist[i]) == 0) {
1345 log_error("invalid ENV attribute, '%s' can not be set %s:%u\n", attr, filename, lineno);
1348 if (rule_add_key(&rule_tmp, TK_A_ENV, op, value, attr) != 0)
1354 if (strcmp(key, "TAG") == 0) {
1355 if (op < OP_MATCH_MAX)
1356 rule_add_key(&rule_tmp, TK_M_TAG, op, value, NULL);
1358 rule_add_key(&rule_tmp, TK_A_TAG, op, value, NULL);
1362 if (strcmp(key, "PROGRAM") == 0) {
1363 rule_add_key(&rule_tmp, TK_M_PROGRAM, op, value, NULL);
1367 if (strcmp(key, "RESULT") == 0) {
1368 if (op > OP_MATCH_MAX) {
1369 log_error("invalid RESULT operation\n");
1372 rule_add_key(&rule_tmp, TK_M_RESULT, op, value, NULL);
1376 if (strncmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
1377 attr = get_key_attribute(rules->udev, key + sizeof("IMPORT")-1);
1379 log_error("IMPORT{} type missing, ignoring IMPORT %s:%u\n", filename, lineno);
1382 if (strstr(attr, "program")) {
1383 /* find known built-in command */
1384 if (value[0] != '/') {
1385 enum udev_builtin_cmd cmd;
1387 cmd = udev_builtin_lookup(value);
1388 if (cmd < UDEV_BUILTIN_MAX) {
1389 log_debug("IMPORT found builtin '%s', replacing %s:%u\n",
1390 value, filename, lineno);
1391 rule_add_key(&rule_tmp, TK_M_IMPORT_BUILTIN, op, value, &cmd);
1395 rule_add_key(&rule_tmp, TK_M_IMPORT_PROG, op, value, NULL);
1396 } else if (strstr(attr, "builtin")) {
1397 enum udev_builtin_cmd cmd = udev_builtin_lookup(value);
1399 if (cmd < UDEV_BUILTIN_MAX)
1400 rule_add_key(&rule_tmp, TK_M_IMPORT_BUILTIN, op, value, &cmd);
1402 log_error("IMPORT{builtin}: '%s' unknown %s:%u\n", value, filename, lineno);
1403 } else if (strstr(attr, "file")) {
1404 rule_add_key(&rule_tmp, TK_M_IMPORT_FILE, op, value, NULL);
1405 } else if (strstr(attr, "db")) {
1406 rule_add_key(&rule_tmp, TK_M_IMPORT_DB, op, value, NULL);
1407 } else if (strstr(attr, "cmdline")) {
1408 rule_add_key(&rule_tmp, TK_M_IMPORT_CMDLINE, op, value, NULL);
1409 } else if (strstr(attr, "parent")) {
1410 rule_add_key(&rule_tmp, TK_M_IMPORT_PARENT, op, value, NULL);
1415 if (strncmp(key, "TEST", sizeof("TEST")-1) == 0) {
1418 if (op > OP_MATCH_MAX) {
1419 log_error("invalid TEST operation\n");
1422 attr = get_key_attribute(rules->udev, key + sizeof("TEST")-1);
1424 mode = strtol(attr, NULL, 8);
1425 rule_add_key(&rule_tmp, TK_M_TEST, op, value, &mode);
1427 rule_add_key(&rule_tmp, TK_M_TEST, op, value, NULL);
1432 if (strcmp(key, "RUN") == 0) {
1433 if (strncmp(value, "socket:", 7) == 0)
1434 log_error("RUN+=\"socket:...\" support will be removed from a future udev release. "
1435 "Please remove it from: %s:%u and use libudev to subscribe to events.\n", filename, lineno);
1436 rule_add_key(&rule_tmp, TK_A_RUN, op, value, NULL);
1440 if (strcmp(key, "WAIT_FOR") == 0 || strcmp(key, "WAIT_FOR_SYSFS") == 0) {
1441 rule_add_key(&rule_tmp, TK_M_WAITFOR, 0, value, NULL);
1445 if (strcmp(key, "LABEL") == 0) {
1446 rule_tmp.rule.rule.label_off = add_string(rules, value);
1450 if (strcmp(key, "GOTO") == 0) {
1451 rule_add_key(&rule_tmp, TK_A_GOTO, 0, value, NULL);
1455 if (strncmp(key, "NAME", sizeof("NAME")-1) == 0) {
1456 if (op < OP_MATCH_MAX) {
1457 rule_add_key(&rule_tmp, TK_M_NAME, op, value, NULL);
1459 if (strcmp(value, "%k") == 0) {
1460 log_error("NAME=\"%%k\" is ignored, because it breaks kernel supplied names, "
1461 "please remove it from %s:%u\n", filename, lineno);
1464 if (value[0] == '\0') {
1465 log_debug("NAME=\"\" is ignored, because udev will not delete any device nodes, "
1466 "please remove it from %s:%u\n", filename, lineno);
1469 rule_add_key(&rule_tmp, TK_A_NAME, op, value, NULL);
1471 rule_tmp.rule.rule.can_set_name = true;
1475 if (strncmp(key, "SYMLINK", sizeof("SYMLINK")-1) == 0) {
1476 if (op < OP_MATCH_MAX) {
1477 rule_add_key(&rule_tmp, TK_M_DEVLINK, op, value, NULL);
1481 attr = get_key_attribute(rules->udev, key + sizeof("SYMLINK")-1);
1482 if (attr != NULL && strstr(attr, "unique") != NULL)
1484 rule_add_key(&rule_tmp, TK_A_DEVLINK, op, value, &flag);
1486 rule_tmp.rule.rule.can_set_name = true;
1490 if (strcmp(key, "OWNER") == 0) {
1494 uid = strtoul(value, &endptr, 10);
1495 if (endptr[0] == '\0') {
1496 rule_add_key(&rule_tmp, TK_A_OWNER_ID, op, NULL, &uid);
1497 } else if ((rules->resolve_names > 0) && strchr("$%", value[0]) == NULL) {
1498 uid = add_uid(rules, value);
1499 rule_add_key(&rule_tmp, TK_A_OWNER_ID, op, NULL, &uid);
1500 } else if (rules->resolve_names >= 0) {
1501 rule_add_key(&rule_tmp, TK_A_OWNER, op, value, NULL);
1503 rule_tmp.rule.rule.can_set_name = true;
1507 if (strcmp(key, "GROUP") == 0) {
1511 gid = strtoul(value, &endptr, 10);
1512 if (endptr[0] == '\0') {
1513 rule_add_key(&rule_tmp, TK_A_GROUP_ID, op, NULL, &gid);
1514 } else if ((rules->resolve_names > 0) && strchr("$%", value[0]) == NULL) {
1515 gid = add_gid(rules, value);
1516 rule_add_key(&rule_tmp, TK_A_GROUP_ID, op, NULL, &gid);
1517 } else if (rules->resolve_names >= 0) {
1518 rule_add_key(&rule_tmp, TK_A_GROUP, op, value, NULL);
1520 rule_tmp.rule.rule.can_set_name = true;
1524 if (strcmp(key, "MODE") == 0) {
1528 mode = strtol(value, &endptr, 8);
1529 if (endptr[0] == '\0')
1530 rule_add_key(&rule_tmp, TK_A_MODE_ID, op, NULL, &mode);
1532 rule_add_key(&rule_tmp, TK_A_MODE, op, value, NULL);
1533 rule_tmp.rule.rule.can_set_name = true;
1537 if (strcmp(key, "OPTIONS") == 0) {
1540 pos = strstr(value, "link_priority=");
1542 int prio = atoi(&pos[strlen("link_priority=")]);
1544 rule_add_key(&rule_tmp, TK_A_DEVLINK_PRIO, op, NULL, &prio);
1547 pos = strstr(value, "event_timeout=");
1549 int tout = atoi(&pos[strlen("event_timeout=")]);
1551 rule_add_key(&rule_tmp, TK_M_EVENT_TIMEOUT, op, NULL, &tout);
1554 pos = strstr(value, "string_escape=");
1556 pos = &pos[strlen("string_escape=")];
1557 if (strncmp(pos, "none", strlen("none")) == 0)
1558 rule_add_key(&rule_tmp, TK_A_STRING_ESCAPE_NONE, op, NULL, NULL);
1559 else if (strncmp(pos, "replace", strlen("replace")) == 0)
1560 rule_add_key(&rule_tmp, TK_A_STRING_ESCAPE_REPLACE, op, NULL, NULL);
1563 pos = strstr(value, "db_persist");
1565 rule_add_key(&rule_tmp, TK_A_DB_PERSIST, op, NULL, NULL);
1567 pos = strstr(value, "nowatch");
1571 rule_add_key(&rule_tmp, TK_A_INOTIFY_WATCH, op, NULL, &off);
1573 pos = strstr(value, "watch");
1577 rule_add_key(&rule_tmp, TK_A_INOTIFY_WATCH, op, NULL, &on);
1581 pos = strstr(value, "static_node=");
1583 rule_add_key(&rule_tmp, TK_A_STATIC_NODE, op, &pos[strlen("static_node=")], NULL);
1584 rule_tmp.rule.rule.has_static_node = true;
1590 log_error("unknown key '%s' in %s:%u\n", key, filename, lineno);
1594 /* add rule token */
1595 rule_tmp.rule.rule.token_count = 1 + rule_tmp.token_cur;
1596 if (add_token(rules, &rule_tmp.rule) != 0)
1599 /* add tokens to list, sorted by type */
1600 if (sort_token(rules, &rule_tmp) != 0)
1605 log_error("invalid rule '%s:%u'\n", filename, lineno);
1609 static int parse_file(struct udev_rules *rules, const char *filename, unsigned short filename_off)
1612 unsigned int first_token;
1613 char line[UTIL_LINE_SIZE];
1617 log_debug("reading '%s' as rules file\n", filename);
1619 f = fopen(filename, "r");
1623 first_token = rules->token_cur;
1625 while (fgets(line, sizeof(line), f) != NULL) {
1629 /* skip whitespace */
1632 while (isspace(key[0]))
1643 /* continue reading if backslash+newline is found */
1644 while (line[len-2] == '\\') {
1645 if (fgets(&line[len-2], (sizeof(line)-len)+2, f) == NULL)
1647 if (strlen(&line[len-2]) < 2)
1653 if (len+1 >= sizeof(line)) {
1654 log_error("line too long '%s':%u, ignored\n", filename, line_nr);
1657 add_rule(rules, key, filename, filename_off, line_nr);
1661 /* link GOTOs to LABEL rules in this file to be able to fast-forward */
1662 for (i = first_token+1; i < rules->token_cur; i++) {
1663 if (rules->tokens[i].type == TK_A_GOTO) {
1664 char *label = &rules->buf[rules->tokens[i].key.value_off];
1667 for (j = i+1; j < rules->token_cur; j++) {
1668 if (rules->tokens[j].type != TK_RULE)
1670 if (rules->tokens[j].rule.label_off == 0)
1672 if (strcmp(label, &rules->buf[rules->tokens[j].rule.label_off]) != 0)
1674 rules->tokens[i].key.rule_goto = j;
1677 if (rules->tokens[i].key.rule_goto == 0)
1678 log_error("GOTO '%s' has no matching label in: '%s'\n", label, filename);
1684 static int add_matching_files(struct udev *udev, struct udev_list *file_list, const char *dirname, const char *suffix)
1687 struct dirent *dent;
1688 char filename[UTIL_PATH_SIZE];
1690 dir = opendir(dirname);
1692 log_debug("unable to open '%s': %m\n", dirname);
1696 for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
1697 if (dent->d_name[0] == '.')
1700 /* look for file matching with specified suffix */
1701 if (suffix != NULL) {
1704 ext = strrchr(dent->d_name, '.');
1707 if (strcmp(ext, suffix) != 0)
1710 util_strscpyl(filename, sizeof(filename), dirname, "/", dent->d_name, NULL);
1712 * the basename is the key, the filename the value
1713 * identical basenames from different directories override each other
1714 * entries are sorted after basename
1716 udev_list_entry_add(file_list, dent->d_name, filename);
1723 struct udev_rules *udev_rules_new(struct udev *udev, int resolve_names)
1725 struct udev_rules *rules;
1726 struct udev_list file_list;
1727 struct udev_list_entry *file_loop;
1728 struct token end_token;
1731 rules = calloc(1, sizeof(struct udev_rules));
1735 rules->resolve_names = resolve_names;
1736 udev_list_init(udev, &file_list, true);
1738 /* init token array and string buffer */
1739 rules->tokens = malloc(PREALLOC_TOKEN * sizeof(struct token));
1740 if (rules->tokens == NULL) {
1744 rules->token_max = PREALLOC_TOKEN;
1746 rules->buf = malloc(PREALLOC_STRBUF);
1747 if (rules->buf == NULL) {
1748 free(rules->tokens);
1752 rules->buf_max = PREALLOC_STRBUF;
1753 /* offset 0 is always '\0' */
1754 rules->buf[0] = '\0';
1757 rules->trie_nodes = malloc(PREALLOC_TRIE * sizeof(struct trie_node));
1758 if (rules->trie_nodes == NULL) {
1760 free(rules->tokens);
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 for (udev_get_rules_path(udev, &s, NULL); *s != NULL; s++)
1770 add_matching_files(udev, &file_list, *s, ".rules");
1772 /* add all filenames to the string buffer */
1773 udev_list_entry_foreach(file_loop, udev_list_get_entry(&file_list)) {
1774 const char *filename = udev_list_entry_get_value(file_loop);
1775 unsigned int filename_off;
1777 filename_off = add_string(rules, filename);
1778 /* the offset in the rule is limited to unsigned short */
1779 if (filename_off < USHRT_MAX)
1780 udev_list_entry_set_num(file_loop, filename_off);
1783 /* parse all rules files */
1784 udev_list_entry_foreach(file_loop, udev_list_get_entry(&file_list)) {
1785 const char *filename = udev_list_entry_get_value(file_loop);
1786 unsigned int filename_off = udev_list_entry_get_num(file_loop);
1789 if (stat(filename, &st) != 0) {
1790 log_error("can not find '%s': %m\n", filename);
1793 if (S_ISREG(st.st_mode) && st.st_size <= 0) {
1794 log_debug("ignore empty '%s'\n", filename);
1797 if (S_ISCHR(st.st_mode)) {
1798 log_debug("ignore masked '%s'\n", filename);
1801 parse_file(rules, filename, filename_off);
1803 udev_list_cleanup(&file_list);
1805 memset(&end_token, 0x00, sizeof(struct token));
1806 end_token.type = TK_END;
1807 add_token(rules, &end_token);
1809 /* shrink allocated token and string buffer */
1810 if (rules->token_cur < rules->token_max) {
1811 struct token *tokens;
1813 tokens = realloc(rules->tokens, rules->token_cur * sizeof(struct token));
1814 if (tokens != NULL || rules->token_cur == 0) {
1815 rules->tokens = tokens;
1816 rules->token_max = rules->token_cur;
1819 if (rules->buf_cur < rules->buf_max) {
1822 buf = realloc(rules->buf, rules->buf_cur);
1823 if (buf != NULL || rules->buf_cur == 0) {
1825 rules->buf_max = rules->buf_cur;
1828 log_debug("rules use %zu bytes tokens (%u * %zu bytes), %zu bytes buffer\n",
1829 rules->token_max * sizeof(struct token), rules->token_max, sizeof(struct token), rules->buf_max);
1830 log_debug("temporary index used %zu bytes (%u * %zu bytes)\n",
1831 rules->trie_nodes_cur * sizeof(struct trie_node),
1832 rules->trie_nodes_cur, sizeof(struct trie_node));
1835 free(rules->trie_nodes);
1836 rules->trie_nodes = NULL;
1837 rules->trie_nodes_cur = 0;
1838 rules->trie_nodes_max = 0;
1840 /* cleanup uid/gid cache */
1843 rules->uids_cur = 0;
1844 rules->uids_max = 0;
1847 rules->gids_cur = 0;
1848 rules->gids_max = 0;
1854 struct udev_rules *udev_rules_unref(struct udev_rules *rules)
1858 free(rules->tokens);
1860 free(rules->trie_nodes);
1867 static int match_key(struct udev_rules *rules, struct token *token, const char *val)
1869 char *key_value = &rules->buf[token->key.value_off];
1876 switch (token->key.glob) {
1878 match = (strcmp(key_value, val) == 0);
1881 match = (fnmatch(key_value, val, 0) == 0);
1888 split = &rules->buf[token->key.value_off];
1893 next = strchr(split, '|');
1895 size_t matchlen = (size_t)(next - split);
1897 match = (matchlen == len && strncmp(split, val, matchlen) == 0);
1901 match = (strcmp(split, val) == 0);
1910 char value[UTIL_PATH_SIZE];
1912 util_strscpy(value, sizeof(value), &rules->buf[token->key.value_off]);
1914 while (key_value != NULL) {
1915 pos = strchr(key_value, '|');
1920 match = (fnmatch(key_value, val, 0) == 0);
1928 match = (val[0] != '\0');
1934 if (match && (token->key.op == OP_MATCH))
1936 if (!match && (token->key.op == OP_NOMATCH))
1941 static int match_attr(struct udev_rules *rules, struct udev_device *dev, struct udev_event *event, struct token *cur)
1944 char nbuf[UTIL_NAME_SIZE];
1946 char vbuf[UTIL_NAME_SIZE];
1949 name = &rules->buf[cur->key.attr_off];
1950 switch (cur->key.attrsubst) {
1952 udev_event_apply_format(event, name, nbuf, sizeof(nbuf));
1956 value = udev_device_get_sysattr_value(dev, name);
1961 if (util_resolve_subsys_kernel(event->udev, name, vbuf, sizeof(vbuf), 1) != 0)
1969 /* remove trailing whitespace, if not asked to match for it */
1970 len = strlen(value);
1971 if (len > 0 && isspace(value[len-1])) {
1972 const char *key_value;
1975 key_value = &rules->buf[cur->key.value_off];
1976 klen = strlen(key_value);
1977 if (klen > 0 && !isspace(key_value[klen-1])) {
1978 if (value != vbuf) {
1979 util_strscpy(vbuf, sizeof(vbuf), value);
1982 while (len > 0 && isspace(vbuf[--len]))
1987 return match_key(rules, cur, value);
1996 int udev_rules_apply_to_event(struct udev_rules *rules, struct udev_event *event, const sigset_t *sigmask)
2000 enum escape_type esc = ESCAPE_UNSET;
2003 if (rules->tokens == NULL)
2006 can_set_name = ((strcmp(udev_device_get_action(event->dev), "remove") != 0) &&
2007 (major(udev_device_get_devnum(event->dev)) > 0 ||
2008 udev_device_get_ifindex(event->dev) > 0));
2010 /* loop through token list, match, run actions or forward to next rule */
2011 cur = &rules->tokens[0];
2014 dump_token(rules, cur);
2015 switch (cur->type) {
2019 /* possibly skip rules which want to set NAME, SYMLINK, OWNER, GROUP, MODE */
2020 if (!can_set_name && rule->rule.can_set_name)
2025 if (match_key(rules, cur, udev_device_get_action(event->dev)) != 0)
2029 if (match_key(rules, cur, udev_device_get_devpath(event->dev)) != 0)
2033 if (match_key(rules, cur, udev_device_get_sysname(event->dev)) != 0)
2036 case TK_M_DEVLINK: {
2037 size_t devlen = strlen(udev_get_dev_path(event->udev))+1;
2038 struct udev_list_entry *list_entry;
2041 udev_list_entry_foreach(list_entry, udev_device_get_devlinks_list_entry(event->dev)) {
2042 const char *devlink;
2044 devlink = &udev_list_entry_get_name(list_entry)[devlen];
2045 if (match_key(rules, cur, devlink) == 0) {
2055 if (match_key(rules, cur, event->name) != 0)
2059 const char *key_name = &rules->buf[cur->key.attr_off];
2062 value = udev_device_get_property_value(event->dev, key_name);
2065 if (match_key(rules, cur, value))
2070 struct udev_list_entry *list_entry;
2073 udev_list_entry_foreach(list_entry, udev_device_get_tags_list_entry(event->dev)) {
2074 if (strcmp(&rules->buf[cur->key.value_off], udev_list_entry_get_name(list_entry)) == 0) {
2079 if (!match && (cur->key.op != OP_NOMATCH))
2083 case TK_M_SUBSYSTEM:
2084 if (match_key(rules, cur, udev_device_get_subsystem(event->dev)) != 0)
2088 if (match_key(rules, cur, udev_device_get_driver(event->dev)) != 0)
2091 case TK_M_WAITFOR: {
2092 char filename[UTIL_PATH_SIZE];
2095 udev_event_apply_format(event, &rules->buf[cur->key.value_off], filename, sizeof(filename));
2096 found = (wait_for_file(event->dev, filename, 10) == 0);
2097 if (!found && (cur->key.op != OP_NOMATCH))
2102 if (match_attr(rules, event->dev, event, cur) != 0)
2106 case TK_M_SUBSYSTEMS:
2112 /* get whole sequence of parent matches */
2114 while (next->type > TK_M_PARENTS_MIN && next->type < TK_M_PARENTS_MAX)
2117 /* loop over parents */
2118 event->dev_parent = event->dev;
2122 /* loop over sequence of parent match keys */
2123 for (key = cur; key < next; key++ ) {
2124 dump_token(rules, key);
2127 if (match_key(rules, key, udev_device_get_sysname(event->dev_parent)) != 0)
2130 case TK_M_SUBSYSTEMS:
2131 if (match_key(rules, key, udev_device_get_subsystem(event->dev_parent)) != 0)
2135 if (match_key(rules, key, udev_device_get_driver(event->dev_parent)) != 0)
2139 if (match_attr(rules, event->dev_parent, event, key) != 0)
2143 bool match = udev_device_has_tag(event->dev_parent, &rules->buf[cur->key.value_off]);
2145 if (match && key->key.op == OP_NOMATCH)
2147 if (!match && key->key.op == OP_MATCH)
2158 event->dev_parent = udev_device_get_parent(event->dev_parent);
2159 if (event->dev_parent == NULL)
2162 /* move behind our sequence of parent match keys */
2167 char filename[UTIL_PATH_SIZE];
2168 struct stat statbuf;
2171 udev_event_apply_format(event, &rules->buf[cur->key.value_off], filename, sizeof(filename));
2172 if (util_resolve_subsys_kernel(event->udev, filename, filename, sizeof(filename), 0) != 0) {
2173 if (filename[0] != '/') {
2174 char tmp[UTIL_PATH_SIZE];
2176 util_strscpy(tmp, sizeof(tmp), filename);
2177 util_strscpyl(filename, sizeof(filename),
2178 udev_device_get_syspath(event->dev), "/", tmp, NULL);
2181 attr_subst_subdir(filename, sizeof(filename));
2183 match = (stat(filename, &statbuf) == 0);
2184 if (match && cur->key.mode > 0)
2185 match = ((statbuf.st_mode & cur->key.mode) > 0);
2186 if (match && cur->key.op == OP_NOMATCH)
2188 if (!match && cur->key.op == OP_MATCH)
2192 case TK_M_EVENT_TIMEOUT:
2193 log_debug("OPTIONS event_timeout=%u\n", cur->key.event_timeout);
2194 event->timeout_usec = cur->key.event_timeout * 1000 * 1000;
2196 case TK_M_PROGRAM: {
2197 char program[UTIL_PATH_SIZE];
2199 char result[UTIL_PATH_SIZE];
2201 free(event->program_result);
2202 event->program_result = NULL;
2203 udev_event_apply_format(event, &rules->buf[cur->key.value_off], program, sizeof(program));
2204 envp = udev_device_get_properties_envp(event->dev);
2205 log_debug("PROGRAM '%s' %s:%u\n",
2207 &rules->buf[rule->rule.filename_off],
2208 rule->rule.filename_line);
2210 if (udev_event_spawn(event, program, envp, sigmask, result, sizeof(result)) < 0) {
2211 if (cur->key.op != OP_NOMATCH)
2216 util_remove_trailing_chars(result, '\n');
2217 if (esc == ESCAPE_UNSET || esc == ESCAPE_REPLACE) {
2218 count = util_replace_chars(result, UDEV_ALLOWED_CHARS_INPUT);
2220 log_debug("%i character(s) replaced\n" , count);
2222 event->program_result = strdup(result);
2223 if (cur->key.op == OP_NOMATCH)
2228 case TK_M_IMPORT_FILE: {
2229 char import[UTIL_PATH_SIZE];
2231 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2232 if (import_file_into_properties(event->dev, import) != 0)
2233 if (cur->key.op != OP_NOMATCH)
2237 case TK_M_IMPORT_PROG: {
2238 char import[UTIL_PATH_SIZE];
2240 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2241 log_debug("IMPORT '%s' %s:%u\n",
2243 &rules->buf[rule->rule.filename_off],
2244 rule->rule.filename_line);
2246 if (import_program_into_properties(event, import, sigmask) != 0)
2247 if (cur->key.op != OP_NOMATCH)
2251 case TK_M_IMPORT_BUILTIN: {
2252 char command[UTIL_PATH_SIZE];
2254 if (udev_builtin_run_once(cur->key.builtin_cmd)) {
2255 /* check if we ran already */
2256 if (event->builtin_run & (1 << cur->key.builtin_cmd)) {
2257 log_debug("IMPORT builtin skip '%s' %s:%u\n",
2258 udev_builtin_name(cur->key.builtin_cmd),
2259 &rules->buf[rule->rule.filename_off],
2260 rule->rule.filename_line);
2261 /* return the result from earlier run */
2262 if (event->builtin_ret & (1 << cur->key.builtin_cmd))
2263 if (cur->key.op != OP_NOMATCH)
2268 event->builtin_run |= (1 << cur->key.builtin_cmd);
2271 udev_event_apply_format(event, &rules->buf[cur->key.value_off], command, sizeof(command));
2272 log_debug("IMPORT builtin '%s' %s:%u\n",
2273 udev_builtin_name(cur->key.builtin_cmd),
2274 &rules->buf[rule->rule.filename_off],
2275 rule->rule.filename_line);
2277 if (udev_builtin_run(event->dev, cur->key.builtin_cmd, command, false) != 0) {
2278 /* remember failure */
2279 log_debug("IMPORT builtin '%s' returned non-zero\n",
2280 udev_builtin_name(cur->key.builtin_cmd));
2281 event->builtin_ret |= (1 << cur->key.builtin_cmd);
2282 if (cur->key.op != OP_NOMATCH)
2287 case TK_M_IMPORT_DB: {
2288 const char *key = &rules->buf[cur->key.value_off];
2291 value = udev_device_get_property_value(event->dev_db, key);
2292 if (value != NULL) {
2293 struct udev_list_entry *entry;
2295 entry = udev_device_add_property(event->dev, key, value);
2296 udev_list_entry_set_num(entry, true);
2298 if (cur->key.op != OP_NOMATCH)
2303 case TK_M_IMPORT_CMDLINE: {
2305 bool imported = false;
2307 f = fopen("/proc/cmdline", "r");
2311 if (fgets(cmdline, sizeof(cmdline), f) != NULL) {
2312 const char *key = &rules->buf[cur->key.value_off];
2315 pos = strstr(cmdline, key);
2317 struct udev_list_entry *entry;
2320 if (pos[0] == '\0' || isspace(pos[0])) {
2321 /* we import simple flags as 'FLAG=1' */
2322 entry = udev_device_add_property(event->dev, key, "1");
2323 udev_list_entry_set_num(entry, true);
2325 } else if (pos[0] == '=') {
2330 while (pos[0] != '\0' && !isspace(pos[0]))
2333 entry = udev_device_add_property(event->dev, key, value);
2334 udev_list_entry_set_num(entry, true);
2341 if (!imported && cur->key.op != OP_NOMATCH)
2345 case TK_M_IMPORT_PARENT: {
2346 char import[UTIL_PATH_SIZE];
2348 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2349 if (import_parent_into_properties(event->dev, import) != 0)
2350 if (cur->key.op != OP_NOMATCH)
2355 if (match_key(rules, cur, event->program_result) != 0)
2358 case TK_A_STRING_ESCAPE_NONE:
2361 case TK_A_STRING_ESCAPE_REPLACE:
2362 esc = ESCAPE_REPLACE;
2364 case TK_A_DB_PERSIST:
2365 udev_device_set_db_persist(event->dev);
2367 case TK_A_INOTIFY_WATCH:
2368 if (event->inotify_watch_final)
2370 if (cur->key.op == OP_ASSIGN_FINAL)
2371 event->inotify_watch_final = true;
2372 event->inotify_watch = cur->key.watch;
2374 case TK_A_DEVLINK_PRIO:
2375 udev_device_set_devlink_priority(event->dev, cur->key.devlink_prio);
2378 char owner[UTIL_NAME_SIZE];
2380 if (event->owner_final)
2382 if (cur->key.op == OP_ASSIGN_FINAL)
2383 event->owner_final = true;
2384 udev_event_apply_format(event, &rules->buf[cur->key.value_off], owner, sizeof(owner));
2385 event->uid = util_lookup_user(event->udev, owner);
2386 log_debug("OWNER %u %s:%u\n",
2388 &rules->buf[rule->rule.filename_off],
2389 rule->rule.filename_line);
2393 char group[UTIL_NAME_SIZE];
2395 if (event->group_final)
2397 if (cur->key.op == OP_ASSIGN_FINAL)
2398 event->group_final = true;
2399 udev_event_apply_format(event, &rules->buf[cur->key.value_off], group, sizeof(group));
2400 event->gid = util_lookup_group(event->udev, group);
2401 log_debug("GROUP %u %s:%u\n",
2403 &rules->buf[rule->rule.filename_off],
2404 rule->rule.filename_line);
2408 char mode_str[UTIL_NAME_SIZE];
2412 if (event->mode_final)
2414 udev_event_apply_format(event, &rules->buf[cur->key.value_off], mode_str, sizeof(mode_str));
2415 mode = strtol(mode_str, &endptr, 8);
2416 if (endptr[0] != '\0') {
2417 log_error("ignoring invalid mode '%s'\n", mode_str);
2420 if (cur->key.op == OP_ASSIGN_FINAL)
2421 event->mode_final = true;
2422 event->mode_set = true;
2424 log_debug("MODE %#o %s:%u\n",
2426 &rules->buf[rule->rule.filename_off],
2427 rule->rule.filename_line);
2431 if (event->owner_final)
2433 if (cur->key.op == OP_ASSIGN_FINAL)
2434 event->owner_final = true;
2435 event->uid = cur->key.uid;
2436 log_debug("OWNER %u %s:%u\n",
2438 &rules->buf[rule->rule.filename_off],
2439 rule->rule.filename_line);
2442 if (event->group_final)
2444 if (cur->key.op == OP_ASSIGN_FINAL)
2445 event->group_final = true;
2446 event->gid = cur->key.gid;
2447 log_debug("GROUP %u %s:%u\n",
2449 &rules->buf[rule->rule.filename_off],
2450 rule->rule.filename_line);
2453 if (event->mode_final)
2455 if (cur->key.op == OP_ASSIGN_FINAL)
2456 event->mode_final = true;
2457 event->mode_set = true;
2458 event->mode = cur->key.mode;
2459 log_debug("MODE %#o %s:%u\n",
2461 &rules->buf[rule->rule.filename_off],
2462 rule->rule.filename_line);
2465 const char *name = &rules->buf[cur->key.attr_off];
2466 char *value = &rules->buf[cur->key.value_off];
2468 if (value[0] != '\0') {
2469 char temp_value[UTIL_NAME_SIZE];
2470 struct udev_list_entry *entry;
2472 udev_event_apply_format(event, value, temp_value, sizeof(temp_value));
2473 entry = udev_device_add_property(event->dev, name, temp_value);
2474 /* store in db, skip private keys */
2476 udev_list_entry_set_num(entry, true);
2478 udev_device_add_property(event->dev, name, NULL);
2483 char tag[UTIL_PATH_SIZE];
2486 udev_event_apply_format(event, &rules->buf[cur->key.value_off], tag, sizeof(tag));
2487 if (cur->key.op == OP_ASSIGN || cur->key.op == OP_ASSIGN_FINAL)
2488 udev_device_cleanup_tags_list(event->dev);
2489 for (p = tag; *p != '\0'; p++) {
2490 if ((*p >= 'a' && *p <= 'z') ||
2491 (*p >= 'A' && *p <= 'Z') ||
2492 (*p >= '0' && *p <= '9') ||
2493 *p == '-' || *p == '_')
2495 log_error("ignoring invalid tag name '%s'\n", tag);
2498 udev_device_add_tag(event->dev, tag);
2502 const char *name = &rules->buf[cur->key.value_off];
2504 char name_str[UTIL_PATH_SIZE];
2507 if (event->name_final)
2509 if (cur->key.op == OP_ASSIGN_FINAL)
2510 event->name_final = true;
2511 udev_event_apply_format(event, name, name_str, sizeof(name_str));
2512 if (esc == ESCAPE_UNSET || esc == ESCAPE_REPLACE) {
2513 count = util_replace_chars(name_str, "/");
2515 log_debug("%i character(s) replaced\n", count);
2517 if (major(udev_device_get_devnum(event->dev))) {
2518 size_t devlen = strlen(udev_get_dev_path(event->udev))+1;
2520 if (strcmp(name_str, &udev_device_get_devnode(event->dev)[devlen]) != 0) {
2521 log_error("NAME=\"%s\" ignored, kernel device nodes "
2522 "can not be renamed; please fix it in %s:%u\n", name,
2523 &rules->buf[rule->rule.filename_off], rule->rule.filename_line);
2528 event->name = strdup(name_str);
2529 log_debug("NAME '%s' %s:%u\n",
2531 &rules->buf[rule->rule.filename_off],
2532 rule->rule.filename_line);
2535 case TK_A_DEVLINK: {
2536 char temp[UTIL_PATH_SIZE];
2537 char filename[UTIL_PATH_SIZE];
2541 if (event->devlink_final)
2543 if (major(udev_device_get_devnum(event->dev)) == 0)
2545 if (cur->key.op == OP_ASSIGN_FINAL)
2546 event->devlink_final = true;
2547 if (cur->key.op == OP_ASSIGN || cur->key.op == OP_ASSIGN_FINAL)
2548 udev_device_cleanup_devlinks_list(event->dev);
2550 /* allow multiple symlinks separated by spaces */
2551 udev_event_apply_format(event, &rules->buf[cur->key.value_off], temp, sizeof(temp));
2552 if (esc == ESCAPE_UNSET)
2553 count = util_replace_chars(temp, "/ ");
2554 else if (esc == ESCAPE_REPLACE)
2555 count = util_replace_chars(temp, "/");
2557 log_debug("%i character(s) replaced\n" , count);
2559 while (isspace(pos[0]))
2561 next = strchr(pos, ' ');
2562 while (next != NULL) {
2564 log_debug("LINK '%s' %s:%u\n", pos,
2565 &rules->buf[rule->rule.filename_off], rule->rule.filename_line);
2566 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(event->udev), "/", pos, NULL);
2567 udev_device_add_devlink(event->dev, filename, cur->key.devlink_unique);
2568 while (isspace(next[1]))
2571 next = strchr(pos, ' ');
2573 if (pos[0] != '\0') {
2574 log_debug("LINK '%s' %s:%u\n", pos,
2575 &rules->buf[rule->rule.filename_off], rule->rule.filename_line);
2576 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(event->udev), "/", pos, NULL);
2577 udev_device_add_devlink(event->dev, filename, cur->key.devlink_unique);
2582 const char *key_name = &rules->buf[cur->key.attr_off];
2583 char attr[UTIL_PATH_SIZE];
2584 char value[UTIL_NAME_SIZE];
2587 if (util_resolve_subsys_kernel(event->udev, key_name, attr, sizeof(attr), 0) != 0)
2588 util_strscpyl(attr, sizeof(attr), udev_device_get_syspath(event->dev), "/", key_name, NULL);
2589 attr_subst_subdir(attr, sizeof(attr));
2591 udev_event_apply_format(event, &rules->buf[cur->key.value_off], value, sizeof(value));
2592 log_debug("ATTR '%s' writing '%s' %s:%u\n", attr, value,
2593 &rules->buf[rule->rule.filename_off],
2594 rule->rule.filename_line);
2595 f = fopen(attr, "w");
2597 if (fprintf(f, "%s", value) <= 0)
2598 log_error("error writing ATTR{%s}: %m\n", attr);
2601 log_error("error opening ATTR{%s} for writing: %m\n", attr);
2606 if (cur->key.op == OP_ASSIGN || cur->key.op == OP_ASSIGN_FINAL)
2607 udev_list_cleanup(&event->run_list);
2608 log_debug("RUN '%s' %s:%u\n",
2609 &rules->buf[cur->key.value_off],
2610 &rules->buf[rule->rule.filename_off],
2611 rule->rule.filename_line);
2612 udev_list_entry_add(&event->run_list, &rules->buf[cur->key.value_off], NULL);
2616 if (cur->key.rule_goto == 0)
2618 cur = &rules->tokens[cur->key.rule_goto];
2623 case TK_M_PARENTS_MIN:
2624 case TK_M_PARENTS_MAX:
2627 log_error("wrong type %u\n", cur->type);
2634 /* fast-forward to next rule */
2635 cur = rule + rule->rule.token_count;
2639 void udev_rules_apply_static_dev_perms(struct udev_rules *rules)
2647 if (rules->tokens == NULL)
2650 cur = &rules->tokens[0];
2653 switch (cur->type) {
2658 /* skip rules without a static_node tag */
2659 if (!rule->rule.has_static_node)
2673 mode = cur->key.mode;
2675 case TK_A_STATIC_NODE: {
2676 char filename[UTIL_PATH_SIZE];
2679 /* we assure, that the permissions tokens are sorted before the static token */
2680 if (mode == 0 && uid == 0 && gid == 0)
2682 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(rules->udev), "/",
2683 &rules->buf[cur->key.value_off], NULL);
2684 if (stat(filename, &stats) != 0)
2686 if (!S_ISBLK(stats.st_mode) && !S_ISCHR(stats.st_mode))
2694 if (mode != (stats.st_mode & 01777)) {
2695 chmod(filename, mode);
2696 log_debug("chmod '%s' %#o\n", filename, mode);
2699 if ((uid != 0 && uid != stats.st_uid) || (gid != 0 && gid != stats.st_gid)) {
2700 chown(filename, uid, gid);
2701 log_debug("chown '%s' %u %u\n", filename, uid, gid);
2704 utimensat(AT_FDCWD, filename, NULL, 0);
2714 /* fast-forward to next rule */
2715 cur = rule + rule->rule.token_count;