1 #ifndef _LTTNG_FILTER_H
2 #define _LTTNG_FILTER_H
7 * LTTng UST filter header.
9 * Copyright (C) 2010-2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 #include <lttng/ust-events.h>
35 #include <lttng/ust-context-provider.h>
42 #include <usterr-signal-safe.h>
43 #include "filter-bytecode.h"
45 /* Filter stack length, in number of entries */
46 #define FILTER_STACK_LEN 10 /* includes 2 dummy */
47 #define FILTER_STACK_EMPTY 1
49 #define FILTER_MAX_DATA_LEN 65536
52 #define min_t(type, a, b) \
53 ((type) (a) < (type) (b) ? (type) (a) : (type) (b))
57 #define likely(x) __builtin_expect(!!(x), 1)
61 #define unlikely(x) __builtin_expect(!!(x), 0)
65 #define dbg_printf(fmt, args...) \
66 printf("[debug bytecode in %s:%s@%u] " fmt, \
67 __FILE__, __func__, __LINE__, ## args)
69 #define dbg_printf(fmt, args...) \
71 /* do nothing but check printf format */ \
73 printf("[debug bytecode in %s:%s@%u] " fmt, \
74 __FILE__, __func__, __LINE__, ## args); \
78 /* Linked bytecode. Child of struct lttng_bytecode_runtime. */
79 struct bytecode_runtime
{
80 struct lttng_bytecode_runtime p
;
82 size_t data_alloc_len
;
99 LOAD_ROOT_APP_CONTEXT
,
116 OBJECT_TYPE_STRING_SEQUENCE
,
118 OBJECT_TYPE_SEQUENCE
,
126 struct filter_get_index_data
{
127 uint64_t offset
; /* in bytes */
132 enum object_type type
;
133 bool rev_bo
; /* reverse byte order */
137 /* Validation stack */
140 enum object_type object_type
;
141 const struct lttng_event_field
*field
;
142 bool rev_bo
; /* reverse byte order */
145 struct vstack_entry
{
146 enum entry_type type
;
147 struct vstack_load load
;
151 int top
; /* top of stack */
152 struct vstack_entry e
[FILTER_STACK_LEN
];
156 void vstack_init(struct vstack
*stack
)
162 struct vstack_entry
*vstack_ax(struct vstack
*stack
)
164 if (unlikely(stack
->top
< 0))
166 return &stack
->e
[stack
->top
];
170 struct vstack_entry
*vstack_bx(struct vstack
*stack
)
172 if (unlikely(stack
->top
< 1))
174 return &stack
->e
[stack
->top
- 1];
178 int vstack_push(struct vstack
*stack
)
180 if (stack
->top
>= FILTER_STACK_LEN
- 1) {
189 int vstack_pop(struct vstack
*stack
)
191 if (unlikely(stack
->top
< 0)) {
192 ERR("Stack empty\n");
199 /* Execution stack */
200 enum estack_string_literal_type
{
201 ESTACK_STRING_LITERAL_TYPE_NONE
,
202 ESTACK_STRING_LITERAL_TYPE_PLAIN
,
203 ESTACK_STRING_LITERAL_TYPE_STAR_GLOB
,
208 enum object_type object_type
;
211 /* Temporary place-holders for contexts. */
218 * "field" is only needed when nested under a variant, in which
219 * case we cannot specialize the nested operations.
221 const struct lttng_event_field
*field
;
224 struct estack_entry
{
225 enum entry_type type
; /* For dynamic typing. */
233 enum estack_string_literal_type literal_type
;
240 int top
; /* top of stack */
241 struct estack_entry e
[FILTER_STACK_LEN
];
245 * Always use aliased type for ax/bx (top of stack).
246 * When ax/bx are S64, use aliased value.
248 #define estack_ax_v ax
249 #define estack_bx_v bx
250 #define estack_ax_t ax_t
251 #define estack_bx_t bx_t
254 * ax and bx registers can hold either integer, double or string.
256 #define estack_ax(stack, top) \
258 assert((top) > FILTER_STACK_EMPTY); \
262 #define estack_bx(stack, top) \
264 assert((top) > FILTER_STACK_EMPTY + 1); \
265 &(stack)->e[(top) - 1]; \
269 * Currently, only integers (REG_S64) can be pushed into the stack.
271 #define estack_push(stack, top, ax, bx, ax_t, bx_t) \
273 assert((top) < FILTER_STACK_LEN - 1); \
274 (stack)->e[(top) - 1].u.v = (bx); \
275 (stack)->e[(top) - 1].type = (bx_t); \
281 #define estack_pop(stack, top, ax, bx, ax_t, bx_t) \
283 assert((top) > FILTER_STACK_EMPTY); \
286 (bx) = (stack)->e[(top) - 2].u.v; \
287 (bx_t) = (stack)->e[(top) - 2].type; \
291 const char *print_op(enum filter_op op
);
293 int lttng_filter_validate_bytecode(struct bytecode_runtime
*bytecode
);
294 int lttng_filter_specialize_bytecode(struct lttng_event
*event
,
295 struct bytecode_runtime
*bytecode
);
297 uint64_t lttng_filter_false(void *filter_data
,
298 const char *filter_stack_data
);
299 uint64_t lttng_filter_interpret_bytecode(void *filter_data
,
300 const char *filter_stack_data
);
302 #endif /* _LTTNG_FILTER_H */