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>
30 #include "time-util.h"
31 #include "bus-creds.h"
32 #include "bus-protocol.h"
34 struct bus_container
{
38 /* Indexes into the signature string */
39 unsigned index
, saved_index
;
42 size_t before
, begin
, end
;
44 /* dbus1: pointer to the array size value, if this is a value */
47 /* gvariant: list of offsets to end of children if this is struct/dict entry/array */
48 size_t *offsets
, n_offsets
, offsets_allocated
, offset_index
;
51 char *peeked_signature
;
54 struct bus_body_part
{
55 struct bus_body_part
*next
;
61 uint64_t memfd_offset
;
69 struct sd_bus_message
{
74 uint64_t reply_cookie
;
77 const char *interface
;
79 const char *destination
;
90 uint64_t verify_destination_id
;
101 /* The first and last bytes of the message */
102 struct bus_header
*header
;
105 /* How many bytes are accessible in the above pointers */
106 size_t header_accessible
;
107 size_t footer_accessible
;
111 size_t user_body_size
;
113 struct bus_body_part body
;
114 struct bus_body_part
*body_end
;
115 unsigned n_body_parts
;
118 struct bus_body_part
*cached_rindex_part
;
119 size_t cached_rindex_part_begin
;
124 struct bus_container root_container
, *containers
;
126 size_t containers_allocated
;
129 struct iovec iovec_fixed
[2];
132 struct kdbus_msg
*kdbus
;
134 char *peeked_signature
;
136 /* If set replies to this message must carry the signature
137 * specified here to successfully seal. This is initialized
138 * from the vtable data */
139 const char *enforced_reply_signature
;
143 char sender_buffer
[3 + DECIMAL_STR_MAX(uint64_t) + 1];
144 char destination_buffer
[3 + DECIMAL_STR_MAX(uint64_t) + 1];
145 char *destination_ptr
;
147 size_t header_offsets
[_BUS_MESSAGE_HEADER_MAX
];
148 unsigned n_header_offsets
;
151 static inline bool BUS_MESSAGE_NEED_BSWAP(sd_bus_message
*m
) {
152 return 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 if (m
->header
->version
== 2)
169 return BUS_MESSAGE_BSWAP64(m
, m
->header
->dbus2
.cookie
);
171 return BUS_MESSAGE_BSWAP32(m
, m
->header
->dbus1
.serial
);
174 static inline size_t BUS_MESSAGE_SIZE(sd_bus_message
*m
) {
176 sizeof(struct bus_header
) +
177 ALIGN8(m
->fields_size
) +
181 static inline size_t BUS_MESSAGE_BODY_BEGIN(sd_bus_message
*m
) {
183 sizeof(struct bus_header
) +
184 ALIGN8(m
->fields_size
);
187 static inline void* BUS_MESSAGE_FIELDS(sd_bus_message
*m
) {
188 return (uint8_t*) m
->header
+ sizeof(struct bus_header
);
191 static inline bool BUS_MESSAGE_IS_GVARIANT(sd_bus_message
*m
) {
192 return m
->header
->version
== 2;
195 int bus_message_seal(sd_bus_message
*m
, uint64_t serial
, usec_t timeout
);
196 int bus_message_get_blob(sd_bus_message
*m
, void **buffer
, size_t *sz
);
197 int bus_message_read_strv_extend(sd_bus_message
*m
, char ***l
);
199 int bus_message_from_header(
202 size_t header_accessible
,
204 size_t footer_accessible
,
208 const struct ucred
*ucred
,
211 sd_bus_message
**ret
);
213 int bus_message_from_malloc(
219 const struct ucred
*ucred
,
221 sd_bus_message
**ret
);
223 int bus_message_get_arg(sd_bus_message
*m
, unsigned i
, const char **str
, char ***strv
);
225 int bus_message_append_ap(sd_bus_message
*m
, const char *types
, va_list ap
);
227 int bus_message_parse_fields(sd_bus_message
*m
);
229 struct bus_body_part
*message_append_part(sd_bus_message
*m
);
231 #define MESSAGE_FOREACH_PART(part, i, m) \
232 for ((i) = 0, (part) = &(m)->body; (i) < (m)->n_body_parts; (i)++, (part) = (part)->next)
234 int bus_body_part_map(struct bus_body_part
*part
);
235 void bus_body_part_unmap(struct bus_body_part
*part
);
237 int bus_message_to_errno(sd_bus_message
*m
);
239 int bus_message_new_synthetic_error(sd_bus
*bus
, uint64_t serial
, const sd_bus_error
*e
, sd_bus_message
**m
);
241 int bus_message_remarshal(sd_bus
*bus
, sd_bus_message
**m
);
243 int bus_message_append_sender(sd_bus_message
*m
, const char *sender
);
245 void bus_message_set_sender_driver(sd_bus
*bus
, sd_bus_message
*m
);
246 void bus_message_set_sender_local(sd_bus
*bus
, sd_bus_message
*m
);