1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2013 Lennart Poettering
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.
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.
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/>.
26 #include <sys/socket.h>
31 #include "time-util.h"
32 #include "bus-creds.h"
33 #include "bus-protocol.h"
35 struct bus_container {
39 /* Indexes into the signature string */
40 unsigned index, saved_index;
43 size_t before, begin, end;
45 /* dbus1: pointer to the array size value, if this is a value */
48 /* gvariant: list of offsets to end of children if this is struct/dict entry/array */
49 size_t *offsets, n_offsets, offsets_allocated, offset_index;
52 char *peeked_signature;
55 struct bus_body_part {
56 struct bus_body_part *next;
62 uint64_t memfd_offset;
70 struct sd_bus_message {
75 uint64_t reply_cookie;
78 const char *interface;
80 const char *destination;
91 uint64_t verify_destination_id;
102 /* The first and last bytes of the message */
103 struct bus_header *header;
106 /* How many bytes are accessible in the above pointers */
107 size_t header_accessible;
108 size_t footer_accessible;
112 size_t user_body_size;
114 struct bus_body_part body;
115 struct bus_body_part *body_end;
116 unsigned n_body_parts;
119 struct bus_body_part *cached_rindex_part;
120 size_t cached_rindex_part_begin;
125 struct bus_container root_container, *containers;
127 size_t containers_allocated;
130 struct iovec iovec_fixed[2];
133 struct kdbus_msg *kdbus;
135 char *peeked_signature;
137 /* If set replies to this message must carry the signature
138 * specified here to successfully seal. This is initialized
139 * from the vtable data */
140 const char *enforced_reply_signature;
144 char sender_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
145 char destination_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
146 char *destination_ptr;
148 size_t header_offsets[_BUS_MESSAGE_HEADER_MAX];
149 unsigned n_header_offsets;
152 static inline bool BUS_MESSAGE_NEED_BSWAP(sd_bus_message *m) {
153 return m->header->endian != BUS_NATIVE_ENDIAN;
156 static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
157 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
160 static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
161 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
164 static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
165 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
168 static inline uint64_t BUS_MESSAGE_COOKIE(sd_bus_message *m) {
169 if (m->header->version == 2)
170 return BUS_MESSAGE_BSWAP64(m, m->header->dbus2.cookie);
172 return BUS_MESSAGE_BSWAP32(m, m->header->dbus1.serial);
175 static inline size_t BUS_MESSAGE_SIZE(sd_bus_message *m) {
177 sizeof(struct bus_header) +
178 ALIGN8(m->fields_size) +
182 static inline size_t BUS_MESSAGE_BODY_BEGIN(sd_bus_message *m) {
184 sizeof(struct bus_header) +
185 ALIGN8(m->fields_size);
188 static inline void* BUS_MESSAGE_FIELDS(sd_bus_message *m) {
189 return (uint8_t*) m->header + sizeof(struct bus_header);
192 static inline bool BUS_MESSAGE_IS_GVARIANT(sd_bus_message *m) {
193 return m->header->version == 2;
196 int bus_message_seal(sd_bus_message *m, uint64_t serial, usec_t timeout);
197 int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
198 int bus_message_read_strv_extend(sd_bus_message *m, char ***l);
200 int bus_message_from_header(
203 size_t header_accessible,
205 size_t footer_accessible,
209 const struct ucred *ucred,
212 sd_bus_message **ret);
214 int bus_message_from_malloc(
220 const struct ucred *ucred,
222 sd_bus_message **ret);
224 int bus_message_get_arg(sd_bus_message *m, unsigned i, const char **str, char ***strv);
226 int bus_message_append_ap(sd_bus_message *m, const char *types, va_list ap);
228 int bus_message_parse_fields(sd_bus_message *m);
230 struct bus_body_part *message_append_part(sd_bus_message *m);
232 #define MESSAGE_FOREACH_PART(part, i, m) \
233 for ((i) = 0, (part) = &(m)->body; (i) < (m)->n_body_parts; (i)++, (part) = (part)->next)
235 int bus_body_part_map(struct bus_body_part *part);
236 void bus_body_part_unmap(struct bus_body_part *part);
238 int bus_message_to_errno(sd_bus_message *m);
240 int bus_message_new_synthetic_error(sd_bus *bus, uint64_t serial, const sd_bus_error *e, sd_bus_message **m);
242 int bus_message_remarshal(sd_bus *bus, sd_bus_message **m);
244 int bus_message_append_sender(sd_bus_message *m, const char *sender);
246 void bus_message_set_sender_driver(sd_bus *bus, sd_bus_message *m);
247 void bus_message_set_sender_local(sd_bus *bus, sd_bus_message *m);