X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger-internal.h;h=e32ea737ea8a911c9dc56402601186d08c5a5a5d;hp=cff4504a7d71e3b656bce857d6307125a338ff94;hb=91c96f622ad9eadbf44a63b55289f673be9cf90e;hpb=ab5be9fa2eb5ba9600a82cd18fd3cfcbac69169a diff --git a/include/lttng/trigger/trigger-internal.h b/include/lttng/trigger/trigger-internal.h index cff4504a7..e32ea737e 100644 --- a/include/lttng/trigger/trigger-internal.h +++ b/include/lttng/trigger/trigger-internal.h @@ -9,32 +9,79 @@ #define LTTNG_TRIGGER_INTERNAL_H #include +#include +#include #include -#include -#include +#include #include #include #include +#include + +struct lttng_payload; +struct lttng_payload_view; struct lttng_trigger { + /* Reference counting is only exposed to internal users. */ + struct urcu_ref ref; + struct lttng_condition *condition; struct lttng_action *action; + 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; +}; + +struct lttng_triggers { + struct lttng_dynamic_pointer_array array; }; struct lttng_trigger_comm { - /* length excludes its own length. */ + /* + * Credentials, only the uid portion is used for now. + * Used as an override when desired by the root user. + */ + uint64_t uid; + /* + * Length of the variable length payload (name, condition, and + * an action). + */ uint32_t length; - /* A condition and action object follow. */ + /* 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; +struct lttng_triggers_comm { + uint32_t count; + uint32_t length; + /* Count * lttng_trigger_comm structure */ + char payload[]; +}; + LTTNG_HIDDEN -ssize_t lttng_trigger_create_from_buffer(const struct lttng_buffer_view *view, +ssize_t lttng_trigger_create_from_payload(struct lttng_payload_view *view, struct lttng_trigger **trigger); LTTNG_HIDDEN -int lttng_trigger_serialize(struct lttng_trigger *trigger, - struct lttng_dynamic_buffer *buf); +int lttng_trigger_serialize(const struct lttng_trigger *trigger, + struct lttng_payload *payload); LTTNG_HIDDEN const struct lttng_condition *lttng_trigger_get_const_condition( @@ -47,4 +94,102 @@ const struct lttng_action *lttng_trigger_get_const_action( LTTNG_HIDDEN bool lttng_trigger_validate(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 +void lttng_trigger_get(struct lttng_trigger *trigger); + +LTTNG_HIDDEN +void lttng_trigger_put(struct lttng_trigger *trigger); + +/* + * 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); + +/* + * Return the a pointer to a mutable element at index "index" of an + * lttng_triggers set. + * + * This differs from the public `lttng_triggers_get_at_index` in that + * the returned pointer to a mutable trigger. + * + * 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); + +/* + * Add a trigger to the triggers set. + * + * 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); + +/* + * 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 +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); + + +/* + * Fire the trigger. + * Increments the occurrence count. + */ +LTTNG_HIDDEN +void lttng_trigger_fire(struct lttng_trigger *trigger); + +/* + * Check if the trigger would fire. + */ +LTTNG_HIDDEN +bool lttng_trigger_should_fire(const struct lttng_trigger *trigger); + +/* + * 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); + #endif /* LTTNG_TRIGGER_INTERNAL_H */