include/lttng/event-rule/event-rule.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_H
   9 #define LTTNG_EVENT_RULE_H
  10
  11 #ifdef __cplusplus
  12 extern "C" {
  13 #endif
  14
  15 struct lttng_event_rule;
  16
  17 enum lttng_event_rule_type {
  18         LTTNG_EVENT_RULE_TYPE_UNKNOWN = -1,
  19         LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL = 0,
  20         LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE = 1,
  21         LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION = 2,
  22         LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT = 3,
  23         LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE = 4,
  24         LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT = 5,
  25         LTTNG_EVENT_RULE_TYPE_JUL_LOGGING = 6,
  26         LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING = 7,
  27         LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING = 8,
  28 };
  29
  30 enum lttng_event_rule_status {
  31         LTTNG_EVENT_RULE_STATUS_OK = 0,
  32         LTTNG_EVENT_RULE_STATUS_ERROR = -1,
  33         LTTNG_EVENT_RULE_STATUS_UNKNOWN = -2,
  34         LTTNG_EVENT_RULE_STATUS_INVALID = -3,
  35         LTTNG_EVENT_RULE_STATUS_UNSET = -4,
  36         LTTNG_EVENT_RULE_STATUS_UNSUPPORTED = -5,
  37 };
  38
  39 /**
  40  * An event rule describes a set of criteria to be used as a discriminant in
  41  * regards to a set of events.
  42  */
  43
  44 /*
  45  * Get the event rule type.
  46  *
  47  * Returns the type of an event rule on success, LTTNG_EVENT_RULE_UNKNOWN on
  48  * error.
  49  */
  50 extern enum lttng_event_rule_type lttng_event_rule_get_type(
  51                 const struct lttng_event_rule *event_rule);
  52
  53 /*
  54  * Destroy an event rule object.
  55  */
  56 extern void lttng_event_rule_destroy(struct lttng_event_rule *rule);
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif
  61
  62 #endif /* LTTNG_EVENT_RULE_H */