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