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
34 #include <babeltrace/ctf-ir/field-types.h>
35 #include <babeltrace/ctf-ir/field-types-internal.h>
36 #include <babeltrace/ctf-ir/fields.h>
37 #include <babeltrace/ctf-ir/fields-internal.h>
38 #include <babeltrace/ctf-writer/serialize-internal.h>
39 #include <babeltrace/align-internal.h>
40 #include <babeltrace/mmap-align-internal.h>
41 #include <babeltrace/endian-internal.h>
42 #include <babeltrace/bitfield-internal.h>
43 #include <babeltrace/compat/fcntl-internal.h>
44 #include <babeltrace/types.h>
45 #include <babeltrace/common-internal.h>
46 #include <babeltrace/assert-internal.h>
50 # error "Unsupported floating point radix"
59 * The aligned read/write functions are expected to be faster than the
60 * bitfield variants. They will be enabled eventually as an
64 int aligned_integer_write(struct bt_stream_pos
*pos
,
65 union intval value
, unsigned int alignment
, unsigned int size
,
66 bt_bool is_signed
, enum bt_byte_order byte_order
)
68 bt_bool rbo
= (byte_order
!= BT_MY_BYTE_ORDER
); /* reverse byte order */
70 if (!bt_stream_pos_align(pos
, alignment
))
73 if (!bt_stream_pos_access_ok(pos
, size
))
76 BT_ASSERT(!(pos
->offset
% CHAR_BIT
));
81 uint8_t v
= value
.unsignd
;
83 memcpy(bt_stream_pos_get_addr(pos
), &v
, sizeof(v
));
88 uint16_t v
= value
.unsignd
;
91 v
= GUINT16_SWAP_LE_BE(v
);
92 memcpy(bt_stream_pos_get_addr(pos
), &v
, sizeof(v
));
97 uint32_t v
= value
.unsignd
;
100 v
= GUINT32_SWAP_LE_BE(v
);
101 memcpy(bt_stream_pos_get_addr(pos
), &v
, sizeof(v
));
106 uint64_t v
= value
.unsignd
;
109 v
= GUINT64_SWAP_LE_BE(v
);
110 memcpy(bt_stream_pos_get_addr(pos
), &v
, sizeof(v
));
120 uint8_t v
= value
.signd
;
122 memcpy(bt_stream_pos_get_addr(pos
), &v
, sizeof(v
));
127 int16_t v
= value
.signd
;
130 v
= GUINT16_SWAP_LE_BE(v
);
131 memcpy(bt_stream_pos_get_addr(pos
), &v
, sizeof(v
));
136 int32_t v
= value
.signd
;
139 v
= GUINT32_SWAP_LE_BE(v
);
140 memcpy(bt_stream_pos_get_addr(pos
), &v
, sizeof(v
));
145 int64_t v
= value
.signd
;
148 v
= GUINT64_SWAP_LE_BE(v
);
149 memcpy(bt_stream_pos_get_addr(pos
), &v
, sizeof(v
));
157 if (!bt_stream_pos_move(pos
, size
))
163 int integer_write(struct bt_stream_pos
*pos
, union intval value
,
164 unsigned int alignment
, unsigned int size
, bt_bool is_signed
,
165 enum bt_byte_order byte_order
)
167 if (!(alignment
% CHAR_BIT
)
168 && !(size
% CHAR_BIT
)) {
169 return aligned_integer_write(pos
, value
, alignment
,
170 size
, is_signed
, byte_order
);
173 if (!bt_stream_pos_align(pos
, alignment
))
176 if (!bt_stream_pos_access_ok(pos
, size
))
180 if (byte_order
== BT_BYTE_ORDER_LITTLE_ENDIAN
)
181 bt_bitfield_write_le(mmap_align_addr(pos
->base_mma
) +
182 pos
->mmap_base_offset
, unsigned char,
183 pos
->offset
, size
, value
.unsignd
);
185 bt_bitfield_write_be(mmap_align_addr(pos
->base_mma
) +
186 pos
->mmap_base_offset
, unsigned char,
187 pos
->offset
, size
, value
.unsignd
);
189 if (byte_order
== BT_BYTE_ORDER_LITTLE_ENDIAN
)
190 bt_bitfield_write_le(mmap_align_addr(pos
->base_mma
) +
191 pos
->mmap_base_offset
, unsigned char,
192 pos
->offset
, size
, value
.signd
);
194 bt_bitfield_write_be(mmap_align_addr(pos
->base_mma
) +
195 pos
->mmap_base_offset
, unsigned char,
196 pos
->offset
, size
, value
.signd
);
199 if (!bt_stream_pos_move(pos
, size
))
205 int bt_field_integer_write(struct bt_field_integer
*int_field
,
206 struct bt_stream_pos
*pos
,
207 enum bt_byte_order native_byte_order
)
209 struct bt_field_type
*type
= int_field
->parent
.type
;
210 struct bt_field_type_integer
*int_type
= (void *) type
;
211 enum bt_byte_order byte_order
;
214 byte_order
= int_type
->user_byte_order
;
215 if (byte_order
== BT_BYTE_ORDER_NATIVE
) {
216 byte_order
= native_byte_order
;
219 value
.signd
= int_field
->payload
.signd
;
220 value
.unsignd
= int_field
->payload
.unsignd
;
221 return integer_write(pos
, value
, type
->alignment
,
222 int_type
->size
, int_type
->is_signed
,
227 int bt_field_floating_point_write(
228 struct bt_field_floating_point
*flt_field
,
229 struct bt_stream_pos
*pos
,
230 enum bt_byte_order native_byte_order
)
232 struct bt_field_type
*type
= flt_field
->parent
.type
;
233 struct bt_field_type_floating_point
*flt_type
= (void *) type
;
234 enum bt_byte_order byte_order
;
238 byte_order
= flt_type
->user_byte_order
;
239 if (byte_order
== BT_BYTE_ORDER_NATIVE
) {
240 byte_order
= native_byte_order
;
243 if (flt_type
->mant_dig
== FLT_MANT_DIG
) {
249 u32f
.f
= (float) flt_field
->payload
;
250 value
.unsignd
= u32f
.u
;
252 } else if (flt_type
->mant_dig
== DBL_MANT_DIG
) {
258 u64d
.d
= flt_field
->payload
;
259 value
.unsignd
= u64d
.u
;
265 return integer_write(pos
, value
, type
->alignment
, size
, BT_FALSE
,
270 void bt_stream_pos_packet_seek(struct bt_stream_pos
*pos
, size_t index
,
275 BT_ASSERT(whence
== SEEK_CUR
&& index
== 0);
279 ret
= munmap_align(pos
->base_mma
);
281 // FIXME: this can legitimately fail?
284 pos
->base_mma
= NULL
;
287 /* The writer will add padding */
288 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
289 pos
->packet_size
= PACKET_LEN_INCREMENT
;
291 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
292 pos
->packet_size
/ CHAR_BIT
);
293 } while (ret
== EINTR
);
297 /* map new base. Need mapping length from header. */
298 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
299 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
300 if (pos
->base_mma
== MAP_FAILED
) {
301 // FIXME: this can legitimately fail?