include/linux/raid/pq.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /* -*- linux-c -*- ------------------------------------------------------- *
   3  *
   4  *   Copyright 2003 H. Peter Anvin - All Rights Reserved
   5  *
   6  * ----------------------------------------------------------------------- */
   7
   8 #ifndef LINUX_RAID_RAID6_H
   9 #define LINUX_RAID_RAID6_H
  10
  11 #ifdef __KERNEL__
  12
  13 #include <linux/blkdev.h>
  14
  15 extern const char raid6_empty_zero_page[PAGE_SIZE];
  16
  17 #else /* ! __KERNEL__ */
  18 /* Used for testing in user space */
  19
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <stddef.h>
  23 #include <string.h>
  24 #include <sys/mman.h>
  25 #include <sys/time.h>
  26 #include <sys/types.h>
  27
  28 /* Not standard, but glibc defines it */
  29 #define BITS_PER_LONG __WORDSIZE
  30
  31 typedef uint8_t  u8;
  32 typedef uint16_t u16;
  33 typedef uint32_t u32;
  34 typedef uint64_t u64;
  35
  36 #ifndef PAGE_SIZE
  37 # define PAGE_SIZE 4096
  38 #endif
  39 #ifndef PAGE_SHIFT
  40 # define PAGE_SHIFT 12
  41 #endif
  42 extern const char raid6_empty_zero_page[PAGE_SIZE];
  43
  44 #define __init
  45 #define __exit
  46 #ifndef __attribute_const__
  47 # define __attribute_const__ __attribute__((const))
  48 #endif
  49 #define noinline __attribute__((noinline))
  50
  51 #define preempt_enable()
  52 #define preempt_disable()
  53 #define cpu_has_feature(x) 1
  54 #define enable_kernel_altivec()
  55 #define disable_kernel_altivec()
  56
  57 #undef  EXPORT_SYMBOL
  58 #define EXPORT_SYMBOL(sym)
  59 #undef  EXPORT_SYMBOL_GPL
  60 #define EXPORT_SYMBOL_GPL(sym)
  61 #define MODULE_LICENSE(licence)
  62 #define MODULE_DESCRIPTION(desc)
  63 #define subsys_initcall(x)
  64 #define module_exit(x)
  65
  66 #define IS_ENABLED(x) (x)
  67 #define CONFIG_RAID6_PQ_BENCHMARK 1
  68 #endif /* __KERNEL__ */
  69
  70 /* Routine choices */
  71 struct raid6_calls {
  72         void (*gen_syndrome)(int, size_t, void **);
  73         void (*xor_syndrome)(int, int, int, size_t, void **);
  74         int  (*valid)(void);    /* Returns 1 if this routine set is usable */
  75         const char *name;       /* Name of this routine set */
  76         int priority;           /* Relative priority ranking if non-zero */
  77 };
  78
  79 /* Selected algorithm */
  80 extern struct raid6_calls raid6_call;
  81
  82 /* Various routine sets */
  83 extern const struct raid6_calls raid6_intx1;
  84 extern const struct raid6_calls raid6_intx2;
  85 extern const struct raid6_calls raid6_intx4;
  86 extern const struct raid6_calls raid6_intx8;
  87 extern const struct raid6_calls raid6_intx16;
  88 extern const struct raid6_calls raid6_intx32;
  89 extern const struct raid6_calls raid6_mmxx1;
  90 extern const struct raid6_calls raid6_mmxx2;
  91 extern const struct raid6_calls raid6_sse1x1;
  92 extern const struct raid6_calls raid6_sse1x2;
  93 extern const struct raid6_calls raid6_sse2x1;
  94 extern const struct raid6_calls raid6_sse2x2;
  95 extern const struct raid6_calls raid6_sse2x4;
  96 extern const struct raid6_calls raid6_altivec1;
  97 extern const struct raid6_calls raid6_altivec2;
  98 extern const struct raid6_calls raid6_altivec4;
  99 extern const struct raid6_calls raid6_altivec8;
 100 extern const struct raid6_calls raid6_avx2x1;
 101 extern const struct raid6_calls raid6_avx2x2;
 102 extern const struct raid6_calls raid6_avx2x4;
 103 extern const struct raid6_calls raid6_avx512x1;
 104 extern const struct raid6_calls raid6_avx512x2;
 105 extern const struct raid6_calls raid6_avx512x4;
 106 extern const struct raid6_calls raid6_s390vx8;
 107 extern const struct raid6_calls raid6_vpermxor1;
 108 extern const struct raid6_calls raid6_vpermxor2;
 109 extern const struct raid6_calls raid6_vpermxor4;
 110 extern const struct raid6_calls raid6_vpermxor8;
 111
 112 struct raid6_recov_calls {
 113         void (*data2)(int, size_t, int, int, void **);
 114         void (*datap)(int, size_t, int, void **);
 115         int  (*valid)(void);
 116         const char *name;
 117         int priority;
 118 };
 119
 120 extern const struct raid6_recov_calls raid6_recov_intx1;
 121 extern const struct raid6_recov_calls raid6_recov_ssse3;
 122 extern const struct raid6_recov_calls raid6_recov_avx2;
 123 extern const struct raid6_recov_calls raid6_recov_avx512;
 124 extern const struct raid6_recov_calls raid6_recov_s390xc;
 125 extern const struct raid6_recov_calls raid6_recov_neon;
 126
 127 extern const struct raid6_calls raid6_neonx1;
 128 extern const struct raid6_calls raid6_neonx2;
 129 extern const struct raid6_calls raid6_neonx4;
 130 extern const struct raid6_calls raid6_neonx8;
 131
 132 /* Algorithm list */
 133 extern const struct raid6_calls * const raid6_algos[];
 134 extern const struct raid6_recov_calls *const raid6_recov_algos[];
 135 int raid6_select_algo(void);
 136
 137 /* Return values from chk_syndrome */
 138 #define RAID6_OK        0
 139 #define RAID6_P_BAD     1
 140 #define RAID6_Q_BAD     2
 141 #define RAID6_PQ_BAD    3
 142
 143 /* Galois field tables */
 144 extern const u8 raid6_gfmul[256][256] __attribute__((aligned(256)));
 145 extern const u8 raid6_vgfmul[256][32] __attribute__((aligned(256)));
 146 extern const u8 raid6_gfexp[256]      __attribute__((aligned(256)));
 147 extern const u8 raid6_gflog[256]      __attribute__((aligned(256)));
 148 extern const u8 raid6_gfinv[256]      __attribute__((aligned(256)));
 149 extern const u8 raid6_gfexi[256]      __attribute__((aligned(256)));
 150
 151 /* Recovery routines */
 152 extern void (*raid6_2data_recov)(int disks, size_t bytes, int faila, int failb,
 153                        void **ptrs);
 154 extern void (*raid6_datap_recov)(int disks, size_t bytes, int faila,
 155                         void **ptrs);
 156 void raid6_dual_recov(int disks, size_t bytes, int faila, int failb,
 157                       void **ptrs);
 158
 159 /* Some definitions to allow code to be compiled for testing in userspace */
 160 #ifndef __KERNEL__
 161
 162 # define jiffies        raid6_jiffies()
 163 # define printk         printf
 164 # define pr_err(format, ...) fprintf(stderr, format, ## __VA_ARGS__)
 165 # define pr_info(format, ...) fprintf(stdout, format, ## __VA_ARGS__)
 166 # define GFP_KERNEL     0
 167 # define __get_free_pages(x, y) ((unsigned long)mmap(NULL, PAGE_SIZE << (y), \
 168                                                      PROT_READ|PROT_WRITE,   \
 169                                                      MAP_PRIVATE|MAP_ANONYMOUS,\
 170                                                      0, 0))
 171 # define free_pages(x, y)       munmap((void *)(x), PAGE_SIZE << (y))
 172
 173 static inline void cpu_relax(void)
 174 {
 175         /* Nothing */
 176 }
 177
 178 #undef  HZ
 179 #define HZ 1000
 180 static inline uint32_t raid6_jiffies(void)
 181 {
 182         struct timeval tv;
 183         gettimeofday(&tv, NULL);
 184         return tv.tv_sec*1000 + tv.tv_usec/1000;
 185 }
 186
 187 #endif /* ! __KERNEL__ */
 188
 189 #endif /* LINUX_RAID_RAID6_H */