document consumer_metadata_cache_flushed use of consumer_data.lock

Reviewed-by: Julien Desfossez <julien.desfossez@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/src/common/consumer-metadata-cache.c b/src/common/consumer-metadata-cache.c
index c6e6c6b164a423b81dace0312ee3c71c9cb3626e..4c8a665af0db7aa1d5d8224edcfac96c5fc2fbb2 100644 (file)
--- a/src/common/consumer-metadata-cache.c
+++ b/src/common/consumer-metadata-cache.c
@@ -203,6 +203,11 @@ int consumer_metadata_cache_flushed(struct lttng_consumer_channel *channel,
 
        cache = channel->metadata_cache;
 
+       /*
+        * XXX This consumer_data.lock should eventually be replaced by
+        * a channel lock. It protects metadata_stream read and endpoint
+        * status check.
+        */
        pthread_mutex_lock(&consumer_data.lock);
        pthread_mutex_lock(&channel->lock);
        pthread_mutex_lock(&channel->metadata_cache->lock);