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.
35 #include "libsysfs/sysfs/libsysfs.h"
37 #include "udev_libc_wrapper.h"
39 #include "udev_utils.h"
40 #include "udev_version.h"
42 #include "udev_rules.h"
46 /* compare string with pattern (supports * ? [0-9] [!A-Z]) */
47 static int strcmp_pattern(const char *p, const char *s)
52 return (p[0] != '\0');
63 while ((p[0] != '\0') && (p[0] != ']')) {
66 if ((s[0] >= p[0]) && (s[0] <= p[2]))
70 match = (p[0] == s[0]);
74 while ((p[0] != '\0') && (p[0] != ']'))
77 return strcmp_pattern(p+1, s+1);
83 if (strcmp_pattern(p, s+1))
84 return strcmp_pattern(p+1, s);
92 if ((p[0] == s[0]) || (p[0] == '?'))
93 return strcmp_pattern(p+1, s+1);
99 /* extract possible {attr} and move str behind it */
100 static char *get_format_attribute(char **str)
105 if (*str[0] == '{') {
106 pos = strchr(*str, '}');
108 err("missing closing brace for format");
114 dbg("attribute='%s', str='%s'", attr, *str);
119 /* extract possible format length and move str behind it*/
120 static int get_format_len(char **str)
125 if (isdigit(*str[0])) {
126 num = (int) strtoul(*str, &tail, 10);
129 dbg("format length=%i", num);
132 err("format parsing error '%s'", *str);
138 /** Finds the lowest positive N such that <name>N isn't present in
139 * $(udevroot) either as a file or a symlink.
141 * @param name Name to check for
142 * @return 0 if <name> didn't exist and N otherwise.
144 static int find_free_number(struct udevice *udev, const char *name)
146 char devpath[PATH_SIZE];
147 char filename[PATH_SIZE];
150 strlcpy(filename, name, sizeof(filename));
152 dbg("look for existing node '%s'", filename);
153 if (udev_db_search_name(devpath, sizeof(devpath), filename) != 0) {
154 dbg("free num=%d", num);
160 info("find_free_number gone crazy (num=%d), aborted", num);
163 snprintf(filename, sizeof(filename), "%s%d", name, num);
164 filename[sizeof(filename)-1] = '\0';
168 static int find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device,
169 const char *name, char *value, size_t len)
171 struct sysfs_attribute *tmpattr;
173 dbg("look for device attribute '%s'", name);
175 tmpattr = sysfs_get_classdev_attr(class_dev, name);
180 tmpattr = sysfs_get_device_attr(sysfs_device, name);
188 strlcpy(value, tmpattr->value, len);
189 remove_trailing_char(value, '\n');
191 dbg("found attribute '%s'", tmpattr->path);
195 static void apply_format(struct udevice *udev, char *string, size_t maxsize,
196 struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
198 char temp[PATH_SIZE];
199 char temp2[PATH_SIZE];
200 char *tail, *pos, *cpos, *attr, *rest;
204 unsigned int next_free_number;
205 struct sysfs_class_device *class_dev_parent;
209 pos = strchr(pos, '%');
215 len = get_format_len(&tail);
217 strlcpy(temp, tail+1, sizeof(temp));
219 dbg("format=%c, string='%s', tail='%s'",c , string, tail);
220 attr = get_format_attribute(&tail);
224 strlcat(string, udev->devpath, maxsize);
225 dbg("substitute kernel name '%s'", udev->kernel_name);
228 strlcat(string, udev->bus_id, maxsize);
229 dbg("substitute bus_id '%s'", udev->bus_id);
232 strlcat(string, udev->kernel_name, maxsize);
233 dbg("substitute kernel name '%s'", udev->kernel_name);
236 strlcat(string, udev->kernel_number, maxsize);
237 dbg("substitute kernel number '%s'", udev->kernel_number);
240 sprintf(temp2, "%d", minor(udev->devt));
241 strlcat(string, temp2, maxsize);
242 dbg("substitute minor number '%s'", temp2);
245 sprintf(temp2, "%d", major(udev->devt));
246 strlcat(string, temp2, maxsize);
247 dbg("substitute major number '%s'", temp2);
250 if (udev->program_result[0] == '\0')
252 /* get part part of the result string */
255 i = strtoul(attr, &rest, 10);
257 dbg("request part #%d of result string", i);
258 cpos = udev->program_result;
260 while (cpos[0] != '\0' && !isspace(cpos[0]))
262 while (isspace(cpos[0]))
266 err("requested part of result string not found");
269 strlcpy(temp2, cpos, sizeof(temp2));
270 /* %{2+}c copies the whole string from the second part on */
271 if (rest[0] != '+') {
272 cpos = strchr(temp2, ' ');
276 strlcat(string, temp2, maxsize);
277 dbg("substitute part of result string '%s'", temp2);
279 strlcat(string, udev->program_result, maxsize);
280 dbg("substitute result string '%s'", udev->program_result);
285 dbg("missing attribute");
288 if (find_sysfs_attribute(class_dev, sysfs_device, attr, temp2, sizeof(temp2)) != 0) {
289 struct sysfs_device *parent_device;
291 dbg("sysfs attribute '%s' not found, walk up the physical devices", attr);
292 parent_device = sysfs_get_device_parent(sysfs_device);
293 while (parent_device) {
294 dbg("looking at '%s'", parent_device->path);
295 if (find_sysfs_attribute(NULL, parent_device, attr, temp2, sizeof(temp2)) == 0)
297 parent_device = sysfs_get_device_parent(parent_device);
302 /* strip trailing whitespace of sysfs value */
304 while (i > 0 && isspace(temp2[i-1]))
306 replace_untrusted_chars(temp2);
307 strlcat(string, temp2, maxsize);
308 dbg("substitute sysfs value '%s'", temp2);
311 strlcat(string, "%", maxsize);
315 next_free_number = find_free_number(udev, string);
316 if (next_free_number > 0) {
317 sprintf(temp2, "%d", next_free_number);
318 strlcat(string, temp2, maxsize);
324 class_dev_parent = sysfs_get_classdev_parent(class_dev);
325 if (class_dev_parent != NULL) {
326 struct udevice udev_parent;
328 dbg("found parent '%s', get the node name", class_dev_parent->path);
329 udev_init_device(&udev_parent, NULL, NULL, NULL);
330 /* lookup the name in the udev_db with the DEVPATH of the parent */
331 if (udev_db_get_device(&udev_parent, &class_dev_parent->path[strlen(sysfs_path)]) == 0) {
332 strlcat(string, udev_parent.name, maxsize);
333 dbg("substitute parent node name'%s'", udev_parent.name);
335 dbg("parent not found in database");
336 udev_cleanup_device(&udev_parent);
340 if (udev->tmp_node[0] == '\0') {
341 dbg("create temporary device node for callout");
342 snprintf(udev->tmp_node, sizeof(udev->tmp_node), "%s/.tmp-%u-%u",
343 udev_root, major(udev->devt), minor(udev->devt));
344 udev->tmp_node[sizeof(udev->tmp_node)-1] = '\0';
345 udev_make_node(udev, udev->tmp_node, udev->devt, 0600, 0, 0);
347 strlcat(string, udev->tmp_node, maxsize);
348 dbg("substitute temporary device node name '%s'", udev->tmp_node);
351 strlcat(string, udev_root, maxsize);
352 dbg("substitute udev_root '%s'", udev_root);
355 err("unknown substitution type '%%%c'", c);
358 /* truncate to specified length */
362 strlcat(string, tail, maxsize);
366 static int execute_program_pipe(const char *command, const char *subsystem, char *value, int len)
375 char *argv[(sizeof(arg) / 2) + 1];
379 strlcpy(arg, command, sizeof(arg));
381 if (strchr(arg, ' ')) {
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] = (char *) subsystem;
402 dbg("execute '%s' with subsystem '%s' argument", arg, argv[1]);
405 retval = pipe(pipefds);
414 /* child dup2 write side of pipe to STDOUT */
415 devnull = open("/dev/null", O_RDWR);
417 dup2(devnull, STDIN_FILENO);
418 dup2(devnull, STDERR_FILENO);
421 dup2(pipefds[1], STDOUT_FILENO);
422 retval = execv(arg, argv);
423 err("exec of program failed");
426 err("fork of '%s' failed", arg);
430 /* parent reads from pipefds[0] */
435 count = read(pipefds[0], value + i, len - i-1);
437 err("read failed with '%s'", strerror(errno));
446 err("result len %d too short", len);
454 waitpid(pid, &status, 0);
456 if (!WIFEXITED(status) || (WEXITSTATUS(status) != 0)) {
457 dbg("exec program status 0x%x", status);
463 remove_trailing_char(value, '\n');
464 dbg("result is '%s'", value);
465 replace_untrusted_chars(value);
472 static int match_rule(struct udevice *udev, struct udev_rule *rule,
473 struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
475 struct sysfs_device *parent_device = sysfs_device;
477 if (rule->kernel_operation != KEY_OP_UNSET) {
478 dbg("check for " KEY_KERNEL " rule->kernel='%s' udev_kernel_name='%s'",
479 rule->kernel, udev->kernel_name);
480 if (strcmp_pattern(rule->kernel, udev->kernel_name) != 0) {
481 dbg(KEY_KERNEL " is not matching");
482 if (rule->kernel_operation != KEY_OP_NOMATCH)
485 dbg(KEY_KERNEL " matches");
486 if (rule->kernel_operation == KEY_OP_NOMATCH)
489 dbg(KEY_KERNEL " key is true");
492 if (rule->subsystem_operation != KEY_OP_UNSET) {
493 dbg("check for " KEY_SUBSYSTEM " rule->subsystem='%s' udev->subsystem='%s'",
494 rule->subsystem, udev->subsystem);
495 if (strcmp_pattern(rule->subsystem, udev->subsystem) != 0) {
496 dbg(KEY_SUBSYSTEM " is not matching");
497 if (rule->subsystem_operation != KEY_OP_NOMATCH)
500 dbg(KEY_SUBSYSTEM " matches");
501 if (rule->subsystem_operation == KEY_OP_NOMATCH)
504 dbg(KEY_SUBSYSTEM " key is true");
507 if (rule->env_pair_count) {
510 dbg("check for " KEY_ENV " pairs");
511 for (i = 0; i < rule->env_pair_count; i++) {
512 struct key_pair *pair;
515 pair = &rule->env_pair[i];
516 value = getenv(pair->name);
518 dbg(KEY_ENV "{'%s'} is not found", pair->name);
521 if (strcmp_pattern(pair->value, value) != 0) {
522 dbg(KEY_ENV "{'%s'} is not matching", pair->name);
523 if (pair->operation != KEY_OP_NOMATCH)
526 dbg(KEY_ENV "{'%s'} matches", pair->name);
527 if (pair->operation == KEY_OP_NOMATCH)
531 dbg(KEY_ENV " key is true");
534 /* walk up the chain of physical devices and find a match */
536 /* check for matching driver */
537 if (rule->driver_operation != KEY_OP_UNSET) {
538 if (parent_device == NULL) {
539 dbg("device has no sysfs_device");
542 dbg("check for " KEY_DRIVER " rule->driver='%s' sysfs_device->driver_name='%s'",
543 rule->driver, parent_device->driver_name);
544 if (strcmp_pattern(rule->driver, parent_device->driver_name) != 0) {
545 dbg(KEY_DRIVER " is not matching");
546 if (rule->driver_operation != KEY_OP_NOMATCH)
549 dbg(KEY_DRIVER " matches");
550 if (rule->driver_operation == KEY_OP_NOMATCH)
553 dbg(KEY_DRIVER " key is true");
556 /* check for matching bus value */
557 if (rule->bus_operation != KEY_OP_UNSET) {
558 if (parent_device == NULL) {
559 dbg("device has no sysfs_device");
562 dbg("check for " KEY_BUS " rule->bus='%s' sysfs_device->bus='%s'",
563 rule->bus, parent_device->bus);
564 if (strcmp_pattern(rule->bus, parent_device->bus) != 0) {
565 dbg(KEY_BUS " is not matching");
566 if (rule->bus_operation != KEY_OP_NOMATCH)
569 dbg(KEY_BUS " matches");
570 if (rule->bus_operation == KEY_OP_NOMATCH)
573 dbg(KEY_BUS " key is true");
576 /* check for matching bus id */
577 if (rule->id_operation != KEY_OP_UNSET) {
578 if (parent_device == NULL) {
579 dbg("device has no sysfs_device");
582 dbg("check " KEY_ID);
583 if (strcmp_pattern(rule->id, parent_device->bus_id) != 0) {
584 dbg(KEY_ID " is not matching");
585 if (rule->id_operation != KEY_OP_NOMATCH)
588 dbg(KEY_ID " matches");
589 if (rule->id_operation == KEY_OP_NOMATCH)
592 dbg(KEY_ID " key is true");
595 /* check for matching sysfs pairs */
596 if (rule->sysfs_pair_count) {
599 dbg("check " KEY_SYSFS " pairs");
600 for (i = 0; i < rule->sysfs_pair_count; i++) {
601 struct key_pair *pair;
602 char value[VALUE_SIZE];
605 pair = &rule->sysfs_pair[i];
606 if (find_sysfs_attribute(class_dev, parent_device, pair->name, value, sizeof(value)) != 0)
609 /* strip trailing whitespace of value, if not asked to match for it */
610 len = strlen(pair->value);
611 if (len && !isspace(pair->value[len-1])) {
613 while (len > 0 && isspace(value[len-1]))
615 dbg("removed %i trailing whitespace chars from '%s'", strlen(value)-len, value);
618 dbg("compare attribute '%s' value '%s' with '%s'", pair->name, value, pair->value);
619 if (strcmp_pattern(pair->value, value) != 0) {
620 dbg(KEY_SYSFS "{'%s'} is not matching", pair->name);
621 if (pair->operation != KEY_OP_NOMATCH)
624 dbg(KEY_SYSFS "{'%s'} matches", pair->name);
625 if (pair->operation == KEY_OP_NOMATCH)
629 dbg(KEY_SYSFS " keys are true");
632 /* found matching physical device */
635 dbg("try parent sysfs device");
636 parent_device = sysfs_get_device_parent(parent_device);
637 if (parent_device == NULL)
639 dbg("look at sysfs_device->path='%s'", parent_device->path);
640 dbg("look at sysfs_device->bus_id='%s'", parent_device->bus_id);
643 /* execute external program */
644 if (rule->program_operation != KEY_OP_UNSET) {
645 char program[PATH_SIZE];
647 dbg("check " KEY_PROGRAM);
648 strlcpy(program, rule->program, sizeof(program));
649 apply_format(udev, program, sizeof(program), class_dev, sysfs_device);
650 if (execute_program_pipe(program, udev->subsystem,
651 udev->program_result, sizeof(udev->program_result)) != 0) {
652 dbg(KEY_PROGRAM " returned nonzero");
653 if (rule->program_operation != KEY_OP_NOMATCH)
656 dbg(KEY_PROGRAM " returned successful");
657 if (rule->program_operation == KEY_OP_NOMATCH)
660 dbg(KEY_PROGRAM " key is true");
663 /* check for matching result of external program */
664 if (rule->result_operation != KEY_OP_UNSET) {
665 dbg("check for " KEY_RESULT " rule->result='%s', udev->program_result='%s'",
666 rule->result, udev->program_result);
667 if (strcmp_pattern(rule->result, udev->program_result) != 0) {
668 dbg(KEY_RESULT " is not matching");
669 if (rule->result_operation != KEY_OP_NOMATCH)
672 dbg(KEY_RESULT " matches");
673 if (rule->result_operation == KEY_OP_NOMATCH)
676 dbg(KEY_RESULT " key is true");
686 int udev_rules_get_name(struct udevice *udev, struct sysfs_class_device *class_dev)
688 struct sysfs_class_device *class_dev_parent;
689 struct sysfs_device *sysfs_device = NULL;
690 struct udev_rule *rule;
692 dbg("class_dev->name='%s'", class_dev->name);
694 /* Figure out where the "device"-symlink is at. For char devices this will
695 * always be in the class_dev->path. On block devices, only the main block
696 * device will have the device symlink in it's path. All partition devices
697 * need to look at the symlink in its parent directory.
699 class_dev_parent = sysfs_get_classdev_parent(class_dev);
700 if (class_dev_parent != NULL) {
701 dbg("given class device has a parent, use this instead");
702 sysfs_device = sysfs_get_classdev_device(class_dev_parent);
704 sysfs_device = sysfs_get_classdev_device(class_dev);
708 dbg("found devices device: path='%s', bus_id='%s', bus='%s'",
709 sysfs_device->path, sysfs_device->bus_id, sysfs_device->bus);
710 strlcpy(udev->bus_id, sysfs_device->bus_id, sizeof(udev->bus_id));
713 dbg("udev->kernel_name='%s'", udev->kernel_name);
715 /* look for a matching rule to apply */
716 list_for_each_entry(rule, &udev_rule_list, node) {
718 if (match_rule(udev, rule, class_dev, sysfs_device) == 0) {
721 if (rule->ignore_device) {
722 info("configured rule in '%s[%i]' applied, '%s' is ignored",
723 rule->config_file, rule->config_line, udev->kernel_name);
726 if (rule->ignore_remove) {
727 udev->ignore_remove = 1;
728 dbg("remove event should be ignored");
730 /* apply all_partitions option only at a main block device */
731 if (rule->partitions && udev->type == DEV_BLOCK && udev->kernel_number[0] == '\0') {
732 udev->partitions = rule->partitions;
733 dbg("creation of partition nodes requested");
736 /* apply permissions */
737 if (rule->mode != 0000) {
738 udev->mode = rule->mode;
739 dbg("applied mode=%#o to '%s'", udev->mode, udev->kernel_name);
741 if (rule->owner[0] != '\0') {
742 strlcpy(udev->owner, rule->owner, sizeof(udev->owner));
743 apply_format(udev, udev->owner, sizeof(udev->owner), class_dev, sysfs_device);
744 dbg("applied owner='%s' to '%s'", udev->owner, udev->kernel_name);
746 if (rule->group[0] != '\0') {
747 strlcpy(udev->group, rule->group, sizeof(udev->group));
748 apply_format(udev, udev->group, sizeof(udev->group), class_dev, sysfs_device);
749 dbg("applied group='%s' to '%s'", udev->group, udev->kernel_name);
752 /* collect symlinks */
753 if (rule->symlink[0] != '\0') {
754 char temp[PATH_SIZE];
757 info("configured rule in '%s[%i]' applied, added symlink '%s'",
758 rule->config_file, rule->config_line, rule->symlink);
759 strlcpy(temp, rule->symlink, sizeof(temp));
760 apply_format(udev, temp, sizeof(temp), class_dev, sysfs_device);
762 /* add multiple symlinks separated by spaces */
764 next = strchr(temp, ' ');
767 info("add symlink '%s'", pos);
768 name_list_add(&udev->symlink_list, pos, 0);
770 next = strchr(pos, ' ');
772 info("add symlink '%s'", pos);
773 name_list_add(&udev->symlink_list, pos, 0);
777 if (rule->name[0] != '\0') {
778 info("configured rule in '%s[%i]' applied, '%s' becomes '%s'",
779 rule->config_file, rule->config_line, udev->kernel_name, rule->name);
781 strlcpy(udev->name, rule->name, sizeof(udev->name));
782 apply_format(udev, udev->name, sizeof(udev->name), class_dev, sysfs_device);
783 strlcpy(udev->config_file, rule->config_file, sizeof(udev->config_file));
784 udev->config_line = rule->config_line;
786 if (udev->type != DEV_NET)
787 dbg("name, '%s' is going to have owner='%s', group='%s', mode=%#o partitions=%i",
788 udev->name, udev->owner, udev->group, udev->mode, udev->partitions);
793 if (rule->last_rule) {
794 dbg("last rule to be applied");
801 if (udev->name[0] == '\0') {
802 /* no rule matched, so we use the kernel name */
803 strlcpy(udev->name, udev->kernel_name, sizeof(udev->name));
804 info("no rule found, use kernel name '%s'", udev->name);
807 if (udev->tmp_node[0] != '\0') {
808 dbg("removing temporary device node");
809 unlink_secure(udev->tmp_node);
810 udev->tmp_node[0] = '\0';