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