rcuja: document destroy requirement

[urcu.git] / urcu / rcuja.h

diff --git a/urcu/rcuja.h b/urcu/rcuja.h
index 2a0de286256b46bb12dabe07d95c85151ed16ccf..4570f1a89da4512184d8fd785a314934ad0d4075 100644 (file)
--- a/urcu/rcuja.h
+++ b/urcu/rcuja.h
@@ -143,11 +143,14 @@ struct cds_ja *cds_ja_new(unsigned int key_bits)
  * @rcu_free_node_cb: callback performing memory free of leftover nodes.
  *
  * Returns 0 on success, negative error value on error.
- * The @rcu_free_node_cb callback should internally wait for a grace
- * period before freeing the node.
+ * There should be no more concurrent add, delete, nor look-up performed
+ * on the Judy array while it is being destroyed (ensured by the caller).
+ * There is no need for the @rcu_free_node_cb callback to wait for grace
+ * periods, since there are no more concurrent users of the Judy array.
+ * RCU read-side lock should _not_ be held when calling this function.
  */
 int cds_ja_destroy(struct cds_ja *ja,
-               void (*rcu_free_node_cb)(struct cds_ja_node *node));
+               void (*free_node_cb)(struct cds_ja_node *node));
 
 /*
  * Iterate through duplicates returned by cds_ja_lookup*()