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/>.
33 #include "libudev-private.h"
38 struct udev_device *parent_device;
44 struct list_head link_list;
45 struct list_head env_list;
52 unsigned long long int seqnum;
53 int num_fake_partitions;
56 struct list_head attr_list;
59 static size_t devpath_to_db_path(struct udev *udev, const char *devpath, char *filename, size_t len)
63 /* translate to location of db file */
64 util_strlcpy(filename, udev_get_dev_path(udev), len);
65 start = util_strlcat(filename, "/.udev/db/", len);
66 util_strlcat(filename, 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];
78 devpath_to_db_path(udev_device->udev, udev_device->devpath, filename, sizeof(filename));
80 if (lstat(filename, &stats) != 0) {
81 info(udev_device->udev, "no db file to read %s: %s\n", filename, strerror(errno));
84 if ((stats.st_mode & S_IFMT) == S_IFLNK) {
85 char target[UTIL_PATH_SIZE];
88 info(udev_device->udev, "found a symlink as db file\n");
89 target_len = readlink(filename, target, sizeof(target));
91 target[target_len] = '\0';
93 info(udev_device->udev, "error reading db link %s: %s\n", filename, strerror(errno));
96 dbg(udev_device->udev, "db link points to '%s'\n", target);
97 if (asprintf(&udev_device->devname, "%s/%s", udev_get_dev_path(udev_device->udev), target) < 0)
102 f = fopen(filename, "r");
104 info(udev_device->udev, "error reading db file %s: %s\n", filename, strerror(errno));
107 while (fgets(line, sizeof(line), f)) {
110 unsigned int maj, min;
120 asprintf(&udev_device->devname, "%s/%s", udev_get_dev_path(udev_device->udev), val);
123 sscanf(val, "%u:%u", &maj, &min);
124 device_set_devnum(udev_device, makedev(maj, min));
127 util_strlcpy(filename, udev_get_dev_path(udev_device->udev), sizeof(filename));
128 util_strlcat(filename, "/", sizeof(filename));
129 util_strlcat(filename, val, sizeof(filename));
130 device_add_devlink(udev_device, filename);
133 device_set_devlink_priority(udev_device, atoi(val));
136 device_set_timeout(udev_device, atoi(val));
139 device_set_num_fake_partitions(udev_device, atoi(val));
142 device_set_ignore_remove(udev_device, atoi(val));
145 device_add_property_from_string(udev_device, val);
154 struct udev_device *device_init(struct udev *udev)
156 struct udev_device *udev_device;
161 udev_device = malloc(sizeof(struct udev_device));
162 if (udev_device == NULL)
164 memset(udev_device, 0x00, sizeof(struct udev_device));
165 udev_device->refcount = 1;
166 udev_device->udev = udev;
167 INIT_LIST_HEAD(&udev_device->link_list);
168 INIT_LIST_HEAD(&udev_device->env_list);
169 INIT_LIST_HEAD(&udev_device->attr_list);
170 info(udev_device->udev, "udev_device: %p created\n", udev_device);
175 * udev_device_new_from_devpath:
176 * @udev: udev library context
177 * @devpath: sys device path
179 * Create new udev device, and fill in information from the sysfs
180 * device and the udev database entry. The devpath must not contain
181 * the sysfs mount path, and must contain a leading '/'.
183 * The initial refcount is 1, and needs to be decremented to
184 * release the ressources of the udev device.
186 * Returns: a new udev device, or #NULL, if it does not exist
188 struct udev_device *udev_device_new_from_devpath(struct udev *udev, const char *devpath)
190 char path[UTIL_PATH_SIZE];
192 struct udev_device *udev_device;
199 util_strlcpy(path, udev_get_sys_path(udev), sizeof(path));
200 util_strlcat(path, devpath, sizeof(path));
201 util_strlcat(path, "/uevent", sizeof(path));
202 if (stat(path, &statbuf) != 0) {
203 info(udev, "not a device :%s\n", devpath);
207 udev_device = device_init(udev);
208 if (udev_device == NULL)
211 /* resolve possible symlink to real path */
212 util_strlcpy(path, devpath, sizeof(path));
213 util_resolve_sys_link(udev, path, sizeof(path));
214 device_set_devpath(udev_device, path);
215 info(udev, "device %p has devpath '%s'\n", udev_device, udev_device_get_devpath(udev_device));
217 if (device_read_db(udev_device) >= 0)
218 info(udev, "device %p filled with udev database data\n", udev_device);
222 static struct udev_device *device_new_from_parent(struct udev_device *udev_device)
224 struct udev_device *udev_device_parent = NULL;
225 char path[UTIL_PATH_SIZE];
228 if (udev_device == NULL)
231 util_strlcpy(path, udev_device_get_devpath(udev_device), sizeof(path));
233 pos = strrchr(path, '/');
234 if (pos == path || pos == NULL)
237 udev_device_parent = udev_device_new_from_devpath(udev_device->udev, path);
238 if (udev_device_parent != NULL)
239 return udev_device_parent;
242 /* follow "device" link in deprecated sysfs /sys/class/ layout */
243 if (strncmp(udev_device->devpath, "/class/", 7) == 0) {
244 util_strlcpy(path, udev_device->devpath, sizeof(path));
245 util_strlcat(path, "/device", sizeof(path));
246 if (util_resolve_sys_link(udev_device->udev, path, sizeof(path)) == 0) {
247 udev_device_parent = udev_device_new_from_devpath(udev_device->udev, path);
248 if (udev_device_parent != NULL)
249 return udev_device_parent;
255 struct udev_device *udev_device_get_parent(struct udev_device *udev_device)
257 if (udev_device->parent_device != NULL) {
258 info(udev_device->udev, "returning existing parent %p\n", udev_device->parent_device);
259 return udev_device->parent_device;
261 udev_device->parent_device = device_new_from_parent(udev_device);
262 return udev_device->parent_device;
266 * udev_device_get_udev:
267 * @udev_device: udev device
269 * Retrieve the udev library context the device was created with.
271 * Returns: the udev library context
273 struct udev *udev_device_get_udev(struct udev_device *udev_device)
275 if (udev_device == NULL)
277 return udev_device->udev;
282 * @udev_device: udev device
284 * Take a reference of a udev device.
286 * Returns: the passed udev device
288 struct udev_device *udev_device_ref(struct udev_device *udev_device)
290 if (udev_device == NULL)
292 udev_device->refcount++;
298 * @udev_device: udev device
300 * Drop a reference of a udev device. If the refcount reaches zero,
301 * the ressources of the device will be released.
304 void udev_device_unref(struct udev_device *udev_device)
306 if (udev_device == NULL)
308 udev_device->refcount--;
309 if (udev_device->refcount > 0)
311 if (udev_device->parent_device != NULL)
312 udev_device_unref(udev_device->parent_device);
313 free(udev_device->syspath);
314 free(udev_device->devname);
315 free(udev_device->subsystem);
316 util_name_list_cleanup(udev_device->udev, &udev_device->link_list);
317 util_name_list_cleanup(udev_device->udev, &udev_device->env_list);
318 free(udev_device->action);
319 free(udev_device->driver);
320 free(udev_device->devpath_old);
321 free(udev_device->physdevpath);
322 util_name_list_cleanup(udev_device->udev, &udev_device->attr_list);
323 info(udev_device->udev, "udev_device: %p released\n", udev_device);
328 * udev_device_get_devpath:
329 * @udev_device: udev device
331 * Retrieve the kernel devpath value of the udev device. The path
332 * does not contain the sys mount point, and starts with a '/'.
334 * Returns: the devpath of the udev device
336 const char *udev_device_get_devpath(struct udev_device *udev_device)
338 if (udev_device == NULL)
340 return udev_device->devpath;
344 * udev_device_get_syspath:
345 * @udev_device: udev device
347 * Retrieve the sys path of the udev device. The path is an
348 * absolute path and starts with the sys mount point.
350 * Returns: the sys path of the udev device
352 const char *udev_device_get_syspath(struct udev_device *udev_device)
354 if (udev_device == NULL)
356 return udev_device->syspath;
359 const char *udev_device_get_sysname(struct udev_device *udev_device)
361 if (udev_device == NULL)
363 return udev_device->sysname;
367 * udev_device_get_devname:
368 * @udev_device: udev device
370 * Retrieve the device node file name belonging to the udev device.
371 * The path is an absolute path, and starts with the device directory.
373 * Returns: the device node file name of the udev device, or #NULL if no device node exists
375 const char *udev_device_get_devname(struct udev_device *udev_device)
377 if (udev_device == NULL)
379 return udev_device->devname;
383 * udev_device_get_subsystem:
384 * @udev_device: udev device
386 * Retrieve the subsystem string of the udev device. The string does not
389 * Returns: the subsystem name of the udev device, or #NULL if it can not be determined
391 const char *udev_device_get_subsystem(struct udev_device *udev_device)
393 char subsystem[UTIL_NAME_SIZE];
395 if (udev_device == NULL)
397 if (udev_device->subsystem != NULL)
398 return udev_device->subsystem;
400 /* read "subsytem" link */
401 if (util_get_sys_subsystem(udev_device->udev, udev_device->devpath, subsystem, sizeof(subsystem)) == 0) {
402 udev_device->subsystem = strdup(subsystem);
403 return udev_device->subsystem;
407 if (strncmp(udev_device->devpath, "/module/", 8) == 0) {
408 udev_device->subsystem = strdup("module");
409 return udev_device->subsystem;
411 if (strstr(udev_device->devpath, "/drivers/") != NULL) {
412 udev_device->subsystem = strdup("drivers");
413 return udev_device->subsystem;
415 if (strncmp(udev_device->devpath, "/subsystem/", 11) == 0 ||
416 strncmp(udev_device->devpath, "/class/", 7) == 0 ||
417 strncmp(udev_device->devpath, "/bus/", 5) == 0) {
418 udev_device->subsystem = strdup("subsystem");
419 return udev_device->subsystem;
425 * udev_device_get_devlinks:
426 * @udev_device: udev device
427 * @cb: function to be called for every device link found
428 * @data: data to be passed to the function
430 * Retrieve the device links pointing to the device file of the
431 * udev device. For every device link, the passed function will be
432 * called with the device link string.
433 * The path is an absolute path, and starts with the device directory.
434 * If the function returns 1, remaning device links will be ignored.
436 * Returns: the number of device links passed to the caller, or a negative value on error
438 int udev_device_get_devlinks(struct udev_device *udev_device,
439 int (*cb)(struct udev_device *udev_device, const char *value, void *data),
442 struct util_name_entry *name_loop;
445 if (udev_device == NULL)
447 list_for_each_entry(name_loop, &udev_device->link_list, node) {
449 if (cb(udev_device, name_loop->name, data) != 0)
456 * udev_device_get_properties:
457 * @udev_device: udev device
458 * @cb: function to be called for every property found
459 * @data: data to be passed to the function
461 * Retrieve the property key/value pairs belonging to the
462 * udev device. For every key/value pair, the passed function will be
463 * called. If the function returns 1, remaning properties will be
466 * Returns: the number of properties passed to the caller, or a negative value on error
468 int udev_device_get_properties(struct udev_device *udev_device,
469 int (*cb)(struct udev_device *udev_device, const char *key, const char *value, void *data),
472 struct util_name_entry *name_loop;
475 if (udev_device == NULL)
477 list_for_each_entry(name_loop, &udev_device->env_list, node) {
479 if (cb(udev_device, name_loop->name, name_loop->value, data) != 0)
485 const char *udev_device_get_driver(struct udev_device *udev_device)
487 char driver[UTIL_NAME_SIZE];
489 if (udev_device == NULL)
491 if (udev_device->driver != NULL)
492 return udev_device->driver;
493 if (util_get_sys_driver(udev_device->udev, udev_device->devpath, driver, sizeof(driver)) < 2)
495 udev_device->driver = strdup(driver);
496 return udev_device->driver;
499 dev_t udev_device_get_devnum(struct udev_device *udev_device)
501 if (udev_device == NULL)
502 return makedev(0, 0);
503 return udev_device->devnum;
506 const char *udev_device_get_action(struct udev_device *udev_device)
508 if (udev_device == NULL)
510 return udev_device->action;
513 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device)
515 if (udev_device == NULL)
517 return udev_device->seqnum;
520 const char *udev_device_get_attr_value(struct udev_device *udev_device, const char *attr)
522 struct util_name_entry *name_loop;
523 char path[UTIL_PATH_SIZE];
524 char value[UTIL_NAME_SIZE];
528 const char *val = NULL;
530 /* look for possibly already cached result */
531 list_for_each_entry(name_loop, &udev_device->attr_list, node) {
532 if (strcmp(name_loop->name, attr) == 0) {
533 info(udev_device->udev, "'%s' in cache '%s'\n", attr, name_loop->value);
534 return name_loop->value;
538 util_strlcpy(path, udev_device_get_syspath(udev_device), sizeof(path));
539 util_strlcat(path, "/", sizeof(path));
540 util_strlcat(path, attr, sizeof(path));
542 if (lstat(path, &statbuf) != 0) {
543 info(udev_device->udev, "stat '%s' failed: %s\n", path, strerror(errno));
547 if (S_ISLNK(statbuf.st_mode)) {
548 /* links return the last element of the target path */
549 char target[UTIL_NAME_SIZE];
553 len = readlink(path, target, sizeof(target));
556 pos = strrchr(target, '/');
559 info(udev_device->udev, "cache '%s' with link value '%s'\n", attr, pos);
560 val = util_name_list_add(udev_device->udev, &udev_device->attr_list, attr, pos, 0)->value;
566 /* skip directories */
567 if (S_ISDIR(statbuf.st_mode))
570 /* skip non-readable files */
571 if ((statbuf.st_mode & S_IRUSR) == 0)
574 /* read attribute value */
575 fd = open(path, O_RDONLY);
577 info(udev_device->udev, "attribute '%s' can not be opened\n", path);
580 size = read(fd, value, sizeof(value));
584 if (size == sizeof(value))
587 /* got a valid value, store it in cache and return it */
589 util_remove_trailing_chars(value, '\n');
590 info(udev_device->udev, "'%s' has attribute value '%s'\n", path, value);
591 val = util_name_list_add(udev_device->udev, &udev_device->attr_list, attr, value, 0)->value;
595 int device_set_devpath(struct udev_device *udev_device, const char *devpath)
597 if (asprintf(&udev_device->syspath, "%s%s", udev_get_sys_path(udev_device->udev), devpath) < 0)
599 udev_device->devpath = &udev_device->syspath[strlen(udev_get_sys_path(udev_device->udev))];
600 udev_device->sysname = strrchr(udev_device->syspath, '/');
601 if (udev_device->sysname != NULL)
602 udev_device->sysname = &udev_device->sysname[1];
606 int device_set_subsystem(struct udev_device *udev_device, const char *subsystem)
608 udev_device->subsystem = strdup(subsystem);
609 if (udev_device->subsystem == NULL)
614 int device_set_devname(struct udev_device *udev_device, const char *devname)
616 udev_device->devname = strdup(devname);
617 if (udev_device->devname == NULL)
622 int device_add_devlink(struct udev_device *udev_device, const char *devlink)
624 if (util_name_list_add(udev_device->udev, &udev_device->link_list, devlink, NULL, 0) == NULL)
629 int device_add_property(struct udev_device *udev_device, const char *key, const char *value)
631 if (util_name_list_add(udev_device->udev, &udev_device->env_list, key, value, 0) == NULL)
636 int device_add_property_from_string(struct udev_device *udev_device, const char *property)
638 char name[UTIL_PATH_SIZE];
641 strncpy(name, property, sizeof(name));
642 val = strchr(name, '=');
649 device_add_property(udev_device, name, val);
653 int device_set_action(struct udev_device *udev_device, const char *action)
655 udev_device->action = strdup(action);
656 if (udev_device->action == NULL)
661 int device_set_driver(struct udev_device *udev_device, const char *driver)
663 udev_device->driver = strdup(driver);
664 if (udev_device->driver == NULL)
669 const char *device_get_devpath_old(struct udev_device *udev_device)
671 if (udev_device == NULL)
673 return udev_device->devpath_old;
676 int device_set_devpath_old(struct udev_device *udev_device, const char *devpath_old)
678 udev_device->devpath_old = strdup(devpath_old);
679 if (udev_device->devpath_old == NULL)
684 const char *device_get_physdevpath(struct udev_device *udev_device)
686 if (udev_device == NULL)
688 return udev_device->physdevpath;
691 int device_set_physdevpath(struct udev_device *udev_device, const char *physdevpath)
693 udev_device->physdevpath = strdup(physdevpath);
694 if (udev_device->physdevpath == NULL)
699 int device_get_timeout(struct udev_device *udev_device)
701 if (udev_device == NULL)
703 return udev_device->timeout;
706 int device_set_timeout(struct udev_device *udev_device, int timeout)
708 udev_device->timeout = timeout;
712 int device_set_seqnum(struct udev_device *udev_device, unsigned long long int seqnum)
714 udev_device->seqnum = seqnum;
718 int device_set_devnum(struct udev_device *udev_device, dev_t devnum)
720 udev_device->devnum = devnum;
724 int device_get_num_fake_partitions(struct udev_device *udev_device)
726 if (udev_device == NULL)
728 return udev_device->num_fake_partitions;
731 int device_set_num_fake_partitions(struct udev_device *udev_device, int num)
733 udev_device->num_fake_partitions = num;
737 int device_get_devlink_priority(struct udev_device *udev_device)
739 if (udev_device == NULL)
741 return udev_device->devlink_priority;
744 int device_set_devlink_priority(struct udev_device *udev_device, int prio)
746 udev_device->devlink_priority = prio;
750 int device_get_ignore_remove(struct udev_device *udev_device)
752 if (udev_device == NULL)
754 return udev_device->ignore_remove;
757 int device_set_ignore_remove(struct udev_device *udev_device, int ignore)
759 udev_device->ignore_remove = ignore;