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
;
198 bool anonymous_auth
:1;
200 bool prefer_writev
:1;
201 bool match_callbacks_modified
:1;
202 bool filter_callbacks_modified
:1;
203 bool nodes_modified
:1;
205 bool manual_peer_interface
:1;
208 bool allow_interactive_authorization
:1;
209 bool exit_on_disconnect
:1;
211 bool exit_triggered
: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
;
248 sd_id128_t server_id
;
251 unsigned address_index
;
253 int last_connect_error
;
257 struct iovec auth_iovec
[3];
273 unsigned iteration_counter
;
275 /* We do locking around the memfd cache, since we want to
276 * allow people to process a sd_bus_message in a different
277 * thread then it was generated on and free it there. Since
278 * adding something to the memfd cache might happen when a
279 * message is released, we hence need to protect this bit with
281 pthread_mutex_t memfd_cache_mutex
;
282 struct memfd_cache memfd_cache
[MEMFD_CACHE_MAX
];
283 unsigned n_memfd_cache
;
287 uint64_t hello_flags
;
288 uint64_t attach_flags
;
290 uint64_t match_cookie
;
292 sd_event_source
*input_io_event_source
;
293 sd_event_source
*output_io_event_source
;
294 sd_event_source
*time_event_source
;
295 sd_event_source
*quit_event_source
;
299 sd_bus_message
*current_message
;
300 sd_bus_slot
*current_slot
;
301 sd_bus_message_handler_t current_handler
;
302 void *current_userdata
;
304 sd_bus
**default_bus_ptr
;
312 unsigned bloom_n_hash
;
314 sd_bus_track
*track_queue
;
316 LIST_HEAD(sd_bus_slot
, slots
);
317 LIST_HEAD(sd_bus_track
, tracks
);
320 /* For method calls we time-out at 25s, like in the D-Bus reference implementation */
321 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
323 /* For the authentication phase we grant 90s, to provide extra room during boot, when RNGs and such are not filled up
324 * with enough entropy yet and might delay the boot */
325 #define BUS_AUTH_TIMEOUT ((usec_t) DEFAULT_TIMEOUT_USEC)
327 #define BUS_WQUEUE_MAX (192*1024)
328 #define BUS_RQUEUE_MAX (192*1024)
330 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
331 #define BUS_AUTH_SIZE_MAX (64*1024)
333 #define BUS_CONTAINER_DEPTH 128
335 /* Defined by the specification as maximum size of an array in
337 #define BUS_ARRAY_MAX_SIZE 67108864
339 #define BUS_FDS_MAX 1024
341 #define BUS_EXEC_ARGV_MAX 256
343 bool interface_name_is_valid(const char *p
) _pure_
;
344 bool service_name_is_valid(const char *p
) _pure_
;
345 char* service_name_startswith(const char *a
, const char *b
);
346 bool member_name_is_valid(const char *p
) _pure_
;
347 bool object_path_is_valid(const char *p
) _pure_
;
348 char *object_path_startswith(const char *a
, const char *b
) _pure_
;
350 bool namespace_complex_pattern(const char *pattern
, const char *value
) _pure_
;
351 bool path_complex_pattern(const char *pattern
, const char *value
) _pure_
;
353 bool namespace_simple_pattern(const char *pattern
, const char *value
) _pure_
;
354 bool path_simple_pattern(const char *pattern
, const char *value
) _pure_
;
356 int bus_message_type_from_string(const char *s
, uint8_t *u
) _pure_
;
357 const char *bus_message_type_to_string(uint8_t u
) _pure_
;
359 #define error_name_is_valid interface_name_is_valid
361 int bus_ensure_running(sd_bus
*bus
);
362 int bus_start_running(sd_bus
*bus
);
363 int bus_next_address(sd_bus
*bus
);
365 int bus_seal_synthetic_message(sd_bus
*b
, sd_bus_message
*m
);
367 int bus_rqueue_make_room(sd_bus
*bus
);
369 bool bus_pid_changed(sd_bus
*bus
);
371 char *bus_address_escape(const char *v
);
373 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path) \
374 for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
375 _slash && !(_slash[(_slash) == (prefix)] = 0); \
376 _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
378 /* If we are invoking callbacks of a bus object, ensure unreffing the
379 * bus from the callback doesn't destroy the object we are working
381 #define BUS_DONT_DESTROY(bus) \
382 _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
384 int bus_set_address_system(sd_bus
*bus
);
385 int bus_set_address_user(sd_bus
*bus
);
386 int bus_set_address_system_remote(sd_bus
*b
, const char *host
);
387 int bus_set_address_system_machine(sd_bus
*b
, const char *machine
);
389 int bus_remove_match_by_string(sd_bus
*bus
, const char *match
, sd_bus_message_handler_t callback
, void *userdata
);
391 int bus_get_root_path(sd_bus
*bus
);
393 int bus_maybe_reply_error(sd_bus_message
*m
, int r
, sd_bus_error
*error
);
395 #define bus_assert_return(expr, r, error) \
397 if (!assert_log(expr, #expr)) \
398 return sd_bus_error_set_errno(error, r); \
402 * enum kdbus_attach_flags - flags for metadata attachments
403 * @KDBUS_ATTACH_TIMESTAMP: Timestamp
404 * @KDBUS_ATTACH_CREDS: Credentials
405 * @KDBUS_ATTACH_PIDS: PIDs
406 * @KDBUS_ATTACH_AUXGROUPS: Auxiliary groups
407 * @KDBUS_ATTACH_NAMES: Well-known names
408 * @KDBUS_ATTACH_TID_COMM: The "comm" process identifier of the TID
409 * @KDBUS_ATTACH_PID_COMM: The "comm" process identifier of the PID
410 * @KDBUS_ATTACH_EXE: The path of the executable
411 * @KDBUS_ATTACH_CMDLINE: The process command line
412 * @KDBUS_ATTACH_CGROUP: The croup membership
413 * @KDBUS_ATTACH_CAPS: The process capabilities
414 * @KDBUS_ATTACH_SECLABEL: The security label
415 * @KDBUS_ATTACH_AUDIT: The audit IDs
416 * @KDBUS_ATTACH_CONN_DESCRIPTION: The human-readable connection name
417 * @_KDBUS_ATTACH_ALL: All of the above
418 * @_KDBUS_ATTACH_ANY: Wildcard match to enable any kind of
421 enum kdbus_attach_flags
{
422 KDBUS_ATTACH_TIMESTAMP
= 1ULL << 0,
423 KDBUS_ATTACH_CREDS
= 1ULL << 1,
424 KDBUS_ATTACH_PIDS
= 1ULL << 2,
425 KDBUS_ATTACH_AUXGROUPS
= 1ULL << 3,
426 KDBUS_ATTACH_NAMES
= 1ULL << 4,
427 KDBUS_ATTACH_TID_COMM
= 1ULL << 5,
428 KDBUS_ATTACH_PID_COMM
= 1ULL << 6,
429 KDBUS_ATTACH_EXE
= 1ULL << 7,
430 KDBUS_ATTACH_CMDLINE
= 1ULL << 8,
431 KDBUS_ATTACH_CGROUP
= 1ULL << 9,
432 KDBUS_ATTACH_CAPS
= 1ULL << 10,
433 KDBUS_ATTACH_SECLABEL
= 1ULL << 11,
434 KDBUS_ATTACH_AUDIT
= 1ULL << 12,
435 KDBUS_ATTACH_CONN_DESCRIPTION
= 1ULL << 13,
436 _KDBUS_ATTACH_ALL
= (1ULL << 14) - 1,
437 _KDBUS_ATTACH_ANY
= ~0ULL
441 * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
442 * @KDBUS_HELLO_ACCEPT_FD: The connection allows the reception of
443 * any passed file descriptors
444 * @KDBUS_HELLO_ACTIVATOR: Special-purpose connection which registers
445 * a well-know name for a process to be started
446 * when traffic arrives
447 * @KDBUS_HELLO_POLICY_HOLDER: Special-purpose connection which registers
448 * policy entries for a name. The provided name
449 * is not activated and not registered with the
450 * name database, it only allows unprivileged
451 * connections to acquire a name, talk or discover
453 * @KDBUS_HELLO_MONITOR: Special-purpose connection to monitor
456 enum kdbus_hello_flags
{
457 KDBUS_HELLO_ACCEPT_FD
= 1ULL << 0,
458 KDBUS_HELLO_ACTIVATOR
= 1ULL << 1,
459 KDBUS_HELLO_POLICY_HOLDER
= 1ULL << 2,
460 KDBUS_HELLO_MONITOR
= 1ULL << 3,