chiark / gitweb /
libudev: introduce udev_device_properties_copy()
[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_from_nulstr(struct udev *udev, char *nulstr, ssize_t buflen);
41 struct udev_device *udev_device_shallow_clone(struct udev_device *old_device);
42 int udev_device_copy_properties(struct udev_device *dst, struct udev_device *src);
43 mode_t udev_device_get_devnode_mode(struct udev_device *udev_device);
44 uid_t udev_device_get_devnode_uid(struct udev_device *udev_device);
45 gid_t udev_device_get_devnode_gid(struct udev_device *udev_device);
46 int udev_device_rename(struct udev_device *udev_device, const char *new_name);
47 int udev_device_add_devlink(struct udev_device *udev_device, const char *devlink);
48 void udev_device_cleanup_devlinks_list(struct udev_device *udev_device);
49 int udev_device_add_property(struct udev_device *udev_device, const char *key, const char *value);
50 char **udev_device_get_properties_envp(struct udev_device *udev_device);
51 ssize_t udev_device_get_properties_monitor_buf(struct udev_device *udev_device, const char **buf);
52 int udev_device_read_db(struct udev_device *udev_device);
53 int udev_device_read_uevent_file(struct udev_device *udev_device);
54 int udev_device_set_action(struct udev_device *udev_device, const char *action);
55 const char *udev_device_get_devpath_old(struct udev_device *udev_device);
56 const char *udev_device_get_id_filename(struct udev_device *udev_device);
57 void udev_device_set_is_initialized(struct udev_device *udev_device);
58 int udev_device_add_tag(struct udev_device *udev_device, const char *tag);
59 void udev_device_remove_tag(struct udev_device *udev_device, const char *tag);
60 void udev_device_cleanup_tags_list(struct udev_device *udev_device);
61 usec_t udev_device_get_usec_initialized(struct udev_device *udev_device);
62 void udev_device_set_usec_initialized(struct udev_device *udev_device, usec_t usec_initialized);
63 int udev_device_get_devlink_priority(struct udev_device *udev_device);
64 int udev_device_set_devlink_priority(struct udev_device *udev_device, int prio);
65 int udev_device_get_watch_handle(struct udev_device *udev_device);
66 int udev_device_set_watch_handle(struct udev_device *udev_device, int handle);
67 int udev_device_get_ifindex(struct udev_device *udev_device);
68 void udev_device_set_info_loaded(struct udev_device *device);
69 bool udev_device_get_db_persist(struct udev_device *udev_device);
70 void udev_device_set_db_persist(struct udev_device *udev_device);
71
72 /* libudev-device-private.c */
73 int udev_device_update_db(struct udev_device *udev_device);
74 int udev_device_delete_db(struct udev_device *udev_device);
75 int udev_device_tag_index(struct udev_device *dev, struct udev_device *dev_old, bool add);
76
77 /* libudev-monitor.c - netlink/unix socket communication  */
78 int udev_monitor_disconnect(struct udev_monitor *udev_monitor);
79 int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender);
80 int udev_monitor_send_device(struct udev_monitor *udev_monitor,
81                              struct udev_monitor *destination, struct udev_device *udev_device);
82 struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd);
83
84 /* libudev-list.c */
85 struct udev_list_node {
86         struct udev_list_node *next, *prev;
87 };
88 struct udev_list {
89         struct udev *udev;
90         struct udev_list_node node;
91         struct udev_list_entry **entries;
92         unsigned int entries_cur;
93         unsigned int entries_max;
94         bool unique;
95 };
96 #define UDEV_LIST(list) struct udev_list_node list = { &(list), &(list) }
97 void udev_list_node_init(struct udev_list_node *list);
98 int udev_list_node_is_empty(struct udev_list_node *list);
99 void udev_list_node_append(struct udev_list_node *new, struct udev_list_node *list);
100 void udev_list_node_remove(struct udev_list_node *entry);
101 #define udev_list_node_foreach(node, list) \
102         for (node = (list)->next; \
103              node != list; \
104              node = (node)->next)
105 #define udev_list_node_foreach_safe(node, tmp, list) \
106         for (node = (list)->next, tmp = (node)->next; \
107              node != list; \
108              node = tmp, tmp = (tmp)->next)
109 void udev_list_init(struct udev *udev, struct udev_list *list, bool unique);
110 void udev_list_cleanup(struct udev_list *list);
111 struct udev_list_entry *udev_list_get_entry(struct udev_list *list);
112 struct udev_list_entry *udev_list_entry_add(struct udev_list *list, const char *name, const char *value);
113 void udev_list_entry_delete(struct udev_list_entry *entry);
114 int udev_list_entry_get_num(struct udev_list_entry *list_entry);
115 void udev_list_entry_set_num(struct udev_list_entry *list_entry, int num);
116 #define udev_list_entry_foreach_safe(entry, tmp, first) \
117         for (entry = first, tmp = udev_list_entry_get_next(entry); \
118              entry != NULL; \
119              entry = tmp, tmp = udev_list_entry_get_next(tmp))
120
121 /* libudev-queue.c */
122 unsigned long long int udev_get_kernel_seqnum(struct udev *udev);
123 int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum);
124 ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size);
125 ssize_t udev_queue_skip_devpath(FILE *queue_file);
126
127 /* libudev-queue-private.c */
128 struct udev_queue_export *udev_queue_export_new(struct udev *udev);
129 struct udev_queue_export *udev_queue_export_unref(struct udev_queue_export *udev_queue_export);
130 void udev_queue_export_cleanup(struct udev_queue_export *udev_queue_export);
131 int udev_queue_export_device_queued(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
132 int udev_queue_export_device_finished(struct udev_queue_export *udev_queue_export, struct udev_device *udev_device);
133
134 /* libudev-util.c */
135 #define UTIL_PATH_SIZE                      1024
136 #define UTIL_NAME_SIZE                       512
137 #define UTIL_LINE_SIZE                     16384
138 #define UDEV_ALLOWED_CHARS_INPUT        "/ $%?,"
139 ssize_t util_get_sys_core_link_value(struct udev *udev, const char *slink, const char *syspath, char *value, size_t size);
140 int util_resolve_sys_link(struct udev *udev, char *syspath, size_t size);
141 int util_log_priority(const char *priority);
142 size_t util_path_encode(const char *src, char *dest, size_t size);
143 void util_remove_trailing_chars(char *path, char c);
144 int util_replace_whitespace(const char *str, char *to, size_t len);
145 int util_replace_chars(char *str, const char *white);
146 unsigned int util_string_hash32(const char *key);
147 uint64_t util_string_bloom64(const char *str);
148
149 /* libudev-util-private.c */
150 int util_resolve_subsys_kernel(struct udev *udev, const char *string, char *result, size_t maxsize, int read_value);
151
152 #endif