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_SLOT_DISCONNECTED,
 130         BUS_REPLY_CALLBACK,
 131         BUS_FILTER_CALLBACK,
 132         BUS_MATCH_CALLBACK,
 133         BUS_NODE_CALLBACK,
 134         BUS_NODE_ENUMERATOR,
 135         BUS_NODE_VTABLE,
 136         BUS_NODE_OBJECT_MANAGER,
 137 } BusSlotType;
 138
 139 struct sd_bus_slot {
 140         unsigned n_ref;
 141         sd_bus *bus;
 142         void *userdata;
 143         BusSlotType type;
 144         bool floating;
 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 manual_peer_interface:1;
 209         bool is_system:1;
 210         bool is_user:1;
 211
 212         int use_memfd;
 213
 214         void *rbuffer;
 215         size_t rbuffer_size;
 216
 217         sd_bus_message **rqueue;
 218         unsigned rqueue_size;
 219         size_t rqueue_allocated;
 220
 221         sd_bus_message **wqueue;
 222         unsigned wqueue_size;
 223         size_t windex;
 224         size_t wqueue_allocated;
 225
 226         uint64_t cookie;
 227
 228         char *unique_name;
 229         uint64_t unique_id;
 230
 231         struct bus_match_node match_callbacks;
 232         Prioq *reply_callbacks_prioq;
 233         Hashmap *reply_callbacks;
 234         LIST_HEAD(struct filter_callback, filter_callbacks);
 235
 236         Hashmap *nodes;
 237         Hashmap *vtable_methods;
 238         Hashmap *vtable_properties;
 239
 240         union {
 241                 struct sockaddr sa;
 242                 struct sockaddr_un un;
 243                 struct sockaddr_in in;
 244                 struct sockaddr_in6 in6;
 245         } sockaddr;
 246         socklen_t sockaddr_size;
 247
 248         char *kernel;
 249         char *machine;
 250
 251         sd_id128_t server_id;
 252
 253         char *address;
 254         unsigned address_index;
 255
 256         int last_connect_error;
 257
 258         enum bus_auth auth;
 259         size_t auth_rbegin;
 260         struct iovec auth_iovec[3];
 261         unsigned auth_index;
 262         char *auth_buffer;
 263         usec_t auth_timeout;
 264
 265         struct ucred ucred;
 266         char label[NAME_MAX];
 267
 268         uint64_t creds_mask;
 269
 270         int *fds;
 271         unsigned n_fds;
 272
 273         char *exec_path;
 274         char **exec_argv;
 275
 276         unsigned iteration_counter;
 277
 278         void *kdbus_buffer;
 279
 280         /* We do locking around the memfd cache, since we want to
 281          * allow people to process a sd_bus_message in a different
 282          * thread then it was generated on and free it there. Since
 283          * adding something to the memfd cache might happen when a
 284          * message is released, we hence need to protect this bit with
 285          * a mutex. */
 286         pthread_mutex_t memfd_cache_mutex;
 287         struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
 288         unsigned n_memfd_cache;
 289
 290         pid_t original_pid;
 291
 292         uint64_t hello_flags;
 293         uint64_t attach_flags;
 294
 295         uint64_t match_cookie;
 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 *event;
 302         int event_priority;
 303
 304         sd_bus_message *current_message;
 305         sd_bus_slot *current_slot;
 306
 307         sd_bus **default_bus_ptr;
 308         pid_t tid;
 309
 310         struct kdbus_creds fake_creds;
 311         char *fake_label;
 312
 313         char *cgroup_root;
 314
 315         char *connection_name;
 316
 317         size_t bloom_size;
 318         unsigned bloom_n_hash;
 319
 320         sd_bus_track *track_queue;
 321
 322         LIST_HEAD(sd_bus_slot, slots);
 323 };
 324
 325 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 326
 327 #define BUS_WQUEUE_MAX 1024
 328 #define BUS_RQUEUE_MAX 64*1024
 329
 330 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
 331 #define BUS_AUTH_SIZE_MAX (64*1024)
 332
 333 #define BUS_CONTAINER_DEPTH 128
 334
 335 /* Defined by the specification as maximum size of an array in
 336  * bytes */
 337 #define BUS_ARRAY_MAX_SIZE 67108864
 338
 339 #define BUS_FDS_MAX 1024
 340
 341 #define BUS_EXEC_ARGV_MAX 256
 342
 343 bool interface_name_is_valid(const char *p) _pure_;
 344 bool service_name_is_valid(const char *p) _pure_;
 345 bool member_name_is_valid(const char *p) _pure_;
 346 bool object_path_is_valid(const char *p) _pure_;
 347 char *object_path_startswith(const char *a, const char *b) _pure_;
 348
 349 bool namespace_complex_pattern(const char *pattern, const char *value) _pure_;
 350 bool path_complex_pattern(const char *pattern, const char *value) _pure_;
 351
 352 bool namespace_simple_pattern(const char *pattern, const char *value) _pure_;
 353 bool path_simple_pattern(const char *pattern, const char *value) _pure_;
 354
 355 int bus_message_type_from_string(const char *s, uint8_t *u) _pure_;
 356 const char *bus_message_type_to_string(uint8_t u) _pure_;
 357
 358 #define error_name_is_valid interface_name_is_valid
 359
 360 int bus_ensure_running(sd_bus *bus);
 361 int bus_start_running(sd_bus *bus);
 362 int bus_next_address(sd_bus *bus);
 363
 364 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
 365
 366 int bus_rqueue_make_room(sd_bus *bus);
 367
 368 bool bus_pid_changed(sd_bus *bus);
 369
 370 char *bus_address_escape(const char *v);
 371
 372 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path)                        \
 373         for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
 374              _slash && !(_slash[(_slash) == (prefix)] = 0);             \
 375              _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
 376
 377 /* If we are invoking callbacks of a bus object, ensure unreffing the
 378  * bus from the callback doesn't destroy the object we are working
 379  * on */
 380 #define BUS_DONT_DESTROY(bus) \
 381         _cleanup_bus_unref_ _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
 382
 383 int bus_set_address_system(sd_bus *bus);
 384 int bus_set_address_user(sd_bus *bus);
 385 int bus_set_address_system_remote(sd_bus *b, const char *host);
 386 int bus_set_address_system_container(sd_bus *b, const char *machine);
 387
 388 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);