Commit | Line | Data |
---|---|---|
a58c490f | 1 | /* |
ab5be9fa | 2 | * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
a58c490f | 3 | * |
ab5be9fa | 4 | * SPDX-License-Identifier: LGPL-2.1-only |
a58c490f | 5 | * |
a58c490f JG |
6 | */ |
7 | ||
8 | #ifndef LTTNG_ACTION_INTERNAL_H | |
9 | #define LTTNG_ACTION_INTERNAL_H | |
10 | ||
a58c490f | 11 | #include <common/buffer-view.h> |
3647288f | 12 | #include <common/dynamic-buffer.h> |
588c4b0d | 13 | #include <common/macros.h> |
9e620ea7 JG |
14 | #include <common/payload-view.h> |
15 | #include <common/payload.h> | |
588c4b0d JG |
16 | #include <lttng/lttng.h> |
17 | #include <pthread.h> | |
a58c490f | 18 | #include <stdbool.h> |
72756a3f | 19 | #include <sys/types.h> |
c852ce4e | 20 | #include <urcu/ref.h> |
a58c490f | 21 | |
7f4d5b07 | 22 | struct lttng_rate_policy; |
6a751b95 JR |
23 | struct mi_writer; |
24 | struct mi_lttng_error_query_callbacks; | |
25 | struct lttng_trigger; | |
2d57482c | 26 | |
a58c490f JG |
27 | typedef bool (*action_validate_cb)(struct lttng_action *action); |
28 | typedef void (*action_destroy_cb)(struct lttng_action *action); | |
3647288f | 29 | typedef int (*action_serialize_cb)(struct lttng_action *action, |
c0a66c84 | 30 | struct lttng_payload *payload); |
3dd04a6a JR |
31 | typedef bool (*action_equal_cb)(const struct lttng_action *a, |
32 | const struct lttng_action *b); | |
c0a66c84 JG |
33 | typedef ssize_t (*action_create_from_payload_cb)( |
34 | struct lttng_payload_view *view, | |
869a3c2d | 35 | struct lttng_action **action); |
7f4d5b07 | 36 | typedef const struct lttng_rate_policy *(*action_get_rate_policy_cb)( |
2d57482c | 37 | const struct lttng_action *action); |
588c4b0d JG |
38 | typedef enum lttng_action_status (*action_add_error_query_results_cb)( |
39 | const struct lttng_action *action, | |
40 | struct lttng_error_query_results *results); | |
6a751b95 JR |
41 | typedef enum lttng_error_code (*action_mi_serialize_cb)( |
42 | const struct lttng_action *condition, struct mi_writer *writer); | |
a58c490f JG |
43 | |
44 | struct lttng_action { | |
c852ce4e | 45 | struct urcu_ref ref; |
a58c490f JG |
46 | enum lttng_action_type type; |
47 | action_validate_cb validate; | |
48 | action_serialize_cb serialize; | |
3dd04a6a | 49 | action_equal_cb equal; |
a58c490f | 50 | action_destroy_cb destroy; |
7f4d5b07 | 51 | action_get_rate_policy_cb get_rate_policy; |
588c4b0d | 52 | action_add_error_query_results_cb add_error_query_results; |
6a751b95 | 53 | action_mi_serialize_cb mi_serialize; |
2d57482c JR |
54 | |
55 | /* Internal use only. */ | |
56 | ||
57 | /* The number of time the actions was enqueued for execution. */ | |
58 | uint64_t execution_request_counter; | |
59 | /* | |
60 | * The number of time the action was actually executed. | |
7f4d5b07 | 61 | * Action rate policy can impact on this number. |
2d57482c JR |
62 | * */ |
63 | uint64_t execution_counter; | |
64 | /* | |
65 | * The number of time the action execution failed. | |
588c4b0d JG |
66 | * An unsigned long is used to use a type which makes atomic |
67 | * operations possible. | |
2d57482c | 68 | */ |
588c4b0d | 69 | unsigned long execution_failure_counter; |
a58c490f JG |
70 | }; |
71 | ||
72 | struct lttng_action_comm { | |
73 | /* enum lttng_action_type */ | |
74 | int8_t action_type; | |
75 | } LTTNG_PACKED; | |
76 | ||
6acb3f46 SM |
77 | LTTNG_HIDDEN |
78 | void lttng_action_init(struct lttng_action *action, | |
79 | enum lttng_action_type type, | |
80 | action_validate_cb validate, | |
81 | action_serialize_cb serialize, | |
3dd04a6a | 82 | action_equal_cb equal, |
2d57482c | 83 | action_destroy_cb destroy, |
588c4b0d | 84 | action_get_rate_policy_cb get_rate_policy, |
6a751b95 JR |
85 | action_add_error_query_results_cb add_error_query_results, |
86 | action_mi_serialize_cb mi); | |
6acb3f46 | 87 | |
a58c490f JG |
88 | LTTNG_HIDDEN |
89 | bool lttng_action_validate(struct lttng_action *action); | |
90 | ||
91 | LTTNG_HIDDEN | |
3647288f | 92 | int lttng_action_serialize(struct lttng_action *action, |
c0a66c84 | 93 | struct lttng_payload *buf); |
a58c490f JG |
94 | |
95 | LTTNG_HIDDEN | |
c0a66c84 | 96 | ssize_t lttng_action_create_from_payload(struct lttng_payload_view *view, |
a58c490f JG |
97 | struct lttng_action **action); |
98 | ||
3dd04a6a JR |
99 | LTTNG_HIDDEN |
100 | bool lttng_action_is_equal(const struct lttng_action *a, | |
101 | const struct lttng_action *b); | |
102 | ||
c852ce4e JG |
103 | LTTNG_HIDDEN |
104 | void lttng_action_get(struct lttng_action *action); | |
105 | ||
106 | LTTNG_HIDDEN | |
107 | void lttng_action_put(struct lttng_action *action); | |
108 | ||
10615eee JR |
109 | LTTNG_HIDDEN |
110 | const char* lttng_action_type_string(enum lttng_action_type action_type); | |
111 | ||
2d57482c JR |
112 | LTTNG_HIDDEN |
113 | void lttng_action_increase_execution_request_count(struct lttng_action *action); | |
114 | ||
115 | LTTNG_HIDDEN | |
116 | void lttng_action_increase_execution_count(struct lttng_action *action); | |
117 | ||
118 | LTTNG_HIDDEN | |
119 | void lttng_action_increase_execution_failure_count(struct lttng_action *action); | |
120 | ||
121 | LTTNG_HIDDEN | |
122 | bool lttng_action_should_execute(const struct lttng_action *action); | |
123 | ||
588c4b0d JG |
124 | LTTNG_HIDDEN |
125 | enum lttng_action_status lttng_action_add_error_query_results( | |
126 | const struct lttng_action *action, | |
127 | struct lttng_error_query_results *results); | |
128 | ||
129 | /* | |
130 | * For use by the various lttng_action implementation. Implements the default | |
131 | * behavior to the generic error "execution failure counter" that all actions | |
a8940c5e | 132 | * (except list, which passes-through) provide. |
588c4b0d JG |
133 | */ |
134 | LTTNG_HIDDEN | |
135 | enum lttng_action_status lttng_action_generic_add_error_query_results( | |
136 | const struct lttng_action *action, | |
137 | struct lttng_error_query_results *results); | |
6a751b95 JR |
138 | LTTNG_HIDDEN |
139 | enum lttng_error_code lttng_action_mi_serialize(const struct lttng_trigger *trigger, | |
140 | const struct lttng_action *action, | |
141 | struct mi_writer *writer, | |
142 | const struct mi_lttng_error_query_callbacks | |
143 | *error_query_callbacks, | |
144 | struct lttng_dynamic_array *action_path_indexes); | |
588c4b0d | 145 | |
a58c490f | 146 | #endif /* LTTNG_ACTION_INTERNAL_H */ |