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/>.
29 #include "time-util.h"
30 #include "bus-creds.h"
31 #include "bus-protocol.h"
33 struct bus_container {
37 /* Indexes into the signature string */
38 unsigned index, saved_index;
41 size_t before, begin, end;
43 /* dbus1: pointer to the array size value, if this is a value */
46 /* gvariant: list of offsets to end of children if this is struct/dict entry/array */
47 size_t *offsets, n_offsets, offsets_allocated, offset_index;
50 char *peeked_signature;
53 struct bus_body_part {
54 struct bus_body_part *next;
60 uint64_t memfd_offset;
68 struct sd_bus_message {
73 uint64_t reply_cookie;
76 const char *interface;
78 const char *destination;
89 uint64_t verify_destination_id;
100 /* The first and last bytes of the message */
101 struct bus_header *header;
104 /* How many bytes are accessible in the above pointers */
105 size_t header_accessible;
106 size_t footer_accessible;
110 size_t user_body_size;
112 struct bus_body_part body;
113 struct bus_body_part *body_end;
114 unsigned n_body_parts;
117 struct bus_body_part *cached_rindex_part;
118 size_t cached_rindex_part_begin;
123 struct bus_container root_container, *containers;
125 size_t containers_allocated;
128 struct iovec iovec_fixed[2];
131 struct kdbus_msg *kdbus;
133 char *peeked_signature;
135 /* If set replies to this message must carry the signature
136 * specified here to successfully seal. This is initialized
137 * from the vtable data */
138 const char *enforced_reply_signature;
142 char sender_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
143 char destination_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
144 char *destination_ptr;
146 size_t header_offsets[_BUS_MESSAGE_HEADER_MAX];
147 unsigned n_header_offsets;
150 static inline bool BUS_MESSAGE_NEED_BSWAP(sd_bus_message *m) {
151 return m->header->endian != BUS_NATIVE_ENDIAN;
154 static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
155 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
158 static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
159 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
162 static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
163 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
166 static inline uint64_t BUS_MESSAGE_COOKIE(sd_bus_message *m) {
167 if (m->header->version == 2)
168 return BUS_MESSAGE_BSWAP64(m, m->header->dbus2.cookie);
170 return BUS_MESSAGE_BSWAP32(m, m->header->dbus1.serial);
173 static inline size_t BUS_MESSAGE_SIZE(sd_bus_message *m) {
175 sizeof(struct bus_header) +
176 ALIGN8(m->fields_size) +
180 static inline size_t BUS_MESSAGE_BODY_BEGIN(sd_bus_message *m) {
182 sizeof(struct bus_header) +
183 ALIGN8(m->fields_size);
186 static inline void* BUS_MESSAGE_FIELDS(sd_bus_message *m) {
187 return (uint8_t*) m->header + sizeof(struct bus_header);
190 static inline bool BUS_MESSAGE_IS_GVARIANT(sd_bus_message *m) {
191 return m->header->version == 2;
194 int bus_message_seal(sd_bus_message *m, uint64_t serial, usec_t timeout);
195 int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
196 int bus_message_read_strv_extend(sd_bus_message *m, char ***l);
198 int bus_message_from_header(
201 size_t header_accessible,
203 size_t footer_accessible,
207 const struct ucred *ucred,
210 sd_bus_message **ret);
212 int bus_message_from_malloc(
218 const struct ucred *ucred,
220 sd_bus_message **ret);
222 int bus_message_get_arg(sd_bus_message *m, unsigned i, const char **str, char ***strv);
224 int bus_message_append_ap(sd_bus_message *m, const char *types, va_list ap);
226 int bus_message_parse_fields(sd_bus_message *m);
228 struct bus_body_part *message_append_part(sd_bus_message *m);
230 #define MESSAGE_FOREACH_PART(part, i, m) \
231 for ((i) = 0, (part) = &(m)->body; (i) < (m)->n_body_parts; (i)++, (part) = (part)->next)
233 int bus_body_part_map(struct bus_body_part *part);
234 void bus_body_part_unmap(struct bus_body_part *part);
236 int bus_message_to_errno(sd_bus_message *m);
238 int bus_message_new_synthetic_error(sd_bus *bus, uint64_t serial, const sd_bus_error *e, sd_bus_message **m);
240 int bus_message_remarshal(sd_bus *bus, sd_bus_message **m);
242 int bus_message_append_sender(sd_bus_message *m, const char *sender);
244 void bus_message_set_sender_driver(sd_bus *bus, sd_bus_message *m);
245 void bus_message_set_sender_local(sd_bus *bus, sd_bus_message *m);