2 * Copyright (C) 2019 Jonathan Rajotte
3 * <jonathan.rajotte-julien@efficios.com>
5 * SPDX-License-Identifier: LGPL-2.1-only
9 #include <common/error.hpp>
10 #include <common/hashtable/hashtable.hpp>
11 #include <common/hashtable/utils.hpp>
12 #include <common/macros.hpp>
13 #include <common/mi-lttng.hpp>
14 #include <common/payload-view.hpp>
15 #include <common/payload.hpp>
16 #include <lttng/event-rule/event-rule-internal.hpp>
17 #include <lttng/event-rule/jul-logging-internal.hpp>
18 #include <lttng/event-rule/kernel-kprobe-internal.hpp>
19 #include <lttng/event-rule/kernel-syscall-internal.hpp>
20 #include <lttng/event-rule/kernel-tracepoint-internal.hpp>
21 #include <lttng/event-rule/kernel-uprobe-internal.hpp>
22 #include <lttng/event-rule/log4j-logging-internal.hpp>
23 #include <lttng/event-rule/python-logging-internal.hpp>
24 #include <lttng/event-rule/user-tracepoint-internal.hpp>
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
;
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_USER_TRACEPOINT
:
40 domain_type
= LTTNG_DOMAIN_UST
;
42 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
43 domain_type
= LTTNG_DOMAIN_JUL
;
45 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
46 domain_type
= LTTNG_DOMAIN_LOG4J
;
48 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
49 domain_type
= LTTNG_DOMAIN_PYTHON
;
51 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
52 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
53 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
54 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
55 domain_type
= LTTNG_DOMAIN_KERNEL
;
57 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
58 domain_type
= LTTNG_DOMAIN_NONE
;
65 static void lttng_event_rule_release(struct urcu_ref
*ref
)
67 struct lttng_event_rule
*event_rule
=
68 container_of(ref
, typeof(*event_rule
), ref
);
70 LTTNG_ASSERT(event_rule
->destroy
);
71 event_rule
->destroy(event_rule
);
74 void lttng_event_rule_destroy(struct lttng_event_rule
*event_rule
)
76 lttng_event_rule_put(event_rule
);
79 bool lttng_event_rule_validate(const struct lttng_event_rule
*event_rule
)
88 if (!event_rule
->validate
) {
89 /* Sub-class guarantees that it can never be invalid. */
94 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
);
126 bool lttng_event_rule_is_equal(const struct lttng_event_rule
*a
,
127 const struct lttng_event_rule
*b
)
129 bool is_equal
= false;
135 if (a
->type
!= b
->type
) {
144 is_equal
= a
->equal
? a
->equal(a
, b
) : true;
149 ssize_t
lttng_event_rule_create_from_payload(
150 struct lttng_payload_view
*view
,
151 struct lttng_event_rule
**event_rule
)
153 ssize_t ret
, consumed
= 0;
154 event_rule_create_from_payload_cb create_from_payload
= NULL
;
155 const struct lttng_event_rule_comm
*event_rule_comm
;
156 const struct lttng_payload_view event_rule_comm_view
=
157 lttng_payload_view_from_view(
158 view
, 0, sizeof(*event_rule_comm
));
160 if (!view
|| !event_rule
) {
165 if (!lttng_payload_view_is_valid(&event_rule_comm_view
)) {
170 DBG("Deserializing event_rule from payload");
171 event_rule_comm
= (const struct lttng_event_rule_comm
*) event_rule_comm_view
.buffer
.data
;
172 consumed
+= sizeof(*event_rule_comm
);
174 switch ((enum lttng_event_rule_type
) event_rule_comm
->event_rule_type
) {
175 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
176 create_from_payload
= lttng_event_rule_kernel_kprobe_create_from_payload
;
178 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
179 create_from_payload
= lttng_event_rule_kernel_uprobe_create_from_payload
;
181 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
182 create_from_payload
=
183 lttng_event_rule_kernel_syscall_create_from_payload
;
185 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
186 create_from_payload
=
187 lttng_event_rule_kernel_tracepoint_create_from_payload
;
189 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
190 create_from_payload
=
191 lttng_event_rule_user_tracepoint_create_from_payload
;
193 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
194 create_from_payload
=
195 lttng_event_rule_jul_logging_create_from_payload
;
197 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
198 create_from_payload
=
199 lttng_event_rule_log4j_logging_create_from_payload
;
201 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
202 create_from_payload
=
203 lttng_event_rule_python_logging_create_from_payload
;
206 ERR("Attempted to create event rule of unknown type (%i)",
207 (int) event_rule_comm
->event_rule_type
);
212 LTTNG_ASSERT(create_from_payload
);
215 struct lttng_payload_view child_view
=
216 lttng_payload_view_from_view(
219 ret
= create_from_payload(&child_view
, event_rule
);
227 if (!lttng_event_rule_validate(*event_rule
)) {
237 void lttng_event_rule_init(struct lttng_event_rule
*event_rule
,
238 enum lttng_event_rule_type type
)
240 urcu_ref_init(&event_rule
->ref
);
241 event_rule
->type
= type
;
244 bool lttng_event_rule_get(struct lttng_event_rule
*event_rule
)
246 return urcu_ref_get_unless_zero(&event_rule
->ref
);
249 void lttng_event_rule_put(struct lttng_event_rule
*event_rule
)
255 LTTNG_ASSERT(event_rule
->ref
.refcount
);
256 urcu_ref_put(&event_rule
->ref
, lttng_event_rule_release
);
259 enum lttng_error_code
lttng_event_rule_generate_filter_bytecode(
260 struct lttng_event_rule
*rule
,
261 const struct lttng_credentials
*creds
)
263 LTTNG_ASSERT(rule
->generate_filter_bytecode
);
264 return rule
->generate_filter_bytecode(rule
, creds
);
267 const char *lttng_event_rule_get_filter(const struct lttng_event_rule
*rule
)
269 LTTNG_ASSERT(rule
->get_filter
);
270 return rule
->get_filter(rule
);
273 const struct lttng_bytecode
*lttng_event_rule_get_filter_bytecode(
274 const struct lttng_event_rule
*rule
)
276 LTTNG_ASSERT(rule
->get_filter_bytecode
);
277 return rule
->get_filter_bytecode(rule
);
280 enum lttng_event_rule_generate_exclusions_status
281 lttng_event_rule_generate_exclusions(const struct lttng_event_rule
*rule
,
282 struct lttng_event_exclusion
**exclusions
)
284 LTTNG_ASSERT(rule
->generate_exclusions
);
285 return rule
->generate_exclusions(rule
, exclusions
);
288 struct lttng_event
*lttng_event_rule_generate_lttng_event(
289 const struct lttng_event_rule
*rule
)
291 LTTNG_ASSERT(rule
->generate_lttng_event
);
292 return rule
->generate_lttng_event(rule
);
295 bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule
*rule
)
297 bool targets_agent_domain
= false;
298 enum lttng_domain_type type
= lttng_event_rule_get_domain_type(rule
);
301 case LTTNG_DOMAIN_JUL
:
302 case LTTNG_DOMAIN_LOG4J
:
303 case LTTNG_DOMAIN_PYTHON
:
304 targets_agent_domain
= true;
306 case LTTNG_DOMAIN_UST
:
307 case LTTNG_DOMAIN_KERNEL
:
308 targets_agent_domain
= false;
314 return targets_agent_domain
;
317 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type
)
320 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
322 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
323 return "kernel syscall";
324 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
325 return "kernel kprobe";
326 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
327 return "kernel uprobe";
328 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
329 return "kernel tracepoint";
330 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
331 return "user tracepoint";
332 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
333 return "jul logging";
334 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
335 return "log4j logging";
336 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
337 return "python logging";
344 unsigned long lttng_event_rule_hash(const struct lttng_event_rule
*rule
)
346 LTTNG_ASSERT(rule
->hash
);
347 return rule
->hash(rule
);
350 enum lttng_error_code
lttng_event_rule_mi_serialize(
351 const struct lttng_event_rule
*rule
, struct mi_writer
*writer
)
354 enum lttng_error_code ret_code
;
357 LTTNG_ASSERT(writer
);
358 LTTNG_ASSERT(rule
->mi_serialize
);
360 /* Open event rule element. */
361 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_rule
);
366 /* Serialize underlying event rule. */
367 ret_code
= rule
->mi_serialize(rule
, writer
);
368 if (ret_code
!= LTTNG_OK
) {
372 /* Close event rule element. */
373 ret
= mi_lttng_writer_close_element(writer
);
382 ret_code
= LTTNG_ERR_MI_IO_FAIL
;