/**********************************************************************
Copyright(c) 2011-2016 Intel Corporation All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* 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.
* Neither the name of Intel Corporation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"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 COPYRIGHT
OWNER OR CONTRIBUTORS 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.
**********************************************************************/
#ifndef _MH_SHA1_MURMUR3_X64_128_H_
#define _MH_SHA1_MURMUR3_X64_128_H_
/**
* @file mh_sha1_murmur3_x64_128.h
* @brief mh_sha1_murmur3_x64_128 function prototypes and structures
*
* Interface for mh_sha1_murmur3_x64_128 functions
*
* mh_sha1_murmur3_x64_128 Init-Update..Update-Finalize
*
* This file defines the interface to optimized functions used in mh_sha1 and
* mh_sha1_murmur3_x64_128. The definition of multi-hash SHA1(mh_sha1,
* for short) is: Pad the buffer in SHA1 style until the total length is a multiple
* of 4*16*16(words-width * parallel-segments * block-size); Hash the buffer
* in parallel, generating digests of 4*16*5 (words-width*parallel-segments*
* digest-size); Treat the set of digests as another data buffer, and generate
* a final SHA1 digest for it. mh_sha1_murmur3_x64_128 is a stitching function
* which will get a murmur3_x64_128 digest while generate mh_sha1 digest.
*
*
* Example
* \code
* uint32_t mh_sha1_digest[SHA1_DIGEST_WORDS];
* uint32_t murmur_digest[MURMUR3_x64_128_DIGEST_WORDS];
* struct mh_sha1_murmur3_x64_128_ctx *ctx;
*
* ctx = malloc(sizeof(struct mh_sha1_murmur3_x64_128_ctx));
* mh_sha1_murmur3_x64_128_init(ctx, 0);
* mh_sha1_murmur3_x64_128_update(ctx, buff, block_len);
* mh_sha1_murmur3_x64_128_finalize(ctx, mh_sha1_digest,
* murmur_digest);
* \endcode
*/
#include
#include "mh_sha1.h"
#ifdef __cplusplus
extern "C" {
#endif
// External Interface Definition
// Add murmur3_x64_128 definition
#define MUR_BLOCK_SIZE (2 * sizeof(uint64_t))
#define MURMUR3_x64_128_DIGEST_WORDS 4
/** @brief Holds info describing a single mh_sha1_murmur3_x64_128
*
* It is better to use heap to allocate this data structure to avoid stack overflow.
*
*/
struct mh_sha1_murmur3_x64_128_ctx {
uint32_t mh_sha1_digest[SHA1_DIGEST_WORDS]; //!< the digest of multi-hash SHA1
uint32_t murmur3_x64_128_digest[MURMUR3_x64_128_DIGEST_WORDS]; //!< the digest of murmur3_x64_128
uint64_t total_length;
//!< Parameters for update feature, describe the lengths of input buffers in bytes
uint8_t partial_block_buffer [MH_SHA1_BLOCK_SIZE * 2];
//!< Padding the tail of input data for SHA1
uint8_t mh_sha1_interim_digests[sizeof(uint32_t) * SHA1_DIGEST_WORDS * HASH_SEGS];
//!< Storing the SHA1 interim digests of all 16 segments. Each time, it will be copied to stack for 64-byte alignment purpose.
uint8_t frame_buffer[MH_SHA1_BLOCK_SIZE + AVX512_ALIGNED];
//!< Re-structure sha1 block data from different segments to fit big endian. Use AVX512_ALIGNED for 64-byte alignment purpose.
};
/**
* @enum mh_sha1_murmur3_ctx_error
* @brief CTX error flags
*/
enum mh_sha1_murmur3_ctx_error{
MH_SHA1_MURMUR3_CTX_ERROR_NONE = 0, //!< MH_SHA1_MURMUR3_CTX_ERROR_NONE
MH_SHA1_MURMUR3_CTX_ERROR_NULL = -1, //!