1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2013 Lennart Poettering
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.
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.
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/>.
24 #include <sys/socket.h>
26 #include <netinet/in.h>
36 #include "bus-error.h"
37 #include "bus-match.h"
38 #include "bus-kernel.h"
41 struct reply_callback {
42 sd_bus_message_handler_t callback;
48 struct filter_callback {
49 sd_bus_message_handler_t callback;
51 unsigned last_iteration;
53 LIST_FIELDS(struct filter_callback, callbacks);
56 struct match_callback {
57 sd_bus_message_handler_t callback;
60 unsigned last_iteration;
64 struct bus_match_node *match_node;
70 LIST_HEAD(struct node, child);
71 LIST_FIELDS(struct node, siblings);
73 LIST_HEAD(struct node_callback, callbacks);
74 LIST_HEAD(struct node_vtable, vtables);
75 LIST_HEAD(struct node_enumerator, enumerators);
76 LIST_HEAD(struct node_object_manager, object_managers);
79 struct node_callback {
83 sd_bus_message_handler_t callback;
85 unsigned last_iteration;
87 LIST_FIELDS(struct node_callback, callbacks);
90 struct node_enumerator {
93 sd_bus_node_enumerator_t callback;
95 unsigned last_iteration;
97 LIST_FIELDS(struct node_enumerator, enumerators);
100 struct node_object_manager {
103 LIST_FIELDS(struct node_object_manager, object_managers);
111 const sd_bus_vtable *vtable;
112 sd_bus_object_find_t find;
114 unsigned last_iteration;
116 LIST_FIELDS(struct node_vtable, vtables);
119 struct vtable_member {
121 const char *interface;
123 struct node_vtable *parent;
124 unsigned last_iteration;
125 const sd_bus_vtable *vtable;
128 typedef enum BusSlotType {
135 BUS_NODE_OBJECT_MANAGER,
136 _BUS_SLOT_INVALID = -1,
147 LIST_FIELDS(sd_bus_slot, slots);
150 struct reply_callback reply_callback;
151 struct filter_callback filter_callback;
152 struct match_callback match_callback;
153 struct node_callback node_callback;
154 struct node_enumerator node_enumerator;
155 struct node_object_manager node_object_manager;
156 struct node_vtable node_vtable;
170 static inline bool BUS_IS_OPEN(enum bus_state state) {
171 return state > BUS_UNSET && state < BUS_CLOSING;
181 /* We use atomic ref counting here since sd_bus_message
182 objects retain references to their originating sd_bus but
183 we want to allow them to be processed in a different
184 thread. We won't provide full thread safety, but only the
185 bare minimum that makes it possible to use sd_bus and
186 sd_bus_message objects independently and on different
187 threads as long as each object is used only once at the
191 enum bus_state state;
192 int input_fd, output_fd;
201 bool anonymous_auth:1;
203 bool prefer_writev:1;
204 bool match_callbacks_modified:1;
205 bool filter_callbacks_modified:1;
206 bool nodes_modified:1;
208 bool fake_creds_valid:1;
209 bool manual_peer_interface:1;
218 sd_bus_message **rqueue;
219 unsigned rqueue_size;
220 size_t rqueue_allocated;
222 sd_bus_message **wqueue;
223 unsigned wqueue_size;
225 size_t wqueue_allocated;
232 struct bus_match_node match_callbacks;
233 Prioq *reply_callbacks_prioq;
234 OrderedHashmap *reply_callbacks;
235 LIST_HEAD(struct filter_callback, filter_callbacks);
238 Hashmap *vtable_methods;
239 Hashmap *vtable_properties;
241 union sockaddr_union sockaddr;
242 socklen_t sockaddr_size;
247 sd_id128_t server_id;
250 unsigned address_index;
252 int last_connect_error;
256 struct iovec auth_iovec[3];
262 char label[NAME_MAX];
272 unsigned iteration_counter;
276 /* We do locking around the memfd cache, since we want to
277 * allow people to process a sd_bus_message in a different
278 * thread then it was generated on and free it there. Since
279 * adding something to the memfd cache might happen when a
280 * message is released, we hence need to protect this bit with
282 pthread_mutex_t memfd_cache_mutex;
283 struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
284 unsigned n_memfd_cache;
288 uint64_t hello_flags;
289 uint64_t attach_flags;
291 uint64_t match_cookie;
293 sd_event_source *input_io_event_source;
294 sd_event_source *output_io_event_source;
295 sd_event_source *time_event_source;
296 sd_event_source *quit_event_source;
300 sd_bus_message *current_message;
301 sd_bus_slot *current_slot;
302 sd_bus_message_handler_t current_handler;
303 void *current_userdata;
305 sd_bus **default_bus_ptr;
308 struct kdbus_creds fake_creds;
316 unsigned bloom_n_hash;
318 sd_bus_track *track_queue;
320 LIST_HEAD(sd_bus_slot, slots);
323 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
325 #define BUS_WQUEUE_MAX 1024
326 #define BUS_RQUEUE_MAX 64*1024
328 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
329 #define BUS_AUTH_SIZE_MAX (64*1024)
331 #define BUS_CONTAINER_DEPTH 128
333 /* Defined by the specification as maximum size of an array in
335 #define BUS_ARRAY_MAX_SIZE 67108864
337 #define BUS_FDS_MAX 1024
339 #define BUS_EXEC_ARGV_MAX 256
341 bool interface_name_is_valid(const char *p) _pure_;
342 bool service_name_is_valid(const char *p) _pure_;
343 bool member_name_is_valid(const char *p) _pure_;
344 bool object_path_is_valid(const char *p) _pure_;
345 char *object_path_startswith(const char *a, const char *b) _pure_;
347 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
348 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
350 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
351 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
353 int bus_message_type_from_string(const char *s, uint8_t *u) _pure_;
354 const char *bus_message_type_to_string(uint8_t u) _pure_;
356 #define error_name_is_valid interface_name_is_valid
358 int bus_ensure_running(sd_bus *bus);
359 int bus_start_running(sd_bus *bus);
360 int bus_next_address(sd_bus *bus);
362 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
364 int bus_rqueue_make_room(sd_bus *bus);
366 bool bus_pid_changed(sd_bus *bus);
368 char *bus_address_escape(const char *v);
370 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path) \
371 for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
372 _slash && !(_slash[(_slash) == (prefix)] = 0); \
373 _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
375 /* If we are invoking callbacks of a bus object, ensure unreffing the
376 * bus from the callback doesn't destroy the object we are working
378 #define BUS_DONT_DESTROY(bus) \
379 _cleanup_bus_unref_ _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
381 int bus_set_address_system(sd_bus *bus);
382 int bus_set_address_user(sd_bus *bus);
383 int bus_set_address_system_remote(sd_bus *b, const char *host);
384 int bus_set_address_system_container(sd_bus *b, const char *machine);
386 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
388 int bus_get_root_path(sd_bus *bus);