chiark / gitweb /
Support Intel's AES Native Instructions where available on x86 hardware.
[catacomb] / base / dispatch.c
1 /* -*-c-*-
2  *
3  * CPU-specific dispatch
4  *
5  * (c) 2015 Straylight/Edgeware
6  */
7
8 /*----- Licensing notice --------------------------------------------------*
9  *
10  * This file is part of Catacomb.
11  *
12  * Catacomb is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU Library General Public License as
14  * published by the Free Software Foundation; either version 2 of the
15  * License, or (at your option) any later version.
16  *
17  * Catacomb is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU Library General Public License for more details.
21  *
22  * You should have received a copy of the GNU Library General Public
23  * License along with Catacomb; if not, write to the Free
24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
25  * MA 02111-1307, USA.
26  */
27
28 /*----- Header files ------------------------------------------------------*/
29
30 #include "config.h"
31
32 #include <ctype.h>
33 #include <stdlib.h>
34 #include <string.h>
35
36 #include <mLib/macros.h>
37
38 #include "dispatch.h"
39
40 /*----- Main code ---------------------------------------------------------*/
41
42 #ifdef CPUFAM_X86
43
44 #define EFLAGS_ID (1u << 21)
45 #define CPUID1D_SSE2 (1u << 26)
46 #define CPUID1D_FXSR (1u << 24)
47 #define CPUID1C_AESNI (1u << 25)
48
49 struct cpuid { unsigned a, b, c, d; };
50
51 /* --- @cpuid@ --- *
52  *
53  * Arguments:   @struct cpuid *cc@ = where to write the result
54  *              @unsigned a, c@ = EAX and ECX registers to set
55  *
56  * Returns:     ---
57  *
58  * Use:         Minimal C wrapper around the x86 `CPUID' instruction.  Checks
59  *              that the instruction is actually available before invoking
60  *              it; fills the output structure with zero if it's not going to
61  *              work.
62  */
63
64 #ifdef __GNUC__
65 static __inline__ unsigned getflags(void)
66   { unsigned f; __asm__ ("pushf; popl %0" : "=g" (f)); return (f); }
67 static __inline__ unsigned setflags(unsigned f)
68 {
69   unsigned ff;
70   __asm__ ("pushf; pushl %1; popf; pushf; popl %0; popf"
71            : "=g" (ff)
72            : "g" (f));
73   return (ff);
74 }
75 #endif
76
77 static void cpuid(struct cpuid *cc, unsigned a, unsigned c)
78 {
79 #ifdef __GNUC__
80   unsigned f;
81 #endif
82
83   cc->a = cc->b = cc->c = cc->d = 0;
84
85 #ifdef __GNUC__
86   /* Stupid dance to detect whether the CPUID instruction is available. */
87   f = getflags();
88   if (!(setflags(f |  EFLAGS_ID) & EFLAGS_ID)) return;
89   if (  setflags(f & ~EFLAGS_ID) & EFLAGS_ID ) return;
90   setflags(f);
91
92   /* Alas, EBX is magical in PIC code, so abuse ESI instead.  This isn't
93    * pretty, but it works.
94    */
95   __asm__ ("pushl %%ebx; cpuid; movl %%ebx, %%esi; popl %%ebx"
96            : "=a" (cc->a), "=S" (cc->b), "=c" (cc->c), "=d" (cc->d)
97            : "a" (a) , "c" (c));
98 #endif
99 }
100
101 static unsigned cpuid_maxleaf(void)
102   { struct cpuid c; cpuid(&c, 0, 0); return (c.a); }
103
104 static int cpuid_features_p(unsigned dbits, unsigned cbits)
105 {
106   struct cpuid c;
107   if (cpuid_maxleaf() < 1) return (0);
108   cpuid(&c, 1, 0);
109   return ((c.d & dbits) == dbits && (c.c & cbits) == cbits);
110 }
111
112 static int xmm_registers_available_p(void)
113 {
114 #ifdef __GNUC__
115   unsigned f;
116   /* This hack is by Agner Fog.  Use FXSAVE/FXRSTOR to figure out whether the
117    * XMM registers are actually alive.
118    */
119   if (!cpuid_features_p(CPUID1D_FXSR, 0)) return (0);
120   __asm__ ("movl %%esp, %%edx; subl $512, %%esp; andl $~15, %%esp\n"
121            "fxsave (%%esp)\n"
122            "movl 160(%%esp), %%eax; xorl $0xaaaa5555, 160(%%esp)\n"
123            "fxrstor (%%esp); fxsave (%%esp)\n"
124            "movl 160(%%esp), %%ecx; movl %%eax, 160(%%esp)\n"
125            "fxrstor (%%esp); movl %%edx, %%esp\n"
126            "xorl %%ecx, %%eax"
127            : "=a" (f)
128            : /* no inputs */
129            : "%ecx", "%edx");
130   return (f);
131 #else
132   return (0);
133 #endif
134 }
135
136 #endif
137
138 /* --- @check_env@ --- *
139  *
140  * Arguments:   @const char *ftok@ = feature token
141  *
142  * Returns:     Zero if the feature is forced off; positive if it's forced
143  *              on; negative if the user hasn't decided.
144  *
145  * Use:         Checks the environment variable `CATACOMB_CPUFEAT' for the
146  *              feature token @ftok@.  The variable, if it exists, should be
147  *              a space-separated sequence of `+tok' and `-tok' items.  These
148  *              tokens may end in `*', which matches any suffix.
149  */
150
151 static int IGNORABLE check_env(const char *ftok)
152 {
153   const char *p, *q, *pp;
154   int d;
155
156   p = getenv("CATACOMB_CPUFEAT");
157   if (!p) return (-1);
158
159   for (;;) {
160     while (isspace((unsigned char)*p)) p++;
161     if (!*p) return (-1);
162     switch (*p) {
163       case '+': d = +1; p++; break;
164       case '-': d =  0; p++; break;
165       default:  d = -1;      break;
166     }
167     for (q = p; *q && !isspace((unsigned char)*q); q++);
168     if (d >= 0) {
169       for (pp = ftok; p < q && *pp && *p == *pp; p++, pp++);
170       if ((p == q && !*pp) || (*p == '*' && p + 1 == q)) return (d);
171     }
172     p = q;
173   }
174   return (-1);
175 }
176
177 /* --- @cpu_feature_p@ --- *
178  *
179  * Arguments:   @unsigned feat@ = a @CPUFEAT_...@ code
180  *
181  * Returns:     Nonzero if the feature is available.
182  */
183
184 #include <stdio.h>
185
186 int cpu_feature_p(int feat)
187 {
188   int IGNORABLE f;
189   IGNORE(f);
190 #define CHECK_ENV(ftok)                                                 \
191   do { if ((f = check_env(ftok)) >= 0) return (f); } while (0)
192
193   switch (feat) {
194 #ifdef CPUFAM_X86
195     case CPUFEAT_X86_SSE2: {
196       CHECK_ENV("x86:sse2");
197       return (xmm_registers_available_p() &&
198               cpuid_features_p(CPUID1D_SSE2, 0));
199     }
200     case CPUFEAT_X86_AESNI: {
201       check_env("x86:aesni");
202       return (xmm_registers_available_p() &&
203               cpuid_features_p(CPUID1D_SSE2, CPUID1C_AESNI));
204     }
205 #endif
206     default:
207       return (0);
208   }
209 #undef CHECK_ENV
210 }
211
212 /*----- That's all, folks -------------------------------------------------*/