Add AVX2/vpgather bulk implementation of Twofish
[libgcrypt.git] / src / hwf-x86.c
1 /* hwf-x86.c - Detect hardware features - x86 part
2  * Copyright (C) 2007, 2011, 2012  Free Software Foundation, Inc.
3  * Copyright (C) 2012  Jussi Kivilinna
4  *
5  * This file is part of Libgcrypt.
6  *
7  * Libgcrypt is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * Libgcrypt is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <stdarg.h>
26 #include <unistd.h>
27
28 #include "g10lib.h"
29 #include "hwf-common.h"
30
31 #if !defined (__i386__) && !defined (__x86_64__)
32 # error Module build for wrong CPU.
33 #endif
34
35 /* We use the next macro to decide whether we can test for certain
36    features.  */
37 #undef HAS_X86_CPUID
38
39 #if defined (__i386__) && SIZEOF_UNSIGNED_LONG == 4 && defined (__GNUC__)
40 # define HAS_X86_CPUID 1
41
42 static int
43 is_cpuid_available(void)
44 {
45   int has_cpuid = 0;
46
47   /* Detect the CPUID feature by testing some undefined behaviour (16
48      vs 32 bit pushf/popf). */
49   asm volatile
50     ("pushf\n\t"                 /* Copy flags to EAX.  */
51      "popl %%eax\n\t"
52      "movl %%eax, %%ecx\n\t"     /* Save flags into ECX.  */
53      "xorl $0x200000, %%eax\n\t" /* Toggle ID bit and copy it to the flags.  */
54      "pushl %%eax\n\t"
55      "popf\n\t"
56      "pushf\n\t"                 /* Copy changed flags again to EAX.  */
57      "popl %%eax\n\t"
58      "pushl %%ecx\n\t"           /* Restore flags from ECX.  */
59      "popf\n\t"
60      "xorl %%eax, %%ecx\n\t"     /* Compare flags against saved flags.  */
61      "jz .Lno_cpuid%=\n\t"       /* Toggling did not work, thus no CPUID.  */
62      "movl $1, %0\n"             /* Worked. true -> HAS_CPUID.  */
63      ".Lno_cpuid%=:\n\t"
64      : "+r" (has_cpuid)
65      :
66      : "%eax", "%ecx", "cc"
67      );
68
69   return has_cpuid;
70 }
71
72 static void
73 get_cpuid(unsigned int in, unsigned int *eax, unsigned int *ebx,
74           unsigned int *ecx, unsigned int *edx)
75 {
76   unsigned int regs[4];
77
78   asm volatile
79     ("pushl %%ebx\n\t"           /* Save GOT register.  */
80      "movl %1, %%ebx\n\t"
81      "cpuid\n\t"
82      "movl %%ebx, %1\n\t"
83      "popl %%ebx\n\t"            /* Restore GOT register. */
84      : "=a" (regs[0]), "=D" (regs[1]), "=c" (regs[2]), "=d" (regs[3])
85      : "0" (in), "1" (0), "2" (0), "3" (0)
86      : "cc"
87      );
88
89   if (eax)
90     *eax = regs[0];
91   if (ebx)
92     *ebx = regs[1];
93   if (ecx)
94     *ecx = regs[2];
95   if (edx)
96     *edx = regs[3];
97 }
98
99 #if defined(ENABLE_AVX_SUPPORT) || defined(ENABLE_AVX2_SUPPORT)
100 static unsigned int
101 get_xgetbv(void)
102 {
103   unsigned int t_eax, t_edx;
104
105   asm volatile
106     ("xgetbv\n\t"
107      : "=a" (t_eax), "=d" (t_edx)
108      : "c" (0)
109     );
110
111   return t_eax;
112 }
113 #endif /* ENABLE_AVX_SUPPORT || ENABLE_AVX2_SUPPORT */
114
115 #endif /* i386 && GNUC */
116
117
118 #if defined (__x86_64__) && defined (__GNUC__)
119 # define HAS_X86_CPUID 1
120
121 static int
122 is_cpuid_available(void)
123 {
124   return 1;
125 }
126
127 static void
128 get_cpuid(unsigned int in, unsigned int *eax, unsigned int *ebx,
129           unsigned int *ecx, unsigned int *edx)
130 {
131   unsigned int regs[4];
132
133   asm volatile
134     ("cpuid\n\t"
135      : "=a" (regs[0]), "=b" (regs[1]), "=c" (regs[2]), "=d" (regs[3])
136      : "0" (in), "1" (0), "2" (0), "3" (0)
137      : "cc"
138      );
139
140   if (eax)
141     *eax = regs[0];
142   if (ebx)
143     *ebx = regs[1];
144   if (ecx)
145     *ecx = regs[2];
146   if (edx)
147     *edx = regs[3];
148 }
149
150 #if defined(ENABLE_AVX_SUPPORT) || defined(ENABLE_AVX2_SUPPORT)
151 static unsigned int
152 get_xgetbv(void)
153 {
154   unsigned int t_eax, t_edx;
155
156   asm volatile
157     ("xgetbv\n\t"
158      : "=a" (t_eax), "=d" (t_edx)
159      : "c" (0)
160     );
161
162   return t_eax;
163 }
164 #endif /* ENABLE_AVX_SUPPORT || ENABLE_AVX2_SUPPORT */
165
166 #endif /* x86-64 && GNUC */
167
168
169 #ifdef HAS_X86_CPUID
170 static unsigned int
171 detect_x86_gnuc (void)
172 {
173   char vendor_id[12+1];
174   unsigned int features;
175   unsigned int os_supports_avx_avx2_registers = 0;
176   unsigned int max_cpuid_level;
177   unsigned int fms, family, model;
178   unsigned int result = 0;
179   unsigned int avoid_vpgather = 0;
180
181   (void)os_supports_avx_avx2_registers;
182
183   if (!is_cpuid_available())
184     return 0;
185
186   get_cpuid(0, &max_cpuid_level,
187             (unsigned int *)&vendor_id[0],
188             (unsigned int *)&vendor_id[8],
189             (unsigned int *)&vendor_id[4]);
190   vendor_id[12] = 0;
191
192   if (0)
193     ; /* Just to make "else if" and ifdef macros look pretty.  */
194 #ifdef ENABLE_PADLOCK_SUPPORT
195   else if (!strcmp (vendor_id, "CentaurHauls"))
196     {
197       /* This is a VIA CPU.  Check what PadLock features we have.  */
198
199       /* Check for extended centaur (EAX).  */
200       get_cpuid(0xC0000000, &features, NULL, NULL, NULL);
201
202       /* Has extended centaur features? */
203       if (features > 0xC0000000)
204         {
205            /* Ask for the extended feature flags (EDX). */
206            get_cpuid(0xC0000001, NULL, NULL, NULL, &features);
207
208            /* Test bits 2 and 3 to see whether the RNG exists and is enabled. */
209            if ((features & 0x0C) == 0x0C)
210              result |= HWF_PADLOCK_RNG;
211
212            /* Test bits 6 and 7 to see whether the ACE exists and is enabled. */
213            if ((features & 0xC0) == 0xC0)
214              result |= HWF_PADLOCK_AES;
215
216            /* Test bits 10 and 11 to see whether the PHE exists and is
217               enabled.  */
218            if ((features & 0xC00) == 0xC00)
219              result |= HWF_PADLOCK_SHA;
220
221            /* Test bits 12 and 13 to see whether the MONTMUL exists and is
222               enabled.  */
223            if ((features & 0x3000) == 0x3000)
224              result |= HWF_PADLOCK_MMUL;
225         }
226     }
227 #endif /*ENABLE_PADLOCK_SUPPORT*/
228   else if (!strcmp (vendor_id, "GenuineIntel"))
229     {
230       /* This is an Intel CPU.  */
231       result |= HWF_INTEL_CPU;
232     }
233   else if (!strcmp (vendor_id, "AuthenticAMD"))
234     {
235       /* This is an AMD CPU.  */
236     }
237
238   /* Detect Intel features, that might also be supported by other
239      vendors.  */
240
241   /* Get CPU family/model/stepping (EAX) and Intel feature flags (ECX).  */
242   get_cpuid(1, &fms, NULL, &features, NULL);
243
244   family = ((fms & 0xf00) >> 8) + ((fms & 0xff00000) >> 20);
245   model = ((fms & 0xf0) >> 4) + ((fms & 0xf0000) >> 12);
246
247   if ((result & HWF_INTEL_CPU) && family == 6)
248     {
249       /* These Intel Core processor models have SHLD/SHRD instruction that
250        * can do integer rotation faster actual ROL/ROR instructions. */
251       switch (model)
252         {
253         case 0x2A:
254         case 0x2D:
255         case 0x3A:
256         case 0x3C:
257         case 0x3F:
258         case 0x45:
259         case 0x46:
260         case 0x3D:
261         case 0x4F:
262         case 0x56:
263         case 0x47:
264         case 0x4E:
265         case 0x5E:
266         case 0x8E:
267         case 0x9E:
268         case 0x55:
269         case 0x66:
270           result |= HWF_INTEL_FAST_SHLD;
271           break;
272         }
273
274       /* These Intel Core processors that have AVX2 have slow VPGATHER and
275        * should be avoided for table-lookup use. */
276       switch (model)
277         {
278         case 0x3C:
279         case 0x3F:
280         case 0x45:
281         case 0x46:
282           /* Haswell */
283           avoid_vpgather |= 1;
284           break;
285         }
286     }
287   else
288     {
289       /* Avoid VPGATHER for non-Intel CPUs as testing is needed to
290        * make sure it is fast enough. */
291
292       avoid_vpgather |= 1;
293     }
294
295 #ifdef ENABLE_PCLMUL_SUPPORT
296   /* Test bit 1 for PCLMUL.  */
297   if (features & 0x00000002)
298      result |= HWF_INTEL_PCLMUL;
299 #endif
300   /* Test bit 9 for SSSE3.  */
301   if (features & 0x00000200)
302      result |= HWF_INTEL_SSSE3;
303   /* Test bit 19 for SSE4.1.  */
304   if (features & 0x00080000)
305      result |= HWF_INTEL_SSE4_1;
306 #ifdef ENABLE_AESNI_SUPPORT
307   /* Test bit 25 for AES-NI.  */
308   if (features & 0x02000000)
309      result |= HWF_INTEL_AESNI;
310 #endif /*ENABLE_AESNI_SUPPORT*/
311 #if defined(ENABLE_AVX_SUPPORT) || defined(ENABLE_AVX2_SUPPORT)
312   /* Test bit 27 for OSXSAVE (required for AVX/AVX2).  */
313   if (features & 0x08000000)
314     {
315       /* Check that OS has enabled both XMM and YMM state support.  */
316       if ((get_xgetbv() & 0x6) == 0x6)
317         os_supports_avx_avx2_registers = 1;
318     }
319 #endif
320 #ifdef ENABLE_AVX_SUPPORT
321   /* Test bit 28 for AVX.  */
322   if (features & 0x10000000)
323     if (os_supports_avx_avx2_registers)
324       result |= HWF_INTEL_AVX;
325 #endif /*ENABLE_AVX_SUPPORT*/
326 #ifdef ENABLE_DRNG_SUPPORT
327   /* Test bit 30 for RDRAND.  */
328   if (features & 0x40000000)
329      result |= HWF_INTEL_RDRAND;
330 #endif /*ENABLE_DRNG_SUPPORT*/
331
332   /* Check additional Intel feature flags.  Early Intel P5 processors report
333    * too high max_cpuid_level, so don't check level 7 if processor does not
334    * support SSE3 (as cpuid:7 contains only features for newer processors).
335    * Source: http://www.sandpile.org/x86/cpuid.htm  */
336   if (max_cpuid_level >= 7 && (features & 0x00000001))
337     {
338       /* Get CPUID:7 contains further Intel feature flags. */
339       get_cpuid(7, NULL, &features, NULL, NULL);
340
341       /* Test bit 8 for BMI2.  */
342       if (features & 0x00000100)
343           result |= HWF_INTEL_BMI2;
344
345 #ifdef ENABLE_AVX2_SUPPORT
346       /* Test bit 5 for AVX2.  */
347       if (features & 0x00000020)
348         if (os_supports_avx_avx2_registers)
349           result |= HWF_INTEL_AVX2;
350
351       if ((result & HWF_INTEL_AVX2) && !avoid_vpgather)
352         result |= HWF_INTEL_FAST_VPGATHER;
353 #endif /*ENABLE_AVX_SUPPORT*/
354     }
355
356   return result;
357 }
358 #endif /* HAS_X86_CPUID */
359
360
361 unsigned int
362 _gcry_hwf_detect_x86 (void)
363 {
364 #if defined (HAS_X86_CPUID)
365   return detect_x86_gnuc ();
366 #else
367   return 0;
368 #endif
369 }