X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=include%2Flttng%2Fevent-rule%2Fkernel-syscall.h;fp=include%2Flttng%2Fevent-rule%2Fkernel-syscall.h;h=1db6915877440a8690dc34b88f4714244ac57125;hb=4f7da553ae57a6c947da2b9668c06418b2d50e99;hp=0000000000000000000000000000000000000000;hpb=f6a5af193de5e5f219111604382ec69b784a49c7;p=lttng-tools.git diff --git a/include/lttng/event-rule/kernel-syscall.h b/include/lttng/event-rule/kernel-syscall.h new file mode 100644 index 000000000..1db691587 --- /dev/null +++ b/include/lttng/event-rule/kernel-syscall.h @@ -0,0 +1,103 @@ +/* + * Copyright (C) 2019 Jonathan Rajotte + * + * SPDX-License-Identifier: LGPL-2.1-only + * + */ + +#ifndef LTTNG_EVENT_RULE_KERNEL_SYSCALL_H +#define LTTNG_EVENT_RULE_KERNEL_SYSCALL_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +enum lttng_event_rule_kernel_syscall_emission_site { + LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT = 0, + LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY = 1, + LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT = 2, + LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_UNKNOWN = -1, +}; + +/* + * Create a newly allocated kernel syscall event rule. + * + * The default pattern is '*'. + * The default emission site is LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT. + * + * Returns a new event rule on success, NULL on failure. This event rule must be + * destroyed using lttng_event_rule_destroy(). + */ +extern struct lttng_event_rule *lttng_event_rule_kernel_syscall_create(enum + lttng_event_rule_kernel_syscall_emission_site emission_site); + +/* + * Set the name pattern of a kernel syscall event rule. + * + * Pattern can contain wildcard '*'. See man lttng-enable-event. + * + * The pattern is copied internally. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_event_rule_status lttng_event_rule_kernel_syscall_set_name_pattern( + struct lttng_event_rule *rule, const char *pattern); + +/* + * Get the name pattern of a kernel syscall event rule. + * + * The caller does not assume the ownership of the returned pattern. The + * pattern shall only only be used for the duration of the event rule's + * lifetime, or before a different pattern is set. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's pattern + * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid + * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern + * was not set prior to this call. + */ +extern enum lttng_event_rule_status lttng_event_rule_kernel_syscall_get_name_pattern( + const struct lttng_event_rule *rule, const char **pattern); + +/* + * Set the filter expression of a kernel syscall event rule. + * + * The expression is copied internally. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_event_rule_status lttng_event_rule_kernel_syscall_set_filter( + struct lttng_event_rule *rule, const char *expression); + +/* + * Get the filter expression of a kernel syscall event rule. + * + * The caller does not assume the ownership of the returned filter expression. + * The filter expression shall only only be used for the duration of the event + * rule's lifetime, or before a different filter expression is set. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter + * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid + * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression + * was not set prior to this call. + */ +extern enum lttng_event_rule_status lttng_event_rule_kernel_syscall_get_filter( + const struct lttng_event_rule *rule, const char **expression); + +/* + * Get the emission site of a kernel syscall event rule. + * + * Returns a enum lttng_event_rule_kernel_syscall_emission_site. + */ +extern enum lttng_event_rule_kernel_syscall_emission_site +lttng_event_rule_kernel_syscall_get_emission_site( + const struct lttng_event_rule *rule); + +#ifdef __cplusplus +} +#endif + +#endif /* LTTNG_EVENT_RULE_KERNEL_SYSCALL_H */