New upstream version 18.02
[deb_dpdk.git] / drivers / crypto / aesni_mb / rte_aesni_mb_pmd.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2017 Intel Corporation
3  */
4
5 #include <des.h>
6
7 #include <rte_common.h>
8 #include <rte_hexdump.h>
9 #include <rte_cryptodev.h>
10 #include <rte_cryptodev_pmd.h>
11 #include <rte_bus_vdev.h>
12 #include <rte_malloc.h>
13 #include <rte_cpuflags.h>
14
15 #include "rte_aesni_mb_pmd_private.h"
16
17 static uint8_t cryptodev_driver_id;
18
19 typedef void (*hash_one_block_t)(const void *data, void *digest);
20 typedef void (*aes_keyexp_t)(const void *key, void *enc_exp_keys, void *dec_exp_keys);
21
22 /**
23  * Calculate the authentication pre-computes
24  *
25  * @param one_block_hash        Function pointer to calculate digest on ipad/opad
26  * @param ipad                  Inner pad output byte array
27  * @param opad                  Outer pad output byte array
28  * @param hkey                  Authentication key
29  * @param hkey_len              Authentication key length
30  * @param blocksize             Block size of selected hash algo
31  */
32 static void
33 calculate_auth_precomputes(hash_one_block_t one_block_hash,
34                 uint8_t *ipad, uint8_t *opad,
35                 uint8_t *hkey, uint16_t hkey_len,
36                 uint16_t blocksize)
37 {
38         unsigned i, length;
39
40         uint8_t ipad_buf[blocksize] __rte_aligned(16);
41         uint8_t opad_buf[blocksize] __rte_aligned(16);
42
43         /* Setup inner and outer pads */
44         memset(ipad_buf, HMAC_IPAD_VALUE, blocksize);
45         memset(opad_buf, HMAC_OPAD_VALUE, blocksize);
46
47         /* XOR hash key with inner and outer pads */
48         length = hkey_len > blocksize ? blocksize : hkey_len;
49
50         for (i = 0; i < length; i++) {
51                 ipad_buf[i] ^= hkey[i];
52                 opad_buf[i] ^= hkey[i];
53         }
54
55         /* Compute partial hashes */
56         (*one_block_hash)(ipad_buf, ipad);
57         (*one_block_hash)(opad_buf, opad);
58
59         /* Clean up stack */
60         memset(ipad_buf, 0, blocksize);
61         memset(opad_buf, 0, blocksize);
62 }
63
64 /** Get xform chain order */
65 static enum aesni_mb_operation
66 aesni_mb_get_chain_order(const struct rte_crypto_sym_xform *xform)
67 {
68         if (xform == NULL)
69                 return AESNI_MB_OP_NOT_SUPPORTED;
70
71         if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
72                 if (xform->next == NULL)
73                         return AESNI_MB_OP_CIPHER_ONLY;
74                 if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
75                         return AESNI_MB_OP_CIPHER_HASH;
76         }
77
78         if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
79                 if (xform->next == NULL)
80                         return AESNI_MB_OP_HASH_ONLY;
81                 if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
82                         return AESNI_MB_OP_HASH_CIPHER;
83         }
84
85         if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
86                 if (xform->aead.algo == RTE_CRYPTO_AEAD_AES_CCM) {
87                         if (xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
88                                 return AESNI_MB_OP_AEAD_CIPHER_HASH;
89                         else
90                                 return AESNI_MB_OP_AEAD_HASH_CIPHER;
91                 }
92         }
93
94         return AESNI_MB_OP_NOT_SUPPORTED;
95 }
96
97 /** Set session authentication parameters */
98 static int
99 aesni_mb_set_session_auth_parameters(const struct aesni_mb_op_fns *mb_ops,
100                 struct aesni_mb_session *sess,
101                 const struct rte_crypto_sym_xform *xform)
102 {
103         hash_one_block_t hash_oneblock_fn;
104
105         if (xform == NULL) {
106                 sess->auth.algo = NULL_HASH;
107                 return 0;
108         }
109
110         if (xform->type != RTE_CRYPTO_SYM_XFORM_AUTH) {
111                 MB_LOG_ERR("Crypto xform struct not of type auth");
112                 return -1;
113         }
114
115         /* Select auth generate/verify */
116         sess->auth.operation = xform->auth.op;
117
118         /* Set Authentication Parameters */
119         if (xform->auth.algo == RTE_CRYPTO_AUTH_AES_XCBC_MAC) {
120                 sess->auth.algo = AES_XCBC;
121                 (*mb_ops->aux.keyexp.aes_xcbc)(xform->auth.key.data,
122                                 sess->auth.xcbc.k1_expanded,
123                                 sess->auth.xcbc.k2, sess->auth.xcbc.k3);
124                 return 0;
125         }
126
127         switch (xform->auth.algo) {
128         case RTE_CRYPTO_AUTH_MD5_HMAC:
129                 sess->auth.algo = MD5;
130                 hash_oneblock_fn = mb_ops->aux.one_block.md5;
131                 break;
132         case RTE_CRYPTO_AUTH_SHA1_HMAC:
133                 sess->auth.algo = SHA1;
134                 hash_oneblock_fn = mb_ops->aux.one_block.sha1;
135                 break;
136         case RTE_CRYPTO_AUTH_SHA224_HMAC:
137                 sess->auth.algo = SHA_224;
138                 hash_oneblock_fn = mb_ops->aux.one_block.sha224;
139                 break;
140         case RTE_CRYPTO_AUTH_SHA256_HMAC:
141                 sess->auth.algo = SHA_256;
142                 hash_oneblock_fn = mb_ops->aux.one_block.sha256;
143                 break;
144         case RTE_CRYPTO_AUTH_SHA384_HMAC:
145                 sess->auth.algo = SHA_384;
146                 hash_oneblock_fn = mb_ops->aux.one_block.sha384;
147                 break;
148         case RTE_CRYPTO_AUTH_SHA512_HMAC:
149                 sess->auth.algo = SHA_512;
150                 hash_oneblock_fn = mb_ops->aux.one_block.sha512;
151                 break;
152         default:
153                 MB_LOG_ERR("Unsupported authentication algorithm selection");
154                 return -ENOTSUP;
155         }
156
157         /* Calculate Authentication precomputes */
158         calculate_auth_precomputes(hash_oneblock_fn,
159                         sess->auth.pads.inner, sess->auth.pads.outer,
160                         xform->auth.key.data,
161                         xform->auth.key.length,
162                         get_auth_algo_blocksize(sess->auth.algo));
163
164         return 0;
165 }
166
167 /** Set session cipher parameters */
168 static int
169 aesni_mb_set_session_cipher_parameters(const struct aesni_mb_op_fns *mb_ops,
170                 struct aesni_mb_session *sess,
171                 const struct rte_crypto_sym_xform *xform)
172 {
173         uint8_t is_aes = 0;
174         aes_keyexp_t aes_keyexp_fn;
175
176         if (xform == NULL) {
177                 sess->cipher.mode = NULL_CIPHER;
178                 return 0;
179         }
180
181         if (xform->type != RTE_CRYPTO_SYM_XFORM_CIPHER) {
182                 MB_LOG_ERR("Crypto xform struct not of type cipher");
183                 return -EINVAL;
184         }
185
186         /* Select cipher direction */
187         switch (xform->cipher.op) {
188         case RTE_CRYPTO_CIPHER_OP_ENCRYPT:
189                 sess->cipher.direction = ENCRYPT;
190                 break;
191         case RTE_CRYPTO_CIPHER_OP_DECRYPT:
192                 sess->cipher.direction = DECRYPT;
193                 break;
194         default:
195                 MB_LOG_ERR("Invalid cipher operation parameter");
196                 return -EINVAL;
197         }
198
199         /* Select cipher mode */
200         switch (xform->cipher.algo) {
201         case RTE_CRYPTO_CIPHER_AES_CBC:
202                 sess->cipher.mode = CBC;
203                 is_aes = 1;
204                 break;
205         case RTE_CRYPTO_CIPHER_AES_CTR:
206                 sess->cipher.mode = CNTR;
207                 is_aes = 1;
208                 break;
209         case RTE_CRYPTO_CIPHER_AES_DOCSISBPI:
210                 sess->cipher.mode = DOCSIS_SEC_BPI;
211                 is_aes = 1;
212                 break;
213         case RTE_CRYPTO_CIPHER_DES_CBC:
214                 sess->cipher.mode = DES;
215                 break;
216         case RTE_CRYPTO_CIPHER_DES_DOCSISBPI:
217                 sess->cipher.mode = DOCSIS_DES;
218                 break;
219         default:
220                 MB_LOG_ERR("Unsupported cipher mode parameter");
221                 return -ENOTSUP;
222         }
223
224         /* Set IV parameters */
225         sess->iv.offset = xform->cipher.iv.offset;
226         sess->iv.length = xform->cipher.iv.length;
227
228         /* Check key length and choose key expansion function for AES */
229         if (is_aes) {
230                 switch (xform->cipher.key.length) {
231                 case AES_128_BYTES:
232                         sess->cipher.key_length_in_bytes = AES_128_BYTES;
233                         aes_keyexp_fn = mb_ops->aux.keyexp.aes128;
234                         break;
235                 case AES_192_BYTES:
236                         sess->cipher.key_length_in_bytes = AES_192_BYTES;
237                         aes_keyexp_fn = mb_ops->aux.keyexp.aes192;
238                         break;
239                 case AES_256_BYTES:
240                         sess->cipher.key_length_in_bytes = AES_256_BYTES;
241                         aes_keyexp_fn = mb_ops->aux.keyexp.aes256;
242                         break;
243                 default:
244                         MB_LOG_ERR("Invalid cipher key length");
245                         return -EINVAL;
246                 }
247
248                 /* Expanded cipher keys */
249                 (*aes_keyexp_fn)(xform->cipher.key.data,
250                                 sess->cipher.expanded_aes_keys.encode,
251                                 sess->cipher.expanded_aes_keys.decode);
252
253         } else {
254                 if (xform->cipher.key.length != 8) {
255                         MB_LOG_ERR("Invalid cipher key length");
256                         return -EINVAL;
257                 }
258                 sess->cipher.key_length_in_bytes = 8;
259
260                 des_key_schedule((uint64_t *)sess->cipher.expanded_aes_keys.encode,
261                                 xform->cipher.key.data);
262                 des_key_schedule((uint64_t *)sess->cipher.expanded_aes_keys.decode,
263                                 xform->cipher.key.data);
264         }
265
266         return 0;
267 }
268
269 static int
270 aesni_mb_set_session_aead_parameters(const struct aesni_mb_op_fns *mb_ops,
271                 struct aesni_mb_session *sess,
272                 const struct rte_crypto_sym_xform *xform)
273 {
274         aes_keyexp_t aes_keyexp_fn;
275
276         switch (xform->aead.op) {
277         case RTE_CRYPTO_AEAD_OP_ENCRYPT:
278                 sess->cipher.direction = ENCRYPT;
279                 sess->auth.operation = RTE_CRYPTO_AUTH_OP_GENERATE;
280                 break;
281         case RTE_CRYPTO_AEAD_OP_DECRYPT:
282                 sess->cipher.direction = DECRYPT;
283                 sess->auth.operation = RTE_CRYPTO_AUTH_OP_VERIFY;
284                 break;
285         default:
286                 MB_LOG_ERR("Invalid aead operation parameter");
287                 return -EINVAL;
288         }
289
290         switch (xform->aead.algo) {
291         case RTE_CRYPTO_AEAD_AES_CCM:
292                 sess->cipher.mode = CCM;
293                 sess->auth.algo = AES_CCM;
294                 break;
295         default:
296                 MB_LOG_ERR("Unsupported aead mode parameter");
297                 return -ENOTSUP;
298         }
299
300         /* Set IV parameters */
301         sess->iv.offset = xform->aead.iv.offset;
302         sess->iv.length = xform->aead.iv.length;
303
304         /* Check key length and choose key expansion function for AES */
305
306         switch (xform->aead.key.length) {
307         case AES_128_BYTES:
308                 sess->cipher.key_length_in_bytes = AES_128_BYTES;
309                 aes_keyexp_fn = mb_ops->aux.keyexp.aes128;
310                 break;
311         default:
312                 MB_LOG_ERR("Invalid cipher key length");
313                 return -EINVAL;
314         }
315
316         /* Expanded cipher keys */
317         (*aes_keyexp_fn)(xform->aead.key.data,
318                         sess->cipher.expanded_aes_keys.encode,
319                         sess->cipher.expanded_aes_keys.decode);
320
321         return 0;
322 }
323
324 /** Parse crypto xform chain and set private session parameters */
325 int
326 aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
327                 struct aesni_mb_session *sess,
328                 const struct rte_crypto_sym_xform *xform)
329 {
330         const struct rte_crypto_sym_xform *auth_xform = NULL;
331         const struct rte_crypto_sym_xform *cipher_xform = NULL;
332         const struct rte_crypto_sym_xform *aead_xform = NULL;
333         int ret;
334
335         /* Select Crypto operation - hash then cipher / cipher then hash */
336         switch (aesni_mb_get_chain_order(xform)) {
337         case AESNI_MB_OP_HASH_CIPHER:
338                 sess->chain_order = HASH_CIPHER;
339                 auth_xform = xform;
340                 cipher_xform = xform->next;
341                 break;
342         case AESNI_MB_OP_CIPHER_HASH:
343                 sess->chain_order = CIPHER_HASH;
344                 auth_xform = xform->next;
345                 cipher_xform = xform;
346                 break;
347         case AESNI_MB_OP_HASH_ONLY:
348                 sess->chain_order = HASH_CIPHER;
349                 auth_xform = xform;
350                 cipher_xform = NULL;
351                 break;
352         case AESNI_MB_OP_CIPHER_ONLY:
353                 /*
354                  * Multi buffer library operates only at two modes,
355                  * CIPHER_HASH and HASH_CIPHER. When doing ciphering only,
356                  * chain order depends on cipher operation: encryption is always
357                  * the first operation and decryption the last one.
358                  */
359                 if (xform->cipher.op == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
360                         sess->chain_order = CIPHER_HASH;
361                 else
362                         sess->chain_order = HASH_CIPHER;
363                 auth_xform = NULL;
364                 cipher_xform = xform;
365                 break;
366         case AESNI_MB_OP_AEAD_CIPHER_HASH:
367                 sess->chain_order = CIPHER_HASH;
368                 sess->aead.aad_len = xform->aead.aad_length;
369                 sess->aead.digest_len = xform->aead.digest_length;
370                 aead_xform = xform;
371                 break;
372         case AESNI_MB_OP_AEAD_HASH_CIPHER:
373                 sess->chain_order = HASH_CIPHER;
374                 sess->aead.aad_len = xform->aead.aad_length;
375                 sess->aead.digest_len = xform->aead.digest_length;
376                 aead_xform = xform;
377                 break;
378         case AESNI_MB_OP_NOT_SUPPORTED:
379         default:
380                 MB_LOG_ERR("Unsupported operation chain order parameter");
381                 return -ENOTSUP;
382         }
383
384         /* Default IV length = 0 */
385         sess->iv.length = 0;
386
387         ret = aesni_mb_set_session_auth_parameters(mb_ops, sess, auth_xform);
388         if (ret != 0) {
389                 MB_LOG_ERR("Invalid/unsupported authentication parameters");
390                 return ret;
391         }
392
393         ret = aesni_mb_set_session_cipher_parameters(mb_ops, sess,
394                         cipher_xform);
395         if (ret != 0) {
396                 MB_LOG_ERR("Invalid/unsupported cipher parameters");
397                 return ret;
398         }
399
400         if (aead_xform) {
401                 ret = aesni_mb_set_session_aead_parameters(mb_ops, sess,
402                                 aead_xform);
403                 if (ret != 0) {
404                         MB_LOG_ERR("Invalid/unsupported aead parameters");
405                         return ret;
406                 }
407         }
408
409         return 0;
410 }
411
412 /**
413  * burst enqueue, place crypto operations on ingress queue for processing.
414  *
415  * @param __qp         Queue Pair to process
416  * @param ops          Crypto operations for processing
417  * @param nb_ops       Number of crypto operations for processing
418  *
419  * @return
420  * - Number of crypto operations enqueued
421  */
422 static uint16_t
423 aesni_mb_pmd_enqueue_burst(void *__qp, struct rte_crypto_op **ops,
424                 uint16_t nb_ops)
425 {
426         struct aesni_mb_qp *qp = __qp;
427
428         unsigned int nb_enqueued;
429
430         nb_enqueued = rte_ring_enqueue_burst(qp->ingress_queue,
431                         (void **)ops, nb_ops, NULL);
432
433         qp->stats.enqueued_count += nb_enqueued;
434
435         return nb_enqueued;
436 }
437
438 /** Get multi buffer session */
439 static inline struct aesni_mb_session *
440 get_session(struct aesni_mb_qp *qp, struct rte_crypto_op *op)
441 {
442         struct aesni_mb_session *sess = NULL;
443
444         if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
445                 if (likely(op->sym->session != NULL))
446                         sess = (struct aesni_mb_session *)
447                                         get_session_private_data(
448                                         op->sym->session,
449                                         cryptodev_driver_id);
450         } else {
451                 void *_sess = NULL;
452                 void *_sess_private_data = NULL;
453
454                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
455                         return NULL;
456
457                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess_private_data))
458                         return NULL;
459
460                 sess = (struct aesni_mb_session *)_sess_private_data;
461
462                 if (unlikely(aesni_mb_set_session_parameters(qp->op_fns,
463                                 sess, op->sym->xform) != 0)) {
464                         rte_mempool_put(qp->sess_mp, _sess);
465                         rte_mempool_put(qp->sess_mp, _sess_private_data);
466                         sess = NULL;
467                 }
468                 op->sym->session = (struct rte_cryptodev_sym_session *)_sess;
469                 set_session_private_data(op->sym->session, cryptodev_driver_id,
470                         _sess_private_data);
471         }
472
473         if (unlikely(sess == NULL))
474                 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
475
476         return sess;
477 }
478
479 /**
480  * Process a crypto operation and complete a JOB_AES_HMAC job structure for
481  * submission to the multi buffer library for processing.
482  *
483  * @param       qp      queue pair
484  * @param       job     JOB_AES_HMAC structure to fill
485  * @param       m       mbuf to process
486  *
487  * @return
488  * - Completed JOB_AES_HMAC structure pointer on success
489  * - NULL pointer if completion of JOB_AES_HMAC structure isn't possible
490  */
491 static inline int
492 set_mb_job_params(JOB_AES_HMAC *job, struct aesni_mb_qp *qp,
493                 struct rte_crypto_op *op, uint8_t *digest_idx)
494 {
495         struct rte_mbuf *m_src = op->sym->m_src, *m_dst;
496         struct aesni_mb_session *session;
497         uint16_t m_offset = 0;
498
499         session = get_session(qp, op);
500         if (session == NULL) {
501                 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
502                 return -1;
503         }
504
505         /* Set crypto operation */
506         job->chain_order = session->chain_order;
507
508         /* Set cipher parameters */
509         job->cipher_direction = session->cipher.direction;
510         job->cipher_mode = session->cipher.mode;
511
512         job->aes_key_len_in_bytes = session->cipher.key_length_in_bytes;
513         job->aes_enc_key_expanded = session->cipher.expanded_aes_keys.encode;
514         job->aes_dec_key_expanded = session->cipher.expanded_aes_keys.decode;
515
516
517         /* Set authentication parameters */
518         job->hash_alg = session->auth.algo;
519         if (job->hash_alg == AES_XCBC) {
520                 job->_k1_expanded = session->auth.xcbc.k1_expanded;
521                 job->_k2 = session->auth.xcbc.k2;
522                 job->_k3 = session->auth.xcbc.k3;
523         } else if (job->hash_alg == AES_CCM) {
524                 job->u.CCM.aad = op->sym->aead.aad.data + 18;
525                 job->u.CCM.aad_len_in_bytes = session->aead.aad_len;
526         } else {
527                 job->hashed_auth_key_xor_ipad = session->auth.pads.inner;
528                 job->hashed_auth_key_xor_opad = session->auth.pads.outer;
529         }
530
531         /* Mutable crypto operation parameters */
532         if (op->sym->m_dst) {
533                 m_src = m_dst = op->sym->m_dst;
534
535                 /* append space for output data to mbuf */
536                 char *odata = rte_pktmbuf_append(m_dst,
537                                 rte_pktmbuf_data_len(op->sym->m_src));
538                 if (odata == NULL) {
539                         MB_LOG_ERR("failed to allocate space in destination "
540                                         "mbuf for source data");
541                         op->status = RTE_CRYPTO_OP_STATUS_ERROR;
542                         return -1;
543                 }
544
545                 memcpy(odata, rte_pktmbuf_mtod(op->sym->m_src, void*),
546                                 rte_pktmbuf_data_len(op->sym->m_src));
547         } else {
548                 m_dst = m_src;
549                 if (job->hash_alg == AES_CCM)
550                         m_offset = op->sym->aead.data.offset;
551                 else
552                         m_offset = op->sym->cipher.data.offset;
553         }
554
555         /* Set digest output location */
556         if (job->hash_alg != NULL_HASH &&
557                         session->auth.operation == RTE_CRYPTO_AUTH_OP_VERIFY) {
558                 job->auth_tag_output = qp->temp_digests[*digest_idx];
559                 *digest_idx = (*digest_idx + 1) % MAX_JOBS;
560         } else {
561                 if (job->hash_alg == AES_CCM)
562                         job->auth_tag_output = op->sym->aead.digest.data;
563                 else
564                         job->auth_tag_output = op->sym->auth.digest.data;
565         }
566
567         /*
568          * Multi-buffer library current only support returning a truncated
569          * digest length as specified in the relevant IPsec RFCs
570          */
571         if (job->hash_alg != AES_CCM)
572                 job->auth_tag_output_len_in_bytes =
573                                 get_truncated_digest_byte_length(job->hash_alg);
574         else
575                 job->auth_tag_output_len_in_bytes = session->aead.digest_len;
576
577
578         /* Set IV parameters */
579
580         job->iv_len_in_bytes = session->iv.length;
581
582         /* Data  Parameter */
583         job->src = rte_pktmbuf_mtod(m_src, uint8_t *);
584         job->dst = rte_pktmbuf_mtod_offset(m_dst, uint8_t *, m_offset);
585
586         if (job->hash_alg == AES_CCM) {
587                 job->cipher_start_src_offset_in_bytes =
588                                 op->sym->aead.data.offset;
589                 job->msg_len_to_cipher_in_bytes = op->sym->aead.data.length;
590                 job->hash_start_src_offset_in_bytes = op->sym->aead.data.offset;
591                 job->msg_len_to_hash_in_bytes = op->sym->aead.data.length;
592
593                 job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
594                         session->iv.offset + 1);
595         } else {
596                 job->cipher_start_src_offset_in_bytes =
597                                 op->sym->cipher.data.offset;
598                 job->msg_len_to_cipher_in_bytes = op->sym->cipher.data.length;
599
600                 job->hash_start_src_offset_in_bytes = op->sym->auth.data.offset;
601                 job->msg_len_to_hash_in_bytes = op->sym->auth.data.length;
602
603                 job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
604                         session->iv.offset);
605         }
606
607         /* Set user data to be crypto operation data struct */
608         job->user_data = op;
609
610         return 0;
611 }
612
613 static inline void
614 verify_digest(struct aesni_mb_qp *qp __rte_unused, JOB_AES_HMAC *job,
615                 struct rte_crypto_op *op) {
616         /* Verify digest if required */
617         if (job->hash_alg == AES_CCM) {
618                 if (memcmp(job->auth_tag_output, op->sym->aead.digest.data,
619                                 job->auth_tag_output_len_in_bytes) != 0)
620                         op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
621         } else {
622                 if (memcmp(job->auth_tag_output, op->sym->auth.digest.data,
623                                 job->auth_tag_output_len_in_bytes) != 0)
624                         op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
625         }
626 }
627
628 /**
629  * Process a completed job and return rte_mbuf which job processed
630  *
631  * @param qp            Queue Pair to process
632  * @param job   JOB_AES_HMAC job to process
633  *
634  * @return
635  * - Returns processed crypto operation.
636  * - Returns NULL on invalid job
637  */
638 static inline struct rte_crypto_op *
639 post_process_mb_job(struct aesni_mb_qp *qp, JOB_AES_HMAC *job)
640 {
641         struct rte_crypto_op *op = (struct rte_crypto_op *)job->user_data;
642         struct aesni_mb_session *sess = get_session_private_data(
643                                                         op->sym->session,
644                                                         cryptodev_driver_id);
645
646         if (likely(op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)) {
647                 switch (job->status) {
648                 case STS_COMPLETED:
649                         op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
650
651                         if (job->hash_alg != NULL_HASH) {
652                                 if (sess->auth.operation ==
653                                                 RTE_CRYPTO_AUTH_OP_VERIFY)
654                                         verify_digest(qp, job, op);
655                         }
656                         break;
657                 default:
658                         op->status = RTE_CRYPTO_OP_STATUS_ERROR;
659                 }
660         }
661
662         /* Free session if a session-less crypto op */
663         if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
664                 memset(sess, 0, sizeof(struct aesni_mb_session));
665                 memset(op->sym->session, 0,
666                                 rte_cryptodev_get_header_session_size());
667                 rte_mempool_put(qp->sess_mp, sess);
668                 rte_mempool_put(qp->sess_mp, op->sym->session);
669                 op->sym->session = NULL;
670         }
671
672         return op;
673 }
674
675 /**
676  * Process a completed JOB_AES_HMAC job and keep processing jobs until
677  * get_completed_job return NULL
678  *
679  * @param qp            Queue Pair to process
680  * @param job           JOB_AES_HMAC job
681  *
682  * @return
683  * - Number of processed jobs
684  */
685 static unsigned
686 handle_completed_jobs(struct aesni_mb_qp *qp, JOB_AES_HMAC *job,
687                 struct rte_crypto_op **ops, uint16_t nb_ops)
688 {
689         struct rte_crypto_op *op = NULL;
690         unsigned processed_jobs = 0;
691
692         while (job != NULL) {
693                 op = post_process_mb_job(qp, job);
694
695                 if (op) {
696                         ops[processed_jobs++] = op;
697                         qp->stats.dequeued_count++;
698                 } else {
699                         qp->stats.dequeue_err_count++;
700                         break;
701                 }
702                 if (processed_jobs == nb_ops)
703                         break;
704
705                 job = (*qp->op_fns->job.get_completed_job)(&qp->mb_mgr);
706         }
707
708         return processed_jobs;
709 }
710
711 static inline uint16_t
712 flush_mb_mgr(struct aesni_mb_qp *qp, struct rte_crypto_op **ops,
713                 uint16_t nb_ops)
714 {
715         int processed_ops = 0;
716
717         /* Flush the remaining jobs */
718         JOB_AES_HMAC *job = (*qp->op_fns->job.flush_job)(&qp->mb_mgr);
719
720         if (job)
721                 processed_ops += handle_completed_jobs(qp, job,
722                                 &ops[processed_ops], nb_ops - processed_ops);
723
724         return processed_ops;
725 }
726
727 static inline JOB_AES_HMAC *
728 set_job_null_op(JOB_AES_HMAC *job, struct rte_crypto_op *op)
729 {
730         job->chain_order = HASH_CIPHER;
731         job->cipher_mode = NULL_CIPHER;
732         job->hash_alg = NULL_HASH;
733         job->cipher_direction = DECRYPT;
734
735         /* Set user data to be crypto operation data struct */
736         job->user_data = op;
737
738         return job;
739 }
740
741 static uint16_t
742 aesni_mb_pmd_dequeue_burst(void *queue_pair, struct rte_crypto_op **ops,
743                 uint16_t nb_ops)
744 {
745         struct aesni_mb_qp *qp = queue_pair;
746
747         struct rte_crypto_op *op;
748         JOB_AES_HMAC *job;
749
750         int retval, processed_jobs = 0;
751
752         if (unlikely(nb_ops == 0))
753                 return 0;
754
755         uint8_t digest_idx = qp->digest_idx;
756         do {
757                 /* Get next operation to process from ingress queue */
758                 retval = rte_ring_dequeue(qp->ingress_queue, (void **)&op);
759                 if (retval < 0)
760                         break;
761
762                 /* Get next free mb job struct from mb manager */
763                 job = (*qp->op_fns->job.get_next)(&qp->mb_mgr);
764                 if (unlikely(job == NULL)) {
765                         /* if no free mb job structs we need to flush mb_mgr */
766                         processed_jobs += flush_mb_mgr(qp,
767                                         &ops[processed_jobs],
768                                         (nb_ops - processed_jobs) - 1);
769
770                         job = (*qp->op_fns->job.get_next)(&qp->mb_mgr);
771                 }
772
773                 retval = set_mb_job_params(job, qp, op, &digest_idx);
774                 if (unlikely(retval != 0)) {
775                         qp->stats.dequeue_err_count++;
776                         set_job_null_op(job, op);
777                 }
778
779                 /* Submit job to multi-buffer for processing */
780                 job = (*qp->op_fns->job.submit)(&qp->mb_mgr);
781
782                 /*
783                  * If submit returns a processed job then handle it,
784                  * before submitting subsequent jobs
785                  */
786                 if (job)
787                         processed_jobs += handle_completed_jobs(qp, job,
788                                         &ops[processed_jobs],
789                                         nb_ops - processed_jobs);
790
791         } while (processed_jobs < nb_ops);
792
793         qp->digest_idx = digest_idx;
794
795         if (processed_jobs < 1)
796                 processed_jobs += flush_mb_mgr(qp,
797                                 &ops[processed_jobs],
798                                 nb_ops - processed_jobs);
799
800         return processed_jobs;
801 }
802
803 static int cryptodev_aesni_mb_remove(struct rte_vdev_device *vdev);
804
805 static int
806 cryptodev_aesni_mb_create(const char *name,
807                         struct rte_vdev_device *vdev,
808                         struct rte_cryptodev_pmd_init_params *init_params)
809 {
810         struct rte_cryptodev *dev;
811         struct aesni_mb_private *internals;
812         enum aesni_mb_vector_mode vector_mode;
813
814         /* Check CPU for support for AES instruction set */
815         if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
816                 MB_LOG_ERR("AES instructions not supported by CPU");
817                 return -EFAULT;
818         }
819
820         dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
821         if (dev == NULL) {
822                 MB_LOG_ERR("failed to create cryptodev vdev");
823                 return -ENODEV;
824         }
825
826         /* Check CPU for supported vector instruction set */
827         if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX512F))
828                 vector_mode = RTE_AESNI_MB_AVX512;
829         else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
830                 vector_mode = RTE_AESNI_MB_AVX2;
831         else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
832                 vector_mode = RTE_AESNI_MB_AVX;
833         else
834                 vector_mode = RTE_AESNI_MB_SSE;
835
836         dev->driver_id = cryptodev_driver_id;
837         dev->dev_ops = rte_aesni_mb_pmd_ops;
838
839         /* register rx/tx burst functions for data path */
840         dev->dequeue_burst = aesni_mb_pmd_dequeue_burst;
841         dev->enqueue_burst = aesni_mb_pmd_enqueue_burst;
842
843         dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
844                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
845                         RTE_CRYPTODEV_FF_CPU_AESNI;
846
847         switch (vector_mode) {
848         case RTE_AESNI_MB_SSE:
849                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
850                 break;
851         case RTE_AESNI_MB_AVX:
852                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
853                 break;
854         case RTE_AESNI_MB_AVX2:
855                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
856                 break;
857         case RTE_AESNI_MB_AVX512:
858                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX512;
859                 break;
860         default:
861                 break;
862         }
863
864         /* Set vector instructions mode supported */
865         internals = dev->data->dev_private;
866
867         internals->vector_mode = vector_mode;
868         internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
869         internals->max_nb_sessions = init_params->max_nb_sessions;
870
871         return 0;
872 }
873
874 static int
875 cryptodev_aesni_mb_probe(struct rte_vdev_device *vdev)
876 {
877         struct rte_cryptodev_pmd_init_params init_params = {
878                 "",
879                 sizeof(struct aesni_mb_private),
880                 rte_socket_id(),
881                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS,
882                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_SESSIONS
883         };
884         const char *name, *args;
885         int retval;
886
887         name = rte_vdev_device_name(vdev);
888         if (name == NULL)
889                 return -EINVAL;
890
891         args = rte_vdev_device_args(vdev);
892
893         retval = rte_cryptodev_pmd_parse_input_args(&init_params, args);
894         if (retval) {
895                 MB_LOG_ERR("Failed to parse initialisation arguments[%s]\n",
896                                 args);
897                 return -EINVAL;
898         }
899
900         return cryptodev_aesni_mb_create(name, vdev, &init_params);
901 }
902
903 static int
904 cryptodev_aesni_mb_remove(struct rte_vdev_device *vdev)
905 {
906         struct rte_cryptodev *cryptodev;
907         const char *name;
908
909         name = rte_vdev_device_name(vdev);
910         if (name == NULL)
911                 return -EINVAL;
912
913         cryptodev = rte_cryptodev_pmd_get_named_dev(name);
914         if (cryptodev == NULL)
915                 return -ENODEV;
916
917         return rte_cryptodev_pmd_destroy(cryptodev);
918 }
919
920 static struct rte_vdev_driver cryptodev_aesni_mb_pmd_drv = {
921         .probe = cryptodev_aesni_mb_probe,
922         .remove = cryptodev_aesni_mb_remove
923 };
924
925 static struct cryptodev_driver aesni_mb_crypto_drv;
926
927 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_MB_PMD, cryptodev_aesni_mb_pmd_drv);
928 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_MB_PMD, cryptodev_aesni_mb_pmd);
929 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_MB_PMD,
930         "max_nb_queue_pairs=<int> "
931         "max_nb_sessions=<int> "
932         "socket_id=<int>");
933 RTE_PMD_REGISTER_CRYPTO_DRIVER(aesni_mb_crypto_drv,
934                 cryptodev_aesni_mb_pmd_drv,
935                 cryptodev_driver_id);