1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 This file is part of systemd.
7 Copyright 2013 Lennart Poettering
11 #include <sys/socket.h>
15 #include "bus-error.h"
16 #include "bus-kernel.h"
17 #include "bus-match.h"
23 #include "socket-util.h"
26 struct reply_callback {
27 sd_bus_message_handler_t callback;
28 usec_t timeout_usec; /* this is a relative timeout until we reach the BUS_HELLO state, and an absolute one right after */
33 struct filter_callback {
34 sd_bus_message_handler_t callback;
36 unsigned last_iteration;
38 LIST_FIELDS(struct filter_callback, callbacks);
41 struct match_callback {
42 sd_bus_message_handler_t callback;
43 sd_bus_message_handler_t install_callback;
45 sd_bus_slot *install_slot; /* The AddMatch() call */
47 unsigned last_iteration;
51 struct bus_match_node *match_node;
57 LIST_HEAD(struct node, child);
58 LIST_FIELDS(struct node, siblings);
60 LIST_HEAD(struct node_callback, callbacks);
61 LIST_HEAD(struct node_vtable, vtables);
62 LIST_HEAD(struct node_enumerator, enumerators);
63 LIST_HEAD(struct node_object_manager, object_managers);
66 struct node_callback {
70 sd_bus_message_handler_t callback;
72 unsigned last_iteration;
74 LIST_FIELDS(struct node_callback, callbacks);
77 struct node_enumerator {
80 sd_bus_node_enumerator_t callback;
82 unsigned last_iteration;
84 LIST_FIELDS(struct node_enumerator, enumerators);
87 struct node_object_manager {
90 LIST_FIELDS(struct node_object_manager, object_managers);
98 const sd_bus_vtable *vtable;
99 sd_bus_object_find_t find;
101 unsigned last_iteration;
103 LIST_FIELDS(struct node_vtable, vtables);
106 struct vtable_member {
108 const char *interface;
110 struct node_vtable *parent;
111 unsigned last_iteration;
112 const sd_bus_vtable *vtable;
115 typedef enum BusSlotType {
122 BUS_NODE_OBJECT_MANAGER,
123 _BUS_SLOT_INVALID = -1,
130 sd_bus_destroy_t destroy_callback;
133 /* Slots can be "floating" or not. If they are not floating (the usual case) then they reference the bus object
134 * they are associated with. This means the bus object stays allocated at least as long as there is a slot
135 * around associated with it. If it is floating, then the slot's lifecycle is bound to the lifecycle of the
136 * bus: it will be disconnected from the bus when the bus is destroyed, and it keeping the slot reffed hence
137 * won't mean the bus stays reffed too. Internally this means the reference direction is reversed: floating
138 * slots objects are referenced by the bus object, and not vice versa. */
144 LIST_FIELDS(sd_bus_slot, slots);
147 struct reply_callback reply_callback;
148 struct filter_callback filter_callback;
149 struct match_callback match_callback;
150 struct node_callback node_callback;
151 struct node_enumerator node_enumerator;
152 struct node_object_manager node_object_manager;
153 struct node_vtable node_vtable;
159 BUS_WATCH_BIND, /* waiting for the socket to appear via inotify */
160 BUS_OPENING, /* the kernel's connect() is still not ready */
161 BUS_AUTHENTICATING, /* we are currently in the "SASL" authorization phase of dbus */
162 BUS_HELLO, /* we are waiting for the Hello() response */
169 static inline bool BUS_IS_OPEN(enum bus_state state) {
170 return state > BUS_UNSET && state < BUS_CLOSING;
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
190 enum bus_state state;
191 int input_fd, output_fd;
200 bool anonymous_auth:1;
202 bool prefer_writev:1;
203 bool match_callbacks_modified:1;
204 bool filter_callbacks_modified:1;
205 bool nodes_modified:1;
207 bool manual_peer_interface:1;
210 bool allow_interactive_authorization:1;
211 bool exit_on_disconnect:1;
213 bool exit_triggered:1;
218 bool attach_timestamp:1;
219 bool connected_signal:1;
226 sd_bus_message **rqueue;
227 unsigned rqueue_size;
228 size_t rqueue_allocated;
230 sd_bus_message **wqueue;
231 unsigned wqueue_size;
233 size_t wqueue_allocated;
240 struct bus_match_node match_callbacks;
241 Prioq *reply_callbacks_prioq;
242 OrderedHashmap *reply_callbacks;
243 LIST_HEAD(struct filter_callback, filter_callbacks);
246 Hashmap *vtable_methods;
247 Hashmap *vtable_properties;
249 union sockaddr_union sockaddr;
250 socklen_t sockaddr_size;
255 sd_id128_t server_id;
258 unsigned address_index;
260 int last_connect_error;
264 struct iovec auth_iovec[3];
282 unsigned iteration_counter;
284 /* We do locking around the memfd cache, since we want to
285 * allow people to process a sd_bus_message in a different
286 * thread then it was generated on and free it there. Since
287 * adding something to the memfd cache might happen when a
288 * message is released, we hence need to protect this bit with
290 pthread_mutex_t memfd_cache_mutex;
291 struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
292 unsigned n_memfd_cache;
297 sd_event_source *input_io_event_source;
298 sd_event_source *output_io_event_source;
299 sd_event_source *time_event_source;
300 sd_event_source *quit_event_source;
301 sd_event_source *inotify_event_source;
305 sd_bus_message *current_message;
306 sd_bus_slot *current_slot;
307 sd_bus_message_handler_t current_handler;
308 void *current_userdata;
310 sd_bus **default_bus_ptr;
318 sd_bus_track *track_queue;
320 LIST_HEAD(sd_bus_slot, slots);
321 LIST_HEAD(sd_bus_track, tracks);
323 int *inotify_watches;
324 size_t n_inotify_watches;
327 /* For method calls we time-out at 25s, like in the D-Bus reference implementation */
328 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
330 /* For the authentication phase we grant 90s, to provide extra room during boot, when RNGs and such are not filled up
331 * with enough entropy yet and might delay the boot */
332 #define BUS_AUTH_TIMEOUT ((usec_t) DEFAULT_TIMEOUT_USEC)
334 #define BUS_WQUEUE_MAX (192*1024)
335 #define BUS_RQUEUE_MAX (192*1024)
337 #define BUS_MESSAGE_SIZE_MAX (128*1024*1024)
338 #define BUS_AUTH_SIZE_MAX (64*1024)
340 #define BUS_CONTAINER_DEPTH 128
342 /* Defined by the specification as maximum size of an array in
344 #define BUS_ARRAY_MAX_SIZE 67108864
346 #define BUS_FDS_MAX 1024
348 #define BUS_EXEC_ARGV_MAX 256
350 bool interface_name_is_valid(const char *p) _pure_;
351 bool service_name_is_valid(const char *p) _pure_;
352 #if 0 /// UNNEEDED by elogind
353 char* service_name_startswith(const char *a, const char *b);
355 bool member_name_is_valid(const char *p) _pure_;
356 bool object_path_is_valid(const char *p) _pure_;
357 char *object_path_startswith(const char *a, const char *b) _pure_;
359 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
360 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
362 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
363 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
365 int bus_message_type_from_string(const char *s, uint8_t *u) _pure_;
366 const char *bus_message_type_to_string(uint8_t u) _pure_;
368 #define error_name_is_valid interface_name_is_valid
370 sd_bus *bus_resolve(sd_bus *bus);
372 int bus_ensure_running(sd_bus *bus);
373 int bus_start_running(sd_bus *bus);
374 int bus_next_address(sd_bus *bus);
376 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
378 int bus_rqueue_make_room(sd_bus *bus);
380 bool bus_pid_changed(sd_bus *bus);
382 char *bus_address_escape(const char *v);
384 int bus_attach_io_events(sd_bus *b);
385 int bus_attach_inotify_event(sd_bus *b);
387 void bus_close_inotify_fd(sd_bus *b);
388 void bus_close_io_fds(sd_bus *b);
390 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path) \
391 for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
392 _slash && !(_slash[(_slash) == (prefix)] = 0); \
393 _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
395 /* If we are invoking callbacks of a bus object, ensure unreffing the
396 * bus from the callback doesn't destroy the object we are working
398 #define BUS_DONT_DESTROY(bus) \
399 _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
401 int bus_set_address_system(sd_bus *bus);
402 #if 0 /// UNNEEDED by elogind
403 int bus_set_address_user(sd_bus *bus);
405 int bus_set_address_system_remote(sd_bus *b, const char *host);
406 int bus_set_address_system_machine(sd_bus *b, const char *machine);
408 #if 0 /// UNNEEDED by elogind
410 int bus_get_root_path(sd_bus *bus);
412 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
414 #define bus_assert_return(expr, r, error) \
416 if (!assert_log(expr, #expr)) \
417 return sd_bus_error_set_errno(error, r); \
420 void bus_enter_closing(sd_bus *bus);
422 void bus_set_state(sd_bus *bus, enum bus_state state);