4 * Copyright (C) 2020 Philippe Proulx <pproulx@efficios.com>
6 * SPDX-License-Identifier: LGPL-2.1-only
14 #include <common/bytecode/bytecode.h>
15 #include <common/error.h>
16 #include <common/macros.h>
17 #include <common/mi-lttng.h>
18 #include <lttng/event-expr-internal.h>
19 #include <lttng/event-expr.h>
22 enum lttng_event_expr_type
lttng_event_expr_get_type(
23 const struct lttng_event_expr
*expr
)
25 enum lttng_event_expr_type type
;
28 type
= LTTNG_EVENT_EXPR_TYPE_INVALID
;
39 struct lttng_event_expr
*create_empty_expr(enum lttng_event_expr_type type
,
42 struct lttng_event_expr
*expr
;
56 struct lttng_event_expr_field
*create_field_event_expr(
57 enum lttng_event_expr_type type
,
60 struct lttng_event_expr_field
*expr
=
62 create_empty_expr(type
, sizeof(*expr
)),
63 struct lttng_event_expr_field
, parent
);
70 expr
->name
= strdup(name
);
79 lttng_event_expr_destroy(&expr
->parent
);
87 struct lttng_event_expr
*lttng_event_expr_event_payload_field_create(
88 const char *field_name
)
90 struct lttng_event_expr
*expr
= NULL
;
96 expr
= &create_field_event_expr(
97 LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD
,
104 struct lttng_event_expr
*lttng_event_expr_channel_context_field_create(
105 const char *field_name
)
107 struct lttng_event_expr
*expr
= NULL
;
113 expr
= &create_field_event_expr(
114 LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD
,
121 struct lttng_event_expr
*lttng_event_expr_app_specific_context_field_create(
122 const char *provider_name
, const char *type_name
)
124 struct lttng_event_expr_app_specific_context_field
*expr
= NULL
;
125 struct lttng_event_expr
*ret_parent_expr
;
127 if (!type_name
|| !provider_name
) {
131 expr
= container_of(create_empty_expr(
132 LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD
,
134 struct lttng_event_expr_app_specific_context_field
,
140 expr
->provider_name
= strdup(provider_name
);
141 if (!expr
->provider_name
) {
145 expr
->type_name
= strdup(type_name
);
146 if (!expr
->type_name
) {
150 ret_parent_expr
= &expr
->parent
;
155 lttng_event_expr_destroy(&expr
->parent
);
157 ret_parent_expr
= NULL
;
160 return ret_parent_expr
;
163 struct lttng_event_expr
*lttng_event_expr_array_field_element_create(
164 struct lttng_event_expr
*array_field_expr
,
167 struct lttng_event_expr_array_field_element
*expr
= NULL
;
168 struct lttng_event_expr
*ret_parent_expr
;
170 /* The parent array field expression must be an l-value */
171 if (!array_field_expr
||
172 !lttng_event_expr_is_lvalue(array_field_expr
)) {
176 expr
= container_of(create_empty_expr(
177 LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT
,
179 struct lttng_event_expr_array_field_element
,
185 expr
->array_field_expr
= array_field_expr
;
187 ret_parent_expr
= &expr
->parent
;
191 ret_parent_expr
= NULL
;
194 return ret_parent_expr
;
197 const char *lttng_event_expr_event_payload_field_get_name(
198 const struct lttng_event_expr
*expr
)
200 const char *ret
= NULL
;
202 if (!expr
|| expr
->type
!= LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD
) {
206 ret
= container_of(expr
,
207 const struct lttng_event_expr_field
, parent
)->name
;
213 const char *lttng_event_expr_channel_context_field_get_name(
214 const struct lttng_event_expr
*expr
)
216 const char *ret
= NULL
;
218 if (!expr
|| expr
->type
!= LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD
) {
222 ret
= container_of(expr
,
223 const struct lttng_event_expr_field
, parent
)->name
;
229 const char *lttng_event_expr_app_specific_context_field_get_provider_name(
230 const struct lttng_event_expr
*expr
)
232 const char *ret
= NULL
;
234 if (!expr
|| expr
->type
!= LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD
) {
238 ret
= container_of(expr
,
239 const struct lttng_event_expr_app_specific_context_field
,
240 parent
)->provider_name
;
246 const char *lttng_event_expr_app_specific_context_field_get_type_name(
247 const struct lttng_event_expr
*expr
)
249 const char *ret
= NULL
;
251 if (!expr
|| expr
->type
!= LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD
) {
255 ret
= container_of(expr
,
256 const struct lttng_event_expr_app_specific_context_field
,
263 const struct lttng_event_expr
*
264 lttng_event_expr_array_field_element_get_parent_expr(
265 const struct lttng_event_expr
*expr
)
267 const struct lttng_event_expr
*ret
= NULL
;
269 if (!expr
|| expr
->type
!= LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT
) {
273 ret
= container_of(expr
,
274 const struct lttng_event_expr_array_field_element
,
275 parent
)->array_field_expr
;
281 enum lttng_event_expr_status
lttng_event_expr_array_field_element_get_index(
282 const struct lttng_event_expr
*expr
, unsigned int *index
)
284 enum lttng_event_expr_status ret
= LTTNG_EVENT_EXPR_STATUS_OK
;
286 if (!expr
|| expr
->type
!= LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT
||
288 ret
= LTTNG_EVENT_EXPR_STATUS_INVALID
;
292 *index
= container_of(expr
,
293 const struct lttng_event_expr_array_field_element
,
300 bool lttng_event_expr_is_equal(const struct lttng_event_expr
*expr_a
,
301 const struct lttng_event_expr
*expr_b
)
303 bool is_equal
= true;
305 if (!expr_a
&& !expr_b
) {
306 /* Both `NULL`: equal */
310 if (!expr_a
|| !expr_b
) {
311 /* Only one `NULL`: not equal */
315 if (expr_a
->type
!= expr_b
->type
) {
316 /* Different types: not equal */
320 switch (expr_a
->type
) {
321 case LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD
:
322 case LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD
:
324 const struct lttng_event_expr_field
*field_expr_a
=
326 const struct lttng_event_expr_field
,
328 const struct lttng_event_expr_field
*field_expr_b
=
330 const struct lttng_event_expr_field
,
333 if (strcmp(field_expr_a
->name
, field_expr_b
->name
) != 0) {
339 case LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD
:
341 const struct lttng_event_expr_app_specific_context_field
*field_expr_a
=
343 const struct lttng_event_expr_app_specific_context_field
,
345 const struct lttng_event_expr_app_specific_context_field
*field_expr_b
=
347 const struct lttng_event_expr_app_specific_context_field
,
350 if (strcmp(field_expr_a
->provider_name
,
351 field_expr_b
->provider_name
) != 0) {
355 if (strcmp(field_expr_a
->type_name
,
356 field_expr_b
->type_name
) != 0) {
362 case LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT
:
364 const struct lttng_event_expr_array_field_element
*elem_expr_a
=
366 const struct lttng_event_expr_array_field_element
,
368 const struct lttng_event_expr_array_field_element
*elem_expr_b
=
370 const struct lttng_event_expr_array_field_element
,
373 if (!lttng_event_expr_is_equal(elem_expr_a
->array_field_expr
,
374 elem_expr_b
->array_field_expr
)) {
378 if (elem_expr_a
->index
!= elem_expr_b
->index
) {
397 void lttng_event_expr_destroy(struct lttng_event_expr
*expr
)
403 switch (expr
->type
) {
404 case LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD
:
405 case LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD
:
407 struct lttng_event_expr_field
*field_expr
=
409 struct lttng_event_expr_field
, parent
);
411 free(field_expr
->name
);
414 case LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD
:
416 struct lttng_event_expr_app_specific_context_field
*field_expr
=
418 struct lttng_event_expr_app_specific_context_field
,
421 free(field_expr
->provider_name
);
422 free(field_expr
->type_name
);
425 case LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT
:
427 struct lttng_event_expr_array_field_element
*elem_expr
=
429 struct lttng_event_expr_array_field_element
,
432 lttng_event_expr_destroy(elem_expr
->array_field_expr
);
445 static int event_expr_to_bytecode_recursive(const struct lttng_event_expr
*expr
,
446 struct lttng_bytecode_alloc
**bytecode
,
447 struct lttng_bytecode_alloc
**bytecode_reloc
)
450 enum lttng_event_expr_status event_expr_status
;
452 switch (lttng_event_expr_get_type(expr
)) {
453 case LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD
:
457 status
= bytecode_push_get_payload_root(bytecode
);
459 ERR("Failed to get payload root from bytecode");
463 name
= lttng_event_expr_event_payload_field_get_name(expr
);
465 ERR("Failed to get payload field name from event expression");
470 status
= bytecode_push_get_symbol(
471 bytecode
, bytecode_reloc
, name
);
473 ERR("Failed to push 'get symbol %s' in bytecode", name
);
479 case LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD
:
483 status
= bytecode_push_get_context_root(bytecode
);
485 ERR("Failed to get context root from bytecode");
489 name
= lttng_event_expr_channel_context_field_get_name(expr
);
491 ERR("Failed to get channel context field name from event expression");
496 status
= bytecode_push_get_symbol(
497 bytecode
, bytecode_reloc
, name
);
499 ERR("Failed to push 'get symbol %s' in bytecode", name
);
505 case LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD
:
509 const char *provider_name
, *type_name
;
511 status
= bytecode_push_get_app_context_root(bytecode
);
513 ERR("Failed to get application context root from bytecode");
517 provider_name
= lttng_event_expr_app_specific_context_field_get_provider_name(
519 if (!provider_name
) {
520 ERR("Failed to get application context provider name from event expression");
525 type_name
= lttng_event_expr_app_specific_context_field_get_type_name(
528 ERR("Failed to get application context type name from event expression");
534 * Reconstitute the app context field name from its two parts.
536 ret
= asprintf(&name
, "%s:%s", provider_name
, type_name
);
538 PERROR("Failed to format application specific context: provider_name = '%s', type_name = '%s'",
539 provider_name
, type_name
);
544 status
= bytecode_push_get_symbol(
545 bytecode
, bytecode_reloc
, name
);
548 ERR("Failed to push 'get symbol %s:%s' in bytecode",
549 provider_name
, type_name
);
555 case LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT
:
558 const struct lttng_event_expr
*parent
;
560 parent
= lttng_event_expr_array_field_element_get_parent_expr(
563 ERR("Failed to get parent expression from array event expression");
568 status
= event_expr_to_bytecode_recursive(
569 parent
, bytecode
, bytecode_reloc
);
575 lttng_event_expr_array_field_element_get_index(
577 if (event_expr_status
!= LTTNG_EVENT_EXPR_STATUS_OK
) {
578 ERR("Failed to get array field element index from event expression");
583 status
= bytecode_push_get_index_u64(bytecode
, index
);
585 ERR("Failed to push 'get index %u' in bytecode", index
);
601 int lttng_event_expr_to_bytecode(const struct lttng_event_expr
*expr
,
602 struct lttng_bytecode
**bytecode_out
)
605 struct return_op ret_insn
;
606 struct lttng_bytecode_alloc
*bytecode
= NULL
;
607 struct lttng_bytecode_alloc
*bytecode_reloc
= NULL
;
609 status
= bytecode_init(&bytecode
);
611 ERR("Failed to initialize bytecode");
615 status
= bytecode_init(&bytecode_reloc
);
617 ERR("Failed to initialize relocation bytecode");
621 status
= event_expr_to_bytecode_recursive(
622 expr
, &bytecode
, &bytecode_reloc
);
624 /* Errors already logged. */
628 ret_insn
.op
= BYTECODE_OP_RETURN
;
629 bytecode_push(&bytecode
, &ret_insn
, 1, sizeof(ret_insn
));
631 /* Append symbol table to bytecode. */
632 bytecode
->b
.reloc_table_offset
= bytecode_get_len(&bytecode
->b
);
633 status
= bytecode_push(&bytecode
, bytecode_reloc
->b
.data
, 1,
634 bytecode_get_len(&bytecode_reloc
->b
));
636 ERR("Failed to push symbol table to bytecode");
640 /* Copy the `lttng_bytecode` out of the `lttng_bytecode_alloc`. */
641 *bytecode_out
= lttng_bytecode_copy(&bytecode
->b
);
642 if (!*bytecode_out
) {
652 if (bytecode_reloc
) {
653 free(bytecode_reloc
);
660 enum lttng_error_code
lttng_event_expr_event_payload_field_mi_serialize(
661 const struct lttng_event_expr
*expression
,
662 struct mi_writer
*writer
)
665 enum lttng_error_code ret_code
;
666 const char *name
= NULL
;
670 assert(expression
->type
== LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD
);
672 name
= lttng_event_expr_event_payload_field_get_name(expression
);
675 /* Open event expr payload field element. */
676 ret
= mi_lttng_writer_open_element(
677 writer
, mi_lttng_element_event_expr_payload_field
);
683 ret
= mi_lttng_writer_write_element_string(
684 writer
, config_element_name
, name
);
689 /* Close event expr payload field element. */
690 ret
= mi_lttng_writer_close_element(writer
);
699 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
705 enum lttng_error_code
lttng_event_expr_channel_context_field_mi_serialize(
706 const struct lttng_event_expr
*expression
,
707 struct mi_writer
*writer
)
710 enum lttng_error_code ret_code
;
711 const char *name
= NULL
;
715 assert(expression
->type
== LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD
);
717 name
= lttng_event_expr_channel_context_field_get_name(expression
);
720 /* Open event expr channel context field element. */
721 ret
= mi_lttng_writer_open_element(writer
,
722 mi_lttng_element_event_expr_channel_context_field
);
728 ret
= mi_lttng_writer_write_element_string(
729 writer
, config_element_name
, name
);
734 /* Close event expr channel context field element. */
735 ret
= mi_lttng_writer_close_element(writer
);
744 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
750 enum lttng_error_code
lttng_event_expr_app_specific_context_field_mi_serialize(
751 const struct lttng_event_expr
*expression
,
752 struct mi_writer
*writer
)
755 enum lttng_error_code ret_code
;
756 const char *provider_name
= NULL
;
757 const char *type_name
= NULL
;
761 assert(expression
->type
==
762 LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD
);
764 provider_name
= lttng_event_expr_app_specific_context_field_get_provider_name(
766 assert(provider_name
);
768 type_name
= lttng_event_expr_app_specific_context_field_get_type_name(
770 assert(provider_name
);
772 /* Open event expr app specific context field element. */
773 ret
= mi_lttng_writer_open_element(writer
,
774 mi_lttng_element_event_expr_app_specific_context_field
);
780 ret
= mi_lttng_writer_write_element_string(writer
,
781 mi_lttng_element_event_expr_provider_name
,
788 ret
= mi_lttng_writer_write_element_string(writer
,
789 mi_lttng_element_event_expr_type_name
, type_name
);
794 /* Close event expr app specific context field element. */
795 ret
= mi_lttng_writer_close_element(writer
);
804 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
810 enum lttng_error_code
lttng_event_expr_array_field_element_mi_serialize(
811 const struct lttng_event_expr
*expression
,
812 struct mi_writer
*writer
)
815 enum lttng_error_code ret_code
;
816 enum lttng_event_expr_status status
;
817 const struct lttng_event_expr
*parent_expr
= NULL
;
822 assert(expression
->type
== LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT
);
824 status
= lttng_event_expr_array_field_element_get_index(
826 assert(status
== LTTNG_EVENT_EXPR_STATUS_OK
);
828 parent_expr
= lttng_event_expr_array_field_element_get_parent_expr(
830 assert(parent_expr
!= NULL
);
832 /* Open event expr array field element. */
833 ret
= mi_lttng_writer_open_element(writer
,
834 mi_lttng_element_event_expr_array_field_element
);
840 ret
= mi_lttng_writer_write_element_unsigned_int(
841 writer
, mi_lttng_element_event_expr_index
, index
);
846 /* Parent expression. */
847 ret_code
= lttng_event_expr_mi_serialize(parent_expr
, writer
);
848 if (ret_code
!= LTTNG_OK
) {
852 /* Close event expr array field element. */
853 ret
= mi_lttng_writer_close_element(writer
);
862 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
868 enum lttng_error_code
lttng_event_expr_mi_serialize(
869 const struct lttng_event_expr
*expression
,
870 struct mi_writer
*writer
)
873 enum lttng_error_code ret_code
;
878 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_expr
);
883 switch (expression
->type
) {
884 case LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD
:
885 ret_code
= lttng_event_expr_event_payload_field_mi_serialize(
888 case LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD
:
889 ret_code
= lttng_event_expr_channel_context_field_mi_serialize(
892 case LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD
:
893 ret_code
= lttng_event_expr_app_specific_context_field_mi_serialize(
896 case LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT
:
897 ret_code
= lttng_event_expr_array_field_element_mi_serialize(
904 if (ret_code
!= LTTNG_OK
) {
908 ret
= mi_lttng_writer_close_element(writer
);
917 ret_code
= LTTNG_ERR_MI_IO_FAIL
;