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