2 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
9 #include <common/credentials.h>
10 #include <common/error.h>
11 #include <common/macros.h>
12 #include <common/payload.h>
13 #include <common/payload-view.h>
14 #include <common/runas.h>
15 #include <common/hashtable/hashtable.h>
16 #include <common/hashtable/utils.h>
17 #include <lttng/event-rule/event-rule-internal.h>
18 #include <lttng/event-rule/syscall-internal.h>
20 #define IS_SYSCALL_EVENT_RULE(rule) \
21 (lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_SYSCALL)
23 static void lttng_event_rule_syscall_destroy(struct lttng_event_rule
*rule
)
25 struct lttng_event_rule_syscall
*syscall
;
31 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
33 free(syscall
->pattern
);
34 free(syscall
->filter_expression
);
35 free(syscall
->internal_filter
.filter
);
36 free(syscall
->internal_filter
.bytecode
);
40 static bool lttng_event_rule_syscall_validate(
41 const struct lttng_event_rule
*rule
)
44 struct lttng_event_rule_syscall
*syscall
;
50 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
53 if (!syscall
->pattern
) {
54 ERR("Invalid syscall event rule: a pattern must be set.");
63 static int lttng_event_rule_syscall_serialize(
64 const struct lttng_event_rule
*rule
,
65 struct lttng_payload
*payload
)
68 size_t pattern_len
, filter_expression_len
;
69 struct lttng_event_rule_syscall
*syscall
;
70 struct lttng_event_rule_syscall_comm syscall_comm
;
72 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
)) {
77 DBG("Serializing syscall event rule");
78 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
80 pattern_len
= strlen(syscall
->pattern
) + 1;
82 if (syscall
->filter_expression
!= NULL
) {
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
;
91 ret
= lttng_dynamic_buffer_append(
92 &payload
->buffer
, &syscall_comm
, sizeof(syscall_comm
));
97 ret
= lttng_dynamic_buffer_append(
98 &payload
->buffer
, syscall
->pattern
, pattern_len
);
103 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
104 syscall
->filter_expression
, filter_expression_len
);
109 static bool lttng_event_rule_syscall_is_equal(const struct lttng_event_rule
*_a
,
110 const struct lttng_event_rule
*_b
)
112 bool is_equal
= false;
113 struct lttng_event_rule_syscall
*a
, *b
;
115 a
= container_of(_a
, struct lttng_event_rule_syscall
, parent
);
116 b
= container_of(_b
, struct lttng_event_rule_syscall
, parent
);
118 if (!!a
->filter_expression
!= !!b
->filter_expression
) {
124 if (strcmp(a
->pattern
, b
->pattern
)) {
128 if (a
->filter_expression
&& b
->filter_expression
) {
129 if (strcmp(a
->filter_expression
, b
->filter_expression
)) {
132 } else if (!!a
->filter_expression
!= !!b
->filter_expression
) {
133 /* One is set and not the other. */
142 static enum lttng_error_code
lttng_event_rule_syscall_generate_filter_bytecode(
143 struct lttng_event_rule
*rule
,
144 const struct lttng_credentials
*creds
)
147 enum lttng_error_code ret_code
= LTTNG_OK
;
148 struct lttng_event_rule_syscall
*syscall
;
149 enum lttng_event_rule_status status
;
151 struct lttng_filter_bytecode
*bytecode
= NULL
;
155 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
157 /* Generate the filter bytecode. */
158 status
= lttng_event_rule_syscall_get_filter(rule
, &filter
);
159 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
161 } else if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
162 ret_code
= LTTNG_ERR_FILTER_INVAL
;
166 if (filter
&& filter
[0] == '\0') {
167 ret_code
= LTTNG_ERR_FILTER_INVAL
;
171 if (filter
== NULL
) {
177 syscall
->internal_filter
.filter
= strdup(filter
);
178 if (syscall
->internal_filter
.filter
== NULL
) {
179 ret_code
= LTTNG_ERR_NOMEM
;
183 ret
= run_as_generate_filter_bytecode(
184 syscall
->internal_filter
.filter
, creds
, &bytecode
);
186 ret_code
= LTTNG_ERR_FILTER_INVAL
;
189 syscall
->internal_filter
.bytecode
= bytecode
;
197 static const char *lttng_event_rule_syscall_get_internal_filter(
198 const struct lttng_event_rule
*rule
)
200 struct lttng_event_rule_syscall
*syscall
;
203 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
205 return syscall
->internal_filter
.filter
;
208 static const struct lttng_filter_bytecode
*
209 lttng_event_rule_syscall_get_internal_filter_bytecode(
210 const struct lttng_event_rule
*rule
)
212 struct lttng_event_rule_syscall
*syscall
;
215 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
217 return syscall
->internal_filter
.bytecode
;
220 static enum lttng_event_rule_generate_exclusions_status
221 lttng_event_rule_syscall_generate_exclusions(const struct lttng_event_rule
*rule
,
222 struct lttng_event_exclusion
**exclusions
)
226 return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
;
230 lttng_event_rule_syscall_hash(
231 const struct lttng_event_rule
*rule
)
234 struct lttng_event_rule_syscall
*syscall_rule
=
235 container_of(rule
, typeof(*syscall_rule
), parent
);
237 hash
= hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_SYSCALL
,
239 hash
^= hash_key_str(syscall_rule
->pattern
, lttng_ht_seed
);
240 if (syscall_rule
->filter_expression
) {
241 hash
^= hash_key_str(syscall_rule
->filter_expression
,
248 struct lttng_event_rule
*lttng_event_rule_syscall_create(void)
250 struct lttng_event_rule
*rule
= NULL
;
251 struct lttng_event_rule_syscall
*syscall_rule
;
253 syscall_rule
= zmalloc(sizeof(struct lttng_event_rule_syscall
));
258 rule
= &syscall_rule
->parent
;
259 lttng_event_rule_init(
260 &syscall_rule
->parent
, LTTNG_EVENT_RULE_TYPE_SYSCALL
);
261 syscall_rule
->parent
.validate
= lttng_event_rule_syscall_validate
;
262 syscall_rule
->parent
.serialize
= lttng_event_rule_syscall_serialize
;
263 syscall_rule
->parent
.equal
= lttng_event_rule_syscall_is_equal
;
264 syscall_rule
->parent
.destroy
= lttng_event_rule_syscall_destroy
;
265 syscall_rule
->parent
.generate_filter_bytecode
=
266 lttng_event_rule_syscall_generate_filter_bytecode
;
267 syscall_rule
->parent
.get_filter
=
268 lttng_event_rule_syscall_get_internal_filter
;
269 syscall_rule
->parent
.get_filter_bytecode
=
270 lttng_event_rule_syscall_get_internal_filter_bytecode
;
271 syscall_rule
->parent
.generate_exclusions
=
272 lttng_event_rule_syscall_generate_exclusions
;
273 syscall_rule
->parent
.hash
= lttng_event_rule_syscall_hash
;
279 ssize_t
lttng_event_rule_syscall_create_from_payload(
280 struct lttng_payload_view
*view
,
281 struct lttng_event_rule
**_event_rule
)
283 ssize_t ret
, offset
= 0;
284 enum lttng_event_rule_status status
;
285 const struct lttng_event_rule_syscall_comm
*syscall_comm
;
287 const char *filter_expression
= NULL
;
288 struct lttng_buffer_view current_buffer_view
;
289 struct lttng_event_rule
*rule
= NULL
;
296 if (view
->buffer
.size
< sizeof(*syscall_comm
)) {
297 ERR("Failed to initialize from malformed event rule syscall: buffer too short to contain header");
302 current_buffer_view
= lttng_buffer_view_from_view(
303 &view
->buffer
, offset
, sizeof(*syscall_comm
));
304 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
309 syscall_comm
= (typeof(syscall_comm
)) current_buffer_view
.data
;
310 rule
= lttng_event_rule_syscall_create();
312 ERR("Failed to create event rule syscall");
317 /* Skip to payload. */
318 offset
+= current_buffer_view
.size
;
320 /* Map the pattern. */
321 current_buffer_view
= lttng_buffer_view_from_view(
322 &view
->buffer
, offset
, syscall_comm
->pattern_len
);
323 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
328 pattern
= current_buffer_view
.data
;
329 if (!lttng_buffer_view_contains_string(¤t_buffer_view
, pattern
,
330 syscall_comm
->pattern_len
)) {
335 /* Skip after the pattern. */
336 offset
+= syscall_comm
->pattern_len
;
338 if (!syscall_comm
->filter_expression_len
) {
339 goto skip_filter_expression
;
342 /* Map the filter_expression. */
343 current_buffer_view
= lttng_buffer_view_from_view(&view
->buffer
, offset
,
344 syscall_comm
->filter_expression_len
);
345 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
350 filter_expression
= current_buffer_view
.data
;
351 if (!lttng_buffer_view_contains_string(¤t_buffer_view
,
353 syscall_comm
->filter_expression_len
)) {
358 /* Skip after the pattern. */
359 offset
+= syscall_comm
->filter_expression_len
;
361 skip_filter_expression
:
363 status
= lttng_event_rule_syscall_set_pattern(rule
, pattern
);
364 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
365 ERR("Failed to set event rule syscall pattern");
370 if (filter_expression
) {
371 status
= lttng_event_rule_syscall_set_filter(
372 rule
, filter_expression
);
373 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
374 ERR("Failed to set event rule syscall pattern");
384 lttng_event_rule_destroy(rule
);
388 enum lttng_event_rule_status
lttng_event_rule_syscall_set_pattern(
389 struct lttng_event_rule
*rule
, const char *pattern
)
391 char *pattern_copy
= NULL
;
392 struct lttng_event_rule_syscall
*syscall
;
393 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
395 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !pattern
||
396 strlen(pattern
) == 0) {
397 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
401 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
402 pattern_copy
= strdup(pattern
);
404 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
408 if (syscall
->pattern
) {
409 free(syscall
->pattern
);
412 syscall
->pattern
= pattern_copy
;
418 enum lttng_event_rule_status
lttng_event_rule_syscall_get_pattern(
419 const struct lttng_event_rule
*rule
, const char **pattern
)
421 struct lttng_event_rule_syscall
*syscall
;
422 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
424 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !pattern
) {
425 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
429 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
430 if (!syscall
->pattern
) {
431 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
435 *pattern
= syscall
->pattern
;
440 enum lttng_event_rule_status
lttng_event_rule_syscall_set_filter(
441 struct lttng_event_rule
*rule
, const char *expression
)
443 char *expression_copy
= NULL
;
444 struct lttng_event_rule_syscall
*syscall
;
445 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
447 /* TODO: validate that the passed expression is valid. */
449 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !expression
||
450 strlen(expression
) == 0) {
451 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
455 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
456 expression_copy
= strdup(expression
);
457 if (!expression_copy
) {
458 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
462 if (syscall
->filter_expression
) {
463 free(syscall
->filter_expression
);
466 syscall
->filter_expression
= expression_copy
;
467 expression_copy
= NULL
;
472 enum lttng_event_rule_status
lttng_event_rule_syscall_get_filter(
473 const struct lttng_event_rule
*rule
, const char **expression
)
475 struct lttng_event_rule_syscall
*syscall
;
476 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
478 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !expression
) {
479 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
483 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
484 if (!syscall
->filter_expression
) {
485 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
489 *expression
= syscall
->filter_expression
;