xxhash.h File Reference

xxHash prototypes and implementation More...

#include <stddef.h>
#include <limits.h>

Include dependency graph for xxhash.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	XXH32_canonical_t
	Canonical (big endian) representation of XXH32_hash_t. More...
struct	XXH64_canonical_t
struct	XXH128_hash_t
	The return value from 128-bit hashes. More...
struct	XXH128_canonical_t

Macros
#define	XXHASH_H_5627135585666179   1
#define	XXH_PUBLIC_API   /* do nothing */
	Marks a global symbol.
#define	XXH_PUBLIC_API   /* do nothing */
	Marks a global symbol.
#define	XXH_CONSTF   /* disable */
#define	XXH_PUREF
#define	XXH_MALLOCF
#define	XXH_VERSION_MAJOR   0
#define	XXH_VERSION_MINOR   8
#define	XXH_VERSION_RELEASE   2
#define	XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)
	Version number, encoded as two digits each.
#define	XXH_HAS_ATTRIBUTE(x)
#define	XXH_C23_VN   201711L
#define	XXH_HAS_C_ATTRIBUTE(x)
#define	XXH_HAS_CPP_ATTRIBUTE(x)
#define	XXH_FALLTHROUGH   /* fallthrough */
#define	XXH_NOESCAPE
#define	XXH3_SECRET_SIZE_MIN   136
	The bare minimum size for a custom secret.

Typedefs
typedef struct XXH32_state_s	XXH32_state_t
	Streaming functions generate the xxHash value from an incremental input.
typedef struct XXH64_state_s	XXH64_state_t
	The opaque state struct for the XXH64 streaming API.
typedef struct XXH3_state_s	XXH3_state_t
	The state struct for the XXH3 streaming API.
typedef unsigned long long	XXH64_hash_t

Enumerations
enum	XXH_errorcode { XXH_OK = 0 , XXH_ERROR }
	Exit code for the streaming API. More...

Functions
XXH_PUBLIC_API XXH_CONSTF unsigned	XXH_versionNumber (void)
	Obtains the xxHash version.
XXH_PUBLIC_API XXH_PUREF XXH32_hash_t	XXH32 (const void *input, size_t length, XXH32_hash_t seed)
	Calculates the 32-bit hash of input using xxHash32.
XXH_PUBLIC_API XXH_MALLOCF XXH32_state_t *	XXH32_createState (void)
	Allocates an XXH32_state_t.
XXH_PUBLIC_API XXH_errorcode	XXH32_freeState (XXH32_state_t *statePtr)
	Frees an XXH32_state_t.
XXH_PUBLIC_API void	XXH32_copyState (XXH32_state_t *dst_state, const XXH32_state_t *src_state)
	Copies one XXH32_state_t to another.
XXH_PUBLIC_API XXH_errorcode	XXH32_reset (XXH32_state_t *statePtr, XXH32_hash_t seed)
	Resets an XXH32_state_t to begin a new hash.
XXH_PUBLIC_API XXH_errorcode	XXH32_update (XXH32_state_t *statePtr, const void *input, size_t length)
	Consumes a block of input to an XXH32_state_t.
XXH_PUBLIC_API XXH_PUREF XXH32_hash_t	XXH32_digest (const XXH32_state_t *statePtr)
	Returns the calculated hash value from an XXH32_state_t.
XXH_PUBLIC_API void	XXH32_canonicalFromHash (XXH32_canonical_t *dst, XXH32_hash_t hash)
	Converts an XXH32_hash_t to a big endian XXH32_canonical_t.
XXH_PUBLIC_API XXH_PUREF XXH32_hash_t	XXH32_hashFromCanonical (const XXH32_canonical_t *src)
	Converts an XXH32_canonical_t to a native XXH32_hash_t.
XXH_PUBLIC_API XXH_PUREF XXH64_hash_t	XXH64 (XXH_NOESCAPE const void *input, size_t length, XXH64_hash_t seed)
	Calculates the 64-bit hash of input using xxHash64.
XXH_PUBLIC_API XXH_MALLOCF XXH64_state_t *	XXH64_createState (void)
XXH_PUBLIC_API XXH_errorcode	XXH64_freeState (XXH64_state_t *statePtr)
XXH_PUBLIC_API void	XXH64_copyState (XXH_NOESCAPE XXH64_state_t *dst_state, const XXH64_state_t *src_state)
XXH_PUBLIC_API XXH_errorcode	XXH64_reset (XXH_NOESCAPE XXH64_state_t *statePtr, XXH64_hash_t seed)
XXH_PUBLIC_API XXH_errorcode	XXH64_update (XXH_NOESCAPE XXH64_state_t *statePtr, XXH_NOESCAPE const void *input, size_t length)
XXH_PUBLIC_API XXH_PUREF XXH64_hash_t	XXH64_digest (XXH_NOESCAPE const XXH64_state_t *statePtr)
XXH_PUBLIC_API void	XXH64_canonicalFromHash (XXH_NOESCAPE XXH64_canonical_t *dst, XXH64_hash_t hash)
XXH_PUBLIC_API XXH_PUREF XXH64_hash_t	XXH64_hashFromCanonical (XXH_NOESCAPE const XXH64_canonical_t *src)
XXH_PUBLIC_API XXH_PUREF XXH64_hash_t	XXH3_64bits (XXH_NOESCAPE const void *input, size_t length)
	64-bit unseeded variant of XXH3.
XXH_PUBLIC_API XXH_PUREF XXH64_hash_t	XXH3_64bits_withSeed (XXH_NOESCAPE const void *input, size_t length, XXH64_hash_t seed)
	64-bit seeded variant of XXH3
XXH_PUBLIC_API XXH_PUREF XXH64_hash_t	XXH3_64bits_withSecret (XXH_NOESCAPE const void *data, size_t len, XXH_NOESCAPE const void *secret, size_t secretSize)
	64-bit variant of XXH3 with a custom "secret".
XXH_PUBLIC_API XXH_MALLOCF XXH3_state_t *	XXH3_createState (void)
XXH_PUBLIC_API XXH_errorcode	XXH3_freeState (XXH3_state_t *statePtr)
XXH_PUBLIC_API void	XXH3_copyState (XXH_NOESCAPE XXH3_state_t *dst_state, XXH_NOESCAPE const XXH3_state_t *src_state)
XXH_PUBLIC_API XXH_errorcode	XXH3_64bits_reset (XXH_NOESCAPE XXH3_state_t *statePtr)
XXH_PUBLIC_API XXH_errorcode	XXH3_64bits_reset_withSeed (XXH_NOESCAPE XXH3_state_t *statePtr, XXH64_hash_t seed)
XXH_PUBLIC_API XXH_errorcode	XXH3_64bits_reset_withSecret (XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret, size_t secretSize)
	XXH3_64bits_reset_withSecret(): secret is referenced, it must outlive the hash streaming session.
XXH_PUBLIC_API XXH_errorcode	XXH3_64bits_update (XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *input, size_t length)
XXH_PUBLIC_API XXH_PUREF XXH64_hash_t	XXH3_64bits_digest (XXH_NOESCAPE const XXH3_state_t *statePtr)
XXH_PUBLIC_API XXH_PUREF XXH128_hash_t	XXH3_128bits (XXH_NOESCAPE const void *data, size_t len)
	Unseeded 128-bit variant of XXH3.
XXH_PUBLIC_API XXH_PUREF XXH128_hash_t	XXH3_128bits_withSeed (XXH_NOESCAPE const void *data, size_t len, XXH64_hash_t seed)
	Seeded 128-bit variant of XXH3.
XXH_PUBLIC_API XXH_PUREF XXH128_hash_t	XXH3_128bits_withSecret (XXH_NOESCAPE const void *data, size_t len, XXH_NOESCAPE const void *secret, size_t secretSize)
	Custom secret 128-bit variant of XXH3.
XXH_PUBLIC_API XXH_errorcode	XXH3_128bits_reset (XXH_NOESCAPE XXH3_state_t *statePtr)
XXH_PUBLIC_API XXH_errorcode	XXH3_128bits_reset_withSeed (XXH_NOESCAPE XXH3_state_t *statePtr, XXH64_hash_t seed)
XXH_PUBLIC_API XXH_errorcode	XXH3_128bits_reset_withSecret (XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret, size_t secretSize)
	Custom secret 128-bit variant of XXH3.
XXH_PUBLIC_API XXH_errorcode	XXH3_128bits_update (XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *input, size_t length)
XXH_PUBLIC_API XXH_PUREF XXH128_hash_t	XXH3_128bits_digest (XXH_NOESCAPE const XXH3_state_t *statePtr)
XXH_PUBLIC_API XXH_PUREF int	XXH128_isEqual (XXH128_hash_t h1, XXH128_hash_t h2)
	XXH128_isEqual(): Return: 1 if h1 and h2 are equal, 0 if they are not.
XXH_PUBLIC_API XXH_PUREF int	XXH128_cmp (XXH_NOESCAPE const void *h128_1, XXH_NOESCAPE const void *h128_2)
	Compares two XXH128_hash_t This comparator is compatible with stdlib's qsort()/bsearch().
XXH_PUBLIC_API void	XXH128_canonicalFromHash (XXH_NOESCAPE XXH128_canonical_t *dst, XXH128_hash_t hash)
XXH_PUBLIC_API XXH_PUREF XXH128_hash_t	XXH128_hashFromCanonical (XXH_NOESCAPE const XXH128_canonical_t *src)

Detailed Description

xxHash prototypes and implementation

Definition in file xxhash.h.