projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| 6d420eff JR |
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_TRACEPOINT_H | |
| 9 | #define LTTNG_EVENT_RULE_TRACEPOINT_H | |
| 10 | ||
| 11 | #include <lttng/domain.h> | |
| 12 | #include <lttng/event-rule/event-rule.h> | |
| c3e68e71 | 13 | #include <lttng/log-level-rule.h> |
| 6d420eff JR |
14 | #include <lttng/event.h> |
| 15 | ||
| 16 | #ifdef __cplusplus | |
| 17 | extern "C" { | |
| 18 | #endif | |
| 19 | ||
| 20 | /* | |
| 21 | * Create a newly allocated tracepoint event rule. | |
| 22 | * | |
| c3e68e71 JR |
23 | * The default pattern is '*'. |
| 24 | * | |
| 6d420eff JR |
25 | * Returns a new event rule on success, NULL on failure. This event rule must be |
| 26 | * destroyed using lttng_event_rule_destroy(). | |
| 27 | */ | |
| 28 | extern struct lttng_event_rule *lttng_event_rule_tracepoint_create( | |
| 29 | enum lttng_domain_type domain); | |
| 30 | ||
| 31 | /* | |
| 32 | * Set the pattern of a tracepoint event rule. | |
| 33 | * | |
| 34 | * Pattern can contain wildcard '*'. See man lttng-enable-event. | |
| 35 | * | |
| 36 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
| 37 | * if invalid parameters are passed. | |
| 38 | */ | |
| 39 | extern enum lttng_event_rule_status lttng_event_rule_tracepoint_set_pattern( | |
| 40 | struct lttng_event_rule *rule, const char *pattern); | |
| 41 | ||
| 42 | /* | |
| 43 | * Get the pattern of a tracepoint event rule. | |
| 44 | * | |
| 45 | * The caller does not assume the ownership of the returned pattern. The | |
| 46 | * pattern shall only only be used for the duration of the event rule's | |
| 47 | * lifetime, or before a different pattern is set. | |
| 48 | * | |
| 49 | * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's pattern | |
| 50 | * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid | |
| 51 | * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern | |
| 52 | * was not set prior to this call. | |
| 53 | */ | |
| 54 | extern enum lttng_event_rule_status lttng_event_rule_tracepoint_get_pattern( | |
| 55 | const struct lttng_event_rule *rule, const char **pattern); | |
| 56 | ||
| 57 | /* | |
| 58 | * Get the domain type of a tracepoint event rule. | |
| 59 | * | |
| 60 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the domain type output parameter | |
| 61 | * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is | |
| 62 | * passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern was not set prior to | |
| 63 | * this call. | |
| 64 | */ | |
| 65 | extern enum lttng_event_rule_status lttng_event_rule_tracepoint_get_domain_type( | |
| 66 | const struct lttng_event_rule *rule, | |
| 67 | enum lttng_domain_type *type); | |
| 68 | ||
| 69 | /* | |
| 70 | * Set the filter expression of a tracepoint event rule. | |
| 71 | * | |
| 72 | * The expression is copied internally. | |
| 73 | * | |
| 74 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
| 75 | * if invalid parameters are passed. | |
| 76 | */ | |
| 77 | extern enum lttng_event_rule_status lttng_event_rule_tracepoint_set_filter( | |
| 78 | struct lttng_event_rule *rule, const char *expression); | |
| 79 | ||
| 80 | /* | |
| 81 | * Get the filter expression of a tracepoint event rule. | |
| 82 | * | |
| 83 | * The caller does not assume the ownership of the returned filter expression. | |
| 84 | * The filter expression shall only only be used for the duration of the event | |
| 85 | * rule's lifetime, or before a different filter expression is set. | |
| 86 | * | |
| 87 | * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter | |
| 88 | * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid | |
| 89 | * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression | |
| 90 | * was not set prior to this call. | |
| 91 | */ | |
| 92 | extern enum lttng_event_rule_status lttng_event_rule_tracepoint_get_filter( | |
| 93 | const struct lttng_event_rule *rule, const char **expression); | |
| 94 | ||
| 95 | /* | |
| c3e68e71 | 96 | * Set the log level rule of a tracepoint event rule. |
| 6d420eff JR |
97 | * |
| 98 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
| 99 | * if invalid parameters are passed. | |
| 100 | */ | |
| 101 | extern enum lttng_event_rule_status | |
| c3e68e71 JR |
102 | lttng_event_rule_tracepoint_set_log_level_rule(struct lttng_event_rule *rule, |
| 103 | const struct lttng_log_level_rule *log_level_rule); | |
| 6d420eff JR |
104 | |
| 105 | /* | |
| c3e68e71 | 106 | * Get the log level rule of a tracepoint event rule. |
| 6d420eff | 107 | * |
| c3e68e71 JR |
108 | * The caller does not assume the ownership of the returned log level rule. The |
| 109 | * log level rule shall only only be used for the duration of the event rule's | |
| 110 | * lifetime, or before a different log level rule is set. | |
| 6d420eff | 111 | * |
| c3e68e71 | 112 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the log level rule output |
| 6d420eff | 113 | * parameter on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter |
| c3e68e71 | 114 | * is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a log level rule was not set prior |
| 6d420eff JR |
115 | * to this call. |
| 116 | */ | |
| 117 | extern enum lttng_event_rule_status | |
| c3e68e71 | 118 | lttng_event_rule_tracepoint_get_log_level_rule( |
| 6d420eff | 119 | const struct lttng_event_rule *rule, |
| c3e68e71 | 120 | const struct lttng_log_level_rule **log_level_rule); |
| 6d420eff JR |
121 | |
| 122 | /* | |
| 123 | * Add an exclusion to the set of exclusion of an event rule. | |
| 124 | * | |
| 125 | * The passed exclusion will be copied to the event_rule. | |
| 126 | * | |
| 127 | * Returns LTTNG_EVENT_RULE_STATUS_OK on success, | |
| 128 | * LTTNG_EVENT_RULE_STATUS_INVALID if invalid parameters are passed, or | |
| 129 | * LTTNG_EVENT_RULE_STATUS_UNSUPPORTED if this property is not supported by the | |
| 130 | * domain. | |
| 131 | */ | |
| 132 | extern enum lttng_event_rule_status lttng_event_rule_tracepoint_add_exclusion( | |
| 133 | struct lttng_event_rule *rule, | |
| 134 | const char *exclusion); | |
| 135 | ||
| 136 | /* | |
| 137 | * Get the exclusions property count of an event rule. | |
| 138 | * | |
| 139 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the count output parameter | |
| 140 | * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is | |
| 141 | * passed. | |
| 142 | */ | |
| 143 | extern enum lttng_event_rule_status | |
| 144 | lttng_event_rule_tracepoint_get_exclusions_count( | |
| 145 | const struct lttng_event_rule *rule, unsigned int *count); | |
| 146 | ||
| 147 | /* | |
| 148 | * Get the event rule exclusion at the given index. | |
| 149 | * | |
| 150 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the exclusion output parameter | |
| 151 | * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is | |
| 152 | * passed. | |
| 153 | */ | |
| 154 | extern enum lttng_event_rule_status | |
| 155 | lttng_event_rule_tracepoint_get_exclusion_at_index( | |
| 156 | const struct lttng_event_rule *rule, | |
| 157 | unsigned int index, | |
| 158 | const char **exclusion); | |
| 159 | ||
| 160 | #ifdef __cplusplus | |
| 161 | } | |
| 162 | #endif | |
| 163 | ||
| 164 | #endif /* LTTNG_EVENT_RULE_TRACEPOINT_H */ |