chiark / gitweb /
libudev: rework list handling
[elogind.git] / udev / lib / libudev.h
1 /*
2  * libudev - interface to udev device information
3  *
4  * Copyright (C) 2008 Kay Sievers <kay.sievers@vrfy.org>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 #ifndef _LIBUDEV_H_
21 #define _LIBUDEV_H_
22
23 #include <stdarg.h>
24 #include <sys/stat.h>
25
26 /* this will stay as long as the DeviceKit integration of udev is work in progress */
27 #if !defined _LIBUDEV_COMPILATION && !defined LIBUDEV_I_KNOW_THE_API_IS_SUBJECT_TO_CHANGE
28 #error "#define LIBUDEV_I_KNOW_THE_API_IS_SUBJECT_TO_CHANGE is needed to use this experimental library version"
29 #endif
30
31 struct udev;
32 struct udev_list;
33 struct udev_device;
34 struct udev_enumerate;
35 struct udev_monitor;
36
37 /* library context */
38 extern struct udev *udev_new(void);
39 extern struct udev *udev_ref(struct udev *udev);
40 extern void udev_unref(struct udev *udev);
41 extern void udev_set_log_fn(struct udev *udev,
42                             void (*log_fn)(struct udev *udev,
43                                            int priority, const char *file, int line, const char *fn,
44                                            const char *format, va_list args));
45 extern int udev_get_log_priority(struct udev *udev);
46 extern void udev_set_log_priority(struct udev *udev, int priority);
47 extern const char *udev_get_sys_path(struct udev *udev);
48 extern const char *udev_get_dev_path(struct udev *udev);
49 extern void *udev_get_userdata(struct udev *udev);
50 extern void udev_set_userdata(struct udev *udev, void *userdata);
51
52 /* selinux glue */
53 extern void udev_selinux_resetfscreatecon(struct udev *udev);
54 extern void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode);
55 extern void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode);
56
57 /* list iteration */
58 extern struct udev_list *udev_list_entry_get_next(struct udev_list *list_entry);
59 extern const char *udev_list_entry_get_name(struct udev_list *list_entry);
60 extern const char *udev_list_entry_get_value(struct udev_list *list_entry);
61
62 /* sys devices */
63 extern struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath);
64 extern struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum);
65 extern struct udev_device *udev_device_get_parent(struct udev_device *udev_device);
66 extern struct udev_device *udev_device_ref(struct udev_device *udev_device);
67 extern void udev_device_unref(struct udev_device *udev_device);
68 extern struct udev *udev_device_get_udev(struct udev_device *udev_device);
69 extern const char *udev_device_get_devpath(struct udev_device *udev_device);
70 extern const char *udev_device_get_subsystem(struct udev_device *udev_device);
71 extern const char *udev_device_get_syspath(struct udev_device *udev_device);
72 extern const char *udev_device_get_sysname(struct udev_device *udev_device);
73 extern const char *udev_device_get_devnode(struct udev_device *udev_device);
74 extern struct udev_list *udev_device_get_devlinks_list(struct udev_device *udev_device);
75 extern struct udev_list *udev_device_get_properties_list(struct udev_device *udev_device);
76 extern const char *udev_device_get_driver(struct udev_device *udev_device);
77 extern dev_t udev_device_get_devnum(struct udev_device *udev_device);
78 extern const char *udev_device_get_action(struct udev_device *udev_device);
79 extern unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device);
80 extern const char *udev_device_get_attr_value(struct udev_device *udev_device, const char *attr);
81
82 /* sys enumeration */
83 extern struct udev_enumerate *udev_enumerate_new_from_subsystems(struct udev *udev, const char *subsystem);
84 extern struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate);
85 extern void udev_enumerate_unref(struct udev_enumerate *udev_enumerate);
86 extern struct udev_list *udev_enumerate_get_list(struct udev_enumerate *udev_enumerate);
87
88 /* udev and kernel device events */
89 extern struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char *socket_path);
90 extern struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev);
91 extern int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor);
92 extern struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor);
93 extern void udev_monitor_unref(struct udev_monitor *udev_monitor);
94 extern struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor);
95 extern int udev_monitor_get_fd(struct udev_monitor *udev_monitor);
96 extern struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor);
97
98 #endif