include/isa-l/mem_routines.h

0001 /**********************************************************************
0002   Copyright(c) 2011-2018 Intel Corporation All rights reserved.
0003
0004   Redistribution and use in source and binary forms, with or without
0005   modification, are permitted provided that the following conditions
0006   are met:
0007     * Redistributions of source code must retain the above copyright
0008       notice, this list of conditions and the following disclaimer.
0009     * Redistributions in binary form must reproduce the above copyright
0010       notice, this list of conditions and the following disclaimer in
0011       the documentation and/or other materials provided with the
0012       distribution.
0013     * Neither the name of Intel Corporation nor the names of its
0014       contributors may be used to endorse or promote products derived
0015       from this software without specific prior written permission.
0016
0017   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0018   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0019   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0020   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0021   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0022   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0023   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0024   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0025   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0026   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0027   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0028 **********************************************************************/
0029
0030 #include <stddef.h>
0031
0032 /**
0033  *  @file mem_routines.h
0034  *  @brief Interface to storage mem operations
0035  *
0036  *  Defines the interface for vector versions of common memory functions.
0037  */
0038
0039 #ifndef _MEM_ROUTINES_H_
0040 #define _MEM_ROUTINES_H_
0041
0042 #ifdef __cplusplus
0043 extern "C" {
0044 #endif
0045
0046 /**
0047  * @brief Detect if a memory region is all zero
0048  *
0049  * Zero detect function with optimizations for large blocks > 128 bytes
0050  *
0051  * @param    mem   Pointer to memory region to test
0052  * @param    len   Length of region in bytes
0053  * @returns  0     - region is all zeros
0054  *           other - region has non zero bytes
0055  */
0056 int
0057 isal_zero_detect(void *mem, size_t len);
0058
0059 #ifdef __cplusplus
0060 }
0061 #endif
0062
0063 #endif // _MEM_ROUTINES_H_