1cad546d27198f557562d386c3aa0b97a2c063d1
[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_CPU,           "intel-cpu" },
50     { HWF_INTEL_FAST_SHLD,     "intel-fast-shld" },
51     { HWF_INTEL_BMI2,          "intel-bmi2" },
52     { HWF_INTEL_SSSE3,         "intel-ssse3" },
53     { HWF_INTEL_SSE4_1,        "intel-sse4.1" },
54     { HWF_INTEL_PCLMUL,        "intel-pclmul" },
55     { HWF_INTEL_AESNI,         "intel-aesni" },
56     { HWF_INTEL_RDRAND,        "intel-rdrand" },
57     { HWF_INTEL_AVX,           "intel-avx" },
58     { HWF_INTEL_AVX2,          "intel-avx2" },
59     { HWF_INTEL_FAST_VPGATHER, "intel-fast-vpgather" },
60     { HWF_INTEL_RDTSC,         "intel-rdtsc" },
61     { HWF_ARM_NEON,            "arm-neon" },
62     { HWF_ARM_AES,             "arm-aes" },
63     { HWF_ARM_SHA1,            "arm-sha1" },
64     { HWF_ARM_SHA2,            "arm-sha2" },
65     { HWF_ARM_PMULL,           "arm-pmull" }
66   };
67
68 /* A bit vector with the hardware features which shall not be used.
69    This variable must be set prior to any initialization.  */
70 static unsigned int disabled_hw_features;
71
72 /* A bit vector describing the hardware features currently
73    available. */
74 static unsigned int hw_features;
75
76
77 \f
78 /* Disable a feature by name.  This function must be called *before*
79    _gcry_detect_hw_features is called.  */
80 gpg_err_code_t
81 _gcry_disable_hw_feature (const char *name)
82 {
83   int i;
84   size_t n1, n2;
85
86   while (name && *name)
87     {
88       n1 = strcspn (name, ":,");
89       if (!n1)
90         ;
91       else if (n1 == 3 && !strncmp (name, "all", 3))
92         disabled_hw_features = ~0;
93       else
94         {
95           for (i=0; i < DIM (hwflist); i++)
96             {
97               n2 = strlen (hwflist[i].desc);
98               if (n1 == n2 && !strncmp (hwflist[i].desc, name, n2))
99                 {
100                   disabled_hw_features |= hwflist[i].flag;
101                   break;
102                 }
103             }
104           if (!(i < DIM (hwflist)))
105             return GPG_ERR_INV_NAME;
106         }
107       name += n1;
108       if (*name)
109         name++; /* Skip delimiter ':' or ','.  */
110     }
111   return 0;
112 }
113
114
115 /* Return a bit vector describing the available hardware features.
116    The HWF_ constants are used to test for them. */
117 unsigned int
118 _gcry_get_hw_features (void)
119 {
120   return hw_features;
121 }
122
123
124 /* Enumerate all features.  The caller is expected to start with an
125    IDX of 0 and then increment IDX until NULL is returned.  */
126 const char *
127 _gcry_enum_hw_features (int idx, unsigned int *r_feature)
128 {
129   if (idx < 0 || idx >= DIM (hwflist))
130     return NULL;
131   if (r_feature)
132     *r_feature = hwflist[idx].flag;
133   return hwflist[idx].desc;
134 }
135
136
137 /* Read a file with features which shall not be used.  The file is a
138    simple text file where empty lines and lines with the first non
139    white-space character being '#' are ignored.  */
140 static void
141 parse_hwf_deny_file (void)
142 {
143   const char *fname = HWF_DENY_FILE;
144   FILE *fp;
145   char buffer[256];
146   char *p, *pend;
147   int lnr = 0;
148
149   fp = fopen (fname, "r");
150   if (!fp)
151     return;
152
153   for (;;)
154     {
155       if (!fgets (buffer, sizeof buffer, fp))
156         {
157           if (!feof (fp))
158             {
159 #ifdef HAVE_SYSLOG
160               syslog (LOG_USER|LOG_WARNING,
161                       "Libgcrypt warning: error reading '%s', line %d",
162                       fname, lnr);
163 #endif /*HAVE_SYSLOG*/
164             }
165           fclose (fp);
166           return;
167         }
168       lnr++;
169       for (p=buffer; my_isascii (*p) && isspace (*p); p++)
170         ;
171       pend = strchr (p, '\n');
172       if (pend)
173         *pend = 0;
174       pend = p + (*p? (strlen (p)-1):0);
175       for ( ;pend > p; pend--)
176         if (my_isascii (*pend) && isspace (*pend))
177           *pend = 0;
178       if (!*p || *p == '#')
179         continue;
180
181       if (_gcry_disable_hw_feature (p) == GPG_ERR_INV_NAME)
182         {
183 #ifdef HAVE_SYSLOG
184           syslog (LOG_USER|LOG_WARNING,
185                   "Libgcrypt warning: unknown feature in '%s', line %d",
186                   fname, lnr);
187 #endif /*HAVE_SYSLOG*/
188         }
189     }
190 }
191
192
193 /* Detect the available hardware features.  This function is called
194    once right at startup and we assume that no other threads are
195    running.  */
196 void
197 _gcry_detect_hw_features (void)
198 {
199   hw_features = 0;
200
201   if (fips_mode ())
202     return; /* Hardware support is not to be evaluated.  */
203
204   parse_hwf_deny_file ();
205
206 #if defined (HAVE_CPU_ARCH_X86)
207   {
208     hw_features = _gcry_hwf_detect_x86 ();
209   }
210 #endif /* HAVE_CPU_ARCH_X86 */
211 #if defined (HAVE_CPU_ARCH_ARM)
212   {
213     hw_features = _gcry_hwf_detect_arm ();
214   }
215 #endif /* HAVE_CPU_ARCH_ARM */
216
217   hw_features &= ~disabled_hw_features;
218 }