X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger.h;h=0a944a15af197d4fe2870e99f496531296b1e177;hb=4bd69c5f1161cd065f487da0f4c1aa03a73c47e4;hp=6490af118a4333eb857d203d46dfce05a78455aa;hpb=e45dd625d3e802d8e6e2ec3de180c73546e8f9fe;p=lttng-tools.git diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h index 6490af118..0a944a15a 100644 --- a/include/lttng/trigger/trigger.h +++ b/include/lttng/trigger/trigger.h @@ -9,7 +9,10 @@ #define LTTNG_TRIGGER_H #include +#include #include +#include +#include struct lttng_action; struct lttng_condition; @@ -60,7 +63,7 @@ enum lttng_trigger_status { * Trigger objects must be destroyed using the lttng_trigger_destroy() * function. */ -extern struct lttng_trigger *lttng_trigger_create( +LTTNG_EXPORT extern struct lttng_trigger *lttng_trigger_create( struct lttng_condition *condition, struct lttng_action *action); /* @@ -72,7 +75,7 @@ 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( +LTTNG_EXPORT extern enum lttng_trigger_status lttng_trigger_set_owner_uid( struct lttng_trigger *trigger, uid_t uid); /* @@ -82,7 +85,7 @@ 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( +LTTNG_EXPORT extern enum lttng_trigger_status lttng_trigger_get_owner_uid( const struct lttng_trigger *trigger, uid_t *uid); /* @@ -92,10 +95,10 @@ 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( +LTTNG_EXPORT extern struct lttng_condition *lttng_trigger_get_condition( struct lttng_trigger *trigger); -const struct lttng_condition *lttng_trigger_get_const_condition( +LTTNG_EXPORT extern const struct lttng_condition *lttng_trigger_get_const_condition( const struct lttng_trigger *trigger); /* @@ -105,10 +108,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( +LTTNG_EXPORT extern struct lttng_action *lttng_trigger_get_action( struct lttng_trigger *trigger); -const struct lttng_action *lttng_trigger_get_const_action( +LTTNG_EXPORT extern const struct lttng_action *lttng_trigger_get_const_action( const struct lttng_trigger *trigger); /* @@ -120,38 +123,40 @@ 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( +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); /* - * Destroy (frees) a trigger object. + * Register a trigger to the session daemon with a given name. + * + * The trigger object can be destroyed after this call. + * On success, this function will set the trigger's name to `name`. + * + * Returns an LTTng status code. */ -extern void lttng_trigger_destroy(struct lttng_trigger *trigger); +LTTNG_EXPORT extern enum lttng_error_code lttng_register_trigger_with_name( + struct lttng_trigger *trigger, + const char *name); /* - * 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. @@ -160,7 +165,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. @@ -172,7 +177,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( +LTTNG_EXPORT extern enum lttng_error_code lttng_list_triggers( struct lttng_triggers **triggers); /* @@ -184,7 +189,7 @@ 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( +LTTNG_EXPORT extern const struct lttng_trigger *lttng_triggers_get_at_index( const struct lttng_triggers *triggers, unsigned int index); /* @@ -193,14 +198,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( +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 }