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>
18 #include <lttng/event-rule/event-rule-internal.hpp>
19 #include <lttng/event-rule/kernel-syscall-internal.hpp>
21 #define IS_SYSCALL_EVENT_RULE(rule) \
22 (lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL)
24 static void lttng_event_rule_kernel_syscall_destroy(struct lttng_event_rule
*rule
)
26 struct lttng_event_rule_kernel_syscall
*syscall
;
32 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
34 free(syscall
->pattern
);
35 free(syscall
->filter_expression
);
36 free(syscall
->internal_filter
.filter
);
37 free(syscall
->internal_filter
.bytecode
);
41 static bool lttng_event_rule_kernel_syscall_validate(
42 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(
65 const struct lttng_event_rule
*rule
,
66 struct lttng_payload
*payload
)
69 size_t pattern_len
, filter_expression_len
;
70 struct lttng_event_rule_kernel_syscall
*syscall
;
71 struct lttng_event_rule_kernel_syscall_comm syscall_comm
;
73 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
)) {
78 DBG("Serializing syscall event rule");
79 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
81 pattern_len
= strlen(syscall
->pattern
) + 1;
83 if (syscall
->filter_expression
!= NULL
) {
84 filter_expression_len
= strlen(syscall
->filter_expression
) + 1;
86 filter_expression_len
= 0;
89 syscall_comm
.pattern_len
= pattern_len
;
90 syscall_comm
.filter_expression_len
= filter_expression_len
;
91 syscall_comm
.emission_site
= syscall
->emission_site
;
93 ret
= lttng_dynamic_buffer_append(
94 &payload
->buffer
, &syscall_comm
, sizeof(syscall_comm
));
99 ret
= lttng_dynamic_buffer_append(
100 &payload
->buffer
, syscall
->pattern
, pattern_len
);
105 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
106 syscall
->filter_expression
, filter_expression_len
);
111 static bool lttng_event_rule_kernel_syscall_is_equal(const struct lttng_event_rule
*_a
,
112 const struct lttng_event_rule
*_b
)
114 bool is_equal
= false;
115 struct lttng_event_rule_kernel_syscall
*a
, *b
;
117 a
= lttng::utils::container_of(_a
, <tng_event_rule_kernel_syscall::parent
);
118 b
= lttng::utils::container_of(_b
, <tng_event_rule_kernel_syscall::parent
);
120 if (!!a
->filter_expression
!= !!b
->filter_expression
) {
124 LTTNG_ASSERT(a
->pattern
);
125 LTTNG_ASSERT(b
->pattern
);
126 if (strcmp(a
->pattern
, b
->pattern
)) {
130 if (a
->filter_expression
&& b
->filter_expression
) {
131 if (strcmp(a
->filter_expression
, b
->filter_expression
)) {
134 } else if (!!a
->filter_expression
!= !!b
->filter_expression
) {
135 /* One is set and not the other. */
144 static enum lttng_error_code
lttng_event_rule_kernel_syscall_generate_filter_bytecode(
145 struct lttng_event_rule
*rule
,
146 const struct lttng_credentials
*creds
)
149 enum lttng_error_code ret_code
= LTTNG_OK
;
150 struct lttng_event_rule_kernel_syscall
*syscall
;
151 enum lttng_event_rule_status status
;
153 struct lttng_bytecode
*bytecode
= NULL
;
157 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
159 /* Generate the filter bytecode. */
160 status
= lttng_event_rule_kernel_syscall_get_filter(rule
, &filter
);
161 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
163 } else if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
164 ret_code
= LTTNG_ERR_FILTER_INVAL
;
168 if (filter
&& filter
[0] == '\0') {
169 ret_code
= LTTNG_ERR_FILTER_INVAL
;
173 if (filter
== NULL
) {
179 syscall
->internal_filter
.filter
= strdup(filter
);
180 if (syscall
->internal_filter
.filter
== NULL
) {
181 ret_code
= LTTNG_ERR_NOMEM
;
185 ret
= run_as_generate_filter_bytecode(
186 syscall
->internal_filter
.filter
, creds
, &bytecode
);
188 ret_code
= LTTNG_ERR_FILTER_INVAL
;
191 syscall
->internal_filter
.bytecode
= bytecode
;
199 static const char *lttng_event_rule_kernel_syscall_get_internal_filter(
200 const struct lttng_event_rule
*rule
)
202 struct lttng_event_rule_kernel_syscall
*syscall
;
205 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
207 return syscall
->internal_filter
.filter
;
210 static const struct lttng_bytecode
*
211 lttng_event_rule_kernel_syscall_get_internal_filter_bytecode(
212 const struct lttng_event_rule
*rule
)
214 struct lttng_event_rule_kernel_syscall
*syscall
;
217 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
219 return syscall
->internal_filter
.bytecode
;
222 static enum lttng_event_rule_generate_exclusions_status
223 lttng_event_rule_kernel_syscall_generate_exclusions(
224 const struct lttng_event_rule
*rule
__attribute__((unused
)),
225 struct lttng_event_exclusion
**exclusions
)
229 return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
;
233 lttng_event_rule_kernel_syscall_hash(
234 const struct lttng_event_rule
*rule
)
237 struct lttng_event_rule_kernel_syscall
*syscall_rule
=
238 lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
240 hash
= hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
,
242 hash
^= hash_key_str(syscall_rule
->pattern
, lttng_ht_seed
);
243 if (syscall_rule
->filter_expression
) {
244 hash
^= hash_key_str(syscall_rule
->filter_expression
,
251 static enum lttng_error_code
lttng_event_rule_kernel_syscall_mi_serialize(
252 const struct lttng_event_rule
*rule
, struct mi_writer
*writer
)
255 enum lttng_error_code ret_code
;
256 enum lttng_event_rule_status status
;
258 enum lttng_event_rule_kernel_syscall_emission_site site_type
;
259 const char *filter
= NULL
;
260 const char *name_pattern
= NULL
;
261 const char *site_type_str
= NULL
;
264 LTTNG_ASSERT(writer
);
265 LTTNG_ASSERT(IS_SYSCALL_EVENT_RULE(rule
));
267 status
= lttng_event_rule_kernel_syscall_get_name_pattern(
268 rule
, &name_pattern
);
269 LTTNG_ASSERT(status
== LTTNG_EVENT_RULE_STATUS_OK
);
270 LTTNG_ASSERT(name_pattern
);
272 status
= lttng_event_rule_kernel_syscall_get_filter(rule
, &filter
);
273 LTTNG_ASSERT(status
== LTTNG_EVENT_RULE_STATUS_OK
||
274 status
== LTTNG_EVENT_RULE_STATUS_UNSET
);
276 site_type
= lttng_event_rule_kernel_syscall_get_emission_site(rule
);
279 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT
:
280 site_type_str
= mi_lttng_event_rule_kernel_syscall_emission_site_entry_exit
;
282 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY
:
283 site_type_str
= mi_lttng_event_rule_kernel_syscall_emission_site_entry
;
285 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT
:
286 site_type_str
= mi_lttng_event_rule_kernel_syscall_emission_site_exit
;
293 /* Open event rule kernel syscall element. */
294 ret
= mi_lttng_writer_open_element(
295 writer
, mi_lttng_element_event_rule_kernel_syscall
);
301 ret
= mi_lttng_writer_write_element_string(writer
,
302 mi_lttng_element_event_rule_kernel_syscall_emission_site
,
309 ret
= mi_lttng_writer_write_element_string(writer
,
310 mi_lttng_element_event_rule_name_pattern
, name_pattern
);
316 if (filter
!= NULL
) {
317 ret
= mi_lttng_writer_write_element_string(writer
,
318 mi_lttng_element_event_rule_filter_expression
,
325 /* Close event rule kernel syscall. */
326 ret
= mi_lttng_writer_close_element(writer
);
335 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
340 struct lttng_event_rule
*lttng_event_rule_kernel_syscall_create(
341 enum lttng_event_rule_kernel_syscall_emission_site
344 struct lttng_event_rule
*rule
= NULL
;
345 struct lttng_event_rule_kernel_syscall
*syscall_rule
;
346 enum lttng_event_rule_status status
;
348 /* Validate the emission site type */
349 switch (emission_site
) {
350 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT
:
351 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY
:
352 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT
:
355 /* Invalid emission type */
359 syscall_rule
= zmalloc
<lttng_event_rule_kernel_syscall
>();
364 rule
= &syscall_rule
->parent
;
365 lttng_event_rule_init(
366 &syscall_rule
->parent
, LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
);
367 syscall_rule
->parent
.validate
= lttng_event_rule_kernel_syscall_validate
;
368 syscall_rule
->parent
.serialize
= lttng_event_rule_kernel_syscall_serialize
;
369 syscall_rule
->parent
.equal
= lttng_event_rule_kernel_syscall_is_equal
;
370 syscall_rule
->parent
.destroy
= lttng_event_rule_kernel_syscall_destroy
;
371 syscall_rule
->parent
.generate_filter_bytecode
=
372 lttng_event_rule_kernel_syscall_generate_filter_bytecode
;
373 syscall_rule
->parent
.get_filter
=
374 lttng_event_rule_kernel_syscall_get_internal_filter
;
375 syscall_rule
->parent
.get_filter_bytecode
=
376 lttng_event_rule_kernel_syscall_get_internal_filter_bytecode
;
377 syscall_rule
->parent
.generate_exclusions
=
378 lttng_event_rule_kernel_syscall_generate_exclusions
;
379 syscall_rule
->parent
.hash
= lttng_event_rule_kernel_syscall_hash
;
380 syscall_rule
->parent
.mi_serialize
= lttng_event_rule_kernel_syscall_mi_serialize
;
382 /* Default pattern is '*'. */
383 status
= lttng_event_rule_kernel_syscall_set_name_pattern(rule
, "*");
384 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
385 lttng_event_rule_destroy(rule
);
389 /* Emission site type */
390 syscall_rule
->emission_site
= emission_site
;
396 ssize_t
lttng_event_rule_kernel_syscall_create_from_payload(
397 struct lttng_payload_view
*view
,
398 struct lttng_event_rule
**_event_rule
)
400 ssize_t ret
, offset
= 0;
401 enum lttng_event_rule_status status
;
402 const struct lttng_event_rule_kernel_syscall_comm
*syscall_comm
;
404 const char *filter_expression
= NULL
;
405 struct lttng_buffer_view current_buffer_view
;
406 struct lttng_event_rule
*rule
= NULL
;
413 if (view
->buffer
.size
< sizeof(*syscall_comm
)) {
414 ERR("Failed to initialize from malformed event rule syscall: buffer too short to contain header");
419 current_buffer_view
= lttng_buffer_view_from_view(
420 &view
->buffer
, offset
, sizeof(*syscall_comm
));
421 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
426 syscall_comm
= (typeof(syscall_comm
)) current_buffer_view
.data
;
427 rule
= lttng_event_rule_kernel_syscall_create((lttng_event_rule_kernel_syscall_emission_site
) syscall_comm
->emission_site
);
429 ERR("Failed to create event rule syscall");
434 /* Skip to payload. */
435 offset
+= current_buffer_view
.size
;
437 /* Map the pattern. */
438 current_buffer_view
= lttng_buffer_view_from_view(
439 &view
->buffer
, offset
, syscall_comm
->pattern_len
);
440 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
445 pattern
= current_buffer_view
.data
;
446 if (!lttng_buffer_view_contains_string(¤t_buffer_view
, pattern
,
447 syscall_comm
->pattern_len
)) {
452 /* Skip after the pattern. */
453 offset
+= syscall_comm
->pattern_len
;
455 if (!syscall_comm
->filter_expression_len
) {
456 goto skip_filter_expression
;
459 /* Map the filter_expression. */
460 current_buffer_view
= lttng_buffer_view_from_view(&view
->buffer
, offset
,
461 syscall_comm
->filter_expression_len
);
462 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
467 filter_expression
= current_buffer_view
.data
;
468 if (!lttng_buffer_view_contains_string(¤t_buffer_view
,
470 syscall_comm
->filter_expression_len
)) {
475 /* Skip after the pattern. */
476 offset
+= syscall_comm
->filter_expression_len
;
478 skip_filter_expression
:
480 status
= lttng_event_rule_kernel_syscall_set_name_pattern(rule
, pattern
);
481 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
482 ERR("Failed to set event rule syscall pattern");
487 if (filter_expression
) {
488 status
= lttng_event_rule_kernel_syscall_set_filter(
489 rule
, filter_expression
);
490 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
491 ERR("Failed to set event rule syscall pattern");
501 lttng_event_rule_destroy(rule
);
505 enum lttng_event_rule_status
lttng_event_rule_kernel_syscall_set_name_pattern(
506 struct lttng_event_rule
*rule
, const char *pattern
)
508 char *pattern_copy
= NULL
;
509 struct lttng_event_rule_kernel_syscall
*syscall
;
510 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
512 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !pattern
||
513 strlen(pattern
) == 0) {
514 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
518 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
519 pattern_copy
= strdup(pattern
);
521 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
525 strutils_normalize_star_glob_pattern(pattern_copy
);
527 free(syscall
->pattern
);
529 syscall
->pattern
= pattern_copy
;
535 enum lttng_event_rule_status
lttng_event_rule_kernel_syscall_get_name_pattern(
536 const struct lttng_event_rule
*rule
, const char **pattern
)
538 struct lttng_event_rule_kernel_syscall
*syscall
;
539 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
541 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !pattern
) {
542 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
546 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
547 if (!syscall
->pattern
) {
548 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
552 *pattern
= syscall
->pattern
;
557 enum lttng_event_rule_status
lttng_event_rule_kernel_syscall_set_filter(
558 struct lttng_event_rule
*rule
, const char *expression
)
560 char *expression_copy
= NULL
;
561 struct lttng_event_rule_kernel_syscall
*syscall
;
562 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
564 /* TODO: validate that the passed expression is valid. */
566 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !expression
||
567 strlen(expression
) == 0) {
568 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
572 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
573 expression_copy
= strdup(expression
);
574 if (!expression_copy
) {
575 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
579 if (syscall
->filter_expression
) {
580 free(syscall
->filter_expression
);
583 syscall
->filter_expression
= expression_copy
;
584 expression_copy
= NULL
;
589 enum lttng_event_rule_status
lttng_event_rule_kernel_syscall_get_filter(
590 const struct lttng_event_rule
*rule
, const char **expression
)
592 struct lttng_event_rule_kernel_syscall
*syscall
;
593 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
595 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !expression
) {
596 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
600 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
601 if (!syscall
->filter_expression
) {
602 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
606 *expression
= syscall
->filter_expression
;
610 extern enum lttng_event_rule_kernel_syscall_emission_site
611 lttng_event_rule_kernel_syscall_get_emission_site(
612 const struct lttng_event_rule
*rule
)
614 enum lttng_event_rule_kernel_syscall_emission_site emission_site
=
615 LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_UNKNOWN
;
616 struct lttng_event_rule_kernel_syscall
*syscall
;
618 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
)) {
622 syscall
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_syscall::parent
);
623 emission_site
= syscall
->emission_site
;
626 return emission_site
;
629 const char *lttng_event_rule_kernel_syscall_emission_site_str(
630 enum lttng_event_rule_kernel_syscall_emission_site emission_site
)
632 switch (emission_site
) {
633 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY
:
635 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT
:
637 case LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT
: