b7d8a7618f085027c42c205271e9c74fd9547d95
[openssl.git] / doc / crypto / OPENSSL_ia32cap.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_ia32cap - finding the IA-32 processor capabilities
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 seven bits are significant, namely:
22
23 1. bit #4 denoting presence of Time-Stamp Counter.
24 2. bit #20, reserved by Intel, is used to choose between RC4 code
25    paths;
26 3. bit #23 denoting MMX support;
27 4. bit #25 denoting SSE support;
28 5. bit #26 denoting SSE2 support;
29 6. bit #28 denoting Hyperthreading, which is used to distiguish
30    cores with shared cache;
31 7. bit #57 denoting Intel AES instruction set extension;
32
33 For example, clearing bit #26 at run-time disables high-performance
34 SSE2 code present in the crypto library. You might have to do this if
35 target OpenSSL application is executed on SSE2 capable CPU, but under
36 control of OS which does not support SSE2 extentions. Even though you
37 can manipulate the value programmatically, you most likely will find it
38 more appropriate to set up an environment variable with the same name
39 prior starting target application, e.g. on Intel P4 processor 'env
40 OPENSSL_ia32cap=0x12900010 apps/openssl', to achieve same effect
41 without modifying the application source code. Alternatively you can
42 reconfigure the toolkit with no-sse2 option and recompile.
43
44 Less intuituve is clearing bit #28. The truth is that it's not copied
45 from CPUID output verbatim, but is adjusted to reflect whether or not
46 the data cache is actually shared between logical cores. This in turn
47 affects the decision on whether or not expensive countermeasures
48 against cache-timing attacks are applied, most notably in AES assembler
49 module.
50 =cut