4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
25 typedef enum qat_compress_dir
{
30 typedef enum qat_encrypt_dir
{
36 #if defined(_KERNEL) && defined(HAVE_QAT)
38 #include <sys/crypto/api.h>
40 #include "dc/cpa_dc.h"
41 #include "lac/cpa_cy_sym.h"
44 * Timeout - no response from hardware after 0.5 seconds
46 #define QAT_TIMEOUT_MS 500
49 * The minimal and maximal buffer size which are not restricted
50 * in the QAT hardware, but with the input buffer size between 4KB
51 * and 128KB the hardware can provide the optimal performance.
53 #define QAT_MIN_BUF_SIZE (4*1024)
54 #define QAT_MAX_BUF_SIZE (128*1024)
59 typedef struct qat_stats
{
61 * Number of jobs submitted to QAT compression engine.
63 kstat_named_t comp_requests
;
65 * Total bytes sent to QAT compression engine.
67 kstat_named_t comp_total_in_bytes
;
69 * Total bytes output from QAT compression engine.
71 kstat_named_t comp_total_out_bytes
;
73 * Number of jobs submitted to QAT de-compression engine.
75 kstat_named_t decomp_requests
;
77 * Total bytes sent to QAT de-compression engine.
79 kstat_named_t decomp_total_in_bytes
;
81 * Total bytes output from QAT de-compression engine.
83 kstat_named_t decomp_total_out_bytes
;
85 * Number of fails in the QAT compression / decompression engine.
86 * Note: when a QAT error happens, it doesn't necessarily indicate a
87 * critical hardware issue. Sometimes it is because the output buffer
88 * is not big enough. The compression job will be transfered to the
89 * gzip software implementation so the functionality of ZFS is not
92 kstat_named_t dc_fails
;
95 * Number of jobs submitted to QAT encryption engine.
97 kstat_named_t encrypt_requests
;
99 * Total bytes sent to QAT encryption engine.
101 kstat_named_t encrypt_total_in_bytes
;
103 * Total bytes output from QAT encryption engine.
105 kstat_named_t encrypt_total_out_bytes
;
107 * Number of jobs submitted to QAT decryption engine.
109 kstat_named_t decrypt_requests
;
111 * Total bytes sent to QAT decryption engine.
113 kstat_named_t decrypt_total_in_bytes
;
115 * Total bytes output from QAT decryption engine.
117 kstat_named_t decrypt_total_out_bytes
;
119 * Number of fails in the QAT encryption / decryption engine.
120 * Note: when a QAT error happens, it doesn't necessarily indicate a
121 * critical hardware issue. The encryption job will be transfered
122 * to the software implementation so the functionality of ZFS is
125 kstat_named_t crypt_fails
;
128 * Number of jobs submitted to QAT checksum engine.
130 kstat_named_t cksum_requests
;
132 * Total bytes sent to QAT checksum engine.
134 kstat_named_t cksum_total_in_bytes
;
136 * Number of fails in the QAT checksum engine.
137 * Note: when a QAT error happens, it doesn't necessarily indicate a
138 * critical hardware issue. The checksum job will be transfered to the
139 * software implementation so the functionality of ZFS is not impacted.
141 kstat_named_t cksum_fails
;
144 #define QAT_STAT_INCR(stat, val) \
145 atomic_add_64(&qat_stats.stat.value.ui64, (val))
146 #define QAT_STAT_BUMP(stat) \
147 QAT_STAT_INCR(stat, 1)
149 extern qat_stats_t qat_stats
;
150 extern int zfs_qat_compress_disable
;
151 extern int zfs_qat_checksum_disable
;
152 extern int zfs_qat_encrypt_disable
;
154 /* inlined for performance */
155 static inline struct page
*
156 qat_mem_to_page(void *addr
)
158 if (!is_vmalloc_addr(addr
))
159 return (virt_to_page(addr
));
161 return (vmalloc_to_page(addr
));
164 CpaStatus
qat_mem_alloc_contig(void **pp_mem_addr
, Cpa32U size_bytes
);
165 void qat_mem_free_contig(void **pp_mem_addr
);
166 #define QAT_PHYS_CONTIG_ALLOC(pp_mem_addr, size_bytes) \
167 qat_mem_alloc_contig((void *)(pp_mem_addr), (size_bytes))
168 #define QAT_PHYS_CONTIG_FREE(p_mem_addr) \
169 qat_mem_free_contig((void *)&(p_mem_addr))
171 extern int qat_dc_init(void);
172 extern void qat_dc_fini(void);
173 extern int qat_cy_init(void);
174 extern void qat_cy_fini(void);
175 extern int qat_init(void);
176 extern void qat_fini(void);
178 /* fake CpaStatus used to indicate data was not compressible */
179 #define CPA_STATUS_INCOMPRESSIBLE (-127)
181 extern boolean_t
qat_dc_use_accel(size_t s_len
);
182 extern boolean_t
qat_crypt_use_accel(size_t s_len
);
183 extern boolean_t
qat_checksum_use_accel(size_t s_len
);
184 extern int qat_compress(qat_compress_dir_t dir
, char *src
, int src_len
,
185 char *dst
, int dst_len
, size_t *c_len
);
186 extern int qat_crypt(qat_encrypt_dir_t dir
, uint8_t *src_buf
, uint8_t *dst_buf
,
187 uint8_t *aad_buf
, uint32_t aad_len
, uint8_t *iv_buf
, uint8_t *digest_buf
,
188 crypto_key_t
*key
, uint64_t crypt
, uint32_t enc_len
);
189 extern int qat_checksum(uint64_t cksum
, uint8_t *buf
, uint64_t size
,
192 #define CPA_STATUS_SUCCESS 0
193 #define CPA_STATUS_INCOMPRESSIBLE (-127)
196 #define qat_dc_use_accel(s_len) 0
197 #define qat_crypt_use_accel(s_len) 0
198 #define qat_checksum_use_accel(s_len) 0
199 #define qat_compress(dir, s, sl, d, dl, cl) 0
200 #define qat_crypt(dir, s, d, a, al, i, db, k, c, el) 0
201 #define qat_checksum(c, buf, s, z) 0
204 #endif /* _SYS_QAT_H */