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

#ifndef __RAID_H
#define __RAID_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 polynomial affects both correctness and performance:
 * all tables, coefficients, and parity data are tied to a specific
 * polynomial and cannot be mixed.
 *
 * 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. Choosing this polynomial ensures
 *   on-disk compatibility with existing RAID arrays and interchange with
 *   other RAID implementations. Use this when reading or writing data
 *   that may be accessed by other software or hardware RAID controllers.
 *
 * 0x1b  (x^8 + x^4 + x^3 + x + 1)    -- AES polynomial
 *
 *   The polynomial used by the AES encryption standard. Choosing this
 *   polynomial enables the use of the Intel GFNI (Galois Field New
 *   Instructions) extension, specifically the vgf2p8mulb instruction,
 *   which performs GF(2^8) multiplication natively in hardware using
 *   exactly this polynomial. This eliminates the nibble-split pshufb
 *   multiply sequence (vpsrlw + vpandq + 2x vpshufb + vpxorq) and the
 *   conditional multiply-by-2 sequence (vpcmpgtb + vpmovm2b + vpaddb +
 *   vpandq + vpxorq) used in the AVX-512BW path, replacing each with a
 *   single vgf2p8mulb instruction. On CPUs supporting GFNI (Ice Lake and
 *   later), this yields a significant throughput improvement. The
 *   trade-off is that parity data is not compatible with arrays using
 *   the standard 0x1d polynomial, so this option requires that all
 *   data be generated and recovered using the same polynomial choice.
 */

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

/**
 * Default RAID mode supporting up to 6 parities using the standard polynomial 0x1d.
 *
 * Provides high performance on modern CPUs with SSSE3, AVX2, AVX-512, or NEON support.
 * Ensures maximum compatibility with standard Linux RAID arrays.
 *
 * 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.
 *
 * It has the same performance as RAID_MODE_CAUCHY_RAID on CPUs without GFNI,
 * but achieves significantly higher throughput on CPUs supporting GFNI hardware
 * acceleration.
 */
#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.
 *
 * The RAID system is initialized in the RAID_MODE_CAUCHY_RAID mode.
 */
void raid_init(void);

/**
 * Runs a basic functionality self test.
 *
 * The test is immediate, and it's intended to be run at application
 * startup to check the integrity of the RAID system.
 *
 * It returns 0 on success.
 */
int raid_selftest(void);

/**
 * Sets or queries the mode to use. One of RAID_MODE_*.
 *
 * 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.
 *
 * Returns the mode that was active prior to this call.
 */
int raid_mode(int mode);

/**
 * Sets the zero buffer to use during recovery.
 *
 * Before calling raid_rec() and raid_data() you must provide a memory
 * buffer filled with zeros of the same size as the blocks to recover.
 *
 * This buffer is only read and never written.
 */
void raid_zero(void *zero);

/**
 * 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.
 * @np Number of parity blocks to compute.
 * @size Size of the blocks pointed to by @v. It must be a multiple of 64.
 * @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 blocks are only read and not modified. Parity blocks are written.
 *   Each block has @size bytes.
 */
void raid_gen(int nd, int np, size_t size, void **v);

/**
 * 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.
 * @ir[] Vector of @nr indexes of the failed data and parity blocks.
 *   The indexes start from 0. They must be 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.
 * @np Number of parity blocks.
 * @size Size of the blocks pointed by @v. It must be a multiple of 64.
 * @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.
 */
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.
 * @id[] Vector of @nr indexes of the data blocks to recover.
 *   The indexes start from 0. They must be in order.
 * @ip[] Vector of @nr indexes of the parity blocks to use for recovery.
 *   The indexes start from 0. They must be in order.
 * @nd Number of data blocks.
 * @size Size of the blocks pointed to by @v. It must be a multiple of 64.
 * @v Vector of pointers to the blocks of data and parity.
 *   It has (@nd + @ip[@nr - 1] + 1) elements. The starting elements are the
 *   blocks for data, following with the parity blocks.
 *   Each block has @size bytes.
 */
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.
 * @ir[] Vector of @nr indexes of the failed data and parity blocks.
 *   The indexes start from 0. They must be 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.
 * @np Number of parity blocks.
 * @size Size of the blocks pointed by @v. It must be a multiple of 64.
 * @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.
 * @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 identifies the failed data and parity blocks using the
 * available redundancy.
 *
 * It uses a brute force method, and then the call can be expensive.
 * 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.
 * @np Number of parity blocks.
 * @size Size of the blocks pointed by @v. It must be a multiple of 64.
 * @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.
 * @return Number of block indexes returned in the @ir vector.
 *   0 if no error is detected.
 *   -1 if it's not possible to identify the failed disks.
 */
int raid_scan(int *ir, int nd, int np, size_t size, void **v);

#endif