Docs: connection_find_by_sock() must be called with rcu_read_lock

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/src/bin/lttng-relayd/connection.c b/src/bin/lttng-relayd/connection.c
index 4cf87ad3471d87e21fb31943ec082cc00b597196..477117b3d7e210d55a06ea6d1fab8d39848f2398 100644 (file)
--- a/src/bin/lttng-relayd/connection.c
+++ b/src/bin/lttng-relayd/connection.c
@@ -31,6 +31,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;