2 * libudev - interface to udev device information
4 * Copyright (C) 2008-2012 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_
27 #define TEST_PREFIX ""
30 /* avoid (sometimes expensive) calculations of parameters for debug output */
31 #define udev_log_cond(udev, prio, arg...) \
33 if (udev_get_log_priority(udev) >= prio) \
34 udev_log(udev, prio, __FILE__, __LINE__, __FUNCTION__, ## arg); \
37 #define dbg(udev, arg...) udev_log_cond(udev, LOG_DEBUG, ## arg)
38 #define info(udev, arg...) udev_log_cond(udev, LOG_INFO, ## arg)
39 #define err(udev, arg...) udev_log_cond(udev, LOG_ERR, ## arg)
42 void udev_log(struct udev *udev,
43 int priority, const char *file, int line, const char *fn,
44 const char *format, ...)
45 __attribute__((format(printf, 6, 7)));
46 int udev_get_rules_path(struct udev *udev, char **path[], unsigned long long *ts_usec[]);
47 struct udev_list_entry *udev_add_property(struct udev *udev, const char *key, const char *value);
48 struct udev_list_entry *udev_get_properties_list_entry(struct udev *udev);
50 /* libudev-device.c */
51 struct udev_device *udev_device_new(struct udev *udev);
52 struct udev_device *udev_device_new_from_id_filename(struct udev *udev, char *id);
53 mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
54 int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
55 int udev_device_set_devnode(struct udev_device *udev_device, const char *devnode);
56 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink, int unique);
57 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
58 struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
59 void udev_device_add_property_from_string_parse(struct udev_device *udev_device, const char *property);
60 int udev_device_add_property_from_string_parse_finish(struct udev_device *udev_device);
61 char **udev_device_get_properties_envp(struct udev_device *udev_device);
62 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
63 int udev_device_read_db(struct udev_device *udev_device, const char *dbfile);
64 int udev_device_read_uevent_file(struct udev_device *udev_device);
65 int udev_device_set_action(struct udev_device *udev_device, const char *action);
66 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
67 const char *udev_device_get_id_filename(struct udev_device *udev_device);
68 void udev_device_set_is_initialized(struct udev_device *udev_device);
69 int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
70 void udev_device_cleanup_tags_list(struct udev_device *udev_device);
71 unsigned long long udev_device_get_usec_initialized(struct udev_device *udev_device);
72 void udev_device_set_usec_initialized(struct udev_device *udev_device, unsigned long long usec_initialized);
73 int udev_device_get_devlink_priority(struct udev_device *udev_device);
74 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
75 int udev_device_get_watch_handle(struct udev_device *udev_device);
76 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
77 int udev_device_get_ifindex(struct udev_device *udev_device);
78 void udev_device_set_info_loaded(struct udev_device *device);
79 bool udev_device_get_db_persist(struct udev_device *udev_device);
80 void udev_device_set_db_persist(struct udev_device *udev_device);
82 /* libudev-device-private.c */
83 int udev_device_update_db(struct udev_device *udev_device);
84 int udev_device_delete_db(struct udev_device *udev_device);
85 int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);
87 /* libudev-monitor.c - netlink/unix socket communication */
88 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
89 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
90 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
91 struct udev_monitor *destination, struct udev_device *udev_device);
92 struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);
95 struct udev_list_node {
96 struct udev_list_node *next, *prev;
100 struct udev_list_node node;
101 struct udev_list_entry **entries;
102 unsigned int entries_cur;
103 unsigned int entries_max;
106 #define UDEV_LIST(list) struct udev_list_node list = { &(list), &(list) }
107 void udev_list_node_init(struct udev_list_node *list);
108 int udev_list_node_is_empty(struct udev_list_node *list);
109 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
110 void udev_list_node_remove(struct udev_list_node *entry);
111 #define udev_list_node_foreach(node, list) \
112 for (node = (list)->next; \
115 #define udev_list_node_foreach_safe(node, tmp, list) \
116 for (node = (list)->next, tmp = (node)->next; \
118 node = tmp, tmp = (tmp)->next)
119 void udev_list_init(struct udev *udev, struct udev_list *list, bool unique);
120 void udev_list_cleanup(struct udev_list *list);
121 struct udev_list_entry *udev_list_get_entry(struct udev_list *list);
122 struct udev_list_entry *udev_list_entry_add(struct udev_list *list, const char *name, const char *value);
123 void udev_list_entry_delete(struct udev_list_entry *entry);
124 void udev_list_entry_insert_before(struct udev_list_entry *new, struct udev_list_entry *entry);
125 void udev_list_entry_append(struct udev_list_entry *new, struct udev_list *list);
126 int udev_list_entry_get_num(struct udev_list_entry *list_entry);
127 void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
128 #define udev_list_entry_foreach_safe(entry, tmp, first) \
129 for (entry = first, tmp = udev_list_entry_get_next(entry); \
131 entry = tmp, tmp = udev_list_entry_get_next(tmp))
133 /* libudev-queue.c */
134 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
135 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
136 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
137 ssize_t udev_queue_skip_devpath(FILE *queue_file);
139 /* libudev-queue-private.c */
140 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
141 struct udev_queue_export *udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
142 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
143 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
144 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
147 #define UTIL_PATH_SIZE 1024
148 #define UTIL_NAME_SIZE 512
149 #define UTIL_LINE_SIZE 16384
150 #define UDEV_ALLOWED_CHARS_INPUT "/ $%?,"
151 ssize_t util_get_sys_core_link_value(struct udev *udev, const char *slink, const char *syspath, char *value, size_t size);
152 int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
153 int util_log_priority(const char *priority);
154 size_t util_path_encode(const char *src, char *dest, size_t size);
155 size_t util_path_decode(char *s);
156 void util_remove_trailing_chars(char *path, char c);
157 size_t util_strpcpy(char **dest, size_t size, const char *src);
158 size_t util_strpcpyl(char **dest, size_t size, const char *src, ...) __attribute__((sentinel));
159 size_t util_strscpy(char *dest, size_t size, const char *src);
160 size_t util_strscpyl(char *dest, size_t size, const char *src, ...) __attribute__((sentinel));
161 int util_replace_whitespace(const char *str, char *to, size_t len);
162 int util_replace_chars(char *str, const char *white);
163 unsigned int util_string_hash32(const char *key);
164 uint64_t util_string_bloom64(const char *str);
166 /* libudev-util-private.c */
167 int util_create_path(struct udev *udev, const char *path);
168 int util_create_path_selinux(struct udev *udev, const char *path);
169 int util_delete_path(struct udev *udev, const char *path);
170 uid_t util_lookup_user(struct udev *udev, const char *user);
171 gid_t util_lookup_group(struct udev *udev, const char *group);
172 int util_resolve_subsys_kernel(struct udev *udev, const char *string,
173 char *result, size_t maxsize, int read_value);
174 unsigned long long ts_usec(const struct timespec *ts);
175 unsigned long long now_usec(void);
177 /* libudev-selinux-private.c */
179 static inline void udev_selinux_init(struct udev *udev) {}
180 static inline void udev_selinux_exit(struct udev *udev) {}
181 static inline void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode) {}
182 static inline void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode) {}
183 static inline void udev_selinux_setfscreateconat(struct udev *udev, int dfd, const char *file, unsigned int mode) {}
184 static inline void udev_selinux_resetfscreatecon(struct udev *udev) {}
186 void udev_selinux_init(struct udev *udev);
187 void udev_selinux_exit(struct udev *udev);
188 void udev_selinux_lsetfilecon(struct udev *udev, const char *file, unsigned int mode);
189 void udev_selinux_setfscreatecon(struct udev *udev, const char *file, unsigned int mode);
190 void udev_selinux_setfscreateconat(struct udev *udev, int dfd, const char *file, unsigned int mode);
191 void udev_selinux_resetfscreatecon(struct udev *udev);