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   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <pthread.h>
  24 #include <sys/socket.h>
  25
  26 #include "sd-bus.h"
  27
  28 #include "bus-error.h"
  29 #include "bus-kernel.h"
  30 #include "bus-match.h"
  31 #include "def.h"
  32 #include "hashmap.h"
  33 #include "list.h"
  34 #include "prioq.h"
  35 #include "refcnt.h"
  36 #include "socket-util.h"
  37 #include "util.h"
  38
  39 struct reply_callback {
  40         sd_bus_message_handler_t callback;
  41         usec_t timeout_usec; /* this is a relative timeout until we reach the BUS_HELLO state, and an absolute one right after */
  42         uint64_t cookie;
  43         unsigned prioq_idx;
  44 };
  45
  46 struct filter_callback {
  47         sd_bus_message_handler_t callback;
  48
  49         unsigned last_iteration;
  50
  51         LIST_FIELDS(struct filter_callback, callbacks);
  52 };
  53
  54 struct match_callback {
  55         sd_bus_message_handler_t callback;
  56
  57         unsigned last_iteration;
  58
  59         char *match_string;
  60
  61         struct bus_match_node *match_node;
  62 };
  63
  64 struct node {
  65         char *path;
  66         struct node *parent;
  67         LIST_HEAD(struct node, child);
  68         LIST_FIELDS(struct node, siblings);
  69
  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);
  74 };
  75
  76 struct node_callback {
  77         struct node *node;
  78
  79         bool is_fallback;
  80         sd_bus_message_handler_t callback;
  81
  82         unsigned last_iteration;
  83
  84         LIST_FIELDS(struct node_callback, callbacks);
  85 };
  86
  87 struct node_enumerator {
  88         struct node *node;
  89
  90         sd_bus_node_enumerator_t callback;
  91
  92         unsigned last_iteration;
  93
  94         LIST_FIELDS(struct node_enumerator, enumerators);
  95 };
  96
  97 struct node_object_manager {
  98         struct node *node;
  99
 100         LIST_FIELDS(struct node_object_manager, object_managers);
 101 };
 102
 103 struct node_vtable {
 104         struct node *node;
 105
 106         char *interface;
 107         bool is_fallback;
 108         const sd_bus_vtable *vtable;
 109         sd_bus_object_find_t find;
 110
 111         unsigned last_iteration;
 112
 113         LIST_FIELDS(struct node_vtable, vtables);
 114 };
 115
 116 struct vtable_member {
 117         const char *path;
 118         const char *interface;
 119         const char *member;
 120         struct node_vtable *parent;
 121         unsigned last_iteration;
 122         const sd_bus_vtable *vtable;
 123 };
 124
 125 typedef enum BusSlotType {
 126         BUS_REPLY_CALLBACK,
 127         BUS_FILTER_CALLBACK,
 128         BUS_MATCH_CALLBACK,
 129         BUS_NODE_CALLBACK,
 130         BUS_NODE_ENUMERATOR,
 131         BUS_NODE_VTABLE,
 132         BUS_NODE_OBJECT_MANAGER,
 133         _BUS_SLOT_INVALID = -1,
 134 } BusSlotType;
 135
 136 struct sd_bus_slot {
 137         unsigned n_ref;
 138         sd_bus *bus;
 139         void *userdata;
 140         BusSlotType type:5;
 141         bool floating:1;
 142         bool match_added:1;
 143         char *description;
 144
 145         LIST_FIELDS(sd_bus_slot, slots);
 146
 147         union {
 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;
 155         };
 156 };
 157
 158 enum bus_state {
 159         BUS_UNSET,
 160         BUS_WATCH_BIND,      /* waiting for the socket to appear via inotify */
 161         BUS_OPENING,         /* the kernel's connect() is still not ready */
 162         BUS_AUTHENTICATING,  /* we are currently in the "SASL" authorization phase of dbus */
 163         BUS_HELLO,           /* we are waiting for the Hello() response */
 164         BUS_RUNNING,
 165         BUS_CLOSING,
 166         BUS_CLOSED
 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
 220         int use_memfd;
 221
 222         void *rbuffer;
 223         size_t rbuffer_size;
 224
 225         sd_bus_message **rqueue;
 226         unsigned rqueue_size;
 227         size_t rqueue_allocated;
 228
 229         sd_bus_message **wqueue;
 230         unsigned wqueue_size;
 231         size_t windex;
 232         size_t wqueue_allocated;
 233
 234         uint64_t cookie;
 235
 236         char *unique_name;
 237         uint64_t unique_id;
 238
 239         struct bus_match_node match_callbacks;
 240         Prioq *reply_callbacks_prioq;
 241         OrderedHashmap *reply_callbacks;
 242         LIST_HEAD(struct filter_callback, filter_callbacks);
 243
 244         Hashmap *nodes;
 245         Hashmap *vtable_methods;
 246         Hashmap *vtable_properties;
 247
 248         union sockaddr_union sockaddr;
 249         socklen_t sockaddr_size;
 250
 251         char *machine;
 252         pid_t nspid;
 253
 254         sd_id128_t server_id;
 255
 256         char *address;
 257         unsigned address_index;
 258
 259         int last_connect_error;
 260
 261         enum bus_auth auth;
 262         size_t auth_rbegin;
 263         struct iovec auth_iovec[3];
 264         unsigned auth_index;
 265         char *auth_buffer;
 266         usec_t auth_timeout;
 267
 268         struct ucred ucred;
 269         char *label;
 270         gid_t *groups;
 271         size_t n_groups;
 272
 273         uint64_t creds_mask;
 274
 275         int *fds;
 276         unsigned n_fds;
 277
 278         char *exec_path;
 279         char **exec_argv;
 280
 281         unsigned iteration_counter;
 282
 283         /* We do locking around the memfd cache, since we want to
 284          * allow people to process a sd_bus_message in a different
 285          * thread then it was generated on and free it there. Since
 286          * adding something to the memfd cache might happen when a
 287          * message is released, we hence need to protect this bit with
 288          * a mutex. */
 289         pthread_mutex_t memfd_cache_mutex;
 290         struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
 291         unsigned n_memfd_cache;
 292
 293         pid_t original_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
 315         sd_bus_track *track_queue;
 316
 317         LIST_HEAD(sd_bus_slot, slots);
 318         LIST_HEAD(sd_bus_track, tracks);
 319
 320         int *inotify_watches;
 321         size_t n_inotify_watches;
 322 };
 323
 324 /* For method calls we time-out at 25s, like in the D-Bus reference implementation */
 325 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 326
 327 /* For the authentication phase we grant 90s, to provide extra room during boot, when RNGs and such are not filled up
 328  * with enough entropy yet and might delay the boot */
 329 #define BUS_AUTH_TIMEOUT ((usec_t) DEFAULT_TIMEOUT_USEC)
 330
 331 #define BUS_WQUEUE_MAX (192*1024)
 332 #define BUS_RQUEUE_MAX (192*1024)
 333
 334 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
 335 #define BUS_AUTH_SIZE_MAX (64*1024)
 336
 337 #define BUS_CONTAINER_DEPTH 128
 338
 339 /* Defined by the specification as maximum size of an array in
 340  * bytes */
 341 #define BUS_ARRAY_MAX_SIZE 67108864
 342
 343 #define BUS_FDS_MAX 1024
 344
 345 #define BUS_EXEC_ARGV_MAX 256
 346
 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);
 351 #endif // 0
 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_;
 355
 356 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
 357 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
 358
 359 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
 360 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
 361
 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_;
 364
 365 #define error_name_is_valid interface_name_is_valid
 366
 367 int bus_ensure_running(sd_bus *bus);
 368 int bus_start_running(sd_bus *bus);
 369 int bus_next_address(sd_bus *bus);
 370
 371 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
 372
 373 int bus_rqueue_make_room(sd_bus *bus);
 374
 375 bool bus_pid_changed(sd_bus *bus);
 376
 377 char *bus_address_escape(const char *v);
 378
 379 int bus_attach_io_events(sd_bus *b);
 380 int bus_attach_inotify_event(sd_bus *b);
 381
 382 void bus_close_inotify_fd(sd_bus *b);
 383 void bus_close_io_fds(sd_bus *b);
 384
 385 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path)                        \
 386         for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
 387              _slash && !(_slash[(_slash) == (prefix)] = 0);             \
 388              _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
 389
 390 /* If we are invoking callbacks of a bus object, ensure unreffing the
 391  * bus from the callback doesn't destroy the object we are working
 392  * on */
 393 #define BUS_DONT_DESTROY(bus) \
 394         _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
 395
 396 int bus_set_address_system(sd_bus *bus);
 397 #if 0 /// UNNEEDED by elogind
 398 int bus_set_address_user(sd_bus *bus);
 399 #endif // 0
 400 int bus_set_address_system_remote(sd_bus *b, const char *host);
 401 int bus_set_address_system_machine(sd_bus *b, const char *machine);
 402
 403 #if 0 /// UNNEEDED by elogind
 404 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 405 #endif // 0
 406
 407 int bus_get_root_path(sd_bus *bus);
 408
 409 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
 410
 411 #define bus_assert_return(expr, r, error)                               \
 412         do {                                                            \
 413                 if (!assert_log(expr, #expr))                           \
 414                         return sd_bus_error_set_errno(error, r);        \
 415         } while (false)
 416
 417 void bus_enter_closing(sd_bus *bus);