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 */
141 TK_M_TEST, /* val, mode_t */
142 TK_M_PROGRAM, /* val */
143 TK_M_IMPORT_FILE, /* val */
144 TK_M_IMPORT_PROG, /* val */
145 TK_M_IMPORT_DB, /* val */
146 TK_M_IMPORT_PARENT, /* val */
147 TK_M_RESULT, /* val */
150 TK_A_STRING_ESCAPE_NONE,
151 TK_A_STRING_ESCAPE_REPLACE,
152 TK_A_INOTIFY_WATCH, /* int */
153 TK_A_DEVLINK_PRIO, /* int */
154 TK_A_OWNER, /* val */
155 TK_A_GROUP, /* val */
157 TK_A_OWNER_ID, /* uid_t */
158 TK_A_GROUP_ID, /* gid_t */
159 TK_A_MODE_ID, /* mode_t */
160 TK_A_ENV, /* val, attr */
163 TK_A_DEVLINK, /* val */
164 TK_A_EVENT_TIMEOUT, /* int */
165 TK_A_ATTR, /* val, attr */
166 TK_A_RUN, /* val, bool */
167 TK_A_GOTO, /* size_t */
172 /* we try to pack stuff in a way that we take only 12 bytes per token */
175 unsigned char type; /* same as in rule and key */
177 enum token_type type:8;
178 unsigned int flags:8;
179 unsigned short token_count;
180 unsigned int label_off;
181 unsigned short filename_off;
182 unsigned short filename_line;
185 enum token_type type:8;
186 enum operation_type op:8;
187 enum string_glob_type glob:8;
188 enum string_subst_type subst:4;
189 enum string_subst_type attrsubst:4;
190 unsigned int value_off;
192 unsigned int attr_off;
195 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_TAG] = "M TAG",
259 [TK_M_SUBSYSTEM] = "M SUBSYSTEM",
260 [TK_M_DRIVER] = "M DRIVER",
261 [TK_M_WAITFOR] = "M WAITFOR",
262 [TK_M_ATTR] = "M ATTR",
264 [TK_M_PARENTS_MIN] = "M PARENTS_MIN",
265 [TK_M_KERNELS] = "M KERNELS",
266 [TK_M_SUBSYSTEMS] = "M SUBSYSTEMS",
267 [TK_M_DRIVERS] = "M DRIVERS",
268 [TK_M_ATTRS] = "M ATTRS",
269 [TK_M_PARENTS_MAX] = "M PARENTS_MAX",
271 [TK_M_TEST] = "M TEST",
272 [TK_M_PROGRAM] = "M PROGRAM",
273 [TK_M_IMPORT_FILE] = "M IMPORT_FILE",
274 [TK_M_IMPORT_PROG] = "M IMPORT_PROG",
275 [TK_M_IMPORT_DB] = "M IMPORT_DB",
276 [TK_M_IMPORT_PARENT] = "M IMPORT_PARENT",
277 [TK_M_RESULT] = "M RESULT",
278 [TK_M_MAX] = "M MAX",
280 [TK_A_STRING_ESCAPE_NONE] = "A STRING_ESCAPE_NONE",
281 [TK_A_STRING_ESCAPE_REPLACE] = "A STRING_ESCAPE_REPLACE",
282 [TK_A_INOTIFY_WATCH] = "A INOTIFY_WATCH",
283 [TK_A_DEVLINK_PRIO] = "A DEVLINK_PRIO",
284 [TK_A_OWNER] = "A OWNER",
285 [TK_A_GROUP] = "A GROUP",
286 [TK_A_MODE] = "A MODE",
287 [TK_A_OWNER_ID] = "A OWNER_ID",
288 [TK_A_GROUP_ID] = "A GROUP_ID",
289 [TK_A_MODE_ID] = "A MODE_ID",
290 [TK_A_ENV] = "A ENV",
291 [TK_A_TAG] = "A ENV",
292 [TK_A_NAME] = "A NAME",
293 [TK_A_DEVLINK] = "A DEVLINK",
294 [TK_A_EVENT_TIMEOUT] = "A EVENT_TIMEOUT",
295 [TK_A_ATTR] = "A ATTR",
296 [TK_A_RUN] = "A RUN",
297 [TK_A_GOTO] = "A GOTO",
302 return token_strs[type];
305 static void dump_token(struct udev_rules *rules, struct token *token)
307 enum token_type type = token->type;
308 enum operation_type op = token->key.op;
309 enum string_glob_type glob = token->key.glob;
310 const char *value = &rules->buf[token->key.value_off];
311 const char *attr = &rules->buf[token->key.attr_off];
316 const char *tks_ptr = (char *)rules->tokens;
317 const char *tk_ptr = (char *)token;
318 unsigned int idx = (tk_ptr - tks_ptr) / sizeof(struct token);
320 dbg(rules->udev, "* RULE %s:%u, token: %u, count: %u, label: '%s', flags: 0x%02x\n",
321 &rules->buf[token->rule.filename_off], token->rule.filename_line,
322 idx, token->rule.token_count,
323 &rules->buf[token->rule.label_off],
336 case TK_M_SUBSYSTEMS:
339 case TK_M_IMPORT_FILE:
340 case TK_M_IMPORT_PROG:
342 case TK_M_IMPORT_PARENT:
350 dbg(rules->udev, "%s %s '%s'(%s)\n",
351 token_str(type), operation_str(op), value, string_glob_str(glob));
358 dbg(rules->udev, "%s %s '%s' '%s'(%s)\n",
359 token_str(type), operation_str(op), attr, value, string_glob_str(glob));
363 dbg(rules->udev, "%s %s '%s'\n", token_str(type), operation_str(op), value);
365 case TK_A_STRING_ESCAPE_NONE:
366 case TK_A_STRING_ESCAPE_REPLACE:
367 dbg(rules->udev, "%s\n", token_str(type));
370 dbg(rules->udev, "%s %s '%s'(%s) %#o\n",
371 token_str(type), operation_str(op), value, string_glob_str(glob), token->key.mode);
373 case TK_A_INOTIFY_WATCH:
374 dbg(rules->udev, "%s %u\n", token_str(type), token->key.watch);
376 case TK_A_DEVLINK_PRIO:
377 dbg(rules->udev, "%s %s %u\n", token_str(type), operation_str(op), token->key.devlink_prio);
380 dbg(rules->udev, "%s %s %u\n", token_str(type), operation_str(op), token->key.uid);
383 dbg(rules->udev, "%s %s %u\n", token_str(type), operation_str(op), token->key.gid);
386 dbg(rules->udev, "%s %s %#o\n", token_str(type), operation_str(op), token->key.mode);
388 case TK_A_EVENT_TIMEOUT:
389 dbg(rules->udev, "%s %s %u\n", token_str(type), operation_str(op), token->key.event_timeout);
392 dbg(rules->udev, "%s '%s' %u\n", token_str(type), value, token->key.rule_goto);
395 dbg(rules->udev, "* %s\n", token_str(type));
397 case TK_M_PARENTS_MIN:
398 case TK_M_PARENTS_MAX:
401 dbg(rules->udev, "unknown type %u\n", type);
406 static void dump_rules(struct udev_rules *rules)
410 dbg(rules->udev, "dumping %u (%zu bytes) tokens, %u (%zu bytes) strings\n",
412 rules->token_cur * sizeof(struct token),
415 for(i = 0; i < rules->token_cur; i++)
416 dump_token(rules, &rules->tokens[i]);
419 static inline const char *operation_str(enum operation_type type) { return NULL; }
420 static inline const char *token_str(enum token_type type) { return NULL; }
421 static inline void dump_token(struct udev_rules *rules, struct token *token) {}
422 static inline void dump_rules(struct udev_rules *rules) {}
423 #endif /* ENABLE_DEBUG */
425 static int add_new_string(struct udev_rules *rules, const char *str, size_t bytes)
429 /* grow buffer if needed */
430 if (rules->buf_cur + bytes+1 >= rules->buf_max) {
434 /* double the buffer size */
435 add = rules->buf_max;
439 buf = realloc(rules->buf, rules->buf_max + add);
442 dbg(rules->udev, "extend buffer from %zu to %zu\n", rules->buf_max, rules->buf_max + add);
444 rules->buf_max += add;
446 off = rules->buf_cur;
447 memcpy(&rules->buf[rules->buf_cur], str, bytes);
448 rules->buf_cur += bytes;
453 static int add_string(struct udev_rules *rules, const char *str)
455 unsigned int node_idx;
456 struct trie_node *new_node;
457 unsigned int new_node_idx;
462 struct trie_node *parent;
464 /* walk trie, start from last character of str to find matching tails */
468 for (depth = 0; depth <= len; depth++) {
469 struct trie_node *node;
470 unsigned int child_idx;
472 node = &rules->trie_nodes[node_idx];
473 off = node->value_off + node->value_len - len;
475 /* match against current node */
476 if (depth == len || (node->value_len >= len && memcmp(&rules->buf[off], str, len) == 0))
479 /* lookup child node */
480 key = str[len - 1 - depth];
481 child_idx = node->child_idx;
482 while (child_idx > 0) {
483 struct trie_node *child;
485 child = &rules->trie_nodes[child_idx];
486 if (child->key == key)
488 child_idx = child->next_child_idx;
492 node_idx = child_idx;
495 /* string not found, add it */
496 off = add_new_string(rules, str, len + 1);
498 /* grow trie nodes if needed */
499 if (rules->trie_nodes_cur >= rules->trie_nodes_max) {
500 struct trie_node *nodes;
503 /* double the buffer size */
504 add = rules->trie_nodes_max;
508 nodes = realloc(rules->trie_nodes, (rules->trie_nodes_max + add) * sizeof(struct trie_node));
511 dbg(rules->udev, "extend trie nodes from %u to %u\n",
512 rules->trie_nodes_max, rules->trie_nodes_max + add);
513 rules->trie_nodes = nodes;
514 rules->trie_nodes_max += add;
518 new_node_idx = rules->trie_nodes_cur;
519 rules->trie_nodes_cur++;
520 new_node = &rules->trie_nodes[new_node_idx];
521 memset(new_node, 0x00, sizeof(struct trie_node));
522 new_node->value_off = off;
523 new_node->value_len = len;
526 /* join the parent's child list */
527 parent = &rules->trie_nodes[node_idx];
528 if (parent->child_idx == 0) {
529 parent->child_idx = new_node_idx;
531 struct trie_node *last_child;
533 last_child = &rules->trie_nodes[parent->last_child_idx];
534 last_child->next_child_idx = new_node_idx;
536 parent->last_child_idx = new_node_idx;
540 static int add_token(struct udev_rules *rules, struct token *token)
542 /* grow buffer if needed */
543 if (rules->token_cur+1 >= rules->token_max) {
544 struct token *tokens;
547 /* double the buffer size */
548 add = rules->token_max;
552 tokens = realloc(rules->tokens, (rules->token_max + add ) * sizeof(struct token));
555 dbg(rules->udev, "extend tokens from %u to %u\n", rules->token_max, rules->token_max + add);
556 rules->tokens = tokens;
557 rules->token_max += add;
559 memcpy(&rules->tokens[rules->token_cur], token, sizeof(struct token));
564 static uid_t add_uid(struct udev_rules *rules, const char *owner)
570 /* lookup, if we know it already */
571 for (i = 0; i < rules->uids_cur; i++) {
572 off = rules->uids[i].name_off;
573 if (strcmp(&rules->buf[off], owner) == 0) {
574 uid = rules->uids[i].uid;
575 dbg(rules->udev, "return existing %u for '%s'\n", uid, owner);
579 uid = util_lookup_user(rules->udev, owner);
581 /* grow buffer if needed */
582 if (rules->uids_cur+1 >= rules->uids_max) {
583 struct uid_gid *uids;
586 /* double the buffer size */
587 add = rules->uids_max;
591 uids = realloc(rules->uids, (rules->uids_max + add ) * sizeof(struct uid_gid));
594 dbg(rules->udev, "extend uids from %u to %u\n", rules->uids_max, rules->uids_max + add);
596 rules->uids_max += add;
598 rules->uids[rules->uids_cur].uid = uid;
599 off = add_string(rules, owner);
602 rules->uids[rules->uids_cur].name_off = off;
607 static gid_t add_gid(struct udev_rules *rules, const char *group)
613 /* lookup, if we know it already */
614 for (i = 0; i < rules->gids_cur; i++) {
615 off = rules->gids[i].name_off;
616 if (strcmp(&rules->buf[off], group) == 0) {
617 gid = rules->gids[i].gid;
618 dbg(rules->udev, "return existing %u for '%s'\n", gid, group);
622 gid = util_lookup_group(rules->udev, group);
624 /* grow buffer if needed */
625 if (rules->gids_cur+1 >= rules->gids_max) {
626 struct uid_gid *gids;
629 /* double the buffer size */
630 add = rules->gids_max;
634 gids = realloc(rules->gids, (rules->gids_max + add ) * sizeof(struct uid_gid));
637 dbg(rules->udev, "extend gids from %u to %u\n", rules->gids_max, rules->gids_max + add);
639 rules->gids_max += add;
641 rules->gids[rules->gids_cur].gid = gid;
642 off = add_string(rules, group);
645 rules->gids[rules->gids_cur].name_off = off;
650 static int import_property_from_string(struct udev_device *dev, char *line)
652 struct udev *udev = udev_device_get_udev(dev);
659 while (isspace(key[0]))
662 /* comment or empty line */
663 if (key[0] == '#' || key[0] == '\0')
666 /* split key/value */
667 val = strchr(key, '=');
674 while (isspace(val[0]))
681 while (isspace(key[len-1]))
685 /* terminate value */
689 while (isspace(val[len-1]))
697 if (val[0] == '"' || val[0] == '\'') {
698 if (val[len-1] != val[0]) {
699 info(udev, "inconsistent quoting: '%s', skip\n", line);
706 dbg(udev, "adding '%s'='%s'\n", key, val);
708 /* handle device, renamed by external tool, returning new path */
709 if (strcmp(key, "DEVPATH") == 0) {
710 char syspath[UTIL_PATH_SIZE];
712 info(udev, "updating devpath from '%s' to '%s'\n",
713 udev_device_get_devpath(dev), val);
714 util_strscpyl(syspath, sizeof(syspath), udev_get_sys_path(udev), val, NULL);
715 udev_device_set_syspath(dev, syspath);
717 struct udev_list_entry *entry;
719 entry = udev_device_add_property(dev, key, val);
720 /* store in db, skip private keys */
722 udev_list_entry_set_flags(entry, 1);
727 static int import_file_into_properties(struct udev_device *dev, const char *filename)
730 char line[UTIL_LINE_SIZE];
732 f = fopen(filename, "r");
735 while (fgets(line, sizeof(line), f) != NULL)
736 import_property_from_string(dev, line);
741 static int import_program_into_properties(struct udev_device *dev, const char *program)
743 struct udev *udev = udev_device_get_udev(dev);
749 envp = udev_device_get_properties_envp(dev);
750 if (util_run_program(udev, program, envp, result, sizeof(result), &reslen, NULL) != 0)
754 while (line != NULL) {
757 pos = strchr(line, '\n');
762 import_property_from_string(dev, line);
768 static int import_parent_into_properties(struct udev_device *dev, const char *filter)
770 struct udev *udev = udev_device_get_udev(dev);
771 struct udev_device *dev_parent;
772 struct udev_list_entry *list_entry;
774 dev_parent = udev_device_get_parent(dev);
775 if (dev_parent == NULL)
778 dbg(udev, "found parent '%s', get the node name\n", udev_device_get_syspath(dev_parent));
779 udev_list_entry_foreach(list_entry, udev_device_get_properties_list_entry(dev_parent)) {
780 const char *key = udev_list_entry_get_name(list_entry);
781 const char *val = udev_list_entry_get_value(list_entry);
783 if (fnmatch(filter, key, 0) == 0) {
784 struct udev_list_entry *entry;
786 dbg(udev, "import key '%s=%s'\n", key, val);
787 entry = udev_device_add_property(dev, key, val);
788 /* store in db, skip private keys */
790 udev_list_entry_set_flags(entry, 1);
796 #define WAIT_LOOP_PER_SECOND 50
797 static int wait_for_file(struct udev_device *dev, const char *file, int timeout)
799 struct udev *udev = udev_device_get_udev(dev);
800 char filepath[UTIL_PATH_SIZE];
801 char devicepath[UTIL_PATH_SIZE];
803 int loop = timeout * WAIT_LOOP_PER_SECOND;
805 /* a relative path is a device attribute */
806 devicepath[0] = '\0';
807 if (file[0] != '/') {
808 util_strscpyl(devicepath, sizeof(devicepath),
809 udev_get_sys_path(udev), udev_device_get_devpath(dev), NULL);
810 util_strscpyl(filepath, sizeof(filepath), devicepath, "/", file, NULL);
814 dbg(udev, "will wait %i sec for '%s'\n", timeout, file);
816 const struct timespec duration = { 0, 1000 * 1000 * 1000 / WAIT_LOOP_PER_SECOND };
819 if (stat(file, &stats) == 0) {
820 info(udev, "file '%s' appeared after %i loops\n", file, (timeout * WAIT_LOOP_PER_SECOND) - loop-1);
823 /* make sure, the device did not disappear in the meantime */
824 if (devicepath[0] != '\0' && stat(devicepath, &stats) != 0) {
825 info(udev, "device disappeared while waiting for '%s'\n", file);
828 info(udev, "wait for '%s' for %i mseconds\n", file, 1000 / WAIT_LOOP_PER_SECOND);
829 nanosleep(&duration, NULL);
831 info(udev, "waiting for '%s' failed\n", file);
835 static int attr_subst_subdir(char *attr, size_t len)
839 if (strstr(attr, "/*/")) {
841 char dirname[UTIL_PATH_SIZE];
845 util_strscpy(dirname, sizeof(dirname), attr);
846 pos = strstr(dirname, "/*/");
851 dir = opendir(dirname);
855 for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
858 if (dent->d_name[0] == '.')
860 util_strscpyl(attr, len, dirname, "/", dent->d_name, tail, NULL);
861 if (stat(attr, &stats) == 0) {
873 static int get_key(struct udev *udev, char **line, char **key, enum operation_type *op, char **value)
879 if (linepos == NULL || linepos[0] == '\0')
882 /* skip whitespace */
883 while (isspace(linepos[0]) || linepos[0] == ',')
887 if (linepos[0] == '\0')
893 if (linepos[0] == '\0')
895 if (isspace(linepos[0]))
897 if (linepos[0] == '=')
899 if ((linepos[0] == '+') || (linepos[0] == '!') || (linepos[0] == ':'))
900 if (linepos[1] == '=')
904 /* remember end of key */
907 /* skip whitespace after key */
908 while (isspace(linepos[0]))
910 if (linepos[0] == '\0')
913 /* get operation type */
914 if (linepos[0] == '=' && linepos[1] == '=') {
917 } else if (linepos[0] == '!' && linepos[1] == '=') {
920 } else if (linepos[0] == '+' && linepos[1] == '=') {
923 } else if (linepos[0] == '=') {
926 } else if (linepos[0] == ':' && linepos[1] == '=') {
927 *op = OP_ASSIGN_FINAL;
935 /* skip whitespace after operator */
936 while (isspace(linepos[0]))
938 if (linepos[0] == '\0')
942 if (linepos[0] == '"')
949 temp = strchr(linepos, '"');
954 dbg(udev, "%s '%s'-'%s'\n", operation_str(*op), *key, *value);
956 /* move line to next key */
961 /* extract possible KEY{attr} */
962 static char *get_key_attribute(struct udev *udev, char *str)
967 attr = strchr(str, '{');
970 pos = strchr(attr, '}');
972 err(udev, "missing closing brace for format\n");
976 dbg(udev, "attribute='%s'\n", attr);
982 static int rule_add_key(struct rule_tmp *rule_tmp, enum token_type type,
983 enum operation_type op,
984 const char *value, const void *data)
986 struct token *token = &rule_tmp->token[rule_tmp->token_cur];
987 const char *attr = NULL;
989 memset(token, 0x00, sizeof(struct token));
1001 case TK_M_SUBSYSTEMS:
1004 case TK_M_IMPORT_FILE:
1005 case TK_M_IMPORT_PROG:
1006 case TK_M_IMPORT_DB:
1007 case TK_M_IMPORT_PARENT:
1016 token->key.value_off = add_string(rule_tmp->rules, value);
1024 token->key.value_off = add_string(rule_tmp->rules, value);
1025 token->key.attr_off = add_string(rule_tmp->rules, attr);
1028 token->key.value_off = add_string(rule_tmp->rules, value);
1029 token->key.devlink_unique = *(int *)data;
1032 token->key.value_off = add_string(rule_tmp->rules, value);
1034 token->key.mode = *(mode_t *)data;
1036 case TK_A_STRING_ESCAPE_NONE:
1037 case TK_A_STRING_ESCAPE_REPLACE:
1040 token->key.value_off = add_string(rule_tmp->rules, value);
1041 token->key.fail_on_error = *(int *)data;
1043 case TK_A_INOTIFY_WATCH:
1044 case TK_A_DEVLINK_PRIO:
1045 token->key.devlink_prio = *(int *)data;
1048 token->key.uid = *(uid_t *)data;
1051 token->key.gid = *(gid_t *)data;
1054 token->key.mode = *(mode_t *)data;
1056 case TK_A_EVENT_TIMEOUT:
1057 token->key.event_timeout = *(int *)data;
1060 case TK_M_PARENTS_MIN:
1061 case TK_M_PARENTS_MAX:
1065 err(rule_tmp->rules->udev, "wrong type %u\n", type);
1069 if (value != NULL && type < TK_M_MAX) {
1070 /* check if we need to split or call fnmatch() while matching rules */
1071 enum string_glob_type glob;
1075 has_split = (strchr(value, '|') != NULL);
1076 has_glob = (strchr(value, '*') != NULL || strchr(value, '?') != NULL || strchr(value, '[') != NULL);
1077 if (has_split && has_glob) {
1078 glob = GL_SPLIT_GLOB;
1079 } else if (has_split) {
1081 } else if (has_glob) {
1082 if (strcmp(value, "?*") == 0)
1083 glob = GL_SOMETHING;
1089 token->key.glob = glob;
1092 if (value != NULL && type > TK_M_MAX) {
1093 /* check if assigned value has substitution chars */
1094 if (value[0] == '[')
1095 token->key.subst = SB_SUBSYS;
1096 else if (strchr(value, '%') != NULL || strchr(value, '$') != NULL)
1097 token->key.subst = SB_FORMAT;
1099 token->key.subst = SB_NONE;
1103 /* check if property/attribut name has substitution chars */
1105 token->key.attrsubst = SB_SUBSYS;
1106 else if (strchr(attr, '%') != NULL || strchr(attr, '$') != NULL)
1107 token->key.attrsubst = SB_FORMAT;
1109 token->key.attrsubst = SB_NONE;
1112 token->key.type = type;
1114 rule_tmp->token_cur++;
1115 if (rule_tmp->token_cur >= ARRAY_SIZE(rule_tmp->token)) {
1116 err(rule_tmp->rules->udev, "temporary rule array too small\n");
1122 static int sort_token(struct udev_rules *rules, struct rule_tmp *rule_tmp)
1125 unsigned int start = 0;
1126 unsigned int end = rule_tmp->token_cur;
1128 for (i = 0; i < rule_tmp->token_cur; i++) {
1129 enum token_type next_val = TK_UNSET;
1130 unsigned int next_idx = 0;
1133 /* find smallest value */
1134 for (j = start; j < end; j++) {
1135 if (rule_tmp->token[j].type == TK_UNSET)
1137 if (next_val == TK_UNSET || rule_tmp->token[j].type < next_val) {
1138 next_val = rule_tmp->token[j].type;
1143 /* add token and mark done */
1144 if (add_token(rules, &rule_tmp->token[next_idx]) != 0)
1146 rule_tmp->token[next_idx].type = TK_UNSET;
1149 if (next_idx == start)
1151 if (next_idx+1 == end)
1157 static int add_rule(struct udev_rules *rules, char *line,
1158 const char *filename, unsigned int filename_off, unsigned int lineno)
1162 struct rule_tmp rule_tmp;
1163 bool bus_warn = false;
1164 bool sysfs_warn = false;
1165 bool id_warn = false;
1167 memset(&rule_tmp, 0x00, sizeof(struct rule_tmp));
1168 rule_tmp.rules = rules;
1169 rule_tmp.rule.type = TK_RULE;
1170 rule_tmp.rule.rule.filename_off = filename_off;
1171 rule_tmp.rule.rule.filename_line = lineno;
1177 enum operation_type op;
1179 if (get_key(rules->udev, &linepos, &key, &op, &value) != 0)
1182 if (strcmp(key, "ACTION") == 0) {
1183 if (op > OP_MATCH_MAX) {
1184 err(rules->udev, "invalid ACTION operation\n");
1187 rule_add_key(&rule_tmp, TK_M_ACTION, op, value, NULL);
1191 if (strcmp(key, "DEVPATH") == 0) {
1192 if (op > OP_MATCH_MAX) {
1193 err(rules->udev, "invalid DEVPATH operation\n");
1196 rule_add_key(&rule_tmp, TK_M_DEVPATH, op, value, NULL);
1200 if (strcmp(key, "KERNEL") == 0) {
1201 if (op > OP_MATCH_MAX) {
1202 err(rules->udev, "invalid KERNEL operation\n");
1205 rule_add_key(&rule_tmp, TK_M_KERNEL, op, value, NULL);
1209 if (strcmp(key, "SUBSYSTEM") == 0) {
1210 if (op > OP_MATCH_MAX) {
1211 err(rules->udev, "invalid SUBSYSTEM operation\n");
1214 /* bus, class, subsystem events should all be the same */
1215 if (strcmp(value, "subsystem") == 0 ||
1216 strcmp(value, "bus") == 0 ||
1217 strcmp(value, "class") == 0) {
1218 if (strcmp(value, "bus") == 0 || strcmp(value, "class") == 0)
1219 err(rules->udev, "'%s' must be specified as 'subsystem' \n"
1220 "please fix it in %s:%u", value, filename, lineno);
1221 rule_add_key(&rule_tmp, TK_M_SUBSYSTEM, op, "subsystem|class|bus", NULL);
1223 rule_add_key(&rule_tmp, TK_M_SUBSYSTEM, op, value, NULL);
1227 if (strcmp(key, "DRIVER") == 0) {
1228 if (op > OP_MATCH_MAX) {
1229 err(rules->udev, "invalid DRIVER operation\n");
1232 rule_add_key(&rule_tmp, TK_M_DRIVER, op, value, NULL);
1236 if (strncmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
1237 attr = get_key_attribute(rules->udev, key + sizeof("ATTR")-1);
1239 err(rules->udev, "error parsing ATTR attribute\n");
1242 if (op < OP_MATCH_MAX) {
1243 rule_add_key(&rule_tmp, TK_M_ATTR, op, value, attr);
1245 rule_add_key(&rule_tmp, TK_A_ATTR, op, value, attr);
1250 if (strcmp(key, "KERNELS") == 0) {
1251 if (op > OP_MATCH_MAX) {
1252 err(rules->udev, "invalid KERNELS operation\n");
1255 rule_add_key(&rule_tmp, TK_M_KERNELS, op, value, NULL);
1259 if (strcmp(key, "ID") == 0) {
1262 err(rules->udev, "ID= will be removed in a future udev version, "
1263 "please use KERNEL= to match the event device, or KERNELS= "
1264 "to match a parent device, in %s:%u\n", filename, lineno);
1266 if (op > OP_MATCH_MAX) {
1267 err(rules->udev, "invalid KERNELS operation\n");
1270 rule_add_key(&rule_tmp, TK_M_KERNELS, op, value, NULL);
1274 if (strcmp(key, "SUBSYSTEMS") == 0) {
1275 if (op > OP_MATCH_MAX) {
1276 err(rules->udev, "invalid SUBSYSTEMS operation\n");
1279 rule_add_key(&rule_tmp, TK_M_SUBSYSTEMS, op, value, NULL);
1283 if (strcmp(key, "BUS") == 0) {
1286 err(rules->udev, "BUS= will be removed in a future udev version, "
1287 "please use SUBSYSTEM= to match the event device, or SUBSYSTEMS= "
1288 "to match a parent device, in %s:%u\n", filename, lineno);
1290 if (op > OP_MATCH_MAX) {
1291 err(rules->udev, "invalid SUBSYSTEMS operation\n");
1294 rule_add_key(&rule_tmp, TK_M_SUBSYSTEMS, op, value, NULL);
1298 if (strcmp(key, "DRIVERS") == 0) {
1299 if (op > OP_MATCH_MAX) {
1300 err(rules->udev, "invalid DRIVERS operation\n");
1303 rule_add_key(&rule_tmp, TK_M_DRIVERS, op, value, NULL);
1307 if (strncmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0) {
1308 if (op > OP_MATCH_MAX) {
1309 err(rules->udev, "invalid ATTRS operation\n");
1312 attr = get_key_attribute(rules->udev, key + sizeof("ATTRS")-1);
1314 err(rules->udev, "error parsing ATTRS attribute\n");
1317 if (strncmp(attr, "device/", 7) == 0)
1318 err(rules->udev, "the 'device' link may not be available in a future kernel, "
1319 "please fix it in %s:%u", filename, lineno);
1320 else if (strstr(attr, "../") != NULL)
1321 err(rules->udev, "do not reference parent sysfs directories directly, "
1322 "it may break with a future kernel, please fix it in %s:%u", filename, lineno);
1323 rule_add_key(&rule_tmp, TK_M_ATTRS, op, value, attr);
1327 if (strncmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
1330 err(rules->udev, "SYSFS{}= will be removed in a future udev version, "
1331 "please use ATTR{}= to match the event device, or ATTRS{}= "
1332 "to match a parent device, in %s:%u\n", filename, lineno);
1334 if (op > OP_MATCH_MAX) {
1335 err(rules->udev, "invalid ATTRS operation\n");
1338 attr = get_key_attribute(rules->udev, key + sizeof("ATTRS")-1);
1340 err(rules->udev, "error parsing ATTRS attribute\n");
1343 rule_add_key(&rule_tmp, TK_M_ATTRS, op, value, attr);
1347 if (strncmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
1348 attr = get_key_attribute(rules->udev, key + sizeof("ENV")-1);
1350 err(rules->udev, "error parsing ENV attribute\n");
1353 if (op < OP_MATCH_MAX) {
1354 if (rule_add_key(&rule_tmp, TK_M_ENV, op, value, attr) != 0)
1357 if (rule_add_key(&rule_tmp, TK_A_ENV, op, value, attr) != 0)
1363 if (strcmp(key, "TAG") == 0) {
1364 if (op < OP_MATCH_MAX)
1365 rule_add_key(&rule_tmp, TK_M_TAG, op, value, NULL);
1367 rule_add_key(&rule_tmp, TK_A_TAG, op, value, NULL);
1371 if (strcmp(key, "PROGRAM") == 0) {
1372 rule_add_key(&rule_tmp, TK_M_PROGRAM, op, value, NULL);
1376 if (strcmp(key, "RESULT") == 0) {
1377 if (op > OP_MATCH_MAX) {
1378 err(rules->udev, "invalid RESULT operation\n");
1381 rule_add_key(&rule_tmp, TK_M_RESULT, op, value, NULL);
1385 if (strncmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
1386 attr = get_key_attribute(rules->udev, key + sizeof("IMPORT")-1);
1387 if (attr != NULL && strstr(attr, "program")) {
1388 dbg(rules->udev, "IMPORT will be executed\n");
1389 rule_add_key(&rule_tmp, TK_M_IMPORT_PROG, op, value, NULL);
1390 } else if (attr != NULL && strstr(attr, "file")) {
1391 dbg(rules->udev, "IMPORT will be included as file\n");
1392 rule_add_key(&rule_tmp, TK_M_IMPORT_FILE, op, value, NULL);
1393 } else if (attr != NULL && strstr(attr, "db")) {
1394 dbg(rules->udev, "IMPORT will include db values\n");
1395 rule_add_key(&rule_tmp, TK_M_IMPORT_DB, op, value, NULL);
1396 } else if (attr != NULL && strstr(attr, "parent")) {
1397 dbg(rules->udev, "IMPORT will include the parent values\n");
1398 rule_add_key(&rule_tmp, TK_M_IMPORT_PARENT, op, value, NULL);
1400 /* figure it out if it is executable */
1401 char file[UTIL_PATH_SIZE];
1403 struct stat statbuf;
1405 /* allow programs in /lib/udev called without the path */
1406 if (value[0] != '/')
1407 util_strscpyl(file, sizeof(file), LIBEXECDIR "/", value, NULL);
1409 util_strscpy(file, sizeof(file), value);
1410 pos = strchr(file, ' ');
1413 dbg(rules->udev, "IMPORT auto mode for '%s'\n", file);
1414 if (stat(file, &statbuf) == 0 && (statbuf.st_mode & S_IXUSR)) {
1415 dbg(rules->udev, "IMPORT will be executed (autotype)\n");
1416 rule_add_key(&rule_tmp, TK_M_IMPORT_PROG, op, value, NULL);
1418 dbg(rules->udev, "IMPORT will be included as file (autotype)\n");
1419 rule_add_key(&rule_tmp, TK_M_IMPORT_FILE, op, value, NULL);
1425 if (strncmp(key, "TEST", sizeof("TEST")-1) == 0) {
1428 if (op > OP_MATCH_MAX) {
1429 err(rules->udev, "invalid TEST operation\n");
1432 attr = get_key_attribute(rules->udev, key + sizeof("TEST")-1);
1434 mode = strtol(attr, NULL, 8);
1435 rule_add_key(&rule_tmp, TK_M_TEST, op, value, &mode);
1437 rule_add_key(&rule_tmp, TK_M_TEST, op, value, NULL);
1442 if (strncmp(key, "RUN", sizeof("RUN")-1) == 0) {
1445 attr = get_key_attribute(rules->udev, key + sizeof("RUN")-1);
1446 if (attr != NULL && strstr(attr, "fail_event_on_error"))
1448 rule_add_key(&rule_tmp, TK_A_RUN, op, value, &flag);
1452 if (strcmp(key, "WAIT_FOR") == 0 || strcmp(key, "WAIT_FOR_SYSFS") == 0) {
1453 rule_add_key(&rule_tmp, TK_M_WAITFOR, 0, value, NULL);
1457 if (strcmp(key, "LABEL") == 0) {
1458 rule_tmp.rule.rule.label_off = add_string(rules, value);
1462 if (strcmp(key, "GOTO") == 0) {
1463 rule_add_key(&rule_tmp, TK_A_GOTO, 0, value, NULL);
1467 if (strncmp(key, "NAME", sizeof("NAME")-1) == 0) {
1468 if (op < OP_MATCH_MAX) {
1469 rule_add_key(&rule_tmp, TK_M_NAME, op, value, NULL);
1471 if (value[0] == '\0')
1472 info(rules->udev, "name empty, node creation suppressed\n");
1473 else if (strcmp(value, "%k") == 0)
1474 err(rules->udev, "NAME=\"%%k\" is superfluous and breaks "
1475 "kernel supplied names, please remove it from %s:%u\n", filename, lineno);
1476 rule_add_key(&rule_tmp, TK_A_NAME, op, value, NULL);
1478 rule_tmp.rule.rule.flags = 1;
1482 if (strncmp(key, "SYMLINK", sizeof("SYMLINK")-1) == 0) {
1483 if (op < OP_MATCH_MAX) {
1484 rule_add_key(&rule_tmp, TK_M_DEVLINK, op, value, NULL);
1488 attr = get_key_attribute(rules->udev, key + sizeof("SYMLINK")-1);
1489 if (attr != NULL && strstr(attr, "unique") != NULL)
1491 rule_add_key(&rule_tmp, TK_A_DEVLINK, op, value, &flag);
1493 rule_tmp.rule.rule.flags = 1;
1497 if (strcmp(key, "OWNER") == 0) {
1501 uid = strtoul(value, &endptr, 10);
1502 if (endptr[0] == '\0') {
1503 rule_add_key(&rule_tmp, TK_A_OWNER_ID, op, NULL, &uid);
1504 } else if ((rules->resolve_names > 0) && strchr("$%", value[0]) == NULL) {
1505 uid = add_uid(rules, value);
1506 rule_add_key(&rule_tmp, TK_A_OWNER_ID, op, NULL, &uid);
1507 } else if (rules->resolve_names >= 0) {
1508 rule_add_key(&rule_tmp, TK_A_OWNER, op, value, NULL);
1510 rule_tmp.rule.rule.flags = 1;
1514 if (strcmp(key, "GROUP") == 0) {
1518 gid = strtoul(value, &endptr, 10);
1519 if (endptr[0] == '\0') {
1520 rule_add_key(&rule_tmp, TK_A_GROUP_ID, op, NULL, &gid);
1521 } else if ((rules->resolve_names > 0) && strchr("$%", value[0]) == NULL) {
1522 gid = add_gid(rules, value);
1523 rule_add_key(&rule_tmp, TK_A_GROUP_ID, op, NULL, &gid);
1524 } else if (rules->resolve_names >= 0) {
1525 rule_add_key(&rule_tmp, TK_A_GROUP, op, value, NULL);
1527 rule_tmp.rule.rule.flags = 1;
1531 if (strcmp(key, "MODE") == 0) {
1535 mode = strtol(value, &endptr, 8);
1536 if (endptr[0] == '\0')
1537 rule_add_key(&rule_tmp, TK_A_MODE_ID, op, NULL, &mode);
1539 rule_add_key(&rule_tmp, TK_A_MODE, op, value, NULL);
1540 rule_tmp.rule.rule.flags = 1;
1544 if (strcmp(key, "OPTIONS") == 0) {
1547 pos = strstr(value, "link_priority=");
1549 int prio = atoi(&pos[strlen("link_priority=")]);
1551 rule_add_key(&rule_tmp, TK_A_DEVLINK_PRIO, 0, NULL, &prio);
1552 dbg(rules->udev, "link priority=%i\n", prio);
1554 pos = strstr(value, "event_timeout=");
1556 int tout = atoi(&pos[strlen("event_timeout=")]);
1558 rule_add_key(&rule_tmp, TK_A_EVENT_TIMEOUT, 0, NULL, &tout);
1559 dbg(rules->udev, "event timeout=%i\n", tout);
1561 pos = strstr(value, "string_escape=");
1563 pos = &pos[strlen("string_escape=")];
1564 if (strncmp(pos, "none", strlen("none")) == 0)
1565 rule_add_key(&rule_tmp, TK_A_STRING_ESCAPE_NONE, 0, NULL, NULL);
1566 else if (strncmp(pos, "replace", strlen("replace")) == 0)
1567 rule_add_key(&rule_tmp, TK_A_STRING_ESCAPE_REPLACE, 0, NULL, NULL);
1569 pos = strstr(value, "nowatch");
1573 rule_add_key(&rule_tmp, TK_A_INOTIFY_WATCH, 0, NULL, &off);
1574 dbg(rules->udev, "inotify watch of device disabled\n");
1576 pos = strstr(value, "watch");
1580 rule_add_key(&rule_tmp, TK_A_INOTIFY_WATCH, 0, NULL, &on);
1581 dbg(rules->udev, "inotify watch of device requested\n");
1586 err(rules->udev, "unknown key '%s' in %s:%u\n", key, filename, lineno);
1589 /* add rule token */
1590 rule_tmp.rule.rule.token_count = 1 + rule_tmp.token_cur;
1591 if (add_token(rules, &rule_tmp.rule) != 0)
1594 /* add tokens to list, sorted by type */
1595 if (sort_token(rules, &rule_tmp) != 0)
1600 err(rules->udev, "invalid rule '%s:%u'\n", filename, lineno);
1604 static int parse_file(struct udev_rules *rules, const char *filename, unsigned short filename_off)
1607 unsigned int first_token;
1608 char line[UTIL_LINE_SIZE];
1612 info(rules->udev, "reading '%s' as rules file\n", filename);
1614 f = fopen(filename, "r");
1618 first_token = rules->token_cur;
1620 while (fgets(line, sizeof(line), f) != NULL) {
1624 /* skip whitespace */
1627 while (isspace(key[0]))
1638 /* continue reading if backslash+newline is found */
1639 while (line[len-2] == '\\') {
1640 if (fgets(&line[len-2], (sizeof(line)-len)+2, f) == NULL)
1642 if (strlen(&line[len-2]) < 2)
1648 if (len+1 >= sizeof(line)) {
1649 err(rules->udev, "line too long '%s':%u, ignored\n", filename, line_nr);
1652 add_rule(rules, key, filename, filename_off, line_nr);
1656 /* link GOTOs to LABEL rules in this file to be able to fast-forward */
1657 for (i = first_token+1; i < rules->token_cur; i++) {
1658 if (rules->tokens[i].type == TK_A_GOTO) {
1659 char *label = &rules->buf[rules->tokens[i].key.value_off];
1662 for (j = i+1; j < rules->token_cur; j++) {
1663 if (rules->tokens[j].type != TK_RULE)
1665 if (rules->tokens[j].rule.label_off == 0)
1667 if (strcmp(label, &rules->buf[rules->tokens[j].rule.label_off]) != 0)
1669 rules->tokens[i].key.rule_goto = j;
1672 if (rules->tokens[i].key.rule_goto == 0)
1673 err(rules->udev, "GOTO '%s' has no matching label in: '%s'\n", label, filename);
1679 static int add_matching_files(struct udev *udev, struct udev_list_node *file_list, const char *dirname, const char *suffix)
1682 char filename[UTIL_PATH_SIZE];
1684 dbg(udev, "open directory '%s'\n", dirname);
1685 dir = opendir(dirname);
1687 info(udev, "unable to open '%s': %m\n", dirname);
1692 struct dirent *dent;
1694 dent = readdir(dir);
1695 if (dent == NULL || dent->d_name[0] == '\0')
1698 if (dent->d_name[0] == '.')
1701 /* look for file matching with specified suffix */
1702 if (suffix != NULL) {
1705 ext = strrchr(dent->d_name, '.');
1708 if (strcmp(ext, suffix) != 0)
1711 util_strscpyl(filename, sizeof(filename), dirname, "/", dent->d_name, NULL);
1712 dbg(udev, "put file '%s' into list\n", filename);
1713 udev_list_entry_add(udev, file_list, filename, NULL, 1, 1);
1720 struct udev_rules *udev_rules_new(struct udev *udev, int resolve_names)
1722 struct udev_rules *rules;
1723 struct stat statbuf;
1724 struct udev_list_node file_list;
1725 struct udev_list_entry *file_loop, *file_tmp;
1726 struct token end_token;
1728 rules = malloc(sizeof(struct udev_rules));
1731 memset(rules, 0x00, sizeof(struct udev_rules));
1733 rules->resolve_names = resolve_names;
1734 udev_list_init(&file_list);
1736 /* init token array and string buffer */
1737 rules->tokens = malloc(PREALLOC_TOKEN * sizeof(struct token));
1738 if (rules->tokens == NULL)
1740 rules->token_max = PREALLOC_TOKEN;
1742 rules->buf = malloc(PREALLOC_STRBUF);
1743 if (rules->buf == NULL)
1745 rules->buf_max = PREALLOC_STRBUF;
1746 /* offset 0 is always '\0' */
1747 rules->buf[0] = '\0';
1749 dbg(udev, "prealloc %zu bytes tokens (%u * %zu bytes), %zu bytes buffer\n",
1750 rules->token_max * sizeof(struct token), rules->token_max, sizeof(struct token), rules->buf_max);
1752 rules->trie_nodes = malloc(PREALLOC_TRIE * sizeof(struct trie_node));
1753 if (rules->trie_nodes == NULL)
1755 rules->trie_nodes_max = PREALLOC_TRIE;
1756 /* offset 0 is the trie root, with an empty string */
1757 memset(rules->trie_nodes, 0x00, sizeof(struct trie_node));
1758 rules->trie_nodes_cur = 1;
1760 if (udev_get_rules_path(udev) != NULL) {
1761 /* custom rules location for testing */
1762 add_matching_files(udev, &file_list, udev_get_rules_path(udev), ".rules");
1764 char filename[PATH_MAX];
1765 struct udev_list_node sort_list;
1766 struct udev_list_entry *sort_loop, *sort_tmp;
1768 /* read user/custom rules */
1769 add_matching_files(udev, &file_list, SYSCONFDIR "/udev/rules.d", ".rules");
1771 /* read dynamic/temporary rules */
1772 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(udev), "/.udev/rules.d", NULL);
1773 udev_list_init(&sort_list);
1774 add_matching_files(udev, &sort_list, filename, ".rules");
1776 /* read default rules */
1777 add_matching_files(udev, &sort_list, LIBEXECDIR "/rules.d", ".rules");
1779 /* sort all rules files by basename into list of files */
1780 udev_list_entry_foreach_safe(sort_loop, sort_tmp, udev_list_get_entry(&sort_list)) {
1781 const char *sort_name = udev_list_entry_get_name(sort_loop);
1782 const char *sort_base = strrchr(sort_name, '/');
1784 if (sort_base == NULL)
1786 /* sort entry into existing list */
1787 udev_list_entry_foreach_safe(file_loop, file_tmp, udev_list_get_entry(&file_list)) {
1788 const char *file_name = udev_list_entry_get_name(file_loop);
1789 const char *file_base = strrchr(file_name, '/');
1791 if (file_base == NULL)
1793 if (strcmp(file_base, sort_base) == 0) {
1794 info(udev, "rule file basename '%s' already added, ignoring '%s'\n",
1795 file_name, sort_name);
1796 udev_list_entry_delete(sort_loop);
1800 if (strcmp(file_base, sort_base) > 0) {
1801 /* found later file, insert before */
1802 udev_list_entry_remove(sort_loop);
1803 udev_list_entry_insert_before(sort_loop, file_loop);
1808 /* current file already handled */
1809 if (sort_loop == NULL)
1811 /* no later file, append to end of list */
1812 udev_list_entry_remove(sort_loop);
1813 udev_list_entry_append(sort_loop, &file_list);
1817 /* add all filenames to the string buffer */
1818 udev_list_entry_foreach(file_loop, udev_list_get_entry(&file_list)) {
1819 const char *filename = udev_list_entry_get_name(file_loop);
1820 unsigned int filename_off;
1822 filename_off = add_string(rules, filename);
1823 /* the offset in the rule is limited to unsigned short */
1824 if (filename_off < USHRT_MAX)
1825 udev_list_entry_set_flags(file_loop, filename_off);
1828 /* parse list of files */
1829 udev_list_entry_foreach_safe(file_loop, file_tmp, udev_list_get_entry(&file_list)) {
1830 const char *filename = udev_list_entry_get_name(file_loop);
1831 unsigned int filename_off = udev_list_entry_get_flags(file_loop);
1833 if (stat(filename, &statbuf) == 0 && statbuf.st_size > 0)
1834 parse_file(rules, filename, filename_off);
1836 err(udev, "can not read '%s'\n", filename);
1837 udev_list_entry_delete(file_loop);
1840 memset(&end_token, 0x00, sizeof(struct token));
1841 end_token.type = TK_END;
1842 add_token(rules, &end_token);
1844 /* shrink allocated token and string buffer */
1845 if (rules->token_cur < rules->token_max) {
1846 struct token *tokens;
1848 tokens = realloc(rules->tokens, rules->token_cur * sizeof(struct token));
1849 if (tokens != NULL || rules->token_cur == 0) {
1850 rules->tokens = tokens;
1851 rules->token_max = rules->token_cur;
1854 if (rules->buf_cur < rules->buf_max) {
1857 buf = realloc(rules->buf, rules->buf_cur);
1858 if (buf != NULL || rules->buf_cur == 0) {
1860 rules->buf_max = rules->buf_cur;
1863 info(udev, "rules use %zu bytes tokens (%u * %zu bytes), %zu bytes buffer\n",
1864 rules->token_max * sizeof(struct token), rules->token_max, sizeof(struct token), rules->buf_max);
1865 info(udev, "temporary index used %zu bytes (%u * %zu bytes)\n",
1866 rules->trie_nodes_cur * sizeof(struct trie_node),
1867 rules->trie_nodes_cur, sizeof(struct trie_node));
1870 free(rules->trie_nodes);
1871 rules->trie_nodes = NULL;
1872 rules->trie_nodes_cur = 0;
1873 rules->trie_nodes_max = 0;
1875 /* cleanup uid/gid cache */
1878 rules->uids_cur = 0;
1879 rules->uids_max = 0;
1882 rules->gids_cur = 0;
1883 rules->gids_max = 0;
1889 void udev_rules_unref(struct udev_rules *rules)
1893 free(rules->tokens);
1895 free(rules->trie_nodes);
1901 static int match_key(struct udev_rules *rules, struct token *token, const char *val)
1903 char *key_value = &rules->buf[token->key.value_off];
1910 switch (token->key.glob) {
1912 match = (strcmp(key_value, val) == 0);
1915 match = (fnmatch(key_value, val, 0) == 0);
1922 split = &rules->buf[token->key.value_off];
1927 next = strchr(split, '|');
1929 size_t matchlen = (size_t)(next - split);
1931 match = (matchlen == len && strncmp(split, val, matchlen) == 0);
1935 match = (strcmp(split, val) == 0);
1944 char value[UTIL_PATH_SIZE];
1946 util_strscpy(value, sizeof(value), &rules->buf[token->key.value_off]);
1948 while (key_value != NULL) {
1949 pos = strchr(key_value, '|');
1954 dbg(rules->udev, "match %s '%s' <-> '%s'\n", token_str(token->type), key_value, val);
1955 match = (fnmatch(key_value, val, 0) == 0);
1963 match = (val[0] != '\0');
1969 if (match && (token->key.op == OP_MATCH)) {
1970 dbg(rules->udev, "%s is true (matching value)\n", token_str(token->type));
1973 if (!match && (token->key.op == OP_NOMATCH)) {
1974 dbg(rules->udev, "%s is true (non-matching value)\n", token_str(token->type));
1977 dbg(rules->udev, "%s is not true\n", token_str(token->type));
1981 static int match_attr(struct udev_rules *rules, struct udev_device *dev, struct udev_event *event, struct token *cur)
1984 char nbuf[UTIL_NAME_SIZE];
1986 char vbuf[UTIL_NAME_SIZE];
1989 name = &rules->buf[cur->key.attr_off];
1990 switch (cur->key.attrsubst) {
1992 udev_event_apply_format(event, name, nbuf, sizeof(nbuf));
1996 value = udev_device_get_sysattr_value(dev, name);
2001 if (util_resolve_subsys_kernel(event->udev, name, vbuf, sizeof(vbuf), 1) != 0)
2009 /* remove trailing whitespace, if not asked to match for it */
2010 len = strlen(value);
2011 if (len > 0 && isspace(value[len-1])) {
2012 const char *key_value;
2015 key_value = &rules->buf[cur->key.value_off];
2016 klen = strlen(key_value);
2017 if (klen > 0 && !isspace(key_value[klen-1])) {
2018 if (value != vbuf) {
2019 util_strscpy(vbuf, sizeof(vbuf), value);
2022 while (len > 0 && isspace(vbuf[--len]))
2024 dbg(rules->udev, "removed trailing whitespace from '%s'\n", value);
2028 return match_key(rules, cur, value);
2037 int udev_rules_apply_to_event(struct udev_rules *rules, struct udev_event *event)
2041 enum escape_type esc = ESCAPE_UNSET;
2044 if (rules->tokens == NULL)
2047 can_set_name = ((strcmp(udev_device_get_action(event->dev), "remove") != 0) &&
2048 (major(udev_device_get_devnum(event->dev)) > 0 ||
2049 strcmp(udev_device_get_subsystem(event->dev), "net") == 0));
2051 /* loop through token list, match, run actions or forward to next rule */
2052 cur = &rules->tokens[0];
2055 dump_token(rules, cur);
2056 switch (cur->type) {
2060 /* possibly skip rules which want to set NAME, SYMLINK, OWNER, GROUP, MODE */
2061 if (!can_set_name && rule->rule.flags)
2066 if (match_key(rules, cur, udev_device_get_action(event->dev)) != 0)
2070 if (match_key(rules, cur, udev_device_get_devpath(event->dev)) != 0)
2074 if (match_key(rules, cur, udev_device_get_sysname(event->dev)) != 0)
2079 size_t devlen = strlen(udev_get_dev_path(event->udev))+1;
2080 struct udev_list_entry *list_entry;
2083 udev_list_entry_foreach(list_entry, udev_device_get_devlinks_list_entry(event->dev)) {
2084 const char *devlink;
2086 devlink = &udev_list_entry_get_name(list_entry)[devlen];
2087 if (match_key(rules, cur, devlink) == 0) {
2097 if (match_key(rules, cur, event->name) != 0)
2102 const char *key_name = &rules->buf[cur->key.attr_off];
2105 value = udev_device_get_property_value(event->dev, key_name);
2106 if (value == NULL) {
2107 dbg(event->udev, "ENV{%s} is not set, treat as empty\n", key_name);
2110 if (match_key(rules, cur, value))
2116 struct udev_list_entry *list_entry;
2119 udev_list_entry_foreach(list_entry, udev_device_get_tags_list_entry(event->dev)) {
2120 if (strcmp(&rules->buf[cur->key.value_off], udev_list_entry_get_name(list_entry)) == 0) {
2125 if (!match && (cur->key.op != OP_NOMATCH))
2129 case TK_M_SUBSYSTEM:
2130 if (match_key(rules, cur, udev_device_get_subsystem(event->dev)) != 0)
2134 if (match_key(rules, cur, udev_device_get_driver(event->dev)) != 0)
2139 char filename[UTIL_PATH_SIZE];
2142 udev_event_apply_format(event, &rules->buf[cur->key.value_off], filename, sizeof(filename));
2143 found = (wait_for_file(event->dev, filename, 10) == 0);
2144 if (!found && (cur->key.op != OP_NOMATCH))
2149 if (match_attr(rules, event->dev, event, cur) != 0)
2153 case TK_M_SUBSYSTEMS:
2159 /* get whole sequence of parent matches */
2161 while (next->type > TK_M_PARENTS_MIN && next->type < TK_M_PARENTS_MAX)
2164 /* loop over parents */
2165 event->dev_parent = event->dev;
2169 dbg(event->udev, "parent: '%s'\n", udev_device_get_syspath(event->dev_parent));
2170 /* loop over sequence of parent match keys */
2171 for (key = cur; key < next; key++ ) {
2172 dump_token(rules, key);
2175 if (match_key(rules, key, udev_device_get_sysname(event->dev_parent)) != 0)
2178 case TK_M_SUBSYSTEMS:
2179 if (match_key(rules, key, udev_device_get_subsystem(event->dev_parent)) != 0)
2183 if (match_key(rules, key, udev_device_get_driver(event->dev_parent)) != 0)
2187 if (match_attr(rules, event->dev_parent, event, key) != 0)
2193 dbg(event->udev, "parent key matched\n");
2195 dbg(event->udev, "all parent keys matched\n");
2196 /* all keys matched */
2200 event->dev_parent = udev_device_get_parent(event->dev_parent);
2201 if (event->dev_parent == NULL)
2204 /* move behind our sequence of parent match keys */
2210 char filename[UTIL_PATH_SIZE];
2211 struct stat statbuf;
2214 udev_event_apply_format(event, &rules->buf[cur->key.value_off], filename, sizeof(filename));
2215 if (util_resolve_subsys_kernel(event->udev, filename, filename, sizeof(filename), 0) != 0) {
2216 if (filename[0] != '/') {
2217 char tmp[UTIL_PATH_SIZE];
2219 util_strscpy(tmp, sizeof(tmp), filename);
2220 util_strscpyl(filename, sizeof(filename),
2221 udev_device_get_syspath(event->dev), "/", tmp, NULL);
2224 attr_subst_subdir(filename, sizeof(filename));
2226 match = (stat(filename, &statbuf) == 0);
2227 dbg(event->udev, "'%s' %s", filename, match ? "exists\n" : "does not exist\n");
2228 if (match && cur->key.mode > 0) {
2229 match = ((statbuf.st_mode & cur->key.mode) > 0);
2230 dbg(event->udev, "'%s' has mode=%#o and %s %#o\n", filename, statbuf.st_mode,
2231 match ? "matches" : "does not match", cur->key.mode);
2233 if (match && cur->key.op == OP_NOMATCH)
2235 if (!match && cur->key.op == OP_MATCH)
2241 char program[UTIL_PATH_SIZE];
2243 char result[UTIL_PATH_SIZE];
2245 free(event->program_result);
2246 event->program_result = NULL;
2247 udev_event_apply_format(event, &rules->buf[cur->key.value_off], program, sizeof(program));
2248 envp = udev_device_get_properties_envp(event->dev);
2249 info(event->udev, "PROGRAM '%s' %s:%u\n",
2251 &rules->buf[rule->rule.filename_off],
2252 rule->rule.filename_line);
2253 if (util_run_program(event->udev, program, envp, result, sizeof(result), NULL, NULL) != 0) {
2254 if (cur->key.op != OP_NOMATCH)
2259 util_remove_trailing_chars(result, '\n');
2260 if (esc == ESCAPE_UNSET || esc == ESCAPE_REPLACE) {
2261 count = udev_util_replace_chars(result, UDEV_ALLOWED_CHARS_INPUT);
2263 info(event->udev, "%i character(s) replaced\n" , count);
2265 event->program_result = strdup(result);
2266 dbg(event->udev, "storing result '%s'\n", event->program_result);
2267 if (cur->key.op == OP_NOMATCH)
2272 case TK_M_IMPORT_FILE:
2274 char import[UTIL_PATH_SIZE];
2276 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2277 if (import_file_into_properties(event->dev, import) != 0)
2278 if (cur->key.op != OP_NOMATCH)
2282 case TK_M_IMPORT_PROG:
2284 char import[UTIL_PATH_SIZE];
2286 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2287 info(event->udev, "IMPORT '%s' %s:%u\n",
2289 &rules->buf[rule->rule.filename_off],
2290 rule->rule.filename_line);
2291 if (import_program_into_properties(event->dev, import) != 0)
2292 if (cur->key.op != OP_NOMATCH)
2296 case TK_M_IMPORT_DB:
2298 const char *key = &rules->buf[cur->key.value_off];
2301 value = udev_device_get_property_value(event->dev_db, key);
2302 if (value != NULL) {
2303 struct udev_list_entry *entry;
2305 entry = udev_device_add_property(event->dev, key, value);
2306 udev_list_entry_set_flags(entry, 1);
2308 if (cur->key.op != OP_NOMATCH)
2313 case TK_M_IMPORT_PARENT:
2315 char import[UTIL_PATH_SIZE];
2317 udev_event_apply_format(event, &rules->buf[cur->key.value_off], import, sizeof(import));
2318 if (import_parent_into_properties(event->dev, import) != 0)
2319 if (cur->key.op != OP_NOMATCH)
2324 if (match_key(rules, cur, event->program_result) != 0)
2327 case TK_A_STRING_ESCAPE_NONE:
2330 case TK_A_STRING_ESCAPE_REPLACE:
2331 esc = ESCAPE_REPLACE;
2333 case TK_A_INOTIFY_WATCH:
2334 event->inotify_watch = cur->key.watch;
2336 case TK_A_DEVLINK_PRIO:
2337 udev_device_set_devlink_priority(event->dev, cur->key.devlink_prio);
2341 char owner[UTIL_NAME_SIZE];
2343 if (event->owner_final)
2345 if (cur->key.op == OP_ASSIGN_FINAL)
2346 event->owner_final = 1;
2347 udev_event_apply_format(event, &rules->buf[cur->key.value_off], owner, sizeof(owner));
2348 event->uid = util_lookup_user(event->udev, owner);
2349 info(event->udev, "OWNER %u %s:%u\n",
2351 &rules->buf[rule->rule.filename_off],
2352 rule->rule.filename_line);
2357 char group[UTIL_NAME_SIZE];
2359 if (event->group_final)
2361 if (cur->key.op == OP_ASSIGN_FINAL)
2362 event->group_final = 1;
2363 udev_event_apply_format(event, &rules->buf[cur->key.value_off], group, sizeof(group));
2364 event->gid = util_lookup_group(event->udev, group);
2365 info(event->udev, "GROUP %u %s:%u\n",
2367 &rules->buf[rule->rule.filename_off],
2368 rule->rule.filename_line);
2373 char mode[UTIL_NAME_SIZE];
2376 if (event->mode_final)
2378 if (cur->key.op == OP_ASSIGN_FINAL)
2379 event->mode_final = 1;
2380 udev_event_apply_format(event, &rules->buf[cur->key.value_off], mode, sizeof(mode));
2381 event->mode = strtol(mode, &endptr, 8);
2382 if (endptr[0] != '\0') {
2383 err(event->udev, "invalide mode '%s' set default mode 0660\n", mode);
2386 info(event->udev, "MODE %#o %s:%u\n",
2388 &rules->buf[rule->rule.filename_off],
2389 rule->rule.filename_line);
2393 if (event->owner_final)
2395 if (cur->key.op == OP_ASSIGN_FINAL)
2396 event->owner_final = 1;
2397 event->uid = cur->key.uid;
2398 info(event->udev, "OWNER %u %s:%u\n",
2400 &rules->buf[rule->rule.filename_off],
2401 rule->rule.filename_line);
2404 if (event->group_final)
2406 if (cur->key.op == OP_ASSIGN_FINAL)
2407 event->group_final = 1;
2408 event->gid = cur->key.gid;
2409 info(event->udev, "GROUP %u %s:%u\n",
2411 &rules->buf[rule->rule.filename_off],
2412 rule->rule.filename_line);
2415 if (event->mode_final)
2417 if (cur->key.op == OP_ASSIGN_FINAL)
2418 event->mode_final = 1;
2419 event->mode = cur->key.mode;
2420 info(event->udev, "MODE %#o %s:%u\n",
2422 &rules->buf[rule->rule.filename_off],
2423 rule->rule.filename_line);
2427 const char *name = &rules->buf[cur->key.attr_off];
2428 char *value = &rules->buf[cur->key.value_off];
2430 if (value[0] != '\0') {
2431 char temp_value[UTIL_NAME_SIZE];
2432 struct udev_list_entry *entry;
2434 udev_event_apply_format(event, value, temp_value, sizeof(temp_value));
2435 entry = udev_device_add_property(event->dev, name, temp_value);
2436 /* store in db, skip private keys */
2438 udev_list_entry_set_flags(entry, 1);
2440 udev_device_add_property(event->dev, name, NULL);
2445 if (cur->key.op == OP_ASSIGN || cur->key.op == OP_ASSIGN_FINAL)
2446 udev_device_cleanup_tags_list(event->dev);
2447 udev_device_add_tag(event->dev, &rules->buf[cur->key.value_off]);
2451 const char *name = &rules->buf[cur->key.value_off];
2452 char name_str[UTIL_PATH_SIZE];
2455 if (event->name_final)
2457 if (cur->key.op == OP_ASSIGN_FINAL)
2458 event->name_final = 1;
2459 udev_event_apply_format(event, name, name_str, sizeof(name_str));
2460 if (esc == ESCAPE_UNSET || esc == ESCAPE_REPLACE) {
2461 count = udev_util_replace_chars(name_str, "/");
2463 info(event->udev, "%i character(s) replaced\n", count);
2466 event->name = strdup(name_str);
2467 info(event->udev, "NAME '%s' %s:%u\n",
2469 &rules->buf[rule->rule.filename_off],
2470 rule->rule.filename_line);
2475 char temp[UTIL_PATH_SIZE];
2476 char filename[UTIL_PATH_SIZE];
2480 if (event->devlink_final)
2482 if (major(udev_device_get_devnum(event->dev)) == 0)
2484 if (cur->key.op == OP_ASSIGN_FINAL)
2485 event->devlink_final = 1;
2486 if (cur->key.op == OP_ASSIGN || cur->key.op == OP_ASSIGN_FINAL)
2487 udev_device_cleanup_devlinks_list(event->dev);
2489 /* allow multiple symlinks separated by spaces */
2490 udev_event_apply_format(event, &rules->buf[cur->key.value_off], temp, sizeof(temp));
2491 if (esc == ESCAPE_UNSET)
2492 count = udev_util_replace_chars(temp, "/ ");
2493 else if (esc == ESCAPE_REPLACE)
2494 count = udev_util_replace_chars(temp, "/");
2496 info(event->udev, "%i character(s) replaced\n" , count);
2497 dbg(event->udev, "rule applied, added symlink(s) '%s'\n", temp);
2499 while (isspace(pos[0]))
2501 next = strchr(pos, ' ');
2502 while (next != NULL) {
2504 info(event->udev, "LINK '%s' %s:%u\n", pos,
2505 &rules->buf[rule->rule.filename_off], rule->rule.filename_line);
2506 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(event->udev), "/", pos, NULL);
2507 udev_device_add_devlink(event->dev, filename, cur->key.devlink_unique);
2508 while (isspace(next[1]))
2511 next = strchr(pos, ' ');
2513 if (pos[0] != '\0') {
2514 info(event->udev, "LINK '%s' %s:%u\n", pos,
2515 &rules->buf[rule->rule.filename_off], rule->rule.filename_line);
2516 util_strscpyl(filename, sizeof(filename), udev_get_dev_path(event->udev), "/", pos, NULL);
2517 udev_device_add_devlink(event->dev, filename, cur->key.devlink_unique);
2521 case TK_A_EVENT_TIMEOUT:
2522 udev_device_set_event_timeout(event->dev, cur->key.event_timeout);
2526 const char *key_name = &rules->buf[cur->key.attr_off];
2527 char attr[UTIL_PATH_SIZE];
2528 char value[UTIL_NAME_SIZE];
2531 if (util_resolve_subsys_kernel(event->udev, key_name, attr, sizeof(attr), 0) != 0)
2532 util_strscpyl(attr, sizeof(attr), udev_device_get_syspath(event->dev), "/", key_name, NULL);
2533 attr_subst_subdir(attr, sizeof(attr));
2535 udev_event_apply_format(event, &rules->buf[cur->key.value_off], value, sizeof(value));
2536 info(event->udev, "ATTR '%s' writing '%s' %s:%u\n", attr, value,
2537 &rules->buf[rule->rule.filename_off],
2538 rule->rule.filename_line);
2539 f = fopen(attr, "w");
2541 if (fprintf(f, "%s", value) <= 0)
2542 err(event->udev, "error writing ATTR{%s}: %m\n", attr);
2545 err(event->udev, "error opening ATTR{%s} for writing: %m\n", attr);
2551 struct udev_list_entry *list_entry;
2553 if (cur->key.op == OP_ASSIGN || cur->key.op == OP_ASSIGN_FINAL)
2554 udev_list_cleanup_entries(event->udev, &event->run_list);
2555 info(event->udev, "RUN '%s' %s:%u\n",
2556 &rules->buf[cur->key.value_off],
2557 &rules->buf[rule->rule.filename_off],
2558 rule->rule.filename_line);
2559 list_entry = udev_list_entry_add(event->udev, &event->run_list,
2560 &rules->buf[cur->key.value_off], NULL, 1, 0);
2561 if (cur->key.fail_on_error)
2562 udev_list_entry_set_flags(list_entry, 1);
2566 if (cur->key.rule_goto == 0)
2568 cur = &rules->tokens[cur->key.rule_goto];
2573 case TK_M_PARENTS_MIN:
2574 case TK_M_PARENTS_MAX:
2577 err(rules->udev, "wrong type %u\n", cur->type);
2584 /* fast-forward to next rule */
2585 cur = rule + rule->rule.token_count;
2586 dbg(rules->udev, "forward to rule: %u\n",
2587 (unsigned int) (cur - rules->tokens));