obiavl.c 42.9 KB
Newer Older
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
/****************************************************************************
 * OBIDMS AVL tree functions	                                            *
 ****************************************************************************/

/**
 * @file obiavl.c
 * @author Celine Mercier
 * @date December 3rd 2015
 * @brief Functions handling AVL trees for storing and retrieving bit arrays.
 */


#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <time.h>
#include <sys/mman.h>
#include <fcntl.h>
#include <math.h>

#include "obiavl.h"
#include "obierrno.h"
#include "obitypes.h"
#include "obidebug.h"
#include "private_at_functions.h"
#include "encode.h"


#define DEBUG_LEVEL 0	// TODO has to be defined somewhere else (cython compil flag?)


/**************************************************************************
 *
 * D E C L A R A T I O N   O F   T H E   P R I V A T E   F U N C T I O N S
 *
 **************************************************************************/

/**
 * @brief Internal function building the file name for an AVL tree file.
 *
 * @warning The returned pointer has to be freed by the caller.
 *
 * @param avl_name The name of the AVL tree.
 *
 * @returns A pointer to the name of the file where the AVL tree is stored.
 * @retval NULL if an error occurred.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
static char* build_avl_file_name(const char* avl_name);


/**
 * @brief Internal function building the file name for an AVL tree file.
 *
 * @warning The returned pointer has to be freed by the caller.
 *
 * @param avl_name The name of the AVL tree.
 *
 * @returns A pointer to the name of the file where the data referred to by the AVL tree is stored.
 * @retval NULL if an error occurred.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
static char* build_avl_data_file_name(const char* avl_name);


/**
 * @brief Internal function returning the size of an AVL tree header on this platform.
 *
 * @returns The size of an AVL tree header in bytes.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
size_t get_avl_header_size();


/**
 * @brief Internal function returning the initial size of an AVL tree on this platform.
 *
 * @returns The initial size of an AVL tree in bytes.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
size_t get_initial_avl_size();


/**
 * @brief Internal function returning the size, on this platform, of the header of the data
 *        referred to by an AVL tree.
 *
 * @returns The size of an AVL data header in bytes.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
size_t get_avl_data_header_size();


/**
 * @brief Internal function returning the initial size, on this platform, of the data
 *        referred to by an AVL tree.
 *
 * @returns The initial size of an AVL data array in bytes.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
size_t get_initial_avl_data_size();


/**
 * @brief Internal function closing an AVL data structure where the data referred to by an AVL tree is stored.
 *
 * @param avl_data A pointer to the data structure referred to by an AVL tree.
 *
 * @retval 0 if the operation was successfully completed.
 * @retval -1 if an error occurred.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
int close_avl_data(OBIDMS_avl_data_p avl_data);


/**
 * @brief Internal function enlarging an AVL tree.
 *
 * @param avl A pointer to the AVL tree structure.
 *
 * @retval 0 if the operation was successfully completed.
 * @retval -1 if an error occurred.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
int grow_avl(OBIDMS_avl_p avl);


/**
 * @brief Internal function enlarging the data array referred to by an AVL tree.
 *
 * @param avl A pointer to the AVL tree structure.
 *
 * @retval 0 if the operation was successfully completed.
 * @retval -1 if an error occurred.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
int grow_avl_data(OBIDMS_avl_p avl);


/**
 * @brief Internal function storing a value (byte array) in the data array referred to by an AVL tree.
 *
 * @param avl A pointer to the AVL tree structure.
 * @param value A pointer to the value (byte array).
 *
 * @returns The index of the stored value.
 * @retval -1 if an error occurred.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
index_t avl_add_value_in_data_array(OBIDMS_avl_p avl, byte_t* value);


/**
 * @brief Internal function comparing two byte arrays.
 *
 * The encoding is compared first, then the length of the
 * values, then the values themselves.
 *
 * @param value_1 A pointer to the first byte array.
 * @param value_2 A pointer to the second byte array.
 *
 * @returns A value < 0 if value_1 < value_2,
 * 			a value > 0 if value_1 > value_2,
 * 			and 0 if value_1 == value_2.
 *
 * @since October 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
int byte_array_compare(byte_t* value_1, byte_t* value_2);


/**
 * @brief Internal function calculating the size in bytes of a byte array.
 *
 * @param value A pointer to the byte array.
 *
 * @returns The size of the byte array in bytes.
 *
 * @since October 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
size_t byte_array_sizeof(byte_t* value);


/**
 * @brief Internal function initializing a node in an AVL tree.
 *
 * @param avl A pointer to the AVL tree structure.
 * @param node_idx The index of the node to initialize in the mmapped AVL tree.
 *
 * @returns The node structure initialized.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
AVL_node_p avl_create_node(OBIDMS_avl_p avl, index_t node_idx);


/**
 * @brief Internal function updating the balance factors in an AVL tree
 *        after adding a node, only in the subtree that will have to be balanced.
 *        That subtree is found using the avl->path_idx array and the directions taken
224
 *        down the tree to add the new node are stored in the avl->path_dir array.
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
 *
 * @param avl A pointer to the AVL tree structure.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
void avl_update_balance_factors(OBIDMS_avl_p avl);


/**
 * @brief Internal function rotating a node with a "left left rotation".
 *
 * @param avl A pointer to the AVL tree structure.
 * @param node A pointer to the node that has to be rotated.
 * @param node_idx The index of the node that has to be rotated.
 *
 * @returns The new root of the subtree.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
index_t avl_rotate_leftleft(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx);

/**
 * @brief Internal function rotating a node with a "left right rotation".
 *
 * @param avl A pointer to the AVL tree structure.
 * @param node A pointer to the node that has to be rotated.
 * @param node_idx The index of the node that has to be rotated.
 *
 * @returns The new root of the subtree.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
index_t avl_rotate_leftright(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx);


/**
 * @brief Internal function rotating a node with a "right left rotation".
 *
 * @param avl A pointer to the AVL tree structure.
 * @param node A pointer to the node that has to be rotated.
 * @param node_idx The index of the node that has to be rotated.
 *
 * @returns The new root of the subtree.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
index_t avl_rotate_rightleft(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx);


/**
 * @brief Internal function rotating a node with a "right right rotation".
 *
 * @param avl A pointer to the AVL tree structure.
 * @param node A pointer to the node that has to be rotated.
 * @param node_idx The index of the node that has to be rotated.
 *
 * @returns The new root of the subtree.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
index_t avl_rotate_rightright(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx);


/**
 * @brief Internal function balancing one node.
 *
 * @param avl A pointer to the AVL tree structure.
 * @param node A pointer to the node that has to be balanced.
 * @param node_idx The index of the node that has to be balanced.
 *
 * @returns The new root of the subtree.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
index_t avl_balance_node(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx);


/**
 * @brief Internal function balancing the nodes of an AVL tree after adding a node,
 *        only in the subtree that eventually has to be balanced.
 *        That subtree is found using the avl->path_idx array.
 *
 * @param avl A pointer to the AVL tree structure.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
void avl_balance(OBIDMS_avl_p avl);


/**
 * @brief Internal function printing a depth first traverse of a node.
 *
 * @param avl A pointer to the AVL tree structure.
 * @param node A pointer to the node.
 * @param node_idx The index of the node.
 * @param depth The depth of the node.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
void avl_print_node(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx, int depth);


/**
 * @brief Internal function printing a depth first traverse of an AVL tree.
 *
 * @param avl A pointer to the AVL tree structure.
 *
 * @since December 2015
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
void avl_print(OBIDMS_avl_p avl);


/************************************************************************
 *
 * D E F I N I T I O N   O F   T H E   P R I V A T E   F U N C T I O N S
 *
 ************************************************************************/

static char* build_avl_file_name(const char* avl_name)
{
	char* file_name;

	// Build the file name
Celine Mercier committed
357 358
	file_name = (char*) malloc((strlen(avl_name) + 5)*sizeof(char));
	if (sprintf(file_name,"%s.oda", avl_name) < 0)
359 360
	{
		obi_set_errno(OBI_AVL_ERROR);
361
		obidebug(1, "\nError building an AVL tree file name");
362 363 364 365 366 367 368
		return NULL;
	}

	// Test if the avl name is not too long
	if (strlen(file_name) >= AVL_MAX_NAME)
	{
		obi_set_errno(OBI_AVL_ERROR);
369
		obidebug(1, "\nError due to AVL tree name too long");
370 371 372 373 374 375 376 377 378 379 380 381 382
		free(file_name);
		return NULL;
	}

	return file_name;
}


static char* build_avl_data_file_name(const char* avl_name)
{
	char* file_name;

	// Build the file name
Celine Mercier committed
383 384
	file_name = (char*) malloc((strlen(avl_name) + 5)*sizeof(char));
	if (sprintf(file_name,"%s.odd", avl_name) < 0)
385 386
	{
		obi_set_errno(OBI_AVL_ERROR);
387
		obidebug(1, "\nError building an AVL tree data file name");
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
		return NULL;
	}

	return file_name;
}


size_t get_avl_header_size()
{
	size_t header_size;
	size_t rounded_header_size;
	double multiple;

	header_size = sizeof(OBIDMS_avl_header_t);

	multiple = 	ceil((double) header_size / (double) getpagesize());

	rounded_header_size = multiple * getpagesize();

	return rounded_header_size;
}


size_t get_initial_avl_size()
{
413 414 415 416 417 418 419
	size_t s;
	size_t m;

	m = 1;
	s = getpagesize() * m;

	return s;
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
}


size_t get_avl_data_header_size()
{
	size_t header_size;
	size_t rounded_header_size;
	double multiple;

	header_size = sizeof(OBIDMS_avl_data_header_t);

	multiple = 	ceil((double) header_size / (double) getpagesize());

	rounded_header_size = multiple * getpagesize();

	return rounded_header_size;
}


size_t get_initial_avl_data_size()
{
441 442 443 444 445 446 447
	size_t s;
	size_t m;

	m = 1;
	s = getpagesize() * m;

	return s;
448 449 450 451 452 453 454 455 456 457
}


int close_avl_data(OBIDMS_avl_data_p avl_data)
{
	int ret_val = 0;

	if (munmap(avl_data->data, (avl_data->header)->data_size_max) < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
458
		obidebug(1, "\nError munmapping the data of an AVL tree data file");
459 460 461 462 463 464
		ret_val = -1;
	}

	if (munmap(avl_data->header, (avl_data->header)->header_size) < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
465
		obidebug(1, "\nError munmapping the header of an AVL tree data file");
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
		ret_val = -1;
	}

	free(avl_data);

	return ret_val;
}


int grow_avl(OBIDMS_avl_p avl)		// TODO Lock when needed
{
	size_t	file_size;
	size_t 	old_data_size;
	size_t 	new_data_size;
	size_t 	header_size;
	int 	avl_file_descriptor;
	char* 	avl_file_name;

	// Get the avl file name
	avl_file_name = build_avl_file_name((avl->header)->avl_name);
	if (avl_file_name == NULL)
		return -1;

	// Open the avl file
	avl_file_descriptor = openat(avl->dir_fd, avl_file_name, O_RDWR);
	if (avl_file_descriptor < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
494
		obidebug(1, "\nError opening an AVL tree file");
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
		free(avl_file_name);
		return -1;
	}
	free(avl_file_name);

	// Calculate the new file size
	old_data_size = (avl->header)->avl_size;
	new_data_size = old_data_size * AVL_GROWTH_FACTOR;
	header_size = (avl->header)->header_size;
	file_size = header_size + new_data_size;

	// Enlarge the file
	if (ftruncate(avl_file_descriptor, file_size) < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
510
		obidebug(1, "\nError enlarging an AVL tree file");
511 512 513 514 515 516 517 518 519
		close(avl_file_descriptor);
		return -1;
	}

	// Unmap and re-map the data

	if (munmap(avl->tree, old_data_size) < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
520
		obidebug(1, "\nError munmapping the tree of an AVL tree file before enlarging");
521 522 523 524 525
		close(avl_file_descriptor);
		return -1;
	}

	avl->tree = mmap(NULL,
526 527 528 529 530 531
					 new_data_size,
					 PROT_READ | PROT_WRITE,
					 MAP_SHARED,
					 avl_file_descriptor,
					 header_size
					);
532 533 534 535

	if (avl->tree == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
536
		obidebug(1, "\nError re-mmapping the tree of an AVL tree file after enlarging the file");
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
		close(avl_file_descriptor);
		return -1;
	}

	// Set new maximum number of items
	(avl->header)->nb_items_max = floor(((double) new_data_size) / ((double) sizeof(AVL_node_t)));

	// Set the new avl size
	(avl->header)->avl_size = new_data_size;

	close(avl_file_descriptor);

	return 0;
}


int grow_avl_data(OBIDMS_avl_p avl)		// TODO Lock when needed
{
	size_t 	file_size;
	index_t old_data_size;
	index_t new_data_size;
	size_t 	header_size;
	int 	avl_data_file_descriptor;
	char* 	avl_data_file_name;

	// Get the avl data file name
	avl_data_file_name = build_avl_data_file_name((avl->header)->avl_name);
	if (avl_data_file_name == NULL)
		return -1;

	// Open the avl data file
	avl_data_file_descriptor = openat(avl->dir_fd, avl_data_file_name, O_RDWR);
	if (avl_data_file_descriptor < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
572
		obidebug(1, "\nError opening an AVL tree data file");
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
		free(avl_data_file_name);
		return -1;
	}
	free(avl_data_file_name);

	// Calculate the new file size
	old_data_size = ((avl->data)->header)->data_size_max;
	new_data_size = old_data_size * AVL_GROWTH_FACTOR;
	header_size = ((avl->data)->header)->header_size;
	file_size = header_size + new_data_size;

	// Enlarge the file
	if (ftruncate(avl_data_file_descriptor, file_size) < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
588
		obidebug(1, "\nError enlarging an AVL tree data file");
589 590 591 592 593 594 595 596 597
		close(avl_data_file_descriptor);
		return -1;
	}

	// Unmap and re-map the data

	if (munmap((avl->data)->data, old_data_size) < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
598
		obidebug(1, "\nError munmapping the data of an AVL tree data file before enlarging");
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
		close(avl_data_file_descriptor);
		return -1;
	}

	(avl->data)->data = mmap(NULL,
							   new_data_size,
							   PROT_READ | PROT_WRITE,
							   MAP_SHARED,
							   avl_data_file_descriptor,
							   header_size
							  );

	if ((avl->data)->data == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
614
		obidebug(1, "\nError re-mmapping the data of an AVL tree data file after enlarging the file");
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 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
		close(avl_data_file_descriptor);
		return -1;
	}

	// Set new data size
	((avl->data)->header)->data_size_max = new_data_size;

	// Initialize new data to 0
	memset(((avl->data)->data)+old_data_size, 0, new_data_size - old_data_size);

	close(avl_data_file_descriptor);

	return 0;
}


index_t avl_add_value_in_data_array(OBIDMS_avl_p avl, byte_t* value)
{
	index_t value_idx;
	size_t value_size;

	value_idx = ((avl->data)->header)->data_size_used;

	// Grow the data if needed
	value_size = byte_array_sizeof(value);
	while (((avl->data)->header)->data_size_max < (value_idx + (int64_t) value_size))
	{
		if (grow_avl_data(avl) < 0)
			return -1;
	}

	// Store the value itself at the end of the data
	memcpy((((avl->data)->data)+value_idx), value, value_size);

	// Update the data size
	((avl->data)->header)->data_size_used = value_idx + value_size;

	// Update the number of items
	(((avl->data)->header)->nb_items)++;

	return value_idx;
}


int byte_array_compare(byte_t* value_1, byte_t* value_2)
{
	int 	comp;
	uint8_t size_1;
	uint8_t size_2;
	int32_t len_1;
	int32_t len_2;
	int32_t ini_len_1;
	int32_t ini_len_2;
	int32_t b;

	size_1 = (uint8_t) *(value_1);
	size_2 = (uint8_t) *(value_2);

	if (size_1 != size_2)
		return (size_1 - size_2);

	len_1 = *((int32_t*)(value_1+1));
	len_2 = *((int32_t*)(value_2+1));

	if (len_1 != len_2)
		return (len_1 - len_2);

	if (size_1 != 8)
	{
		ini_len_1 = *((int32_t*)(value_1+5));
		ini_len_2 = *((int32_t*)(value_2+5));

		if (ini_len_1 != ini_len_2)
			return (ini_len_1 - ini_len_2);
	}

	b = BYTE_ARRAY_HEADER_SIZE;
	comp = 0;
	while (!comp && (b < len_1+BYTE_ARRAY_HEADER_SIZE))
	{
		comp = *(value_1+b) - *(value_2+b);
		b++;
	}
	return comp;
}


size_t byte_array_sizeof(byte_t* value)
{
	return (BYTE_ARRAY_HEADER_SIZE + *((int32_t*)(value+1)));
}


// Initialize a new node
AVL_node_p avl_create_node(OBIDMS_avl_p avl, index_t node_idx)
{
	AVL_node_p node;

	node = (avl->tree)+node_idx;

	node->left_child = -1;
	node->right_child = -1;
	node->balance_factor = 0;
	node->value = -1;

	return node;
}


// Update the balance factors of the nodes from the node that will need balancing
void avl_update_balance_factors(OBIDMS_avl_p avl)
{
	uint8_t n;
	AVL_node_p node;

	// Update balance factors from the node where balancing might be needed
	node=(avl->tree)+((avl->path_idx)[1]);

	for (n=1; (avl->path_dir)[n] != -1; n++)
	{
		if ((avl->path_dir)[n]) // Went right
		{
			(node->balance_factor)--;
			node=RIGHT_CHILD(node);
		}
		else 	// Went left
		{
			(node->balance_factor)++;
			node=LEFT_CHILD(node);
		}
	}
}


// Left Left Rotate
index_t avl_rotate_leftleft(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx)
{
	AVL_node_p left_child = LEFT_CHILD(node);
	index_t left_child_idx = node->left_child;

	node->left_child = left_child->right_child;
	left_child->right_child = node_idx;

	node->balance_factor = 0;
	left_child->balance_factor = 0;

	return left_child_idx;
}


// Left Right Rotate
index_t avl_rotate_leftright(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx)
{
	AVL_node_p left_child = LEFT_CHILD(node);
	index_t left_child_idx = node->left_child;
	AVL_node_p rc_of_lc = RIGHT_CHILD(left_child);
	index_t rc_of_lc_idx = left_child->right_child;

	node->left_child = rc_of_lc->right_child;
	left_child->right_child = rc_of_lc->left_child;
	rc_of_lc->left_child = left_child_idx;
	rc_of_lc->right_child = node_idx;

	if (rc_of_lc->balance_factor == -1)
	{
		left_child->balance_factor = 1;
		node->balance_factor = 0;
	}
	else if (rc_of_lc->balance_factor == 0)
	{
		left_child->balance_factor = 0;
		node->balance_factor = 0;
	}
	else	// if (rc_of_lc->balance_factor == 1)
	{
		left_child->balance_factor = 0;
		node->balance_factor = -1;
	}

	rc_of_lc->balance_factor = 0;

	return rc_of_lc_idx;
}


// Right Left Rotate
index_t avl_rotate_rightleft(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx)
{
	AVL_node_p right_child = RIGHT_CHILD(node);
	index_t right_child_idx = node->right_child;;
	AVL_node_p lc_of_rc = LEFT_CHILD(right_child);
	index_t lc_of_rc_idx = right_child->left_child;

	node->right_child = lc_of_rc->left_child;
	right_child->left_child = lc_of_rc->right_child;
	lc_of_rc->right_child = right_child_idx;
	lc_of_rc->left_child = node_idx;

	if (lc_of_rc->balance_factor == 1)
	{
		right_child->balance_factor = 1;
		node->balance_factor = 0;
	}
	else if (lc_of_rc->balance_factor == 0)
	{
		right_child->balance_factor = 0;
		node->balance_factor = 0;
	}
	else	// if (lc_of_rc->balance_factor == -1)
	{
		right_child->balance_factor = 0;
		node->balance_factor = 1;
	}

	lc_of_rc->balance_factor = 0;

	return lc_of_rc_idx;
}


// Right Right Rotate
index_t avl_rotate_rightright(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx)
{
	AVL_node_p right_child = RIGHT_CHILD(node);
	index_t right_child_idx = node->right_child;

	node->right_child = right_child->left_child;
	right_child->left_child = node_idx;

	node->balance_factor = 0;
	right_child->balance_factor = 0;

	return right_child_idx;
}


// Balance a given node
index_t avl_balance_node(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx)
{
	index_t new_root = 0;

	if (node->balance_factor == 2)
	{ // Left Heavy
		if ((LEFT_CHILD(node))->balance_factor == -1)
			new_root = avl_rotate_leftright(avl, node, node_idx);
		else
			new_root = avl_rotate_leftleft(avl, node, node_idx);
	}
	else if (node->balance_factor == -2)
	{ // Right Heavy
		if ((RIGHT_CHILD(node))->balance_factor == 1)
			new_root = avl_rotate_rightleft(avl, node, node_idx);
		else
			new_root = avl_rotate_rightright(avl, node, node_idx);
	}
	else
	// Node is balanced
		new_root = node_idx;

	return new_root;
}


// Balance a given tree
void avl_balance(OBIDMS_avl_p avl)
{
	index_t new_root;
	index_t node_index;
	AVL_node_p node_to_balance;
	AVL_node_p parent_of_node_to_balance;

	node_index = (avl->path_idx)[1];
	node_to_balance = (avl->tree)+node_index;
	parent_of_node_to_balance = (avl->tree)+((avl->path_idx)[0]);

	// Balance the 2nd node stored in the path (the first is only kept to connect the new root
	// of the subtree if needed).
	new_root = avl_balance_node(avl, node_to_balance, node_index);

	if (new_root != node_index)
	// If the root of the subtree has changed
	{
		// If the subtree's root is the tree's root, store the new root
		if (node_index == (avl->header)->root_idx)
			(avl->header)->root_idx = new_root;
		// Else, connect the new subtree's root to the parent of the subtree
		else if ((avl->path_dir)[0])	   // Subtree is the right child of its parent
			parent_of_node_to_balance->right_child = new_root;
		else	   // Subtree is the left child of its parent
			parent_of_node_to_balance->left_child = new_root;
	}
}


// Print a depth first traverse of a node
void avl_print_node(OBIDMS_avl_p avl, AVL_node_p node, index_t node_idx, int depth)
{
	int i = 0;

	if (node->left_child != -1)
		avl_print_node(avl, LEFT_CHILD(node), node->left_child, depth+2);

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

	fprintf(stderr, "Node idx: %lld, Value idx: %lld, Left child: %lld, Right child: %lld, "
			"Balance factor: %d\n", node_idx, node->value, node->left_child, node->right_child, node->balance_factor);

	if (node->right_child != -1)
		avl_print_node(avl, RIGHT_CHILD(node), node->right_child, depth+2);
}


// Print a depth first traverse of a tree
void avl_print(OBIDMS_avl_p avl)
{
	fprintf(stderr, "\nRoot index: %lld\n", (avl->header)->root_idx);
	avl_print_node(avl, (avl->tree)+((avl->header)->root_idx), (avl->header)->root_idx, 0);
}


/**********************************************************************
 *
 * D E F I N I T I O N   O F   T H E   P U B L I C   F U N C T I O N S
 *
 **********************************************************************/

int obi_avl_exists(OBIDMS_p dms, const char* avl_name)
{
944 945 946
	struct stat buffer;
	char* 	    avl_file_path;
	char* 	    avl_file_name;
Celine Mercier committed
947 948
	char*		avl_file_relative_path;
	int			relative_path_size;
949
	int 	    check_dir;
950

Celine Mercier committed
951
	// Build the AVL tree file path
952 953 954
	avl_file_name = build_avl_file_name(avl_name);
	if (avl_file_name == NULL)
		return -1;
Celine Mercier committed
955 956 957 958 959 960
	relative_path_size = strlen(avl_file_name) + strlen(AVL_TREES_DIR_NAME) + 2;
	avl_file_relative_path = (char*) malloc(relative_path_size*sizeof(char));
	strcpy(avl_file_relative_path, AVL_TREES_DIR_NAME);
	strcat(avl_file_relative_path, "/");
	strcat(avl_file_relative_path, avl_file_name);
	avl_file_path = get_full_path(dms, avl_file_relative_path);
961 962
	if (avl_file_path == NULL)
	{
963
		obidebug(1, "\nError getting the file path for an AVL tree file");
964 965 966 967 968 969 970
		return -1;
	}

	check_dir = stat(avl_file_path, &buffer);

	free(avl_file_path);
	free(avl_file_name);
Celine Mercier committed
971
	free(avl_file_relative_path);
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993

	if (check_dir == 0)
		return 1;
	else
		return 0;
}


OBIDMS_avl_p obi_avl(OBIDMS_p dms, const char* avl_name)
{
	int exists;

	exists = obi_avl_exists(dms, avl_name);

	switch (exists)
	{
		case 0:
			return obi_create_avl(dms, avl_name);
		case 1:
			return obi_open_avl(dms, avl_name);
	};

994
	obidebug(1, "\nError checking if an AVL tree already exists");
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
	return NULL;
}


OBIDMS_avl_p obi_create_avl(OBIDMS_p dms, const char* avl_name)
{
	char* 				avl_file_name;
	char* 				avl_data_file_name;
	size_t				header_size;
	size_t				data_size;
	size_t				file_size;
	int					avl_file_descriptor;
	int					avl_data_file_descriptor;
	int					avl_dir_file_descriptor;
	OBIDMS_avl_data_p   avl_data;
	OBIDMS_avl_p		avl;

	// Create the data file

		// Build file name
	avl_data_file_name = build_avl_data_file_name(avl_name);
	if (avl_data_file_name == NULL)
		return NULL;

		// Get the file descriptor of the avl directory
	avl_dir_file_descriptor = dms->avl_dir_fd;

		// Create file
	avl_data_file_descriptor = openat(avl_dir_file_descriptor, avl_data_file_name, O_RDWR | O_CREAT | O_EXCL, 0777);
	if (avl_data_file_descriptor < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
1027
		obidebug(1, "\nError creating an AVL tree data file");
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
		free(avl_data_file_name);
		return NULL;
	}
	free(avl_data_file_name);

		// Calculate the size needed
	header_size = get_avl_data_header_size();
	data_size   = get_initial_avl_data_size();
	file_size   = header_size + data_size;

1038
		// Truncate the AVL tree data file to the right size
1039 1040 1041
	if (ftruncate(avl_data_file_descriptor, file_size) < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
1042
		obidebug(1, "\nError truncating an AVL tree data file to the right size");
1043 1044 1045 1046
		close(avl_data_file_descriptor);
		return NULL;
	}

1047
		// Allocate the memory for the AVL tree data structure
1048 1049 1050 1051
	avl_data = (OBIDMS_avl_data_p) malloc(sizeof(OBIDMS_avl_data_t));
	if (avl_data == NULL)
	{
		obi_set_errno(OBI_AVL_ERROR);
1052
		obidebug(1, "\nError allocating the memory for the AVL tree data structure");
1053 1054 1055 1056
		close(avl_data_file_descriptor);
		return NULL;
	}

1057
		// Fill the AVL tree data structure
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	avl_data->header = mmap(NULL,
			                header_size,
			                PROT_READ | PROT_WRITE,
			                MAP_SHARED,
			                avl_data_file_descriptor,
			                0
			               );
	if (avl_data->header == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
1068
		obidebug(1, "\nError mmapping the header of an AVL tree data file");
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
		close(avl_data_file_descriptor);
		free(avl_data);
		return NULL;
	}

	avl_data->data   = mmap(NULL,
			                data_size,
			                PROT_READ | PROT_WRITE,
			                MAP_SHARED,
			                avl_data_file_descriptor,
			                header_size
			               );
	if (avl_data->data == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
1084
		obidebug(1, "\nError mmapping the data of an AVL tree data file");
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
		munmap(avl_data->header, header_size);
		close(avl_data_file_descriptor);
		free(avl_data);
		return NULL;
	}

	(avl_data->header)->header_size 	 = header_size;
	(avl_data->header)->data_size_max	 = data_size;
	(avl_data->header)->data_size_used   = 0;
	(avl_data->header)->nb_items	 	 = 0;
	(avl_data->header)->creation_date    = time(NULL);
	strcpy((avl_data->header)->avl_name, avl_name);

	// Initialize all bits to 0
	memset(avl_data->data, 0, (avl_data->header)->data_size_max);

	close(avl_data_file_descriptor);


1104
	// Create the AVL tree file
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123

		// Build file name
	avl_file_name = build_avl_file_name(avl_name);
	if (avl_file_name == NULL)
	{
		close_avl_data(avl_data);
		return NULL;
	}

		// Calculate the size needed
	header_size = get_avl_header_size();
	data_size = get_initial_avl_size();
	file_size = header_size + data_size;

		// Create file
	avl_file_descriptor = openat(avl_dir_file_descriptor, avl_file_name, O_RDWR | O_CREAT | O_EXCL, 0777);
	if (avl_file_descriptor < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
1124
		obidebug(1, "\nError creating an AVL tree file");
1125 1126 1127 1128 1129 1130
		close_avl_data(avl_data);
		free(avl_file_name);
		return NULL;
	}
	free(avl_file_name);

1131
		// Truncate the AVL tree file to the right size
1132 1133 1134
	if (ftruncate(avl_file_descriptor, file_size) < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
1135
		obidebug(1, "\nError truncating an AVL tree file to the right size");
1136 1137 1138 1139 1140
		close_avl_data(avl_data);
		close(avl_file_descriptor);
		return NULL;
	}

1141
		// Allocate the memory for the AVL tree structure
1142 1143 1144 1145
	avl = (OBIDMS_avl_p) malloc(sizeof(OBIDMS_avl_t));
	if (avl == NULL)
	{
		obi_set_errno(OBI_AVL_ERROR);
1146
		obidebug(1, "\nError allocating the memory for the AVL tree structure");
1147 1148 1149 1150 1151
		close_avl_data(avl_data);
		close(avl_file_descriptor);
		return NULL;
	}

1152
		// Fill the AVL tree structure
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
	avl->header = mmap(NULL,
			           header_size,
			           PROT_READ | PROT_WRITE,
			           MAP_SHARED,
			           avl_file_descriptor,
			           0
			          );
	if (avl->header == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
1163
		obidebug(1, "\nError mmapping the header of an AVL tree file");
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
		close_avl_data(avl_data);
		close(avl_file_descriptor);
		free(avl);
		return NULL;
	}

	avl->tree  = mmap(NULL,
			          data_size,
			          PROT_READ | PROT_WRITE,
			          MAP_SHARED,
			          avl_file_descriptor,
			          header_size
			         );
	if (avl->tree == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
1180
		obidebug(1, "\nError mmapping the data of an AVL tree file");
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
		close_avl_data(avl_data);
		munmap(avl->header, header_size);
		close(avl_file_descriptor);
		free(avl);
		return NULL;
	}

	avl->dms = dms;
	avl->data = avl_data;
	avl->directory = dms->avl_directory;
	avl->dir_fd = avl_dir_file_descriptor;

	(avl->header)->header_size 	 = header_size;
	(avl->header)->avl_size 	 = data_size;
	(avl->header)->nb_items	 	 = 0;
	(avl->header)->nb_items_max	 = (index_t) floor(((double) get_initial_avl_size()) / ((double) sizeof(AVL_node_t)));
	(avl->header)->root_idx = -1;
	(avl->header)->creation_date = time(NULL);
	strcpy((avl->header)->avl_name, avl_name);

	close(avl_file_descriptor);

1203
	// Add in the list of opened AVL trees
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
	*(((dms->opened_avls)->avls)+((dms->opened_avls)->nb_opened_avls)) = avl;
	((dms->opened_avls)->nb_opened_avls)++;
	avl->counter = 1;

	return avl;
}


OBIDMS_avl_p obi_open_avl(OBIDMS_p dms, const char* avl_name)
{
	char* 	 			avl_file_name;
	char* 				avl_data_file_name;
	size_t				header_size;
	int					avl_file_descriptor;
	int					avl_data_file_descriptor;
	int					avl_dir_file_descriptor;
	OBIDMS_avl_data_p   avl_data;
	OBIDMS_avl_p		avl;
	size_t i;

1224
	// Check if the AVL tree is already in the list of opened AVL trees
1225 1226 1227
	for (i=0; i < ((dms->opened_avls)->nb_opened_avls); i++)
	{
		if (!strcmp(((*(((dms->opened_avls)->avls)+i))->header)->avl_name, avl_name))
1228
		{	// Found the AVL tree already opened
1229 1230 1231 1232 1233 1234 1235
			((*(((dms->opened_avls)->avls)+i))->counter)++;
			return *(((dms->opened_avls)->avls)+i);
		}
	}

	// Open the data file

1236
		// Get the file descriptor of the AVL trees directory
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
	avl_dir_file_descriptor = dms->avl_dir_fd;

		// Build file name
	avl_data_file_name = build_avl_data_file_name(avl_name);
	if (avl_data_file_name == NULL)
		return NULL;

		// Open file
	avl_data_file_descriptor = openat(avl_dir_file_descriptor, avl_data_file_name, O_RDWR, 0777);
	if (avl_data_file_descriptor < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
1249
		obidebug(1, "\nError opening an AVL tree data file");
1250 1251 1252 1253 1254
		free(avl_data_file_name);
		return NULL;
	}
	free(avl_data_file_name);

1255
		// Allocate the memory for the AVL tree data structure
1256 1257 1258 1259
	avl_data = (OBIDMS_avl_data_p) malloc(sizeof(OBIDMS_avl_data_t));
	if (avl_data == NULL)
	{
		obi_set_errno(OBI_AVL_ERROR);
1260
		obidebug(1, "\nError allocating the memory for the AVL tree data structure");
1261 1262 1263 1264 1265 1266 1267 1268
		close(avl_data_file_descriptor);
		return NULL;
	}

	// Read the header size
	if (read(avl_data_file_descriptor, &header_size, sizeof(size_t)) < ((ssize_t) sizeof(size_t)))
	{
		obi_set_errno(OBI_AVL_ERROR);
1269
		obidebug(1, "\nError reading the header size to open an AVL tree data file");
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
		close(avl_data_file_descriptor);
		return NULL;
	}

		// Fill the avl data structure
	avl_data->header = mmap(NULL,
			                header_size,
			                PROT_READ | PROT_WRITE,
			                MAP_SHARED,
			                avl_data_file_descriptor,
			                0
			               );
	if (avl_data->header == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
1285
		obidebug(1, "\nError mmapping the header of an AVL tree data file");
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
		close(avl_data_file_descriptor);
		free(avl_data);
		return NULL;
	}

	avl_data->data   = mmap(NULL,
			                (avl_data->header)->data_size_max,
			                PROT_READ | PROT_WRITE,
			                MAP_SHARED,
			                avl_data_file_descriptor,
			                header_size
			               );
	if (avl_data->data == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
1301
		obidebug(1, "\nError mmapping the data of an AVL tree data file");
1302 1303 1304 1305 1306 1307 1308 1309 1310
		munmap(avl_data->header, header_size);
		close(avl_data_file_descriptor);
		free(avl_data);
		return NULL;
	}

	close(avl_data_file_descriptor);


1311
	// Open the AVL tree file
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325

		// Build file name
	avl_file_name = build_avl_file_name(avl_name);
	if (avl_file_name == NULL)
	{
		close_avl_data(avl_data);
		return NULL;
	}

		// Open file
	avl_file_descriptor = openat(avl_dir_file_descriptor, avl_file_name, O_RDWR, 0777);
	if (avl_file_descriptor < 0)
	{
		obi_set_errno(OBI_AVL_ERROR);
1326
		obidebug(1, "\nError opening an AVL tree file");
1327 1328 1329 1330 1331 1332
		close_avl_data(avl_data);
		free(avl_file_name);
		return NULL;
	}
	free(avl_file_name);

1333
		// Allocate the memory for the AVL tree structure
1334 1335 1336 1337
	avl = (OBIDMS_avl_p) malloc(sizeof(OBIDMS_avl_t));
	if (avl == NULL)
	{
		obi_set_errno(OBI_AVL_ERROR);
1338
		obidebug(1, "\nError allocating the memory for the AVL tree structure");
1339 1340 1341 1342 1343 1344 1345 1346 1347
		close_avl_data(avl_data);
		close(avl_file_descriptor);
		return NULL;
	}

		// Read the header size
	if (read(avl_file_descriptor, &header_size, sizeof(size_t)) < ((ssize_t) sizeof(size_t)))
	{
		obi_set_errno(OBI_AVL_ERROR);
1348
		obidebug(1, "\nError reading the header size to open an AVL tree");
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
		close(avl_file_descriptor);
		return NULL;
	}

		// Fill the avl structure
	avl->header = mmap(NULL,
			           header_size,
			           PROT_READ | PROT_WRITE,
			           MAP_SHARED,
			           avl_file_descriptor,
			           0
			          );
	if (avl->header == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
1364
		obidebug(1, "\nError mmapping the header of an AVL tree file");
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
		close_avl_data(avl_data);
		close(avl_file_descriptor);
		free(avl);
		return NULL;
	}

	avl->tree = mmap(NULL,
					 (((avl->header)->nb_items_max) * sizeof(AVL_node_t)),
			         PROT_READ | PROT_WRITE,
			         MAP_SHARED,
			         avl_file_descriptor,
			         header_size
			        );
	if (avl->tree == MAP_FAILED)
	{
		obi_set_errno(OBI_AVL_ERROR);
1381
		obidebug(1, "\nError mmapping the data of an AVL tree file");
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
		close_avl_data(avl_data);
		munmap(avl->header, header_size);
		close(avl_file_descriptor);
		free(avl);
		return NULL;
	}

	avl->dms = dms;
	avl->data = avl_data;
	avl->directory = dms->avl_directory;
	avl->dir_fd = avl_dir_file_descriptor;

	close(avl_file_descriptor);

1396
	// Add in the list of opened AVL trees
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
	*(((dms->opened_avls)->avls)+((dms->opened_avls)->nb_opened_avls)) = avl;
	((dms->opened_avls)->nb_opened_avls)++;
	avl->counter = 1;

	return avl;
}


int obi_close_avl(OBIDMS_avl_p avl)
{
	int ret_val = 0;
	size_t i;
	Opened_avls_list_p avls_list;
	OBIDMS_p dms;

	dms = avl->dms;

	avls_list = dms->opened_avls;

	(avl->counter)--;

	if (avl->counter == 0)
	{
		// Delete from the list of opened avls
		for (i=0; i < (avls_list->nb_opened_avls); i++)
		{
			if (!strcmp(((*((avls_list->avls)+i))->header)->avl_name, (avl->header)->avl_name))
			{	// Found the avl. Rearrange list
				(avls_list->nb_opened_avls)--;
				(avls_list->avls)[i] = (avls_list->avls)[avls_list->nb_opened_avls];
			}
		}

		ret_val = close_avl_data(avl->data);

		if (munmap(avl->tree, (((avl->header)->nb_items_max) * sizeof(AVL_node_t))) < 0)
		{
			obi_set_errno(OBI_AVL_ERROR);
1435
			obidebug(1, "\nError munmapping the tree of an AVL tree file");
1436 1437 1438 1439 1440 1441
			ret_val = -1;
		}

		if (munmap(avl->header, (avl->header)->header_size) < 0)
		{
			obi_set_errno(OBI_AVL_ERROR);
1442
			obidebug(1, "\nError munmapping the header of an AVL tree file");
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
			ret_val = -1;
		}

		free(avl);
	}

	return ret_val;
}


byte_t* obi_avl_get(OBIDMS_avl_p avl, index_t idx)
{
	return (((avl->data)->data)+idx);
}


// Insert a new node
index_t obi_avl_add(OBIDMS_avl_p avl, byte_t* value)
{
	AVL_node_p node_to_add = NULL;
	AVL_node_p current_node;
	index_t next, parent;
	index_t value_data_idx;
	index_t node_idx;
	byte_t* to_compare;
	int comp;
1469
	int n = 0;
1470
	int depth = 0;
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530

	// Check if first node
	if (!((avl->header)->nb_items))
	{
		node_to_add = avl_create_node(avl, 0);

		// Add the value in the data array and store its index
		value_data_idx = avl_add_value_in_data_array(avl, value);
		node_to_add->value = value_data_idx;

		// Update the number of items
		((avl->header)->nb_items)++;

		// Set the AVL tree root
		(avl->header)->root_idx = 0;

		return 0;
	}

	// Not first node
	next = (avl->header)->root_idx;
	parent = next;
	comp = 0;

	while (next != -1)
	{
		current_node = (avl->tree)+next;

		// Store path from the lowest node with a balance factor different than 0,
		// as it is the node that will have to be balanced.
		if (current_node->balance_factor != 0)
			// New lowest node with a balance factor different than 0
			n=0;
		(avl->path_idx)[n] = parent;	// Store parent
		(avl->path_dir)[n] = comp < 0;	// Store direction (0 if left, 1 if right)
		n++;

		parent = next;

		// Compare value with value of current node
		to_compare = obi_avl_get(avl, current_node->value);
		comp = byte_array_compare(to_compare, value);

		if (comp > 0)
			// Go to left child
			next = current_node->left_child;
		else if (comp < 0)
			// Go to right child
			next = current_node->right_child;
		else if (comp == 0)
			// Value already stored
			return current_node->value;

		depth++;
	}

	// Check if the AVL tree has not become too big
	if (depth == AVL_MAX_DEPTH)
	{
		obi_set_errno(OBI_AVL_ERROR);
1531
		obidebug(1, "\nThis AVL tree has reached the maximum height (%d).", AVL_MAX_DEPTH);
1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
		return -1;
	}

	// Grow the AVL tree if needed
	if ((avl->header)->nb_items == (avl->header)->nb_items_max)
	{
		if (grow_avl(avl) < 0)
			return -1;
	}

	// Initialize node at the end of the tree
	node_idx = (avl->header)->nb_items;
	node_to_add = avl_create_node(avl, node_idx);

	// Add the value in the data array and store its index
	value_data_idx = avl_add_value_in_data_array(avl, value);
	node_to_add->value = value_data_idx;

	// Update the number of items
	((avl->header)->nb_items)++;

	// Add either as right or left child
	if (comp > 0)	// Add as left child
		((avl->tree)+parent)->left_child = node_idx;
	else		    // Add as right child
		((avl->tree)+parent)->right_child = node_idx;

	// End path
	(avl->path_idx)[n] = parent;
	(avl->path_dir)[n] = comp < 0;	// 0 if went left, 1 if went right
	n++;
	(avl->path_idx)[n] = -1;	// flag path end
	(avl->path_dir)[n] = -1;

	// Update balance factors
	avl_update_balance_factors(avl);

	// Balance tree
	avl_balance(avl);

	// Print tree
	//avl_print(avl);

	return value_data_idx;
}


// Find if a value is already in an AVL tree
index_t obi_avl_find(OBIDMS_avl_p avl, byte_t* value)
{
	int comp;
	index_t next;
	byte_t* to_compare;
	AVL_node_p current_node;

	next = (avl->header)->root_idx;
	while (next != -1)
	{
		current_node = (avl->tree)+next;

		// Compare value with value of current node
		to_compare = obi_avl_get(avl, current_node->value);
		comp = byte_array_compare(to_compare, value);

		if (comp > 0)
			// Go to left child
			next = current_node->left_child;
		else if (comp < 0)
			// Go to right child
			next = current_node->right_child;
		else if (comp == 0)
			// Value found
			return current_node->value;
	}
	// Value not found
	return -1;
}


byte_t* obi_str_to_obibytes(char* value)
{
	byte_t* value_b;
	int32_t length;

	// Compute the number of bytes on which the value will be encoded
	length = strlen(value) + 1;		// +1 to store \0 at the end (makes retrieving faster)

	// Allocate the memory for the encoded value
	value_b = (byte_t*) malloc(BYTE_ARRAY_HEADER_SIZE + length);
	if (value_b == NULL)
	{
		obi_set_errno(OBI_AVL_ERROR);
Celine Mercier committed
1624
		obidebug(1, "\nError allocating memory for a byte array");
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
		return NULL;
	}

	// Store the number of bits on which each element is encoded
	*(value_b) = 8;

	// Store the length (in bytes) of the encoded value (same as decoded for character strings)
	*((int32_t*)(value_b+1)) = length;

	// Store the initial length (in bytes) of the decoded value (same as encoded for character strings)
	*((int32_t*)(value_b+5)) = length;

	// Store the character string
	strcpy(value_b+BYTE_ARRAY_HEADER_SIZE, value);

	return value_b;
}


const char* obi_obibytes_to_str(byte_t* value_b)
{
	const char* value;

	value = value_b+BYTE_ARRAY_HEADER_SIZE;

	return value;
}


byte_t* obi_seq_to_obibytes(char* seq)
{
	byte_t*  value_b;
	int32_t  length;	   // length of the value (without the header) in bytes
	uint8_t  size;	  	   // size of one element in bits
	int32_t  seq_length;
	byte_t*  encoded_seq;

	// Check if just ATGC and set size of a nucleotide accordingly (2 bits or 4 bits)
	if (only_ATGC(seq))
		size = 2;
	else
		size = 4;

	// Compute the length (in bytes) of the encoded sequence
	seq_length = strlen(seq);
	if (size == 2)
		length = ceil((double) seq_length / (double) 4.0);
	else	// size == 4
		length = ceil((double) seq_length / (double) 2.0);

	// Encode
	if (size == 2)
		encoded_seq = encode_seq_on_2_bits(seq, seq_length);
	else	// size == 4
		encoded_seq = encode_seq_on_4_bits(seq, seq_length);
	if (encoded_seq == NULL)
	{
		obi_set_errno(OBI_AVL_ERROR);
		obidebug(1, "\nError encoding a DNA sequence");
		return NULL;
	}

	// Allocate the memory for the encoded value
	value_b = (byte_t*) malloc(BYTE_ARRAY_HEADER_SIZE + length);
	if (value_b == NULL)
	{
		obi_set_errno(OBI_AVL_ERROR);
Celine Mercier committed
1692
		obidebug(1, "\nError allocating memory for a byte array");
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737
		return NULL;
	}

	// Store the number of bits on which each nucleotide is encoded
	*(value_b) = size;

	// Store the length (in bytes) of the encoded sequence
	*((int32_t*)(value_b+1)) = length;

	// Store the length (in bytes) of the initial sequence (necessary for decoding)
	*((int32_t*)(value_b+5)) = seq_length;

	// Store the encoded sequence
	memcpy(value_b+BYTE_ARRAY_HEADER_SIZE, encoded_seq, length);

	free(encoded_seq);

	return value_b;
}


const char* obi_obibytes_to_seq(byte_t* value_b)
{
	const char* value;
	uint8_t size;	    // size of one element in bits

	// Check the encoding (each nucleotide on 2 bits or 4 bits)
	size = *(value_b);

	// Decode
	if (size == 2)
		value = decode_seq_on_2_bits(value_b+BYTE_ARRAY_HEADER_SIZE, *((int32_t*)(value_b+5)));
	else
		value = decode_seq_on_4_bits(value_b+BYTE_ARRAY_HEADER_SIZE, *((int32_t*)(value_b+5)));

	if (value == NULL)
	{
		obi_set_errno(OBI_AVL_ERROR);
		obidebug(1, "\nError decoding a DNA sequence");
		return NULL;
	}

	return value;
}