6 * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation version 2 of the License.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 675 Mass Ave, Cambridge, MA 02139, USA.
36 #include "libsysfs/sysfs/libsysfs.h"
39 #include "udev_version.h"
42 #include "klibc_fixups.h"
44 static struct sysfs_attribute *find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, char *attr);
46 LIST_HEAD(config_device_list);
47 LIST_HEAD(perm_device_list);
49 /* compare string with pattern (supports * ? [0-9] [!A-Z]) */
50 static int strcmp_pattern(const char *p, const char *s)
55 return (p[0] != '\0');
66 while ((p[0] != '\0') && (p[0] != ']')) {
69 if ((s[0] >= p[0]) && (s[0] <= p[2]))
73 match = (p[0] == s[0]);
77 while ((p[0] != '\0') && (p[0] != ']'))
80 return strcmp_pattern(p+1, s+1);
86 if (strcmp_pattern(p, s+1))
87 return strcmp_pattern(p+1, s);
95 if ((p[0] == s[0]) || (p[0] == '?'))
96 return strcmp_pattern(p+1, s+1);
102 #define copy_var(a, b, var) \
106 #define copy_string(a, b, var) \
107 if (strlen(b->var)) \
108 strcpy(a->var, b->var);
110 int add_perm_dev(struct perm_device *new_dev)
112 struct perm_device *dev;
113 struct perm_device *tmp_dev;
115 /* update the values if we already have the device */
116 list_for_each_entry(dev, &perm_device_list, node) {
117 if (strcmp(new_dev->name, dev->name))
119 copy_var(dev, new_dev, mode);
120 copy_string(dev, new_dev, owner);
121 copy_string(dev, new_dev, group);
125 /* not found, add new structure to the perm list */
126 tmp_dev = malloc(sizeof(*tmp_dev));
129 memcpy(tmp_dev, new_dev, sizeof(*tmp_dev));
130 list_add_tail(&tmp_dev->node, &perm_device_list);
131 //dump_perm_dev(tmp_dev);
135 static struct perm_device *find_perm(char *name)
137 struct perm_device *perm;
139 list_for_each_entry(perm, &perm_device_list, node) {
140 if (strcmp_pattern(perm->name, name))
147 static mode_t get_default_mode(void)
149 mode_t mode = 0600; /* default to owner rw only */
151 if (strlen(default_mode_str) != 0)
152 mode = strtol(default_mode_str, NULL, 8);
157 static char *get_default_owner(void)
159 if (strlen(default_owner_str) == 0)
160 strfieldcpy(default_owner_str, "root");
162 return default_owner_str;
165 static char *get_default_group(void)
167 if (strlen(default_group_str) == 0)
168 strfieldcpy(default_group_str, "root");
170 return default_group_str;
173 /* extract possible {attr} and move str behind it */
174 static char *get_format_attribute(char **str)
179 if (*str[0] == '{') {
180 pos = strchr(*str, '}');
182 dbg("missing closing brace for format");
188 dbg("attribute='%s', str='%s'", attr, *str);
193 /* extract possible format length and move str behind it*/
194 static int get_format_len(char **str)
199 if (isdigit(*str[0])) {
200 num = (int) strtoul(*str, &tail, 10);
203 dbg("format length=%i", num);
206 dbg("format parsing error '%s'", *str);
212 static void apply_format(struct udevice *udev, char *string, size_t maxsize,
213 struct sysfs_class_device *class_dev,
214 struct sysfs_device *sysfs_device)
216 char temp[NAME_SIZE];
217 char temp2[NAME_SIZE];
226 struct sysfs_attribute *tmpattr;
231 pos = strchr(string, '%');
235 len = get_format_len(&tail);
237 strfieldcpy(temp, tail+1);
242 dbg("format=%c, string='%s', tail='%s'",c , string, tail);
244 attr = get_format_attribute(&tail);
248 if (strlen(udev->bus_id) == 0)
250 strnfieldcat(string, udev->bus_id, maxsize);
251 dbg("substitute bus_id '%s'", udev->bus_id);
254 if (strlen(udev->kernel_name) == 0)
256 strnfieldcat(string, udev->kernel_name, maxsize);
257 dbg("substitute kernel name '%s'", udev->kernel_name);
260 if (strlen(udev->kernel_number) == 0)
262 strnfieldcat(string, udev->kernel_number, maxsize);
263 dbg("substitute kernel number '%s'", udev->kernel_number);
266 strnintcat(string, udev->minor, maxsize);
267 dbg("substitute minor number '%u'", udev->minor);
270 strnintcat(string, udev->major, maxsize);
271 dbg("substitute major number '%u'", udev->major);
274 if (strlen(udev->program_result) == 0)
276 /* get part part of the result string */
281 foreach_strpart(udev->program_result, " \n\r", spos, slen) {
287 dbg("requested part of result string not found");
290 strnfieldcpy(temp2, spos, slen+1);
291 strnfieldcat(string, temp2, maxsize);
292 dbg("substitute part of result string '%s'", temp2);
294 strnfieldcat(string, udev->program_result, maxsize);
295 dbg("substitute result string '%s'", udev->program_result);
300 tmpattr = find_sysfs_attribute(class_dev, sysfs_device, attr);
301 if (tmpattr == NULL) {
302 dbg("sysfa attribute '%s' not found", attr);
305 strnfieldcat(string, tmpattr->value, maxsize);
306 dbg("substitute sysfs value '%s'", tmpattr->value);
308 dbg("missing attribute");
312 strnfieldcat(string, "%", maxsize);
315 dbg("unknown substitution type '%%%c'", c);
318 /* truncate to specified length */
322 strnfieldcat(string, tail, maxsize);
327 * Note, we can have multiple files for different busses in here due
328 * to the mess that USB has for its device tree...
330 static struct bus_file {
334 { .bus = "scsi", .file = "vendor" },
335 { .bus = "usb", .file = "idVendor" },
336 { .bus = "usb", .file = "iInterface" },
337 { .bus = "usb-serial", .file = "detach_state" },
338 { .bus = "ide", .file = "detach_state" },
339 { .bus = "pci", .file = "vendor" },
343 #define SECONDS_TO_WAIT_FOR_FILE 10
344 static void wait_for_device_to_initialize(struct sysfs_device *sysfs_device)
346 /* sleep until we see the file for this specific bus type show up this
347 * is needed because we can easily out-run the kernel in looking for
348 * these files before the paticular subsystem has created them in the
349 * sysfs tree properly.
351 * And people thought that the /sbin/hotplug event system was going to
352 * be slow, poo on you for arguing that before even testing it...
354 struct bus_file *b = &bus_files[0];
355 struct sysfs_attribute *tmpattr;
357 int loop = SECONDS_TO_WAIT_FOR_FILE;
360 if (b->bus == NULL) {
363 /* sleep to give the kernel a chance to create the file */
370 if (strcmp(sysfs_device->bus, b->bus) == 0) {
372 dbg("looking for file '%s' on bus '%s'", b->file, b->bus);
373 tmpattr = sysfs_get_device_attr(sysfs_device, b->file);
378 dbg("can't find '%s' file", b->file);
383 dbg("did not find bus type '%s' on list of bus_id_files, "
384 "contact greg@kroah.com", sysfs_device->bus);
386 return; /* here to prevent compiler warning... */
389 static void fix_kernel_name(struct udevice *udev)
391 char *temp = udev->kernel_name;
393 while (*temp != 0x00) {
394 /* Some block devices have a ! in their name,
395 * we need to change that to / */
402 static int execute_program(char *path, char *value, int len)
412 char *args[PROGRAM_MAXARG];
415 dbg("executing '%s'", path);
425 close(STDOUT_FILENO);
427 /* dup write side of pipe to STDOUT */
430 /* copy off our path to use incase we have too many args */
431 strnfieldcpy(buffer, path, sizeof(buffer));
433 if (strchr(path, ' ')) {
434 /* exec with arguments */
436 for (i=0; i < PROGRAM_MAXARG-1; i++) {
437 args[i] = strsep(&pos, " ");
442 dbg("too many args - %d, using subshell instead '%s'", i, buffer);
443 retval = execl("/bin/sh", "sh", "-c", buffer, NULL);
445 dbg("execute program '%s'", path);
446 retval = execv(args[0], args);
449 retval = execv(path, main_argv);
451 info(FIELD_PROGRAM " execution of '%s' failed", path);
457 /* parent reads from fds[0] */
461 res = read(fds[0], buffer, sizeof(buffer) - 1);
466 dbg("result len %d too short", len);
470 dbg("result value already set");
474 strncpy(value, buffer, len);
475 pos = value + strlen(value)-1;
478 dbg("result is '%s'", value);
484 dbg("wait failed result %d", res);
488 if (!WIFEXITED(status) || (WEXITSTATUS(status) != 0)) {
489 dbg("exec program status 0x%x", status);
496 static struct sysfs_attribute *find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, char *attr)
498 struct sysfs_attribute *tmpattr = NULL;
501 dbg("look for device attribute '%s'", attr);
502 /* try to find the attribute in the class device directory */
503 tmpattr = sysfs_get_classdev_attr(class_dev, attr);
507 /* look in the class device directory if present */
509 tmpattr = sysfs_get_device_attr(sysfs_device, attr);
517 c = strchr(tmpattr->value, '\n');
521 dbg("found attribute '%s'", tmpattr->path);
525 static int compare_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, struct sysfs_pair *pair)
527 struct sysfs_attribute *tmpattr;
531 if ((pair == NULL) || (pair->file[0] == '\0') || (pair->value == '\0'))
534 tmpattr = find_sysfs_attribute(class_dev, sysfs_device, pair->file);
538 /* strip trailing whitespace of value, if not asked to match for it */
539 if (! isspace(pair->value[strlen(pair->value)-1])) {
540 i = len = strlen(tmpattr->value);
541 while (i > 0 && isspace(tmpattr->value[i-1]))
544 tmpattr->value[i] = '\0';
545 dbg("remove %i trailing whitespace chars from '%s'",
546 len - i, tmpattr->value);
550 dbg("compare attribute '%s' value '%s' with '%s'",
551 pair->file, tmpattr->value, pair->value);
552 if (strcmp_pattern(pair->value, tmpattr->value) != 0)
555 dbg("found matching attribute '%s' with value '%s'",
556 pair->file, pair->value);
560 static int match_sysfs_pairs(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
562 struct sysfs_pair *pair;
565 for (i = 0; i < MAX_SYSFS_PAIRS; ++i) {
566 pair = &dev->sysfs_pair[i];
567 if ((pair->file[0] == '\0') || (pair->value[0] == '\0'))
569 if (compare_sysfs_attribute(class_dev, sysfs_device, pair) != 0) {
570 dbg("sysfs attribute doesn't match");
578 static int match_id(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
580 char path[SYSFS_PATH_MAX];
583 /* we have to have a sysfs device for ID to work */
587 strfieldcpy(path, sysfs_device->path);
588 temp = strrchr(path, '/');
590 dbg("search '%s' in '%s', path='%s'", dev->id, temp, path);
591 if (strcmp_pattern(dev->id, temp) != 0)
597 static int match_place(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
599 char path[SYSFS_PATH_MAX];
603 /* we have to have a sysfs device for PLACE to work */
608 strfieldcpy(path, sysfs_device->path);
609 temp = strrchr(path, '/');
610 dbg("search '%s' in '%s', path='%s'", dev->place, temp, path);
611 if (strstr(temp, dev->place) != NULL) {
615 temp = strrchr(path, '/');
616 dbg("search '%s' in '%s', path='%s'", dev->place, temp, path);
617 if (strstr(temp, dev->place) != NULL)
621 dbg("place doesn't match");
628 static struct sysfs_device *get_sysfs_device(struct sysfs_class_device *class_dev)
630 struct sysfs_device *sysfs_device;
631 struct sysfs_class_device *class_dev_parent;
632 struct timespec tspec;
635 /* Figure out where the device symlink is at. For char devices this will
636 * always be in the class_dev->path. But for block devices, it's different.
637 * The main block device will have the device symlink in it's path, but
638 * all partitions have the symlink in its parent directory.
639 * But we need to watch out for block devices that do not have parents, yet
640 * look like a partition (fd0, loop0, etc.) They all do not have a device
641 * symlink yet. We do sit and spin on waiting for them right now, we should
642 * possibly have a whitelist for these devices here...
644 class_dev_parent = sysfs_get_classdev_parent(class_dev);
645 if (class_dev_parent)
646 dbg("Really a partition");
649 tspec.tv_nsec = 10000000; /* sleep 10 millisec */
653 nanosleep(&tspec, NULL);
654 if (class_dev_parent)
655 sysfs_device = sysfs_get_classdev_device(class_dev_parent);
657 sysfs_device = sysfs_get_classdev_device(class_dev);
659 if (sysfs_device != NULL)
662 dbg("timed out waiting for device symlink, continuing on anyway...");
665 /* We have another issue with just the wait above - the sysfs part of
666 * the kernel may not be quick enough to have created the link to the
667 * device under the "bus" subsystem. Due to this, the sysfs_device->bus
668 * will not contain the actual bus name :(
670 * Libsysfs now provides a new API sysfs_get_device_bus(), so use it
674 if (sysfs_device->bus[0] != '\0')
678 tspec.tv_nsec = 10000000;
681 nanosleep(&tspec, NULL);
682 sysfs_get_device_bus(sysfs_device);
684 if (sysfs_device->bus[0] != '\0')
687 dbg("timed out waiting to find the device bus, continuing on anyway");
690 dbg("device %s is registered with bus '%s'",
691 sysfs_device->name, sysfs_device->bus);
697 static int match_rule(struct config_device *dev, struct sysfs_class_device *class_dev, struct udevice *udev, struct sysfs_device *sysfs_device)
700 /* check for matching bus value */
701 if (dev->bus[0] != '\0') {
702 if (sysfs_device == NULL) {
703 dbg("device has no bus");
706 dbg("check for " FIELD_BUS " dev->bus='%s' sysfs_device->bus='%s'", dev->bus, sysfs_device->bus);
707 if (strcmp_pattern(dev->bus, sysfs_device->bus) != 0) {
708 dbg(FIELD_BUS " is not matching");
711 dbg(FIELD_BUS " matches");
715 /* check for matching kernel name*/
716 if (dev->kernel[0] != '\0') {
717 dbg("check for " FIELD_KERNEL " dev->kernel='%s' class_dev->name='%s'", dev->kernel, class_dev->name);
718 if (strcmp_pattern(dev->kernel, class_dev->name) != 0) {
719 dbg(FIELD_KERNEL " is not matching");
722 dbg(FIELD_KERNEL " matches");
726 /* check for matching bus id */
727 if (dev->id[0] != '\0') {
728 dbg("check " FIELD_ID);
729 if (match_id(dev, class_dev, sysfs_device) != 0) {
730 dbg(FIELD_ID " is not matching");
733 dbg(FIELD_ID " matches");
737 /* check for matching place of device */
738 if (dev->place[0] != '\0') {
739 dbg("check " FIELD_PLACE);
740 if (match_place(dev, class_dev, sysfs_device) != 0) {
741 dbg(FIELD_PLACE " is not matching");
744 dbg(FIELD_PLACE " matches");
748 /* check for matching sysfs pairs */
749 if (dev->sysfs_pair[0].file[0] != '\0') {
750 dbg("check " FIELD_SYSFS " pairs");
751 if (match_sysfs_pairs(dev, class_dev, sysfs_device) != 0) {
752 dbg(FIELD_SYSFS " is not matching");
755 dbg(FIELD_SYSFS " matches");
759 /* execute external program */
760 if (dev->program[0] != '\0') {
761 dbg("check " FIELD_PROGRAM);
762 apply_format(udev, dev->program, sizeof(dev->program),
763 class_dev, sysfs_device);
764 if (execute_program(dev->program, udev->program_result, NAME_SIZE) != 0) {
765 dbg(FIELD_PROGRAM " returned nozero");
768 dbg(FIELD_PROGRAM " returned successful");
772 /* check for matching result of external program */
773 if (dev->result[0] != '\0') {
774 dbg("check for " FIELD_RESULT
775 " dev->result='%s', udev->program_result='%s'",
776 dev->result, udev->program_result);
777 if (strcmp_pattern(dev->result, udev->program_result) != 0) {
778 dbg(FIELD_RESULT " is not matching");
781 dbg(FIELD_RESULT " matches");
785 /* Yeah, we matched! */
789 dbg("try parent sysfs device");
790 sysfs_device = sysfs_get_device_parent(sysfs_device);
791 if (sysfs_device == NULL)
793 dbg("sysfs_device->path='%s'", sysfs_device->path);
794 dbg("sysfs_device->bus_id='%s'", sysfs_device->bus_id);
795 dbg("sysfs_device->bus='%s'", sysfs_device->bus);
800 int namedev_name_device(struct sysfs_class_device *class_dev, struct udevice *udev)
802 struct sysfs_device *sysfs_device = NULL;
803 struct config_device *dev;
804 struct perm_device *perm;
809 /* find the sysfs_device associated with this class device */
810 sysfs_device = get_sysfs_device(class_dev);
812 dbg("sysfs_device->path='%s'", sysfs_device->path);
813 dbg("sysfs_device->bus_id='%s'", sysfs_device->bus_id);
814 dbg("sysfs_device->bus='%s'", sysfs_device->bus);
815 strfieldcpy(udev->bus_id, sysfs_device->bus_id);
816 wait_for_device_to_initialize(sysfs_device);
818 dbg("class_dev->name = '%s'", class_dev->name);
820 strfieldcpy(udev->kernel_name, class_dev->name);
821 fix_kernel_name(udev);
822 dbg("udev->kernel_name = '%s'", udev->kernel_name);
824 /* get kernel number */
825 pos = class_dev->name + strlen(class_dev->name);
826 while (isdigit(*(pos-1)))
828 strfieldcpy(udev->kernel_number, pos);
829 dbg("kernel_number='%s'", udev->kernel_number);
831 /* look for a matching rule to apply */
832 list_for_each_entry(dev, &config_device_list, node) {
834 if (match_rule(dev, class_dev, udev, sysfs_device) == 0) {
835 if (dev->name[0] == '\0' && dev->symlink[0] == '\0') {
836 info("configured rule in '%s' at line %i applied, '%s' is ignored",
837 dev->config_file, dev->config_line, udev->kernel_name);
841 if (dev->symlink[0] != '\0') {
844 info("configured rule in '%s' at line %i applied, added symlink '%s'",
845 dev->config_file, dev->config_line, dev->symlink);
846 /* do not clobber dev */
847 strfieldcpy(temp, dev->symlink);
848 apply_format(udev, temp, sizeof(temp),
849 class_dev, sysfs_device);
850 strfieldcat(udev->symlink, temp);
851 strfieldcat(udev->symlink, " ");
854 if (dev->name[0] != '\0') {
855 info("configured rule in '%s' at line %i applied, '%s' becomes '%s'",
856 dev->config_file, dev->config_line, udev->kernel_name, dev->name);
857 strfieldcpy(udev->name, dev->name);
863 /* no rule was found so we use the kernel name */
864 strfieldcpy(udev->name, udev->kernel_name);
868 /* substitute placeholder */
869 apply_format(udev, udev->name, sizeof(udev->name),
870 class_dev, sysfs_device);
871 udev->partitions = dev->partitions;
873 perm = find_perm(udev->name);
875 udev->mode = perm->mode;
876 strfieldcpy(udev->owner, perm->owner);
877 strfieldcpy(udev->group, perm->group);
879 /* no matching perms found :( */
880 udev->mode = get_default_mode();
881 strfieldcpy(udev->owner, get_default_owner());
882 strfieldcpy(udev->group, get_default_group());
884 dbg("name, '%s' is going to have owner='%s', group='%s', mode = %#o",
885 udev->name, udev->owner, udev->group, udev->mode);
890 int namedev_init(void)
894 retval = namedev_init_rules();
898 retval = namedev_init_permissions();
902 dump_config_dev_list();
903 dump_perm_dev_list();