src/libelogind/sd-bus/bus-internal.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2013 Lennart Poettering
   8 ***/
   9
  10 #include <pthread.h>
  11 #include <sys/socket.h>
  12
  13 #include "sd-bus.h"
  14
  15 #include "bus-error.h"
  16 #include "bus-kernel.h"
  17 #include "bus-match.h"
  18 #include "def.h"
  19 #include "hashmap.h"
  20 #include "list.h"
  21 #include "prioq.h"
  22 #include "refcnt.h"
  23 #include "socket-util.h"
  24 #include "util.h"
  25
  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 */
  29         uint64_t cookie;
  30         unsigned prioq_idx;
  31 };
  32
  33 struct filter_callback {
  34         sd_bus_message_handler_t callback;
  35
  36         unsigned last_iteration;
  37
  38         LIST_FIELDS(struct filter_callback, callbacks);
  39 };
  40
  41 struct match_callback {
  42         sd_bus_message_handler_t callback;
  43         sd_bus_message_handler_t install_callback;
  44
  45         sd_bus_slot *install_slot; /* The AddMatch() call */
  46
  47         unsigned last_iteration;
  48
  49         char *match_string;
  50
  51         struct bus_match_node *match_node;
  52 };
  53
  54 struct node {
  55         char *path;
  56         struct node *parent;
  57         LIST_HEAD(struct node, child);
  58         LIST_FIELDS(struct node, siblings);
  59
  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);
  64 };
  65
  66 struct node_callback {
  67         struct node *node;
  68
  69         bool is_fallback;
  70         sd_bus_message_handler_t callback;
  71
  72         unsigned last_iteration;
  73
  74         LIST_FIELDS(struct node_callback, callbacks);
  75 };
  76
  77 struct node_enumerator {
  78         struct node *node;
  79
  80         sd_bus_node_enumerator_t callback;
  81
  82         unsigned last_iteration;
  83
  84         LIST_FIELDS(struct node_enumerator, enumerators);
  85 };
  86
  87 struct node_object_manager {
  88         struct node *node;
  89
  90         LIST_FIELDS(struct node_object_manager, object_managers);
  91 };
  92
  93 struct node_vtable {
  94         struct node *node;
  95
  96         char *interface;
  97         bool is_fallback;
  98         const sd_bus_vtable *vtable;
  99         sd_bus_object_find_t find;
 100
 101         unsigned last_iteration;
 102
 103         LIST_FIELDS(struct node_vtable, vtables);
 104 };
 105
 106 struct vtable_member {
 107         const char *path;
 108         const char *interface;
 109         const char *member;
 110         struct node_vtable *parent;
 111         unsigned last_iteration;
 112         const sd_bus_vtable *vtable;
 113 };
 114
 115 typedef enum BusSlotType {
 116         BUS_REPLY_CALLBACK,
 117         BUS_FILTER_CALLBACK,
 118         BUS_MATCH_CALLBACK,
 119         BUS_NODE_CALLBACK,
 120         BUS_NODE_ENUMERATOR,
 121         BUS_NODE_VTABLE,
 122         BUS_NODE_OBJECT_MANAGER,
 123         _BUS_SLOT_INVALID = -1,
 124 } BusSlotType;
 125
 126 struct sd_bus_slot {
 127         unsigned n_ref;
 128         sd_bus *bus;
 129         void *userdata;
 130         sd_bus_destroy_t destroy_callback;
 131         BusSlotType type:5;
 132
 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. */
 139         bool floating:1;
 140
 141         bool match_added:1;
 142         char *description;
 143
 144         LIST_FIELDS(sd_bus_slot, slots);
 145
 146         union {
 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;
 154         };
 155 };
 156
 157 enum bus_state {
 158         BUS_UNSET,
 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 */
 163         BUS_RUNNING,
 164         BUS_CLOSING,
 165         BUS_CLOSED,
 166         _BUS_STATE_MAX,
 167 };
 168
 169 static inline bool BUS_IS_OPEN(enum bus_state state) {
 170         return state > BUS_UNSET && state < BUS_CLOSING;
 171 }
 172
 173 enum bus_auth {
 174         _BUS_AUTH_INVALID,
 175         BUS_AUTH_EXTERNAL,
 176         BUS_AUTH_ANONYMOUS
 177 };
 178
 179 struct sd_bus {
 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
 187            same time. */
 188         RefCount n_ref;
 189
 190         enum bus_state state;
 191         int input_fd, output_fd;
 192         int inotify_fd;
 193         int message_version;
 194         int message_endian;
 195
 196         bool can_fds:1;
 197         bool bus_client:1;
 198         bool ucred_valid:1;
 199         bool is_server:1;
 200         bool anonymous_auth:1;
 201         bool prefer_readv:1;
 202         bool prefer_writev:1;
 203         bool match_callbacks_modified:1;
 204         bool filter_callbacks_modified:1;
 205         bool nodes_modified:1;
 206         bool trusted:1;
 207         bool manual_peer_interface:1;
 208         bool is_system:1;
 209         bool is_user:1;
 210         bool allow_interactive_authorization:1;
 211         bool exit_on_disconnect:1;
 212         bool exited:1;
 213         bool exit_triggered:1;
 214         bool is_local:1;
 215         bool watch_bind:1;
 216         bool is_monitor:1;
 217         bool accept_fd:1;
 218         bool attach_timestamp:1;
 219         bool connected_signal:1;
 220
 221         int use_memfd;
 222
 223         void *rbuffer;
 224         size_t rbuffer_size;
 225
 226         sd_bus_message **rqueue;
 227         unsigned rqueue_size;
 228         size_t rqueue_allocated;
 229
 230         sd_bus_message **wqueue;
 231         unsigned wqueue_size;
 232         size_t windex;
 233         size_t wqueue_allocated;
 234
 235         uint64_t cookie;
 236
 237         char *unique_name;
 238         uint64_t unique_id;
 239
 240         struct bus_match_node match_callbacks;
 241         Prioq *reply_callbacks_prioq;
 242         OrderedHashmap *reply_callbacks;
 243         LIST_HEAD(struct filter_callback, filter_callbacks);
 244
 245         Hashmap *nodes;
 246         Hashmap *vtable_methods;
 247         Hashmap *vtable_properties;
 248
 249         union sockaddr_union sockaddr;
 250         socklen_t sockaddr_size;
 251
 252         char *machine;
 253         pid_t nspid;
 254
 255         sd_id128_t server_id;
 256
 257         char *address;
 258         unsigned address_index;
 259
 260         int last_connect_error;
 261
 262         enum bus_auth auth;
 263         size_t auth_rbegin;
 264         struct iovec auth_iovec[3];
 265         unsigned auth_index;
 266         char *auth_buffer;
 267         usec_t auth_timeout;
 268
 269         struct ucred ucred;
 270         char *label;
 271         gid_t *groups;
 272         size_t n_groups;
 273
 274         uint64_t creds_mask;
 275
 276         int *fds;
 277         size_t n_fds;
 278
 279         char *exec_path;
 280         char **exec_argv;
 281
 282         unsigned iteration_counter;
 283
 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
 289          * a mutex. */
 290         pthread_mutex_t memfd_cache_mutex;
 291         struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
 292         unsigned n_memfd_cache;
 293
 294         pid_t original_pid;
 295         pid_t busexec_pid;
 296
 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;
 302         sd_event *event;
 303         int event_priority;
 304
 305         sd_bus_message *current_message;
 306         sd_bus_slot *current_slot;
 307         sd_bus_message_handler_t current_handler;
 308         void *current_userdata;
 309
 310         sd_bus **default_bus_ptr;
 311         pid_t tid;
 312
 313         char *cgroup_root;
 314
 315         char *description;
 316         char *patch_sender;
 317
 318         sd_bus_track *track_queue;
 319
 320         LIST_HEAD(sd_bus_slot, slots);
 321         LIST_HEAD(sd_bus_track, tracks);
 322
 323         int *inotify_watches;
 324         size_t n_inotify_watches;
 325 };
 326
 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))
 329
 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)
 333
 334 #define BUS_WQUEUE_MAX (192*1024)
 335 #define BUS_RQUEUE_MAX (192*1024)
 336
 337 #define BUS_MESSAGE_SIZE_MAX (128*1024*1024)
 338 #define BUS_AUTH_SIZE_MAX (64*1024)
 339
 340 #define BUS_CONTAINER_DEPTH 128
 341
 342 /* Defined by the specification as maximum size of an array in
 343  * bytes */
 344 #define BUS_ARRAY_MAX_SIZE 67108864
 345
 346 #define BUS_FDS_MAX 1024
 347
 348 #define BUS_EXEC_ARGV_MAX 256
 349
 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);
 354 #endif // 0
 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_;
 358
 359 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
 360 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
 361
 362 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
 363 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
 364
 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_;
 367
 368 #define error_name_is_valid interface_name_is_valid
 369
 370 sd_bus *bus_resolve(sd_bus *bus);
 371
 372 int bus_ensure_running(sd_bus *bus);
 373 int bus_start_running(sd_bus *bus);
 374 int bus_next_address(sd_bus *bus);
 375
 376 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
 377
 378 int bus_rqueue_make_room(sd_bus *bus);
 379
 380 bool bus_pid_changed(sd_bus *bus);
 381
 382 char *bus_address_escape(const char *v);
 383
 384 int bus_attach_io_events(sd_bus *b);
 385 int bus_attach_inotify_event(sd_bus *b);
 386
 387 void bus_close_inotify_fd(sd_bus *b);
 388 void bus_close_io_fds(sd_bus *b);
 389
 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), '/'))
 394
 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
 397  * on */
 398 #define BUS_DONT_DESTROY(bus) \
 399         _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
 400
 401 int bus_set_address_system(sd_bus *bus);
 402 #if 0 /// UNNEEDED by elogind
 403 int bus_set_address_user(sd_bus *bus);
 404 #endif // 0
 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);
 407
 408 #if 0 /// UNNEEDED by elogind
 409 #endif // 0
 410 int bus_get_root_path(sd_bus *bus);
 411
 412 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
 413
 414 #define bus_assert_return(expr, r, error)                               \
 415         do {                                                            \
 416                 if (!assert_log(expr, #expr))                           \
 417                         return sd_bus_error_set_errno(error, r);        \
 418         } while (false)
 419
 420 void bus_enter_closing(sd_bus *bus);
 421
 422 void bus_set_state(sd_bus *bus, enum bus_state state);