4 * Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <rte_common.h>
36 #include <rte_malloc.h>
37 #include <rte_cryptodev_pmd.h>
39 #include "rte_openssl_pmd_private.h"
42 static const struct rte_cryptodev_capabilities openssl_pmd_capabilities[] = {
44 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
46 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
48 .algo = RTE_CRYPTO_AUTH_MD5_HMAC,
65 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
67 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
69 .algo = RTE_CRYPTO_AUTH_MD5,
86 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
88 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
90 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
107 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
109 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
111 .algo = RTE_CRYPTO_AUTH_SHA1,
128 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
130 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
132 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC,
149 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
151 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
153 .algo = RTE_CRYPTO_AUTH_SHA224,
170 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
172 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
174 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
191 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
193 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
195 .algo = RTE_CRYPTO_AUTH_SHA256,
212 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
214 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
216 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC,
233 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
235 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
237 .algo = RTE_CRYPTO_AUTH_SHA384,
254 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
256 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
258 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC,
275 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
277 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
279 .algo = RTE_CRYPTO_AUTH_SHA512,
296 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
298 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
300 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
316 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
318 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
320 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
336 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
338 .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
340 .algo = RTE_CRYPTO_AEAD_AES_GCM,
366 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
368 .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
370 .algo = RTE_CRYPTO_AEAD_AES_CCM,
395 { /* AES GMAC (AUTH) */
396 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
398 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
400 .algo = RTE_CRYPTO_AUTH_AES_GMAC,
421 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
423 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
425 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
441 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
443 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
445 .algo = RTE_CRYPTO_CIPHER_3DES_CTR,
461 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
463 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
465 .algo = RTE_CRYPTO_CIPHER_DES_CBC,
480 { /* DES DOCSIS BPI */
481 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
483 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
485 .algo = RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
501 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
505 /** Configure device */
507 openssl_pmd_config(__rte_unused struct rte_cryptodev *dev,
508 __rte_unused struct rte_cryptodev_config *config)
515 openssl_pmd_start(__rte_unused struct rte_cryptodev *dev)
522 openssl_pmd_stop(__rte_unused struct rte_cryptodev *dev)
528 openssl_pmd_close(__rte_unused struct rte_cryptodev *dev)
534 /** Get device statistics */
536 openssl_pmd_stats_get(struct rte_cryptodev *dev,
537 struct rte_cryptodev_stats *stats)
541 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
542 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
544 stats->enqueued_count += qp->stats.enqueued_count;
545 stats->dequeued_count += qp->stats.dequeued_count;
547 stats->enqueue_err_count += qp->stats.enqueue_err_count;
548 stats->dequeue_err_count += qp->stats.dequeue_err_count;
552 /** Reset device statistics */
554 openssl_pmd_stats_reset(struct rte_cryptodev *dev)
558 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
559 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
561 memset(&qp->stats, 0, sizeof(qp->stats));
566 /** Get device info */
568 openssl_pmd_info_get(struct rte_cryptodev *dev,
569 struct rte_cryptodev_info *dev_info)
571 struct openssl_private *internals = dev->data->dev_private;
573 if (dev_info != NULL) {
574 dev_info->driver_id = dev->driver_id;
575 dev_info->feature_flags = dev->feature_flags;
576 dev_info->capabilities = openssl_pmd_capabilities;
577 dev_info->max_nb_queue_pairs = internals->max_nb_qpairs;
578 dev_info->sym.max_nb_sessions = internals->max_nb_sessions;
582 /** Release queue pair */
584 openssl_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
586 if (dev->data->queue_pairs[qp_id] != NULL) {
587 rte_free(dev->data->queue_pairs[qp_id]);
588 dev->data->queue_pairs[qp_id] = NULL;
593 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
595 openssl_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
596 struct openssl_qp *qp)
598 unsigned int n = snprintf(qp->name, sizeof(qp->name),
599 "openssl_pmd_%u_qp_%u",
600 dev->data->dev_id, qp->id);
602 if (n >= sizeof(qp->name))
609 /** Create a ring to place processed operations on */
610 static struct rte_ring *
611 openssl_pmd_qp_create_processed_ops_ring(struct openssl_qp *qp,
612 unsigned int ring_size, int socket_id)
616 r = rte_ring_lookup(qp->name);
618 if (rte_ring_get_size(r) >= ring_size) {
620 "Reusing existing ring %s for processed ops",
626 "Unable to reuse existing ring %s for processed ops",
631 return rte_ring_create(qp->name, ring_size, socket_id,
632 RING_F_SP_ENQ | RING_F_SC_DEQ);
636 /** Setup a queue pair */
638 openssl_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
639 const struct rte_cryptodev_qp_conf *qp_conf,
640 int socket_id, struct rte_mempool *session_pool)
642 struct openssl_qp *qp = NULL;
644 /* Free memory prior to re-allocation if needed. */
645 if (dev->data->queue_pairs[qp_id] != NULL)
646 openssl_pmd_qp_release(dev, qp_id);
648 /* Allocate the queue pair data structure. */
649 qp = rte_zmalloc_socket("OPENSSL PMD Queue Pair", sizeof(*qp),
650 RTE_CACHE_LINE_SIZE, socket_id);
655 dev->data->queue_pairs[qp_id] = qp;
657 if (openssl_pmd_qp_set_unique_name(dev, qp))
658 goto qp_setup_cleanup;
660 qp->processed_ops = openssl_pmd_qp_create_processed_ops_ring(qp,
661 qp_conf->nb_descriptors, socket_id);
662 if (qp->processed_ops == NULL)
663 goto qp_setup_cleanup;
665 qp->sess_mp = session_pool;
667 memset(&qp->stats, 0, sizeof(qp->stats));
678 /** Start queue pair */
680 openssl_pmd_qp_start(__rte_unused struct rte_cryptodev *dev,
681 __rte_unused uint16_t queue_pair_id)
686 /** Stop queue pair */
688 openssl_pmd_qp_stop(__rte_unused struct rte_cryptodev *dev,
689 __rte_unused uint16_t queue_pair_id)
694 /** Return the number of allocated queue pairs */
696 openssl_pmd_qp_count(struct rte_cryptodev *dev)
698 return dev->data->nb_queue_pairs;
701 /** Returns the size of the session structure */
703 openssl_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused)
705 return sizeof(struct openssl_session);
708 /** Configure the session from a crypto xform chain */
710 openssl_pmd_session_configure(struct rte_cryptodev *dev __rte_unused,
711 struct rte_crypto_sym_xform *xform,
712 struct rte_cryptodev_sym_session *sess,
713 struct rte_mempool *mempool)
715 void *sess_private_data;
718 if (unlikely(sess == NULL)) {
719 OPENSSL_LOG_ERR("invalid session struct");
723 if (rte_mempool_get(mempool, &sess_private_data)) {
725 "Couldn't get object from session mempool");
729 ret = openssl_set_session_parameters(sess_private_data, xform);
731 OPENSSL_LOG_ERR("failed configure session parameters");
733 /* Return session to mempool */
734 rte_mempool_put(mempool, sess_private_data);
738 set_session_private_data(sess, dev->driver_id,
745 /** Clear the memory of session so it doesn't leave key material behind */
747 openssl_pmd_session_clear(struct rte_cryptodev *dev,
748 struct rte_cryptodev_sym_session *sess)
750 uint8_t index = dev->driver_id;
751 void *sess_priv = get_session_private_data(sess, index);
753 /* Zero out the whole structure */
755 openssl_reset_session(sess_priv);
756 memset(sess_priv, 0, sizeof(struct openssl_session));
757 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
758 set_session_private_data(sess, index, NULL);
759 rte_mempool_put(sess_mp, sess_priv);
763 struct rte_cryptodev_ops openssl_pmd_ops = {
764 .dev_configure = openssl_pmd_config,
765 .dev_start = openssl_pmd_start,
766 .dev_stop = openssl_pmd_stop,
767 .dev_close = openssl_pmd_close,
769 .stats_get = openssl_pmd_stats_get,
770 .stats_reset = openssl_pmd_stats_reset,
772 .dev_infos_get = openssl_pmd_info_get,
774 .queue_pair_setup = openssl_pmd_qp_setup,
775 .queue_pair_release = openssl_pmd_qp_release,
776 .queue_pair_start = openssl_pmd_qp_start,
777 .queue_pair_stop = openssl_pmd_qp_stop,
778 .queue_pair_count = openssl_pmd_qp_count,
780 .session_get_size = openssl_pmd_session_get_size,
781 .session_configure = openssl_pmd_session_configure,
782 .session_clear = openssl_pmd_session_clear
785 struct rte_cryptodev_ops *rte_openssl_pmd_ops = &openssl_pmd_ops;