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 struct lttng_event_exclusion
*
221 lttng_event_rule_syscall_generate_exclusions(
222 const struct lttng_event_rule
*rule
)
229 lttng_event_rule_syscall_hash(
230 const struct lttng_event_rule
*rule
)
233 struct lttng_event_rule_syscall
*syscall_rule
=
234 container_of(rule
, typeof(*syscall_rule
), parent
);
236 hash
= hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_SYSCALL
,
238 hash
^= hash_key_str(syscall_rule
->pattern
, lttng_ht_seed
);
239 if (syscall_rule
->filter_expression
) {
240 hash
^= hash_key_str(syscall_rule
->filter_expression
,
247 struct lttng_event_rule
*lttng_event_rule_syscall_create()
249 struct lttng_event_rule
*rule
= NULL
;
250 struct lttng_event_rule_syscall
*syscall_rule
;
252 syscall_rule
= zmalloc(sizeof(struct lttng_event_rule_syscall
));
257 rule
= &syscall_rule
->parent
;
258 lttng_event_rule_init(
259 &syscall_rule
->parent
, LTTNG_EVENT_RULE_TYPE_SYSCALL
);
260 syscall_rule
->parent
.validate
= lttng_event_rule_syscall_validate
;
261 syscall_rule
->parent
.serialize
= lttng_event_rule_syscall_serialize
;
262 syscall_rule
->parent
.equal
= lttng_event_rule_syscall_is_equal
;
263 syscall_rule
->parent
.destroy
= lttng_event_rule_syscall_destroy
;
264 syscall_rule
->parent
.generate_filter_bytecode
=
265 lttng_event_rule_syscall_generate_filter_bytecode
;
266 syscall_rule
->parent
.get_filter
=
267 lttng_event_rule_syscall_get_internal_filter
;
268 syscall_rule
->parent
.get_filter_bytecode
=
269 lttng_event_rule_syscall_get_internal_filter_bytecode
;
270 syscall_rule
->parent
.generate_exclusions
=
271 lttng_event_rule_syscall_generate_exclusions
;
272 syscall_rule
->parent
.hash
= lttng_event_rule_syscall_hash
;
278 ssize_t
lttng_event_rule_syscall_create_from_payload(
279 struct lttng_payload_view
*view
,
280 struct lttng_event_rule
**_event_rule
)
282 ssize_t ret
, offset
= 0;
283 enum lttng_event_rule_status status
;
284 const struct lttng_event_rule_syscall_comm
*syscall_comm
;
286 const char *filter_expression
= NULL
;
287 struct lttng_buffer_view current_buffer_view
;
288 struct lttng_event_rule
*rule
= NULL
;
295 if (view
->buffer
.size
< sizeof(*syscall_comm
)) {
296 ERR("Failed to initialize from malformed event rule syscall: buffer too short to contain header");
301 current_buffer_view
= lttng_buffer_view_from_view(
302 &view
->buffer
, offset
, sizeof(*syscall_comm
));
303 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
308 syscall_comm
= (typeof(syscall_comm
)) current_buffer_view
.data
;
309 rule
= lttng_event_rule_syscall_create();
311 ERR("Failed to create event rule syscall");
316 /* Skip to payload. */
317 offset
+= current_buffer_view
.size
;
319 /* Map the pattern. */
320 current_buffer_view
= lttng_buffer_view_from_view(
321 &view
->buffer
, offset
, syscall_comm
->pattern_len
);
322 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
327 pattern
= current_buffer_view
.data
;
328 if (!lttng_buffer_view_contains_string(¤t_buffer_view
, pattern
,
329 syscall_comm
->pattern_len
)) {
334 /* Skip after the pattern. */
335 offset
+= syscall_comm
->pattern_len
;
337 if (!syscall_comm
->filter_expression_len
) {
338 goto skip_filter_expression
;
341 /* Map the filter_expression. */
342 current_buffer_view
= lttng_buffer_view_from_view(&view
->buffer
, offset
,
343 syscall_comm
->filter_expression_len
);
344 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
349 filter_expression
= current_buffer_view
.data
;
350 if (!lttng_buffer_view_contains_string(¤t_buffer_view
,
352 syscall_comm
->filter_expression_len
)) {
357 /* Skip after the pattern. */
358 offset
+= syscall_comm
->filter_expression_len
;
360 skip_filter_expression
:
362 status
= lttng_event_rule_syscall_set_pattern(rule
, pattern
);
363 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
364 ERR("Failed to set event rule syscall pattern");
369 if (filter_expression
) {
370 status
= lttng_event_rule_syscall_set_filter(
371 rule
, filter_expression
);
372 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
373 ERR("Failed to set event rule syscall pattern");
383 lttng_event_rule_destroy(rule
);
387 enum lttng_event_rule_status
lttng_event_rule_syscall_set_pattern(
388 struct lttng_event_rule
*rule
, const char *pattern
)
390 char *pattern_copy
= NULL
;
391 struct lttng_event_rule_syscall
*syscall
;
392 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
394 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !pattern
||
395 strlen(pattern
) == 0) {
396 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
400 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
401 pattern_copy
= strdup(pattern
);
403 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
407 if (syscall
->pattern
) {
408 free(syscall
->pattern
);
411 syscall
->pattern
= pattern_copy
;
417 enum lttng_event_rule_status
lttng_event_rule_syscall_get_pattern(
418 const struct lttng_event_rule
*rule
, const char **pattern
)
420 struct lttng_event_rule_syscall
*syscall
;
421 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
423 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !pattern
) {
424 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
428 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
429 if (!syscall
->pattern
) {
430 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
434 *pattern
= syscall
->pattern
;
439 enum lttng_event_rule_status
lttng_event_rule_syscall_set_filter(
440 struct lttng_event_rule
*rule
, const char *expression
)
442 char *expression_copy
= NULL
;
443 struct lttng_event_rule_syscall
*syscall
;
444 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
446 /* TODO: validate that the passed expression is valid. */
448 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !expression
||
449 strlen(expression
) == 0) {
450 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
454 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
455 expression_copy
= strdup(expression
);
456 if (!expression_copy
) {
457 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
461 if (syscall
->filter_expression
) {
462 free(syscall
->filter_expression
);
465 syscall
->filter_expression
= expression_copy
;
466 expression_copy
= NULL
;
471 enum lttng_event_rule_status
lttng_event_rule_syscall_get_filter(
472 const struct lttng_event_rule
*rule
, const char **expression
)
474 struct lttng_event_rule_syscall
*syscall
;
475 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
477 if (!rule
|| !IS_SYSCALL_EVENT_RULE(rule
) || !expression
) {
478 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
482 syscall
= container_of(rule
, struct lttng_event_rule_syscall
, parent
);
483 if (!syscall
->filter_expression
) {
484 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
488 *expression
= syscall
->filter_expression
;