git.mutantstargoat.com Git - dosrtxon/blob - src/rbtree.c

   1 /*
   2 rbtree - simple balanced binary search tree (red-black tree) library.
   3 Copyright (C) 2011-2014  John Tsiombikas <nuclear@member.fsf.org>
   4
   5 rbtree is free software, feel free to use, modify, and redistribute it, under
   6 the terms of the 3-clause BSD license. See COPYING for details.
   7  */
   8 #include <stdio.h>
   9 #include <stdlib.h>
  10 #include <stdint.h>
  11 #include <string.h>
  12 #include "rbtree.h"
  13
  14 #define INT2PTR(x)      ((void*)(intptr_t)(x))
  15 #define PTR2INT(x)      ((int)(intptr_t)(x))
  16
  17 struct rbtree {
  18         struct rbnode *root;
  19
  20         rb_alloc_func_t alloc;
  21         rb_free_func_t free;
  22
  23         rb_cmp_func_t cmp;
  24         rb_del_func_t del;
  25         void *del_cls;
  26
  27         struct rbnode *rstack, *iter;
  28 };
  29
  30 static int cmpaddr(const void *ap, const void *bp);
  31 static int cmpint(const void *ap, const void *bp);
  32
  33 static int count_nodes(struct rbnode *node);
  34 static void del_tree(struct rbnode *node, void (*delfunc)(struct rbnode*, void*), void *cls);
  35 static struct rbnode *insert(struct rbtree *rb, struct rbnode *tree, void *key, void *data);
  36 static struct rbnode *delete(struct rbtree *rb, struct rbnode *tree, void *key);
  37 /*static struct rbnode *find(struct rbtree *rb, struct rbnode *node, void *key);*/
  38 static void traverse(struct rbnode *node, void (*func)(struct rbnode*, void*), void *cls);
  39
  40 struct rbtree *rb_create(rb_cmp_func_t cmp_func)
  41 {
  42         struct rbtree *rb;
  43
  44         if(!(rb = malloc(sizeof *rb))) {
  45                 return 0;
  46         }
  47         if(rb_init(rb, cmp_func) == -1) {
  48                 free(rb);
  49                 return 0;
  50         }
  51         return rb;
  52 }
  53
  54 void rb_free(struct rbtree *rb)
  55 {
  56         rb_destroy(rb);
  57         free(rb);
  58 }
  59
  60
  61 int rb_init(struct rbtree *rb, rb_cmp_func_t cmp_func)
  62 {
  63         memset(rb, 0, sizeof *rb);
  64
  65         if(!cmp_func) {
  66                 rb->cmp = cmpaddr;
  67         } else if(cmp_func == RB_KEY_INT) {
  68                 rb->cmp = cmpint;
  69         } else if(cmp_func == RB_KEY_STRING) {
  70                 rb->cmp = (rb_cmp_func_t)strcmp;
  71         } else {
  72                 rb->cmp = cmp_func;
  73         }
  74
  75         rb->alloc = malloc;
  76         rb->free = free;
  77         return 0;
  78 }
  79
  80 void rb_destroy(struct rbtree *rb)
  81 {
  82         del_tree(rb->root, rb->del, rb->del_cls);
  83 }
  84
  85 void rb_set_allocator(struct rbtree *rb, rb_alloc_func_t alloc, rb_free_func_t free)
  86 {
  87         rb->alloc = alloc;
  88         rb->free = free;
  89 }
  90
  91
  92 void rb_set_compare_func(struct rbtree *rb, rb_cmp_func_t func)
  93 {
  94         rb->cmp = func;
  95 }
  96
  97 void rb_set_delete_func(struct rbtree *rb, rb_del_func_t func, void *cls)
  98 {
  99         rb->del = func;
 100         rb->del_cls = cls;
 101 }
 102
 103
 104 void rb_clear(struct rbtree *rb)
 105 {
 106         del_tree(rb->root, rb->del, rb->del_cls);
 107         rb->root = 0;
 108 }
 109
 110 int rb_copy(struct rbtree *dest, struct rbtree *src)
 111 {
 112         struct rbnode *node;
 113
 114         rb_clear(dest);
 115         rb_begin(src);
 116         while((node = rb_next(src))) {
 117                 if(rb_insert(dest, node->key, node->data) == -1) {
 118                         return -1;
 119                 }
 120         }
 121         return 0;
 122 }
 123
 124 int rb_size(struct rbtree *rb)
 125 {
 126         return count_nodes(rb->root);
 127 }
 128
 129 int rb_insert(struct rbtree *rb, void *key, void *data)
 130 {
 131         rb->root = insert(rb, rb->root, key, data);
 132         rb->root->red = 0;
 133         return 0;
 134 }
 135
 136 int rb_inserti(struct rbtree *rb, int key, void *data)
 137 {
 138         rb->root = insert(rb, rb->root, INT2PTR(key), data);
 139         rb->root->red = 0;
 140         return 0;
 141 }
 142
 143
 144 int rb_delete(struct rbtree *rb, void *key)
 145 {
 146         if((rb->root = delete(rb, rb->root, key))) {
 147                 rb->root->red = 0;
 148         }
 149         return 0;
 150 }
 151
 152 int rb_deletei(struct rbtree *rb, int key)
 153 {
 154         if((rb->root = delete(rb, rb->root, INT2PTR(key)))) {
 155                 rb->root->red = 0;
 156         }
 157         return 0;
 158 }
 159
 160
 161 struct rbnode *rb_find(struct rbtree *rb, void *key)
 162 {
 163         struct rbnode *node = rb->root;
 164
 165         while(node) {
 166                 int cmp = rb->cmp(key, node->key);
 167                 if(cmp == 0) {
 168                         return node;
 169                 }
 170                 node = cmp < 0 ? node->left : node->right;
 171         }
 172         return 0;
 173 }
 174
 175 struct rbnode *rb_findi(struct rbtree *rb, int key)
 176 {
 177         return rb_find(rb, INT2PTR(key));
 178 }
 179
 180
 181 void rb_foreach(struct rbtree *rb, void (*func)(struct rbnode*, void*), void *cls)
 182 {
 183         traverse(rb->root, func, cls);
 184 }
 185
 186
 187 struct rbnode *rb_root(struct rbtree *rb)
 188 {
 189         return rb->root;
 190 }
 191
 192 void rb_begin(struct rbtree *rb)
 193 {
 194         rb->rstack = 0;
 195         rb->iter = rb->root;
 196 }
 197
 198 #define push(sp, x)             ((x)->next = (sp), (sp) = (x))
 199 #define pop(sp)                 ((sp) = (sp)->next)
 200 #define top(sp)                 (sp)
 201
 202 struct rbnode *rb_next(struct rbtree *rb)
 203 {
 204         struct rbnode *res = 0;
 205
 206         while(rb->rstack || rb->iter) {
 207                 if(rb->iter) {
 208                         push(rb->rstack, rb->iter);
 209                         rb->iter = rb->iter->left;
 210                 } else {
 211                         rb->iter = top(rb->rstack);
 212                         pop(rb->rstack);
 213                         res = rb->iter;
 214                         rb->iter = rb->iter->right;
 215                         break;
 216                 }
 217         }
 218         return res;
 219 }
 220
 221 void *rb_node_key(struct rbnode *node)
 222 {
 223         return node ? node->key : 0;
 224 }
 225
 226 int rb_node_keyi(struct rbnode *node)
 227 {
 228         return node ? PTR2INT(node->key) : 0;
 229 }
 230
 231 void *rb_node_data(struct rbnode *node)
 232 {
 233         return node ? node->data : 0;
 234 }
 235
 236 static int cmpaddr(const void *ap, const void *bp)
 237 {
 238         return ap < bp ? -1 : (ap > bp ? 1 : 0);
 239 }
 240
 241 static int cmpint(const void *ap, const void *bp)
 242 {
 243         return PTR2INT(ap) - PTR2INT(bp);
 244 }
 245
 246
 247 /* ---- left-leaning 2-3 red-black implementation ---- */
 248
 249 /* helper prototypes */
 250 static int is_red(struct rbnode *tree);
 251 static void color_flip(struct rbnode *tree);
 252 static struct rbnode *rot_left(struct rbnode *a);
 253 static struct rbnode *rot_right(struct rbnode *a);
 254 static struct rbnode *find_min(struct rbnode *tree);
 255 static struct rbnode *del_min(struct rbtree *rb, struct rbnode *tree);
 256 /*static struct rbnode *move_red_right(struct rbnode *tree);*/
 257 static struct rbnode *move_red_left(struct rbnode *tree);
 258 static struct rbnode *fix_up(struct rbnode *tree);
 259
 260 static int count_nodes(struct rbnode *node)
 261 {
 262         if(!node)
 263                 return 0;
 264
 265         return 1 + count_nodes(node->left) + count_nodes(node->right);
 266 }
 267
 268 static void del_tree(struct rbnode *node, rb_del_func_t delfunc, void *cls)
 269 {
 270         if(!node)
 271                 return;
 272
 273         del_tree(node->left, delfunc, cls);
 274         del_tree(node->right, delfunc, cls);
 275
 276         if(delfunc) {
 277                 delfunc(node, cls);
 278         }
 279         free(node);
 280 }
 281
 282 static struct rbnode *insert(struct rbtree *rb, struct rbnode *tree, void *key, void *data)
 283 {
 284         int cmp;
 285
 286         if(!tree) {
 287                 struct rbnode *node = rb->alloc(sizeof *node);
 288                 node->red = 1;
 289                 node->key = key;
 290                 node->data = data;
 291                 node->left = node->right = 0;
 292                 return node;
 293         }
 294
 295         cmp = rb->cmp(key, tree->key);
 296
 297         if(cmp < 0) {
 298                 tree->left = insert(rb, tree->left, key, data);
 299         } else if(cmp > 0) {
 300                 tree->right = insert(rb, tree->right, key, data);
 301         } else {
 302                 tree->data = data;
 303         }
 304
 305         /* fix right-leaning reds */
 306         if(is_red(tree->right)) {
 307                 tree = rot_left(tree);
 308         }
 309         /* fix two reds in a row */
 310         if(is_red(tree->left) && is_red(tree->left->left)) {
 311                 tree = rot_right(tree);
 312         }
 313
 314         /* if 4-node, split it by color inversion */
 315         if(is_red(tree->left) && is_red(tree->right)) {
 316                 color_flip(tree);
 317         }
 318
 319         return tree;
 320 }
 321
 322 static struct rbnode *delete(struct rbtree *rb, struct rbnode *tree, void *key)
 323 {
 324         int cmp;
 325
 326         if(!tree) {
 327                 return 0;
 328         }
 329
 330         cmp = rb->cmp(key, tree->key);
 331
 332         if(cmp < 0) {
 333                 if(!is_red(tree->left) && !is_red(tree->left->left)) {
 334                         tree = move_red_left(tree);
 335                 }
 336                 tree->left = delete(rb, tree->left, key);
 337         } else {
 338                 /* need reds on the right */
 339                 if(is_red(tree->left)) {
 340                         tree = rot_right(tree);
 341                 }
 342
 343                 /* found it at the bottom (XXX what certifies left is null?) */
 344                 if(cmp == 0 && !tree->right) {
 345                         if(rb->del) {
 346                                 rb->del(tree, rb->del_cls);
 347                         }
 348                         rb->free(tree);
 349                         return 0;
 350                 }
 351
 352                 if(!is_red(tree->right) && !is_red(tree->right->left)) {
 353                         tree = move_red_left(tree);
 354                 }
 355
 356                 if(key == tree->key) {
 357                         struct rbnode *rmin = find_min(tree->right);
 358                         tree->key = rmin->key;
 359                         tree->data = rmin->data;
 360                         tree->right = del_min(rb, tree->right);
 361                 } else {
 362                         tree->right = delete(rb, tree->right, key);
 363                 }
 364         }
 365
 366         return fix_up(tree);
 367 }
 368
 369 /*static struct rbnode *find(struct rbtree *rb, struct rbnode *node, void *key)
 370 {
 371         int cmp;
 372
 373         if(!node)
 374                 return 0;
 375
 376         if((cmp = rb->cmp(key, node->key)) == 0) {
 377                 return node;
 378         }
 379         return find(rb, cmp < 0 ? node->left : node->right, key);
 380 }*/
 381
 382 static void traverse(struct rbnode *node, void (*func)(struct rbnode*, void*), void *cls)
 383 {
 384         if(!node)
 385                 return;
 386
 387         traverse(node->left, func, cls);
 388         func(node, cls);
 389         traverse(node->right, func, cls);
 390 }
 391
 392 /* helpers */
 393
 394 static int is_red(struct rbnode *tree)
 395 {
 396         return tree && tree->red;
 397 }
 398
 399 static void color_flip(struct rbnode *tree)
 400 {
 401         tree->red = !tree->red;
 402         tree->left->red = !tree->left->red;
 403         tree->right->red = !tree->right->red;
 404 }
 405
 406 static struct rbnode *rot_left(struct rbnode *a)
 407 {
 408         struct rbnode *b = a->right;
 409         a->right = b->left;
 410         b->left = a;
 411         b->red = a->red;
 412         a->red = 1;
 413         return b;
 414 }
 415
 416 static struct rbnode *rot_right(struct rbnode *a)
 417 {
 418         struct rbnode *b = a->left;
 419         a->left = b->right;
 420         b->right = a;
 421         b->red = a->red;
 422         a->red = 1;
 423         return b;
 424 }
 425
 426 static struct rbnode *find_min(struct rbnode *tree)
 427 {
 428         if(!tree)
 429                 return 0;
 430
 431         while(tree->left) {
 432                 tree = tree->left;
 433         }
 434         return tree;
 435 }
 436
 437 static struct rbnode *del_min(struct rbtree *rb, struct rbnode *tree)
 438 {
 439         if(!tree->left) {
 440                 if(rb->del) {
 441                         rb->del(tree->left, rb->del_cls);
 442                 }
 443                 rb->free(tree->left);
 444                 return 0;
 445         }
 446
 447         /* make sure we've got red (3/4-nodes) at the left side so we can delete at the bottom */
 448         if(!is_red(tree->left) && !is_red(tree->left->left)) {
 449                 tree = move_red_left(tree);
 450         }
 451         tree->left = del_min(rb, tree->left);
 452
 453         /* fix right-reds, red-reds, and split 4-nodes on the way up */
 454         return fix_up(tree);
 455 }
 456
 457 #if 0
 458 /* push a red link on this node to the right */
 459 static struct rbnode *move_red_right(struct rbnode *tree)
 460 {
 461         /* flipping it makes both children go red, so we have a red to the right */
 462         color_flip(tree);
 463
 464         /* if after the flip we've got a red-red situation to the left, fix it */
 465         if(is_red(tree->left->left)) {
 466                 tree = rot_right(tree);
 467                 color_flip(tree);
 468         }
 469         return tree;
 470 }
 471 #endif
 472
 473 /* push a red link on this node to the left */
 474 static struct rbnode *move_red_left(struct rbnode *tree)
 475 {
 476         /* flipping it makes both children go red, so we have a red to the left */
 477         color_flip(tree);
 478
 479         /* if after the flip we've got a red-red on the right-left, fix it */
 480         if(is_red(tree->right->left)) {
 481                 tree->right = rot_right(tree->right);
 482                 tree = rot_left(tree);
 483                 color_flip(tree);
 484         }
 485         return tree;
 486 }
 487
 488 static struct rbnode *fix_up(struct rbnode *tree)
 489 {
 490         /* fix right-leaning */
 491         if(is_red(tree->right)) {
 492                 tree = rot_left(tree);
 493         }
 494         /* change invalid red-red pairs into a proper 4-node */
 495         if(is_red(tree->left) && is_red(tree->left->left)) {
 496                 tree = rot_right(tree);
 497         }
 498         /* split 4-nodes */
 499         if(is_red(tree->left) && is_red(tree->right)) {
 500                 color_flip(tree);
 501         }
 502         return tree;
 503 }