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

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2013 Lennart Poettering
   6 ***/
   7
   8 #include <pthread.h>
   9 #include <sys/socket.h>
  10
  11 #include "sd-bus.h"
  12
  13 #include "bus-error.h"
  14 #include "bus-kernel.h"
  15 #include "bus-match.h"
  16 #include "def.h"
  17 #include "hashmap.h"
  18 #include "list.h"
  19 #include "prioq.h"
  20 #include "refcnt.h"
  21 #include "socket-util.h"
  22 #include "util.h"
  23
  24 struct reply_callback {
  25         sd_bus_message_handler_t callback;
  26         usec_t timeout_usec; /* this is a relative timeout until we reach the BUS_HELLO state, and an absolute one right after */
  27         uint64_t cookie;
  28         unsigned prioq_idx;
  29 };
  30
  31 struct filter_callback {
  32         sd_bus_message_handler_t callback;
  33
  34         unsigned last_iteration;
  35
  36         LIST_FIELDS(struct filter_callback, callbacks);
  37 };
  38
  39 struct match_callback {
  40         sd_bus_message_handler_t callback;
  41         sd_bus_message_handler_t install_callback;
  42
  43         sd_bus_slot *install_slot; /* The AddMatch() call */
  44
  45         unsigned last_iteration;
  46
  47         char *match_string;
  48
  49         struct bus_match_node *match_node;
  50 };
  51
  52 struct node {
  53         char *path;
  54         struct node *parent;
  55         LIST_HEAD(struct node, child);
  56         LIST_FIELDS(struct node, siblings);
  57
  58         LIST_HEAD(struct node_callback, callbacks);
  59         LIST_HEAD(struct node_vtable, vtables);
  60         LIST_HEAD(struct node_enumerator, enumerators);
  61         LIST_HEAD(struct node_object_manager, object_managers);
  62 };
  63
  64 struct node_callback {
  65         struct node *node;
  66
  67         bool is_fallback;
  68         sd_bus_message_handler_t callback;
  69
  70         unsigned last_iteration;
  71
  72         LIST_FIELDS(struct node_callback, callbacks);
  73 };
  74
  75 struct node_enumerator {
  76         struct node *node;
  77
  78         sd_bus_node_enumerator_t callback;
  79
  80         unsigned last_iteration;
  81
  82         LIST_FIELDS(struct node_enumerator, enumerators);
  83 };
  84
  85 struct node_object_manager {
  86         struct node *node;
  87
  88         LIST_FIELDS(struct node_object_manager, object_managers);
  89 };
  90
  91 struct node_vtable {
  92         struct node *node;
  93
  94         char *interface;
  95         bool is_fallback;
  96         const sd_bus_vtable *vtable;
  97         sd_bus_object_find_t find;
  98
  99         unsigned last_iteration;
 100
 101         LIST_FIELDS(struct node_vtable, vtables);
 102 };
 103
 104 struct vtable_member {
 105         const char *path;
 106         const char *interface;
 107         const char *member;
 108         struct node_vtable *parent;
 109         unsigned last_iteration;
 110         const sd_bus_vtable *vtable;
 111 };
 112
 113 typedef enum BusSlotType {
 114         BUS_REPLY_CALLBACK,
 115         BUS_FILTER_CALLBACK,
 116         BUS_MATCH_CALLBACK,
 117         BUS_NODE_CALLBACK,
 118         BUS_NODE_ENUMERATOR,
 119         BUS_NODE_VTABLE,
 120         BUS_NODE_OBJECT_MANAGER,
 121         _BUS_SLOT_INVALID = -1,
 122 } BusSlotType;
 123
 124 struct sd_bus_slot {
 125         unsigned n_ref;
 126         sd_bus *bus;
 127         void *userdata;
 128         sd_bus_destroy_t destroy_callback;
 129         BusSlotType type:5;
 130
 131         /* Slots can be "floating" or not. If they are not floating (the usual case) then they reference the bus object
 132          * they are associated with. This means the bus object stays allocated at least as long as there is a slot
 133          * around associated with it. If it is floating, then the slot's lifecycle is bound to the lifecycle of the
 134          * bus: it will be disconnected from the bus when the bus is destroyed, and it keeping the slot reffed hence
 135          * won't mean the bus stays reffed too. Internally this means the reference direction is reversed: floating
 136          * slots objects are referenced by the bus object, and not vice versa. */
 137         bool floating:1;
 138
 139         bool match_added:1;
 140         char *description;
 141
 142         LIST_FIELDS(sd_bus_slot, slots);
 143
 144         union {
 145                 struct reply_callback reply_callback;
 146                 struct filter_callback filter_callback;
 147                 struct match_callback match_callback;
 148                 struct node_callback node_callback;
 149                 struct node_enumerator node_enumerator;
 150                 struct node_object_manager node_object_manager;
 151                 struct node_vtable node_vtable;
 152         };
 153 };
 154
 155 enum bus_state {
 156         BUS_UNSET,
 157         BUS_WATCH_BIND,      /* waiting for the socket to appear via inotify */
 158         BUS_OPENING,         /* the kernel's connect() is still not ready */
 159         BUS_AUTHENTICATING,  /* we are currently in the "SASL" authorization phase of dbus */
 160         BUS_HELLO,           /* we are waiting for the Hello() response */
 161         BUS_RUNNING,
 162         BUS_CLOSING,
 163         BUS_CLOSED,
 164         _BUS_STATE_MAX,
 165 };
 166
 167 static inline bool BUS_IS_OPEN(enum bus_state state) {
 168         return state > BUS_UNSET && state < BUS_CLOSING;
 169 }
 170
 171 enum bus_auth {
 172         _BUS_AUTH_INVALID,
 173         BUS_AUTH_EXTERNAL,
 174         BUS_AUTH_ANONYMOUS
 175 };
 176
 177 struct sd_bus {
 178         /* We use atomic ref counting here since sd_bus_message
 179            objects retain references to their originating sd_bus but
 180            we want to allow them to be processed in a different
 181            thread. We won't provide full thread safety, but only the
 182            bare minimum that makes it possible to use sd_bus and
 183            sd_bus_message objects independently and on different
 184            threads as long as each object is used only once at the
 185            same time. */
 186         RefCount n_ref;
 187
 188         enum bus_state state;
 189         int input_fd, output_fd;
 190         int inotify_fd;
 191         int message_version;
 192         int message_endian;
 193
 194         bool can_fds:1;
 195         bool bus_client:1;
 196         bool ucred_valid:1;
 197         bool is_server:1;
 198         bool anonymous_auth:1;
 199         bool prefer_readv:1;
 200         bool prefer_writev:1;
 201         bool match_callbacks_modified:1;
 202         bool filter_callbacks_modified:1;
 203         bool nodes_modified:1;
 204         bool trusted:1;
 205         bool manual_peer_interface:1;
 206         bool is_system:1;
 207         bool is_user:1;
 208         bool allow_interactive_authorization:1;
 209         bool exit_on_disconnect:1;
 210         bool exited:1;
 211         bool exit_triggered:1;
 212         bool is_local:1;
 213         bool watch_bind:1;
 214         bool is_monitor:1;
 215         bool accept_fd:1;
 216         bool attach_timestamp:1;
 217         bool connected_signal:1;
 218
 219         int use_memfd;
 220
 221         void *rbuffer;
 222         size_t rbuffer_size;
 223
 224         sd_bus_message **rqueue;
 225         unsigned rqueue_size;
 226         size_t rqueue_allocated;
 227
 228         sd_bus_message **wqueue;
 229         unsigned wqueue_size;
 230         size_t windex;
 231         size_t wqueue_allocated;
 232
 233         uint64_t cookie;
 234
 235         char *unique_name;
 236         uint64_t unique_id;
 237
 238         struct bus_match_node match_callbacks;
 239         Prioq *reply_callbacks_prioq;
 240         OrderedHashmap *reply_callbacks;
 241         LIST_HEAD(struct filter_callback, filter_callbacks);
 242
 243         Hashmap *nodes;
 244         Hashmap *vtable_methods;
 245         Hashmap *vtable_properties;
 246
 247         union sockaddr_union sockaddr;
 248         socklen_t sockaddr_size;
 249
 250         char *machine;
 251         pid_t nspid;
 252
 253         sd_id128_t server_id;
 254
 255         char *address;
 256         unsigned address_index;
 257
 258         int last_connect_error;
 259
 260         enum bus_auth auth;
 261         size_t auth_rbegin;
 262         struct iovec auth_iovec[3];
 263         unsigned auth_index;
 264         char *auth_buffer;
 265         usec_t auth_timeout;
 266
 267         struct ucred ucred;
 268         char *label;
 269         gid_t *groups;
 270         size_t n_groups;
 271
 272         uint64_t creds_mask;
 273
 274         int *fds;
 275         size_t n_fds;
 276
 277         char *exec_path;
 278         char **exec_argv;
 279
 280         unsigned iteration_counter;
 281
 282         /* We do locking around the memfd cache, since we want to
 283          * allow people to process a sd_bus_message in a different
 284          * thread then it was generated on and free it there. Since
 285          * adding something to the memfd cache might happen when a
 286          * message is released, we hence need to protect this bit with
 287          * a mutex. */
 288         pthread_mutex_t memfd_cache_mutex;
 289         struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
 290         unsigned n_memfd_cache;
 291
 292         pid_t original_pid;
 293         pid_t busexec_pid;
 294
 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;
 299         sd_event_source *inotify_event_source;
 300         sd_event *event;
 301         int event_priority;
 302
 303         sd_bus_message *current_message;
 304         sd_bus_slot *current_slot;
 305         sd_bus_message_handler_t current_handler;
 306         void *current_userdata;
 307
 308         sd_bus **default_bus_ptr;
 309         pid_t tid;
 310
 311         char *cgroup_root;
 312
 313         char *description;
 314         char *patch_sender;
 315
 316         sd_bus_track *track_queue;
 317
 318         LIST_HEAD(sd_bus_slot, slots);
 319         LIST_HEAD(sd_bus_track, tracks);
 320
 321         int *inotify_watches;
 322         size_t n_inotify_watches;
 323 };
 324
 325 /* For method calls we time-out at 25s, like in the D-Bus reference implementation */
 326 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 327
 328 /* For the authentication phase we grant 90s, to provide extra room during boot, when RNGs and such are not filled up
 329  * with enough entropy yet and might delay the boot */
 330 #define BUS_AUTH_TIMEOUT ((usec_t) DEFAULT_TIMEOUT_USEC)
 331
 332 #define BUS_WQUEUE_MAX (192*1024)
 333 #define BUS_RQUEUE_MAX (192*1024)
 334
 335 #define BUS_MESSAGE_SIZE_MAX (128*1024*1024)
 336 #define BUS_AUTH_SIZE_MAX (64*1024)
 337
 338 #define BUS_CONTAINER_DEPTH 128
 339
 340 /* Defined by the specification as maximum size of an array in
 341  * bytes */
 342 #define BUS_ARRAY_MAX_SIZE 67108864
 343
 344 #define BUS_FDS_MAX 1024
 345
 346 #define BUS_EXEC_ARGV_MAX 256
 347
 348 bool interface_name_is_valid(const char *p) _pure_;
 349 bool service_name_is_valid(const char *p) _pure_;
 350 #if 0 /// UNNEEDED by elogind
 351 char* service_name_startswith(const char *a, const char *b);
 352 #endif // 0
 353 bool member_name_is_valid(const char *p) _pure_;
 354 bool object_path_is_valid(const char *p) _pure_;
 355 char *object_path_startswith(const char *a, const char *b) _pure_;
 356
 357 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
 358 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
 359
 360 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
 361 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
 362
 363 int bus_message_type_from_string(const char *s, uint8_t *u) _pure_;
 364 const char *bus_message_type_to_string(uint8_t u) _pure_;
 365
 366 #define error_name_is_valid interface_name_is_valid
 367
 368 sd_bus *bus_resolve(sd_bus *bus);
 369
 370 int bus_ensure_running(sd_bus *bus);
 371 int bus_start_running(sd_bus *bus);
 372 int bus_next_address(sd_bus *bus);
 373
 374 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
 375
 376 int bus_rqueue_make_room(sd_bus *bus);
 377
 378 bool bus_pid_changed(sd_bus *bus);
 379
 380 char *bus_address_escape(const char *v);
 381
 382 int bus_attach_io_events(sd_bus *b);
 383 int bus_attach_inotify_event(sd_bus *b);
 384
 385 void bus_close_inotify_fd(sd_bus *b);
 386 void bus_close_io_fds(sd_bus *b);
 387
 388 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path)                        \
 389         for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
 390              _slash && !(_slash[(_slash) == (prefix)] = 0);             \
 391              _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
 392
 393 /* If we are invoking callbacks of a bus object, ensure unreffing the
 394  * bus from the callback doesn't destroy the object we are working
 395  * on */
 396 #define BUS_DONT_DESTROY(bus) \
 397         _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
 398
 399 int bus_set_address_system(sd_bus *bus);
 400 #if 0 /// UNNEEDED by elogind
 401 int bus_set_address_user(sd_bus *bus);
 402 #endif // 0
 403 int bus_set_address_system_remote(sd_bus *b, const char *host);
 404 int bus_set_address_system_machine(sd_bus *b, const char *machine);
 405
 406 #if 0 /// UNNEEDED by elogind
 407 #endif // 0
 408 int bus_get_root_path(sd_bus *bus);
 409
 410 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
 411
 412 #define bus_assert_return(expr, r, error)                               \
 413         do {                                                            \
 414                 if (!assert_log(expr, #expr))                           \
 415                         return sd_bus_error_set_errno(error, r);        \
 416         } while (false)
 417
 418 void bus_enter_closing(sd_bus *bus);
 419
 420 void bus_set_state(sd_bus *bus, enum bus_state state);