rcuja: rename cds_ja_node to cds_ja_inode
[userspace-rcu.git] / rcuja / rcuja.c
index 45ce8f70a816e4cca4188ab5d9c9a54bceb02655..a2815f2b8248e7e6e9689b8eb1dd9147c883c85b 100644 (file)
 #include <urcu/arch.h>
 #include <assert.h>
 #include <urcu-pointer.h>
+#include <stdint.h>
 
 #include "rcuja-internal.h"
 #include "bitfield.h"
 
-enum rcu_ja_type_class {
+enum cds_ja_type_class {
        RCU_JA_LINEAR = 0,      /* Type A */
                        /* 32-bit: 1 to 25 children, 8 to 128 bytes */
                        /* 64-bit: 1 to 28 children, 16 to 256 bytes */
@@ -49,8 +50,8 @@ enum rcu_ja_type_class {
        RCU_JA_NULL,    /* not an encoded type, but keeps code regular */
 };
 
-struct rcu_ja_type {
-       enum rcu_ja_type_class type_class;
+struct cds_ja_type {
+       enum cds_ja_type_class type_class;
        uint16_t min_child;             /* minimum number of children: 1 to 256 */
        uint16_t max_child;             /* maximum number of children: 1 to 256 */
        uint16_t max_linear_child;      /* per-pool max nr. children: 1 to 256 */
@@ -69,6 +70,7 @@ struct rcu_ja_type {
 #define JA_PTR_MASK    (~JA_TYPE_MASK)
 
 #define JA_ENTRY_PER_NODE      256UL
+#define JA_BITS_PER_BYTE       3
 
 /*
  * Entry for NULL node is at index 8 of the table. It is never encoded
@@ -123,7 +125,7 @@ enum {
        ja_type_6_nr_pool_order = 2,
 };
 
-const struct rcu_ja_type ja_types[] = {
+const struct cds_ja_type ja_types[] = {
        { .type_class = RCU_JA_LINEAR, .min_child = 1, .max_child = ja_type_0_max_child, .max_linear_child = ja_type_0_max_linear_child, .order = 3, },
        { .type_class = RCU_JA_LINEAR, .min_child = 1, .max_child = ja_type_1_max_child, .max_linear_child = ja_type_1_max_linear_child, .order = 4, },
        { .type_class = RCU_JA_LINEAR, .min_child = 3, .max_child = ja_type_2_max_child, .max_linear_child = ja_type_2_max_linear_child, .order = 5, },
@@ -171,7 +173,7 @@ enum {
        ja_type_6_nr_pool_order = 2,
 };
 
-const struct rcu_ja_type ja_types[] = {
+const struct cds_ja_type ja_types[] = {
        { .type_class = RCU_JA_LINEAR, .min_child = 1, .max_child = ja_type_0_max_child, .max_linear_child = ja_type_0_max_linear_child, .order = 4, },
        { .type_class = RCU_JA_LINEAR, .min_child = 1, .max_child = ja_type_1_max_child, .max_linear_child = ja_type_1_max_linear_child, .order = 5, },
        { .type_class = RCU_JA_LINEAR, .min_child = 3, .max_child = ja_type_2_max_child, .max_linear_child = ja_type_2_max_linear_child, .order = 6, },
@@ -199,7 +201,7 @@ void static_array_size_check(void)
 }
 
 /*
- * The rcu_ja_node contains the compressed node data needed for
+ * The cds_ja_node contains the compressed node data needed for
  * read-side. For linear and pool node configurations, it starts with a
  * byte counting the number of children in the node.  Then, the
  * node-specific data is placed.
@@ -214,7 +216,7 @@ void static_array_size_check(void)
        struct {                                                                                \
                uint8_t nr_child;                                                               \
                uint8_t child_value[ja_type_## index ##_max_linear_child];                      \
-               struct rcu_ja_node_flag *child_ptr[ja_type_## index ##_max_linear_child];       \
+               struct cds_ja_inode_flag *child_ptr[ja_type_## index ##_max_linear_child];      \
        }
 
 #define DECLARE_POOL_NODE(index)                                                               \
@@ -222,11 +224,11 @@ void static_array_size_check(void)
                struct {                                                                        \
                        uint8_t nr_child;                                                       \
                        uint8_t child_value[ja_type_## index ##_max_linear_child];              \
-                       struct rcu_ja_node_flag *child_ptr[ja_type_## index ##_max_linear_child]; \
+                       struct cds_ja_inode_flag *child_ptr[ja_type_## index ##_max_linear_child]; \
                } linear[1U << ja_type_## index ##_nr_pool_order];                              \
        }
 
-struct rcu_ja_node {
+struct cds_ja_inode {
        union {
                /* Linear configuration */
                DECLARE_LINEAR_NODE(0) conf_0;
@@ -241,29 +243,29 @@ struct rcu_ja_node {
 
                /* Pigeon configuration */
                struct {
-                       struct rcu_ja_node_flag *child[ja_type_7_max_child];
+                       struct cds_ja_inode_flag *child[ja_type_7_max_child];
                } conf_7;
                /* data aliasing nodes for computed accesses */
-               uint8_t data[sizeof(struct rcu_ja_node_flag *) * ja_type_7_max_child];
+               uint8_t data[sizeof(struct cds_ja_inode_flag *) * ja_type_7_max_child];
        } u;
 };
 
 static
-struct rcu_ja_node_flag *ja_node_flag(struct rcu_ja_node *node,
+struct cds_ja_inode_flag *ja_node_flag(struct cds_ja_inode *node,
                unsigned int type)
 {
        assert(type < RCU_JA_NR_TYPES);
-       return (struct rcu_ja_node_flag *) (((unsigned long) node) | type);
+       return (struct cds_ja_inode_flag *) (((unsigned long) node) | type);
 }
 
 static
-struct rcu_ja_node *ja_node_ptr(struct rcu_ja_node_flag *node)
+struct cds_ja_inode *ja_node_ptr(struct cds_ja_inode_flag *node)
 {
-       return (struct rcu_ja_node *) (((unsigned long) node) | JA_PTR_MASK);
+       return (struct cds_ja_inode *) (((unsigned long) node) | JA_PTR_MASK);
 }
 
 static
-unsigned int ja_node_type(struct rcu_ja_node_flag *node)
+unsigned int ja_node_type(struct cds_ja_inode_flag *node)
 {
        unsigned int type;
 
@@ -275,12 +277,12 @@ unsigned int ja_node_type(struct rcu_ja_node_flag *node)
        return type;
 }
 
-struct rcu_ja_node *alloc_rcu_ja_node(const struct rcu_ja_type *ja_type)
+struct cds_ja_inode *alloc_cds_ja_node(const struct cds_ja_type *ja_type)
 {
        return calloc(1U << ja_type->order, sizeof(char));
 }
 
-void free_rcu_ja_node(struct rcu_ja_node *node)
+void free_cds_ja_node(struct cds_ja_inode *node)
 {
        free(node);
 }
@@ -296,25 +298,33 @@ uint8_t *align_ptr_size(uint8_t *ptr)
        return (uint8_t *) JA_ALIGN((unsigned long) ptr, sizeof(void *));
 }
 
+static
+uint8_t ja_linear_node_get_nr_child(const struct cds_ja_type *type,
+               struct cds_ja_inode *node)
+{
+       assert(type->type_class == RCU_JA_LINEAR || type->type_class == RCU_JA_POOL);
+       return CMM_LOAD_SHARED(node->u.data[0]);
+}
+
 /*
  * The order in which values and pointers are does does not matter: if
  * a value is missing, we return NULL. If a value is there, but its
  * associated pointers is still NULL, we return NULL too.
  */
 static
-struct rcu_ja_node_flag *ja_linear_node_get_nth(const struct rcu_ja_type *type,
-               struct rcu_ja_node *node,
+struct cds_ja_inode_flag *ja_linear_node_get_nth(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
                uint8_t n)
 {
        uint8_t nr_child;
        uint8_t *values;
-       struct rcu_ja_node_flag **pointers;
-       struct rcu_ja_node_flag *ptr;
+       struct cds_ja_inode_flag **pointers;
+       struct cds_ja_inode_flag *ptr;
        unsigned int i;
 
        assert(type->type_class == RCU_JA_LINEAR || type->type_class == RCU_JA_POOL);
 
-       nr_child = CMM_LOAD_SHARED(node->u.data[0]);
+       nr_child = ja_linear_node_get_nr_child(type, node);
        cmm_smp_rmb();  /* read nr_child before values and pointers */
        assert(nr_child <= type->max_linear_child);
        assert(type->type_class != RCU_JA_LINEAR || nr_child >= type->min_child);
@@ -326,36 +336,65 @@ struct rcu_ja_node_flag *ja_linear_node_get_nth(const struct rcu_ja_type *type,
        }
        if (i >= nr_child)
                return NULL;
-       pointers = (struct rcu_ja_node_flag **) align_ptr_size(&values[type->max_linear_child]);
+       pointers = (struct cds_ja_inode_flag **) align_ptr_size(&values[type->max_linear_child]);
        ptr = rcu_dereference(pointers[i]);
        assert(ja_node_ptr(ptr) != NULL);
        return ptr;
 }
 
 static
-struct rcu_ja_node_flag *ja_pool_node_get_nth(const struct rcu_ja_type *type,
-               struct rcu_ja_node *node,
+struct cds_ja_inode_flag *ja_linear_node_get_ith_pos(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
+               uint8_t i,
+               uint8_t *v,
+               struct cds_ja_inode_flag **iter)
+{
+       uint8_t *values;
+       struct cds_ja_inode_flag **pointers;
+
+       assert(type->type_class == RCU_JA_LINEAR || type->type_class == RCU_JA_POOL);
+       assert(i < ja_linear_node_get_nr_child(type, node));
+
+       values = &node->u.data[1];
+       *v = values[i];
+       pointers = (struct cds_ja_inode_flag **) align_ptr_size(&values[type->max_linear_child]);
+       *iter = pointers[i];
+}
+
+static
+struct cds_ja_inode_flag *ja_pool_node_get_nth(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
                uint8_t n)
 {
-       struct rcu_ja_node *linear;
+       struct cds_ja_inode *linear;
 
        assert(type->type_class == RCU_JA_POOL);
        /*
         * TODO: currently, we select the pool by highest bits. We
         * should support various encodings.
         */
-       linear = (struct rcu_ja_node *)
+       linear = (struct cds_ja_inode *)
                &node->u.data[((unsigned long) n >> (CHAR_BIT - type->nr_pool_order)) << type->pool_size_order];
        return ja_linear_node_get_nth(type, linear, n);
 }
 
 static
-struct rcu_ja_node_flag *ja_pigeon_node_get_nth(const struct rcu_ja_type *type,
-               struct rcu_ja_node *node,
+struct cds_ja_inode *ja_pool_node_get_ith_pool(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
+               uint8_t i)
+{
+       assert(type->type_class == RCU_JA_POOL);
+       return (struct cds_ja_inode *)
+               &node->u.data[(unsigned int) i << type->pool_size_order];
+}
+
+static
+struct cds_ja_inode_flag *ja_pigeon_node_get_nth(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
                uint8_t n)
 {
        assert(type->type_class == RCU_JA_PIGEON);
-       return rcu_dereference(((struct rcu_ja_node_flag **) node->u.data)[n]);
+       return rcu_dereference(((struct cds_ja_inode_flag **) node->u.data)[n]);
 }
 
 /*
@@ -363,12 +402,12 @@ struct rcu_ja_node_flag *ja_pigeon_node_get_nth(const struct rcu_ja_type *type,
  * node_flag is already rcu_dereference'd.
  */
 static
-struct rcu_ja_node_flag *ja_node_get_nth(struct rcu_ja_node_flag *node_flag,
+struct cds_ja_inode_flag *ja_node_get_nth(struct cds_ja_inode_flag *node_flag,
                uint8_t n)
 {
        unsigned int type_index;
-       struct rcu_ja_node *node;
-       const struct rcu_ja_type *type;
+       struct cds_ja_inode *node;
+       const struct cds_ja_type *type;
 
        node = ja_node_ptr(node_flag);
        assert(node != NULL);
@@ -388,22 +427,28 @@ struct rcu_ja_node_flag *ja_node_get_nth(struct rcu_ja_node_flag *node_flag,
        }
 }
 
+/*
+ * TODO: use ja_get_nr_child to monitor limits triggering shrink
+ * recompaction.
+ * Also use ja_get_nr_child to make the difference between resize and
+ * pool change of compaction bit(s).
+ */
 static
-unsigned int ja_get_nr_child(struct rcu_ja_shadow_node *shadow_node)
+unsigned int ja_get_nr_child(struct cds_ja_shadow_node *shadow_node)
 {
        return shadow_node->nr_child;
 }
 
 static
-int ja_linear_node_set_nth(const struct rcu_ja_type *type,
-               struct rcu_ja_node *node,
-               struct rcu_ja_shadow_node *shadow_node,
+int ja_linear_node_set_nth(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
+               struct cds_ja_shadow_node *shadow_node,
                uint8_t n,
-               struct rcu_ja_node_flag *child_node_flag)
+               struct cds_ja_inode_flag *child_node_flag)
 {
        uint8_t nr_child;
        uint8_t *values, *nr_child_ptr;
-       struct rcu_ja_node_flag **pointers;
+       struct cds_ja_inode_flag **pointers;
        unsigned int i;
 
        assert(type->type_class == RCU_JA_LINEAR || type->type_class == RCU_JA_POOL);
@@ -422,7 +467,7 @@ int ja_linear_node_set_nth(const struct rcu_ja_type *type,
                /* No space left in this node type */
                return -ENOSPC;
        }
-       pointers = (struct rcu_ja_node_flag **) align_ptr_size(&values[type->max_linear_child]);
+       pointers = (struct cds_ja_inode_flag **) align_ptr_size(&values[type->max_linear_child]);
        assert(pointers[nr_child] == NULL);
        rcu_assign_pointer(pointers[nr_child], child_node_flag);
        CMM_STORE_SHARED(values[nr_child], n);
@@ -433,32 +478,32 @@ int ja_linear_node_set_nth(const struct rcu_ja_type *type,
 }
 
 static
-int ja_pool_node_set_nth(const struct rcu_ja_type *type,
-               struct rcu_ja_node *node,
-               struct rcu_ja_shadow_node *shadow_node,
+int ja_pool_node_set_nth(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
+               struct cds_ja_shadow_node *shadow_node,
                uint8_t n,
-               struct rcu_ja_node_flag *child_node_flag)
+               struct cds_ja_inode_flag *child_node_flag)
 {
-       struct rcu_ja_node *linear;
+       struct cds_ja_inode *linear;
 
        assert(type->type_class == RCU_JA_POOL);
-       linear = (struct rcu_ja_node *)
+       linear = (struct cds_ja_inode *)
                &node->u.data[((unsigned long) n >> (CHAR_BIT - type->nr_pool_order)) << type->pool_size_order];
        return ja_linear_node_set_nth(type, linear, shadow_node,
                        n, child_node_flag);
 }
 
 static
-int ja_pigeon_node_set_nth(const struct rcu_ja_type *type,
-               struct rcu_ja_node *node,
-               struct rcu_ja_shadow_node *shadow_node,
+int ja_pigeon_node_set_nth(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
+               struct cds_ja_shadow_node *shadow_node,
                uint8_t n,
-               struct rcu_ja_node_flag *child_node_flag)
+               struct cds_ja_inode_flag *child_node_flag)
 {
-       struct rcu_ja_node_flag **ptr;
+       struct cds_ja_inode_flag **ptr;
 
        assert(type->type_class == RCU_JA_PIGEON);
-       ptr = &((struct rcu_ja_node_flag **) node->u.data)[n];
+       ptr = &((struct cds_ja_inode_flag **) node->u.data)[n];
        if (*ptr != NULL)
                return -EEXIST;
        rcu_assign_pointer(*ptr, child_node_flag);
@@ -472,11 +517,11 @@ int ja_pigeon_node_set_nth(const struct rcu_ja_type *type,
  * TODO: exclusive access on node.
  */
 static
-int _ja_node_set_nth(const struct rcu_ja_type *type,
-               struct rcu_ja_node *node,
-               struct rcu_ja_shadow_node *shadow_node,
+int _ja_node_set_nth(const struct cds_ja_type *type,
+               struct cds_ja_inode *node,
+               struct cds_ja_shadow_node *shadow_node,
                uint8_t n,
-               struct rcu_ja_node_flag *child_node_flag)
+               struct cds_ja_inode_flag *child_node_flag)
 {
        switch (type->type_class) {
        case RCU_JA_LINEAR:
@@ -503,19 +548,18 @@ int _ja_node_set_nth(const struct rcu_ja_type *type,
  * TODO: for pool type, take selection bit(s) into account.
  */
 static
-int ja_node_recompact_add(struct rcu_ja *ja,
+int ja_node_recompact_add(struct cds_ja *ja,
                unsigned int old_type_index,
-               const struct rcu_ja_type *old_type,
-               struct rcu_ja_node *old_node,
-               struct rcu_ja_shadow_node **shadow_node,
-               struct rcu_ja_node_flag **old_node_flag, uint8_t n,
-               struct rcu_ja_node_flag *child_node_flag)
+               const struct cds_ja_type *old_type,
+               struct cds_ja_inode *old_node,
+               struct cds_ja_shadow_node **shadow_node,
+               struct cds_ja_inode_flag **old_node_flag, uint8_t n,
+               struct cds_ja_inode_flag *child_node_flag)
 {
        unsigned int new_type_index;
-       struct rcu_ja_node *new_node;
-       const struct rcu_ja_type *new_type;
-       struct rcu_ja_node_flag *new_node_flag;
-       unsigned int i;
+       struct cds_ja_inode *new_node;
+       const struct cds_ja_type *new_type;
+       struct cds_ja_inode_flag *new_node_flag;
        int ret;
 
        if (*shadow_node == NULL) {
@@ -524,7 +568,7 @@ int ja_node_recompact_add(struct rcu_ja *ja,
                new_type_index = old_type_index + 1;
        }
        new_type = &ja_types[new_type_index];
-       new_node = alloc_rcu_ja_node(new_type);
+       new_node = alloc_cds_ja_node(new_type);
        if (!new_node)
                return -ENOMEM;
        new_node_flag = ja_node_flag(new_node, new_type_index);
@@ -538,17 +582,66 @@ int ja_node_recompact_add(struct rcu_ja *ja,
                assert(*shadow_node);
        }
 
+       /*
+        * We need to clear nr_child, because it will be re-incremented
+        * by _ja_node_set_nth().
+        */
        (*shadow_node)->nr_child = 0;
-       for (i = 0; i < old_type->max_child; i++) {
-               struct rcu_ja_node_flag *iter;
-
-               iter = ja_node_get_nth(*old_node_flag, i);
-               if (!iter)
-                       continue;
-               ret = _ja_node_set_nth(new_type, new_node, *shadow_node,
-                               i, iter);
-               assert(!ret);
+
+       assert(old_type->type_class != RCU_JA_PIGEON);
+       switch (old_type->type_class) {
+       case RCU_JA_LINEAR:
+       {
+               uint8_t nr_child =
+                       ja_linear_node_get_nr_child(old_type, old_node);
+               unsigned int i;
+
+               for (i = 0; i < nr_child; i++) {
+                       struct cds_ja_inode_flag *iter;
+                       uint8_t v;
+
+                       ja_linear_node_get_ith_pos(old_type, old_node, i, &v, &iter);
+                       if (!iter)
+                               continue;
+                       ret = _ja_node_set_nth(new_type, new_node, *shadow_node,
+                                       v, iter);
+                       assert(!ret);
+               }
+               break;
        }
+       case RCU_JA_POOL:
+       {
+               unsigned int pool_nr;
+
+               for (pool_nr = 0; pool_nr < (1U << old_type->nr_pool_order); pool_nr++) {
+                       struct cds_ja_inode *pool =
+                               ja_pool_node_get_ith_pool(old_type,
+                                       old_node, pool_nr);
+                       uint8_t nr_child =
+                               ja_linear_node_get_nr_child(old_type, pool);
+                       unsigned int j;
+
+                       for (j = 0; j < nr_child; j++) {
+                               struct cds_ja_inode_flag *iter;
+                               uint8_t v;
+
+                               ja_linear_node_get_ith_pos(old_type, pool,
+                                               j, &v, &iter);
+                               if (!iter)
+                                       continue;
+                               ret = _ja_node_set_nth(new_type, new_node, *shadow_node,
+                                               v, iter);
+                               assert(!ret);
+                       }
+               }
+               break;
+       }
+       case RCU_JA_PIGEON:
+       default:
+               assert(0);
+               return -EINVAL;
+       }
+
        /* add node */
        ret = _ja_node_set_nth(new_type, new_node, *shadow_node,
                        n, child_node_flag);
@@ -562,15 +655,15 @@ int ja_node_recompact_add(struct rcu_ja *ja,
 }
 
 static
-int ja_node_set_nth(struct rcu_ja *ja,
-               struct rcu_ja_node_flag **node_flag, uint8_t n,
-               struct rcu_ja_node_flag *child_node_flag)
+int ja_node_set_nth(struct cds_ja *ja,
+               struct cds_ja_inode_flag **node_flag, uint8_t n,
+               struct cds_ja_inode_flag *child_node_flag)
 {
        int ret;
        unsigned int type_index;
-       const struct rcu_ja_type *type;
-       struct rcu_ja_node *node;
-       struct rcu_ja_shadow_node *shadow_node = NULL;
+       const struct cds_ja_type *type;
+       struct cds_ja_inode *node;
+       struct cds_ja_shadow_node *shadow_node = NULL;
 
        node = ja_node_ptr(*node_flag);
        type_index = ja_node_type(*node_flag);
@@ -590,3 +683,65 @@ int ja_node_set_nth(struct rcu_ja *ja,
        rcuja_shadow_unlock(shadow_node);
        return ret;
 }
+
+struct cds_ja_node *cds_ja_lookup(uint64_t key)
+{
+       /* TODO */
+}
+
+struct cds_ja *_cds_ja_new(unsigned int key_bits,
+               const struct rcu_flavor_struct *flavor)
+{
+       struct cds_ja *ja;
+
+
+       ja = calloc(sizeof(*ja), 1);
+       if (!ja)
+               goto ja_error;
+
+       switch (key_bits) {
+       case 8:
+               ja->key_max = UINT8_MAX;
+               break;
+       case 16:
+               ja->key_max = UINT16_MAX;
+               break;
+       case 32:
+               ja->key_max = UINT32_MAX;
+               break;
+       case 64:
+               ja->key_max = UINT64_MAX;
+               break;
+       default:
+               goto check_error;
+       }
+
+       /* ja->root is NULL */
+       ja->tree_depth = key_bits >> JA_BITS_PER_BYTE;
+       ja->ht = rcuja_create_ht(flavor);
+       if (!ja->ht)
+               goto ht_error;
+       return ja;
+
+ht_error:
+check_error:
+       free(ja);
+ja_error:
+       return NULL;
+}
+
+/*
+ * There should be no more concurrent add to the judy array while it is
+ * being destroyed (ensured by the caller).
+ */
+int cds_ja_destroy(struct cds_ja *ja)
+{
+       int ret;
+
+       rcuja_shadow_prune(ja->ht,
+               RCUJA_SHADOW_CLEAR_FREE_NODE | RCUJA_SHADOW_CLEAR_FREE_LOCK);
+       ret = rcuja_delete_ht(ja->ht);
+       if (ret)
+               return ret;
+       free(ja);
+}
This page took 0.032585 seconds and 4 git commands to generate.