freebsd-dev/sys/sys/hash.h
Pedro F. Giffuni c4e20cad00 sys/sys: further adoption of SPDX licensing ID tags.
Mainly focus on files that use BSD 2-Clause license, however the tool I
was using misidentified many licenses so this was mostly a manual - error
prone - task.

The Software Package Data Exchange (SPDX) group provides a specification
to make it easier for automated tools to detect and summarize well known
opensource licenses. We are gradually adopting the specification, noting
that the tags are considered only advisory and do not, in any way,
superceed or replace the license texts.
2017-11-27 15:01:59 +00:00

137 lines
3.5 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2001 Tobias Weingartner
* All rights reserved.
*
* 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 ``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 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.
*
* $OpenBSD: hash.h,v 1.4 2004/05/25 18:37:23 jmc Exp $
* $FreeBSD$
*/
#ifndef _SYS_HASH_H_
#define _SYS_HASH_H_
#include <sys/types.h>
/* Convenience */
#ifndef HASHINIT
#define HASHINIT 5381
#define HASHSTEP(x,c) (((x << 5) + x) + (c))
#endif
/*
* Return a 32-bit hash of the given buffer. The init
* value should be 0, or the previous hash value to extend
* the previous hash.
*/
static __inline uint32_t
hash32_buf(const void *buf, size_t len, uint32_t hash)
{
const unsigned char *p = buf;
while (len--)
hash = HASHSTEP(hash, *p++);
return hash;
}
/*
* Return a 32-bit hash of the given string.
*/
static __inline uint32_t
hash32_str(const void *buf, uint32_t hash)
{
const unsigned char *p = buf;
while (*p)
hash = HASHSTEP(hash, *p++);
return hash;
}
/*
* Return a 32-bit hash of the given string, limited by N.
*/
static __inline uint32_t
hash32_strn(const void *buf, size_t len, uint32_t hash)
{
const unsigned char *p = buf;
while (*p && len--)
hash = HASHSTEP(hash, *p++);
return hash;
}
/*
* Return a 32-bit hash of the given string terminated by C,
* (as well as 0). This is mainly here as a helper for the
* namei() hashing of path name parts.
*/
static __inline uint32_t
hash32_stre(const void *buf, int end, const char **ep, uint32_t hash)
{
const unsigned char *p = buf;
while (*p && (*p != end))
hash = HASHSTEP(hash, *p++);
if (ep)
*ep = p;
return hash;
}
/*
* Return a 32-bit hash of the given string, limited by N,
* and terminated by C (as well as 0). This is mainly here
* as a helper for the namei() hashing of path name parts.
*/
static __inline uint32_t
hash32_strne(const void *buf, size_t len, int end, const char **ep,
uint32_t hash)
{
const unsigned char *p = buf;
while (*p && (*p != end) && len--)
hash = HASHSTEP(hash, *p++);
if (ep)
*ep = p;
return hash;
}
#ifdef _KERNEL
/*
* Hashing function from Bob Jenkins. Implementation in libkern/jenkins_hash.c.
*/
uint32_t jenkins_hash(const void *, size_t, uint32_t);
uint32_t jenkins_hash32(const uint32_t *, size_t, uint32_t);
uint32_t murmur3_32_hash(const void *, size_t, uint32_t);
uint32_t murmur3_32_hash32(const uint32_t *, size_t, uint32_t);
#endif /* _KERNEL */
#endif /* !_SYS_HASH_H_ */