xxhash.h File Reference

#include <stddef.h>
#include <limits.h>
#include <stdlib.h>
#include <string.h>
#include "xxh3.h"

Go to the source code of this file.

Classes
struct	XXH32_canonical_t
struct	XXH64_canonical_t

Macros
#define	XXHASH_H_5627135585666179   1
#define	XXH_PUBLIC_API   /* do nothing */
#define	XXH_VERSION_MAJOR   0
#define	XXH_VERSION_MINOR   7
#define	XXH_VERSION_RELEASE   2
#define	XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)

Typedefs
typedef struct XXH32_state_s	XXH32_state_t
typedef unsigned long long	XXH64_hash_t
typedef struct XXH64_state_s	XXH64_state_t

Enumerations
enum	XXH_errorcode { XXH_OK =0, XXH_ERROR }

Functions
XXH_PUBLIC_API unsigned	XXH_versionNumber (void)
XXH_PUBLIC_API XXH32_hash_t	XXH32 (const void *input, size_t length, XXH32_hash_t seed)
XXH_PUBLIC_API XXH32_state_t *	XXH32_createState (void)
XXH_PUBLIC_API XXH_errorcode	XXH32_freeState (XXH32_state_t *statePtr)
XXH_PUBLIC_API void	XXH32_copyState (XXH32_state_t *dst_state, const XXH32_state_t *src_state)
XXH_PUBLIC_API XXH_errorcode	XXH32_reset (XXH32_state_t *statePtr, XXH32_hash_t seed)
XXH_PUBLIC_API XXH_errorcode	XXH32_update (XXH32_state_t *statePtr, const void *input, size_t length)
XXH_PUBLIC_API XXH32_hash_t	XXH32_digest (const XXH32_state_t *statePtr)
XXH_PUBLIC_API void	XXH32_canonicalFromHash (XXH32_canonical_t *dst, XXH32_hash_t hash)
XXH_PUBLIC_API XXH32_hash_t	XXH32_hashFromCanonical (const XXH32_canonical_t *src)
XXH_PUBLIC_API XXH64_hash_t	XXH64 (const void *input, size_t length, XXH64_hash_t seed)
XXH_PUBLIC_API XXH64_state_t *	XXH64_createState (void)
XXH_PUBLIC_API XXH_errorcode	XXH64_freeState (XXH64_state_t *statePtr)
XXH_PUBLIC_API void	XXH64_copyState (XXH64_state_t *dst_state, const XXH64_state_t *src_state)
XXH_PUBLIC_API XXH_errorcode	XXH64_reset (XXH64_state_t *statePtr, XXH64_hash_t seed)
XXH_PUBLIC_API XXH_errorcode	XXH64_update (XXH64_state_t *statePtr, const void *input, size_t length)
XXH_PUBLIC_API XXH64_hash_t	XXH64_digest (const XXH64_state_t *statePtr)
XXH_PUBLIC_API void	XXH64_canonicalFromHash (XXH64_canonical_t *dst, XXH64_hash_t hash)
XXH_PUBLIC_API XXH64_hash_t	XXH64_hashFromCanonical (const XXH64_canonical_t *src)

Macro Definition Documentation

XXH_PUBLIC_API

#define XXH_PUBLIC_API   /* do nothing */

Definition at line 159 of file xxhash.h.

XXH_VERSION_MAJOR

#define XXH_VERSION_MAJOR   0

XXH_NAMESPACE, aka Namespace Emulation :

If you want to include and expose xxHash functions from within your own library, but also want to avoid symbol collisions with other libraries which may also include xxHash,

you can use XXH_NAMESPACE, to automatically prefix any public symbol from xxhash library with the value of XXH_NAMESPACE (therefore, avoid NULL and numeric values).

Note that no change is required within the calling program as long as it includes xxhash.h : regular symbol name will be automatically translated by this header.

Definition at line 202 of file xxhash.h.

XXH_VERSION_MINOR

#define XXH_VERSION_MINOR   7

Definition at line 203 of file xxhash.h.

XXH_VERSION_NUMBER

#define XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)

Definition at line 205 of file xxhash.h.

XXH_VERSION_RELEASE

#define XXH_VERSION_RELEASE   2

Definition at line 204 of file xxhash.h.

XXHASH_H_5627135585666179

#define XXHASH_H_5627135585666179   1

XXH_INLINE_ALL (and XXH_PRIVATE_API) Implement requested xxhash functions directly in the unit. Inlining offers great performance improvement on small inputs, and dramatic ones when length is expressed as a compile-time constant. See https://fastcompression.blogspot.com/2018/03/xxhash-for-small-keys-impressive-power.html . It also removes all symbols from the public list. Methodology : #define XXH_INLINE_ALL #include "xxhash.h" Do not compile and link xxhash.o as a separate object (not useful)

Definition at line 148 of file xxhash.h.

Typedef Documentation

XXH32_state_t

typedef struct XXH32_state_s XXH32_state_t

Definition at line 267 of file xxhash.h.

XXH64_hash_t

typedef unsigned long long XXH64_hash_t

Definition at line 309 of file xxhash.h.

XXH64_state_t

typedef struct XXH64_state_s XXH64_state_t

Definition at line 320 of file xxhash.h.

Enumeration Type Documentation

XXH_errorcode

enum XXH_errorcode

Enumerator
XXH_OK
XXH_ERROR

Definition at line 213 of file xxhash.h.

{ XXH_OK=0, XXH_ERROR } XXH_errorcode;

Function Documentation

XXH32()

XXH_PUBLIC_API XXH32_hash_t XXH32	(	const void *	input,
		size_t	length,
		XXH32_hash_t	seed
	)

XXH32() : Calculate the 32-bit hash of sequence "length" bytes stored at memory address "input". The memory between input & input+length must be valid (allocated and read-accessible). "seed" can be used to alter the result predictably. Speed on Core 2 Duo @ 3 GHz (single thread, SMHasher benchmark) : 5.4 GB/s

XXH32_canonicalFromHash()

XXH_PUBLIC_API void XXH32_canonicalFromHash	(	XXH32_canonical_t *	dst,
		XXH32_hash_t	hash
	)

XXH32_copyState()

XXH_PUBLIC_API void XXH32_copyState	(	XXH32_state_t *	dst_state,
		const XXH32_state_t *	src_state
	)

XXH32_createState()

XXH_PUBLIC_API XXH32_state_t* XXH32_createState

(

void

)

XXH32_digest()

XXH_PUBLIC_API XXH32_hash_t XXH32_digest

(

const XXH32_state_t *

statePtr

)

XXH32_freeState()

XXH_PUBLIC_API XXH_errorcode XXH32_freeState

(

XXH32_state_t *

statePtr

)

XXH32_hashFromCanonical()

XXH_PUBLIC_API XXH32_hash_t XXH32_hashFromCanonical

(

const XXH32_canonical_t *

src

)

XXH32_reset()

XXH_PUBLIC_API XXH_errorcode XXH32_reset	(	XXH32_state_t *	statePtr,
		XXH32_hash_t	seed
	)

XXH32_update()

XXH_PUBLIC_API XXH_errorcode XXH32_update	(	XXH32_state_t *	statePtr,
		const void *	input,
		size_t	length
	)

XXH64()

XXH_PUBLIC_API XXH64_hash_t XXH64	(	const void *	input,
		size_t	length,
		XXH64_hash_t	seed
	)

XXH64() : Returns the 64-bit hash of sequence of length stored at memory address . can be used to alter the result predictably. This function runs faster on 64-bit systems, but slower on 32-bit systems (see benchmark).

XXH64_canonicalFromHash()

XXH_PUBLIC_API void XXH64_canonicalFromHash	(	XXH64_canonical_t *	dst,
		XXH64_hash_t	hash
	)

XXH64_copyState()

XXH_PUBLIC_API void XXH64_copyState	(	XXH64_state_t *	dst_state,
		const XXH64_state_t *	src_state
	)

XXH64_createState()

XXH_PUBLIC_API XXH64_state_t* XXH64_createState

(

void

)

XXH64_digest()

XXH_PUBLIC_API XXH64_hash_t XXH64_digest

(

const XXH64_state_t *

statePtr

)

XXH64_freeState()

XXH_PUBLIC_API XXH_errorcode XXH64_freeState

(

XXH64_state_t *

statePtr

)

XXH64_hashFromCanonical()

XXH_PUBLIC_API XXH64_hash_t XXH64_hashFromCanonical

(

const XXH64_canonical_t *

src

)

XXH64_reset()

XXH_PUBLIC_API XXH_errorcode XXH64_reset	(	XXH64_state_t *	statePtr,
		XXH64_hash_t	seed
	)

XXH64_update()

XXH_PUBLIC_API XXH_errorcode XXH64_update	(	XXH64_state_t *	statePtr,
		const void *	input,
		size_t	length
	)

XXH_versionNumber()

XXH_PUBLIC_API unsigned XXH_versionNumber

(

void

)