X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger.h;h=18ab06e505627d1539633dbf8ed1d707d4b9612d;hb=HEAD;hp=b8e6080d9519a7edaaab43ca291c7c45f56e685d;hpb=a02903c0743cebd1f51227905ee89e571b84acbc;p=lttng-tools.git

diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h
index b8e6080d9..18ab06e50 100644
--- a/include/lttng/trigger/trigger.h
+++ b/include/lttng/trigger/trigger.h
@@ -8,6 +8,11 @@
 #ifndef LTTNG_TRIGGER_H
 #define LTTNG_TRIGGER_H
 
+#include <lttng/constant.h>
+#include <lttng/lttng-error.h>
+#include <lttng/lttng-export.h>
+
+#include <inttypes.h>
 #include <sys/types.h>
 
 struct lttng_action;
@@ -43,8 +48,14 @@ enum lttng_trigger_status {
  * 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.
@@ -53,8 +64,8 @@ enum lttng_trigger_status {
  * 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.
@@ -65,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.
@@ -75,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.
@@ -85,8 +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);
+
+LTTNG_EXPORT extern const struct lttng_condition *
+lttng_trigger_get_const_condition(const struct lttng_trigger *trigger);
 
 /*
  * Get the action of a trigger.
@@ -95,9 +109,10 @@ extern struct lttng_condition *lttng_trigger_get_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);
 
+LTTNG_EXPORT extern const struct lttng_action *
+lttng_trigger_get_const_action(const struct lttng_trigger *trigger);
 
 /*
  * Get the name of a trigger.
@@ -108,38 +123,39 @@ extern struct lttng_action *lttng_trigger_get_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);
 
 /*
- * 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.
@@ -148,7 +164,19 @@ 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);
+LTTNG_EXPORT 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.
+ */
+LTTNG_EXPORT extern enum lttng_error_code lttng_list_triggers(struct lttng_triggers **triggers);
 
 /*
  * Get a trigger from the set at a given index.
@@ -159,8 +187,8 @@ extern int lttng_unregister_trigger(struct lttng_trigger *trigger);
  *
  * 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.
@@ -168,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
 }