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 <common/error.h>
  10 #include <common/hashtable/hashtable.h>
  11 #include <common/hashtable/utils.h>
  12 #include <common/macros.h>
  13 #include <common/mi-lttng.h>
  14 #include <common/payload-view.h>
  15 #include <common/payload.h>
  16 #include <lttng/event-rule/event-rule-internal.h>
  17 #include <lttng/event-rule/jul-logging-internal.h>
  18 #include <lttng/event-rule/kernel-kprobe-internal.h>
  19 #include <lttng/event-rule/kernel-syscall-internal.h>
  20 #include <lttng/event-rule/kernel-tracepoint-internal.h>
  21 #include <lttng/event-rule/kernel-uprobe-internal.h>
  22 #include <lttng/event-rule/log4j-logging-internal.h>
  23 #include <lttng/event-rule/python-logging-internal.h>
  24 #include <lttng/event-rule/user-tracepoint-internal.h>
  25 #include <stdbool.h>
  26
  27 enum lttng_event_rule_type lttng_event_rule_get_type(
  28                 const struct lttng_event_rule *event_rule)
  29 {
  30         return event_rule ? event_rule->type : LTTNG_EVENT_RULE_TYPE_UNKNOWN;
  31 }
  32
  33 LTTNG_HIDDEN
  34 enum lttng_domain_type lttng_event_rule_get_domain_type(
  35                 const struct lttng_event_rule *event_rule)
  36 {
  37         enum lttng_domain_type domain_type = LTTNG_DOMAIN_NONE;
  38
  39         switch (lttng_event_rule_get_type(event_rule)) {
  40         case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
  41                 domain_type = LTTNG_DOMAIN_UST;
  42                 break;
  43         case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
  44                 domain_type = LTTNG_DOMAIN_JUL;
  45                 break;
  46         case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
  47                 domain_type = LTTNG_DOMAIN_LOG4J;
  48                 break;
  49         case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
  50                 domain_type = LTTNG_DOMAIN_PYTHON;
  51                 break;
  52         case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
  53         case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
  54         case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
  55         case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
  56                 domain_type = LTTNG_DOMAIN_KERNEL;
  57                 break;
  58         case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
  59                 domain_type = LTTNG_DOMAIN_NONE;
  60                 break;
  61         }
  62
  63         return domain_type;
  64 }
  65
  66 static void lttng_event_rule_release(struct urcu_ref *ref)
  67 {
  68         struct lttng_event_rule *event_rule =
  69                         container_of(ref, typeof(*event_rule), ref);
  70
  71         LTTNG_ASSERT(event_rule->destroy);
  72         event_rule->destroy(event_rule);
  73 }
  74
  75 void lttng_event_rule_destroy(struct lttng_event_rule *event_rule)
  76 {
  77         lttng_event_rule_put(event_rule);
  78 }
  79
  80 LTTNG_HIDDEN
  81 bool lttng_event_rule_validate(const struct lttng_event_rule *event_rule)
  82 {
  83         bool valid;
  84
  85         if (!event_rule) {
  86                 valid = false;
  87                 goto end;
  88         }
  89
  90         if (!event_rule->validate) {
  91                 /* Sub-class guarantees that it can never be invalid. */
  92                 valid = true;
  93                 goto end;
  94         }
  95
  96         valid = event_rule->validate(event_rule);
  97 end:
  98         return valid;
  99 }
 100
 101 LTTNG_HIDDEN
 102 int lttng_event_rule_serialize(const struct lttng_event_rule *event_rule,
 103                 struct lttng_payload *payload)
 104 {
 105         int ret;
 106         struct lttng_event_rule_comm event_rule_comm = {};
 107
 108         if (!event_rule) {
 109                 ret = -1;
 110                 goto end;
 111         }
 112
 113         event_rule_comm.event_rule_type = (int8_t) event_rule->type;
 114
 115         ret = lttng_dynamic_buffer_append(
 116                         &payload->buffer, &event_rule_comm, sizeof(event_rule_comm));
 117         if (ret) {
 118                 goto end;
 119         }
 120
 121         ret = event_rule->serialize(event_rule, payload);
 122         if (ret) {
 123                 goto end;
 124         }
 125 end:
 126         return ret;
 127 }
 128
 129 LTTNG_HIDDEN
 130 bool lttng_event_rule_is_equal(const struct lttng_event_rule *a,
 131                 const struct lttng_event_rule *b)
 132 {
 133         bool is_equal = false;
 134
 135         if (!a || !b) {
 136                 goto end;
 137         }
 138
 139         if (a->type != b->type) {
 140                 goto end;
 141         }
 142
 143         if (a == b) {
 144                 is_equal = true;
 145                 goto end;
 146         }
 147
 148         is_equal = a->equal ? a->equal(a, b) : true;
 149 end:
 150         return is_equal;
 151 }
 152
 153 LTTNG_HIDDEN
 154 ssize_t lttng_event_rule_create_from_payload(
 155                 struct lttng_payload_view *view,
 156                 struct lttng_event_rule **event_rule)
 157 {
 158         ssize_t ret, consumed = 0;
 159         event_rule_create_from_payload_cb create_from_payload = NULL;
 160         const struct lttng_event_rule_comm *event_rule_comm;
 161         const struct lttng_payload_view event_rule_comm_view =
 162                         lttng_payload_view_from_view(
 163                                         view, 0, sizeof(*event_rule_comm));
 164
 165         if (!view || !event_rule) {
 166                 ret = -1;
 167                 goto end;
 168         }
 169
 170         if (!lttng_payload_view_is_valid(&event_rule_comm_view)) {
 171                 ret = -1;
 172                 goto end;
 173         }
 174
 175         DBG("Deserializing event_rule from payload");
 176         event_rule_comm = (const struct lttng_event_rule_comm *) event_rule_comm_view.buffer.data;
 177         consumed += sizeof(*event_rule_comm);
 178
 179         switch ((enum lttng_event_rule_type) event_rule_comm->event_rule_type) {
 180         case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
 181                 create_from_payload = lttng_event_rule_kernel_kprobe_create_from_payload;
 182                 break;
 183         case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
 184                 create_from_payload = lttng_event_rule_kernel_uprobe_create_from_payload;
 185                 break;
 186         case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
 187                 create_from_payload =
 188                                 lttng_event_rule_kernel_syscall_create_from_payload;
 189                 break;
 190         case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
 191                 create_from_payload =
 192                                 lttng_event_rule_kernel_tracepoint_create_from_payload;
 193                 break;
 194         case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
 195                 create_from_payload =
 196                                 lttng_event_rule_user_tracepoint_create_from_payload;
 197                 break;
 198         case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
 199                 create_from_payload =
 200                                 lttng_event_rule_jul_logging_create_from_payload;
 201                 break;
 202         case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
 203                 create_from_payload =
 204                                 lttng_event_rule_log4j_logging_create_from_payload;
 205                 break;
 206         case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
 207                 create_from_payload =
 208                                 lttng_event_rule_python_logging_create_from_payload;
 209                 break;
 210         default:
 211                 ERR("Attempted to create event rule of unknown type (%i)",
 212                                 (int) event_rule_comm->event_rule_type);
 213                 ret = -1;
 214                 goto end;
 215         }
 216
 217         LTTNG_ASSERT(create_from_payload);
 218
 219         {
 220                 struct lttng_payload_view child_view =
 221                                 lttng_payload_view_from_view(
 222                                                 view, consumed, -1);
 223
 224                 ret = create_from_payload(&child_view, event_rule);
 225                 if (ret < 0) {
 226                         goto end;
 227                 }
 228
 229                 consumed += ret;
 230         }
 231
 232         if (!lttng_event_rule_validate(*event_rule)) {
 233                 ret = -1;
 234                 goto end;
 235         }
 236
 237         ret = consumed;
 238 end:
 239         return ret;
 240 }
 241
 242 LTTNG_HIDDEN
 243 void lttng_event_rule_init(struct lttng_event_rule *event_rule,
 244                 enum lttng_event_rule_type type)
 245 {
 246         urcu_ref_init(&event_rule->ref);
 247         event_rule->type = type;
 248 }
 249
 250 LTTNG_HIDDEN
 251 bool lttng_event_rule_get(struct lttng_event_rule *event_rule)
 252 {
 253         return urcu_ref_get_unless_zero(&event_rule->ref);
 254 }
 255
 256 LTTNG_HIDDEN
 257 void lttng_event_rule_put(struct lttng_event_rule *event_rule)
 258 {
 259         if (!event_rule) {
 260                 return;
 261         }
 262
 263         LTTNG_ASSERT(event_rule->ref.refcount);
 264         urcu_ref_put(&event_rule->ref, lttng_event_rule_release);
 265 }
 266
 267 LTTNG_HIDDEN
 268 enum lttng_error_code lttng_event_rule_generate_filter_bytecode(
 269                 struct lttng_event_rule *rule,
 270                 const struct lttng_credentials *creds)
 271 {
 272         LTTNG_ASSERT(rule->generate_filter_bytecode);
 273         return rule->generate_filter_bytecode(rule, creds);
 274 }
 275
 276 LTTNG_HIDDEN
 277 const char *lttng_event_rule_get_filter(const struct lttng_event_rule *rule)
 278 {
 279         LTTNG_ASSERT(rule->get_filter);
 280         return rule->get_filter(rule);
 281 }
 282
 283 LTTNG_HIDDEN
 284 const struct lttng_bytecode *lttng_event_rule_get_filter_bytecode(
 285                 const struct lttng_event_rule *rule)
 286 {
 287         LTTNG_ASSERT(rule->get_filter_bytecode);
 288         return rule->get_filter_bytecode(rule);
 289 }
 290
 291 LTTNG_HIDDEN
 292 enum lttng_event_rule_generate_exclusions_status
 293 lttng_event_rule_generate_exclusions(const struct lttng_event_rule *rule,
 294                 struct lttng_event_exclusion **exclusions)
 295 {
 296         LTTNG_ASSERT(rule->generate_exclusions);
 297         return rule->generate_exclusions(rule, exclusions);
 298 }
 299
 300 LTTNG_HIDDEN
 301 struct lttng_event *lttng_event_rule_generate_lttng_event(
 302                 const struct lttng_event_rule *rule)
 303 {
 304         LTTNG_ASSERT(rule->generate_lttng_event);
 305         return rule->generate_lttng_event(rule);
 306 }
 307
 308 LTTNG_HIDDEN
 309 bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule *rule)
 310 {
 311         bool targets_agent_domain = false;
 312         enum lttng_domain_type type = lttng_event_rule_get_domain_type(rule);
 313
 314         switch (type) {
 315         case LTTNG_DOMAIN_JUL:
 316         case LTTNG_DOMAIN_LOG4J:
 317         case LTTNG_DOMAIN_PYTHON:
 318                 targets_agent_domain = true;
 319                 break;
 320         case LTTNG_DOMAIN_UST:
 321         case LTTNG_DOMAIN_KERNEL:
 322                 targets_agent_domain = false;
 323                 break;
 324         default:
 325                 abort();
 326         };
 327
 328         return targets_agent_domain;
 329 }
 330
 331 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type)
 332 {
 333         switch (type) {
 334         case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
 335                 return "unknown";
 336         case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
 337                 return "kernel syscall";
 338         case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
 339                 return "kernel kprobe";
 340         case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
 341                 return "kernel uprobe";
 342         case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
 343                 return "kernel tracepoint";
 344         case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
 345                 return "user tracepoint";
 346         case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
 347                 return "jul logging";
 348         case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING:
 349                 return "log4j logging";
 350         case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING:
 351                 return "python logging";
 352
 353         default:
 354                 abort();
 355         }
 356 }
 357
 358 LTTNG_HIDDEN
 359 unsigned long lttng_event_rule_hash(const struct lttng_event_rule *rule)
 360 {
 361         LTTNG_ASSERT(rule->hash);
 362         return rule->hash(rule);
 363 }
 364
 365 LTTNG_HIDDEN
 366 enum lttng_error_code lttng_event_rule_mi_serialize(
 367                 const struct lttng_event_rule *rule, struct mi_writer *writer)
 368 {
 369         int ret;
 370         enum lttng_error_code ret_code;
 371
 372         LTTNG_ASSERT(rule);
 373         LTTNG_ASSERT(writer);
 374         LTTNG_ASSERT(rule->mi_serialize);
 375
 376         /* Open event rule element. */
 377         ret = mi_lttng_writer_open_element(writer, mi_lttng_element_event_rule);
 378         if (ret) {
 379                 goto mi_error;
 380         }
 381
 382         /* Serialize underlying event rule. */
 383         ret_code = rule->mi_serialize(rule, writer);
 384         if (ret_code != LTTNG_OK) {
 385                 goto end;
 386         }
 387
 388         /* Close event rule element. */
 389         ret = mi_lttng_writer_close_element(writer);
 390         if (ret) {
 391                 goto mi_error;
 392         }
 393
 394         ret_code = LTTNG_OK;
 395         goto end;
 396
 397 mi_error:
 398         ret_code = LTTNG_ERR_MI_IO_FAIL;
 399 end:
 400         return ret_code;
 401 }