1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2017 Intel Corporation
7 #include <rte_common.h>
8 #include <rte_malloc.h>
9 #include <rte_cryptodev_pmd.h>
11 #include "rte_openssl_pmd_private.h"
14 static const struct rte_cryptodev_capabilities openssl_pmd_capabilities[] = {
16 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
18 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
20 .algo = RTE_CRYPTO_AUTH_MD5_HMAC,
37 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
39 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
41 .algo = RTE_CRYPTO_AUTH_MD5,
58 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
60 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
62 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
79 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
81 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
83 .algo = RTE_CRYPTO_AUTH_SHA1,
100 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
102 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
104 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC,
121 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
123 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
125 .algo = RTE_CRYPTO_AUTH_SHA224,
142 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
144 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
146 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
163 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
165 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
167 .algo = RTE_CRYPTO_AUTH_SHA256,
184 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
186 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
188 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC,
205 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
207 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
209 .algo = RTE_CRYPTO_AUTH_SHA384,
226 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
228 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
230 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC,
247 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
249 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
251 .algo = RTE_CRYPTO_AUTH_SHA512,
268 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
270 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
272 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
288 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
290 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
292 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
308 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
310 .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
312 .algo = RTE_CRYPTO_AEAD_AES_GCM,
338 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
340 .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
342 .algo = RTE_CRYPTO_AEAD_AES_CCM,
367 { /* AES GMAC (AUTH) */
368 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
370 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
372 .algo = RTE_CRYPTO_AUTH_AES_GMAC,
393 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
395 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
397 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
413 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
415 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
417 .algo = RTE_CRYPTO_CIPHER_3DES_CTR,
433 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
435 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
437 .algo = RTE_CRYPTO_CIPHER_DES_CBC,
452 { /* DES DOCSIS BPI */
453 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
455 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
457 .algo = RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
473 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
477 /** Configure device */
479 openssl_pmd_config(__rte_unused struct rte_cryptodev *dev,
480 __rte_unused struct rte_cryptodev_config *config)
487 openssl_pmd_start(__rte_unused struct rte_cryptodev *dev)
494 openssl_pmd_stop(__rte_unused struct rte_cryptodev *dev)
500 openssl_pmd_close(__rte_unused struct rte_cryptodev *dev)
506 /** Get device statistics */
508 openssl_pmd_stats_get(struct rte_cryptodev *dev,
509 struct rte_cryptodev_stats *stats)
513 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
514 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
516 stats->enqueued_count += qp->stats.enqueued_count;
517 stats->dequeued_count += qp->stats.dequeued_count;
519 stats->enqueue_err_count += qp->stats.enqueue_err_count;
520 stats->dequeue_err_count += qp->stats.dequeue_err_count;
524 /** Reset device statistics */
526 openssl_pmd_stats_reset(struct rte_cryptodev *dev)
530 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
531 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
533 memset(&qp->stats, 0, sizeof(qp->stats));
538 /** Get device info */
540 openssl_pmd_info_get(struct rte_cryptodev *dev,
541 struct rte_cryptodev_info *dev_info)
543 struct openssl_private *internals = dev->data->dev_private;
545 if (dev_info != NULL) {
546 dev_info->driver_id = dev->driver_id;
547 dev_info->feature_flags = dev->feature_flags;
548 dev_info->capabilities = openssl_pmd_capabilities;
549 dev_info->max_nb_queue_pairs = internals->max_nb_qpairs;
550 /* No limit of number of sessions */
551 dev_info->sym.max_nb_sessions = 0;
555 /** Release queue pair */
557 openssl_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
559 if (dev->data->queue_pairs[qp_id] != NULL) {
560 rte_free(dev->data->queue_pairs[qp_id]);
561 dev->data->queue_pairs[qp_id] = NULL;
566 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
568 openssl_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
569 struct openssl_qp *qp)
571 unsigned int n = snprintf(qp->name, sizeof(qp->name),
572 "openssl_pmd_%u_qp_%u",
573 dev->data->dev_id, qp->id);
575 if (n >= sizeof(qp->name))
582 /** Create a ring to place processed operations on */
583 static struct rte_ring *
584 openssl_pmd_qp_create_processed_ops_ring(struct openssl_qp *qp,
585 unsigned int ring_size, int socket_id)
589 r = rte_ring_lookup(qp->name);
591 if (rte_ring_get_size(r) >= ring_size) {
593 "Reusing existing ring %s for processed ops",
599 "Unable to reuse existing ring %s for processed ops",
604 return rte_ring_create(qp->name, ring_size, socket_id,
605 RING_F_SP_ENQ | RING_F_SC_DEQ);
609 /** Setup a queue pair */
611 openssl_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
612 const struct rte_cryptodev_qp_conf *qp_conf,
613 int socket_id, struct rte_mempool *session_pool)
615 struct openssl_qp *qp = NULL;
617 /* Free memory prior to re-allocation if needed. */
618 if (dev->data->queue_pairs[qp_id] != NULL)
619 openssl_pmd_qp_release(dev, qp_id);
621 /* Allocate the queue pair data structure. */
622 qp = rte_zmalloc_socket("OPENSSL PMD Queue Pair", sizeof(*qp),
623 RTE_CACHE_LINE_SIZE, socket_id);
628 dev->data->queue_pairs[qp_id] = qp;
630 if (openssl_pmd_qp_set_unique_name(dev, qp))
631 goto qp_setup_cleanup;
633 qp->processed_ops = openssl_pmd_qp_create_processed_ops_ring(qp,
634 qp_conf->nb_descriptors, socket_id);
635 if (qp->processed_ops == NULL)
636 goto qp_setup_cleanup;
638 qp->sess_mp = session_pool;
640 memset(&qp->stats, 0, sizeof(qp->stats));
651 /** Return the number of allocated queue pairs */
653 openssl_pmd_qp_count(struct rte_cryptodev *dev)
655 return dev->data->nb_queue_pairs;
658 /** Returns the size of the session structure */
660 openssl_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused)
662 return sizeof(struct openssl_session);
665 /** Configure the session from a crypto xform chain */
667 openssl_pmd_session_configure(struct rte_cryptodev *dev __rte_unused,
668 struct rte_crypto_sym_xform *xform,
669 struct rte_cryptodev_sym_session *sess,
670 struct rte_mempool *mempool)
672 void *sess_private_data;
675 if (unlikely(sess == NULL)) {
676 OPENSSL_LOG(ERR, "invalid session struct");
680 if (rte_mempool_get(mempool, &sess_private_data)) {
682 "Couldn't get object from session mempool");
686 ret = openssl_set_session_parameters(sess_private_data, xform);
688 OPENSSL_LOG(ERR, "failed configure session parameters");
690 /* Return session to mempool */
691 rte_mempool_put(mempool, sess_private_data);
695 set_session_private_data(sess, dev->driver_id,
702 /** Clear the memory of session so it doesn't leave key material behind */
704 openssl_pmd_session_clear(struct rte_cryptodev *dev,
705 struct rte_cryptodev_sym_session *sess)
707 uint8_t index = dev->driver_id;
708 void *sess_priv = get_session_private_data(sess, index);
710 /* Zero out the whole structure */
712 openssl_reset_session(sess_priv);
713 memset(sess_priv, 0, sizeof(struct openssl_session));
714 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
715 set_session_private_data(sess, index, NULL);
716 rte_mempool_put(sess_mp, sess_priv);
720 struct rte_cryptodev_ops openssl_pmd_ops = {
721 .dev_configure = openssl_pmd_config,
722 .dev_start = openssl_pmd_start,
723 .dev_stop = openssl_pmd_stop,
724 .dev_close = openssl_pmd_close,
726 .stats_get = openssl_pmd_stats_get,
727 .stats_reset = openssl_pmd_stats_reset,
729 .dev_infos_get = openssl_pmd_info_get,
731 .queue_pair_setup = openssl_pmd_qp_setup,
732 .queue_pair_release = openssl_pmd_qp_release,
733 .queue_pair_count = openssl_pmd_qp_count,
735 .session_get_size = openssl_pmd_session_get_size,
736 .session_configure = openssl_pmd_session_configure,
737 .session_clear = openssl_pmd_session_clear
740 struct rte_cryptodev_ops *rte_openssl_pmd_ops = &openssl_pmd_ops;