rcuja: for each key iteration

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/tests/test_urcu_ja.c b/tests/test_urcu_ja.c
index a552db1b2e9ffb2e865705074b9bf6723e5549ff..5dd16618faa4cadd3db411b2998a85e148160121 100644 (file)
--- a/tests/test_urcu_ja.c
+++ b/tests/test_urcu_ja.c
@@ -223,6 +223,32 @@ printf("        [not -u nor -s] Add entries (supports redundant keys).\n");
        printf("\n\n");
 }
 
+static
+int test_free_all_nodes(struct cds_ja *ja)
+{
+       uint64_t key;
+       struct cds_ja_node *ja_node;
+       int ret = 0;
+
+       rcu_read_lock();
+       cds_ja_for_each_key_rcu(test_ja, key, ja_node) {
+               struct cds_ja_node *tmp_node;
+
+               cds_ja_for_each_duplicate_safe_rcu(ja_node, tmp_node) {
+                       ret = cds_ja_del(test_ja, key, ja_node);
+                       if (ret) {
+                               fprintf(stderr, "Error (%d) removing node %" PRIu64 "\n", ret, key);
+                               goto end;
+                       }
+                       /* Alone using Judy array, OK to free now */
+                       free_node(ja_node);
+               }
+       }
+end:
+       rcu_read_unlock();
+       return ret;
+}
+
 static
 int test_8bit_key(void)
 {
@@ -230,6 +256,7 @@ int test_8bit_key(void)
        uint64_t key;
        uint64_t ka[] = { 5, 17, 100, 222 };
        uint64_t ka_test_offset = 5;
+       struct cds_ja_node *ja_node;
 
        /* Test with 8-bit key */
        test_ja = cds_ja_new(8);
@@ -257,11 +284,9 @@ int test_8bit_key(void)
 
        printf("Test #2: successful key lookup (8-bit).\n");
        for (key = 0; key < 200; key++) {
-               struct cds_ja_node *node;
-
                rcu_read_lock();
-               node = cds_ja_lookup(test_ja, key);
-               if (!node) {
+               ja_node = cds_ja_lookup(test_ja, key);
+               if (!ja_node) {
                        fprintf(stderr, "Error lookup node %" PRIu64 "\n", key);
                        assert(0);
                }
@@ -270,11 +295,9 @@ int test_8bit_key(void)
        printf("OK\n");
        printf("Test #3: unsuccessful key lookup (8-bit).\n");
        for (key = 200; key < 240; key++) {
-               struct cds_ja_node *node;
-
                rcu_read_lock();
-               node = cds_ja_lookup(test_ja, key);
-               if (node) {
+               ja_node = cds_ja_lookup(test_ja, key);
+               if (ja_node) {
                        fprintf(stderr,
                                "Error unexpected lookup node %" PRIu64 "\n",
                                key);
@@ -285,7 +308,6 @@ int test_8bit_key(void)
        printf("OK\n");
        printf("Test #4: remove keys (8-bit).\n");
        for (key = 0; key < 200; key++) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
 
                rcu_read_lock();
@@ -328,7 +350,6 @@ int test_8bit_key(void)
        }
 
        for (i = 0; i < CAA_ARRAY_SIZE(ka); i++) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
                uint64_t result_key;
 
@@ -350,7 +371,6 @@ int test_8bit_key(void)
        }
 
        for (i = 0; i < CAA_ARRAY_SIZE(ka); i++) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
                uint64_t result_key;
 
@@ -372,7 +392,6 @@ int test_8bit_key(void)
        }
 
        for (i = 0; i < CAA_ARRAY_SIZE(ka); i++) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
                uint64_t result_key;
 
@@ -408,6 +427,12 @@ int test_8bit_key(void)
 
        printf("OK\n");
 
+       ret = test_free_all_nodes(test_ja);
+       if (ret) {
+               fprintf(stderr, "Error freeing all nodes\n");
+               return -1;
+       }
+
        ret = cds_ja_destroy(test_ja, free_node);
        if (ret) {
                fprintf(stderr, "Error destroying judy array\n");
@@ -423,6 +448,7 @@ int test_16bit_key(void)
        uint64_t key;
        uint64_t ka[] = { 105, 206, 4000, 4111, 59990, 65435 };
        uint64_t ka_test_offset = 100;
+       struct cds_ja_node *ja_node;
 
        /* Test with 16-bit key */
        test_ja = cds_ja_new(16);
@@ -452,11 +478,11 @@ int test_16bit_key(void)
        printf("Test #2: successful key lookup (16-bit).\n");
        for (key = 0; key < 10000; key++) {
        //for (key = 0; key < 65536; key+=256) {
-               struct cds_ja_node *node;
+               struct cds_ja_node *ja_node;
 
                rcu_read_lock();
-               node = cds_ja_lookup(test_ja, key);
-               if (!node) {
+               ja_node = cds_ja_lookup(test_ja, key);
+               if (!ja_node) {
                        fprintf(stderr, "Error lookup node %" PRIu64 "\n", key);
                        assert(0);
                }
@@ -465,11 +491,11 @@ int test_16bit_key(void)
        printf("OK\n");
        printf("Test #3: unsuccessful key lookup (16-bit).\n");
        for (key = 11000; key <= 11002; key++) {
-               struct cds_ja_node *node;
+               struct cds_ja_node *ja_node;
 
                rcu_read_lock();
-               node = cds_ja_lookup(test_ja, key);
-               if (node) {
+               ja_node = cds_ja_lookup(test_ja, key);
+               if (ja_node) {
                        fprintf(stderr,
                                "Error unexpected lookup node %" PRIu64 "\n",
                                key);
@@ -481,7 +507,6 @@ int test_16bit_key(void)
        printf("Test #4: remove keys (16-bit).\n");
        for (key = 0; key < 10000; key++) {
        //for (key = 0; key < 65536; key+=256) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
 
                rcu_read_lock();
@@ -524,7 +549,6 @@ int test_16bit_key(void)
        }
 
        for (i = 0; i < CAA_ARRAY_SIZE(ka); i++) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
                uint64_t result_key;
 
@@ -546,7 +570,6 @@ int test_16bit_key(void)
        }
 
        for (i = 0; i < CAA_ARRAY_SIZE(ka); i++) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
                uint64_t result_key;
 
@@ -568,7 +591,6 @@ int test_16bit_key(void)
        }
 
        for (i = 0; i < CAA_ARRAY_SIZE(ka); i++) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
                uint64_t result_key;
 
@@ -604,6 +626,12 @@ int test_16bit_key(void)
 
        printf("OK\n");
 
+       ret = test_free_all_nodes(test_ja);
+       if (ret) {
+               fprintf(stderr, "Error freeing all nodes\n");
+               return -1;
+       }
+
        ret = cds_ja_destroy(test_ja, free_node);
        if (ret) {
                fprintf(stderr, "Error destroying judy array\n");
@@ -620,6 +648,7 @@ int test_sparse_key(unsigned int bits, int nr_dup)
 {
        uint64_t key, max_key;
        int zerocount, i, ret;
+       struct cds_ja_node *ja_node;
 
        if (bits == 64)
                max_key = UINT64_MAX;
@@ -659,7 +688,6 @@ int test_sparse_key(unsigned int bits, int nr_dup)
        printf("Test #2: successful key lookup (%u-bit).\n", bits);
        zerocount = 0;
        for (key = 0; key <= max_key && (key != 0 || zerocount < 1); key += 1ULL << (bits - 8)) {
-               struct cds_ja_node *ja_node;
                struct ja_test_node *node;
                int count = 0;
 
@@ -684,8 +712,6 @@ int test_sparse_key(unsigned int bits, int nr_dup)
                printf("Test #3: unsuccessful key lookup (%u-bit).\n", bits);
                zerocount = 0;
                for (key = 0; key <= max_key && (key != 0 || zerocount < 1); key += 1ULL << (bits - 8)) {
-                       struct cds_ja_node *ja_node;
-
                        rcu_read_lock();
                        ja_node = cds_ja_lookup(test_ja, key + 42);
                        if (ja_node) {
@@ -703,7 +729,6 @@ int test_sparse_key(unsigned int bits, int nr_dup)
        printf("Test #4: remove keys (%u-bit).\n", bits);
        zerocount = 0;
        for (key = 0; key <= max_key && (key != 0 || zerocount < 1); key += 1ULL << (bits - 8)) {
-               struct cds_ja_node *ja_node;
                int count = 0;
 
                rcu_read_lock();
@@ -739,6 +764,12 @@ int test_sparse_key(unsigned int bits, int nr_dup)
        }
        printf("OK\n");
 
+       ret = test_free_all_nodes(test_ja);
+       if (ret) {
+               fprintf(stderr, "Error freeing all nodes\n");
+               return -1;
+       }
+
        ret = cds_ja_destroy(test_ja, free_node);
        if (ret) {
                fprintf(stderr, "Error destroying judy array\n");
@@ -1085,6 +1116,12 @@ int do_mt_test(void)
        }
        rcu_thread_online_qsbr();
 
+       ret = test_free_all_nodes(test_ja);
+       if (ret) {
+               fprintf(stderr, "Error freeing all nodes\n");
+               return -1;
+       }
+
        ret = cds_ja_destroy(test_ja, free_node);
        if (ret) {
                fprintf(stderr, "Error destroying judy array\n");

diff --git a/urcu/rcuja.h b/urcu/rcuja.h
index eb384941d6a7cde6d38c530a24702a505873ec9e..7546332d5ea2a2638a7543e23dc742318f39471a 100644 (file)
--- a/urcu/rcuja.h
+++ b/urcu/rcuja.h
@@ -169,14 +169,62 @@ int cds_ja_destroy(struct cds_ja *ja,
                void (*free_node_cb)(struct cds_ja_node *node));
 
 /*
+ * cds_ja_for_each_duplicate_rcu: Iterate through duplicates.
+ * @pos: struct cds_ja_node *, start of duplicate list and loop cursor.
+ *
  * Iterate through duplicates returned by cds_ja_lookup*()
  * This must be done while rcu_read_lock() is held.
  * Receives a struct cds_ja_node * as parameter, which is used as start
  * of duplicate list and loop cursor.
+ * _NOT_ safe against node removal within iteration.
  */
 #define cds_ja_for_each_duplicate_rcu(pos)                             \
        for (; (pos) != NULL; (pos) = rcu_dereference((pos)->next))
 
+/*
+ * cds_ja_for_each_duplicate_safe_rcu: Iterate through duplicates.
+ * @pos: struct cds_ja_node *, start of duplicate list and loop cursor.
+ * @p: struct cds_ja_node *, temporary pointer to next.
+ *
+ * Iterate through duplicates returned by cds_ja_lookup*()
+ * This must be done while rcu_read_lock() is held.
+ * Safe against node removal within iteration.
+ */
+#define cds_ja_for_each_duplicate_safe_rcu(pos, p)                     \
+       for (; (pos) != NULL ?                                          \
+                       ((p) = rcu_dereference((pos)->next), 1) : 0;    \
+                       (pos) = (p))
+
+/*
+ * cds_ja_for_each_key_rcu: Iterate over all keys in ascending order.
+ * @ja: Judy array on which iteration should be done.
+ * @key: Key cursor, needs to be a uint64_t.
+ * @pos: struct cds_ja_node *, used as loop cursor.
+ *
+ * Iterate over all keys of a RCU Judy array (_not_ duplicates) in
+ * ascending order.
+ * This must be done while rcu_read_lock() is held.
+ * Safe against node removal during iteration.
+ */
+#define cds_ja_for_each_key_rcu(ja, key, pos)                          \
+       for ((key) = 0;                                                 \
+               ((pos) = cds_ja_lookup_above_equal(ja, key, &(key))); )
+
+/*
+ * cds_ja_for_each_key_prev_rcu: Iterate over all keys in descending order.
+ * @ja: Judy array on which iteration should be done.
+ * @key: Key cursor, needs to be a uint64_t.
+ * @pos: struct cds_ja_node *, used as loop cursor.
+ *
+ * Iterate over all keys of a RCU Judy array (_not_ duplicates) in
+ * descending order.
+ * This must be done while rcu_read_lock() is held.
+ * Safe against node removal during iteration.
+ */
+#define cds_ja_for_each_key_prev_rcu(ja, key, pos)                     \
+       for ((key) = UINT64_MAX;                                        \
+               ((pos) = cds_ja_lookup_below_equal(ja, key, &(key))); )
+
 #ifdef __cplusplus
 }
 #endif