X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger.h;h=18ab06e505627d1539633dbf8ed1d707d4b9612d;hb=28f23191dcbf047429d51950a337a57d7a3f866a;hp=3b1cedda1fb4709457537ded9df978e206d6d3ca;hpb=2c30250238cbd1c1976aca903cacc4abbb4f59ce;p=lttng-tools.git diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h index 3b1cedda1..18ab06e50 100644 --- a/include/lttng/trigger/trigger.h +++ b/include/lttng/trigger/trigger.h @@ -8,8 +8,12 @@ #ifndef LTTNG_TRIGGER_H #define LTTNG_TRIGGER_H -#include +#include +#include +#include + #include +#include struct lttng_action; struct lttng_condition; @@ -36,11 +40,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. * @@ -65,8 +64,8 @@ enum lttng_trigger_firing_policy { * Trigger objects must be destroyed using the lttng_trigger_destroy() * function. */ -extern struct lttng_trigger *lttng_trigger_create( - struct lttng_condition *condition, struct lttng_action *action); +LTTNG_EXPORT extern struct lttng_trigger *lttng_trigger_create(struct lttng_condition *condition, + struct lttng_action *action); /* * Set the user identity (uid) of a trigger. @@ -77,8 +76,8 @@ extern struct lttng_trigger *lttng_trigger_create( * LTTNG_TRIGGER_STATUS_EPERM if not authorized, * LTTNG_TRIGGER_STATUS_INVALID if invalid parameters are passed. */ -extern enum lttng_trigger_status lttng_trigger_set_owner_uid( - struct lttng_trigger *trigger, uid_t uid); +LTTNG_EXPORT extern enum lttng_trigger_status +lttng_trigger_set_owner_uid(struct lttng_trigger *trigger, uid_t uid); /* * Get the user identity (uid) of a trigger. @@ -87,8 +86,8 @@ extern enum lttng_trigger_status lttng_trigger_set_owner_uid( * LTTNG_TRIGGER_STATUS_UNSET if unset, * LTTNG_TRIGGER_STATUS_INVALID if invalid parameters are passed. */ -extern enum lttng_trigger_status lttng_trigger_get_owner_uid( - const struct lttng_trigger *trigger, uid_t *uid); +LTTNG_EXPORT extern enum lttng_trigger_status +lttng_trigger_get_owner_uid(const struct lttng_trigger *trigger, uid_t *uid); /* * Get the condition of a trigger. @@ -97,11 +96,11 @@ extern enum lttng_trigger_status lttng_trigger_get_owner_uid( * * Returns a condition on success, NULL on error. */ -extern struct lttng_condition *lttng_trigger_get_condition( - struct lttng_trigger *trigger); +LTTNG_EXPORT 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); +LTTNG_EXPORT extern const struct lttng_condition * +lttng_trigger_get_const_condition(const struct lttng_trigger *trigger); /* * Get the action of a trigger. @@ -110,11 +109,10 @@ const struct lttng_condition *lttng_trigger_get_const_condition( * * Returns an action on success, NULL on error. */ -extern struct lttng_action *lttng_trigger_get_action( - struct lttng_trigger *trigger); +LTTNG_EXPORT 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); +LTTNG_EXPORT extern const struct lttng_action * +lttng_trigger_get_const_action(const struct lttng_trigger *trigger); /* * Get the name of a trigger. @@ -125,69 +123,39 @@ const struct lttng_action *lttng_trigger_get_const_action( * * Returns LTTNG_TRIGGER_STATUS_OK and a pointer to the trigger's name on * success, LTTNG_TRIGGER_STATUS_INVALID if an invalid parameter is passed, - * or LTTNG_TRIGGER_STATUS_UNSET if a name was not set prior to this call. + * or LTTNG_TRIGGER_STATUS_UNSET if the trigger is unnamed. */ -extern enum lttng_trigger_status lttng_trigger_get_name( - const struct lttng_trigger *trigger, const char **name); +LTTNG_EXPORT extern enum lttng_trigger_status +lttng_trigger_get_name(const struct lttng_trigger *trigger, const char **name); /* - * 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. + * Destroy (frees) a trigger object. */ -extern enum lttng_trigger_status lttng_trigger_set_name( - struct lttng_trigger *trigger, const char *name); +LTTNG_EXPORT extern void lttng_trigger_destroy(struct lttng_trigger *trigger); /* - * Set the trigger firing policy. - * - * This is optional. By default a trigger is set to fire each time the - * associated condition occurs. + * Register a trigger to the session daemon with a given name. * - * Threshold is the number of times the condition must be hit before the policy - * is enacted. + * The trigger object can be destroyed after this call. + * On success, this function will set the trigger's name to `name`. * - * Return LTTNG_TRIGGER_STATUS_OK on success, LTTNG_TRIGGER_STATUS_INVALID - * if invalid parameters are passed. + * Returns an LTTng status code. */ -extern enum lttng_trigger_status lttng_trigger_set_firing_policy( - struct lttng_trigger *trigger, - enum lttng_trigger_firing_policy policy_type, - uint64_t threshold); +LTTNG_EXPORT extern enum lttng_error_code +lttng_register_trigger_with_name(struct lttng_trigger *trigger, const char *name); /* - * 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. - */ -extern void lttng_trigger_destroy(struct lttng_trigger *trigger); - -/* - * Register a trigger to the session daemon. + * Register a trigger to the session daemon, generating a unique name for its + * owner. * * The trigger can be destroyed after this call. + * On success, this function will set the trigger's name to the generated + * name. * - * Return 0 on success, a negative LTTng error code on error. + * Returns an LTTng status code. */ -extern int lttng_register_trigger(struct lttng_trigger *trigger); +LTTNG_EXPORT extern enum lttng_error_code +lttng_register_trigger_with_automatic_name(struct lttng_trigger *trigger); /* * Unregister a trigger from the session daemon. @@ -196,7 +164,7 @@ 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(const struct lttng_trigger *trigger); +LTTNG_EXPORT extern int lttng_unregister_trigger(const struct lttng_trigger *trigger); /* * List triggers for the current user. @@ -208,8 +176,7 @@ extern int lttng_unregister_trigger(const struct lttng_trigger *trigger); * * Returns LTTNG_OK on success, else a suitable LTTng error code. */ -extern enum lttng_error_code lttng_list_triggers( - struct lttng_triggers **triggers); +LTTNG_EXPORT extern enum lttng_error_code lttng_list_triggers(struct lttng_triggers **triggers); /* * Get a trigger from the set at a given index. @@ -220,8 +187,8 @@ extern enum lttng_error_code lttng_list_triggers( * * Returns a trigger, or NULL on error. */ -extern const struct lttng_trigger *lttng_triggers_get_at_index( - const struct lttng_triggers *triggers, unsigned int index); +LTTNG_EXPORT extern const struct lttng_trigger * +lttng_triggers_get_at_index(const struct lttng_triggers *triggers, unsigned int index); /* * Get the number of triggers in a trigger set. @@ -229,14 +196,26 @@ extern const struct lttng_trigger *lttng_triggers_get_at_index( * Return LTTNG_TRIGGER_STATUS_OK on success, * LTTNG_TRIGGER_STATUS_INVALID when invalid parameters are passed. */ -extern enum lttng_trigger_status lttng_triggers_get_count( - const struct lttng_triggers *triggers, unsigned int *count); +LTTNG_EXPORT extern enum lttng_trigger_status +lttng_triggers_get_count(const struct lttng_triggers *triggers, unsigned int *count); /* * Destroy a trigger set. */ -extern void lttng_triggers_destroy(struct lttng_triggers *triggers); +LTTNG_EXPORT extern void lttng_triggers_destroy(struct lttng_triggers *triggers); +/* + * Deprecated: invocations should be replaced by + * lttng_register_trigger_with_automatic_name(). + * + * Register a trigger to the session daemon. + * + * The trigger can be destroyed after this call. + * + * Return 0 on success, a negative LTTng error code on error. + */ +LTTNG_DEPRECATED("Use lttng_register_trigger_with_automatic_name") +LTTNG_EXPORT extern int lttng_register_trigger(struct lttng_trigger *trigger); #ifdef __cplusplus }