// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright (C) 2013 Andrea Mazzoleni

#ifndef __RAID_H
#define __RAID_H

#include <stddef.h>

/*
 * GF(2^8) reducing polynomial selection.
 *
 * RAID parity computation operates in GF(2^8), a finite field where
 * arithmetic is performed modulo an irreducible polynomial of degree 8.
 * The choice of operating mode affects both correctness and performance:
 * all tables, coefficients, and parity data are tied to the selected
 * polynomial and primitive generator and cannot be mixed between
 * incompatible operating modes.
 *
 * Two polynomials are supported:
 *
 * 0x1d  (x^8 + x^4 + x^3 + x^2 + 1)  -- Standard RAID polynomial
 *
 *   The polynomial used by the original RAID-6 specification and the
 *   Linux kernel RAID implementation, used with primitive generator g=2.
 *   For identically ordered data blocks, the generated P/Q syndrome bytes
 *   match the Linux RAID6 implementation.
 *
 *   On CPUs supporting Intel GFNI (Galois Field New Instructions),
 *   generation and recovery are accelerated with vgf2p8affineqb.
 *   Multiplication by each GF(2^8) coefficient is represented as a
 *   precomputed GF(2) 8x8 affine matrix for the 0x11d field.
 *
 * 0x1b  (x^8 + x^4 + x^3 + x + 1)    -- AES polynomial
 *
 *   The polynomial used by the AES encryption standard (0x11b including
 *   the x^8 term), used with primitive generator g=3.
 *
 *   On CPUs supporting Intel GFNI, generation and recovery can use the
 *   vgf2p8mulb instruction, which performs GF(2^8) multiplication directly
 *   using this polynomial.
 *
 *   This mode also provides a useful comparison with
 *   RAID_MODE_CAUCHY_RAID, where multiplication by a fixed coefficient in
 *   GF(2^8)/0x11d is implemented directly with vgf2p8affineqb and a
 *   precomputed 8x8 GF(2) matrix. Relative performance depends on the CPU,
 *   backend, parity count, and workload.
 *
 *   The trade-off is that parity data is not compatible with arrays using
 *   the standard 0x11d polynomial (g=2), so all data must be generated and
 *   recovered using the same operating mode.
 *
 * Both Cauchy modes can therefore use GFNI acceleration. The standard RAID
 * mode uses affine transformations for fixed-coefficient multiplication in
 * the 0x11d field, while the AES mode can use native vgf2p8mulb
 * multiplication in the 0x11b field.
 */

/**
 * Special mode code used to query the active mode.
 */
#define RAID_MODE_GET -1

/**
 * Default RAID mode supporting up to 6 parities using standard polynomial 0x1d and generator g=2.
 *
 * Provides high performance on modern CPUs with SSSE3, AVX2, AVX-512, GFNI, or NEON support.
 * On GFNI CPUs, the standard RAID field is accelerated using affine transformations.
 * Uses Linux RAID6-compatible P/Q coefficients.
 *
 * This is the default mode set after calling raid_init().
 */
#define RAID_MODE_CAUCHY_RAID 0

/**
 * Legacy RAID mode supporting up to 3 parities using standard polynomial 0x1d.
 *
 * Uses Vandermonde matrix coefficients for triple parity (Z parity), which allows
 * efficient 3-parity generation on older/low-end CPUs without SSSE3 or NEON.
 *
 * It cannot be used for arrays with more than 3 parities.
 */
#define RAID_MODE_VANDERMONDE_RAID 1

/**
 * RAID mode supporting up to 6 parities using AES polynomial 0x1b (0x11b)
 * and primitive generator g=3.
 *
 * It has slightly lower performance than RAID_MODE_CAUCHY_RAID on CPUs
 * without GFNI due to the additional cost of generator g=3.
 *
 * On CPUs supporting GFNI, it uses native VGF2P8MULB multiplication. This
 * mode also provides a useful benchmark and reference implementation for
 * comparing native AES-field GFNI multiplication with the affine GFNI
 * implementation used by RAID_MODE_CAUCHY_RAID. Relative performance
 * depends on the CPU, backend, parity count, and workload.
 *
 * Parity data is incompatible with RAID_MODE_CAUCHY_RAID.
 */
#define RAID_MODE_CAUCHY_AES 2

/**
 * Maximum number of parity disks supported.
 */
#define RAID_PARITY_MAX 6

/**
 * Maximum number of data disks supported.
 */
#define RAID_DATA_MAX 251

/**
 * Initializes the RAID system.
 *
 * You must call this function before any other RAID function.
 *
 * After selecting the RAID mode to use, raid_selftest() should be called
 * before using the RAID system.
 *
 * Initialization modifies global RAID state and must not be called
 * concurrently with any other RAID function.
 *
 * The RAID system is initialized in the RAID_MODE_CAUCHY_RAID mode.
 */
void raid_init(void);

/**
 * Sets or queries the mode to use. One of RAID_MODE_*.
 *
 * The selected mode is global to the RAID library and affects all subsequent
 * generation, recovery, validation, and scanning operations.
 *
 * Passing RAID_MODE_GET (-1) queries the current active mode without changing it.
 * Passing a valid mode (RAID_MODE_CAUCHY_RAID, RAID_MODE_VANDERMONDE_RAID,
 * RAID_MODE_CAUCHY_AES) sets the mode.
 *
 * Changing the mode modifies global RAID state. raid_mode() must not be called
 * concurrently with any other RAID function.
 *
 * Returns the mode that was active prior to this call.
 */
int raid_mode(int mode);

/**
 * Runs a basic functionality self test.
 *
 * raid_init() must be called before this function.
 *
 * The RAID mode to use must be selected before calling this function.
 * raid_init() selects RAID_MODE_CAUCHY_RAID by default; raid_mode() may be
 * used to select a different mode. The self test verifies only the currently
 * selected RAID mode.
 *
 * The test is immediate and is intended to be run at every application
 * startup after the RAID mode has been selected. It verifies the RAID
 * implementation selected for the current mode, CPU, compiler, and ABI
 * before it is used.
 *
 * If the RAID mode is changed later, this function should be called again
 * before using the new mode.
 *
 * The test modifies global RAID state and must not be called concurrently
 * with any other RAID function.
 *
 * It returns 0 on success.
 */
int raid_selftest(void);

/**
 * Block aliasing
 *
 * In raid_gen(), block pointers passed through @v may alias the same block
 * buffer. Blocks are processed from lower to higher offsets. For each
 * processed byte or vector chunk, all required inputs are read before
 * outputs are written. Parity outputs are written in increasing parity
 * order.
 *
 * If multiple parity outputs alias the same block, the value of the last
 * parity written remains in that block.
 *
 * In raid_rec() and raid_data(), each block being recovered must have a
 * distinct destination buffer that does not alias any other block in @v.
 *
 * Arbitrary partial overlap between different block ranges is not supported.
 */

/**
 * Computes parity blocks.
 *
 * This function computes the specified number of parity blocks of the
 * provided set of data blocks.
 *
 * Each parity block allows to recover one data block.
 *
 * @nd Number of data blocks. It must be between 1 and RAID_DATA_MAX.
 * @np Number of parity blocks to compute. It must be between 1 and
 *   RAID_PARITY_MAX. RAID_MODE_VANDERMONDE_RAID supports at most 3.
 * @size Size of the blocks pointed to by @v. It must be a multiple of 64.
 *   It may be 0, in which case no block data is read or written.
 * @v Vector of pointers to the blocks of data and parity.
 *   It has (@nd + @np) elements. The starting elements are the blocks for
 *   data, following with the parity blocks.
 *   Data entries are used only for reading and may reference read-only memory.
 *   Parity entries are outputs and must reference writable memory.
 *   Entries may point to the same block buffer.
 *   Each block has @size bytes and must be aligned to a 64-byte boundary.
 * @streaming Store policy hint: 1 for streaming / non-temporal stores
 *   (bypassing cache) where supported, or 0 for normal cached / temporal stores.
 *   No other values are valid.
 *   Use 1 when generated output will not be read immediately by the CPU
 *   (e.g., parity queued for disk writes during sync), avoiding cache pollution.
 *   Use 0 when output will be consumed immediately by the CPU (e.g., in-memory
 *   parity verification or single-disk data recovery).
 *   Both modes produce bit-identical parity data. Backends without streaming
 *   stores ignore this hint.
 */
void raid_gen(int nd, int np, size_t size, void **v, int streaming);

/**
 * Recovers failures in data and parity blocks.
 *
 * This function recovers all the data and parity blocks marked as bad
 * in the @ir vector.
 *
 * Ensure @nr <= @np, otherwise recovery is not possible.
 *
 * The parity blocks used for recovery are automatically selected from
 * the ones NOT present in the @ir vector.
 *
 * In case there are more parity blocks than needed, the parities at lower
 * indexes are used for recovery, and the others are ignored.
 *
 * Note that no internal integrity check is done when recovering. If the
 * provided parities are correct, the resulting data will be correct.
 * If parities are wrong, the resulting recovered data will be wrong.
 * This happens even in the case you have more parity blocks than needed,
 * and some form of integrity verification would be possible.
 *
 * @nr Number of failed data and parity blocks to recover. It must be
 *   between 0 and @np.
 * @ir[] Vector of @nr indexes of the failed data and parity blocks.
 *   The indexes start from 0. They must be in order.
 *   All indexes must be nonnegative and smaller than @nd + @np.
 *   The first parity is represented with value @nd, the second with value
 *   @nd + 1, just like positions in the @v vector.
 *   It may be 0 if @nr is 0.
 * @nd Number of data blocks. It must be between 1 and RAID_DATA_MAX.
 * @np Number of parity blocks. It must be between 1 and RAID_PARITY_MAX.
 *   RAID_MODE_VANDERMONDE_RAID supports at most 3.
 * @size Size of the blocks pointed by @v. It must be a multiple of 64.
 *   It may be 0, in which case no block data is read or written.
 * @v Vector of pointers to the blocks of data and parity.
 *   If @nr is greater than 0, it has (@nd + @np) elements. The starting
 *   elements are the blocks for data, followed by the parity blocks.
 *   If @nr is 0, @v must be nonzero but no block pointers are accessed.
 *   Each block being recovered must have a distinct destination buffer
 *   that does not alias any other block in this vector.
 *   Each block has @size bytes and must be aligned to a 64-byte boundary.
 */
void raid_rec(int nr, int *ir, int nd, int np, size_t size, void **v);

/**
 * Recovers failures in data blocks only.
 *
 * This function recovers all the data blocks marked as bad in the @id vector.
 * The parity blocks are not modified.
 *
 * @nr Number of failed data blocks to recover. It must be nonnegative,
 *   not greater than @nd, and not greater than RAID_PARITY_MAX.
 * @id[] Vector of @nr indexes of the data blocks to recover.
 *   The indexes start from 0. They must be in order.
 *   All indexes must be nonnegative and smaller than @nd.
 *   It may be 0 if @nr is 0.
 * @ip[] Vector of @nr indexes of the parity blocks to use for recovery.
 *   The indexes start from 0. They must be in order.
 *   All indexes must be nonnegative and smaller than RAID_PARITY_MAX.
 *   In RAID_MODE_VANDERMONDE_RAID they must be smaller than 3.
 *   It may be 0 if @nr is 0.
 * @nd Number of data blocks. It must be between 1 and RAID_DATA_MAX.
 * @size Size of the blocks pointed to by @v. It must be a multiple of 64.
 *   It may be 0, in which case no block data is read or written.
 * @v Vector of pointers to the blocks of data and parity.
 *   If @nr is greater than 0, it has (@nd + @ip[@nr - 1] + 1) elements.
 *   The starting elements are the blocks for data, followed by the parity
 *   blocks. If @nr is 0, @v must be nonzero but no block pointers are accessed.
 *   Each data block being recovered must have a distinct destination buffer
 *   that does not alias any other block in this vector.
 *   Each block has @size bytes and must be aligned to a 64-byte boundary.
 */
void raid_data(int nr, int *id, int *ip, int nd, size_t size, void **v);

/**
 * Check the provided failed blocks combination.
 *
 * This function checks if the specified failed blocks combination satisfies
 * the redundancy information. A combination is assumed matching, if the
 * remaining valid parity matches the expected value after recovery.
 *
 * The number of failed blocks @nr must be strictly less than the number of
 * parities @np, because you need one more parity to validate recovery.
 *
 * No data or parity blocks are modified.
 *
 * @nr Number of failed data and parity blocks. It must be nonnegative and
 *   strictly smaller than @np.
 * @ir[] Vector of @nr indexes of the failed data and parity blocks.
 *   The indexes start from 0. They must be in order.
 *   All indexes must be nonnegative and smaller than @nd + @np.
 *   The first parity is represented with value @nd, the second with value
 *   @nd + 1, just like positions in the @v vector.
 *   It may be 0 if @nr is 0.
 * @nd Number of data blocks. It must be between 1 and RAID_DATA_MAX.
 * @np Number of parity blocks. It must be between 1 and RAID_PARITY_MAX.
 *   RAID_MODE_VANDERMONDE_RAID supports at most 3.
 * @size Size of the blocks pointed by @v. It must be a multiple of 64.
 *   If it is 0, the function returns -1 because no redundancy data is
 *   available for validation.
 * @v Vector of pointers to the blocks of data and parity.
 *   It has (@nd + @np) elements. The starting elements are the blocks
 *   for data, following with the parity blocks.
 *   Each block has @size bytes and must be aligned to a 64-byte boundary.
 * @return 0 if the check is satisfied. -1 otherwise.
 */
int raid_check(int nr, int *ir, int nd, int np, size_t size, void **v);

/**
 * Scan for failed blocks.
 *
 * This function searches for a set of failed data and parity blocks
 * compatible with the available redundancy.
 *
 * It first checks for no failures, and then tries candidate combinations
 * with an increasing number of failures, from 1 up to @np - 1. The first
 * combination satisfying the redundancy information is returned.
 *
 * If multiple combinations satisfy the redundancy information, only the
 * first one encountered is returned. This function does not check that the
 * returned combination is unique.
 *
 * This function is primarily intended as a reference implementation and to
 * demonstrate how raid_check() can be used to locate failed blocks. It uses
 * an exhaustive brute force search and is not intended for production use.
 *
 * The expected execution time is proportional to the binomial coefficient
 * @np + @nd choose @np - 1, usually written as:
 *
 * ( @np + @nd )
 * (           )
 * (  @np - 1  )
 *
 * No data or parity blocks are modified.
 *
 * The failed block indexes are returned in the @ir vector.
 * It must have space for at least @np - 1 values.
 *
 * The returned @ir vector can then be used in a raid_rec() call to recover
 * the failed data and parity blocks.
 *
 * @ir[] Vector filled with the indexes of the failed data and parity blocks.
 *   The indexes start from 0 and they are in order.
 *   The first parity is represented with value @nd, the second with value
 *   @nd + 1, just like positions in the @v vector.
 * @nd Number of data blocks. It must be between 1 and RAID_DATA_MAX.
 * @np Number of parity blocks. It must be between 0 and RAID_PARITY_MAX.
 *   RAID_MODE_VANDERMONDE_RAID supports at most 3.
 * @size Size of the blocks pointed by @v. It must be a multiple of 64.
 *   If it is 0, the function returns -1 because no redundancy data is
 *   available for validation.
 * @v Vector of pointers to the blocks of data and parity.
 *   It has (@nd + @np) elements. The starting elements are the blocks
 *   for data, following with the parity blocks.
 *   Each block has @size bytes and must be aligned to a 64-byte boundary.
 * @return Number of block indexes returned in the @ir vector.
 *   0 if no error is detected.
 *   -1 if no compatible combination with fewer than @np failures is found.
 */
int raid_scan(int *ir, int nd, int np, size_t size, void **v);

#endif