src/libsystemd/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 <sys/un.h>
  26 #include <netinet/in.h>
  27 #include <pthread.h>
  28
  29 #include "hashmap.h"
  30 #include "prioq.h"
  31 #include "list.h"
  32 #include "util.h"
  33 #include "refcnt.h"
  34
  35 #include "sd-bus.h"
  36 #include "bus-error.h"
  37 #include "bus-match.h"
  38 #include "bus-kernel.h"
  39 #include "kdbus.h"
  40
  41 struct reply_callback {
  42         sd_bus_message_handler_t callback;
  43         usec_t timeout;
  44         uint64_t cookie;
  45         unsigned prioq_idx;
  46 };
  47
  48 struct filter_callback {
  49         sd_bus_message_handler_t callback;
  50
  51         unsigned last_iteration;
  52
  53         LIST_FIELDS(struct filter_callback, callbacks);
  54 };
  55
  56 struct match_callback {
  57         sd_bus_message_handler_t callback;
  58
  59         uint64_t cookie;
  60         unsigned last_iteration;
  61
  62         char *match_string;
  63
  64         struct bus_match_node *match_node;
  65 };
  66
  67 struct node {
  68         char *path;
  69         struct node *parent;
  70         LIST_HEAD(struct node, child);
  71         LIST_FIELDS(struct node, siblings);
  72
  73         LIST_HEAD(struct node_callback, callbacks);
  74         LIST_HEAD(struct node_vtable, vtables);
  75         LIST_HEAD(struct node_enumerator, enumerators);
  76         LIST_HEAD(struct node_object_manager, object_managers);
  77 };
  78
  79 struct node_callback {
  80         struct node *node;
  81
  82         bool is_fallback;
  83         sd_bus_message_handler_t callback;
  84
  85         unsigned last_iteration;
  86
  87         LIST_FIELDS(struct node_callback, callbacks);
  88 };
  89
  90 struct node_enumerator {
  91         struct node *node;
  92
  93         sd_bus_node_enumerator_t callback;
  94
  95         unsigned last_iteration;
  96
  97         LIST_FIELDS(struct node_enumerator, enumerators);
  98 };
  99
 100 struct node_object_manager {
 101         struct node *node;
 102
 103         LIST_FIELDS(struct node_object_manager, object_managers);
 104 };
 105
 106 struct node_vtable {
 107         struct node *node;
 108
 109         char *interface;
 110         bool is_fallback;
 111         const sd_bus_vtable *vtable;
 112         sd_bus_object_find_t find;
 113
 114         unsigned last_iteration;
 115
 116         LIST_FIELDS(struct node_vtable, vtables);
 117 };
 118
 119 struct vtable_member {
 120         const char *path;
 121         const char *interface;
 122         const char *member;
 123         struct node_vtable *parent;
 124         unsigned last_iteration;
 125         const sd_bus_vtable *vtable;
 126 };
 127
 128 typedef enum BusSlotType {
 129         BUS_REPLY_CALLBACK,
 130         BUS_FILTER_CALLBACK,
 131         BUS_MATCH_CALLBACK,
 132         BUS_NODE_CALLBACK,
 133         BUS_NODE_ENUMERATOR,
 134         BUS_NODE_VTABLE,
 135         BUS_NODE_OBJECT_MANAGER,
 136         _BUS_SLOT_INVALID = -1,
 137 } BusSlotType;
 138
 139 struct sd_bus_slot {
 140         unsigned n_ref;
 141         sd_bus *bus;
 142         void *userdata;
 143         BusSlotType type:5;
 144         bool floating:1;
 145         char *description;
 146
 147         LIST_FIELDS(sd_bus_slot, slots);
 148
 149         union {
 150                 struct reply_callback reply_callback;
 151                 struct filter_callback filter_callback;
 152                 struct match_callback match_callback;
 153                 struct node_callback node_callback;
 154                 struct node_enumerator node_enumerator;
 155                 struct node_object_manager node_object_manager;
 156                 struct node_vtable node_vtable;
 157         };
 158 };
 159
 160 enum bus_state {
 161         BUS_UNSET,
 162         BUS_OPENING,
 163         BUS_AUTHENTICATING,
 164         BUS_HELLO,
 165         BUS_RUNNING,
 166         BUS_CLOSING,
 167         BUS_CLOSED
 168 };
 169
 170 static inline bool BUS_IS_OPEN(enum bus_state state) {
 171         return state > BUS_UNSET && state < BUS_CLOSING;
 172 }
 173
 174 enum bus_auth {
 175         _BUS_AUTH_INVALID,
 176         BUS_AUTH_EXTERNAL,
 177         BUS_AUTH_ANONYMOUS
 178 };
 179
 180 struct sd_bus {
 181         /* We use atomic ref counting here since sd_bus_message
 182            objects retain references to their originating sd_bus but
 183            we want to allow them to be processed in a different
 184            thread. We won't provide full thread safety, but only the
 185            bare minimum that makes it possible to use sd_bus and
 186            sd_bus_message objects independently and on different
 187            threads as long as each object is used only once at the
 188            same time. */
 189         RefCount n_ref;
 190
 191         enum bus_state state;
 192         int input_fd, output_fd;
 193         int message_version;
 194         int message_endian;
 195
 196         bool is_kernel:1;
 197         bool can_fds:1;
 198         bool bus_client:1;
 199         bool ucred_valid:1;
 200         bool is_server:1;
 201         bool anonymous_auth:1;
 202         bool prefer_readv:1;
 203         bool prefer_writev:1;
 204         bool match_callbacks_modified:1;
 205         bool filter_callbacks_modified:1;
 206         bool nodes_modified:1;
 207         bool trusted:1;
 208         bool fake_creds_valid:1;
 209         bool manual_peer_interface:1;
 210         bool is_system:1;
 211         bool is_user:1;
 212
 213         int use_memfd;
 214
 215         void *rbuffer;
 216         size_t rbuffer_size;
 217
 218         sd_bus_message **rqueue;
 219         unsigned rqueue_size;
 220         size_t rqueue_allocated;
 221
 222         sd_bus_message **wqueue;
 223         unsigned wqueue_size;
 224         size_t windex;
 225         size_t wqueue_allocated;
 226
 227         uint64_t cookie;
 228
 229         char *unique_name;
 230         uint64_t unique_id;
 231
 232         struct bus_match_node match_callbacks;
 233         Prioq *reply_callbacks_prioq;
 234         OrderedHashmap *reply_callbacks;
 235         LIST_HEAD(struct filter_callback, filter_callbacks);
 236
 237         Hashmap *nodes;
 238         Hashmap *vtable_methods;
 239         Hashmap *vtable_properties;
 240
 241         union sockaddr_union sockaddr;
 242         socklen_t sockaddr_size;
 243
 244         char *kernel;
 245         char *machine;
 246
 247         sd_id128_t server_id;
 248
 249         char *address;
 250         unsigned address_index;
 251
 252         int last_connect_error;
 253
 254         enum bus_auth auth;
 255         size_t auth_rbegin;
 256         struct iovec auth_iovec[3];
 257         unsigned auth_index;
 258         char *auth_buffer;
 259         usec_t auth_timeout;
 260
 261         struct ucred ucred;
 262         char label[NAME_MAX];
 263
 264         uint64_t creds_mask;
 265
 266         int *fds;
 267         unsigned n_fds;
 268
 269         char *exec_path;
 270         char **exec_argv;
 271
 272         unsigned iteration_counter;
 273
 274         void *kdbus_buffer;
 275
 276         /* We do locking around the memfd cache, since we want to
 277          * allow people to process a sd_bus_message in a different
 278          * thread then it was generated on and free it there. Since
 279          * adding something to the memfd cache might happen when a
 280          * message is released, we hence need to protect this bit with
 281          * a mutex. */
 282         pthread_mutex_t memfd_cache_mutex;
 283         struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
 284         unsigned n_memfd_cache;
 285
 286         pid_t original_pid;
 287
 288         uint64_t hello_flags;
 289         uint64_t attach_flags;
 290
 291         uint64_t match_cookie;
 292
 293         sd_event_source *input_io_event_source;
 294         sd_event_source *output_io_event_source;
 295         sd_event_source *time_event_source;
 296         sd_event_source *quit_event_source;
 297         sd_event *event;
 298         int event_priority;
 299
 300         sd_bus_message *current_message;
 301         sd_bus_slot *current_slot;
 302         sd_bus_message_handler_t current_handler;
 303         void *current_userdata;
 304
 305         sd_bus **default_bus_ptr;
 306         pid_t tid;
 307
 308         struct kdbus_creds fake_creds;
 309         char *fake_label;
 310
 311         char *cgroup_root;
 312
 313         char *description;
 314
 315         size_t bloom_size;
 316         unsigned bloom_n_hash;
 317
 318         sd_bus_track *track_queue;
 319
 320         LIST_HEAD(sd_bus_slot, slots);
 321 };
 322
 323 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 324
 325 #define BUS_WQUEUE_MAX 1024
 326 #define BUS_RQUEUE_MAX 64*1024
 327
 328 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
 329 #define BUS_AUTH_SIZE_MAX (64*1024)
 330
 331 #define BUS_CONTAINER_DEPTH 128
 332
 333 /* Defined by the specification as maximum size of an array in
 334  * bytes */
 335 #define BUS_ARRAY_MAX_SIZE 67108864
 336
 337 #define BUS_FDS_MAX 1024
 338
 339 #define BUS_EXEC_ARGV_MAX 256
 340
 341 bool interface_name_is_valid(const char *p) _pure_;
 342 bool service_name_is_valid(const char *p) _pure_;
 343 char* service_name_startswith(const char *a, const char *b);
 344 bool member_name_is_valid(const char *p) _pure_;
 345 bool object_path_is_valid(const char *p) _pure_;
 346 char *object_path_startswith(const char *a, const char *b) _pure_;
 347
 348 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
 349 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
 350
 351 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
 352 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
 353
 354 int bus_message_type_from_string(const char *s, uint8_t *u) _pure_;
 355 const char *bus_message_type_to_string(uint8_t u) _pure_;
 356
 357 #define error_name_is_valid interface_name_is_valid
 358
 359 int bus_ensure_running(sd_bus *bus);
 360 int bus_start_running(sd_bus *bus);
 361 int bus_next_address(sd_bus *bus);
 362
 363 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
 364
 365 int bus_rqueue_make_room(sd_bus *bus);
 366
 367 bool bus_pid_changed(sd_bus *bus);
 368
 369 char *bus_address_escape(const char *v);
 370
 371 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path)                        \
 372         for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
 373              _slash && !(_slash[(_slash) == (prefix)] = 0);             \
 374              _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
 375
 376 /* If we are invoking callbacks of a bus object, ensure unreffing the
 377  * bus from the callback doesn't destroy the object we are working
 378  * on */
 379 #define BUS_DONT_DESTROY(bus) \
 380         _cleanup_bus_unref_ _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
 381
 382 int bus_set_address_system(sd_bus *bus);
 383 int bus_set_address_user(sd_bus *bus);
 384 int bus_set_address_system_remote(sd_bus *b, const char *host);
 385 int bus_set_address_system_container(sd_bus *b, const char *machine);
 386
 387 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 388
 389 int bus_get_root_path(sd_bus *bus);