chiark / gitweb /
03b3f2a1165de1910354677eb9522047b7f49bf6
[elogind.git] / udev_rules.c
1 /*
2  * udev_rules.c
3  *
4  * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
5  * Copyright (C) 2003-2006 Kay Sievers <kay.sievers@vrfy.org>
6  *
7  *      This program is free software; you can redistribute it and/or modify it
8  *      under the terms of the GNU General Public License as published by the
9  *      Free Software Foundation version 2 of the License.
10  *
11  *      This program is distributed in the hope that it will be useful, but
12  *      WITHOUT ANY WARRANTY; without even the implied warranty of
13  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *      General Public License for more details.
15  *
16  *      You should have received a copy of the GNU General Public License along
17  *      with this program; if not, write to the Free Software Foundation, Inc.,
18  *      675 Mass Ave, Cambridge, MA 02139, USA.
19  *
20  */
21
22 #include <stddef.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <stdio.h>
26 #include <fcntl.h>
27 #include <ctype.h>
28 #include <unistd.h>
29 #include <errno.h>
30 #include <syslog.h>
31 #include <sys/wait.h>
32 #include <sys/stat.h>
33
34 #include "udev.h"
35 #include "udev_rules.h"
36
37
38 /* extract possible {attr} and move str behind it */
39 static char *get_format_attribute(char **str)
40 {
41         char *pos;
42         char *attr = NULL;
43
44         if (*str[0] == '{') {
45                 pos = strchr(*str, '}');
46                 if (pos == NULL) {
47                         err("missing closing brace for format");
48                         return NULL;
49                 }
50                 pos[0] = '\0';
51                 attr = *str+1;
52                 *str = pos+1;
53                 dbg("attribute='%s', str='%s'", attr, *str);
54         }
55         return attr;
56 }
57
58 /* extract possible format length and move str behind it*/
59 static int get_format_len(char **str)
60 {
61         int num;
62         char *tail;
63
64         if (isdigit(*str[0])) {
65                 num = (int) strtoul(*str, &tail, 10);
66                 if (num > 0) {
67                         *str = tail;
68                         dbg("format length=%i", num);
69                         return num;
70                 } else {
71                         err("format parsing error '%s'", *str);
72                 }
73         }
74         return -1;
75 }
76
77 static int get_key(char **line, char **key, char **value)
78 {
79         char *linepos;
80         char *temp;
81
82         linepos = *line;
83         if (!linepos)
84                 return -1;
85
86         if (strchr(linepos, '\\')) {
87                 dbg("escaped characters are not supported, skip");
88                 return -1;
89         }
90
91         /* skip whitespace */
92         while (isspace(linepos[0]))
93                 linepos++;
94
95         /* get the key */
96         *key = linepos;
97         while (1) {
98                 linepos++;
99                 if (linepos[0] == '\0')
100                         return -1;
101                 if (isspace(linepos[0]))
102                         break;
103                 if (linepos[0] == '=')
104                         break;
105         }
106
107         /* terminate key */
108         linepos[0] = '\0';
109         linepos++;
110
111         /* skip whitespace */
112         while (isspace(linepos[0]))
113                 linepos++;
114
115         /* get the value*/
116         if (linepos[0] == '"') {
117                 linepos++;
118                 temp = strchr(linepos, '"');
119                 if (!temp) {
120                         dbg("missing closing quote");
121                         return -1;
122                 }
123                 dbg("value is quoted");
124                 temp[0] = '\0';
125         } else if (linepos[0] == '\'') {
126                 linepos++;
127                 temp = strchr(linepos, '\'');
128                 if (!temp) {
129                         dbg("missing closing quote");
130                         return -1;
131                 }
132                 dbg("value is quoted");
133                 temp[0] = '\0';
134         } else if (linepos[0] == '\0') {
135                 dbg("value is empty");
136         } else {
137                 temp = linepos;
138                 while (temp[0] && !isspace(temp[0]))
139                         temp++;
140                 temp[0] = '\0';
141         }
142         *value = linepos;
143
144         return 0;
145 }
146
147 static int import_keys_into_env(struct udevice *udev, const char *buf, size_t bufsize)
148 {
149         char line[LINE_SIZE];
150         const char *bufline;
151         char *linepos;
152         char *variable;
153         char *value;
154         size_t cur;
155         size_t count;
156         int lineno;
157
158         /* loop through the whole buffer */
159         lineno = 0;
160         cur = 0;
161         while (cur < bufsize) {
162                 count = buf_get_line(buf, bufsize, cur);
163                 bufline = &buf[cur];
164                 cur += count+1;
165                 lineno++;
166
167                 if (count >= sizeof(line)) {
168                         err("line too long, conf line skipped %s, line %d", udev_config_filename, lineno);
169                         continue;
170                 }
171
172                 /* eat the whitespace */
173                 while ((count > 0) && isspace(bufline[0])) {
174                         bufline++;
175                         count--;
176                 }
177                 if (count == 0)
178                         continue;
179
180                 /* see if this is a comment */
181                 if (bufline[0] == COMMENT_CHARACTER)
182                         continue;
183
184                 memcpy(line, bufline, count);
185                 line[count] = '\0';
186
187                 linepos = line;
188                 if (get_key(&linepos, &variable, &value) == 0) {
189                         dbg("import '%s=%s'", variable, value);
190                         name_list_key_add(&udev->env_list, variable, value);
191                         setenv(variable, value, 1);
192                 }
193         }
194
195         return 0;
196 }
197
198 static int import_file_into_env(struct udevice *udev, const char *filename)
199 {
200         char *buf;
201         size_t bufsize;
202
203         if (file_map(filename, &buf, &bufsize) != 0) {
204                 err("can't open '%s': %s", filename, strerror(errno));
205                 return -1;
206         }
207         import_keys_into_env(udev, buf, bufsize);
208         file_unmap(buf, bufsize);
209
210         return 0;
211 }
212
213 static int import_program_into_env(struct udevice *udev, const char *program)
214 {
215         char result[1024];
216         size_t reslen;
217
218         if (run_program(program, udev->dev->subsystem, result, sizeof(result), &reslen, (udev_log_priority >= LOG_INFO)) != 0)
219                 return -1;
220         return import_keys_into_env(udev, result, reslen);
221 }
222
223 static int import_parent_into_env(struct udevice *udev, const char *filter)
224 {
225         struct sysfs_device *dev_parent;
226         int rc = -1;
227
228         dev_parent = sysfs_device_get_parent(udev->dev);
229         if (dev_parent != NULL) {
230                 struct udevice *udev_parent;
231                 struct name_entry *name_loop;
232
233                 dbg("found parent '%s', get the node name", dev_parent->devpath);
234                 udev_parent = udev_device_init();
235                 if (udev_parent == NULL)
236                         return -1;
237                 /* import the udev_db of the parent */
238                 if (udev_db_get_device(udev_parent, dev_parent->devpath) == 0) {
239                         dbg("import stored parent env '%s'", udev_parent->name);
240                         list_for_each_entry(name_loop, &udev_parent->env_list, node) {
241                                 char name[NAME_SIZE];
242                                 char *pos;
243
244                                 strlcpy(name, name_loop->name, sizeof(name));
245                                 pos = strchr(name, '=');
246                                 if (pos) {
247                                         pos[0] = '\0';
248                                         pos++;
249                                         if (strcmp_pattern(filter, name) == 0) {
250                                                 dbg("import key '%s'", name_loop->name);
251                                                 name_list_add(&udev->env_list, name_loop->name, 0);
252                                                 setenv(name, pos, 1);
253                                         } else
254                                                 dbg("skip key '%s'", name_loop->name);
255                                 }
256                         }
257                         rc = 0;
258                 } else
259                         dbg("parent not found in database");
260                 udev_device_cleanup(udev_parent);
261         }
262
263         return rc;
264 }
265
266 static int match_name_and_get_number(const char *base, const char *devname)
267 {
268         size_t baselen;
269         char *endptr;
270         int num;
271
272         baselen = strlen(base);
273         if (strncmp(base, devname, baselen) != 0)
274                 return -1;
275         if (devname[baselen] == '\0')
276                 return 0;
277         if (!isdigit(devname[baselen]))
278                 return -1;
279         num = strtoul(&devname[baselen], &endptr, 10);
280         if (endptr[0] != '\0')
281                 return -1;
282         return num;
283 }
284
285 /* finds the lowest positive device number such that <name>N isn't present in the udevdb
286  * if <name> doesn't exist, 0 is returned, N otherwise */
287 static int find_free_number(const char *base, const char *devpath)
288 {
289         char db_devpath[PATH_SIZE];
290         char filename[PATH_SIZE];
291         struct udevice *udev_db;
292         int num = 0;
293         static int warn = 1;
294
295         if (warn) {
296                 err("%%e is deprecated, will be removed and is unlikely to work correctly. Don't use it.");
297                 warn = 0;
298         }
299
300         /* check if the device already owns a matching name */
301         udev_db = udev_device_init();
302         if (udev_db == NULL)
303                 return -1;
304         if (udev_db_get_device(udev_db, devpath) == 0) {
305                 struct name_entry *name_loop;
306                 int devnum;
307
308                 devnum = match_name_and_get_number(base, udev_db->name);
309                 if (devnum >= 0) {
310                         num = devnum;
311                         dbg("device '%s', already has the node '%s' with num %u, use it", devpath, base, num);
312                         goto out;
313                 }
314                 list_for_each_entry(name_loop, &udev_db->symlink_list, node) {
315                         devnum = match_name_and_get_number(base, name_loop->name);
316                         if (devnum >= 0) {
317                                 num = devnum;
318                                 dbg("device '%s', already has a symlink '%s' with num %u, use it", devpath, base, num);
319                                 goto out;
320                         }
321                 }
322         }
323
324         /* just search the database again and again until a free name is found */
325         strlcpy(filename, base, sizeof(filename));
326         while (1) {
327                 dbg("look for existing node '%s'", filename);
328                 if (udev_db_lookup_name(filename, db_devpath, sizeof(db_devpath)) != 0) {
329                         dbg("free num=%d", num);
330                         break;
331                 }
332
333                 num++;
334                 if (num > 100000) {
335                         err("find_free_number aborted at num=%d", num);
336                         num = -1;
337                         break;
338                 }
339                 snprintf(filename, sizeof(filename), "%s%d", base, num);
340                 filename[sizeof(filename)-1] = '\0';
341         }
342
343 out:
344         udev_device_cleanup(udev_db);
345         return num;
346 }
347
348 #define WAIT_LOOP_PER_SECOND            50
349 static int wait_for_sysfs(struct udevice *udev, const char *file, int timeout)
350 {
351         char devicepath[PATH_SIZE];
352         char filepath[PATH_SIZE];
353         struct stat stats;
354         int loop = timeout * WAIT_LOOP_PER_SECOND;
355
356         strlcpy(devicepath, sysfs_path, sizeof(devicepath));
357         strlcat(devicepath, udev->dev->devpath, sizeof(devicepath));
358         strlcpy(filepath, devicepath, sizeof(filepath));
359         strlcat(filepath, "/", sizeof(filepath));
360         strlcat(filepath, file, sizeof(filepath));
361
362         dbg("will wait %i sec for '%s'", timeout, filepath);
363         while (--loop) {
364                 /* lookup file */
365                 if (stat(filepath, &stats) == 0) {
366                         info("file '%s' appeared after %i loops", filepath, (timeout * WAIT_LOOP_PER_SECOND) - loop-1);
367                         return 0;
368                 }
369                 /* make sure the device does not have disappeared in the meantime */
370                 if (stat(devicepath, &stats) != 0) {
371                         info("device disappeared while waiting for '%s'", filepath);
372                         return -2;
373                 }
374                 info("wait for '%s' for %i mseconds", filepath, 1000 / WAIT_LOOP_PER_SECOND);
375                 usleep(1000 * 1000 / WAIT_LOOP_PER_SECOND);
376         }
377         err("waiting for '%s' failed", filepath);
378         return -1;
379 }
380
381 void udev_rules_apply_format(struct udevice *udev, char *string, size_t maxsize)
382 {
383         char temp[PATH_SIZE];
384         char temp2[PATH_SIZE];
385         char *head, *tail, *pos, *cpos, *attr, *rest;
386         int len;
387         int i;
388         int count;
389         unsigned int next_free_number;
390         enum subst_type {
391                 SUBST_UNKNOWN,
392                 SUBST_DEVPATH,
393                 SUBST_KERNEL_NUMBER,
394                 SUBST_KERNEL_NAME,
395                 SUBST_ID,
396                 SUBST_MAJOR,
397                 SUBST_MINOR,
398                 SUBST_RESULT,
399                 SUBST_SYSFS,
400                 SUBST_ENUM,
401                 SUBST_PARENT,
402                 SUBST_TEMP_NODE,
403                 SUBST_ROOT,
404                 SUBST_ENV,
405         };
406         static const struct subst_map {
407                 char *name;
408                 char fmt;
409                 enum subst_type type;
410         } map[] = {
411                 { .name = "devpath",            .fmt = 'p',     .type = SUBST_DEVPATH },
412                 { .name = "number",             .fmt = 'n',     .type = SUBST_KERNEL_NUMBER },
413                 { .name = "kernel",             .fmt = 'k',     .type = SUBST_KERNEL_NAME },
414                 { .name = "id",                 .fmt = 'b',     .type = SUBST_ID },
415                 { .name = "major",              .fmt = 'M',     .type = SUBST_MAJOR },
416                 { .name = "minor",              .fmt = 'm',     .type = SUBST_MINOR },
417                 { .name = "result",             .fmt = 'c',     .type = SUBST_RESULT },
418                 { .name = "sysfs",              .fmt = 's',     .type = SUBST_SYSFS },
419                 { .name = "enum",               .fmt = 'e',     .type = SUBST_ENUM },
420                 { .name = "parent",             .fmt = 'P',     .type = SUBST_PARENT },
421                 { .name = "tempnode",           .fmt = 'N',     .type = SUBST_TEMP_NODE },
422                 { .name = "root",               .fmt = 'r',     .type = SUBST_ROOT },
423                 { .name = "env",                .fmt = 'E',     .type = SUBST_ENV },
424                 { NULL, '\0', 0 }
425         };
426         enum subst_type type;
427         const struct subst_map *subst;
428
429         head = string;
430         while (1) {
431                 len = -1;
432                 while (head[0] != '\0') {
433                         if (head[0] == '$') {
434                                 /* substitute named variable */
435                                 if (head[1] == '\0')
436                                         break;
437                                 if (head[1] == '$') {
438                                         strlcpy(temp, head+2, sizeof(temp));
439                                         strlcpy(head+1, temp, maxsize);
440                                         head++;
441                                         continue;
442                                 }
443                                 head[0] = '\0';
444                                 for (subst = map; subst->name; subst++) {
445                                         if (strncasecmp(&head[1], subst->name, strlen(subst->name)) == 0) {
446                                                 type = subst->type;
447                                                 tail = head + strlen(subst->name)+1;
448                                                 dbg("will substitute format name '%s'", subst->name);
449                                                 goto found;
450                                         }
451                                 }
452                         } else if (head[0] == '%') {
453                                 /* substitute format char */
454                                 if (head[1] == '\0')
455                                         break;
456                                 if (head[1] == '%') {
457                                         strlcpy(temp, head+2, sizeof(temp));
458                                         strlcpy(head+1, temp, maxsize);
459                                         head++;
460                                         continue;
461                                 }
462                                 head[0] = '\0';
463                                 tail = head+1;
464                                 len = get_format_len(&tail);
465                                 for (subst = map; subst->name; subst++) {
466                                         if (tail[0] == subst->fmt) {
467                                                 type = subst->type;
468                                                 tail++;
469                                                 dbg("will substitute format char '%c'", subst->fmt);
470                                                 goto found;
471                                         }
472                                 }
473                         }
474                         head++;
475                 }
476                 break;
477 found:
478                 attr = get_format_attribute(&tail);
479                 strlcpy(temp, tail, sizeof(temp));
480                 dbg("format=%i, string='%s', tail='%s'", type ,string, tail);
481
482                 switch (type) {
483                 case SUBST_DEVPATH:
484                         strlcat(string, udev->dev->devpath, maxsize);
485                         dbg("substitute devpath '%s'", udev->dev->devpath);
486                         break;
487                 case SUBST_KERNEL_NAME:
488                         strlcat(string, udev->dev->kernel_name, maxsize);
489                         dbg("substitute kernel name '%s'", udev->dev->kernel_name);
490                         break;
491                 case SUBST_KERNEL_NUMBER:
492                         strlcat(string, udev->dev->kernel_number, maxsize);
493                         dbg("substitute kernel number '%s'", udev->dev->kernel_number);
494                         break;
495                 case SUBST_ID:
496                         if (udev->dev_parent != NULL) {
497                                 strlcat(string, udev->dev_parent->kernel_name, maxsize);
498                                 dbg("substitute id '%s'", udev->dev_parent->kernel_name);
499                         }
500                         break;
501                 case SUBST_MAJOR:
502                         sprintf(temp2, "%d", major(udev->devt));
503                         strlcat(string, temp2, maxsize);
504                         dbg("substitute major number '%s'", temp2);
505                         break;
506                 case SUBST_MINOR:
507                         sprintf(temp2, "%d", minor(udev->devt));
508                         strlcat(string, temp2, maxsize);
509                         dbg("substitute minor number '%s'", temp2);
510                         break;
511                 case SUBST_RESULT:
512                         if (udev->program_result[0] == '\0')
513                                 break;
514                         /* get part part of the result string */
515                         i = 0;
516                         if (attr != NULL)
517                                 i = strtoul(attr, &rest, 10);
518                         if (i > 0) {
519                                 dbg("request part #%d of result string", i);
520                                 cpos = udev->program_result;
521                                 while (--i) {
522                                         while (cpos[0] != '\0' && !isspace(cpos[0]))
523                                                 cpos++;
524                                         while (isspace(cpos[0]))
525                                                 cpos++;
526                                 }
527                                 if (i > 0) {
528                                         err("requested part of result string not found");
529                                         break;
530                                 }
531                                 strlcpy(temp2, cpos, sizeof(temp2));
532                                 /* %{2+}c copies the whole string from the second part on */
533                                 if (rest[0] != '+') {
534                                         cpos = strchr(temp2, ' ');
535                                         if (cpos)
536                                                 cpos[0] = '\0';
537                                 }
538                                 strlcat(string, temp2, maxsize);
539                                 dbg("substitute part of result string '%s'", temp2);
540                         } else {
541                                 strlcat(string, udev->program_result, maxsize);
542                                 dbg("substitute result string '%s'", udev->program_result);
543                         }
544                         break;
545                 case SUBST_SYSFS:
546                         if (attr == NULL) {
547                                 dbg("missing attribute");
548                                 break;
549                         } else {
550                                 struct sysfs_device *dev_parent;
551                                 const char *value;
552
553                                 dev_parent = udev->dev;
554                                 do {
555                                         dbg("looking at '%s'", dev_parent->devpath);
556                                         value = sysfs_attr_get_value(dev_parent->devpath, attr);
557                                         if (value != NULL) {
558                                                 strlcpy(temp2, value, sizeof(temp2));
559                                                 break;
560                                         }
561                                         dev_parent = sysfs_device_get_parent(dev_parent);
562                                 } while (dev_parent != NULL);
563
564                                 /* strip trailing whitespace of sysfs value */
565                                 i = strlen(temp2);
566                                 while (i > 0 && isspace(temp2[i-1]))
567                                         temp2[--i] = '\0';
568                                 count = replace_untrusted_chars(temp2);
569                                 if (count)
570                                         info("%i untrusted character(s) replaced" , count);
571                                 strlcat(string, temp2, maxsize);
572                                 dbg("substitute sysfs value '%s'", temp2);
573                         }
574                         break;
575                 case SUBST_ENUM:
576                         next_free_number = find_free_number(string, udev->dev->devpath);
577                         if (next_free_number > 0) {
578                                 sprintf(temp2, "%d", next_free_number);
579                                 strlcat(string, temp2, maxsize);
580                         }
581                         break;
582                 case SUBST_PARENT:
583                         {
584                                 struct sysfs_device *dev_parent;
585
586                                 dev_parent = sysfs_device_get_parent(udev->dev);
587                                 if (dev_parent != NULL) {
588                                         struct udevice *udev_parent;
589
590                                         dbg("found parent '%s', get the node name", dev_parent->devpath);
591                                         udev_parent = udev_device_init();
592                                         if (udev_parent != NULL) {
593                                                 /* lookup the name in the udev_db with the DEVPATH of the parent */
594                                                 if (udev_db_get_device(udev_parent, dev_parent->devpath) == 0) {
595                                                         strlcat(string, udev_parent->name, maxsize);
596                                                         dbg("substitute parent node name'%s'", udev_parent->name);
597                                                 } else
598                                                         dbg("parent not found in database");
599                                                 udev_device_cleanup(udev_parent);
600                                         }
601                                 }
602                         }
603                         break;
604                 case SUBST_TEMP_NODE:
605                         if (udev->tmp_node[0] == '\0') {
606                                 dbg("create temporary device node for callout");
607                                 snprintf(udev->tmp_node, sizeof(udev->tmp_node), "%s/.tmp-%u-%u",
608                                          udev_root, major(udev->devt), minor(udev->devt));
609                                 udev->tmp_node[sizeof(udev->tmp_node)-1] = '\0';
610                                 udev_node_mknod(udev, udev->tmp_node, udev->devt, 0600, 0, 0);
611                         }
612                         strlcat(string, udev->tmp_node, maxsize);
613                         dbg("substitute temporary device node name '%s'", udev->tmp_node);
614                         break;
615                 case SUBST_ROOT:
616                         strlcat(string, udev_root, maxsize);
617                         dbg("substitute udev_root '%s'", udev_root);
618                         break;
619                 case SUBST_ENV:
620                         if (attr == NULL) {
621                                 dbg("missing attribute");
622                                 break;
623                         }
624                         pos = getenv(attr);
625                         if (pos == NULL) {
626                                 dbg("env '%s' not available", attr);
627                                 break;
628                         }
629                         dbg("substitute env '%s=%s'", attr, pos);
630                         strlcat(string, pos, maxsize);
631                         break;
632                 default:
633                         err("unknown substitution type=%i", type);
634                         break;
635                 }
636                 /* possibly truncate to format-char specified length */
637                 if (len != -1) {
638                         head[len] = '\0';
639                         dbg("truncate to %i chars, subtitution string becomes '%s'", len, head);
640                 }
641                 strlcat(string, temp, maxsize);
642         }
643 }
644
645 static char *key_val(struct udev_rule *rule, struct key *key)
646 {
647         return rule->buf + key->val_off;
648 }
649
650 static char *key_pair_name(struct udev_rule *rule, struct key_pair *pair)
651 {
652         return rule->buf + pair->key_name_off;
653 }
654
655 static int match_key(const char *key_name, struct udev_rule *rule, struct key *key, const char *val)
656 {
657         int match;
658         char value[PATH_SIZE];
659         char *key_value;
660         char *pos;
661
662         if (key->operation != KEY_OP_MATCH &&
663             key->operation != KEY_OP_NOMATCH)
664                 return 0;
665
666         strlcpy(value, rule->buf + key->val_off, sizeof(value));
667         key_value = value;
668
669         dbg("key %s value='%s'", key_name, key_value);
670         while (key_value) {
671                 pos = strchr(key_value, '|');
672                 if (pos) {
673                         pos[0] = '\0';
674                         pos++;
675                 }
676                 dbg("match %s '%s' <-> '%s'", key_name, key_value, val);
677                 match = (strcmp_pattern(key_value, val) == 0);
678                 if (match && (key->operation != KEY_OP_NOMATCH)) {
679                         dbg("%s is true (matching value)", key_name);
680                         return 0;
681                 }
682                 if (!match && (key->operation == KEY_OP_NOMATCH)) {
683                         dbg("%s is true (non-matching value)", key_name);
684                         return 0;
685                 }
686                 key_value = pos;
687         }
688         dbg("%s is false", key_name);
689         return -1;
690 }
691
692 /* match a single rule against a given device and possibly its parent devices */
693 static int match_rule(struct udevice *udev, struct udev_rule *rule)
694 {
695         int i;
696
697         if (match_key("ACTION", rule, &rule->action, udev->action))
698                 goto nomatch;
699
700         if (match_key("KERNEL", rule, &rule->kernel_name, udev->dev->kernel_name))
701                 goto nomatch;
702
703         if (match_key("SUBSYSTEM", rule, &rule->subsystem, udev->dev->subsystem))
704                 goto nomatch;
705
706         if (match_key("DEVPATH", rule, &rule->devpath, udev->dev->devpath))
707                 goto nomatch;
708
709         /* compare NAME against a previously assigned value */
710         if (match_key("NAME", rule, &rule->name, udev->name))
711                 goto nomatch;
712
713         for (i = 0; i < rule->env.count; i++) {
714                 struct key_pair *pair = &rule->env.keys[i];
715
716                 /* we only check for matches, assignments will be handled later */
717                 if (pair->key.operation == KEY_OP_MATCH ||
718                     pair->key.operation == KEY_OP_NOMATCH) {
719                         const char *key_name = key_pair_name(rule, pair);
720                         const char *value = getenv(key_name);
721
722                         if (!value) {
723                                 dbg("ENV{'%s'} is not set, treat as empty", key_name);
724                                 value = "";
725                         }
726                         if (match_key("ENV", rule, &pair->key, value))
727                                 goto nomatch;
728                 }
729         }
730
731         if (rule->wait_for_sysfs.operation != KEY_OP_UNSET) {
732                 int found;
733
734                 found = (wait_for_sysfs(udev, key_val(rule, &rule->wait_for_sysfs), 3) == 0);
735                 if (!found && (rule->wait_for_sysfs.operation != KEY_OP_NOMATCH)) {
736                         dbg("WAIT_FOR_SYSFS failed");
737                         goto nomatch;
738                 }
739         }
740
741         /* walk up the chain of parent devices and find a match */
742         udev->dev_parent = udev->dev;
743         while (1) {
744                 /* check for matching driver */
745                 if (match_key("DRIVER", rule, &rule->driver, udev->dev_parent->driver))
746                         goto try_parent;
747
748                 /* check for matching subsystem/bus value */
749                 if (match_key("BUS", rule, &rule->bus, udev->dev_parent->subsystem))
750                         goto try_parent;
751
752                 /* check for matching bus id (device name) */
753                 if (match_key("ID", rule, &rule->id, udev->dev_parent->kernel_name))
754                         goto try_parent;
755
756                 /* check for matching sysfs pairs */
757                 if (rule->sysfs.count) {
758                         dbg("check %i SYSFS keys", rule->sysfs.count);
759                         for (i = 0; i < rule->sysfs.count; i++) {
760                                 struct key_pair *pair = &rule->sysfs.keys[i];
761                                 const char *key_name = key_pair_name(rule, pair);
762                                 const char *key_value = key_val(rule, &pair->key);
763                                 const char *value;
764                                 char val[VALUE_SIZE];
765                                 size_t len;
766
767                                 value = sysfs_attr_get_value(udev->dev_parent->devpath, key_name);
768                                 if (value == NULL)
769                                         value = sysfs_attr_get_value(udev->dev->devpath, key_name);
770                                 if (value == NULL)
771                                         goto try_parent;
772                                 strlcpy(val, value, sizeof(val));
773
774                                 /* strip trailing whitespace of value, if not asked to match for it */
775                                 len = strlen(key_value);
776                                 if (len > 0 && !isspace(key_value[len-1])) {
777                                         len = strlen(val);
778                                         while (len > 0 && isspace(val[len-1]))
779                                                 val[--len] = '\0';
780                                         dbg("removed %zi trailing whitespace chars from '%s'", strlen(val)-len, val);
781                                 }
782
783                                 if (match_key("SYSFS", rule, &pair->key, val))
784                                         goto try_parent;
785                         }
786                         dbg("all %i SYSFS keys matched", rule->sysfs.count);
787                 }
788
789                 /* found matching device  */
790                 break;
791 try_parent:
792                 /* move to parent device */
793                 dbg("try parent sysfs device");
794                 udev->dev_parent = sysfs_device_get_parent(udev->dev_parent);
795                 if (udev->dev_parent == NULL)
796                         goto nomatch;
797                 dbg("looking at dev_parent->devpath='%s'", udev->dev_parent->devpath);
798                 dbg("looking at dev_parent->bus_kernel_name='%s'", udev->dev_parent->kernel_name);
799         }
800
801         /* execute external program */
802         if (rule->program.operation != KEY_OP_UNSET) {
803                 char program[PATH_SIZE];
804                 char result[PATH_SIZE];
805
806                 strlcpy(program, key_val(rule, &rule->program), sizeof(program));
807                 udev_rules_apply_format(udev, program, sizeof(program));
808                 if (run_program(program, udev->dev->subsystem, result, sizeof(result), NULL, (udev_log_priority >= LOG_INFO)) != 0) {
809                         dbg("PROGRAM is false");
810                         udev->program_result[0] = '\0';
811                         if (rule->program.operation != KEY_OP_NOMATCH)
812                                 goto nomatch;
813                 } else {
814                         int count;
815
816                         dbg("PROGRAM matches");
817                         remove_trailing_chars(result, '\n');
818                         count = replace_untrusted_chars(result);
819                         if (count)
820                                 info("%i untrusted character(s) replaced" , count);
821                         dbg("result is '%s'", result);
822                         strlcpy(udev->program_result, result, sizeof(udev->program_result));
823                         dbg("PROGRAM returned successful");
824                         if (rule->program.operation == KEY_OP_NOMATCH)
825                                 goto nomatch;
826                 }
827                 dbg("PROGRAM key is true");
828         }
829
830         /* check for matching result of external program */
831         if (match_key("RESULT", rule, &rule->result, udev->program_result))
832                 goto nomatch;
833
834         /* import variables returned from program or or file into environment */
835         if (rule->import.operation != KEY_OP_UNSET) {
836                 char import[PATH_SIZE];
837                 int rc = -1;
838
839                 strlcpy(import, key_val(rule, &rule->import), sizeof(import));
840                 udev_rules_apply_format(udev, import, sizeof(import));
841                 dbg("check for IMPORT import='%s'", import);
842                 if (rule->import_type == IMPORT_PROGRAM) {
843                         rc = import_program_into_env(udev, import);
844                 } else if (rule->import_type == IMPORT_FILE) {
845                         dbg("import file import='%s'", import);
846                         rc = import_file_into_env(udev, import);
847                 } else if (rule->import_type == IMPORT_PARENT) {
848                         dbg("import parent import='%s'", import);
849                         rc = import_parent_into_env(udev, import);
850                 }
851                 if (rc != 0) {
852                         dbg("IMPORT failed");
853                         if (rule->import.operation != KEY_OP_NOMATCH)
854                                 goto nomatch;
855                 } else
856                         dbg("IMPORT '%s' imported", key_val(rule, &rule->import));
857                 dbg("IMPORT key is true");
858         }
859
860         /* rule matches, if we have ENV assignments export it */
861         for (i = 0; i < rule->env.count; i++) {
862                 struct key_pair *pair = &rule->env.keys[i];
863
864                 if (pair->key.operation == KEY_OP_ASSIGN) {
865                         const char *key_name = key_pair_name(rule, pair);
866                         const char *value = key_val(rule, &pair->key);
867                         char *key_value = name_list_key_add(&udev->env_list, key_name, value);
868                         if (key_value == NULL)
869                                 break;
870
871                         udev_rules_apply_format(udev, key_value, NAME_SIZE);
872                         putenv(key_value);
873                         dbg("export ENV '%s'", key_value);
874                 }
875         }
876
877         return 0;
878
879 nomatch:
880         return -1;
881 }
882
883 int udev_rules_get_name(struct udev_rules *rules, struct udevice *udev)
884 {
885         struct udev_rule *rule;
886         int name_set = 0;
887
888         dbg("udev->dev->devpath='%s'", udev->dev->devpath);
889         dbg("udev->dev->kernel_name='%s'", udev->dev->kernel_name);
890
891         /* look for a matching rule to apply */
892         udev_rules_iter_init(rules);
893         while (1) {
894                 rule = udev_rules_iter_next(rules);
895                 if (rule == NULL)
896                         break;
897
898                 if (name_set &&
899                     (rule->name.operation == KEY_OP_ASSIGN ||
900                      rule->name.operation == KEY_OP_ASSIGN_FINAL ||
901                      rule->name.operation == KEY_OP_ADD)) {
902                         dbg("node name already set, rule ignored");
903                         continue;
904                 }
905
906                 dbg("process rule");
907                 if (match_rule(udev, rule) == 0) {
908                         /* apply options */
909                         if (rule->ignore_device) {
910                                 info("rule applied, '%s' is ignored", udev->dev->kernel_name);
911                                 udev->ignore_device = 1;
912                                 return 0;
913                         }
914                         if (rule->ignore_remove) {
915                                 udev->ignore_remove = 1;
916                                 dbg("remove event should be ignored");
917                         }
918                         /* apply all_partitions option only at a main block device */
919                         if (rule->partitions &&
920                             strcmp(udev->dev->subsystem, "block") == 0 && udev->dev->kernel_number[0] == '\0') {
921                                 udev->partitions = rule->partitions;
922                                 dbg("creation of partition nodes requested");
923                         }
924
925                         /* apply permissions */
926                         if (!udev->mode_final && rule->mode != 0000) {
927                                 if (rule->mode_operation == KEY_OP_ASSIGN_FINAL)
928                                         udev->mode_final = 1;
929                                 udev->mode = rule->mode;
930                                 dbg("applied mode=%#o to '%s'", rule->mode, udev->dev->kernel_name);
931                         }
932                         if (!udev->owner_final && rule->owner.operation != KEY_OP_UNSET) {
933                                 if (rule->owner.operation == KEY_OP_ASSIGN_FINAL)
934                                         udev->owner_final = 1;
935                                 strlcpy(udev->owner, key_val(rule, &rule->owner), sizeof(udev->owner));
936                                 udev_rules_apply_format(udev, udev->owner, sizeof(udev->owner));
937                                 dbg("applied owner='%s' to '%s'", udev->owner, udev->dev->kernel_name);
938                         }
939                         if (!udev->group_final && rule->group.operation != KEY_OP_UNSET) {
940                                 if (rule->group.operation == KEY_OP_ASSIGN_FINAL)
941                                         udev->group_final = 1;
942                                 strlcpy(udev->group, key_val(rule, &rule->group), sizeof(udev->group));
943                                 udev_rules_apply_format(udev, udev->group, sizeof(udev->group));
944                                 dbg("applied group='%s' to '%s'", udev->group, udev->dev->kernel_name);
945                         }
946
947                         /* collect symlinks */
948                         if (!udev->symlink_final && rule->symlink.operation != KEY_OP_UNSET) {
949                                 char temp[PATH_SIZE];
950                                 char *pos, *next;
951                                 int count;
952
953                                 if (rule->symlink.operation == KEY_OP_ASSIGN_FINAL)
954                                         udev->symlink_final = 1;
955                                 if (rule->symlink.operation == KEY_OP_ASSIGN || rule->symlink.operation == KEY_OP_ASSIGN_FINAL) {
956                                         info("reset symlink list");
957                                         name_list_cleanup(&udev->symlink_list);
958                                 }
959                                 strlcpy(temp, key_val(rule, &rule->symlink), sizeof(temp));
960                                 udev_rules_apply_format(udev, temp, sizeof(temp));
961                                 count = replace_untrusted_chars(temp);
962                                 if (count)
963                                         info("%i untrusted character(s) replaced" , count);
964                                 dbg("rule applied, added symlink(s) '%s'", temp);
965
966                                 /* add multiple symlinks separated by spaces */
967                                 pos = temp;
968                                 while (isspace(pos[0]))
969                                         pos++;
970                                 next = strchr(pos, ' ');
971                                 while (next) {
972                                         next[0] = '\0';
973                                         info("add symlink '%s'", pos);
974                                         name_list_add(&udev->symlink_list, pos, 0);
975                                         while (isspace(next[1]))
976                                                 next++;
977                                         pos = &next[1];
978                                         next = strchr(pos, ' ');
979                                 }
980                                 if (pos[0] != '\0') {
981                                         info("add symlink '%s'", pos);
982                                         name_list_add(&udev->symlink_list, pos, 0);
983                                 }
984                         }
985
986                         /* set name, later rules with name set will be ignored */
987                         if (rule->name.operation == KEY_OP_ASSIGN ||
988                             rule->name.operation == KEY_OP_ASSIGN_FINAL ||
989                             rule->name.operation == KEY_OP_ADD) {
990                                 int count;
991
992                                 name_set = 1;
993                                 strlcpy(udev->name, key_val(rule, &rule->name), sizeof(udev->name));
994                                 udev_rules_apply_format(udev, udev->name, sizeof(udev->name));
995                                 count = replace_untrusted_chars(udev->name);
996                                 if (count)
997                                         info("%i untrusted character(s) replaced", count);
998
999                                 info("rule applied, '%s' becomes '%s'", udev->dev->kernel_name, udev->name);
1000                                 if (strcmp(udev->dev->subsystem, "net") != 0)
1001                                         dbg("name, '%s' is going to have owner='%s', group='%s', mode=%#o partitions=%i",
1002                                             udev->name, udev->owner, udev->group, udev->mode, udev->partitions);
1003                         }
1004
1005                         if (!udev->run_final && rule->run.operation != KEY_OP_UNSET) {
1006                                 if (rule->run.operation == KEY_OP_ASSIGN_FINAL)
1007                                         udev->run_final = 1;
1008                                 if (rule->run.operation == KEY_OP_ASSIGN || rule->run.operation == KEY_OP_ASSIGN_FINAL) {
1009                                         info("reset run list");
1010                                         name_list_cleanup(&udev->run_list);
1011                                 }
1012                                 dbg("add run '%s'", key_val(rule, &rule->run));
1013                                 name_list_add(&udev->run_list, key_val(rule, &rule->run), 0);
1014                         }
1015
1016                         if (rule->last_rule) {
1017                                 dbg("last rule to be applied");
1018                                 break;
1019                         }
1020
1021                         if (rule->goto_label.operation != KEY_OP_UNSET) {
1022                                 dbg("moving forward to label '%s'", key_val(rule, &rule->goto_label));
1023                                 udev_rules_iter_label(rules, key_val(rule, &rule->goto_label));
1024                         }
1025                 }
1026         }
1027
1028         if (!name_set) {
1029                 strlcpy(udev->name, udev->dev->kernel_name, sizeof(udev->name));
1030                 info("no node name set, will use kernel name '%s'", udev->name);
1031         }
1032
1033         if (udev->tmp_node[0] != '\0') {
1034                 dbg("removing temporary device node");
1035                 unlink_secure(udev->tmp_node);
1036                 udev->tmp_node[0] = '\0';
1037         }
1038
1039         return 0;
1040 }
1041
1042 int udev_rules_get_run(struct udev_rules *rules, struct udevice *udev)
1043 {
1044         struct udev_rule *rule;
1045
1046         dbg("udev->kernel_name='%s'", udev->dev->kernel_name);
1047
1048         /* look for a matching rule to apply */
1049         udev_rules_iter_init(rules);
1050         while (1) {
1051                 rule = udev_rules_iter_next(rules);
1052                 if (rule == NULL)
1053                         break;
1054
1055                 dbg("process rule");
1056                 if (rule->name.operation != KEY_OP_UNSET || rule->symlink.operation != KEY_OP_UNSET ||
1057                     rule->mode_operation != KEY_OP_UNSET || rule->owner.operation != KEY_OP_UNSET || rule->group.operation != KEY_OP_UNSET) {
1058                         dbg("skip rule that names a device");
1059                         continue;
1060                 }
1061
1062                 if (match_rule(udev, rule) == 0) {
1063                         if (rule->ignore_device) {
1064                                 info("rule applied, '%s' is ignored", udev->dev->kernel_name);
1065                                 udev->ignore_device = 1;
1066                                 return 0;
1067                         }
1068
1069                         if (!udev->run_final && rule->run.operation != KEY_OP_UNSET) {
1070                                 if (rule->run.operation == KEY_OP_ASSIGN || rule->run.operation == KEY_OP_ASSIGN_FINAL) {
1071                                         info("reset run list");
1072                                         name_list_cleanup(&udev->run_list);
1073                                 }
1074                                 dbg("add run '%s'", key_val(rule, &rule->run));
1075                                 name_list_add(&udev->run_list, key_val(rule, &rule->run), 0);
1076                                 if (rule->run.operation == KEY_OP_ASSIGN_FINAL)
1077                                         break;
1078                         }
1079
1080                         if (rule->last_rule) {
1081                                 dbg("last rule to be applied");
1082                                 break;
1083                         }
1084
1085                         if (rule->goto_label.operation != KEY_OP_UNSET) {
1086                                 dbg("moving forward to label '%s'", key_val(rule, &rule->goto_label));
1087                                 udev_rules_iter_label(rules, key_val(rule, &rule->goto_label));
1088                         }
1089                 }
1090         }
1091
1092         return 0;
1093 }