s390x assembly pack: update OPENSSL_s390xcap(3)
[openssl.git] / doc / man3 / OPENSSL_s390xcap.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_s390xcap - the IBM z processor capabilities vector
6
7 =head1 SYNOPSIS
8
9  env OPENSSL_s390xcap=... <application>
10
11 =head1 DESCRIPTION
12
13 libcrypto supports z/Architecture instruction set extensions. These
14 extensions are denoted by individual bits in the capabilities vector.
15 When libcrypto is initialized, the bits returned by the STFLE instruction
16 and by the QUERY functions are stored in the vector.
17
18 To change the set of instructions available to an application, you can
19 set the OPENSSL_s390xcap environment variable before you start the
20 application. After initialization, the capability vector is ANDed bitwise
21 with a mask which is derived from the environment variable.
22
23 The environment variable is a semicolon-separated list of tokens which is
24 processed from left to right (whitespace is ignored):
25
26  OPENSSL_s390xcap="<tok1>;<tok2>;..."
27
28 There are three types of tokens:
29
30 =over 4
31
32 =item <string>
33
34 The name of a processor generation. A bit in the environment variable's
35 mask is set to one if and only if the specified processor generation
36 implements the corresponding instruction set extension. Possible values
37 are z900, z990, z9, z10, z196, zEC12, z13, z14 and z15.
38
39 =item <string>:<mask>:<mask>
40
41 The name of an instruction followed by two 64-bit masks. The part of the
42 environment variable's mask corresponding to the specified instruction is
43 set to the specified 128-bit mask. Possible values are kimd, klmd, km, kmc,
44 kmac, kmctr, kmo, kmf, prno, kma, pcc and kdsa.
45
46 =item stfle:<mask>:<mask>:<mask>
47
48 Store-facility-list-extended (stfle) followed by three 64-bit masks. The
49 part of the environment variable's mask corresponding to the stfle
50 instruction is set to the specified 192-bit mask.
51
52 =back
53
54 The 64-bit masks are specified in hexadecimal notation. The 0x prefix is
55 optional. Prefix a mask with a tilde (~) to denote a bitwise NOT operation.
56
57 The following is a list of significant bits for each instruction. Colon
58 rows separate the individual 64-bit masks. The bit numbers in the first
59 column are consistent with [1], that is, 0 denotes the leftmost bit and
60 the numbering is continuous across 64-bit mask boundaries.
61
62       Bit     Mask     Facility/Function
63
64  stfle:
65       # 17    1<<46    message-security assist
66       # 25    1<<38    store-clock-fast facility
67       :
68       # 76    1<<51    message-security assist extension 3
69       # 77    1<<50    message-security assist extension 4
70       :
71       #129    1<<62    vector facility
72       #134    1<<57    vector packed decimal facility
73       #135    1<<56    vector enhancements facility 1
74       #146    1<<45    message-security assist extension 8
75
76  kimd :
77       #  1    1<<62    KIMD-SHA-1
78       #  2    1<<61    KIMD-SHA-256
79       #  3    1<<60    KIMD-SHA-512
80       # 32    1<<31    KIMD-SHA3-224
81       # 33    1<<30    KIMD-SHA3-256
82       # 34    1<<29    KIMD-SHA3-384
83       # 35    1<<28    KIMD-SHA3-512
84       # 36    1<<27    KIMD-SHAKE-128
85       # 37    1<<26    KIMD-SHAKE-256
86       :
87       # 65    1<<62    KIMD-GHASH
88
89  klmd :
90       # 32    1<<31    KLMD-SHA3-224
91       # 33    1<<30    KLMD-SHA3-256
92       # 34    1<<29    KLMD-SHA3-384
93       # 35    1<<28    KLMD-SHA3-512
94       # 36    1<<27    KLMD-SHAKE-128
95       # 37    1<<26    KLMD-SHAKE-256
96       :
97
98  km   :
99       # 18    1<<45    KM-AES-128
100       # 19    1<<44    KM-AES-192
101       # 20    1<<43    KM-AES-256
102       # 50    1<<13    KM-XTS-AES-128
103       # 52    1<<11    KM-XTS-AES-256
104       :
105
106  kmc  :
107       # 18    1<<45    KMC-AES-128
108       # 19    1<<44    KMC-AES-192
109       # 20    1<<43    KMC-AES-256
110       :
111
112  kmac :
113       # 18    1<<45    KMAC-AES-128
114       # 19    1<<44    KMAC-AES-192
115       # 20    1<<43    KMAC-AES-256
116       :
117
118  kmctr:
119       :
120
121  kmo  :
122       # 18    1<<45    KMO-AES-128
123       # 19    1<<44    KMO-AES-192
124       # 20    1<<43    KMO-AES-256
125       :
126
127  kmf  :
128       # 18    1<<45    KMF-AES-128
129       # 19    1<<44    KMF-AES-192
130       # 20    1<<43    KMF-AES-256
131       :
132
133  prno :
134       :
135
136  kma  :
137       # 18    1<<45    KMA-GCM-AES-128
138       # 19    1<<44    KMA-GCM-AES-192
139       # 20    1<<43    KMA-GCM-AES-256
140       :
141
142  pcc  :
143       :
144       # 64    1<<63    PCC-Scalar-Multiply-P256
145       # 65    1<<62    PCC-Scalar-Multiply-P384
146       # 66    1<<61    PCC-Scalar-Multiply-P521
147
148  kdsa :
149       #  1    1<<62    KDSA-ECDSA-Verify-P256
150       #  2    1<<61    KDSA-ECDSA-Verify-P384
151       #  3    1<<60    KDSA-ECDSA-Verify-P521
152       #  9    1<<54    KDSA-ECDSA-Sign-P256
153       # 10    1<<53    KDSA-ECDSA-Sign-P384
154       # 11    1<<52    KDSA-ECDSA-Sign-P521
155       :
156
157 =head1 RETURN VALUES
158
159 Not available.
160
161 =head1 EXAMPLES
162
163 Disables all instruction set extensions which the z196 processor does not implement:
164
165  OPENSSL_s390xcap="z196"
166
167 Disables the vector facility:
168
169  OPENSSL_s390xcap="stfle:~0:~0:~0x4000000000000000"
170
171 Disables the KM-XTS-AES and and the KIMD-SHAKE function codes:
172
173  OPENSSL_s390xcap="km:~0x2800:~0;kimd:~0xc000000:~0"
174
175 =head1 SEE ALSO
176
177 [1] z/Architecture Principles of Operation, SA22-7832-12
178
179 =head1 COPYRIGHT
180
181 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
182
183 Licensed under the Apache License 2.0 (the "License").  You may not use
184 this file except in compliance with the License.  You can obtain a copy
185 in the file LICENSE in the source distribution or at
186 L<https://www.openssl.org/source/license.html>.
187
188 =cut