2 * Copyright (C) 2019 Jonathan Rajotte
3 * <jonathan.rajotte-julien@efficios.com>
5 * SPDX-License-Identifier: LGPL-2.1-only
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/log4j-logging-internal.h>
20 #include <lttng/event-rule/jul-logging-internal.h>
21 #include <lttng/event-rule/tracepoint-internal.h>
22 #include <lttng/event-rule/kernel-tracepoint-internal.h>
23 #include <lttng/event-rule/kernel-uprobe-internal.h>
24 #include <lttng/event-rule/user-tracepoint-internal.h>
27 enum lttng_event_rule_type
lttng_event_rule_get_type(
28 const struct lttng_event_rule
*event_rule
)
30 return event_rule
? event_rule
->type
: LTTNG_EVENT_RULE_TYPE_UNKNOWN
;
34 enum lttng_domain_type
lttng_event_rule_get_domain_type(
35 const struct lttng_event_rule
*event_rule
)
37 enum lttng_domain_type domain_type
= LTTNG_DOMAIN_NONE
;
39 switch (lttng_event_rule_get_type(event_rule
)) {
40 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
42 enum lttng_event_rule_status status
;
43 status
= lttng_event_rule_tracepoint_get_domain_type(event_rule
, &domain_type
);
44 assert(status
== LTTNG_EVENT_RULE_STATUS_OK
);
47 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
48 domain_type
= LTTNG_DOMAIN_UST
;
50 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
51 domain_type
= LTTNG_DOMAIN_JUL
;
53 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
54 domain_type
= LTTNG_DOMAIN_LOG4J
;
56 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
57 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
58 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
59 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
60 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
61 domain_type
= LTTNG_DOMAIN_KERNEL
;
63 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
64 domain_type
= LTTNG_DOMAIN_NONE
;
71 static void lttng_event_rule_release(struct urcu_ref
*ref
)
73 struct lttng_event_rule
*event_rule
=
74 container_of(ref
, typeof(*event_rule
), ref
);
76 assert(event_rule
->destroy
);
77 event_rule
->destroy(event_rule
);
80 void lttng_event_rule_destroy(struct lttng_event_rule
*event_rule
)
82 lttng_event_rule_put(event_rule
);
86 bool lttng_event_rule_validate(const struct lttng_event_rule
*event_rule
)
95 if (!event_rule
->validate
) {
96 /* Sub-class guarantees that it can never be invalid. */
101 valid
= event_rule
->validate(event_rule
);
107 int lttng_event_rule_serialize(const struct lttng_event_rule
*event_rule
,
108 struct lttng_payload
*payload
)
111 struct lttng_event_rule_comm event_rule_comm
= {};
118 event_rule_comm
.event_rule_type
= (int8_t) event_rule
->type
;
120 ret
= lttng_dynamic_buffer_append(
121 &payload
->buffer
, &event_rule_comm
, sizeof(event_rule_comm
));
126 ret
= event_rule
->serialize(event_rule
, payload
);
135 bool lttng_event_rule_is_equal(const struct lttng_event_rule
*a
,
136 const struct lttng_event_rule
*b
)
138 bool is_equal
= false;
144 if (a
->type
!= b
->type
) {
153 is_equal
= a
->equal
? a
->equal(a
, b
) : true;
159 ssize_t
lttng_event_rule_create_from_payload(
160 struct lttng_payload_view
*view
,
161 struct lttng_event_rule
**event_rule
)
163 ssize_t ret
, consumed
= 0;
164 event_rule_create_from_payload_cb create_from_payload
= NULL
;
165 const struct lttng_event_rule_comm
*event_rule_comm
;
166 const struct lttng_payload_view event_rule_comm_view
=
167 lttng_payload_view_from_view(
168 view
, 0, sizeof(*event_rule_comm
));
170 if (!view
|| !event_rule
) {
175 if (!lttng_payload_view_is_valid(&event_rule_comm_view
)) {
180 DBG("Deserializing event_rule from payload");
181 event_rule_comm
= (const struct lttng_event_rule_comm
*) event_rule_comm_view
.buffer
.data
;
182 consumed
+= sizeof(*event_rule_comm
);
184 switch ((enum lttng_event_rule_type
) event_rule_comm
->event_rule_type
) {
185 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
186 create_from_payload
=
187 lttng_event_rule_tracepoint_create_from_payload
;
189 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
190 create_from_payload
= lttng_event_rule_kernel_kprobe_create_from_payload
;
192 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
195 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
196 create_from_payload
= lttng_event_rule_kernel_uprobe_create_from_payload
;
198 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
199 create_from_payload
=
200 lttng_event_rule_kernel_syscall_create_from_payload
;
202 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
203 create_from_payload
=
204 lttng_event_rule_kernel_tracepoint_create_from_payload
;
206 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
207 create_from_payload
=
208 lttng_event_rule_user_tracepoint_create_from_payload
;
210 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
211 create_from_payload
=
212 lttng_event_rule_jul_logging_create_from_payload
;
214 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
215 create_from_payload
=
216 lttng_event_rule_log4j_logging_create_from_payload
;
219 ERR("Attempted to create event rule of unknown type (%i)",
220 (int) event_rule_comm
->event_rule_type
);
225 assert(create_from_payload
);
228 struct lttng_payload_view child_view
=
229 lttng_payload_view_from_view(
232 ret
= create_from_payload(&child_view
, event_rule
);
240 if (!lttng_event_rule_validate(*event_rule
)) {
251 void lttng_event_rule_init(struct lttng_event_rule
*event_rule
,
252 enum lttng_event_rule_type type
)
254 urcu_ref_init(&event_rule
->ref
);
255 event_rule
->type
= type
;
259 bool lttng_event_rule_get(struct lttng_event_rule
*event_rule
)
261 return urcu_ref_get_unless_zero(&event_rule
->ref
);
265 void lttng_event_rule_put(struct lttng_event_rule
*event_rule
)
271 assert(event_rule
->ref
.refcount
);
272 urcu_ref_put(&event_rule
->ref
, lttng_event_rule_release
);
276 enum lttng_error_code
lttng_event_rule_generate_filter_bytecode(
277 struct lttng_event_rule
*rule
,
278 const struct lttng_credentials
*creds
)
280 assert(rule
->generate_filter_bytecode
);
281 return rule
->generate_filter_bytecode(rule
, creds
);
285 const char *lttng_event_rule_get_filter(const struct lttng_event_rule
*rule
)
287 assert(rule
->get_filter
);
288 return rule
->get_filter(rule
);
292 const struct lttng_bytecode
*lttng_event_rule_get_filter_bytecode(
293 const struct lttng_event_rule
*rule
)
295 assert(rule
->get_filter_bytecode
);
296 return rule
->get_filter_bytecode(rule
);
300 enum lttng_event_rule_generate_exclusions_status
301 lttng_event_rule_generate_exclusions(const struct lttng_event_rule
*rule
,
302 struct lttng_event_exclusion
**exclusions
)
304 assert(rule
->generate_exclusions
);
305 return rule
->generate_exclusions(rule
, exclusions
);
309 struct lttng_event
*lttng_event_rule_generate_lttng_event(
310 const struct lttng_event_rule
*rule
)
312 assert(rule
->generate_lttng_event
);
313 return rule
->generate_lttng_event(rule
);
317 bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule
*rule
)
319 bool targets_agent_domain
= false;
320 enum lttng_domain_type type
= lttng_event_rule_get_domain_type(rule
);
323 case LTTNG_DOMAIN_JUL
:
324 case LTTNG_DOMAIN_LOG4J
:
325 case LTTNG_DOMAIN_PYTHON
:
326 targets_agent_domain
= true;
328 case LTTNG_DOMAIN_UST
:
329 case LTTNG_DOMAIN_KERNEL
:
330 targets_agent_domain
= false;
336 return targets_agent_domain
;
339 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type
)
342 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
344 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
346 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
347 return "kernel syscall";
348 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
349 return "kernel kprobe";
350 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
352 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
353 return "kernel uprobe";
354 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
355 return "kernel tracepoint";
356 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
357 return "user tracepoint";
358 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
359 return "jul logging";
360 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
361 return "log4j logging";
368 unsigned long lttng_event_rule_hash(const struct lttng_event_rule
*rule
)
371 return rule
->hash(rule
);