From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Wed, 10 Apr 2019 15:14:03 +0000 (-0400)
Subject: ust-ctl API: clarify getter usage requirements
X-Git-Tag: v2.10.4~6
X-Git-Url: http://git.lttng.org/?p=lttng-ust.git;a=commitdiff_plain;h=cac721e112c0f1c2f8cc5bc1fc6c7bbfe9115b62

ust-ctl API: clarify getter usage requirements

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/include/lttng/ust-ctl.h b/include/lttng/ust-ctl.h
index f83124d1..be2b00ee 100644
--- a/include/lttng/ust-ctl.h
+++ b/include/lttng/ust-ctl.h
@@ -240,6 +240,12 @@ void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
 		int producer_active);
 
 /* index */
+
+/*
+ * Getters which need to be used on the current packet (between get/put
+ * or get_next/put_next.
+ */
+
 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
 		uint64_t *timestamp_begin);
 int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
@@ -250,15 +256,26 @@ int ustctl_get_content_size(struct ustctl_consumer_stream *stream,
 	uint64_t *content_size);
 int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
 	uint64_t *packet_size);
-int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
-		uint64_t *stream_id);
-int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
-		uint64_t *ts);
 int ustctl_get_sequence_number(struct ustctl_consumer_stream *stream,
 		uint64_t *seq);
+
+/*
+ * Getter returning state invariant for the stream, which can be used
+ * without "get" operation.
+ */
+
+int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
+		uint64_t *stream_id);
 int ustctl_get_instance_id(struct ustctl_consumer_stream *stream,
 		uint64_t *id);
 
+/*
+ * Getter returning the current timestamp as perceived from the
+ * tracer.
+ */
+int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
+		uint64_t *ts);
+
 /* returns whether UST has perf counters support. */
 int ustctl_has_perf_counters(void);