Add stream lock comment for nesting

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

diff --git a/src/common/consumer.h b/src/common/consumer.h
index df002f81a606c62f75db59bf23d752ec29743e62..53b6151822ba36102b6b6df5a53878ac35b714a7 100644 (file)
--- a/src/common/consumer.h
+++ b/src/common/consumer.h
@@ -141,7 +141,12 @@ struct lttng_consumer_stream {
        uint64_t relayd_stream_id;
        /* Next sequence number to use for trace packet */
        uint64_t next_net_seq_num;
-       /* Lock to use the stream FDs since they are used between threads. */
+       /*
+        * Lock to use the stream FDs since they are used between threads. Using
+        * this lock with network streaming, when using the control mutex of a
+        * consumer_relayd_sock_pair, make sure to acquire this lock BEFORE locking
+        * it and releasing it AFTER the control mutex unlock.
+        */
        pthread_mutex_t lock;
        /* Tracing session id */
        uint64_t session_id;