include/lttng/event-rule/event-rule-internal.h

   1 /*
   2  * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef LTTNG_EVENT_RULE_INTERNAL_H
   9 #define LTTNG_EVENT_RULE_INTERNAL_H
  10
  11 #include <common/macros.h>
  12 #include <common/credentials.h>
  13 #include <common/sessiond-comm/sessiond-comm.h>
  14 #include <lttng/domain.h>
  15 #include <lttng/event.h>
  16 #include <lttng/event-rule/event-rule.h>
  17 #include <lttng/lttng-error.h>
  18 #include <stdbool.h>
  19 #include <stdint.h>
  20 #include <sys/types.h>
  21 #include <urcu/ref.h>
  22
  23 #if defined(__cplusplus)
  24 extern "C" {
  25 #endif
  26
  27 struct lttng_payload;
  28 struct lttng_payload_view;
  29 struct mi_writer;
  30
  31 enum lttng_event_rule_generate_exclusions_status {
  32         LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OK,
  33         LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE,
  34         LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_ERROR,
  35         LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OUT_OF_MEMORY,
  36 };
  37
  38 typedef void (*event_rule_destroy_cb)(struct lttng_event_rule *event_rule);
  39 typedef bool (*event_rule_validate_cb)(
  40                 const struct lttng_event_rule *event_rule);
  41 typedef int (*event_rule_serialize_cb)(
  42                 const struct lttng_event_rule *event_rule,
  43                 struct lttng_payload *payload);
  44 typedef bool (*event_rule_equal_cb)(const struct lttng_event_rule *a,
  45                 const struct lttng_event_rule *b);
  46 typedef ssize_t (*event_rule_create_from_payload_cb)(
  47                 struct lttng_payload_view *view,
  48                 struct lttng_event_rule **event_rule);
  49 typedef enum lttng_error_code (*event_rule_generate_filter_bytecode_cb)(
  50                 struct lttng_event_rule *event_rule,
  51                 const struct lttng_credentials *creds);
  52 typedef const char *(*event_rule_get_filter_cb)(
  53                 const struct lttng_event_rule *event_rule);
  54 typedef const struct lttng_bytecode *(
  55                 *event_rule_get_filter_bytecode_cb)(
  56                 const struct lttng_event_rule *event_rule);
  57 typedef enum lttng_event_rule_generate_exclusions_status (
  58                 *event_rule_generate_exclusions_cb)(
  59                 const struct lttng_event_rule *event_rule,
  60                 struct lttng_event_exclusion **exclusions);
  61 typedef unsigned long (*event_rule_hash_cb)(
  62                 const struct lttng_event_rule *event_rule);
  63 typedef struct lttng_event *(*event_rule_generate_lttng_event_cb)(
  64                 const struct lttng_event_rule *event_rule);
  65 typedef enum lttng_error_code (*event_rule_mi_serialize_cb)(
  66                 const struct lttng_event_rule *event_rule,
  67                 struct mi_writer *writer);
  68
  69 struct lttng_event_rule {
  70         struct urcu_ref ref;
  71         enum lttng_event_rule_type type;
  72         event_rule_validate_cb validate;
  73         event_rule_serialize_cb serialize;
  74         event_rule_equal_cb equal;
  75         event_rule_destroy_cb destroy;
  76         event_rule_generate_filter_bytecode_cb generate_filter_bytecode;
  77         event_rule_get_filter_cb get_filter;
  78         event_rule_get_filter_bytecode_cb get_filter_bytecode;
  79         event_rule_generate_exclusions_cb generate_exclusions;
  80         event_rule_hash_cb hash;
  81         event_rule_generate_lttng_event_cb generate_lttng_event;
  82         event_rule_mi_serialize_cb mi_serialize;
  83 };
  84
  85 struct lttng_event_rule_comm {
  86         /* enum lttng_event_rule_type */
  87         int8_t event_rule_type;
  88         char payload[];
  89 };
  90
  91 void lttng_event_rule_init(struct lttng_event_rule *event_rule,
  92                 enum lttng_event_rule_type type);
  93
  94 bool lttng_event_rule_validate(const struct lttng_event_rule *event_rule);
  95
  96 ssize_t lttng_event_rule_create_from_payload(
  97                 struct lttng_payload_view *payload,
  98                 struct lttng_event_rule **event_rule);
  99
 100 int lttng_event_rule_serialize(const struct lttng_event_rule *event_rule,
 101                 struct lttng_payload *payload);
 102
 103 bool lttng_event_rule_is_equal(const struct lttng_event_rule *a,
 104                 const struct lttng_event_rule *b);
 105
 106 bool lttng_event_rule_get(struct lttng_event_rule *rule);
 107
 108 void lttng_event_rule_put(struct lttng_event_rule *rule);
 109
 110 enum lttng_domain_type lttng_event_rule_get_domain_type(
 111                 const struct lttng_event_rule *rule);
 112
 113 enum lttng_error_code lttng_event_rule_generate_filter_bytecode(
 114                 struct lttng_event_rule *rule,
 115                 const struct lttng_credentials *creds);
 116
 117 /*
 118  * If not present/implemented returns NULL.
 119  * Caller DOES NOT own the returned object.
 120  */
 121 const char *lttng_event_rule_get_filter(const struct lttng_event_rule *rule);
 122
 123 /*
 124  * If not present/implemented returns NULL.
 125  * Caller DOES NOT own the returned object.
 126  */
 127 const struct lttng_bytecode *lttng_event_rule_get_filter_bytecode(
 128                 const struct lttng_event_rule *rule);
 129
 130 /*
 131  * If not present/implemented return NULL.
 132  * Caller OWNS the returned object.
 133  */
 134 enum lttng_event_rule_generate_exclusions_status
 135 lttng_event_rule_generate_exclusions(const struct lttng_event_rule *rule,
 136                 struct lttng_event_exclusion **exclusions);
 137
 138 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type);
 139
 140 unsigned long lttng_event_rule_hash(const struct lttng_event_rule *rule);
 141
 142 /*
 143  * This is a compatibility helper allowing us to generate a sessiond-side (not
 144  * communication) `struct lttng_event` object from an event rule.
 145  *
 146  * This effectively bridges older parts of the code using those structures and
 147  * new event-rule based code.
 148  *
 149  * The caller owns the returned object.
 150  */
 151 struct lttng_event *lttng_event_rule_generate_lttng_event(
 152                 const struct lttng_event_rule *rule);
 153
 154 /* Test if an event rule targets an agent domain. */
 155 bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule *rule);
 156
 157 enum lttng_error_code lttng_event_rule_mi_serialize(
 158                 const struct lttng_event_rule *rule, struct mi_writer *writer);
 159
 160 #if defined(__cplusplus)
 161 }
 162 #endif
 163
 164 #endif /* LTTNG_EVENT_RULE_INTERNAL_H */