Backport: trackers: update liblttng-ctl

[lttng-tools.git] / include / lttng / session.h

diff --git a/include/lttng/session.h b/include/lttng/session.h
index e0594d2e82e452bf072d90899b945b2afc31be3c..4a7f0c8c5bdac292a9532161d88b5a06d0613c35 100644 (file)
--- a/include/lttng/session.h
+++ b/include/lttng/session.h
@@ -22,6 +22,33 @@
 extern "C" {
 #endif
 
+#include <lttng/constant.h>
+
+enum lttng_tracker_type {
+       LTTNG_TRACKER_PID = 0,
+       LTTNG_TRACKER_VPID,
+       LTTNG_TRACKER_UID,
+       LTTNG_TRACKER_GID,
+       LTTNG_TRACKER_VUID,
+       LTTNG_TRACKER_VGID,
+};
+
+enum lttng_tracker_id_type {
+       LTTNG_ID_UNKNOWN = -1,
+
+       LTTNG_ID_ALL,
+       LTTNG_ID_VALUE,
+       LTTNG_ID_STRING,
+};
+
+struct lttng_tracker_id {
+       enum lttng_tracker_id_type type;
+       int value;
+       char *string;
+};
+
+struct lttng_handle;
+
 /*
  * Basic session information.
  *
@@ -32,7 +59,7 @@ extern "C" {
  */
 #define LTTNG_SESSION_PADDING1             12
 struct lttng_session {
-       char name[NAME_MAX];
+       char name[LTTNG_NAME_MAX];
        /* The path where traces are written */
        char path[PATH_MAX];
        uint32_t enabled;       /* enabled/started: 1, disabled/stopped: 0 */
@@ -90,12 +117,25 @@ extern int lttng_create_session_live(const char *name, const char *url,
  * The session will not be usable, tracing will be stopped thus buffers will be
  * flushed.
  *
+ * This call will wait for data availability for each domain of the session,
+ * which can take an arbitrary amount of time. However, when returning the
+ * tracing data is guaranteed to be ready to be read and analyzed.
+ *
+ * lttng_destroy_session_no_wait() may be used if such a guarantee is not
+ * needed.
+ *
  * The name can't be NULL here.
  *
  * Return 0 on success else a negative LTTng error code.
  */
 extern int lttng_destroy_session(const char *name);
 
+/*
+ * Behaves exactly like lttng_destroy_session but does not wait for data
+ * availability.
+ */
+extern int lttng_destroy_session_no_wait(const char *name);
+
 /*
  * List all the tracing sessions.
  *
@@ -116,6 +156,48 @@ extern int lttng_list_sessions(struct lttng_session **sessions);
 extern int lttng_set_session_shm_path(const char *session_name,
                const char *shm_path);
 
+/*
+ * Add ID to session tracker.
+ *
+ * tracker_type is the type of tracker.
+ * An id argument >= 0 adds the ID to the session tracker.
+ * An id argument of -1 means "track all IDs".
+ *
+ * Return 0 on success else a negative LTTng error code.
+ */
+extern int lttng_track_id(struct lttng_handle *handle,
+               enum lttng_tracker_type tracker_type,
+               struct lttng_tracker_id *id);
+
+/*
+ * Remove ID from session tracker.
+ *
+ * tracker_type is the type of tracker.
+ * An id argument >= 0 removes the ID from the session tracker.
+ * An id argument of -1 means "untrack all IDs".
+ *
+ * Return 0 on success else a negative LTTng error code.
+ */
+extern int lttng_untrack_id(struct lttng_handle *handle,
+               enum lttng_tracker_type tracker_type,
+               struct lttng_tracker_id *id);
+
+/*
+ * List IDs in the tracker.
+ *
+ * tracker_type is the type of tracker.
+ * ids is set to an allocated array of IDs currently tracked. On
+ * success, ids and the strings it contains must be freed by the
+ * caller.
+ * nr_ids is set to the number of entries contained by the ids array.
+ *
+ * Returns 0 on success, else a negative LTTng error code.
+ */
+extern int lttng_list_tracker_ids(struct lttng_handle *handle,
+               enum lttng_tracker_type tracker_type,
+               struct lttng_tracker_id **ids,
+               size_t *nr_ids);
+
 /*
  * Add PID to session tracker.
  *