1 /* SPDX-License-Identifier: LGPL-2.1+ */
8 #include <sys/socket.h>
12 #include "bus-error.h"
13 #include "bus-kernel.h"
14 #include "bus-match.h"
20 #include "socket-util.h"
23 struct reply_callback {
24 sd_bus_message_handler_t callback;
25 usec_t timeout_usec; /* this is a relative timeout until we reach the BUS_HELLO state, and an absolute one right after */
30 struct filter_callback {
31 sd_bus_message_handler_t callback;
33 unsigned last_iteration;
35 LIST_FIELDS(struct filter_callback, callbacks);
38 struct match_callback {
39 sd_bus_message_handler_t callback;
40 sd_bus_message_handler_t install_callback;
42 sd_bus_slot *install_slot; /* The AddMatch() call */
44 unsigned last_iteration;
48 struct bus_match_node *match_node;
54 LIST_HEAD(struct node, child);
55 LIST_FIELDS(struct node, siblings);
57 LIST_HEAD(struct node_callback, callbacks);
58 LIST_HEAD(struct node_vtable, vtables);
59 LIST_HEAD(struct node_enumerator, enumerators);
60 LIST_HEAD(struct node_object_manager, object_managers);
63 struct node_callback {
67 sd_bus_message_handler_t callback;
69 unsigned last_iteration;
71 LIST_FIELDS(struct node_callback, callbacks);
74 struct node_enumerator {
77 sd_bus_node_enumerator_t callback;
79 unsigned last_iteration;
81 LIST_FIELDS(struct node_enumerator, enumerators);
84 struct node_object_manager {
87 LIST_FIELDS(struct node_object_manager, object_managers);
95 const sd_bus_vtable *vtable;
96 sd_bus_object_find_t find;
98 unsigned last_iteration;
100 LIST_FIELDS(struct node_vtable, vtables);
103 struct vtable_member {
105 const char *interface;
107 struct node_vtable *parent;
108 unsigned last_iteration;
109 const sd_bus_vtable *vtable;
112 typedef enum BusSlotType {
119 BUS_NODE_OBJECT_MANAGER,
120 _BUS_SLOT_INVALID = -1,
127 sd_bus_destroy_t destroy_callback;
130 /* Slots can be "floating" or not. If they are not floating (the usual case) then they reference the bus object
131 * they are associated with. This means the bus object stays allocated at least as long as there is a slot
132 * around associated with it. If it is floating, then the slot's lifecycle is bound to the lifecycle of the
133 * bus: it will be disconnected from the bus when the bus is destroyed, and it keeping the slot reffed hence
134 * won't mean the bus stays reffed too. Internally this means the reference direction is reversed: floating
135 * slots objects are referenced by the bus object, and not vice versa. */
141 LIST_FIELDS(sd_bus_slot, slots);
144 struct reply_callback reply_callback;
145 struct filter_callback filter_callback;
146 struct match_callback match_callback;
147 struct node_callback node_callback;
148 struct node_enumerator node_enumerator;
149 struct node_object_manager node_object_manager;
150 struct node_vtable node_vtable;
156 BUS_WATCH_BIND, /* waiting for the socket to appear via inotify */
157 BUS_OPENING, /* the kernel's connect() is still not ready */
158 BUS_AUTHENTICATING, /* we are currently in the "SASL" authorization phase of dbus */
159 BUS_HELLO, /* we are waiting for the Hello() response */
166 static inline bool BUS_IS_OPEN(enum bus_state state) {
167 return state > BUS_UNSET && state < BUS_CLOSING;
177 /* We use atomic ref counting here since sd_bus_message
178 objects retain references to their originating sd_bus but
179 we want to allow them to be processed in a different
180 thread. We won't provide full thread safety, but only the
181 bare minimum that makes it possible to use sd_bus and
182 sd_bus_message objects independently and on different
183 threads as long as each object is used only once at the
187 enum bus_state state;
188 int input_fd, output_fd;
197 bool anonymous_auth:1;
199 bool prefer_writev:1;
200 bool match_callbacks_modified:1;
201 bool filter_callbacks_modified:1;
202 bool nodes_modified:1;
204 bool manual_peer_interface:1;
207 bool allow_interactive_authorization:1;
208 bool exit_on_disconnect:1;
210 bool exit_triggered:1;
215 bool attach_timestamp:1;
216 bool connected_signal:1;
223 sd_bus_message **rqueue;
224 unsigned rqueue_size;
225 size_t rqueue_allocated;
227 sd_bus_message **wqueue;
228 unsigned wqueue_size;
230 size_t wqueue_allocated;
237 struct bus_match_node match_callbacks;
238 Prioq *reply_callbacks_prioq;
239 OrderedHashmap *reply_callbacks;
240 LIST_HEAD(struct filter_callback, filter_callbacks);
243 Hashmap *vtable_methods;
244 Hashmap *vtable_properties;
246 union sockaddr_union sockaddr;
247 socklen_t sockaddr_size;
252 sd_id128_t server_id;
255 unsigned address_index;
257 int last_connect_error;
261 struct iovec auth_iovec[3];
279 unsigned iteration_counter;
281 /* We do locking around the memfd cache, since we want to
282 * allow people to process a sd_bus_message in a different
283 * thread then it was generated on and free it there. Since
284 * adding something to the memfd cache might happen when a
285 * message is released, we hence need to protect this bit with
287 pthread_mutex_t memfd_cache_mutex;
288 struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
289 unsigned n_memfd_cache;
294 sd_event_source *input_io_event_source;
295 sd_event_source *output_io_event_source;
296 sd_event_source *time_event_source;
297 sd_event_source *quit_event_source;
298 sd_event_source *inotify_event_source;
302 sd_bus_message *current_message;
303 sd_bus_slot *current_slot;
304 sd_bus_message_handler_t current_handler;
305 void *current_userdata;
307 sd_bus **default_bus_ptr;
315 sd_bus_track *track_queue;
317 LIST_HEAD(sd_bus_slot, slots);
318 LIST_HEAD(sd_bus_track, tracks);
320 int *inotify_watches;
321 size_t n_inotify_watches;
324 /* For method calls we time-out at 25s, like in the D-Bus reference implementation */
325 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
327 /* For the authentication phase we grant 90s, to provide extra room during boot, when RNGs and such are not filled up
328 * with enough entropy yet and might delay the boot */
329 #define BUS_AUTH_TIMEOUT ((usec_t) DEFAULT_TIMEOUT_USEC)
331 #define BUS_WQUEUE_MAX (192*1024)
332 #define BUS_RQUEUE_MAX (192*1024)
334 #define BUS_MESSAGE_SIZE_MAX (128*1024*1024)
335 #define BUS_AUTH_SIZE_MAX (64*1024)
337 #define BUS_CONTAINER_DEPTH 128
339 /* Defined by the specification as maximum size of an array in
341 #define BUS_ARRAY_MAX_SIZE 67108864
343 #define BUS_FDS_MAX 1024
345 #define BUS_EXEC_ARGV_MAX 256
347 bool interface_name_is_valid(const char *p) _pure_;
348 bool service_name_is_valid(const char *p) _pure_;
349 #if 0 /// UNNEEDED by elogind
350 char* service_name_startswith(const char *a, const char *b);
352 bool member_name_is_valid(const char *p) _pure_;
353 bool object_path_is_valid(const char *p) _pure_;
354 char *object_path_startswith(const char *a, const char *b) _pure_;
356 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
357 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
359 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
360 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
362 int bus_message_type_from_string(const char *s, uint8_t *u) _pure_;
363 const char *bus_message_type_to_string(uint8_t u) _pure_;
365 #define error_name_is_valid interface_name_is_valid
367 sd_bus *bus_resolve(sd_bus *bus);
369 int bus_ensure_running(sd_bus *bus);
370 int bus_start_running(sd_bus *bus);
371 int bus_next_address(sd_bus *bus);
373 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
375 int bus_rqueue_make_room(sd_bus *bus);
377 bool bus_pid_changed(sd_bus *bus);
379 char *bus_address_escape(const char *v);
381 int bus_attach_io_events(sd_bus *b);
382 int bus_attach_inotify_event(sd_bus *b);
384 void bus_close_inotify_fd(sd_bus *b);
385 void bus_close_io_fds(sd_bus *b);
387 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path) \
388 for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
389 _slash && !(_slash[(_slash) == (prefix)] = 0); \
390 _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
392 /* If we are invoking callbacks of a bus object, ensure unreffing the
393 * bus from the callback doesn't destroy the object we are working
395 #define BUS_DONT_DESTROY(bus) \
396 _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
398 int bus_set_address_system(sd_bus *bus);
399 #if 0 /// UNNEEDED by elogind
400 int bus_set_address_user(sd_bus *bus);
402 int bus_set_address_system_remote(sd_bus *b, const char *host);
403 int bus_set_address_system_machine(sd_bus *b, const char *machine);
405 #if 0 /// UNNEEDED by elogind
407 int bus_get_root_path(sd_bus *bus);
409 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
411 #define bus_assert_return(expr, r, error) \
413 if (!assert_log(expr, #expr)) \
414 return sd_bus_error_set_errno(error, r); \
417 void bus_enter_closing(sd_bus *bus);
419 void bus_set_state(sd_bus *bus, enum bus_state state);