chiark / gitweb /
udev: event - introduce and use internal udev_device_shallow_clone()
[elogind.git] / src / libudev / libudev-private.h
1 /***
2   This file is part of systemd.
3
4   Copyright 2008-2012 Kay Sievers <kay@vrfy.org>
5
6   systemd is free software; you can redistribute it and/or modify it
7   under the terms of the GNU Lesser General Public License as published by
8   the Free Software Foundation; either version 2.1 of the License, or
9   (at your option) any later version.
10
11   systemd is distributed in the hope that it will be useful, but
12   WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14   Lesser General Public License for more details.
15
16   You should have received a copy of the GNU Lesser General Public License
17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #ifndef _LIBUDEV_PRIVATE_H_
21 #define _LIBUDEV_PRIVATE_H_
22
23 #include <signal.h>
24 #include <stdint.h>
25 #include <stdbool.h>
26
27 #include "libudev.h"
28 #include "macro.h"
29 #include "util.h"
30 #include "mkdir.h"
31 #include "strxcpyx.h"
32
33 #define READ_END  0
34 #define WRITE_END 1
35
36 /* libudev.c */
37 int udev_get_rules_path(struct udev *udev, char **path[], usec_t *ts_usec[]);
38
39 /* libudev-device.c */
40 struct udev_device *udev_device_new(struct udev *udev);
41 struct udev_device *udev_device_shallow_clone(struct udev_device *old_device);
42 mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
43 uid_t udev_device_get_devnode_uid(struct udev_device *udev_device);
44 gid_t udev_device_get_devnode_gid(struct udev_device *udev_device);
45 int udev_device_set_subsystem(struct udev_device *udev_device, const char *subsystem);
46 int udev_device_set_syspath(struct udev_device *udev_device, const char *syspath);
47 int udev_device_rename(struct udev_device *udev_device, const char *new_name);
48 int udev_device_set_devnum(struct udev_device *udev_device, dev_t devnum);
49 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
50 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
51 struct udev_list_entry *udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
52 void udev_device_add_property_from_string_parse(struct udev_device *udev_device, const char *property);
53 int udev_device_add_property_from_string_parse_finish(struct udev_device *udev_device);
54 char **udev_device_get_properties_envp(struct udev_device *udev_device);
55 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
56 int udev_device_read_db(struct udev_device *udev_device, const char *dbfile);
57 int udev_device_read_uevent_file(struct udev_device *udev_device);
58 int udev_device_set_action(struct udev_device *udev_device, const char *action);
59 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
60 const char *udev_device_get_id_filename(struct udev_device *udev_device);
61 void udev_device_set_is_initialized(struct udev_device *udev_device);
62 int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
63 void udev_device_remove_tag(struct udev_device *udev_device, const char *tag);
64 void udev_device_cleanup_tags_list(struct udev_device *udev_device);
65 usec_t udev_device_get_usec_initialized(struct udev_device *udev_device);
66 void udev_device_set_usec_initialized(struct udev_device *udev_device, usec_t usec_initialized);
67 int udev_device_get_devlink_priority(struct udev_device *udev_device);
68 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
69 int udev_device_get_watch_handle(struct udev_device *udev_device);
70 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
71 int udev_device_get_ifindex(struct udev_device *udev_device);
72 void udev_device_set_info_loaded(struct udev_device *device);
73 bool udev_device_get_db_persist(struct udev_device *udev_device);
74 void udev_device_set_db_persist(struct udev_device *udev_device);
75
76 /* libudev-device-private.c */
77 int udev_device_update_db(struct udev_device *udev_device);
78 int udev_device_delete_db(struct udev_device *udev_device);
79 int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);
80
81 /* libudev-monitor.c - netlink/unix socket communication  */
82 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
83 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
84 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
85                              struct udev_monitor *destination, struct udev_device *udev_device);
86 struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);
87
88 /* libudev-list.c */
89 struct udev_list_node {
90         struct udev_list_node *next, *prev;
91 };
92 struct udev_list {
93         struct udev *udev;
94         struct udev_list_node node;
95         struct udev_list_entry **entries;
96         unsigned int entries_cur;
97         unsigned int entries_max;
98         bool unique;
99 };
100 #define UDEV_LIST(list) struct udev_list_node list = { &(list), &(list) }
101 void udev_list_node_init(struct udev_list_node *list);
102 int udev_list_node_is_empty(struct udev_list_node *list);
103 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
104 void udev_list_node_remove(struct udev_list_node *entry);
105 #define udev_list_node_foreach(node, list) \
106         for (node = (list)->next; \
107              node != list; \
108              node = (node)->next)
109 #define udev_list_node_foreach_safe(node, tmp, list) \
110         for (node = (list)->next, tmp = (node)->next; \
111              node != list; \
112              node = tmp, tmp = (tmp)->next)
113 void udev_list_init(struct udev *udev, struct udev_list *list, bool unique);
114 void udev_list_cleanup(struct udev_list *list);
115 struct udev_list_entry *udev_list_get_entry(struct udev_list *list);
116 struct udev_list_entry *udev_list_entry_add(struct udev_list *list, const char *name, const char *value);
117 void udev_list_entry_delete(struct udev_list_entry *entry);
118 int udev_list_entry_get_num(struct udev_list_entry *list_entry);
119 void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
120 #define udev_list_entry_foreach_safe(entry, tmp, first) \
121         for (entry = first, tmp = udev_list_entry_get_next(entry); \
122              entry != NULL; \
123              entry = tmp, tmp = udev_list_entry_get_next(tmp))
124
125 /* libudev-queue.c */
126 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
127 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
128 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
129 ssize_t udev_queue_skip_devpath(FILE *queue_file);
130
131 /* libudev-queue-private.c */
132 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
133 struct udev_queue_export *udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
134 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
135 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
136 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
137
138 /* libudev-util.c */
139 #define UTIL_PATH_SIZE                      1024
140 #define UTIL_NAME_SIZE                       512
141 #define UTIL_LINE_SIZE                     16384
142 #define UDEV_ALLOWED_CHARS_INPUT        "/ $%?,"
143 ssize_t util_get_sys_core_link_value(struct udev *udev, const char *slink, const char *syspath, char *value, size_t size);
144 int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
145 int util_log_priority(const char *priority);
146 size_t util_path_encode(const char *src, char *dest, size_t size);
147 void util_remove_trailing_chars(char *path, char c);
148 int util_replace_whitespace(const char *str, char *to, size_t len);
149 int util_replace_chars(char *str, const char *white);
150 unsigned int util_string_hash32(const char *key);
151 uint64_t util_string_bloom64(const char *str);
152
153 /* libudev-util-private.c */
154 int util_resolve_subsys_kernel(struct udev *udev, const char *string, char *result, size_t maxsize, int read_value);
155
156 #endif