Rename "tsc" to "timestamp"
[lttng-ust.git] / liblttng-ust / lttng-filter.c
1 /*
2 * lttng-filter.c
3 *
4 * LTTng UST filter code.
5 *
6 * Copyright (C) 2010-2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27 #define _LGPL_SOURCE
28 #include <stddef.h>
29 #include <stdint.h>
30
31 #include <urcu/rculist.h>
32
33 #include "lttng-filter.h"
34
35 static const char *opnames[] = {
36 [ FILTER_OP_UNKNOWN ] = "UNKNOWN",
37
38 [ FILTER_OP_RETURN ] = "RETURN",
39
40 /* binary */
41 [ FILTER_OP_MUL ] = "MUL",
42 [ FILTER_OP_DIV ] = "DIV",
43 [ FILTER_OP_MOD ] = "MOD",
44 [ FILTER_OP_PLUS ] = "PLUS",
45 [ FILTER_OP_MINUS ] = "MINUS",
46 [ FILTER_OP_BIT_RSHIFT ] = "BIT_RSHIFT",
47 [ FILTER_OP_BIT_LSHIFT ] = "BIT_LSHIFT",
48 [ FILTER_OP_BIT_AND ] = "BIT_AND",
49 [ FILTER_OP_BIT_OR ] = "BIT_OR",
50 [ FILTER_OP_BIT_XOR ] = "BIT_XOR",
51
52 /* binary comparators */
53 [ FILTER_OP_EQ ] = "EQ",
54 [ FILTER_OP_NE ] = "NE",
55 [ FILTER_OP_GT ] = "GT",
56 [ FILTER_OP_LT ] = "LT",
57 [ FILTER_OP_GE ] = "GE",
58 [ FILTER_OP_LE ] = "LE",
59
60 /* string binary comparators */
61 [ FILTER_OP_EQ_STRING ] = "EQ_STRING",
62 [ FILTER_OP_NE_STRING ] = "NE_STRING",
63 [ FILTER_OP_GT_STRING ] = "GT_STRING",
64 [ FILTER_OP_LT_STRING ] = "LT_STRING",
65 [ FILTER_OP_GE_STRING ] = "GE_STRING",
66 [ FILTER_OP_LE_STRING ] = "LE_STRING",
67
68 /* s64 binary comparators */
69 [ FILTER_OP_EQ_S64 ] = "EQ_S64",
70 [ FILTER_OP_NE_S64 ] = "NE_S64",
71 [ FILTER_OP_GT_S64 ] = "GT_S64",
72 [ FILTER_OP_LT_S64 ] = "LT_S64",
73 [ FILTER_OP_GE_S64 ] = "GE_S64",
74 [ FILTER_OP_LE_S64 ] = "LE_S64",
75
76 /* double binary comparators */
77 [ FILTER_OP_EQ_DOUBLE ] = "EQ_DOUBLE",
78 [ FILTER_OP_NE_DOUBLE ] = "NE_DOUBLE",
79 [ FILTER_OP_GT_DOUBLE ] = "GT_DOUBLE",
80 [ FILTER_OP_LT_DOUBLE ] = "LT_DOUBLE",
81 [ FILTER_OP_GE_DOUBLE ] = "GE_DOUBLE",
82 [ FILTER_OP_LE_DOUBLE ] = "LE_DOUBLE",
83
84 /* Mixed S64-double binary comparators */
85 [ FILTER_OP_EQ_DOUBLE_S64 ] = "EQ_DOUBLE_S64",
86 [ FILTER_OP_NE_DOUBLE_S64 ] = "NE_DOUBLE_S64",
87 [ FILTER_OP_GT_DOUBLE_S64 ] = "GT_DOUBLE_S64",
88 [ FILTER_OP_LT_DOUBLE_S64 ] = "LT_DOUBLE_S64",
89 [ FILTER_OP_GE_DOUBLE_S64 ] = "GE_DOUBLE_S64",
90 [ FILTER_OP_LE_DOUBLE_S64 ] = "LE_DOUBLE_S64",
91
92 [ FILTER_OP_EQ_S64_DOUBLE ] = "EQ_S64_DOUBLE",
93 [ FILTER_OP_NE_S64_DOUBLE ] = "NE_S64_DOUBLE",
94 [ FILTER_OP_GT_S64_DOUBLE ] = "GT_S64_DOUBLE",
95 [ FILTER_OP_LT_S64_DOUBLE ] = "LT_S64_DOUBLE",
96 [ FILTER_OP_GE_S64_DOUBLE ] = "GE_S64_DOUBLE",
97 [ FILTER_OP_LE_S64_DOUBLE ] = "LE_S64_DOUBLE",
98
99 /* unary */
100 [ FILTER_OP_UNARY_PLUS ] = "UNARY_PLUS",
101 [ FILTER_OP_UNARY_MINUS ] = "UNARY_MINUS",
102 [ FILTER_OP_UNARY_NOT ] = "UNARY_NOT",
103 [ FILTER_OP_UNARY_PLUS_S64 ] = "UNARY_PLUS_S64",
104 [ FILTER_OP_UNARY_MINUS_S64 ] = "UNARY_MINUS_S64",
105 [ FILTER_OP_UNARY_NOT_S64 ] = "UNARY_NOT_S64",
106 [ FILTER_OP_UNARY_PLUS_DOUBLE ] = "UNARY_PLUS_DOUBLE",
107 [ FILTER_OP_UNARY_MINUS_DOUBLE ] = "UNARY_MINUS_DOUBLE",
108 [ FILTER_OP_UNARY_NOT_DOUBLE ] = "UNARY_NOT_DOUBLE",
109
110 /* logical */
111 [ FILTER_OP_AND ] = "AND",
112 [ FILTER_OP_OR ] = "OR",
113
114 /* load field ref */
115 [ FILTER_OP_LOAD_FIELD_REF ] = "LOAD_FIELD_REF",
116 [ FILTER_OP_LOAD_FIELD_REF_STRING ] = "LOAD_FIELD_REF_STRING",
117 [ FILTER_OP_LOAD_FIELD_REF_SEQUENCE ] = "LOAD_FIELD_REF_SEQUENCE",
118 [ FILTER_OP_LOAD_FIELD_REF_S64 ] = "LOAD_FIELD_REF_S64",
119 [ FILTER_OP_LOAD_FIELD_REF_DOUBLE ] = "LOAD_FIELD_REF_DOUBLE",
120
121 /* load from immediate operand */
122 [ FILTER_OP_LOAD_STRING ] = "LOAD_STRING",
123 [ FILTER_OP_LOAD_S64 ] = "LOAD_S64",
124 [ FILTER_OP_LOAD_DOUBLE ] = "LOAD_DOUBLE",
125
126 /* cast */
127 [ FILTER_OP_CAST_TO_S64 ] = "CAST_TO_S64",
128 [ FILTER_OP_CAST_DOUBLE_TO_S64 ] = "CAST_DOUBLE_TO_S64",
129 [ FILTER_OP_CAST_NOP ] = "CAST_NOP",
130
131 /* get context ref */
132 [ FILTER_OP_GET_CONTEXT_REF ] = "GET_CONTEXT_REF",
133 [ FILTER_OP_GET_CONTEXT_REF_STRING ] = "GET_CONTEXT_REF_STRING",
134 [ FILTER_OP_GET_CONTEXT_REF_S64 ] = "GET_CONTEXT_REF_S64",
135 [ FILTER_OP_GET_CONTEXT_REF_DOUBLE ] = "GET_CONTEXT_REF_DOUBLE",
136
137 /* load userspace field ref */
138 [ FILTER_OP_LOAD_FIELD_REF_USER_STRING ] = "LOAD_FIELD_REF_USER_STRING",
139 [ FILTER_OP_LOAD_FIELD_REF_USER_SEQUENCE ] = "LOAD_FIELD_REF_USER_SEQUENCE",
140
141 /*
142 * load immediate star globbing pattern (literal string)
143 * from immediate.
144 */
145 [ FILTER_OP_LOAD_STAR_GLOB_STRING ] = "LOAD_STAR_GLOB_STRING",
146
147 /* globbing pattern binary operator: apply to */
148 [ FILTER_OP_EQ_STAR_GLOB_STRING ] = "EQ_STAR_GLOB_STRING",
149 [ FILTER_OP_NE_STAR_GLOB_STRING ] = "NE_STAR_GLOB_STRING",
150
151 /*
152 * Instructions for recursive traversal through composed types.
153 */
154 [ FILTER_OP_GET_CONTEXT_ROOT ] = "GET_CONTEXT_ROOT",
155 [ FILTER_OP_GET_APP_CONTEXT_ROOT ] = "GET_APP_CONTEXT_ROOT",
156 [ FILTER_OP_GET_PAYLOAD_ROOT ] = "GET_PAYLOAD_ROOT",
157
158 [ FILTER_OP_GET_SYMBOL ] = "GET_SYMBOL",
159 [ FILTER_OP_GET_SYMBOL_FIELD ] = "GET_SYMBOL_FIELD",
160 [ FILTER_OP_GET_INDEX_U16 ] = "GET_INDEX_U16",
161 [ FILTER_OP_GET_INDEX_U64 ] = "GET_INDEX_U64",
162
163 [ FILTER_OP_LOAD_FIELD ] = "LOAD_FIELD",
164 [ FILTER_OP_LOAD_FIELD_S8 ] = "LOAD_FIELD_S8",
165 [ FILTER_OP_LOAD_FIELD_S16 ] = "LOAD_FIELD_S16",
166 [ FILTER_OP_LOAD_FIELD_S32 ] = "LOAD_FIELD_S32",
167 [ FILTER_OP_LOAD_FIELD_S64 ] = "LOAD_FIELD_S64",
168 [ FILTER_OP_LOAD_FIELD_U8 ] = "LOAD_FIELD_U8",
169 [ FILTER_OP_LOAD_FIELD_U16 ] = "LOAD_FIELD_U16",
170 [ FILTER_OP_LOAD_FIELD_U32 ] = "LOAD_FIELD_U32",
171 [ FILTER_OP_LOAD_FIELD_U64 ] = "LOAD_FIELD_U64",
172 [ FILTER_OP_LOAD_FIELD_STRING ] = "LOAD_FIELD_STRING",
173 [ FILTER_OP_LOAD_FIELD_SEQUENCE ] = "LOAD_FIELD_SEQUENCE",
174 [ FILTER_OP_LOAD_FIELD_DOUBLE ] = "LOAD_FIELD_DOUBLE",
175
176 [ FILTER_OP_UNARY_BIT_NOT ] = "UNARY_BIT_NOT",
177
178 [ FILTER_OP_RETURN_S64 ] = "RETURN_S64",
179 };
180
181 const char *print_op(enum filter_op op)
182 {
183 if (op >= NR_FILTER_OPS)
184 return "UNKNOWN";
185 else
186 return opnames[op];
187 }
188
189 static
190 int apply_field_reloc(struct lttng_event *event,
191 struct bytecode_runtime *runtime,
192 uint32_t runtime_len,
193 uint32_t reloc_offset,
194 const char *field_name,
195 enum filter_op filter_op)
196 {
197 const struct lttng_event_desc *desc;
198 const struct lttng_event_field *fields, *field = NULL;
199 unsigned int nr_fields, i;
200 struct load_op *op;
201 uint32_t field_offset = 0;
202
203 dbg_printf("Apply field reloc: %u %s\n", reloc_offset, field_name);
204
205 /* Lookup event by name */
206 desc = event->desc;
207 if (!desc)
208 return -EINVAL;
209 fields = desc->fields;
210 if (!fields)
211 return -EINVAL;
212 nr_fields = desc->nr_fields;
213 for (i = 0; i < nr_fields; i++) {
214 if (fields[i].u.ext.nofilter) {
215 continue;
216 }
217 if (!strcmp(fields[i].name, field_name)) {
218 field = &fields[i];
219 break;
220 }
221 /* compute field offset */
222 switch (fields[i].type.atype) {
223 case atype_integer:
224 case atype_enum:
225 case atype_enum_nestable:
226 field_offset += sizeof(int64_t);
227 break;
228 case atype_array:
229 case atype_array_nestable:
230 case atype_sequence:
231 case atype_sequence_nestable:
232 field_offset += sizeof(unsigned long);
233 field_offset += sizeof(void *);
234 break;
235 case atype_string:
236 field_offset += sizeof(void *);
237 break;
238 case atype_float:
239 field_offset += sizeof(double);
240 break;
241 default:
242 return -EINVAL;
243 }
244 }
245 if (!field)
246 return -EINVAL;
247
248 /* Check if field offset is too large for 16-bit offset */
249 if (field_offset > FILTER_BYTECODE_MAX_LEN - 1)
250 return -EINVAL;
251
252 /* set type */
253 op = (struct load_op *) &runtime->code[reloc_offset];
254
255 switch (filter_op) {
256 case FILTER_OP_LOAD_FIELD_REF:
257 {
258 struct field_ref *field_ref;
259
260 field_ref = (struct field_ref *) op->data;
261 switch (field->type.atype) {
262 case atype_integer:
263 case atype_enum:
264 case atype_enum_nestable:
265 op->op = FILTER_OP_LOAD_FIELD_REF_S64;
266 break;
267 case atype_array:
268 case atype_array_nestable:
269 case atype_sequence:
270 case atype_sequence_nestable:
271 op->op = FILTER_OP_LOAD_FIELD_REF_SEQUENCE;
272 break;
273 case atype_string:
274 op->op = FILTER_OP_LOAD_FIELD_REF_STRING;
275 break;
276 case atype_float:
277 op->op = FILTER_OP_LOAD_FIELD_REF_DOUBLE;
278 break;
279 default:
280 return -EINVAL;
281 }
282 /* set offset */
283 field_ref->offset = (uint16_t) field_offset;
284 break;
285 }
286 default:
287 return -EINVAL;
288 }
289 return 0;
290 }
291
292 static
293 int apply_context_reloc(struct lttng_event *event,
294 struct bytecode_runtime *runtime,
295 uint32_t runtime_len,
296 uint32_t reloc_offset,
297 const char *context_name,
298 enum filter_op filter_op)
299 {
300 struct load_op *op;
301 struct lttng_ctx_field *ctx_field;
302 int idx;
303 struct lttng_session *session = runtime->p.session;
304
305 dbg_printf("Apply context reloc: %u %s\n", reloc_offset, context_name);
306
307 /* Get context index */
308 idx = lttng_get_context_index(session->ctx, context_name);
309 if (idx < 0) {
310 if (lttng_context_is_app(context_name)) {
311 int ret;
312
313 ret = lttng_ust_add_app_context_to_ctx_rcu(context_name,
314 &session->ctx);
315 if (ret)
316 return ret;
317 idx = lttng_get_context_index(session->ctx,
318 context_name);
319 if (idx < 0)
320 return -ENOENT;
321 } else {
322 return -ENOENT;
323 }
324 }
325 /* Check if idx is too large for 16-bit offset */
326 if (idx > FILTER_BYTECODE_MAX_LEN - 1)
327 return -EINVAL;
328
329 /* Get context return type */
330 ctx_field = &session->ctx->fields[idx];
331 op = (struct load_op *) &runtime->code[reloc_offset];
332
333 switch (filter_op) {
334 case FILTER_OP_GET_CONTEXT_REF:
335 {
336 struct field_ref *field_ref;
337
338 field_ref = (struct field_ref *) op->data;
339 switch (ctx_field->event_field.type.atype) {
340 case atype_integer:
341 case atype_enum:
342 case atype_enum_nestable:
343 op->op = FILTER_OP_GET_CONTEXT_REF_S64;
344 break;
345 /* Sequence and array supported as string */
346 case atype_string:
347 case atype_array:
348 case atype_array_nestable:
349 case atype_sequence:
350 case atype_sequence_nestable:
351 op->op = FILTER_OP_GET_CONTEXT_REF_STRING;
352 break;
353 case atype_float:
354 op->op = FILTER_OP_GET_CONTEXT_REF_DOUBLE;
355 break;
356 case atype_dynamic:
357 op->op = FILTER_OP_GET_CONTEXT_REF;
358 break;
359 default:
360 return -EINVAL;
361 }
362 /* set offset to context index within channel contexts */
363 field_ref->offset = (uint16_t) idx;
364 break;
365 }
366 default:
367 return -EINVAL;
368 }
369 return 0;
370 }
371
372 static
373 int apply_reloc(struct lttng_event *event,
374 struct bytecode_runtime *runtime,
375 uint32_t runtime_len,
376 uint32_t reloc_offset,
377 const char *name)
378 {
379 struct load_op *op;
380
381 dbg_printf("Apply reloc: %u %s\n", reloc_offset, name);
382
383 /* Ensure that the reloc is within the code */
384 if (runtime_len - reloc_offset < sizeof(uint16_t))
385 return -EINVAL;
386
387 op = (struct load_op *) &runtime->code[reloc_offset];
388 switch (op->op) {
389 case FILTER_OP_LOAD_FIELD_REF:
390 return apply_field_reloc(event, runtime, runtime_len,
391 reloc_offset, name, op->op);
392 case FILTER_OP_GET_CONTEXT_REF:
393 return apply_context_reloc(event, runtime, runtime_len,
394 reloc_offset, name, op->op);
395 case FILTER_OP_GET_SYMBOL:
396 case FILTER_OP_GET_SYMBOL_FIELD:
397 /*
398 * Will be handled by load specialize phase or
399 * dynamically by interpreter.
400 */
401 return 0;
402 default:
403 ERR("Unknown reloc op type %u\n", op->op);
404 return -EINVAL;
405 }
406 return 0;
407 }
408
409 static
410 int bytecode_is_linked(struct lttng_ust_filter_bytecode_node *filter_bytecode,
411 struct lttng_event *event)
412 {
413 struct lttng_bytecode_runtime *bc_runtime;
414
415 cds_list_for_each_entry(bc_runtime,
416 &event->bytecode_runtime_head, node) {
417 if (bc_runtime->bc == filter_bytecode)
418 return 1;
419 }
420 return 0;
421 }
422
423 /*
424 * Take a bytecode with reloc table and link it to an event to create a
425 * bytecode runtime.
426 */
427 static
428 int _lttng_filter_event_link_bytecode(struct lttng_event *event,
429 struct lttng_ust_filter_bytecode_node *filter_bytecode,
430 struct cds_list_head *insert_loc)
431 {
432 int ret, offset, next_offset;
433 struct bytecode_runtime *runtime = NULL;
434 size_t runtime_alloc_len;
435
436 if (!filter_bytecode)
437 return 0;
438 /* Bytecode already linked */
439 if (bytecode_is_linked(filter_bytecode, event))
440 return 0;
441
442 dbg_printf("Linking...\n");
443
444 /* We don't need the reloc table in the runtime */
445 runtime_alloc_len = sizeof(*runtime) + filter_bytecode->bc.reloc_offset;
446 runtime = zmalloc(runtime_alloc_len);
447 if (!runtime) {
448 ret = -ENOMEM;
449 goto alloc_error;
450 }
451 runtime->p.bc = filter_bytecode;
452 runtime->p.session = event->chan->session;
453 runtime->len = filter_bytecode->bc.reloc_offset;
454 /* copy original bytecode */
455 memcpy(runtime->code, filter_bytecode->bc.data, runtime->len);
456 /*
457 * apply relocs. Those are a uint16_t (offset in bytecode)
458 * followed by a string (field name).
459 */
460 for (offset = filter_bytecode->bc.reloc_offset;
461 offset < filter_bytecode->bc.len;
462 offset = next_offset) {
463 uint16_t reloc_offset =
464 *(uint16_t *) &filter_bytecode->bc.data[offset];
465 const char *name =
466 (const char *) &filter_bytecode->bc.data[offset + sizeof(uint16_t)];
467
468 ret = apply_reloc(event, runtime, runtime->len, reloc_offset, name);
469 if (ret) {
470 goto link_error;
471 }
472 next_offset = offset + sizeof(uint16_t) + strlen(name) + 1;
473 }
474 /* Validate bytecode */
475 ret = lttng_filter_validate_bytecode(runtime);
476 if (ret) {
477 goto link_error;
478 }
479 /* Specialize bytecode */
480 ret = lttng_filter_specialize_bytecode(event, runtime);
481 if (ret) {
482 goto link_error;
483 }
484 runtime->p.filter = lttng_filter_interpret_bytecode;
485 runtime->p.link_failed = 0;
486 cds_list_add_rcu(&runtime->p.node, insert_loc);
487 dbg_printf("Linking successful.\n");
488 return 0;
489
490 link_error:
491 runtime->p.filter = lttng_filter_false;
492 runtime->p.link_failed = 1;
493 cds_list_add_rcu(&runtime->p.node, insert_loc);
494 alloc_error:
495 dbg_printf("Linking failed.\n");
496 return ret;
497 }
498
499 void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime)
500 {
501 struct lttng_ust_filter_bytecode_node *bc = runtime->bc;
502
503 if (!bc->enabler->enabled || runtime->link_failed)
504 runtime->filter = lttng_filter_false;
505 else
506 runtime->filter = lttng_filter_interpret_bytecode;
507 }
508
509 /*
510 * Link bytecode for all enablers referenced by an event.
511 */
512 void lttng_enabler_event_link_bytecode(struct lttng_event *event,
513 struct lttng_enabler *enabler)
514 {
515 struct lttng_ust_filter_bytecode_node *bc;
516 struct lttng_bytecode_runtime *runtime;
517
518 /* Can only be called for events with desc attached */
519 assert(event->desc);
520
521 /* Link each bytecode. */
522 cds_list_for_each_entry(bc, &enabler->filter_bytecode_head, node) {
523 int found = 0, ret;
524 struct cds_list_head *insert_loc;
525
526 cds_list_for_each_entry(runtime,
527 &event->bytecode_runtime_head, node) {
528 if (runtime->bc == bc) {
529 found = 1;
530 break;
531 }
532 }
533 /* Skip bytecode already linked */
534 if (found)
535 continue;
536
537 /*
538 * Insert at specified priority (seqnum) in increasing
539 * order. If there already is a bytecode of the same priority,
540 * insert the new bytecode right after it.
541 */
542 cds_list_for_each_entry_reverse(runtime,
543 &event->bytecode_runtime_head, node) {
544 if (runtime->bc->bc.seqnum <= bc->bc.seqnum) {
545 /* insert here */
546 insert_loc = &runtime->node;
547 goto add_within;
548 }
549 }
550 /* Add to head to list */
551 insert_loc = &event->bytecode_runtime_head;
552 add_within:
553 dbg_printf("linking bytecode\n");
554 ret = _lttng_filter_event_link_bytecode(event, bc,
555 insert_loc);
556 if (ret) {
557 dbg_printf("[lttng filter] warning: cannot link event bytecode\n");
558 }
559 }
560 }
561
562 /*
563 * We own the filter_bytecode if we return success.
564 */
565 int lttng_filter_enabler_attach_bytecode(struct lttng_enabler *enabler,
566 struct lttng_ust_filter_bytecode_node *filter_bytecode)
567 {
568 cds_list_add(&filter_bytecode->node, &enabler->filter_bytecode_head);
569 return 0;
570 }
571
572 void lttng_free_event_filter_runtime(struct lttng_event *event)
573 {
574 struct bytecode_runtime *runtime, *tmp;
575
576 cds_list_for_each_entry_safe(runtime, tmp,
577 &event->bytecode_runtime_head, p.node) {
578 free(runtime->data);
579 free(runtime);
580 }
581 }
This page took 0.041557 seconds and 4 git commands to generate.