459d04a5ee
The existing implementations of POSIX tsearch() and tdelete() don't attempt to perform any balancing at all. Testing reveals that inserting 100k nodes into a tree sequentially takes approximately one minute on my system. Though most other BSDs also don't use any balanced tree internally, C libraries like glibc and musl do provide better implementations. glibc uses a red-black tree and musl uses an AVL tree. Red-black trees have the advantage over AVL trees that they only require O(1) rotations after insertion and deletion, but have the disadvantage that the tree has a maximum depth of 2*log2(n) instead of 1.44*log2(n). My take is that it's better to focus on having a lower maximum depth, for the reason that in the case of tsearch() the invocation of the comparator likely dominates the running time. This change replaces the tsearch() and tdelete() functions by versions that create an AVL tree. Compared to musl's implementation, this version is different in two different ways: - We don't keep track of heights; just balances. This is sufficient. This has the advantage that it reduces the number of nodes that are being accessed. Storing heights requires us to also access all of the siblings along the path. - Don't use any recursion at all. We know that the tree cannot 2^64 elements in size, so the height of the tree can never be larger than 96. Use a 128-bit bitmask to keep track of the path that is computed. This allows us to iterate over the same path twice, meaning we can apply rotations from top to bottom. Inserting 100k nodes into a tree now only takes 0.015 seconds. Insertion seems to be twice as fast as glibc, whereas deletion has about the same performance. Unlike glibc, it uses a fixed amount of memory. I also experimented with both recursive and iterative bottom-up implementations of the same algorithm. This iterative top-down version performs similar to the recursive bottom-up version in terms of speed and code size. For some reason, the iterative bottom-up algorithm was actually 30% faster for deletion, but has a quadratic memory complexity to keep track of all the parent pointers. Reviewed by: jilles Obtained from: https://github.com/NuxiNL/cloudlibc Differential Revision: https://reviews.freebsd.org/D4412
132 lines
3.7 KiB
C
132 lines
3.7 KiB
C
/*-
|
|
* Copyright (c) 2015 Nuxi, https://nuxi.nl/
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
#include <atf-c.h>
|
|
#define _SEARCH_PRIVATE
|
|
#include <search.h>
|
|
#include <stdbool.h>
|
|
#include <stdlib.h>
|
|
|
|
/* Validates the integrity of an AVL tree. */
|
|
static inline unsigned int
|
|
tnode_assert(const node_t *n)
|
|
{
|
|
unsigned int height_left, height_right;
|
|
int balance;
|
|
|
|
if (n == NULL)
|
|
return 0;
|
|
height_left = tnode_assert(n->llink);
|
|
height_right = tnode_assert(n->rlink);
|
|
balance = (int)height_left - (int)height_right;
|
|
ATF_CHECK(balance >= -1);
|
|
ATF_CHECK(balance <= 1);
|
|
ATF_CHECK_EQ(balance, n->balance);
|
|
return (height_left > height_right ? height_left : height_right) + 1;
|
|
}
|
|
|
|
static int
|
|
compar(const void *a, const void *b)
|
|
{
|
|
|
|
return *(int *)a - *(int *)b;
|
|
}
|
|
|
|
ATF_TC_WITHOUT_HEAD(tsearch_test);
|
|
ATF_TC_BODY(tsearch_test, tc)
|
|
{
|
|
/*
|
|
* Run the test below in a deterministic fashion to prevent this
|
|
* test from potentially flapping. We assume that this provides
|
|
* enough coverage.
|
|
*/
|
|
#if 0
|
|
unsigned short random_state[3];
|
|
arc4random_buf(random_state, sizeof(random_state));
|
|
#else
|
|
unsigned short random_state[3] = { 26554, 13330, 3246 };
|
|
#endif
|
|
|
|
#define NKEYS 1000
|
|
/* Create 1000 possible keys. */
|
|
int keys[NKEYS];
|
|
for (int i = 0; i < NKEYS; ++i)
|
|
keys[i] = i;
|
|
|
|
/* Apply random operations on a binary tree and check the results. */
|
|
void *root = NULL;
|
|
bool present[NKEYS] = {};
|
|
for (int i = 0; i < NKEYS * 10; ++i) {
|
|
int key = nrand48(random_state) % NKEYS;
|
|
switch (nrand48(random_state) % 3) {
|
|
case 0: /* tdelete(). */
|
|
if (present[key]) {
|
|
ATF_CHECK(tdelete(&key, &root, compar) != NULL);
|
|
present[key] = false;
|
|
} else {
|
|
ATF_CHECK_EQ(NULL,
|
|
tdelete(&key, &root, compar));
|
|
}
|
|
break;
|
|
case 1: /* tfind(). */
|
|
if (present[key]) {
|
|
ATF_CHECK_EQ(&keys[key],
|
|
*(int **)tfind(&key, &root, compar));
|
|
} else {
|
|
ATF_CHECK_EQ(NULL, tfind(&key, &root, compar));
|
|
}
|
|
break;
|
|
case 2: /* tsearch(). */
|
|
if (present[key]) {
|
|
ATF_CHECK_EQ(&keys[key],
|
|
*(int **)tsearch(&key, &root, compar));
|
|
} else {
|
|
ATF_CHECK_EQ(&keys[key], *(int **)tsearch(
|
|
&keys[key], &root, compar));
|
|
present[key] = true;
|
|
}
|
|
break;
|
|
}
|
|
tnode_assert(root);
|
|
}
|
|
|
|
/* Remove all entries from the tree. */
|
|
for (int key = 0; key < NKEYS; ++key)
|
|
if (present[key])
|
|
ATF_CHECK(tdelete(&key, &root, compar) != NULL);
|
|
ATF_CHECK_EQ(NULL, root);
|
|
}
|
|
|
|
ATF_TP_ADD_TCS(tp)
|
|
{
|
|
|
|
ATF_TP_ADD_TC(tp, tsearch_test);
|
|
|
|
return (atf_no_error());
|
|
}
|