X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger-internal.h;h=69226bce75b3a5f45dfba06584e8192ff8195ef5;hb=48a4000561343808724f7cb5fa8c131877489ccd;hp=6942ece78d7a88d9b15a2585fdb200e43f0261f8;hpb=a02903c0743cebd1f51227905ee89e571b84acbc;p=lttng-tools.git diff --git a/include/lttng/trigger/trigger-internal.h b/include/lttng/trigger/trigger-internal.h index 6942ece78..69226bce7 100644 --- a/include/lttng/trigger/trigger-internal.h +++ b/include/lttng/trigger/trigger-internal.h @@ -8,18 +8,25 @@ #ifndef LTTNG_TRIGGER_INTERNAL_H #define LTTNG_TRIGGER_INTERNAL_H -#include #include #include #include #include -#include +#include +#include #include +#include #include #include +#if defined(__cplusplus) +extern "C" { +#endif + struct lttng_payload; struct lttng_payload_view; +struct mi_writer; +struct mi_lttng_error_query_callbacks; struct lttng_trigger { /* Reference counting is only exposed to internal users. */ @@ -36,6 +43,42 @@ struct lttng_trigger { * 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; + + /* + * A "hidden" trigger is a trigger that is not externally listed. + * It is used to hide triggers that are used internally by the session + * daemon so that they can't be listed nor unregistered by external + * clients. + * + * This is a property that can only be set internally by the session + * daemon. As such, it is not serialized nor set by a + * "create_from_buffer" constructor. + * + * The hidden property is preserved by copies. + * + * Note that notifications originating from an "hidden" trigger will not + * be sent to clients that are not within the session daemon's process. + */ + bool is_hidden; + + /* + * The lock is used to protect against concurrent trigger execution and + * trigger removal. + */ + pthread_mutex_t lock; }; struct lttng_triggers { @@ -66,55 +109,49 @@ struct lttng_triggers_comm { char payload[]; }; -LTTNG_HIDDEN ssize_t lttng_trigger_create_from_payload(struct lttng_payload_view *view, struct lttng_trigger **trigger); -LTTNG_HIDDEN 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( struct lttng_trigger *dst, const struct lttng_trigger *src); -LTTNG_HIDDEN void lttng_trigger_set_tracer_token( struct lttng_trigger *trigger, uint64_t token); -LTTNG_HIDDEN uint64_t lttng_trigger_get_tracer_token(const struct lttng_trigger *trigger); -LTTNG_HIDDEN int lttng_trigger_generate_name(struct lttng_trigger *trigger, uint64_t unique_id); -LTTNG_HIDDEN bool lttng_trigger_is_equal( const struct lttng_trigger *a, const struct lttng_trigger *b); -LTTNG_HIDDEN +bool lttng_trigger_is_hidden(const struct lttng_trigger *trigger); + +void lttng_trigger_set_hidden(struct lttng_trigger *trigger); + void lttng_trigger_get(struct lttng_trigger *trigger); -LTTNG_HIDDEN void lttng_trigger_put(struct lttng_trigger *trigger); +/* + * Serialize a trigger to a mi_writer. + * Return LTTNG_OK in success, other enum lttng_error_code on error. + */ +enum lttng_error_code lttng_trigger_mi_serialize(const struct lttng_trigger *trigger, + struct mi_writer *writer, + const struct mi_lttng_error_query_callbacks + *error_query_callbacks); + /* * Allocate a new set of triggers. * The returned object must be freed via lttng_triggers_destroy. */ -LTTNG_HIDDEN struct lttng_triggers *lttng_triggers_create(void); /* @@ -127,7 +164,6 @@ struct lttng_triggers *lttng_triggers_create(void); * The ownership of the trigger set element is NOT transfered. * The returned object can NOT be freed via lttng_trigger_destroy. */ -LTTNG_HIDDEN struct lttng_trigger *lttng_triggers_borrow_mutable_at_index( const struct lttng_triggers *triggers, unsigned int index); @@ -137,28 +173,117 @@ struct lttng_trigger *lttng_triggers_borrow_mutable_at_index( * A reference to the added trigger is acquired on behalf of the trigger set * on success. */ -LTTNG_HIDDEN int lttng_triggers_add( struct lttng_triggers *triggers, struct lttng_trigger *trigger); +/* + * Remove all triggers marked as hidden from the provided trigger set. + */ +int lttng_triggers_remove_hidden_triggers(struct lttng_triggers *triggers); + /* * Serialize a trigger set to an lttng_payload object. * Return LTTNG_OK on success, negative lttng error code on error. */ -LTTNG_HIDDEN int lttng_triggers_serialize(const struct lttng_triggers *triggers, struct lttng_payload *payload); -LTTNG_HIDDEN ssize_t lttng_triggers_create_from_payload(struct lttng_payload_view *view, struct lttng_triggers **triggers); -LTTNG_HIDDEN +/* + * Serialize a trigger set to a mi_writer. + * Return LTTNG_OK in success, other enum lttng_error_code on error. + */ +enum lttng_error_code lttng_triggers_mi_serialize(const struct lttng_triggers *triggers, + struct mi_writer *writer, + const struct mi_lttng_error_query_callbacks + *error_query_callbacks); + const struct lttng_credentials *lttng_trigger_get_credentials( const struct lttng_trigger *trigger); -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. + */ +enum lttng_domain_type lttng_trigger_get_underlying_domain_type_restriction( + const struct lttng_trigger *trigger); + +/* + * Generate any bytecode related to the trigger. + * On success LTTNG_OK. On error, returns lttng_error code. + */ +enum lttng_error_code lttng_trigger_generate_bytecode( + struct lttng_trigger *trigger, + const struct lttng_credentials *creds); + +/* + * 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. + */ +struct lttng_trigger *lttng_trigger_copy(const struct lttng_trigger *trigger); + +/* + * A given trigger needs a tracer notifier if + * it has an event-rule condition, + * AND + * it has one or more sessiond-execution action. + */ +bool lttng_trigger_needs_tracer_notifier(const struct lttng_trigger *trigger); + +void lttng_trigger_set_as_registered(struct lttng_trigger *trigger); + +void lttng_trigger_set_as_unregistered(struct lttng_trigger *trigger); + +/* + * 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`. + */ +bool lttng_trigger_is_registered(struct lttng_trigger *trigger); + +void lttng_trigger_lock(struct lttng_trigger *trigger); + +void lttng_trigger_unlock(struct lttng_trigger *trigger); + +enum lttng_trigger_status lttng_trigger_add_error_results( + const struct lttng_trigger *trigger, + struct lttng_error_query_results *results); + +enum lttng_trigger_status lttng_trigger_condition_add_error_results( + const struct lttng_trigger *trigger, + struct lttng_error_query_results *results); + +enum lttng_trigger_status lttng_trigger_add_action_error_query_results( + struct lttng_trigger *trigger, + 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. + */ +enum lttng_trigger_status lttng_trigger_set_name( + struct lttng_trigger *trigger, const char *name); + +#if defined(__cplusplus) +} +#endif + #endif /* LTTNG_TRIGGER_INTERNAL_H */