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
  28 #include "hashmap.h"
  29 #include "prioq.h"
  30 #include "list.h"
  31 #include "util.h"
  32
  33 #include "sd-bus.h"
  34 #include "bus-error.h"
  35 #include "bus-match.h"
  36
  37 struct reply_callback {
  38         sd_bus_message_handler_t callback;
  39         void *userdata;
  40         usec_t timeout;
  41         uint64_t serial;
  42         unsigned prioq_idx;
  43 };
  44
  45 struct filter_callback {
  46         sd_bus_message_handler_t callback;
  47         void *userdata;
  48
  49         unsigned last_iteration;
  50
  51         LIST_FIELDS(struct filter_callback, callbacks);
  52 };
  53
  54 struct object_callback {
  55         sd_bus_message_handler_t callback;
  56         void *userdata;
  57
  58         char *path;
  59         bool is_fallback;
  60
  61         unsigned last_iteration;
  62 };
  63
  64 enum bus_state {
  65         BUS_UNSET,
  66         BUS_OPENING,
  67         BUS_AUTHENTICATING,
  68         BUS_HELLO,
  69         BUS_RUNNING
  70 };
  71
  72 enum bus_auth {
  73         _BUS_AUTH_INVALID,
  74         BUS_AUTH_EXTERNAL,
  75         BUS_AUTH_ANONYMOUS
  76 };
  77
  78 struct sd_bus {
  79         unsigned n_ref;
  80         enum bus_state state;
  81         int input_fd, output_fd;
  82         int message_version;
  83
  84         bool is_kernel:1;
  85         bool negotiate_fds:1;
  86         bool can_fds:1;
  87         bool bus_client:1;
  88         bool ucred_valid:1;
  89         bool is_server:1;
  90         bool anonymous_auth:1;
  91         bool prefer_readv:1;
  92         bool prefer_writev:1;
  93         bool processing:1;
  94         bool match_callbacks_modified:1;
  95         bool filter_callbacks_modified:1;
  96         bool object_callbacks_modified:1;
  97
  98         void *rbuffer;
  99         size_t rbuffer_size;
 100
 101         sd_bus_message **rqueue;
 102         unsigned rqueue_size;
 103
 104         sd_bus_message **wqueue;
 105         unsigned wqueue_size;
 106         size_t windex;
 107
 108         uint64_t serial;
 109
 110         char *unique_name;
 111
 112         struct bus_match_node match_callbacks;
 113         Prioq *reply_callbacks_prioq;
 114         Hashmap *reply_callbacks;
 115         LIST_HEAD(struct filter_callback, filter_callbacks);
 116         Hashmap *object_callbacks;
 117
 118         union {
 119                 struct sockaddr sa;
 120                 struct sockaddr_un un;
 121                 struct sockaddr_in in;
 122                 struct sockaddr_in6 in6;
 123         } sockaddr;
 124         socklen_t sockaddr_size;
 125
 126         char *kernel;
 127
 128         sd_id128_t server_id;
 129
 130         char *address;
 131         unsigned address_index;
 132
 133         int last_connect_error;
 134
 135         enum bus_auth auth;
 136         size_t auth_rbegin;
 137         struct iovec auth_iovec[3];
 138         unsigned auth_index;
 139         char *auth_buffer;
 140         usec_t auth_timeout;
 141
 142         struct ucred ucred;
 143         char label[NAME_MAX];
 144
 145         int *fds;
 146         unsigned n_fds;
 147
 148         char *exec_path;
 149         char **exec_argv;
 150
 151         uint64_t hello_serial;
 152         unsigned iteration_counter;
 153 };
 154
 155 static inline void bus_unrefp(sd_bus **b) {
 156         sd_bus_unref(*b);
 157 }
 158
 159 #define _cleanup_bus_unref_ __attribute__((cleanup(bus_unrefp)))
 160 #define _cleanup_bus_error_free_ __attribute__((cleanup(sd_bus_error_free)))
 161
 162 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 163
 164 #define BUS_WQUEUE_MAX 128
 165 #define BUS_RQUEUE_MAX 128
 166
 167 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
 168 #define BUS_AUTH_SIZE_MAX (64*1024)
 169
 170 #define BUS_CONTAINER_DEPTH 128
 171
 172 /* Defined by the specification as maximum size of an array in
 173  * bytes */
 174 #define BUS_ARRAY_MAX_SIZE 67108864
 175
 176 #define BUS_FDS_MAX 1024
 177
 178 #define BUS_EXEC_ARGV_MAX 256
 179
 180 bool object_path_is_valid(const char *p);
 181 bool interface_name_is_valid(const char *p);
 182 bool service_name_is_valid(const char *p);
 183 bool member_name_is_valid(const char *p);
 184
 185 bool namespace_complex_pattern(const char *pattern, const char *value);
 186 bool path_complex_pattern(const char *pattern, const char *value);
 187
 188 bool namespace_simple_pattern(const char *pattern, const char *value);
 189 bool path_simple_pattern(const char *pattern, const char *value);
 190
 191 int bus_message_type_from_string(const char *s, uint8_t *u);
 192
 193 #define error_name_is_valid interface_name_is_valid
 194
 195 int bus_ensure_running(sd_bus *bus);
 196 int bus_start_running(sd_bus *bus);
 197 int bus_next_address(sd_bus *bus);