cpu-intel.c 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  2. * All rights reserved.
  3. *
  4. * This package is an SSL implementation written
  5. * by Eric Young (eay@cryptsoft.com).
  6. * The implementation was written so as to conform with Netscapes SSL.
  7. *
  8. * This library is free for commercial and non-commercial use as long as
  9. * the following conditions are aheared to. The following conditions
  10. * apply to all code found in this distribution, be it the RC4, RSA,
  11. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  12. * included with this distribution is covered by the same copyright terms
  13. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14. *
  15. * Copyright remains Eric Young's, and as such any Copyright notices in
  16. * the code are not to be removed.
  17. * If this package is used in a product, Eric Young should be given attribution
  18. * as the author of the parts of the library used.
  19. * This can be in the form of a textual message at program startup or
  20. * in documentation (online or textual) provided with the package.
  21. *
  22. * Redistribution and use in source and binary forms, with or without
  23. * modification, are permitted provided that the following conditions
  24. * are met:
  25. * 1. Redistributions of source code must retain the copyright
  26. * notice, this list of conditions and the following disclaimer.
  27. * 2. Redistributions in binary form must reproduce the above copyright
  28. * notice, this list of conditions and the following disclaimer in the
  29. * documentation and/or other materials provided with the distribution.
  30. * 3. All advertising materials mentioning features or use of this software
  31. * must display the following acknowledgement:
  32. * "This product includes cryptographic software written by
  33. * Eric Young (eay@cryptsoft.com)"
  34. * The word 'cryptographic' can be left out if the rouines from the library
  35. * being used are not cryptographic related :-).
  36. * 4. If you include any Windows specific code (or a derivative thereof) from
  37. * the apps directory (application code) you must include an acknowledgement:
  38. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39. *
  40. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50. * SUCH DAMAGE.
  51. *
  52. * The licence and distribution terms for any publically available version or
  53. * derivative of this code cannot be changed. i.e. this code cannot simply be
  54. * copied and put under another distribution licence
  55. * [including the GNU Public Licence.] */
  56. #include <openssl/cpu.h>
  57. #if !defined(OPENSSL_NO_ASM) && (defined(OPENSSL_X86) || defined(OPENSSL_X86_64))
  58. #include <inttypes.h>
  59. #include <stdio.h>
  60. #include <stdlib.h>
  61. #include <string.h>
  62. #if defined(_MSC_VER)
  63. OPENSSL_MSVC_PRAGMA(warning(push, 3))
  64. #include <immintrin.h>
  65. #include <intrin.h>
  66. OPENSSL_MSVC_PRAGMA(warning(pop))
  67. #endif
  68. #include "internal.h"
  69. // OPENSSL_cpuid runs the cpuid instruction. |leaf| is passed in as EAX and ECX
  70. // is set to zero. It writes EAX, EBX, ECX, and EDX to |*out_eax| through
  71. // |*out_edx|.
  72. static void OPENSSL_cpuid(uint32_t *out_eax, uint32_t *out_ebx,
  73. uint32_t *out_ecx, uint32_t *out_edx, uint32_t leaf) {
  74. #if defined(_MSC_VER)
  75. int tmp[4];
  76. __cpuid(tmp, (int)leaf);
  77. *out_eax = (uint32_t)tmp[0];
  78. *out_ebx = (uint32_t)tmp[1];
  79. *out_ecx = (uint32_t)tmp[2];
  80. *out_edx = (uint32_t)tmp[3];
  81. #elif defined(__pic__) && defined(OPENSSL_32_BIT)
  82. // Inline assembly may not clobber the PIC register. For 32-bit, this is EBX.
  83. // See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=47602.
  84. __asm__ volatile (
  85. "xor %%ecx, %%ecx\n"
  86. "mov %%ebx, %%edi\n"
  87. "cpuid\n"
  88. "xchg %%edi, %%ebx\n"
  89. : "=a"(*out_eax), "=D"(*out_ebx), "=c"(*out_ecx), "=d"(*out_edx)
  90. : "a"(leaf)
  91. );
  92. #else
  93. __asm__ volatile (
  94. "xor %%ecx, %%ecx\n"
  95. "cpuid\n"
  96. : "=a"(*out_eax), "=b"(*out_ebx), "=c"(*out_ecx), "=d"(*out_edx)
  97. : "a"(leaf)
  98. );
  99. #endif
  100. }
  101. // OPENSSL_xgetbv returns the value of an Intel Extended Control Register (XCR).
  102. // Currently only XCR0 is defined by Intel so |xcr| should always be zero.
  103. static uint64_t OPENSSL_xgetbv(uint32_t xcr) {
  104. #if defined(_MSC_VER)
  105. return (uint64_t)_xgetbv(xcr);
  106. #else
  107. uint32_t eax, edx;
  108. __asm__ volatile ("xgetbv" : "=a"(eax), "=d"(edx) : "c"(xcr));
  109. return (((uint64_t)edx) << 32) | eax;
  110. #endif
  111. }
  112. // handle_cpu_env applies the value from |in| to the CPUID values in |out[0]|
  113. // and |out[1]|. See the comment in |OPENSSL_cpuid_setup| about this.
  114. static void handle_cpu_env(uint32_t *out, const char *in) {
  115. const int invert = in[0] == '~';
  116. uint64_t v;
  117. if (!sscanf(in + invert, "%" PRIu64, &v)) {
  118. return;
  119. }
  120. if (invert) {
  121. out[0] &= ~v;
  122. out[1] &= ~(v >> 32);
  123. } else {
  124. out[0] = v;
  125. out[1] = v >> 32;
  126. }
  127. }
  128. void OPENSSL_cpuid_setup(void) {
  129. // Determine the vendor and maximum input value.
  130. uint32_t eax, ebx, ecx, edx;
  131. OPENSSL_cpuid(&eax, &ebx, &ecx, &edx, 0);
  132. uint32_t num_ids = eax;
  133. int is_intel = ebx == 0x756e6547 /* Genu */ &&
  134. edx == 0x49656e69 /* ineI */ &&
  135. ecx == 0x6c65746e /* ntel */;
  136. int is_amd = ebx == 0x68747541 /* Auth */ &&
  137. edx == 0x69746e65 /* enti */ &&
  138. ecx == 0x444d4163 /* cAMD */;
  139. uint32_t extended_features[2] = {0};
  140. if (num_ids >= 7) {
  141. OPENSSL_cpuid(&eax, &ebx, &ecx, &edx, 7);
  142. extended_features[0] = ebx;
  143. extended_features[1] = ecx;
  144. }
  145. OPENSSL_cpuid(&eax, &ebx, &ecx, &edx, 1);
  146. if (is_amd) {
  147. // See https://www.amd.com/system/files/TechDocs/25481.pdf, page 10.
  148. const uint32_t base_family = (eax >> 8) & 15;
  149. const uint32_t base_model = (eax >> 4) & 15;
  150. uint32_t family = base_family;
  151. uint32_t model = base_model;
  152. if (base_family == 0xf) {
  153. const uint32_t ext_family = (eax >> 20) & 255;
  154. family += ext_family;
  155. const uint32_t ext_model = (eax >> 16) & 15;
  156. model |= ext_model << 4;
  157. }
  158. if (family < 0x17 || (family == 0x17 && 0x70 <= model && model <= 0x7f)) {
  159. // Disable RDRAND on AMD families before 0x17 (Zen) due to reported
  160. // failures after suspend.
  161. // https://bugzilla.redhat.com/show_bug.cgi?id=1150286
  162. // Also disable for family 0x17, models 0x70–0x7f, due to possible RDRAND
  163. // failures there too.
  164. ecx &= ~(1u << 30);
  165. }
  166. }
  167. // Force the hyper-threading bit so that the more conservative path is always
  168. // chosen.
  169. edx |= 1u << 28;
  170. // Reserved bit #20 was historically repurposed to control the in-memory
  171. // representation of RC4 state. Always set it to zero.
  172. edx &= ~(1u << 20);
  173. // Reserved bit #30 is repurposed to signal an Intel CPU.
  174. if (is_intel) {
  175. edx |= (1u << 30);
  176. // Clear the XSAVE bit on Knights Landing to mimic Silvermont. This enables
  177. // some Silvermont-specific codepaths which perform better. See OpenSSL
  178. // commit 64d92d74985ebb3d0be58a9718f9e080a14a8e7f.
  179. if ((eax & 0x0fff0ff0) == 0x00050670 /* Knights Landing */ ||
  180. (eax & 0x0fff0ff0) == 0x00080650 /* Knights Mill (per SDE) */) {
  181. ecx &= ~(1u << 26);
  182. }
  183. } else {
  184. edx &= ~(1u << 30);
  185. }
  186. // The SDBG bit is repurposed to denote AMD XOP support. Don't ever use AMD
  187. // XOP code paths.
  188. ecx &= ~(1u << 11);
  189. uint64_t xcr0 = 0;
  190. if (ecx & (1u << 27)) {
  191. // XCR0 may only be queried if the OSXSAVE bit is set.
  192. xcr0 = OPENSSL_xgetbv(0);
  193. }
  194. // See Intel manual, volume 1, section 14.3.
  195. if ((xcr0 & 6) != 6) {
  196. // YMM registers cannot be used.
  197. ecx &= ~(1u << 28); // AVX
  198. ecx &= ~(1u << 12); // FMA
  199. ecx &= ~(1u << 11); // AMD XOP
  200. // Clear AVX2 and AVX512* bits.
  201. //
  202. // TODO(davidben): Should bits 17 and 26-28 also be cleared? Upstream
  203. // doesn't clear those.
  204. extended_features[0] &=
  205. ~((1u << 5) | (1u << 16) | (1u << 21) | (1u << 30) | (1u << 31));
  206. }
  207. // See Intel manual, volume 1, section 15.2.
  208. if ((xcr0 & 0xe6) != 0xe6) {
  209. // Clear AVX512F. Note we don't touch other AVX512 extensions because they
  210. // can be used with YMM.
  211. extended_features[0] &= ~(1u << 16);
  212. }
  213. // Disable ADX instructions on Knights Landing. See OpenSSL commit
  214. // 64d92d74985ebb3d0be58a9718f9e080a14a8e7f.
  215. if ((ecx & (1u << 26)) == 0) {
  216. extended_features[0] &= ~(1u << 19);
  217. }
  218. OPENSSL_ia32cap_P[0] = edx;
  219. OPENSSL_ia32cap_P[1] = ecx;
  220. OPENSSL_ia32cap_P[2] = extended_features[0];
  221. OPENSSL_ia32cap_P[3] = extended_features[1];
  222. const char *env1, *env2;
  223. env1 = getenv("OPENSSL_ia32cap");
  224. if (env1 == NULL) {
  225. return;
  226. }
  227. // OPENSSL_ia32cap can contain zero, one or two values, separated with a ':'.
  228. // Each value is a 64-bit, unsigned value which may start with "0x" to
  229. // indicate a hex value. Prior to the 64-bit value, a '~' may be given.
  230. //
  231. // If '~' isn't present, then the value is taken as the result of the CPUID.
  232. // Otherwise the value is inverted and ANDed with the probed CPUID result.
  233. //
  234. // The first value determines OPENSSL_ia32cap_P[0] and [1]. The second [2]
  235. // and [3].
  236. handle_cpu_env(&OPENSSL_ia32cap_P[0], env1);
  237. env2 = strchr(env1, ':');
  238. if (env2 != NULL) {
  239. handle_cpu_env(&OPENSSL_ia32cap_P[2], env2 + 1);
  240. }
  241. }
  242. #endif // !OPENSSL_NO_ASM && (OPENSSL_X86 || OPENSSL_X86_64)