4 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
8 * The original author of the serialization functions for Babeltrace 1
9 * is Mathieu Desnoyers. Philippe Proulx modified the functions in 2017
10 * to use Babeltrace 2 objects.
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 #define BT_LOG_TAG "CTF-WRITER-SERIALIZE"
32 #include <babeltrace/lib-logging-internal.h>
37 #include <babeltrace/ctf-writer/fields.h>
38 #include <babeltrace/ctf-writer/field-types.h>
39 #include <babeltrace/ctf-writer/serialize-internal.h>
40 #include <babeltrace/ctf-ir/utils-internal.h>
41 #include <babeltrace/ctf-ir/fields-internal.h>
42 #include <babeltrace/ctf-ir/field-types-internal.h>
43 #include <babeltrace/align-internal.h>
44 #include <babeltrace/mmap-align-internal.h>
45 #include <babeltrace/endian-internal.h>
46 #include <babeltrace/bitfield-internal.h>
47 #include <babeltrace/compat/fcntl-internal.h>
48 #include <babeltrace/types.h>
49 #include <babeltrace/common-internal.h>
53 # error "Unsupported floating point radix"
62 * The aligned read/write functions are expected to be faster than the
63 * bitfield variants. They will be enabled eventually as an
67 int aligned_integer_write(struct bt_ctf_stream_pos
*pos
, union intval value
,
68 unsigned int alignment
, unsigned int size
, bt_bool is_signed
,
69 enum bt_ctf_byte_order byte_order
)
71 bt_bool rbo
= (byte_order
!= BT_MY_BYTE_ORDER
); /* reverse byte order */
73 if (!bt_ctf_stream_pos_align(pos
, alignment
))
76 if (!bt_ctf_stream_pos_access_ok(pos
, size
))
79 BT_ASSERT(!(pos
->offset
% CHAR_BIT
));
84 uint8_t v
= value
.unsignd
;
86 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
91 uint16_t v
= value
.unsignd
;
94 v
= GUINT16_SWAP_LE_BE(v
);
95 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
100 uint32_t v
= value
.unsignd
;
103 v
= GUINT32_SWAP_LE_BE(v
);
104 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
109 uint64_t v
= value
.unsignd
;
112 v
= GUINT64_SWAP_LE_BE(v
);
113 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
123 uint8_t v
= value
.signd
;
125 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
130 int16_t v
= value
.signd
;
133 v
= GUINT16_SWAP_LE_BE(v
);
134 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
139 int32_t v
= value
.signd
;
142 v
= GUINT32_SWAP_LE_BE(v
);
143 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
148 int64_t v
= value
.signd
;
151 v
= GUINT64_SWAP_LE_BE(v
);
152 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
160 if (!bt_ctf_stream_pos_move(pos
, size
))
166 int integer_write(struct bt_ctf_stream_pos
*pos
, union intval value
,
167 unsigned int alignment
, unsigned int size
, bt_bool is_signed
,
168 enum bt_ctf_byte_order byte_order
)
170 if (!(alignment
% CHAR_BIT
)
171 && !(size
% CHAR_BIT
)) {
172 return aligned_integer_write(pos
, value
, alignment
,
173 size
, is_signed
, byte_order
);
176 if (!bt_ctf_stream_pos_align(pos
, alignment
))
179 if (!bt_ctf_stream_pos_access_ok(pos
, size
))
183 if (byte_order
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
)
184 bt_bitfield_write_le(mmap_align_addr(pos
->base_mma
) +
185 pos
->mmap_base_offset
, unsigned char,
186 pos
->offset
, size
, value
.unsignd
);
188 bt_bitfield_write_be(mmap_align_addr(pos
->base_mma
) +
189 pos
->mmap_base_offset
, unsigned char,
190 pos
->offset
, size
, value
.unsignd
);
192 if (byte_order
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
)
193 bt_bitfield_write_le(mmap_align_addr(pos
->base_mma
) +
194 pos
->mmap_base_offset
, unsigned char,
195 pos
->offset
, size
, value
.signd
);
197 bt_bitfield_write_be(mmap_align_addr(pos
->base_mma
) +
198 pos
->mmap_base_offset
, unsigned char,
199 pos
->offset
, size
, value
.signd
);
202 if (!bt_ctf_stream_pos_move(pos
, size
))
208 int bt_ctf_field_integer_write(struct bt_field_common
*field
,
209 struct bt_ctf_stream_pos
*pos
,
210 enum bt_ctf_byte_order native_byte_order
)
212 struct bt_field_type_common_integer
*int_type
=
213 BT_FROM_COMMON(field
->type
);
214 struct bt_field_common_integer
*int_field
= BT_FROM_COMMON(field
);
215 enum bt_ctf_byte_order byte_order
;
218 byte_order
= (int) int_type
->user_byte_order
;
219 if (byte_order
== BT_BYTE_ORDER_NATIVE
) {
220 byte_order
= native_byte_order
;
223 value
.signd
= int_field
->payload
.signd
;
224 value
.unsignd
= int_field
->payload
.unsignd
;
225 return integer_write(pos
, value
, int_type
->common
.alignment
,
226 int_type
->size
, int_type
->is_signed
,
231 int bt_ctf_field_floating_point_write(
232 struct bt_field_common
*field
,
233 struct bt_ctf_stream_pos
*pos
,
234 enum bt_ctf_byte_order native_byte_order
)
236 struct bt_field_type_common_floating_point
*flt_type
=
237 BT_FROM_COMMON(field
->type
);
238 struct bt_field_common_floating_point
*flt_field
= BT_FROM_COMMON(field
);
239 enum bt_ctf_byte_order byte_order
;
243 byte_order
= (int) flt_type
->user_byte_order
;
244 if (byte_order
== BT_BYTE_ORDER_NATIVE
) {
245 byte_order
= native_byte_order
;
248 if (flt_type
->mant_dig
== FLT_MANT_DIG
) {
254 u32f
.f
= (float) flt_field
->payload
;
255 value
.unsignd
= u32f
.u
;
257 } else if (flt_type
->mant_dig
== DBL_MANT_DIG
) {
263 u64d
.d
= flt_field
->payload
;
264 value
.unsignd
= u64d
.u
;
270 return integer_write(pos
, value
, flt_type
->common
.alignment
,
271 size
, BT_FALSE
, byte_order
);
275 void bt_ctf_stream_pos_packet_seek(struct bt_ctf_stream_pos
*pos
, size_t index
,
280 BT_ASSERT(whence
== SEEK_CUR
&& index
== 0);
284 ret
= munmap_align(pos
->base_mma
);
286 // FIXME: this can legitimately fail?
289 pos
->base_mma
= NULL
;
292 /* The writer will add padding */
293 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
294 pos
->packet_size
= PACKET_LEN_INCREMENT
;
296 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
297 pos
->packet_size
/ CHAR_BIT
);
298 } while (ret
== EINTR
);
302 /* map new base. Need mapping length from header. */
303 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
304 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
305 if (pos
->base_mma
== MAP_FAILED
) {
306 // FIXME: this can legitimately fail?