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