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/jul-logging-internal.h>
20 #include <lttng/event-rule/tracepoint-internal.h>
21 #include <lttng/event-rule/kernel-tracepoint-internal.h>
22 #include <lttng/event-rule/kernel-uprobe-internal.h>
23 #include <lttng/event-rule/user-tracepoint-internal.h>
26 enum lttng_event_rule_type
lttng_event_rule_get_type(
27 const struct lttng_event_rule
*event_rule
)
29 return event_rule
? event_rule
->type
: LTTNG_EVENT_RULE_TYPE_UNKNOWN
;
33 enum lttng_domain_type
lttng_event_rule_get_domain_type(
34 const struct lttng_event_rule
*event_rule
)
36 enum lttng_domain_type domain_type
= LTTNG_DOMAIN_NONE
;
38 switch (lttng_event_rule_get_type(event_rule
)) {
39 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
41 enum lttng_event_rule_status status
;
42 status
= lttng_event_rule_tracepoint_get_domain_type(event_rule
, &domain_type
);
43 assert(status
== LTTNG_EVENT_RULE_STATUS_OK
);
46 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
47 domain_type
= LTTNG_DOMAIN_UST
;
49 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
50 domain_type
= LTTNG_DOMAIN_JUL
;
52 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
53 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
54 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
55 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
56 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
57 domain_type
= LTTNG_DOMAIN_KERNEL
;
59 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
60 domain_type
= LTTNG_DOMAIN_NONE
;
67 static void lttng_event_rule_release(struct urcu_ref
*ref
)
69 struct lttng_event_rule
*event_rule
=
70 container_of(ref
, typeof(*event_rule
), ref
);
72 assert(event_rule
->destroy
);
73 event_rule
->destroy(event_rule
);
76 void lttng_event_rule_destroy(struct lttng_event_rule
*event_rule
)
78 lttng_event_rule_put(event_rule
);
82 bool lttng_event_rule_validate(const struct lttng_event_rule
*event_rule
)
91 if (!event_rule
->validate
) {
92 /* Sub-class guarantees that it can never be invalid. */
97 valid
= event_rule
->validate(event_rule
);
103 int lttng_event_rule_serialize(const struct lttng_event_rule
*event_rule
,
104 struct lttng_payload
*payload
)
107 struct lttng_event_rule_comm event_rule_comm
= {};
114 event_rule_comm
.event_rule_type
= (int8_t) event_rule
->type
;
116 ret
= lttng_dynamic_buffer_append(
117 &payload
->buffer
, &event_rule_comm
, sizeof(event_rule_comm
));
122 ret
= event_rule
->serialize(event_rule
, payload
);
131 bool lttng_event_rule_is_equal(const struct lttng_event_rule
*a
,
132 const struct lttng_event_rule
*b
)
134 bool is_equal
= false;
140 if (a
->type
!= b
->type
) {
149 is_equal
= a
->equal
? a
->equal(a
, b
) : true;
155 ssize_t
lttng_event_rule_create_from_payload(
156 struct lttng_payload_view
*view
,
157 struct lttng_event_rule
**event_rule
)
159 ssize_t ret
, consumed
= 0;
160 event_rule_create_from_payload_cb create_from_payload
= NULL
;
161 const struct lttng_event_rule_comm
*event_rule_comm
;
162 const struct lttng_payload_view event_rule_comm_view
=
163 lttng_payload_view_from_view(
164 view
, 0, sizeof(*event_rule_comm
));
166 if (!view
|| !event_rule
) {
171 if (!lttng_payload_view_is_valid(&event_rule_comm_view
)) {
176 DBG("Deserializing event_rule from payload");
177 event_rule_comm
= (const struct lttng_event_rule_comm
*) event_rule_comm_view
.buffer
.data
;
178 consumed
+= sizeof(*event_rule_comm
);
180 switch ((enum lttng_event_rule_type
) event_rule_comm
->event_rule_type
) {
181 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
182 create_from_payload
=
183 lttng_event_rule_tracepoint_create_from_payload
;
185 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
186 create_from_payload
= lttng_event_rule_kernel_kprobe_create_from_payload
;
188 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
191 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
192 create_from_payload
= lttng_event_rule_kernel_uprobe_create_from_payload
;
194 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
195 create_from_payload
=
196 lttng_event_rule_kernel_syscall_create_from_payload
;
198 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
199 create_from_payload
=
200 lttng_event_rule_kernel_tracepoint_create_from_payload
;
202 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
203 create_from_payload
=
204 lttng_event_rule_user_tracepoint_create_from_payload
;
206 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
207 create_from_payload
=
208 lttng_event_rule_jul_logging_create_from_payload
;
211 ERR("Attempted to create event rule of unknown type (%i)",
212 (int) event_rule_comm
->event_rule_type
);
217 assert(create_from_payload
);
220 struct lttng_payload_view child_view
=
221 lttng_payload_view_from_view(
224 ret
= create_from_payload(&child_view
, event_rule
);
232 if (!lttng_event_rule_validate(*event_rule
)) {
243 void lttng_event_rule_init(struct lttng_event_rule
*event_rule
,
244 enum lttng_event_rule_type type
)
246 urcu_ref_init(&event_rule
->ref
);
247 event_rule
->type
= type
;
251 bool lttng_event_rule_get(struct lttng_event_rule
*event_rule
)
253 return urcu_ref_get_unless_zero(&event_rule
->ref
);
257 void lttng_event_rule_put(struct lttng_event_rule
*event_rule
)
263 assert(event_rule
->ref
.refcount
);
264 urcu_ref_put(&event_rule
->ref
, lttng_event_rule_release
);
268 enum lttng_error_code
lttng_event_rule_generate_filter_bytecode(
269 struct lttng_event_rule
*rule
,
270 const struct lttng_credentials
*creds
)
272 assert(rule
->generate_filter_bytecode
);
273 return rule
->generate_filter_bytecode(rule
, creds
);
277 const char *lttng_event_rule_get_filter(const struct lttng_event_rule
*rule
)
279 assert(rule
->get_filter
);
280 return rule
->get_filter(rule
);
284 const struct lttng_bytecode
*lttng_event_rule_get_filter_bytecode(
285 const struct lttng_event_rule
*rule
)
287 assert(rule
->get_filter_bytecode
);
288 return rule
->get_filter_bytecode(rule
);
292 enum lttng_event_rule_generate_exclusions_status
293 lttng_event_rule_generate_exclusions(const struct lttng_event_rule
*rule
,
294 struct lttng_event_exclusion
**exclusions
)
296 assert(rule
->generate_exclusions
);
297 return rule
->generate_exclusions(rule
, exclusions
);
301 struct lttng_event
*lttng_event_rule_generate_lttng_event(
302 const struct lttng_event_rule
*rule
)
304 assert(rule
->generate_lttng_event
);
305 return rule
->generate_lttng_event(rule
);
309 bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule
*rule
)
311 bool targets_agent_domain
= false;
312 enum lttng_domain_type type
= lttng_event_rule_get_domain_type(rule
);
315 case LTTNG_DOMAIN_JUL
:
316 case LTTNG_DOMAIN_LOG4J
:
317 case LTTNG_DOMAIN_PYTHON
:
318 targets_agent_domain
= true;
320 case LTTNG_DOMAIN_UST
:
321 case LTTNG_DOMAIN_KERNEL
:
322 targets_agent_domain
= false;
328 return targets_agent_domain
;
331 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type
)
334 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
336 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
338 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
339 return "kernel syscall";
340 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
341 return "kernel kprobe";
342 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
344 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
345 return "kernel uprobe";
346 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
347 return "kernel tracepoint";
348 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
349 return "user tracepoint";
350 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
351 return "jul logging";
358 unsigned long lttng_event_rule_hash(const struct lttng_event_rule
*rule
)
361 return rule
->hash(rule
);