4 This file is part of systemd.
6 Copyright 2013 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 #include <sys/socket.h>
27 #include "bus-error.h"
28 #include "bus-kernel.h"
29 #include "bus-match.h"
35 #include "socket-util.h"
38 struct reply_callback {
39 sd_bus_message_handler_t callback;
45 struct filter_callback {
46 sd_bus_message_handler_t callback;
48 unsigned last_iteration;
50 LIST_FIELDS(struct filter_callback, callbacks);
53 struct match_callback {
54 sd_bus_message_handler_t callback;
57 unsigned last_iteration;
61 struct bus_match_node *match_node;
67 LIST_HEAD(struct node, child);
68 LIST_FIELDS(struct node, siblings);
70 LIST_HEAD(struct node_callback, callbacks);
71 LIST_HEAD(struct node_vtable, vtables);
72 LIST_HEAD(struct node_enumerator, enumerators);
73 LIST_HEAD(struct node_object_manager, object_managers);
76 struct node_callback {
80 sd_bus_message_handler_t callback;
82 unsigned last_iteration;
84 LIST_FIELDS(struct node_callback, callbacks);
87 struct node_enumerator {
90 sd_bus_node_enumerator_t callback;
92 unsigned last_iteration;
94 LIST_FIELDS(struct node_enumerator, enumerators);
97 struct node_object_manager {
100 LIST_FIELDS(struct node_object_manager, object_managers);
108 const sd_bus_vtable *vtable;
109 sd_bus_object_find_t find;
111 unsigned last_iteration;
113 LIST_FIELDS(struct node_vtable, vtables);
116 struct vtable_member {
118 const char *interface;
120 struct node_vtable *parent;
121 unsigned last_iteration;
122 const sd_bus_vtable *vtable;
125 typedef enum BusSlotType {
132 BUS_NODE_OBJECT_MANAGER,
133 _BUS_SLOT_INVALID = -1,
145 LIST_FIELDS(sd_bus_slot, slots);
148 struct reply_callback reply_callback;
149 struct filter_callback filter_callback;
150 struct match_callback match_callback;
151 struct node_callback node_callback;
152 struct node_enumerator node_enumerator;
153 struct node_object_manager node_object_manager;
154 struct node_vtable node_vtable;
168 static inline bool BUS_IS_OPEN(enum bus_state state) {
169 return state > BUS_UNSET && state < BUS_CLOSING;
179 /* We use atomic ref counting here since sd_bus_message
180 objects retain references to their originating sd_bus but
181 we want to allow them to be processed in a different
182 thread. We won't provide full thread safety, but only the
183 bare minimum that makes it possible to use sd_bus and
184 sd_bus_message objects independently and on different
185 threads as long as each object is used only once at the
189 enum bus_state state;
190 int input_fd, output_fd;
199 bool anonymous_auth:1;
201 bool prefer_writev:1;
202 bool match_callbacks_modified:1;
203 bool filter_callbacks_modified:1;
204 bool nodes_modified:1;
206 bool fake_creds_valid:1;
207 bool fake_pids_valid:1;
208 bool manual_peer_interface:1;
211 bool allow_interactive_authorization:1;
212 bool exit_on_disconnect:1;
214 bool exit_triggered:1;
221 sd_bus_message **rqueue;
222 unsigned rqueue_size;
223 size_t rqueue_allocated;
225 sd_bus_message **wqueue;
226 unsigned wqueue_size;
228 size_t wqueue_allocated;
235 struct bus_match_node match_callbacks;
236 Prioq *reply_callbacks_prioq;
237 OrderedHashmap *reply_callbacks;
238 LIST_HEAD(struct filter_callback, filter_callbacks);
241 Hashmap *vtable_methods;
242 Hashmap *vtable_properties;
244 union sockaddr_union sockaddr;
245 socklen_t sockaddr_size;
251 sd_id128_t server_id;
254 unsigned address_index;
256 int last_connect_error;
260 struct iovec auth_iovec[3];
276 unsigned iteration_counter;
280 /* We do locking around the memfd cache, since we want to
281 * allow people to process a sd_bus_message in a different
282 * thread then it was generated on and free it there. Since
283 * adding something to the memfd cache might happen when a
284 * message is released, we hence need to protect this bit with
286 pthread_mutex_t memfd_cache_mutex;
287 struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
288 unsigned n_memfd_cache;
292 uint64_t hello_flags;
293 uint64_t attach_flags;
295 uint64_t match_cookie;
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;
304 sd_bus_message *current_message;
305 sd_bus_slot *current_slot;
306 sd_bus_message_handler_t current_handler;
307 void *current_userdata;
309 sd_bus **default_bus_ptr;
312 struct kdbus_creds fake_creds;
313 struct kdbus_pids fake_pids;
321 unsigned bloom_n_hash;
323 sd_bus_track *track_queue;
325 LIST_HEAD(sd_bus_slot, slots);
326 LIST_HEAD(sd_bus_track, tracks);
329 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
331 #define BUS_WQUEUE_MAX (192*1024)
332 #define BUS_RQUEUE_MAX (192*1024)
334 #define BUS_MESSAGE_SIZE_MAX (64*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 int bus_ensure_running(sd_bus *bus);
368 int bus_start_running(sd_bus *bus);
369 int bus_next_address(sd_bus *bus);
371 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
373 int bus_rqueue_make_room(sd_bus *bus);
375 bool bus_pid_changed(sd_bus *bus);
377 char *bus_address_escape(const char *v);
379 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path) \
380 for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
381 _slash && !(_slash[(_slash) == (prefix)] = 0); \
382 _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
384 /* If we are invoking callbacks of a bus object, ensure unreffing the
385 * bus from the callback doesn't destroy the object we are working
387 #define BUS_DONT_DESTROY(bus) \
388 _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
390 int bus_set_address_system(sd_bus *bus);
391 #if 0 /// UNNEEDED by elogind
392 int bus_set_address_user(sd_bus *bus);
394 int bus_set_address_system_remote(sd_bus *b, const char *host);
395 int bus_set_address_system_machine(sd_bus *b, const char *machine);
397 #if 0 /// UNNEEDED by elogind
398 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
401 int bus_get_root_path(sd_bus *bus);
403 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
405 #define bus_assert_return(expr, r, error) \
407 if (!assert_log(expr, #expr)) \
408 return sd_bus_error_set_errno(error, r); \