2 * lttng-filter-validator.c
4 * LTTng modules filter bytecode validator.
6 * Copyright (C) 2010-2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
27 #include <linux/types.h>
28 #include <linux/jhash.h>
29 #include <linux/slab.h>
31 #include <wrapper/list.h>
32 #include <lttng-filter.h>
34 #define MERGE_POINT_TABLE_BITS 7
35 #define MERGE_POINT_TABLE_SIZE (1U << MERGE_POINT_TABLE_BITS)
37 /* merge point table node */
39 struct hlist_node node
;
41 /* Context at merge point */
43 unsigned long target_pc
;
47 struct hlist_head mp_head
[MERGE_POINT_TABLE_SIZE
];
51 int lttng_hash_match(struct mp_node
*mp_node
, unsigned long key_pc
)
53 if (mp_node
->target_pc
== key_pc
)
60 int merge_points_compare(const struct vstack
*stacka
,
61 const struct vstack
*stackb
)
65 if (stacka
->top
!= stackb
->top
)
67 len
= stacka
->top
+ 1;
68 WARN_ON_ONCE(len
< 0);
69 for (i
= 0; i
< len
; i
++) {
70 if (stacka
->e
[i
].type
!= stackb
->e
[i
].type
)
77 int merge_point_add_check(struct mp_table
*mp_table
, unsigned long target_pc
,
78 const struct vstack
*stack
)
80 struct mp_node
*mp_node
;
81 unsigned long hash
= jhash_1word(target_pc
, 0);
82 struct hlist_head
*head
;
83 struct mp_node
*lookup_node
;
86 dbg_printk("Filter: adding merge point at offset %lu, hash %lu\n",
88 mp_node
= kzalloc(sizeof(struct mp_node
), GFP_KERNEL
);
91 mp_node
->target_pc
= target_pc
;
92 memcpy(&mp_node
->stack
, stack
, sizeof(mp_node
->stack
));
94 head
= &mp_table
->mp_head
[hash
& (MERGE_POINT_TABLE_SIZE
- 1)];
95 lttng_hlist_for_each_entry(lookup_node
, head
, node
) {
96 if (lttng_hash_match(lookup_node
, target_pc
)) {
102 /* Key already present */
103 dbg_printk("Filter: compare merge points for offset %lu, hash %lu\n",
106 if (merge_points_compare(stack
, &lookup_node
->stack
)) {
107 printk(KERN_WARNING
"Merge points differ for offset %lu\n",
112 hlist_add_head(&mp_node
->node
, head
);
118 * Binary comparators use top of stack and top of stack -1.
121 int bin_op_compare_check(struct vstack
*stack
, const filter_opcode_t opcode
,
124 if (unlikely(!vstack_ax(stack
) || !vstack_bx(stack
)))
127 switch (vstack_ax(stack
)->type
) {
133 switch (vstack_bx(stack
)->type
) {
137 case REG_TYPE_UNKNOWN
:
141 case REG_STAR_GLOB_STRING
:
142 if (opcode
!= FILTER_OP_EQ
&& opcode
!= FILTER_OP_NE
) {
150 case REG_STAR_GLOB_STRING
:
151 switch (vstack_bx(stack
)->type
) {
155 case REG_TYPE_UNKNOWN
:
158 if (opcode
!= FILTER_OP_EQ
&& opcode
!= FILTER_OP_NE
) {
162 case REG_STAR_GLOB_STRING
:
168 switch (vstack_bx(stack
)->type
) {
172 case REG_TYPE_UNKNOWN
:
175 case REG_STAR_GLOB_STRING
:
181 case REG_TYPE_UNKNOWN
:
182 switch (vstack_bx(stack
)->type
) {
186 case REG_TYPE_UNKNOWN
:
188 case REG_STAR_GLOB_STRING
:
200 printk(KERN_WARNING
"empty stack for '%s' binary operator\n", str
);
204 printk(KERN_WARNING
"type mismatch for '%s' binary operator\n", str
);
208 printk(KERN_WARNING
"unknown type for '%s' binary operator\n", str
);
213 * Binary bitwise operators use top of stack and top of stack -1.
214 * Return 0 if typing is known to match, 1 if typing is dynamic
215 * (unknown), negative error value on error.
218 int bin_op_bitwise_check(struct vstack
*stack
, filter_opcode_t opcode
,
221 if (unlikely(!vstack_ax(stack
) || !vstack_bx(stack
)))
224 switch (vstack_ax(stack
)->type
) {
229 case REG_TYPE_UNKNOWN
:
230 switch (vstack_bx(stack
)->type
) {
234 case REG_TYPE_UNKNOWN
:
236 case REG_STAR_GLOB_STRING
:
242 switch (vstack_bx(stack
)->type
) {
246 case REG_TYPE_UNKNOWN
:
259 printk(KERN_WARNING
"empty stack for '%s' binary operator\n", str
);
263 printk(KERN_WARNING
"unknown type for '%s' binary operator\n", str
);
268 int validate_get_symbol(struct bytecode_runtime
*bytecode
,
269 const struct get_symbol
*sym
)
271 const char *str
, *str_limit
;
274 if (sym
->offset
>= bytecode
->p
.bc
->bc
.len
- bytecode
->p
.bc
->bc
.reloc_offset
)
277 str
= bytecode
->p
.bc
->bc
.data
+ bytecode
->p
.bc
->bc
.reloc_offset
+ sym
->offset
;
278 str_limit
= bytecode
->p
.bc
->bc
.data
+ bytecode
->p
.bc
->bc
.len
;
279 len_limit
= str_limit
- str
;
280 if (strnlen(str
, len_limit
) == len_limit
)
286 * Validate bytecode range overflow within the validation pass.
287 * Called for each instruction encountered.
290 int bytecode_validate_overflow(struct bytecode_runtime
*bytecode
,
291 char *start_pc
, char *pc
)
295 switch (*(filter_opcode_t
*) pc
) {
296 case FILTER_OP_UNKNOWN
:
299 printk(KERN_WARNING
"unknown bytecode op %u\n",
300 (unsigned int) *(filter_opcode_t
*) pc
);
305 case FILTER_OP_RETURN
:
307 if (unlikely(pc
+ sizeof(struct return_op
)
308 > start_pc
+ bytecode
->len
)) {
319 case FILTER_OP_MINUS
:
320 case FILTER_OP_EQ_DOUBLE
:
321 case FILTER_OP_NE_DOUBLE
:
322 case FILTER_OP_GT_DOUBLE
:
323 case FILTER_OP_LT_DOUBLE
:
324 case FILTER_OP_GE_DOUBLE
:
325 case FILTER_OP_LE_DOUBLE
:
327 case FILTER_OP_EQ_DOUBLE_S64
:
328 case FILTER_OP_NE_DOUBLE_S64
:
329 case FILTER_OP_GT_DOUBLE_S64
:
330 case FILTER_OP_LT_DOUBLE_S64
:
331 case FILTER_OP_GE_DOUBLE_S64
:
332 case FILTER_OP_LE_DOUBLE_S64
:
333 case FILTER_OP_EQ_S64_DOUBLE
:
334 case FILTER_OP_NE_S64_DOUBLE
:
335 case FILTER_OP_GT_S64_DOUBLE
:
336 case FILTER_OP_LT_S64_DOUBLE
:
337 case FILTER_OP_GE_S64_DOUBLE
:
338 case FILTER_OP_LE_S64_DOUBLE
:
339 case FILTER_OP_LOAD_FIELD_REF_DOUBLE
:
340 case FILTER_OP_GET_CONTEXT_REF_DOUBLE
:
341 case FILTER_OP_LOAD_DOUBLE
:
342 case FILTER_OP_CAST_DOUBLE_TO_S64
:
343 case FILTER_OP_UNARY_PLUS_DOUBLE
:
344 case FILTER_OP_UNARY_MINUS_DOUBLE
:
345 case FILTER_OP_UNARY_NOT_DOUBLE
:
347 printk(KERN_WARNING
"unsupported bytecode op %u\n",
348 (unsigned int) *(filter_opcode_t
*) pc
);
359 case FILTER_OP_EQ_STRING
:
360 case FILTER_OP_NE_STRING
:
361 case FILTER_OP_GT_STRING
:
362 case FILTER_OP_LT_STRING
:
363 case FILTER_OP_GE_STRING
:
364 case FILTER_OP_LE_STRING
:
365 case FILTER_OP_EQ_STAR_GLOB_STRING
:
366 case FILTER_OP_NE_STAR_GLOB_STRING
:
367 case FILTER_OP_EQ_S64
:
368 case FILTER_OP_NE_S64
:
369 case FILTER_OP_GT_S64
:
370 case FILTER_OP_LT_S64
:
371 case FILTER_OP_GE_S64
:
372 case FILTER_OP_LE_S64
:
373 case FILTER_OP_BIT_RSHIFT
:
374 case FILTER_OP_BIT_LSHIFT
:
375 case FILTER_OP_BIT_AND
:
376 case FILTER_OP_BIT_OR
:
377 case FILTER_OP_BIT_XOR
:
379 if (unlikely(pc
+ sizeof(struct binary_op
)
380 > start_pc
+ bytecode
->len
)) {
387 case FILTER_OP_UNARY_PLUS
:
388 case FILTER_OP_UNARY_MINUS
:
389 case FILTER_OP_UNARY_NOT
:
390 case FILTER_OP_UNARY_PLUS_S64
:
391 case FILTER_OP_UNARY_MINUS_S64
:
392 case FILTER_OP_UNARY_NOT_S64
:
393 case FILTER_OP_UNARY_BIT_NOT
:
395 if (unlikely(pc
+ sizeof(struct unary_op
)
396 > start_pc
+ bytecode
->len
)) {
406 if (unlikely(pc
+ sizeof(struct logical_op
)
407 > start_pc
+ bytecode
->len
)) {
414 case FILTER_OP_LOAD_FIELD_REF
:
416 printk(KERN_WARNING
"Unknown field ref type\n");
421 /* get context ref */
422 case FILTER_OP_GET_CONTEXT_REF
:
424 printk(KERN_WARNING
"Unknown field ref type\n");
428 case FILTER_OP_LOAD_FIELD_REF_STRING
:
429 case FILTER_OP_LOAD_FIELD_REF_SEQUENCE
:
430 case FILTER_OP_LOAD_FIELD_REF_USER_STRING
:
431 case FILTER_OP_LOAD_FIELD_REF_USER_SEQUENCE
:
432 case FILTER_OP_LOAD_FIELD_REF_S64
:
433 case FILTER_OP_GET_CONTEXT_REF_STRING
:
434 case FILTER_OP_GET_CONTEXT_REF_S64
:
436 if (unlikely(pc
+ sizeof(struct load_op
) + sizeof(struct field_ref
)
437 > start_pc
+ bytecode
->len
)) {
443 /* load from immediate operand */
444 case FILTER_OP_LOAD_STRING
:
445 case FILTER_OP_LOAD_STAR_GLOB_STRING
:
447 struct load_op
*insn
= (struct load_op
*) pc
;
448 uint32_t str_len
, maxlen
;
450 if (unlikely(pc
+ sizeof(struct load_op
)
451 > start_pc
+ bytecode
->len
)) {
456 maxlen
= start_pc
+ bytecode
->len
- pc
- sizeof(struct load_op
);
457 str_len
= strnlen(insn
->data
, maxlen
);
458 if (unlikely(str_len
>= maxlen
)) {
459 /* Final '\0' not found within range */
465 case FILTER_OP_LOAD_S64
:
467 if (unlikely(pc
+ sizeof(struct load_op
) + sizeof(struct literal_numeric
)
468 > start_pc
+ bytecode
->len
)) {
474 case FILTER_OP_CAST_TO_S64
:
475 case FILTER_OP_CAST_NOP
:
477 if (unlikely(pc
+ sizeof(struct cast_op
)
478 > start_pc
+ bytecode
->len
)) {
485 * Instructions for recursive traversal through composed types.
487 case FILTER_OP_GET_CONTEXT_ROOT
:
488 case FILTER_OP_GET_APP_CONTEXT_ROOT
:
489 case FILTER_OP_GET_PAYLOAD_ROOT
:
490 case FILTER_OP_LOAD_FIELD
:
491 case FILTER_OP_LOAD_FIELD_S8
:
492 case FILTER_OP_LOAD_FIELD_S16
:
493 case FILTER_OP_LOAD_FIELD_S32
:
494 case FILTER_OP_LOAD_FIELD_S64
:
495 case FILTER_OP_LOAD_FIELD_U8
:
496 case FILTER_OP_LOAD_FIELD_U16
:
497 case FILTER_OP_LOAD_FIELD_U32
:
498 case FILTER_OP_LOAD_FIELD_U64
:
499 case FILTER_OP_LOAD_FIELD_STRING
:
500 case FILTER_OP_LOAD_FIELD_SEQUENCE
:
501 case FILTER_OP_LOAD_FIELD_DOUBLE
:
502 if (unlikely(pc
+ sizeof(struct load_op
)
503 > start_pc
+ bytecode
->len
)) {
508 case FILTER_OP_GET_SYMBOL
:
510 struct load_op
*insn
= (struct load_op
*) pc
;
511 struct get_symbol
*sym
= (struct get_symbol
*) insn
->data
;
513 if (unlikely(pc
+ sizeof(struct load_op
) + sizeof(struct get_symbol
)
514 > start_pc
+ bytecode
->len
)) {
517 ret
= validate_get_symbol(bytecode
, sym
);
521 case FILTER_OP_GET_SYMBOL_FIELD
:
522 printk(KERN_WARNING
"Unexpected get symbol field\n");
526 case FILTER_OP_GET_INDEX_U16
:
527 if (unlikely(pc
+ sizeof(struct load_op
) + sizeof(struct get_index_u16
)
528 > start_pc
+ bytecode
->len
)) {
533 case FILTER_OP_GET_INDEX_U64
:
534 if (unlikely(pc
+ sizeof(struct load_op
) + sizeof(struct get_index_u64
)
535 > start_pc
+ bytecode
->len
)) {
545 unsigned long delete_all_nodes(struct mp_table
*mp_table
)
547 struct mp_node
*mp_node
;
548 struct hlist_node
*tmp
;
549 unsigned long nr_nodes
= 0;
552 for (i
= 0; i
< MERGE_POINT_TABLE_SIZE
; i
++) {
553 struct hlist_head
*head
;
555 head
= &mp_table
->mp_head
[i
];
556 lttng_hlist_for_each_entry_safe(mp_node
, tmp
, head
, node
) {
570 int validate_instruction_context(struct bytecode_runtime
*bytecode
,
571 struct vstack
*stack
,
576 const filter_opcode_t opcode
= *(filter_opcode_t
*) pc
;
579 case FILTER_OP_UNKNOWN
:
582 printk(KERN_WARNING
"unknown bytecode op %u\n",
583 (unsigned int) *(filter_opcode_t
*) pc
);
588 case FILTER_OP_RETURN
:
598 case FILTER_OP_MINUS
:
600 case FILTER_OP_EQ_DOUBLE
:
601 case FILTER_OP_NE_DOUBLE
:
602 case FILTER_OP_GT_DOUBLE
:
603 case FILTER_OP_LT_DOUBLE
:
604 case FILTER_OP_GE_DOUBLE
:
605 case FILTER_OP_LE_DOUBLE
:
606 case FILTER_OP_EQ_DOUBLE_S64
:
607 case FILTER_OP_NE_DOUBLE_S64
:
608 case FILTER_OP_GT_DOUBLE_S64
:
609 case FILTER_OP_LT_DOUBLE_S64
:
610 case FILTER_OP_GE_DOUBLE_S64
:
611 case FILTER_OP_LE_DOUBLE_S64
:
612 case FILTER_OP_EQ_S64_DOUBLE
:
613 case FILTER_OP_NE_S64_DOUBLE
:
614 case FILTER_OP_GT_S64_DOUBLE
:
615 case FILTER_OP_LT_S64_DOUBLE
:
616 case FILTER_OP_GE_S64_DOUBLE
:
617 case FILTER_OP_LE_S64_DOUBLE
:
618 case FILTER_OP_UNARY_PLUS_DOUBLE
:
619 case FILTER_OP_UNARY_MINUS_DOUBLE
:
620 case FILTER_OP_UNARY_NOT_DOUBLE
:
621 case FILTER_OP_LOAD_FIELD_REF_DOUBLE
:
622 case FILTER_OP_LOAD_DOUBLE
:
623 case FILTER_OP_CAST_DOUBLE_TO_S64
:
624 case FILTER_OP_GET_CONTEXT_REF_DOUBLE
:
626 printk(KERN_WARNING
"unsupported bytecode op %u\n",
627 (unsigned int) *(filter_opcode_t
*) pc
);
634 ret
= bin_op_compare_check(stack
, opcode
, "==");
641 ret
= bin_op_compare_check(stack
, opcode
, "!=");
648 ret
= bin_op_compare_check(stack
, opcode
, ">");
655 ret
= bin_op_compare_check(stack
, opcode
, "<");
662 ret
= bin_op_compare_check(stack
, opcode
, ">=");
669 ret
= bin_op_compare_check(stack
, opcode
, "<=");
675 case FILTER_OP_EQ_STRING
:
676 case FILTER_OP_NE_STRING
:
677 case FILTER_OP_GT_STRING
:
678 case FILTER_OP_LT_STRING
:
679 case FILTER_OP_GE_STRING
:
680 case FILTER_OP_LE_STRING
:
682 if (!vstack_ax(stack
) || !vstack_bx(stack
)) {
683 printk(KERN_WARNING
"Empty stack\n");
687 if (vstack_ax(stack
)->type
!= REG_STRING
688 || vstack_bx(stack
)->type
!= REG_STRING
) {
689 printk(KERN_WARNING
"Unexpected register type for string comparator\n");
697 case FILTER_OP_EQ_STAR_GLOB_STRING
:
698 case FILTER_OP_NE_STAR_GLOB_STRING
:
700 if (!vstack_ax(stack
) || !vstack_bx(stack
)) {
701 printk(KERN_WARNING
"Empty stack\n");
705 if (vstack_ax(stack
)->type
!= REG_STAR_GLOB_STRING
706 && vstack_bx(stack
)->type
!= REG_STAR_GLOB_STRING
) {
707 printk(KERN_WARNING
"Unexpected register type for globbing pattern comparator\n");
714 case FILTER_OP_EQ_S64
:
715 case FILTER_OP_NE_S64
:
716 case FILTER_OP_GT_S64
:
717 case FILTER_OP_LT_S64
:
718 case FILTER_OP_GE_S64
:
719 case FILTER_OP_LE_S64
:
721 if (!vstack_ax(stack
) || !vstack_bx(stack
)) {
722 printk(KERN_WARNING
"Empty stack\n");
726 if (vstack_ax(stack
)->type
!= REG_S64
727 || vstack_bx(stack
)->type
!= REG_S64
) {
728 printk(KERN_WARNING
"Unexpected register type for s64 comparator\n");
735 case FILTER_OP_BIT_RSHIFT
:
736 ret
= bin_op_bitwise_check(stack
, opcode
, ">>");
740 case FILTER_OP_BIT_LSHIFT
:
741 ret
= bin_op_bitwise_check(stack
, opcode
, "<<");
745 case FILTER_OP_BIT_AND
:
746 ret
= bin_op_bitwise_check(stack
, opcode
, "&");
750 case FILTER_OP_BIT_OR
:
751 ret
= bin_op_bitwise_check(stack
, opcode
, "|");
755 case FILTER_OP_BIT_XOR
:
756 ret
= bin_op_bitwise_check(stack
, opcode
, "^");
762 case FILTER_OP_UNARY_PLUS
:
763 case FILTER_OP_UNARY_MINUS
:
764 case FILTER_OP_UNARY_NOT
:
766 if (!vstack_ax(stack
)) {
767 printk(KERN_WARNING
"Empty stack\n");
771 switch (vstack_ax(stack
)->type
) {
774 printk(KERN_WARNING
"unknown register type\n");
779 case REG_STAR_GLOB_STRING
:
780 printk(KERN_WARNING
"Unary op can only be applied to numeric or floating point registers\n");
784 case REG_TYPE_UNKNOWN
:
789 case FILTER_OP_UNARY_BIT_NOT
:
791 if (!vstack_ax(stack
)) {
792 printk(KERN_WARNING
"Empty stack\n");
796 switch (vstack_ax(stack
)->type
) {
798 printk(KERN_WARNING
"unknown register type\n");
803 case REG_STAR_GLOB_STRING
:
805 printk(KERN_WARNING
"Unary bitwise op can only be applied to numeric registers\n");
810 case REG_TYPE_UNKNOWN
:
816 case FILTER_OP_UNARY_PLUS_S64
:
817 case FILTER_OP_UNARY_MINUS_S64
:
818 case FILTER_OP_UNARY_NOT_S64
:
820 if (!vstack_ax(stack
)) {
821 printk(KERN_WARNING
"Empty stack\n");
825 if (vstack_ax(stack
)->type
!= REG_S64
) {
826 printk(KERN_WARNING
"Invalid register type\n");
837 struct logical_op
*insn
= (struct logical_op
*) pc
;
839 if (!vstack_ax(stack
)) {
840 printk(KERN_WARNING
"Empty stack\n");
844 if (vstack_ax(stack
)->type
!= REG_S64
) {
845 printk(KERN_WARNING
"Logical comparator expects S64 register\n");
850 dbg_printk("Validate jumping to bytecode offset %u\n",
851 (unsigned int) insn
->skip_offset
);
852 if (unlikely(start_pc
+ insn
->skip_offset
<= pc
)) {
853 printk(KERN_WARNING
"Loops are not allowed in bytecode\n");
861 case FILTER_OP_LOAD_FIELD_REF
:
863 printk(KERN_WARNING
"Unknown field ref type\n");
867 case FILTER_OP_LOAD_FIELD_REF_STRING
:
868 case FILTER_OP_LOAD_FIELD_REF_SEQUENCE
:
869 case FILTER_OP_LOAD_FIELD_REF_USER_STRING
:
870 case FILTER_OP_LOAD_FIELD_REF_USER_SEQUENCE
:
872 struct load_op
*insn
= (struct load_op
*) pc
;
873 struct field_ref
*ref
= (struct field_ref
*) insn
->data
;
875 dbg_printk("Validate load field ref offset %u type string\n",
879 case FILTER_OP_LOAD_FIELD_REF_S64
:
881 struct load_op
*insn
= (struct load_op
*) pc
;
882 struct field_ref
*ref
= (struct field_ref
*) insn
->data
;
884 dbg_printk("Validate load field ref offset %u type s64\n",
889 /* load from immediate operand */
890 case FILTER_OP_LOAD_STRING
:
891 case FILTER_OP_LOAD_STAR_GLOB_STRING
:
896 case FILTER_OP_LOAD_S64
:
901 case FILTER_OP_CAST_TO_S64
:
903 struct cast_op
*insn
= (struct cast_op
*) pc
;
905 if (!vstack_ax(stack
)) {
906 printk(KERN_WARNING
"Empty stack\n");
910 switch (vstack_ax(stack
)->type
) {
913 printk(KERN_WARNING
"unknown register type\n");
918 case REG_STAR_GLOB_STRING
:
919 printk(KERN_WARNING
"Cast op can only be applied to numeric or floating point registers\n");
925 if (insn
->op
== FILTER_OP_CAST_DOUBLE_TO_S64
) {
926 if (vstack_ax(stack
)->type
!= REG_DOUBLE
) {
927 printk(KERN_WARNING
"Cast expects double\n");
934 case FILTER_OP_CAST_NOP
:
939 /* get context ref */
940 case FILTER_OP_GET_CONTEXT_REF
:
942 printk(KERN_WARNING
"Unknown get context ref type\n");
946 case FILTER_OP_GET_CONTEXT_REF_STRING
:
948 struct load_op
*insn
= (struct load_op
*) pc
;
949 struct field_ref
*ref
= (struct field_ref
*) insn
->data
;
951 dbg_printk("Validate get context ref offset %u type string\n",
955 case FILTER_OP_GET_CONTEXT_REF_S64
:
957 struct load_op
*insn
= (struct load_op
*) pc
;
958 struct field_ref
*ref
= (struct field_ref
*) insn
->data
;
960 dbg_printk("Validate get context ref offset %u type s64\n",
966 * Instructions for recursive traversal through composed types.
968 case FILTER_OP_GET_CONTEXT_ROOT
:
970 dbg_printk("Validate get context root\n");
973 case FILTER_OP_GET_APP_CONTEXT_ROOT
:
975 dbg_printk("Validate get app context root\n");
978 case FILTER_OP_GET_PAYLOAD_ROOT
:
980 dbg_printk("Validate get payload root\n");
983 case FILTER_OP_LOAD_FIELD
:
986 * We tolerate that field type is unknown at validation,
987 * because we are performing the load specialization in
988 * a phase after validation.
990 dbg_printk("Validate load field\n");
993 case FILTER_OP_LOAD_FIELD_S8
:
995 dbg_printk("Validate load field s8\n");
998 case FILTER_OP_LOAD_FIELD_S16
:
1000 dbg_printk("Validate load field s16\n");
1003 case FILTER_OP_LOAD_FIELD_S32
:
1005 dbg_printk("Validate load field s32\n");
1008 case FILTER_OP_LOAD_FIELD_S64
:
1010 dbg_printk("Validate load field s64\n");
1013 case FILTER_OP_LOAD_FIELD_U8
:
1015 dbg_printk("Validate load field u8\n");
1018 case FILTER_OP_LOAD_FIELD_U16
:
1020 dbg_printk("Validate load field u16\n");
1023 case FILTER_OP_LOAD_FIELD_U32
:
1025 dbg_printk("Validate load field u32\n");
1028 case FILTER_OP_LOAD_FIELD_U64
:
1030 dbg_printk("Validate load field u64\n");
1033 case FILTER_OP_LOAD_FIELD_STRING
:
1035 dbg_printk("Validate load field string\n");
1038 case FILTER_OP_LOAD_FIELD_SEQUENCE
:
1040 dbg_printk("Validate load field sequence\n");
1043 case FILTER_OP_LOAD_FIELD_DOUBLE
:
1045 dbg_printk("Validate load field double\n");
1049 case FILTER_OP_GET_SYMBOL
:
1051 struct load_op
*insn
= (struct load_op
*) pc
;
1052 struct get_symbol
*sym
= (struct get_symbol
*) insn
->data
;
1054 dbg_printk("Validate get symbol offset %u\n", sym
->offset
);
1058 case FILTER_OP_GET_SYMBOL_FIELD
:
1060 struct load_op
*insn
= (struct load_op
*) pc
;
1061 struct get_symbol
*sym
= (struct get_symbol
*) insn
->data
;
1063 dbg_printk("Validate get symbol field offset %u\n", sym
->offset
);
1067 case FILTER_OP_GET_INDEX_U16
:
1069 struct load_op
*insn
= (struct load_op
*) pc
;
1070 struct get_index_u16
*get_index
= (struct get_index_u16
*) insn
->data
;
1072 dbg_printk("Validate get index u16 index %u\n", get_index
->index
);
1076 case FILTER_OP_GET_INDEX_U64
:
1078 struct load_op
*insn
= (struct load_op
*) pc
;
1079 struct get_index_u64
*get_index
= (struct get_index_u64
*) insn
->data
;
1081 dbg_printk("Validate get index u64 index %llu\n",
1082 (unsigned long long) get_index
->index
);
1096 int validate_instruction_all_contexts(struct bytecode_runtime
*bytecode
,
1097 struct mp_table
*mp_table
,
1098 struct vstack
*stack
,
1103 unsigned long target_pc
= pc
- start_pc
;
1105 struct hlist_head
*head
;
1106 struct mp_node
*mp_node
;
1108 /* Validate the context resulting from the previous instruction */
1109 ret
= validate_instruction_context(bytecode
, stack
, start_pc
, pc
);
1113 /* Validate merge points */
1114 hash
= jhash_1word(target_pc
, 0);
1115 head
= &mp_table
->mp_head
[hash
& (MERGE_POINT_TABLE_SIZE
- 1)];
1116 lttng_hlist_for_each_entry(mp_node
, head
, node
) {
1117 if (lttng_hash_match(mp_node
, target_pc
)) {
1123 dbg_printk("Filter: validate merge point at offset %lu\n",
1125 if (merge_points_compare(stack
, &mp_node
->stack
)) {
1126 printk(KERN_WARNING
"Merge points differ for offset %lu\n",
1130 /* Once validated, we can remove the merge point */
1131 dbg_printk("Filter: remove merge point at offset %lu\n",
1133 hlist_del(&mp_node
->node
);
1140 * >0: going to next insn.
1141 * 0: success, stop iteration.
1145 int exec_insn(struct bytecode_runtime
*bytecode
,
1146 struct mp_table
*mp_table
,
1147 struct vstack
*stack
,
1152 char *next_pc
= *_next_pc
;
1154 switch (*(filter_opcode_t
*) pc
) {
1155 case FILTER_OP_UNKNOWN
:
1158 printk(KERN_WARNING
"unknown bytecode op %u\n",
1159 (unsigned int) *(filter_opcode_t
*) pc
);
1164 case FILTER_OP_RETURN
:
1166 if (!vstack_ax(stack
)) {
1167 printk(KERN_WARNING
"Empty stack\n");
1171 switch (vstack_ax(stack
)->type
) {
1173 case REG_TYPE_UNKNOWN
:
1176 printk(KERN_WARNING
"Unexpected register type %d at end of bytecode\n",
1177 (int) vstack_ax(stack
)->type
);
1190 case FILTER_OP_PLUS
:
1191 case FILTER_OP_MINUS
:
1192 /* Floating point */
1193 case FILTER_OP_EQ_DOUBLE
:
1194 case FILTER_OP_NE_DOUBLE
:
1195 case FILTER_OP_GT_DOUBLE
:
1196 case FILTER_OP_LT_DOUBLE
:
1197 case FILTER_OP_GE_DOUBLE
:
1198 case FILTER_OP_LE_DOUBLE
:
1199 case FILTER_OP_EQ_DOUBLE_S64
:
1200 case FILTER_OP_NE_DOUBLE_S64
:
1201 case FILTER_OP_GT_DOUBLE_S64
:
1202 case FILTER_OP_LT_DOUBLE_S64
:
1203 case FILTER_OP_GE_DOUBLE_S64
:
1204 case FILTER_OP_LE_DOUBLE_S64
:
1205 case FILTER_OP_EQ_S64_DOUBLE
:
1206 case FILTER_OP_NE_S64_DOUBLE
:
1207 case FILTER_OP_GT_S64_DOUBLE
:
1208 case FILTER_OP_LT_S64_DOUBLE
:
1209 case FILTER_OP_GE_S64_DOUBLE
:
1210 case FILTER_OP_LE_S64_DOUBLE
:
1211 case FILTER_OP_UNARY_PLUS_DOUBLE
:
1212 case FILTER_OP_UNARY_MINUS_DOUBLE
:
1213 case FILTER_OP_UNARY_NOT_DOUBLE
:
1214 case FILTER_OP_LOAD_FIELD_REF_DOUBLE
:
1215 case FILTER_OP_GET_CONTEXT_REF_DOUBLE
:
1216 case FILTER_OP_LOAD_DOUBLE
:
1217 case FILTER_OP_CAST_DOUBLE_TO_S64
:
1219 printk(KERN_WARNING
"unsupported bytecode op %u\n",
1220 (unsigned int) *(filter_opcode_t
*) pc
);
1231 case FILTER_OP_EQ_STRING
:
1232 case FILTER_OP_NE_STRING
:
1233 case FILTER_OP_GT_STRING
:
1234 case FILTER_OP_LT_STRING
:
1235 case FILTER_OP_GE_STRING
:
1236 case FILTER_OP_LE_STRING
:
1237 case FILTER_OP_EQ_STAR_GLOB_STRING
:
1238 case FILTER_OP_NE_STAR_GLOB_STRING
:
1239 case FILTER_OP_EQ_S64
:
1240 case FILTER_OP_NE_S64
:
1241 case FILTER_OP_GT_S64
:
1242 case FILTER_OP_LT_S64
:
1243 case FILTER_OP_GE_S64
:
1244 case FILTER_OP_LE_S64
:
1245 case FILTER_OP_BIT_RSHIFT
:
1246 case FILTER_OP_BIT_LSHIFT
:
1247 case FILTER_OP_BIT_AND
:
1248 case FILTER_OP_BIT_OR
:
1249 case FILTER_OP_BIT_XOR
:
1252 if (vstack_pop(stack
)) {
1256 if (!vstack_ax(stack
)) {
1257 printk(KERN_WARNING
"Empty stack\n");
1261 switch (vstack_ax(stack
)->type
) {
1265 case REG_STAR_GLOB_STRING
:
1266 case REG_TYPE_UNKNOWN
:
1269 printk(KERN_WARNING
"Unexpected register type %d for operation\n",
1270 (int) vstack_ax(stack
)->type
);
1275 vstack_ax(stack
)->type
= REG_S64
;
1276 next_pc
+= sizeof(struct binary_op
);
1281 case FILTER_OP_UNARY_PLUS
:
1282 case FILTER_OP_UNARY_MINUS
:
1285 if (!vstack_ax(stack
)) {
1286 printk(KERN_WARNING
"Empty stack\n\n");
1290 switch (vstack_ax(stack
)->type
) {
1292 case REG_TYPE_UNKNOWN
:
1295 printk(KERN_WARNING
"Unexpected register type %d for operation\n",
1296 (int) vstack_ax(stack
)->type
);
1301 vstack_ax(stack
)->type
= REG_TYPE_UNKNOWN
;
1302 next_pc
+= sizeof(struct unary_op
);
1306 case FILTER_OP_UNARY_PLUS_S64
:
1307 case FILTER_OP_UNARY_MINUS_S64
:
1308 case FILTER_OP_UNARY_NOT_S64
:
1311 if (!vstack_ax(stack
)) {
1312 printk(KERN_WARNING
"Empty stack\n\n");
1316 switch (vstack_ax(stack
)->type
) {
1320 printk(KERN_WARNING
"Unexpected register type %d for operation\n",
1321 (int) vstack_ax(stack
)->type
);
1326 vstack_ax(stack
)->type
= REG_S64
;
1327 next_pc
+= sizeof(struct unary_op
);
1331 case FILTER_OP_UNARY_NOT
:
1334 if (!vstack_ax(stack
)) {
1335 printk(KERN_WARNING
"Empty stack\n\n");
1339 switch (vstack_ax(stack
)->type
) {
1341 case REG_TYPE_UNKNOWN
:
1344 printk(KERN_WARNING
"Unexpected register type %d for operation\n",
1345 (int) vstack_ax(stack
)->type
);
1350 vstack_ax(stack
)->type
= REG_S64
;
1351 next_pc
+= sizeof(struct unary_op
);
1355 case FILTER_OP_UNARY_BIT_NOT
:
1358 if (!vstack_ax(stack
)) {
1359 printk(KERN_WARNING
"Empty stack\n");
1363 switch (vstack_ax(stack
)->type
) {
1365 case REG_TYPE_UNKNOWN
:
1369 printk(KERN_WARNING
"Unexpected register type %d for operation\n",
1370 (int) vstack_ax(stack
)->type
);
1375 vstack_ax(stack
)->type
= REG_S64
;
1376 next_pc
+= sizeof(struct unary_op
);
1384 struct logical_op
*insn
= (struct logical_op
*) pc
;
1387 /* Add merge point to table */
1388 merge_ret
= merge_point_add_check(mp_table
,
1389 insn
->skip_offset
, stack
);
1395 if (!vstack_ax(stack
)) {
1396 printk(KERN_WARNING
"Empty stack\n\n");
1400 /* There is always a cast-to-s64 operation before a or/and op. */
1401 switch (vstack_ax(stack
)->type
) {
1405 printk(KERN_WARNING
"Incorrect register type %d for operation\n",
1406 (int) vstack_ax(stack
)->type
);
1411 /* Continue to next instruction */
1412 /* Pop 1 when jump not taken */
1413 if (vstack_pop(stack
)) {
1417 next_pc
+= sizeof(struct logical_op
);
1421 /* load field ref */
1422 case FILTER_OP_LOAD_FIELD_REF
:
1424 printk(KERN_WARNING
"Unknown field ref type\n");
1428 /* get context ref */
1429 case FILTER_OP_GET_CONTEXT_REF
:
1431 printk(KERN_WARNING
"Unknown get context ref type\n");
1435 case FILTER_OP_LOAD_FIELD_REF_STRING
:
1436 case FILTER_OP_LOAD_FIELD_REF_SEQUENCE
:
1437 case FILTER_OP_GET_CONTEXT_REF_STRING
:
1438 case FILTER_OP_LOAD_FIELD_REF_USER_STRING
:
1439 case FILTER_OP_LOAD_FIELD_REF_USER_SEQUENCE
:
1441 if (vstack_push(stack
)) {
1445 vstack_ax(stack
)->type
= REG_STRING
;
1446 next_pc
+= sizeof(struct load_op
) + sizeof(struct field_ref
);
1449 case FILTER_OP_LOAD_FIELD_REF_S64
:
1450 case FILTER_OP_GET_CONTEXT_REF_S64
:
1452 if (vstack_push(stack
)) {
1456 vstack_ax(stack
)->type
= REG_S64
;
1457 next_pc
+= sizeof(struct load_op
) + sizeof(struct field_ref
);
1461 /* load from immediate operand */
1462 case FILTER_OP_LOAD_STRING
:
1464 struct load_op
*insn
= (struct load_op
*) pc
;
1466 if (vstack_push(stack
)) {
1470 vstack_ax(stack
)->type
= REG_STRING
;
1471 next_pc
+= sizeof(struct load_op
) + strlen(insn
->data
) + 1;
1475 case FILTER_OP_LOAD_STAR_GLOB_STRING
:
1477 struct load_op
*insn
= (struct load_op
*) pc
;
1479 if (vstack_push(stack
)) {
1483 vstack_ax(stack
)->type
= REG_STAR_GLOB_STRING
;
1484 next_pc
+= sizeof(struct load_op
) + strlen(insn
->data
) + 1;
1488 case FILTER_OP_LOAD_S64
:
1490 if (vstack_push(stack
)) {
1494 vstack_ax(stack
)->type
= REG_S64
;
1495 next_pc
+= sizeof(struct load_op
)
1496 + sizeof(struct literal_numeric
);
1500 case FILTER_OP_CAST_TO_S64
:
1503 if (!vstack_ax(stack
)) {
1504 printk(KERN_WARNING
"Empty stack\n");
1508 switch (vstack_ax(stack
)->type
) {
1511 case REG_TYPE_UNKNOWN
:
1514 printk(KERN_WARNING
"Incorrect register type %d for cast\n",
1515 (int) vstack_ax(stack
)->type
);
1519 vstack_ax(stack
)->type
= REG_S64
;
1520 next_pc
+= sizeof(struct cast_op
);
1523 case FILTER_OP_CAST_NOP
:
1525 next_pc
+= sizeof(struct cast_op
);
1530 * Instructions for recursive traversal through composed types.
1532 case FILTER_OP_GET_CONTEXT_ROOT
:
1533 case FILTER_OP_GET_APP_CONTEXT_ROOT
:
1534 case FILTER_OP_GET_PAYLOAD_ROOT
:
1536 if (vstack_push(stack
)) {
1540 vstack_ax(stack
)->type
= REG_PTR
;
1541 next_pc
+= sizeof(struct load_op
);
1545 case FILTER_OP_LOAD_FIELD
:
1548 if (!vstack_ax(stack
)) {
1549 printk(KERN_WARNING
"Empty stack\n\n");
1553 if (vstack_ax(stack
)->type
!= REG_PTR
) {
1554 printk(KERN_WARNING
"Expecting pointer on top of stack\n\n");
1558 vstack_ax(stack
)->type
= REG_TYPE_UNKNOWN
;
1559 next_pc
+= sizeof(struct load_op
);
1563 case FILTER_OP_LOAD_FIELD_S8
:
1564 case FILTER_OP_LOAD_FIELD_S16
:
1565 case FILTER_OP_LOAD_FIELD_S32
:
1566 case FILTER_OP_LOAD_FIELD_S64
:
1567 case FILTER_OP_LOAD_FIELD_U8
:
1568 case FILTER_OP_LOAD_FIELD_U16
:
1569 case FILTER_OP_LOAD_FIELD_U32
:
1570 case FILTER_OP_LOAD_FIELD_U64
:
1573 if (!vstack_ax(stack
)) {
1574 printk(KERN_WARNING
"Empty stack\n\n");
1578 if (vstack_ax(stack
)->type
!= REG_PTR
) {
1579 printk(KERN_WARNING
"Expecting pointer on top of stack\n\n");
1583 vstack_ax(stack
)->type
= REG_S64
;
1584 next_pc
+= sizeof(struct load_op
);
1588 case FILTER_OP_LOAD_FIELD_STRING
:
1589 case FILTER_OP_LOAD_FIELD_SEQUENCE
:
1592 if (!vstack_ax(stack
)) {
1593 printk(KERN_WARNING
"Empty stack\n\n");
1597 if (vstack_ax(stack
)->type
!= REG_PTR
) {
1598 printk(KERN_WARNING
"Expecting pointer on top of stack\n\n");
1602 vstack_ax(stack
)->type
= REG_STRING
;
1603 next_pc
+= sizeof(struct load_op
);
1607 case FILTER_OP_LOAD_FIELD_DOUBLE
:
1610 if (!vstack_ax(stack
)) {
1611 printk(KERN_WARNING
"Empty stack\n\n");
1615 if (vstack_ax(stack
)->type
!= REG_PTR
) {
1616 printk(KERN_WARNING
"Expecting pointer on top of stack\n\n");
1620 vstack_ax(stack
)->type
= REG_DOUBLE
;
1621 next_pc
+= sizeof(struct load_op
);
1625 case FILTER_OP_GET_SYMBOL
:
1626 case FILTER_OP_GET_SYMBOL_FIELD
:
1629 if (!vstack_ax(stack
)) {
1630 printk(KERN_WARNING
"Empty stack\n\n");
1634 if (vstack_ax(stack
)->type
!= REG_PTR
) {
1635 printk(KERN_WARNING
"Expecting pointer on top of stack\n\n");
1639 next_pc
+= sizeof(struct load_op
) + sizeof(struct get_symbol
);
1643 case FILTER_OP_GET_INDEX_U16
:
1646 if (!vstack_ax(stack
)) {
1647 printk(KERN_WARNING
"Empty stack\n\n");
1651 if (vstack_ax(stack
)->type
!= REG_PTR
) {
1652 printk(KERN_WARNING
"Expecting pointer on top of stack\n\n");
1656 next_pc
+= sizeof(struct load_op
) + sizeof(struct get_index_u16
);
1660 case FILTER_OP_GET_INDEX_U64
:
1663 if (!vstack_ax(stack
)) {
1664 printk(KERN_WARNING
"Empty stack\n\n");
1668 if (vstack_ax(stack
)->type
!= REG_PTR
) {
1669 printk(KERN_WARNING
"Expecting pointer on top of stack\n\n");
1673 next_pc
+= sizeof(struct load_op
) + sizeof(struct get_index_u64
);
1679 *_next_pc
= next_pc
;
1684 * Never called concurrently (hash seed is shared).
1686 int lttng_filter_validate_bytecode(struct bytecode_runtime
*bytecode
)
1688 struct mp_table
*mp_table
;
1689 char *pc
, *next_pc
, *start_pc
;
1691 struct vstack stack
;
1693 vstack_init(&stack
);
1695 mp_table
= kzalloc(sizeof(*mp_table
), GFP_KERNEL
);
1697 printk(KERN_WARNING
"Error allocating hash table for bytecode validation\n");
1700 start_pc
= &bytecode
->code
[0];
1701 for (pc
= next_pc
= start_pc
; pc
- start_pc
< bytecode
->len
;
1703 ret
= bytecode_validate_overflow(bytecode
, start_pc
, pc
);
1706 printk(KERN_WARNING
"filter bytecode overflow\n");
1709 dbg_printk("Validating op %s (%u)\n",
1710 lttng_filter_print_op((unsigned int) *(filter_opcode_t
*) pc
),
1711 (unsigned int) *(filter_opcode_t
*) pc
);
1714 * For each instruction, validate the current context
1715 * (traversal of entire execution flow), and validate
1716 * all merge points targeting this instruction.
1718 ret
= validate_instruction_all_contexts(bytecode
, mp_table
,
1719 &stack
, start_pc
, pc
);
1722 ret
= exec_insn(bytecode
, mp_table
, &stack
, &next_pc
, pc
);
1727 if (delete_all_nodes(mp_table
)) {
1729 printk(KERN_WARNING
"Unexpected merge points\n");