1 /*
2  * Implement fast Fletcher4 with SSE2,SSSE3 instructions. (x86)
3  *
4  * Use the 128-bit SSE2/SSSE3 SIMD instructions and registers to compute
5  * Fletcher4 in two incremental 64-bit parallel accumulator streams,
6  * and then combine the streams to form the final four checksum words.
7  * This implementation is a derivative of the AVX SIMD implementation by
8  * James Guilford and Jinshan Xiong from Intel (see zfs_fletcher_intel.c).
9  *
10  * Copyright (C) 2016 Tyler J. Stachecki.
11  *
12  * Authors:
13  *	Tyler J. Stachecki <stachecki.tyler@gmail.com>
14  *
15  * This software is available to you under a choice of one of two
16  * licenses.  You may choose to be licensed under the terms of the GNU
17  * General Public License (GPL) Version 2, available from the file
18  * COPYING in the main directory of this source tree, or the
19  * OpenIB.org BSD license below:
20  *
21  *     Redistribution and use in source and binary forms, with or
22  *     without modification, are permitted provided that the following
23  *     conditions are met:
24  *
25  *      - Redistributions of source code must retain the above
26  *        copyright notice, this list of conditions and the following
27  *        disclaimer.
28  *
29  *      - Redistributions in binary form must reproduce the above
30  *        copyright notice, this list of conditions and the following
31  *        disclaimer in the documentation and/or other materials
32  *        provided with the distribution.
33  *
34  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
35  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
36  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
37  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
38  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
39  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
40  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
41  * SOFTWARE.
42  */
43 
44 #if defined(HAVE_SSE2)
45 
46 #include <sys/simd.h>
47 #include <sys/spa_checksum.h>
48 #include <sys/string.h>
49 #include <sys/byteorder.h>
50 #include <zfs_fletcher.h>
51 
52 ZFS_NO_SANITIZE_UNDEFINED
53 static void
54 fletcher_4_sse2_init(fletcher_4_ctx_t *ctx)
55 {
56 	kfpu_begin();
57 	memset(ctx->sse, 0, 4 * sizeof (zfs_fletcher_sse_t));
58 }
59 
60 ZFS_NO_SANITIZE_UNDEFINED
61 static void
62 fletcher_4_sse2_fini(fletcher_4_ctx_t *ctx, zio_cksum_t *zcp)
63 {
64 	uint64_t A, B, C, D;
65 
66 	/*
67 	 * The mixing matrix for checksum calculation is:
68 	 * a = a0 + a1
69 	 * b = 2b0 + 2b1 - a1
70 	 * c = 4c0 - b0 + 4c1 -3b1
71 	 * d = 8d0 - 4c0 + 8d1 - 8c1 + b1;
72 	 *
73 	 * c and d are multiplied by 4 and 8, respectively,
74 	 * before spilling the vectors out to memory.
75 	 */
76 	A = ctx->sse[0].v[0] + ctx->sse[0].v[1];
77 	B = 2 * ctx->sse[1].v[0] + 2 * ctx->sse[1].v[1] - ctx->sse[0].v[1];
78 	C = 4 * ctx->sse[2].v[0] - ctx->sse[1].v[0] + 4 * ctx->sse[2].v[1] -
79 	    3 * ctx->sse[1].v[1];
80 	D = 8 * ctx->sse[3].v[0] - 4 * ctx->sse[2].v[0] + 8 * ctx->sse[3].v[1] -
81 	    8 * ctx->sse[2].v[1] + ctx->sse[1].v[1];
82 
83 	ZIO_SET_CHECKSUM(zcp, A, B, C, D);
84 	kfpu_end();
85 }
86 
87 #define	FLETCHER_4_SSE_RESTORE_CTX(ctx)					\
88 {									\
89 	asm volatile("movdqu %0, %%xmm0" :: "m" ((ctx)->sse[0]));	\
90 	asm volatile("movdqu %0, %%xmm1" :: "m" ((ctx)->sse[1]));	\
91 	asm volatile("movdqu %0, %%xmm2" :: "m" ((ctx)->sse[2]));	\
92 	asm volatile("movdqu %0, %%xmm3" :: "m" ((ctx)->sse[3]));	\
93 }
94 
95 #define	FLETCHER_4_SSE_SAVE_CTX(ctx)					\
96 {									\
97 	asm volatile("movdqu %%xmm0, %0" : "=m" ((ctx)->sse[0]));	\
98 	asm volatile("movdqu %%xmm1, %0" : "=m" ((ctx)->sse[1]));	\
99 	asm volatile("movdqu %%xmm2, %0" : "=m" ((ctx)->sse[2]));	\
100 	asm volatile("movdqu %%xmm3, %0" : "=m" ((ctx)->sse[3]));	\
101 }
102 
103 static void
104 fletcher_4_sse2_native(fletcher_4_ctx_t *ctx, const void *buf, uint64_t size)
105 {
106 	const uint64_t *ip = buf;
107 	const uint64_t *ipend = (uint64_t *)((uint8_t *)ip + size);
108 
109 	FLETCHER_4_SSE_RESTORE_CTX(ctx);
110 
111 	asm volatile("pxor %xmm4, %xmm4");
112 
113 	do {
114 		asm volatile("movdqu %0, %%xmm5" :: "m"(*ip));
115 		asm volatile("movdqa %xmm5, %xmm6");
116 		asm volatile("punpckldq %xmm4, %xmm5");
117 		asm volatile("punpckhdq %xmm4, %xmm6");
118 		asm volatile("paddq %xmm5, %xmm0");
119 		asm volatile("paddq %xmm0, %xmm1");
120 		asm volatile("paddq %xmm1, %xmm2");
121 		asm volatile("paddq %xmm2, %xmm3");
122 		asm volatile("paddq %xmm6, %xmm0");
123 		asm volatile("paddq %xmm0, %xmm1");
124 		asm volatile("paddq %xmm1, %xmm2");
125 		asm volatile("paddq %xmm2, %xmm3");
126 	} while ((ip += 2) < ipend);
127 
128 	FLETCHER_4_SSE_SAVE_CTX(ctx);
129 }
130 
131 static void
132 fletcher_4_sse2_byteswap(fletcher_4_ctx_t *ctx, const void *buf, uint64_t size)
133 {
134 	const uint32_t *ip = buf;
135 	const uint32_t *ipend = (uint32_t *)((uint8_t *)ip + size);
136 
137 	FLETCHER_4_SSE_RESTORE_CTX(ctx);
138 
139 	do {
140 		uint32_t scratch1 = BSWAP_32(ip[0]);
141 		uint32_t scratch2 = BSWAP_32(ip[1]);
142 		asm volatile("movd %0, %%xmm5" :: "r"(scratch1));
143 		asm volatile("movd %0, %%xmm6" :: "r"(scratch2));
144 		asm volatile("punpcklqdq %xmm6, %xmm5");
145 		asm volatile("paddq %xmm5, %xmm0");
146 		asm volatile("paddq %xmm0, %xmm1");
147 		asm volatile("paddq %xmm1, %xmm2");
148 		asm volatile("paddq %xmm2, %xmm3");
149 	} while ((ip += 2) < ipend);
150 
151 	FLETCHER_4_SSE_SAVE_CTX(ctx);
152 }
153 
154 static boolean_t fletcher_4_sse2_valid(void)
155 {
156 	return (kfpu_allowed() && zfs_sse2_available());
157 }
158 
159 const fletcher_4_ops_t fletcher_4_sse2_ops = {
160 	.init_native = fletcher_4_sse2_init,
161 	.fini_native = fletcher_4_sse2_fini,
162 	.compute_native = fletcher_4_sse2_native,
163 	.init_byteswap = fletcher_4_sse2_init,
164 	.fini_byteswap = fletcher_4_sse2_fini,
165 	.compute_byteswap = fletcher_4_sse2_byteswap,
166 	.valid = fletcher_4_sse2_valid,
167 	.name = "sse2"
168 };
169 
170 #endif /* defined(HAVE_SSE2) */
171 
172 #if defined(HAVE_SSE2) && defined(HAVE_SSSE3)
173 static void
174 fletcher_4_ssse3_byteswap(fletcher_4_ctx_t *ctx, const void *buf, uint64_t size)
175 {
176 	static const zfs_fletcher_sse_t mask = {
177 		.v = { 0x0405060700010203, 0x0C0D0E0F08090A0B }
178 	};
179 
180 	const uint64_t *ip = buf;
181 	const uint64_t *ipend = (uint64_t *)((uint8_t *)ip + size);
182 
183 	FLETCHER_4_SSE_RESTORE_CTX(ctx);
184 
185 	asm volatile("movdqu %0, %%xmm7"::"m" (mask));
186 	asm volatile("pxor %xmm4, %xmm4");
187 
188 	do {
189 		asm volatile("movdqu %0, %%xmm5"::"m" (*ip));
190 		asm volatile("pshufb %xmm7, %xmm5");
191 		asm volatile("movdqa %xmm5, %xmm6");
192 		asm volatile("punpckldq %xmm4, %xmm5");
193 		asm volatile("punpckhdq %xmm4, %xmm6");
194 		asm volatile("paddq %xmm5, %xmm0");
195 		asm volatile("paddq %xmm0, %xmm1");
196 		asm volatile("paddq %xmm1, %xmm2");
197 		asm volatile("paddq %xmm2, %xmm3");
198 		asm volatile("paddq %xmm6, %xmm0");
199 		asm volatile("paddq %xmm0, %xmm1");
200 		asm volatile("paddq %xmm1, %xmm2");
201 		asm volatile("paddq %xmm2, %xmm3");
202 	} while ((ip += 2) < ipend);
203 
204 	FLETCHER_4_SSE_SAVE_CTX(ctx);
205 }
206 
207 static boolean_t fletcher_4_ssse3_valid(void)
208 {
209 	return (kfpu_allowed() && zfs_sse2_available() &&
210 	    zfs_ssse3_available());
211 }
212 
213 const fletcher_4_ops_t fletcher_4_ssse3_ops = {
214 	.init_native = fletcher_4_sse2_init,
215 	.fini_native = fletcher_4_sse2_fini,
216 	.compute_native = fletcher_4_sse2_native,
217 	.init_byteswap = fletcher_4_sse2_init,
218 	.fini_byteswap = fletcher_4_sse2_fini,
219 	.compute_byteswap = fletcher_4_ssse3_byteswap,
220 	.valid = fletcher_4_ssse3_valid,
221 	.name = "ssse3"
222 };
223 
224 #endif /* defined(HAVE_SSE2) && defined(HAVE_SSSE3) */
225