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);
207 if (strlen(udev->devpath) == 0)
209 strfieldcatmax(string, udev->devpath, maxsize);
210 dbg("substitute kernel name '%s'", udev->kernel_name);
213 if (strlen(udev->bus_id) == 0)
215 strfieldcatmax(string, udev->bus_id, maxsize);
216 dbg("substitute bus_id '%s'", udev->bus_id);
219 if (strlen(udev->kernel_name) == 0)
221 strfieldcatmax(string, udev->kernel_name, maxsize);
222 dbg("substitute kernel name '%s'", udev->kernel_name);
225 if (strlen(udev->kernel_number) == 0)
227 strfieldcatmax(string, udev->kernel_number, maxsize);
228 dbg("substitute kernel number '%s'", udev->kernel_number);
231 strintcatmax(string, udev->minor, maxsize);
232 dbg("substitute minor number '%u'", udev->minor);
235 strintcatmax(string, udev->major, maxsize);
236 dbg("substitute major number '%u'", udev->major);
239 if (strlen(udev->program_result) == 0)
241 /* get part part of the result string */
244 i = strtoul(attr, &rest, 10);
246 foreach_strpart(udev->program_result, " \n\r", spos, slen) {
252 dbg("requested part of result string not found");
256 strfieldcpy(temp2, spos);
258 strfieldcpymax(temp2, spos, slen+1);
259 strfieldcatmax(string, temp2, maxsize);
260 dbg("substitute part of result string '%s'", temp2);
262 strfieldcatmax(string, udev->program_result, maxsize);
263 dbg("substitute result string '%s'", udev->program_result);
268 tmpattr = find_sysfs_attribute(class_dev, sysfs_device, attr);
269 if (tmpattr == NULL) {
270 dbg("sysfa attribute '%s' not found", attr);
273 /* strip trailing whitespace of matching value */
274 if (isspace(tmpattr->value[strlen(tmpattr->value)-1])) {
275 i = len = strlen(tmpattr->value);
276 while (i > 0 && isspace(tmpattr->value[i-1]))
279 tmpattr->value[i] = '\0';
280 dbg("remove %i trailing whitespace chars from '%s'",
281 len - i, tmpattr->value);
284 strfieldcatmax(string, tmpattr->value, maxsize);
285 dbg("substitute sysfs value '%s'", tmpattr->value);
287 dbg("missing attribute");
291 strfieldcatmax(string, "%", maxsize);
295 next_free_number = find_free_number(udev, string);
296 if (next_free_number > 0) {
297 sprintf(temp2, "%d", next_free_number);
298 strfieldcatmax(string, temp2, maxsize);
302 class_dev_parent = sysfs_get_classdev_parent(class_dev);
303 if (class_dev_parent != NULL) {
304 struct udevice udev_parent;
306 dbg("found parent '%s', get the node name", class_dev_parent->path);
307 memset(&udev_parent, 0x00, sizeof(struct udevice));
308 /* lookup the name in the udev_db with the DEVPATH of the parent */
309 strfieldcpy(udev_parent.devpath, &class_dev_parent->path[strlen(sysfs_path)]);
310 if (udev_db_get_device(&udev_parent) == 0) {
311 strfieldcatmax(string, udev_parent.name, maxsize);
312 dbg("substitute parent node name'%s'", udev_parent.name);
314 dbg("parent not found in database");
318 if (udev->tmp_node[0] == '\0') {
319 dbg("create temporary device node for callout");
320 snprintf(udev->tmp_node, NAME_SIZE-1, "%s/.tmp-%u-%u", udev_root, udev->major, udev->minor);
321 udev_make_node(udev, udev->tmp_node, udev->major, udev->minor, 0600, 0, 0);
323 strfieldcatmax(string, udev->tmp_node, maxsize);
324 dbg("substitute temporary device node name '%s'", udev->tmp_node);
327 strfieldcatmax(string, udev_root, maxsize);
328 dbg("substitute udev_root '%s'", udev_root);
331 dbg("unknown substitution type '%%%c'", c);
334 /* truncate to specified length */
338 strfieldcatmax(string, tail, maxsize);
342 static void fix_kernel_name(struct udevice *udev)
344 char *temp = udev->kernel_name;
346 while (*temp != 0x00) {
347 /* Some block devices have a ! in their name,
348 * we need to change that to / */
355 static int execute_program(struct udevice *udev, const char *path, char *value, int len)
363 char arg[PROGRAM_SIZE];
364 char *argv[(PROGRAM_SIZE / 2) + 1];
367 strfieldcpy(arg, path);
369 if (strchr(path, ' ')) {
371 while (pos != NULL) {
372 if (pos[0] == '\'') {
373 /* don't separate if in apostrophes */
375 argv[i] = strsep(&pos, "\'");
376 while (pos && pos[0] == ' ')
379 argv[i] = strsep(&pos, " ");
381 dbg("arg[%i] '%s'", i, argv[i]);
385 dbg("execute '%s' with parsed arguments", arg);
388 argv[1] = udev->subsystem;
390 dbg("execute '%s' with subsystem '%s' argument", arg, argv[1]);
403 /* dup2 write side of pipe to STDOUT */
404 dup2(fds[1], STDOUT_FILENO);
405 retval = execv(arg, argv);
407 info(FIELD_PROGRAM " execution of '%s' failed", path);
413 /* parent reads from fds[0] */
418 count = read(fds[0], value + i, len - i-1);
424 dbg("result len %d too short", len);
431 dbg("read failed with '%s'", strerror(errno));
435 if (i > 0 && value[i-1] == '\n')
438 dbg("result is '%s'", value);
441 waitpid(pid, &status, 0);
443 if (!WIFEXITED(status) || (WEXITSTATUS(status) != 0)) {
444 dbg("exec program status 0x%x", status);
451 static struct sysfs_attribute *find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, char *attr)
453 struct sysfs_attribute *tmpattr = NULL;
456 dbg("look for device attribute '%s'", attr);
457 /* try to find the attribute in the class device directory */
458 tmpattr = sysfs_get_classdev_attr(class_dev, attr);
462 /* look in the class device directory if present */
464 tmpattr = sysfs_get_device_attr(sysfs_device, attr);
472 c = strchr(tmpattr->value, '\n');
476 dbg("found attribute '%s'", tmpattr->path);
480 static int compare_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, struct sysfs_pair *pair)
482 struct sysfs_attribute *tmpattr;
486 if ((pair == NULL) || (pair->file[0] == '\0') || (pair->value == '\0'))
489 tmpattr = find_sysfs_attribute(class_dev, sysfs_device, pair->file);
493 /* strip trailing whitespace of value, if not asked to match for it */
494 if (! isspace(pair->value[strlen(pair->value)-1])) {
495 i = len = strlen(tmpattr->value);
496 while (i > 0 && isspace(tmpattr->value[i-1]))
499 tmpattr->value[i] = '\0';
500 dbg("remove %i trailing whitespace chars from '%s'",
501 len - i, tmpattr->value);
505 dbg("compare attribute '%s' value '%s' with '%s'",
506 pair->file, tmpattr->value, pair->value);
507 if (strcmp_pattern(pair->value, tmpattr->value) != 0)
510 dbg("found matching attribute '%s' with value '%s'",
511 pair->file, pair->value);
515 static int match_sysfs_pairs(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
517 struct sysfs_pair *pair;
520 for (i = 0; i < MAX_SYSFS_PAIRS; ++i) {
521 pair = &dev->sysfs_pair[i];
522 if ((pair->file[0] == '\0') || (pair->value[0] == '\0'))
524 if (compare_sysfs_attribute(class_dev, sysfs_device, pair) != 0) {
525 dbg("sysfs attribute doesn't match");
533 static int match_id(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
535 char path[SYSFS_PATH_MAX];
538 /* we have to have a sysfs device for ID to work */
542 strfieldcpy(path, sysfs_device->path);
543 temp = strrchr(path, '/');
545 dbg("search '%s' in '%s', path='%s'", dev->id, temp, path);
546 if (strcmp_pattern(dev->id, temp) != 0)
552 static int match_place(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
554 char path[SYSFS_PATH_MAX];
558 /* we have to have a sysfs device for PLACE to work */
563 strfieldcpy(path, sysfs_device->path);
564 temp = strrchr(path, '/');
565 dbg("search '%s' in '%s', path='%s'", dev->place, temp, path);
566 if (strstr(temp, dev->place) != NULL) {
570 temp = strrchr(path, '/');
571 dbg("search '%s' in '%s', path='%s'", dev->place, temp, path);
572 if (strstr(temp, dev->place) != NULL)
576 dbg("place doesn't match");
583 static int match_rule(struct udevice *udev, struct config_device *dev,
584 struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
586 /* check for matching kernel name */
587 if (dev->kernel[0] != '\0') {
588 dbg("check for " FIELD_KERNEL " dev->kernel='%s' class_dev->name='%s'",
589 dev->kernel, class_dev->name);
590 if (strcmp_pattern(dev->kernel, class_dev->name) != 0) {
591 dbg(FIELD_KERNEL " is not matching");
594 dbg(FIELD_KERNEL " matches");
597 /* check for matching subsystem */
598 if (dev->subsystem[0] != '\0') {
599 dbg("check for " FIELD_SUBSYSTEM " dev->subsystem='%s' class_dev->name='%s'",
600 dev->subsystem, class_dev->name);
601 if (strcmp_pattern(dev->subsystem, udev->subsystem) != 0) {
602 dbg(FIELD_SUBSYSTEM " is not matching");
605 dbg(FIELD_SUBSYSTEM " matches");
608 /* walk up the chain of physical devices and find a match */
610 /* check for matching driver */
611 if (dev->driver[0] != '\0') {
612 dbg("check for " FIELD_DRIVER " dev->driver='%s' sysfs_device->driver_name='%s'",
613 dev->driver, sysfs_device->driver_name);
614 if (strcmp_pattern(dev->driver, sysfs_device->driver_name) != 0) {
615 dbg(FIELD_DRIVER " is not matching");
618 dbg(FIELD_DRIVER " matches");
621 /* check for matching bus value */
622 if (dev->bus[0] != '\0') {
623 if (sysfs_device == NULL) {
624 dbg("device has no bus");
627 dbg("check for " FIELD_BUS " dev->bus='%s' sysfs_device->bus='%s'",
628 dev->bus, sysfs_device->bus);
629 if (strcmp_pattern(dev->bus, sysfs_device->bus) != 0) {
630 dbg(FIELD_BUS " is not matching");
633 dbg(FIELD_BUS " matches");
636 /* check for matching bus id */
637 if (dev->id[0] != '\0') {
638 dbg("check " FIELD_ID);
639 if (match_id(dev, class_dev, sysfs_device) != 0) {
640 dbg(FIELD_ID " is not matching");
643 dbg(FIELD_ID " matches");
646 /* check for matching place of device */
647 if (dev->place[0] != '\0') {
648 dbg("check " FIELD_PLACE);
649 if (match_place(dev, class_dev, sysfs_device) != 0) {
650 dbg(FIELD_PLACE " is not matching");
653 dbg(FIELD_PLACE " matches");
656 /* check for matching sysfs pairs */
657 if (dev->sysfs_pair[0].file[0] != '\0') {
658 dbg("check " FIELD_SYSFS " pairs");
659 if (match_sysfs_pairs(dev, class_dev, sysfs_device) != 0) {
660 dbg(FIELD_SYSFS " is not matching");
663 dbg(FIELD_SYSFS " matches");
666 /* found matching physical device */
669 dbg("try parent sysfs device");
670 sysfs_device = sysfs_get_device_parent(sysfs_device);
671 if (sysfs_device == NULL)
673 dbg("sysfs_device->path='%s'", sysfs_device->path);
674 dbg("sysfs_device->bus_id='%s'", sysfs_device->bus_id);
677 /* execute external program */
678 if (dev->program[0] != '\0') {
679 char program[PROGRAM_SIZE];
681 dbg("check " FIELD_PROGRAM);
682 strfieldcpy(program, dev->program);
683 apply_format(udev, program, sizeof(program), class_dev, sysfs_device);
684 if (execute_program(udev, program, udev->program_result, NAME_SIZE) != 0) {
685 dbg(FIELD_PROGRAM " returned nonzero");
688 dbg(FIELD_PROGRAM " returned successful");
691 /* check for matching result of external program */
692 if (dev->result[0] != '\0') {
693 dbg("check for " FIELD_RESULT " dev->result='%s', udev->program_result='%s'",
694 dev->result, udev->program_result);
695 if (strcmp_pattern(dev->result, udev->program_result) != 0) {
696 dbg(FIELD_RESULT " is not matching");
699 dbg(FIELD_RESULT " matches");
709 int namedev_name_device(struct udevice *udev, struct sysfs_class_device *class_dev)
711 struct sysfs_class_device *class_dev_parent;
712 struct sysfs_device *sysfs_device = NULL;
713 struct config_device *dev;
716 dbg("class_dev->name='%s'", class_dev->name);
718 /* Figure out where the "device"-symlink is at. For char devices this will
719 * always be in the class_dev->path. On block devices, only the main block
720 * device will have the device symlink in it's path. All partition devices
721 * need to look at the symlink in its parent directory.
723 class_dev_parent = sysfs_get_classdev_parent(class_dev);
724 if (class_dev_parent != NULL) {
725 dbg("given class device has a parent, use this instead");
726 sysfs_device = sysfs_get_classdev_device(class_dev_parent);
728 sysfs_device = sysfs_get_classdev_device(class_dev);
732 dbg("found devices device: path='%s', bus_id='%s', bus='%s'",
733 sysfs_device->path, sysfs_device->bus_id, sysfs_device->bus);
734 strfieldcpy(udev->bus_id, sysfs_device->bus_id);
737 strfieldcpy(udev->kernel_name, class_dev->name);
738 fix_kernel_name(udev);
739 dbg("udev->kernel_name = '%s'", udev->kernel_name);
741 /* get kernel number */
742 pos = class_dev->name + strlen(class_dev->name);
743 while (isdigit(*(pos-1)))
745 strfieldcpy(udev->kernel_number, pos);
746 dbg("kernel_number='%s'", udev->kernel_number);
748 /* look for a matching rule to apply */
749 list_for_each_entry(dev, &config_device_list, node) {
751 if (match_rule(udev, dev, class_dev, sysfs_device) == 0) {
753 /* FIXME: remove old style ignore rule and make OPTION="ignore" mandatory */
754 if (dev->name[0] == '\0' && dev->symlink[0] == '\0' &&
755 dev->mode == 0000 && dev->owner[0] == '\0' && dev->group[0] == '\0' &&
756 !dev->ignore_device && !dev->partitions && !dev->ignore_remove) {
757 info("configured rule in '%s[%i]' applied, '%s' is ignored",
758 dev->config_file, dev->config_line, udev->kernel_name);
763 if (dev->ignore_device) {
764 info("configured rule in '%s[%i]' applied, '%s' is ignored",
765 dev->config_file, dev->config_line, udev->kernel_name);
768 if (dev->ignore_remove) {
769 udev->ignore_remove = dev->ignore_remove;
770 dbg_parse("remove event should be ignored");
772 /* apply all_partitions option only at a main block device */
773 if (dev->partitions && udev->type == 'b' && udev->kernel_number[0] == '\0') {
774 udev->partitions = dev->partitions;
775 dbg("creation of partition nodes requested");
778 /* apply permissions */
779 if (dev->mode != 0000) {
780 udev->mode = dev->mode;
781 dbg("applied mode=%#o to '%s'", udev->mode, udev->kernel_name);
783 if (dev->owner[0] != '\0') {
784 strfieldcpy(udev->owner, dev->owner);
785 apply_format(udev, udev->owner, sizeof(udev->owner), class_dev, sysfs_device);
786 dbg("applied owner='%s' to '%s'", udev->owner, udev->kernel_name);
788 if (dev->group[0] != '\0') {
789 strfieldcpy(udev->group, dev->group);
790 apply_format(udev, udev->group, sizeof(udev->group), class_dev, sysfs_device);
791 dbg("applied group='%s' to '%s'", udev->group, udev->kernel_name);
794 /* collect symlinks for this or the final matching rule */
795 if (dev->symlink[0] != '\0') {
796 char temp[NAME_SIZE];
798 info("configured rule in '%s[%i]' applied, added symlink '%s'",
799 dev->config_file, dev->config_line, dev->symlink);
800 strfieldcpy(temp, dev->symlink);
801 apply_format(udev, temp, sizeof(temp), class_dev, sysfs_device);
802 if (udev->symlink[0] != '\0')
803 strfieldcat(udev->symlink, " ");
804 strfieldcat(udev->symlink, temp);
808 if (dev->name[0] != '\0') {
809 info("configured rule in '%s[%i]' applied, '%s' becomes '%s'",
810 dev->config_file, dev->config_line, udev->kernel_name, dev->name);
812 strfieldcpy(udev->name, dev->name);
813 apply_format(udev, udev->name, sizeof(udev->name), class_dev, sysfs_device);
814 strfieldcpy(udev->config_file, dev->config_file);
815 udev->config_line = dev->config_line;
817 if (udev->type != 'n')
818 dbg("name, '%s' is going to have owner='%s', group='%s', mode=%#o partitions=%i",
819 udev->name, udev->owner, udev->group, udev->mode, udev->partitions);
826 /* no rule matched, so we use the kernel name */
827 strfieldcpy(udev->name, udev->kernel_name);
828 dbg("no rule found, use kernel name '%s'", udev->name);
831 if (udev->tmp_node[0] != '\0') {
832 dbg("removing temporary device node");
833 unlink_secure(udev->tmp_node);
834 udev->tmp_node[0] = '\0';