]>
Commit | Line | Data |
---|---|---|
de1c301e LP |
1 | /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ |
2 | ||
3 | #pragma once | |
4 | ||
5 | /*** | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2013 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
11 | under the terms of the GNU Lesser General Public License as published by | |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
13 | (at your option) any later version. | |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
19 | ||
20 | You should have received a copy of the GNU Lesser General Public License | |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
22 | ***/ | |
23 | ||
24 | #include <sys/socket.h> | |
25 | #include <sys/un.h> | |
26 | #include <netinet/in.h> | |
45fbe937 | 27 | #include <pthread.h> |
de1c301e LP |
28 | |
29 | #include "hashmap.h" | |
e3017af9 | 30 | #include "prioq.h" |
de1c301e LP |
31 | #include "list.h" |
32 | #include "util.h" | |
e4ee6e5c | 33 | #include "refcnt.h" |
de1c301e LP |
34 | |
35 | #include "sd-bus.h" | |
36 | #include "bus-error.h" | |
392d5b37 | 37 | #include "bus-match.h" |
bc7fd8cd | 38 | #include "bus-kernel.h" |
8a0e0ed9 | 39 | #include "kdbus.h" |
de1c301e LP |
40 | |
41 | struct reply_callback { | |
52f3ba91 | 42 | sd_bus_message_handler_t callback; |
de1c301e | 43 | usec_t timeout; |
693eb9a2 | 44 | uint64_t cookie; |
e3017af9 | 45 | unsigned prioq_idx; |
de1c301e LP |
46 | }; |
47 | ||
48 | struct filter_callback { | |
52f3ba91 | 49 | sd_bus_message_handler_t callback; |
de1c301e | 50 | |
7286037f LP |
51 | unsigned last_iteration; |
52 | ||
de1c301e LP |
53 | LIST_FIELDS(struct filter_callback, callbacks); |
54 | }; | |
55 | ||
19befb2d LP |
56 | struct match_callback { |
57 | sd_bus_message_handler_t callback; | |
58 | ||
59 | uint64_t cookie; | |
60 | unsigned last_iteration; | |
61 | ||
62 | char *match_string; | |
63 | ||
64 | struct bus_match_node *match_node; | |
65 | }; | |
66 | ||
29ddb38f LP |
67 | struct node { |
68 | char *path; | |
69 | struct node *parent; | |
70 | LIST_HEAD(struct node, child); | |
71 | LIST_FIELDS(struct node, siblings); | |
72 | ||
73 | LIST_HEAD(struct node_callback, callbacks); | |
74 | LIST_HEAD(struct node_vtable, vtables); | |
75 | LIST_HEAD(struct node_enumerator, enumerators); | |
19befb2d | 76 | LIST_HEAD(struct node_object_manager, object_managers); |
29ddb38f LP |
77 | }; |
78 | ||
79 | struct node_callback { | |
80 | struct node *node; | |
81 | ||
82 | bool is_fallback; | |
52f3ba91 | 83 | sd_bus_message_handler_t callback; |
a652755d | 84 | |
29ddb38f LP |
85 | unsigned last_iteration; |
86 | ||
87 | LIST_FIELDS(struct node_callback, callbacks); | |
88 | }; | |
89 | ||
90 | struct node_enumerator { | |
91 | struct node *node; | |
92 | ||
93 | sd_bus_node_enumerator_t callback; | |
29ddb38f LP |
94 | |
95 | unsigned last_iteration; | |
96 | ||
97 | LIST_FIELDS(struct node_enumerator, enumerators); | |
98 | }; | |
99 | ||
19befb2d LP |
100 | struct node_object_manager { |
101 | struct node *node; | |
102 | ||
103 | LIST_FIELDS(struct node_object_manager, object_managers); | |
104 | }; | |
105 | ||
29ddb38f LP |
106 | struct node_vtable { |
107 | struct node *node; | |
108 | ||
109 | char *interface; | |
a652755d | 110 | bool is_fallback; |
29ddb38f | 111 | const sd_bus_vtable *vtable; |
29ddb38f | 112 | sd_bus_object_find_t find; |
7286037f LP |
113 | |
114 | unsigned last_iteration; | |
29ddb38f LP |
115 | |
116 | LIST_FIELDS(struct node_vtable, vtables); | |
117 | }; | |
118 | ||
119 | struct vtable_member { | |
120 | const char *path; | |
121 | const char *interface; | |
122 | const char *member; | |
123 | struct node_vtable *parent; | |
124 | unsigned last_iteration; | |
125 | const sd_bus_vtable *vtable; | |
a652755d LP |
126 | }; |
127 | ||
19befb2d | 128 | typedef enum BusSlotType { |
19befb2d LP |
129 | BUS_REPLY_CALLBACK, |
130 | BUS_FILTER_CALLBACK, | |
131 | BUS_MATCH_CALLBACK, | |
132 | BUS_NODE_CALLBACK, | |
133 | BUS_NODE_ENUMERATOR, | |
134 | BUS_NODE_VTABLE, | |
135 | BUS_NODE_OBJECT_MANAGER, | |
a71fe8b8 | 136 | _BUS_SLOT_INVALID = -1, |
19befb2d LP |
137 | } BusSlotType; |
138 | ||
139 | struct sd_bus_slot { | |
140 | unsigned n_ref; | |
141 | sd_bus *bus; | |
142 | void *userdata; | |
a71fe8b8 LP |
143 | BusSlotType type:5; |
144 | bool floating:1; | |
19befb2d LP |
145 | |
146 | LIST_FIELDS(sd_bus_slot, slots); | |
147 | ||
148 | union { | |
149 | struct reply_callback reply_callback; | |
150 | struct filter_callback filter_callback; | |
151 | struct match_callback match_callback; | |
152 | struct node_callback node_callback; | |
153 | struct node_enumerator node_enumerator; | |
154 | struct node_object_manager node_object_manager; | |
155 | struct node_vtable node_vtable; | |
156 | }; | |
157 | }; | |
158 | ||
de1c301e | 159 | enum bus_state { |
021a1e78 | 160 | BUS_UNSET, |
de1c301e LP |
161 | BUS_OPENING, |
162 | BUS_AUTHENTICATING, | |
163 | BUS_HELLO, | |
f54514f3 | 164 | BUS_RUNNING, |
718db961 | 165 | BUS_CLOSING, |
f54514f3 | 166 | BUS_CLOSED |
de1c301e LP |
167 | }; |
168 | ||
f54514f3 | 169 | static inline bool BUS_IS_OPEN(enum bus_state state) { |
718db961 | 170 | return state > BUS_UNSET && state < BUS_CLOSING; |
f54514f3 LP |
171 | } |
172 | ||
2181a7f5 LP |
173 | enum bus_auth { |
174 | _BUS_AUTH_INVALID, | |
175 | BUS_AUTH_EXTERNAL, | |
176 | BUS_AUTH_ANONYMOUS | |
177 | }; | |
178 | ||
de1c301e | 179 | struct sd_bus { |
e4ee6e5c LP |
180 | /* We use atomic ref counting here since sd_bus_message |
181 | objects retain references to their originating sd_bus but | |
182 | we want to allow them to be processed in a different | |
183 | thread. We won't provide full thread safety, but only the | |
184 | bare minimum that makes it possible to use sd_bus and | |
185 | sd_bus_message objects independently and on different | |
186 | threads as long as each object is used only once at the | |
187 | same time. */ | |
188 | RefCount n_ref; | |
189 | ||
de1c301e | 190 | enum bus_state state; |
e82c9509 | 191 | int input_fd, output_fd; |
de1c301e | 192 | int message_version; |
0f437184 | 193 | int message_endian; |
021a1e78 | 194 | |
6629161f | 195 | bool is_kernel:1; |
de1c301e | 196 | bool can_fds:1; |
94bbf1ba | 197 | bool bus_client:1; |
2571ead1 | 198 | bool ucred_valid:1; |
2181a7f5 LP |
199 | bool is_server:1; |
200 | bool anonymous_auth:1; | |
15d5af81 LP |
201 | bool prefer_readv:1; |
202 | bool prefer_writev:1; | |
7286037f LP |
203 | bool match_callbacks_modified:1; |
204 | bool filter_callbacks_modified:1; | |
29ddb38f | 205 | bool nodes_modified:1; |
adacb957 | 206 | bool trusted:1; |
8a0e0ed9 | 207 | bool fake_creds_valid:1; |
758bf0c7 | 208 | bool manual_peer_interface:1; |
5972fe95 LP |
209 | bool is_system:1; |
210 | bool is_user:1; | |
de1c301e | 211 | |
8f155917 LP |
212 | int use_memfd; |
213 | ||
de1c301e LP |
214 | void *rbuffer; |
215 | size_t rbuffer_size; | |
216 | ||
217 | sd_bus_message **rqueue; | |
821e0756 LP |
218 | unsigned rqueue_size; |
219 | size_t rqueue_allocated; | |
de1c301e LP |
220 | |
221 | sd_bus_message **wqueue; | |
222 | unsigned wqueue_size; | |
223 | size_t windex; | |
821e0756 | 224 | size_t wqueue_allocated; |
de1c301e | 225 | |
693eb9a2 | 226 | uint64_t cookie; |
de1c301e LP |
227 | |
228 | char *unique_name; | |
219728b3 | 229 | uint64_t unique_id; |
de1c301e | 230 | |
392d5b37 | 231 | struct bus_match_node match_callbacks; |
e3017af9 | 232 | Prioq *reply_callbacks_prioq; |
c9fe4af7 | 233 | OrderedHashmap *reply_callbacks; |
de1c301e | 234 | LIST_HEAD(struct filter_callback, filter_callbacks); |
29ddb38f LP |
235 | |
236 | Hashmap *nodes; | |
29ddb38f LP |
237 | Hashmap *vtable_methods; |
238 | Hashmap *vtable_properties; | |
de1c301e | 239 | |
3cb46740 | 240 | union sockaddr_union sockaddr; |
de1c301e LP |
241 | socklen_t sockaddr_size; |
242 | ||
6629161f | 243 | char *kernel; |
a7893c6b | 244 | char *machine; |
6629161f | 245 | |
98178d39 | 246 | sd_id128_t server_id; |
de1c301e LP |
247 | |
248 | char *address; | |
249 | unsigned address_index; | |
250 | ||
251 | int last_connect_error; | |
252 | ||
2181a7f5 LP |
253 | enum bus_auth auth; |
254 | size_t auth_rbegin; | |
de1c301e LP |
255 | struct iovec auth_iovec[3]; |
256 | unsigned auth_index; | |
2181a7f5 | 257 | char *auth_buffer; |
e3017af9 | 258 | usec_t auth_timeout; |
2571ead1 LP |
259 | |
260 | struct ucred ucred; | |
261 | char label[NAME_MAX]; | |
2c93b4ef | 262 | |
5b12334d LP |
263 | uint64_t creds_mask; |
264 | ||
2c93b4ef LP |
265 | int *fds; |
266 | unsigned n_fds; | |
2fd9ae2e LP |
267 | |
268 | char *exec_path; | |
269 | char **exec_argv; | |
9d373862 | 270 | |
7286037f | 271 | unsigned iteration_counter; |
fd8d62d9 LP |
272 | |
273 | void *kdbus_buffer; | |
bc7fd8cd | 274 | |
45fbe937 LP |
275 | /* We do locking around the memfd cache, since we want to |
276 | * allow people to process a sd_bus_message in a different | |
277 | * thread then it was generated on and free it there. Since | |
278 | * adding something to the memfd cache might happen when a | |
279 | * message is released, we hence need to protect this bit with | |
280 | * a mutex. */ | |
281 | pthread_mutex_t memfd_cache_mutex; | |
bc7fd8cd LP |
282 | struct memfd_cache memfd_cache[MEMFD_CACHE_MAX]; |
283 | unsigned n_memfd_cache; | |
d5a2b9a6 LP |
284 | |
285 | pid_t original_pid; | |
264ad849 LP |
286 | |
287 | uint64_t hello_flags; | |
d21a7bb1 | 288 | uint64_t attach_flags; |
c7819669 LP |
289 | |
290 | uint64_t match_cookie; | |
89ffcd2a | 291 | |
40ca29a1 LP |
292 | sd_event_source *input_io_event_source; |
293 | sd_event_source *output_io_event_source; | |
294 | sd_event_source *time_event_source; | |
abc5fe72 | 295 | sd_event_source *quit_event_source; |
40ca29a1 | 296 | sd_event *event; |
1e05d493 | 297 | int event_priority; |
affff0b6 | 298 | |
19befb2d LP |
299 | sd_bus_message *current_message; |
300 | sd_bus_slot *current_slot; | |
caa82984 LP |
301 | sd_bus_message_handler_t current_handler; |
302 | void *current_userdata; | |
76b54375 LP |
303 | |
304 | sd_bus **default_bus_ptr; | |
305 | pid_t tid; | |
8a0e0ed9 LP |
306 | |
307 | struct kdbus_creds fake_creds; | |
308 | char *fake_label; | |
751bc6ac LP |
309 | |
310 | char *cgroup_root; | |
5972fe95 | 311 | |
455971c1 | 312 | char *description; |
b28ff39f LP |
313 | |
314 | size_t bloom_size; | |
315 | unsigned bloom_n_hash; | |
8f8f05a9 LP |
316 | |
317 | sd_bus_track *track_queue; | |
19befb2d LP |
318 | |
319 | LIST_HEAD(sd_bus_slot, slots); | |
40ca29a1 | 320 | }; |
e3017af9 LP |
321 | |
322 | #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC)) | |
25220239 | 323 | |
7a4a2105 LP |
324 | #define BUS_WQUEUE_MAX 1024 |
325 | #define BUS_RQUEUE_MAX 64*1024 | |
25220239 LP |
326 | |
327 | #define BUS_MESSAGE_SIZE_MAX (64*1024*1024) | |
328 | #define BUS_AUTH_SIZE_MAX (64*1024) | |
ac89bf1d | 329 | |
ed205a6b LP |
330 | #define BUS_CONTAINER_DEPTH 128 |
331 | ||
ac89bf1d LP |
332 | /* Defined by the specification as maximum size of an array in |
333 | * bytes */ | |
334 | #define BUS_ARRAY_MAX_SIZE 67108864 | |
335 | ||
2c93b4ef LP |
336 | #define BUS_FDS_MAX 1024 |
337 | ||
2fd9ae2e LP |
338 | #define BUS_EXEC_ARGV_MAX 256 |
339 | ||
0ce036ce LP |
340 | bool interface_name_is_valid(const char *p) _pure_; |
341 | bool service_name_is_valid(const char *p) _pure_; | |
342 | bool member_name_is_valid(const char *p) _pure_; | |
343 | bool object_path_is_valid(const char *p) _pure_; | |
344 | char *object_path_startswith(const char *a, const char *b) _pure_; | |
6693860f | 345 | |
0ce036ce LP |
346 | bool namespace_complex_pattern(const char *pattern, const char *value) _pure_; |
347 | bool path_complex_pattern(const char *pattern, const char *value) _pure_; | |
392d5b37 | 348 | |
0ce036ce LP |
349 | bool namespace_simple_pattern(const char *pattern, const char *value) _pure_; |
350 | bool path_simple_pattern(const char *pattern, const char *value) _pure_; | |
392d5b37 | 351 | |
0ce036ce LP |
352 | int bus_message_type_from_string(const char *s, uint8_t *u) _pure_; |
353 | const char *bus_message_type_to_string(uint8_t u) _pure_; | |
392d5b37 | 354 | |
6693860f | 355 | #define error_name_is_valid interface_name_is_valid |
20902f3e LP |
356 | |
357 | int bus_ensure_running(sd_bus *bus); | |
a7e3212d LP |
358 | int bus_start_running(sd_bus *bus); |
359 | int bus_next_address(sd_bus *bus); | |
d5a2b9a6 | 360 | |
7adc46fc | 361 | int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m); |
777d7a61 | 362 | |
7adc46fc | 363 | int bus_rqueue_make_room(sd_bus *bus); |
7d22c717 | 364 | |
d5a2b9a6 | 365 | bool bus_pid_changed(sd_bus *bus); |
92e189e5 | 366 | |
0f8bd8de LP |
367 | char *bus_address_escape(const char *v); |
368 | ||
92e189e5 LP |
369 | #define OBJECT_PATH_FOREACH_PREFIX(prefix, path) \ |
370 | for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \ | |
371 | _slash && !(_slash[(_slash) == (prefix)] = 0); \ | |
372 | _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/')) | |
8ce2afd6 LP |
373 | |
374 | /* If we are invoking callbacks of a bus object, ensure unreffing the | |
375 | * bus from the callback doesn't destroy the object we are working | |
376 | * on */ | |
377 | #define BUS_DONT_DESTROY(bus) \ | |
d7726e57 | 378 | _cleanup_bus_unref_ _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus) |
09365592 LP |
379 | |
380 | int bus_set_address_system(sd_bus *bus); | |
381 | int bus_set_address_user(sd_bus *bus); | |
382 | int bus_set_address_system_remote(sd_bus *b, const char *host); | |
383 | int bus_set_address_system_container(sd_bus *b, const char *machine); | |
19befb2d LP |
384 | |
385 | int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata); | |
fe3f22d1 DK |
386 | |
387 | int bus_get_root_path(sd_bus *bus); |