1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2017 Intel Corporation
5 #include <rte_common.h>
6 #include <rte_hexdump.h>
7 #include <rte_cryptodev.h>
8 #include <rte_cryptodev_pmd.h>
9 #include <rte_bus_vdev.h>
10 #include <rte_malloc.h>
11 #include <rte_cpuflags.h>
12 #include <rte_byteorder.h>
14 #include "aesni_gcm_pmd_private.h"
16 static uint8_t cryptodev_driver_id;
18 /** Parse crypto xform chain and set private session parameters */
20 aesni_gcm_set_session_parameters(const struct aesni_gcm_ops *gcm_ops,
21 struct aesni_gcm_session *sess,
22 const struct rte_crypto_sym_xform *xform)
24 const struct rte_crypto_sym_xform *auth_xform;
25 const struct rte_crypto_sym_xform *aead_xform;
30 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
32 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_AES_GMAC) {
33 AESNI_GCM_LOG(ERR, "Only AES GMAC is supported as an "
34 "authentication only algorithm");
37 /* Set IV parameters */
38 sess->iv.offset = auth_xform->auth.iv.offset;
39 sess->iv.length = auth_xform->auth.iv.length;
41 /* Select Crypto operation */
42 if (auth_xform->auth.op == RTE_CRYPTO_AUTH_OP_GENERATE)
43 sess->op = AESNI_GMAC_OP_GENERATE;
45 sess->op = AESNI_GMAC_OP_VERIFY;
47 key_length = auth_xform->auth.key.length;
48 key = auth_xform->auth.key.data;
49 sess->req_digest_length = auth_xform->auth.digest_length;
52 } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
55 if (aead_xform->aead.algo != RTE_CRYPTO_AEAD_AES_GCM) {
56 AESNI_GCM_LOG(ERR, "The only combined operation "
57 "supported is AES GCM");
61 /* Set IV parameters */
62 sess->iv.offset = aead_xform->aead.iv.offset;
63 sess->iv.length = aead_xform->aead.iv.length;
65 /* Select Crypto operation */
66 if (aead_xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
67 sess->op = AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION;
69 sess->op = AESNI_GCM_OP_AUTHENTICATED_DECRYPTION;
71 key_length = aead_xform->aead.key.length;
72 key = aead_xform->aead.key.data;
74 sess->aad_length = aead_xform->aead.aad_length;
75 sess->req_digest_length = aead_xform->aead.digest_length;
77 AESNI_GCM_LOG(ERR, "Wrong xform type, has to be AEAD or authentication");
83 if (sess->iv.length != 16 && sess->iv.length != 12 &&
84 sess->iv.length != 0) {
85 AESNI_GCM_LOG(ERR, "Wrong IV length");
89 /* Check key length and calculate GCM pre-compute. */
92 sess->key = GCM_KEY_128;
95 sess->key = GCM_KEY_192;
98 sess->key = GCM_KEY_256;
101 AESNI_GCM_LOG(ERR, "Invalid key length");
105 gcm_ops[sess->key].pre(key, &sess->gdata_key);
108 if (sess->req_digest_length > 16) {
109 AESNI_GCM_LOG(ERR, "Invalid digest length");
113 * Multi-buffer lib supports digest sizes from 4 to 16 bytes
114 * in version 0.50 and sizes of 8, 12 and 16 bytes,
116 * If size requested is different, generate the full digest
117 * (16 bytes) in a temporary location and then memcpy
118 * the requested number of bytes.
120 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
121 if (sess->req_digest_length < 4)
123 if (sess->req_digest_length != 16 &&
124 sess->req_digest_length != 12 &&
125 sess->req_digest_length != 8)
127 sess->gen_digest_length = 16;
129 sess->gen_digest_length = sess->req_digest_length;
134 /** Get gcm session */
135 static struct aesni_gcm_session *
136 aesni_gcm_get_session(struct aesni_gcm_qp *qp, struct rte_crypto_op *op)
138 struct aesni_gcm_session *sess = NULL;
139 struct rte_crypto_sym_op *sym_op = op->sym;
141 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
142 if (likely(sym_op->session != NULL))
143 sess = (struct aesni_gcm_session *)
144 get_sym_session_private_data(
146 cryptodev_driver_id);
149 void *_sess_private_data = NULL;
151 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
154 if (rte_mempool_get(qp->sess_mp_priv,
155 (void **)&_sess_private_data))
158 sess = (struct aesni_gcm_session *)_sess_private_data;
160 if (unlikely(aesni_gcm_set_session_parameters(qp->ops,
161 sess, sym_op->xform) != 0)) {
162 rte_mempool_put(qp->sess_mp, _sess);
163 rte_mempool_put(qp->sess_mp_priv, _sess_private_data);
166 sym_op->session = (struct rte_cryptodev_sym_session *)_sess;
167 set_sym_session_private_data(sym_op->session,
168 cryptodev_driver_id, _sess_private_data);
171 if (unlikely(sess == NULL))
172 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
178 * Process a crypto operation, calling
179 * the GCM API from the multi buffer library.
181 * @param qp queue pair
182 * @param op symmetric crypto operation
183 * @param session GCM session
189 process_gcm_crypto_op(struct aesni_gcm_qp *qp, struct rte_crypto_op *op,
190 struct aesni_gcm_session *session)
194 struct rte_crypto_sym_op *sym_op = op->sym;
195 struct rte_mbuf *m_src = sym_op->m_src;
196 uint32_t offset, data_offset, data_length;
197 uint32_t part_len, total_len, data_len;
199 unsigned int oop = 0;
201 if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION ||
202 session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
203 offset = sym_op->aead.data.offset;
204 data_offset = offset;
205 data_length = sym_op->aead.data.length;
207 offset = sym_op->auth.data.offset;
208 data_offset = offset;
209 data_length = sym_op->auth.data.length;
212 RTE_ASSERT(m_src != NULL);
214 while (offset >= m_src->data_len && data_length != 0) {
215 offset -= m_src->data_len;
218 RTE_ASSERT(m_src != NULL);
221 src = rte_pktmbuf_mtod_offset(m_src, uint8_t *, offset);
223 data_len = m_src->data_len - offset;
224 part_len = (data_len < data_length) ? data_len :
227 RTE_ASSERT((sym_op->m_dst == NULL) ||
228 ((sym_op->m_dst != NULL) &&
229 rte_pktmbuf_is_contiguous(sym_op->m_dst)));
232 if (sym_op->m_dst == NULL || (sym_op->m_dst == sym_op->m_src))
237 /* Segmented destination buffer is not supported if operation is
239 RTE_ASSERT(rte_pktmbuf_is_contiguous(sym_op->m_dst));
240 dst = rte_pktmbuf_mtod_offset(sym_op->m_dst, uint8_t *,
244 iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
247 if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION) {
248 qp->ops[session->key].init(&session->gdata_key,
251 sym_op->aead.aad.data,
252 (uint64_t)session->aad_length);
254 qp->ops[session->key].update_enc(&session->gdata_key,
255 &qp->gdata_ctx, dst, src,
257 total_len = data_length - part_len;
262 RTE_ASSERT(m_src != NULL);
264 src = rte_pktmbuf_mtod(m_src, uint8_t *);
269 part_len = (m_src->data_len < total_len) ?
270 m_src->data_len : total_len;
272 qp->ops[session->key].update_enc(&session->gdata_key,
273 &qp->gdata_ctx, dst, src,
275 total_len -= part_len;
278 if (session->req_digest_length != session->gen_digest_length)
279 tag = qp->temp_digest;
281 tag = sym_op->aead.digest.data;
283 qp->ops[session->key].finalize_enc(&session->gdata_key,
286 session->gen_digest_length);
287 } else if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
288 qp->ops[session->key].init(&session->gdata_key,
291 sym_op->aead.aad.data,
292 (uint64_t)session->aad_length);
294 qp->ops[session->key].update_dec(&session->gdata_key,
295 &qp->gdata_ctx, dst, src,
297 total_len = data_length - part_len;
302 RTE_ASSERT(m_src != NULL);
304 src = rte_pktmbuf_mtod(m_src, uint8_t *);
309 part_len = (m_src->data_len < total_len) ?
310 m_src->data_len : total_len;
312 qp->ops[session->key].update_dec(&session->gdata_key,
316 total_len -= part_len;
319 tag = qp->temp_digest;
320 qp->ops[session->key].finalize_dec(&session->gdata_key,
323 session->gen_digest_length);
324 } else if (session->op == AESNI_GMAC_OP_GENERATE) {
325 qp->ops[session->key].init(&session->gdata_key,
329 (uint64_t)data_length);
330 if (session->req_digest_length != session->gen_digest_length)
331 tag = qp->temp_digest;
333 tag = sym_op->auth.digest.data;
334 qp->ops[session->key].finalize_enc(&session->gdata_key,
337 session->gen_digest_length);
338 } else { /* AESNI_GMAC_OP_VERIFY */
339 qp->ops[session->key].init(&session->gdata_key,
343 (uint64_t)data_length);
346 * Generate always 16 bytes and later compare only
349 tag = qp->temp_digest;
350 qp->ops[session->key].finalize_enc(&session->gdata_key,
353 session->gen_digest_length);
360 * Process a completed job and return rte_mbuf which job processed
362 * @param job JOB_AES_HMAC job to process
365 * - Returns processed mbuf which is trimmed of output digest used in
366 * verification of supplied digest in the case of a HASH_CIPHER operation
367 * - Returns NULL on invalid job
370 post_process_gcm_crypto_op(struct aesni_gcm_qp *qp,
371 struct rte_crypto_op *op,
372 struct aesni_gcm_session *session)
374 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
376 /* Verify digest if required */
377 if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION ||
378 session->op == AESNI_GMAC_OP_VERIFY) {
381 uint8_t *tag = qp->temp_digest;
383 if (session->op == AESNI_GMAC_OP_VERIFY)
384 digest = op->sym->auth.digest.data;
386 digest = op->sym->aead.digest.data;
388 #ifdef RTE_LIBRTE_PMD_AESNI_GCM_DEBUG
389 rte_hexdump(stdout, "auth tag (orig):",
390 digest, session->req_digest_length);
391 rte_hexdump(stdout, "auth tag (calc):",
392 tag, session->req_digest_length);
395 if (memcmp(tag, digest, session->req_digest_length) != 0)
396 op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
398 if (session->req_digest_length != session->gen_digest_length) {
399 if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION)
400 memcpy(op->sym->aead.digest.data, qp->temp_digest,
401 session->req_digest_length);
403 memcpy(op->sym->auth.digest.data, qp->temp_digest,
404 session->req_digest_length);
410 * Process a completed GCM request
412 * @param qp Queue Pair to process
413 * @param op Crypto operation
414 * @param job JOB_AES_HMAC job
417 * - Number of processed jobs
420 handle_completed_gcm_crypto_op(struct aesni_gcm_qp *qp,
421 struct rte_crypto_op *op,
422 struct aesni_gcm_session *sess)
424 post_process_gcm_crypto_op(qp, op, sess);
426 /* Free session if a session-less crypto op */
427 if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
428 memset(sess, 0, sizeof(struct aesni_gcm_session));
429 memset(op->sym->session, 0,
430 rte_cryptodev_sym_get_existing_header_session_size(
432 rte_mempool_put(qp->sess_mp_priv, sess);
433 rte_mempool_put(qp->sess_mp, op->sym->session);
434 op->sym->session = NULL;
439 aesni_gcm_pmd_dequeue_burst(void *queue_pair,
440 struct rte_crypto_op **ops, uint16_t nb_ops)
442 struct aesni_gcm_session *sess;
443 struct aesni_gcm_qp *qp = queue_pair;
446 unsigned int i, nb_dequeued;
448 nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
449 (void **)ops, nb_ops, NULL);
451 for (i = 0; i < nb_dequeued; i++) {
453 sess = aesni_gcm_get_session(qp, ops[i]);
454 if (unlikely(sess == NULL)) {
455 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
456 qp->qp_stats.dequeue_err_count++;
460 retval = process_gcm_crypto_op(qp, ops[i], sess);
462 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
463 qp->qp_stats.dequeue_err_count++;
467 handle_completed_gcm_crypto_op(qp, ops[i], sess);
470 qp->qp_stats.dequeued_count += i;
476 aesni_gcm_pmd_enqueue_burst(void *queue_pair,
477 struct rte_crypto_op **ops, uint16_t nb_ops)
479 struct aesni_gcm_qp *qp = queue_pair;
481 unsigned int nb_enqueued;
483 nb_enqueued = rte_ring_enqueue_burst(qp->processed_pkts,
484 (void **)ops, nb_ops, NULL);
485 qp->qp_stats.enqueued_count += nb_enqueued;
490 static int aesni_gcm_remove(struct rte_vdev_device *vdev);
493 aesni_gcm_create(const char *name,
494 struct rte_vdev_device *vdev,
495 struct rte_cryptodev_pmd_init_params *init_params)
497 struct rte_cryptodev *dev;
498 struct aesni_gcm_private *internals;
499 enum aesni_gcm_vector_mode vector_mode;
502 dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
504 AESNI_GCM_LOG(ERR, "driver %s: create failed",
509 /* Check CPU for supported vector instruction set */
510 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX512F))
511 vector_mode = RTE_AESNI_GCM_AVX512;
512 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
513 vector_mode = RTE_AESNI_GCM_AVX2;
514 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
515 vector_mode = RTE_AESNI_GCM_AVX;
517 vector_mode = RTE_AESNI_GCM_SSE;
519 dev->driver_id = cryptodev_driver_id;
520 dev->dev_ops = rte_aesni_gcm_pmd_ops;
522 /* register rx/tx burst functions for data path */
523 dev->dequeue_burst = aesni_gcm_pmd_dequeue_burst;
524 dev->enqueue_burst = aesni_gcm_pmd_enqueue_burst;
526 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
527 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
528 RTE_CRYPTODEV_FF_IN_PLACE_SGL |
529 RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
530 RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT;
532 /* Check CPU for support for AES instruction set */
533 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES))
534 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AESNI;
536 AESNI_GCM_LOG(WARNING, "AES instructions not supported by CPU");
538 mb_mgr = alloc_mb_mgr(0);
542 switch (vector_mode) {
543 case RTE_AESNI_GCM_SSE:
544 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
545 init_mb_mgr_sse(mb_mgr);
547 case RTE_AESNI_GCM_AVX:
548 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
549 init_mb_mgr_avx(mb_mgr);
551 case RTE_AESNI_GCM_AVX2:
552 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
553 init_mb_mgr_avx2(mb_mgr);
555 case RTE_AESNI_GCM_AVX512:
556 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
557 init_mb_mgr_avx512(mb_mgr);
560 AESNI_GCM_LOG(ERR, "Unsupported vector mode %u\n", vector_mode);
564 internals = dev->data->dev_private;
566 internals->vector_mode = vector_mode;
567 internals->mb_mgr = mb_mgr;
569 /* Set arch independent function pointers, based on key size */
570 internals->ops[GCM_KEY_128].enc = mb_mgr->gcm128_enc;
571 internals->ops[GCM_KEY_128].dec = mb_mgr->gcm128_dec;
572 internals->ops[GCM_KEY_128].pre = mb_mgr->gcm128_pre;
573 internals->ops[GCM_KEY_128].init = mb_mgr->gcm128_init;
574 internals->ops[GCM_KEY_128].update_enc = mb_mgr->gcm128_enc_update;
575 internals->ops[GCM_KEY_128].update_dec = mb_mgr->gcm128_dec_update;
576 internals->ops[GCM_KEY_128].finalize_enc = mb_mgr->gcm128_enc_finalize;
577 internals->ops[GCM_KEY_128].finalize_dec = mb_mgr->gcm128_dec_finalize;
579 internals->ops[GCM_KEY_192].enc = mb_mgr->gcm192_enc;
580 internals->ops[GCM_KEY_192].dec = mb_mgr->gcm192_dec;
581 internals->ops[GCM_KEY_192].pre = mb_mgr->gcm192_pre;
582 internals->ops[GCM_KEY_192].init = mb_mgr->gcm192_init;
583 internals->ops[GCM_KEY_192].update_enc = mb_mgr->gcm192_enc_update;
584 internals->ops[GCM_KEY_192].update_dec = mb_mgr->gcm192_dec_update;
585 internals->ops[GCM_KEY_192].finalize_enc = mb_mgr->gcm192_enc_finalize;
586 internals->ops[GCM_KEY_192].finalize_dec = mb_mgr->gcm192_dec_finalize;
588 internals->ops[GCM_KEY_256].enc = mb_mgr->gcm256_enc;
589 internals->ops[GCM_KEY_256].dec = mb_mgr->gcm256_dec;
590 internals->ops[GCM_KEY_256].pre = mb_mgr->gcm256_pre;
591 internals->ops[GCM_KEY_256].init = mb_mgr->gcm256_init;
592 internals->ops[GCM_KEY_256].update_enc = mb_mgr->gcm256_enc_update;
593 internals->ops[GCM_KEY_256].update_dec = mb_mgr->gcm256_dec_update;
594 internals->ops[GCM_KEY_256].finalize_enc = mb_mgr->gcm256_enc_finalize;
595 internals->ops[GCM_KEY_256].finalize_dec = mb_mgr->gcm256_dec_finalize;
597 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
599 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
600 AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: %s\n",
601 imb_get_version_str());
603 AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: 0.49.0\n");
612 rte_cryptodev_pmd_destroy(dev);
618 aesni_gcm_probe(struct rte_vdev_device *vdev)
620 struct rte_cryptodev_pmd_init_params init_params = {
622 sizeof(struct aesni_gcm_private),
624 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
627 const char *input_args;
629 name = rte_vdev_device_name(vdev);
632 input_args = rte_vdev_device_args(vdev);
633 rte_cryptodev_pmd_parse_input_args(&init_params, input_args);
635 return aesni_gcm_create(name, vdev, &init_params);
639 aesni_gcm_remove(struct rte_vdev_device *vdev)
641 struct rte_cryptodev *cryptodev;
642 struct aesni_gcm_private *internals;
645 name = rte_vdev_device_name(vdev);
649 cryptodev = rte_cryptodev_pmd_get_named_dev(name);
650 if (cryptodev == NULL)
653 internals = cryptodev->data->dev_private;
655 free_mb_mgr(internals->mb_mgr);
657 return rte_cryptodev_pmd_destroy(cryptodev);
660 static struct rte_vdev_driver aesni_gcm_pmd_drv = {
661 .probe = aesni_gcm_probe,
662 .remove = aesni_gcm_remove
665 static struct cryptodev_driver aesni_gcm_crypto_drv;
667 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_GCM_PMD, aesni_gcm_pmd_drv);
668 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_GCM_PMD, cryptodev_aesni_gcm_pmd);
669 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_GCM_PMD,
670 "max_nb_queue_pairs=<int> "
672 RTE_PMD_REGISTER_CRYPTO_DRIVER(aesni_gcm_crypto_drv, aesni_gcm_pmd_drv.driver,
673 cryptodev_driver_id);
676 RTE_INIT(aesni_gcm_init_log)
678 aesni_gcm_logtype_driver = rte_log_register("pmd.crypto.aesni_gcm");