Commit | Line | Data |
---|---|---|
e6a39346 JR |
1 | /* |
2 | * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com> | |
3 | * | |
4 | * SPDX-License-Identifier: LGPL-2.1-only | |
5 | * | |
6 | */ | |
7 | ||
4f7da553 JR |
8 | #ifndef LTTNG_EVENT_RULE_KERNEL_SYSCALL_H |
9 | #define LTTNG_EVENT_RULE_KERNEL_SYSCALL_H | |
e6a39346 JR |
10 | |
11 | #include <lttng/event-rule/event-rule.h> | |
4bd69c5f | 12 | #include <lttng/lttng-export.h> |
e6a39346 JR |
13 | |
14 | #ifdef __cplusplus | |
15 | extern "C" { | |
16 | #endif | |
17 | ||
4f7da553 JR |
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, | |
57739a6b JR |
23 | }; |
24 | ||
e6a39346 | 25 | /* |
4f7da553 | 26 | * Create a newly allocated kernel syscall event rule. |
e6a39346 | 27 | * |
67d38b93 | 28 | * The default pattern is '*'. |
4f7da553 | 29 | * The default emission site is LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT. |
67d38b93 | 30 | * |
e6a39346 JR |
31 | * Returns a new event rule on success, NULL on failure. This event rule must be |
32 | * destroyed using lttng_event_rule_destroy(). | |
33 | */ | |
28f23191 JG |
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); | |
e6a39346 JR |
36 | |
37 | /* | |
4f7da553 | 38 | * Set the name pattern of a kernel syscall event rule. |
e6a39346 JR |
39 | * |
40 | * Pattern can contain wildcard '*'. See man lttng-enable-event. | |
41 | * | |
42 | * The pattern is copied internally. | |
43 | * | |
44 | * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
45 | * if invalid parameters are passed. | |
46 | */ | |
28f23191 JG |
47 | LTTNG_EXPORT extern enum lttng_event_rule_status |
48 | lttng_event_rule_kernel_syscall_set_name_pattern(struct lttng_event_rule *rule, | |
49 | const char *pattern); | |
e6a39346 JR |
50 | |
51 | /* | |
4f7da553 | 52 | * Get the name pattern of a kernel syscall event rule. |
e6a39346 JR |
53 | * |
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. | |
57 | * | |
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. | |
62 | */ | |
28f23191 JG |
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); | |
e6a39346 JR |
66 | |
67 | /* | |
4f7da553 | 68 | * Set the filter expression of a kernel syscall event rule. |
e6a39346 JR |
69 | * |
70 | * The expression is copied internally. | |
71 | * | |
72 | * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
73 | * if invalid parameters are passed. | |
74 | */ | |
28f23191 JG |
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); | |
e6a39346 JR |
77 | |
78 | /* | |
4f7da553 | 79 | * Get the filter expression of a kernel syscall event rule. |
e6a39346 JR |
80 | * |
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. | |
84 | * | |
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. | |
89 | */ | |
28f23191 JG |
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); | |
e6a39346 | 93 | |
57739a6b | 94 | /* |
4f7da553 | 95 | * Get the emission site of a kernel syscall event rule. |
57739a6b | 96 | * |
4f7da553 | 97 | * Returns a enum lttng_event_rule_kernel_syscall_emission_site. |
57739a6b | 98 | */ |
4bd69c5f | 99 | LTTNG_EXPORT extern enum lttng_event_rule_kernel_syscall_emission_site |
28f23191 | 100 | lttng_event_rule_kernel_syscall_get_emission_site(const struct lttng_event_rule *rule); |
57739a6b | 101 | |
e6a39346 JR |
102 | #ifdef __cplusplus |
103 | } | |
104 | #endif | |
105 | ||
4f7da553 | 106 | #endif /* LTTNG_EVENT_RULE_KERNEL_SYSCALL_H */ |