diff mbox series

[v2,4/4] userspace-rcu: Add a brief description of rculflist in cds-api.md

Message ID 1564407331-25820-5-git-send-email-junchangwang@gmail.com
State New
Headers show
Series userspace-rcu: Add lock-free, ordered singly linked list | expand

Commit Message

Junchang Wang July 29, 2019, 1:35 p.m. UTC
Signed-off-by: Junchang Wang <junchangwang at gmail.com>
 doc/cds-api.md | 7 +++++++
 1 file changed, 7 insertions(+)
diff mbox series


diff --git a/doc/cds-api.md b/doc/cds-api.md
index 49a3c7c..577126a 100644
--- a/doc/cds-api.md
+++ b/doc/cds-api.md
@@ -82,3 +82,10 @@  are supported. Provides "uniquify add" and "replace add"
 operations, along with associated read-side traversal uniqueness
 guarantees. Automatic hash table resize based on number of
 elements is supported. See the API for more details.
+### `urcu/rculflist.h`
+Ordered singly linked list with lock-free insert, delete and find operations.
+This list relies on RCU for existence guarantees and ABA-problem prevention.
+It is useful for implementing hash tables.