src/libsystemd-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 <stdbool.h>
  25 #include <byteswap.h>
  26 #include <sys/socket.h>
  27
  28 #include "macro.h"
  29 #include "sd-bus.h"
  30 #include "kdbus.h"
  31
  32 struct bus_container {
  33         char enclosing;
  34
  35         char *signature;
  36         unsigned index;
  37
  38         uint32_t *array_size;
  39         size_t begin;
  40 };
  41
  42 struct bus_header {
  43         uint8_t endian;
  44         uint8_t type;
  45         uint8_t flags;
  46         uint8_t version;
  47         uint32_t body_size;
  48         uint32_t serial;
  49         uint32_t fields_size;
  50 } _packed_;
  51
  52 struct sd_bus_message {
  53         unsigned n_ref;
  54
  55         uint32_t reply_serial;
  56
  57         const char *path;
  58         const char *interface;
  59         const char *member;
  60         const char *destination;
  61         const char *sender;
  62
  63         sd_bus_error error;
  64
  65         uid_t uid;
  66         gid_t gid;
  67         pid_t pid;
  68         pid_t tid;
  69
  70         bool sealed:1;
  71         bool dont_send:1;
  72         bool allow_fds:1;
  73         bool uid_valid:1;
  74         bool gid_valid:1;
  75         bool free_header:1;
  76         bool free_fields:1;
  77         bool free_body:1;
  78         bool free_kdbus:1;
  79         bool free_fds:1;
  80
  81         struct bus_header *header;
  82         void *fields;
  83         void *body;
  84         struct kdbus_msg *kdbus;
  85
  86         char *label;
  87
  88         size_t rindex;
  89
  90         uint32_t n_fds;
  91         int *fds;
  92
  93         struct bus_container root_container, *containers;
  94         unsigned n_containers;
  95
  96         struct iovec iovec[4];
  97         unsigned n_iovec;
  98
  99         char *peeked_signature;
 100
 101         usec_t timeout;
 102 };
 103
 104 #define BUS_MESSAGE_NEED_BSWAP(m) ((m)->header->endian != SD_BUS_NATIVE_ENDIAN)
 105
 106 static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
 107         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
 108 }
 109
 110 static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
 111         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
 112 }
 113
 114 static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
 115         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
 116 }
 117
 118 static inline uint32_t BUS_MESSAGE_SERIAL(sd_bus_message *m) {
 119         return BUS_MESSAGE_BSWAP32(m, m->header->serial);
 120 }
 121
 122 static inline uint32_t BUS_MESSAGE_BODY_SIZE(sd_bus_message *m) {
 123         return BUS_MESSAGE_BSWAP32(m, m->header->body_size);
 124 }
 125
 126 static inline uint32_t BUS_MESSAGE_FIELDS_SIZE(sd_bus_message *m) {
 127         return BUS_MESSAGE_BSWAP32(m, m->header->fields_size);
 128 }
 129
 130 static inline uint32_t BUS_MESSAGE_SIZE(sd_bus_message *m) {
 131         return
 132                 sizeof(struct bus_header) +
 133                 ALIGN8(BUS_MESSAGE_FIELDS_SIZE(m)) +
 134                 BUS_MESSAGE_BODY_SIZE(m);
 135 }
 136
 137 static inline void bus_message_unrefp(sd_bus_message **m) {
 138         sd_bus_message_unref(*m);
 139 }
 140
 141 #define _cleanup_bus_message_unref_ __attribute__((cleanup(bus_message_unrefp)))
 142
 143 int bus_message_seal(sd_bus_message *m, uint64_t serial);
 144 int bus_message_dump(sd_bus_message *m);
 145 int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
 146 int bus_message_read_strv_extend(sd_bus_message *m, char ***l);
 147
 148 int bus_message_from_header(
 149                 void *header,
 150                 size_t length,
 151                 int *fds,
 152                 unsigned n_fds,
 153                 const struct ucred *ucred,
 154                 const char *label,
 155                 size_t extra,
 156                 sd_bus_message **ret);
 157
 158 int bus_message_from_malloc(
 159                 void *buffer,
 160                 size_t length,
 161                 int *fds,
 162                 unsigned n_fds,
 163                 const struct ucred *ucred,
 164                 const char *label,
 165                 sd_bus_message **ret);
 166
 167 const char* bus_message_get_arg(sd_bus_message *m, unsigned i);
 168
 169 int bus_message_append_ap(sd_bus_message *m, const char *types, va_list ap);
 170
 171 int bus_message_parse_fields(sd_bus_message *m);
 172
 173 int bus_header_size(struct bus_header *h, size_t *sum);