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 temp1[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 strfieldcpy(temp1, udev->program_result);
285 pos3 = strsep(&pos2, " ");
287 dbg("requested part of result string not found");
292 strnfieldcat(string, pos3, maxsize);
293 dbg("substitute part of result string '%s'", pos3);
296 strnfieldcat(string, udev->program_result, maxsize);
297 dbg("substitute result string '%s'", udev->program_result);
302 tmpattr = find_sysfs_attribute(class_dev, sysfs_device, attr);
303 if (tmpattr == NULL) {
304 dbg("sysfa attribute '%s' not found", attr);
307 strnfieldcat(string, tmpattr->value, maxsize);
308 dbg("substitute sysfs value '%s'", tmpattr->value);
310 dbg("missing attribute");
314 strnfieldcat(string, "%", maxsize);
317 dbg("unknown substitution type '%%%c'", c);
320 /* truncate to specified length */
324 strnfieldcat(string, tail, maxsize);
329 * Note, we can have multiple files for different busses in here due
330 * to the mess that USB has for its device tree...
332 static struct bus_file {
336 { .bus = "scsi", .file = "vendor" },
337 { .bus = "usb", .file = "idVendor" },
338 { .bus = "usb", .file = "iInterface" },
339 { .bus = "usb-serial", .file = "detach_state" },
340 { .bus = "ide", .file = "detach_state" },
341 { .bus = "pci", .file = "vendor" },
345 #define SECONDS_TO_WAIT_FOR_FILE 10
346 static void wait_for_device_to_initialize(struct sysfs_device *sysfs_device)
348 /* sleep until we see the file for this specific bus type show up this
349 * is needed because we can easily out-run the kernel in looking for
350 * these files before the paticular subsystem has created them in the
351 * sysfs tree properly.
353 * And people thought that the /sbin/hotplug event system was going to
354 * be slow, poo on you for arguing that before even testing it...
356 struct bus_file *b = &bus_files[0];
357 struct sysfs_attribute *tmpattr;
359 int loop = SECONDS_TO_WAIT_FOR_FILE;
362 if (b->bus == NULL) {
365 /* sleep to give the kernel a chance to create the file */
372 if (strcmp(sysfs_device->bus, b->bus) == 0) {
374 dbg("looking for file '%s' on bus '%s'", b->file, b->bus);
375 tmpattr = sysfs_get_device_attr(sysfs_device, b->file);
380 dbg("can't find '%s' file", b->file);
385 dbg("did not find bus type '%s' on list of bus_id_files, "
386 "contact greg@kroah.com", sysfs_device->bus);
388 return; /* here to prevent compiler warning... */
391 static void fix_kernel_name(struct udevice *udev)
393 char *temp = udev->kernel_name;
395 while (*temp != 0x00) {
396 /* Some block devices have a ! in their name,
397 * we need to change that to / */
404 static int execute_program(char *path, char *value, int len)
414 char *args[PROGRAM_MAXARG];
417 dbg("executing '%s'", path);
427 close(STDOUT_FILENO);
429 /* dup write side of pipe to STDOUT */
432 /* copy off our path to use incase we have too many args */
433 strnfieldcpy(buffer, path, sizeof(buffer));
435 if (strchr(path, ' ')) {
436 /* exec with arguments */
438 for (i=0; i < PROGRAM_MAXARG-1; i++) {
439 args[i] = strsep(&pos, " ");
444 dbg("too many args - %d, using subshell instead '%s'", i, buffer);
445 retval = execl("/bin/sh", "sh", "-c", buffer, NULL);
447 dbg("execute program '%s'", path);
448 retval = execv(args[0], args);
451 retval = execv(path, main_argv);
453 info(FIELD_PROGRAM " execution of '%s' failed", path);
459 /* parent reads from fds[0] */
463 res = read(fds[0], buffer, sizeof(buffer) - 1);
468 dbg("result len %d too short", len);
472 dbg("result value already set");
476 strncpy(value, buffer, len);
477 pos = value + strlen(value)-1;
480 dbg("result is '%s'", value);
486 dbg("wait failed result %d", res);
490 if (!WIFEXITED(status) || (WEXITSTATUS(status) != 0)) {
491 dbg("exec program status 0x%x", status);
498 static struct sysfs_attribute *find_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, char *attr)
500 struct sysfs_attribute *tmpattr = NULL;
503 dbg("look for device attribute '%s'", attr);
504 /* try to find the attribute in the class device directory */
505 tmpattr = sysfs_get_classdev_attr(class_dev, attr);
509 /* look in the class device directory if present */
511 tmpattr = sysfs_get_device_attr(sysfs_device, attr);
519 c = strchr(tmpattr->value, '\n');
523 dbg("found attribute '%s'", tmpattr->path);
527 static int compare_sysfs_attribute(struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device, struct sysfs_pair *pair)
529 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 dbg("compare attribute '%s' value '%s' with '%s'",
539 pair->file, tmpattr->value, pair->value);
540 if (strcmp_pattern(pair->value, tmpattr->value) != 0)
543 dbg("found matching attribute '%s' with value '%s'",
544 pair->file, pair->value);
548 static int match_sysfs_pairs(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
550 struct sysfs_pair *pair;
553 for (i = 0; i < MAX_SYSFS_PAIRS; ++i) {
554 pair = &dev->sysfs_pair[i];
555 if ((pair->file[0] == '\0') || (pair->value[0] == '\0'))
557 if (compare_sysfs_attribute(class_dev, sysfs_device, pair) != 0) {
558 dbg("sysfs attribute doesn't match");
566 static int match_id(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
568 char path[SYSFS_PATH_MAX];
571 /* we have to have a sysfs device for ID to work */
575 strfieldcpy(path, sysfs_device->path);
576 temp = strrchr(path, '/');
578 dbg("search '%s' in '%s', path='%s'", dev->id, temp, path);
579 if (strcmp_pattern(dev->id, temp) != 0)
585 static int match_place(struct config_device *dev, struct sysfs_class_device *class_dev, struct sysfs_device *sysfs_device)
587 char path[SYSFS_PATH_MAX];
591 /* we have to have a sysfs device for PLACE to work */
596 strfieldcpy(path, sysfs_device->path);
597 temp = strrchr(path, '/');
598 dbg("search '%s' in '%s', path='%s'", dev->place, temp, path);
599 if (strstr(temp, dev->place) != NULL) {
603 temp = strrchr(path, '/');
604 dbg("search '%s' in '%s', path='%s'", dev->place, temp, path);
605 if (strstr(temp, dev->place) != NULL)
609 dbg("place doesn't match");
616 static struct sysfs_device *get_sysfs_device(struct sysfs_class_device *class_dev)
618 struct sysfs_device *sysfs_device;
619 struct sysfs_class_device *class_dev_parent;
620 struct timespec tspec;
623 /* Figure out where the device symlink is at. For char devices this will
624 * always be in the class_dev->path. But for block devices, it's different.
625 * The main block device will have the device symlink in it's path, but
626 * all partitions have the symlink in its parent directory.
627 * But we need to watch out for block devices that do not have parents, yet
628 * look like a partition (fd0, loop0, etc.) They all do not have a device
629 * symlink yet. We do sit and spin on waiting for them right now, we should
630 * possibly have a whitelist for these devices here...
632 class_dev_parent = sysfs_get_classdev_parent(class_dev);
633 if (class_dev_parent)
634 dbg("Really a partition");
637 tspec.tv_nsec = 10000000; /* sleep 10 millisec */
641 nanosleep(&tspec, NULL);
642 if (class_dev_parent)
643 sysfs_device = sysfs_get_classdev_device(class_dev_parent);
645 sysfs_device = sysfs_get_classdev_device(class_dev);
647 if (sysfs_device != NULL)
650 dbg("timed out waiting for device symlink, continuing on anyway...");
653 /* We have another issue with just the wait above - the sysfs part of
654 * the kernel may not be quick enough to have created the link to the
655 * device under the "bus" subsystem. Due to this, the sysfs_device->bus
656 * will not contain the actual bus name :(
658 * Libsysfs now provides a new API sysfs_get_device_bus(), so use it
662 if (sysfs_device->bus[0] != '\0')
666 tspec.tv_nsec = 10000000;
669 nanosleep(&tspec, NULL);
670 sysfs_get_device_bus(sysfs_device);
672 if (sysfs_device->bus[0] != '\0')
675 dbg("timed out waiting to find the device bus, continuing on anyway");
678 dbg("device %s is registered with bus '%s'",
679 sysfs_device->name, sysfs_device->bus);
685 static int match_rule(struct config_device *dev, struct sysfs_class_device *class_dev, struct udevice *udev, struct sysfs_device *sysfs_device)
688 /* check for matching bus value */
689 if (dev->bus[0] != '\0') {
690 if (sysfs_device == NULL) {
691 dbg("device has no bus");
694 dbg("check for " FIELD_BUS " dev->bus='%s' sysfs_device->bus='%s'", dev->bus, sysfs_device->bus);
695 if (strcmp_pattern(dev->bus, sysfs_device->bus) != 0) {
696 dbg(FIELD_BUS " is not matching");
699 dbg(FIELD_BUS " matches");
703 /* check for matching kernel name*/
704 if (dev->kernel[0] != '\0') {
705 dbg("check for " FIELD_KERNEL " dev->kernel='%s' class_dev->name='%s'", dev->kernel, class_dev->name);
706 if (strcmp_pattern(dev->kernel, class_dev->name) != 0) {
707 dbg(FIELD_KERNEL " is not matching");
710 dbg(FIELD_KERNEL " matches");
714 /* check for matching bus id */
715 if (dev->id[0] != '\0') {
716 dbg("check " FIELD_ID);
717 if (match_id(dev, class_dev, sysfs_device) != 0) {
718 dbg(FIELD_ID " is not matching");
721 dbg(FIELD_ID " matches");
725 /* check for matching place of device */
726 if (dev->place[0] != '\0') {
727 dbg("check " FIELD_PLACE);
728 if (match_place(dev, class_dev, sysfs_device) != 0) {
729 dbg(FIELD_PLACE " is not matching");
732 dbg(FIELD_PLACE " matches");
736 /* check for matching sysfs pairs */
737 if (dev->sysfs_pair[0].file[0] != '\0') {
738 dbg("check " FIELD_SYSFS " pairs");
739 if (match_sysfs_pairs(dev, class_dev, sysfs_device) != 0) {
740 dbg(FIELD_SYSFS " is not matching");
743 dbg(FIELD_SYSFS " matches");
747 /* execute external program */
748 if (dev->program[0] != '\0') {
749 dbg("check " FIELD_PROGRAM);
750 apply_format(udev, dev->program, sizeof(dev->program),
751 class_dev, sysfs_device);
752 if (execute_program(dev->program, udev->program_result, NAME_SIZE) != 0) {
753 dbg(FIELD_PROGRAM " returned nozero");
756 dbg(FIELD_PROGRAM " returned successful");
760 /* check for matching result of external program */
761 if (dev->result[0] != '\0') {
762 dbg("check for " FIELD_RESULT
763 " dev->result='%s', udev->program_result='%s'",
764 dev->result, udev->program_result);
765 if (strcmp_pattern(dev->result, udev->program_result) != 0) {
766 dbg(FIELD_RESULT " is not matching");
769 dbg(FIELD_RESULT " matches");
773 /* Yeah, we matched! */
777 dbg("try parent sysfs device");
778 sysfs_device = sysfs_get_device_parent(sysfs_device);
779 if (sysfs_device == NULL)
781 dbg("sysfs_device->path='%s'", sysfs_device->path);
782 dbg("sysfs_device->bus_id='%s'", sysfs_device->bus_id);
783 dbg("sysfs_device->bus='%s'", sysfs_device->bus);
788 int namedev_name_device(struct sysfs_class_device *class_dev, struct udevice *udev)
790 struct sysfs_device *sysfs_device = NULL;
791 struct config_device *dev;
792 struct perm_device *perm;
797 /* find the sysfs_device associated with this class device */
798 sysfs_device = get_sysfs_device(class_dev);
800 dbg("sysfs_device->path='%s'", sysfs_device->path);
801 dbg("sysfs_device->bus_id='%s'", sysfs_device->bus_id);
802 dbg("sysfs_device->bus='%s'", sysfs_device->bus);
803 strfieldcpy(udev->bus_id, sysfs_device->bus_id);
804 wait_for_device_to_initialize(sysfs_device);
806 dbg("class_dev->name = '%s'", class_dev->name);
808 strfieldcpy(udev->kernel_name, class_dev->name);
809 fix_kernel_name(udev);
810 dbg("udev->kernel_name = '%s'", udev->kernel_name);
812 /* get kernel number */
813 pos = class_dev->name + strlen(class_dev->name);
814 while (isdigit(*(pos-1)))
816 strfieldcpy(udev->kernel_number, pos);
817 dbg("kernel_number='%s'", udev->kernel_number);
819 /* look for a matching rule to apply */
820 list_for_each_entry(dev, &config_device_list, node) {
822 if (match_rule(dev, class_dev, udev, sysfs_device) == 0) {
823 if (dev->name[0] == '\0' && dev->symlink[0] == '\0') {
824 info("configured rule in '%s' at line %i applied, '%s' is ignored",
825 dev->config_file, dev->config_line, udev->kernel_name);
829 if (dev->symlink[0] != '\0') {
832 info("configured rule in '%s' at line %i applied, added symlink '%s'",
833 dev->config_file, dev->config_line, dev->symlink);
834 /* do not clobber dev */
835 strfieldcpy(temp, dev->symlink);
836 apply_format(udev, temp, sizeof(temp),
837 class_dev, sysfs_device);
838 strfieldcat(udev->symlink, temp);
839 strfieldcat(udev->symlink, " ");
842 if (dev->name[0] != '\0') {
843 info("configured rule in '%s' at line %i applied, '%s' becomes '%s'",
844 dev->config_file, dev->config_line, udev->kernel_name, dev->name);
845 strfieldcpy(udev->name, dev->name);
851 /* no rule was found so we use the kernel name */
852 strfieldcpy(udev->name, udev->kernel_name);
856 /* substitute placeholder */
857 apply_format(udev, udev->name, sizeof(udev->name),
858 class_dev, sysfs_device);
859 udev->partitions = dev->partitions;
861 perm = find_perm(udev->name);
863 udev->mode = perm->mode;
864 strfieldcpy(udev->owner, perm->owner);
865 strfieldcpy(udev->group, perm->group);
867 /* no matching perms found :( */
868 udev->mode = get_default_mode();
869 strfieldcpy(udev->owner, get_default_owner());
870 strfieldcpy(udev->group, get_default_group());
872 dbg("name, '%s' is going to have owner='%s', group='%s', mode = %#o",
873 udev->name, udev->owner, udev->group, udev->mode);
878 int namedev_init(void)
882 retval = namedev_init_rules();
886 retval = namedev_init_permissions();
890 dump_config_dev_list();
891 dump_perm_dev_list();