X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger.h;h=842203ace0f145f17ecbee0389762671acbeea83;hp=e92897fd541e79accfeac412393dd780e1014a4d;hb=657d1bf105996bf8f6e13af697fb1112afa61b28;hpb=64eafdf60552bbd7e22fb1c8fc8fc2b42a3cf68b

diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h
index e92897fd5..842203ace 100644
--- a/include/lttng/trigger/trigger.h
+++ b/include/lttng/trigger/trigger.h
@@ -9,10 +9,15 @@
 #define LTTNG_TRIGGER_H
 
 #include <sys/types.h>
+#include <lttng/constant.h>
+#include <inttypes.h>
+#include <lttng/lttng-error.h>
 
 struct lttng_action;
 struct lttng_condition;
 struct lttng_trigger;
+/* A set of triggers. */
+struct lttng_triggers;
 
 #ifdef __cplusplus
 extern "C" {
@@ -41,8 +46,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.
@@ -86,6 +97,9 @@ extern enum lttng_trigger_status lttng_trigger_get_owner_uid(
 extern struct lttng_condition *lttng_trigger_get_condition(
 		struct lttng_trigger *trigger);
 
+extern const struct lttng_condition *lttng_trigger_get_const_condition(
+		const struct lttng_trigger *trigger);
+
 /*
  * Get the action of a trigger.
  *
@@ -96,19 +110,52 @@ extern struct lttng_condition *lttng_trigger_get_condition(
 extern struct lttng_action *lttng_trigger_get_action(
 		struct lttng_trigger *trigger);
 
+extern const struct lttng_action *lttng_trigger_get_const_action(
+		const struct lttng_trigger *trigger);
+
+/*
+ * Get the name of a trigger.
+ *
+ * The caller does not assume the ownership of the returned name.
+ * The name shall only only be used for the duration of the trigger's
+ * lifetime, or until a different name is set.
+ *
+ * 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 the trigger is unnamed.
+ */
+extern enum lttng_trigger_status lttng_trigger_get_name(
+		const struct lttng_trigger *trigger, const char **name);
+
 /*
  * 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 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 enum lttng_error_code lttng_register_trigger_with_name(
+		struct lttng_trigger *trigger,
+		const char *name);
+
+/*
+ * 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);
+extern enum lttng_error_code lttng_register_trigger_with_automatic_name(
+		struct lttng_trigger *trigger);
 
 /*
  * Unregister a trigger from the session daemon.
@@ -117,7 +164,59 @@ 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.
+ *
+ * Note that the trigger set maintains the ownership of the returned trigger.
+ * It must not be destroyed by the user, nor should a reference to it be held
+ * beyond the lifetime of the trigger set.
+ *
+ * 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);
+
+/*
+ * Get the number of triggers in a trigger set.
+ *
+ * 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);
+
+/*
+ * Destroy a trigger set.
+ */
+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")
+extern int lttng_register_trigger(struct lttng_trigger *trigger);
 
 #ifdef __cplusplus
 }