1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2017 Intel Corporation
5 #include <intel-ipsec-mb.h>
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>
15 #include "rte_aesni_mb_pmd_private.h"
17 #define AES_CCM_DIGEST_MIN_LEN 4
18 #define AES_CCM_DIGEST_MAX_LEN 16
19 #define HMAC_MAX_BLOCK_SIZE 128
20 static uint8_t cryptodev_driver_id;
22 typedef void (*hash_one_block_t)(const void *data, void *digest);
23 typedef void (*aes_keyexp_t)(const void *key, void *enc_exp_keys, void *dec_exp_keys);
26 * Calculate the authentication pre-computes
28 * @param one_block_hash Function pointer to calculate digest on ipad/opad
29 * @param ipad Inner pad output byte array
30 * @param opad Outer pad output byte array
31 * @param hkey Authentication key
32 * @param hkey_len Authentication key length
33 * @param blocksize Block size of selected hash algo
36 calculate_auth_precomputes(hash_one_block_t one_block_hash,
37 uint8_t *ipad, uint8_t *opad,
38 uint8_t *hkey, uint16_t hkey_len,
43 uint8_t ipad_buf[blocksize] __rte_aligned(16);
44 uint8_t opad_buf[blocksize] __rte_aligned(16);
46 /* Setup inner and outer pads */
47 memset(ipad_buf, HMAC_IPAD_VALUE, blocksize);
48 memset(opad_buf, HMAC_OPAD_VALUE, blocksize);
50 /* XOR hash key with inner and outer pads */
51 length = hkey_len > blocksize ? blocksize : hkey_len;
53 for (i = 0; i < length; i++) {
54 ipad_buf[i] ^= hkey[i];
55 opad_buf[i] ^= hkey[i];
58 /* Compute partial hashes */
59 (*one_block_hash)(ipad_buf, ipad);
60 (*one_block_hash)(opad_buf, opad);
63 memset(ipad_buf, 0, blocksize);
64 memset(opad_buf, 0, blocksize);
67 /** Get xform chain order */
68 static enum aesni_mb_operation
69 aesni_mb_get_chain_order(const struct rte_crypto_sym_xform *xform)
72 return AESNI_MB_OP_NOT_SUPPORTED;
74 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
75 if (xform->next == NULL)
76 return AESNI_MB_OP_CIPHER_ONLY;
77 if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
78 return AESNI_MB_OP_CIPHER_HASH;
81 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
82 if (xform->next == NULL)
83 return AESNI_MB_OP_HASH_ONLY;
84 if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
85 return AESNI_MB_OP_HASH_CIPHER;
88 if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
89 if (xform->aead.algo == RTE_CRYPTO_AEAD_AES_CCM ||
90 xform->aead.algo == RTE_CRYPTO_AEAD_AES_GCM) {
91 if (xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
92 return AESNI_MB_OP_AEAD_CIPHER_HASH;
94 return AESNI_MB_OP_AEAD_HASH_CIPHER;
98 return AESNI_MB_OP_NOT_SUPPORTED;
101 /** Set session authentication parameters */
103 aesni_mb_set_session_auth_parameters(const struct aesni_mb_op_fns *mb_ops,
104 struct aesni_mb_session *sess,
105 const struct rte_crypto_sym_xform *xform)
107 hash_one_block_t hash_oneblock_fn;
108 unsigned int key_larger_block_size = 0;
109 uint8_t hashed_key[HMAC_MAX_BLOCK_SIZE] = { 0 };
112 sess->auth.algo = NULL_HASH;
116 if (xform->type != RTE_CRYPTO_SYM_XFORM_AUTH) {
117 AESNI_MB_LOG(ERR, "Crypto xform struct not of type auth");
121 /* Set the request digest size */
122 sess->auth.req_digest_len = xform->auth.digest_length;
124 /* Select auth generate/verify */
125 sess->auth.operation = xform->auth.op;
127 /* Set Authentication Parameters */
128 if (xform->auth.algo == RTE_CRYPTO_AUTH_AES_XCBC_MAC) {
129 sess->auth.algo = AES_XCBC;
131 uint16_t xcbc_mac_digest_len =
132 get_truncated_digest_byte_length(AES_XCBC);
133 if (sess->auth.req_digest_len != xcbc_mac_digest_len) {
134 AESNI_MB_LOG(ERR, "Invalid digest size\n");
137 sess->auth.gen_digest_len = sess->auth.req_digest_len;
138 (*mb_ops->aux.keyexp.aes_xcbc)(xform->auth.key.data,
139 sess->auth.xcbc.k1_expanded,
140 sess->auth.xcbc.k2, sess->auth.xcbc.k3);
144 if (xform->auth.algo == RTE_CRYPTO_AUTH_AES_CMAC) {
145 sess->auth.algo = AES_CMAC;
147 uint16_t cmac_digest_len = get_digest_byte_length(AES_CMAC);
149 if (sess->auth.req_digest_len > cmac_digest_len) {
150 AESNI_MB_LOG(ERR, "Invalid digest size\n");
154 * Multi-buffer lib supports digest sizes from 4 to 16 bytes
155 * in version 0.50 and sizes of 12 and 16 bytes,
157 * If size requested is different, generate the full digest
158 * (16 bytes) in a temporary location and then memcpy
159 * the requested number of bytes.
161 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
162 if (sess->auth.req_digest_len < 4)
164 uint16_t cmac_trunc_digest_len =
165 get_truncated_digest_byte_length(AES_CMAC);
166 if (sess->auth.req_digest_len != cmac_digest_len &&
167 sess->auth.req_digest_len != cmac_trunc_digest_len)
169 sess->auth.gen_digest_len = cmac_digest_len;
171 sess->auth.gen_digest_len = sess->auth.req_digest_len;
172 (*mb_ops->aux.keyexp.aes_cmac_expkey)(xform->auth.key.data,
173 sess->auth.cmac.expkey);
175 (*mb_ops->aux.keyexp.aes_cmac_subkey)(sess->auth.cmac.expkey,
176 sess->auth.cmac.skey1, sess->auth.cmac.skey2);
180 if (xform->auth.algo == RTE_CRYPTO_AUTH_AES_GMAC) {
181 if (xform->auth.op == RTE_CRYPTO_AUTH_OP_GENERATE) {
182 sess->cipher.direction = ENCRYPT;
183 sess->chain_order = CIPHER_HASH;
185 sess->cipher.direction = DECRYPT;
187 sess->auth.algo = AES_GMAC;
189 * Multi-buffer lib supports 8, 12 and 16 bytes of digest.
190 * If size requested is different, generate the full digest
191 * (16 bytes) in a temporary location and then memcpy
192 * the requested number of bytes.
194 if (sess->auth.req_digest_len != 16 &&
195 sess->auth.req_digest_len != 12 &&
196 sess->auth.req_digest_len != 8) {
197 sess->auth.gen_digest_len = 16;
199 sess->auth.gen_digest_len = sess->auth.req_digest_len;
201 sess->iv.length = xform->auth.iv.length;
202 sess->iv.offset = xform->auth.iv.offset;
204 switch (xform->auth.key.length) {
206 sess->cipher.key_length_in_bytes = AES_128_BYTES;
207 (mb_ops->aux.keyexp.aes_gcm_128)(xform->auth.key.data,
208 &sess->cipher.gcm_key);
211 sess->cipher.key_length_in_bytes = AES_192_BYTES;
212 (mb_ops->aux.keyexp.aes_gcm_192)(xform->auth.key.data,
213 &sess->cipher.gcm_key);
216 sess->cipher.key_length_in_bytes = AES_256_BYTES;
217 (mb_ops->aux.keyexp.aes_gcm_256)(xform->auth.key.data,
218 &sess->cipher.gcm_key);
221 RTE_LOG(ERR, PMD, "failed to parse test type\n");
228 switch (xform->auth.algo) {
229 case RTE_CRYPTO_AUTH_MD5_HMAC:
230 sess->auth.algo = MD5;
231 hash_oneblock_fn = mb_ops->aux.one_block.md5;
233 case RTE_CRYPTO_AUTH_SHA1_HMAC:
234 sess->auth.algo = SHA1;
235 hash_oneblock_fn = mb_ops->aux.one_block.sha1;
236 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
237 if (xform->auth.key.length > get_auth_algo_blocksize(SHA1)) {
238 mb_ops->aux.multi_block.sha1(
239 xform->auth.key.data,
240 xform->auth.key.length,
242 key_larger_block_size = 1;
246 case RTE_CRYPTO_AUTH_SHA224_HMAC:
247 sess->auth.algo = SHA_224;
248 hash_oneblock_fn = mb_ops->aux.one_block.sha224;
249 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
250 if (xform->auth.key.length > get_auth_algo_blocksize(SHA_224)) {
251 mb_ops->aux.multi_block.sha224(
252 xform->auth.key.data,
253 xform->auth.key.length,
255 key_larger_block_size = 1;
259 case RTE_CRYPTO_AUTH_SHA256_HMAC:
260 sess->auth.algo = SHA_256;
261 hash_oneblock_fn = mb_ops->aux.one_block.sha256;
262 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
263 if (xform->auth.key.length > get_auth_algo_blocksize(SHA_256)) {
264 mb_ops->aux.multi_block.sha256(
265 xform->auth.key.data,
266 xform->auth.key.length,
268 key_larger_block_size = 1;
272 case RTE_CRYPTO_AUTH_SHA384_HMAC:
273 sess->auth.algo = SHA_384;
274 hash_oneblock_fn = mb_ops->aux.one_block.sha384;
275 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
276 if (xform->auth.key.length > get_auth_algo_blocksize(SHA_384)) {
277 mb_ops->aux.multi_block.sha384(
278 xform->auth.key.data,
279 xform->auth.key.length,
281 key_larger_block_size = 1;
285 case RTE_CRYPTO_AUTH_SHA512_HMAC:
286 sess->auth.algo = SHA_512;
287 hash_oneblock_fn = mb_ops->aux.one_block.sha512;
288 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
289 if (xform->auth.key.length > get_auth_algo_blocksize(SHA_512)) {
290 mb_ops->aux.multi_block.sha512(
291 xform->auth.key.data,
292 xform->auth.key.length,
294 key_larger_block_size = 1;
299 AESNI_MB_LOG(ERR, "Unsupported authentication algorithm selection");
302 uint16_t trunc_digest_size =
303 get_truncated_digest_byte_length(sess->auth.algo);
304 uint16_t full_digest_size =
305 get_digest_byte_length(sess->auth.algo);
307 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
308 if (sess->auth.req_digest_len > full_digest_size ||
309 sess->auth.req_digest_len == 0) {
311 if (sess->auth.req_digest_len != trunc_digest_size) {
313 AESNI_MB_LOG(ERR, "Invalid digest size\n");
317 if (sess->auth.req_digest_len != trunc_digest_size &&
318 sess->auth.req_digest_len != full_digest_size)
319 sess->auth.gen_digest_len = full_digest_size;
321 sess->auth.gen_digest_len = sess->auth.req_digest_len;
323 /* Calculate Authentication precomputes */
324 if (key_larger_block_size) {
325 calculate_auth_precomputes(hash_oneblock_fn,
326 sess->auth.pads.inner, sess->auth.pads.outer,
328 xform->auth.key.length,
329 get_auth_algo_blocksize(sess->auth.algo));
331 calculate_auth_precomputes(hash_oneblock_fn,
332 sess->auth.pads.inner, sess->auth.pads.outer,
333 xform->auth.key.data,
334 xform->auth.key.length,
335 get_auth_algo_blocksize(sess->auth.algo));
341 /** Set session cipher parameters */
343 aesni_mb_set_session_cipher_parameters(const struct aesni_mb_op_fns *mb_ops,
344 struct aesni_mb_session *sess,
345 const struct rte_crypto_sym_xform *xform)
349 aes_keyexp_t aes_keyexp_fn;
352 sess->cipher.mode = NULL_CIPHER;
356 if (xform->type != RTE_CRYPTO_SYM_XFORM_CIPHER) {
357 AESNI_MB_LOG(ERR, "Crypto xform struct not of type cipher");
361 /* Select cipher direction */
362 switch (xform->cipher.op) {
363 case RTE_CRYPTO_CIPHER_OP_ENCRYPT:
364 sess->cipher.direction = ENCRYPT;
366 case RTE_CRYPTO_CIPHER_OP_DECRYPT:
367 sess->cipher.direction = DECRYPT;
370 AESNI_MB_LOG(ERR, "Invalid cipher operation parameter");
374 /* Select cipher mode */
375 switch (xform->cipher.algo) {
376 case RTE_CRYPTO_CIPHER_AES_CBC:
377 sess->cipher.mode = CBC;
380 case RTE_CRYPTO_CIPHER_AES_CTR:
381 sess->cipher.mode = CNTR;
384 case RTE_CRYPTO_CIPHER_AES_DOCSISBPI:
385 sess->cipher.mode = DOCSIS_SEC_BPI;
388 case RTE_CRYPTO_CIPHER_DES_CBC:
389 sess->cipher.mode = DES;
391 case RTE_CRYPTO_CIPHER_DES_DOCSISBPI:
392 sess->cipher.mode = DOCSIS_DES;
394 case RTE_CRYPTO_CIPHER_3DES_CBC:
395 sess->cipher.mode = DES3;
399 AESNI_MB_LOG(ERR, "Unsupported cipher mode parameter");
403 /* Set IV parameters */
404 sess->iv.offset = xform->cipher.iv.offset;
405 sess->iv.length = xform->cipher.iv.length;
407 /* Check key length and choose key expansion function for AES */
409 switch (xform->cipher.key.length) {
411 sess->cipher.key_length_in_bytes = AES_128_BYTES;
412 aes_keyexp_fn = mb_ops->aux.keyexp.aes128;
415 sess->cipher.key_length_in_bytes = AES_192_BYTES;
416 aes_keyexp_fn = mb_ops->aux.keyexp.aes192;
419 sess->cipher.key_length_in_bytes = AES_256_BYTES;
420 aes_keyexp_fn = mb_ops->aux.keyexp.aes256;
423 AESNI_MB_LOG(ERR, "Invalid cipher key length");
427 /* Expanded cipher keys */
428 (*aes_keyexp_fn)(xform->cipher.key.data,
429 sess->cipher.expanded_aes_keys.encode,
430 sess->cipher.expanded_aes_keys.decode);
432 } else if (is_3DES) {
433 uint64_t *keys[3] = {sess->cipher.exp_3des_keys.key[0],
434 sess->cipher.exp_3des_keys.key[1],
435 sess->cipher.exp_3des_keys.key[2]};
437 switch (xform->cipher.key.length) {
439 des_key_schedule(keys[0], xform->cipher.key.data);
440 des_key_schedule(keys[1], xform->cipher.key.data+8);
441 des_key_schedule(keys[2], xform->cipher.key.data+16);
443 /* Initialize keys - 24 bytes: [K1-K2-K3] */
444 sess->cipher.exp_3des_keys.ks_ptr[0] = keys[0];
445 sess->cipher.exp_3des_keys.ks_ptr[1] = keys[1];
446 sess->cipher.exp_3des_keys.ks_ptr[2] = keys[2];
449 des_key_schedule(keys[0], xform->cipher.key.data);
450 des_key_schedule(keys[1], xform->cipher.key.data+8);
452 /* Initialize keys - 16 bytes: [K1=K1,K2=K2,K3=K1] */
453 sess->cipher.exp_3des_keys.ks_ptr[0] = keys[0];
454 sess->cipher.exp_3des_keys.ks_ptr[1] = keys[1];
455 sess->cipher.exp_3des_keys.ks_ptr[2] = keys[0];
458 des_key_schedule(keys[0], xform->cipher.key.data);
460 /* Initialize keys - 8 bytes: [K1 = K2 = K3] */
461 sess->cipher.exp_3des_keys.ks_ptr[0] = keys[0];
462 sess->cipher.exp_3des_keys.ks_ptr[1] = keys[0];
463 sess->cipher.exp_3des_keys.ks_ptr[2] = keys[0];
466 AESNI_MB_LOG(ERR, "Invalid cipher key length");
470 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
471 sess->cipher.key_length_in_bytes = 24;
473 sess->cipher.key_length_in_bytes = 8;
476 if (xform->cipher.key.length != 8) {
477 AESNI_MB_LOG(ERR, "Invalid cipher key length");
480 sess->cipher.key_length_in_bytes = 8;
482 des_key_schedule((uint64_t *)sess->cipher.expanded_aes_keys.encode,
483 xform->cipher.key.data);
484 des_key_schedule((uint64_t *)sess->cipher.expanded_aes_keys.decode,
485 xform->cipher.key.data);
492 aesni_mb_set_session_aead_parameters(const struct aesni_mb_op_fns *mb_ops,
493 struct aesni_mb_session *sess,
494 const struct rte_crypto_sym_xform *xform)
497 aes_keyexp_t aes_keyexp_fn;
498 aes_gcm_keyexp_t aes_gcm_keyexp_fn;
501 switch (xform->aead.op) {
502 case RTE_CRYPTO_AEAD_OP_ENCRYPT:
503 sess->cipher.direction = ENCRYPT;
504 sess->auth.operation = RTE_CRYPTO_AUTH_OP_GENERATE;
506 case RTE_CRYPTO_AEAD_OP_DECRYPT:
507 sess->cipher.direction = DECRYPT;
508 sess->auth.operation = RTE_CRYPTO_AUTH_OP_VERIFY;
511 AESNI_MB_LOG(ERR, "Invalid aead operation parameter");
515 switch (xform->aead.algo) {
516 case RTE_CRYPTO_AEAD_AES_CCM:
517 sess->cipher.mode = CCM;
518 sess->auth.algo = AES_CCM;
520 /* Check key length and choose key expansion function for AES */
521 switch (xform->aead.key.length) {
523 sess->cipher.key_length_in_bytes = AES_128_BYTES;
524 keyexp.aes_keyexp_fn = mb_ops->aux.keyexp.aes128;
527 AESNI_MB_LOG(ERR, "Invalid cipher key length");
531 /* Expanded cipher keys */
532 (*keyexp.aes_keyexp_fn)(xform->aead.key.data,
533 sess->cipher.expanded_aes_keys.encode,
534 sess->cipher.expanded_aes_keys.decode);
537 case RTE_CRYPTO_AEAD_AES_GCM:
538 sess->cipher.mode = GCM;
539 sess->auth.algo = AES_GMAC;
541 switch (xform->aead.key.length) {
543 sess->cipher.key_length_in_bytes = AES_128_BYTES;
544 keyexp.aes_gcm_keyexp_fn =
545 mb_ops->aux.keyexp.aes_gcm_128;
548 sess->cipher.key_length_in_bytes = AES_192_BYTES;
549 keyexp.aes_gcm_keyexp_fn =
550 mb_ops->aux.keyexp.aes_gcm_192;
553 sess->cipher.key_length_in_bytes = AES_256_BYTES;
554 keyexp.aes_gcm_keyexp_fn =
555 mb_ops->aux.keyexp.aes_gcm_256;
558 AESNI_MB_LOG(ERR, "Invalid cipher key length");
562 (keyexp.aes_gcm_keyexp_fn)(xform->aead.key.data,
563 &sess->cipher.gcm_key);
567 AESNI_MB_LOG(ERR, "Unsupported aead mode parameter");
571 /* Set IV parameters */
572 sess->iv.offset = xform->aead.iv.offset;
573 sess->iv.length = xform->aead.iv.length;
575 sess->auth.req_digest_len = xform->aead.digest_length;
576 /* CCM digests must be between 4 and 16 and an even number */
577 if (sess->auth.req_digest_len < AES_CCM_DIGEST_MIN_LEN ||
578 sess->auth.req_digest_len > AES_CCM_DIGEST_MAX_LEN ||
579 (sess->auth.req_digest_len & 1) == 1) {
580 AESNI_MB_LOG(ERR, "Invalid digest size\n");
583 sess->auth.gen_digest_len = sess->auth.req_digest_len;
588 /** Parse crypto xform chain and set private session parameters */
590 aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
591 struct aesni_mb_session *sess,
592 const struct rte_crypto_sym_xform *xform)
594 const struct rte_crypto_sym_xform *auth_xform = NULL;
595 const struct rte_crypto_sym_xform *cipher_xform = NULL;
596 const struct rte_crypto_sym_xform *aead_xform = NULL;
599 /* Select Crypto operation - hash then cipher / cipher then hash */
600 switch (aesni_mb_get_chain_order(xform)) {
601 case AESNI_MB_OP_HASH_CIPHER:
602 sess->chain_order = HASH_CIPHER;
604 cipher_xform = xform->next;
606 case AESNI_MB_OP_CIPHER_HASH:
607 sess->chain_order = CIPHER_HASH;
608 auth_xform = xform->next;
609 cipher_xform = xform;
611 case AESNI_MB_OP_HASH_ONLY:
612 sess->chain_order = HASH_CIPHER;
616 case AESNI_MB_OP_CIPHER_ONLY:
618 * Multi buffer library operates only at two modes,
619 * CIPHER_HASH and HASH_CIPHER. When doing ciphering only,
620 * chain order depends on cipher operation: encryption is always
621 * the first operation and decryption the last one.
623 if (xform->cipher.op == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
624 sess->chain_order = CIPHER_HASH;
626 sess->chain_order = HASH_CIPHER;
628 cipher_xform = xform;
630 case AESNI_MB_OP_AEAD_CIPHER_HASH:
631 sess->chain_order = CIPHER_HASH;
632 sess->aead.aad_len = xform->aead.aad_length;
635 case AESNI_MB_OP_AEAD_HASH_CIPHER:
636 sess->chain_order = HASH_CIPHER;
637 sess->aead.aad_len = xform->aead.aad_length;
640 case AESNI_MB_OP_NOT_SUPPORTED:
642 AESNI_MB_LOG(ERR, "Unsupported operation chain order parameter");
646 /* Default IV length = 0 */
649 ret = aesni_mb_set_session_auth_parameters(mb_ops, sess, auth_xform);
651 AESNI_MB_LOG(ERR, "Invalid/unsupported authentication parameters");
655 ret = aesni_mb_set_session_cipher_parameters(mb_ops, sess,
658 AESNI_MB_LOG(ERR, "Invalid/unsupported cipher parameters");
663 ret = aesni_mb_set_session_aead_parameters(mb_ops, sess,
666 AESNI_MB_LOG(ERR, "Invalid/unsupported aead parameters");
675 * burst enqueue, place crypto operations on ingress queue for processing.
677 * @param __qp Queue Pair to process
678 * @param ops Crypto operations for processing
679 * @param nb_ops Number of crypto operations for processing
682 * - Number of crypto operations enqueued
685 aesni_mb_pmd_enqueue_burst(void *__qp, struct rte_crypto_op **ops,
688 struct aesni_mb_qp *qp = __qp;
690 unsigned int nb_enqueued;
692 nb_enqueued = rte_ring_enqueue_burst(qp->ingress_queue,
693 (void **)ops, nb_ops, NULL);
695 qp->stats.enqueued_count += nb_enqueued;
700 /** Get multi buffer session */
701 static inline struct aesni_mb_session *
702 get_session(struct aesni_mb_qp *qp, struct rte_crypto_op *op)
704 struct aesni_mb_session *sess = NULL;
706 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
707 if (likely(op->sym->session != NULL))
708 sess = (struct aesni_mb_session *)
709 get_sym_session_private_data(
711 cryptodev_driver_id);
714 void *_sess_private_data = NULL;
716 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
719 if (rte_mempool_get(qp->sess_mp_priv, (void **)&_sess_private_data))
722 sess = (struct aesni_mb_session *)_sess_private_data;
724 if (unlikely(aesni_mb_set_session_parameters(qp->op_fns,
725 sess, op->sym->xform) != 0)) {
726 rte_mempool_put(qp->sess_mp, _sess);
727 rte_mempool_put(qp->sess_mp_priv, _sess_private_data);
730 op->sym->session = (struct rte_cryptodev_sym_session *)_sess;
731 set_sym_session_private_data(op->sym->session,
732 cryptodev_driver_id, _sess_private_data);
735 if (unlikely(sess == NULL))
736 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
742 * Process a crypto operation and complete a JOB_AES_HMAC job structure for
743 * submission to the multi buffer library for processing.
745 * @param qp queue pair
746 * @param job JOB_AES_HMAC structure to fill
747 * @param m mbuf to process
750 * - Completed JOB_AES_HMAC structure pointer on success
751 * - NULL pointer if completion of JOB_AES_HMAC structure isn't possible
754 set_mb_job_params(JOB_AES_HMAC *job, struct aesni_mb_qp *qp,
755 struct rte_crypto_op *op, uint8_t *digest_idx)
757 struct rte_mbuf *m_src = op->sym->m_src, *m_dst;
758 struct aesni_mb_session *session;
759 uint16_t m_offset = 0;
761 session = get_session(qp, op);
762 if (session == NULL) {
763 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
767 /* Set crypto operation */
768 job->chain_order = session->chain_order;
770 /* Set cipher parameters */
771 job->cipher_direction = session->cipher.direction;
772 job->cipher_mode = session->cipher.mode;
774 job->aes_key_len_in_bytes = session->cipher.key_length_in_bytes;
776 /* Set authentication parameters */
777 job->hash_alg = session->auth.algo;
779 switch (job->hash_alg) {
781 job->u.XCBC._k1_expanded = session->auth.xcbc.k1_expanded;
782 job->u.XCBC._k2 = session->auth.xcbc.k2;
783 job->u.XCBC._k3 = session->auth.xcbc.k3;
785 job->aes_enc_key_expanded =
786 session->cipher.expanded_aes_keys.encode;
787 job->aes_dec_key_expanded =
788 session->cipher.expanded_aes_keys.decode;
792 job->u.CCM.aad = op->sym->aead.aad.data + 18;
793 job->u.CCM.aad_len_in_bytes = session->aead.aad_len;
794 job->aes_enc_key_expanded =
795 session->cipher.expanded_aes_keys.encode;
796 job->aes_dec_key_expanded =
797 session->cipher.expanded_aes_keys.decode;
801 job->u.CMAC._key_expanded = session->auth.cmac.expkey;
802 job->u.CMAC._skey1 = session->auth.cmac.skey1;
803 job->u.CMAC._skey2 = session->auth.cmac.skey2;
804 job->aes_enc_key_expanded =
805 session->cipher.expanded_aes_keys.encode;
806 job->aes_dec_key_expanded =
807 session->cipher.expanded_aes_keys.decode;
811 if (session->cipher.mode == GCM) {
812 job->u.GCM.aad = op->sym->aead.aad.data;
813 job->u.GCM.aad_len_in_bytes = session->aead.aad_len;
816 job->u.GCM.aad = rte_pktmbuf_mtod_offset(m_src,
817 uint8_t *, op->sym->auth.data.offset);
818 job->u.GCM.aad_len_in_bytes = op->sym->auth.data.length;
819 job->cipher_mode = GCM;
821 job->aes_enc_key_expanded = &session->cipher.gcm_key;
822 job->aes_dec_key_expanded = &session->cipher.gcm_key;
826 job->u.HMAC._hashed_auth_key_xor_ipad = session->auth.pads.inner;
827 job->u.HMAC._hashed_auth_key_xor_opad = session->auth.pads.outer;
829 if (job->cipher_mode == DES3) {
830 job->aes_enc_key_expanded =
831 session->cipher.exp_3des_keys.ks_ptr;
832 job->aes_dec_key_expanded =
833 session->cipher.exp_3des_keys.ks_ptr;
835 job->aes_enc_key_expanded =
836 session->cipher.expanded_aes_keys.encode;
837 job->aes_dec_key_expanded =
838 session->cipher.expanded_aes_keys.decode;
842 /* Mutable crypto operation parameters */
843 if (op->sym->m_dst) {
844 m_src = m_dst = op->sym->m_dst;
846 /* append space for output data to mbuf */
847 char *odata = rte_pktmbuf_append(m_dst,
848 rte_pktmbuf_data_len(op->sym->m_src));
850 AESNI_MB_LOG(ERR, "failed to allocate space in destination "
851 "mbuf for source data");
852 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
856 memcpy(odata, rte_pktmbuf_mtod(op->sym->m_src, void*),
857 rte_pktmbuf_data_len(op->sym->m_src));
860 if (job->hash_alg == AES_CCM || (job->hash_alg == AES_GMAC &&
861 session->cipher.mode == GCM))
862 m_offset = op->sym->aead.data.offset;
864 m_offset = op->sym->cipher.data.offset;
867 /* Set digest output location */
868 if (job->hash_alg != NULL_HASH &&
869 session->auth.operation == RTE_CRYPTO_AUTH_OP_VERIFY) {
870 job->auth_tag_output = qp->temp_digests[*digest_idx];
871 *digest_idx = (*digest_idx + 1) % MAX_JOBS;
873 if (job->hash_alg == AES_CCM || (job->hash_alg == AES_GMAC &&
874 session->cipher.mode == GCM))
875 job->auth_tag_output = op->sym->aead.digest.data;
877 job->auth_tag_output = op->sym->auth.digest.data;
879 if (session->auth.req_digest_len != session->auth.gen_digest_len) {
880 job->auth_tag_output = qp->temp_digests[*digest_idx];
881 *digest_idx = (*digest_idx + 1) % MAX_JOBS;
885 * Multi-buffer library current only support returning a truncated
886 * digest length as specified in the relevant IPsec RFCs
889 /* Set digest length */
890 job->auth_tag_output_len_in_bytes = session->auth.gen_digest_len;
892 /* Set IV parameters */
893 job->iv_len_in_bytes = session->iv.length;
896 job->src = rte_pktmbuf_mtod(m_src, uint8_t *);
897 job->dst = rte_pktmbuf_mtod_offset(m_dst, uint8_t *, m_offset);
899 switch (job->hash_alg) {
901 job->cipher_start_src_offset_in_bytes =
902 op->sym->aead.data.offset;
903 job->msg_len_to_cipher_in_bytes = op->sym->aead.data.length;
904 job->hash_start_src_offset_in_bytes = op->sym->aead.data.offset;
905 job->msg_len_to_hash_in_bytes = op->sym->aead.data.length;
907 job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
908 session->iv.offset + 1);
912 if (session->cipher.mode == GCM) {
913 job->cipher_start_src_offset_in_bytes =
914 op->sym->aead.data.offset;
915 job->hash_start_src_offset_in_bytes =
916 op->sym->aead.data.offset;
917 job->msg_len_to_cipher_in_bytes =
918 op->sym->aead.data.length;
919 job->msg_len_to_hash_in_bytes =
920 op->sym->aead.data.length;
922 job->cipher_start_src_offset_in_bytes =
923 op->sym->auth.data.offset;
924 job->hash_start_src_offset_in_bytes =
925 op->sym->auth.data.offset;
926 job->msg_len_to_cipher_in_bytes = 0;
927 job->msg_len_to_hash_in_bytes = 0;
929 job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
935 job->cipher_start_src_offset_in_bytes =
936 op->sym->cipher.data.offset;
937 job->msg_len_to_cipher_in_bytes = op->sym->cipher.data.length;
939 job->hash_start_src_offset_in_bytes = op->sym->auth.data.offset;
940 job->msg_len_to_hash_in_bytes = op->sym->auth.data.length;
942 job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
946 /* Set user data to be crypto operation data struct */
953 verify_digest(JOB_AES_HMAC *job, void *digest, uint16_t len, uint8_t *status)
955 if (memcmp(job->auth_tag_output, digest, len) != 0)
956 *status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
960 generate_digest(JOB_AES_HMAC *job, struct rte_crypto_op *op,
961 struct aesni_mb_session *sess)
963 /* No extra copy neeed */
964 if (likely(sess->auth.req_digest_len == sess->auth.gen_digest_len))
968 * This can only happen for HMAC, so only digest
969 * for authentication algos is required
971 memcpy(op->sym->auth.digest.data, job->auth_tag_output,
972 sess->auth.req_digest_len);
976 * Process a completed job and return rte_mbuf which job processed
978 * @param qp Queue Pair to process
979 * @param job JOB_AES_HMAC job to process
982 * - Returns processed crypto operation.
983 * - Returns NULL on invalid job
985 static inline struct rte_crypto_op *
986 post_process_mb_job(struct aesni_mb_qp *qp, JOB_AES_HMAC *job)
988 struct rte_crypto_op *op = (struct rte_crypto_op *)job->user_data;
989 struct aesni_mb_session *sess = get_sym_session_private_data(
991 cryptodev_driver_id);
993 if (likely(op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)) {
994 switch (job->status) {
996 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
998 if (job->hash_alg == NULL_HASH)
1001 if (sess->auth.operation == RTE_CRYPTO_AUTH_OP_VERIFY) {
1002 if (job->hash_alg == AES_CCM ||
1003 (job->hash_alg == AES_GMAC &&
1004 sess->cipher.mode == GCM))
1006 op->sym->aead.digest.data,
1007 sess->auth.req_digest_len,
1011 op->sym->auth.digest.data,
1012 sess->auth.req_digest_len,
1015 generate_digest(job, op, sess);
1018 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
1022 /* Free session if a session-less crypto op */
1023 if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
1024 memset(sess, 0, sizeof(struct aesni_mb_session));
1025 memset(op->sym->session, 0,
1026 rte_cryptodev_sym_get_existing_header_session_size(
1028 rte_mempool_put(qp->sess_mp_priv, sess);
1029 rte_mempool_put(qp->sess_mp, op->sym->session);
1030 op->sym->session = NULL;
1037 * Process a completed JOB_AES_HMAC job and keep processing jobs until
1038 * get_completed_job return NULL
1040 * @param qp Queue Pair to process
1041 * @param job JOB_AES_HMAC job
1044 * - Number of processed jobs
1047 handle_completed_jobs(struct aesni_mb_qp *qp, JOB_AES_HMAC *job,
1048 struct rte_crypto_op **ops, uint16_t nb_ops)
1050 struct rte_crypto_op *op = NULL;
1051 unsigned processed_jobs = 0;
1053 while (job != NULL) {
1054 op = post_process_mb_job(qp, job);
1057 ops[processed_jobs++] = op;
1058 qp->stats.dequeued_count++;
1060 qp->stats.dequeue_err_count++;
1063 if (processed_jobs == nb_ops)
1066 job = (*qp->op_fns->job.get_completed_job)(qp->mb_mgr);
1069 return processed_jobs;
1072 static inline uint16_t
1073 flush_mb_mgr(struct aesni_mb_qp *qp, struct rte_crypto_op **ops,
1076 int processed_ops = 0;
1078 /* Flush the remaining jobs */
1079 JOB_AES_HMAC *job = (*qp->op_fns->job.flush_job)(qp->mb_mgr);
1082 processed_ops += handle_completed_jobs(qp, job,
1083 &ops[processed_ops], nb_ops - processed_ops);
1085 return processed_ops;
1088 static inline JOB_AES_HMAC *
1089 set_job_null_op(JOB_AES_HMAC *job, struct rte_crypto_op *op)
1091 job->chain_order = HASH_CIPHER;
1092 job->cipher_mode = NULL_CIPHER;
1093 job->hash_alg = NULL_HASH;
1094 job->cipher_direction = DECRYPT;
1096 /* Set user data to be crypto operation data struct */
1097 job->user_data = op;
1103 aesni_mb_pmd_dequeue_burst(void *queue_pair, struct rte_crypto_op **ops,
1106 struct aesni_mb_qp *qp = queue_pair;
1108 struct rte_crypto_op *op;
1111 int retval, processed_jobs = 0;
1113 if (unlikely(nb_ops == 0))
1116 uint8_t digest_idx = qp->digest_idx;
1118 /* Get next free mb job struct from mb manager */
1119 job = (*qp->op_fns->job.get_next)(qp->mb_mgr);
1120 if (unlikely(job == NULL)) {
1121 /* if no free mb job structs we need to flush mb_mgr */
1122 processed_jobs += flush_mb_mgr(qp,
1123 &ops[processed_jobs],
1124 nb_ops - processed_jobs);
1126 if (nb_ops == processed_jobs)
1129 job = (*qp->op_fns->job.get_next)(qp->mb_mgr);
1133 * Get next operation to process from ingress queue.
1134 * There is no need to return the job to the MB_MGR
1135 * if there are no more operations to process, since the MB_MGR
1136 * can use that pointer again in next get_next calls.
1138 retval = rte_ring_dequeue(qp->ingress_queue, (void **)&op);
1142 retval = set_mb_job_params(job, qp, op, &digest_idx);
1143 if (unlikely(retval != 0)) {
1144 qp->stats.dequeue_err_count++;
1145 set_job_null_op(job, op);
1148 /* Submit job to multi-buffer for processing */
1149 job = (*qp->op_fns->job.submit)(qp->mb_mgr);
1152 * If submit returns a processed job then handle it,
1153 * before submitting subsequent jobs
1156 processed_jobs += handle_completed_jobs(qp, job,
1157 &ops[processed_jobs],
1158 nb_ops - processed_jobs);
1160 } while (processed_jobs < nb_ops);
1162 qp->digest_idx = digest_idx;
1164 if (processed_jobs < 1)
1165 processed_jobs += flush_mb_mgr(qp,
1166 &ops[processed_jobs],
1167 nb_ops - processed_jobs);
1169 return processed_jobs;
1172 static int cryptodev_aesni_mb_remove(struct rte_vdev_device *vdev);
1175 cryptodev_aesni_mb_create(const char *name,
1176 struct rte_vdev_device *vdev,
1177 struct rte_cryptodev_pmd_init_params *init_params)
1179 struct rte_cryptodev *dev;
1180 struct aesni_mb_private *internals;
1181 enum aesni_mb_vector_mode vector_mode;
1183 /* Check CPU for support for AES instruction set */
1184 if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
1185 AESNI_MB_LOG(ERR, "AES instructions not supported by CPU");
1189 dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
1191 AESNI_MB_LOG(ERR, "failed to create cryptodev vdev");
1195 /* Check CPU for supported vector instruction set */
1196 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX512F))
1197 vector_mode = RTE_AESNI_MB_AVX512;
1198 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
1199 vector_mode = RTE_AESNI_MB_AVX2;
1200 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
1201 vector_mode = RTE_AESNI_MB_AVX;
1203 vector_mode = RTE_AESNI_MB_SSE;
1205 dev->driver_id = cryptodev_driver_id;
1206 dev->dev_ops = rte_aesni_mb_pmd_ops;
1208 /* register rx/tx burst functions for data path */
1209 dev->dequeue_burst = aesni_mb_pmd_dequeue_burst;
1210 dev->enqueue_burst = aesni_mb_pmd_enqueue_burst;
1212 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
1213 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
1214 RTE_CRYPTODEV_FF_CPU_AESNI;
1216 switch (vector_mode) {
1217 case RTE_AESNI_MB_SSE:
1218 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
1220 case RTE_AESNI_MB_AVX:
1221 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
1223 case RTE_AESNI_MB_AVX2:
1224 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
1226 case RTE_AESNI_MB_AVX512:
1227 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX512;
1233 /* Set vector instructions mode supported */
1234 internals = dev->data->dev_private;
1236 internals->vector_mode = vector_mode;
1237 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
1239 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
1240 AESNI_MB_LOG(INFO, "IPSec Multi-buffer library version used: %s\n",
1241 imb_get_version_str());
1243 AESNI_MB_LOG(INFO, "IPSec Multi-buffer library version used: 0.49.0\n");
1250 cryptodev_aesni_mb_probe(struct rte_vdev_device *vdev)
1252 struct rte_cryptodev_pmd_init_params init_params = {
1254 sizeof(struct aesni_mb_private),
1256 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
1258 const char *name, *args;
1261 name = rte_vdev_device_name(vdev);
1265 args = rte_vdev_device_args(vdev);
1267 retval = rte_cryptodev_pmd_parse_input_args(&init_params, args);
1269 AESNI_MB_LOG(ERR, "Failed to parse initialisation arguments[%s]",
1274 return cryptodev_aesni_mb_create(name, vdev, &init_params);
1278 cryptodev_aesni_mb_remove(struct rte_vdev_device *vdev)
1280 struct rte_cryptodev *cryptodev;
1283 name = rte_vdev_device_name(vdev);
1287 cryptodev = rte_cryptodev_pmd_get_named_dev(name);
1288 if (cryptodev == NULL)
1291 return rte_cryptodev_pmd_destroy(cryptodev);
1294 static struct rte_vdev_driver cryptodev_aesni_mb_pmd_drv = {
1295 .probe = cryptodev_aesni_mb_probe,
1296 .remove = cryptodev_aesni_mb_remove
1299 static struct cryptodev_driver aesni_mb_crypto_drv;
1301 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_MB_PMD, cryptodev_aesni_mb_pmd_drv);
1302 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_MB_PMD, cryptodev_aesni_mb_pmd);
1303 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_MB_PMD,
1304 "max_nb_queue_pairs=<int> "
1306 RTE_PMD_REGISTER_CRYPTO_DRIVER(aesni_mb_crypto_drv,
1307 cryptodev_aesni_mb_pmd_drv.driver,
1308 cryptodev_driver_id);
1310 RTE_INIT(aesni_mb_init_log)
1312 aesni_mb_logtype_driver = rte_log_register("pmd.crypto.aesni_mb");