1
/* Copyright (C) 2000 MySQL AB
3
This program is free software; you can redistribute it and/or modify
4
it under the terms of the GNU General Public License as published by
5
the Free Software Foundation; version 2 of the License.
7
This program is distributed in the hope that it will be useful,
8
but WITHOUT ANY WARRANTY; without even the implied warranty of
9
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
GNU General Public License for more details.
12
You should have received a copy of the GNU General Public License
13
along with this program; if not, write to the Free Software
14
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
17
Code for handling red-black (balanced) binary trees.
18
key in tree is allocated accrding to following:
20
1) If size < 0 then tree will not allocate keys and only a pointer to
21
each key is saved in tree.
22
compare and search functions uses and returns key-pointer
24
2) If size == 0 then there are two options:
25
- key_size != 0 to tree_insert: The key will be stored in the tree.
26
- key_size == 0 to tree_insert: A pointer to the key is stored.
27
compare and search functions uses and returns key-pointer.
29
3) if key_size is given to init_tree then each node will continue the
30
key and calls to insert_key may increase length of key.
31
if key_size > sizeof(pointer) and key_size is a multiple of 8 (double
32
allign) then key will be put on a 8 alligned adress. Else
33
the key will be on adress (element+1). This is transparent for user
34
compare and search functions uses a pointer to given key-argument.
36
- If you use a free function for tree-elements and you are freeing
37
the element itself, you should use key_size = 0 to init_tree and
40
The actual key in TREE_ELEMENT is saved as a pointer or after the
42
If one uses only pointers in tree one can use tree_set_pointer() to
43
change address of data.
50
tree->compare function should be ALWAYS called as
51
(*tree->compare)(custom_arg, ELEMENT_KEY(tree,element), key)
52
and not other way around, as
53
(*tree->compare)(custom_arg, key, ELEMENT_KEY(tree,element))
58
#include "drizzled/my_tree.h"
59
#include "drizzled/internal/my_sys.h"
60
#include "drizzled/internal/m_string.h"
61
#include "drizzled/memory/root.h"
63
using namespace drizzled;
67
#define DEFAULT_ALLOC_SIZE 8192
68
#define DEFAULT_ALIGN_SIZE 8192
70
#define ELEMENT_KEY(tree,element)\
71
(tree->offset_to_key ? (void*)((unsigned char*) element+tree->offset_to_key) :\
72
*((void**) (element+1)))
73
#define ELEMENT_CHILD(element, offs) (*(TREE_ELEMENT**)((char*)element + offs))
75
static void delete_tree_element(TREE *,TREE_ELEMENT *);
76
static int tree_walk_left_root_right(TREE *,TREE_ELEMENT *,
77
tree_walk_action,void *);
78
static int tree_walk_right_root_left(TREE *,TREE_ELEMENT *,
79
tree_walk_action,void *);
80
static void left_rotate(TREE_ELEMENT **parent,TREE_ELEMENT *leaf);
81
static void right_rotate(TREE_ELEMENT **parent, TREE_ELEMENT *leaf);
82
static void rb_insert(TREE *tree,TREE_ELEMENT ***parent,
84
static void rb_delete_fixup(TREE *tree,TREE_ELEMENT ***parent);
87
void init_tree(TREE *tree, size_t default_alloc_size, uint32_t memory_limit,
88
uint32_t size, qsort_cmp2 compare, bool with_delete,
89
tree_element_free free_element, void *custom_arg)
91
if (default_alloc_size < DEFAULT_ALLOC_SIZE)
92
default_alloc_size= DEFAULT_ALLOC_SIZE;
93
default_alloc_size= MY_ALIGN(default_alloc_size, DEFAULT_ALIGN_SIZE);
94
memset(&tree->null_element, 0, sizeof(tree->null_element));
95
tree->root= &tree->null_element;
96
tree->compare= compare;
97
tree->size_of_element= size > 0 ? (uint32_t) size : 0;
98
tree->memory_limit= memory_limit;
99
tree->free= free_element;
101
tree->elements_in_tree= 0;
102
tree->custom_arg = custom_arg;
103
tree->null_element.colour= BLACK;
104
tree->null_element.left=tree->null_element.right= 0;
107
(size <= sizeof(void*) || ((uint32_t) size & (sizeof(void*)-1))))
110
We know that the data doesn't have to be aligned (like if the key
111
contains a double), so we can store the data combined with the
114
tree->offset_to_key= sizeof(TREE_ELEMENT); /* Put key after element */
115
/* Fix allocation size so that we don't lose any memory */
116
default_alloc_size/= (sizeof(TREE_ELEMENT)+size);
117
if (!default_alloc_size)
118
default_alloc_size= 1;
119
default_alloc_size*= (sizeof(TREE_ELEMENT)+size);
123
tree->offset_to_key= 0; /* use key through pointer */
124
tree->size_of_element+= sizeof(void*);
126
if (! (tree->with_delete= with_delete))
128
init_alloc_root(&tree->mem_root, default_alloc_size);
129
tree->mem_root.min_malloc= (sizeof(TREE_ELEMENT)+tree->size_of_element);
133
static void free_tree(TREE *tree, myf free_flags)
135
if (tree->root) /* If initialized */
137
if (tree->with_delete)
138
delete_tree_element(tree,tree->root);
143
if (tree->memory_limit)
144
(*tree->free)(NULL, free_init, tree->custom_arg);
145
delete_tree_element(tree,tree->root);
146
if (tree->memory_limit)
147
(*tree->free)(NULL, free_end, tree->custom_arg);
149
free_root(&tree->mem_root, free_flags);
152
tree->root= &tree->null_element;
153
tree->elements_in_tree= 0;
157
void delete_tree(TREE* tree)
159
free_tree(tree, MYF(0)); /* free() mem_root if applicable */
162
void reset_tree(TREE* tree)
164
/* do not free mem_root, just mark blocks as free */
165
free_tree(tree, MYF(memory::MARK_BLOCKS_FREE));
169
static void delete_tree_element(TREE *tree, TREE_ELEMENT *element)
171
if (element != &tree->null_element)
173
delete_tree_element(tree,element->left);
175
(*tree->free)(ELEMENT_KEY(tree,element), free_free, tree->custom_arg);
176
delete_tree_element(tree,element->right);
177
if (tree->with_delete)
178
free((char*) element);
184
insert, search and delete of elements
186
The following should be true:
187
parent[0] = & parent[-1][0]->left ||
188
parent[0] = & parent[-1][0]->right
191
TREE_ELEMENT *tree_insert(TREE *tree, void *key, uint32_t key_size,
195
TREE_ELEMENT *element,***parent;
197
parent= tree->parents;
198
*parent = &tree->root; element= tree->root;
201
if (element == &tree->null_element ||
202
(cmp = (*tree->compare)(custom_arg, ELEMENT_KEY(tree,element),
207
*++parent= &element->right; element= element->right;
211
*++parent = &element->left; element= element->left;
214
if (element == &tree->null_element)
216
size_t alloc_size= sizeof(TREE_ELEMENT)+key_size+tree->size_of_element;
217
tree->allocated+= alloc_size;
219
if (tree->memory_limit && tree->elements_in_tree
220
&& tree->allocated > tree->memory_limit)
223
return tree_insert(tree, key, key_size, custom_arg);
226
key_size+= tree->size_of_element;
227
if (tree->with_delete)
228
element= (TREE_ELEMENT *) malloc(alloc_size);
230
element= (TREE_ELEMENT *) alloc_root(&tree->mem_root,alloc_size);
234
element->left= element->right= &tree->null_element;
235
if (!tree->offset_to_key)
237
if (key_size == sizeof(void*)) /* no length, save pointer */
238
*((void**) (element+1))= key;
241
*((void**) (element+1))= (void*) ((void **) (element+1)+1);
242
memcpy(*((void **) (element+1)),key, key_size - sizeof(void*));
246
memcpy((unsigned char*) element + tree->offset_to_key, key, key_size);
247
element->count= 1; /* May give warning in purify */
248
tree->elements_in_tree++;
249
rb_insert(tree,parent,element); /* rebalance tree */
253
if (tree->flag & TREE_NO_DUPS)
256
/* Avoid a wrap over of the count. */
257
if (! element->count)
264
int tree_delete(TREE *tree, void *key, uint32_t key_size, void *custom_arg)
267
TREE_ELEMENT *element,***parent, ***org_parent, *nod;
268
if (!tree->with_delete)
269
return 1; /* not allowed */
271
parent= tree->parents;
272
*parent= &tree->root; element= tree->root;
277
if (element == &tree->null_element)
278
return 1; /* Was not in tree */
279
if ((cmp = (*tree->compare)(custom_arg, ELEMENT_KEY(tree,element),
284
*++parent= &element->right; element= element->right;
288
*++parent = &element->left; element= element->left;
291
if (element->left == &tree->null_element)
293
(**parent)= element->right;
294
remove_colour= element->colour;
296
else if (element->right == &tree->null_element)
298
(**parent)= element->left;
299
remove_colour= element->colour;
304
*++parent= &element->right; nod= element->right;
305
while (nod->left != &tree->null_element)
307
*++parent= &nod->left; nod= nod->left;
309
(**parent)= nod->right; /* unlink nod from tree */
310
remove_colour= nod->colour;
311
org_parent[0][0]= nod; /* put y in place of element */
312
org_parent[1]= &nod->right;
313
nod->left= element->left;
314
nod->right= element->right;
315
nod->colour= element->colour;
317
if (remove_colour == BLACK)
318
rb_delete_fixup(tree,parent);
320
(*tree->free)(ELEMENT_KEY(tree,element), free_free, tree->custom_arg);
321
tree->allocated-= sizeof(TREE_ELEMENT) + tree->size_of_element + key_size;
322
free((unsigned char*) element);
323
tree->elements_in_tree--;
328
void *tree_search_key(TREE *tree, const void *key,
329
TREE_ELEMENT **parents, TREE_ELEMENT ***last_pos,
330
enum ha_rkey_function flag, void *custom_arg)
332
TREE_ELEMENT *element= tree->root;
333
TREE_ELEMENT **last_left_step_parent= NULL, **last_right_step_parent= NULL;
334
TREE_ELEMENT **last_equal_element= NULL;
337
TODO: support for HA_READ_KEY_OR_PREV, HA_READ_PREFIX flags if needed.
340
*parents = &tree->null_element;
341
while (element != &tree->null_element)
347
if ((cmp= (*tree->compare)(custom_arg, ELEMENT_KEY(tree, element),
351
case HA_READ_KEY_EXACT:
352
case HA_READ_KEY_OR_NEXT:
353
case HA_READ_BEFORE_KEY:
354
last_equal_element= parents;
357
case HA_READ_AFTER_KEY:
360
case HA_READ_PREFIX_LAST:
361
case HA_READ_PREFIX_LAST_OR_PREV:
362
last_equal_element= parents;
369
if (cmp < 0) /* element < key */
371
last_right_step_parent= parents;
372
element= element->right;
376
last_left_step_parent= parents;
377
element= element->left;
381
case HA_READ_KEY_EXACT:
382
case HA_READ_PREFIX_LAST:
383
*last_pos= last_equal_element;
385
case HA_READ_KEY_OR_NEXT:
386
*last_pos= last_equal_element ? last_equal_element : last_left_step_parent;
388
case HA_READ_AFTER_KEY:
389
*last_pos= last_left_step_parent;
391
case HA_READ_PREFIX_LAST_OR_PREV:
392
*last_pos= last_equal_element ? last_equal_element : last_right_step_parent;
394
case HA_READ_BEFORE_KEY:
395
*last_pos= last_right_step_parent;
401
return *last_pos ? ELEMENT_KEY(tree, **last_pos) : NULL;
405
Search first (the most left) or last (the most right) tree element
407
void *tree_search_edge(TREE *tree, TREE_ELEMENT **parents,
408
TREE_ELEMENT ***last_pos, int child_offs)
410
TREE_ELEMENT *element= tree->root;
412
*parents= &tree->null_element;
413
while (element != &tree->null_element)
416
element= ELEMENT_CHILD(element, child_offs);
419
return **last_pos != &tree->null_element ?
420
ELEMENT_KEY(tree, **last_pos) : NULL;
423
void *tree_search_next(TREE *tree, TREE_ELEMENT ***last_pos, int l_offs,
426
TREE_ELEMENT *x= **last_pos;
428
if (ELEMENT_CHILD(x, r_offs) != &tree->null_element)
430
x= ELEMENT_CHILD(x, r_offs);
432
while (ELEMENT_CHILD(x, l_offs) != &tree->null_element)
434
x= ELEMENT_CHILD(x, l_offs);
437
return ELEMENT_KEY(tree, x);
441
TREE_ELEMENT *y= *--*last_pos;
442
while (y != &tree->null_element && x == ELEMENT_CHILD(y, r_offs))
447
return y == &tree->null_element ? NULL : ELEMENT_KEY(tree, y);
452
Expected that tree is fully balanced
453
(each path from root to leaf has the same length)
455
ha_rows tree_record_pos(TREE *tree, const void *key,
456
enum ha_rkey_function flag, void *custom_arg)
458
TREE_ELEMENT *element= tree->root;
460
double right= tree->elements_in_tree;
462
while (element != &tree->null_element)
466
if ((cmp= (*tree->compare)(custom_arg, ELEMENT_KEY(tree, element),
470
case HA_READ_KEY_EXACT:
471
case HA_READ_BEFORE_KEY:
474
case HA_READ_AFTER_KEY:
481
if (cmp < 0) /* element < key */
483
element= element->right;
484
left= (left + right) / 2;
488
element= element->left;
489
right= (left + right) / 2;
494
case HA_READ_KEY_EXACT:
495
case HA_READ_BEFORE_KEY:
496
return (ha_rows) right;
497
case HA_READ_AFTER_KEY:
498
return (ha_rows) left;
504
int tree_walk(TREE *tree, tree_walk_action action, void *argument, TREE_WALK visit)
507
case left_root_right:
508
return tree_walk_left_root_right(tree,tree->root,action,argument);
509
case right_root_left:
510
return tree_walk_right_root_left(tree,tree->root,action,argument);
513
return 0; /* Keep gcc happy */
516
static int tree_walk_left_root_right(TREE *tree, TREE_ELEMENT *element, tree_walk_action action, void *argument)
519
if (element->left) /* Not null_element */
521
if ((error=tree_walk_left_root_right(tree,element->left,action,
523
(error=(*action)(ELEMENT_KEY(tree,element),
526
error=tree_walk_left_root_right(tree,element->right,action,argument);
533
static int tree_walk_right_root_left(TREE *tree, TREE_ELEMENT *element, tree_walk_action action, void *argument)
536
if (element->right) /* Not null_element */
538
if ((error=tree_walk_right_root_left(tree,element->right,action,
540
(error=(*action)(ELEMENT_KEY(tree,element),
543
error=tree_walk_right_root_left(tree,element->left,action,argument);
551
/* Functions to fix up the tree after insert and delete */
553
static void left_rotate(TREE_ELEMENT **parent, TREE_ELEMENT *leaf)
558
leaf->right= y->left;
563
static void right_rotate(TREE_ELEMENT **parent, TREE_ELEMENT *leaf)
568
leaf->left= x->right;
573
static void rb_insert(TREE *tree, TREE_ELEMENT ***parent, TREE_ELEMENT *leaf)
575
TREE_ELEMENT *y,*par,*par2;
578
while (leaf != tree->root && (par=parent[-1][0])->colour == RED)
580
if (par == (par2=parent[-2][0])->left)
583
if (y->colour == RED)
589
leaf->colour= RED; /* And the loop continues */
593
if (leaf == par->right)
595
left_rotate(parent[-1],par);
596
par= leaf; /* leaf is now parent to old leaf */
600
right_rotate(parent[-2],par2);
607
if (y->colour == RED)
613
leaf->colour= RED; /* And the loop continues */
617
if (leaf == par->left)
619
right_rotate(parent[-1],par);
624
left_rotate(parent[-2],par2);
629
tree->root->colour=BLACK;
632
static void rb_delete_fixup(TREE *tree, TREE_ELEMENT ***parent)
634
TREE_ELEMENT *x,*w,*par;
637
while (x != tree->root && x->colour == BLACK)
639
if (x == (par=parent[-1][0])->left)
642
if (w->colour == RED)
646
left_rotate(parent[-1],par);
648
*++parent= &par->left;
651
if (w->left->colour == BLACK && w->right->colour == BLACK)
659
if (w->right->colour == BLACK)
661
w->left->colour= BLACK;
663
right_rotate(&par->right,w);
666
w->colour= par->colour;
668
w->right->colour= BLACK;
669
left_rotate(parent[-1],par);
677
if (w->colour == RED)
681
right_rotate(parent[-1],par);
682
parent[0]= &w->right;
683
*++parent= &par->right;
686
if (w->right->colour == BLACK && w->left->colour == BLACK)
694
if (w->left->colour == BLACK)
696
w->right->colour= BLACK;
698
left_rotate(&par->left,w);
701
w->colour= par->colour;
703
w->left->colour= BLACK;
704
right_rotate(parent[-1],par);