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/>.
32 #include "libudev-private.h"
42 struct list_head link_list;
43 struct list_head env_list;
50 unsigned long long int seqnum;
51 int num_fake_partitions;
56 static size_t devpath_to_db_path(struct udev *udev, const char *devpath, char *filename, size_t len)
60 /* translate to location of db file */
61 strlcpy(filename, udev_get_dev_path(udev), len);
62 start = strlcat(filename, "/.udev/db/", len);
63 strlcat(filename, devpath, len);
64 return util_path_encode(&filename[start], len - start);
67 static int device_read_db(struct udev_device *udev_device)
70 char filename[PATH_SIZE];
75 devpath_to_db_path(udev_device->udev, udev_device->devpath, filename, sizeof(filename));
77 if (lstat(filename, &stats) != 0) {
78 info(udev_device->udev, "no db file to read %s: %s\n", filename, strerror(errno));
81 if ((stats.st_mode & S_IFMT) == S_IFLNK) {
82 char target[NAME_SIZE];
85 info(udev_device->udev, "found a symlink as db file\n");
86 target_len = readlink(filename, target, sizeof(target));
88 target[target_len] = '\0';
90 info(udev_device->udev, "error reading db link %s: %s\n", filename, strerror(errno));
93 dbg(udev_device->udev, "db link points to '%s'\n", target);
94 if (asprintf(&udev_device->devname, "%s/%s", udev_get_dev_path(udev_device->udev), target) < 0)
99 f = fopen(filename, "r");
101 info(udev_device->udev, "error reading db file %s: %s\n", filename, strerror(errno));
104 while (fgets(line, sizeof(line), f)) {
107 unsigned int maj, min;
117 asprintf(&udev_device->devname, "%s/%s", udev_get_dev_path(udev_device->udev), val);
120 sscanf(val, "%u:%u", &maj, &min);
121 device_set_devnum(udev_device, makedev(maj, min));
124 strlcpy(filename, udev_get_dev_path(udev_device->udev), sizeof(filename));
125 strlcat(filename, "/", sizeof(filename));
126 strlcat(filename, val, sizeof(filename));
127 device_add_devlink(udev_device, filename);
130 device_set_devlink_priority(udev_device, atoi(val));
133 device_set_timeout(udev_device, atoi(val));
136 device_set_num_fake_partitions(udev_device, atoi(val));
139 device_set_ignore_remove(udev_device, atoi(val));
142 device_add_property(udev_device, val);
151 struct udev_device *device_init(struct udev *udev)
153 struct udev_device *udev_device;
158 udev_device = malloc(sizeof(struct udev_device));
159 if (udev_device == NULL)
161 memset(udev_device, 0x00, sizeof(struct udev_device));
162 udev_device->refcount = 1;
163 udev_device->udev = udev;
164 INIT_LIST_HEAD(&udev_device->link_list);
165 INIT_LIST_HEAD(&udev_device->env_list);
166 info(udev_device->udev, "udev_device: %p created\n", udev_device);
171 * udev_device_new_from_devpath:
172 * @udev: udev library context
173 * @devpath: sys device path
175 * Create new udev device, and fill in information from the sysfs
176 * device and the udev database entry. The devpath must not contain
177 * the sysfs mount path, and must contain a leading '/'.
179 * The initial refcount is 1, and needs to be decremented to
180 * release the ressources of the udev device.
182 * Returns: a new udev device, or #NULL, if it does not exist
184 struct udev_device *udev_device_new_from_devpath(struct udev *udev, const char *devpath)
186 char path[PATH_SIZE];
188 struct udev_device *udev_device;
195 strlcpy(path, udev_get_sys_path(udev), sizeof(path));
196 strlcat(path, devpath, sizeof(path));
197 if (stat(path, &statbuf) != 0)
199 if (!S_ISDIR(statbuf.st_mode))
202 udev_device = device_init(udev);
203 if (udev_device == NULL)
206 /* resolve possible symlink to real path */
207 strlcpy(path, devpath, sizeof(path));
208 util_resolve_sys_link(udev, path, sizeof(path));
209 device_set_devpath(udev_device, path);
210 info(udev, "device %p has devpath '%s'\n", udev_device, udev_device_get_devpath(udev_device));
212 if (device_read_db(udev_device) >= 0)
213 info(udev, "device %p filled with udev database data\n", udev_device);
219 * udev_device_get_udev:
220 * @udev_device: udev device
222 * Retrieve the udev library context the device was created with.
224 * Returns: the udev library context
226 struct udev *udev_device_get_udev(struct udev_device *udev_device)
228 if (udev_device == NULL)
230 return udev_device->udev;
235 * @udev_device: udev device
237 * Take a reference of a udev device.
239 * Returns: the passed udev device
241 struct udev_device *udev_device_ref(struct udev_device *udev_device)
243 if (udev_device == NULL)
245 udev_device->refcount++;
251 * @udev_device: udev device
253 * Drop a reference of a udev device. If the refcount reaches zero,
254 * the ressources of the device will be released.
257 void udev_device_unref(struct udev_device *udev_device)
259 if (udev_device == NULL)
261 udev_device->refcount--;
262 if (udev_device->refcount > 0)
264 free(udev_device->syspath);
265 free(udev_device->devname);
266 free(udev_device->subsystem);
267 util_name_list_cleanup(udev_device->udev, &udev_device->link_list);
268 util_name_list_cleanup(udev_device->udev, &udev_device->env_list);
269 free(udev_device->action);
270 free(udev_device->driver);
271 free(udev_device->devpath_old);
272 free(udev_device->physdevpath);
273 info(udev_device->udev, "udev_device: %p released\n", udev_device);
278 * udev_device_get_devpath:
279 * @udev_device: udev device
281 * Retrieve the kernel devpath value of the udev device. The path
282 * does not contain the sys mount point, and starts with a '/'.
284 * Returns: the devpath of the udev device
286 const char *udev_device_get_devpath(struct udev_device *udev_device)
288 if (udev_device == NULL)
290 return udev_device->devpath;
294 * udev_device_get_syspath:
295 * @udev_device: udev device
297 * Retrieve the sys path of the udev device. The path is an
298 * absolute path and starts with the sys mount point.
300 * Returns: the sys path of the udev device
302 const char *udev_device_get_syspath(struct udev_device *udev_device)
304 if (udev_device == NULL)
306 return udev_device->syspath;
310 * udev_device_get_devname:
311 * @udev_device: udev device
313 * Retrieve the device node file name belonging to the udev device.
314 * The path is an absolute path, and starts with the device directory.
316 * Returns: the device node file name of the udev device, or #NULL if no device node exists
318 const char *udev_device_get_devname(struct udev_device *udev_device)
320 if (udev_device == NULL)
322 return udev_device->devname;
326 * udev_device_get_subsystem:
327 * @udev_device: udev device
329 * Retrieve the subsystem string of the udev device. The string does not
332 * Returns: the subsystem name of the udev device, or #NULL if it can not be determined
334 const char *udev_device_get_subsystem(struct udev_device *udev_device)
336 char subsystem[NAME_SIZE];
338 if (udev_device == NULL)
340 if (udev_device->subsystem != NULL)
341 return udev_device->subsystem;
342 if (util_get_sys_subsystem(udev_device->udev, udev_device->devpath, subsystem, sizeof(subsystem)) < 2)
344 udev_device->subsystem = strdup(subsystem);
345 return udev_device->subsystem;
349 * udev_device_get_devlinks:
350 * @udev_device: udev device
351 * @cb: function to be called for every device link found
352 * @data: data to be passed to the function
354 * Retrieve the device links pointing to the device file of the
355 * udev device. For every device link, the passed function will be
356 * called with the device link string.
357 * The path is an absolute path, and starts with the device directory.
358 * If the function returns 1, remaning device links will be ignored.
360 * Returns: the number of device links passed to the caller, or a negative value on error
362 int udev_device_get_devlinks(struct udev_device *udev_device,
363 int (*cb)(struct udev_device *udev_device, const char *value, void *data),
366 struct name_entry *name_loop;
369 if (udev_device == NULL)
371 list_for_each_entry(name_loop, &udev_device->link_list, node) {
373 if (cb(udev_device, name_loop->name, data) != 0)
380 * udev_device_get_properties:
381 * @udev_device: udev device
382 * @cb: function to be called for every property found
383 * @data: data to be passed to the function
385 * Retrieve the property key/value pairs belonging to the
386 * udev device. For every key/value pair, the passed function will be
387 * called. If the function returns 1, remaning properties will be
390 * Returns: the number of properties passed to the caller, or a negative value on error
392 int udev_device_get_properties(struct udev_device *udev_device,
393 int (*cb)(struct udev_device *udev_device, const char *key, const char *value, void *data),
396 struct name_entry *name_loop;
399 if (udev_device == NULL)
401 list_for_each_entry(name_loop, &udev_device->env_list, node) {
402 char name[PATH_SIZE];
405 strncpy(name, name_loop->name, PATH_SIZE);
406 name[PATH_SIZE-1] = '\0';
407 val = strchr(name, '=');
413 if (cb(udev_device, name, val, data) != 0)
419 const char *udev_device_get_driver(struct udev_device *udev_device)
421 char driver[NAME_SIZE];
423 if (udev_device == NULL)
425 if (udev_device->driver != NULL)
426 return udev_device->driver;
427 if (util_get_sys_driver(udev_device->udev, udev_device->devpath, driver, sizeof(driver)) < 2)
429 udev_device->driver = strdup(driver);
430 return udev_device->driver;
433 dev_t udev_device_get_devnum(struct udev_device *udev_device)
435 if (udev_device == NULL)
436 return makedev(0, 0);
437 return udev_device->devnum;
440 const char *udev_device_get_action(struct udev_device *udev_device)
442 if (udev_device == NULL)
444 return udev_device->action;
447 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device)
449 if (udev_device == NULL)
451 return udev_device->seqnum;
454 int device_set_devpath(struct udev_device *udev_device, const char *devpath)
456 if (asprintf(&udev_device->syspath, "%s%s", udev_get_sys_path(udev_device->udev), devpath) < 0)
458 udev_device->devpath = &udev_device->syspath[strlen(udev_get_sys_path(udev_device->udev))];
462 int device_set_subsystem(struct udev_device *udev_device, const char *subsystem)
464 udev_device->subsystem = strdup(subsystem);
465 if (udev_device->subsystem == NULL)
470 int device_set_devname(struct udev_device *udev_device, const char *devname)
472 udev_device->devname = strdup(devname);
473 if (udev_device->devname == NULL)
478 int device_add_devlink(struct udev_device *udev_device, const char *devlink)
480 if (util_name_list_add(udev_device->udev, &udev_device->link_list, devlink, 0) == NULL)
485 int device_add_property(struct udev_device *udev_device, const char *property)
487 if (util_name_list_add(udev_device->udev, &udev_device->env_list, property, 0) == NULL)
492 int device_set_action(struct udev_device *udev_device, const char *action)
494 udev_device->action = strdup(action);
495 if (udev_device->action == NULL)
500 int device_set_driver(struct udev_device *udev_device, const char *driver)
502 udev_device->driver = strdup(driver);
503 if (udev_device->driver == NULL)
508 const char *device_get_devpath_old(struct udev_device *udev_device)
510 if (udev_device == NULL)
512 return udev_device->devpath_old;
515 int device_set_devpath_old(struct udev_device *udev_device, const char *devpath_old)
517 udev_device->devpath_old = strdup(devpath_old);
518 if (udev_device->devpath_old == NULL)
523 const char *device_get_physdevpath(struct udev_device *udev_device)
525 if (udev_device == NULL)
527 return udev_device->physdevpath;
530 int device_set_physdevpath(struct udev_device *udev_device, const char *physdevpath)
532 udev_device->physdevpath = strdup(physdevpath);
533 if (udev_device->physdevpath == NULL)
538 int device_get_timeout(struct udev_device *udev_device)
540 if (udev_device == NULL)
542 return udev_device->timeout;
545 int device_set_timeout(struct udev_device *udev_device, int timeout)
547 udev_device->timeout = timeout;
551 int device_set_seqnum(struct udev_device *udev_device, unsigned long long int seqnum)
553 udev_device->seqnum = seqnum;
557 int device_set_devnum(struct udev_device *udev_device, dev_t devnum)
559 udev_device->devnum = devnum;
563 int device_get_num_fake_partitions(struct udev_device *udev_device)
565 if (udev_device == NULL)
567 return udev_device->num_fake_partitions;
570 int device_set_num_fake_partitions(struct udev_device *udev_device, int num)
572 udev_device->num_fake_partitions = num;
576 int device_get_devlink_priority(struct udev_device *udev_device)
578 if (udev_device == NULL)
580 return udev_device->devlink_priority;
583 int device_set_devlink_priority(struct udev_device *udev_device, int prio)
585 udev_device->devlink_priority = prio;
589 int device_get_ignore_remove(struct udev_device *udev_device)
591 if (udev_device == NULL)
593 return udev_device->ignore_remove;
596 int device_set_ignore_remove(struct udev_device *udev_device, int ignore)
598 udev_device->ignore_remove = ignore;