2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_ACTION_INTERNAL_H
9 #define LTTNG_ACTION_INTERNAL_H
11 #include <common/buffer-view.hpp>
12 #include <common/dynamic-buffer.hpp>
13 #include <common/macros.hpp>
14 #include <common/payload-view.hpp>
15 #include <common/payload.hpp>
16 #include <lttng/lttng.h>
19 #include <sys/types.h>
22 struct lttng_rate_policy;
24 struct mi_lttng_error_query_callbacks;
27 using action_validate_cb = bool (*)(struct lttng_action *);
28 using action_destroy_cb = void (*)(struct lttng_action *);
29 using action_serialize_cb = int (*)(struct lttng_action *, struct lttng_payload *);
30 using action_equal_cb = bool (*)(const struct lttng_action *, const struct lttng_action *);
31 using action_create_from_payload_cb = ssize_t (*)(struct lttng_payload_view *,
32 struct lttng_action **);
33 using action_get_rate_policy_cb = const struct lttng_rate_policy *(*) (const struct lttng_action *);
34 using action_add_error_query_results_cb = enum lttng_action_status (*)(
35 const struct lttng_action *, struct lttng_error_query_results *);
36 using action_mi_serialize_cb = enum lttng_error_code (*)(const struct lttng_action *,
41 enum lttng_action_type type;
42 action_validate_cb validate;
43 action_serialize_cb serialize;
44 action_equal_cb equal;
45 action_destroy_cb destroy;
46 action_get_rate_policy_cb get_rate_policy;
47 action_add_error_query_results_cb add_error_query_results;
48 action_mi_serialize_cb mi_serialize;
50 /* Internal use only. */
52 /* The number of time the actions was enqueued for execution. */
53 uint64_t execution_request_counter;
55 * The number of time the action was actually executed.
56 * Action rate policy can impact on this number.
58 uint64_t execution_counter;
60 * The number of time the action execution failed.
61 * An unsigned long is used to use a type which makes atomic
62 * operations possible.
64 unsigned long execution_failure_counter;
67 struct lttng_action_comm {
68 /* enum lttng_action_type */
72 void lttng_action_init(struct lttng_action *action,
73 enum lttng_action_type type,
74 action_validate_cb validate,
75 action_serialize_cb serialize,
76 action_equal_cb equal,
77 action_destroy_cb destroy,
78 action_get_rate_policy_cb get_rate_policy,
79 action_add_error_query_results_cb add_error_query_results,
80 action_mi_serialize_cb mi);
82 bool lttng_action_validate(struct lttng_action *action);
84 int lttng_action_serialize(struct lttng_action *action,
85 struct lttng_payload *buf);
87 ssize_t lttng_action_create_from_payload(struct lttng_payload_view *view,
88 struct lttng_action **action);
90 bool lttng_action_is_equal(const struct lttng_action *a,
91 const struct lttng_action *b);
93 void lttng_action_get(struct lttng_action *action);
95 void lttng_action_put(struct lttng_action *action);
97 const char* lttng_action_type_string(enum lttng_action_type action_type);
99 void lttng_action_increase_execution_request_count(struct lttng_action *action);
101 void lttng_action_increase_execution_count(struct lttng_action *action);
103 void lttng_action_increase_execution_failure_count(struct lttng_action *action);
105 bool lttng_action_should_execute(const struct lttng_action *action);
107 enum lttng_action_status lttng_action_add_error_query_results(
108 const struct lttng_action *action,
109 struct lttng_error_query_results *results);
112 * For use by the various lttng_action implementation. Implements the default
113 * behavior to the generic error "execution failure counter" that all actions
114 * (except list, which passes-through) provide.
116 enum lttng_action_status lttng_action_generic_add_error_query_results(
117 const struct lttng_action *action,
118 struct lttng_error_query_results *results);
119 enum lttng_error_code lttng_action_mi_serialize(const struct lttng_trigger *trigger,
120 const struct lttng_action *action,
121 struct mi_writer *writer,
122 const struct mi_lttng_error_query_callbacks
123 *error_query_callbacks,
124 struct lttng_dynamic_array *action_path_indexes);
126 #endif /* LTTNG_ACTION_INTERNAL_H */