Document metadata_socket_lock nesting

[lttng-tools.git] / src / common / consumer-metadata-cache.h

diff --git a/src/common/consumer-metadata-cache.h b/src/common/consumer-metadata-cache.h
index 164f9eaae0689d68262e007278bbfc82a3a7d6ac..8f485d6390feda1e399de76348aa15fdf371ef5d 100644 (file)
--- a/src/common/consumer-metadata-cache.h
+++ b/src/common/consumer-metadata-cache.h
@@ -25,9 +25,9 @@ struct consumer_metadata_cache {
        char *data;
        uint64_t cache_alloc_size;
        /*
-        * How many bytes from the cache were already sent to the ring buffer.
+        * How many bytes from the cache are written contiguously.
         */
-       uint64_t rb_pushed;
+       uint64_t contiguous;
        /*
         * How many bytes are written in the buffer (excluding the wholes).
         */
@@ -43,6 +43,8 @@ struct consumer_metadata_cache {
        /*
         * Lock to update the metadata cache and push into the ring_buffer
         * (ustctl_write_metadata_to_channel).
+        *
+        * This is nested INSIDE the consumer_data lock.
         */
        pthread_mutex_t lock;
 };