SHA-256: Add SSSE3 implementation for x86-64
[libgcrypt.git] / src / hwfeatures.c
1 /* hwfeatures.c - Detect hardware features.
2  * Copyright (C) 2007, 2011  Free Software Foundation, Inc.
3  * Copyright (C) 2012  g10 Code GmbH
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 <ctype.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <stdarg.h>
27 #include <unistd.h>
28 #ifdef HAVE_SYSLOG
29 # include <syslog.h>
30 #endif /*HAVE_SYSLOG*/
31
32 #include "g10lib.h"
33 #include "hwf-common.h"
34
35 /* The name of a file used to globally disable selected features. */
36 #define HWF_DENY_FILE "/etc/gcrypt/hwf.deny"
37
38 /* A table to map hardware features to a string.  */
39 static struct
40 {
41   unsigned int flag;
42   const char *desc;
43 } hwflist[] =
44   {
45     { HWF_PADLOCK_RNG, "padlock-rng" },
46     { HWF_PADLOCK_AES, "padlock-aes" },
47     { HWF_PADLOCK_SHA, "padlock-sha" },
48     { HWF_PADLOCK_MMUL,"padlock-mmul"},
49     { HWF_INTEL_SSSE3, "intel-ssse3" },
50     { HWF_INTEL_PCLMUL,"intel-pclmul" },
51     { HWF_INTEL_AESNI, "intel-aesni" },
52     { HWF_INTEL_RDRAND,"intel-rdrand" },
53     { HWF_INTEL_AVX,   "intel-avx" },
54     { HWF_INTEL_AVX2,  "intel-avx2" },
55     { HWF_ARM_NEON,    "arm-neon" }
56   };
57
58 /* A bit vector with the hardware features which shall not be used.
59    This variable must be set prior to any initialization.  */
60 static unsigned int disabled_hw_features;
61
62 /* A bit vector describing the hardware features currently
63    available. */
64 static unsigned int hw_features;
65
66 /* Convenience macros.  */
67 #define my_isascii(c) (!((c) & 0x80))
68
69
70 \f
71 /* Disable a feature by name.  This function must be called *before*
72    _gcry_detect_hw_features is called.  */
73 gpg_err_code_t
74 _gcry_disable_hw_feature (const char *name)
75 {
76   int i;
77
78   for (i=0; i < DIM (hwflist); i++)
79     if (!strcmp (hwflist[i].desc, name))
80       {
81         disabled_hw_features |= hwflist[i].flag;
82         return 0;
83       }
84   return GPG_ERR_INV_NAME;
85 }
86
87
88 /* Return a bit vector describing the available hardware features.
89    The HWF_ constants are used to test for them. */
90 unsigned int
91 _gcry_get_hw_features (void)
92 {
93   return hw_features;
94 }
95
96
97 /* Enumerate all features.  The caller is expected to start with an
98    IDX of 0 and then increment IDX until NULL is returned.  */
99 const char *
100 _gcry_enum_hw_features (int idx, unsigned int *r_feature)
101 {
102   if (idx < 0 || idx >= DIM (hwflist))
103     return NULL;
104   if (r_feature)
105     *r_feature = hwflist[idx].flag;
106   return hwflist[idx].desc;
107 }
108
109
110 /* Read a file with features which shall not be used.  The file is a
111    simple text file where empty lines and lines with the first non
112    white-space character being '#' are ignored.  */
113 static void
114 parse_hwf_deny_file (void)
115 {
116   const char *fname = HWF_DENY_FILE;
117   FILE *fp;
118   char buffer[256];
119   char *p, *pend;
120   int i, lnr = 0;
121
122   fp = fopen (fname, "r");
123   if (!fp)
124     return;
125
126   for (;;)
127     {
128       if (!fgets (buffer, sizeof buffer, fp))
129         {
130           if (!feof (fp))
131             {
132 #ifdef HAVE_SYSLOG
133               syslog (LOG_USER|LOG_WARNING,
134                       "Libgcrypt warning: error reading '%s', line %d",
135                       fname, lnr);
136 #endif /*HAVE_SYSLOG*/
137             }
138           fclose (fp);
139           return;
140         }
141       lnr++;
142       for (p=buffer; my_isascii (*p) && isspace (*p); p++)
143         ;
144       pend = strchr (p, '\n');
145       if (pend)
146         *pend = 0;
147       pend = p + (*p? (strlen (p)-1):0);
148       for ( ;pend > p; pend--)
149         if (my_isascii (*pend) && isspace (*pend))
150           *pend = 0;
151       if (!*p || *p == '#')
152         continue;
153
154       for (i=0; i < DIM (hwflist); i++)
155         {
156           if (!strcmp (hwflist[i].desc, p))
157             {
158               disabled_hw_features |= hwflist[i].flag;
159               break;
160             }
161         }
162       if (i == DIM (hwflist))
163         {
164 #ifdef HAVE_SYSLOG
165           syslog (LOG_USER|LOG_WARNING,
166                   "Libgcrypt warning: unknown feature in '%s', line %d",
167                   fname, lnr);
168 #endif /*HAVE_SYSLOG*/
169         }
170     }
171 }
172
173
174 /* Detect the available hardware features.  This function is called
175    once right at startup and we assume that no other threads are
176    running.  */
177 void
178 _gcry_detect_hw_features (void)
179 {
180   hw_features = 0;
181
182   if (fips_mode ())
183     return; /* Hardware support is not to be evaluated.  */
184
185   parse_hwf_deny_file ();
186
187 #if defined (HAVE_CPU_ARCH_X86)
188   {
189     hw_features = _gcry_hwf_detect_x86 ();
190   }
191 #endif /* HAVE_CPU_ARCH_X86 */
192 #if defined (HAVE_CPU_ARCH_ARM)
193   {
194     hw_features = _gcry_hwf_detect_arm ();
195   }
196 #endif /* HAVE_CPU_ARCH_ARM */
197
198   hw_features &= ~disabled_hw_features;
199 }