$NetBSD: OPENSSL_ia32cap.3,v 1.17 2018/02/08 21:57:26 christos Exp $

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\}
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OPENSSL_ia32cap 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
OPENSSL_ia32cap - the x86[_64] processor capabilities vector libcrypto, -lcrypto Header "SYNOPSIS" .Vb 1 env OPENSSL_ia32cap=... <application> .Ve Header "DESCRIPTION" OpenSSL supports a range of x86[_64] instruction set extensions. These extensions are denoted by individual bits in capability vector returned by processor in \s-1EDX:ECX\s0 register pair after executing \s-1CPUID\s0 instruction with EAX=1 input value (see Intel Application Note #241618). This vector is copied to memory upon toolkit initialization and used to choose between different code paths to provide optimal performance across wide range of processors. For the moment of this writing following bits are significant: Item "bit #4 denoting presence of Time-Stamp Counter."

0

Item "bit #19 denoting availability of CLFLUSH instruction;" Item "bit #20, reserved by Intel, is used to choose among RC4 code paths;" Item "bit #23 denoting MMX support;" Item "bit #24, FXSR bit, denoting availability of XMM registers;" Item "bit #25 denoting SSE support;" Item "bit #26 denoting SSE2 support;" Item "bit #28 denoting Hyperthreading, which is used to distinguish cores with shared cache;" Item "bit #30, reserved by Intel, denotes specifically Intel CPUs;" Item "bit #33 denoting availability of PCLMULQDQ instruction;" Item "bit #41 denoting SSSE3, Supplemental SSE3, support;" Item "bit #43 denoting AMD XOP support (forced to zero on non-AMD CPUs);" Item "bit #54 denoting availability of MOVBE instruction;" Item "bit #57 denoting AES-NI instruction set extension;" Item "bit #58, XSAVE bit, lack of which in combination with MOVBE is used to identify Atom Silvermont core;" Item "bit #59, OSXSAVE bit, denoting availability of YMM registers;" Item "bit #60 denoting AVX extension;" Item "bit #62 denoting availability of RDRAND instruction;"

For example, in 32-bit application context clearing bit #26 at run-time disables high-performance \s-1SSE2\s0 code present in the crypto library, while clearing bit #24 disables \s-1SSE2\s0 code operating on 128-bit \s-1XMM\s0 register bank. You might have to do the latter if target OpenSSL application is executed on \s-1SSE2\s0 capable \s-1CPU,\s0 but under control of \s-1OS\s0 that does not enable \s-1XMM\s0 registers. Historically address of the capability vector copy was exposed to application through OPENSSL_ia32cap_loc(), but not anymore. Now the only way to affect the capability detection is to set OPENSSL_ia32cap environment variable prior target application start. To give a specific example, on Intel P4 processor 'env OPENSSL_ia32cap=0x16980010 apps/openssl', or better yet 'env OPENSSL_ia32cap=~0x1000000 apps/openssl' would achieve the desired effect. Alternatively you can reconfigure the toolkit with no-sse2 option and recompile.

Less intuitive is clearing bit #28, or ~0x10000000 in the \*(L"environment variable\*(R" terms. The truth is that it's not copied from \s-1CPUID\s0 output verbatim, but is adjusted to reflect whether or not the data cache is actually shared between logical cores. This in turn affects the decision on whether or not expensive countermeasures against cache-timing attacks are applied, most notably in \s-1AES\s0 assembler module.

The capability vector is further extended with \s-1EBX\s0 value returned by \s-1CPUID\s0 with EAX=7 and ECX=0 as input. Following bits are significant:

Item "bit #64+3 denoting availability of BMI1 instructions, e.g. ANDN;"

0

Item "bit #64+5 denoting availability of AVX2 instructions;" Item "bit #64+8 denoting availability of BMI2 instructions, e.g. MULX and RORX;" Item "bit #64+16 denoting availability of AVX512F extension;" Item "bit #64+18 denoting availability of RDSEED instruction;" Item "bit #64+19 denoting availability of ADCX and ADOX instructions;" Item "bit #64+29 denoting availability of SHA extension;" Item "bit #64+30 denoting availability of AVX512BW extension;" Item "bit #64+31 denoting availability of AVX512VL extension;"

To control this extended capability word use ':' as delimiter when setting up OPENSSL_ia32cap environment variable. For example assigning ':~0x20' would disable \s-1AVX2\s0 code paths, and ':0' - all post-AVX extensions.

It should be noted that whether or not some of the most \*(L"fancy\*(R" extension code paths are actually assembled depends on current assembler version. Base minimum of \s-1AES-NI/PCLMULQDQ, SSSE3\s0 and \s-1SHA\s0 extension code paths are always assembled. Besides that, minimum assembler version requirements are summarized in below table:

.Vb 5 Extension | GNU as | nasm | llvm ------------+--------+--------+-------- AVX | 2.19 | 2.09 | 3.0 AVX2 | 2.22 | 2.10 | 3.1 AVX512 | 2.25 | 2.11.8 | 3.6 .Ve

\fBOPENSSL_ia32cap is a macro returning the first word of the vector.

Header "COPYRIGHT" Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.