bind9/tests/isc/ht_test.c
Ondřej Surý f46ce447a6
Add isc_hashmap API that implements Robin Hood hashing
Add new isc_hashmap API that differs from the current isc_ht API in
several aspects:

1. It implements Robin Hood Hashing which is open-addressing hash table
   algorithm (e.g. no linked-lists)

2. No memory allocations - the array to store the nodes is made of
   isc_hashmap_node_t structures instead of just pointers, so there's
   only allocation on resize.

3. The key is not copied into the hashmap node and must be also stored
   externally, either as part of the stored value or in any other
   location that's valid as long the value is stored in the hashmap.

This makes the isc_hashmap_t a little less universal because of the key
storage requirements, but the inserts and deletes are faster because
they don't require memory allocation on isc_hashmap_add() and memory
deallocation on isc_hashmap_delete().
2022-11-10 15:07:19 +01:00

343 lines
8.9 KiB
C

/*
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
*
* SPDX-License-Identifier: MPL-2.0
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
*
* See the COPYRIGHT file distributed with this work for additional
* information regarding copyright ownership.
*/
#include <inttypes.h>
#include <sched.h> /* IWYU pragma: keep */
#include <setjmp.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#define UNIT_TESTING
#include <cmocka.h>
#include <isc/hash.h>
#include <isc/ht.h>
#include <isc/mem.h>
#include <isc/print.h>
#include <isc/string.h>
#include <isc/util.h>
#include <tests/isc.h>
/* INCLUDE LAST */
#define mctx __mctx
#include "ht.c"
#undef mctx
static void
test_ht_full(uint8_t init_bits, uintptr_t count) {
isc_ht_t *ht = NULL;
isc_result_t result;
uintptr_t i;
isc_ht_init(&ht, mctx, init_bits, ISC_HT_CASE_SENSITIVE);
assert_non_null(ht);
for (i = 1; i < count; i++) {
/*
* Note: snprintf() is followed with strlcat()
* to ensure we are always filling the 16 byte key.
*/
unsigned char key[16];
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " key of a raw hashtable!!", sizeof(key));
result = isc_ht_add(ht, key, 16, (void *)i);
assert_int_equal(result, ISC_R_SUCCESS);
}
for (i = 1; i < count; i++) {
unsigned char key[16];
void *f = NULL;
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " key of a raw hashtable!!", sizeof(key));
result = isc_ht_find(ht, key, 16, &f);
assert_int_equal(result, ISC_R_SUCCESS);
assert_ptr_equal((void *)i, (uintptr_t)f);
}
for (i = 1; i < count; i++) {
unsigned char key[16];
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " key of a raw hashtable!!", sizeof(key));
result = isc_ht_add(ht, key, 16, (void *)i);
assert_int_equal(result, ISC_R_EXISTS);
}
for (i = 1; i < count; i++) {
char key[64];
/*
* Note: the key size is now strlen(key) which is bigger
* then the keys added above.
*/
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " key of a raw hashtable!!", sizeof(key));
result = isc_ht_add(ht, (const unsigned char *)key, strlen(key),
(void *)i);
assert_int_equal(result, ISC_R_SUCCESS);
}
for (i = 1; i < count; i++) {
unsigned char key[16];
void *f = NULL;
/*
* Note: case of KEY is now in capitals,
*/
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " KEY of a raw hashtable!!", sizeof(key));
result = isc_ht_find(ht, key, 16, &f);
assert_int_equal(result, ISC_R_NOTFOUND);
assert_null(f);
}
for (i = 1; i < count; i++) {
char key[64];
void *f = NULL;
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " key of a raw hashtable!!", sizeof(key));
result = isc_ht_find(ht, (const unsigned char *)key,
strlen(key), &f);
assert_int_equal(result, ISC_R_SUCCESS);
assert_ptr_equal(f, (void *)i);
}
for (i = 1; i < count; i++) {
unsigned char key[16];
void *f = NULL;
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " key of a raw hashtable!!", sizeof(key));
result = isc_ht_delete(ht, key, 16);
assert_int_equal(result, ISC_R_SUCCESS);
result = isc_ht_find(ht, key, 16, &f);
assert_int_equal(result, ISC_R_NOTFOUND);
assert_null(f);
}
for (i = 1; i < count; i++) {
unsigned char key[16];
/*
* Note: upper case KEY.
*/
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " KEY of a raw hashtable!!", sizeof(key));
result = isc_ht_add(ht, key, 16, (void *)i);
assert_int_equal(result, ISC_R_SUCCESS);
}
for (i = 1; i < count; i++) {
char key[64];
void *f = NULL;
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " key of a raw hashtable!!", sizeof(key));
result = isc_ht_delete(ht, (const unsigned char *)key,
strlen(key));
assert_int_equal(result, ISC_R_SUCCESS);
result = isc_ht_find(ht, (const unsigned char *)key,
strlen(key), &f);
assert_int_equal(result, ISC_R_NOTFOUND);
assert_null(f);
}
for (i = 1; i < count; i++) {
unsigned char key[16];
void *f = NULL;
/*
* Note: case of KEY is now in capitals,
*/
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " KEY of a raw hashtable!!", sizeof(key));
result = isc_ht_find(ht, key, 16, &f);
assert_int_equal(result, ISC_R_SUCCESS);
assert_ptr_equal((void *)i, (uintptr_t)f);
}
for (i = 1; i < count; i++) {
unsigned char key[16];
void *f = NULL;
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, " key of a raw hashtable!!", sizeof(key));
result = isc_ht_find(ht, key, 16, &f);
assert_int_equal(result, ISC_R_NOTFOUND);
assert_null(f);
}
isc_ht_destroy(&ht);
assert_null(ht);
}
static void
test_ht_iterator(void) {
isc_ht_t *ht = NULL;
isc_result_t result;
isc_ht_iter_t *iter = NULL;
uintptr_t i;
uintptr_t count = 7600;
uint32_t walked;
unsigned char key[16];
size_t tksize;
isc_ht_init(&ht, mctx, HT_MIN_BITS, ISC_HT_CASE_SENSITIVE);
assert_non_null(ht);
for (i = 1; i <= count; i++) {
/*
* Note that the string we're snprintfing is always > 16 bytes
* so we are always filling the key.
*/
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, "key of a raw hashtable!!", sizeof(key));
result = isc_ht_add(ht, key, 16, (void *)i);
assert_int_equal(result, ISC_R_SUCCESS);
}
/* We want to iterate while rehashing is in progress */
assert_true(rehashing_in_progress(ht));
walked = 0;
isc_ht_iter_create(ht, &iter);
for (result = isc_ht_iter_first(iter); result == ISC_R_SUCCESS;
result = isc_ht_iter_next(iter))
{
unsigned char *tkey = NULL;
void *v = NULL;
isc_ht_iter_current(iter, &v);
isc_ht_iter_currentkey(iter, &tkey, &tksize);
assert_int_equal(tksize, 16);
i = (uintptr_t)v;
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, "key of a raw hashtable!!", sizeof(key));
assert_memory_equal(key, tkey, 16);
walked++;
}
assert_int_equal(walked, count);
assert_int_equal(result, ISC_R_NOMORE);
/* erase odd */
walked = 0;
result = isc_ht_iter_first(iter);
while (result == ISC_R_SUCCESS) {
unsigned char *tkey = NULL;
void *v = NULL;
isc_ht_iter_current(iter, &v);
isc_ht_iter_currentkey(iter, &tkey, &tksize);
assert_int_equal(tksize, 16);
i = (uintptr_t)v;
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, "key of a raw hashtable!!", sizeof(key));
assert_memory_equal(key, tkey, 16);
if ((uintptr_t)v % 2 == 0) {
result = isc_ht_iter_delcurrent_next(iter);
} else {
result = isc_ht_iter_next(iter);
}
walked++;
}
assert_int_equal(result, ISC_R_NOMORE);
assert_int_equal(walked, count);
/* erase even */
walked = 0;
result = isc_ht_iter_first(iter);
while (result == ISC_R_SUCCESS) {
unsigned char *tkey = NULL;
void *v = NULL;
isc_ht_iter_current(iter, &v);
isc_ht_iter_currentkey(iter, &tkey, &tksize);
assert_int_equal(tksize, 16);
i = (uintptr_t)v;
snprintf((char *)key, sizeof(key), "%u", (unsigned int)i);
strlcat((char *)key, "key of a raw hashtable!!", sizeof(key));
assert_memory_equal(key, tkey, 16);
if ((uintptr_t)v % 2 == 1) {
result = isc_ht_iter_delcurrent_next(iter);
} else {
result = isc_ht_iter_next(iter);
}
walked++;
}
assert_int_equal(result, ISC_R_NOMORE);
assert_int_equal(walked, count / 2);
walked = 0;
for (result = isc_ht_iter_first(iter); result == ISC_R_SUCCESS;
result = isc_ht_iter_next(iter))
{
walked++;
}
assert_int_equal(result, ISC_R_NOMORE);
assert_int_equal(walked, 0);
/* Iterator doesn't progress rehashing */
assert_true(rehashing_in_progress(ht));
isc_ht_iter_destroy(&iter);
assert_null(iter);
isc_ht_destroy(&ht);
assert_null(ht);
}
/* 1 bit, 120 elements test, full rehashing */
ISC_RUN_TEST_IMPL(isc_ht_1_120) {
test_ht_full(1, 120);
return;
}
/* 6 bit, 1000 elements test, full rehashing */
ISC_RUN_TEST_IMPL(isc_ht_6_1000) {
test_ht_full(6, 1000);
return;
}
/* 24 bit, 200K elements test, no rehashing */
ISC_RUN_TEST_IMPL(isc_ht_24_200000) {
UNUSED(state);
test_ht_full(24, 200000);
}
/* 15 bit, 45K elements test, full rehashing */
ISC_RUN_TEST_IMPL(isc_ht_1_48000) {
UNUSED(state);
test_ht_full(1, 48000);
}
/* 8 bit, 20k elements test, partial rehashing */
ISC_RUN_TEST_IMPL(isc_ht_8_20000) {
UNUSED(state);
test_ht_full(8, 20000);
}
/* test hashtable iterator */
ISC_RUN_TEST_IMPL(isc_ht_iterator) {
UNUSED(state);
test_ht_iterator();
}
ISC_TEST_LIST_START
ISC_TEST_ENTRY(isc_ht_1_120)
ISC_TEST_ENTRY(isc_ht_6_1000)
ISC_TEST_ENTRY(isc_ht_24_200000)
ISC_TEST_ENTRY(isc_ht_1_48000)
ISC_TEST_ENTRY(isc_ht_8_20000)
ISC_TEST_ENTRY(isc_ht_iterator)
ISC_TEST_LIST_END
ISC_TEST_MAIN