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
27extern 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
43typedef uint8_t  u8;
44typedef uint16_t u16;
45typedef uint32_t u32;
46typedef uint64_t u64;
47
48#ifndef PAGE_SIZE
49# define PAGE_SIZE 4096
50#endif
51extern 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 */
73struct 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 */
82extern struct raid6_calls raid6_call;
83
84/* Various routine sets */
85extern const struct raid6_calls raid6_intx1;
86extern const struct raid6_calls raid6_intx2;
87extern const struct raid6_calls raid6_intx4;
88extern const struct raid6_calls raid6_intx8;
89extern const struct raid6_calls raid6_intx16;
90extern const struct raid6_calls raid6_intx32;
91extern const struct raid6_calls raid6_mmxx1;
92extern const struct raid6_calls raid6_mmxx2;
93extern const struct raid6_calls raid6_sse1x1;
94extern const struct raid6_calls raid6_sse1x2;
95extern const struct raid6_calls raid6_sse2x1;
96extern const struct raid6_calls raid6_sse2x2;
97extern const struct raid6_calls raid6_sse2x4;
98extern const struct raid6_calls raid6_altivec1;
99extern const struct raid6_calls raid6_altivec2;
100extern const struct raid6_calls raid6_altivec4;
101extern const struct raid6_calls raid6_altivec8;
102extern const struct raid6_calls raid6_avx2x1;
103extern const struct raid6_calls raid6_avx2x2;
104extern const struct raid6_calls raid6_avx2x4;
105extern const struct raid6_calls raid6_tilegx8;
106
107struct raid6_recov_calls {
108	void (*data2)(int, size_t, int, int, void **);
109	void (*datap)(int, size_t, int, void **);
110	int  (*valid)(void);
111	const char *name;
112	int priority;
113};
114
115extern const struct raid6_recov_calls raid6_recov_intx1;
116extern const struct raid6_recov_calls raid6_recov_ssse3;
117extern const struct raid6_recov_calls raid6_recov_avx2;
118
119extern const struct raid6_calls raid6_neonx1;
120extern const struct raid6_calls raid6_neonx2;
121extern const struct raid6_calls raid6_neonx4;
122extern const struct raid6_calls raid6_neonx8;
123
124/* Algorithm list */
125extern const struct raid6_calls * const raid6_algos[];
126extern const struct raid6_recov_calls *const raid6_recov_algos[];
127int raid6_select_algo(void);
128
129/* Return values from chk_syndrome */
130#define RAID6_OK	0
131#define RAID6_P_BAD	1
132#define RAID6_Q_BAD	2
133#define RAID6_PQ_BAD	3
134
135/* Galois field tables */
136extern const u8 raid6_gfmul[256][256] __attribute__((aligned(256)));
137extern const u8 raid6_vgfmul[256][32] __attribute__((aligned(256)));
138extern const u8 raid6_gfexp[256]      __attribute__((aligned(256)));
139extern const u8 raid6_gfinv[256]      __attribute__((aligned(256)));
140extern const u8 raid6_gfexi[256]      __attribute__((aligned(256)));
141
142/* Recovery routines */
143extern void (*raid6_2data_recov)(int disks, size_t bytes, int faila, int failb,
144		       void **ptrs);
145extern void (*raid6_datap_recov)(int disks, size_t bytes, int faila,
146			void **ptrs);
147void raid6_dual_recov(int disks, size_t bytes, int faila, int failb,
148		      void **ptrs);
149
150/* Some definitions to allow code to be compiled for testing in userspace */
151#ifndef __KERNEL__
152
153# define jiffies	raid6_jiffies()
154# define printk 	printf
155# define GFP_KERNEL	0
156# define __get_free_pages(x, y)	((unsigned long)mmap(NULL, PAGE_SIZE << (y), \
157						     PROT_READ|PROT_WRITE,   \
158						     MAP_PRIVATE|MAP_ANONYMOUS,\
159						     0, 0))
160# define free_pages(x, y)	munmap((void *)(x), PAGE_SIZE << (y))
161
162static inline void cpu_relax(void)
163{
164	/* Nothing */
165}
166
167#undef  HZ
168#define HZ 1000
169static inline uint32_t raid6_jiffies(void)
170{
171	struct timeval tv;
172	gettimeofday(&tv, NULL);
173	return tv.tv_sec*1000 + tv.tv_usec/1000;
174}
175
176#endif /* ! __KERNEL__ */
177
178#endif /* LINUX_RAID_RAID6_H */
179