include/lttng/event-expr-internal.h

   1 /*
   2  * Copyright (C) 2020 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef LTTNG_EVENT_EXPR_INTERNAL_H
   9 #define LTTNG_EVENT_EXPR_INTERNAL_H
  10
  11 #include <assert.h>
  12 #include <common/macros.h>
  13 #include <lttng/event-expr.h>
  14 #include <urcu/ref.h>
  15
  16 struct lttng_event_expr {
  17         struct urcu_ref ref;
  18         enum lttng_event_expr_type type;
  19 };
  20
  21 /*
  22  * `LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD` and
  23  * `LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD`.
  24  */
  25 struct lttng_event_expr_field {
  26         struct lttng_event_expr parent;
  27         char *name;
  28 };
  29
  30 /* `LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD` */
  31 struct lttng_event_expr_app_specific_context_field {
  32         struct lttng_event_expr parent;
  33         char *provider_name;
  34         char *type_name;
  35 };
  36
  37 /* `LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT` */
  38 struct lttng_event_expr_array_field_element {
  39         struct lttng_event_expr parent;
  40
  41         /* Owned by this */
  42         struct lttng_event_expr *array_field_expr;
  43
  44         unsigned int index;
  45 };
  46
  47 /*
  48  * Returns whether or not `expr` is an l-value (locator value).
  49  */
  50 static inline
  51 bool lttng_event_expr_is_lvalue(const struct lttng_event_expr *expr)
  52 {
  53         assert(expr);
  54         return expr->type == LTTNG_EVENT_EXPR_TYPE_EVENT_PAYLOAD_FIELD ||
  55                         expr->type == LTTNG_EVENT_EXPR_TYPE_CHANNEL_CONTEXT_FIELD ||
  56                         expr->type == LTTNG_EVENT_EXPR_TYPE_APP_SPECIFIC_CONTEXT_FIELD ||
  57                         expr->type == LTTNG_EVENT_EXPR_TYPE_ARRAY_FIELD_ELEMENT;
  58 }
  59
  60 LTTNG_HIDDEN
  61 void lttng_event_expr_get(struct lttng_event_expr *expr);
  62
  63 LTTNG_HIDDEN
  64 void lttng_event_expr_put(struct lttng_event_expr *expr);
  65
  66 #endif /* LTTNG_EVENT_EXPR_INTERNAL_H */