3f6458c6bd1e2cfbf6b74421de4622ce09117e36
[openssl.git] / doc / crypto / OPENSSL_ia32cap.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_ia32cap - the IA-32 processor capabilities vector
6
7 =head1 SYNOPSIS
8
9  unsigned int *OPENSSL_ia32cap_loc(void);
10  #define OPENSSL_ia32cap ((OPENSSL_ia32cap_loc())[0])
11
12 =head1 DESCRIPTION
13
14 Value returned by OPENSSL_ia32cap_loc() is address of a variable
15 containing IA-32 processor capabilities bit vector as it appears in
16 EDX:ECX register pair after executing CPUID instruction with EAX=1
17 input value (see Intel Application Note #241618). Naturally it's
18 meaningful on x86 and x86_64 platforms only. The variable is normally
19 set up automatically upon toolkit initialization, but can be
20 manipulated afterwards to modify crypto library behaviour. For the
21 moment of this writing following bits are significant:
22
23 =item bit #4 denoting presence of Time-Stamp Counter.
24
25 =item bit #19 denoting availability of CLFLUSH instruction;
26
27 =item bit #20, reserved by Intel, is used to choose among RC4 code paths;
28
29 =item bit #23 denoting MMX support;
30
31 =item bit #24, FXSR bit, denoting availability of XMM registers;
32
33 =item bit #25 denoting SSE support;
34
35 =item bit #26 denoting SSE2 support;
36
37 =item bit #28 denoting Hyperthreading, which is used to distiguish
38       cores with shared cache;
39
40 =item bit #30, reserved by Intel, denotes specifically Intel CPUs;
41
42 =item bit #33 denoting availability of PCLMULQDQ instruction;
43
44 =item bit #41 denoting SSSE3, Supplemental SSE3, support;
45
46 =item bit #43 denoting AMD XOP support (forced to zero on non-AMD CPUs);
47
48 =item bit #57 denoting AES-NI instruction set extension;
49
50 =item bit #59, OSXSAVE bit, denoting availability of YMM registers;
51
52 =item bit #60 denoting AVX extension;
53
54 For example, clearing bit #26 at run-time disables high-performance
55 SSE2 code present in the crypto library, while clearing bit #24
56 disables SSE2 code operating on 128-bit XMM register bank. You might
57 have to do the latter if target OpenSSL application is executed on SSE2
58 capable CPU, but under control of OS that does not enable XMM
59 registers. Even though you can manipulate the value programmatically,
60 you most likely will find it more appropriate to set up an environment
61 variable with the same name prior starting target application, e.g. on
62 Intel P4 processor 'env OPENSSL_ia32cap=0x16980010 apps/openssl', to
63 achieve same effect without modifying the application source code.
64 Alternatively you can reconfigure the toolkit with no-sse2 option and
65 recompile.
66
67 Less intuituve is clearing bit #28. The truth is that it's not copied
68 from CPUID output verbatim, but is adjusted to reflect whether or not
69 the data cache is actually shared between logical cores. This in turn
70 affects the decision on whether or not expensive countermeasures
71 against cache-timing attacks are applied, most notably in AES assembler
72 module.