Files
bind9/lib/isc/include/isc/hash.h
T
Ondřej Surý b84c9b2608 Turn isc_hash_bits32() into static online function
Adding extra val & 0xffff in the isc_hash_bits32() macros in the hotpath
has significantly reduced the performance.  Turn the macro into static
inline function matching the previous hash_32() function used to compute
hashval matching the hashtable->bits.
2022-04-01 23:04:24 +02:00

93 lines
2.4 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.
*/
#pragma once
#include <inttypes.h>
#include <stdbool.h>
#include <isc/assertions.h>
#include <isc/lang.h>
#include <isc/types.h>
#include <isc/util.h>
#define ISC_HASHSIZE(bits) (UINT64_C(1) << (bits))
#define ISC_HASH_OVERCOMMIT 3
#define ISC_HASH_MIN_BITS 2U
#define ISC_HASH_MAX_BITS 32U
/***
*** Functions
***/
ISC_LANG_BEGINDECLS
const void *
isc_hash_get_initializer(void);
void
isc_hash_set_initializer(const void *initializer);
#define isc_hash_function isc_hash64
uint32_t
isc_hash32(const void *data, const size_t length, const bool case_sensitive);
uint64_t
isc_hash64(const void *data, const size_t length, const bool case_sensitive);
/*!<
* \brief Calculate a hash over data.
*
* This hash function is useful for hashtables. The hash function is
* opaque and not important to the caller. The returned hash values are
* non-deterministic and will have different mapping every time a
* process using this library is run, but will have uniform
* distribution.
*
* isc_hash_32/64() calculates the hash from start to end over the
* input data.
*
* 'data' is the data to be hashed.
*
* 'length' is the size of the data to be hashed.
*
* 'case_sensitive' specifies whether the hash key should be treated as
* case_sensitive values. It should typically be false if the hash key
* is a DNS name.
*
* Returns:
* \li 32 or 64-bit hash value
*/
/*!
* \brief Return a hash value of a specified number of bits
*
* This function uses Fibonacci Hashing to convert a 32 bit hash value
* 'val' into a smaller hash value of up to 'bits' bits. This results
* in better hash table distribution than the use of modulo.
*
* Requires:
* \li 'bits' is less than 32.
*
* Returns:
* \li a hash value of length 'bits'.
*/
#define ISC_HASH_GOLDENRATIO_32 0x61C88647
static inline uint32_t
isc_hash_bits32(uint32_t val, unsigned int bits) {
ISC_REQUIRE(bits <= ISC_HASH_MAX_BITS);
/* High bits are more random. */
return (val * ISC_HASH_GOLDENRATIO_32 >> (32 - bits));
}
ISC_LANG_ENDDECLS