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, saved_index;
  38
  39         uint32_t *array_size;
  40         size_t before, 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         sd_bus *bus;
  57
  58         uint32_t reply_serial;
  59
  60         const char *path;
  61         const char *interface;
  62         const char *member;
  63         const char *destination;
  64         const char *sender;
  65
  66         sd_bus_error error;
  67
  68         uid_t uid;
  69         gid_t gid;
  70         pid_t pid;
  71         pid_t tid;
  72         usec_t pid_starttime;
  73         usec_t monotonic;
  74         usec_t realtime;
  75
  76         bool sealed:1;
  77         bool dont_send:1;
  78         bool allow_fds:1;
  79         bool uid_valid:1;
  80         bool gid_valid:1;
  81         bool free_header:1;
  82         bool free_fields:1;
  83         bool free_body:1;
  84         bool free_kdbus:1;
  85         bool free_fds:1;
  86         bool release_kdbus:1;
  87
  88         struct bus_header *header;
  89         void *fields;
  90         void *body;
  91         struct kdbus_msg *kdbus;
  92
  93         char *label;
  94
  95         size_t rindex;
  96
  97         uint32_t n_fds;
  98         int *fds;
  99
 100         struct bus_container root_container, *containers;
 101         unsigned n_containers;
 102
 103         struct iovec iovec[3];
 104         unsigned n_iovec;
 105
 106         char *peeked_signature;
 107
 108         usec_t timeout;
 109
 110         char sender_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
 111         char destination_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
 112
 113         const char *exe;
 114         const char *comm;
 115         const char *tid_comm;
 116         const char *cgroup;
 117
 118         const char *cmdline;
 119         size_t cmdline_length;
 120         char **cmdline_array;
 121
 122         char *session;
 123         char *unit;
 124         char *user_unit;
 125
 126         struct kdbus_audit *audit;
 127
 128         uint8_t *capability;
 129         size_t capability_size;
 130 };
 131
 132 #define BUS_MESSAGE_NEED_BSWAP(m) ((m)->header->endian != SD_BUS_NATIVE_ENDIAN)
 133
 134 static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
 135         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
 136 }
 137
 138 static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
 139         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
 140 }
 141
 142 static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
 143         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
 144 }
 145
 146 static inline uint32_t BUS_MESSAGE_SERIAL(sd_bus_message *m) {
 147         return BUS_MESSAGE_BSWAP32(m, m->header->serial);
 148 }
 149
 150 static inline uint32_t BUS_MESSAGE_BODY_SIZE(sd_bus_message *m) {
 151         return BUS_MESSAGE_BSWAP32(m, m->header->body_size);
 152 }
 153
 154 static inline uint32_t BUS_MESSAGE_FIELDS_SIZE(sd_bus_message *m) {
 155         return BUS_MESSAGE_BSWAP32(m, m->header->fields_size);
 156 }
 157
 158 static inline uint32_t BUS_MESSAGE_SIZE(sd_bus_message *m) {
 159         return
 160                 sizeof(struct bus_header) +
 161                 ALIGN8(BUS_MESSAGE_FIELDS_SIZE(m)) +
 162                 BUS_MESSAGE_BODY_SIZE(m);
 163 }
 164
 165 static inline void bus_message_unrefp(sd_bus_message **m) {
 166         sd_bus_message_unref(*m);
 167 }
 168
 169 #define _cleanup_bus_message_unref_ __attribute__((cleanup(bus_message_unrefp)))
 170
 171 int bus_message_seal(sd_bus_message *m, uint64_t serial);
 172 int bus_message_dump(sd_bus_message *m);
 173 int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
 174 int bus_message_read_strv_extend(sd_bus_message *m, char ***l);
 175
 176 int bus_message_from_header(
 177                 void *header,
 178                 size_t length,
 179                 int *fds,
 180                 unsigned n_fds,
 181                 const struct ucred *ucred,
 182                 const char *label,
 183                 size_t extra,
 184                 sd_bus_message **ret);
 185
 186 int bus_message_from_malloc(
 187                 void *buffer,
 188                 size_t length,
 189                 int *fds,
 190                 unsigned n_fds,
 191                 const struct ucred *ucred,
 192                 const char *label,
 193                 sd_bus_message **ret);
 194
 195 const char* bus_message_get_arg(sd_bus_message *m, unsigned i);
 196
 197 int bus_message_append_ap(sd_bus_message *m, const char *types, va_list ap);
 198
 199 int bus_message_parse_fields(sd_bus_message *m);
 200
 201 int bus_header_size(struct bus_header *h, size_t *sum);