X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger.h;h=6490af118a4333eb857d203d46dfce05a78455aa;hp=a0c312ddd1e92e2efdb94c6affcbb942696198ff;hb=0efb2ad7fc448283184e43d6fb0915febae45384;hpb=5c504c41e4d470012cb98c849aa82086d1ba1bde diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h index a0c312ddd..6490af118 100644 --- a/include/lttng/trigger/trigger.h +++ b/include/lttng/trigger/trigger.h @@ -36,11 +36,6 @@ 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. * @@ -49,8 +44,14 @@ enum lttng_trigger_firing_policy { * in the emission of a notification to clients listening through * notification channels. * - * The caller retains the ownership of both the condition and action - * and both must be kept alive for the lifetime of the trigger object. + * Prior to 2.13, the caller had to retain the ownership of both the condition + * and action. Both objects had to be kept alive for the lifetime of the trigger + * object. This is no longer the case as the condition and action objects are + * internally reference counted. It is safe to destroy a condition and an action + * after using them to create a trigger. However, they should no longer be used. + * + * If the action is a notification action with capture descriptors, + * the condition must be an event rule condition. * * A trigger must be registered in order to become activate and can * be destroyed after its registration. @@ -94,6 +95,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. * @@ -104,6 +108,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. @@ -133,37 +139,6 @@ 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. */ @@ -185,7 +160,20 @@ extern int lttng_register_trigger(struct lttng_trigger *trigger); * * Return 0 on success, a negative LTTng error code on error. */ -extern int lttng_unregister_trigger(struct lttng_trigger *trigger); +extern int lttng_unregister_trigger(const 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.