X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fcondition%2Fevent-rule-matches.h;h=c579a1864cd6f43d7304b1e5cff87f06d6e49c52;hb=HEAD;hp=18c4155a2c73dd10d1462d088f9beec6a3dbf8e3;hpb=670a26e4165562ab2dc5a16b9941f942e4f30996;p=lttng-tools.git diff --git a/include/lttng/condition/event-rule-matches.h b/include/lttng/condition/event-rule-matches.h index 18c4155a2..c579a1864 100644 --- a/include/lttng/condition/event-rule-matches.h +++ b/include/lttng/condition/event-rule-matches.h @@ -5,12 +5,13 @@ * */ -#ifndef LTTNG_CONDITION_ON_EVENT_H -#define LTTNG_CONDITION_ON_EVENT_H +#ifndef LTTNG_CONDITION_EVENT_RULE_MATCHES_H +#define LTTNG_CONDITION_EVENT_RULE_MATCHES_H -#include #include #include +#include +#include #ifdef __cplusplus extern "C" { @@ -19,34 +20,34 @@ extern "C" { struct lttng_event_expr; struct lttng_event_field_value; -enum lttng_evaluation_on_event_status { - LTTNG_EVALUATION_ON_EVENT_STATUS_NONE = 1, - LTTNG_EVALUATION_ON_EVENT_STATUS_OK = 0, - LTTNG_EVALUATION_ON_EVENT_STATUS_INVALID = -1, +enum lttng_evaluation_event_rule_matches_status { + LTTNG_EVALUATION_EVENT_RULE_MATCHES_STATUS_NONE = 1, + LTTNG_EVALUATION_EVENT_RULE_MATCHES_STATUS_OK = 0, + LTTNG_EVALUATION_EVENT_RULE_MATCHES_STATUS_INVALID = -1, }; /** - * On event conditions allows an action to be taken whenever an event matching - * the on event is hit by the tracers. + * Event Rule Matches conditions allows an action to be taken whenever an event + * matching the Event Rule Matches is hit by the tracers. * - * An on event condition can also specify a payload to be captured at runtime. - * This is done via the capture descriptor. + * An Event Rule Matches condition can also specify a payload to be captured at + * runtime. This is done via the capture descriptor. * * Note: the dynamic runtime capture of payload is only available for the * trigger notification subsystem. */ /* - * Create a newly allocated on event condition. + * Create a newly allocated Event Rule Matches condition. * * Returns a new condition on success, NULL on failure. This condition must be * destroyed using lttng_condition_destroy(). */ -extern struct lttng_condition *lttng_condition_on_event_create( - struct lttng_event_rule *rule); +LTTNG_EXPORT extern struct lttng_condition * +lttng_condition_event_rule_matches_create(struct lttng_event_rule *rule); /* - * Get the rule property of a on event condition. + * Get the rule property of an Event Rule Matches condition. * * The caller does not assume the ownership of the returned rule. The * rule shall only be used for the duration of the condition's @@ -55,48 +56,48 @@ extern struct lttng_condition *lttng_condition_on_event_create( * Returns LTTNG_CONDITION_STATUS_OK and a pointer to the condition's rule * on success, LTTNG_CONDITION_STATUS_INVALID if an invalid * parameter is passed. */ -extern enum lttng_condition_status lttng_condition_on_event_get_rule( - const struct lttng_condition *condition, - const struct lttng_event_rule **rule); +LTTNG_EXPORT extern enum lttng_condition_status +lttng_condition_event_rule_matches_get_rule(const struct lttng_condition *condition, + const struct lttng_event_rule **rule); /** - * lttng_evaluation_on_event_hit are specialised lttng_evaluations which - * allow users to query a number of properties resulting from the evaluation - * of a condition which evaluated to true. + * lttng_evaluation_event_rule_matches_hit are specialised lttng_evaluations + * which allow users to query a number of properties resulting from the + * evaluation of a condition which evaluated to true. * - * The evaluation of an on event condition contains the captured event + * The evaluation of an Event Rule Matches condition contains the captured event * payload fields that were specified by the condition. */ /* - * Sets `*field_val` to the array event field value of the on event + * Sets `*field_val` to the array event field value of the Event Rule Matches * condition evaluation `evaluation` which contains its captured values. * * Returns: * - * `LTTNG_EVALUATION_ON_EVENT_STATUS_OK`: + * `LTTNG_EVALUATION_EVENT_RULE_MATCHES_STATUS_OK`: * Success. * * `*field_val` is an array event field value with a length of at * least one. * - * `LTTNG_EVALUATION_ON_EVENT_STATUS_INVALID`: + * `LTTNG_EVALUATION_EVENT_RULE_MATCHES_STATUS_INVALID`: * * `evaluation` is `NULL`. * * The type of the condition of `evaluation` is not - * `LTTNG_CONDITION_TYPE_ON_EVENT`. + * `LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES`. * * `field_val` is `NULL`. * - * `LTTNG_EVALUATION_ON_EVENT_STATUS_NONE`: + * `LTTNG_EVALUATION_EVENT_RULE_MATCHES_STATUS_NONE`: * * The condition of `evaluation` has no capture descriptors. */ -extern enum lttng_evaluation_on_event_status -lttng_evaluation_on_event_get_captured_values( - const struct lttng_evaluation *evaluation, - const struct lttng_event_field_value **field_val); +LTTNG_EXPORT extern enum lttng_evaluation_event_rule_matches_status +lttng_evaluation_event_rule_matches_get_captured_values( + const struct lttng_evaluation *evaluation, + const struct lttng_event_field_value **field_val); /* * Appends (transfering the ownership) the capture descriptor `expr` to - * the on event condition `condition`. + * the Event Rule Matches condition `condition`. * * Returns: * @@ -109,7 +110,7 @@ lttng_evaluation_on_event_get_captured_values( * `LTTNG_CONDITION_STATUS_INVALID`: * * `condition` is `NULL`. * * The type of `condition` is not - * `LTTNG_CONDITION_TYPE_ON_EVENT`. + * `LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES`. * * `expr` is `NULL`. * * `expr` is not a locator expression, that is, its type is not * one of: @@ -122,13 +123,12 @@ lttng_evaluation_on_event_get_captured_values( * `LTTNG_CONDITION_STATUS_UNSUPPORTED`: * * The associated event-rule does not support runtime capture. */ -extern enum lttng_condition_status -lttng_condition_on_event_append_capture_descriptor( - struct lttng_condition *condition, - struct lttng_event_expr *expr); +LTTNG_EXPORT extern enum lttng_condition_status +lttng_condition_event_rule_matches_append_capture_descriptor(struct lttng_condition *condition, + struct lttng_event_expr *expr); /* - * Sets `*count` to the number of capture descriptors in the on event + * Sets `*count` to the number of capture descriptors in the Event Rule Matches * condition `condition`. * * Returns: @@ -139,30 +139,30 @@ lttng_condition_on_event_append_capture_descriptor( * `LTTNG_CONDITION_STATUS_INVALID`: * * `condition` is `NULL`. * * The type of `condition` is not - * `LTTNG_CONDITION_TYPE_ON_EVENT`. + * `LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES`. * * `count` is `NULL`. */ -extern enum lttng_condition_status -lttng_condition_on_event_get_capture_descriptor_count( - const struct lttng_condition *condition, unsigned int *count); +LTTNG_EXPORT extern enum lttng_condition_status +lttng_condition_event_rule_matches_get_capture_descriptor_count( + const struct lttng_condition *condition, unsigned int *count); /* - * Returns the capture descriptor (borrowed) of the on event condition + * Returns the capture descriptor (borrowed) of the Event Rule Matches condition * `condition` at the index `index`, or `NULL` if: * * * `condition` is `NULL`. * * The type of `condition` is not - * `LTTNG_CONDITION_TYPE_ON_EVENT`. + * `LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES`. * * `index` is greater than or equal to the number of capture * descriptors in `condition` (as returned by - * lttng_condition_on_event_get_capture_descriptor_count()). + * lttng_condition_event_rule_matches_get_capture_descriptor_count()). */ -extern const struct lttng_event_expr * -lttng_condition_on_event_get_capture_descriptor_at_index( - const struct lttng_condition *condition, unsigned int index); +LTTNG_EXPORT extern const struct lttng_event_expr * +lttng_condition_event_rule_matches_get_capture_descriptor_at_index( + const struct lttng_condition *condition, unsigned int index); #ifdef __cplusplus } #endif -#endif /* LTTNG_CONDITION_ON_EVENT_H */ +#endif /* LTTNG_CONDITION_EVENT_RULE_MATCHES_H */