summaryrefslogtreecommitdiffstats
path: root/src/isa-l/include/raid.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
commite6918187568dbd01842d8d1d2c808ce16a894239 (patch)
tree64f88b554b444a49f656b6c656111a145cbbaa28 /src/isa-l/include/raid.h
parentInitial commit. (diff)
downloadceph-b26c4052f3542036551aa9dec9caa4226e456195.tar.xz
ceph-b26c4052f3542036551aa9dec9caa4226e456195.zip
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/isa-l/include/raid.h')
-rw-r--r--src/isa-l/include/raid.h305
1 files changed, 305 insertions, 0 deletions
diff --git a/src/isa-l/include/raid.h b/src/isa-l/include/raid.h
new file mode 100644
index 000000000..6100a4824
--- /dev/null
+++ b/src/isa-l/include/raid.h
@@ -0,0 +1,305 @@
+/**********************************************************************
+ Copyright(c) 2011-2015 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 _RAID_H_
+#define _RAID_H_
+
+/**
+ * @file raid.h
+ * @brief Interface to RAID functions - XOR and P+Q calculation.
+ *
+ * This file defines the interface to optimized XOR calculation (RAID5) or P+Q
+ * dual parity (RAID6). Operations are carried out on an array of pointers to
+ * sources and output arrays.
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Multi-binary functions */
+
+/**
+ * @brief Generate XOR parity vector from N sources, runs appropriate version.
+ *
+ * This function determines what instruction sets are enabled and
+ * selects the appropriate version at runtime.
+ *
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes.
+ * @param array Array of pointers to source and dest. For XOR the dest is
+ * the last pointer. ie array[vects-1]. Src and dest
+ * pointers must be aligned to 32B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int xor_gen(int vects, int len, void **array);
+
+
+/**
+ * @brief Checks that array has XOR parity sum of 0 across all vectors, runs appropriate version.
+ *
+ * This function determines what instruction sets are enabled and
+ * selects the appropriate version at runtime.
+ *
+ * @param vects Number of vectors in array.
+ * @param len Length of each vector in bytes.
+ * @param array Array of pointers to vectors. Src and dest pointers
+ * must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int xor_check(int vects, int len, void **array);
+
+
+/**
+ * @brief Generate P+Q parity vectors from N sources, runs appropriate version.
+ *
+ * This function determines what instruction sets are enabled and
+ * selects the appropriate version at runtime.
+ *
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes. Must be 32B aligned.
+ * @param array Array of pointers to source and dest. For P+Q the dest
+ * is the last two pointers. ie array[vects-2],
+ * array[vects-1]. P and Q parity vectors are
+ * written to these last two pointers. Src and dest
+ * pointers must be aligned to 32B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int pq_gen(int vects, int len, void **array);
+
+
+/**
+ * @brief Checks that array of N sources, P and Q are consistent across all vectors, runs appropriate version.
+ *
+ * This function determines what instruction sets are enabled and
+ * selects the appropriate version at runtime.
+ *
+ * @param vects Number of vectors in array including P&Q.
+ * @param len Length of each vector in bytes. Must be 16B aligned.
+ * @param array Array of pointers to source and P, Q. P and Q parity
+ * are assumed to be the last two pointers in the array.
+ * All pointers must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int pq_check(int vects, int len, void **array);
+
+
+/* Arch specific versions */
+// x86 only
+#if defined(__i386__) || defined(__x86_64__)
+
+/**
+ * @brief Generate XOR parity vector from N sources.
+ * @requires SSE4.1
+ *
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes.
+ * @param array Array of pointers to source and dest. For XOR the dest is
+ * the last pointer. ie array[vects-1]. Src and dest pointers
+ * must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int xor_gen_sse(int vects, int len, void **array);
+
+
+/**
+ * @brief Generate XOR parity vector from N sources.
+ * @requires AVX
+ *
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes.
+ * @param array Array of pointers to source and dest. For XOR the dest is
+ * the last pointer. ie array[vects-1]. Src and dest pointers
+ * must be aligned to 32B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int xor_gen_avx(int vects, int len, void **array);
+
+
+/**
+ * @brief Checks that array has XOR parity sum of 0 across all vectors.
+ * @requires SSE4.1
+ *
+ * @param vects Number of vectors in array.
+ * @param len Length of each vector in bytes.
+ * @param array Array of pointers to vectors. Src and dest pointers
+ * must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int xor_check_sse(int vects, int len, void **array);
+
+
+/**
+ * @brief Generate P+Q parity vectors from N sources.
+ * @requires SSE4.1
+ *
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes. Must be 16B aligned.
+ * @param array Array of pointers to source and dest. For P+Q the dest
+ * is the last two pointers. ie array[vects-2],
+ * array[vects-1]. P and Q parity vectors are
+ * written to these last two pointers. Src and dest
+ * pointers must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int pq_gen_sse(int vects, int len, void **array);
+
+
+/**
+ * @brief Generate P+Q parity vectors from N sources.
+ * @requires AVX
+ *
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes. Must be 16B aligned.
+ * @param array Array of pointers to source and dest. For P+Q the dest
+ * is the last two pointers. ie array[vects-2],
+ * array[vects-1]. P and Q parity vectors are
+ * written to these last two pointers. Src and dest
+ * pointers must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int pq_gen_avx(int vects, int len, void **array);
+
+
+/**
+ * @brief Generate P+Q parity vectors from N sources.
+ * @requires AVX2
+ *
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes. Must be 32B aligned.
+ * @param array Array of pointers to source and dest. For P+Q the dest
+ * is the last two pointers. ie array[vects-2],
+ * array[vects-1]. P and Q parity vectors are
+ * written to these last two pointers. Src and dest
+ * pointers must be aligned to 32B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int pq_gen_avx2(int vects, int len, void **array);
+
+
+/**
+ * @brief Checks that array of N sources, P and Q are consistent across all vectors.
+ * @requires SSE4.1
+ *
+ * @param vects Number of vectors in array including P&Q.
+ * @param len Length of each vector in bytes. Must be 16B aligned.
+ * @param array Array of pointers to source and P, Q. P and Q parity
+ are assumed to be the last two pointers in the array.
+ All pointers must be aligned to 16B.
+ * @returns 0 pass, other fail
+ */
+
+int pq_check_sse(int vects, int len, void **array);
+
+#endif
+
+/**
+ * @brief Generate P+Q parity vectors from N sources, runs baseline version.
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes. Must be 16B aligned.
+ * @param array Array of pointers to source and dest. For P+Q the dest
+ * is the last two pointers. ie array[vects-2],
+ * array[vects-1]. P and Q parity vectors are
+ * written to these last two pointers. Src and dest pointers
+ * must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int pq_gen_base(int vects, int len, void **array);
+
+
+/**
+ * @brief Generate XOR parity vector from N sources, runs baseline version.
+ * @param vects Number of source+dest vectors in array.
+ * @param len Length of each vector in bytes.
+ * @param array Array of pointers to source and dest. For XOR the dest is
+ * the last pointer. ie array[vects-1]. Src and dest pointers
+ * must be aligned to 32B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int xor_gen_base(int vects, int len, void **array);
+
+
+/**
+ * @brief Checks that array has XOR parity sum of 0 across all vectors, runs baseline version.
+ *
+ * @param vects Number of vectors in array.
+ * @param len Length of each vector in bytes.
+ * @param array Array of pointers to vectors. Src and dest pointers
+ * must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int xor_check_base(int vects, int len, void **array);
+
+
+/**
+ * @brief Checks that array of N sources, P and Q are consistent across all vectors, runs baseline version.
+ *
+ * @param vects Number of vectors in array including P&Q.
+ * @param len Length of each vector in bytes. Must be 16B aligned.
+ * @param array Array of pointers to source and P, Q. P and Q parity
+ * are assumed to be the last two pointers in the array.
+ * All pointers must be aligned to 16B.
+ *
+ * @returns 0 pass, other fail
+ */
+
+int pq_check_base(int vects, int len, void **array);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif //_RAID_H_