2 * libudev - interface to udev device information
4 * Copyright (C) 2008 Kay Sievers <kay.sievers@vrfy.org>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 #include "libudev-private.h"
36 struct udev_device *parent_device;
42 struct list_node devlink_list;
43 struct list_node properties_list;
51 unsigned long long int seqnum;
52 int num_fake_partitions;
55 struct list_node attr_list;
59 static size_t syspath_to_db_path(struct udev_device *udev_device, char *filename, size_t len)
63 /* translate to location of db file */
64 util_strlcpy(filename, udev_get_dev_path(udev_device->udev), len);
65 start = util_strlcat(filename, "/.udev/db/", len);
66 util_strlcat(filename, udev_device->devpath, len);
67 return util_path_encode(&filename[start], len - start);
70 static int device_read_db(struct udev_device *udev_device)
73 char filename[UTIL_PATH_SIZE];
74 char line[UTIL_LINE_SIZE];
77 syspath_to_db_path(udev_device, filename, sizeof(filename));
79 if (lstat(filename, &stats) != 0) {
80 info(udev_device->udev, "no db file to read %s: %s\n", filename, strerror(errno));
83 if ((stats.st_mode & S_IFMT) == S_IFLNK) {
84 char target[UTIL_PATH_SIZE];
87 target_len = readlink(filename, target, sizeof(target));
89 target[target_len] = '\0';
91 info(udev_device->udev, "error reading db link %s: %s\n", filename, strerror(errno));
94 if (asprintf(&udev_device->devnode, "%s/%s", udev_get_dev_path(udev_device->udev), target) < 0)
96 info(udev_device->udev, "device %p filled with db symlink data '%s'\n", udev_device, udev_device->devnode);
100 f = fopen(filename, "r");
102 info(udev_device->udev, "error reading db file %s: %s\n", filename, strerror(errno));
105 while (fgets(line, sizeof(line), f)) {
117 asprintf(&udev_device->devnode, "%s/%s", udev_get_dev_path(udev_device->udev), val);
120 util_strlcpy(filename, udev_get_dev_path(udev_device->udev), sizeof(filename));
121 util_strlcat(filename, "/", sizeof(filename));
122 util_strlcat(filename, val, sizeof(filename));
123 device_add_devlink(udev_device, filename);
126 device_set_devlink_priority(udev_device, atoi(val));
129 device_set_event_timeout(udev_device, atoi(val));
132 device_set_num_fake_partitions(udev_device, atoi(val));
135 device_set_ignore_remove(udev_device, atoi(val));
138 device_add_property_from_string(udev_device, val);
144 info(udev_device->udev, "device %p filled with db file data\n", udev_device);
148 static int device_read_uevent_file(struct udev_device *udev_device)
150 char filename[UTIL_PATH_SIZE];
152 char line[UTIL_LINE_SIZE];
156 util_strlcpy(filename, udev_device->syspath, sizeof(filename));
157 util_strlcat(filename, "/uevent", sizeof(filename));
158 f = fopen(filename, "r");
162 while (fgets(line, sizeof(line), f)) {
165 pos = strchr(line, '\n');
170 if (strncmp(line, "MAJOR=", 6) == 0)
171 maj = strtoull(&line[6], NULL, 10);
172 else if (strncmp(line, "MINOR=", 6) == 0)
173 min = strtoull(&line[6], NULL, 10);
175 device_add_property_from_string(udev_device, line);
178 udev_device->devnum = makedev(maj, min);
184 static void device_load_info(struct udev_device *device)
186 device_read_uevent_file(device);
187 device_read_db(device);
188 device->info_loaded = 1;
191 void device_set_info_loaded(struct udev_device *device)
193 device->info_loaded = 1;
196 struct udev_device *device_init(struct udev *udev)
198 struct udev_device *udev_device;
203 udev_device = malloc(sizeof(struct udev_device));
204 if (udev_device == NULL)
206 memset(udev_device, 0x00, sizeof(struct udev_device));
207 udev_device->refcount = 1;
208 udev_device->udev = udev;
209 list_init(&udev_device->devlink_list);
210 list_init(&udev_device->properties_list);
211 list_init(&udev_device->attr_list);
212 info(udev_device->udev, "udev_device: %p created\n", udev_device);
217 * udev_device_new_from_syspath:
218 * @udev: udev library context
219 * @syspath: sys device path including sys directory
221 * Create new udev device, and fill in information from the sys
222 * device and the udev database entry. The sypath is the absolute
223 * path to the device, including the sys mount point.
225 * The initial refcount is 1, and needs to be decremented to
226 * release the ressources of the udev device.
228 * Returns: a new udev device, or #NULL, if it does not exist
230 struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath)
232 char path[UTIL_PATH_SIZE];
234 struct udev_device *udev_device;
241 util_strlcpy(path, syspath, sizeof(path));
242 util_strlcat(path, "/uevent", sizeof(path));
243 if (stat(path, &statbuf) != 0) {
244 info(udev, "not a device :%s\n", syspath);
248 udev_device = device_init(udev);
249 if (udev_device == NULL)
252 /* resolve possible symlink to real path */
253 util_strlcpy(path, syspath, sizeof(path));
254 util_resolve_sys_link(udev, path, sizeof(path));
255 device_set_syspath(udev_device, path);
256 info(udev, "device %p has devpath '%s'\n", udev_device, udev_device_get_devpath(udev_device));
261 struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum)
263 char path[UTIL_PATH_SIZE];
264 const char *type_str;
265 struct udev_enumerate *enumerate;
266 struct udev_list_entry *list_entry;
267 struct udev_device *device = NULL;
271 else if (type == 'c')
276 /* /sys/dev/{block,char}/<maj>:<min> links */
277 snprintf(path, sizeof(path), "%s/dev/%s/%u:%u", udev_get_sys_path(udev),
278 type_str, major(devnum), minor(devnum));
279 if (util_resolve_sys_link(udev, path, sizeof(path)) == 0)
280 return udev_device_new_from_syspath(udev, path);
282 /* fallback to search all sys devices for the major/minor */
283 enumerate = udev_enumerate_new_from_subsystems(udev, NULL);
284 if (enumerate == NULL)
286 udev_list_entry_foreach(list_entry, udev_enumerate_get_list_entry(enumerate)) {
287 struct udev_device *device_loop;
289 device_loop = udev_device_new_from_syspath(udev, udev_list_entry_get_name(list_entry));
290 if (device_loop != NULL) {
291 if (udev_device_get_devnum(device_loop) == devnum) {
292 device = device_loop;
295 udev_device_unref(device_loop);
298 udev_enumerate_unref(enumerate);
302 static struct udev_device *device_new_from_parent(struct udev_device *udev_device)
304 struct udev_device *udev_device_parent = NULL;
305 char path[UTIL_PATH_SIZE];
308 if (udev_device == NULL)
311 util_strlcpy(path, udev_device->syspath, sizeof(path));
313 pos = strrchr(path, '/');
314 if (pos == path || pos == NULL)
317 udev_device_parent = udev_device_new_from_syspath(udev_device->udev, path);
318 if (udev_device_parent != NULL)
319 return udev_device_parent;
322 /* follow "device" link in deprecated sys /sys/class/ layout */
323 if (strncmp(udev_device->devpath, "/class/", 7) == 0) {
324 util_strlcpy(path, udev_device->syspath, sizeof(path));
325 util_strlcat(path, "/device", sizeof(path));
326 if (util_resolve_sys_link(udev_device->udev, path, sizeof(path)) == 0) {
327 udev_device_parent = udev_device_new_from_syspath(udev_device->udev, path);
328 if (udev_device_parent != NULL)
329 return udev_device_parent;
335 struct udev_device *udev_device_get_parent(struct udev_device *udev_device)
337 if (udev_device->parent_device != NULL) {
338 info(udev_device->udev, "returning existing parent %p\n", udev_device->parent_device);
339 return udev_device->parent_device;
341 udev_device->parent_device = device_new_from_parent(udev_device);
342 return udev_device->parent_device;
346 * udev_device_get_udev:
347 * @udev_device: udev device
349 * Retrieve the udev library context the device was created with.
351 * Returns: the udev library context
353 struct udev *udev_device_get_udev(struct udev_device *udev_device)
355 if (udev_device == NULL)
357 return udev_device->udev;
362 * @udev_device: udev device
364 * Take a reference of a udev device.
366 * Returns: the passed udev device
368 struct udev_device *udev_device_ref(struct udev_device *udev_device)
370 if (udev_device == NULL)
372 udev_device->refcount++;
378 * @udev_device: udev device
380 * Drop a reference of a udev device. If the refcount reaches zero,
381 * the ressources of the device will be released.
384 void udev_device_unref(struct udev_device *udev_device)
386 if (udev_device == NULL)
388 udev_device->refcount--;
389 if (udev_device->refcount > 0)
391 if (udev_device->parent_device != NULL)
392 udev_device_unref(udev_device->parent_device);
393 free(udev_device->syspath);
394 free(udev_device->devnode);
395 free(udev_device->subsystem);
396 list_cleanup(udev_device->udev, &udev_device->devlink_list);
397 list_cleanup(udev_device->udev, &udev_device->properties_list);
398 free(udev_device->action);
399 free(udev_device->driver);
400 free(udev_device->devpath_old);
401 free(udev_device->physdevpath);
402 list_cleanup(udev_device->udev, &udev_device->attr_list);
403 info(udev_device->udev, "udev_device: %p released\n", udev_device);
408 * udev_device_get_devpath:
409 * @udev_device: udev device
411 * Retrieve the kernel devpath value of the udev device. The path
412 * does not contain the sys mount point, and starts with a '/'.
414 * Returns: the devpath of the udev device
416 const char *udev_device_get_devpath(struct udev_device *udev_device)
418 if (udev_device == NULL)
420 return udev_device->devpath;
424 * udev_device_get_syspath:
425 * @udev_device: udev device
427 * Retrieve the sys path of the udev device. The path is an
428 * absolute path and starts with the sys mount point.
430 * Returns: the sys path of the udev device
432 const char *udev_device_get_syspath(struct udev_device *udev_device)
434 if (udev_device == NULL)
436 return udev_device->syspath;
439 const char *udev_device_get_sysname(struct udev_device *udev_device)
441 if (udev_device == NULL)
443 return udev_device->sysname;
447 * udev_device_get_devnode:
448 * @udev_device: udev device
450 * Retrieve the device node file name belonging to the udev device.
451 * The path is an absolute path, and starts with the device directory.
453 * Returns: the device node file name of the udev device, or #NULL if no device node exists
455 const char *udev_device_get_devnode(struct udev_device *udev_device)
457 if (udev_device == NULL)
459 if (!udev_device->info_loaded)
460 device_load_info(udev_device);
461 return udev_device->devnode;
465 * udev_device_get_subsystem:
466 * @udev_device: udev device
468 * Retrieve the subsystem string of the udev device. The string does not
471 * Returns: the subsystem name of the udev device, or #NULL if it can not be determined
473 const char *udev_device_get_subsystem(struct udev_device *udev_device)
475 char subsystem[UTIL_NAME_SIZE];
477 if (udev_device == NULL)
479 if (udev_device->subsystem != NULL)
480 return udev_device->subsystem;
482 /* read "subsytem" link */
483 if (util_get_sys_subsystem(udev_device->udev, udev_device->syspath, subsystem, sizeof(subsystem)) > 0) {
484 udev_device->subsystem = strdup(subsystem);
485 return udev_device->subsystem;
489 if (strncmp(udev_device->devpath, "/module/", 8) == 0) {
490 udev_device->subsystem = strdup("module");
491 return udev_device->subsystem;
493 if (strstr(udev_device->devpath, "/drivers/") != NULL) {
494 udev_device->subsystem = strdup("drivers");
495 return udev_device->subsystem;
497 if (strncmp(udev_device->devpath, "/subsystem/", 11) == 0 ||
498 strncmp(udev_device->devpath, "/class/", 7) == 0 ||
499 strncmp(udev_device->devpath, "/bus/", 5) == 0) {
500 udev_device->subsystem = strdup("subsystem");
501 return udev_device->subsystem;
507 * udev_device_get_devlinks_list_entry:
508 * @udev_device: udev device
510 * Retrieve the list of device links pointing to the device file of
511 * the udev device. The next list entry can be retrieved with
512 * udev_list_entry_next(), which returns #NULL if no more entries exist.
513 * The devlink path can be retrieved from the list entry by
514 * udev_list_entry_get_name(). The path is an absolute path, and starts with
515 * the device directory.
517 * Returns: the first entry of the device node link list
519 struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device)
521 if (udev_device == NULL)
523 if (!udev_device->info_loaded)
524 device_load_info(udev_device);
525 return list_get_entry(&udev_device->devlink_list);
529 * udev_device_get_properties_list_entry:
530 * @udev_device: udev device
532 * Retrieve the list of key/value device properties of the udev
533 * device. The next list entry can be retrieved with udev_list_entry_next(),
534 * which returns #NULL if no more entries exist. The property name
535 * can be retrieved from the list entry by udev_list_get_name(),
536 * the property value by udev_list_get_value().
538 * Returns: the first entry of the property list
540 struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device)
542 if (udev_device == NULL)
544 if (!udev_device->info_loaded)
545 device_load_info(udev_device);
546 return list_get_entry(&udev_device->properties_list);
549 const char *udev_device_get_driver(struct udev_device *udev_device)
551 char driver[UTIL_NAME_SIZE];
553 if (udev_device == NULL)
555 if (udev_device->driver != NULL)
556 return udev_device->driver;
557 if (util_get_sys_driver(udev_device->udev, udev_device->syspath, driver, sizeof(driver)) < 2)
559 udev_device->driver = strdup(driver);
560 return udev_device->driver;
563 dev_t udev_device_get_devnum(struct udev_device *udev_device)
565 if (udev_device == NULL)
566 return makedev(0, 0);
567 if (!udev_device->info_loaded)
568 device_load_info(udev_device);
569 return udev_device->devnum;
572 const char *udev_device_get_action(struct udev_device *udev_device)
574 if (udev_device == NULL)
576 return udev_device->action;
579 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device)
581 if (udev_device == NULL)
583 return udev_device->seqnum;
586 const char *udev_device_get_attr_value(struct udev_device *udev_device, const char *attr)
588 struct udev_list_entry *list_entry;
589 char path[UTIL_PATH_SIZE];
590 char value[UTIL_NAME_SIZE];
594 const char *val = NULL;
596 /* look for possibly already cached result */
597 udev_list_entry_foreach(list_entry, list_get_entry(&udev_device->attr_list)) {
598 if (strcmp(udev_list_entry_get_name(list_entry), attr) == 0) {
599 info(udev_device->udev, "got '%s' (%s) from cache\n", attr, udev_list_entry_get_value(list_entry));
600 return udev_list_entry_get_value(list_entry);
604 util_strlcpy(path, udev_device_get_syspath(udev_device), sizeof(path));
605 util_strlcat(path, "/", sizeof(path));
606 util_strlcat(path, attr, sizeof(path));
608 if (lstat(path, &statbuf) != 0) {
609 info(udev_device->udev, "stat '%s' failed: %s\n", path, strerror(errno));
613 if (S_ISLNK(statbuf.st_mode)) {
614 /* links return the last element of the target path */
615 char target[UTIL_NAME_SIZE];
619 len = readlink(path, target, sizeof(target));
622 pos = strrchr(target, '/');
625 info(udev_device->udev, "cache '%s' with link value '%s'\n", attr, pos);
626 list_entry = list_entry_add(udev_device->udev, &udev_device->attr_list, attr, pos, 0, 0);
627 val = udev_list_entry_get_value(list_entry);
633 /* skip directories */
634 if (S_ISDIR(statbuf.st_mode))
637 /* skip non-readable files */
638 if ((statbuf.st_mode & S_IRUSR) == 0)
641 /* read attribute value */
642 fd = open(path, O_RDONLY);
644 info(udev_device->udev, "attribute '%s' can not be opened\n", path);
647 size = read(fd, value, sizeof(value));
651 if (size == sizeof(value))
654 /* got a valid value, store it in cache and return it */
656 util_remove_trailing_chars(value, '\n');
657 info(udev_device->udev, "'%s' has attribute value '%s'\n", path, value);
658 list_entry = list_entry_add(udev_device->udev, &udev_device->attr_list, attr, value, 0, 0);
659 val = udev_list_entry_get_value(list_entry);
663 int device_set_syspath(struct udev_device *udev_device, const char *syspath)
667 udev_device->syspath = strdup(syspath);
668 if (udev_device->syspath == NULL)
670 udev_device->devpath = &udev_device->syspath[strlen(udev_get_sys_path(udev_device->udev))];
671 pos = strrchr(udev_device->syspath, '/');
674 udev_device->sysname = &pos[1];
678 int device_set_subsystem(struct udev_device *udev_device, const char *subsystem)
680 udev_device->subsystem = strdup(subsystem);
681 if (udev_device->subsystem == NULL)
686 int device_set_devnode(struct udev_device *udev_device, const char *devnode)
688 udev_device->devnode = strdup(devnode);
689 if (udev_device->devnode == NULL)
694 int device_add_devlink(struct udev_device *udev_device, const char *devlink)
696 if (list_entry_add(udev_device->udev, &udev_device->devlink_list, devlink, NULL, 1, 0) == NULL)
701 int device_add_property(struct udev_device *udev_device, const char *key, const char *value)
703 if (list_entry_add(udev_device->udev, &udev_device->properties_list, key, value, 1, 0) == NULL)
708 int device_add_property_from_string(struct udev_device *udev_device, const char *property)
710 char name[UTIL_PATH_SIZE];
713 strncpy(name, property, sizeof(name));
714 val = strchr(name, '=');
721 device_add_property(udev_device, name, val);
725 int device_set_action(struct udev_device *udev_device, const char *action)
727 udev_device->action = strdup(action);
728 if (udev_device->action == NULL)
733 int device_set_driver(struct udev_device *udev_device, const char *driver)
735 udev_device->driver = strdup(driver);
736 if (udev_device->driver == NULL)
741 const char *device_get_devpath_old(struct udev_device *udev_device)
743 return udev_device->devpath_old;
746 int device_set_devpath_old(struct udev_device *udev_device, const char *devpath_old)
748 udev_device->devpath_old = strdup(devpath_old);
749 if (udev_device->devpath_old == NULL)
754 const char *device_get_physdevpath(struct udev_device *udev_device)
756 return udev_device->physdevpath;
759 int device_set_physdevpath(struct udev_device *udev_device, const char *physdevpath)
761 udev_device->physdevpath = strdup(physdevpath);
762 if (udev_device->physdevpath == NULL)
767 int device_get_timeout(struct udev_device *udev_device)
769 return udev_device->timeout;
772 int device_set_timeout(struct udev_device *udev_device, int timeout)
774 udev_device->timeout = timeout;
777 int device_get_event_timeout(struct udev_device *udev_device)
779 if (!udev_device->info_loaded)
780 device_load_info(udev_device);
781 return udev_device->event_timeout;
784 int device_set_event_timeout(struct udev_device *udev_device, int event_timeout)
786 udev_device->event_timeout = event_timeout;
790 int device_set_seqnum(struct udev_device *udev_device, unsigned long long int seqnum)
792 udev_device->seqnum = seqnum;
796 int device_set_devnum(struct udev_device *udev_device, dev_t devnum)
798 udev_device->devnum = devnum;
802 int device_get_num_fake_partitions(struct udev_device *udev_device)
804 if (!udev_device->info_loaded)
805 device_load_info(udev_device);
806 return udev_device->num_fake_partitions;
809 int device_set_num_fake_partitions(struct udev_device *udev_device, int num)
811 udev_device->num_fake_partitions = num;
815 int device_get_devlink_priority(struct udev_device *udev_device)
817 if (!udev_device->info_loaded)
818 device_load_info(udev_device);
819 return udev_device->devlink_priority;
822 int device_set_devlink_priority(struct udev_device *udev_device, int prio)
824 udev_device->devlink_priority = prio;
828 int device_get_ignore_remove(struct udev_device *udev_device)
830 if (!udev_device->info_loaded)
831 device_load_info(udev_device);
832 return udev_device->ignore_remove;
835 int device_set_ignore_remove(struct udev_device *udev_device, int ignore)
837 udev_device->ignore_remove = ignore;