X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Faction%2Faction-internal.h;h=b55a6d59bc2dcde627f517b51436c163afe3d911;hp=df400d5a3527588ddea04d928a0041785dae5022;hb=7966af5763c4aaca39df9bbfa9277ff15715c720;hpb=9b63a4aa352c184984395c097f86d5e54c295012 diff --git a/include/lttng/action/action-internal.h b/include/lttng/action/action-internal.h index df400d5a3..b55a6d59b 100644 --- a/include/lttng/action/action-internal.h +++ b/include/lttng/action/action-internal.h @@ -1,40 +1,76 @@ /* - * Copyright (C) 2017 - Jérémie Galarneau + * Copyright (C) 2017 Jérémie Galarneau * - * This library is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License, version 2.1 only, - * as published by the Free Software Foundation. + * SPDX-License-Identifier: LGPL-2.1-only * - * This library is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License - * for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this library; if not, write to the Free Software Foundation, - * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef LTTNG_ACTION_INTERNAL_H #define LTTNG_ACTION_INTERNAL_H -#include -#include #include #include +#include +#include +#include +#include +#include #include #include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +struct lttng_rate_policy; +struct mi_writer; +struct mi_lttng_error_query_callbacks; +struct lttng_trigger; typedef bool (*action_validate_cb)(struct lttng_action *action); typedef void (*action_destroy_cb)(struct lttng_action *action); typedef int (*action_serialize_cb)(struct lttng_action *action, - struct lttng_dynamic_buffer *buf); + struct lttng_payload *payload); +typedef bool (*action_equal_cb)(const struct lttng_action *a, + const struct lttng_action *b); +typedef ssize_t (*action_create_from_payload_cb)( + struct lttng_payload_view *view, + struct lttng_action **action); +typedef const struct lttng_rate_policy *(*action_get_rate_policy_cb)( + const struct lttng_action *action); +typedef enum lttng_action_status (*action_add_error_query_results_cb)( + const struct lttng_action *action, + struct lttng_error_query_results *results); +typedef enum lttng_error_code (*action_mi_serialize_cb)( + const struct lttng_action *condition, struct mi_writer *writer); struct lttng_action { + struct urcu_ref ref; enum lttng_action_type type; action_validate_cb validate; action_serialize_cb serialize; + action_equal_cb equal; action_destroy_cb destroy; + action_get_rate_policy_cb get_rate_policy; + action_add_error_query_results_cb add_error_query_results; + action_mi_serialize_cb mi_serialize; + + /* Internal use only. */ + + /* The number of time the actions was enqueued for execution. */ + uint64_t execution_request_counter; + /* + * The number of time the action was actually executed. + * Action rate policy can impact on this number. + * */ + uint64_t execution_counter; + /* + * The number of time the action execution failed. + * An unsigned long is used to use a type which makes atomic + * operations possible. + */ + unsigned long execution_failure_counter; }; struct lttng_action_comm { @@ -42,19 +78,62 @@ struct lttng_action_comm { int8_t action_type; } LTTNG_PACKED; -LTTNG_HIDDEN +void lttng_action_init(struct lttng_action *action, + enum lttng_action_type type, + action_validate_cb validate, + action_serialize_cb serialize, + action_equal_cb equal, + action_destroy_cb destroy, + action_get_rate_policy_cb get_rate_policy, + action_add_error_query_results_cb add_error_query_results, + action_mi_serialize_cb mi); + bool lttng_action_validate(struct lttng_action *action); -LTTNG_HIDDEN int lttng_action_serialize(struct lttng_action *action, - struct lttng_dynamic_buffer *buf); + struct lttng_payload *buf); -LTTNG_HIDDEN -ssize_t lttng_action_create_from_buffer(const struct lttng_buffer_view *view, +ssize_t lttng_action_create_from_payload(struct lttng_payload_view *view, struct lttng_action **action); -LTTNG_HIDDEN -enum lttng_action_type lttng_action_get_type_const( - const struct lttng_action *action); +bool lttng_action_is_equal(const struct lttng_action *a, + const struct lttng_action *b); + +void lttng_action_get(struct lttng_action *action); + +void lttng_action_put(struct lttng_action *action); + +const char* lttng_action_type_string(enum lttng_action_type action_type); + +void lttng_action_increase_execution_request_count(struct lttng_action *action); + +void lttng_action_increase_execution_count(struct lttng_action *action); + +void lttng_action_increase_execution_failure_count(struct lttng_action *action); + +bool lttng_action_should_execute(const struct lttng_action *action); + +enum lttng_action_status lttng_action_add_error_query_results( + const struct lttng_action *action, + struct lttng_error_query_results *results); + +/* + * For use by the various lttng_action implementation. Implements the default + * behavior to the generic error "execution failure counter" that all actions + * (except list, which passes-through) provide. + */ +enum lttng_action_status lttng_action_generic_add_error_query_results( + const struct lttng_action *action, + struct lttng_error_query_results *results); +enum lttng_error_code lttng_action_mi_serialize(const struct lttng_trigger *trigger, + const struct lttng_action *action, + struct mi_writer *writer, + const struct mi_lttng_error_query_callbacks + *error_query_callbacks, + struct lttng_dynamic_array *action_path_indexes); + +#ifdef __cplusplus +} +#endif #endif /* LTTNG_ACTION_INTERNAL_H */