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
  27 #include "macro.h"
  28 #include "sd-bus.h"
  29
  30 struct bus_container {
  31         char enclosing;
  32
  33         char *signature;
  34         unsigned index;
  35
  36         uint32_t *array_size;
  37         size_t begin;
  38 };
  39
  40 _packed_ struct bus_header {
  41         uint8_t endian;
  42         uint8_t type;
  43         uint8_t flags;
  44         uint8_t version;
  45         uint32_t body_size;
  46         uint32_t serial;
  47         uint32_t fields_size;
  48 };
  49
  50 struct sd_bus_message {
  51         unsigned n_ref;
  52
  53         uint32_t reply_serial;
  54
  55         const char *path;
  56         const char *interface;
  57         const char *member;
  58         const char *destination;
  59         const char *sender;
  60
  61         sd_bus_error error;
  62
  63         uid_t uid;
  64         gid_t gid;
  65         pid_t pid;
  66         pid_t tid;
  67
  68         bool sealed:1;
  69         bool uid_valid:1;
  70         bool gid_valid:1;
  71         bool free_header:1;
  72         bool free_fields:1;
  73         bool free_body:1;
  74         bool dont_send:1;
  75
  76         struct bus_header *header;
  77         void *fields;
  78         void *body;
  79
  80         size_t rindex;
  81
  82         uint32_t n_fds;
  83         int *fds;
  84
  85         struct bus_container root_container, *containers;
  86         unsigned n_containers;
  87
  88         struct iovec iovec[4];
  89         unsigned n_iovec;
  90
  91         char *peeked_signature;
  92 };
  93
  94 #define BUS_MESSAGE_NEED_BSWAP(m) ((m)->header->endian != SD_BUS_NATIVE_ENDIAN)
  95
  96 static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
  97         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
  98 }
  99
 100 static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
 101         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
 102 }
 103
 104 static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
 105         return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
 106 }
 107
 108 static inline uint32_t BUS_MESSAGE_SERIAL(sd_bus_message *m) {
 109         return BUS_MESSAGE_BSWAP32(m, m->header->serial);
 110 }
 111
 112 static inline uint32_t BUS_MESSAGE_BODY_SIZE(sd_bus_message *m) {
 113         return BUS_MESSAGE_BSWAP32(m, m->header->body_size);
 114 }
 115
 116 static inline uint32_t BUS_MESSAGE_FIELDS_SIZE(sd_bus_message *m) {
 117         return BUS_MESSAGE_BSWAP32(m, m->header->fields_size);
 118 }
 119
 120 static inline void bus_message_unrefp(sd_bus_message **m) {
 121         sd_bus_message_unref(*m);
 122 }
 123
 124 #define _cleanup_bus_message_unref_ __attribute__((cleanup(bus_message_unrefp)))
 125
 126 int bus_message_seal(sd_bus_message *m, uint64_t serial);
 127 int bus_message_dump(sd_bus_message *m);
 128 int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
 129 int bus_message_from_malloc(void *buffer, size_t length, sd_bus_message **ret);
 130 int bus_message_read_strv_extend(sd_bus_message *m, char ***l);