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 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
  87         void *rbuffer;
  88         size_t rbuffer_size;
  89
  90         sd_bus_message **rqueue;
  91         unsigned rqueue_size;
  92
  93         sd_bus_message **wqueue;
  94         unsigned wqueue_size;
  95         size_t windex;
  96
  97         uint64_t serial;
  98
  99         char *unique_name;
 100
 101         struct bus_match_node match_callbacks;
 102         Prioq *reply_callbacks_prioq;
 103         Hashmap *reply_callbacks;
 104         LIST_HEAD(struct filter_callback, filter_callbacks);
 105         Hashmap *object_callbacks;
 106
 107         union {
 108                 struct sockaddr sa;
 109                 struct sockaddr_un un;
 110                 struct sockaddr_in in;
 111                 struct sockaddr_in6 in6;
 112         } sockaddr;
 113         socklen_t sockaddr_size;
 114
 115         sd_id128_t peer;
 116
 117         char *address;
 118         unsigned address_index;
 119
 120         int last_connect_error;
 121
 122         enum bus_auth auth;
 123         size_t auth_rbegin;
 124         struct iovec auth_iovec[3];
 125         unsigned auth_index;
 126         char *auth_buffer;
 127         usec_t auth_timeout;
 128
 129         struct ucred ucred;
 130         char label[NAME_MAX];
 131
 132         int *fds;
 133         unsigned n_fds;
 134
 135         char *exec_path;
 136         char **exec_argv;
 137
 138         uint64_t hello_serial;
 139 };
 140
 141 static inline void bus_unrefp(sd_bus **b) {
 142         sd_bus_unref(*b);
 143 }
 144
 145 #define _cleanup_bus_unref_ __attribute__((cleanup(bus_unrefp)))
 146 #define _cleanup_bus_error_free_ __attribute__((cleanup(sd_bus_error_free)))
 147
 148 #define BUS_DEFAULT_TIMEOUT ((usec_t) (25 * USEC_PER_SEC))
 149
 150 #define BUS_WQUEUE_MAX 128
 151 #define BUS_RQUEUE_MAX 128
 152
 153 #define BUS_MESSAGE_SIZE_MAX (64*1024*1024)
 154 #define BUS_AUTH_SIZE_MAX (64*1024)
 155
 156 #define BUS_CONTAINER_DEPTH 128
 157
 158 /* Defined by the specification as maximum size of an array in
 159  * bytes */
 160 #define BUS_ARRAY_MAX_SIZE 67108864
 161
 162 #define BUS_FDS_MAX 1024
 163
 164 #define BUS_EXEC_ARGV_MAX 256
 165
 166 bool object_path_is_valid(const char *p);
 167 bool interface_name_is_valid(const char *p);
 168 bool service_name_is_valid(const char *p);
 169 bool member_name_is_valid(const char *p);
 170
 171 bool namespace_complex_pattern(const char *pattern, const char *value);
 172 bool path_complex_pattern(const char *pattern, const char *value);
 173
 174 bool namespace_simple_pattern(const char *pattern, const char *value);
 175 bool path_simple_pattern(const char *pattern, const char *value);
 176
 177 int bus_message_type_from_string(const char *s, uint8_t *u);
 178
 179 #define error_name_is_valid interface_name_is_valid
 180
 181 int bus_ensure_running(sd_bus *bus);
 182 int bus_start_running(sd_bus *bus);
 183 int bus_next_address(sd_bus *bus);