src/common/event-rule/event-rule.c

   1 /*
   2  * Copyright (C) 2019 Jonathan Rajotte
   3  * <jonathan.rajotte-julien@efficios.com>
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-only
   6  *
   7  */
   8
   9 #include <assert.h>
  10 #include <common/error.h>
  11 #include <common/macros.h>
  12 #include <common/payload.h>
  13 #include <common/payload-view.h>
  14 #include <common/hashtable/hashtable.h>
  15 #include <common/hashtable/utils.h>
  16 #include <lttng/event-rule/event-rule-internal.h>
  17 #include <lttng/event-rule/kernel-function-internal.h>
  18 #include <lttng/event-rule/kernel-probe-internal.h>
  19 #include <lttng/event-rule/syscall-internal.h>
  20 #include <lttng/event-rule/tracepoint-internal.h>
  21 #include <lttng/event-rule/userspace-probe-internal.h>
  22 #include <stdbool.h>
  23
  24 enum lttng_event_rule_type lttng_event_rule_get_type(
  25                 const struct lttng_event_rule *event_rule)
  26 {
  27         return event_rule ? event_rule->type : LTTNG_EVENT_RULE_TYPE_UNKNOWN;
  28 }
  29
  30 LTTNG_HIDDEN
  31 enum lttng_domain_type lttng_event_rule_get_domain_type(
  32                 const struct lttng_event_rule *event_rule)
  33 {
  34         enum lttng_domain_type domain_type = LTTNG_DOMAIN_NONE;
  35
  36         switch (lttng_event_rule_get_type(event_rule)) {
  37         case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
  38         {
  39                 enum lttng_event_rule_status status;
  40                 status = lttng_event_rule_tracepoint_get_domain_type(event_rule, &domain_type);
  41                 assert(status == LTTNG_EVENT_RULE_STATUS_OK);
  42                 break;
  43         }
  44         case LTTNG_EVENT_RULE_TYPE_SYSCALL:
  45         case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE:
  46         case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION:
  47         case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE:
  48                 domain_type = LTTNG_DOMAIN_KERNEL;
  49                 break;
  50         case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
  51                 domain_type = LTTNG_DOMAIN_NONE;
  52                 break;
  53         }
  54
  55         return domain_type;
  56 }
  57
  58 static void lttng_event_rule_release(struct urcu_ref *ref)
  59 {
  60         struct lttng_event_rule *event_rule =
  61                         container_of(ref, typeof(*event_rule), ref);
  62
  63         assert(event_rule->destroy);
  64         event_rule->destroy(event_rule);
  65 }
  66
  67 void lttng_event_rule_destroy(struct lttng_event_rule *event_rule)
  68 {
  69         lttng_event_rule_put(event_rule);
  70 }
  71
  72 LTTNG_HIDDEN
  73 bool lttng_event_rule_validate(const struct lttng_event_rule *event_rule)
  74 {
  75         bool valid;
  76
  77         if (!event_rule) {
  78                 valid = false;
  79                 goto end;
  80         }
  81
  82         if (!event_rule->validate) {
  83                 /* Sub-class guarantees that it can never be invalid. */
  84                 valid = true;
  85                 goto end;
  86         }
  87
  88         valid = event_rule->validate(event_rule);
  89 end:
  90         return valid;
  91 }
  92
  93 LTTNG_HIDDEN
  94 int lttng_event_rule_serialize(const struct lttng_event_rule *event_rule,
  95                 struct lttng_payload *payload)
  96 {
  97         int ret;
  98         struct lttng_event_rule_comm event_rule_comm = {};
  99
 100         if (!event_rule) {
 101                 ret = -1;
 102                 goto end;
 103         }
 104
 105         event_rule_comm.event_rule_type = (int8_t) event_rule->type;
 106
 107         ret = lttng_dynamic_buffer_append(
 108                         &payload->buffer, &event_rule_comm, sizeof(event_rule_comm));
 109         if (ret) {
 110                 goto end;
 111         }
 112
 113         ret = event_rule->serialize(event_rule, payload);
 114         if (ret) {
 115                 goto end;
 116         }
 117 end:
 118         return ret;
 119 }
 120
 121 LTTNG_HIDDEN
 122 bool lttng_event_rule_is_equal(const struct lttng_event_rule *a,
 123                 const struct lttng_event_rule *b)
 124 {
 125         bool is_equal = false;
 126
 127         if (!a || !b) {
 128                 goto end;
 129         }
 130
 131         if (a->type != b->type) {
 132                 goto end;
 133         }
 134
 135         if (a == b) {
 136                 is_equal = true;
 137                 goto end;
 138         }
 139
 140         is_equal = a->equal ? a->equal(a, b) : true;
 141 end:
 142         return is_equal;
 143 }
 144
 145 LTTNG_HIDDEN
 146 ssize_t lttng_event_rule_create_from_payload(
 147                 struct lttng_payload_view *view,
 148                 struct lttng_event_rule **event_rule)
 149 {
 150         ssize_t ret, consumed = 0;
 151         event_rule_create_from_payload_cb create_from_payload = NULL;
 152         const struct lttng_event_rule_comm *event_rule_comm;
 153         const struct lttng_payload_view event_rule_comm_view =
 154                         lttng_payload_view_from_view(
 155                                         view, 0, sizeof(*event_rule_comm));
 156
 157         if (!view || !event_rule) {
 158                 ret = -1;
 159                 goto end;
 160         }
 161
 162         if (!lttng_payload_view_is_valid(&event_rule_comm_view)) {
 163                 ret = -1;
 164                 goto end;
 165         }
 166
 167         DBG("Deserializing event_rule from payload");
 168         event_rule_comm = (const struct lttng_event_rule_comm *) event_rule_comm_view.buffer.data;
 169         consumed += sizeof(*event_rule_comm);
 170
 171         switch ((enum lttng_event_rule_type) event_rule_comm->event_rule_type) {
 172         case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
 173                 create_from_payload =
 174                                 lttng_event_rule_tracepoint_create_from_payload;
 175                 break;
 176         case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE:
 177                 create_from_payload = lttng_event_rule_kernel_probe_create_from_payload;
 178                 break;
 179         case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION:
 180                 create_from_payload = lttng_event_rule_kernel_function_create_from_payload;
 181                 break;
 182         case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE:
 183                 create_from_payload = lttng_event_rule_userspace_probe_create_from_payload;
 184                 break;
 185         case LTTNG_EVENT_RULE_TYPE_SYSCALL:
 186                 create_from_payload =
 187                                 lttng_event_rule_syscall_create_from_payload;
 188                 break;
 189         default:
 190                 ERR("Attempted to create event rule of unknown type (%i)",
 191                                 (int) event_rule_comm->event_rule_type);
 192                 ret = -1;
 193                 goto end;
 194         }
 195
 196         assert(create_from_payload);
 197
 198         {
 199                 struct lttng_payload_view child_view =
 200                                 lttng_payload_view_from_view(
 201                                                 view, consumed, -1);
 202
 203                 ret = create_from_payload(&child_view, event_rule);
 204                 if (ret < 0) {
 205                         goto end;
 206                 }
 207
 208                 consumed += ret;
 209         }
 210
 211         if (!lttng_event_rule_validate(*event_rule)) {
 212                 ret = -1;
 213                 goto end;
 214         }
 215
 216         ret = consumed;
 217 end:
 218         return ret;
 219 }
 220
 221 LTTNG_HIDDEN
 222 void lttng_event_rule_init(struct lttng_event_rule *event_rule,
 223                 enum lttng_event_rule_type type)
 224 {
 225         urcu_ref_init(&event_rule->ref);
 226         event_rule->type = type;
 227 }
 228
 229 LTTNG_HIDDEN
 230 bool lttng_event_rule_get(struct lttng_event_rule *event_rule)
 231 {
 232         return urcu_ref_get_unless_zero(&event_rule->ref);
 233 }
 234
 235 LTTNG_HIDDEN
 236 void lttng_event_rule_put(struct lttng_event_rule *event_rule)
 237 {
 238         if (!event_rule) {
 239                 return;
 240         }
 241
 242         assert(event_rule->ref.refcount);
 243         urcu_ref_put(&event_rule->ref, lttng_event_rule_release);
 244 }
 245
 246 LTTNG_HIDDEN
 247 enum lttng_error_code lttng_event_rule_generate_filter_bytecode(
 248                 struct lttng_event_rule *rule,
 249                 const struct lttng_credentials *creds)
 250 {
 251         assert(rule->generate_filter_bytecode);
 252         return rule->generate_filter_bytecode(rule, creds);
 253 }
 254
 255 LTTNG_HIDDEN
 256 const char *lttng_event_rule_get_filter(const struct lttng_event_rule *rule)
 257 {
 258         assert(rule->get_filter);
 259         return rule->get_filter(rule);
 260 }
 261
 262 LTTNG_HIDDEN
 263 const struct lttng_bytecode *lttng_event_rule_get_filter_bytecode(
 264                 const struct lttng_event_rule *rule)
 265 {
 266         assert(rule->get_filter_bytecode);
 267         return rule->get_filter_bytecode(rule);
 268 }
 269
 270 LTTNG_HIDDEN
 271 enum lttng_event_rule_generate_exclusions_status
 272 lttng_event_rule_generate_exclusions(const struct lttng_event_rule *rule,
 273                 struct lttng_event_exclusion **exclusions)
 274 {
 275         assert(rule->generate_exclusions);
 276         return rule->generate_exclusions(rule, exclusions);
 277 }
 278
 279 LTTNG_HIDDEN
 280 struct lttng_event *lttng_event_rule_generate_lttng_event(
 281                 const struct lttng_event_rule *rule)
 282 {
 283         assert(rule->generate_lttng_event);
 284         return rule->generate_lttng_event(rule);
 285 }
 286
 287 LTTNG_HIDDEN
 288 bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule *rule)
 289 {
 290         bool targets_agent_domain = false;
 291         enum lttng_domain_type type = lttng_event_rule_get_domain_type(rule);
 292
 293         switch (type) {
 294         case LTTNG_DOMAIN_JUL:
 295         case LTTNG_DOMAIN_LOG4J:
 296         case LTTNG_DOMAIN_PYTHON:
 297                 targets_agent_domain = true;
 298                 break;
 299         case LTTNG_DOMAIN_UST:
 300         case LTTNG_DOMAIN_KERNEL:
 301                 targets_agent_domain = false;
 302                 break;
 303         default:
 304                 abort();
 305         };
 306
 307         return targets_agent_domain;
 308 }
 309
 310 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type)
 311 {
 312         switch (type) {
 313         case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
 314                 return "unknown";
 315         case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
 316                 return "tracepoint";
 317         case LTTNG_EVENT_RULE_TYPE_SYSCALL:
 318                 return "syscall";
 319         case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE:
 320                 return "probe";
 321         case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION:
 322                 return "function";
 323         case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE:
 324                 return "userspace-probe";
 325         default:
 326                 abort();
 327         }
 328 }
 329
 330 LTTNG_HIDDEN
 331 unsigned long lttng_event_rule_hash(const struct lttng_event_rule *rule)
 332 {
 333         assert(rule->hash);
 334         return rule->hash(rule);
 335 }