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>
49 # error "Unsupported floating point radix"
58 * The aligned read/write functions are expected to be faster than the
59 * bitfield variants. They will be enabled eventually as an
63 int aligned_integer_write(struct bt_ctf_stream_pos
*pos
,
64 union intval value
, unsigned int alignment
, unsigned int size
,
65 bt_bool is_signed
, enum bt_ctf_byte_order byte_order
)
67 bt_bool rbo
= (byte_order
!= BT_CTF_MY_BYTE_ORDER
); /* reverse byte order */
69 if (!bt_ctf_stream_pos_align(pos
, alignment
))
72 if (!bt_ctf_stream_pos_access_ok(pos
, size
))
75 assert(!(pos
->offset
% CHAR_BIT
));
80 uint8_t v
= value
.unsignd
;
82 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
87 uint16_t v
= value
.unsignd
;
90 v
= GUINT16_SWAP_LE_BE(v
);
91 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
96 uint32_t v
= value
.unsignd
;
99 v
= GUINT32_SWAP_LE_BE(v
);
100 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
105 uint64_t v
= value
.unsignd
;
108 v
= GUINT64_SWAP_LE_BE(v
);
109 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
119 uint8_t v
= value
.signd
;
121 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
126 int16_t v
= value
.signd
;
129 v
= GUINT16_SWAP_LE_BE(v
);
130 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
135 int32_t v
= value
.signd
;
138 v
= GUINT32_SWAP_LE_BE(v
);
139 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
144 int64_t v
= value
.signd
;
147 v
= GUINT64_SWAP_LE_BE(v
);
148 memcpy(bt_ctf_stream_pos_get_addr(pos
), &v
, sizeof(v
));
156 if (!bt_ctf_stream_pos_move(pos
, size
))
162 int integer_write(struct bt_ctf_stream_pos
*pos
, union intval value
,
163 unsigned int alignment
, unsigned int size
, bt_bool is_signed
,
164 enum bt_ctf_byte_order byte_order
)
166 if (!(alignment
% CHAR_BIT
)
167 && !(size
% CHAR_BIT
)) {
168 return aligned_integer_write(pos
, value
, alignment
,
169 size
, is_signed
, byte_order
);
172 if (!bt_ctf_stream_pos_align(pos
, alignment
))
175 if (!bt_ctf_stream_pos_access_ok(pos
, size
))
179 if (byte_order
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
)
180 bt_bitfield_write_le(mmap_align_addr(pos
->base_mma
) +
181 pos
->mmap_base_offset
, unsigned char,
182 pos
->offset
, size
, value
.unsignd
);
184 bt_bitfield_write_be(mmap_align_addr(pos
->base_mma
) +
185 pos
->mmap_base_offset
, unsigned char,
186 pos
->offset
, size
, value
.unsignd
);
188 if (byte_order
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
)
189 bt_bitfield_write_le(mmap_align_addr(pos
->base_mma
) +
190 pos
->mmap_base_offset
, unsigned char,
191 pos
->offset
, size
, value
.signd
);
193 bt_bitfield_write_be(mmap_align_addr(pos
->base_mma
) +
194 pos
->mmap_base_offset
, unsigned char,
195 pos
->offset
, size
, value
.signd
);
198 if (!bt_ctf_stream_pos_move(pos
, size
))
204 int bt_ctf_field_integer_write(struct bt_ctf_field_integer
*int_field
,
205 struct bt_ctf_stream_pos
*pos
,
206 enum bt_ctf_byte_order native_byte_order
)
208 struct bt_ctf_field_type
*type
= int_field
->parent
.type
;
209 struct bt_ctf_field_type_integer
*int_type
= (void *) type
;
210 enum bt_ctf_byte_order byte_order
;
213 byte_order
= int_type
->user_byte_order
;
214 if (byte_order
== BT_CTF_BYTE_ORDER_NATIVE
) {
215 byte_order
= native_byte_order
;
218 value
.signd
= int_field
->payload
.signd
;
219 value
.unsignd
= int_field
->payload
.unsignd
;
220 return integer_write(pos
, value
, type
->alignment
,
221 int_type
->size
, int_type
->is_signed
,
226 int bt_ctf_field_floating_point_write(
227 struct bt_ctf_field_floating_point
*flt_field
,
228 struct bt_ctf_stream_pos
*pos
,
229 enum bt_ctf_byte_order native_byte_order
)
231 struct bt_ctf_field_type
*type
= flt_field
->parent
.type
;
232 struct bt_ctf_field_type_floating_point
*flt_type
= (void *) type
;
233 enum bt_ctf_byte_order byte_order
;
237 byte_order
= flt_type
->user_byte_order
;
238 if (byte_order
== BT_CTF_BYTE_ORDER_NATIVE
) {
239 byte_order
= native_byte_order
;
242 if (flt_type
->mant_dig
== FLT_MANT_DIG
) {
248 u32f
.f
= (float) flt_field
->payload
;
249 value
.unsignd
= u32f
.u
;
251 } else if (flt_type
->mant_dig
== DBL_MANT_DIG
) {
257 u64d
.d
= flt_field
->payload
;
258 value
.unsignd
= u64d
.u
;
264 return integer_write(pos
, value
, type
->alignment
, size
, BT_FALSE
,
269 void bt_ctf_stream_pos_packet_seek(struct bt_ctf_stream_pos
*pos
, size_t index
,
274 assert(whence
== SEEK_CUR
&& index
== 0);
278 ret
= munmap_align(pos
->base_mma
);
280 // FIXME: this can legitimately fail?
283 pos
->base_mma
= NULL
;
286 /* The writer will add padding */
287 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
288 pos
->packet_size
= PACKET_LEN_INCREMENT
;
290 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
291 pos
->packet_size
/ CHAR_BIT
);
292 } while (ret
== EINTR
);
296 /* map new base. Need mapping length from header. */
297 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
298 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
299 if (pos
->base_mma
== MAP_FAILED
) {
300 // FIXME: this can legitimately fail?