2 * SPDX-License-Identifier: MIT
4 * Copyright (C) 2010-2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * LTTng UST bytecode code.
13 #include <urcu/rculist.h>
15 #include "context-internal.h"
16 #include "lttng-bytecode.h"
17 #include "ust-events-internal.h"
19 static const char *opnames
[] = {
20 [ BYTECODE_OP_UNKNOWN
] = "UNKNOWN",
22 [ BYTECODE_OP_RETURN
] = "RETURN",
25 [ BYTECODE_OP_MUL
] = "MUL",
26 [ BYTECODE_OP_DIV
] = "DIV",
27 [ BYTECODE_OP_MOD
] = "MOD",
28 [ BYTECODE_OP_PLUS
] = "PLUS",
29 [ BYTECODE_OP_MINUS
] = "MINUS",
30 [ BYTECODE_OP_BIT_RSHIFT
] = "BIT_RSHIFT",
31 [ BYTECODE_OP_BIT_LSHIFT
] = "BIT_LSHIFT",
32 [ BYTECODE_OP_BIT_AND
] = "BIT_AND",
33 [ BYTECODE_OP_BIT_OR
] = "BIT_OR",
34 [ BYTECODE_OP_BIT_XOR
] = "BIT_XOR",
36 /* binary comparators */
37 [ BYTECODE_OP_EQ
] = "EQ",
38 [ BYTECODE_OP_NE
] = "NE",
39 [ BYTECODE_OP_GT
] = "GT",
40 [ BYTECODE_OP_LT
] = "LT",
41 [ BYTECODE_OP_GE
] = "GE",
42 [ BYTECODE_OP_LE
] = "LE",
44 /* string binary comparators */
45 [ BYTECODE_OP_EQ_STRING
] = "EQ_STRING",
46 [ BYTECODE_OP_NE_STRING
] = "NE_STRING",
47 [ BYTECODE_OP_GT_STRING
] = "GT_STRING",
48 [ BYTECODE_OP_LT_STRING
] = "LT_STRING",
49 [ BYTECODE_OP_GE_STRING
] = "GE_STRING",
50 [ BYTECODE_OP_LE_STRING
] = "LE_STRING",
52 /* s64 binary comparators */
53 [ BYTECODE_OP_EQ_S64
] = "EQ_S64",
54 [ BYTECODE_OP_NE_S64
] = "NE_S64",
55 [ BYTECODE_OP_GT_S64
] = "GT_S64",
56 [ BYTECODE_OP_LT_S64
] = "LT_S64",
57 [ BYTECODE_OP_GE_S64
] = "GE_S64",
58 [ BYTECODE_OP_LE_S64
] = "LE_S64",
60 /* double binary comparators */
61 [ BYTECODE_OP_EQ_DOUBLE
] = "EQ_DOUBLE",
62 [ BYTECODE_OP_NE_DOUBLE
] = "NE_DOUBLE",
63 [ BYTECODE_OP_GT_DOUBLE
] = "GT_DOUBLE",
64 [ BYTECODE_OP_LT_DOUBLE
] = "LT_DOUBLE",
65 [ BYTECODE_OP_GE_DOUBLE
] = "GE_DOUBLE",
66 [ BYTECODE_OP_LE_DOUBLE
] = "LE_DOUBLE",
68 /* Mixed S64-double binary comparators */
69 [ BYTECODE_OP_EQ_DOUBLE_S64
] = "EQ_DOUBLE_S64",
70 [ BYTECODE_OP_NE_DOUBLE_S64
] = "NE_DOUBLE_S64",
71 [ BYTECODE_OP_GT_DOUBLE_S64
] = "GT_DOUBLE_S64",
72 [ BYTECODE_OP_LT_DOUBLE_S64
] = "LT_DOUBLE_S64",
73 [ BYTECODE_OP_GE_DOUBLE_S64
] = "GE_DOUBLE_S64",
74 [ BYTECODE_OP_LE_DOUBLE_S64
] = "LE_DOUBLE_S64",
76 [ BYTECODE_OP_EQ_S64_DOUBLE
] = "EQ_S64_DOUBLE",
77 [ BYTECODE_OP_NE_S64_DOUBLE
] = "NE_S64_DOUBLE",
78 [ BYTECODE_OP_GT_S64_DOUBLE
] = "GT_S64_DOUBLE",
79 [ BYTECODE_OP_LT_S64_DOUBLE
] = "LT_S64_DOUBLE",
80 [ BYTECODE_OP_GE_S64_DOUBLE
] = "GE_S64_DOUBLE",
81 [ BYTECODE_OP_LE_S64_DOUBLE
] = "LE_S64_DOUBLE",
84 [ BYTECODE_OP_UNARY_PLUS
] = "UNARY_PLUS",
85 [ BYTECODE_OP_UNARY_MINUS
] = "UNARY_MINUS",
86 [ BYTECODE_OP_UNARY_NOT
] = "UNARY_NOT",
87 [ BYTECODE_OP_UNARY_PLUS_S64
] = "UNARY_PLUS_S64",
88 [ BYTECODE_OP_UNARY_MINUS_S64
] = "UNARY_MINUS_S64",
89 [ BYTECODE_OP_UNARY_NOT_S64
] = "UNARY_NOT_S64",
90 [ BYTECODE_OP_UNARY_PLUS_DOUBLE
] = "UNARY_PLUS_DOUBLE",
91 [ BYTECODE_OP_UNARY_MINUS_DOUBLE
] = "UNARY_MINUS_DOUBLE",
92 [ BYTECODE_OP_UNARY_NOT_DOUBLE
] = "UNARY_NOT_DOUBLE",
95 [ BYTECODE_OP_AND
] = "AND",
96 [ BYTECODE_OP_OR
] = "OR",
99 [ BYTECODE_OP_LOAD_FIELD_REF
] = "LOAD_FIELD_REF",
100 [ BYTECODE_OP_LOAD_FIELD_REF_STRING
] = "LOAD_FIELD_REF_STRING",
101 [ BYTECODE_OP_LOAD_FIELD_REF_SEQUENCE
] = "LOAD_FIELD_REF_SEQUENCE",
102 [ BYTECODE_OP_LOAD_FIELD_REF_S64
] = "LOAD_FIELD_REF_S64",
103 [ BYTECODE_OP_LOAD_FIELD_REF_DOUBLE
] = "LOAD_FIELD_REF_DOUBLE",
105 /* load from immediate operand */
106 [ BYTECODE_OP_LOAD_STRING
] = "LOAD_STRING",
107 [ BYTECODE_OP_LOAD_S64
] = "LOAD_S64",
108 [ BYTECODE_OP_LOAD_DOUBLE
] = "LOAD_DOUBLE",
111 [ BYTECODE_OP_CAST_TO_S64
] = "CAST_TO_S64",
112 [ BYTECODE_OP_CAST_DOUBLE_TO_S64
] = "CAST_DOUBLE_TO_S64",
113 [ BYTECODE_OP_CAST_NOP
] = "CAST_NOP",
115 /* get context ref */
116 [ BYTECODE_OP_GET_CONTEXT_REF
] = "GET_CONTEXT_REF",
117 [ BYTECODE_OP_GET_CONTEXT_REF_STRING
] = "GET_CONTEXT_REF_STRING",
118 [ BYTECODE_OP_GET_CONTEXT_REF_S64
] = "GET_CONTEXT_REF_S64",
119 [ BYTECODE_OP_GET_CONTEXT_REF_DOUBLE
] = "GET_CONTEXT_REF_DOUBLE",
121 /* load userspace field ref */
122 [ BYTECODE_OP_LOAD_FIELD_REF_USER_STRING
] = "LOAD_FIELD_REF_USER_STRING",
123 [ BYTECODE_OP_LOAD_FIELD_REF_USER_SEQUENCE
] = "LOAD_FIELD_REF_USER_SEQUENCE",
126 * load immediate star globbing pattern (literal string)
129 [ BYTECODE_OP_LOAD_STAR_GLOB_STRING
] = "LOAD_STAR_GLOB_STRING",
131 /* globbing pattern binary operator: apply to */
132 [ BYTECODE_OP_EQ_STAR_GLOB_STRING
] = "EQ_STAR_GLOB_STRING",
133 [ BYTECODE_OP_NE_STAR_GLOB_STRING
] = "NE_STAR_GLOB_STRING",
136 * Instructions for recursive traversal through composed types.
138 [ BYTECODE_OP_GET_CONTEXT_ROOT
] = "GET_CONTEXT_ROOT",
139 [ BYTECODE_OP_GET_APP_CONTEXT_ROOT
] = "GET_APP_CONTEXT_ROOT",
140 [ BYTECODE_OP_GET_PAYLOAD_ROOT
] = "GET_PAYLOAD_ROOT",
142 [ BYTECODE_OP_GET_SYMBOL
] = "GET_SYMBOL",
143 [ BYTECODE_OP_GET_SYMBOL_FIELD
] = "GET_SYMBOL_FIELD",
144 [ BYTECODE_OP_GET_INDEX_U16
] = "GET_INDEX_U16",
145 [ BYTECODE_OP_GET_INDEX_U64
] = "GET_INDEX_U64",
147 [ BYTECODE_OP_LOAD_FIELD
] = "LOAD_FIELD",
148 [ BYTECODE_OP_LOAD_FIELD_S8
] = "LOAD_FIELD_S8",
149 [ BYTECODE_OP_LOAD_FIELD_S16
] = "LOAD_FIELD_S16",
150 [ BYTECODE_OP_LOAD_FIELD_S32
] = "LOAD_FIELD_S32",
151 [ BYTECODE_OP_LOAD_FIELD_S64
] = "LOAD_FIELD_S64",
152 [ BYTECODE_OP_LOAD_FIELD_U8
] = "LOAD_FIELD_U8",
153 [ BYTECODE_OP_LOAD_FIELD_U16
] = "LOAD_FIELD_U16",
154 [ BYTECODE_OP_LOAD_FIELD_U32
] = "LOAD_FIELD_U32",
155 [ BYTECODE_OP_LOAD_FIELD_U64
] = "LOAD_FIELD_U64",
156 [ BYTECODE_OP_LOAD_FIELD_STRING
] = "LOAD_FIELD_STRING",
157 [ BYTECODE_OP_LOAD_FIELD_SEQUENCE
] = "LOAD_FIELD_SEQUENCE",
158 [ BYTECODE_OP_LOAD_FIELD_DOUBLE
] = "LOAD_FIELD_DOUBLE",
160 [ BYTECODE_OP_UNARY_BIT_NOT
] = "UNARY_BIT_NOT",
162 [ BYTECODE_OP_RETURN_S64
] = "RETURN_S64",
165 const char *lttng_bytecode_print_op(enum bytecode_op op
)
167 if (op
>= NR_BYTECODE_OPS
)
174 int apply_field_reloc(const struct lttng_event_desc
*event_desc
,
175 struct bytecode_runtime
*runtime
,
176 uint32_t runtime_len
,
177 uint32_t reloc_offset
,
178 const char *field_name
,
179 enum bytecode_op bytecode_op
)
181 const struct lttng_event_field
*fields
, *field
= NULL
;
182 unsigned int nr_fields
, i
;
184 uint32_t field_offset
= 0;
186 dbg_printf("Apply field reloc: %u %s\n", reloc_offset
, field_name
);
188 /* Lookup event by name */
191 fields
= event_desc
->fields
;
194 nr_fields
= event_desc
->nr_fields
;
195 for (i
= 0; i
< nr_fields
; i
++) {
196 if (fields
[i
].u
.ext
.nofilter
) {
199 if (!strcmp(fields
[i
].name
, field_name
)) {
203 /* compute field offset */
204 switch (fields
[i
].type
.atype
) {
207 case atype_enum_nestable
:
208 field_offset
+= sizeof(int64_t);
211 case atype_array_nestable
:
213 case atype_sequence_nestable
:
214 field_offset
+= sizeof(unsigned long);
215 field_offset
+= sizeof(void *);
218 field_offset
+= sizeof(void *);
221 field_offset
+= sizeof(double);
230 /* Check if field offset is too large for 16-bit offset */
231 if (field_offset
> FILTER_BYTECODE_MAX_LEN
- 1)
235 op
= (struct load_op
*) &runtime
->code
[reloc_offset
];
237 switch (bytecode_op
) {
238 case BYTECODE_OP_LOAD_FIELD_REF
:
240 struct field_ref
*field_ref
;
242 field_ref
= (struct field_ref
*) op
->data
;
243 switch (field
->type
.atype
) {
246 case atype_enum_nestable
:
247 op
->op
= BYTECODE_OP_LOAD_FIELD_REF_S64
;
250 case atype_array_nestable
:
252 case atype_sequence_nestable
:
253 op
->op
= BYTECODE_OP_LOAD_FIELD_REF_SEQUENCE
;
256 op
->op
= BYTECODE_OP_LOAD_FIELD_REF_STRING
;
259 op
->op
= BYTECODE_OP_LOAD_FIELD_REF_DOUBLE
;
265 field_ref
->offset
= (uint16_t) field_offset
;
275 int apply_context_reloc(struct bytecode_runtime
*runtime
,
276 uint32_t runtime_len
,
277 uint32_t reloc_offset
,
278 const char *context_name
,
279 enum bytecode_op bytecode_op
)
282 struct lttng_ctx_field
*ctx_field
;
284 struct lttng_ctx
**pctx
= runtime
->p
.priv
->pctx
;
286 dbg_printf("Apply context reloc: %u %s\n", reloc_offset
, context_name
);
288 /* Get context index */
289 idx
= lttng_get_context_index(*pctx
, context_name
);
291 if (lttng_context_is_app(context_name
)) {
294 ret
= lttng_ust_add_app_context_to_ctx_rcu(context_name
,
298 idx
= lttng_get_context_index(*pctx
, context_name
);
305 /* Check if idx is too large for 16-bit offset */
306 if (idx
> FILTER_BYTECODE_MAX_LEN
- 1)
309 /* Get context return type */
310 ctx_field
= &(*pctx
)->fields
[idx
];
311 op
= (struct load_op
*) &runtime
->code
[reloc_offset
];
313 switch (bytecode_op
) {
314 case BYTECODE_OP_GET_CONTEXT_REF
:
316 struct field_ref
*field_ref
;
318 field_ref
= (struct field_ref
*) op
->data
;
319 switch (ctx_field
->event_field
.type
.atype
) {
322 case atype_enum_nestable
:
323 op
->op
= BYTECODE_OP_GET_CONTEXT_REF_S64
;
325 /* Sequence and array supported as string */
328 case atype_array_nestable
:
330 case atype_sequence_nestable
:
331 op
->op
= BYTECODE_OP_GET_CONTEXT_REF_STRING
;
334 op
->op
= BYTECODE_OP_GET_CONTEXT_REF_DOUBLE
;
337 op
->op
= BYTECODE_OP_GET_CONTEXT_REF
;
342 /* set offset to context index within channel contexts */
343 field_ref
->offset
= (uint16_t) idx
;
353 int apply_reloc(const struct lttng_event_desc
*event_desc
,
354 struct bytecode_runtime
*runtime
,
355 uint32_t runtime_len
,
356 uint32_t reloc_offset
,
361 dbg_printf("Apply reloc: %u %s\n", reloc_offset
, name
);
363 /* Ensure that the reloc is within the code */
364 if (runtime_len
- reloc_offset
< sizeof(uint16_t))
367 op
= (struct load_op
*) &runtime
->code
[reloc_offset
];
369 case BYTECODE_OP_LOAD_FIELD_REF
:
370 return apply_field_reloc(event_desc
, runtime
, runtime_len
,
371 reloc_offset
, name
, op
->op
);
372 case BYTECODE_OP_GET_CONTEXT_REF
:
373 return apply_context_reloc(runtime
, runtime_len
,
374 reloc_offset
, name
, op
->op
);
375 case BYTECODE_OP_GET_SYMBOL
:
376 case BYTECODE_OP_GET_SYMBOL_FIELD
:
378 * Will be handled by load specialize phase or
379 * dynamically by interpreter.
383 ERR("Unknown reloc op type %u\n", op
->op
);
390 int bytecode_is_linked(struct lttng_ust_bytecode_node
*bytecode
,
391 struct cds_list_head
*bytecode_runtime_head
)
393 struct lttng_bytecode_runtime
*bc_runtime
;
395 cds_list_for_each_entry(bc_runtime
, bytecode_runtime_head
, node
) {
396 if (bc_runtime
->priv
->bc
== bytecode
)
403 * Take a bytecode with reloc table and link it to an event to create a
407 int link_bytecode(const struct lttng_event_desc
*event_desc
,
408 struct lttng_ctx
**ctx
,
409 struct lttng_ust_bytecode_node
*bytecode
,
410 struct cds_list_head
*insert_loc
)
412 int ret
, offset
, next_offset
;
413 struct bytecode_runtime
*runtime
= NULL
;
414 struct lttng_ust_bytecode_runtime_private
*runtime_priv
= NULL
;
415 size_t runtime_alloc_len
;
419 /* Bytecode already linked */
420 if (bytecode_is_linked(bytecode
, insert_loc
))
423 dbg_printf("Linking...\n");
425 /* We don't need the reloc table in the runtime */
426 runtime_alloc_len
= sizeof(*runtime
) + bytecode
->bc
.reloc_offset
;
427 runtime
= zmalloc(runtime_alloc_len
);
432 runtime_priv
= zmalloc(sizeof(struct lttng_ust_bytecode_runtime_private
));
439 runtime
->p
.priv
= runtime_priv
;
440 runtime_priv
->pub
= runtime
;
441 runtime_priv
->bc
= bytecode
;
442 runtime_priv
->pctx
= ctx
;
443 runtime
->len
= bytecode
->bc
.reloc_offset
;
444 /* copy original bytecode */
445 memcpy(runtime
->code
, bytecode
->bc
.data
, runtime
->len
);
447 * apply relocs. Those are a uint16_t (offset in bytecode)
448 * followed by a string (field name).
450 for (offset
= bytecode
->bc
.reloc_offset
;
451 offset
< bytecode
->bc
.len
;
452 offset
= next_offset
) {
453 uint16_t reloc_offset
=
454 *(uint16_t *) &bytecode
->bc
.data
[offset
];
456 (const char *) &bytecode
->bc
.data
[offset
+ sizeof(uint16_t)];
458 ret
= apply_reloc(event_desc
, runtime
, runtime
->len
, reloc_offset
, name
);
462 next_offset
= offset
+ sizeof(uint16_t) + strlen(name
) + 1;
464 /* Validate bytecode */
465 ret
= lttng_bytecode_validate(runtime
);
469 /* Specialize bytecode */
470 ret
= lttng_bytecode_specialize(event_desc
, runtime
);
475 switch (bytecode
->type
) {
476 case LTTNG_UST_BYTECODE_NODE_TYPE_FILTER
:
477 runtime
->p
.interpreter_funcs
.filter
= lttng_bytecode_filter_interpret
;
479 case LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE
:
480 runtime
->p
.interpreter_funcs
.capture
= lttng_bytecode_capture_interpret
;
486 runtime
->p
.priv
->link_failed
= 0;
487 cds_list_add_rcu(&runtime
->p
.node
, insert_loc
);
488 dbg_printf("Linking successful.\n");
492 switch (bytecode
->type
) {
493 case LTTNG_UST_BYTECODE_NODE_TYPE_FILTER
:
494 runtime
->p
.interpreter_funcs
.filter
= lttng_bytecode_filter_interpret_false
;
496 case LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE
:
497 runtime
->p
.interpreter_funcs
.capture
= lttng_bytecode_capture_interpret_false
;
503 runtime_priv
->link_failed
= 1;
504 cds_list_add_rcu(&runtime
->p
.node
, insert_loc
);
506 dbg_printf("Linking failed.\n");
510 void lttng_bytecode_filter_sync_state(struct lttng_bytecode_runtime
*runtime
)
512 struct lttng_ust_bytecode_node
*bc
= runtime
->priv
->bc
;
514 if (!bc
->enabler
->enabled
|| runtime
->priv
->link_failed
)
515 runtime
->interpreter_funcs
.filter
= lttng_bytecode_filter_interpret_false
;
517 runtime
->interpreter_funcs
.filter
= lttng_bytecode_filter_interpret
;
520 void lttng_bytecode_capture_sync_state(struct lttng_bytecode_runtime
*runtime
)
522 struct lttng_ust_bytecode_node
*bc
= runtime
->priv
->bc
;
524 if (!bc
->enabler
->enabled
|| runtime
->priv
->link_failed
)
525 runtime
->interpreter_funcs
.capture
= lttng_bytecode_capture_interpret_false
;
527 runtime
->interpreter_funcs
.capture
= lttng_bytecode_capture_interpret
;
531 * Given the lists of bytecode programs of an instance (trigger or event) and
532 * of a matching enabler, try to link all the enabler's bytecode programs with
535 * This function is called after we confirmed that name enabler and the
536 * instance are name matching (or glob pattern matching).
538 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
539 struct lttng_ctx
**ctx
,
540 struct cds_list_head
*instance_bytecode_head
,
541 struct cds_list_head
*enabler_bytecode_head
)
543 struct lttng_ust_bytecode_node
*enabler_bc
;
544 struct lttng_bytecode_runtime
*runtime
;
548 /* Go over all the bytecode programs of the enabler. */
549 cds_list_for_each_entry(enabler_bc
, enabler_bytecode_head
, node
) {
551 struct cds_list_head
*insert_loc
;
554 * Check if the current enabler bytecode program is already
555 * linked with the instance.
557 cds_list_for_each_entry(runtime
, instance_bytecode_head
, node
) {
558 if (runtime
->priv
->bc
== enabler_bc
) {
565 * Skip bytecode already linked, go to the next enabler
572 * Insert at specified priority (seqnum) in increasing
573 * order. If there already is a bytecode of the same priority,
574 * insert the new bytecode right after it.
576 cds_list_for_each_entry_reverse(runtime
,
577 instance_bytecode_head
, node
) {
578 if (runtime
->priv
->bc
->bc
.seqnum
<= enabler_bc
->bc
.seqnum
) {
580 insert_loc
= &runtime
->node
;
585 /* Add to head to list */
586 insert_loc
= instance_bytecode_head
;
588 dbg_printf("linking bytecode\n");
589 ret
= link_bytecode(event_desc
, ctx
, enabler_bc
, insert_loc
);
591 dbg_printf("[lttng filter] warning: cannot link event bytecode\n");
597 * We own the bytecode if we return success.
599 int lttng_filter_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
600 struct lttng_ust_bytecode_node
*bytecode
)
602 cds_list_add(&bytecode
->node
, &enabler
->filter_bytecode_head
);
607 void free_filter_runtime(struct cds_list_head
*bytecode_runtime_head
)
609 struct bytecode_runtime
*runtime
, *tmp
;
611 cds_list_for_each_entry_safe(runtime
, tmp
, bytecode_runtime_head
,
614 free(runtime
->p
.priv
);
619 void lttng_free_event_filter_runtime(struct lttng_event
*event
)
621 free_filter_runtime(&event
->filter_bytecode_runtime_head
);
624 void lttng_free_event_notifier_filter_runtime(
625 struct lttng_event_notifier
*event_notifier
)
627 free_filter_runtime(&event_notifier
->filter_bytecode_runtime_head
);