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

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2013 Lennart Poettering
   9
  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.
  14
  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.
  19
  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/>.
  22 ***/
  23
  24 #include <sys/socket.h>
  25 #include <pthread.h>
  26
  27 #include "hashmap.h"
  28 #include "prioq.h"
  29 #include "list.h"
  30 #include "util.h"
  31 #include "refcnt.h"
  32 #include "socket-util.h"
  33
  34 #include "sd-bus.h"
  35 #include "bus-error.h"
  36 #include "bus-match.h"
  37 #include "bus-kernel.h"
  38 #include "kdbus.h"
  39
  40 struct reply_callback {
  41         sd_bus_message_handler_t callback;
  42         usec_t timeout;
  43         uint64_t cookie;
  44         unsigned prioq_idx;
  45 };
  46
  47 struct filter_callback {
  48         sd_bus_message_handler_t callback;
  49
  50         unsigned last_iteration;
  51
  52         LIST_FIELDS(struct filter_callback, callbacks);
  53 };
  54
  55 struct match_callback {
  56         sd_bus_message_handler_t callback;
  57
  58         uint64_t cookie;
  59         unsigned last_iteration;
  60
  61         char *match_string;
  62
  63         struct bus_match_node *match_node;
  64 };
  65
  66 struct node {
  67         char *path;
  68         struct node *parent;
  69         LIST_HEAD(struct node, child);
  70         LIST_FIELDS(struct node, siblings);
  71
  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);
  76 };
  77
  78 struct node_callback {
  79         struct node *node;
  80
  81         bool is_fallback;
  82         sd_bus_message_handler_t callback;
  83
  84         unsigned last_iteration;
  85
  86         LIST_FIELDS(struct node_callback, callbacks);
  87 };
  88
  89 struct node_enumerator {
  90         struct node *node;
  91
  92         sd_bus_node_enumerator_t callback;
  93
  94         unsigned last_iteration;
  95
  96         LIST_FIELDS(struct node_enumerator, enumerators);
  97 };
  98
  99 struct node_object_manager {
 100         struct node *node;
 101
 102         LIST_FIELDS(struct node_object_manager, object_managers);
 103 };
 104
 105 struct node_vtable {
 106         struct node *node;
 107
 108         char *interface;
 109         bool is_fallback;
 110         const sd_bus_vtable *vtable;
 111         sd_bus_object_find_t find;
 112
 113         unsigned last_iteration;
 114
 115         LIST_FIELDS(struct node_vtable, vtables);
 116 };
 117
 118 struct vtable_member {
 119         const char *path;
 120         const char *interface;
 121         const char *member;
 122         struct node_vtable *parent;
 123         unsigned last_iteration;
 124         const sd_bus_vtable *vtable;
 125 };
 126
 127 typedef enum BusSlotType {
 128         BUS_REPLY_CALLBACK,
 129         BUS_FILTER_CALLBACK,
 130         BUS_MATCH_CALLBACK,
 131         BUS_NODE_CALLBACK,
 132         BUS_NODE_ENUMERATOR,
 133         BUS_NODE_VTABLE,
 134         BUS_NODE_OBJECT_MANAGER,
 135         _BUS_SLOT_INVALID = -1,
 136 } BusSlotType;
 137
 138 struct sd_bus_slot {
 139         unsigned n_ref;
 140         sd_bus *bus;
 141         void *userdata;
 142         BusSlotType type:5;
 143         bool floating:1;
 144         char *description;
 145
 146         LIST_FIELDS(sd_bus_slot, slots);
 147
 148         union {
 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;
 156         };
 157 };
 158
 159 enum bus_state {
 160         BUS_UNSET,
 161         BUS_OPENING,
 162         BUS_AUTHENTICATING,
 163         BUS_HELLO,
 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 message_version;
 193         int message_endian;
 194
 195         bool is_kernel:1;
 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 fake_creds_valid:1;
 208         bool fake_pids_valid:1;
 209         bool manual_peer_interface:1;
 210         bool is_system:1;
 211         bool is_user:1;
 212         bool allow_interactive_authorization:1;
 213
 214         int use_memfd;
 215
 216         void *rbuffer;
 217         size_t rbuffer_size;
 218
 219         sd_bus_message **rqueue;
 220         unsigned rqueue_size;
 221         size_t rqueue_allocated;
 222
 223         sd_bus_message **wqueue;
 224         unsigned wqueue_size;
 225         size_t windex;
 226         size_t wqueue_allocated;
 227
 228         uint64_t cookie;
 229
 230         char *unique_name;
 231         uint64_t unique_id;
 232
 233         struct bus_match_node match_callbacks;
 234         Prioq *reply_callbacks_prioq;
 235         OrderedHashmap *reply_callbacks;
 236         LIST_HEAD(struct filter_callback, filter_callbacks);
 237
 238         Hashmap *nodes;
 239         Hashmap *vtable_methods;
 240         Hashmap *vtable_properties;
 241
 242         union sockaddr_union sockaddr;
 243         socklen_t sockaddr_size;
 244
 245         char *kernel;
 246         char *machine;
 247         pid_t nspid;
 248
 249         sd_id128_t server_id;
 250
 251         char *address;
 252         unsigned address_index;
 253
 254         int last_connect_error;
 255
 256         enum bus_auth auth;
 257         size_t auth_rbegin;
 258         struct iovec auth_iovec[3];
 259         unsigned auth_index;
 260         char *auth_buffer;
 261         usec_t auth_timeout;
 262
 263         struct ucred ucred;
 264         char label[NAME_MAX];
 265
 266         uint64_t creds_mask;
 267
 268         int *fds;
 269         unsigned n_fds;
 270
 271         char *exec_path;
 272         char **exec_argv;
 273
 274         unsigned iteration_counter;
 275
 276         void *kdbus_buffer;
 277
 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
 283          * a mutex. */
 284         pthread_mutex_t memfd_cache_mutex;
 285         struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
 286         unsigned n_memfd_cache;
 287
 288         pid_t original_pid;
 289
 290         uint64_t hello_flags;
 291         uint64_t attach_flags;
 292
 293         uint64_t match_cookie;
 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 *event;
 300         int event_priority;
 301
 302         sd_bus_message *current_message;
 303         sd_bus_slot *current_slot;
 304         sd_bus_message_handler_t current_handler;
 305         void *current_userdata;
 306
 307         sd_bus **default_bus_ptr;
 308         pid_t tid;
 309
 310         struct kdbus_creds fake_creds;
 311         struct kdbus_pids fake_pids;
 312         char *fake_label;
 313
 314         char *cgroup_root;
 315
 316         char *description;
 317
 318         size_t bloom_size;
 319         unsigned bloom_n_hash;
 320
 321         sd_bus_track *track_queue;
 322
 323         LIST_HEAD(sd_bus_slot, slots);
 324 };
 325
 326 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 327
 328 #define BUS_WQUEUE_MAX 1024
 329 #define BUS_RQUEUE_MAX 64*1024
 330
 331 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
 332 #define BUS_AUTH_SIZE_MAX (64*1024)
 333
 334 #define BUS_CONTAINER_DEPTH 128
 335
 336 /* Defined by the specification as maximum size of an array in
 337  * bytes */
 338 #define BUS_ARRAY_MAX_SIZE 67108864
 339
 340 #define BUS_FDS_MAX 1024
 341
 342 #define BUS_EXEC_ARGV_MAX 256
 343
 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_;
 350
 351 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
 352 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
 353
 354 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
 355 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
 356
 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_;
 359
 360 #define error_name_is_valid interface_name_is_valid
 361
 362 int bus_ensure_running(sd_bus *bus);
 363 int bus_start_running(sd_bus *bus);
 364 int bus_next_address(sd_bus *bus);
 365
 366 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
 367
 368 int bus_rqueue_make_room(sd_bus *bus);
 369
 370 bool bus_pid_changed(sd_bus *bus);
 371
 372 char *bus_address_escape(const char *v);
 373
 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), '/'))
 378
 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
 381  * on */
 382 #define BUS_DONT_DESTROY(bus) \
 383         _cleanup_bus_unref_ _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
 384
 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);
 389
 390 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 391
 392 int bus_get_root_path(sd_bus *bus);