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