summaryrefslogtreecommitdiff
path: root/src/utils/rbtree.c
blob: 4fd3c23caed058e8de2817b5e2dfae1674da5464 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
/*
 * This file is part of LibParserUtils.
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 * Copyright 2008 John-Mark Bell <jmb@netsurf-browser.org>
 */

#include <assert.h>
#ifndef NDEBUG
#include <stdio.h>
#endif

#include <parserutils/errors.h>
#include <parserutils/functypes.h>

#include "utils/rbtree.h"

/* Compile-time configuration */

/* Define this to validate the tree structure after every insertion/deletion 
 * Note: this performs a complete tree traversal, so has a large performance 
 * impact */
#undef RBTREE_VALIDATE

/* Define this to use deleteMax() to destroy a tree. 
 * Uses deleteMin() if undefined. */
#undef USE_DELETEMAX

/**
 * Node in an RB tree
 */
typedef struct rbnode
{
	struct rbnode *left;		/**< Left subtree */
	struct rbnode *right;		/**< Right subtree */
	enum { RED = true, BLACK = false } colour;	/**< Colour of node */

	void *key;			/**< Node key */
	void *value;			/**< Node value */
} rbnode;

/**
 * RB tree object
 */
struct parserutils_rbtree
{
	rbnode *root;			/**< Root node of tree */

	parserutils_rbtree_cmp cmp;	/**< Key comparator */

	parserutils_alloc alloc;	/**< Memory (de)allocation function */
	void *pw;			/**< Pointer to client data */
};

static rbnode *rbtree_insert_internal(parserutils_rbtree *tree, 
		rbnode *current, void *key, void *value, void **oldvalue);
static rbnode *rbtree_delete_internal(parserutils_rbtree *tree, 
		rbnode *current, const void *key, void **intkey, void **value);
static inline rbnode *rbnode_create(parserutils_alloc alloc, void *pw, 
		void *key, void *value);
static inline void rbnode_destroy(parserutils_alloc alloc, void *pw, 
		rbnode *node);
static inline bool isRed(rbnode *node);
static inline void colourFlip(rbnode *node);
static inline rbnode *rotateLeft(rbnode *node);
static inline rbnode *rotateRight(rbnode *node);
static inline rbnode *moveRedLeft(rbnode *node);
static inline rbnode *moveRedRight(rbnode *node);
static inline rbnode *fixUp(rbnode *node);
#ifdef USE_DELETEMAX
static inline rbnode *deleteMax(parserutils_rbtree *tree, rbnode *node,
		parserutils_rbtree_del destructor, void *pw);
#else
static inline rbnode *deleteMin(parserutils_rbtree *tree, rbnode *node, 
		parserutils_rbtree_del destructor, void *pw);
#endif
static inline rbnode *findMin(rbnode *node);

#ifndef NDEBUG
#ifdef RBTREE_VALIDATE
static inline void verify_tree(rbnode *node);
static inline rbnode *verify_tree_internal(rbnode *node);
static inline void dump_tree_raw(rbnode *node, uint32_t depth);
#endif
static inline void dump_tree(rbnode *node, parserutils_rbtree_print print, 
		uint32_t depth);
#endif

/**
 * Create a RB tree
 *
 * \param cmp    Comparator routine for keys
 * \param alloc  Memory (de)allocation function
 * \param pw     Pointer to client-specific private data
 * \param tree   Pointer to location to receive tree instance
 * \return PARSERUTILS_OK on success, 
 *         PARSERUTILS_BADPARM on bad parameters,
 *         PARSERUTILS_NOMEM on memory exhaustion
 */
parserutils_error parserutils_rbtree_create(parserutils_rbtree_cmp cmp, 
		parserutils_alloc alloc, void *pw, parserutils_rbtree **tree)
{
	parserutils_rbtree *t;

	if (cmp == NULL || alloc == NULL || tree == NULL)
		return PARSERUTILS_BADPARM;

	t = alloc(NULL, sizeof(parserutils_rbtree), pw);
	if (t == NULL)
		return PARSERUTILS_NOMEM;

	t->root = NULL;
	t->cmp = cmp;
	t->alloc = alloc;
	t->pw = pw;

	*tree = t;

	return PARSERUTILS_OK;
}

/**
 * Destroy an RB tree
 *
 * \param tree        The tree to destroy
 * \param destructor  Routine to be called with key/value pairs to destroy
 * \param pw          Pointer to client-specific private data
 * \return PARSERUTILS_OK on success, appropriate error otherwise
 */
parserutils_error parserutils_rbtree_destroy(parserutils_rbtree *tree,
		parserutils_rbtree_del destructor, void *pw)
{
	if (tree == NULL)
		return PARSERUTILS_BADPARM;

	while (tree->root != NULL) {
#ifndef USE_DELETEMAX
		tree->root = deleteMin(tree, tree->root, destructor, pw);
#else
		tree->root = deleteMax(tree, tree->root, destructor, pw);
#endif
		if (tree->root != NULL)
			tree->root->colour = BLACK;

#if !defined(NDEBUG) && defined(RBTREE_VALIDATE)
		verify_tree(tree->root);
#endif
	}

	tree->alloc(tree, 0, tree->pw);

	return PARSERUTILS_OK;
}

/**
 * Insert into a RB tree
 * 
 * \param tree   The tree to insert into
 * \param key    The key to insert (not copied)
 * \param value  The value to insert (not copied)
 * \param oldvalue  Pointer to location to receive previous value for key
 * \return PARSERUTILS_OK on success, appropriate error otherwise.
 */
parserutils_error parserutils_rbtree_insert(parserutils_rbtree *tree, 
		void *key, void *value, void **oldvalue)
{
	rbnode *temp;

	if (tree == NULL || key == NULL || oldvalue == NULL)
		return PARSERUTILS_BADPARM;

	temp = rbtree_insert_internal(tree, tree->root, key, 
			value, oldvalue);
	if (temp == NULL)
		return PARSERUTILS_NOMEM;

	temp->colour = BLACK;
	tree->root = temp;

#if !defined(NDEBUG) && defined(RBTREE_VALIDATE)
	verify_tree(tree->root);
#endif

	return PARSERUTILS_OK;
}

/**
 * Find an entry in a RB tree
 *
 * \param tree   The tree to search in
 * \param key    The key to search for
 * \param value  Pointer to location to receive value for key
 * \return PARSERUTILS_OK on success, appropriate error otherwise
 */
parserutils_error parserutils_rbtree_find(parserutils_rbtree *tree, 
		const void *key, void **value)
{
	rbnode *node;

	if (tree == NULL || key == NULL || value == NULL)
		return PARSERUTILS_BADPARM;

	node = tree->root;
	*value = NULL;

	while (node != NULL) {
		int cmp = tree->cmp(key, node->key);

		if (cmp == 0) {
			*value = node->value;
			break;
		} else if (cmp < 0) {
			node = node->left;
		} else {
			node = node->right;
		}
	}

	return PARSERUTILS_OK;
}

/**
 * Delete an entry from a RB tree
 *
 * \param tree    The tree to delete from
 * \param key     The key to delete
 * \param intkey  Pointer to location to receive key
 * \param value   Pointer to location to receive value
 * \return PARSERUTILS_OK on success, appropriate error otherwise
 */
parserutils_error parserutils_rbtree_delete(parserutils_rbtree *tree, 
		const void *key, void **intkey, void **value)
{
	rbnode *temp;

	if (tree == NULL || key == NULL || intkey == NULL || value == NULL)
		return PARSERUTILS_BADPARM;

	if (tree->root == NULL) {
		*intkey = NULL;
		*value = NULL;
		return PARSERUTILS_OK;
	}

	temp = rbtree_delete_internal(tree, tree->root, key, intkey, value);
	if (temp != NULL)
		temp->colour = BLACK;
	tree->root = temp;

#if !defined(NDEBUG) && defined(RBTREE_VALIDATE)
	verify_tree(tree->root);
#endif

	return PARSERUTILS_OK;
}

/**
 * Helper function for tree insertion
 *
 * \param tree      Tree to insert into
 * \param current   The root of the current subtree
 * \param key       Key to insert (not copied)
 * \param value     Value to insert (not copied)
 * \param oldvalue  Pointer to location to receive old value for key
 * \return Pointer to new root of current subtree
 */
rbnode *rbtree_insert_internal(parserutils_rbtree *tree, rbnode *current, 
		void *key, void *value, void **oldvalue)
{
	int cmp;
	if (current == NULL) {
		rbnode *node = rbnode_create(tree->alloc, tree->pw, key, value);
		if (node == NULL)
			return NULL;

		*oldvalue = NULL;

		return node;
	}

	/* Split 4-nodes */
	if (isRed(current->left) && isRed(current->right))
		colourFlip(current);

	cmp = tree->cmp(key, current->key);

	if (cmp == 0) {
		*oldvalue = current->value;
		current->value = value;
	} else if (cmp < 0) {
		rbnode *temp = rbtree_insert_internal(tree, current->left, 
				key, value, oldvalue);
		if (temp == NULL)
			return NULL;
		current->left = temp;
	} else {
		rbnode *temp = rbtree_insert_internal(tree, current->right,
				key, value, oldvalue);
		if (temp == NULL)
			return NULL;
		current->right = temp;
	}

	/* Eliminate right-leaning 3-nodes by rotating left */
	if (isRed(current->right))
		current = rotateLeft(current);

	/* Balance 4-nodes by rotating right */
	if (isRed(current->left) && isRed(current->left->left))
		current = rotateRight(current);

	return current;
}

/**
 * Helper function for tree deletion
 * 
 * \param tree     Tree to delete from
 * \param current  Root node of current subtree
 * \param key      Key to delete
 * \param intkey   Pointer to location to receive key
 * \param value    Pointer to location to receive value
 * \return Pointer to new root node for current subtree
 */
rbnode *rbtree_delete_internal(parserutils_rbtree *tree, rbnode *current, 
		const void *key, void **intkey, void **value)
{
	int cmp;

	if (current == NULL)
		return NULL;

	cmp = tree->cmp(key, current->key);

	if (cmp < 0) {
		if (current->left != NULL && !isRed(current->left) && 
				!isRed(current->left->left))
			current = moveRedLeft(current);
		current->left = rbtree_delete_internal(tree, current->left, 
				key, intkey, value);
	} else {
		if (isRed(current->left))
			current = rotateRight(current);

		if (cmp == 0 && current->right == NULL) {
			*intkey = current->key;
			*value = current->value;

			rbnode_destroy(tree->alloc, tree->pw, current);
			return NULL;
		}

		if (current->right != NULL && !isRed(current->right) && 
				!isRed(current->right->left))
			current = moveRedRight(current);

		/* Must recalculate here, as current may have changed */
		if (tree->cmp(key, current->key) == 0) {
			rbnode *successor;
			*intkey = current->key;
			*value = current->value;

			successor = findMin(current->right);

			current->value = successor->value;
			current->key = successor->key;

			current->right = deleteMin(tree, current->right, 
					NULL, NULL);
		} else {
			current->right = rbtree_delete_internal(tree,
					current->right, key, intkey, value);
		}
	}

	return fixUp(current);
}

/**
 * Create a RB node
 *
 * \param alloc  Memory (de)allocation function
 * \param pw     Pointer to client-specific private data
 * \param key    Key for node (not copied)
 * \param value  Value for node (not copied)
 * \return Pointer to node, or NULL on memory exhaustion
 */
rbnode *rbnode_create(parserutils_alloc alloc, void *pw, void *key, void *value)
{
	rbnode *node = alloc(NULL, sizeof(rbnode), pw);
	if (node == NULL)
		return NULL;

	node->left = NULL;
	node->right = NULL;
	node->colour = RED;
	node->key = key;
	node->value = value;

	return node;
}

/**
 * Destroy a RB node
 *
 * \param alloc  Memory (de)allocation function
 * \param pw     Pointer to client-specific private data
 * \param node   The node to destroy
 */
void rbnode_destroy(parserutils_alloc alloc, void *pw, rbnode *node)
{
	alloc(node, 0, pw);
}

/**
 * Determine if a given node is red
 *
 * \param node  The node to consider
 * \return True if node is red, false otherwise
 */
bool isRed(rbnode *node)
{
	if (node == NULL)
		return false;

	return node->colour == RED;
}

/**
 * Flip the colours for a node
 *
 * \param node  The node to consider
 */
void colourFlip(rbnode *node)
{
	node->colour = !node->colour;
	if (node->left != NULL)
		node->left->colour = !node->left->colour;
	if (node->right != NULL)
		node->right->colour = !node->right->colour;
}

/**
 * Rotate a node left
 *
 * \param node  The node to rotate
 * \return The new root of the subtree
 */
rbnode *rotateLeft(rbnode *node)
{
	rbnode *r = node->right;

	node->right = r->left;
	r->left = node;
	r->colour = node->colour;
	node->colour = RED;

	return r;
}

/**
 * Rotate a node right
 *
 * \param node  The node to rotate
 * \return The new root of the subtree
 */
rbnode *rotateRight(rbnode *node)
{
	rbnode *l = node->left;

	node->left = l->right;
	l->right = node;
	l->colour = node->colour;
	node->colour = RED;

	return l;
}

/**
 * Move a red node left
 *
 * \param node  Root of subtree to manipulate
 * \return New root of subtree
 */
rbnode *moveRedLeft(rbnode *node)
{
	colourFlip(node);

	if (node->right != NULL && isRed(node->right->left)) {
		node->right = rotateRight(node->right);
		node = rotateLeft(node);
		colourFlip(node);

		/* Maintain left-leaning requirement for 3-nodes after
		 * we've just split a 4-node */
		if (node->right != NULL && isRed(node->right->right)) {
			node->right = rotateLeft(node->right);
		}
	}

	return node;
}

/**
 * Move a red node right
 *
 * \param node  Root of subtree to manipulate
 * \return New root of subtree
 */
rbnode *moveRedRight(rbnode *node)
{
	colourFlip(node);

	if (node->left != NULL && isRed(node->left->left)) {
		node = rotateRight(node);
		colourFlip(node);
	}

	return node;
}

/**
 * Fix right-leaning red links
 *
 * \param node  Root of subtree to manipulate
 * \return New root of subtree
 */
rbnode *fixUp(rbnode *node)
{
	if (node->right != NULL && isRed(node->right))
		node = rotateLeft(node);

	if (node->left != NULL && isRed(node->left)) {
		/* Two red links in a row aren't permitted */
		if (node->left->left != NULL && isRed(node->left->left)) {
			node = rotateRight(node);
		} else if (node->left->right != NULL && 
				isRed(node->left->right)) {
			node->left = rotateLeft(node->left);
			/* Force left child colour to black (it can only have 
			 * been red before). We can't use colourFlip() here, as 
			 * it will potentially break the right-hand subtree. */
			node->left->colour = BLACK;
		}
	}

	if (isRed(node->left) && isRed(node->right))
		colourFlip(node);

	return node;
}

#ifdef USE_DELETEMAX
/**
 * Delete the right-most node in a tree
 *
 * \param tree        The tree instance
 * \param node        Root of subtree to manipulate
 * \param destructor  Destructor routine, or NULL
 * \param pw          Pointer to client-specific private data
 * \return New root of subtree
 */
rbnode *deleteMax(parserutils_rbtree *tree, rbnode *node,
		parserutils_rbtree_del destructor, void *pw)
{
	if (isRed(node->left))
		node = rotateRight(node);

	if (node->right == NULL) {
		if (destructor != NULL)
			destructor(node->key, node->value, pw);
		rbnode_destroy(tree->alloc, tree->pw, node);
		return NULL;
	}

	if (!isRed(node->right) && !isRed(node->right->left))
		node = moveRedRight(node);

	assert(isRed(node->right) || isRed(node->right->left) ||
			isRed(node->right->right));

	node->right = deleteMax(tree, node->right, destructor, pw);

	return fixUp(node);
}
#else
/**
 * Delete the left-most node in a tree
 *
 * \param tree        The tree instance
 * \param node        Root of subtree to manipulate
 * \param destructor  Destructor routine, or NULL
 * \param pw          Pointer to client-specific private data
 * \return New root of subtree
 */
rbnode *deleteMin(parserutils_rbtree *tree, rbnode *node, 
		parserutils_rbtree_del destructor, void *pw)
{
	if (node->left == NULL) {
		if (destructor != NULL)
			destructor(node->key, node->value, pw);
		rbnode_destroy(tree->alloc, tree->pw, node);
		return NULL;
	}

	if (!isRed(node->left) && !isRed(node->left->left))
		node = moveRedLeft(node);

	assert(isRed(node->left) || isRed(node->left->left));

	node->left = deleteMin(tree, node->left, destructor, pw);

	return fixUp(node);
}
#endif

/**
 * Find the left-most node in a tree
 *
 * \param node  Root of the subtree to consider
 * \return Left-most node
 */
rbnode *findMin(rbnode *node)
{
	while (node->left != NULL)
		node = node->left;

	return node;
}

#ifndef NDEBUG
#ifdef RBTREE_VALIDATE
/**
 * Verify the correctness of a tree
 *
 * \param node  Root of tree to verify
 */
void verify_tree(rbnode *node)
{
	rbnode *invalid;

	if ((invalid = verify_tree_internal(node)) != NULL) {
		dump_tree_raw(node, 0);
		printf("Invalid node: %p\n", (void *) invalid);
		assert(0 && "RB invariant violated");
	}
}

/**
 * Verify the structure of an RB tree
 * 
 * \param node  Root node of tree to validate
 * \return Pointer to invalid node, or NULL
 */
rbnode *verify_tree_internal(rbnode *node)
{
	rbnode *invalid;

	if (node == NULL)
		return NULL;

	if (isRed(node) && (isRed(node->left) || isRed(node->right))) {
		return node;
	}

	if (isRed(node->right) && !isRed(node->left)) {
		return node;
	}

	if (isRed(node->left) && isRed(node->left->left)) {
		return node;
	}

	if (isRed(node->right) && isRed(node->right->right)) {
		return node;
	}

	if ((invalid = verify_tree_internal(node->left)) != NULL)
		return invalid;

	if ((invalid = verify_tree_internal(node->right)) != NULL)
		return invalid;

	return NULL;
}

/**
 * Dump a tree to stdout in raw format
 *
 * \param node   Root of tree to dump
 * \param depth  Current node depth
 */
void dump_tree_raw(rbnode *node, uint32_t depth)
{
	if (node->right)
		dump_tree_raw(node->right, depth + 1);

	for (uint32_t i = 0; i < depth; i++)
		putchar(' ');

	printf("%p %p %p [%c]\n", (void *) node, node->key, node->value,
			isRed(node) ? 'r' : 'b');

	if (node->left)
		dump_tree_raw(node->left, depth + 1);
}
#endif

/**
 * Recursively print out a pre-order traversal of a RB tree
 *
 * \param node   Root node of subtree
 * \param print  Print routine
 * \param depth  Current depth in tree
 */
void dump_tree(rbnode *node, parserutils_rbtree_print print, uint32_t depth)
{
	if (node->right)
		dump_tree(node->right, print, depth + 1);

	print(node->key, node->value, depth);

	if (node->left)
		dump_tree(node->left, print, depth + 1);
}

/**
 * Print out a RB tree
 *
 * \param tree   The tree to print
 * \param print  Print routine
 */
void parserutils_rbtree_dump(parserutils_rbtree *tree, 
		parserutils_rbtree_print print)
{
	if (tree == NULL || tree->root == NULL)
		return;

	dump_tree(tree->root, print, 0);
}
#endif