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;
62 /* Note that what the bus spec calls "serial" we'll call
63 "cookie" instead, because we don't want to imply that the
64 cookie was in any way monotonically increasing. */
69 struct bus_body_part {
70 struct bus_body_part *next;
82 struct sd_bus_message {
87 uint64_t reply_cookie;
90 const char *interface;
92 const char *destination;
103 uint64_t verify_destination_id;
111 bool release_kdbus:1;
114 struct bus_header *header;
115 struct bus_body_part body;
116 struct bus_body_part *body_end;
117 unsigned n_body_parts;
120 struct bus_body_part *cached_rindex_part;
121 size_t cached_rindex_part_begin;
126 struct bus_container root_container, *containers;
127 unsigned n_containers;
128 size_t containers_allocated;
131 struct iovec iovec_fixed[2];
134 struct kdbus_msg *kdbus;
136 char *peeked_signature;
138 /* If set replies to this message must carry the signature
139 * specified here to successfully seal. This is initialized
140 * from the vtable data */
141 const char *enforced_reply_signature;
145 char sender_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
146 char destination_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
147 char *destination_ptr;
149 size_t header_offsets[_BUS_MESSAGE_HEADER_MAX];
150 unsigned n_header_offsets;
153 #define BUS_MESSAGE_NEED_BSWAP(m) ((m)->header->endian != BUS_NATIVE_ENDIAN)
155 static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
156 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
159 static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
160 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
163 static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
164 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
167 static inline uint64_t BUS_MESSAGE_COOKIE(sd_bus_message *m) {
168 /* Note that we return the serial converted to a 64bit value here */
169 return BUS_MESSAGE_BSWAP32(m, m->header->serial);
172 static inline uint32_t BUS_MESSAGE_BODY_SIZE(sd_bus_message *m) {
173 return BUS_MESSAGE_BSWAP32(m, m->header->body_size);
176 static inline uint32_t BUS_MESSAGE_FIELDS_SIZE(sd_bus_message *m) {
177 return BUS_MESSAGE_BSWAP32(m, m->header->fields_size);
180 static inline uint32_t BUS_MESSAGE_SIZE(sd_bus_message *m) {
182 sizeof(struct bus_header) +
183 ALIGN8(BUS_MESSAGE_FIELDS_SIZE(m)) +
184 BUS_MESSAGE_BODY_SIZE(m);
187 static inline uint32_t BUS_MESSAGE_BODY_BEGIN(sd_bus_message *m) {
189 sizeof(struct bus_header) +
190 ALIGN8(BUS_MESSAGE_FIELDS_SIZE(m));
193 static inline void* BUS_MESSAGE_FIELDS(sd_bus_message *m) {
194 return (uint8_t*) m->header + sizeof(struct bus_header);
197 static inline bool BUS_MESSAGE_IS_GVARIANT(sd_bus_message *m) {
198 return m->header->version == 2;
201 int bus_message_seal(sd_bus_message *m, uint64_t serial, usec_t timeout);
202 int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
203 int bus_message_read_strv_extend(sd_bus_message *m, char ***l);
205 int bus_message_from_header(
211 const struct ucred *ucred,
214 sd_bus_message **ret);
216 int bus_message_from_malloc(
222 const struct ucred *ucred,
224 sd_bus_message **ret);
226 const char* bus_message_get_arg(sd_bus_message *m, unsigned i);
228 int bus_message_append_ap(sd_bus_message *m, const char *types, va_list ap);
230 int bus_message_parse_fields(sd_bus_message *m);
232 bool bus_header_is_complete(struct bus_header *h, size_t size);
233 int bus_header_message_size(struct bus_header *h, size_t *sum);
235 struct bus_body_part *message_append_part(sd_bus_message *m);
237 #define MESSAGE_FOREACH_PART(part, i, m) \
238 for ((i) = 0, (part) = &(m)->body; (i) < (m)->n_body_parts; (i)++, (part) = (part)->next)
240 int bus_body_part_map(struct bus_body_part *part);
241 void bus_body_part_unmap(struct bus_body_part *part);
243 int bus_message_to_errno(sd_bus_message *m);
245 int bus_message_new_synthetic_error(sd_bus *bus, uint64_t serial, const sd_bus_error *e, sd_bus_message **m);
247 int bus_message_remarshal(sd_bus *bus, sd_bus_message **m);
249 int bus_message_append_sender(sd_bus_message *m, const char *sender);