xref: /linux/include/linux/raid/pq.h (revision 0074281bb6316108e0cff094bd4db78ab3eee236)
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 #include <linux/mm.h>
15 
16 /* This should be const but the raid6 code is too convoluted for that. */
raid6_get_zero_page(void)17 static inline void *raid6_get_zero_page(void)
18 {
19 	return page_address(ZERO_PAGE(0));
20 }
21 
22 #else /* ! __KERNEL__ */
23 /* Used for testing in user space */
24 
25 #include <errno.h>
26 #include <inttypes.h>
27 #include <stddef.h>
28 #include <string.h>
29 #include <sys/mman.h>
30 #include <sys/time.h>
31 #include <sys/types.h>
32 
33 /* Not standard, but glibc defines it */
34 #define BITS_PER_LONG __WORDSIZE
35 
36 typedef uint8_t  u8;
37 typedef uint16_t u16;
38 typedef uint32_t u32;
39 typedef uint64_t u64;
40 
41 #ifndef PAGE_SIZE
42 # define PAGE_SIZE 4096
43 #endif
44 #ifndef PAGE_SHIFT
45 # define PAGE_SHIFT 12
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 #undef	EXPORT_SYMBOL
63 #define EXPORT_SYMBOL(sym)
64 #undef	EXPORT_SYMBOL_GPL
65 #define EXPORT_SYMBOL_GPL(sym)
66 #define MODULE_LICENSE(licence)
67 #define MODULE_DESCRIPTION(desc)
68 #define subsys_initcall(x)
69 #define module_exit(x)
70 
71 #define IS_ENABLED(x) (x)
72 #define CONFIG_RAID6_PQ_BENCHMARK 1
73 #endif /* __KERNEL__ */
74 
75 /* Routine choices */
76 struct raid6_calls {
77 	void (*gen_syndrome)(int, size_t, void **);
78 	void (*xor_syndrome)(int, int, int, size_t, void **);
79 	int  (*valid)(void);	/* Returns 1 if this routine set is usable */
80 	const char *name;	/* Name of this routine set */
81 	int priority;		/* Relative priority ranking if non-zero */
82 };
83 
84 /* Selected algorithm */
85 extern struct raid6_calls raid6_call;
86 
87 /* Various routine sets */
88 extern const struct raid6_calls raid6_intx1;
89 extern const struct raid6_calls raid6_intx2;
90 extern const struct raid6_calls raid6_intx4;
91 extern const struct raid6_calls raid6_intx8;
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 extern const struct raid6_calls raid6_lsx;
115 extern const struct raid6_calls raid6_lasx;
116 extern const struct raid6_calls raid6_rvvx1;
117 extern const struct raid6_calls raid6_rvvx2;
118 extern const struct raid6_calls raid6_rvvx4;
119 extern const struct raid6_calls raid6_rvvx8;
120 
121 struct raid6_recov_calls {
122 	void (*data2)(int, size_t, int, int, void **);
123 	void (*datap)(int, size_t, int, void **);
124 	int  (*valid)(void);
125 	const char *name;
126 	int priority;
127 };
128 
129 extern const struct raid6_recov_calls raid6_recov_intx1;
130 extern const struct raid6_recov_calls raid6_recov_ssse3;
131 extern const struct raid6_recov_calls raid6_recov_avx2;
132 extern const struct raid6_recov_calls raid6_recov_avx512;
133 extern const struct raid6_recov_calls raid6_recov_s390xc;
134 extern const struct raid6_recov_calls raid6_recov_neon;
135 extern const struct raid6_recov_calls raid6_recov_lsx;
136 extern const struct raid6_recov_calls raid6_recov_lasx;
137 extern const struct raid6_recov_calls raid6_recov_rvv;
138 
139 extern const struct raid6_calls raid6_neonx1;
140 extern const struct raid6_calls raid6_neonx2;
141 extern const struct raid6_calls raid6_neonx4;
142 extern const struct raid6_calls raid6_neonx8;
143 
144 /* Algorithm list */
145 extern const struct raid6_calls * const raid6_algos[];
146 extern const struct raid6_recov_calls *const raid6_recov_algos[];
147 int raid6_select_algo(void);
148 
149 /* Return values from chk_syndrome */
150 #define RAID6_OK	0
151 #define RAID6_P_BAD	1
152 #define RAID6_Q_BAD	2
153 #define RAID6_PQ_BAD	3
154 
155 /* Galois field tables */
156 extern const u8 raid6_gfmul[256][256] __attribute__((aligned(256)));
157 extern const u8 raid6_vgfmul[256][32] __attribute__((aligned(256)));
158 extern const u8 raid6_gfexp[256]      __attribute__((aligned(256)));
159 extern const u8 raid6_gflog[256]      __attribute__((aligned(256)));
160 extern const u8 raid6_gfinv[256]      __attribute__((aligned(256)));
161 extern const u8 raid6_gfexi[256]      __attribute__((aligned(256)));
162 
163 /* Recovery routines */
164 extern void (*raid6_2data_recov)(int disks, size_t bytes, int faila, int failb,
165 		       void **ptrs);
166 extern void (*raid6_datap_recov)(int disks, size_t bytes, int faila,
167 			void **ptrs);
168 void raid6_dual_recov(int disks, size_t bytes, int faila, int failb,
169 		      void **ptrs);
170 
171 /* Some definitions to allow code to be compiled for testing in userspace */
172 #ifndef __KERNEL__
173 
174 # define jiffies	raid6_jiffies()
175 # define printk 	printf
176 # define pr_err(format, ...) fprintf(stderr, format, ## __VA_ARGS__)
177 # define pr_info(format, ...) fprintf(stdout, format, ## __VA_ARGS__)
178 # define GFP_KERNEL	0
179 # define __get_free_pages(x, y)	((unsigned long)mmap(NULL, PAGE_SIZE << (y), \
180 						     PROT_READ|PROT_WRITE,   \
181 						     MAP_PRIVATE|MAP_ANONYMOUS,\
182 						     0, 0))
183 # define free_pages(x, y)	munmap((void *)(x), PAGE_SIZE << (y))
184 
cpu_relax(void)185 static inline void cpu_relax(void)
186 {
187 	/* Nothing */
188 }
189 
190 #undef  HZ
191 #define HZ 1000
raid6_jiffies(void)192 static inline uint32_t raid6_jiffies(void)
193 {
194 	struct timeval tv;
195 	gettimeofday(&tv, NULL);
196 	return tv.tv_sec*1000 + tv.tv_usec/1000;
197 }
198 
raid6_get_zero_page(void)199 static inline void *raid6_get_zero_page(void)
200 {
201 	return raid6_empty_zero_page;
202 }
203 
204 #endif /* ! __KERNEL__ */
205 
206 #endif /* LINUX_RAID_RAID6_H */
207