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