2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
10 #define MSGPACK_FIXSTR_ID_MASK 0xA0
11 #define MSGPACK_FIXMAP_ID_MASK 0x80
12 #define MSGPACK_FIXARRAY_ID_MASK 0x90
14 #define MSGPACK_NIL_ID 0xC0
15 #define MSGPACK_FALSE_ID 0xC2
16 #define MSGPACK_TRUE_ID 0xC3
17 #define MSGPACK_MAP16_ID 0xDE
18 #define MSGPACK_ARRAY16_ID 0xDC
20 #define MSGPACK_UINT8_ID 0xCC
21 #define MSGPACK_UINT16_ID 0xCD
22 #define MSGPACK_UINT32_ID 0xCE
23 #define MSGPACK_UINT64_ID 0xCF
25 #define MSGPACK_INT8_ID 0xD0
26 #define MSGPACK_INT16_ID 0xD1
27 #define MSGPACK_INT32_ID 0xD2
28 #define MSGPACK_INT64_ID 0xD3
30 #define MSGPACK_FLOAT64_ID 0xCB
31 #define MSGPACK_STR16_ID 0xDA
33 #define MSGPACK_FIXINT_MAX ((1 << 7) - 1)
34 #define MSGPACK_FIXINT_MIN -(1 << 5)
35 #define MSGPACK_FIXMAP_MAX_COUNT 15
36 #define MSGPACK_FIXARRAY_MAX_COUNT 15
37 #define MSGPACK_FIXSTR_MAX_LENGTH 31
40 #include <linux/bug.h>
41 #include <linux/string.h>
42 #include <linux/types.h>
44 #include <lttng/msgpack.h>
46 #define INT8_MIN (-128)
47 #define INT16_MIN (-32767-1)
48 #define INT32_MIN (-2147483647-1)
49 #define INT8_MAX (127)
50 #define INT16_MAX (32767)
51 #define INT32_MAX (2147483647)
52 #define UINT8_MAX (255)
53 #define UINT16_MAX (65535)
54 #define UINT32_MAX (4294967295U)
56 #define byteswap_host_to_be16(_tmp) cpu_to_be16(_tmp)
57 #define byteswap_host_to_be32(_tmp) cpu_to_be32(_tmp)
58 #define byteswap_host_to_be64(_tmp) cpu_to_be64(_tmp)
60 #define lttng_msgpack_assert(cond) WARN_ON(!(cond))
62 #else /* __KERNEL__ */
64 #include <lttng/ust-endian.h>
70 #define byteswap_host_to_be16(_tmp) htobe16(_tmp)
71 #define byteswap_host_to_be32(_tmp) htobe32(_tmp)
72 #define byteswap_host_to_be64(_tmp) htobe64(_tmp)
74 #define lttng_msgpack_assert(cond) ({ \
76 fprintf(stderr, "Assertion failed. %s:%d\n", __FILE__, __LINE__); \
78 #endif /* __KERNEL__ */
80 static inline int lttng_msgpack_append_buffer(
81 struct lttng_msgpack_writer
*writer
,
87 lttng_msgpack_assert(buf
);
89 /* Ensure we are not trying to write after the end of the buffer. */
90 if (writer
->write_pos
+ length
> writer
->end_write_pos
) {
95 memcpy(writer
->write_pos
, buf
, length
);
96 writer
->write_pos
+= length
;
101 static inline int lttng_msgpack_append_u8(
102 struct lttng_msgpack_writer
*writer
, uint8_t value
)
104 return lttng_msgpack_append_buffer(writer
, &value
, sizeof(value
));
107 static inline int lttng_msgpack_append_u16(
108 struct lttng_msgpack_writer
*writer
, uint16_t value
)
110 value
= byteswap_host_to_be16(value
);
112 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
115 static inline int lttng_msgpack_append_u32(
116 struct lttng_msgpack_writer
*writer
, uint32_t value
)
118 value
= byteswap_host_to_be32(value
);
120 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
123 static inline int lttng_msgpack_append_u64(
124 struct lttng_msgpack_writer
*writer
, uint64_t value
)
126 value
= byteswap_host_to_be64(value
);
128 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
131 static inline int lttng_msgpack_append_f64(
132 struct lttng_msgpack_writer
*writer
, double value
)
142 return lttng_msgpack_append_u64(writer
, u
.u
);
145 static inline int lttng_msgpack_append_i8(
146 struct lttng_msgpack_writer
*writer
, int8_t value
)
148 return lttng_msgpack_append_u8(writer
, (uint8_t) value
);
151 static inline int lttng_msgpack_append_i16(
152 struct lttng_msgpack_writer
*writer
, int16_t value
)
154 return lttng_msgpack_append_u16(writer
, (uint16_t) value
);
157 static inline int lttng_msgpack_append_i32(
158 struct lttng_msgpack_writer
*writer
, int32_t value
)
160 return lttng_msgpack_append_u32(writer
, (uint32_t) value
);
163 static inline int lttng_msgpack_append_i64(
164 struct lttng_msgpack_writer
*writer
, int64_t value
)
166 return lttng_msgpack_append_u64(writer
, (uint64_t) value
);
169 static inline int lttng_msgpack_encode_f64(
170 struct lttng_msgpack_writer
*writer
, double value
)
174 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FLOAT64_ID
);
178 ret
= lttng_msgpack_append_f64(writer
, value
);
186 static inline int lttng_msgpack_encode_fixmap(
187 struct lttng_msgpack_writer
*writer
, uint8_t count
)
191 lttng_msgpack_assert(count
<= MSGPACK_FIXMAP_MAX_COUNT
);
193 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXMAP_ID_MASK
| count
);
201 static inline int lttng_msgpack_encode_map16(
202 struct lttng_msgpack_writer
*writer
, uint16_t count
)
206 lttng_msgpack_assert(count
> MSGPACK_FIXMAP_MAX_COUNT
);
208 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_MAP16_ID
);
212 ret
= lttng_msgpack_append_u16(writer
, count
);
220 static inline int lttng_msgpack_encode_fixarray(
221 struct lttng_msgpack_writer
*writer
, uint8_t count
)
225 lttng_msgpack_assert(count
<= MSGPACK_FIXARRAY_MAX_COUNT
);
227 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXARRAY_ID_MASK
| count
);
235 static inline int lttng_msgpack_encode_array16(
236 struct lttng_msgpack_writer
*writer
, uint16_t count
)
240 lttng_msgpack_assert(count
> MSGPACK_FIXARRAY_MAX_COUNT
);
242 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_ARRAY16_ID
);
246 ret
= lttng_msgpack_append_u16(writer
, count
);
254 static inline int lttng_msgpack_encode_fixstr(
255 struct lttng_msgpack_writer
*writer
,
261 lttng_msgpack_assert(len
<= MSGPACK_FIXSTR_MAX_LENGTH
);
263 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXSTR_ID_MASK
| len
);
267 ret
= lttng_msgpack_append_buffer(writer
, (uint8_t *) str
, len
);
275 static inline int lttng_msgpack_encode_str16(
276 struct lttng_msgpack_writer
*writer
,
282 lttng_msgpack_assert(len
> MSGPACK_FIXSTR_MAX_LENGTH
);
284 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_STR16_ID
);
288 ret
= lttng_msgpack_append_u16(writer
, len
);
292 ret
= lttng_msgpack_append_buffer(writer
, (uint8_t *) str
, len
);
300 int lttng_msgpack_begin_map(struct lttng_msgpack_writer
*writer
, size_t count
)
304 if (count
>= (1 << 16)) {
309 if (count
<= MSGPACK_FIXMAP_MAX_COUNT
)
310 ret
= lttng_msgpack_encode_fixmap(writer
, count
);
312 ret
= lttng_msgpack_encode_map16(writer
, count
);
314 writer
->map_nesting
++;
319 int lttng_msgpack_end_map(struct lttng_msgpack_writer
*writer
)
321 lttng_msgpack_assert(writer
->map_nesting
> 0);
322 writer
->map_nesting
--;
326 int lttng_msgpack_begin_array(
327 struct lttng_msgpack_writer
*writer
, size_t count
)
331 if (count
>= (1 << 16)) {
336 if (count
<= MSGPACK_FIXARRAY_MAX_COUNT
)
337 ret
= lttng_msgpack_encode_fixarray(writer
, count
);
339 ret
= lttng_msgpack_encode_array16(writer
, count
);
341 writer
->array_nesting
++;
346 int lttng_msgpack_end_array(struct lttng_msgpack_writer
*writer
)
348 lttng_msgpack_assert(writer
->array_nesting
> 0);
349 writer
->array_nesting
--;
353 int lttng_msgpack_write_str(struct lttng_msgpack_writer
*writer
,
357 size_t length
= strlen(str
);
359 if (length
>= (1 << 16)) {
364 if (length
<= MSGPACK_FIXSTR_MAX_LENGTH
)
365 ret
= lttng_msgpack_encode_fixstr(writer
, str
, length
);
367 ret
= lttng_msgpack_encode_str16(writer
, str
, length
);
373 int lttng_msgpack_write_nil(struct lttng_msgpack_writer
*writer
)
375 return lttng_msgpack_append_u8(writer
, MSGPACK_NIL_ID
);
378 int lttng_msgpack_write_true(struct lttng_msgpack_writer
*writer
)
380 return lttng_msgpack_append_u8(writer
, MSGPACK_TRUE_ID
);
383 int lttng_msgpack_write_false(struct lttng_msgpack_writer
*writer
)
385 return lttng_msgpack_append_u8(writer
, MSGPACK_FALSE_ID
);
388 int lttng_msgpack_write_unsigned_integer(
389 struct lttng_msgpack_writer
*writer
, uint64_t value
)
393 if (value
<= MSGPACK_FIXINT_MAX
) {
394 ret
= lttng_msgpack_append_u8(writer
, (uint8_t) value
);
397 } else if (value
<= UINT8_MAX
) {
398 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT8_ID
);
402 ret
= lttng_msgpack_append_u8(writer
, (uint8_t) value
);
405 } else if (value
<= UINT16_MAX
) {
406 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT16_ID
);
410 ret
= lttng_msgpack_append_u16(writer
, (uint16_t) value
);
413 } else if (value
<= UINT32_MAX
) {
414 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT32_ID
);
418 ret
= lttng_msgpack_append_u32(writer
, (uint32_t) value
);
422 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT64_ID
);
426 ret
= lttng_msgpack_append_u64(writer
, value
);
435 int lttng_msgpack_write_signed_integer(struct lttng_msgpack_writer
*writer
, int64_t value
)
439 if (value
>= MSGPACK_FIXINT_MIN
&& value
<= MSGPACK_FIXINT_MAX
){
440 ret
= lttng_msgpack_append_i8(writer
, (int8_t) value
);
443 } else if (value
>= INT8_MIN
&& value
<= INT8_MAX
) {
444 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT8_ID
);
448 ret
= lttng_msgpack_append_i8(writer
, (int8_t) value
);
451 } else if (value
>= INT16_MIN
&& value
<= INT16_MAX
) {
452 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT16_ID
);
456 ret
= lttng_msgpack_append_i16(writer
, (int16_t) value
);
459 } else if (value
>= INT32_MIN
&& value
<= INT32_MAX
) {
460 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT32_ID
);
464 ret
= lttng_msgpack_append_i32(writer
, (int32_t) value
);
468 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT64_ID
);
472 ret
= lttng_msgpack_append_i64(writer
, value
);
481 int lttng_msgpack_write_double(struct lttng_msgpack_writer
*writer
, double value
)
483 return lttng_msgpack_encode_f64(writer
, value
);
486 void lttng_msgpack_writer_init(struct lttng_msgpack_writer
*writer
,
487 uint8_t *buffer
, size_t size
)
489 lttng_msgpack_assert(buffer
);
490 lttng_msgpack_assert(size
>= 0);
492 writer
->buffer
= buffer
;
493 writer
->write_pos
= buffer
;
494 writer
->end_write_pos
= buffer
+ size
;
496 writer
->array_nesting
= 0;
497 writer
->map_nesting
= 0;
500 void lttng_msgpack_writer_fini(struct lttng_msgpack_writer
*writer
)
502 memset(writer
, 0, sizeof(*writer
));