2 * libudev - interface to udev device information
4 * Copyright (C) 2008-2010 Kay Sievers <kay.sievers@vrfy.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
12 #ifndef _LIBUDEV_PRIVATE_H_
13 #define _LIBUDEV_PRIVATE_H_
21 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
25 static inline void __attribute__((always_inline, format(printf, 2, 3)))
26 udev_log_null(struct udev *udev, const char *format, ...) {}
28 #define udev_log_cond(udev, prio, arg...) \
30 if (udev_get_log_priority(udev) >= prio) \
31 udev_log(udev, prio, __FILE__, __LINE__, __FUNCTION__, ## arg); \
36 # define dbg(udev, arg...) udev_log_cond(udev, LOG_DEBUG, ## arg)
38 # define dbg(udev, arg...) udev_log_null(udev, ## arg)
40 # define info(udev, arg...) udev_log_cond(udev, LOG_INFO, ## arg)
41 # define err(udev, arg...) udev_log_cond(udev, LOG_ERR, ## arg)
43 # define dbg(udev, arg...) udev_log_null(udev, ## arg)
44 # define info(udev, arg...) udev_log_null(udev, ## arg)
45 # define err(udev, arg...) udev_log_null(udev, ## arg)
48 static inline void udev_log_init(const char *program_name)
50 openlog(program_name, LOG_PID | LOG_CONS, LOG_DAEMON);
53 static inline void udev_log_close(void)
59 void udev_log(struct udev *udev,
60 int priority, const char *file, int line, const char *fn,
61 const char *format, ...)
62 __attribute__((format(printf, 6, 7)));
63 const char *udev_get_rules_path(struct udev *udev);
64 const char *udev_get_run_config_path(struct udev *udev);
65 const char *udev_set_run_path(struct udev *udev, const char *path);
66 struct udev_list_entry *udev_add_property(struct udev *udev, const char *key, const char *value);
67 struct udev_list_entry *udev_get_properties_list_entry(struct udev *udev);
69 /* libudev-device.c */
70 struct udev_device *udev_device_new(struct udev *udev);
71 struct udev_device *udev_device_new_from_id_filename(struct udev *udev, char *id);
72 int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
73 int udev_device_set_subsystem(struct udev_device *udev_device, const char *subsystem);
74 int udev_device_set_devtype(struct udev_device *udev_device, const char *devtype);
75 int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
76 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink, int unique);
77 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
78 struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
79 void udev_device_add_property_from_string_parse(struct udev_device *udev_device, const char *property);
80 int udev_device_add_property_from_string_parse_finish(struct udev_device *udev_device);
81 char **udev_device_get_properties_envp(struct udev_device *udev_device);
82 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
83 int udev_device_read_db(struct udev_device *udev_device, const char *dbfile);
84 int udev_device_read_uevent_file(struct udev_device *udev_device);
85 int udev_device_set_action(struct udev_device *udev_device, const char *action);
86 int udev_device_set_driver(struct udev_device *udev_device, const char *driver);
87 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
88 const char *udev_device_get_sysname_old(struct udev_device *udev_device);
89 int udev_device_set_devpath_old(struct udev_device *udev_device, const char *devpath_old);
90 const char *udev_device_get_knodename(struct udev_device *udev_device);
91 const char *udev_device_get_id_filename(struct udev_device *udev_device);
92 void udev_device_set_is_initialized(struct udev_device *udev_device);
93 int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
94 void udev_device_cleanup_tags_list(struct udev_device *udev_device);
95 int udev_device_has_tag(struct udev_device *udev_device, const char *tag);
96 int udev_device_set_knodename(struct udev_device *udev_device, const char *knodename);
97 int udev_device_get_timeout(struct udev_device *udev_device);
98 int udev_device_set_timeout(struct udev_device *udev_device, int timeout);
99 int udev_device_set_devnum(struct udev_device *udev_device, dev_t devnum);
100 int udev_device_set_seqnum(struct udev_device *udev_device, unsigned long long int seqnum);
101 unsigned long long udev_device_get_usec_initialized(struct udev_device *udev_device);
102 void udev_device_set_usec_initialized(struct udev_device *udev_device, unsigned long long usec_initialized);
103 int udev_device_get_devlink_priority(struct udev_device *udev_device);
104 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
105 int udev_device_get_watch_handle(struct udev_device *udev_device);
106 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
107 int udev_device_get_ifindex(struct udev_device *udev_device);
108 int udev_device_set_ifindex(struct udev_device *udev_device, int ifindex);
109 void udev_device_set_info_loaded(struct udev_device *device);
110 bool udev_device_get_db_persist(struct udev_device *udev_device);
111 void udev_device_set_db_persist(struct udev_device *udev_device);
113 /* libudev-device-private.c */
114 int udev_device_update_db(struct udev_device *udev_device);
115 int udev_device_delete_db(struct udev_device *udev_device);
116 int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);
118 /* libudev-monitor.c - netlink/unix socket communication */
119 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
120 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
121 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
122 struct udev_monitor *destination, struct udev_device *udev_device);
123 struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);
125 /* libudev-ctrl.c - daemon runtime setup */
127 struct udev_ctrl *udev_ctrl_new_from_socket(struct udev *udev, const char *socket_path);
128 struct udev_ctrl *udev_ctrl_new_from_socket_fd(struct udev *udev, const char *socket_path, int fd);
129 int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
130 struct udev_ctrl *udev_ctrl_ref(struct udev_ctrl *uctrl);
131 struct udev_ctrl *udev_ctrl_unref(struct udev_ctrl *uctrl);
132 struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
133 int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
134 int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority, int timeout);
135 int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl, int timeout);
136 int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl, int timeout);
137 int udev_ctrl_send_reload_rules(struct udev_ctrl *uctrl, int timeout);
138 int udev_ctrl_send_ping(struct udev_ctrl *uctrl, int timeout);
139 int udev_ctrl_send_exit(struct udev_ctrl *uctrl, int timeout);
140 int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key, int timeout);
141 int udev_ctrl_send_set_children_max(struct udev_ctrl *uctrl, int count, int timeout);
142 struct udev_ctrl_connection;
143 struct udev_ctrl_connection *udev_ctrl_get_connection(struct udev_ctrl *uctrl);
144 struct udev_ctrl_connection *udev_ctrl_connection_ref(struct udev_ctrl_connection *conn);
145 struct udev_ctrl_connection *udev_ctrl_connection_unref(struct udev_ctrl_connection *conn);
146 struct udev_ctrl_msg;
147 struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn);
148 struct udev_ctrl_msg *udev_ctrl_msg_ref(struct udev_ctrl_msg *ctrl_msg);
149 struct udev_ctrl_msg *udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
150 int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
151 int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
152 int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
153 int udev_ctrl_get_reload_rules(struct udev_ctrl_msg *ctrl_msg);
154 int udev_ctrl_get_ping(struct udev_ctrl_msg *ctrl_msg);
155 int udev_ctrl_get_exit(struct udev_ctrl_msg *ctrl_msg);
156 const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
157 int udev_ctrl_get_set_children_max(struct udev_ctrl_msg *ctrl_msg);
160 enum udev_list_flags {
162 UDEV_LIST_UNIQUE = 1,
163 UDEV_LIST_SORT = 1 << 1,
165 struct udev_list_node {
166 struct udev_list_node *next, *prev;
168 #define UDEV_LIST(list) struct udev_list_node list = { &(list), &(list) }
169 void udev_list_init(struct udev_list_node *list);
170 int udev_list_is_empty(struct udev_list_node *list);
171 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
172 void udev_list_node_remove(struct udev_list_node *entry);
173 #define udev_list_node_foreach(node, list) \
174 for (node = (list)->next; \
177 #define udev_list_node_foreach_safe(node, tmp, list) \
178 for (node = (list)->next, tmp = (node)->next; \
180 node = tmp, tmp = (tmp)->next)
181 struct udev_list_entry *udev_list_entry_add(struct udev *udev, struct udev_list_node *list,
182 const char *name, const char *value, unsigned int flags);
183 void udev_list_entry_delete(struct udev_list_entry *entry);
184 void udev_list_entry_remove(struct udev_list_entry *entry);
185 void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry);
186 void udev_list_entry_append(struct udev_list_entry *new, struct udev_list_node *list);
187 void udev_list_cleanup_entries(struct udev *udev, struct udev_list_node *name_list);
188 struct udev_list_entry *udev_list_get_entry(struct udev_list_node *list);
189 int udev_list_entry_get_num(struct udev_list_entry *list_entry);
190 void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
191 #define udev_list_entry_foreach_safe(entry, tmp, first) \
192 for (entry = first, tmp = udev_list_entry_get_next(entry); \
194 entry = tmp, tmp = udev_list_entry_get_next(tmp))
196 /* libudev-queue.c */
197 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
198 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
199 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
200 ssize_t udev_queue_skip_devpath(FILE *queue_file);
202 /* libudev-queue-private.c */
203 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
204 struct udev_queue_export *udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
205 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
206 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
207 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
208 int udev_queue_export_device_failed(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
211 #define UTIL_PATH_SIZE 1024
212 #define UTIL_NAME_SIZE 512
213 #define UTIL_LINE_SIZE 16384
214 #define UDEV_ALLOWED_CHARS_INPUT "/ $%?,"
215 ssize_t util_get_sys_subsystem(struct udev *udev, const char *syspath, char *subsystem, size_t size);
216 ssize_t util_get_sys_driver(struct udev *udev, const char *syspath, char *driver, size_t size);
217 int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
218 int util_log_priority(const char *priority);
219 size_t util_path_encode(const char *src, char *dest, size_t size);
220 size_t util_path_decode(char *s);
221 void util_remove_trailing_chars(char *path, char c);
222 size_t util_strpcpy(char **dest, size_t size, const char *src);
223 size_t util_strpcpyl(char **dest, size_t size, const char *src, ...) __attribute__((sentinel));
224 size_t util_strscpy(char *dest, size_t size, const char *src);
225 size_t util_strscpyl(char *dest, size_t size, const char *src, ...) __attribute__((sentinel));
226 int udev_util_replace_whitespace(const char *str, char *to, size_t len);
227 int udev_util_replace_chars(char *str, const char *white);
228 int udev_util_encode_string(const char *str, char *str_enc, size_t len);
229 unsigned int util_string_hash32(const char *key);
230 uint64_t util_string_bloom64(const char *str);
232 /* libudev-util-private.c */
233 int util_create_path(struct udev *udev, const char *path);
234 int util_create_path_selinux(struct udev *udev, const char *path);
235 int util_delete_path(struct udev *udev, const char *path);
236 int util_unlink_secure(struct udev *udev, const char *filename);
237 uid_t util_lookup_user(struct udev *udev, const char *user);
238 gid_t util_lookup_group(struct udev *udev, const char *group);
239 int util_resolve_subsys_kernel(struct udev *udev, const char *string,
240 char *result, size_t maxsize, int read_value);
241 unsigned long long now_usec(void);
243 /* libudev-selinux-private.c */
245 static inline void udev_selinux_init(struct udev *udev) {}
246 static inline void udev_selinux_exit(struct udev *udev) {}
247 static inline void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode) {}
248 static inline void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode) {}
249 static inline void udev_selinux_setfscreateconat(struct udev *udev, int dfd, const char *file, unsigned int mode) {}
250 static inline void udev_selinux_resetfscreatecon(struct udev *udev) {}
252 void udev_selinux_init(struct udev *udev);
253 void udev_selinux_exit(struct udev *udev);
254 void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode);
255 void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode);
256 void udev_selinux_setfscreateconat(struct udev *udev, int dfd, const char *file, unsigned int mode);
257 void udev_selinux_resetfscreatecon(struct udev *udev);