X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger.h;h=2a7d4e36bf1b1c26f94b2666f159259f89b60763;hp=b8e6080d9519a7edaaab43ca291c7c45f56e685d;hb=0de2479d5f5a287d31c69e34ea5202a69019f224;hpb=a02903c0743cebd1f51227905ee89e571b84acbc diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h index b8e6080d9..2a7d4e36b 100644 --- a/include/lttng/trigger/trigger.h +++ b/include/lttng/trigger/trigger.h @@ -9,6 +9,7 @@ #define LTTNG_TRIGGER_H #include +#include struct lttng_action; struct lttng_condition; @@ -35,6 +36,11 @@ enum lttng_trigger_status { LTTNG_TRIGGER_STATUS_PERMISSION_DENIED = -6, }; +enum lttng_trigger_firing_policy { + LTTNG_TRIGGER_FIRING_POLICY_EVERY_N = 0, + LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N = 1, +}; + /* * Create a trigger object associating a condition and an action. * @@ -88,6 +94,9 @@ extern enum lttng_trigger_status lttng_trigger_get_owner_uid( extern struct lttng_condition *lttng_trigger_get_condition( struct lttng_trigger *trigger); +const struct lttng_condition *lttng_trigger_get_const_condition( + const struct lttng_trigger *trigger); + /* * Get the action of a trigger. * @@ -98,6 +107,8 @@ extern struct lttng_condition *lttng_trigger_get_condition( extern struct lttng_action *lttng_trigger_get_action( struct lttng_trigger *trigger); +const struct lttng_action *lttng_trigger_get_const_action( + const struct lttng_trigger *trigger); /* * Get the name of a trigger. @@ -127,6 +138,37 @@ extern enum lttng_trigger_status lttng_trigger_get_name( extern enum lttng_trigger_status lttng_trigger_set_name( struct lttng_trigger *trigger, const char *name); +/* + * Set the trigger firing policy. + * + * This is optional. By default a trigger is set to fire each time the + * associated condition occurs. + * + * Threshold is the number of times the condition must be hit before the policy + * is enacted. + * + * Return LTTNG_TRIGGER_STATUS_OK on success, LTTNG_TRIGGER_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_trigger_status lttng_trigger_set_firing_policy( + struct lttng_trigger *trigger, + enum lttng_trigger_firing_policy policy_type, + uint64_t threshold); + +/* + * Get the trigger firing policy. + * + * Threshold is the number of time the condition must be hit before the policy is + * enacted. + * + * Return LTTNG_TRIGGER_STATUS_OK on success, LTTNG_TRIGGER_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_trigger_status lttng_trigger_get_firing_policy( + const struct lttng_trigger *trigger, + enum lttng_trigger_firing_policy *policy_type, + uint64_t *threshold); + /* * Destroy (frees) a trigger object. */ @@ -150,6 +192,19 @@ extern int lttng_register_trigger(struct lttng_trigger *trigger); */ extern int lttng_unregister_trigger(struct lttng_trigger *trigger); +/* + * List triggers for the current user. + * + * On success, a newly-allocated trigger set is returned. + * + * The trigger set must be destroyed by the caller (see + * lttng_triggers_destroy()). + * + * Returns LTTNG_OK on success, else a suitable LTTng error code. + */ +extern enum lttng_error_code lttng_list_triggers( + struct lttng_triggers **triggers); + /* * Get a trigger from the set at a given index. *