chiark / gitweb /
Use strlen even for constant strings
[elogind.git] / src / udev / udev.h
1 /*
2  * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
3  * Copyright (C) 2003-2010 Kay Sievers <kay@vrfy.org>
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #pragma once
20
21 #include <sys/types.h>
22 #include <sys/param.h>
23 #include <signal.h>
24
25 #include "macro.h"
26 #include "libudev.h"
27 #include "libudev-private.h"
28 #include "util.h"
29 #include "label.h"
30 #include "strv.h"
31
32 struct udev_event {
33         struct udev *udev;
34         struct udev_device *dev;
35         struct udev_device *dev_parent;
36         struct udev_device *dev_db;
37         char *name;
38         char *program_result;
39         mode_t mode;
40         uid_t uid;
41         gid_t gid;
42         struct udev_list seclabel_list;
43         struct udev_list run_list;
44         int exec_delay;
45         usec_t birth_usec;
46         usec_t timeout_usec;
47         int fd_signal;
48         unsigned int builtin_run;
49         unsigned int builtin_ret;
50         bool sigterm;
51         bool inotify_watch;
52         bool inotify_watch_final;
53         bool group_set;
54         bool group_final;
55         bool owner_set;
56         bool owner_final;
57         bool mode_set;
58         bool mode_final;
59         bool name_final;
60         bool devlink_final;
61         bool run_final;
62 };
63
64 struct udev_watch {
65         struct udev_list_node node;
66         int handle;
67         char *name;
68 };
69
70 /* udev-rules.c */
71 struct udev_rules;
72 struct udev_rules *udev_rules_new(struct udev *udev, int resolve_names);
73 struct udev_rules *udev_rules_unref(struct udev_rules *rules);
74 bool udev_rules_check_timestamp(struct udev_rules *rules);
75 int udev_rules_apply_to_event(struct udev_rules *rules, struct udev_event *event, const sigset_t *sigmask);
76 int udev_rules_apply_static_dev_perms(struct udev_rules *rules);
77
78 /* udev-event.c */
79 struct udev_event *udev_event_new(struct udev_device *dev);
80 void udev_event_unref(struct udev_event *event);
81 size_t udev_event_apply_format(struct udev_event *event, const char *src, char *dest, size_t size);
82 int udev_event_apply_subsys_kernel(struct udev_event *event, const char *string,
83                                    char *result, size_t maxsize, int read_value);
84 int udev_event_spawn(struct udev_event *event,
85                      const char *cmd, char **envp, const sigset_t *sigmask,
86                      char *result, size_t ressize);
87 int udev_event_execute_rules(struct udev_event *event, struct udev_rules *rules, const sigset_t *sigset);
88 void udev_event_execute_run(struct udev_event *event, const sigset_t *sigset);
89 int udev_build_argv(struct udev *udev, char *cmd, int *argc, char *argv[]);
90
91 /* udev-watch.c */
92 int udev_watch_init(struct udev *udev);
93 void udev_watch_restore(struct udev *udev);
94 void udev_watch_begin(struct udev *udev, struct udev_device *dev);
95 void udev_watch_end(struct udev *udev, struct udev_device *dev);
96 struct udev_device *udev_watch_lookup(struct udev *udev, int wd);
97
98 /* udev-node.c */
99 void udev_node_add(struct udev_device *dev, bool apply,
100                    mode_t mode, uid_t uid, gid_t gid,
101                    struct udev_list *seclabel_list);
102 void udev_node_remove(struct udev_device *dev);
103 void udev_node_update_old_links(struct udev_device *dev, struct udev_device *dev_old);
104
105 /* udev-ctrl.c */
106 struct udev_ctrl;
107 struct udev_ctrl *udev_ctrl_new(struct udev *udev);
108 struct udev_ctrl *udev_ctrl_new_from_fd(struct udev *udev, int fd);
109 int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl);
110 struct udev_ctrl *udev_ctrl_unref(struct udev_ctrl *uctrl);
111 int udev_ctrl_cleanup(struct udev_ctrl *uctrl);
112 struct udev *udev_ctrl_get_udev(struct udev_ctrl *uctrl);
113 int udev_ctrl_get_fd(struct udev_ctrl *uctrl);
114 int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority, int timeout);
115 int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl, int timeout);
116 int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl, int timeout);
117 int udev_ctrl_send_reload(struct udev_ctrl *uctrl, int timeout);
118 int udev_ctrl_send_ping(struct udev_ctrl *uctrl, int timeout);
119 int udev_ctrl_send_exit(struct udev_ctrl *uctrl, int timeout);
120 int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key, int timeout);
121 int udev_ctrl_send_set_children_max(struct udev_ctrl *uctrl, int count, int timeout);
122 struct udev_ctrl_connection;
123 struct udev_ctrl_connection *udev_ctrl_get_connection(struct udev_ctrl *uctrl);
124 struct udev_ctrl_connection *udev_ctrl_connection_ref(struct udev_ctrl_connection *conn);
125 struct udev_ctrl_connection *udev_ctrl_connection_unref(struct udev_ctrl_connection *conn);
126 struct udev_ctrl_msg;
127 struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn);
128 struct udev_ctrl_msg *udev_ctrl_msg_unref(struct udev_ctrl_msg *ctrl_msg);
129 int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg);
130 int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg);
131 int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg);
132 int udev_ctrl_get_reload(struct udev_ctrl_msg *ctrl_msg);
133 int udev_ctrl_get_ping(struct udev_ctrl_msg *ctrl_msg);
134 int udev_ctrl_get_exit(struct udev_ctrl_msg *ctrl_msg);
135 const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg);
136 int udev_ctrl_get_set_children_max(struct udev_ctrl_msg *ctrl_msg);
137
138 /* built-in commands */
139 enum udev_builtin_cmd {
140 #ifdef HAVE_BLKID
141         UDEV_BUILTIN_BLKID,
142 #endif
143         UDEV_BUILTIN_BTRFS,
144 #ifdef HAVE_FIRMWARE
145         UDEV_BUILTIN_FIRMWARE,
146 #endif
147         UDEV_BUILTIN_HWDB,
148         UDEV_BUILTIN_INPUT_ID,
149         UDEV_BUILTIN_KEYBOARD,
150 #ifdef HAVE_KMOD
151         UDEV_BUILTIN_KMOD,
152 #endif
153         UDEV_BUILTIN_NET_ID,
154         UDEV_BUILTIN_NET_LINK,
155         UDEV_BUILTIN_PATH_ID,
156         UDEV_BUILTIN_USB_ID,
157 #ifdef HAVE_ACL
158         UDEV_BUILTIN_UACCESS,
159 #endif
160         UDEV_BUILTIN_MAX
161 };
162 struct udev_builtin {
163         const char *name;
164         int (*cmd)(struct udev_device *dev, int argc, char *argv[], bool test);
165         const char *help;
166         int (*init)(struct udev *udev);
167         void (*exit)(struct udev *udev);
168         bool (*validate)(struct udev *udev);
169         bool run_once;
170 };
171 #ifdef HAVE_BLKID
172 extern const struct udev_builtin udev_builtin_blkid;
173 #endif
174 extern const struct udev_builtin udev_builtin_btrfs;
175 #ifdef HAVE_FIRMWARE
176 extern const struct udev_builtin udev_builtin_firmware;
177 #endif
178 extern const struct udev_builtin udev_builtin_hwdb;
179 extern const struct udev_builtin udev_builtin_input_id;
180 extern const struct udev_builtin udev_builtin_keyboard;
181 #ifdef HAVE_KMOD
182 extern const struct udev_builtin udev_builtin_kmod;
183 #endif
184 extern const struct udev_builtin udev_builtin_net_id;
185 extern const struct udev_builtin udev_builtin_net_setup_link;
186 extern const struct udev_builtin udev_builtin_path_id;
187 extern const struct udev_builtin udev_builtin_usb_id;
188 extern const struct udev_builtin udev_builtin_uaccess;
189 void udev_builtin_init(struct udev *udev);
190 void udev_builtin_exit(struct udev *udev);
191 enum udev_builtin_cmd udev_builtin_lookup(const char *command);
192 const char *udev_builtin_name(enum udev_builtin_cmd cmd);
193 bool udev_builtin_run_once(enum udev_builtin_cmd cmd);
194 int udev_builtin_run(struct udev_device *dev, enum udev_builtin_cmd cmd, const char *command, bool test);
195 void udev_builtin_list(struct udev *udev);
196 bool udev_builtin_validate(struct udev *udev);
197 int udev_builtin_add_property(struct udev_device *dev, bool test, const char *key, const char *val);
198 int udev_builtin_hwdb_lookup(struct udev_device *dev, const char *prefix, const char *modalias,
199                              const char *filter, bool test);
200
201 /* udev logging */
202 void udev_main_log(struct udev *udev, int priority,
203                    const char *file, int line, const char *fn,
204                    const char *format, va_list args) _printf_(6, 0);
205
206 /* udevadm commands */
207 struct udevadm_cmd {
208         const char *name;
209         int (*cmd)(struct udev *udev, int argc, char *argv[]);
210         const char *help;
211         int debug;
212 };
213 extern const struct udevadm_cmd udevadm_info;
214 extern const struct udevadm_cmd udevadm_trigger;
215 extern const struct udevadm_cmd udevadm_settle;
216 extern const struct udevadm_cmd udevadm_control;
217 extern const struct udevadm_cmd udevadm_monitor;
218 extern const struct udevadm_cmd udevadm_hwdb;
219 extern const struct udevadm_cmd udevadm_test;
220 extern const struct udevadm_cmd udevadm_test_builtin;