src/libsystemd/sd-bus/bus-message.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 <byteswap.h>
  25 #include <stdbool.h>
  26 #include <sys/socket.h>
  27
  28 #include "sd-bus.h"
  29
  30 #include "bus-creds.h"
  31 #include "bus-protocol.h"
  32 #include "macro.h"
  33 #include "time-util.h"
  34
  35 struct bus_container {
  36         char enclosing;
  37         bool need_offsets:1;
  38
  39         /* Indexes into the signature  string */
  40         unsigned index, saved_index;
  41         char *signature;
  42
  43         size_t before, begin, end;
  44
  45         /* dbus1: pointer to the array size value, if this is a value */
  46         uint32_t *array_size;
  47
  48         /* gvariant: list of offsets to end of children if this is struct/dict entry/array */
  49         size_t *offsets, n_offsets, offsets_allocated, offset_index;
  50         size_t item_size;
  51
  52         char *peeked_signature;
  53 };
  54
  55 struct bus_body_part {
  56         struct bus_body_part *next;
  57         void *data;
  58         void *mmap_begin;
  59         size_t size;
  60         size_t mapped;
  61         size_t allocated;
  62         uint64_t memfd_offset;
  63         int memfd;
  64         bool free_this:1;
  65         bool munmap_this:1;
  66         bool sealed:1;
  67         bool is_zero:1;
  68 };
  69
  70 struct sd_bus_message {
  71         unsigned n_ref;
  72
  73         sd_bus *bus;
  74
  75         uint64_t reply_cookie;
  76
  77         const char *path;
  78         const char *interface;
  79         const char *member;
  80         const char *destination;
  81         const char *sender;
  82
  83         sd_bus_error error;
  84
  85         sd_bus_creds creds;
  86
  87         usec_t monotonic;
  88         usec_t realtime;
  89         uint64_t seqnum;
  90         int64_t priority;
  91         uint64_t verify_destination_id;
  92
  93         bool sealed:1;
  94         bool dont_send:1;
  95         bool allow_fds:1;
  96         bool free_header:1;
  97         bool free_kdbus:1;
  98         bool free_fds:1;
  99         bool release_kdbus:1;
 100         bool poisoned:1;
 101
 102         /* The first and last bytes of the message */
 103         struct bus_header *header;
 104         void *footer;
 105
 106         /* How many bytes are accessible in the above pointers */
 107         size_t header_accessible;
 108         size_t footer_accessible;
 109
 110         size_t fields_size;
 111         size_t body_size;
 112         size_t user_body_size;
 113
 114         struct bus_body_part body;
 115         struct bus_body_part *body_end;
 116         unsigned n_body_parts;
 117
 118         size_t rindex;
 119         struct bus_body_part *cached_rindex_part;
 120         size_t cached_rindex_part_begin;
 121
 122         uint32_t n_fds;
 123         int *fds;
 124
 125         struct bus_container root_container, *containers;
 126         size_t n_containers;
 127         size_t containers_allocated;
 128
 129         struct iovec *iovec;
 130         struct iovec iovec_fixed[2];
 131         unsigned n_iovec;
 132
 133         struct kdbus_msg *kdbus;
 134
 135         char *peeked_signature;
 136
 137         /* If set replies to this message must carry the signature
 138          * specified here to successfully seal. This is initialized
 139          * from the vtable data */
 140         const char *enforced_reply_signature;
 141
 142         usec_t timeout;
 143
 144         char sender_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
 145         char destination_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
 146         char *destination_ptr;
 147
 148         size_t header_offsets[_BUS_MESSAGE_HEADER_MAX];
 149         unsigned n_header_offsets;
 150 };
 151
 152 static inline bool BUS_MESSAGE_NEED_BSWAP(sd_bus_message *m) {
 153         return m->header->endian != BUS_NATIVE_ENDIAN;
 154 }
 155
 156 static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
 157         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
 158 }
 159
 160 static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
 161         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
 162 }
 163
 164 static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
 165         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
 166 }
 167
 168 static inline uint64_t BUS_MESSAGE_COOKIE(sd_bus_message *m) {
 169         if (m->header->version == 2)
 170                 return BUS_MESSAGE_BSWAP64(m, m->header->dbus2.cookie);
 171
 172         return BUS_MESSAGE_BSWAP32(m, m->header->dbus1.serial);
 173 }
 174
 175 static inline size_t BUS_MESSAGE_SIZE(sd_bus_message *m) {
 176         return
 177                 sizeof(struct bus_header) +
 178                 ALIGN8(m->fields_size) +
 179                 m->body_size;
 180 }
 181
 182 static inline size_t BUS_MESSAGE_BODY_BEGIN(sd_bus_message *m) {
 183         return
 184                 sizeof(struct bus_header) +
 185                 ALIGN8(m->fields_size);
 186 }
 187
 188 static inline void* BUS_MESSAGE_FIELDS(sd_bus_message *m) {
 189         return (uint8_t*) m->header + sizeof(struct bus_header);
 190 }
 191
 192 static inline bool BUS_MESSAGE_IS_GVARIANT(sd_bus_message *m) {
 193         return m->header->version == 2;
 194 }
 195
 196 int bus_message_seal(sd_bus_message *m, uint64_t serial, usec_t timeout);
 197 int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
 198 int bus_message_read_strv_extend(sd_bus_message *m, char ***l);
 199
 200 int bus_message_from_header(
 201                 sd_bus *bus,
 202                 void *header,
 203                 size_t header_accessible,
 204                 void *footer,
 205                 size_t footer_accessible,
 206                 size_t message_size,
 207                 int *fds,
 208                 unsigned n_fds,
 209                 const char *label,
 210                 size_t extra,
 211                 sd_bus_message **ret);
 212
 213 int bus_message_from_malloc(
 214                 sd_bus *bus,
 215                 void *buffer,
 216                 size_t length,
 217                 int *fds,
 218                 unsigned n_fds,
 219                 const char *label,
 220                 sd_bus_message **ret);
 221
 222 int bus_message_get_arg(sd_bus_message *m, unsigned i, const char **str);
 223 int bus_message_get_arg_strv(sd_bus_message *m, unsigned i, char ***strv);
 224
 225 int bus_message_append_ap(sd_bus_message *m, const char *types, va_list ap);
 226
 227 int bus_message_parse_fields(sd_bus_message *m);
 228
 229 struct bus_body_part *message_append_part(sd_bus_message *m);
 230
 231 #define MESSAGE_FOREACH_PART(part, i, m) \
 232         for ((i) = 0, (part) = &(m)->body; (i) < (m)->n_body_parts; (i)++, (part) = (part)->next)
 233
 234 int bus_body_part_map(struct bus_body_part *part);
 235 void bus_body_part_unmap(struct bus_body_part *part);
 236
 237 int bus_message_to_errno(sd_bus_message *m);
 238
 239 int bus_message_new_synthetic_error(sd_bus *bus, uint64_t serial, const sd_bus_error *e, sd_bus_message **m);
 240
 241 int bus_message_remarshal(sd_bus *bus, sd_bus_message **m);
 242
 243 int bus_message_append_sender(sd_bus_message *m, const char *sender);
 244
 245 void bus_message_set_sender_driver(sd_bus *bus, sd_bus_message *m);
 246 void bus_message_set_sender_local(sd_bus *bus, sd_bus_message *m);