//////////////////////////////////////////////////////////////////////////////// /// @brief hash functions /// /// @file /// /// DISCLAIMER /// /// Copyright 2004-2013 triAGENS GmbH, Cologne, Germany /// /// Licensed under the Apache License, Version 2.0 (the "License"); /// you may not use this file except in compliance with the License. /// You may obtain a copy of the License at /// /// http://www.apache.org/licenses/LICENSE-2.0 /// /// Unless required by applicable law or agreed to in writing, software /// distributed under the License is distributed on an "AS IS" BASIS, /// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. /// See the License for the specific language governing permissions and /// limitations under the License. /// /// Copyright holder is triAGENS GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Copyright 2011-2013, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #ifndef TRIAGENS_BASICS_C_HASHES_H #define TRIAGENS_BASICS_C_HASHES_H 1 #include "BasicsC/common.h" #ifdef __cplusplus extern "C" { #endif // ----------------------------------------------------------------------------- // --SECTION-- (FNV-1a Fowler–Noll–Vo hash function) FNV // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Hashes /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief computes a FNV hash for blobs //////////////////////////////////////////////////////////////////////////////// uint64_t TRI_FnvHashBlob (TRI_blob_t*); //////////////////////////////////////////////////////////////////////////////// /// @brief computes a FNV hash for memory blobs //////////////////////////////////////////////////////////////////////////////// uint64_t TRI_FnvHashPointer (void const*, size_t); //////////////////////////////////////////////////////////////////////////////// /// @brief computes a FNV hash for strings //////////////////////////////////////////////////////////////////////////////// uint64_t TRI_FnvHashString (char const*); //////////////////////////////////////////////////////////////////////////////// /// @brief computes a FNV hash for blocks //////////////////////////////////////////////////////////////////////////////// uint64_t TRI_FnvHashBlock (uint64_t, char const*, size_t); //////////////////////////////////////////////////////////////////////////////// /// @brief computes a initial FNV for blocks //////////////////////////////////////////////////////////////////////////////// uint64_t TRI_FnvHashBlockInitial (void); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- CRC32 // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Hashes /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief initial CRC32 value //////////////////////////////////////////////////////////////////////////////// uint32_t TRI_InitialCrc32 (void); //////////////////////////////////////////////////////////////////////////////// /// @brief final CRC32 value //////////////////////////////////////////////////////////////////////////////// uint32_t TRI_FinalCrc32 (uint32_t); //////////////////////////////////////////////////////////////////////////////// /// @brief CRC32 value of data block //////////////////////////////////////////////////////////////////////////////// uint32_t TRI_BlockCrc32 (uint32_t, char const* data, size_t length); //////////////////////////////////////////////////////////////////////////////// /// @brief CRC32 value of data block ended by 0 //////////////////////////////////////////////////////////////////////////////// uint32_t TRI_BlockStringCrc32 (uint32_t, char const* data); //////////////////////////////////////////////////////////////////////////////// /// @brief computes a CRC32 for blobs //////////////////////////////////////////////////////////////////////////////// uint32_t TRI_Crc32HashBlob (TRI_blob_t*); //////////////////////////////////////////////////////////////////////////////// /// @brief computes a CRC32 for memory blobs //////////////////////////////////////////////////////////////////////////////// uint32_t TRI_Crc32HashPointer (void const*, size_t); //////////////////////////////////////////////////////////////////////////////// /// @brief computes a CRC32 for strings //////////////////////////////////////////////////////////////////////////////// uint64_t TRI_Crc32HashString (char const*); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- MODULE // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Hashes /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief initialises the hashes components //////////////////////////////////////////////////////////////////////////////// void TRI_InitialiseHashes (void); //////////////////////////////////////////////////////////////////////////////// /// @brief shut downs the hashes components //////////////////////////////////////////////////////////////////////////////// void TRI_ShutdownHashes (void); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// #ifdef __cplusplus } #endif #endif // Local Variables: // mode: outline-minor // outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}" // End: