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

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2013 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 #include <pthread.h>
  23 #include <sys/socket.h>
  24
  25 #include "sd-bus.h"
  26
  27 #include "bus-error.h"
  28 #include "bus-kernel.h"
  29 #include "bus-match.h"
  30 #include "hashmap.h"
  31 #include "kdbus.h"
  32 #include "list.h"
  33 #include "prioq.h"
  34 #include "refcnt.h"
  35 #include "socket-util.h"
  36 #include "util.h"
  37
  38 struct reply_callback {
  39         sd_bus_message_handler_t callback;
  40         usec_t timeout;
  41         uint64_t cookie;
  42         unsigned prioq_idx;
  43 };
  44
  45 struct filter_callback {
  46         sd_bus_message_handler_t callback;
  47
  48         unsigned last_iteration;
  49
  50         LIST_FIELDS(struct filter_callback, callbacks);
  51 };
  52
  53 struct match_callback {
  54         sd_bus_message_handler_t callback;
  55
  56         uint64_t cookie;
  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_OPENING,
 161         BUS_AUTHENTICATING,
 162         BUS_HELLO,
 163         BUS_RUNNING,
 164         BUS_CLOSING,
 165         BUS_CLOSED
 166 };
 167
 168 static inline bool BUS_IS_OPEN(enum bus_state state) {
 169         return state > BUS_UNSET && state < BUS_CLOSING;
 170 }
 171
 172 enum bus_auth {
 173         _BUS_AUTH_INVALID,
 174         BUS_AUTH_EXTERNAL,
 175         BUS_AUTH_ANONYMOUS
 176 };
 177
 178 struct sd_bus {
 179         /* We use atomic ref counting here since sd_bus_message
 180            objects retain references to their originating sd_bus but
 181            we want to allow them to be processed in a different
 182            thread. We won't provide full thread safety, but only the
 183            bare minimum that makes it possible to use sd_bus and
 184            sd_bus_message objects independently and on different
 185            threads as long as each object is used only once at the
 186            same time. */
 187         RefCount n_ref;
 188
 189         enum bus_state state;
 190         int input_fd, output_fd;
 191         int message_version;
 192         int message_endian;
 193
 194         bool is_kernel:1;
 195         bool can_fds:1;
 196         bool bus_client:1;
 197         bool ucred_valid:1;
 198         bool is_server:1;
 199         bool anonymous_auth:1;
 200         bool prefer_readv:1;
 201         bool prefer_writev:1;
 202         bool match_callbacks_modified:1;
 203         bool filter_callbacks_modified:1;
 204         bool nodes_modified:1;
 205         bool trusted:1;
 206         bool fake_creds_valid:1;
 207         bool fake_pids_valid:1;
 208         bool manual_peer_interface:1;
 209         bool is_system:1;
 210         bool is_user:1;
 211         bool allow_interactive_authorization:1;
 212         bool exit_on_disconnect:1;
 213         bool exited:1;
 214         bool exit_triggered:1;
 215         bool is_local:1;
 216
 217         int use_memfd;
 218
 219         void *rbuffer;
 220         size_t rbuffer_size;
 221
 222         sd_bus_message **rqueue;
 223         unsigned rqueue_size;
 224         size_t rqueue_allocated;
 225
 226         sd_bus_message **wqueue;
 227         unsigned wqueue_size;
 228         size_t windex;
 229         size_t wqueue_allocated;
 230
 231         uint64_t cookie;
 232
 233         char *unique_name;
 234         uint64_t unique_id;
 235
 236         struct bus_match_node match_callbacks;
 237         Prioq *reply_callbacks_prioq;
 238         OrderedHashmap *reply_callbacks;
 239         LIST_HEAD(struct filter_callback, filter_callbacks);
 240
 241         Hashmap *nodes;
 242         Hashmap *vtable_methods;
 243         Hashmap *vtable_properties;
 244
 245         union sockaddr_union sockaddr;
 246         socklen_t sockaddr_size;
 247
 248         char *kernel;
 249         char *machine;
 250         pid_t nspid;
 251
 252         sd_id128_t server_id;
 253
 254         char *address;
 255         unsigned address_index;
 256
 257         int last_connect_error;
 258
 259         enum bus_auth auth;
 260         size_t auth_rbegin;
 261         struct iovec auth_iovec[3];
 262         unsigned auth_index;
 263         char *auth_buffer;
 264         usec_t auth_timeout;
 265
 266         struct ucred ucred;
 267         char *label;
 268
 269         uint64_t creds_mask;
 270
 271         int *fds;
 272         unsigned n_fds;
 273
 274         char *exec_path;
 275         char **exec_argv;
 276
 277         unsigned iteration_counter;
 278
 279         void *kdbus_buffer;
 280
 281         /* We do locking around the memfd cache, since we want to
 282          * allow people to process a sd_bus_message in a different
 283          * thread then it was generated on and free it there. Since
 284          * adding something to the memfd cache might happen when a
 285          * message is released, we hence need to protect this bit with
 286          * a mutex. */
 287         pthread_mutex_t memfd_cache_mutex;
 288         struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
 289         unsigned n_memfd_cache;
 290
 291         pid_t original_pid;
 292
 293         uint64_t hello_flags;
 294         uint64_t attach_flags;
 295
 296         uint64_t match_cookie;
 297
 298         sd_event_source *input_io_event_source;
 299         sd_event_source *output_io_event_source;
 300         sd_event_source *time_event_source;
 301         sd_event_source *quit_event_source;
 302         sd_event *event;
 303         int event_priority;
 304
 305         sd_bus_message *current_message;
 306         sd_bus_slot *current_slot;
 307         sd_bus_message_handler_t current_handler;
 308         void *current_userdata;
 309
 310         sd_bus **default_bus_ptr;
 311         pid_t tid;
 312
 313         struct kdbus_creds fake_creds;
 314         struct kdbus_pids fake_pids;
 315         char *fake_label;
 316
 317         char *cgroup_root;
 318
 319         char *description;
 320
 321         size_t bloom_size;
 322         unsigned bloom_n_hash;
 323
 324         sd_bus_track *track_queue;
 325
 326         LIST_HEAD(sd_bus_slot, slots);
 327         LIST_HEAD(sd_bus_track, tracks);
 328 };
 329
 330 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 331
 332 #define BUS_WQUEUE_MAX (192*1024)
 333 #define BUS_RQUEUE_MAX (192*1024)
 334
 335 #define BUS_MESSAGE_SIZE_MAX (64*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 int bus_ensure_running(sd_bus *bus);
 369 int bus_start_running(sd_bus *bus);
 370 int bus_next_address(sd_bus *bus);
 371
 372 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m);
 373
 374 int bus_rqueue_make_room(sd_bus *bus);
 375
 376 bool bus_pid_changed(sd_bus *bus);
 377
 378 char *bus_address_escape(const char *v);
 379
 380 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path)                        \
 381         for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
 382              _slash && !(_slash[(_slash) == (prefix)] = 0);             \
 383              _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
 384
 385 /* If we are invoking callbacks of a bus object, ensure unreffing the
 386  * bus from the callback doesn't destroy the object we are working
 387  * on */
 388 #define BUS_DONT_DESTROY(bus) \
 389         _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
 390
 391 int bus_set_address_system(sd_bus *bus);
 392 #if 0 /// UNNEEDED by elogind
 393 int bus_set_address_user(sd_bus *bus);
 394 #endif // 0
 395 int bus_set_address_system_remote(sd_bus *b, const char *host);
 396 int bus_set_address_system_machine(sd_bus *b, const char *machine);
 397
 398 #if 0 /// UNNEEDED by elogind
 399 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 400 #endif // 0
 401
 402 int bus_get_root_path(sd_bus *bus);
 403
 404 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
 405
 406 #define bus_assert_return(expr, r, error)                               \
 407         do {                                                            \
 408                 if (!assert_log(expr, #expr))                           \
 409                         return sd_bus_error_set_errno(error, r);        \
 410         } while (false)