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