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
24 #define MSGPACK_FIXSTR_ID_MASK 0xA0
25 #define MSGPACK_FIXMAP_ID_MASK 0x80
26 #define MSGPACK_FIXARRAY_ID_MASK 0x90
28 #define MSGPACK_NIL_ID 0xC0
29 #define MSGPACK_FALSE_ID 0xC2
30 #define MSGPACK_TRUE_ID 0xC3
31 #define MSGPACK_MAP16_ID 0xDE
32 #define MSGPACK_ARRAY16_ID 0xDC
34 #define MSGPACK_UINT8_ID 0xCC
35 #define MSGPACK_UINT16_ID 0xCD
36 #define MSGPACK_UINT32_ID 0xCE
37 #define MSGPACK_UINT64_ID 0xCF
39 #define MSGPACK_INT8_ID 0xD0
40 #define MSGPACK_INT16_ID 0xD1
41 #define MSGPACK_INT32_ID 0xD2
42 #define MSGPACK_INT64_ID 0xD3
44 #define MSGPACK_FLOAT64_ID 0xCB
45 #define MSGPACK_STR16_ID 0xDA
47 #define MSGPACK_FIXINT_MAX ((1 << 7) - 1)
48 #define MSGPACK_FIXINT_MIN -(1 << 5)
49 #define MSGPACK_FIXMAP_MAX_COUNT 15
50 #define MSGPACK_FIXARRAY_MAX_COUNT 15
51 #define MSGPACK_FIXSTR_MAX_LENGTH 31
54 #include <linux/bug.h>
55 #include <linux/string.h>
56 #include <linux/types.h>
57 #include <asm/byteorder.h>
59 #include <lttng/msgpack.h>
60 #include <lttng/probe-user.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_user_buffer(
118 struct lttng_msgpack_writer
*writer
,
119 const uint8_t __user
*ubuf
,
124 lttng_msgpack_assert(ubuf
);
126 /* Ensure we are not trying to write after the end of the buffer. */
127 if (writer
->write_pos
+ length
> writer
->end_write_pos
) {
132 if (lttng_copy_from_user_check_nofault(writer
->write_pos
, ubuf
, length
)) {
136 writer
->write_pos
+= length
;
141 static inline int lttng_msgpack_append_u8(
142 struct lttng_msgpack_writer
*writer
, uint8_t value
)
144 return lttng_msgpack_append_buffer(writer
, &value
, sizeof(value
));
147 static inline int lttng_msgpack_append_u16(
148 struct lttng_msgpack_writer
*writer
, uint16_t value
)
150 value
= byteswap_host_to_be16(value
);
152 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
155 static inline int lttng_msgpack_append_u32(
156 struct lttng_msgpack_writer
*writer
, uint32_t value
)
158 value
= byteswap_host_to_be32(value
);
160 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
163 static inline int lttng_msgpack_append_u64(
164 struct lttng_msgpack_writer
*writer
, uint64_t value
)
166 value
= byteswap_host_to_be64(value
);
168 return lttng_msgpack_append_buffer(writer
, (uint8_t *) &value
, sizeof(value
));
171 static inline int lttng_msgpack_append_i8(
172 struct lttng_msgpack_writer
*writer
, int8_t value
)
174 return lttng_msgpack_append_u8(writer
, (uint8_t) value
);
177 static inline int lttng_msgpack_append_i16(
178 struct lttng_msgpack_writer
*writer
, int16_t value
)
180 return lttng_msgpack_append_u16(writer
, (uint16_t) value
);
183 static inline int lttng_msgpack_append_i32(
184 struct lttng_msgpack_writer
*writer
, int32_t value
)
186 return lttng_msgpack_append_u32(writer
, (uint32_t) value
);
189 static inline int lttng_msgpack_append_i64(
190 struct lttng_msgpack_writer
*writer
, int64_t value
)
192 return lttng_msgpack_append_u64(writer
, (uint64_t) value
);
195 static inline int lttng_msgpack_encode_fixmap(
196 struct lttng_msgpack_writer
*writer
, uint8_t count
)
200 lttng_msgpack_assert(count
<= MSGPACK_FIXMAP_MAX_COUNT
);
202 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXMAP_ID_MASK
| count
);
210 static inline int lttng_msgpack_encode_map16(
211 struct lttng_msgpack_writer
*writer
, uint16_t count
)
215 lttng_msgpack_assert(count
> MSGPACK_FIXMAP_MAX_COUNT
);
217 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_MAP16_ID
);
221 ret
= lttng_msgpack_append_u16(writer
, count
);
229 static inline int lttng_msgpack_encode_fixarray(
230 struct lttng_msgpack_writer
*writer
, uint8_t count
)
234 lttng_msgpack_assert(count
<= MSGPACK_FIXARRAY_MAX_COUNT
);
236 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXARRAY_ID_MASK
| count
);
244 static inline int lttng_msgpack_encode_array16(
245 struct lttng_msgpack_writer
*writer
, uint16_t count
)
249 lttng_msgpack_assert(count
> MSGPACK_FIXARRAY_MAX_COUNT
);
251 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_ARRAY16_ID
);
255 ret
= lttng_msgpack_append_u16(writer
, count
);
263 static inline int lttng_msgpack_encode_fixstr(
264 struct lttng_msgpack_writer
*writer
,
270 lttng_msgpack_assert(len
<= MSGPACK_FIXSTR_MAX_LENGTH
);
272 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXSTR_ID_MASK
| len
);
276 ret
= lttng_msgpack_append_buffer(writer
, (uint8_t *) str
, len
);
284 static inline int lttng_msgpack_encode_str16(
285 struct lttng_msgpack_writer
*writer
,
291 lttng_msgpack_assert(len
> MSGPACK_FIXSTR_MAX_LENGTH
);
293 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_STR16_ID
);
297 ret
= lttng_msgpack_append_u16(writer
, len
);
301 ret
= lttng_msgpack_append_buffer(writer
, (uint8_t *) str
, len
);
309 static inline int lttng_msgpack_encode_user_fixstr(
310 struct lttng_msgpack_writer
*writer
,
311 const char __user
*ustr
,
316 lttng_msgpack_assert(len
<= MSGPACK_FIXSTR_MAX_LENGTH
);
318 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_FIXSTR_ID_MASK
| len
);
322 ret
= lttng_msgpack_append_user_buffer(writer
, (uint8_t __user
*) ustr
, len
);
330 static inline int lttng_msgpack_encode_user_str16(
331 struct lttng_msgpack_writer
*writer
,
332 const char __user
*ustr
,
337 lttng_msgpack_assert(len
> MSGPACK_FIXSTR_MAX_LENGTH
);
339 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_STR16_ID
);
343 ret
= lttng_msgpack_append_u16(writer
, len
);
347 ret
= lttng_msgpack_append_user_buffer(writer
, (uint8_t __user
*) ustr
, len
);
356 int lttng_msgpack_begin_map(struct lttng_msgpack_writer
*writer
, size_t count
)
360 if (count
>= (1 << 16)) {
365 if (count
<= MSGPACK_FIXMAP_MAX_COUNT
)
366 ret
= lttng_msgpack_encode_fixmap(writer
, count
);
368 ret
= lttng_msgpack_encode_map16(writer
, count
);
370 writer
->map_nesting
++;
375 int lttng_msgpack_end_map(struct lttng_msgpack_writer
*writer
)
377 lttng_msgpack_assert(writer
->map_nesting
> 0);
378 writer
->map_nesting
--;
382 int lttng_msgpack_begin_array(
383 struct lttng_msgpack_writer
*writer
, size_t count
)
387 if (count
>= (1 << 16)) {
392 if (count
<= MSGPACK_FIXARRAY_MAX_COUNT
)
393 ret
= lttng_msgpack_encode_fixarray(writer
, count
);
395 ret
= lttng_msgpack_encode_array16(writer
, count
);
397 writer
->array_nesting
++;
402 int lttng_msgpack_end_array(struct lttng_msgpack_writer
*writer
)
404 lttng_msgpack_assert(writer
->array_nesting
> 0);
405 writer
->array_nesting
--;
409 int lttng_msgpack_write_str(struct lttng_msgpack_writer
*writer
,
413 size_t length
= strlen(str
);
415 if (length
>= (1 << 16)) {
420 if (length
<= MSGPACK_FIXSTR_MAX_LENGTH
)
421 ret
= lttng_msgpack_encode_fixstr(writer
, str
, length
);
423 ret
= lttng_msgpack_encode_str16(writer
, str
, length
);
430 * Provide the same behavior on lttng_strlen_user_inatomic page fault as the
431 * lttng ring buffer: truncate the last string character.
433 int lttng_msgpack_write_user_str(struct lttng_msgpack_writer
*writer
,
434 const char __user
*ustr
)
437 size_t length
= max_t(size_t, lttng_strlen_user_inatomic(ustr
), 1);
439 if (length
>= (1 << 16)) {
444 if (length
<= MSGPACK_FIXSTR_MAX_LENGTH
)
445 ret
= lttng_msgpack_encode_user_fixstr(writer
, ustr
, length
);
447 ret
= lttng_msgpack_encode_user_str16(writer
, ustr
, length
);
453 int lttng_msgpack_write_nil(struct lttng_msgpack_writer
*writer
)
455 return lttng_msgpack_append_u8(writer
, MSGPACK_NIL_ID
);
458 int lttng_msgpack_write_true(struct lttng_msgpack_writer
*writer
)
460 return lttng_msgpack_append_u8(writer
, MSGPACK_TRUE_ID
);
463 int lttng_msgpack_write_false(struct lttng_msgpack_writer
*writer
)
465 return lttng_msgpack_append_u8(writer
, MSGPACK_FALSE_ID
);
468 int lttng_msgpack_write_unsigned_integer(
469 struct lttng_msgpack_writer
*writer
, uint64_t value
)
473 if (value
<= MSGPACK_FIXINT_MAX
) {
474 ret
= lttng_msgpack_append_u8(writer
, (uint8_t) value
);
477 } else if (value
<= UINT8_MAX
) {
478 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT8_ID
);
482 ret
= lttng_msgpack_append_u8(writer
, (uint8_t) value
);
485 } else if (value
<= UINT16_MAX
) {
486 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT16_ID
);
490 ret
= lttng_msgpack_append_u16(writer
, (uint16_t) value
);
493 } else if (value
<= UINT32_MAX
) {
494 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT32_ID
);
498 ret
= lttng_msgpack_append_u32(writer
, (uint32_t) value
);
502 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_UINT64_ID
);
506 ret
= lttng_msgpack_append_u64(writer
, value
);
515 int lttng_msgpack_write_signed_integer(struct lttng_msgpack_writer
*writer
, int64_t value
)
519 if (value
>= MSGPACK_FIXINT_MIN
&& value
<= MSGPACK_FIXINT_MAX
){
520 ret
= lttng_msgpack_append_i8(writer
, (int8_t) value
);
523 } else if (value
>= INT8_MIN
&& value
<= INT8_MAX
) {
524 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT8_ID
);
528 ret
= lttng_msgpack_append_i8(writer
, (int8_t) value
);
531 } else if (value
>= INT16_MIN
&& value
<= INT16_MAX
) {
532 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT16_ID
);
536 ret
= lttng_msgpack_append_i16(writer
, (int16_t) value
);
539 } else if (value
>= INT32_MIN
&& value
<= INT32_MAX
) {
540 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT32_ID
);
544 ret
= lttng_msgpack_append_i32(writer
, (int32_t) value
);
548 ret
= lttng_msgpack_append_u8(writer
, MSGPACK_INT64_ID
);
552 ret
= lttng_msgpack_append_i64(writer
, value
);
561 int lttng_msgpack_save_writer_pos(struct lttng_msgpack_writer
*writer
, uint8_t **pos
)
563 *pos
= writer
->write_pos
;
567 int lttng_msgpack_restore_writer_pos(struct lttng_msgpack_writer
*writer
, uint8_t *pos
)
569 writer
->write_pos
= pos
;
573 void lttng_msgpack_writer_init(struct lttng_msgpack_writer
*writer
,
574 uint8_t *buffer
, size_t size
)
576 lttng_msgpack_assert(buffer
);
577 lttng_msgpack_assert(size
>= 0);
579 writer
->buffer
= buffer
;
580 writer
->write_pos
= buffer
;
581 writer
->end_write_pos
= buffer
+ size
;
583 writer
->array_nesting
= 0;
584 writer
->map_nesting
= 0;
587 void lttng_msgpack_writer_fini(struct lttng_msgpack_writer
*writer
)
589 memset(writer
, 0, sizeof(*writer
));