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-function-internal.h>
18 #include <lttng/event-rule/kernel-probe-internal.h>
19 #include <lttng/event-rule/syscall-internal.h>
20 #include <lttng/event-rule/tracepoint-internal.h>
21 #include <lttng/event-rule/userspace-probe-internal.h>
24 enum lttng_event_rule_type
lttng_event_rule_get_type(
25 const struct lttng_event_rule
*event_rule
)
27 return event_rule
? event_rule
->type
: LTTNG_EVENT_RULE_TYPE_UNKNOWN
;
31 enum lttng_domain_type
lttng_event_rule_get_domain_type(
32 const struct lttng_event_rule
*event_rule
)
34 enum lttng_domain_type domain_type
= LTTNG_DOMAIN_NONE
;
36 switch (lttng_event_rule_get_type(event_rule
)) {
37 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
39 enum lttng_event_rule_status status
;
40 status
= lttng_event_rule_tracepoint_get_domain_type(event_rule
, &domain_type
);
41 assert(status
== LTTNG_EVENT_RULE_STATUS_OK
);
44 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
45 case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE
:
46 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
47 case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE
:
48 domain_type
= LTTNG_DOMAIN_KERNEL
;
50 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
51 domain_type
= LTTNG_DOMAIN_NONE
;
58 static void lttng_event_rule_release(struct urcu_ref
*ref
)
60 struct lttng_event_rule
*event_rule
=
61 container_of(ref
, typeof(*event_rule
), ref
);
63 assert(event_rule
->destroy
);
64 event_rule
->destroy(event_rule
);
67 void lttng_event_rule_destroy(struct lttng_event_rule
*event_rule
)
69 lttng_event_rule_put(event_rule
);
73 bool lttng_event_rule_validate(const struct lttng_event_rule
*event_rule
)
82 if (!event_rule
->validate
) {
83 /* Sub-class guarantees that it can never be invalid. */
88 valid
= event_rule
->validate(event_rule
);
94 int lttng_event_rule_serialize(const struct lttng_event_rule
*event_rule
,
95 struct lttng_payload
*payload
)
98 struct lttng_event_rule_comm event_rule_comm
= {};
105 event_rule_comm
.event_rule_type
= (int8_t) event_rule
->type
;
107 ret
= lttng_dynamic_buffer_append(
108 &payload
->buffer
, &event_rule_comm
, sizeof(event_rule_comm
));
113 ret
= event_rule
->serialize(event_rule
, payload
);
122 bool lttng_event_rule_is_equal(const struct lttng_event_rule
*a
,
123 const struct lttng_event_rule
*b
)
125 bool is_equal
= false;
131 if (a
->type
!= b
->type
) {
140 is_equal
= a
->equal
? a
->equal(a
, b
) : true;
146 ssize_t
lttng_event_rule_create_from_payload(
147 struct lttng_payload_view
*view
,
148 struct lttng_event_rule
**event_rule
)
150 ssize_t ret
, consumed
= 0;
151 event_rule_create_from_payload_cb create_from_payload
= NULL
;
152 const struct lttng_event_rule_comm
*event_rule_comm
;
153 const struct lttng_payload_view event_rule_comm_view
=
154 lttng_payload_view_from_view(
155 view
, 0, sizeof(*event_rule_comm
));
157 if (!view
|| !event_rule
) {
162 if (!lttng_payload_view_is_valid(&event_rule_comm_view
)) {
167 DBG("Deserializing event_rule from payload");
168 event_rule_comm
= (const struct lttng_event_rule_comm
*) event_rule_comm_view
.buffer
.data
;
169 consumed
+= sizeof(*event_rule_comm
);
171 switch ((enum lttng_event_rule_type
) event_rule_comm
->event_rule_type
) {
172 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
173 create_from_payload
=
174 lttng_event_rule_tracepoint_create_from_payload
;
176 case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE
:
177 create_from_payload
= lttng_event_rule_kernel_probe_create_from_payload
;
179 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
180 create_from_payload
= lttng_event_rule_kernel_function_create_from_payload
;
182 case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE
:
183 create_from_payload
= lttng_event_rule_userspace_probe_create_from_payload
;
185 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
186 create_from_payload
=
187 lttng_event_rule_syscall_create_from_payload
;
190 ERR("Attempted to create event rule of unknown type (%i)",
191 (int) event_rule_comm
->event_rule_type
);
196 assert(create_from_payload
);
199 struct lttng_payload_view child_view
=
200 lttng_payload_view_from_view(
203 ret
= create_from_payload(&child_view
, event_rule
);
211 if (!lttng_event_rule_validate(*event_rule
)) {
222 void lttng_event_rule_init(struct lttng_event_rule
*event_rule
,
223 enum lttng_event_rule_type type
)
225 urcu_ref_init(&event_rule
->ref
);
226 event_rule
->type
= type
;
230 bool lttng_event_rule_get(struct lttng_event_rule
*event_rule
)
232 return urcu_ref_get_unless_zero(&event_rule
->ref
);
236 void lttng_event_rule_put(struct lttng_event_rule
*event_rule
)
242 assert(event_rule
->ref
.refcount
);
243 urcu_ref_put(&event_rule
->ref
, lttng_event_rule_release
);
247 enum lttng_error_code
lttng_event_rule_generate_filter_bytecode(
248 struct lttng_event_rule
*rule
,
249 const struct lttng_credentials
*creds
)
251 assert(rule
->generate_filter_bytecode
);
252 return rule
->generate_filter_bytecode(rule
, creds
);
256 const char *lttng_event_rule_get_filter(const struct lttng_event_rule
*rule
)
258 assert(rule
->get_filter
);
259 return rule
->get_filter(rule
);
263 const struct lttng_bytecode
*lttng_event_rule_get_filter_bytecode(
264 const struct lttng_event_rule
*rule
)
266 assert(rule
->get_filter_bytecode
);
267 return rule
->get_filter_bytecode(rule
);
271 enum lttng_event_rule_generate_exclusions_status
272 lttng_event_rule_generate_exclusions(const struct lttng_event_rule
*rule
,
273 struct lttng_event_exclusion
**exclusions
)
275 assert(rule
->generate_exclusions
);
276 return rule
->generate_exclusions(rule
, exclusions
);
280 struct lttng_event
*lttng_event_rule_generate_lttng_event(
281 const struct lttng_event_rule
*rule
)
283 assert(rule
->generate_lttng_event
);
284 return rule
->generate_lttng_event(rule
);
288 bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule
*rule
)
290 bool targets_agent_domain
= false;
291 enum lttng_domain_type type
= lttng_event_rule_get_domain_type(rule
);
294 case LTTNG_DOMAIN_JUL
:
295 case LTTNG_DOMAIN_LOG4J
:
296 case LTTNG_DOMAIN_PYTHON
:
297 targets_agent_domain
= true;
299 case LTTNG_DOMAIN_UST
:
300 case LTTNG_DOMAIN_KERNEL
:
301 targets_agent_domain
= false;
307 return targets_agent_domain
;
310 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type
)
313 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
315 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
317 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
319 case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE
:
321 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
323 case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE
:
324 return "userspace-probe";
331 unsigned long lttng_event_rule_hash(const struct lttng_event_rule
*rule
)
334 return rule
->hash(rule
);