Docs: connection_find_by_sock() must be called with rcu_read_lock

[lttng-tools.git] / src / bin / lttng-relayd / connection.c

diff --git a/src/bin/lttng-relayd/connection.c b/src/bin/lttng-relayd/connection.c
index 2376a3f29c973c45b3671e0eea413f06cea24deb..76e48a6ab7762a11b1ead8a0fb09c854e3ceb1e5 100644 (file)
--- a/src/bin/lttng-relayd/connection.c
+++ b/src/bin/lttng-relayd/connection.c
@@ -32,6 +32,10 @@ static void rcu_free_connection(struct rcu_head *head)
        connection_free(conn);
 }
 
+/*
+ * Must be called with a read side lock held. The read side lock must be
+ * kept until the returned relay_connection is no longer in use.
+ */
 struct relay_connection *connection_find_by_sock(struct lttng_ht *ht, int sock)
 {
        struct lttng_ht_node_ulong *node;