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