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
15extern 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
31typedef uint8_t  u8;
32typedef uint16_t u16;
33typedef uint32_t u32;
34typedef 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
42extern 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 */
71struct 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 */
80extern struct raid6_calls raid6_call;
81
82/* Various routine sets */
83extern const struct raid6_calls raid6_intx1;
84extern const struct raid6_calls raid6_intx2;
85extern const struct raid6_calls raid6_intx4;
86extern const struct raid6_calls raid6_intx8;
87extern const struct raid6_calls raid6_mmxx1;
88extern const struct raid6_calls raid6_mmxx2;
89extern const struct raid6_calls raid6_sse1x1;
90extern const struct raid6_calls raid6_sse1x2;
91extern const struct raid6_calls raid6_sse2x1;
92extern const struct raid6_calls raid6_sse2x2;
93extern const struct raid6_calls raid6_sse2x4;
94extern const struct raid6_calls raid6_altivec1;
95extern const struct raid6_calls raid6_altivec2;
96extern const struct raid6_calls raid6_altivec4;
97extern const struct raid6_calls raid6_altivec8;
98extern const struct raid6_calls raid6_avx2x1;
99extern const struct raid6_calls raid6_avx2x2;
100extern const struct raid6_calls raid6_avx2x4;
101extern const struct raid6_calls raid6_avx512x1;
102extern const struct raid6_calls raid6_avx512x2;
103extern const struct raid6_calls raid6_avx512x4;
104extern const struct raid6_calls raid6_s390vx8;
105extern const struct raid6_calls raid6_vpermxor1;
106extern const struct raid6_calls raid6_vpermxor2;
107extern const struct raid6_calls raid6_vpermxor4;
108extern const struct raid6_calls raid6_vpermxor8;
109extern const struct raid6_calls raid6_lsx;
110extern const struct raid6_calls raid6_lasx;
111
112struct 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
120extern const struct raid6_recov_calls raid6_recov_intx1;
121extern const struct raid6_recov_calls raid6_recov_ssse3;
122extern const struct raid6_recov_calls raid6_recov_avx2;
123extern const struct raid6_recov_calls raid6_recov_avx512;
124extern const struct raid6_recov_calls raid6_recov_s390xc;
125extern const struct raid6_recov_calls raid6_recov_neon;
126extern const struct raid6_recov_calls raid6_recov_lsx;
127extern const struct raid6_recov_calls raid6_recov_lasx;
128
129extern const struct raid6_calls raid6_neonx1;
130extern const struct raid6_calls raid6_neonx2;
131extern const struct raid6_calls raid6_neonx4;
132extern const struct raid6_calls raid6_neonx8;
133
134/* Algorithm list */
135extern const struct raid6_calls * const raid6_algos[];
136extern const struct raid6_recov_calls *const raid6_recov_algos[];
137int 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 */
146extern const u8 raid6_gfmul[256][256] __attribute__((aligned(256)));
147extern const u8 raid6_vgfmul[256][32] __attribute__((aligned(256)));
148extern const u8 raid6_gfexp[256]      __attribute__((aligned(256)));
149extern const u8 raid6_gflog[256]      __attribute__((aligned(256)));
150extern const u8 raid6_gfinv[256]      __attribute__((aligned(256)));
151extern const u8 raid6_gfexi[256]      __attribute__((aligned(256)));
152
153/* Recovery routines */
154extern void (*raid6_2data_recov)(int disks, size_t bytes, int faila, int failb,
155		       void **ptrs);
156extern void (*raid6_datap_recov)(int disks, size_t bytes, int faila,
157			void **ptrs);
158void 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
175static inline void cpu_relax(void)
176{
177	/* Nothing */
178}
179
180#undef  HZ
181#define HZ 1000
182static 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