*
* LTTng UST filter code.
*
- * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (C) 2010-2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; only
- * version 2.1 of the License.
+ * 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:
*
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * 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.
*/
+#define _LGPL_SOURCE
+#include <urcu/rculist.h>
#include "lttng-filter.h"
static const char *opnames[] = {
[ FILTER_OP_MOD ] = "MOD",
[ FILTER_OP_PLUS ] = "PLUS",
[ FILTER_OP_MINUS ] = "MINUS",
- [ FILTER_OP_RSHIFT ] = "RSHIFT",
- [ FILTER_OP_LSHIFT ] = "LSHIFT",
- [ FILTER_OP_BIN_AND ] = "BIN_AND",
- [ FILTER_OP_BIN_OR ] = "BIN_OR",
- [ FILTER_OP_BIN_XOR ] = "BIN_XOR",
+ [ FILTER_OP_BIT_RSHIFT ] = "BIT_RSHIFT",
+ [ FILTER_OP_BIT_LSHIFT ] = "BIT_LSHIFT",
+ [ FILTER_OP_BIT_AND ] = "BIT_AND",
+ [ FILTER_OP_BIT_OR ] = "BIT_OR",
+ [ FILTER_OP_BIT_XOR ] = "BIT_XOR",
/* binary comparators */
[ FILTER_OP_EQ ] = "EQ",
[ FILTER_OP_AND ] = "AND",
[ FILTER_OP_OR ] = "OR",
- /* load */
+ /* load field ref */
[ FILTER_OP_LOAD_FIELD_REF ] = "LOAD_FIELD_REF",
[ FILTER_OP_LOAD_FIELD_REF_STRING ] = "LOAD_FIELD_REF_STRING",
[ FILTER_OP_LOAD_FIELD_REF_SEQUENCE ] = "LOAD_FIELD_REF_SEQUENCE",
[ FILTER_OP_LOAD_FIELD_REF_S64 ] = "LOAD_FIELD_REF_S64",
[ FILTER_OP_LOAD_FIELD_REF_DOUBLE ] = "LOAD_FIELD_REF_DOUBLE",
+ /* load from immediate operand */
[ FILTER_OP_LOAD_STRING ] = "LOAD_STRING",
[ FILTER_OP_LOAD_S64 ] = "LOAD_S64",
[ FILTER_OP_LOAD_DOUBLE ] = "LOAD_DOUBLE",
[ FILTER_OP_CAST_TO_S64 ] = "CAST_TO_S64",
[ FILTER_OP_CAST_DOUBLE_TO_S64 ] = "CAST_DOUBLE_TO_S64",
[ FILTER_OP_CAST_NOP ] = "CAST_NOP",
+
+ /* get context ref */
+ [ FILTER_OP_GET_CONTEXT_REF ] = "GET_CONTEXT_REF",
+ [ FILTER_OP_GET_CONTEXT_REF_STRING ] = "GET_CONTEXT_REF_STRING",
+ [ FILTER_OP_GET_CONTEXT_REF_S64 ] = "GET_CONTEXT_REF_S64",
+ [ FILTER_OP_GET_CONTEXT_REF_DOUBLE ] = "GET_CONTEXT_REF_DOUBLE",
+
+ /* load userspace field ref */
+ [ FILTER_OP_LOAD_FIELD_REF_USER_STRING ] = "LOAD_FIELD_REF_USER_STRING",
+ [ FILTER_OP_LOAD_FIELD_REF_USER_SEQUENCE ] = "LOAD_FIELD_REF_USER_SEQUENCE",
+
+ /*
+ * load immediate star globbing pattern (literal string)
+ * from immediate.
+ */
+ [ FILTER_OP_LOAD_STAR_GLOB_STRING ] = "LOAD_STAR_GLOB_STRING",
+
+ /* globbing pattern binary operator: apply to */
+ [ FILTER_OP_EQ_STAR_GLOB_STRING ] = "EQ_STAR_GLOB_STRING",
+ [ FILTER_OP_NE_STAR_GLOB_STRING ] = "NE_STAR_GLOB_STRING",
+
+ /*
+ * Instructions for recursive traversal through composed types.
+ */
+ [ FILTER_OP_GET_CONTEXT_ROOT ] = "GET_CONTEXT_ROOT",
+ [ FILTER_OP_GET_APP_CONTEXT_ROOT ] = "GET_APP_CONTEXT_ROOT",
+ [ FILTER_OP_GET_PAYLOAD_ROOT ] = "GET_PAYLOAD_ROOT",
+
+ [ FILTER_OP_GET_SYMBOL ] = "GET_SYMBOL",
+ [ FILTER_OP_GET_SYMBOL_FIELD ] = "GET_SYMBOL_FIELD",
+ [ FILTER_OP_GET_INDEX_U16 ] = "GET_INDEX_U16",
+ [ FILTER_OP_GET_INDEX_U64 ] = "GET_INDEX_U64",
+
+ [ FILTER_OP_LOAD_FIELD ] = "LOAD_FIELD",
+ [ FILTER_OP_LOAD_FIELD_S8 ] = "LOAD_FIELD_S8",
+ [ FILTER_OP_LOAD_FIELD_S16 ] = "LOAD_FIELD_S16",
+ [ FILTER_OP_LOAD_FIELD_S32 ] = "LOAD_FIELD_S32",
+ [ FILTER_OP_LOAD_FIELD_S64 ] = "LOAD_FIELD_S64",
+ [ FILTER_OP_LOAD_FIELD_U8 ] = "LOAD_FIELD_U8",
+ [ FILTER_OP_LOAD_FIELD_U16 ] = "LOAD_FIELD_U16",
+ [ FILTER_OP_LOAD_FIELD_U32 ] = "LOAD_FIELD_U32",
+ [ FILTER_OP_LOAD_FIELD_U64 ] = "LOAD_FIELD_U64",
+ [ FILTER_OP_LOAD_FIELD_STRING ] = "LOAD_FIELD_STRING",
+ [ FILTER_OP_LOAD_FIELD_SEQUENCE ] = "LOAD_FIELD_SEQUENCE",
+ [ FILTER_OP_LOAD_FIELD_DOUBLE ] = "LOAD_FIELD_DOUBLE",
+
+ [ FILTER_OP_UNARY_BIT_NOT ] = "UNARY_BIT_NOT",
+
+ [ FILTER_OP_RETURN_S64 ] = "RETURN_S64",
};
const char *print_op(enum filter_op op)
}
static
-int apply_field_reloc(struct ltt_event *event,
+int apply_field_reloc(struct lttng_event *event,
struct bytecode_runtime *runtime,
uint32_t runtime_len,
uint32_t reloc_offset,
- const char *field_name)
+ const char *field_name,
+ enum filter_op filter_op)
{
const struct lttng_event_desc *desc;
const struct lttng_event_field *fields, *field = NULL;
unsigned int nr_fields, i;
- struct field_ref *field_ref;
struct load_op *op;
uint32_t field_offset = 0;
- dbg_printf("Apply reloc: %u %s\n", reloc_offset, field_name);
-
- /* Ensure that the reloc is within the code */
- if (runtime_len - reloc_offset < sizeof(uint16_t))
- return -EINVAL;
+ dbg_printf("Apply field reloc: %u %s\n", reloc_offset, field_name);
/* Lookup event by name */
desc = event->desc;
return -EINVAL;
/* set type */
- op = (struct load_op *) &runtime->data[reloc_offset];
- field_ref = (struct field_ref *) op->data;
- switch (field->type.atype) {
- case atype_integer:
- case atype_enum:
- op->op = FILTER_OP_LOAD_FIELD_REF_S64;
- break;
- case atype_array:
- case atype_sequence:
- op->op = FILTER_OP_LOAD_FIELD_REF_SEQUENCE;
- break;
- case atype_string:
- op->op = FILTER_OP_LOAD_FIELD_REF_STRING;
+ op = (struct load_op *) &runtime->code[reloc_offset];
+
+ switch (filter_op) {
+ case FILTER_OP_LOAD_FIELD_REF:
+ {
+ struct field_ref *field_ref;
+
+ field_ref = (struct field_ref *) op->data;
+ switch (field->type.atype) {
+ case atype_integer:
+ case atype_enum:
+ op->op = FILTER_OP_LOAD_FIELD_REF_S64;
+ break;
+ case atype_array:
+ case atype_sequence:
+ op->op = FILTER_OP_LOAD_FIELD_REF_SEQUENCE;
+ break;
+ case atype_string:
+ op->op = FILTER_OP_LOAD_FIELD_REF_STRING;
+ break;
+ case atype_float:
+ op->op = FILTER_OP_LOAD_FIELD_REF_DOUBLE;
+ break;
+ default:
+ return -EINVAL;
+ }
+ /* set offset */
+ field_ref->offset = (uint16_t) field_offset;
break;
- case atype_float:
- op->op = FILTER_OP_LOAD_FIELD_REF_DOUBLE;
+ }
+ default:
+ return -EINVAL;
+ }
+ return 0;
+}
+
+static
+int apply_context_reloc(struct lttng_event *event,
+ struct bytecode_runtime *runtime,
+ uint32_t runtime_len,
+ uint32_t reloc_offset,
+ const char *context_name,
+ enum filter_op filter_op)
+{
+ struct load_op *op;
+ struct lttng_ctx_field *ctx_field;
+ int idx;
+ struct lttng_session *session = runtime->p.session;
+
+ dbg_printf("Apply context reloc: %u %s\n", reloc_offset, context_name);
+
+ /* Get context index */
+ idx = lttng_get_context_index(session->ctx, context_name);
+ if (idx < 0) {
+ if (lttng_context_is_app(context_name)) {
+ int ret;
+
+ ret = lttng_ust_add_app_context_to_ctx_rcu(context_name,
+ &session->ctx);
+ if (ret)
+ return ret;
+ idx = lttng_get_context_index(session->ctx,
+ context_name);
+ if (idx < 0)
+ return -ENOENT;
+ } else {
+ return -ENOENT;
+ }
+ }
+ /* Check if idx is too large for 16-bit offset */
+ if (idx > FILTER_BYTECODE_MAX_LEN - 1)
+ return -EINVAL;
+
+ /* Get context return type */
+ ctx_field = &session->ctx->fields[idx];
+ op = (struct load_op *) &runtime->code[reloc_offset];
+
+ switch (filter_op) {
+ case FILTER_OP_GET_CONTEXT_REF:
+ {
+ struct field_ref *field_ref;
+
+ field_ref = (struct field_ref *) op->data;
+ switch (ctx_field->event_field.type.atype) {
+ case atype_integer:
+ case atype_enum:
+ op->op = FILTER_OP_GET_CONTEXT_REF_S64;
+ break;
+ /* Sequence and array supported as string */
+ case atype_string:
+ case atype_array:
+ case atype_sequence:
+ op->op = FILTER_OP_GET_CONTEXT_REF_STRING;
+ break;
+ case atype_float:
+ op->op = FILTER_OP_GET_CONTEXT_REF_DOUBLE;
+ break;
+ case atype_dynamic:
+ op->op = FILTER_OP_GET_CONTEXT_REF;
+ break;
+ default:
+ return -EINVAL;
+ }
+ /* set offset to context index within channel contexts */
+ field_ref->offset = (uint16_t) idx;
break;
+ }
+ default:
+ return -EINVAL;
+ }
+ return 0;
+}
+
+static
+int apply_reloc(struct lttng_event *event,
+ struct bytecode_runtime *runtime,
+ uint32_t runtime_len,
+ uint32_t reloc_offset,
+ const char *name)
+{
+ struct load_op *op;
+
+ dbg_printf("Apply reloc: %u %s\n", reloc_offset, name);
+
+ /* Ensure that the reloc is within the code */
+ if (runtime_len - reloc_offset < sizeof(uint16_t))
+ return -EINVAL;
+
+ op = (struct load_op *) &runtime->code[reloc_offset];
+ switch (op->op) {
+ case FILTER_OP_LOAD_FIELD_REF:
+ return apply_field_reloc(event, runtime, runtime_len,
+ reloc_offset, name, op->op);
+ case FILTER_OP_GET_CONTEXT_REF:
+ return apply_context_reloc(event, runtime, runtime_len,
+ reloc_offset, name, op->op);
+ case FILTER_OP_GET_SYMBOL:
+ case FILTER_OP_GET_SYMBOL_FIELD:
+ /*
+ * Will be handled by load specialize phase or
+ * dynamically by interpreter.
+ */
+ return 0;
default:
+ ERR("Unknown reloc op type %u\n", op->op);
return -EINVAL;
}
- /* set offset */
- field_ref->offset = (uint16_t) field_offset;
+ return 0;
+}
+
+static
+int bytecode_is_linked(struct lttng_ust_filter_bytecode_node *filter_bytecode,
+ struct lttng_event *event)
+{
+ struct lttng_bytecode_runtime *bc_runtime;
+
+ cds_list_for_each_entry(bc_runtime,
+ &event->bytecode_runtime_head, node) {
+ if (bc_runtime->bc == filter_bytecode)
+ return 1;
+ }
return 0;
}
* bytecode runtime.
*/
static
-int _lttng_filter_event_link_bytecode(struct ltt_event *event,
- struct lttng_ust_filter_bytecode *filter_bytecode)
+int _lttng_filter_event_link_bytecode(struct lttng_event *event,
+ struct lttng_ust_filter_bytecode_node *filter_bytecode,
+ struct cds_list_head *insert_loc)
{
int ret, offset, next_offset;
struct bytecode_runtime *runtime = NULL;
if (!filter_bytecode)
return 0;
- /* Even is not connected to any description */
- if (!event->desc)
- return 0;
/* Bytecode already linked */
- if (event->filter || event->filter_data)
+ if (bytecode_is_linked(filter_bytecode, event))
return 0;
- dbg_printf("Linking\n");
+ dbg_printf("Linking...\n");
/* We don't need the reloc table in the runtime */
- runtime_alloc_len = sizeof(*runtime) + filter_bytecode->reloc_offset;
+ runtime_alloc_len = sizeof(*runtime) + filter_bytecode->bc.reloc_offset;
runtime = zmalloc(runtime_alloc_len);
if (!runtime) {
ret = -ENOMEM;
- goto link_error;
+ goto alloc_error;
}
- runtime->len = filter_bytecode->reloc_offset;
+ runtime->p.bc = filter_bytecode;
+ runtime->p.session = event->chan->session;
+ runtime->p.event = event;
+ runtime->len = filter_bytecode->bc.reloc_offset;
/* copy original bytecode */
- memcpy(runtime->data, filter_bytecode->data, runtime->len);
+ memcpy(runtime->code, filter_bytecode->bc.data, runtime->len);
/*
* apply relocs. Those are a uint16_t (offset in bytecode)
* followed by a string (field name).
*/
- for (offset = filter_bytecode->reloc_offset;
- offset < filter_bytecode->len;
+ for (offset = filter_bytecode->bc.reloc_offset;
+ offset < filter_bytecode->bc.len;
offset = next_offset) {
uint16_t reloc_offset =
- *(uint16_t *) &filter_bytecode->data[offset];
- const char *field_name =
- (const char *) &filter_bytecode->data[offset + sizeof(uint16_t)];
+ *(uint16_t *) &filter_bytecode->bc.data[offset];
+ const char *name =
+ (const char *) &filter_bytecode->bc.data[offset + sizeof(uint16_t)];
- ret = apply_field_reloc(event, runtime, runtime->len, reloc_offset, field_name);
+ ret = apply_reloc(event, runtime, runtime->len, reloc_offset, name);
if (ret) {
goto link_error;
}
- next_offset = offset + sizeof(uint16_t) + strlen(field_name) + 1;
+ next_offset = offset + sizeof(uint16_t) + strlen(name) + 1;
}
/* Validate bytecode */
ret = lttng_filter_validate_bytecode(runtime);
goto link_error;
}
/* Specialize bytecode */
- ret = lttng_filter_specialize_bytecode(runtime);
+ ret = lttng_filter_specialize_bytecode(event, runtime);
if (ret) {
goto link_error;
}
- event->filter_data = runtime;
- event->filter = lttng_filter_interpret_bytecode;
+ runtime->p.filter = lttng_filter_interpret_bytecode;
+ runtime->p.link_failed = 0;
+ cds_list_add_rcu(&runtime->p.node, insert_loc);
+ dbg_printf("Linking successful.\n");
return 0;
link_error:
- event->filter = lttng_filter_false;
- free(runtime);
+ runtime->p.filter = lttng_filter_false;
+ runtime->p.link_failed = 1;
+ cds_list_add_rcu(&runtime->p.node, insert_loc);
+alloc_error:
+ dbg_printf("Linking failed.\n");
return ret;
}
-void lttng_filter_event_link_bytecode(struct ltt_event *event,
- struct lttng_ust_filter_bytecode *filter_bytecode)
+void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime)
{
- int ret;
+ struct lttng_ust_filter_bytecode_node *bc = runtime->bc;
- ret = _lttng_filter_event_link_bytecode(event, filter_bytecode);
- if (ret) {
- dbg_printf("[lttng filter] warning: cannot link event bytecode\n");
- }
+ if (!bc->enabler->enabled || runtime->link_failed)
+ runtime->filter = lttng_filter_false;
+ else
+ runtime->filter = lttng_filter_interpret_bytecode;
}
/*
- * Link bytecode to all events for a wildcard. Skips events that already
- * have a bytecode linked.
- * We do not set each event's filter_bytecode field, because they do not
- * own the filter_bytecode: the wildcard owns it.
+ * Link bytecode for all enablers referenced by an event.
*/
-void lttng_filter_wildcard_link_bytecode(struct session_wildcard *wildcard)
+void lttng_enabler_event_link_bytecode(struct lttng_event *event,
+ struct lttng_enabler *enabler)
{
- struct ltt_event *event;
- int ret;
-
- if (!wildcard->filter_bytecode)
- return;
-
- cds_list_for_each_entry(event, &wildcard->events, wildcard_list) {
- if (event->filter)
+ struct lttng_ust_filter_bytecode_node *bc;
+ struct lttng_bytecode_runtime *runtime;
+
+ /* Can only be called for events with desc attached */
+ assert(event->desc);
+
+ /* Link each bytecode. */
+ cds_list_for_each_entry(bc, &enabler->filter_bytecode_head, node) {
+ int found = 0, ret;
+ struct cds_list_head *insert_loc;
+
+ cds_list_for_each_entry(runtime,
+ &event->bytecode_runtime_head, node) {
+ if (runtime->bc == bc) {
+ found = 1;
+ break;
+ }
+ }
+ /* Skip bytecode already linked */
+ if (found)
continue;
- ret = _lttng_filter_event_link_bytecode(event,
- wildcard->filter_bytecode);
+
+ /*
+ * Insert at specified priority (seqnum) in increasing
+ * order.
+ */
+ cds_list_for_each_entry_reverse(runtime,
+ &event->bytecode_runtime_head, node) {
+ if (runtime->bc->bc.seqnum < bc->bc.seqnum) {
+ /* insert here */
+ insert_loc = &runtime->node;
+ goto add_within;
+ }
+ }
+ /* Add to head to list */
+ insert_loc = &event->bytecode_runtime_head;
+ add_within:
+ dbg_printf("linking bytecode\n");
+ ret = _lttng_filter_event_link_bytecode(event, bc,
+ insert_loc);
if (ret) {
- dbg_printf("[lttng filter] error linking wildcard bytecode");
+ dbg_printf("[lttng filter] warning: cannot link event bytecode\n");
}
-
}
- return;
}
/*
- * Need to attach filter to an event before starting tracing for the
- * session. We own the filter_bytecode if we return success.
+ * We own the filter_bytecode if we return success.
*/
-int lttng_filter_event_attach_bytecode(struct ltt_event *event,
- struct lttng_ust_filter_bytecode *filter_bytecode)
+int lttng_filter_enabler_attach_bytecode(struct lttng_enabler *enabler,
+ struct lttng_ust_filter_bytecode_node *filter_bytecode)
{
- if (event->chan->session->been_active)
- return -EPERM;
- if (event->filter_bytecode)
- return -EEXIST;
- event->filter_bytecode = filter_bytecode;
+ cds_list_add(&filter_bytecode->node, &enabler->filter_bytecode_head);
return 0;
}
-/*
- * Need to attach filter to a wildcard before starting tracing for the
- * session. We own the filter_bytecode if we return success.
- */
-int lttng_filter_wildcard_attach_bytecode(struct session_wildcard *wildcard,
- struct lttng_ust_filter_bytecode *filter_bytecode)
+void lttng_free_enabler_filter_bytecode(struct lttng_enabler *enabler)
{
- if (wildcard->chan->session->been_active)
- return -EPERM;
- if (wildcard->filter_bytecode)
- return -EEXIST;
- wildcard->filter_bytecode = filter_bytecode;
- return 0;
+ struct lttng_ust_filter_bytecode_node *filter_bytecode, *tmp;
+
+ cds_list_for_each_entry_safe(filter_bytecode, tmp,
+ &enabler->filter_bytecode_head, node) {
+ free(filter_bytecode);
+ }
+}
+
+void lttng_free_event_filter_runtime(struct lttng_event *event)
+{
+ struct bytecode_runtime *runtime, *tmp;
+
+ cds_list_for_each_entry_safe(runtime, tmp,
+ &event->bytecode_runtime_head, p.node) {
+ free(runtime->data);
+ free(runtime);
+ }
}