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>
32 #include "socket-util.h"
35 #include "bus-error.h"
36 #include "bus-match.h"
37 #include "bus-kernel.h"
40 struct reply_callback {
41 sd_bus_message_handler_t callback;
47 struct filter_callback {
48 sd_bus_message_handler_t callback;
50 unsigned last_iteration;
52 LIST_FIELDS(struct filter_callback, callbacks);
55 struct match_callback {
56 sd_bus_message_handler_t callback;
59 unsigned last_iteration;
63 struct bus_match_node *match_node;
69 LIST_HEAD(struct node, child);
70 LIST_FIELDS(struct node, siblings);
72 LIST_HEAD(struct node_callback, callbacks);
73 LIST_HEAD(struct node_vtable, vtables);
74 LIST_HEAD(struct node_enumerator, enumerators);
75 LIST_HEAD(struct node_object_manager, object_managers);
78 struct node_callback {
82 sd_bus_message_handler_t callback;
84 unsigned last_iteration;
86 LIST_FIELDS(struct node_callback, callbacks);
89 struct node_enumerator {
92 sd_bus_node_enumerator_t callback;
94 unsigned last_iteration;
96 LIST_FIELDS(struct node_enumerator, enumerators);
99 struct node_object_manager {
102 LIST_FIELDS(struct node_object_manager, object_managers);
110 const sd_bus_vtable *vtable;
111 sd_bus_object_find_t find;
113 unsigned last_iteration;
115 LIST_FIELDS(struct node_vtable, vtables);
118 struct vtable_member {
120 const char *interface;
122 struct node_vtable *parent;
123 unsigned last_iteration;
124 const sd_bus_vtable *vtable;
127 typedef enum BusSlotType {
134 BUS_NODE_OBJECT_MANAGER,
135 _BUS_SLOT_INVALID = -1,
146 LIST_FIELDS(sd_bus_slot, slots);
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;
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 fake_creds_valid:1;
208 bool fake_pids_valid:1;
209 bool manual_peer_interface:1;
212 bool allow_interactive_authorization:1;
219 sd_bus_message **rqueue;
220 unsigned rqueue_size;
221 size_t rqueue_allocated;
223 sd_bus_message **wqueue;
224 unsigned wqueue_size;
226 size_t wqueue_allocated;
233 struct bus_match_node match_callbacks;
234 Prioq *reply_callbacks_prioq;
235 OrderedHashmap *reply_callbacks;
236 LIST_HEAD(struct filter_callback, filter_callbacks);
239 Hashmap *vtable_methods;
240 Hashmap *vtable_properties;
242 union sockaddr_union sockaddr;
243 socklen_t sockaddr_size;
249 sd_id128_t server_id;
252 unsigned address_index;
254 int last_connect_error;
258 struct iovec auth_iovec[3];
264 char label[NAME_MAX];
274 unsigned iteration_counter;
278 /* We do locking around the memfd cache, since we want to
279 * allow people to process a sd_bus_message in a different
280 * thread then it was generated on and free it there. Since
281 * adding something to the memfd cache might happen when a
282 * message is released, we hence need to protect this bit with
284 pthread_mutex_t memfd_cache_mutex;
285 struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
286 unsigned n_memfd_cache;
290 uint64_t hello_flags;
291 uint64_t attach_flags;
293 uint64_t match_cookie;
295 sd_event_source *input_io_event_source;
296 sd_event_source *output_io_event_source;
297 sd_event_source *time_event_source;
298 sd_event_source *quit_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;
310 struct kdbus_creds fake_creds;
311 struct kdbus_pids fake_pids;
319 unsigned bloom_n_hash;
321 sd_bus_track *track_queue;
323 LIST_HEAD(sd_bus_slot, slots);
326 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
328 #define BUS_WQUEUE_MAX 1024
329 #define BUS_RQUEUE_MAX 64*1024
331 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
332 #define BUS_AUTH_SIZE_MAX (64*1024)
334 #define BUS_CONTAINER_DEPTH 128
336 /* Defined by the specification as maximum size of an array in
338 #define BUS_ARRAY_MAX_SIZE 67108864
340 #define BUS_FDS_MAX 1024
342 #define BUS_EXEC_ARGV_MAX 256
344 bool interface_name_is_valid(const char *p) _pure_;
345 bool service_name_is_valid(const char *p) _pure_;
346 char* service_name_startswith(const char *a, const char *b);
347 bool member_name_is_valid(const char *p) _pure_;
348 bool object_path_is_valid(const char *p) _pure_;
349 char *object_path_startswith(const char *a, const char *b) _pure_;
351 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
352 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
354 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
355 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
357 int bus_message_type_from_string(const char *s, uint8_t *u) _pure_;
358 const char *bus_message_type_to_string(uint8_t u) _pure_;
360 #define error_name_is_valid interface_name_is_valid
362 int bus_ensure_running(sd_bus *bus);
363 int bus_start_running(sd_bus *bus);
364 int bus_next_address(sd_bus *bus);
366 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
368 int bus_rqueue_make_room(sd_bus *bus);
370 bool bus_pid_changed(sd_bus *bus);
372 char *bus_address_escape(const char *v);
374 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path) \
375 for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
376 _slash && !(_slash[(_slash) == (prefix)] = 0); \
377 _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
379 /* If we are invoking callbacks of a bus object, ensure unreffing the
380 * bus from the callback doesn't destroy the object we are working
382 #define BUS_DONT_DESTROY(bus) \
383 _cleanup_bus_unref_ _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
385 int bus_set_address_system(sd_bus *bus);
386 int bus_set_address_user(sd_bus *bus);
387 int bus_set_address_system_remote(sd_bus *b, const char *host);
388 int bus_set_address_system_machine(sd_bus *b, const char *machine);
390 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
392 int bus_get_root_path(sd_bus *bus);