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 err(KEY_PROGRAM " execution of '%s' failed", path);
422 err("fork of '%s' failed", path);
426 /* parent reads from fds[0] */
431 count = read(fds[0], value + i, len - i-1);
433 err("read failed with '%s'", strerror(errno));
442 err("result len %d too short", len);
450 waitpid(pid, &status, 0);
452 if (!WIFEXITED(status) || (WEXITSTATUS(status) != 0)) {
453 dbg("exec program status 0x%x", status);
459 remove_trailing_char(value, '\n');
460 dbg("result is '%s'", value);
461 replace_untrusted_chars(value);
468 static int match_rule(struct udevice *udev, struct udev_rule *rule,
469 struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
471 struct sysfs_device *parent_device = sysfs_device;
473 if (rule->kernel_operation != KEY_OP_UNSET) {
474 dbg("check for " KEY_KERNEL " rule->kernel='%s' class_dev->name='%s'",
475 rule->kernel, class_dev->name);
476 if (strcmp_pattern(rule->kernel, class_dev->name) != 0) {
477 dbg(KEY_KERNEL " is not matching");
478 if (rule->kernel_operation != KEY_OP_NOMATCH)
481 dbg(KEY_KERNEL " matches");
482 if (rule->kernel_operation == KEY_OP_NOMATCH)
485 dbg(KEY_KERNEL " key is true");
488 if (rule->subsystem_operation != KEY_OP_UNSET) {
489 dbg("check for " KEY_SUBSYSTEM " rule->subsystem='%s' class_dev->name='%s'",
490 rule->subsystem, class_dev->name);
491 if (strcmp_pattern(rule->subsystem, udev->subsystem) != 0) {
492 dbg(KEY_SUBSYSTEM " is not matching");
493 if (rule->subsystem_operation != KEY_OP_NOMATCH)
496 dbg(KEY_SUBSYSTEM " matches");
497 if (rule->subsystem_operation == KEY_OP_NOMATCH)
500 dbg(KEY_SUBSYSTEM " key is true");
503 if (rule->env_pair_count) {
506 dbg("check for " KEY_ENV " pairs");
507 for (i = 0; i < rule->env_pair_count; i++) {
508 struct key_pair *pair;
511 pair = &rule->env_pair[i];
512 value = getenv(pair->name);
514 dbg(KEY_ENV "{'%s'} is not found", pair->name);
517 if (strcmp_pattern(pair->value, value) != 0) {
518 dbg(KEY_ENV "{'%s'} is not matching", pair->name);
519 if (pair->operation != KEY_OP_NOMATCH)
522 dbg(KEY_ENV "{'%s'} matches", pair->name);
523 if (pair->operation == KEY_OP_NOMATCH)
527 dbg(KEY_ENV " key is true");
530 /* walk up the chain of physical devices and find a match */
532 /* check for matching driver */
533 if (rule->driver_operation != KEY_OP_UNSET) {
534 if (parent_device == NULL) {
535 dbg("device has no sysfs_device");
538 dbg("check for " KEY_DRIVER " rule->driver='%s' sysfs_device->driver_name='%s'",
539 rule->driver, parent_device->driver_name);
540 if (strcmp_pattern(rule->driver, parent_device->driver_name) != 0) {
541 dbg(KEY_DRIVER " is not matching");
542 if (rule->driver_operation != KEY_OP_NOMATCH)
545 dbg(KEY_DRIVER " matches");
546 if (rule->driver_operation == KEY_OP_NOMATCH)
549 dbg(KEY_DRIVER " key is true");
552 /* check for matching bus value */
553 if (rule->bus_operation != KEY_OP_UNSET) {
554 if (parent_device == NULL) {
555 dbg("device has no sysfs_device");
558 dbg("check for " KEY_BUS " rule->bus='%s' sysfs_device->bus='%s'",
559 rule->bus, parent_device->bus);
560 if (strcmp_pattern(rule->bus, parent_device->bus) != 0) {
561 dbg(KEY_BUS " is not matching");
562 if (rule->bus_operation != KEY_OP_NOMATCH)
565 dbg(KEY_BUS " matches");
566 if (rule->bus_operation == KEY_OP_NOMATCH)
569 dbg(KEY_BUS " key is true");
572 /* check for matching bus id */
573 if (rule->id_operation != KEY_OP_UNSET) {
574 if (parent_device == NULL) {
575 dbg("device has no sysfs_device");
578 dbg("check " KEY_ID);
579 if (strcmp_pattern(rule->id, parent_device->bus_id) != 0) {
580 dbg(KEY_ID " is not matching");
581 if (rule->id_operation != KEY_OP_NOMATCH)
584 dbg(KEY_ID " matches");
585 if (rule->id_operation == KEY_OP_NOMATCH)
588 dbg(KEY_ID " key is true");
591 /* check for matching sysfs pairs */
592 if (rule->sysfs_pair_count) {
595 dbg("check " KEY_SYSFS " pairs");
596 for (i = 0; i < rule->sysfs_pair_count; i++) {
597 struct key_pair *pair;
598 char value[VALUE_SIZE];
601 pair = &rule->sysfs_pair[i];
602 if (find_sysfs_attribute(class_dev, parent_device, pair->name, value, sizeof(value)) != 0)
605 /* strip trailing whitespace of value, if not asked to match for it */
606 len = strlen(pair->value);
607 if (len && !isspace(pair->value[len-1])) {
609 while (len > 0 && isspace(value[len-1]))
611 dbg("removed %i trailing whitespace chars from '%s'", strlen(value)-len, value);
614 dbg("compare attribute '%s' value '%s' with '%s'", pair->name, value, pair->value);
615 if (strcmp_pattern(pair->value, value) != 0) {
616 dbg(KEY_SYSFS "{'%s'} is not matching", pair->name);
617 if (pair->operation != KEY_OP_NOMATCH)
620 dbg(KEY_SYSFS "{'%s'} matches", pair->name);
621 if (pair->operation == KEY_OP_NOMATCH)
625 dbg(KEY_SYSFS " keys are true");
628 /* found matching physical device */
631 dbg("try parent sysfs device");
632 parent_device = sysfs_get_device_parent(parent_device);
633 if (parent_device == NULL)
635 dbg("look at sysfs_device->path='%s'", parent_device->path);
636 dbg("look at sysfs_device->bus_id='%s'", parent_device->bus_id);
639 /* execute external program */
640 if (rule->program_operation != KEY_OP_UNSET) {
641 char program[PATH_SIZE];
643 dbg("check " KEY_PROGRAM);
644 strlcpy(program, rule->program, sizeof(program));
645 apply_format(udev, program, sizeof(program), class_dev, sysfs_device);
646 if (execute_program(udev, program, udev->program_result, sizeof(udev->program_result)) != 0) {
647 dbg(KEY_PROGRAM " returned nonzero");
648 if (rule->program_operation != KEY_OP_NOMATCH)
651 dbg(KEY_PROGRAM " returned successful");
652 if (rule->program_operation == KEY_OP_NOMATCH)
655 dbg(KEY_PROGRAM " key is true");
658 /* check for matching result of external program */
659 if (rule->result_operation != KEY_OP_UNSET) {
660 dbg("check for " KEY_RESULT " rule->result='%s', udev->program_result='%s'",
661 rule->result, udev->program_result);
662 if (strcmp_pattern(rule->result, udev->program_result) != 0) {
663 dbg(KEY_RESULT " is not matching");
664 if (rule->result_operation != KEY_OP_NOMATCH)
667 dbg(KEY_RESULT " matches");
668 if (rule->result_operation == KEY_OP_NOMATCH)
671 dbg(KEY_RESULT " key is true");
681 int udev_rules_get_name(struct udevice *udev, struct sysfs_class_device *class_dev)
683 struct sysfs_class_device *class_dev_parent;
684 struct sysfs_device *sysfs_device = NULL;
685 struct udev_rule *rule;
687 dbg("class_dev->name='%s'", class_dev->name);
689 /* Figure out where the "device"-symlink is at. For char devices this will
690 * always be in the class_dev->path. On block devices, only the main block
691 * device will have the device symlink in it's path. All partition devices
692 * need to look at the symlink in its parent directory.
694 class_dev_parent = sysfs_get_classdev_parent(class_dev);
695 if (class_dev_parent != NULL) {
696 dbg("given class device has a parent, use this instead");
697 sysfs_device = sysfs_get_classdev_device(class_dev_parent);
699 sysfs_device = sysfs_get_classdev_device(class_dev);
703 dbg("found devices device: path='%s', bus_id='%s', bus='%s'",
704 sysfs_device->path, sysfs_device->bus_id, sysfs_device->bus);
705 strlcpy(udev->bus_id, sysfs_device->bus_id, sizeof(udev->bus_id));
708 dbg("udev->kernel_name='%s'", udev->kernel_name);
710 /* look for a matching rule to apply */
711 list_for_each_entry(rule, &udev_rule_list, node) {
713 if (match_rule(udev, rule, class_dev, sysfs_device) == 0) {
716 if (rule->ignore_device) {
717 info("configured rule in '%s[%i]' applied, '%s' is ignored",
718 rule->config_file, rule->config_line, udev->kernel_name);
721 if (rule->ignore_remove) {
722 udev->ignore_remove = 1;
723 dbg("remove event should be ignored");
725 /* apply all_partitions option only at a main block device */
726 if (rule->partitions && udev->type == DEV_BLOCK && udev->kernel_number[0] == '\0') {
727 udev->partitions = rule->partitions;
728 dbg("creation of partition nodes requested");
731 /* apply permissions */
732 if (rule->mode != 0000) {
733 udev->mode = rule->mode;
734 dbg("applied mode=%#o to '%s'", udev->mode, udev->kernel_name);
736 if (rule->owner[0] != '\0') {
737 strlcpy(udev->owner, rule->owner, sizeof(udev->owner));
738 apply_format(udev, udev->owner, sizeof(udev->owner), class_dev, sysfs_device);
739 dbg("applied owner='%s' to '%s'", udev->owner, udev->kernel_name);
741 if (rule->group[0] != '\0') {
742 strlcpy(udev->group, rule->group, sizeof(udev->group));
743 apply_format(udev, udev->group, sizeof(udev->group), class_dev, sysfs_device);
744 dbg("applied group='%s' to '%s'", udev->group, udev->kernel_name);
747 /* collect symlinks */
748 if (rule->symlink[0] != '\0') {
749 char temp[PATH_SIZE];
752 info("configured rule in '%s[%i]' applied, added symlink '%s'",
753 rule->config_file, rule->config_line, rule->symlink);
754 strlcpy(temp, rule->symlink, sizeof(temp));
755 apply_format(udev, temp, sizeof(temp), class_dev, sysfs_device);
757 /* add multiple symlinks separated by spaces */
759 next = strchr(temp, ' ');
762 info("add symlink '%s'", pos);
763 name_list_add(&udev->symlink_list, pos, 0);
765 next = strchr(pos, ' ');
767 info("add symlink '%s'", pos);
768 name_list_add(&udev->symlink_list, pos, 0);
772 if (rule->name[0] != '\0') {
773 info("configured rule in '%s[%i]' applied, '%s' becomes '%s'",
774 rule->config_file, rule->config_line, udev->kernel_name, rule->name);
776 strlcpy(udev->name, rule->name, sizeof(udev->name));
777 apply_format(udev, udev->name, sizeof(udev->name), class_dev, sysfs_device);
778 strlcpy(udev->config_file, rule->config_file, sizeof(udev->config_file));
779 udev->config_line = rule->config_line;
781 if (udev->type != DEV_NET)
782 dbg("name, '%s' is going to have owner='%s', group='%s', mode=%#o partitions=%i",
783 udev->name, udev->owner, udev->group, udev->mode, udev->partitions);
788 if (rule->last_rule) {
789 dbg("last rule to be applied");
796 if (udev->name[0] == '\0') {
797 /* no rule matched, so we use the kernel name */
798 strlcpy(udev->name, udev->kernel_name, sizeof(udev->name));
799 info("no rule found, use kernel name '%s'", udev->name);
802 if (udev->tmp_node[0] != '\0') {
803 dbg("removing temporary device node");
804 unlink_secure(udev->tmp_node);
805 udev->tmp_node[0] = '\0';