4 * Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; only
9 * version 2.1 of the License.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #define MSGPACK_FIXSTR_ID_MASK 0xA0
26 #define MSGPACK_FIXMAP_ID_MASK 0x80
27 #define MSGPACK_FIXARRAY_ID_MASK 0x90
29 #define MSGPACK_NIL_ID 0xC0
30 #define MSGPACK_FALSE_ID 0xC2
31 #define MSGPACK_TRUE_ID 0xC3
32 #define MSGPACK_MAP16_ID 0xDE
33 #define MSGPACK_ARRAY16_ID 0xDC
35 #define MSGPACK_UINT8_ID 0xCC
36 #define MSGPACK_UINT16_ID 0xCD
37 #define MSGPACK_UINT32_ID 0xCE
38 #define MSGPACK_UINT64_ID 0xCF
40 #define MSGPACK_INT8_ID 0xD0
41 #define MSGPACK_INT16_ID 0xD1
42 #define MSGPACK_INT32_ID 0xD2
43 #define MSGPACK_INT64_ID 0xD3
45 #define MSGPACK_FLOAT64_ID 0xCB
46 #define MSGPACK_STR16_ID 0xDA
48 #define MSGPACK_FIXINT_MAX ((1 << 7) - 1)
49 #define MSGPACK_FIXINT_MIN -(1 << 5)
50 #define MSGPACK_FIXMAP_MAX_COUNT 15
51 #define MSGPACK_FIXARRAY_MAX_COUNT 15
52 #define MSGPACK_FIXSTR_MAX_LENGTH 31
55 #include <linux/bug.h>
56 #include <linux/string.h>
57 #include <linux/types.h>
58 #include <asm/byteorder.h>
60 #include <lttng/msgpack.h>
62 #define INT8_MIN (-128)
63 #define INT16_MIN (-32767-1)
64 #define INT32_MIN (-2147483647-1)
65 #define INT8_MAX (127)
66 #define INT16_MAX (32767)
67 #define INT32_MAX (2147483647)
68 #define UINT8_MAX (255)
69 #define UINT16_MAX (65535)
70 #define UINT32_MAX (4294967295U)
72 #define byteswap_host_to_be16(_tmp) cpu_to_be16(_tmp)
73 #define byteswap_host_to_be32(_tmp) cpu_to_be32(_tmp)
74 #define byteswap_host_to_be64(_tmp) cpu_to_be64(_tmp)
76 #define lttng_msgpack_assert(cond) WARN_ON(!(cond))
78 #else /* __KERNEL__ */
86 #define byteswap_host_to_be16(_tmp) htobe16(_tmp)
87 #define byteswap_host_to_be32(_tmp) htobe32(_tmp)
88 #define byteswap_host_to_be64(_tmp) htobe64(_tmp)
90 #define lttng_msgpack_assert(cond) ({ \
92 fprintf(stderr, "Assertion failed. %s:%d\n", __FILE__, __LINE__); \
94 #endif /* __KERNEL__ */
96 static inline int lttng_msgpack_append_buffer(
97 struct lttng_msgpack_writer
*writer
,
103 lttng_msgpack_assert(buf
);
105 /* Ensure we are not trying to write after the end of the buffer. */
106 if (writer
->write_pos
+ length
> writer
->end_write_pos
) {
111 memcpy(writer
->write_pos
, buf
, length
);
112 writer
->write_pos
+= length
;
117 static inline int lttng_msgpack_append_u8(
118 struct lttng_msgpack_writer
*writer
, uint8_t value
)
120 return lttng_msgpack_append_buffer(writer
, &value
, sizeof(value
));
123 static inline int lttng_msgpack_append_u16(
124 struct lttng_msgpack_writer
*writer
, uint16_t value
)
126 value
= byteswap_host_to_be16(value
);
128 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
131 static inline int lttng_msgpack_append_u32(
132 struct lttng_msgpack_writer
*writer
, uint32_t value
)
134 value
= byteswap_host_to_be32(value
);
136 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
139 static inline int lttng_msgpack_append_u64(
140 struct lttng_msgpack_writer
*writer
, uint64_t value
)
142 value
= byteswap_host_to_be64(value
);
144 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
147 static inline int lttng_msgpack_append_i8(
148 struct lttng_msgpack_writer
*writer
, int8_t value
)
150 return lttng_msgpack_append_u8(writer
, (uint8_t) value
);
153 static inline int lttng_msgpack_append_i16(
154 struct lttng_msgpack_writer
*writer
, int16_t value
)
156 return lttng_msgpack_append_u16(writer
, (uint16_t) value
);
159 static inline int lttng_msgpack_append_i32(
160 struct lttng_msgpack_writer
*writer
, int32_t value
)
162 return lttng_msgpack_append_u32(writer
, (uint32_t) value
);
165 static inline int lttng_msgpack_append_i64(
166 struct lttng_msgpack_writer
*writer
, int64_t value
)
168 return lttng_msgpack_append_u64(writer
, (uint64_t) value
);
171 static inline int lttng_msgpack_encode_fixmap(
172 struct lttng_msgpack_writer
*writer
, uint8_t count
)
176 lttng_msgpack_assert(count
<= MSGPACK_FIXMAP_MAX_COUNT
);
178 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXMAP_ID_MASK
| count
);
186 static inline int lttng_msgpack_encode_map16(
187 struct lttng_msgpack_writer
*writer
, uint16_t count
)
191 lttng_msgpack_assert(count
> MSGPACK_FIXMAP_MAX_COUNT
);
193 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_MAP16_ID
);
197 ret
= lttng_msgpack_append_u16(writer
, count
);
205 static inline int lttng_msgpack_encode_fixarray(
206 struct lttng_msgpack_writer
*writer
, uint8_t count
)
210 lttng_msgpack_assert(count
<= MSGPACK_FIXARRAY_MAX_COUNT
);
212 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXARRAY_ID_MASK
| count
);
220 static inline int lttng_msgpack_encode_array16(
221 struct lttng_msgpack_writer
*writer
, uint16_t count
)
225 lttng_msgpack_assert(count
> MSGPACK_FIXARRAY_MAX_COUNT
);
227 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_ARRAY16_ID
);
231 ret
= lttng_msgpack_append_u16(writer
, count
);
239 static inline int lttng_msgpack_encode_fixstr(
240 struct lttng_msgpack_writer
*writer
,
246 lttng_msgpack_assert(len
<= MSGPACK_FIXSTR_MAX_LENGTH
);
248 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXSTR_ID_MASK
| len
);
252 ret
= lttng_msgpack_append_buffer(writer
, (uint8_t *) str
, len
);
260 static inline int lttng_msgpack_encode_str16(
261 struct lttng_msgpack_writer
*writer
,
267 lttng_msgpack_assert(len
> MSGPACK_FIXSTR_MAX_LENGTH
);
269 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_STR16_ID
);
273 ret
= lttng_msgpack_append_u16(writer
, len
);
277 ret
= lttng_msgpack_append_buffer(writer
, (uint8_t *) str
, len
);
285 int lttng_msgpack_begin_map(struct lttng_msgpack_writer
*writer
, size_t count
)
289 if (count
>= (1 << 16)) {
294 if (count
<= MSGPACK_FIXMAP_MAX_COUNT
)
295 ret
= lttng_msgpack_encode_fixmap(writer
, count
);
297 ret
= lttng_msgpack_encode_map16(writer
, count
);
299 writer
->map_nesting
++;
304 int lttng_msgpack_end_map(struct lttng_msgpack_writer
*writer
)
306 lttng_msgpack_assert(writer
->map_nesting
> 0);
307 writer
->map_nesting
--;
311 int lttng_msgpack_begin_array(
312 struct lttng_msgpack_writer
*writer
, size_t count
)
316 if (count
>= (1 << 16)) {
321 if (count
<= MSGPACK_FIXARRAY_MAX_COUNT
)
322 ret
= lttng_msgpack_encode_fixarray(writer
, count
);
324 ret
= lttng_msgpack_encode_array16(writer
, count
);
326 writer
->array_nesting
++;
331 int lttng_msgpack_end_array(struct lttng_msgpack_writer
*writer
)
333 lttng_msgpack_assert(writer
->array_nesting
> 0);
334 writer
->array_nesting
--;
338 int lttng_msgpack_write_str(struct lttng_msgpack_writer
*writer
,
342 size_t length
= strlen(str
);
344 if (length
>= (1 << 16)) {
349 if (length
<= MSGPACK_FIXSTR_MAX_LENGTH
)
350 ret
= lttng_msgpack_encode_fixstr(writer
, str
, length
);
352 ret
= lttng_msgpack_encode_str16(writer
, str
, length
);
358 int lttng_msgpack_write_nil(struct lttng_msgpack_writer
*writer
)
360 return lttng_msgpack_append_u8(writer
, MSGPACK_NIL_ID
);
363 int lttng_msgpack_write_true(struct lttng_msgpack_writer
*writer
)
365 return lttng_msgpack_append_u8(writer
, MSGPACK_TRUE_ID
);
368 int lttng_msgpack_write_false(struct lttng_msgpack_writer
*writer
)
370 return lttng_msgpack_append_u8(writer
, MSGPACK_FALSE_ID
);
373 int lttng_msgpack_write_unsigned_integer(
374 struct lttng_msgpack_writer
*writer
, uint64_t value
)
378 if (value
<= MSGPACK_FIXINT_MAX
) {
379 ret
= lttng_msgpack_append_u8(writer
, (uint8_t) value
);
382 } else if (value
<= UINT8_MAX
) {
383 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT8_ID
);
387 ret
= lttng_msgpack_append_u8(writer
, (uint8_t) value
);
390 } else if (value
<= UINT16_MAX
) {
391 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT16_ID
);
395 ret
= lttng_msgpack_append_u16(writer
, (uint16_t) value
);
398 } else if (value
<= UINT32_MAX
) {
399 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT32_ID
);
403 ret
= lttng_msgpack_append_u32(writer
, (uint32_t) value
);
407 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT64_ID
);
411 ret
= lttng_msgpack_append_u64(writer
, value
);
420 int lttng_msgpack_write_signed_integer(struct lttng_msgpack_writer
*writer
, int64_t value
)
424 if (value
>= MSGPACK_FIXINT_MIN
&& value
<= MSGPACK_FIXINT_MAX
){
425 ret
= lttng_msgpack_append_i8(writer
, (int8_t) value
);
428 } else if (value
>= INT8_MIN
&& value
<= INT8_MAX
) {
429 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT8_ID
);
433 ret
= lttng_msgpack_append_i8(writer
, (int8_t) value
);
436 } else if (value
>= INT16_MIN
&& value
<= INT16_MAX
) {
437 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT16_ID
);
441 ret
= lttng_msgpack_append_i16(writer
, (int16_t) value
);
444 } else if (value
>= INT32_MIN
&& value
<= INT32_MAX
) {
445 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT32_ID
);
449 ret
= lttng_msgpack_append_i32(writer
, (int32_t) value
);
453 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT64_ID
);
457 ret
= lttng_msgpack_append_i64(writer
, value
);
466 void lttng_msgpack_writer_init(struct lttng_msgpack_writer
*writer
,
467 uint8_t *buffer
, size_t size
)
469 lttng_msgpack_assert(buffer
);
470 lttng_msgpack_assert(size
>= 0);
472 writer
->buffer
= buffer
;
473 writer
->write_pos
= buffer
;
474 writer
->end_write_pos
= buffer
+ size
;
476 writer
->array_nesting
= 0;
477 writer
->map_nesting
= 0;
480 void lttng_msgpack_writer_fini(struct lttng_msgpack_writer
*writer
)
482 memset(writer
, 0, sizeof(*writer
));