2 * Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #include "common/compat/string.h"
9 #include "common/macros.h"
10 #include "lttng/lttng-error.h"
12 #include <common/buffer-view.h>
13 #include <common/dynamic-array.h>
14 #include <common/dynamic-buffer.h>
15 #include <common/error.h>
16 #include <common/sessiond-comm/sessiond-comm.h>
17 #include <common/align.h>
18 #include <lttng/constant.h>
19 #include <lttng/event-internal.h>
20 #include <lttng/event.h>
21 #include <lttng/userspace-probe-internal.h>
25 struct event_list_element
{
26 struct lttng_event
*event
;
27 struct lttng_event_exclusion
*exclusions
;
28 char *filter_expression
;
31 static void event_list_destructor(void *ptr
)
33 struct event_list_element
*element
= (struct event_list_element
*) ptr
;
35 free(element
->filter_expression
);
36 free(element
->exclusions
);
37 lttng_event_destroy(element
->event
);
42 struct lttng_event
*lttng_event_copy(const struct lttng_event
*event
)
44 struct lttng_event
*new_event
;
45 struct lttng_event_extended
*new_event_extended
;
47 new_event
= zmalloc(sizeof(*event
));
49 PERROR("Error allocating event structure");
53 /* Copy the content of the old event. */
54 memcpy(new_event
, event
, sizeof(*event
));
57 * We need to create a new extended since the previous pointer is now
60 new_event_extended
= zmalloc(sizeof(*new_event_extended
));
61 if (!new_event_extended
) {
62 PERROR("Error allocating event extended structure");
66 new_event
->extended
.ptr
= new_event_extended
;
75 static int lttng_event_probe_attr_serialize(
76 const struct lttng_event_probe_attr
*probe
,
77 struct lttng_payload
*payload
)
80 size_t symbol_name_len
;
81 struct lttng_event_probe_attr_comm comm
= { 0 };
83 symbol_name_len
= lttng_strnlen(probe
->symbol_name
, LTTNG_SYMBOL_NAME_LEN
);
84 if (symbol_name_len
== LTTNG_SYMBOL_NAME_LEN
) {
85 /* Not null-termintated. */
90 /* Include the null terminator. */
93 comm
.symbol_name_len
= (uint32_t) symbol_name_len
;
94 comm
.addr
= probe
->addr
;
95 comm
.offset
= probe
->addr
;
97 ret
= lttng_dynamic_buffer_append(
98 &payload
->buffer
, &comm
, sizeof(comm
));
104 ret
= lttng_dynamic_buffer_append(
105 &payload
->buffer
, probe
->symbol_name
, symbol_name_len
);
110 static int lttng_event_function_attr_serialize(
111 const struct lttng_event_function_attr
*function
,
112 struct lttng_payload
*payload
)
115 size_t symbol_name_len
;
116 struct lttng_event_function_attr_comm comm
= { 0 };
118 symbol_name_len
= lttng_strnlen(function
->symbol_name
, LTTNG_SYMBOL_NAME_LEN
);
119 if (symbol_name_len
== LTTNG_SYMBOL_NAME_LEN
) {
120 /* Not null-termintated. */
125 /* Include the null terminator. */
126 symbol_name_len
+= 1;
128 comm
.symbol_name_len
= (uint32_t) symbol_name_len
;
130 ret
= lttng_dynamic_buffer_append(
131 &payload
->buffer
, &comm
, sizeof(comm
));
137 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
138 function
->symbol_name
, symbol_name_len
);
143 static ssize_t
lttng_event_probe_attr_create_from_payload(
144 struct lttng_payload_view
*view
,
145 struct lttng_event_probe_attr
**probe_attr
)
147 ssize_t ret
, offset
= 0;
148 const struct lttng_event_probe_attr_comm
*comm
;
149 struct lttng_event_probe_attr
*local_attr
= NULL
;
150 struct lttng_payload_view comm_view
= lttng_payload_view_from_view(
151 view
, offset
, sizeof(*comm
));
153 if (!lttng_payload_view_is_valid(&comm_view
)) {
158 comm
= (typeof(comm
)) comm_view
.buffer
.data
;
159 offset
+= sizeof(*comm
);
161 local_attr
= (struct lttng_event_probe_attr
*) zmalloc(
162 sizeof(*local_attr
));
163 if (local_attr
== NULL
) {
168 local_attr
->addr
= comm
->addr
;
169 local_attr
->offset
= comm
->offset
;
173 struct lttng_payload_view name_view
=
174 lttng_payload_view_from_view(view
, offset
,
175 comm
->symbol_name_len
);
177 if (!lttng_payload_view_is_valid(&name_view
)) {
182 name
= name_view
.buffer
.data
;
184 if (!lttng_buffer_view_contains_string(&name_view
.buffer
, name
,
185 comm
->symbol_name_len
)) {
190 ret
= lttng_strncpy(local_attr
->symbol_name
, name
,
191 LTTNG_SYMBOL_NAME_LEN
);
197 offset
+= comm
->symbol_name_len
;
200 *probe_attr
= local_attr
;
207 static ssize_t
lttng_event_function_attr_create_from_payload(
208 struct lttng_payload_view
*view
,
209 struct lttng_event_function_attr
**function_attr
)
211 ssize_t ret
, offset
= 0;
212 const struct lttng_event_function_attr_comm
*comm
;
213 struct lttng_event_function_attr
*local_attr
= NULL
;
214 struct lttng_payload_view comm_view
= lttng_payload_view_from_view(
215 view
, offset
, sizeof(*comm
));
217 if (!lttng_payload_view_is_valid(&comm_view
)) {
222 comm
= (typeof(comm
)) view
->buffer
.data
;
223 offset
+= sizeof(*comm
);
225 local_attr
= (struct lttng_event_function_attr
*) zmalloc(
226 sizeof(*local_attr
));
227 if (local_attr
== NULL
) {
234 struct lttng_payload_view name_view
=
235 lttng_payload_view_from_view(view
, offset
,
236 comm
->symbol_name_len
);
238 if (!lttng_payload_view_is_valid(&name_view
)) {
243 name
= name_view
.buffer
.data
;
245 if (!lttng_buffer_view_contains_string(&name_view
.buffer
, name
,
246 comm
->symbol_name_len
)) {
251 ret
= lttng_strncpy(local_attr
->symbol_name
, name
,
252 LTTNG_SYMBOL_NAME_LEN
);
258 offset
+= comm
->symbol_name_len
;
261 *function_attr
= local_attr
;
268 static ssize_t
lttng_event_exclusions_create_from_payload(
269 struct lttng_payload_view
*view
,
271 struct lttng_event_exclusion
**exclusions
)
273 ssize_t ret
, offset
= 0;
274 size_t size
= (count
* LTTNG_SYMBOL_NAME_LEN
);
276 const struct lttng_event_exclusion_comm
*comm
;
277 struct lttng_event_exclusion
*local_exclusions
;
279 local_exclusions
= (struct lttng_event_exclusion
*) zmalloc(
280 sizeof(struct lttng_event_exclusion
) + size
);
281 if (!local_exclusions
) {
286 local_exclusions
->count
= count
;
288 for (i
= 0; i
< count
; i
++) {
290 struct lttng_buffer_view string_view
;
291 const struct lttng_buffer_view comm_view
=
292 lttng_buffer_view_from_view(&view
->buffer
,
293 offset
, sizeof(*comm
));
295 if (!lttng_buffer_view_is_valid(&comm_view
)) {
300 comm
= (typeof(comm
)) comm_view
.data
;
301 offset
+= sizeof(*comm
);
303 string_view
= lttng_buffer_view_from_view(
304 &view
->buffer
, offset
, comm
->len
);
306 if (!lttng_buffer_view_is_valid(&string_view
)) {
311 string
= string_view
.data
;
313 if (!lttng_buffer_view_contains_string(
314 &string_view
, string
, comm
->len
)) {
319 ret
= lttng_strncpy(local_exclusions
->names
[i
],
320 string
, LTTNG_SYMBOL_NAME_LEN
);
329 *exclusions
= local_exclusions
;
330 local_exclusions
= NULL
;
333 free(local_exclusions
);
337 ssize_t
lttng_event_create_from_payload(struct lttng_payload_view
*view
,
338 struct lttng_event
**out_event
,
339 struct lttng_event_exclusion
**out_exclusion
,
340 char **out_filter_expression
,
341 struct lttng_bytecode
**out_bytecode
)
343 ssize_t ret
, offset
= 0;
344 struct lttng_event
*local_event
= NULL
;
345 struct lttng_event_exclusion
*local_exclusions
= NULL
;
346 struct lttng_bytecode
*local_bytecode
= NULL
;
347 char *local_filter_expression
= NULL
;
348 const struct lttng_event_comm
*event_comm
;
349 struct lttng_event_function_attr
*local_function_attr
= NULL
;
350 struct lttng_event_probe_attr
*local_probe_attr
= NULL
;
351 struct lttng_userspace_probe_location
*local_userspace_probe_location
=
355 * Only event is obligatory, the other output argument are optional and
356 * depends on what the caller is interested in.
362 struct lttng_payload_view comm_view
=
363 lttng_payload_view_from_view(view
, offset
,
364 sizeof(*event_comm
));
366 if (!lttng_payload_view_is_valid(&comm_view
)) {
371 /* lttng_event_comm header */
372 event_comm
= (typeof(event_comm
)) comm_view
.buffer
.data
;
373 offset
+= sizeof(*event_comm
);
376 local_event
= lttng_event_create();
377 if (local_event
== NULL
) {
382 local_event
->type
= (enum lttng_event_type
) event_comm
->event_type
;
383 local_event
->loglevel_type
= (enum lttng_loglevel_type
) event_comm
->loglevel_type
;
384 local_event
->loglevel
= event_comm
->loglevel
;
385 local_event
->enabled
= event_comm
->enabled
;
386 local_event
->pid
= event_comm
->pid
;
387 local_event
->flags
= (enum lttng_event_flag
) event_comm
->flags
;
391 const struct lttng_buffer_view name_view
=
392 lttng_buffer_view_from_view(&view
->buffer
,
393 offset
, event_comm
->name_len
);
395 if (!lttng_buffer_view_is_valid(&name_view
)) {
400 name
= (const char *) name_view
.data
;
402 if (!lttng_buffer_view_contains_string(
403 &name_view
, name
, event_comm
->name_len
)) {
409 local_event
->name
, name
, LTTNG_SYMBOL_NAME_LEN
);
415 offset
+= event_comm
->name_len
;
419 if (event_comm
->exclusion_count
== 0) {
420 goto deserialize_filter_expression
;
424 struct lttng_payload_view exclusions_view
=
425 lttng_payload_view_from_view(
428 if (!lttng_payload_view_is_valid(&exclusions_view
)) {
433 ret
= lttng_event_exclusions_create_from_payload(&exclusions_view
,
434 event_comm
->exclusion_count
, &local_exclusions
);
441 local_event
->exclusion
= 1;
444 deserialize_filter_expression
:
446 if (event_comm
->filter_expression_len
== 0) {
447 if (event_comm
->bytecode_len
!= 0) {
449 * This is an invalid event payload.
451 * Filter expression without bytecode is possible but
452 * not the other way around.
457 goto deserialize_event_type_payload
;
461 const char *filter_expression_buffer
;
462 struct lttng_buffer_view filter_expression_view
=
463 lttng_buffer_view_from_view(&view
->buffer
, offset
,
464 event_comm
->filter_expression_len
);
466 if (!lttng_buffer_view_is_valid(&filter_expression_view
)) {
471 filter_expression_buffer
= filter_expression_view
.data
;
473 if (!lttng_buffer_view_contains_string(&filter_expression_view
,
474 filter_expression_buffer
,
475 event_comm
->filter_expression_len
)) {
480 local_filter_expression
= lttng_strndup(
481 filter_expression_buffer
,
482 event_comm
->filter_expression_len
);
483 if (!local_filter_expression
) {
488 local_event
->filter
= 1;
490 offset
+= event_comm
->filter_expression_len
;
493 if (event_comm
->bytecode_len
== 0) {
495 * Filter expression can be present but without bytecode
496 * when dealing with event listing.
498 goto deserialize_event_type_payload
;
503 struct lttng_payload_view bytecode_view
=
504 lttng_payload_view_from_view(view
, offset
,
505 event_comm
->bytecode_len
);
507 if (!lttng_payload_view_is_valid(&bytecode_view
)) {
512 local_bytecode
= (struct lttng_bytecode
*) zmalloc(
513 event_comm
->bytecode_len
);
514 if (!local_bytecode
) {
519 memcpy(local_bytecode
, bytecode_view
.buffer
.data
,
520 event_comm
->bytecode_len
);
521 if ((local_bytecode
->len
+ sizeof(*local_bytecode
)) !=
522 event_comm
->bytecode_len
) {
527 offset
+= event_comm
->bytecode_len
;
530 deserialize_event_type_payload
:
531 /* Event type specific payload */
532 switch (local_event
->type
) {
533 case LTTNG_EVENT_FUNCTION
:
535 case LTTNG_EVENT_PROBE
:
537 struct lttng_payload_view probe_attr_view
=
538 lttng_payload_view_from_view(view
, offset
,
539 event_comm
->lttng_event_probe_attr_len
);
541 if (event_comm
->lttng_event_probe_attr_len
== 0) {
546 if (!lttng_payload_view_is_valid(&probe_attr_view
)) {
551 ret
= lttng_event_probe_attr_create_from_payload(
552 &probe_attr_view
, &local_probe_attr
);
553 if (ret
< 0 || ret
!= event_comm
->lttng_event_probe_attr_len
) {
558 /* Copy to the local event. */
559 memcpy(&local_event
->attr
.probe
, local_probe_attr
,
560 sizeof(local_event
->attr
.probe
));
565 case LTTNG_EVENT_FUNCTION_ENTRY
:
567 struct lttng_payload_view function_attr_view
=
568 lttng_payload_view_from_view(view
, offset
,
569 event_comm
->lttng_event_function_attr_len
);
571 if (event_comm
->lttng_event_function_attr_len
== 0) {
576 if (!lttng_payload_view_is_valid(&function_attr_view
)) {
581 ret
= lttng_event_function_attr_create_from_payload(
582 &function_attr_view
, &local_function_attr
);
583 if (ret
< 0 || ret
!= event_comm
->lttng_event_function_attr_len
) {
588 /* Copy to the local event. */
589 memcpy(&local_event
->attr
.ftrace
, local_function_attr
,
590 sizeof(local_event
->attr
.ftrace
));
596 case LTTNG_EVENT_USERSPACE_PROBE
:
598 struct lttng_payload_view userspace_probe_location_view
=
599 lttng_payload_view_from_view(view
, offset
,
600 event_comm
->userspace_probe_location_len
);
602 if (event_comm
->userspace_probe_location_len
== 0) {
607 if (!lttng_payload_view_is_valid(
608 &userspace_probe_location_view
)) {
613 ret
= lttng_userspace_probe_location_create_from_payload(
614 &userspace_probe_location_view
,
615 &local_userspace_probe_location
);
617 WARN("Failed to create a userspace probe location from the received buffer");
622 if (ret
!= event_comm
->userspace_probe_location_len
) {
623 WARN("Userspace probe location from the received buffer is not the advertised length: header length = %" PRIu32
", payload length = %lu", event_comm
->userspace_probe_location_len
, ret
);
628 /* Attach the probe location to the event. */
629 ret
= lttng_event_set_userspace_probe_location(
630 local_event
, local_userspace_probe_location
);
632 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
637 * Userspace probe location object ownership transfered to the
640 local_userspace_probe_location
= NULL
;
641 offset
+= event_comm
->userspace_probe_location_len
;
644 case LTTNG_EVENT_TRACEPOINT
:
646 case LTTNG_EVENT_ALL
:
648 case LTTNG_EVENT_SYSCALL
:
650 case LTTNG_EVENT_NOOP
:
651 /* Nothing to do here */
659 /* Transfer ownership to the caller. */
660 *out_event
= local_event
;
664 *out_bytecode
= local_bytecode
;
665 local_bytecode
= NULL
;
669 *out_exclusion
= local_exclusions
;
670 local_exclusions
= NULL
;
673 if (out_filter_expression
) {
674 *out_filter_expression
= local_filter_expression
;
675 local_filter_expression
= NULL
;
680 lttng_event_destroy(local_event
);
681 lttng_userspace_probe_location_destroy(local_userspace_probe_location
);
682 free(local_filter_expression
);
683 free(local_exclusions
);
684 free(local_bytecode
);
685 free(local_function_attr
);
686 free(local_probe_attr
);
690 int lttng_event_serialize(const struct lttng_event
*event
,
691 unsigned int exclusion_count
,
692 char **exclusion_list
,
693 char *filter_expression
,
695 struct lttng_bytecode
*bytecode
,
696 struct lttng_payload
*payload
)
700 size_t header_offset
, size_before_payload
;
702 struct lttng_event_comm event_comm
= { 0 };
703 struct lttng_event_comm
*header
;
707 assert(exclusion_count
== 0 || exclusion_list
);
709 /* Save the header location for later in-place header update. */
710 header_offset
= payload
->buffer
.size
;
712 name_len
= lttng_strnlen(event
->name
, LTTNG_SYMBOL_NAME_LEN
);
713 if (name_len
== LTTNG_SYMBOL_NAME_LEN
) {
714 /* Event name is not NULL-terminated. */
719 /* Add null termination. */
722 if (exclusion_count
> UINT32_MAX
) {
723 /* Possible overflow. */
728 if (bytecode_len
> UINT32_MAX
) {
729 /* Possible overflow. */
734 event_comm
.name_len
= (uint32_t) name_len
;
735 event_comm
.event_type
= (int8_t) event
->type
;
736 event_comm
.loglevel_type
= (int8_t) event
->loglevel_type
;
737 event_comm
.loglevel
= (int32_t) event
->loglevel
;
738 event_comm
.enabled
= (int8_t) event
->enabled
;
739 event_comm
.pid
= (int32_t) event
->pid
;
740 event_comm
.exclusion_count
= (uint32_t) exclusion_count
;
741 event_comm
.bytecode_len
= (uint32_t) bytecode_len
;
742 event_comm
.flags
= (int32_t) event
->flags
;
744 if (filter_expression
) {
745 event_comm
.filter_expression_len
=
746 strlen(filter_expression
) + 1;
750 ret
= lttng_dynamic_buffer_append(
751 &payload
->buffer
, &event_comm
, sizeof(event_comm
));
757 ret
= lttng_dynamic_buffer_append(
758 &payload
->buffer
, event
->name
, name_len
);
764 for (i
= 0; i
< exclusion_count
; i
++) {
765 const size_t exclusion_len
= lttng_strnlen(
766 *(exclusion_list
+ i
), LTTNG_SYMBOL_NAME_LEN
);
767 const struct lttng_event_exclusion_comm exclusion_header
= {
768 .len
= (uint32_t) exclusion_len
+ 1,
771 if (exclusion_len
== LTTNG_SYMBOL_NAME_LEN
) {
772 /* Exclusion is not NULL-terminated. */
777 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
778 &exclusion_header
, sizeof(exclusion_header
));
783 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
784 *(exclusion_list
+ i
), exclusion_len
+ 1);
790 /* Filter expression and its bytecode */
791 if (filter_expression
) {
792 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
794 event_comm
.filter_expression_len
);
800 * Bytecode can be absent when we serialize to the client
804 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
805 bytecode
, bytecode_len
);
812 size_before_payload
= payload
->buffer
.size
;
814 /* Event type specific payload */
815 switch (event
->type
) {
816 case LTTNG_EVENT_FUNCTION
:
818 case LTTNG_EVENT_PROBE
:
819 ret
= lttng_event_probe_attr_serialize(&event
->attr
.probe
, payload
);
825 header
= (struct lttng_event_comm
*) ((char *) payload
->buffer
.data
+
827 header
->lttng_event_probe_attr_len
=
828 payload
->buffer
.size
- size_before_payload
;
831 case LTTNG_EVENT_FUNCTION_ENTRY
:
832 ret
= lttng_event_function_attr_serialize(
833 &event
->attr
.ftrace
, payload
);
839 /* Update the lttng_event_function_attr len. */
840 header
= (struct lttng_event_comm
*) ((char *) payload
->buffer
.data
+
842 header
->lttng_event_function_attr_len
=
843 payload
->buffer
.size
- size_before_payload
;
846 case LTTNG_EVENT_USERSPACE_PROBE
:
848 const struct lttng_event_extended
*ev_ext
=
849 (const struct lttng_event_extended
*)
852 assert(event
->extended
.ptr
);
853 assert(ev_ext
->probe_location
);
855 size_before_payload
= payload
->buffer
.size
;
856 if (ev_ext
->probe_location
) {
858 * lttng_userspace_probe_location_serialize returns the
859 * number of bytes that were appended to the buffer.
861 ret
= lttng_userspace_probe_location_serialize(
862 ev_ext
->probe_location
, payload
);
869 /* Update the userspace probe location len. */
870 header
= (struct lttng_event_comm
*) ((char *) payload
->buffer
.data
+
872 header
->userspace_probe_location_len
=
873 payload
->buffer
.size
- size_before_payload
;
877 case LTTNG_EVENT_TRACEPOINT
:
879 case LTTNG_EVENT_ALL
:
882 /* Nothing to do here. */
890 static ssize_t
lttng_event_context_app_populate_from_payload(
891 const struct lttng_payload_view
*view
,
892 struct lttng_event_context
*event_ctx
)
894 ssize_t ret
, offset
= 0;
895 const struct lttng_event_context_app_comm
*comm
;
896 char *provider_name
= NULL
, *context_name
= NULL
;
897 size_t provider_name_len
, context_name_len
;
898 const struct lttng_buffer_view comm_view
= lttng_buffer_view_from_view(
899 &view
->buffer
, offset
, sizeof(*comm
));
901 assert(event_ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
);
903 if (!lttng_buffer_view_is_valid(&comm_view
)) {
908 comm
= (typeof(comm
)) comm_view
.data
;
909 offset
+= sizeof(*comm
);
911 provider_name_len
= comm
->provider_name_len
;
912 context_name_len
= comm
->ctx_name_len
;
914 if (provider_name_len
== 0 || context_name_len
== 0) {
916 * Application provider and context names MUST
925 const struct lttng_buffer_view provider_name_view
=
926 lttng_buffer_view_from_view(&view
->buffer
,
930 if (!lttng_buffer_view_is_valid(&provider_name_view
)) {
935 name
= provider_name_view
.data
;
937 if (!lttng_buffer_view_contains_string(&provider_name_view
,
938 name
, provider_name_len
)) {
943 provider_name
= lttng_strndup(name
, provider_name_len
);
944 if (!provider_name
) {
949 offset
+= provider_name_len
;
954 const struct lttng_buffer_view context_name_view
=
955 lttng_buffer_view_from_view(
956 &view
->buffer
, offset
,
959 if (!lttng_buffer_view_is_valid(&context_name_view
)) {
964 name
= context_name_view
.data
;
966 if (!lttng_buffer_view_contains_string(&context_name_view
, name
,
972 context_name
= lttng_strndup(name
, context_name_len
);
978 offset
+= context_name_len
;
981 /* Transfer ownership of the strings */
982 event_ctx
->u
.app_ctx
.provider_name
= provider_name
;
983 event_ctx
->u
.app_ctx
.ctx_name
= context_name
;
984 provider_name
= NULL
;
995 static ssize_t
lttng_event_context_perf_counter_populate_from_payload(
996 const struct lttng_payload_view
*view
,
997 struct lttng_event_context
*event_ctx
)
999 ssize_t ret
, offset
= 0;
1000 const struct lttng_event_context_perf_counter_comm
*comm
;
1002 const struct lttng_buffer_view comm_view
= lttng_buffer_view_from_view(
1003 &view
->buffer
, offset
, sizeof(*comm
));
1005 assert(event_ctx
->ctx
== LTTNG_EVENT_CONTEXT_PERF_COUNTER
||
1007 LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
||
1008 event_ctx
->ctx
== LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER
);
1010 if (!lttng_buffer_view_is_valid(&comm_view
)) {
1015 comm
= (typeof(comm
)) comm_view
.data
;
1016 offset
+= sizeof(*comm
);
1018 name_len
= comm
->name_len
;
1022 const struct lttng_buffer_view provider_name_view
=
1023 lttng_buffer_view_from_view(
1024 &view
->buffer
, offset
,
1027 if (!lttng_buffer_view_is_valid(&provider_name_view
)) {
1032 name
= provider_name_view
.data
;
1034 if (!lttng_buffer_view_contains_string(
1035 &provider_name_view
, name
, name_len
)) {
1040 lttng_strncpy(event_ctx
->u
.perf_counter
.name
, name
, name_len
);
1044 event_ctx
->u
.perf_counter
.config
= comm
->config
;
1045 event_ctx
->u
.perf_counter
.type
= comm
->type
;
1053 ssize_t
lttng_event_context_create_from_payload(
1054 struct lttng_payload_view
*view
,
1055 struct lttng_event_context
**event_ctx
)
1057 ssize_t ret
, offset
= 0;
1058 const struct lttng_event_context_comm
*comm
;
1059 struct lttng_event_context
*local_context
= NULL
;
1060 struct lttng_buffer_view comm_view
= lttng_buffer_view_from_view(
1061 &view
->buffer
, offset
, sizeof(*comm
));
1066 if (!lttng_buffer_view_is_valid(&comm_view
)) {
1071 comm
= (typeof(comm
)) comm_view
.data
;
1072 offset
+= sizeof(*comm
);
1074 local_context
= (struct lttng_event_context
*)
1075 zmalloc(sizeof(*local_context
));
1076 if (!local_context
) {
1081 local_context
->ctx
= (enum lttng_event_context_type
) comm
->type
;
1084 struct lttng_payload_view subtype_view
=
1085 lttng_payload_view_from_view(view
, offset
, -1);
1087 switch (local_context
->ctx
) {
1088 case LTTNG_EVENT_CONTEXT_APP_CONTEXT
:
1089 ret
= lttng_event_context_app_populate_from_payload(
1090 &subtype_view
, local_context
);
1092 case LTTNG_EVENT_CONTEXT_PERF_COUNTER
:
1093 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
1094 case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER
:
1095 ret
= lttng_event_context_perf_counter_populate_from_payload(
1096 &subtype_view
, local_context
);
1099 /* Nothing else to deserialize. */
1111 *event_ctx
= local_context
;
1112 local_context
= NULL
;
1116 free(local_context
);
1120 static int lttng_event_context_app_serialize(
1121 struct lttng_event_context
*context
,
1122 struct lttng_payload
*payload
)
1125 struct lttng_event_context_app_comm comm
= { 0 };
1126 size_t provider_len
, ctx_len
;
1127 const char *provider_name
;
1128 const char *ctx_name
;
1132 assert(context
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
);
1134 provider_name
= context
->u
.app_ctx
.provider_name
;
1135 ctx_name
= context
->u
.app_ctx
.ctx_name
;
1137 if (!provider_name
|| !ctx_name
) {
1138 ret
= -LTTNG_ERR_INVALID
;
1142 provider_len
= strlen(provider_name
);
1143 if (provider_len
== 0) {
1144 ret
= -LTTNG_ERR_INVALID
;
1148 /* Include the null terminator. */
1149 comm
.provider_name_len
= provider_len
+ 1;
1151 ctx_len
= strlen(ctx_name
);
1153 ret
= -LTTNG_ERR_INVALID
;
1157 /* Include the null terminator. */
1158 comm
.ctx_name_len
= ctx_len
+ 1;
1161 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, &comm
,
1168 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, provider_name
,
1175 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, ctx_name
,
1186 static int lttng_event_context_perf_counter_serialize(
1187 struct lttng_event_perf_counter_ctx
*context
,
1188 struct lttng_payload
*payload
)
1191 struct lttng_event_context_perf_counter_comm comm
= { 0 };
1196 comm
.config
= context
->config
;
1197 comm
.type
= context
->type
;
1198 comm
.name_len
= lttng_strnlen(context
->name
, LTTNG_SYMBOL_NAME_LEN
);
1200 if (comm
.name_len
== LTTNG_SYMBOL_NAME_LEN
) {
1205 /* Include the null terminator. */
1209 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, &comm
,
1216 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, context
->name
,
1227 int lttng_event_context_serialize(struct lttng_event_context
*context
,
1228 struct lttng_payload
*payload
)
1231 struct lttng_event_context_comm context_comm
= { 0 };
1236 context_comm
.type
= (uint32_t) context
->ctx
;
1239 ret
= lttng_dynamic_buffer_append(
1240 &payload
->buffer
, &context_comm
, sizeof(context_comm
));
1245 switch (context
->ctx
) {
1246 case LTTNG_EVENT_CONTEXT_APP_CONTEXT
:
1247 ret
= lttng_event_context_app_serialize(context
, payload
);
1249 case LTTNG_EVENT_CONTEXT_PERF_COUNTER
:
1250 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
1251 case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER
:
1252 ret
= lttng_event_context_perf_counter_serialize(
1253 &context
->u
.perf_counter
, payload
);
1256 /* Nothing else to serialize. */
1268 void lttng_event_context_destroy(struct lttng_event_context
*context
)
1274 if (context
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1275 free(context
->u
.app_ctx
.provider_name
);
1276 free(context
->u
.app_ctx
.ctx_name
);
1283 * This is a specialized populate for lttng_event_field since it ignores
1284 * the extension field of the lttng_event struct and simply copies what it can
1285 * to the internal struct lttng_event of a lttng_event_field.
1287 static void lttng_event_field_populate_lttng_event_from_event(
1288 const struct lttng_event
*src
, struct lttng_event
*destination
)
1290 memcpy(destination
, src
, sizeof(*destination
));
1292 /* Remove all possible dynamic data from the destination event rule. */
1293 destination
->extended
.ptr
= NULL
;
1296 ssize_t
lttng_event_field_create_from_payload(
1297 struct lttng_payload_view
*view
,
1298 struct lttng_event_field
**field
)
1300 ssize_t ret
, offset
= 0;
1301 struct lttng_event_field
*local_event_field
= NULL
;
1302 struct lttng_event
*event
= NULL
;
1303 const struct lttng_event_field_comm
*comm
;
1304 const char* name
= NULL
;
1310 const struct lttng_buffer_view comm_view
=
1311 lttng_buffer_view_from_view(
1312 &view
->buffer
, offset
,
1315 if (!lttng_buffer_view_is_valid(&comm_view
)) {
1320 /* lttng_event_field_comm header */
1321 comm
= (const struct lttng_event_field_comm
*) comm_view
.data
;
1322 offset
+= sizeof(*comm
);
1325 local_event_field
= (struct lttng_event_field
*)
1326 zmalloc(sizeof(*local_event_field
));
1327 if (!local_event_field
) {
1332 local_event_field
->type
= (enum lttng_event_field_type
) comm
->type
;
1333 local_event_field
->nowrite
= comm
->nowrite
;
1337 const struct lttng_buffer_view name_view
=
1338 lttng_buffer_view_from_view(
1339 &view
->buffer
, offset
,
1342 if (!lttng_buffer_view_is_valid(&name_view
)) {
1347 name
= name_view
.data
;
1349 if (!lttng_buffer_view_contains_string(&name_view
,
1350 name_view
.data
, comm
->name_len
)) {
1355 if (comm
->name_len
> LTTNG_SYMBOL_NAME_LEN
- 1) {
1356 /* Name is too long.*/
1361 offset
+= comm
->name_len
;
1366 struct lttng_payload_view event_view
=
1367 lttng_payload_view_from_view(
1371 if (!lttng_payload_view_is_valid(&event_view
)) {
1376 ret
= lttng_event_create_from_payload(&event_view
, &event
, NULL
,
1378 if (ret
!= comm
->event_len
) {
1389 if (lttng_strncpy(local_event_field
->field_name
, name
, LTTNG_SYMBOL_NAME_LEN
)) {
1394 lttng_event_field_populate_lttng_event_from_event(
1395 event
, &local_event_field
->event
);
1397 *field
= local_event_field
;
1398 local_event_field
= NULL
;
1401 lttng_event_destroy(event
);
1402 free(local_event_field
);
1406 int lttng_event_field_serialize(const struct lttng_event_field
*field
,
1407 struct lttng_payload
*payload
)
1410 size_t header_offset
, size_before_event
;
1412 struct lttng_event_field_comm event_field_comm
= { 0 };
1413 struct lttng_event_field_comm
*header
;
1418 /* Save the header location for later in-place header update. */
1419 header_offset
= payload
->buffer
.size
;
1421 name_len
= strnlen(field
->field_name
, LTTNG_SYMBOL_NAME_LEN
);
1422 if (name_len
== LTTNG_SYMBOL_NAME_LEN
) {
1423 /* Event name is not NULL-terminated. */
1428 /* Add null termination. */
1431 event_field_comm
.type
= field
->type
;
1432 event_field_comm
.nowrite
= (uint8_t)field
->nowrite
;
1433 event_field_comm
.name_len
= name_len
;
1436 ret
= lttng_dynamic_buffer_append(
1437 &payload
->buffer
, &event_field_comm
,
1438 sizeof(event_field_comm
));
1444 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, field
->field_name
,
1450 size_before_event
= payload
->buffer
.size
;
1451 ret
= lttng_event_serialize(
1452 &field
->event
, 0, NULL
, NULL
, 0, 0, payload
);
1458 /* Update the event len. */
1459 header
= (struct lttng_event_field_comm
*)
1460 ((char *) payload
->buffer
.data
+
1462 header
->event_len
= payload
->buffer
.size
- size_before_event
;
1468 static enum lttng_error_code
compute_flattened_size(
1469 struct lttng_dynamic_pointer_array
*events
, size_t *size
)
1471 enum lttng_error_code ret_code
;
1473 size_t storage_req
, event_count
, i
;
1478 event_count
= lttng_dynamic_pointer_array_get_count(events
);
1480 /* The basic struct lttng_event */
1481 storage_req
= event_count
* sizeof(struct lttng_event
);
1483 for (i
= 0; i
< event_count
; i
++) {
1484 int probe_storage_req
= 0;
1485 const struct event_list_element
*element
= (const struct event_list_element
*)
1486 lttng_dynamic_pointer_array_get_pointer(
1488 const struct lttng_userspace_probe_location
*location
= NULL
;
1490 location
= lttng_event_get_userspace_probe_location(
1493 ret
= lttng_userspace_probe_location_flatten(
1496 ret_code
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
1500 probe_storage_req
= ret
;
1503 /* The struct·lttng_event_extended */
1504 storage_req
+= event_count
*
1505 sizeof(struct lttng_event_extended
);
1507 if (element
->filter_expression
) {
1508 storage_req
+= strlen(element
->filter_expression
) + 1;
1511 if (element
->exclusions
) {
1512 storage_req
+= element
->exclusions
->count
*
1513 LTTNG_SYMBOL_NAME_LEN
;
1516 /* Padding to ensure the flat probe is aligned. */
1517 storage_req
= ALIGN_TO(storage_req
, sizeof(uint64_t));
1518 storage_req
+= probe_storage_req
;
1521 *size
= storage_req
;
1522 ret_code
= LTTNG_OK
;
1529 * Flatten a list of struct lttng_event.
1531 * The buffer that is returned to the API client must contain a "flat" version
1532 * of the events that are returned. In other words, all pointers within an
1533 * lttng_event must point to a location within the returned buffer so that the
1534 * user may free everything by simply calling free() on the returned buffer.
1535 * This is needed in order to maintain API compatibility.
1537 * A first pass is performed to compute the size of the buffer that must be
1538 * allocated. A second pass is then performed to setup the returned events so
1539 * that their members always point within the buffer.
1541 * The layout of the returned buffer is as follows:
1542 * - struct lttng_event[nb_events],
1543 * - nb_events times the following:
1544 * - struct lttng_event_extended,
1545 * - filter_expression
1547 * - padding to align to 64-bits
1548 * - flattened version of userspace_probe_location
1550 static enum lttng_error_code
flatten_lttng_events(
1551 struct lttng_dynamic_pointer_array
*events
,
1552 struct lttng_event
**flattened_events
)
1554 enum lttng_error_code ret_code
;
1557 struct lttng_dynamic_buffer local_flattened_events
;
1561 assert(flattened_events
);
1563 lttng_dynamic_buffer_init(&local_flattened_events
);
1564 nb_events
= lttng_dynamic_pointer_array_get_count(events
);
1566 ret_code
= compute_flattened_size(events
, &storage_req
);
1567 if (ret_code
!= LTTNG_OK
) {
1572 * We must ensure that "local_flattened_events" is never resized so as
1573 * to preserve the validity of the flattened objects.
1575 ret
= lttng_dynamic_buffer_set_capacity(
1576 &local_flattened_events
, storage_req
);
1578 ret_code
= LTTNG_ERR_NOMEM
;
1582 /* Start by laying the struct lttng_event */
1583 for (i
= 0; i
< nb_events
; i
++) {
1584 const struct event_list_element
*element
= (const struct event_list_element
*)
1585 lttng_dynamic_pointer_array_get_pointer(
1589 ret_code
= LTTNG_ERR_FATAL
;
1593 ret
= lttng_dynamic_buffer_append(&local_flattened_events
,
1594 element
->event
, sizeof(struct lttng_event
));
1596 ret_code
= LTTNG_ERR_NOMEM
;
1601 for (i
= 0; i
< nb_events
; i
++) {
1602 const struct event_list_element
*element
= (const struct event_list_element
*)
1603 lttng_dynamic_pointer_array_get_pointer(events
, i
);
1604 struct lttng_event
*event
= (struct lttng_event
*)
1605 (local_flattened_events
.data
+ (sizeof(struct lttng_event
) * i
));
1606 struct lttng_event_extended
*event_extended
=
1607 (struct lttng_event_extended
*)
1608 (local_flattened_events
.data
+ local_flattened_events
.size
);
1609 const struct lttng_userspace_probe_location
*location
= NULL
;
1613 /* Insert struct lttng_event_extended. */
1614 ret
= lttng_dynamic_buffer_set_size(&local_flattened_events
,
1615 local_flattened_events
.size
+
1616 sizeof(*event_extended
));
1618 ret_code
= LTTNG_ERR_NOMEM
;
1621 event
->extended
.ptr
= event_extended
;
1623 /* Insert filter expression. */
1624 if (element
->filter_expression
) {
1625 const size_t len
= strlen(element
->filter_expression
) + 1;
1627 event_extended
->filter_expression
=
1628 local_flattened_events
.data
+
1629 local_flattened_events
.size
;
1630 ret
= lttng_dynamic_buffer_append(
1631 &local_flattened_events
,
1632 element
->filter_expression
, len
);
1634 ret_code
= LTTNG_ERR_NOMEM
;
1639 /* Insert exclusions. */
1640 if (element
->exclusions
) {
1641 event_extended
->exclusions
.count
=
1642 element
->exclusions
->count
;
1643 event_extended
->exclusions
.strings
=
1644 local_flattened_events
.data
+
1645 local_flattened_events
.size
;
1647 ret
= lttng_dynamic_buffer_append(
1648 &local_flattened_events
,
1649 element
->exclusions
->names
,
1650 element
->exclusions
->count
*
1651 LTTNG_SYMBOL_NAME_LEN
);
1653 ret_code
= LTTNG_ERR_NOMEM
;
1658 /* Insert padding to align to 64-bits. */
1659 ret
= lttng_dynamic_buffer_set_size(&local_flattened_events
,
1660 ALIGN_TO(local_flattened_events
.size
,
1663 ret_code
= LTTNG_ERR_NOMEM
;
1667 location
= lttng_event_get_userspace_probe_location(
1670 event_extended
->probe_location
= (struct lttng_userspace_probe_location
*)
1671 (local_flattened_events
.data
+ local_flattened_events
.size
);
1672 ret
= lttng_userspace_probe_location_flatten(
1673 location
, &local_flattened_events
);
1675 ret_code
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
1681 /* Don't reset local_flattened_events buffer as we return its content. */
1682 *flattened_events
= (struct lttng_event
*) local_flattened_events
.data
;
1683 lttng_dynamic_buffer_init(&local_flattened_events
);
1684 ret_code
= LTTNG_OK
;
1686 lttng_dynamic_buffer_reset(&local_flattened_events
);
1690 static enum lttng_error_code
event_list_create_from_payload(
1691 struct lttng_payload_view
*view
,
1693 struct lttng_dynamic_pointer_array
*event_list
)
1695 enum lttng_error_code ret_code
;
1703 for (i
= 0; i
< count
; i
++) {
1705 struct lttng_payload_view event_view
=
1706 lttng_payload_view_from_view(view
, offset
, -1);
1707 struct event_list_element
*element
=
1708 (struct event_list_element
*) zmalloc(sizeof(*element
));
1711 ret_code
= LTTNG_ERR_NOMEM
;
1716 * Lifetime and management of the object is now bound to the
1719 ret
= lttng_dynamic_pointer_array_add_pointer(
1720 event_list
, element
);
1722 event_list_destructor(element
);
1723 ret_code
= LTTNG_ERR_NOMEM
;
1728 * Bytecode is not transmitted on listing in any case we do not
1731 event_size
= lttng_event_create_from_payload(&event_view
,
1733 &element
->exclusions
,
1734 &element
->filter_expression
, NULL
);
1735 if (event_size
< 0) {
1736 ret_code
= LTTNG_ERR_INVALID
;
1740 offset
+= event_size
;
1743 if (view
->buffer
.size
!= offset
) {
1744 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
1748 ret_code
= LTTNG_OK
;
1754 enum lttng_error_code
lttng_events_create_and_flatten_from_payload(
1755 struct lttng_payload_view
*payload
,
1757 struct lttng_event
**events
)
1759 enum lttng_error_code ret
= LTTNG_OK
;
1760 struct lttng_dynamic_pointer_array local_events
;
1762 lttng_dynamic_pointer_array_init(&local_events
, event_list_destructor
);
1764 /* Deserialize the events. */
1766 struct lttng_payload_view events_view
=
1767 lttng_payload_view_from_view(payload
, 0, -1);
1769 ret
= event_list_create_from_payload(
1770 &events_view
, count
, &local_events
);
1771 if (ret
!= LTTNG_OK
) {
1776 ret
= flatten_lttng_events(&local_events
, events
);
1777 if (ret
!= LTTNG_OK
) {
1782 lttng_dynamic_pointer_array_reset(&local_events
);
1786 static enum lttng_error_code
flatten_lttng_event_fields(
1787 struct lttng_dynamic_pointer_array
*event_fields
,
1788 struct lttng_event_field
**flattened_event_fields
)
1791 enum lttng_error_code ret_code
;
1792 size_t storage_req
= 0;
1793 struct lttng_dynamic_buffer local_flattened_event_fields
;
1796 assert(event_fields
);
1797 assert(flattened_event_fields
);
1799 lttng_dynamic_buffer_init(&local_flattened_event_fields
);
1800 nb_event_field
= lttng_dynamic_pointer_array_get_count(event_fields
);
1803 * Here even if the event field contains a `struct lttng_event` that
1804 * could contain dynamic data, in reality it is not the case.
1805 * Dynamic data is not present. Here the flattening is mostly a direct
1806 * memcpy. This is less than ideal but this code is still better than
1807 * direct usage of an unpacked lttng_event_field array.
1809 storage_req
+= sizeof(struct lttng_event_field
) * nb_event_field
;
1811 lttng_dynamic_buffer_init(&local_flattened_event_fields
);
1814 * We must ensure that "local_flattened_event_fields" is never resized
1815 * so as to preserve the validity of the flattened objects.
1817 ret
= lttng_dynamic_buffer_set_capacity(
1818 &local_flattened_event_fields
, storage_req
);
1820 ret_code
= LTTNG_ERR_NOMEM
;
1824 for (i
= 0; i
< nb_event_field
; i
++) {
1825 const struct lttng_event_field
*element
=
1826 (const struct lttng_event_field
*)
1827 lttng_dynamic_pointer_array_get_pointer(
1831 ret_code
= LTTNG_ERR_FATAL
;
1834 ret
= lttng_dynamic_buffer_append(&local_flattened_event_fields
,
1835 element
, sizeof(struct lttng_event_field
));
1837 ret_code
= LTTNG_ERR_NOMEM
;
1842 /* Don't reset local_flattened_channels buffer as we return its content. */
1843 *flattened_event_fields
= (struct lttng_event_field
*) local_flattened_event_fields
.data
;
1844 lttng_dynamic_buffer_init(&local_flattened_event_fields
);
1845 ret_code
= LTTNG_OK
;
1847 lttng_dynamic_buffer_reset(&local_flattened_event_fields
);
1851 static enum lttng_error_code
event_field_list_create_from_payload(
1852 struct lttng_payload_view
*view
,
1854 struct lttng_dynamic_pointer_array
**event_field_list
)
1856 enum lttng_error_code ret_code
;
1857 int ret
, offset
= 0;
1859 struct lttng_dynamic_pointer_array
*list
= NULL
;
1862 assert(event_field_list
);
1864 list
= (struct lttng_dynamic_pointer_array
*) zmalloc(sizeof(*list
));
1866 ret_code
= LTTNG_ERR_NOMEM
;
1870 lttng_dynamic_pointer_array_init(list
, free
);
1872 for (i
= 0; i
< count
; i
++) {
1873 ssize_t event_field_size
;
1874 struct lttng_event_field
*field
= NULL
;
1875 struct lttng_payload_view event_field_view
=
1876 lttng_payload_view_from_view(view
, offset
, -1);
1878 event_field_size
= lttng_event_field_create_from_payload(
1879 &event_field_view
, &field
);
1880 if (event_field_size
< 0) {
1881 ret_code
= LTTNG_ERR_INVALID
;
1885 /* Lifetime and management of the object is now bound to the array. */
1886 ret
= lttng_dynamic_pointer_array_add_pointer(list
, field
);
1889 ret_code
= LTTNG_ERR_NOMEM
;
1893 offset
+= event_field_size
;
1896 if (view
->buffer
.size
!= offset
) {
1897 ret_code
= LTTNG_ERR_INVALID
;
1901 *event_field_list
= list
;
1903 ret_code
= LTTNG_OK
;
1907 lttng_dynamic_pointer_array_reset(list
);
1914 enum lttng_error_code
lttng_event_fields_create_and_flatten_from_payload(
1915 struct lttng_payload_view
*view
,
1917 struct lttng_event_field
**fields
)
1919 enum lttng_error_code ret_code
;
1920 struct lttng_dynamic_pointer_array
*local_event_fields
= NULL
;
1922 ret_code
= event_field_list_create_from_payload(
1923 view
, count
, &local_event_fields
);
1924 if (ret_code
!= LTTNG_OK
) {
1928 ret_code
= flatten_lttng_event_fields(local_event_fields
, fields
);
1929 if (ret_code
!= LTTNG_OK
) {
1933 if (local_event_fields
) {
1934 lttng_dynamic_pointer_array_reset(local_event_fields
);
1935 free(local_event_fields
);