46afd1988083ed20de053fd6a0ede2dd23c3bc10
[openssl.git] / doc / crypto / OPENSSL_ia32cap.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_ia32cap
6
7 =head1 SYNOPSIS
8
9  extern unsigned long OPENSSL_ia32cap;
10  unsigned long *OPENSSL_ia32cap_loc();
11
12 =head1 DESCRIPTION
13
14 OPENSSL_ia32cap is a variable containing IA-32 processor capabilities
15 bit vector as it appears in EDX register after executing CPUID
16 instruction with EAX=1 input value (see Intel Application Note
17 #241618). Naturally it's defined/meaningful on IA-32 platforms only.
18 The variable is normally set up automatically upon toolkit
19 initialization and can be manipulated afterwards to modify crypto
20 library behaviour. For the moment of this writing only two bits are
21 significant, namely bit #26 denoting SSE2 support, and bit #4 denoting
22 presence of Time-Stamp Counter. Resetting bit #26 at run-time for
23 example disables high-performance SSE2 code present in the crypto
24 library. You might have to do this if target OpenSSL application is
25 executed on SSE2 capable CPU, but under control of OS which does not
26 support SSE2 extentions. Even though you can programmatically
27 manipulate the value, you most likely will find it more appropriate to
28 set up an environment variable with the same name prior starting target
29 application, e.g. 'env OPENSSL_ia32cap=0x10 apps/openssl', to achieve
30 same effect without modifying the application source code.
31 Alternatively you can reconfigure the toolkit with no-sse2 option and
32 recompile.
33
34 =cut