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"
39 #include "udev_utils.h"
40 #include "udev_version.h"
45 static struct sysfs_attribute *find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, char *attr);
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 dbg("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 dbg("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 filename[NAME_SIZE];
149 struct udevice db_udev;
151 strfieldcpy(filename, name);
153 dbg("look for existing node '%s'", filename);
154 memset(&db_udev, 0x00, sizeof(struct udevice));
155 if (udev_db_get_device_byname(&db_udev, filename) != 0) {
156 dbg("free num=%d", num);
162 info("find_free_number gone crazy (num=%d), aborted", num);
165 snprintf(filename, NAME_SIZE, "%s%d", name, num);
166 filename[NAME_SIZE-1] = '\0';
170 static void apply_format(struct udevice *udev, char *string, size_t maxsize,
171 struct sysfs_class_device *class_dev,
172 struct sysfs_device *sysfs_device)
174 char temp[NAME_SIZE];
175 char temp2[NAME_SIZE];
185 struct sysfs_attribute *tmpattr;
186 unsigned int next_free_number;
187 struct sysfs_class_device *class_dev_parent;
191 pos = strchr(pos, '%');
197 len = get_format_len(&tail);
199 strfieldcpy(temp, tail+1);
201 dbg("format=%c, string='%s', tail='%s'",c , string, tail);
202 attr = get_format_attribute(&tail);
206 if (strlen(udev->devpath) == 0)
208 strfieldcatmax(string, udev->devpath, maxsize);
209 dbg("substitute kernel name '%s'", udev->kernel_name);
212 if (strlen(udev->bus_id) == 0)
214 strfieldcatmax(string, udev->bus_id, maxsize);
215 dbg("substitute bus_id '%s'", udev->bus_id);
218 if (strlen(udev->kernel_name) == 0)
220 strfieldcatmax(string, udev->kernel_name, maxsize);
221 dbg("substitute kernel name '%s'", udev->kernel_name);
224 if (strlen(udev->kernel_number) == 0)
226 strfieldcatmax(string, udev->kernel_number, maxsize);
227 dbg("substitute kernel number '%s'", udev->kernel_number);
230 strintcatmax(string, minor(udev->devt), maxsize);
231 dbg("substitute minor number '%u'", minor(udev->devt));
234 strintcatmax(string, major(udev->devt), maxsize);
235 dbg("substitute major number '%u'", major(udev->devt));
238 if (strlen(udev->program_result) == 0)
240 /* get part part of the result string */
243 i = strtoul(attr, &rest, 10);
245 foreach_strpart(udev->program_result, " \n\r", spos, slen) {
251 dbg("requested part of result string not found");
255 strfieldcpy(temp2, spos);
257 strfieldcpymax(temp2, spos, slen+1);
258 strfieldcatmax(string, temp2, maxsize);
259 dbg("substitute part of result string '%s'", temp2);
261 strfieldcatmax(string, udev->program_result, maxsize);
262 dbg("substitute result string '%s'", udev->program_result);
269 dbg("missing attribute");
272 tmpattr = find_sysfs_attribute(class_dev, sysfs_device, attr);
273 if (tmpattr == NULL) {
274 dbg("sysfa attribute '%s' not found", attr);
277 /* strip trailing whitespace of matching value */
278 if (isspace(tmpattr->value[strlen(tmpattr->value)-1])) {
279 i = len = strlen(tmpattr->value);
280 while (i > 0 && isspace(tmpattr->value[i-1]))
283 tmpattr->value[i] = '\0';
284 dbg("remove %i trailing whitespace chars from '%s'",
285 len - i, tmpattr->value);
288 strfieldcatmax(string, tmpattr->value, maxsize);
289 dbg("substitute sysfs value '%s'", tmpattr->value);
292 strfieldcatmax(string, "%", maxsize);
296 next_free_number = find_free_number(udev, string);
297 if (next_free_number > 0) {
298 sprintf(temp2, "%d", next_free_number);
299 strfieldcatmax(string, temp2, maxsize);
305 class_dev_parent = sysfs_get_classdev_parent(class_dev);
306 if (class_dev_parent != NULL) {
307 struct udevice udev_parent;
309 dbg("found parent '%s', get the node name", class_dev_parent->path);
310 memset(&udev_parent, 0x00, sizeof(struct udevice));
311 /* lookup the name in the udev_db with the DEVPATH of the parent */
312 if (udev_db_get_device_by_devpath(&udev_parent, &class_dev_parent->path[strlen(sysfs_path)]) == 0) {
313 strfieldcatmax(string, udev_parent.name, maxsize);
314 dbg("substitute parent node name'%s'", udev_parent.name);
316 dbg("parent not found in database");
320 if (udev->tmp_node[0] == '\0') {
321 dbg("create temporary device node for callout");
322 snprintf(udev->tmp_node, NAME_SIZE, "%s/.tmp-%u-%u", udev_root, major(udev->devt), minor(udev->devt));
323 udev->tmp_node[NAME_SIZE] = '\0';
324 udev_make_node(udev, udev->tmp_node, udev->devt, 0600, 0, 0);
326 strfieldcatmax(string, udev->tmp_node, maxsize);
327 dbg("substitute temporary device node name '%s'", udev->tmp_node);
330 strfieldcatmax(string, udev_root, maxsize);
331 dbg("substitute udev_root '%s'", udev_root);
334 dbg("unknown substitution type '%%%c'", c);
337 /* truncate to specified length */
341 strfieldcatmax(string, tail, maxsize);
345 static int execute_program(struct udevice *udev, const char *path, char *value, int len)
353 char arg[PROGRAM_SIZE];
354 char *argv[(PROGRAM_SIZE / 2) + 1];
357 strfieldcpy(arg, path);
359 if (strchr(path, ' ')) {
361 while (pos != NULL) {
362 if (pos[0] == '\'') {
363 /* don't separate if in apostrophes */
365 argv[i] = strsep(&pos, "\'");
366 while (pos && pos[0] == ' ')
369 argv[i] = strsep(&pos, " ");
371 dbg("arg[%i] '%s'", i, argv[i]);
375 dbg("execute '%s' with parsed arguments", arg);
378 argv[1] = udev->subsystem;
380 dbg("execute '%s' with subsystem '%s' argument", arg, argv[1]);
393 /* dup2 write side of pipe to STDOUT */
394 dup2(fds[1], STDOUT_FILENO);
395 retval = execv(arg, argv);
397 info(FIELD_PROGRAM " execution of '%s' failed", path);
403 /* parent reads from fds[0] */
408 count = read(fds[0], value + i, len - i-1);
414 dbg("result len %d too short", len);
421 dbg("read failed with '%s'", strerror(errno));
425 if (i > 0 && value[i-1] == '\n')
428 dbg("result is '%s'", value);
431 waitpid(pid, &status, 0);
433 if (!WIFEXITED(status) || (WEXITSTATUS(status) != 0)) {
434 dbg("exec program status 0x%x", status);
441 static struct sysfs_attribute *find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, char *attr)
443 struct sysfs_attribute *tmpattr = NULL;
446 dbg("look for device attribute '%s'", attr);
447 /* try to find the attribute in the class device directory */
448 tmpattr = sysfs_get_classdev_attr(class_dev, attr);
452 /* look in the class device directory if present */
454 tmpattr = sysfs_get_device_attr(sysfs_device, attr);
462 c = strchr(tmpattr->value, '\n');
466 dbg("found attribute '%s'", tmpattr->path);
470 static int compare_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, struct sysfs_pair *pair)
472 struct sysfs_attribute *tmpattr;
476 if ((pair == NULL) || (pair->file[0] == '\0') || (pair->value == '\0'))
479 tmpattr = find_sysfs_attribute(class_dev, sysfs_device, pair->file);
483 /* strip trailing whitespace of value, if not asked to match for it */
484 if (! isspace(pair->value[strlen(pair->value)-1])) {
485 i = len = strlen(tmpattr->value);
486 while (i > 0 && isspace(tmpattr->value[i-1]))
489 tmpattr->value[i] = '\0';
490 dbg("remove %i trailing whitespace chars from '%s'",
491 len - i, tmpattr->value);
495 dbg("compare attribute '%s' value '%s' with '%s'",
496 pair->file, tmpattr->value, pair->value);
497 if (strcmp_pattern(pair->value, tmpattr->value) != 0)
500 dbg("found matching attribute '%s' with value '%s'",
501 pair->file, pair->value);
505 static int match_sysfs_pairs(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
507 struct sysfs_pair *pair;
510 for (i = 0; i < MAX_SYSFS_PAIRS; ++i) {
511 pair = &dev->sysfs_pair[i];
512 if ((pair->file[0] == '\0') || (pair->value[0] == '\0'))
514 if (compare_sysfs_attribute(class_dev, sysfs_device, pair) != 0) {
515 dbg("sysfs attribute doesn't match");
523 static int match_id(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
525 char path[SYSFS_PATH_MAX];
528 /* we have to have a sysfs device for ID to work */
532 strfieldcpy(path, sysfs_device->path);
533 temp = strrchr(path, '/');
535 dbg("search '%s' in '%s', path='%s'", dev->id, temp, path);
536 if (strcmp_pattern(dev->id, temp) != 0)
542 static int match_place(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
544 char path[SYSFS_PATH_MAX];
547 /* we have to have a sysfs device for PLACE to work */
551 strfieldcpy(path, sysfs_device->path);
552 temp = strrchr(path, '/');
553 dbg("search '%s' in '%s', path='%s'", dev->place, temp, path);
554 if (strstr(temp, dev->place) != NULL)
559 temp = strrchr(path, '/');
560 dbg("search '%s' in '%s', path='%s'", dev->place, temp, path);
561 if (strstr(temp, dev->place) == NULL)
564 dbg("place doesn't match");
568 static int match_rule(struct udevice *udev, struct config_device *dev,
569 struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
571 if (dev->kernel[0] != '\0') {
572 dbg("check for " FIELD_KERNEL " dev->kernel='%s' class_dev->name='%s'",
573 dev->kernel, class_dev->name);
574 if (strcmp_pattern(dev->kernel, class_dev->name) != 0) {
575 dbg(FIELD_KERNEL " is not matching");
578 dbg(FIELD_KERNEL " matches");
581 if (dev->subsystem[0] != '\0') {
582 dbg("check for " FIELD_SUBSYSTEM " dev->subsystem='%s' class_dev->name='%s'",
583 dev->subsystem, class_dev->name);
584 if (strcmp_pattern(dev->subsystem, udev->subsystem) != 0) {
585 dbg(FIELD_SUBSYSTEM " is not matching");
588 dbg(FIELD_SUBSYSTEM " matches");
591 /* walk up the chain of physical devices and find a match */
593 /* check for matching driver */
594 if (dev->driver[0] != '\0') {
595 dbg("check for " FIELD_DRIVER " dev->driver='%s' sysfs_device->driver_name='%s'",
596 dev->driver, sysfs_device->driver_name);
597 if (strcmp_pattern(dev->driver, sysfs_device->driver_name) != 0) {
598 dbg(FIELD_DRIVER " is not matching");
601 dbg(FIELD_DRIVER " matches");
604 /* check for matching bus value */
605 if (dev->bus[0] != '\0') {
606 if (sysfs_device == NULL) {
607 dbg("device has no bus");
610 dbg("check for " FIELD_BUS " dev->bus='%s' sysfs_device->bus='%s'",
611 dev->bus, sysfs_device->bus);
612 if (strcmp_pattern(dev->bus, sysfs_device->bus) != 0) {
613 dbg(FIELD_BUS " is not matching");
616 dbg(FIELD_BUS " matches");
619 /* check for matching bus id */
620 if (dev->id[0] != '\0') {
621 dbg("check " FIELD_ID);
622 if (match_id(dev, class_dev, sysfs_device) != 0) {
623 dbg(FIELD_ID " is not matching");
626 dbg(FIELD_ID " matches");
629 /* check for matching place of device */
630 if (dev->place[0] != '\0') {
631 dbg("check " FIELD_PLACE);
632 if (match_place(dev, class_dev, sysfs_device) != 0) {
633 dbg(FIELD_PLACE " is not matching");
636 dbg(FIELD_PLACE " matches");
639 /* check for matching sysfs pairs */
640 if (dev->sysfs_pair[0].file[0] != '\0') {
641 dbg("check " FIELD_SYSFS " pairs");
642 if (match_sysfs_pairs(dev, class_dev, sysfs_device) != 0) {
643 dbg(FIELD_SYSFS " is not matching");
646 dbg(FIELD_SYSFS " matches");
649 /* found matching physical device */
652 dbg("try parent sysfs device");
653 sysfs_device = sysfs_get_device_parent(sysfs_device);
654 if (sysfs_device == NULL)
656 dbg("sysfs_device->path='%s'", sysfs_device->path);
657 dbg("sysfs_device->bus_id='%s'", sysfs_device->bus_id);
660 /* execute external program */
661 if (dev->program[0] != '\0') {
662 char program[PROGRAM_SIZE];
664 dbg("check " FIELD_PROGRAM);
665 strfieldcpy(program, dev->program);
666 apply_format(udev, program, sizeof(program), class_dev, sysfs_device);
667 if (execute_program(udev, program, udev->program_result, NAME_SIZE) != 0) {
668 dbg(FIELD_PROGRAM " returned nonzero");
671 dbg(FIELD_PROGRAM " returned successful");
674 /* check for matching result of external program */
675 if (dev->result[0] != '\0') {
676 dbg("check for " FIELD_RESULT " dev->result='%s', udev->program_result='%s'",
677 dev->result, udev->program_result);
678 if (strcmp_pattern(dev->result, udev->program_result) != 0) {
679 dbg(FIELD_RESULT " is not matching");
682 dbg(FIELD_RESULT " matches");
692 int namedev_name_device(struct udevice *udev, struct sysfs_class_device *class_dev)
694 struct sysfs_class_device *class_dev_parent;
695 struct sysfs_device *sysfs_device = NULL;
696 struct config_device *dev;
698 dbg("class_dev->name='%s'", class_dev->name);
700 /* Figure out where the "device"-symlink is at. For char devices this will
701 * always be in the class_dev->path. On block devices, only the main block
702 * device will have the device symlink in it's path. All partition devices
703 * need to look at the symlink in its parent directory.
705 class_dev_parent = sysfs_get_classdev_parent(class_dev);
706 if (class_dev_parent != NULL) {
707 dbg("given class device has a parent, use this instead");
708 sysfs_device = sysfs_get_classdev_device(class_dev_parent);
710 sysfs_device = sysfs_get_classdev_device(class_dev);
714 dbg("found devices device: path='%s', bus_id='%s', bus='%s'",
715 sysfs_device->path, sysfs_device->bus_id, sysfs_device->bus);
716 strfieldcpy(udev->bus_id, sysfs_device->bus_id);
719 dbg("udev->kernel_name='%s'", udev->kernel_name);
721 /* look for a matching rule to apply */
722 list_for_each_entry(dev, &config_device_list, node) {
724 if (match_rule(udev, dev, class_dev, sysfs_device) == 0) {
727 if (dev->ignore_device) {
728 info("configured rule in '%s[%i]' applied, '%s' is ignored",
729 dev->config_file, dev->config_line, udev->kernel_name);
732 if (dev->ignore_remove) {
733 udev->ignore_remove = dev->ignore_remove;
734 dbg_parse("remove event should be ignored");
736 /* apply all_partitions option only at a main block device */
737 if (dev->partitions && udev->type == BLOCK && udev->kernel_number[0] == '\0') {
738 udev->partitions = dev->partitions;
739 dbg("creation of partition nodes requested");
742 /* apply permissions */
743 if (dev->mode != 0000) {
744 udev->mode = dev->mode;
745 dbg("applied mode=%#o to '%s'", udev->mode, udev->kernel_name);
747 if (dev->owner[0] != '\0') {
748 strfieldcpy(udev->owner, dev->owner);
749 apply_format(udev, udev->owner, sizeof(udev->owner), class_dev, sysfs_device);
750 dbg("applied owner='%s' to '%s'", udev->owner, udev->kernel_name);
752 if (dev->group[0] != '\0') {
753 strfieldcpy(udev->group, dev->group);
754 apply_format(udev, udev->group, sizeof(udev->group), class_dev, sysfs_device);
755 dbg("applied group='%s' to '%s'", udev->group, udev->kernel_name);
758 /* collect symlinks */
759 if (dev->symlink[0] != '\0') {
760 char temp[NAME_SIZE];
762 info("configured rule in '%s[%i]' applied, added symlink '%s'",
763 dev->config_file, dev->config_line, dev->symlink);
764 strfieldcpy(temp, dev->symlink);
765 apply_format(udev, temp, sizeof(temp), class_dev, sysfs_device);
766 if (udev->symlink[0] != '\0')
767 strfieldcat(udev->symlink, " ");
768 strfieldcat(udev->symlink, temp);
772 if (dev->name[0] != '\0') {
773 info("configured rule in '%s[%i]' applied, '%s' becomes '%s'",
774 dev->config_file, dev->config_line, udev->kernel_name, dev->name);
776 strfieldcpy(udev->name, dev->name);
777 apply_format(udev, udev->name, sizeof(udev->name), class_dev, sysfs_device);
778 strfieldcpy(udev->config_file, dev->config_file);
779 udev->config_line = dev->config_line;
781 if (udev->type != 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);
790 /* no rule matched, so we use the kernel name */
791 strfieldcpy(udev->name, udev->kernel_name);
792 dbg("no rule found, use kernel name '%s'", udev->name);
795 if (udev->tmp_node[0] != '\0') {
796 dbg("removing temporary device node");
797 unlink_secure(udev->tmp_node);
798 udev->tmp_node[0] = '\0';