src/libsystemd-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
  40 struct reply_callback {
  41         sd_bus_message_handler_t callback;
  42         void *userdata;
  43         usec_t timeout;
  44         uint64_t serial;
  45         unsigned prioq_idx;
  46 };
  47
  48 struct filter_callback {
  49         sd_bus_message_handler_t callback;
  50         void *userdata;
  51
  52         unsigned last_iteration;
  53
  54         LIST_FIELDS(struct filter_callback, callbacks);
  55 };
  56
  57 struct node {
  58         char *path;
  59         struct node *parent;
  60         LIST_HEAD(struct node, child);
  61         LIST_FIELDS(struct node, siblings);
  62
  63         LIST_HEAD(struct node_callback, callbacks);
  64         LIST_HEAD(struct node_vtable, vtables);
  65         LIST_HEAD(struct node_enumerator, enumerators);
  66
  67         bool object_manager;
  68 };
  69
  70 struct node_callback {
  71         struct node *node;
  72
  73         bool is_fallback;
  74         sd_bus_message_handler_t callback;
  75         void *userdata;
  76
  77         unsigned last_iteration;
  78
  79         LIST_FIELDS(struct node_callback, callbacks);
  80 };
  81
  82 struct node_enumerator {
  83         struct node *node;
  84
  85         sd_bus_node_enumerator_t callback;
  86         void *userdata;
  87
  88         unsigned last_iteration;
  89
  90         LIST_FIELDS(struct node_enumerator, enumerators);
  91 };
  92
  93 struct node_vtable {
  94         struct node *node;
  95
  96         char *interface;
  97         bool is_fallback;
  98         const sd_bus_vtable *vtable;
  99         void *userdata;
 100         sd_bus_object_find_t find;
 101
 102         unsigned last_iteration;
 103
 104         LIST_FIELDS(struct node_vtable, vtables);
 105 };
 106
 107 struct vtable_member {
 108         const char *path;
 109         const char *interface;
 110         const char *member;
 111         struct node_vtable *parent;
 112         unsigned last_iteration;
 113         const sd_bus_vtable *vtable;
 114 };
 115
 116 enum bus_state {
 117         BUS_UNSET,
 118         BUS_OPENING,
 119         BUS_AUTHENTICATING,
 120         BUS_HELLO,
 121         BUS_RUNNING,
 122         BUS_CLOSED
 123 };
 124
 125 static inline bool BUS_IS_OPEN(enum bus_state state) {
 126         return state > BUS_UNSET && state < BUS_CLOSED;
 127 }
 128
 129 enum bus_auth {
 130         _BUS_AUTH_INVALID,
 131         BUS_AUTH_EXTERNAL,
 132         BUS_AUTH_ANONYMOUS
 133 };
 134
 135 struct sd_bus {
 136         /* We use atomic ref counting here since sd_bus_message
 137            objects retain references to their originating sd_bus but
 138            we want to allow them to be processed in a different
 139            thread. We won't provide full thread safety, but only the
 140            bare minimum that makes it possible to use sd_bus and
 141            sd_bus_message objects independently and on different
 142            threads as long as each object is used only once at the
 143            same time. */
 144         RefCount n_ref;
 145
 146         enum bus_state state;
 147         int input_fd, output_fd;
 148         int message_version;
 149
 150         bool is_kernel:1;
 151         bool can_fds:1;
 152         bool bus_client:1;
 153         bool ucred_valid:1;
 154         bool is_server:1;
 155         bool anonymous_auth:1;
 156         bool prefer_readv:1;
 157         bool prefer_writev:1;
 158         bool processing:1;
 159         bool match_callbacks_modified:1;
 160         bool filter_callbacks_modified:1;
 161         bool nodes_modified:1;
 162
 163         int use_memfd;
 164
 165         void *rbuffer;
 166         size_t rbuffer_size;
 167
 168         sd_bus_message **rqueue;
 169         unsigned rqueue_size;
 170
 171         sd_bus_message **wqueue;
 172         unsigned wqueue_size;
 173         size_t windex;
 174
 175         uint64_t serial;
 176
 177         char *unique_name;
 178
 179         struct bus_match_node match_callbacks;
 180         Prioq *reply_callbacks_prioq;
 181         Hashmap *reply_callbacks;
 182         LIST_HEAD(struct filter_callback, filter_callbacks);
 183
 184         Hashmap *nodes;
 185
 186
 187         Hashmap *vtable_methods;
 188         Hashmap *vtable_properties;
 189
 190         union {
 191                 struct sockaddr sa;
 192                 struct sockaddr_un un;
 193                 struct sockaddr_in in;
 194                 struct sockaddr_in6 in6;
 195         } sockaddr;
 196         socklen_t sockaddr_size;
 197
 198         char *kernel;
 199         char *machine;
 200
 201         sd_id128_t server_id;
 202
 203         char *address;
 204         unsigned address_index;
 205
 206         int last_connect_error;
 207
 208         enum bus_auth auth;
 209         size_t auth_rbegin;
 210         struct iovec auth_iovec[3];
 211         unsigned auth_index;
 212         char *auth_buffer;
 213         usec_t auth_timeout;
 214
 215         struct ucred ucred;
 216         char label[NAME_MAX];
 217
 218         int *fds;
 219         unsigned n_fds;
 220
 221         char *exec_path;
 222         char **exec_argv;
 223
 224         uint64_t hello_serial;
 225         unsigned iteration_counter;
 226
 227         void *kdbus_buffer;
 228
 229         /* We do locking around the memfd cache, since we want to
 230          * allow people to process a sd_bus_message in a different
 231          * thread then it was generated on and free it there. Since
 232          * adding something to the memfd cache might happen when a
 233          * message is released, we hence need to protect this bit with
 234          * a mutex. */
 235         pthread_mutex_t memfd_cache_mutex;
 236         struct memfd_cache memfd_cache[MEMFD_CACHE_MAX];
 237         unsigned n_memfd_cache;
 238
 239         pid_t original_pid;
 240
 241         uint64_t hello_flags;
 242
 243         uint64_t match_cookie;
 244
 245         sd_event_source *input_io_event_source;
 246         sd_event_source *output_io_event_source;
 247         sd_event_source *time_event_source;
 248         sd_event_source *quit_event_source;
 249         sd_event *event;
 250
 251         sd_bus_message *current;
 252
 253         sd_bus **default_bus_ptr;
 254         pid_t tid;
 255 };
 256
 257 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 258
 259 #define BUS_WQUEUE_MAX 1024
 260 #define BUS_RQUEUE_MAX 64*1024
 261
 262 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
 263 #define BUS_AUTH_SIZE_MAX (64*1024)
 264
 265 #define BUS_CONTAINER_DEPTH 128
 266
 267 /* Defined by the specification as maximum size of an array in
 268  * bytes */
 269 #define BUS_ARRAY_MAX_SIZE 67108864
 270
 271 #define BUS_FDS_MAX 1024
 272
 273 #define BUS_EXEC_ARGV_MAX 256
 274
 275 bool interface_name_is_valid(const char *p);
 276 bool service_name_is_valid(const char *p);
 277 bool sender_name_is_valid(const char *p);
 278 bool member_name_is_valid(const char *p);
 279 bool object_path_is_valid(const char *p);
 280 char *object_path_startswith(const char *a, const char *b);
 281
 282 bool namespace_complex_pattern(const char *pattern, const char *value);
 283 bool path_complex_pattern(const char *pattern, const char *value);
 284
 285 bool namespace_simple_pattern(const char *pattern, const char *value);
 286 bool path_simple_pattern(const char *pattern, const char *value);
 287
 288 int bus_message_type_from_string(const char *s, uint8_t *u);
 289 const char *bus_message_type_to_string(uint8_t u);
 290
 291 #define error_name_is_valid interface_name_is_valid
 292
 293 int bus_ensure_running(sd_bus *bus);
 294 int bus_start_running(sd_bus *bus);
 295 int bus_next_address(sd_bus *bus);
 296
 297 bool bus_pid_changed(sd_bus *bus);
 298
 299 char *bus_address_escape(const char *v);
 300
 301 #define OBJECT_PATH_FOREACH_PREFIX(prefix, path)                        \
 302         for (char *_slash = ({ strcpy((prefix), (path)); streq((prefix), "/") ? NULL : strrchr((prefix), '/'); }) ; \
 303              _slash && !(_slash[(_slash) == (prefix)] = 0);             \
 304              _slash = streq((prefix), "/") ? NULL : strrchr((prefix), '/'))
 305
 306 /* If we are invoking callbacks of a bus object, ensure unreffing the
 307  * bus from the callback doesn't destroy the object we are working
 308  * on */
 309 #define BUS_DONT_DESTROY(bus) \
 310         _cleanup_bus_unref_ _unused_ sd_bus *_dont_destroy_##bus = sd_bus_ref(bus)