X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger-internal.h;h=02dcf5335afea316b60194fe13c3d2e36493faa6;hb=63dd3d7b5b0979c4b11a6bb8d0e4155120482977;hp=3b760e1675a83709e4e12bb2568d1957de8c0d39;hpb=58daac01d91347336f24e1fc1cacd4e7a3101e93;p=lttng-tools.git diff --git a/include/lttng/trigger/trigger-internal.h b/include/lttng/trigger/trigger-internal.h index 3b760e167..02dcf5335 100644 --- a/include/lttng/trigger/trigger-internal.h +++ b/include/lttng/trigger/trigger-internal.h @@ -8,13 +8,14 @@ #ifndef LTTNG_TRIGGER_INTERNAL_H #define LTTNG_TRIGGER_INTERNAL_H -#include #include #include #include #include -#include +#include +#include #include +#include #include #include @@ -30,17 +31,31 @@ struct lttng_trigger { char *name; /* For now only the uid portion of the credentials is used. */ struct lttng_credentials creds; - struct { - enum lttng_trigger_firing_policy type; - uint64_t threshold; - uint64_t current_count; - } firing_policy; /* * Internal use only. * The unique token passed to the tracer to identify an event-rule * notification. */ LTTNG_OPTIONAL(uint64_t) tracer_token; + + /* + * Is the trigger registered? + * + * This is necessary since a reference holder might be interested in the + * overall state of the trigger from the point of view of its owner. + * + * The main user is the action executor since we want to prevent the + * execution of actions related to a trigger that is unregistered. + * + * Not considered for `is_equal`. + */ + bool registered; + + /* + * The lock is used to protect against concurrent trigger execution and + * trigger removal. + */ + pthread_mutex_t lock; }; struct lttng_triggers { @@ -60,10 +75,6 @@ struct lttng_trigger_comm { uint32_t length; /* Includes '\0' terminator. */ uint32_t name_length; - /* Firing policy. */ - /* Maps to enum lttng_trigger_firing_policy. */ - uint8_t firing_policy_type; - uint64_t firing_policy_threshold; /* A null-terminated name, a condition, and an action follow. */ char payload[]; } LTTNG_PACKED; @@ -84,15 +95,7 @@ int lttng_trigger_serialize(const struct lttng_trigger *trigger, struct lttng_payload *payload); LTTNG_HIDDEN -const struct lttng_condition *lttng_trigger_get_const_condition( - const struct lttng_trigger *trigger); - -LTTNG_HIDDEN -const struct lttng_action *lttng_trigger_get_const_action( - const struct lttng_trigger *trigger); - -LTTNG_HIDDEN -bool lttng_trigger_validate(struct lttng_trigger *trigger); +bool lttng_trigger_validate(const struct lttng_trigger *trigger); LTTNG_HIDDEN int lttng_trigger_assign_name( @@ -170,35 +173,93 @@ LTTNG_HIDDEN void lttng_trigger_set_credentials(struct lttng_trigger *trigger, const struct lttng_credentials *creds); +/* + * Return the type of any underlying domain restriction. If no particular + * requirement is present, returns LTTNG_DOMAIN_NONE. + */ +LTTNG_HIDDEN +enum lttng_domain_type lttng_trigger_get_underlying_domain_type_restriction( + const struct lttng_trigger *trigger); /* - * Fire the trigger. - * Increments the occurrence count. + * Generate any bytecode related to the trigger. + * On success LTTNG_OK. On error, returns lttng_error code. */ LTTNG_HIDDEN -void lttng_trigger_fire(struct lttng_trigger *trigger); +enum lttng_error_code lttng_trigger_generate_bytecode( + struct lttng_trigger *trigger, + const struct lttng_credentials *creds); /* - * Check if the trigger would fire. + * Note that the trigger object is not locked by "copy" as it is const and + * used with a number of 'const' triggers. If the trigger could be shared at + * the moment of the copy, it is the caller's responsability to lock it for + * the duration of the copy. */ LTTNG_HIDDEN -bool lttng_trigger_should_fire(const struct lttng_trigger *trigger); +struct lttng_trigger *lttng_trigger_copy(const struct lttng_trigger *trigger); /* - * Return the type of any underlying domain restriction. If no particular - * requirement is present, returns LTTNG_DOMAIN_NONE. + * A given trigger needs a tracer notifier if + * it has an event-rule condition, + * AND + * it has one or more sessiond-execution action. */ LTTNG_HIDDEN -enum lttng_domain_type lttng_trigger_get_underlying_domain_type_restriction( - const struct lttng_trigger *trigger); +bool lttng_trigger_needs_tracer_notifier(const struct lttng_trigger *trigger); + +LTTNG_HIDDEN +void lttng_trigger_set_as_registered(struct lttng_trigger *trigger); + +LTTNG_HIDDEN +void lttng_trigger_set_as_unregistered(struct lttng_trigger *trigger); /* - * Generate any bytecode related to the trigger. - * On success LTTNG_OK. On error, returns lttng_error code. + * The trigger must be locked before calling lttng_trigger_is_registered. + * + * The lock is necessary since a trigger can be unregistered at any time. + * + * Manipulations requiring that the trigger be registered must always acquire + * the trigger lock for the duration of the manipulation using + * `lttng_trigger_lock` and `lttng_trigger_unlock`. */ LTTNG_HIDDEN -enum lttng_error_code lttng_trigger_generate_bytecode( +bool lttng_trigger_is_registered(struct lttng_trigger *trigger); + +LTTNG_HIDDEN +void lttng_trigger_lock(struct lttng_trigger *trigger); + +LTTNG_HIDDEN +void lttng_trigger_unlock(struct lttng_trigger *trigger); + +LTTNG_HIDDEN +enum lttng_trigger_status lttng_trigger_add_error_results( + const struct lttng_trigger *trigger, + struct lttng_error_query_results *results); + +LTTNG_HIDDEN +enum lttng_trigger_status lttng_trigger_condition_add_error_results( + const struct lttng_trigger *trigger, + struct lttng_error_query_results *results); + +LTTNG_HIDDEN +enum lttng_trigger_status lttng_trigger_add_action_error_query_results( struct lttng_trigger *trigger, - const struct lttng_credentials *creds); + struct lttng_error_query_results *results); + +/* + * Set the trigger name. + * + * A name is optional. + * A name will be assigned on trigger registration if no name is set. + * + * The name is copied. + * + * Return LTTNG_TRIGGER_STATUS_OK on success, LTTNG_TRIGGER_STATUS_INVALID + * if invalid parameters are passed. + */ +LTTNG_HIDDEN +enum lttng_trigger_status lttng_trigger_set_name( + struct lttng_trigger *trigger, const char *name); #endif /* LTTNG_TRIGGER_INTERNAL_H */