Commit | Line | Data |
---|---|---|
0a23a07d JR |
1 | /* |
2 | * Copyright (C) 2021 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com> | |
3 | * | |
4 | * SPDX-License-Identifier: LGPL-2.1-only | |
5 | * | |
6 | */ | |
7 | ||
8 | #ifndef LTTNG_EVENT_RULE_USER_TRACEPOINT_H | |
9 | #define LTTNG_EVENT_RULE_USER_TRACEPOINT_H | |
10 | ||
11 | #include <lttng/domain.h> | |
12 | #include <lttng/event-rule/event-rule.h> | |
28f23191 | 13 | #include <lttng/event.h> |
0a23a07d | 14 | #include <lttng/log-level-rule.h> |
4bd69c5f | 15 | #include <lttng/lttng-export.h> |
0a23a07d JR |
16 | |
17 | #ifdef __cplusplus | |
18 | extern "C" { | |
19 | #endif | |
20 | ||
21 | /* | |
22 | * Create a newly allocated user tracepoint event rule. | |
23 | * | |
24 | * The default pattern is '*'. | |
25 | * | |
26 | * Returns a new event rule on success, NULL on failure. This event rule must be | |
27 | * destroyed using lttng_event_rule_destroy(). | |
28 | */ | |
4bd69c5f | 29 | LTTNG_EXPORT extern struct lttng_event_rule *lttng_event_rule_user_tracepoint_create(void); |
0a23a07d JR |
30 | |
31 | /* | |
32 | * Set the name pattern of a user 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 | */ | |
28f23191 JG |
39 | LTTNG_EXPORT extern enum lttng_event_rule_status |
40 | lttng_event_rule_user_tracepoint_set_name_pattern(struct lttng_event_rule *rule, | |
41 | const char *pattern); | |
0a23a07d JR |
42 | |
43 | /* | |
44 | * Get the name pattern of a user tracepoint event rule. | |
45 | * | |
46 | * The caller does not assume the ownership of the returned pattern. The | |
47 | * pattern shall only only be used for the duration of the event rule's | |
48 | * lifetime, or before a different pattern is set. | |
49 | * | |
50 | * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's pattern | |
51 | * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid | |
52 | * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern | |
53 | * was not set prior to this call. | |
54 | */ | |
28f23191 JG |
55 | LTTNG_EXPORT extern enum lttng_event_rule_status |
56 | lttng_event_rule_user_tracepoint_get_name_pattern(const struct lttng_event_rule *rule, | |
57 | const char **pattern); | |
0a23a07d JR |
58 | |
59 | /* | |
60 | * Set the filter expression of a user tracepoint event rule. | |
61 | * | |
62 | * The expression is copied internally. | |
63 | * | |
64 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
65 | * if invalid parameters are passed. | |
66 | */ | |
28f23191 JG |
67 | LTTNG_EXPORT extern enum lttng_event_rule_status |
68 | lttng_event_rule_user_tracepoint_set_filter(struct lttng_event_rule *rule, const char *expression); | |
0a23a07d JR |
69 | |
70 | /* | |
71 | * Get the filter expression of a user tracepoint event rule. | |
72 | * | |
73 | * The caller does not assume the ownership of the returned filter expression. | |
74 | * The filter expression shall only only be used for the duration of the event | |
75 | * rule's lifetime, or before a different filter expression is set. | |
76 | * | |
77 | * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter | |
78 | * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid | |
79 | * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression | |
80 | * was not set prior to this call. | |
81 | */ | |
28f23191 JG |
82 | LTTNG_EXPORT extern enum lttng_event_rule_status |
83 | lttng_event_rule_user_tracepoint_get_filter(const struct lttng_event_rule *rule, | |
84 | const char **expression); | |
0a23a07d JR |
85 | |
86 | /* | |
87 | * Set the log level rule of a user tracepoint event rule. | |
88 | * | |
89 | * The log level rule is copied internally. | |
90 | * | |
91 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
92 | * if invalid parameters are passed. | |
93 | */ | |
4bd69c5f | 94 | LTTNG_EXPORT extern enum lttng_event_rule_status |
28f23191 JG |
95 | lttng_event_rule_user_tracepoint_set_log_level_rule( |
96 | struct lttng_event_rule *rule, const struct lttng_log_level_rule *log_level_rule); | |
0a23a07d JR |
97 | |
98 | /* | |
99 | * Get the log level rule of a user tracepoint event rule. | |
100 | * | |
101 | * The caller does not assume the ownership of the returned log level rule. The | |
102 | * log level rule shall only only be used for the duration of the event rule's | |
103 | * lifetime, or before a different log level rule is set. | |
104 | * | |
105 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the log level rule output | |
106 | * parameter on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter | |
107 | * is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a log level rule was not set prior | |
108 | * to this call. | |
109 | */ | |
4bd69c5f | 110 | LTTNG_EXPORT extern enum lttng_event_rule_status |
0a23a07d | 111 | lttng_event_rule_user_tracepoint_get_log_level_rule( |
28f23191 | 112 | const struct lttng_event_rule *rule, const struct lttng_log_level_rule **log_level_rule); |
0a23a07d JR |
113 | |
114 | /* | |
115 | * Add a name pattern exclusion to the set of name pattern exclusion of an event rule. | |
116 | * | |
117 | * The passed exclusion will be copied to the event_rule. | |
118 | * | |
119 | * Returns LTTNG_EVENT_RULE_STATUS_OK on success, | |
120 | * LTTNG_EVENT_RULE_STATUS_INVALID if invalid parameters are passed. | |
121 | */ | |
28f23191 JG |
122 | LTTNG_EXPORT extern enum lttng_event_rule_status |
123 | lttng_event_rule_user_tracepoint_add_name_pattern_exclusion(struct lttng_event_rule *rule, | |
124 | const char *exclusion); | |
0a23a07d JR |
125 | |
126 | /* | |
127 | * Get the name pattern exclusions property count of an event rule. | |
128 | * | |
129 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the count output parameter | |
130 | * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is | |
131 | * passed. | |
132 | */ | |
4bd69c5f | 133 | LTTNG_EXPORT extern enum lttng_event_rule_status |
0a23a07d | 134 | lttng_event_rule_user_tracepoint_get_name_pattern_exclusion_count( |
28f23191 | 135 | const struct lttng_event_rule *rule, unsigned int *count); |
0a23a07d JR |
136 | |
137 | /* | |
138 | * Get the pattern name exclusion at the given index. | |
139 | * | |
140 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the exclusion output parameter | |
141 | * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is | |
142 | * passed. | |
143 | */ | |
4bd69c5f | 144 | LTTNG_EXPORT extern enum lttng_event_rule_status |
0a23a07d | 145 | lttng_event_rule_user_tracepoint_get_name_pattern_exclusion_at_index( |
28f23191 | 146 | const struct lttng_event_rule *rule, unsigned int index, const char **exclusion); |
0a23a07d JR |
147 | |
148 | #ifdef __cplusplus | |
149 | } | |
150 | #endif | |
151 | ||
152 | #endif /* LTTNG_EVENT_RULE_USER_TRACEPOINT_H */ |