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
 216         int use_memfd;
 217
 218         void *rbuffer;
 219         size_t rbuffer_size;
 220
 221         sd_bus_message **rqueue;
 222         unsigned rqueue_size;
 223         size_t rqueue_allocated;
 224
 225         sd_bus_message **wqueue;
 226         unsigned wqueue_size;
 227         size_t windex;
 228         size_t wqueue_allocated;
 229
 230         uint64_t cookie;
 231
 232         char *unique_name;
 233         uint64_t unique_id;
 234
 235         struct bus_match_node match_callbacks;
 236         Prioq *reply_callbacks_prioq;
 237         OrderedHashmap *reply_callbacks;
 238         LIST_HEAD(struct filter_callback, filter_callbacks);
 239
 240         Hashmap *nodes;
 241         Hashmap *vtable_methods;
 242         Hashmap *vtable_properties;
 243
 244         union sockaddr_union sockaddr;
 245         socklen_t sockaddr_size;
 246
 247         char *kernel;
 248         char *machine;
 249         pid_t nspid;
 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;
 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         sd_bus_message_handler_t current_handler;
 307         void *current_userdata;
 308
 309         sd_bus **default_bus_ptr;
 310         pid_t tid;
 311
 312         struct kdbus_creds fake_creds;
 313         struct kdbus_pids fake_pids;
 314         char *fake_label;
 315
 316         char *cgroup_root;
 317
 318         char *description;
 319
 320         size_t bloom_size;
 321         unsigned bloom_n_hash;
 322
 323         sd_bus_track *track_queue;
 324
 325         LIST_HEAD(sd_bus_slot, slots);
 326         LIST_HEAD(sd_bus_track, tracks);
 327 };
 328
 329 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 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 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path)                        \
 380         for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
 381              _slash && !(_slash[(_slash) == (prefix)] = 0);             \
 382              _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
 383
 384 /* If we are invoking callbacks of a bus object, ensure unreffing the
 385  * bus from the callback doesn't destroy the object we are working
 386  * on */
 387 #define BUS_DONT_DESTROY(bus) \
 388         _cleanup_(sd_bus_unrefp) _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)
 389
 390 int bus_set_address_system(sd_bus *bus);
 391 #if 0 /// UNNEEDED by elogind
 392 int bus_set_address_user(sd_bus *bus);
 393 #endif // 0
 394 int bus_set_address_system_remote(sd_bus *b, const char *host);
 395 int bus_set_address_system_machine(sd_bus *b, const char *machine);
 396
 397 #if 0 /// UNNEEDED by elogind
 398 int bus_remove_match_by_string(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 399 #endif // 0
 400
 401 int bus_get_root_path(sd_bus *bus);
 402
 403 int bus_maybe_reply_error(sd_bus_message *m, int r, sd_bus_error *error);
 404
 405 #define bus_assert_return(expr, r, error)                               \
 406         do {                                                            \
 407                 if (!assert_log(expr, #expr))                           \
 408                         return sd_bus_error_set_errno(error, r);        \
 409         } while (false)