Do not ship generated header file in tarball.
[libgcrypt.git] / src / hwf-arm.c
1 /* hwf-arm.c - Detect hardware features - ARM part
2  * Copyright (C) 2013  Jussi Kivilinna <jussi.kivilinna@iki.fi>
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <stdarg.h>
25 #include <unistd.h>
26
27 #include "g10lib.h"
28 #include "hwf-common.h"
29
30 #if !defined (__arm__)
31 # error Module build for wrong CPU.
32 #endif
33
34 #undef HAS_SYS_AT_HWCAP
35 #undef HAS_PROC_CPUINFO
36 #ifdef __linux__
37
38 #define HAS_SYS_AT_HWCAP 1
39
40 #define AT_HWCAP 16
41 #define HWCAP_NEON 4096
42
43 static int
44 get_hwcap(unsigned int *hwcap)
45 {
46   struct { unsigned int a_type; unsigned int a_val; } auxv;
47   FILE *f;
48   int err = -1;
49   static int hwcap_initialized = 0;
50   static unsigned int stored_hwcap;
51
52   if (hwcap_initialized)
53     {
54       *hwcap = stored_hwcap;
55       return 0;
56     }
57
58   f = fopen("/proc/self/auxv", "r");
59   if (!f)
60     {
61       *hwcap = stored_hwcap;
62       return -1;
63     }
64
65   while (fread(&auxv, sizeof(auxv), 1, f) > 0)
66     {
67       if (auxv.a_type != AT_HWCAP)
68         continue;
69
70       stored_hwcap = auxv.a_val;
71       hwcap_initialized = 1;
72       err = 0;
73       break;
74     }
75
76   fclose(f);
77   *hwcap = stored_hwcap;
78   return err;
79 }
80
81 static unsigned int
82 detect_arm_at_hwcap(void)
83 {
84   unsigned int hwcap;
85   unsigned int features = 0;
86
87   if (get_hwcap(&hwcap) < 0)
88     return features;
89
90 #ifdef ENABLE_NEON_SUPPORT
91   if (hwcap & HWCAP_NEON)
92     features |= HWF_ARM_NEON;
93 #endif
94
95   return features;
96 }
97
98 #define HAS_PROC_CPUINFO 1
99
100 static unsigned int
101 detect_arm_proc_cpuinfo(unsigned int *broken_hwfs)
102 {
103   char buf[1024]; /* large enough */
104   char *str_features, *str_neon;
105   int cpu_implementer, cpu_arch, cpu_variant, cpu_part, cpu_revision;
106   FILE *f;
107   int readlen, i;
108   static int cpuinfo_initialized = 0;
109   static unsigned int stored_cpuinfo_features;
110   static unsigned int stored_broken_hwfs;
111   struct {
112     const char *name;
113     int *value;
114   } cpu_entries[5] = {
115     { "CPU implementer", &cpu_implementer },
116     { "CPU architecture", &cpu_arch },
117     { "CPU variant", &cpu_variant },
118     { "CPU part", &cpu_part },
119     { "CPU revision", &cpu_revision },
120   };
121
122   if (cpuinfo_initialized)
123     {
124       *broken_hwfs |= stored_broken_hwfs;
125       return stored_cpuinfo_features;
126     }
127
128   f = fopen("/proc/cpuinfo", "r");
129   if (!f)
130     return 0;
131
132   memset (buf, 0, sizeof(buf));
133   readlen = fread (buf, 1, sizeof(buf), f);
134   fclose (f);
135   if (readlen <= 0 || readlen > sizeof(buf))
136     return 0;
137
138   buf[sizeof(buf) - 1] = '\0';
139
140   cpuinfo_initialized = 1;
141   stored_cpuinfo_features = 0;
142   stored_broken_hwfs = 0;
143
144   /* Find features line. */
145   str_features = strstr(buf, "Features");
146   if (!str_features)
147     return stored_cpuinfo_features;
148
149   /* Find CPU version information. */
150   for (i = 0; i < DIM(cpu_entries); i++)
151     {
152       char *str;
153
154       *cpu_entries[i].value = -1;
155
156       str = strstr(buf, cpu_entries[i].name);
157       if (!str)
158         continue;
159
160       str = strstr(str, ": ");
161       if (!str)
162         continue;
163
164       str += 2;
165       *cpu_entries[i].value = strtoul(str, NULL, 0);
166     }
167
168   /* Lines to strings. */
169   for (i = 0; i < sizeof(buf); i++)
170     if (buf[i] == '\n')
171       buf[i] = '\0';
172
173   /* Check for NEON. */
174   str_neon = strstr(str_features, " neon");
175   if (str_neon && (str_neon[5] == ' ' || str_neon[5] == '\0'))
176     stored_cpuinfo_features |= HWF_ARM_NEON;
177
178   /* Check for CPUs with broken NEON implementation. See
179    * https://code.google.com/p/chromium/issues/detail?id=341598
180    */
181   if (cpu_implementer == 0x51
182       && cpu_arch == 7
183       && cpu_variant == 1
184       && cpu_part == 0x4d
185       && cpu_revision == 0)
186     {
187       stored_broken_hwfs = HWF_ARM_NEON;
188     }
189
190   *broken_hwfs |= stored_broken_hwfs;
191   return stored_cpuinfo_features;
192 }
193
194 #endif /* __linux__ */
195
196 unsigned int
197 _gcry_hwf_detect_arm (void)
198 {
199   unsigned int ret = 0;
200   unsigned int broken_hwfs = 0;
201
202 #if defined (HAS_SYS_AT_HWCAP)
203   ret |= detect_arm_at_hwcap ();
204 #endif
205
206 #if defined (HAS_PROC_CPUINFO)
207   ret |= detect_arm_proc_cpuinfo (&broken_hwfs);
208 #endif
209
210 #if defined(__ARM_NEON__) && defined(ENABLE_NEON_SUPPORT)
211   ret |= HWF_ARM_NEON;
212 #endif
213
214   ret &= ~broken_hwfs;
215
216   return ret;
217 }