[userspace-rcu.git] / rcuja / rcuja.c

/*
 * rcuja/rcuja.c
 *
 * Userspace RCU library - RCU Judy Array
 *
 * Copyright 2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include <stdint.h>
#include <errno.h>
#include <limits.h>
#include <urcu/rcuja.h>
#include <urcu/compiler.h>
#include <urcu/arch.h>
#include <assert.h>
#include <urcu-pointer.h>

#include "rcuja-internal.h"
#include "bitfield.h"

enum rcu_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 */
	RCU_JA_POOL = 1,	/* Type B */
			/* 32-bit: 26 to 100 children, 256 to 512 bytes */
			/* 64-bit: 29 to 112 children, 512 to 1024 bytes */
	RCU_JA_PIGEON = 2,	/* Type C */
			/* 32-bit: 101 to 256 children, 1024 bytes */
			/* 64-bit: 113 to 256 children, 2048 bytes */
	/* Leaf nodes are implicit from their height in the tree */
	RCU_JA_NR_TYPES,
};

struct rcu_ja_type {
	enum rcu_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 */
	uint16_t order;			/* node size is (1 << order), in bytes */
	uint16_t nr_pool_order;		/* number of pools */
	uint16_t pool_size_order;	/* pool size */
};

/*
 * Number of least significant pointer bits reserved to represent the
 * child type.
 */
#define JA_TYPE_BITS	3
#define JA_TYPE_MAX_NR	(1U << JA_TYPE_BITS)
#define JA_TYPE_MASK	(JA_TYPE_MAX_NR - 1)
#define JA_PTR_MASK	(~JA_TYPE_MASK)

#define JA_ENTRY_PER_NODE	256UL

/*
 * Iteration on the array to find the right node size for the number of
 * children stops when it reaches .max_child == 256 (this is the largest
 * possible node size, which contains 256 children).
 * The min_child overlaps with the previous max_child to provide an
 * hysteresis loop to reallocation for patterns of cyclic add/removal
 * within the same node.
 * The node the index within the following arrays is represented on 3
 * bits. It identifies the node type, min/max number of children, and
 * the size order.
 * The max_child values for the RCU_JA_POOL below result from
 * statistical approximation: over million populations, the max_child
 * covers between 97% and 99% of the populations generated. Therefore, a
 * fallback should exist to cover the rare extreme population unbalance
 * cases, but it will not have a major impact on speed nor space
 * consumption, since those are rare cases.
 */

#if (CAA_BITS_PER_LONG < 64)
/* 32-bit pointers */
enum {
	ja_type_0_max_child = 1,
	ja_type_1_max_child = 3,
	ja_type_2_max_child = 6,
	ja_type_3_max_child = 12,
	ja_type_4_max_child = 25,
	ja_type_5_max_child = 48,
	ja_type_6_max_child = 92,
	ja_type_7_max_child = 256,
};

enum {
	ja_type_0_max_linear_child = 1,
	ja_type_1_max_linear_child = 3,
	ja_type_2_max_linear_child = 6,
	ja_type_3_max_linear_child = 12,
	ja_type_4_max_linear_child = 25,
	ja_type_5_max_linear_child = 24,
	ja_type_6_max_linear_child = 23,
};

enum {
	ja_type_5_nr_pool_order = 1,
	ja_type_6_nr_pool_order = 2,
};

const struct rcu_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, },
	{ .type_class = RCU_JA_LINEAR, .min_child = 4, .max_child = ja_type_3_max_child, .max_linear_child = ja_type_3_max_linear_child, .order = 6, },
	{ .type_class = RCU_JA_LINEAR, .min_child = 10, .max_child = ja_type_4_max_child, .max_linear_child = ja_type_4_max_linear_child, .order = 7, },

	/* Pools may fill sooner than max_child */
	{ .type_class = RCU_JA_POOL, .min_child = 20, .max_child = ja_type_5_max_child, .max_linear_child = ja_type_5_max_linear_child, .order = 8, .nr_pool_order = ja_type_5_nr_pool_order, .pool_size_order = 7, },
	{ .type_class = RCU_JA_POOL, .min_child = 45, .max_child = ja_type_6_max_child, .max_linear_child = ja_type_6_max_linear_child, .order = 9, .nr_pool_order = ja_type_6_nr_pool_order, .pool_size_order = 7, },

	/*
	 * TODO: Upon node removal below min_child, if child pool is
	 * filled beyond capacity, we need to roll back to pigeon.
	 */
	{ .type_class = RCU_JA_PIGEON, .min_child = 89, .max_child = ja_type_7_max_child, .order = 10, },
};
#else /* !(CAA_BITS_PER_LONG < 64) */
/* 64-bit pointers */
enum {
	ja_type_0_max_child = 1,
	ja_type_1_max_child = 3,
	ja_type_2_max_child = 7,
	ja_type_3_max_child = 14,
	ja_type_4_max_child = 28,
	ja_type_5_max_child = 54,
	ja_type_6_max_child = 104,
	ja_type_7_max_child = 256,
};

enum {
	ja_type_0_max_linear_child = 1,
	ja_type_1_max_linear_child = 3,
	ja_type_2_max_linear_child = 7,
	ja_type_3_max_linear_child = 14,
	ja_type_4_max_linear_child = 28,
	ja_type_5_max_linear_child = 27,
	ja_type_6_max_linear_child = 26,
};

enum {
	ja_type_5_nr_pool_order = 1,
	ja_type_6_nr_pool_order = 2,
};

const struct rcu_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, },
	{ .type_class = RCU_JA_LINEAR, .min_child = 5, .max_child = ja_type_3_max_child, .max_linear_child = ja_type_3_max_linear_child, .order = 7, },
	{ .type_class = RCU_JA_LINEAR, .min_child = 10, .max_child = ja_type_4_max_child, .max_linear_child = ja_type_4_max_linear_child, .order = 8, },

	/* Pools may fill sooner than max_child. */
	{ .type_class = RCU_JA_POOL, .min_child = 22, .max_child = ja_type_5_max_child, .max_linear_child = ja_type_5_max_linear_child, .order = 9, .nr_pool_order = ja_type_5_nr_pool_order, .pool_size_order = 8, },
	{ .type_class = RCU_JA_POOL, .min_child = 51, .max_child = ja_type_6_max_child, .max_linear_child = ja_type_6_max_linear_child, .order = 10, .nr_pool_order = ja_type_6_nr_pool_order, .pool_size_order = 8, },

	/*
	 * TODO: Upon node removal below min_child, if child pool is
	 * filled beyond capacity, we need to roll back to pigeon.
	 */
	{ .type_class = RCU_JA_PIGEON, .min_child = 101, .max_child = ja_type_7_max_child, .order = 11, },
};
#endif /* !(BITS_PER_LONG < 64) */

static inline __attribute__((unused))
void static_array_size_check(void)
{
	CAA_BUILD_BUG_ON(CAA_ARRAY_SIZE(ja_types) > JA_TYPE_MAX_NR);
}

/* Never declared. Opaque type used to store flagged node pointers. */
struct rcu_ja_node_flag;

/*
 * The rcu_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.
 * The node mutex, if any is needed, protecting concurrent updated of
 * each node is placed in a separate hash table indexed by node address.
 * For the pigeon configuration, the number of children is also kept in
 * a separate hash table, indexed by node address, because it is only
 * required for updates.
 */

#define DECLARE_LINEAR_NODE(index)								\
	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];	\
	}

#define DECLARE_POOL_NODE(index)								\
	struct {										\
		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]; \
		} linear[1U << ja_type_## index ##_nr_pool_order];				\
	}

struct rcu_ja_node {
	union {
		/* Linear configuration */
		DECLARE_LINEAR_NODE(0) conf_0;
		DECLARE_LINEAR_NODE(1) conf_1;
		DECLARE_LINEAR_NODE(2) conf_2;
		DECLARE_LINEAR_NODE(3) conf_3;
		DECLARE_LINEAR_NODE(4) conf_4;

		/* Pool configuration */
		DECLARE_POOL_NODE(5) conf_5;
		DECLARE_POOL_NODE(6) conf_6;

		/* Pigeon configuration */
		struct {
			struct rcu_ja_node_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];
	} u;
};

static
struct rcu_ja_node_flag *ja_node_flag(struct rcu_ja_node *node,
		unsigned int type)
{
	assert(type < RCU_JA_NR_TYPES);
	return (struct rcu_ja_node_flag *) (((unsigned long) node) | type);
}

static
unsigned int ja_node_type(struct rcu_ja_node_flag *node)
{
	unsigned int type;

	type = (unsigned int) ((unsigned long) node & JA_TYPE_MASK);
	assert(type < RCU_JA_NR_TYPES);
	return type;
}

static
struct rcu_ja_node *ja_node_ptr(struct rcu_ja_node_flag *node)
{
	return (struct rcu_ja_node *) (((unsigned long) node) | JA_PTR_MASK);
}

struct rcu_ja_node *alloc_rcu_ja_node(struct rcu_ja_type *ja_type)
{
	return calloc(1U << ja_type->order, sizeof(char));
}

void free_rcu_ja_node(struct rcu_ja_node *node)
{
	free(node);
}

#define __JA_ALIGN_MASK(v, mask)	(((v) + (mask)) & ~(mask))
#define JA_ALIGN(v, align)		__JA_ALIGN_MASK(v, (typeof(v)) (align) - 1)
#define __JA_FLOOR_MASK(v, mask)	((v) & ~(mask))
#define JA_FLOOR(v, align)		__JA_FLOOR_MASK(v, (typeof(v)) (align) - 1)

static
uint8_t *align_ptr_size(uint8_t *ptr)
{
	return (uint8_t *) JA_ALIGN((unsigned long) ptr, sizeof(void *));
}

/*
 * 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,
		uint8_t n)
{
	uint8_t nr_child;
	uint8_t *values;
	struct rcu_ja_node_flag **pointers;
	struct rcu_ja_node_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]);
	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);

	values = &node->u.data[1];
	for (i = 0; i < nr_child; i++) {
		if (CMM_LOAD_SHARED(values[i]) == n)
			break;
	}
	if (i >= nr_child)
		return NULL;
	pointers = (struct rcu_ja_node_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,
		uint8_t n)
{
	struct rcu_ja_node *linear;

	assert(type->type_class == RCU_JA_POOL);
	linear = (struct rcu_ja_node *)
		&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,
		uint8_t n)
{
	assert(type->type_class == RCU_JA_PIGEON);
	return rcu_dereference(((struct rcu_ja_node_flag **) node->u.data)[n]);
}

/*
 * ja_node_get_nth: get nth item from a node.
 * node_flag is already rcu_dereference'd.
 */
static
struct rcu_ja_node_flag *ja_node_get_nth(struct rcu_ja_node_flag *node_flag,
		uint8_t n)
{
	unsigned int type_index;
	struct rcu_ja_node *node;
	const struct rcu_ja_type *type;

	node = ja_node_ptr(node_flag);
	assert(node != NULL);
	type_index = ja_node_type(node_flag);
	type = &ja_types[type_index];

	switch (type->type_class) {
	case RCU_JA_LINEAR:
		return ja_linear_node_get_nth(type, node, n);
	case RCU_JA_POOL:
		return ja_pool_node_get_nth(type, node, n);
	case RCU_JA_PIGEON:
		return ja_pigeon_node_get_nth(type, node, n);
	default:
		assert(0);
		return (void *) -1UL;
	}
}

static
int ja_linear_node_set_nth(const struct rcu_ja_type *type,
		struct rcu_ja_node *node,
		uint8_t n,
		struct rcu_ja_node_flag *child_node_flag)
{
	uint8_t nr_child;
	uint8_t *values, *nr_child_ptr;
	struct rcu_ja_node_flag **pointers;
	unsigned int i;

	assert(type->type_class == RCU_JA_LINEAR || type->type_class == RCU_JA_POOL);

	nr_child_ptr = &node->u.data[0];
	nr_child = *nr_child_ptr;
	assert(nr_child <= type->max_linear_child);
	assert(type->type_class != RCU_JA_LINEAR || nr_child >= type->min_child);

	values = &node->u.data[1];
	for (i = 0; i < nr_child; i++) {
		if (values[i] == n)
			return -EEXIST;
	}
	if (nr_child >= type->max_linear_child) {
		/* No space left in this node type */
		return -ENOSPC;
	}
	pointers = (struct rcu_ja_node_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);
	cmm_smp_wmb();	/* write value and pointer before nr_child */
	CMM_STORE_SHARED(*nr_child_ptr, nr_child + 1);
	return 0;
}

static
int ja_pool_node_set_nth(const struct rcu_ja_type *type,
		struct rcu_ja_node *node,
		uint8_t n,
		struct rcu_ja_node_flag *child_node_flag)
{
	struct rcu_ja_node *linear;

	assert(type->type_class == RCU_JA_POOL);
	linear = (struct rcu_ja_node *)
		&node->u.data[((unsigned long) n >> (CHAR_BIT - type->nr_pool_order)) << type->pool_size_order];
	return ja_linear_node_set_nth(type, linear, n, child_node_flag);
}

static
int ja_pigeon_node_set_nth(const struct rcu_ja_type *type,
		struct rcu_ja_node *node,
		uint8_t n,
		struct rcu_ja_node_flag *child_node_flag)
{
	struct rcu_ja_node_flag **ptr;

	assert(type->type_class == RCU_JA_PIGEON);
	ptr = &((struct rcu_ja_node_flag **) node->u.data)[n];
	if (*ptr != NULL)
		return -EEXIST;
	rcu_assign_pointer(*ptr, child_node_flag);
	return 0;
}

/*
 * ja_node_set_nth: set nth item within a node. Return an error
 * (negative error value) if it is already there.
 * TODO: exclusive access on node.
 */
static
int ja_node_set_nth(struct rcu_ja_node_flag *node_flag, uint8_t n,
		struct rcu_ja_node_flag *child_node_flag)
{
	unsigned int type_index;
	struct rcu_ja_node *node;
	const struct rcu_ja_type *type;

	node = ja_node_ptr(node_flag);
	assert(node != NULL);
	type_index = ja_node_type(node_flag);
	type = &ja_types[type_index];

	switch (type->type_class) {
	case RCU_JA_LINEAR:
		return ja_linear_node_set_nth(type, node, n,
				child_node_flag);
	case RCU_JA_POOL:
		return ja_pool_node_set_nth(type, node, n,
				child_node_flag);
	case RCU_JA_PIGEON:
		return ja_pigeon_node_set_nth(type, node, n,
				child_node_flag);
	default:
		assert(0);
		return -EINVAL;
	}

	return 0;
}
Commit	Line	Data
61009379 MD	1	/*
	2	* rcuja/rcuja.c
	3	*
	4	* Userspace RCU library - RCU Judy Array
	5	*
	6	* Copyright 2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	7	*
	8	* This library is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU Lesser General Public
	10	* License as published by the Free Software Foundation; either
	11	* version 2.1 of the License, or (at your option) any later version.
	12	*
	13	* This library is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* Lesser General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU Lesser General Public
	19	* License along with this library; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	21	*/
	22
e5227865	23	#include <stdint.h>
8e519e3c	24	#include <errno.h>
d68c6810	25	#include <limits.h>
61009379	26	#include <urcu/rcuja.h>
d68c6810 MD	27	#include <urcu/compiler.h>
	28	#include <urcu/arch.h>
	29	#include <assert.h>
8e519e3c MD	30	#include <urcu-pointer.h>
8e519e3c MD	31
61009379	32	#include "rcuja-internal.h"
d68c6810	33	#include "bitfield.h"
61009379	34
d68c6810	35	enum rcu_ja_type_class {
e5227865	36	RCU_JA_LINEAR = 0, /* Type A */
fd800776 MD	37	/* 32-bit: 1 to 25 children, 8 to 128 bytes */
	38	/* 64-bit: 1 to 28 children, 16 to 256 bytes */
	39	RCU_JA_POOL = 1, /* Type B */
	40	/* 32-bit: 26 to 100 children, 256 to 512 bytes */
	41	/* 64-bit: 29 to 112 children, 512 to 1024 bytes */
e5227865	42	RCU_JA_PIGEON = 2, /* Type C */
fd800776 MD	43	/* 32-bit: 101 to 256 children, 1024 bytes */
fd800776 MD	44	/* 64-bit: 113 to 256 children, 2048 bytes */
e5227865	45	/* Leaf nodes are implicit from their height in the tree */
1db4943c	46	RCU_JA_NR_TYPES,
e5227865 MD	47	};
e5227865 MD	48
d68c6810 MD	49	struct rcu_ja_type {
d68c6810 MD	50	enum rcu_ja_type_class type_class;
8e519e3c MD	51	uint16_t min_child; /* minimum number of children: 1 to 256 */
	52	uint16_t max_child; /* maximum number of children: 1 to 256 */
	53	uint16_t max_linear_child; /* per-pool max nr. children: 1 to 256 */
	54	uint16_t order; /* node size is (1 << order), in bytes */
fd800776 MD	55	uint16_t nr_pool_order; /* number of pools */
fd800776 MD	56	uint16_t pool_size_order; /* pool size */
e5227865 MD	57	};
e5227865 MD	58
d68c6810 MD	59	/*
	60	* Number of least significant pointer bits reserved to represent the
	61	* child type.
	62	*/
	63	#define JA_TYPE_BITS 3
	64	#define JA_TYPE_MAX_NR (1U << JA_TYPE_BITS)
	65	#define JA_TYPE_MASK (JA_TYPE_MAX_NR - 1)
	66	#define JA_PTR_MASK (~JA_TYPE_MASK)
	67
	68	#define JA_ENTRY_PER_NODE 256UL
	69
e5227865 MD	70	/*
e5227865 MD	71	* Iteration on the array to find the right node size for the number of
d68c6810	72	* children stops when it reaches .max_child == 256 (this is the largest
e5227865	73	* possible node size, which contains 256 children).
d68c6810 MD	74	* The min_child overlaps with the previous max_child to provide an
	75	* hysteresis loop to reallocation for patterns of cyclic add/removal
	76	* within the same node.
	77	* The node the index within the following arrays is represented on 3
	78	* bits. It identifies the node type, min/max number of children, and
	79	* the size order.
3d45251f MD	80	* The max_child values for the RCU_JA_POOL below result from
	81	* statistical approximation: over million populations, the max_child
	82	* covers between 97% and 99% of the populations generated. Therefore, a
	83	* fallback should exist to cover the rare extreme population unbalance
	84	* cases, but it will not have a major impact on speed nor space
	85	* consumption, since those are rare cases.
e5227865	86	*/
e5227865	87
d68c6810 MD	88	#if (CAA_BITS_PER_LONG < 64)
d68c6810 MD	89	/* 32-bit pointers */
1db4943c MD	90	enum {
	91	ja_type_0_max_child = 1,
	92	ja_type_1_max_child = 3,
	93	ja_type_2_max_child = 6,
	94	ja_type_3_max_child = 12,
	95	ja_type_4_max_child = 25,
	96	ja_type_5_max_child = 48,
	97	ja_type_6_max_child = 92,
	98	ja_type_7_max_child = 256,
	99	};
	100
8e519e3c MD	101	enum {
	102	ja_type_0_max_linear_child = 1,
	103	ja_type_1_max_linear_child = 3,
	104	ja_type_2_max_linear_child = 6,
	105	ja_type_3_max_linear_child = 12,
	106	ja_type_4_max_linear_child = 25,
	107	ja_type_5_max_linear_child = 24,
	108	ja_type_6_max_linear_child = 23,
	109	};
	110
1db4943c MD	111	enum {
	112	ja_type_5_nr_pool_order = 1,
	113	ja_type_6_nr_pool_order = 2,
	114	};
	115
d68c6810	116	const struct rcu_ja_type ja_types[] = {
8e519e3c MD	117	{ .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, },
	118	{ .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, },
	119	{ .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, },
	120	{ .type_class = RCU_JA_LINEAR, .min_child = 4, .max_child = ja_type_3_max_child, .max_linear_child = ja_type_3_max_linear_child, .order = 6, },
	121	{ .type_class = RCU_JA_LINEAR, .min_child = 10, .max_child = ja_type_4_max_child, .max_linear_child = ja_type_4_max_linear_child, .order = 7, },
e5227865	122
fd800776	123	/* Pools may fill sooner than max_child */
8e519e3c MD	124	{ .type_class = RCU_JA_POOL, .min_child = 20, .max_child = ja_type_5_max_child, .max_linear_child = ja_type_5_max_linear_child, .order = 8, .nr_pool_order = ja_type_5_nr_pool_order, .pool_size_order = 7, },
8e519e3c MD	125	{ .type_class = RCU_JA_POOL, .min_child = 45, .max_child = ja_type_6_max_child, .max_linear_child = ja_type_6_max_linear_child, .order = 9, .nr_pool_order = ja_type_6_nr_pool_order, .pool_size_order = 7, },
3d45251f MD	126
	127	/*
	128	* TODO: Upon node removal below min_child, if child pool is
	129	* filled beyond capacity, we need to roll back to pigeon.
	130	*/
1db4943c	131	{ .type_class = RCU_JA_PIGEON, .min_child = 89, .max_child = ja_type_7_max_child, .order = 10, },
d68c6810	132	};
d68c6810 MD	133	#else /* !(CAA_BITS_PER_LONG < 64) */
d68c6810 MD	134	/* 64-bit pointers */
1db4943c MD	135	enum {
	136	ja_type_0_max_child = 1,
	137	ja_type_1_max_child = 3,
	138	ja_type_2_max_child = 7,
	139	ja_type_3_max_child = 14,
	140	ja_type_4_max_child = 28,
	141	ja_type_5_max_child = 54,
	142	ja_type_6_max_child = 104,
	143	ja_type_7_max_child = 256,
	144	};
	145
8e519e3c MD	146	enum {
	147	ja_type_0_max_linear_child = 1,
	148	ja_type_1_max_linear_child = 3,
	149	ja_type_2_max_linear_child = 7,
	150	ja_type_3_max_linear_child = 14,
	151	ja_type_4_max_linear_child = 28,
	152	ja_type_5_max_linear_child = 27,
	153	ja_type_6_max_linear_child = 26,
	154	};
	155
1db4943c MD	156	enum {
	157	ja_type_5_nr_pool_order = 1,
	158	ja_type_6_nr_pool_order = 2,
	159	};
	160
d68c6810	161	const struct rcu_ja_type ja_types[] = {
8e519e3c MD	162	{ .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, },
	163	{ .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, },
	164	{ .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, },
	165	{ .type_class = RCU_JA_LINEAR, .min_child = 5, .max_child = ja_type_3_max_child, .max_linear_child = ja_type_3_max_linear_child, .order = 7, },
	166	{ .type_class = RCU_JA_LINEAR, .min_child = 10, .max_child = ja_type_4_max_child, .max_linear_child = ja_type_4_max_linear_child, .order = 8, },
e5227865	167
3d45251f	168	/* Pools may fill sooner than max_child. */
8e519e3c MD	169	{ .type_class = RCU_JA_POOL, .min_child = 22, .max_child = ja_type_5_max_child, .max_linear_child = ja_type_5_max_linear_child, .order = 9, .nr_pool_order = ja_type_5_nr_pool_order, .pool_size_order = 8, },
8e519e3c MD	170	{ .type_class = RCU_JA_POOL, .min_child = 51, .max_child = ja_type_6_max_child, .max_linear_child = ja_type_6_max_linear_child, .order = 10, .nr_pool_order = ja_type_6_nr_pool_order, .pool_size_order = 8, },
e5227865	171
3d45251f MD	172	/*
	173	* TODO: Upon node removal below min_child, if child pool is
	174	* filled beyond capacity, we need to roll back to pigeon.
	175	*/
1db4943c	176	{ .type_class = RCU_JA_PIGEON, .min_child = 101, .max_child = ja_type_7_max_child, .order = 11, },
e5227865	177	};
d68c6810	178	#endif /* !(BITS_PER_LONG < 64) */
e5227865	179
1db4943c MD	180	static inline __attribute__((unused))
	181	void static_array_size_check(void)
	182	{
	183	CAA_BUILD_BUG_ON(CAA_ARRAY_SIZE(ja_types) > JA_TYPE_MAX_NR);
	184	}
	185
	186	/* Never declared. Opaque type used to store flagged node pointers. */
	187	struct rcu_ja_node_flag;
	188
e5227865	189	/*
1db4943c MD	190	* The rcu_ja_node contains the compressed node data needed for
	191	* read-side. For linear and pool node configurations, it starts with a
	192	* byte counting the number of children in the node. Then, the
	193	* node-specific data is placed.
	194	* The node mutex, if any is needed, protecting concurrent updated of
	195	* each node is placed in a separate hash table indexed by node address.
	196	* For the pigeon configuration, the number of children is also kept in
	197	* a separate hash table, indexed by node address, because it is only
	198	* required for updates.
e5227865	199	*/
1db4943c	200
ff38c745 MD	201	#define DECLARE_LINEAR_NODE(index) \
	202	struct { \
	203	uint8_t nr_child; \
	204	uint8_t child_value[ja_type_## index ##_max_linear_child]; \
	205	struct rcu_ja_node_flag *child_ptr[ja_type_## index ##_max_linear_child]; \
	206	}
	207
	208	#define DECLARE_POOL_NODE(index) \
	209	struct { \
	210	struct { \
	211	uint8_t nr_child; \
	212	uint8_t child_value[ja_type_## index ##_max_linear_child]; \
	213	struct rcu_ja_node_flag *child_ptr[ja_type_## index ##_max_linear_child]; \
	214	} linear[1U << ja_type_## index ##_nr_pool_order]; \
	215	}
1db4943c	216
e5227865	217	struct rcu_ja_node {
1db4943c MD	218	union {
	219	/* Linear configuration */
	220	DECLARE_LINEAR_NODE(0) conf_0;
	221	DECLARE_LINEAR_NODE(1) conf_1;
	222	DECLARE_LINEAR_NODE(2) conf_2;
	223	DECLARE_LINEAR_NODE(3) conf_3;
	224	DECLARE_LINEAR_NODE(4) conf_4;
	225
	226	/* Pool configuration */
	227	DECLARE_POOL_NODE(5) conf_5;
	228	DECLARE_POOL_NODE(6) conf_6;
	229
	230	/* Pigeon configuration */
	231	struct {
	232	struct rcu_ja_node_flag *child[ja_type_7_max_child];
	233	} conf_7;
	234	/* data aliasing nodes for computed accesses */
	235	uint8_t data[sizeof(struct rcu_ja_node_flag ) ja_type_7_max_child];
	236	} u;
e5227865 MD	237	};
e5227865 MD	238
d68c6810	239	static
8e519e3c MD	240	struct rcu_ja_node_flag ja_node_flag(struct rcu_ja_node node,
8e519e3c MD	241	unsigned int type)
d68c6810	242	{
1db4943c	243	assert(type < RCU_JA_NR_TYPES);
d68c6810 MD	244	return (struct rcu_ja_node_flag *) (((unsigned long) node) \| type);
	245	}
	246
	247	static
	248	unsigned int ja_node_type(struct rcu_ja_node_flag *node)
	249	{
	250	unsigned int type;
	251
	252	type = (unsigned int) ((unsigned long) node & JA_TYPE_MASK);
1db4943c	253	assert(type < RCU_JA_NR_TYPES);
d68c6810 MD	254	return type;
	255	}
	256
	257	static
	258	struct rcu_ja_node ja_node_ptr(struct rcu_ja_node_flag node)
	259	{
	260	return (struct rcu_ja_node *) (((unsigned long) node) \| JA_PTR_MASK);
	261	}
	262
	263	struct rcu_ja_node alloc_rcu_ja_node(struct rcu_ja_type ja_type)
e5227865	264	{
1db4943c	265	return calloc(1U << ja_type->order, sizeof(char));
e5227865 MD	266	}
	267
	268	void free_rcu_ja_node(struct rcu_ja_node *node)
	269	{
	270	free(node);
	271	}
	272
d68c6810 MD	273	#define __JA_ALIGN_MASK(v, mask) (((v) + (mask)) & ~(mask))
	274	#define JA_ALIGN(v, align) __JA_ALIGN_MASK(v, (typeof(v)) (align) - 1)
	275	#define __JA_FLOOR_MASK(v, mask) ((v) & ~(mask))
	276	#define JA_FLOOR(v, align) __JA_FLOOR_MASK(v, (typeof(v)) (align) - 1)
	277
	278	static
1db4943c	279	uint8_t align_ptr_size(uint8_t ptr)
d68c6810	280	{
1db4943c	281	return (uint8_t ) JA_ALIGN((unsigned long) ptr, sizeof(void ));
d68c6810 MD	282	}
d68c6810 MD	283
13a7f5a6 MD	284	/*
	285	* The order in which values and pointers are does does not matter: if
	286	* a value is missing, we return NULL. If a value is there, but its
	287	* associated pointers is still NULL, we return NULL too.
	288	*/
d68c6810 MD	289	static
d68c6810 MD	290	struct rcu_ja_node_flag ja_linear_node_get_nth(const struct rcu_ja_type type,
8e519e3c MD	291	struct rcu_ja_node *node,
8e519e3c MD	292	uint8_t n)
d68c6810 MD	293	{
	294	uint8_t nr_child;
	295	uint8_t *values;
1db4943c	296	struct rcu_ja_node_flag **pointers;
d68c6810 MD	297	struct rcu_ja_node_flag *ptr;
	298	unsigned int i;
	299
8e519e3c	300	assert(type->type_class == RCU_JA_LINEAR \|\| type->type_class == RCU_JA_POOL);
d68c6810	301
13a7f5a6 MD	302	nr_child = CMM_LOAD_SHARED(node->u.data[0]);
13a7f5a6 MD	303	cmm_smp_rmb(); /* read nr_child before values and pointers */
8e519e3c MD	304	assert(nr_child <= type->max_linear_child);
8e519e3c MD	305	assert(type->type_class != RCU_JA_LINEAR \|\| nr_child >= type->min_child);
d68c6810	306
1db4943c	307	values = &node->u.data[1];
d68c6810	308	for (i = 0; i < nr_child; i++) {
13a7f5a6	309	if (CMM_LOAD_SHARED(values[i]) == n)
d68c6810 MD	310	break;
	311	}
	312	if (i >= nr_child)
	313	return NULL;
8e519e3c	314	pointers = (struct rcu_ja_node_flag **) align_ptr_size(&values[type->max_linear_child]);
13a7f5a6	315	ptr = rcu_dereference(pointers[i]);
d68c6810 MD	316	assert(ja_node_ptr(ptr) != NULL);
	317	return ptr;
	318	}
	319
d68c6810	320	static
fd800776	321	struct rcu_ja_node_flag ja_pool_node_get_nth(const struct rcu_ja_type type,
8e519e3c MD	322	struct rcu_ja_node *node,
8e519e3c MD	323	uint8_t n)
d68c6810	324	{
fd800776	325	struct rcu_ja_node *linear;
d68c6810	326
fd800776 MD	327	assert(type->type_class == RCU_JA_POOL);
fd800776 MD	328	linear = (struct rcu_ja_node *)
1db4943c	329	&node->u.data[((unsigned long) n >> (CHAR_BIT - type->nr_pool_order)) << type->pool_size_order];
8e519e3c	330	return ja_linear_node_get_nth(type, linear, n);
d68c6810 MD	331	}
	332
	333	static
	334	struct rcu_ja_node_flag ja_pigeon_node_get_nth(const struct rcu_ja_type type,
8e519e3c MD	335	struct rcu_ja_node *node,
8e519e3c MD	336	uint8_t n)
d68c6810 MD	337	{
d68c6810 MD	338	assert(type->type_class == RCU_JA_PIGEON);
13a7f5a6	339	return rcu_dereference(((struct rcu_ja_node_flag **) node->u.data)[n]);
d68c6810 MD	340	}
d68c6810 MD	341
13a7f5a6 MD	342	/*
	343	* ja_node_get_nth: get nth item from a node.
	344	* node_flag is already rcu_dereference'd.
	345	*/
d68c6810 MD	346	static
d68c6810 MD	347	struct rcu_ja_node_flag ja_node_get_nth(struct rcu_ja_node_flag node_flag,
8e519e3c	348	uint8_t n)
d68c6810 MD	349	{
	350	unsigned int type_index;
	351	struct rcu_ja_node *node;
	352	const struct rcu_ja_type *type;
	353
d68c6810 MD	354	node = ja_node_ptr(node_flag);
	355	assert(node != NULL);
	356	type_index = ja_node_type(node_flag);
	357	type = &ja_types[type_index];
	358
	359	switch (type->type_class) {
	360	case RCU_JA_LINEAR:
	361	return ja_linear_node_get_nth(type, node, n);
fd800776 MD	362	case RCU_JA_POOL:
fd800776 MD	363	return ja_pool_node_get_nth(type, node, n);
d68c6810 MD	364	case RCU_JA_PIGEON:
	365	return ja_pigeon_node_get_nth(type, node, n);
	366	default:
	367	assert(0);
	368	return (void *) -1UL;
	369	}
	370	}
	371
8e519e3c MD	372	static
	373	int ja_linear_node_set_nth(const struct rcu_ja_type *type,
	374	struct rcu_ja_node *node,
	375	uint8_t n,
	376	struct rcu_ja_node_flag *child_node_flag)
	377	{
	378	uint8_t nr_child;
	379	uint8_t values, nr_child_ptr;
	380	struct rcu_ja_node_flag **pointers;
	381	unsigned int i;
	382
	383	assert(type->type_class == RCU_JA_LINEAR \|\| type->type_class == RCU_JA_POOL);
	384
	385	nr_child_ptr = &node->u.data[0];
	386	nr_child = *nr_child_ptr;
	387	assert(nr_child <= type->max_linear_child);
	388	assert(type->type_class != RCU_JA_LINEAR \|\| nr_child >= type->min_child);
	389
	390	values = &node->u.data[1];
	391	for (i = 0; i < nr_child; i++) {
	392	if (values[i] == n)
	393	return -EEXIST;
	394	}
	395	if (nr_child >= type->max_linear_child) {
	396	/* No space left in this node type */
	397	return -ENOSPC;
	398	}
	399	pointers = (struct rcu_ja_node_flag **) align_ptr_size(&values[type->max_linear_child]);
13a7f5a6 MD	400	assert(pointers[nr_child] == NULL);
	401	rcu_assign_pointer(pointers[nr_child], child_node_flag);
	402	CMM_STORE_SHARED(values[nr_child], n);
	403	cmm_smp_wmb(); /* write value and pointer before nr_child */
	404	CMM_STORE_SHARED(*nr_child_ptr, nr_child + 1);
8e519e3c MD	405	return 0;
	406	}
	407
	408	static
	409	int ja_pool_node_set_nth(const struct rcu_ja_type *type,
	410	struct rcu_ja_node *node,
	411	uint8_t n,
	412	struct rcu_ja_node_flag *child_node_flag)
	413	{
	414	struct rcu_ja_node *linear;
	415
	416	assert(type->type_class == RCU_JA_POOL);
	417	linear = (struct rcu_ja_node *)
	418	&node->u.data[((unsigned long) n >> (CHAR_BIT - type->nr_pool_order)) << type->pool_size_order];
	419	return ja_linear_node_set_nth(type, linear, n, child_node_flag);
	420	}
	421
	422	static
	423	int ja_pigeon_node_set_nth(const struct rcu_ja_type *type,
	424	struct rcu_ja_node *node,
	425	uint8_t n,
	426	struct rcu_ja_node_flag *child_node_flag)
	427	{
	428	struct rcu_ja_node_flag **ptr;
	429
	430	assert(type->type_class == RCU_JA_PIGEON);
	431	ptr = &((struct rcu_ja_node_flag **) node->u.data)[n];
	432	if (*ptr != NULL)
	433	return -EEXIST;
	434	rcu_assign_pointer(*ptr, child_node_flag);
	435	return 0;
	436	}
	437
d68c6810	438	/*
8e519e3c MD	439	* ja_node_set_nth: set nth item within a node. Return an error
	440	* (negative error value) if it is already there.
	441	* TODO: exclusive access on node.
d68c6810	442	*/
8e519e3c MD	443	static
	444	int ja_node_set_nth(struct rcu_ja_node_flag *node_flag, uint8_t n,
	445	struct rcu_ja_node_flag *child_node_flag)
	446	{
	447	unsigned int type_index;
	448	struct rcu_ja_node *node;
	449	const struct rcu_ja_type *type;
e5227865	450
8e519e3c MD	451	node = ja_node_ptr(node_flag);
	452	assert(node != NULL);
	453	type_index = ja_node_type(node_flag);
	454	type = &ja_types[type_index];
	455
	456	switch (type->type_class) {
	457	case RCU_JA_LINEAR:
	458	return ja_linear_node_set_nth(type, node, n,
	459	child_node_flag);
	460	case RCU_JA_POOL:
	461	return ja_pool_node_set_nth(type, node, n,
	462	child_node_flag);
	463	case RCU_JA_PIGEON:
	464	return ja_pigeon_node_set_nth(type, node, n,
	465	child_node_flag);
	466	default:
	467	assert(0);
	468	return -EINVAL;
	469	}
	470
	471	return 0;
	472	}