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/tracepoint-internal.h>
20 #include <lttng/event-rule/kernel-tracepoint-internal.h>
21 #include <lttng/event-rule/kernel-uprobe-internal.h>
22 #include <lttng/event-rule/user-tracepoint-internal.h>
25 enum lttng_event_rule_type
lttng_event_rule_get_type(
26 const struct lttng_event_rule
*event_rule
)
28 return event_rule
? event_rule
->type
: LTTNG_EVENT_RULE_TYPE_UNKNOWN
;
32 enum lttng_domain_type
lttng_event_rule_get_domain_type(
33 const struct lttng_event_rule
*event_rule
)
35 enum lttng_domain_type domain_type
= LTTNG_DOMAIN_NONE
;
37 switch (lttng_event_rule_get_type(event_rule
)) {
38 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
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
);
45 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
46 domain_type
= LTTNG_DOMAIN_UST
;
48 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
49 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
50 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
51 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
52 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
53 domain_type
= LTTNG_DOMAIN_KERNEL
;
55 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
56 domain_type
= LTTNG_DOMAIN_NONE
;
63 static void lttng_event_rule_release(struct urcu_ref
*ref
)
65 struct lttng_event_rule
*event_rule
=
66 container_of(ref
, typeof(*event_rule
), ref
);
68 assert(event_rule
->destroy
);
69 event_rule
->destroy(event_rule
);
72 void lttng_event_rule_destroy(struct lttng_event_rule
*event_rule
)
74 lttng_event_rule_put(event_rule
);
78 bool lttng_event_rule_validate(const struct lttng_event_rule
*event_rule
)
87 if (!event_rule
->validate
) {
88 /* Sub-class guarantees that it can never be invalid. */
93 valid
= event_rule
->validate(event_rule
);
99 int lttng_event_rule_serialize(const struct lttng_event_rule
*event_rule
,
100 struct lttng_payload
*payload
)
103 struct lttng_event_rule_comm event_rule_comm
= {};
110 event_rule_comm
.event_rule_type
= (int8_t) event_rule
->type
;
112 ret
= lttng_dynamic_buffer_append(
113 &payload
->buffer
, &event_rule_comm
, sizeof(event_rule_comm
));
118 ret
= event_rule
->serialize(event_rule
, payload
);
127 bool lttng_event_rule_is_equal(const struct lttng_event_rule
*a
,
128 const struct lttng_event_rule
*b
)
130 bool is_equal
= false;
136 if (a
->type
!= b
->type
) {
145 is_equal
= a
->equal
? a
->equal(a
, b
) : true;
151 ssize_t
lttng_event_rule_create_from_payload(
152 struct lttng_payload_view
*view
,
153 struct lttng_event_rule
**event_rule
)
155 ssize_t ret
, consumed
= 0;
156 event_rule_create_from_payload_cb create_from_payload
= NULL
;
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
));
162 if (!view
|| !event_rule
) {
167 if (!lttng_payload_view_is_valid(&event_rule_comm_view
)) {
172 DBG("Deserializing event_rule from payload");
173 event_rule_comm
= (const struct lttng_event_rule_comm
*) event_rule_comm_view
.buffer
.data
;
174 consumed
+= sizeof(*event_rule_comm
);
176 switch ((enum lttng_event_rule_type
) event_rule_comm
->event_rule_type
) {
177 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
178 create_from_payload
=
179 lttng_event_rule_tracepoint_create_from_payload
;
181 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
182 create_from_payload
= lttng_event_rule_kernel_kprobe_create_from_payload
;
184 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
187 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
188 create_from_payload
= lttng_event_rule_kernel_uprobe_create_from_payload
;
190 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
191 create_from_payload
=
192 lttng_event_rule_kernel_syscall_create_from_payload
;
194 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
195 create_from_payload
=
196 lttng_event_rule_kernel_tracepoint_create_from_payload
;
198 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
199 create_from_payload
=
200 lttng_event_rule_user_tracepoint_create_from_payload
;
203 ERR("Attempted to create event rule of unknown type (%i)",
204 (int) event_rule_comm
->event_rule_type
);
209 assert(create_from_payload
);
212 struct lttng_payload_view child_view
=
213 lttng_payload_view_from_view(
216 ret
= create_from_payload(&child_view
, event_rule
);
224 if (!lttng_event_rule_validate(*event_rule
)) {
235 void lttng_event_rule_init(struct lttng_event_rule
*event_rule
,
236 enum lttng_event_rule_type type
)
238 urcu_ref_init(&event_rule
->ref
);
239 event_rule
->type
= type
;
243 bool lttng_event_rule_get(struct lttng_event_rule
*event_rule
)
245 return urcu_ref_get_unless_zero(&event_rule
->ref
);
249 void lttng_event_rule_put(struct lttng_event_rule
*event_rule
)
255 assert(event_rule
->ref
.refcount
);
256 urcu_ref_put(&event_rule
->ref
, lttng_event_rule_release
);
260 enum lttng_error_code
lttng_event_rule_generate_filter_bytecode(
261 struct lttng_event_rule
*rule
,
262 const struct lttng_credentials
*creds
)
264 assert(rule
->generate_filter_bytecode
);
265 return rule
->generate_filter_bytecode(rule
, creds
);
269 const char *lttng_event_rule_get_filter(const struct lttng_event_rule
*rule
)
271 assert(rule
->get_filter
);
272 return rule
->get_filter(rule
);
276 const struct lttng_bytecode
*lttng_event_rule_get_filter_bytecode(
277 const struct lttng_event_rule
*rule
)
279 assert(rule
->get_filter_bytecode
);
280 return rule
->get_filter_bytecode(rule
);
284 enum lttng_event_rule_generate_exclusions_status
285 lttng_event_rule_generate_exclusions(const struct lttng_event_rule
*rule
,
286 struct lttng_event_exclusion
**exclusions
)
288 assert(rule
->generate_exclusions
);
289 return rule
->generate_exclusions(rule
, exclusions
);
293 struct lttng_event
*lttng_event_rule_generate_lttng_event(
294 const struct lttng_event_rule
*rule
)
296 assert(rule
->generate_lttng_event
);
297 return rule
->generate_lttng_event(rule
);
301 bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule
*rule
)
303 bool targets_agent_domain
= false;
304 enum lttng_domain_type type
= lttng_event_rule_get_domain_type(rule
);
307 case LTTNG_DOMAIN_JUL
:
308 case LTTNG_DOMAIN_LOG4J
:
309 case LTTNG_DOMAIN_PYTHON
:
310 targets_agent_domain
= true;
312 case LTTNG_DOMAIN_UST
:
313 case LTTNG_DOMAIN_KERNEL
:
314 targets_agent_domain
= false;
320 return targets_agent_domain
;
323 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type
)
326 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
328 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
330 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
331 return "kernel syscall";
332 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
333 return "kernel kprobe";
334 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
336 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
337 return "kernel uprobe";
338 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
339 return "kernel tracepoint";
340 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
341 return "user tracepoint";
348 unsigned long lttng_event_rule_hash(const struct lttng_event_rule
*rule
)
351 return rule
->hash(rule
);