6 * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
7 * Copyright (C) 2003-2005 Kay Sievers <kay.sievers@vrfy.org>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation version 2 of the License.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 675 Mass Ave, Cambridge, MA 02139, USA.
36 #include "libsysfs/sysfs/libsysfs.h"
38 #include "udev_libc_wrapper.h"
40 #include "udev_utils.h"
41 #include "udev_version.h"
43 #include "udev_rules.h"
47 /* compare string with pattern (supports * ? [0-9] [!A-Z]) */
48 static int strcmp_pattern(const char *p, const char *s)
53 return (p[0] != '\0');
64 while ((p[0] != '\0') && (p[0] != ']')) {
67 if ((s[0] >= p[0]) && (s[0] <= p[2]))
71 match = (p[0] == s[0]);
75 while ((p[0] != '\0') && (p[0] != ']'))
78 return strcmp_pattern(p+1, s+1);
84 if (strcmp_pattern(p, s+1))
85 return strcmp_pattern(p+1, s);
93 if ((p[0] == s[0]) || (p[0] == '?'))
94 return strcmp_pattern(p+1, s+1);
100 /* extract possible {attr} and move str behind it */
101 static char *get_format_attribute(char **str)
106 if (*str[0] == '{') {
107 pos = strchr(*str, '}');
109 err("missing closing brace for format");
115 dbg("attribute='%s', str='%s'", attr, *str);
120 /* extract possible format length and move str behind it*/
121 static int get_format_len(char **str)
126 if (isdigit(*str[0])) {
127 num = (int) strtoul(*str, &tail, 10);
130 dbg("format length=%i", num);
133 err("format parsing error '%s'", *str);
139 /** Finds the lowest positive N such that <name>N isn't present in
140 * $(udevroot) either as a file or a symlink.
142 * @param name Name to check for
143 * @return 0 if <name> didn't exist and N otherwise.
145 static int find_free_number(struct udevice *udev, const char *name)
147 char devpath[PATH_SIZE];
148 char filename[PATH_SIZE];
151 strlcpy(filename, name, sizeof(filename));
153 dbg("look for existing node '%s'", filename);
154 if (udev_db_search_name(devpath, sizeof(devpath), filename) != 0) {
155 dbg("free num=%d", num);
161 info("find_free_number gone crazy (num=%d), aborted", num);
164 snprintf(filename, sizeof(filename), "%s%d", name, num);
165 filename[sizeof(filename)-1] = '\0';
169 static int find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device,
170 const char *name, char *value, size_t len)
172 struct sysfs_attribute *tmpattr;
174 dbg("look for device attribute '%s'", name);
176 tmpattr = sysfs_get_classdev_attr(class_dev, name);
181 tmpattr = sysfs_get_device_attr(sysfs_device, name);
189 strlcpy(value, tmpattr->value, len);
190 remove_trailing_char(value, '\n');
192 dbg("found attribute '%s'", tmpattr->path);
196 static void apply_format(struct udevice *udev, char *string, size_t maxsize,
197 struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
199 char temp[PATH_SIZE];
200 char temp2[PATH_SIZE];
201 char *tail, *pos, *cpos, *attr, *rest;
205 unsigned int next_free_number;
206 struct sysfs_class_device *class_dev_parent;
210 pos = strchr(pos, '%');
216 len = get_format_len(&tail);
218 strlcpy(temp, tail+1, sizeof(temp));
220 dbg("format=%c, string='%s', tail='%s'",c , string, tail);
221 attr = get_format_attribute(&tail);
225 strlcat(string, udev->devpath, maxsize);
226 dbg("substitute kernel name '%s'", udev->kernel_name);
229 strlcat(string, udev->bus_id, maxsize);
230 dbg("substitute bus_id '%s'", udev->bus_id);
233 strlcat(string, udev->kernel_name, maxsize);
234 dbg("substitute kernel name '%s'", udev->kernel_name);
237 strlcat(string, udev->kernel_number, maxsize);
238 dbg("substitute kernel number '%s'", udev->kernel_number);
241 sprintf(temp2, "%d", minor(udev->devt));
242 strlcat(string, temp2, maxsize);
243 dbg("substitute minor number '%s'", temp2);
246 sprintf(temp2, "%d", major(udev->devt));
247 strlcat(string, temp2, maxsize);
248 dbg("substitute major number '%s'", temp2);
251 if (udev->program_result[0] == '\0')
253 /* get part part of the result string */
256 i = strtoul(attr, &rest, 10);
258 dbg("request part #%d of result string", i);
259 cpos = udev->program_result;
261 while (cpos[0] != '\0' && !isspace(cpos[0]))
263 while (isspace(cpos[0]))
267 err("requested part of result string not found");
270 strlcpy(temp2, cpos, sizeof(temp2));
271 /* %{2+}c copies the whole string from the second part on */
272 if (rest[0] != '+') {
273 cpos = strchr(temp2, ' ');
277 strlcat(string, temp2, maxsize);
278 dbg("substitute part of result string '%s'", temp2);
280 strlcat(string, udev->program_result, maxsize);
281 dbg("substitute result string '%s'", udev->program_result);
286 dbg("missing attribute");
289 if (find_sysfs_attribute(class_dev, sysfs_device, attr, temp2, sizeof(temp2)) != 0) {
290 struct sysfs_device *parent_device;
292 dbg("sysfs attribute '%s' not found, walk up the physical devices", attr);
293 parent_device = sysfs_get_device_parent(sysfs_device);
294 while (parent_device) {
295 dbg("looking at '%s'", parent_device->path);
296 if (find_sysfs_attribute(NULL, parent_device, attr, temp2, sizeof(temp2)) == 0)
298 parent_device = sysfs_get_device_parent(parent_device);
303 /* strip trailing whitespace of sysfs value */
305 while (i > 0 && isspace(temp2[i-1]))
307 replace_untrusted_chars(temp2);
308 strlcat(string, temp2, maxsize);
309 dbg("substitute sysfs value '%s'", temp2);
312 strlcat(string, "%", maxsize);
316 next_free_number = find_free_number(udev, string);
317 if (next_free_number > 0) {
318 sprintf(temp2, "%d", next_free_number);
319 strlcat(string, temp2, maxsize);
325 class_dev_parent = sysfs_get_classdev_parent(class_dev);
326 if (class_dev_parent != NULL) {
327 struct udevice udev_parent;
329 dbg("found parent '%s', get the node name", class_dev_parent->path);
330 udev_init_device(&udev_parent, NULL, NULL);
331 /* lookup the name in the udev_db with the DEVPATH of the parent */
332 if (udev_db_get_device(&udev_parent, &class_dev_parent->path[strlen(sysfs_path)]) == 0) {
333 strlcat(string, udev_parent.name, maxsize);
334 dbg("substitute parent node name'%s'", udev_parent.name);
336 dbg("parent not found in database");
337 udev_cleanup_device(&udev_parent);
341 if (udev->tmp_node[0] == '\0') {
342 dbg("create temporary device node for callout");
343 snprintf(udev->tmp_node, sizeof(udev->tmp_node), "%s/.tmp-%u-%u",
344 udev_root, major(udev->devt), minor(udev->devt));
345 udev->tmp_node[sizeof(udev->tmp_node)-1] = '\0';
346 udev_make_node(udev, udev->tmp_node, udev->devt, 0600, 0, 0);
348 strlcat(string, udev->tmp_node, maxsize);
349 dbg("substitute temporary device node name '%s'", udev->tmp_node);
352 strlcat(string, udev_root, maxsize);
353 dbg("substitute udev_root '%s'", udev_root);
356 err("unknown substitution type '%%%c'", c);
359 /* truncate to specified length */
363 strlcat(string, tail, maxsize);
367 static int execute_program(struct udevice *udev, const char *path, char *value, int len)
376 char *argv[(sizeof(arg) / 2) + 1];
379 strlcpy(arg, path, sizeof(arg));
381 if (strchr(path, ' ')) {
383 while (pos != NULL) {
384 if (pos[0] == '\'') {
385 /* don't separate if in apostrophes */
387 argv[i] = strsep(&pos, "\'");
388 while (pos && pos[0] == ' ')
391 argv[i] = strsep(&pos, " ");
393 dbg("arg[%i] '%s'", i, argv[i]);
397 dbg("execute '%s' with parsed arguments", arg);
400 argv[1] = udev->subsystem;
402 dbg("execute '%s' with subsystem '%s' argument", arg, argv[1]);
414 /* child dup2 write side of pipe to STDOUT */
415 dup2(fds[1], STDOUT_FILENO);
416 retval = execv(arg, argv);
418 info(KEY_PROGRAM " execution of '%s' failed", path);
421 err("fork of '%s' failed", path);
424 /* parent reads from fds[0] */
429 count = read(fds[0], value + i, len - i-1);
431 err("read failed with '%s'", strerror(errno));
440 err("result len %d too short", len);
448 waitpid(pid, &status, 0);
450 if (!WIFEXITED(status) || (WEXITSTATUS(status) != 0)) {
451 dbg("exec program status 0x%x", status);
457 remove_trailing_char(value, '\n');
458 dbg("result is '%s'", value);
459 replace_untrusted_chars(value);
466 static int match_rule(struct udevice *udev, struct udev_rule *rule,
467 struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
469 struct sysfs_device *parent_device = sysfs_device;
471 if (rule->kernel_operation != KEY_OP_UNSET) {
472 dbg("check for " KEY_KERNEL " rule->kernel='%s' class_dev->name='%s'",
473 rule->kernel, class_dev->name);
474 if (strcmp_pattern(rule->kernel, class_dev->name) != 0) {
475 dbg(KEY_KERNEL " is not matching");
476 if (rule->kernel_operation != KEY_OP_NOMATCH)
479 dbg(KEY_KERNEL " matches");
480 if (rule->kernel_operation == KEY_OP_NOMATCH)
483 dbg(KEY_KERNEL " key is true");
486 if (rule->subsystem_operation != KEY_OP_UNSET) {
487 dbg("check for " KEY_SUBSYSTEM " rule->subsystem='%s' class_dev->name='%s'",
488 rule->subsystem, class_dev->name);
489 if (strcmp_pattern(rule->subsystem, udev->subsystem) != 0) {
490 dbg(KEY_SUBSYSTEM " is not matching");
491 if (rule->subsystem_operation != KEY_OP_NOMATCH)
494 dbg(KEY_SUBSYSTEM " matches");
495 if (rule->subsystem_operation == KEY_OP_NOMATCH)
498 dbg(KEY_SUBSYSTEM " key is true");
501 if (rule->env_pair_count) {
504 dbg("check for " KEY_ENV " pairs");
505 for (i = 0; i < rule->env_pair_count; i++) {
506 struct key_pair *pair;
509 pair = &rule->env_pair[i];
510 value = getenv(pair->name);
512 dbg(KEY_ENV "{'%s'} is not found", pair->name);
515 if (strcmp_pattern(pair->value, value) != 0) {
516 dbg(KEY_ENV "{'%s'} is not matching", pair->name);
517 if (pair->operation != KEY_OP_NOMATCH)
520 dbg(KEY_ENV "{'%s'} matches", pair->name);
521 if (pair->operation == KEY_OP_NOMATCH)
525 dbg(KEY_ENV " key is true");
528 /* walk up the chain of physical devices and find a match */
530 /* check for matching driver */
531 if (rule->driver_operation != KEY_OP_UNSET) {
532 if (parent_device == NULL) {
533 dbg("device has no sysfs_device");
536 dbg("check for " KEY_DRIVER " rule->driver='%s' sysfs_device->driver_name='%s'",
537 rule->driver, parent_device->driver_name);
538 if (strcmp_pattern(rule->driver, parent_device->driver_name) != 0) {
539 dbg(KEY_DRIVER " is not matching");
540 if (rule->driver_operation != KEY_OP_NOMATCH)
543 dbg(KEY_DRIVER " matches");
544 if (rule->driver_operation == KEY_OP_NOMATCH)
547 dbg(KEY_DRIVER " key is true");
550 /* check for matching bus value */
551 if (rule->bus_operation != KEY_OP_UNSET) {
552 if (parent_device == NULL) {
553 dbg("device has no sysfs_device");
556 dbg("check for " KEY_BUS " rule->bus='%s' sysfs_device->bus='%s'",
557 rule->bus, parent_device->bus);
558 if (strcmp_pattern(rule->bus, parent_device->bus) != 0) {
559 dbg(KEY_BUS " is not matching");
560 if (rule->bus_operation != KEY_OP_NOMATCH)
563 dbg(KEY_BUS " matches");
564 if (rule->bus_operation == KEY_OP_NOMATCH)
567 dbg(KEY_BUS " key is true");
570 /* check for matching bus id */
571 if (rule->id_operation != KEY_OP_UNSET) {
572 if (parent_device == NULL) {
573 dbg("device has no sysfs_device");
576 dbg("check " KEY_ID);
577 if (strcmp_pattern(rule->id, parent_device->bus_id) != 0) {
578 dbg(KEY_ID " is not matching");
579 if (rule->id_operation != KEY_OP_NOMATCH)
582 dbg(KEY_ID " matches");
583 if (rule->id_operation == KEY_OP_NOMATCH)
586 dbg(KEY_ID " key is true");
589 /* check for matching sysfs pairs */
590 if (rule->sysfs_pair_count) {
593 dbg("check " KEY_SYSFS " pairs");
594 for (i = 0; i < rule->sysfs_pair_count; i++) {
595 struct key_pair *pair;
596 char value[VALUE_SIZE];
599 pair = &rule->sysfs_pair[i];
600 if (find_sysfs_attribute(class_dev, parent_device, pair->name, value, sizeof(value)) != 0)
603 /* strip trailing whitespace of value, if not asked to match for it */
604 len = strlen(pair->value);
605 if (len && !isspace(pair->value[len-1])) {
607 while (len > 0 && isspace(value[len-1]))
609 dbg("removed %i trailing whitespace chars from '%s'", strlen(value)-len, value);
612 dbg("compare attribute '%s' value '%s' with '%s'", pair->name, value, pair->value);
613 if (strcmp_pattern(pair->value, value) != 0) {
614 dbg(KEY_SYSFS "{'%s'} is not matching", pair->name);
615 if (pair->operation != KEY_OP_NOMATCH)
618 dbg(KEY_SYSFS "{'%s'} matches", pair->name);
619 if (pair->operation == KEY_OP_NOMATCH)
623 dbg(KEY_SYSFS " keys are true");
626 /* found matching physical device */
629 dbg("try parent sysfs device");
630 parent_device = sysfs_get_device_parent(parent_device);
631 if (parent_device == NULL)
633 dbg("look at sysfs_device->path='%s'", parent_device->path);
634 dbg("look at sysfs_device->bus_id='%s'", parent_device->bus_id);
637 /* execute external program */
638 if (rule->program_operation != KEY_OP_UNSET) {
639 char program[PATH_SIZE];
641 dbg("check " KEY_PROGRAM);
642 strlcpy(program, rule->program, sizeof(program));
643 apply_format(udev, program, sizeof(program), class_dev, sysfs_device);
644 if (execute_program(udev, program, udev->program_result, sizeof(udev->program_result)) != 0) {
645 dbg(KEY_PROGRAM " returned nonzero");
646 if (rule->program_operation != KEY_OP_NOMATCH)
649 dbg(KEY_PROGRAM " returned successful");
650 if (rule->program_operation == KEY_OP_NOMATCH)
653 dbg(KEY_PROGRAM " key is true");
656 /* check for matching result of external program */
657 if (rule->result_operation != KEY_OP_UNSET) {
658 dbg("check for " KEY_RESULT " rule->result='%s', udev->program_result='%s'",
659 rule->result, udev->program_result);
660 if (strcmp_pattern(rule->result, udev->program_result) != 0) {
661 dbg(KEY_RESULT " is not matching");
662 if (rule->result_operation != KEY_OP_NOMATCH)
665 dbg(KEY_RESULT " matches");
666 if (rule->result_operation == KEY_OP_NOMATCH)
669 dbg(KEY_RESULT " key is true");
679 int udev_rules_get_name(struct udevice *udev, struct sysfs_class_device *class_dev)
681 struct sysfs_class_device *class_dev_parent;
682 struct sysfs_device *sysfs_device = NULL;
683 struct udev_rule *rule;
685 dbg("class_dev->name='%s'", class_dev->name);
687 /* Figure out where the "device"-symlink is at. For char devices this will
688 * always be in the class_dev->path. On block devices, only the main block
689 * device will have the device symlink in it's path. All partition devices
690 * need to look at the symlink in its parent directory.
692 class_dev_parent = sysfs_get_classdev_parent(class_dev);
693 if (class_dev_parent != NULL) {
694 dbg("given class device has a parent, use this instead");
695 sysfs_device = sysfs_get_classdev_device(class_dev_parent);
697 sysfs_device = sysfs_get_classdev_device(class_dev);
701 dbg("found devices device: path='%s', bus_id='%s', bus='%s'",
702 sysfs_device->path, sysfs_device->bus_id, sysfs_device->bus);
703 strlcpy(udev->bus_id, sysfs_device->bus_id, sizeof(udev->bus_id));
706 dbg("udev->kernel_name='%s'", udev->kernel_name);
708 /* look for a matching rule to apply */
709 list_for_each_entry(rule, &udev_rule_list, node) {
711 if (match_rule(udev, rule, class_dev, sysfs_device) == 0) {
714 if (rule->ignore_device) {
715 info("configured rule in '%s[%i]' applied, '%s' is ignored",
716 rule->config_file, rule->config_line, udev->kernel_name);
719 if (rule->ignore_remove) {
720 udev->ignore_remove = 1;
721 dbg("remove event should be ignored");
723 /* apply all_partitions option only at a main block device */
724 if (rule->partitions && udev->type == DEV_BLOCK && udev->kernel_number[0] == '\0') {
725 udev->partitions = rule->partitions;
726 dbg("creation of partition nodes requested");
729 /* apply permissions */
730 if (rule->mode != 0000) {
731 udev->mode = rule->mode;
732 dbg("applied mode=%#o to '%s'", udev->mode, udev->kernel_name);
734 if (rule->owner[0] != '\0') {
735 strlcpy(udev->owner, rule->owner, sizeof(udev->owner));
736 apply_format(udev, udev->owner, sizeof(udev->owner), class_dev, sysfs_device);
737 dbg("applied owner='%s' to '%s'", udev->owner, udev->kernel_name);
739 if (rule->group[0] != '\0') {
740 strlcpy(udev->group, rule->group, sizeof(udev->group));
741 apply_format(udev, udev->group, sizeof(udev->group), class_dev, sysfs_device);
742 dbg("applied group='%s' to '%s'", udev->group, udev->kernel_name);
745 /* collect symlinks */
746 if (rule->symlink[0] != '\0') {
747 char temp[PATH_SIZE];
750 info("configured rule in '%s[%i]' applied, added symlink '%s'",
751 rule->config_file, rule->config_line, rule->symlink);
752 strlcpy(temp, rule->symlink, sizeof(temp));
753 apply_format(udev, temp, sizeof(temp), class_dev, sysfs_device);
755 /* add multiple symlinks separated by spaces */
757 next = strchr(temp, ' ');
760 info("add symlink '%s'", pos);
761 name_list_add(&udev->symlink_list, pos, 0);
763 next = strchr(pos, ' ');
765 info("add symlink '%s'", pos);
766 name_list_add(&udev->symlink_list, pos, 0);
770 if (rule->name[0] != '\0') {
771 info("configured rule in '%s[%i]' applied, '%s' becomes '%s'",
772 rule->config_file, rule->config_line, udev->kernel_name, rule->name);
774 strlcpy(udev->name, rule->name, sizeof(udev->name));
775 apply_format(udev, udev->name, sizeof(udev->name), class_dev, sysfs_device);
776 strlcpy(udev->config_file, rule->config_file, sizeof(udev->config_file));
777 udev->config_line = rule->config_line;
779 if (udev->type != DEV_NET)
780 dbg("name, '%s' is going to have owner='%s', group='%s', mode=%#o partitions=%i",
781 udev->name, udev->owner, udev->group, udev->mode, udev->partitions);
786 if (rule->last_rule) {
787 dbg("last rule to be applied");
794 if (udev->name[0] == '\0') {
795 /* no rule matched, so we use the kernel name */
796 strlcpy(udev->name, udev->kernel_name, sizeof(udev->name));
797 info("no rule found, use kernel name '%s'", udev->name);
800 if (udev->tmp_node[0] != '\0') {
801 dbg("removing temporary device node");
802 unlink_secure(udev->tmp_node);
803 udev->tmp_node[0] = '\0';