Fix: liblttng-ctl comm: lttng_event is not packed
[lttng-tools.git] / include / lttng / event-rule / kernel-tracepoint.h
1 /*
2 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
3 *
4 * SPDX-License-Identifier: LGPL-2.1-only
5 *
6 */
7
8 #ifndef LTTNG_EVENT_RULE_KERNEL_TRACEPOINT_H
9 #define LTTNG_EVENT_RULE_KERNEL_TRACEPOINT_H
10
11 #include <lttng/event-rule/event-rule.h>
12 #include <lttng/event.h>
13 #include <lttng/lttng-export.h>
14
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18
19 /*
20 * Create a newly allocated kernel tracepoint event rule.
21 *
22 * The default pattern is '*'.
23 *
24 * Returns a new event rule on success, NULL on failure. This event rule must be
25 * destroyed using lttng_event_rule_destroy().
26 */
27 LTTNG_EXPORT extern struct lttng_event_rule *lttng_event_rule_kernel_tracepoint_create(void);
28
29 /*
30 * Set the name pattern of a kernel tracepoint event rule.
31 *
32 * Pattern can contain wildcard '*'. See man lttng-enable-event.
33 *
34 * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
35 * if invalid parameters are passed.
36 */
37 LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_set_name_pattern(
38 struct lttng_event_rule *rule, const char *pattern);
39
40 /*
41 * Get the name pattern of a kernel tracepoint event rule.
42 *
43 * The caller does not assume the ownership of the returned pattern. The
44 * pattern shall only only be used for the duration of the event rule's
45 * lifetime, or before a different pattern is set.
46 *
47 * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's pattern
48 * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid
49 * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern
50 * was not set prior to this call.
51 */
52 LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_get_name_pattern(
53 const struct lttng_event_rule *rule, const char **pattern);
54
55 /*
56 * Set the filter expression of a kernel tracepoint event rule.
57 *
58 * The expression is copied internally.
59 *
60 * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
61 * if invalid parameters are passed.
62 */
63 LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_set_filter(
64 struct lttng_event_rule *rule, const char *expression);
65
66 /*
67 * Get the filter expression of a kernel tracepoint event rule.
68 *
69 * The caller does not assume the ownership of the returned filter expression.
70 * The filter expression shall only only be used for the duration of the event
71 * rule's lifetime, or before a different filter expression is set.
72 *
73 * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter
74 * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid
75 * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression
76 * was not set prior to this call.
77 */
78 LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_kernel_tracepoint_get_filter(
79 const struct lttng_event_rule *rule, const char **expression);
80
81 #ifdef __cplusplus
82 }
83 #endif
84
85 #endif /* LTTNG_EVENT_RULE_KERNEL_TRACEPOINT_H */
This page took 0.030741 seconds and 4 git commands to generate.