/*
- * lttng-bytecode-interpreter.c
- *
- * LTTng UST bytecode interpreter.
+ * SPDX-License-Identifier: MIT
*
* Copyright (C) 2010-2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * LTTng UST bytecode interpreter.
*/
#define _LGPL_SOURCE
#include <stddef.h>
#include <stdint.h>
-#include <urcu-pointer.h>
-#include <byteswap.h>
+#include <lttng/urcu/pointer.h>
+#include <urcu/rculist.h>
#include <lttng/ust-endian.h>
#include <lttng/ust-events.h>
+#include "ust-events-internal.h"
#include "lttng-bytecode.h"
#include "string-utils.h"
}
static
-int stack_star_glob_match(struct estack *stack, int top, const char *cmp_type)
+int stack_star_glob_match(struct estack *stack, int top,
+ const char *cmp_type __attribute__((unused)))
{
const char *pattern;
const char *candidate;
}
static
-int stack_strcmp(struct estack *stack, int top, const char *cmp_type)
+int stack_strcmp(struct estack *stack, int top, const char *cmp_type __attribute__((unused)))
{
const char *p = estack_bx(stack, top)->u.s.str, *q = estack_ax(stack, top)->u.s.str;
int ret;
return diff;
}
-uint64_t lttng_bytecode_filter_interpret_false(void *filter_data,
- const char *filter_stack_data)
+int lttng_bytecode_interpret_error(
+ struct lttng_ust_bytecode_runtime *bytecode_runtime __attribute__((unused)),
+ const char *stack_data __attribute__((unused)),
+ void *ctx __attribute__((unused)))
{
- return LTTNG_INTERPRETER_DISCARD;
+ return LTTNG_UST_BYTECODE_INTERPRETER_ERROR;
}
#ifdef INTERPRETER_USE_SWITCH
for (pc = next_pc = start_pc; pc - start_pc < bytecode->len; \
pc = next_pc) { \
dbg_printf("Executing op %s (%u)\n", \
- print_op((unsigned int) *(bytecode_opcode_t *) pc), \
+ lttng_bytecode_print_op((unsigned int) *(bytecode_opcode_t *) pc), \
(unsigned int) *(bytecode_opcode_t *) pc); \
switch (*(bytecode_opcode_t *) pc) {
#define IS_INTEGER_REGISTER(reg_type) \
(reg_type == REG_U64 || reg_type == REG_S64)
-static int context_get_index(struct lttng_ctx *ctx,
+static int context_get_index(struct lttng_ust_ctx *ctx,
struct load_ptr *ptr,
uint32_t idx)
{
- struct lttng_ctx_field *ctx_field;
- struct lttng_event_field *field;
- struct lttng_ctx_value v;
+ const struct lttng_ust_ctx_field *ctx_field;
+ const struct lttng_ust_event_field *field;
+ struct lttng_ust_ctx_value v;
ctx_field = &ctx->fields[idx];
- field = &ctx_field->event_field;
+ field = ctx_field->event_field;
ptr->type = LOAD_OBJECT;
ptr->field = field;
- switch (field->type.atype) {
- case atype_integer:
- ctx_field->get_value(ctx_field, &v);
- if (field->type.u.integer.signedness) {
+ switch (field->type->type) {
+ case lttng_ust_type_integer:
+ ctx_field->get_value(ctx_field->priv, &v);
+ if (lttng_ust_get_type_integer(field->type)->signedness) {
ptr->object_type = OBJECT_TYPE_S64;
ptr->u.s64 = v.u.s64;
ptr->ptr = &ptr->u.s64;
ptr->ptr = &ptr->u.u64;
}
break;
- case atype_enum: /* Fall-through */
- case atype_enum_nestable:
+ case lttng_ust_type_enum:
{
- const struct lttng_integer_type *itype;
+ const struct lttng_ust_type_integer *itype;
- if (field->type.atype == atype_enum) {
- itype = &field->type.u.legacy.basic.enumeration.container_type;
- } else {
- itype = &field->type.u.enum_nestable.container_type->u.integer;
- }
- ctx_field->get_value(ctx_field, &v);
+ itype = lttng_ust_get_type_integer(lttng_ust_get_type_enum(field->type)->container_type);
+ ctx_field->get_value(ctx_field->priv, &v);
if (itype->signedness) {
ptr->object_type = OBJECT_TYPE_SIGNED_ENUM;
ptr->u.s64 = v.u.s64;
}
break;
}
- case atype_array:
- if (field->type.u.legacy.array.elem_type.atype != atype_integer) {
+ case lttng_ust_type_array:
+ if (lttng_ust_get_type_array(field->type)->elem_type->type != lttng_ust_type_integer) {
ERR("Array nesting only supports integer types.");
return -EINVAL;
}
- if (field->type.u.legacy.array.elem_type.u.basic.integer.encoding == lttng_encode_none) {
+ if (lttng_ust_get_type_array(field->type)->encoding == lttng_ust_string_encoding_none) {
ERR("Only string arrays are supported for contexts.");
return -EINVAL;
}
ptr->object_type = OBJECT_TYPE_STRING;
- ctx_field->get_value(ctx_field, &v);
- ptr->ptr = v.u.str;
- break;
- case atype_array_nestable:
- if (field->type.u.array_nestable.elem_type->atype != atype_integer) {
- ERR("Array nesting only supports integer types.");
- return -EINVAL;
- }
- if (field->type.u.array_nestable.elem_type->u.integer.encoding == lttng_encode_none) {
- ERR("Only string arrays are supported for contexts.");
- return -EINVAL;
- }
- ptr->object_type = OBJECT_TYPE_STRING;
- ctx_field->get_value(ctx_field, &v);
- ptr->ptr = v.u.str;
- break;
- case atype_sequence:
- if (field->type.u.legacy.sequence.elem_type.atype != atype_integer) {
- ERR("Sequence nesting only supports integer types.");
- return -EINVAL;
- }
- if (field->type.u.legacy.sequence.elem_type.u.basic.integer.encoding == lttng_encode_none) {
- ERR("Only string sequences are supported for contexts.");
- return -EINVAL;
- }
- ptr->object_type = OBJECT_TYPE_STRING;
- ctx_field->get_value(ctx_field, &v);
+ ctx_field->get_value(ctx_field->priv, &v);
ptr->ptr = v.u.str;
break;
- case atype_sequence_nestable:
- if (field->type.u.sequence_nestable.elem_type->atype != atype_integer) {
+ case lttng_ust_type_sequence:
+ if (lttng_ust_get_type_sequence(field->type)->elem_type->type != lttng_ust_type_integer) {
ERR("Sequence nesting only supports integer types.");
return -EINVAL;
}
- if (field->type.u.sequence_nestable.elem_type->u.integer.encoding == lttng_encode_none) {
+ if (lttng_ust_get_type_sequence(field->type)->encoding == lttng_ust_string_encoding_none) {
ERR("Only string sequences are supported for contexts.");
return -EINVAL;
}
ptr->object_type = OBJECT_TYPE_STRING;
- ctx_field->get_value(ctx_field, &v);
+ ctx_field->get_value(ctx_field->priv, &v);
ptr->ptr = v.u.str;
break;
- case atype_string:
+ case lttng_ust_type_string:
ptr->object_type = OBJECT_TYPE_STRING;
- ctx_field->get_value(ctx_field, &v);
+ ctx_field->get_value(ctx_field->priv, &v);
ptr->ptr = v.u.str;
break;
- case atype_float:
+ case lttng_ust_type_float:
ptr->object_type = OBJECT_TYPE_DOUBLE;
- ctx_field->get_value(ctx_field, &v);
+ ctx_field->get_value(ctx_field->priv, &v);
ptr->u.d = v.u.d;
ptr->ptr = &ptr->u.d;
break;
- case atype_dynamic:
- ctx_field->get_value(ctx_field, &v);
+ case lttng_ust_type_dynamic:
+ ctx_field->get_value(ctx_field->priv, &v);
switch (v.sel) {
case LTTNG_UST_DYNAMIC_TYPE_NONE:
return -EINVAL;
+ case LTTNG_UST_DYNAMIC_TYPE_U8:
+ case LTTNG_UST_DYNAMIC_TYPE_U16:
+ case LTTNG_UST_DYNAMIC_TYPE_U32:
+ case LTTNG_UST_DYNAMIC_TYPE_U64:
+ ptr->object_type = OBJECT_TYPE_U64;
+ ptr->u.u64 = v.u.u64;
+ ptr->ptr = &ptr->u.u64;
+ dbg_printf("context get index dynamic u64 %" PRIi64 "\n", ptr->u.u64);
+ break;
+ case LTTNG_UST_DYNAMIC_TYPE_S8:
+ case LTTNG_UST_DYNAMIC_TYPE_S16:
+ case LTTNG_UST_DYNAMIC_TYPE_S32:
case LTTNG_UST_DYNAMIC_TYPE_S64:
ptr->object_type = OBJECT_TYPE_S64;
ptr->u.s64 = v.u.s64;
ptr->ptr = &ptr->u.s64;
dbg_printf("context get index dynamic s64 %" PRIi64 "\n", ptr->u.s64);
break;
+ case LTTNG_UST_DYNAMIC_TYPE_FLOAT:
case LTTNG_UST_DYNAMIC_TYPE_DOUBLE:
ptr->object_type = OBJECT_TYPE_DOUBLE;
ptr->u.d = v.u.d;
return -EINVAL;
}
break;
- case atype_struct:
- ERR("Structure type cannot be loaded.");
- return -EINVAL;
default:
- ERR("Unknown type: %d", (int) field->type.atype);
+ ERR("Unknown type: %d", (int) field->type->type);
return -EINVAL;
}
return 0;
}
-static int dynamic_get_index(struct lttng_ctx *ctx,
+static int dynamic_get_index(struct lttng_ust_ctx *ctx,
struct bytecode_runtime *runtime,
uint64_t index, struct estack_entry *stack_top)
{
stack_top->u.ptr.ptr = ptr;
stack_top->u.ptr.object_type = gid->elem.type;
stack_top->u.ptr.rev_bo = gid->elem.rev_bo;
- assert(stack_top->u.ptr.field->type.atype == atype_array ||
- stack_top->u.ptr.field->type.atype == atype_array_nestable);
+ assert(stack_top->u.ptr.field->type->type == lttng_ust_type_array);
stack_top->u.ptr.field = NULL;
break;
}
stack_top->u.ptr.ptr = ptr;
stack_top->u.ptr.object_type = gid->elem.type;
stack_top->u.ptr.rev_bo = gid->elem.rev_bo;
- assert(stack_top->u.ptr.field->type.atype == atype_sequence ||
- stack_top->u.ptr.field->type.atype == atype_sequence_nestable);
+ assert(stack_top->u.ptr.field->type->type == lttng_ust_type_sequence);
stack_top->u.ptr.field = NULL;
break;
}
output->type = LTTNG_INTERPRETER_TYPE_SEQUENCE;
output->u.sequence.ptr = *(const char **) (ax->u.ptr.ptr + sizeof(unsigned long));
output->u.sequence.nr_elem = *(unsigned long *) ax->u.ptr.ptr;
- output->u.sequence.nested_type = ax->u.ptr.field->type.u.sequence_nestable.elem_type;
+ output->u.sequence.nested_type = lttng_ust_get_type_sequence(ax->u.ptr.field->type)->elem_type;
break;
case OBJECT_TYPE_ARRAY:
/* Skip count (unsigned long) */
output->type = LTTNG_INTERPRETER_TYPE_SEQUENCE;
output->u.sequence.ptr = *(const char **) (ax->u.ptr.ptr + sizeof(unsigned long));
- output->u.sequence.nr_elem = ax->u.ptr.field->type.u.array_nestable.length;
- output->u.sequence.nested_type = ax->u.ptr.field->type.u.array_nestable.elem_type;
+ output->u.sequence.nr_elem = lttng_ust_get_type_array(ax->u.ptr.field->type)->length;
+ output->u.sequence.nested_type = lttng_ust_get_type_array(ax->u.ptr.field->type)->elem_type;
break;
case OBJECT_TYPE_SIGNED_ENUM:
ret = dynamic_load_field(ax);
return -EINVAL;
}
- return LTTNG_INTERPRETER_RECORD_FLAG;
+ return 0;
}
/*
- * Return 0 (discard), or raise the 0x1 flag (log event).
- * Currently, other flags are kept for future extensions and have no
- * effect.
+ * Return LTTNG_UST_BYTECODE_INTERPRETER_OK on success.
+ * Return LTTNG_UST_BYTECODE_INTERPRETER_ERROR on error.
+ *
+ * For FILTER bytecode: expect a struct lttng_ust_bytecode_filter_ctx *
+ * as @ctx argument.
+ * For CAPTURE bytecode: expect a struct lttng_interpreter_output *
+ * as @ctx argument.
*/
-static
-uint64_t bytecode_interpret(void *interpreter_data,
+int lttng_bytecode_interpret(struct lttng_ust_bytecode_runtime *ust_bytecode,
const char *interpreter_stack_data,
- struct lttng_interpreter_output *output)
+ void *caller_ctx)
{
- struct bytecode_runtime *bytecode = interpreter_data;
- struct lttng_ctx *ctx = rcu_dereference(*bytecode->p.pctx);
+ struct bytecode_runtime *bytecode = caa_container_of(ust_bytecode, struct bytecode_runtime, p);
+ struct lttng_ust_ctx *ctx = lttng_ust_rcu_dereference(*ust_bytecode->pctx);
void *pc, *next_pc, *start_pc;
- int ret = -EINVAL;
- uint64_t retval = 0;
+ int ret = -EINVAL, retval = 0;
struct estack _stack;
struct estack *stack = &_stack;
register int64_t ax = 0, bx = 0;
goto end;
OP(BYTECODE_OP_RETURN):
- /* LTTNG_INTERPRETER_DISCARD or LTTNG_INTERPRETER_RECORD_FLAG */
+ /* LTTNG_UST_BYTECODE_INTERPRETER_ERROR or LTTNG_UST_BYTECODE_INTERPRETER_OK */
/* Handle dynamic typing. */
switch (estack_ax_t) {
case REG_S64:
case REG_DOUBLE:
case REG_STRING:
case REG_PTR:
- if (!output) {
+ if (ust_bytecode->type != LTTNG_UST_BYTECODE_TYPE_CAPTURE) {
ret = -EINVAL;
goto end;
}
goto end;
OP(BYTECODE_OP_RETURN_S64):
- /* LTTNG_INTERPRETER_DISCARD or LTTNG_INTERPRETER_RECORD_FLAG */
+ /* LTTNG_UST_BYTECODE_INTERPRETER_ERROR or LTTNG_UST_BYTECODE_INTERPRETER_OK */
retval = !!estack_ax_v;
ret = 0;
goto end;
JUMP_TO(BYTECODE_OP_CAST_DOUBLE_TO_S64);
case REG_U64:
estack_ax_t = REG_S64;
- next_pc += sizeof(struct cast_op);
+ next_pc += sizeof(struct cast_op); /* Fall-through */
case REG_STRING: /* Fall-through */
case REG_STAR_GLOB_STRING:
ret = -EINVAL;
{
struct load_op *insn = (struct load_op *) pc;
struct field_ref *ref = (struct field_ref *) insn->data;
- struct lttng_ctx_field *ctx_field;
- struct lttng_ctx_value v;
+ const struct lttng_ust_ctx_field *ctx_field;
+ struct lttng_ust_ctx_value v;
dbg_printf("get context ref offset %u type dynamic\n",
ref->offset);
ctx_field = &ctx->fields[ref->offset];
- ctx_field->get_value(ctx_field, &v);
+ ctx_field->get_value(ctx_field->priv, &v);
estack_push(stack, top, ax, bx, ax_t, bx_t);
switch (v.sel) {
case LTTNG_UST_DYNAMIC_TYPE_NONE:
{
struct load_op *insn = (struct load_op *) pc;
struct field_ref *ref = (struct field_ref *) insn->data;
- struct lttng_ctx_field *ctx_field;
- struct lttng_ctx_value v;
+ const struct lttng_ust_ctx_field *ctx_field;
+ struct lttng_ust_ctx_value v;
dbg_printf("get context ref offset %u type string\n",
ref->offset);
ctx_field = &ctx->fields[ref->offset];
- ctx_field->get_value(ctx_field, &v);
+ ctx_field->get_value(ctx_field->priv, &v);
estack_push(stack, top, ax, bx, ax_t, bx_t);
estack_ax(stack, top)->u.s.str = v.u.str;
if (unlikely(!estack_ax(stack, top)->u.s.str)) {
{
struct load_op *insn = (struct load_op *) pc;
struct field_ref *ref = (struct field_ref *) insn->data;
- struct lttng_ctx_field *ctx_field;
- struct lttng_ctx_value v;
+ const struct lttng_ust_ctx_field *ctx_field;
+ struct lttng_ust_ctx_value v;
dbg_printf("get context ref offset %u type s64\n",
ref->offset);
ctx_field = &ctx->fields[ref->offset];
- ctx_field->get_value(ctx_field, &v);
+ ctx_field->get_value(ctx_field->priv, &v);
estack_push(stack, top, ax, bx, ax_t, bx_t);
estack_ax_v = v.u.s64;
estack_ax_t = REG_S64;
{
struct load_op *insn = (struct load_op *) pc;
struct field_ref *ref = (struct field_ref *) insn->data;
- struct lttng_ctx_field *ctx_field;
- struct lttng_ctx_value v;
+ const struct lttng_ust_ctx_field *ctx_field;
+ struct lttng_ust_ctx_value v;
dbg_printf("get context ref offset %u type double\n",
ref->offset);
ctx_field = &ctx->fields[ref->offset];
- ctx_field->get_value(ctx_field, &v);
+ ctx_field->get_value(ctx_field->priv, &v);
estack_push(stack, top, ax, bx, ax_t, bx_t);
memcpy(&estack_ax(stack, top)->u.d, &v.u.d, sizeof(struct literal_double));
estack_ax_t = REG_DOUBLE;
END_OP
end:
- /* Return _DISCARD on error. */
+ /* No need to prepare output if an error occurred. */
if (ret)
- return LTTNG_INTERPRETER_DISCARD;
+ return LTTNG_UST_BYTECODE_INTERPRETER_ERROR;
- if (output) {
- return lttng_bytecode_interpret_format_output(estack_ax(stack, top),
- output);
+ /* Prepare output. */
+ switch (ust_bytecode->type) {
+ case LTTNG_UST_BYTECODE_TYPE_FILTER:
+ {
+ struct lttng_ust_bytecode_filter_ctx *filter_ctx =
+ (struct lttng_ust_bytecode_filter_ctx *) caller_ctx;
+ if (retval)
+ filter_ctx->result = LTTNG_UST_BYTECODE_FILTER_ACCEPT;
+ else
+ filter_ctx->result = LTTNG_UST_BYTECODE_FILTER_REJECT;
+ break;
}
-
- return retval;
+ case LTTNG_UST_BYTECODE_TYPE_CAPTURE:
+ ret = lttng_bytecode_interpret_format_output(estack_ax(stack, top),
+ (struct lttng_interpreter_output *) caller_ctx);
+ break;
+ default:
+ ret = -EINVAL;
+ break;
+ }
+ if (ret)
+ return LTTNG_UST_BYTECODE_INTERPRETER_ERROR;
+ else
+ return LTTNG_UST_BYTECODE_INTERPRETER_OK;
}
-uint64_t lttng_bytecode_filter_interpret(void *filter_data,
- const char *filter_stack_data)
+/*
+ * Return LTTNG_UST_EVENT_FILTER_ACCEPT or LTTNG_UST_EVENT_FILTER_REJECT.
+ */
+int lttng_ust_interpret_event_filter(struct lttng_ust_event_common *event,
+ const char *interpreter_stack_data,
+ void *event_filter_ctx __attribute__((unused)))
{
- return bytecode_interpret(filter_data, filter_stack_data, NULL);
+ struct lttng_ust_bytecode_runtime *filter_bc_runtime;
+ struct cds_list_head *filter_bytecode_runtime_head = &event->priv->filter_bytecode_runtime_head;
+ struct lttng_ust_bytecode_filter_ctx bytecode_filter_ctx;
+ bool filter_record = false;
+
+ cds_list_for_each_entry_rcu(filter_bc_runtime, filter_bytecode_runtime_head, node) {
+ if (caa_likely(filter_bc_runtime->interpreter_func(filter_bc_runtime,
+ interpreter_stack_data, &bytecode_filter_ctx) == LTTNG_UST_BYTECODE_INTERPRETER_OK)) {
+ if (caa_unlikely(bytecode_filter_ctx.result == LTTNG_UST_BYTECODE_FILTER_ACCEPT)) {
+ filter_record = true;
+ break;
+ }
+ }
+ }
+ if (filter_record)
+ return LTTNG_UST_EVENT_FILTER_ACCEPT;
+ else
+ return LTTNG_UST_EVENT_FILTER_REJECT;
}
#undef START_OP