2 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #include <common/credentials.hpp>
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 <common/runas.hpp>
17 #include <common/string-utils/string-utils.hpp>
19 #include <lttng/event-rule/event-rule-internal.hpp>
20 #include <lttng/event-rule/kernel-syscall-internal.hpp>
22 #define IS_SYSCALL_EVENT_RULE(rule) \
23 (lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL)
25 static void lttng_event_rule_kernel_syscall_destroy(struct lttng_event_rule
*rule
)
27 struct lttng_event_rule_kernel_syscall
*syscall
;
29 if (rule
== nullptr) {
33 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
35 free(syscall
->pattern
);
36 free(syscall
->filter_expression
);
37 free(syscall
->internal_filter
.filter
);
38 free(syscall
->internal_filter
.bytecode
);
42 static bool lttng_event_rule_kernel_syscall_validate(const struct lttng_event_rule
*rule
)
45 struct lttng_event_rule_kernel_syscall
*syscall
;
51 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
54 if (!syscall
->pattern
) {
55 ERR("Invalid syscall event rule: a pattern must be set.");
64 static int lttng_event_rule_kernel_syscall_serialize(const struct lttng_event_rule
*rule
,
65 struct lttng_payload
*payload
)
68 size_t pattern_len
, filter_expression_len
;
69 struct lttng_event_rule_kernel_syscall
*syscall
;
70 struct lttng_event_rule_kernel_syscall_comm syscall_comm
;
72 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
)) {
77 DBG("Serializing syscall event rule");
78 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
80 pattern_len
= strlen(syscall
->pattern
) + 1;
82 if (syscall
->filter_expression
!= nullptr) {
83 filter_expression_len
= strlen(syscall
->filter_expression
) + 1;
85 filter_expression_len
= 0;
88 syscall_comm
.pattern_len
= pattern_len
;
89 syscall_comm
.filter_expression_len
= filter_expression_len
;
90 syscall_comm
.emission_site
= syscall
->emission_site
;
92 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, &syscall_comm
, sizeof(syscall_comm
));
97 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, syscall
->pattern
, pattern_len
);
102 ret
= lttng_dynamic_buffer_append(
103 &payload
->buffer
, syscall
->filter_expression
, filter_expression_len
);
108 static bool lttng_event_rule_kernel_syscall_is_equal(const struct lttng_event_rule
*_a
,
109 const struct lttng_event_rule
*_b
)
111 bool is_equal
= false;
112 struct lttng_event_rule_kernel_syscall
*a
, *b
;
114 a
= lttng::utils::container_of(_a
, <tng_event_rule_kernel_syscall::parent
);
115 b
= lttng::utils::container_of(_b
, <tng_event_rule_kernel_syscall::parent
);
117 if (!!a
->filter_expression
!= !!b
->filter_expression
) {
121 LTTNG_ASSERT(a
->pattern
);
122 LTTNG_ASSERT(b
->pattern
);
123 if (strcmp(a
->pattern
, b
->pattern
) != 0) {
127 if (a
->filter_expression
&& b
->filter_expression
) {
128 if (strcmp(a
->filter_expression
, b
->filter_expression
) != 0) {
131 } else if (!!a
->filter_expression
!= !!b
->filter_expression
) {
132 /* One is set and not the other. */
141 static enum lttng_error_code
142 lttng_event_rule_kernel_syscall_generate_filter_bytecode(struct lttng_event_rule
*rule
,
143 const struct lttng_credentials
*creds
)
146 enum lttng_error_code ret_code
= LTTNG_OK
;
147 struct lttng_event_rule_kernel_syscall
*syscall
;
148 enum lttng_event_rule_status status
;
150 struct lttng_bytecode
*bytecode
= nullptr;
154 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
156 /* Generate the filter bytecode. */
157 status
= lttng_event_rule_kernel_syscall_get_filter(rule
, &filter
);
158 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
160 } else if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
161 ret_code
= LTTNG_ERR_FILTER_INVAL
;
165 if (filter
&& filter
[0] == '\0') {
166 ret_code
= LTTNG_ERR_FILTER_INVAL
;
170 if (filter
== nullptr) {
176 syscall
->internal_filter
.filter
= strdup(filter
);
177 if (syscall
->internal_filter
.filter
== nullptr) {
178 ret_code
= LTTNG_ERR_NOMEM
;
182 ret
= run_as_generate_filter_bytecode(syscall
->internal_filter
.filter
, creds
, &bytecode
);
184 ret_code
= LTTNG_ERR_FILTER_INVAL
;
187 syscall
->internal_filter
.bytecode
= bytecode
;
196 lttng_event_rule_kernel_syscall_get_internal_filter(const struct lttng_event_rule
*rule
)
198 struct lttng_event_rule_kernel_syscall
*syscall
;
201 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
203 return syscall
->internal_filter
.filter
;
206 static const struct lttng_bytecode
*
207 lttng_event_rule_kernel_syscall_get_internal_filter_bytecode(const struct lttng_event_rule
*rule
)
209 struct lttng_event_rule_kernel_syscall
*syscall
;
212 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
214 return syscall
->internal_filter
.bytecode
;
217 static enum lttng_event_rule_generate_exclusions_status
218 lttng_event_rule_kernel_syscall_generate_exclusions(const struct lttng_event_rule
*rule
219 __attribute__((unused
)),
220 struct lttng_event_exclusion
**exclusions
)
223 *exclusions
= nullptr;
224 return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
;
227 static unsigned long lttng_event_rule_kernel_syscall_hash(const struct lttng_event_rule
*rule
)
230 struct lttng_event_rule_kernel_syscall
*syscall_rule
=
231 lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
233 hash
= hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
, lttng_ht_seed
);
234 hash
^= hash_key_str(syscall_rule
->pattern
, lttng_ht_seed
);
235 if (syscall_rule
->filter_expression
) {
236 hash
^= hash_key_str(syscall_rule
->filter_expression
, lttng_ht_seed
);
242 static enum lttng_error_code
243 lttng_event_rule_kernel_syscall_mi_serialize(const struct lttng_event_rule
*rule
,
244 struct mi_writer
*writer
)
247 enum lttng_error_code ret_code
;
248 enum lttng_event_rule_status status
;
250 enum lttng_event_rule_kernel_syscall_emission_site site_type
;
251 const char *filter
= nullptr;
252 const char *name_pattern
= nullptr;
253 const char *site_type_str
= nullptr;
256 LTTNG_ASSERT(writer
);
257 LTTNG_ASSERT(IS_SYSCALL_EVENT_RULE(rule
));
259 status
= lttng_event_rule_kernel_syscall_get_name_pattern(rule
, &name_pattern
);
260 LTTNG_ASSERT(status
== LTTNG_EVENT_RULE_STATUS_OK
);
261 LTTNG_ASSERT(name_pattern
);
263 status
= lttng_event_rule_kernel_syscall_get_filter(rule
, &filter
);
264 LTTNG_ASSERT(status
== LTTNG_EVENT_RULE_STATUS_OK
||
265 status
== LTTNG_EVENT_RULE_STATUS_UNSET
);
267 site_type
= lttng_event_rule_kernel_syscall_get_emission_site(rule
);
270 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT
:
271 site_type_str
= mi_lttng_event_rule_kernel_syscall_emission_site_entry_exit
;
273 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY
:
274 site_type_str
= mi_lttng_event_rule_kernel_syscall_emission_site_entry
;
276 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT
:
277 site_type_str
= mi_lttng_event_rule_kernel_syscall_emission_site_exit
;
284 /* Open event rule kernel syscall element. */
285 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_rule_kernel_syscall
);
291 ret
= mi_lttng_writer_write_element_string(
292 writer
, mi_lttng_element_event_rule_kernel_syscall_emission_site
, site_type_str
);
298 ret
= mi_lttng_writer_write_element_string(
299 writer
, mi_lttng_element_event_rule_name_pattern
, name_pattern
);
305 if (filter
!= nullptr) {
306 ret
= mi_lttng_writer_write_element_string(
307 writer
, mi_lttng_element_event_rule_filter_expression
, filter
);
313 /* Close event rule kernel syscall. */
314 ret
= mi_lttng_writer_close_element(writer
);
323 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
328 struct lttng_event_rule
*lttng_event_rule_kernel_syscall_create(
329 enum lttng_event_rule_kernel_syscall_emission_site emission_site
)
331 struct lttng_event_rule
*rule
= nullptr;
332 struct lttng_event_rule_kernel_syscall
*syscall_rule
;
333 enum lttng_event_rule_status status
;
335 /* Validate the emission site type */
336 switch (emission_site
) {
337 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT
:
338 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY
:
339 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT
:
342 /* Invalid emission type */
346 syscall_rule
= zmalloc
<lttng_event_rule_kernel_syscall
>();
351 rule
= &syscall_rule
->parent
;
352 lttng_event_rule_init(&syscall_rule
->parent
, LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
);
353 syscall_rule
->parent
.validate
= lttng_event_rule_kernel_syscall_validate
;
354 syscall_rule
->parent
.serialize
= lttng_event_rule_kernel_syscall_serialize
;
355 syscall_rule
->parent
.equal
= lttng_event_rule_kernel_syscall_is_equal
;
356 syscall_rule
->parent
.destroy
= lttng_event_rule_kernel_syscall_destroy
;
357 syscall_rule
->parent
.generate_filter_bytecode
=
358 lttng_event_rule_kernel_syscall_generate_filter_bytecode
;
359 syscall_rule
->parent
.get_filter
= lttng_event_rule_kernel_syscall_get_internal_filter
;
360 syscall_rule
->parent
.get_filter_bytecode
=
361 lttng_event_rule_kernel_syscall_get_internal_filter_bytecode
;
362 syscall_rule
->parent
.generate_exclusions
=
363 lttng_event_rule_kernel_syscall_generate_exclusions
;
364 syscall_rule
->parent
.hash
= lttng_event_rule_kernel_syscall_hash
;
365 syscall_rule
->parent
.mi_serialize
= lttng_event_rule_kernel_syscall_mi_serialize
;
367 /* Default pattern is '*'. */
368 status
= lttng_event_rule_kernel_syscall_set_name_pattern(rule
, "*");
369 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
370 lttng_event_rule_destroy(rule
);
374 /* Emission site type */
375 syscall_rule
->emission_site
= emission_site
;
381 ssize_t
lttng_event_rule_kernel_syscall_create_from_payload(struct lttng_payload_view
*view
,
382 struct lttng_event_rule
**_event_rule
)
384 ssize_t ret
, offset
= 0;
385 enum lttng_event_rule_status status
;
386 const struct lttng_event_rule_kernel_syscall_comm
*syscall_comm
;
388 const char *filter_expression
= nullptr;
389 struct lttng_buffer_view current_buffer_view
;
390 struct lttng_event_rule
*rule
= nullptr;
397 if (view
->buffer
.size
< sizeof(*syscall_comm
)) {
398 ERR("Failed to initialize from malformed event rule syscall: buffer too short to contain header");
403 current_buffer_view
=
404 lttng_buffer_view_from_view(&view
->buffer
, offset
, sizeof(*syscall_comm
));
405 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
410 syscall_comm
= (typeof(syscall_comm
)) current_buffer_view
.data
;
411 rule
= lttng_event_rule_kernel_syscall_create(
412 (lttng_event_rule_kernel_syscall_emission_site
) syscall_comm
->emission_site
);
414 ERR("Failed to create event rule syscall");
419 /* Skip to payload. */
420 offset
+= current_buffer_view
.size
;
422 /* Map the pattern. */
423 current_buffer_view
=
424 lttng_buffer_view_from_view(&view
->buffer
, offset
, syscall_comm
->pattern_len
);
425 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
430 pattern
= current_buffer_view
.data
;
431 if (!lttng_buffer_view_contains_string(
432 ¤t_buffer_view
, pattern
, syscall_comm
->pattern_len
)) {
437 /* Skip after the pattern. */
438 offset
+= syscall_comm
->pattern_len
;
440 if (!syscall_comm
->filter_expression_len
) {
441 goto skip_filter_expression
;
444 /* Map the filter_expression. */
445 current_buffer_view
= lttng_buffer_view_from_view(
446 &view
->buffer
, offset
, syscall_comm
->filter_expression_len
);
447 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
452 filter_expression
= current_buffer_view
.data
;
453 if (!lttng_buffer_view_contains_string(
454 ¤t_buffer_view
, filter_expression
, syscall_comm
->filter_expression_len
)) {
459 /* Skip after the pattern. */
460 offset
+= syscall_comm
->filter_expression_len
;
462 skip_filter_expression
:
464 status
= lttng_event_rule_kernel_syscall_set_name_pattern(rule
, pattern
);
465 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
466 ERR("Failed to set event rule syscall pattern");
471 if (filter_expression
) {
472 status
= lttng_event_rule_kernel_syscall_set_filter(rule
, filter_expression
);
473 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
474 ERR("Failed to set event rule syscall pattern");
484 lttng_event_rule_destroy(rule
);
488 enum lttng_event_rule_status
489 lttng_event_rule_kernel_syscall_set_name_pattern(struct lttng_event_rule
*rule
, const char *pattern
)
491 char *pattern_copy
= nullptr;
492 struct lttng_event_rule_kernel_syscall
*syscall
;
493 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
495 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !pattern
|| strlen(pattern
) == 0) {
496 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
500 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
501 pattern_copy
= strdup(pattern
);
503 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
507 strutils_normalize_star_glob_pattern(pattern_copy
);
509 free(syscall
->pattern
);
511 syscall
->pattern
= pattern_copy
;
512 pattern_copy
= nullptr;
517 enum lttng_event_rule_status
518 lttng_event_rule_kernel_syscall_get_name_pattern(const struct lttng_event_rule
*rule
,
519 const char **pattern
)
521 struct lttng_event_rule_kernel_syscall
*syscall
;
522 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
524 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !pattern
) {
525 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
529 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
530 if (!syscall
->pattern
) {
531 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
535 *pattern
= syscall
->pattern
;
540 enum lttng_event_rule_status
541 lttng_event_rule_kernel_syscall_set_filter(struct lttng_event_rule
*rule
, const char *expression
)
543 char *expression_copy
= nullptr;
544 struct lttng_event_rule_kernel_syscall
*syscall
;
545 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
547 /* TODO: validate that the passed expression is valid. */
549 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !expression
|| strlen(expression
) == 0) {
550 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
554 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
555 expression_copy
= strdup(expression
);
556 if (!expression_copy
) {
557 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
561 if (syscall
->filter_expression
) {
562 free(syscall
->filter_expression
);
565 syscall
->filter_expression
= expression_copy
;
566 expression_copy
= nullptr;
571 enum lttng_event_rule_status
572 lttng_event_rule_kernel_syscall_get_filter(const struct lttng_event_rule
*rule
,
573 const char **expression
)
575 struct lttng_event_rule_kernel_syscall
*syscall
;
576 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
578 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !expression
) {
579 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
583 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
584 if (!syscall
->filter_expression
) {
585 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
589 *expression
= syscall
->filter_expression
;
593 extern enum lttng_event_rule_kernel_syscall_emission_site
594 lttng_event_rule_kernel_syscall_get_emission_site(const struct lttng_event_rule
*rule
)
596 enum lttng_event_rule_kernel_syscall_emission_site emission_site
=
597 LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_UNKNOWN
;
598 struct lttng_event_rule_kernel_syscall
*syscall
;
600 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
)) {
604 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
605 emission_site
= syscall
->emission_site
;
608 return emission_site
;
611 const char *lttng_event_rule_kernel_syscall_emission_site_str(
612 enum lttng_event_rule_kernel_syscall_emission_site emission_site
)
614 switch (emission_site
) {
615 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY
:
617 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT
:
619 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT
: