4 * LTTng UST filter code.
6 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; only
11 * version 2.1 of the License.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <urcu/rculist.h>
24 #include "lttng-filter.h"
26 static const char *opnames
[] = {
27 [ FILTER_OP_UNKNOWN
] = "UNKNOWN",
29 [ FILTER_OP_RETURN
] = "RETURN",
32 [ FILTER_OP_MUL
] = "MUL",
33 [ FILTER_OP_DIV
] = "DIV",
34 [ FILTER_OP_MOD
] = "MOD",
35 [ FILTER_OP_PLUS
] = "PLUS",
36 [ FILTER_OP_MINUS
] = "MINUS",
37 [ FILTER_OP_RSHIFT
] = "RSHIFT",
38 [ FILTER_OP_LSHIFT
] = "LSHIFT",
39 [ FILTER_OP_BIN_AND
] = "BIN_AND",
40 [ FILTER_OP_BIN_OR
] = "BIN_OR",
41 [ FILTER_OP_BIN_XOR
] = "BIN_XOR",
43 /* binary comparators */
44 [ FILTER_OP_EQ
] = "EQ",
45 [ FILTER_OP_NE
] = "NE",
46 [ FILTER_OP_GT
] = "GT",
47 [ FILTER_OP_LT
] = "LT",
48 [ FILTER_OP_GE
] = "GE",
49 [ FILTER_OP_LE
] = "LE",
51 /* string binary comparators */
52 [ FILTER_OP_EQ_STRING
] = "EQ_STRING",
53 [ FILTER_OP_NE_STRING
] = "NE_STRING",
54 [ FILTER_OP_GT_STRING
] = "GT_STRING",
55 [ FILTER_OP_LT_STRING
] = "LT_STRING",
56 [ FILTER_OP_GE_STRING
] = "GE_STRING",
57 [ FILTER_OP_LE_STRING
] = "LE_STRING",
59 /* s64 binary comparators */
60 [ FILTER_OP_EQ_S64
] = "EQ_S64",
61 [ FILTER_OP_NE_S64
] = "NE_S64",
62 [ FILTER_OP_GT_S64
] = "GT_S64",
63 [ FILTER_OP_LT_S64
] = "LT_S64",
64 [ FILTER_OP_GE_S64
] = "GE_S64",
65 [ FILTER_OP_LE_S64
] = "LE_S64",
67 /* double binary comparators */
68 [ FILTER_OP_EQ_DOUBLE
] = "EQ_DOUBLE",
69 [ FILTER_OP_NE_DOUBLE
] = "NE_DOUBLE",
70 [ FILTER_OP_GT_DOUBLE
] = "GT_DOUBLE",
71 [ FILTER_OP_LT_DOUBLE
] = "LT_DOUBLE",
72 [ FILTER_OP_GE_DOUBLE
] = "GE_DOUBLE",
73 [ FILTER_OP_LE_DOUBLE
] = "LE_DOUBLE",
75 /* Mixed S64-double binary comparators */
76 [ FILTER_OP_EQ_DOUBLE_S64
] = "EQ_DOUBLE_S64",
77 [ FILTER_OP_NE_DOUBLE_S64
] = "NE_DOUBLE_S64",
78 [ FILTER_OP_GT_DOUBLE_S64
] = "GT_DOUBLE_S64",
79 [ FILTER_OP_LT_DOUBLE_S64
] = "LT_DOUBLE_S64",
80 [ FILTER_OP_GE_DOUBLE_S64
] = "GE_DOUBLE_S64",
81 [ FILTER_OP_LE_DOUBLE_S64
] = "LE_DOUBLE_S64",
83 [ FILTER_OP_EQ_S64_DOUBLE
] = "EQ_S64_DOUBLE",
84 [ FILTER_OP_NE_S64_DOUBLE
] = "NE_S64_DOUBLE",
85 [ FILTER_OP_GT_S64_DOUBLE
] = "GT_S64_DOUBLE",
86 [ FILTER_OP_LT_S64_DOUBLE
] = "LT_S64_DOUBLE",
87 [ FILTER_OP_GE_S64_DOUBLE
] = "GE_S64_DOUBLE",
88 [ FILTER_OP_LE_S64_DOUBLE
] = "LE_S64_DOUBLE",
91 [ FILTER_OP_UNARY_PLUS
] = "UNARY_PLUS",
92 [ FILTER_OP_UNARY_MINUS
] = "UNARY_MINUS",
93 [ FILTER_OP_UNARY_NOT
] = "UNARY_NOT",
94 [ FILTER_OP_UNARY_PLUS_S64
] = "UNARY_PLUS_S64",
95 [ FILTER_OP_UNARY_MINUS_S64
] = "UNARY_MINUS_S64",
96 [ FILTER_OP_UNARY_NOT_S64
] = "UNARY_NOT_S64",
97 [ FILTER_OP_UNARY_PLUS_DOUBLE
] = "UNARY_PLUS_DOUBLE",
98 [ FILTER_OP_UNARY_MINUS_DOUBLE
] = "UNARY_MINUS_DOUBLE",
99 [ FILTER_OP_UNARY_NOT_DOUBLE
] = "UNARY_NOT_DOUBLE",
102 [ FILTER_OP_AND
] = "AND",
103 [ FILTER_OP_OR
] = "OR",
106 [ FILTER_OP_LOAD_FIELD_REF
] = "LOAD_FIELD_REF",
107 [ FILTER_OP_LOAD_FIELD_REF_STRING
] = "LOAD_FIELD_REF_STRING",
108 [ FILTER_OP_LOAD_FIELD_REF_SEQUENCE
] = "LOAD_FIELD_REF_SEQUENCE",
109 [ FILTER_OP_LOAD_FIELD_REF_S64
] = "LOAD_FIELD_REF_S64",
110 [ FILTER_OP_LOAD_FIELD_REF_DOUBLE
] = "LOAD_FIELD_REF_DOUBLE",
112 /* load from immediate operand */
113 [ FILTER_OP_LOAD_STRING
] = "LOAD_STRING",
114 [ FILTER_OP_LOAD_S64
] = "LOAD_S64",
115 [ FILTER_OP_LOAD_DOUBLE
] = "LOAD_DOUBLE",
118 [ FILTER_OP_CAST_TO_S64
] = "CAST_TO_S64",
119 [ FILTER_OP_CAST_DOUBLE_TO_S64
] = "CAST_DOUBLE_TO_S64",
120 [ FILTER_OP_CAST_NOP
] = "CAST_NOP",
122 /* get context ref */
123 [ FILTER_OP_GET_CONTEXT_REF
] = "GET_CONTEXT_REF",
124 [ FILTER_OP_GET_CONTEXT_REF_STRING
] = "GET_CONTEXT_REF_STRING",
125 [ FILTER_OP_GET_CONTEXT_REF_S64
] = "GET_CONTEXT_REF_S64",
126 [ FILTER_OP_GET_CONTEXT_REF_DOUBLE
] = "GET_CONTEXT_REF_DOUBLE",
129 const char *print_op(enum filter_op op
)
131 if (op
>= NR_FILTER_OPS
)
138 int apply_field_reloc(struct lttng_event
*event
,
139 struct bytecode_runtime
*runtime
,
140 uint32_t runtime_len
,
141 uint32_t reloc_offset
,
142 const char *field_name
)
144 const struct lttng_event_desc
*desc
;
145 const struct lttng_event_field
*fields
, *field
= NULL
;
146 unsigned int nr_fields
, i
;
147 struct field_ref
*field_ref
;
149 uint32_t field_offset
= 0;
151 dbg_printf("Apply field reloc: %u %s\n", reloc_offset
, field_name
);
153 /* Lookup event by name */
157 fields
= desc
->fields
;
160 nr_fields
= desc
->nr_fields
;
161 for (i
= 0; i
< nr_fields
; i
++) {
162 if (!strcmp(fields
[i
].name
, field_name
)) {
166 /* compute field offset */
167 switch (fields
[i
].type
.atype
) {
170 field_offset
+= sizeof(int64_t);
174 field_offset
+= sizeof(unsigned long);
175 field_offset
+= sizeof(void *);
178 field_offset
+= sizeof(void *);
181 field_offset
+= sizeof(double);
190 /* Check if field offset is too large for 16-bit offset */
191 if (field_offset
> FILTER_BYTECODE_MAX_LEN
- 1)
195 op
= (struct load_op
*) &runtime
->data
[reloc_offset
];
196 field_ref
= (struct field_ref
*) op
->data
;
197 switch (field
->type
.atype
) {
200 op
->op
= FILTER_OP_LOAD_FIELD_REF_S64
;
204 op
->op
= FILTER_OP_LOAD_FIELD_REF_SEQUENCE
;
207 op
->op
= FILTER_OP_LOAD_FIELD_REF_STRING
;
210 op
->op
= FILTER_OP_LOAD_FIELD_REF_DOUBLE
;
216 field_ref
->offset
= (uint16_t) field_offset
;
221 int apply_context_reloc(struct lttng_event
*event
,
222 struct bytecode_runtime
*runtime
,
223 uint32_t runtime_len
,
224 uint32_t reloc_offset
,
225 const char *context_name
)
227 struct field_ref
*field_ref
;
229 struct lttng_ctx_field
*ctx_field
;
231 struct lttng_session
*session
= runtime
->p
.session
;
233 dbg_printf("Apply context reloc: %u %s\n", reloc_offset
, context_name
);
235 /* Get context index */
236 idx
= lttng_get_context_index(session
->ctx
, context_name
);
238 if (lttng_context_is_app(context_name
)) {
241 ret
= lttng_ust_add_app_context_to_ctx_rcu(context_name
,
245 idx
= lttng_get_context_index(session
->ctx
,
253 /* Check if idx is too large for 16-bit offset */
254 if (idx
> FILTER_BYTECODE_MAX_LEN
- 1)
257 /* Get context return type */
258 ctx_field
= &session
->ctx
->fields
[idx
];
259 op
= (struct load_op
*) &runtime
->data
[reloc_offset
];
260 field_ref
= (struct field_ref
*) op
->data
;
261 switch (ctx_field
->event_field
.type
.atype
) {
264 op
->op
= FILTER_OP_GET_CONTEXT_REF_S64
;
266 /* Sequence and array supported as string */
270 op
->op
= FILTER_OP_GET_CONTEXT_REF_STRING
;
273 op
->op
= FILTER_OP_GET_CONTEXT_REF_DOUBLE
;
276 op
->op
= FILTER_OP_GET_CONTEXT_REF
;
281 /* set offset to context index within channel contexts */
282 field_ref
->offset
= (uint16_t) idx
;
287 int apply_reloc(struct lttng_event
*event
,
288 struct bytecode_runtime
*runtime
,
289 uint32_t runtime_len
,
290 uint32_t reloc_offset
,
295 dbg_printf("Apply reloc: %u %s\n", reloc_offset
, name
);
297 /* Ensure that the reloc is within the code */
298 if (runtime_len
- reloc_offset
< sizeof(uint16_t))
301 op
= (struct load_op
*) &runtime
->data
[reloc_offset
];
303 case FILTER_OP_LOAD_FIELD_REF
:
304 return apply_field_reloc(event
, runtime
, runtime_len
,
306 case FILTER_OP_GET_CONTEXT_REF
:
307 return apply_context_reloc(event
, runtime
, runtime_len
,
310 ERR("Unknown reloc op type %u\n", op
->op
);
317 int bytecode_is_linked(struct lttng_ust_filter_bytecode_node
*filter_bytecode
,
318 struct lttng_event
*event
)
320 struct lttng_bytecode_runtime
*bc_runtime
;
322 cds_list_for_each_entry(bc_runtime
,
323 &event
->bytecode_runtime_head
, node
) {
324 if (bc_runtime
->bc
== filter_bytecode
)
331 * Take a bytecode with reloc table and link it to an event to create a
335 int _lttng_filter_event_link_bytecode(struct lttng_event
*event
,
336 struct lttng_ust_filter_bytecode_node
*filter_bytecode
,
337 struct cds_list_head
*insert_loc
)
339 int ret
, offset
, next_offset
;
340 struct bytecode_runtime
*runtime
= NULL
;
341 size_t runtime_alloc_len
;
343 if (!filter_bytecode
)
345 /* Bytecode already linked */
346 if (bytecode_is_linked(filter_bytecode
, event
))
349 dbg_printf("Linking...\n");
351 /* We don't need the reloc table in the runtime */
352 runtime_alloc_len
= sizeof(*runtime
) + filter_bytecode
->bc
.reloc_offset
;
353 runtime
= zmalloc(runtime_alloc_len
);
358 runtime
->p
.bc
= filter_bytecode
;
359 runtime
->p
.session
= event
->chan
->session
;
360 runtime
->len
= filter_bytecode
->bc
.reloc_offset
;
361 /* copy original bytecode */
362 memcpy(runtime
->data
, filter_bytecode
->bc
.data
, runtime
->len
);
364 * apply relocs. Those are a uint16_t (offset in bytecode)
365 * followed by a string (field name).
367 for (offset
= filter_bytecode
->bc
.reloc_offset
;
368 offset
< filter_bytecode
->bc
.len
;
369 offset
= next_offset
) {
370 uint16_t reloc_offset
=
371 *(uint16_t *) &filter_bytecode
->bc
.data
[offset
];
373 (const char *) &filter_bytecode
->bc
.data
[offset
+ sizeof(uint16_t)];
375 ret
= apply_reloc(event
, runtime
, runtime
->len
, reloc_offset
, name
);
379 next_offset
= offset
+ sizeof(uint16_t) + strlen(name
) + 1;
381 /* Validate bytecode */
382 ret
= lttng_filter_validate_bytecode(runtime
);
386 /* Specialize bytecode */
387 ret
= lttng_filter_specialize_bytecode(runtime
);
391 runtime
->p
.filter
= lttng_filter_interpret_bytecode
;
392 runtime
->p
.link_failed
= 0;
393 cds_list_add_rcu(&runtime
->p
.node
, insert_loc
);
394 dbg_printf("Linking successful.\n");
398 runtime
->p
.filter
= lttng_filter_false
;
399 runtime
->p
.link_failed
= 1;
400 cds_list_add_rcu(&runtime
->p
.node
, insert_loc
);
402 dbg_printf("Linking failed.\n");
406 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
)
408 struct lttng_ust_filter_bytecode_node
*bc
= runtime
->bc
;
410 if (!bc
->enabler
->enabled
|| runtime
->link_failed
)
411 runtime
->filter
= lttng_filter_false
;
413 runtime
->filter
= lttng_filter_interpret_bytecode
;
417 * Link bytecode for all enablers referenced by an event.
419 void lttng_enabler_event_link_bytecode(struct lttng_event
*event
,
420 struct lttng_enabler
*enabler
)
422 struct lttng_ust_filter_bytecode_node
*bc
;
423 struct lttng_bytecode_runtime
*runtime
;
425 /* Can only be called for events with desc attached */
428 /* Link each bytecode. */
429 cds_list_for_each_entry(bc
, &enabler
->filter_bytecode_head
, node
) {
431 struct cds_list_head
*insert_loc
;
433 cds_list_for_each_entry(runtime
,
434 &event
->bytecode_runtime_head
, node
) {
435 if (runtime
->bc
== bc
) {
440 /* Skip bytecode already linked */
445 * Insert at specified priority (seqnum) in increasing
448 cds_list_for_each_entry_reverse(runtime
,
449 &event
->bytecode_runtime_head
, node
) {
450 if (runtime
->bc
->bc
.seqnum
< bc
->bc
.seqnum
) {
452 insert_loc
= &runtime
->node
;
456 /* Add to head to list */
457 insert_loc
= &event
->bytecode_runtime_head
;
459 dbg_printf("linking bytecode\n");
460 ret
= _lttng_filter_event_link_bytecode(event
, bc
,
463 dbg_printf("[lttng filter] warning: cannot link event bytecode\n");
469 * We own the filter_bytecode if we return success.
471 int lttng_filter_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
472 struct lttng_ust_filter_bytecode_node
*filter_bytecode
)
474 cds_list_add(&filter_bytecode
->node
, &enabler
->filter_bytecode_head
);
478 void lttng_free_enabler_filter_bytecode(struct lttng_enabler
*enabler
)
480 struct lttng_ust_filter_bytecode_node
*filter_bytecode
, *tmp
;
482 cds_list_for_each_entry_safe(filter_bytecode
, tmp
,
483 &enabler
->filter_bytecode_head
, node
) {
484 free(filter_bytecode
);
488 void lttng_free_event_filter_runtime(struct lttng_event
*event
)
490 struct bytecode_runtime
*runtime
, *tmp
;
492 cds_list_for_each_entry_safe(runtime
, tmp
,
493 &event
->bytecode_runtime_head
, p
.node
) {