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 struct bus_header *header;
103 struct bus_body_part body;
104 struct bus_body_part *body_end;
105 unsigned n_body_parts;
108 struct bus_body_part *cached_rindex_part;
109 size_t cached_rindex_part_begin;
114 struct bus_container root_container, *containers;
115 unsigned n_containers;
116 size_t containers_allocated;
119 struct iovec iovec_fixed[2];
122 struct kdbus_msg *kdbus;
124 char *peeked_signature;
126 /* If set replies to this message must carry the signature
127 * specified here to successfully seal. This is initialized
128 * from the vtable data */
129 const char *enforced_reply_signature;
133 char sender_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
134 char destination_buffer[3 + DECIMAL_STR_MAX(uint64_t) + 1];
135 char *destination_ptr;
137 size_t header_offsets[_BUS_MESSAGE_HEADER_MAX];
138 unsigned n_header_offsets;
141 #define BUS_MESSAGE_NEED_BSWAP(m) ((m)->header->endian != BUS_NATIVE_ENDIAN)
143 static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
144 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
147 static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
148 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
151 static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
152 return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
155 static inline uint64_t BUS_MESSAGE_COOKIE(sd_bus_message *m) {
156 /* Note that we return the serial converted to a 64bit value here */
157 return BUS_MESSAGE_BSWAP32(m, m->header->serial);
160 static inline uint32_t BUS_MESSAGE_BODY_SIZE(sd_bus_message *m) {
161 return BUS_MESSAGE_BSWAP32(m, m->header->body_size);
164 static inline uint32_t BUS_MESSAGE_FIELDS_SIZE(sd_bus_message *m) {
165 return BUS_MESSAGE_BSWAP32(m, m->header->fields_size);
168 static inline uint32_t BUS_MESSAGE_SIZE(sd_bus_message *m) {
170 sizeof(struct bus_header) +
171 ALIGN8(BUS_MESSAGE_FIELDS_SIZE(m)) +
172 BUS_MESSAGE_BODY_SIZE(m);
175 static inline uint32_t BUS_MESSAGE_BODY_BEGIN(sd_bus_message *m) {
177 sizeof(struct bus_header) +
178 ALIGN8(BUS_MESSAGE_FIELDS_SIZE(m));
181 static inline void* BUS_MESSAGE_FIELDS(sd_bus_message *m) {
182 return (uint8_t*) m->header + sizeof(struct bus_header);
185 static inline bool BUS_MESSAGE_IS_GVARIANT(sd_bus_message *m) {
186 return m->header->version == 2;
189 int bus_message_seal(sd_bus_message *m, uint64_t serial, usec_t timeout);
190 int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
191 int bus_message_read_strv_extend(sd_bus_message *m, char ***l);
193 int bus_message_from_header(
199 const struct ucred *ucred,
202 sd_bus_message **ret);
204 int bus_message_from_malloc(
210 const struct ucred *ucred,
212 sd_bus_message **ret);
214 int bus_message_get_arg(sd_bus_message *m, unsigned i, const char **str, char ***strv);
216 int bus_message_append_ap(sd_bus_message *m, const char *types, va_list ap);
218 int bus_message_parse_fields(sd_bus_message *m);
220 bool bus_header_is_complete(struct bus_header *h, size_t size);
221 int bus_header_message_size(struct bus_header *h, size_t *sum);
223 struct bus_body_part *message_append_part(sd_bus_message *m);
225 #define MESSAGE_FOREACH_PART(part, i, m) \
226 for ((i) = 0, (part) = &(m)->body; (i) < (m)->n_body_parts; (i)++, (part) = (part)->next)
228 int bus_body_part_map(struct bus_body_part *part);
229 void bus_body_part_unmap(struct bus_body_part *part);
231 int bus_message_to_errno(sd_bus_message *m);
233 int bus_message_new_synthetic_error(sd_bus *bus, uint64_t serial, const sd_bus_error *e, sd_bus_message **m);
235 int bus_message_remarshal(sd_bus *bus, sd_bus_message **m);
237 int bus_message_append_sender(sd_bus_message *m, const char *sender);