5bf1e8818b8cf46d58e26ba58a09edf65773c0d9
[dpdk.git] / app / test / test_cryptodev.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2017 Intel Corporation
3  */
4 #ifndef TEST_CRYPTODEV_H_
5 #define TEST_CRYPTODEV_H_
6
7 #define HEX_DUMP 0
8
9 #define FALSE                           0
10 #define TRUE                            1
11
12 #define MAX_NUM_OPS_INFLIGHT            (4096)
13 #define MIN_NUM_OPS_INFLIGHT            (128)
14 #define DEFAULT_NUM_OPS_INFLIGHT        (128)
15
16 #define MAX_NUM_QPS_PER_QAT_DEVICE      (2)
17 #define DEFAULT_NUM_QPS_PER_QAT_DEVICE  (2)
18 #define DEFAULT_BURST_SIZE              (64)
19 #define DEFAULT_NUM_XFORMS              (2)
20 #define NUM_MBUFS                       (8191)
21 #define MBUF_CACHE_SIZE                 (256)
22 #define MBUF_DATAPAYLOAD_SIZE           (2048 + DIGEST_BYTE_LENGTH_SHA512)
23 #define MBUF_SIZE                       (sizeof(struct rte_mbuf) + \
24                 RTE_PKTMBUF_HEADROOM + MBUF_DATAPAYLOAD_SIZE)
25
26 #define BYTE_LENGTH(x)                          (x/8)
27 /* HASH DIGEST LENGTHS */
28 #define DIGEST_BYTE_LENGTH_MD5                  (BYTE_LENGTH(128))
29 #define DIGEST_BYTE_LENGTH_SHA1                 (BYTE_LENGTH(160))
30 #define DIGEST_BYTE_LENGTH_SHA224               (BYTE_LENGTH(224))
31 #define DIGEST_BYTE_LENGTH_SHA256               (BYTE_LENGTH(256))
32 #define DIGEST_BYTE_LENGTH_SHA384               (BYTE_LENGTH(384))
33 #define DIGEST_BYTE_LENGTH_SHA512               (BYTE_LENGTH(512))
34 #define DIGEST_BYTE_LENGTH_AES_XCBC             (BYTE_LENGTH(96))
35 #define DIGEST_BYTE_LENGTH_SNOW3G_UIA2          (BYTE_LENGTH(32))
36 #define DIGEST_BYTE_LENGTH_KASUMI_F9            (BYTE_LENGTH(32))
37 #define AES_XCBC_MAC_KEY_SZ                     (16)
38 #define DIGEST_BYTE_LENGTH_AES_GCM              (BYTE_LENGTH(128))
39
40 #define TRUNCATED_DIGEST_BYTE_LENGTH_SHA1               (12)
41 #define TRUNCATED_DIGEST_BYTE_LENGTH_SHA224             (16)
42 #define TRUNCATED_DIGEST_BYTE_LENGTH_SHA256             (16)
43 #define TRUNCATED_DIGEST_BYTE_LENGTH_SHA384             (24)
44 #define TRUNCATED_DIGEST_BYTE_LENGTH_SHA512             (32)
45
46 #define MAXIMUM_IV_LENGTH                               (16)
47 #define AES_GCM_J0_LENGTH                               (16)
48
49 #define IV_OFFSET                       (sizeof(struct rte_crypto_op) + \
50                 sizeof(struct rte_crypto_sym_op) + DEFAULT_NUM_XFORMS * \
51                 sizeof(struct rte_crypto_sym_xform))
52
53 #define CRYPTODEV_NAME_NULL_PMD         crypto_null
54 #define CRYPTODEV_NAME_AESNI_MB_PMD     crypto_aesni_mb
55 #define CRYPTODEV_NAME_AESNI_GCM_PMD    crypto_aesni_gcm
56 #define CRYPTODEV_NAME_OPENSSL_PMD      crypto_openssl
57 #define CRYPTODEV_NAME_QAT_SYM_PMD      crypto_qat
58 #define CRYPTODEV_NAME_QAT_ASYM_PMD     crypto_qat_asym
59 #define CRYPTODEV_NAME_SNOW3G_PMD       crypto_snow3g
60 #define CRYPTODEV_NAME_KASUMI_PMD       crypto_kasumi
61 #define CRYPTODEV_NAME_ZUC_PMD          crypto_zuc
62 #define CRYPTODEV_NAME_ARMV8_PMD        crypto_armv8
63 #define CRYPTODEV_NAME_DPAA_SEC_PMD     crypto_dpaa_sec
64 #define CRYPTODEV_NAME_DPAA2_SEC_PMD    crypto_dpaa2_sec
65 #define CRYPTODEV_NAME_SCHEDULER_PMD    crypto_scheduler
66 #define CRYPTODEV_NAME_MVSAM_PMD                crypto_mvsam
67 #define CRYPTODEV_NAME_CCP_PMD          crypto_ccp
68 #define CRYPTODEV_NAME_VIRTIO_PMD       crypto_virtio
69 #define CRYPTODEV_NAME_OCTEONTX_SYM_PMD crypto_octeontx
70 #define CRYPTODEV_NAME_OCTEONTX2_PMD    crypto_octeontx2
71 #define CRYPTODEV_NAME_CAAM_JR_PMD      crypto_caam_jr
72 #define CRYPTODEV_NAME_NITROX_PMD       crypto_nitrox_sym
73 #define CRYPTODEV_NAME_BCMFS_PMD        crypto_bcmfs
74 #define CRYPTODEV_NAME_CN9K_PMD         crypto_cn9k
75 #define CRYPTODEV_NAME_CN10K_PMD        crypto_cn10k
76
77 enum cryptodev_api_test_type {
78         CRYPTODEV_API_TEST = 0,
79         CRYPTODEV_RAW_API_TEST
80 };
81
82 extern enum cryptodev_api_test_type global_api_test_type;
83
84 extern struct crypto_testsuite_params *p_testsuite_params;
85 struct crypto_testsuite_params {
86         struct rte_mempool *mbuf_pool;
87         struct rte_mempool *large_mbuf_pool;
88         struct rte_mempool *op_mpool;
89         struct rte_mempool *session_mpool;
90         struct rte_mempool *session_priv_mpool;
91         struct rte_cryptodev_config conf;
92         struct rte_cryptodev_qp_conf qp_conf;
93
94         uint8_t valid_devs[RTE_CRYPTO_MAX_DEVS];
95         uint8_t valid_dev_count;
96 };
97
98 /**
99  * Write (spread) data from buffer to mbuf data
100  *
101  * @param mbuf
102  *   Destination mbuf
103  * @param offset
104  *   Start offset in mbuf
105  * @param len
106  *   Number of bytes to copy
107  * @param buffer
108  *   Continuous source buffer
109  */
110 static inline void
111 pktmbuf_write(struct rte_mbuf *mbuf, int offset, int len, const uint8_t *buffer)
112 {
113         int n = len;
114         int l;
115         struct rte_mbuf *m;
116         char *dst;
117
118         for (m = mbuf; (m != NULL) && (offset > m->data_len); m = m->next)
119                 offset -= m->data_len;
120
121         l = m->data_len - offset;
122
123         /* copy data from first segment */
124         dst = rte_pktmbuf_mtod_offset(m, char *, offset);
125         if (len <= l) {
126                 rte_memcpy(dst, buffer, len);
127                 return;
128         }
129
130         rte_memcpy(dst, buffer, l);
131         buffer += l;
132         n -= l;
133
134         for (m = m->next; (m != NULL) && (n > 0); m = m->next) {
135                 dst = rte_pktmbuf_mtod(m, char *);
136                 l = m->data_len;
137                 if (n < l) {
138                         rte_memcpy(dst, buffer, n);
139                         return;
140                 }
141                 rte_memcpy(dst, buffer, l);
142                 buffer += l;
143                 n -= l;
144         }
145 }
146
147 static inline uint8_t *
148 pktmbuf_mtod_offset(struct rte_mbuf *mbuf, int offset) {
149         struct rte_mbuf *m;
150
151         for (m = mbuf; (m != NULL) && (offset > m->data_len); m = m->next)
152                 offset -= m->data_len;
153
154         if (m == NULL) {
155                 printf("pktmbuf_mtod_offset: offset out of buffer\n");
156                 return NULL;
157         }
158         return rte_pktmbuf_mtod_offset(m, uint8_t *, offset);
159 }
160
161 static inline rte_iova_t
162 pktmbuf_iova_offset(struct rte_mbuf *mbuf, int offset) {
163         struct rte_mbuf *m;
164
165         for (m = mbuf; (m != NULL) && (offset > m->data_len); m = m->next)
166                 offset -= m->data_len;
167
168         if (m == NULL) {
169                 printf("pktmbuf_iova_offset: offset out of buffer\n");
170                 return 0;
171         }
172         return rte_pktmbuf_iova_offset(m, offset);
173 }
174
175 static inline struct rte_mbuf *
176 create_segmented_mbuf(struct rte_mempool *mbuf_pool, int pkt_len,
177                 int nb_segs, uint8_t pattern) {
178
179         struct rte_mbuf *m = NULL, *mbuf = NULL;
180         uint8_t *dst;
181         int data_len = 0;
182         int i, size;
183         int t_len;
184
185         if (pkt_len < 1) {
186                 printf("Packet size must be 1 or more (is %d)\n", pkt_len);
187                 return NULL;
188         }
189
190         if (nb_segs < 1) {
191                 printf("Number of segments must be 1 or more (is %d)\n",
192                                 nb_segs);
193                 return NULL;
194         }
195
196         t_len = pkt_len >= nb_segs ? pkt_len / nb_segs : 1;
197         size = pkt_len;
198
199         /* Create chained mbuf_src and fill it generated data */
200         for (i = 0; size > 0; i++) {
201
202                 m = rte_pktmbuf_alloc(mbuf_pool);
203                 if (i == 0)
204                         mbuf = m;
205
206                 if (m == NULL) {
207                         printf("Cannot create segment for source mbuf");
208                         goto fail;
209                 }
210
211                 /* Make sure if tailroom is zeroed */
212                 memset(m->buf_addr, pattern, m->buf_len);
213
214                 data_len = size > t_len ? t_len : size;
215                 dst = (uint8_t *)rte_pktmbuf_append(m, data_len);
216                 if (dst == NULL) {
217                         printf("Cannot append %d bytes to the mbuf\n",
218                                         data_len);
219                         goto fail;
220                 }
221
222                 if (mbuf != m)
223                         rte_pktmbuf_chain(mbuf, m);
224
225                 size -= data_len;
226
227         }
228         return mbuf;
229
230 fail:
231         if (mbuf)
232                 rte_pktmbuf_free(mbuf);
233         return NULL;
234 }
235
236 void
237 process_sym_raw_dp_op(uint8_t dev_id, uint16_t qp_id,
238                 struct rte_crypto_op *op, uint8_t is_cipher, uint8_t is_auth,
239                 uint8_t len_in_bits, uint8_t cipher_iv_len);
240
241 int
242 check_cipher_capabilities_supported(const enum rte_crypto_cipher_algorithm *ciphers,
243                 uint16_t num_ciphers);
244
245 int
246 check_auth_capabilities_supported(const enum rte_crypto_auth_algorithm *auths,
247                 uint16_t num_auths);
248
249 int
250 check_aead_capabilities_supported(const enum rte_crypto_aead_algorithm *aeads,
251                 uint16_t num_aeads);
252
253 int
254 ut_setup(void);
255
256 void
257 ut_teardown(void);
258
259 #endif /* TEST_CRYPTODEV_H_ */