[linux.git] / lib / rbtree_test.c

#include <linux/module.h>
#include <linux/rbtree_augmented.h>
#include <linux/random.h>
#include <asm/timex.h>

#define NODES       100
#define PERF_LOOPS  100000
#define CHECK_LOOPS 100

struct test_node {
	u32 key;
	struct rb_node rb;

	/* following fields used for testing augmented rbtree functionality */
	u32 val;
	u32 augmented;
};

static struct rb_root root = RB_ROOT;
static struct test_node nodes[NODES];

static struct rnd_state rnd;

static void insert(struct test_node *node, struct rb_root *root)
{
	struct rb_node **new = &root->rb_node, *parent = NULL;
	u32 key = node->key;

	while (*new) {
		parent = *new;
		if (key < rb_entry(parent, struct test_node, rb)->key)
			new = &parent->rb_left;
		else
			new = &parent->rb_right;
	}

	rb_link_node(&node->rb, parent, new);
	rb_insert_color(&node->rb, root);
}

static inline void erase(struct test_node *node, struct rb_root *root)
{
	rb_erase(&node->rb, root);
}

static inline u32 augment_recompute(struct test_node *node)
{
	u32 max = node->val, child_augmented;
	if (node->rb.rb_left) {
		child_augmented = rb_entry(node->rb.rb_left, struct test_node,
					   rb)->augmented;
		if (max < child_augmented)
			max = child_augmented;
	}
	if (node->rb.rb_right) {
		child_augmented = rb_entry(node->rb.rb_right, struct test_node,
					   rb)->augmented;
		if (max < child_augmented)
			max = child_augmented;
	}
	return max;
}

RB_DECLARE_CALLBACKS(static, augment_callbacks, struct test_node, rb,
		     u32, augmented, augment_recompute)

static void insert_augmented(struct test_node *node, struct rb_root *root)
{
	struct rb_node **new = &root->rb_node, *rb_parent = NULL;
	u32 key = node->key;
	u32 val = node->val;
	struct test_node *parent;

	while (*new) {
		rb_parent = *new;
		parent = rb_entry(rb_parent, struct test_node, rb);
		if (parent->augmented < val)
			parent->augmented = val;
		if (key < parent->key)
			new = &parent->rb.rb_left;
		else
			new = &parent->rb.rb_right;
	}

	node->augmented = val;
	rb_link_node(&node->rb, rb_parent, new);
	rb_insert_augmented(&node->rb, root, &augment_callbacks);
}

static void erase_augmented(struct test_node *node, struct rb_root *root)
{
	rb_erase_augmented(&node->rb, root, &augment_callbacks);
}

static void init(void)
{
	int i;
	for (i = 0; i < NODES; i++) {
		nodes[i].key = prandom_u32_state(&rnd);
		nodes[i].val = prandom_u32_state(&rnd);
	}
}

static bool is_red(struct rb_node *rb)
{
	return !(rb->__rb_parent_color & 1);
}

static int black_path_count(struct rb_node *rb)
{
	int count;
	for (count = 0; rb; rb = rb_parent(rb))
		count += !is_red(rb);
	return count;
}

static void check_postorder_foreach(int nr_nodes)
{
	struct test_node *cur, *n;
	int count = 0;
	rbtree_postorder_for_each_entry_safe(cur, n, &root, rb)
		count++;

	WARN_ON_ONCE(count != nr_nodes);
}

static void check_postorder(int nr_nodes)
{
	struct rb_node *rb;
	int count = 0;
	for (rb = rb_first_postorder(&root); rb; rb = rb_next_postorder(rb))
		count++;

	WARN_ON_ONCE(count != nr_nodes);
}

static void check(int nr_nodes)
{
	struct rb_node *rb;
	int count = 0, blacks = 0;
	u32 prev_key = 0;

	for (rb = rb_first(&root); rb; rb = rb_next(rb)) {
		struct test_node *node = rb_entry(rb, struct test_node, rb);
		WARN_ON_ONCE(node->key < prev_key);
		WARN_ON_ONCE(is_red(rb) &&
			     (!rb_parent(rb) || is_red(rb_parent(rb))));
		if (!count)
			blacks = black_path_count(rb);
		else
			WARN_ON_ONCE((!rb->rb_left || !rb->rb_right) &&
				     blacks != black_path_count(rb));
		prev_key = node->key;
		count++;
	}

	WARN_ON_ONCE(count != nr_nodes);
	WARN_ON_ONCE(count < (1 << black_path_count(rb_last(&root))) - 1);

	check_postorder(nr_nodes);
	check_postorder_foreach(nr_nodes);
}

static void check_augmented(int nr_nodes)
{
	struct rb_node *rb;

	check(nr_nodes);
	for (rb = rb_first(&root); rb; rb = rb_next(rb)) {
		struct test_node *node = rb_entry(rb, struct test_node, rb);
		WARN_ON_ONCE(node->augmented != augment_recompute(node));
	}
}

static int __init rbtree_test_init(void)
{
	int i, j;
	cycles_t time1, time2, time;

	printk(KERN_ALERT "rbtree testing");

	prandom_seed_state(&rnd, 3141592653589793238ULL);
	init();

	time1 = get_cycles();

	for (i = 0; i < PERF_LOOPS; i++) {
		for (j = 0; j < NODES; j++)
			insert(nodes + j, &root);
		for (j = 0; j < NODES; j++)
			erase(nodes + j, &root);
	}

	time2 = get_cycles();
	time = time2 - time1;

	time = div_u64(time, PERF_LOOPS);
	printk(" -> %llu cycles\n", (unsigned long long)time);

	for (i = 0; i < CHECK_LOOPS; i++) {
		init();
		for (j = 0; j < NODES; j++) {
			check(j);
			insert(nodes + j, &root);
		}
		for (j = 0; j < NODES; j++) {
			check(NODES - j);
			erase(nodes + j, &root);
		}
		check(0);
	}

	printk(KERN_ALERT "augmented rbtree testing");

	init();

	time1 = get_cycles();

	for (i = 0; i < PERF_LOOPS; i++) {
		for (j = 0; j < NODES; j++)
			insert_augmented(nodes + j, &root);
		for (j = 0; j < NODES; j++)
			erase_augmented(nodes + j, &root);
	}

	time2 = get_cycles();
	time = time2 - time1;

	time = div_u64(time, PERF_LOOPS);
	printk(" -> %llu cycles\n", (unsigned long long)time);

	for (i = 0; i < CHECK_LOOPS; i++) {
		init();
		for (j = 0; j < NODES; j++) {
			check_augmented(j);
			insert_augmented(nodes + j, &root);
		}
		for (j = 0; j < NODES; j++) {
			check_augmented(NODES - j);
			erase_augmented(nodes + j, &root);
		}
		check_augmented(0);
	}

	return -EAGAIN; /* Fail will directly unload the module */
}

static void __exit rbtree_test_exit(void)
{
	printk(KERN_ALERT "test exit\n");
}

module_init(rbtree_test_init)
module_exit(rbtree_test_exit)

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Michel Lespinasse");
MODULE_DESCRIPTION("Red Black Tree test");
Commit	Line	Data
910a742d	1	#include <linux/module.h>
9c079add	2	#include <linux/rbtree_augmented.h>
910a742d ML	3	#include <linux/random.h>
	4	#include <asm/timex.h>
	5
	6	#define NODES 100
	7	#define PERF_LOOPS 100000
	8	#define CHECK_LOOPS 100
	9
	10	struct test_node {
910a742d	11	u32 key;
dbf128cb	12	struct rb_node rb;
dadf9353 ML	13
	14	/* following fields used for testing augmented rbtree functionality */
	15	u32 val;
	16	u32 augmented;
910a742d ML	17	};
	18
	19	static struct rb_root root = RB_ROOT;
	20	static struct test_node nodes[NODES];
	21
	22	static struct rnd_state rnd;
	23
	24	static void insert(struct test_node node, struct rb_root root)
	25	{
	26	struct rb_node *new = &root->rb_node, parent = NULL;
dadf9353	27	u32 key = node->key;
910a742d ML	28
	29	while (*new) {
	30	parent = *new;
dadf9353	31	if (key < rb_entry(parent, struct test_node, rb)->key)
910a742d ML	32	new = &parent->rb_left;
	33	else
	34	new = &parent->rb_right;
	35	}
	36
	37	rb_link_node(&node->rb, parent, new);
	38	rb_insert_color(&node->rb, root);
	39	}
	40
	41	static inline void erase(struct test_node node, struct rb_root root)
	42	{
	43	rb_erase(&node->rb, root);
	44	}
	45
dadf9353 ML	46	static inline u32 augment_recompute(struct test_node *node)
	47	{
	48	u32 max = node->val, child_augmented;
	49	if (node->rb.rb_left) {
	50	child_augmented = rb_entry(node->rb.rb_left, struct test_node,
	51	rb)->augmented;
	52	if (max < child_augmented)
	53	max = child_augmented;
	54	}
	55	if (node->rb.rb_right) {
	56	child_augmented = rb_entry(node->rb.rb_right, struct test_node,
	57	rb)->augmented;
	58	if (max < child_augmented)
	59	max = child_augmented;
	60	}
	61	return max;
	62	}
	63
3908836a ML	64	RB_DECLARE_CALLBACKS(static, augment_callbacks, struct test_node, rb,
3908836a ML	65	u32, augmented, augment_recompute)
14b94af0	66
dadf9353 ML	67	static void insert_augmented(struct test_node node, struct rb_root root)
dadf9353 ML	68	{
14b94af0	69	struct rb_node *new = &root->rb_node, rb_parent = NULL;
dadf9353	70	u32 key = node->key;
14b94af0 ML	71	u32 val = node->val;
14b94af0 ML	72	struct test_node *parent;
dadf9353 ML	73
dadf9353 ML	74	while (*new) {
14b94af0 ML	75	rb_parent = *new;
	76	parent = rb_entry(rb_parent, struct test_node, rb);
	77	if (parent->augmented < val)
	78	parent->augmented = val;
	79	if (key < parent->key)
	80	new = &parent->rb.rb_left;
dadf9353	81	else
14b94af0	82	new = &parent->rb.rb_right;
dadf9353 ML	83	}
dadf9353 ML	84
14b94af0 ML	85	node->augmented = val;
	86	rb_link_node(&node->rb, rb_parent, new);
	87	rb_insert_augmented(&node->rb, root, &augment_callbacks);
dadf9353 ML	88	}
	89
	90	static void erase_augmented(struct test_node node, struct rb_root root)
	91	{
14b94af0	92	rb_erase_augmented(&node->rb, root, &augment_callbacks);
dadf9353 ML	93	}
dadf9353 ML	94
910a742d ML	95	static void init(void)
	96	{
	97	int i;
dadf9353	98	for (i = 0; i < NODES; i++) {
496f2f93 AM	99	nodes[i].key = prandom_u32_state(&rnd);
496f2f93 AM	100	nodes[i].val = prandom_u32_state(&rnd);
dadf9353	101	}
910a742d ML	102	}
	103
	104	static bool is_red(struct rb_node *rb)
	105	{
	106	return !(rb->__rb_parent_color & 1);
	107	}
	108
	109	static int black_path_count(struct rb_node *rb)
	110	{
	111	int count;
	112	for (count = 0; rb; rb = rb_parent(rb))
	113	count += !is_red(rb);
	114	return count;
	115	}
	116
964fe94d CS	117	static void check_postorder_foreach(int nr_nodes)
	118	{
	119	struct test_node cur, n;
	120	int count = 0;
	121	rbtree_postorder_for_each_entry_safe(cur, n, &root, rb)
	122	count++;
	123
	124	WARN_ON_ONCE(count != nr_nodes);
	125	}
	126
a791a62f CS	127	static void check_postorder(int nr_nodes)
	128	{
	129	struct rb_node *rb;
	130	int count = 0;
	131	for (rb = rb_first_postorder(&root); rb; rb = rb_next_postorder(rb))
	132	count++;
	133
	134	WARN_ON_ONCE(count != nr_nodes);
	135	}
	136
910a742d ML	137	static void check(int nr_nodes)
	138	{
	139	struct rb_node *rb;
4130f0ef	140	int count = 0, blacks = 0;
910a742d ML	141	u32 prev_key = 0;
	142
	143	for (rb = rb_first(&root); rb; rb = rb_next(rb)) {
	144	struct test_node *node = rb_entry(rb, struct test_node, rb);
	145	WARN_ON_ONCE(node->key < prev_key);
	146	WARN_ON_ONCE(is_red(rb) &&
	147	(!rb_parent(rb) \|\| is_red(rb_parent(rb))));
	148	if (!count)
	149	blacks = black_path_count(rb);
	150	else
	151	WARN_ON_ONCE((!rb->rb_left \|\| !rb->rb_right) &&
	152	blacks != black_path_count(rb));
	153	prev_key = node->key;
	154	count++;
	155	}
4130f0ef	156
910a742d	157	WARN_ON_ONCE(count != nr_nodes);
4130f0ef	158	WARN_ON_ONCE(count < (1 << black_path_count(rb_last(&root))) - 1);
a791a62f CS	159
a791a62f CS	160	check_postorder(nr_nodes);
964fe94d	161	check_postorder_foreach(nr_nodes);
910a742d ML	162	}
910a742d ML	163
dadf9353 ML	164	static void check_augmented(int nr_nodes)
	165	{
	166	struct rb_node *rb;
	167
	168	check(nr_nodes);
	169	for (rb = rb_first(&root); rb; rb = rb_next(rb)) {
	170	struct test_node *node = rb_entry(rb, struct test_node, rb);
	171	WARN_ON_ONCE(node->augmented != augment_recompute(node));
	172	}
	173	}
	174
c75aaa8e	175	static int __init rbtree_test_init(void)
910a742d ML	176	{
	177	int i, j;
	178	cycles_t time1, time2, time;
	179
	180	printk(KERN_ALERT "rbtree testing");
	181
496f2f93	182	prandom_seed_state(&rnd, 3141592653589793238ULL);
910a742d ML	183	init();
	184
	185	time1 = get_cycles();
	186
	187	for (i = 0; i < PERF_LOOPS; i++) {
	188	for (j = 0; j < NODES; j++)
	189	insert(nodes + j, &root);
	190	for (j = 0; j < NODES; j++)
	191	erase(nodes + j, &root);
	192	}
	193
	194	time2 = get_cycles();
	195	time = time2 - time1;
	196
	197	time = div_u64(time, PERF_LOOPS);
	198	printk(" -> %llu cycles\n", (unsigned long long)time);
	199
	200	for (i = 0; i < CHECK_LOOPS; i++) {
	201	init();
	202	for (j = 0; j < NODES; j++) {
	203	check(j);
	204	insert(nodes + j, &root);
	205	}
	206	for (j = 0; j < NODES; j++) {
	207	check(NODES - j);
	208	erase(nodes + j, &root);
	209	}
	210	check(0);
	211	}
	212
dadf9353 ML	213	printk(KERN_ALERT "augmented rbtree testing");
	214
	215	init();
	216
	217	time1 = get_cycles();
	218
	219	for (i = 0; i < PERF_LOOPS; i++) {
	220	for (j = 0; j < NODES; j++)
	221	insert_augmented(nodes + j, &root);
	222	for (j = 0; j < NODES; j++)
	223	erase_augmented(nodes + j, &root);
	224	}
	225
	226	time2 = get_cycles();
	227	time = time2 - time1;
	228
	229	time = div_u64(time, PERF_LOOPS);
	230	printk(" -> %llu cycles\n", (unsigned long long)time);
	231
	232	for (i = 0; i < CHECK_LOOPS; i++) {
	233	init();
	234	for (j = 0; j < NODES; j++) {
	235	check_augmented(j);
	236	insert_augmented(nodes + j, &root);
	237	}
	238	for (j = 0; j < NODES; j++) {
	239	check_augmented(NODES - j);
	240	erase_augmented(nodes + j, &root);
	241	}
	242	check_augmented(0);
	243	}
	244
910a742d ML	245	return -EAGAIN; /* Fail will directly unload the module */
	246	}
	247
c75aaa8e	248	static void __exit rbtree_test_exit(void)
910a742d ML	249	{
	250	printk(KERN_ALERT "test exit\n");
	251	}
	252
	253	module_init(rbtree_test_init)
	254	module_exit(rbtree_test_exit)
	255
	256	MODULE_LICENSE("GPL");
	257	MODULE_AUTHOR("Michel Lespinasse");
	258	MODULE_DESCRIPTION("Red Black Tree test");