2 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_EVENT_RULE_KERNEL_SYSCALL_H
9 #define LTTNG_EVENT_RULE_KERNEL_SYSCALL_H
11 #include <lttng/event-rule/event-rule.h>
12 #include <lttng/lttng-export.h>
18 enum lttng_event_rule_kernel_syscall_emission_site
{
19 LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT
= 0,
20 LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY
= 1,
21 LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT
= 2,
22 LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_UNKNOWN
= -1,
26 * Create a newly allocated kernel syscall event rule.
28 * The default pattern is '*'.
29 * The default emission site is LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT.
31 * Returns a new event rule on success, NULL on failure. This event rule must be
32 * destroyed using lttng_event_rule_destroy().
34 LTTNG_EXPORT
extern struct lttng_event_rule
*lttng_event_rule_kernel_syscall_create(
35 enum lttng_event_rule_kernel_syscall_emission_site emission_site
);
38 * Set the name pattern of a kernel syscall event rule.
40 * Pattern can contain wildcard '*'. See man lttng-enable-event.
42 * The pattern is copied internally.
44 * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
45 * if invalid parameters are passed.
47 LTTNG_EXPORT
extern enum lttng_event_rule_status
48 lttng_event_rule_kernel_syscall_set_name_pattern(struct lttng_event_rule
*rule
,
52 * Get the name pattern of a kernel syscall event rule.
54 * The caller does not assume the ownership of the returned pattern. The
55 * pattern shall only only be used for the duration of the event rule's
56 * lifetime, or before a different pattern is set.
58 * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's pattern
59 * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid
60 * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern
61 * was not set prior to this call.
63 LTTNG_EXPORT
extern enum lttng_event_rule_status
64 lttng_event_rule_kernel_syscall_get_name_pattern(const struct lttng_event_rule
*rule
,
65 const char **pattern
);
68 * Set the filter expression of a kernel syscall event rule.
70 * The expression is copied internally.
72 * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
73 * if invalid parameters are passed.
75 LTTNG_EXPORT
extern enum lttng_event_rule_status
76 lttng_event_rule_kernel_syscall_set_filter(struct lttng_event_rule
*rule
, const char *expression
);
79 * Get the filter expression of a kernel syscall event rule.
81 * The caller does not assume the ownership of the returned filter expression.
82 * The filter expression shall only only be used for the duration of the event
83 * rule's lifetime, or before a different filter expression is set.
85 * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter
86 * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid
87 * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression
88 * was not set prior to this call.
90 LTTNG_EXPORT
extern enum lttng_event_rule_status
91 lttng_event_rule_kernel_syscall_get_filter(const struct lttng_event_rule
*rule
,
92 const char **expression
);
95 * Get the emission site of a kernel syscall event rule.
97 * Returns a enum lttng_event_rule_kernel_syscall_emission_site.
99 LTTNG_EXPORT
extern enum lttng_event_rule_kernel_syscall_emission_site
100 lttng_event_rule_kernel_syscall_get_emission_site(const struct lttng_event_rule
*rule
);
106 #endif /* LTTNG_EVENT_RULE_KERNEL_SYSCALL_H */