cryptodev: remove attach/detach session API
[dpdk.git] / lib / librte_cryptodev / rte_cryptodev.c
index b40c028..745ea1c 100644 (file)
@@ -1,33 +1,5 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2015-2017 Intel Corporation
  */
 
 #include <sys/types.h>
@@ -290,19 +262,40 @@ rte_cryptodev_sym_capability_get(uint8_t dev_id,
 
 }
 
-#define param_range_check(x, y) \
-       (((x < y.min) || (x > y.max)) || \
-       (y.increment != 0 && (x % y.increment) != 0))
+static int
+param_range_check(uint16_t size, const struct rte_crypto_param_range *range)
+{
+       unsigned int next_size;
+
+       /* Check lower/upper bounds */
+       if (size < range->min)
+               return -1;
+
+       if (size > range->max)
+               return -1;
+
+       /* If range is actually only one value, size is correct */
+       if (range->increment == 0)
+               return 0;
+
+       /* Check if value is one of the supported sizes */
+       for (next_size = range->min; next_size <= range->max;
+                       next_size += range->increment)
+               if (size == next_size)
+                       return 0;
+
+       return -1;
+}
 
 int
 rte_cryptodev_sym_capability_check_cipher(
                const struct rte_cryptodev_symmetric_capability *capability,
                uint16_t key_size, uint16_t iv_size)
 {
-       if (param_range_check(key_size, capability->cipher.key_size))
+       if (param_range_check(key_size, &capability->cipher.key_size) != 0)
                return -1;
 
-       if (param_range_check(iv_size, capability->cipher.iv_size))
+       if (param_range_check(iv_size, &capability->cipher.iv_size) != 0)
                return -1;
 
        return 0;
@@ -313,13 +306,13 @@ rte_cryptodev_sym_capability_check_auth(
                const struct rte_cryptodev_symmetric_capability *capability,
                uint16_t key_size, uint16_t digest_size, uint16_t iv_size)
 {
-       if (param_range_check(key_size, capability->auth.key_size))
+       if (param_range_check(key_size, &capability->auth.key_size) != 0)
                return -1;
 
-       if (param_range_check(digest_size, capability->auth.digest_size))
+       if (param_range_check(digest_size, &capability->auth.digest_size) != 0)
                return -1;
 
-       if (param_range_check(iv_size, capability->auth.iv_size))
+       if (param_range_check(iv_size, &capability->auth.iv_size) != 0)
                return -1;
 
        return 0;
@@ -331,16 +324,16 @@ rte_cryptodev_sym_capability_check_aead(
                uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
                uint16_t iv_size)
 {
-       if (param_range_check(key_size, capability->aead.key_size))
+       if (param_range_check(key_size, &capability->aead.key_size) != 0)
                return -1;
 
-       if (param_range_check(digest_size, capability->aead.digest_size))
+       if (param_range_check(digest_size, &capability->aead.digest_size) != 0)
                return -1;
 
-       if (param_range_check(aad_size, capability->aead.aad_size))
+       if (param_range_check(aad_size, &capability->aead.aad_size) != 0)
                return -1;
 
-       if (param_range_check(iv_size, capability->aead.iv_size))
+       if (param_range_check(iv_size, &capability->aead.iv_size) != 0)
                return -1;
 
        return 0;
@@ -362,16 +355,28 @@ rte_cryptodev_get_feature_name(uint64_t flag)
                return "CPU_AVX";
        case RTE_CRYPTODEV_FF_CPU_AVX2:
                return "CPU_AVX2";
+       case RTE_CRYPTODEV_FF_CPU_AVX512:
+               return "CPU_AVX512";
        case RTE_CRYPTODEV_FF_CPU_AESNI:
                return "CPU_AESNI";
        case RTE_CRYPTODEV_FF_HW_ACCELERATED:
                return "HW_ACCELERATED";
-       case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
-               return "MBUF_SCATTER_GATHER";
+       case RTE_CRYPTODEV_FF_IN_PLACE_SGL:
+               return "IN_PLACE_SGL";
+       case RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT:
+               return "OOP_SGL_IN_SGL_OUT";
+       case RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT:
+               return "OOP_SGL_IN_LB_OUT";
+       case RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT:
+               return "OOP_LB_IN_SGL_OUT";
+       case RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT:
+               return "OOP_LB_IN_LB_OUT";
        case RTE_CRYPTODEV_FF_CPU_NEON:
                return "CPU_NEON";
        case RTE_CRYPTODEV_FF_CPU_ARM_CE:
                return "CPU_ARM_CE";
+       case RTE_CRYPTODEV_FF_SECURITY:
+               return "SECURITY_PROTOCOL";
        default:
                return NULL;
        }
@@ -705,50 +710,6 @@ rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
        return 0;
 }
 
-int
-rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
-{
-       struct rte_cryptodev *dev;
-
-       if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
-               CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
-               return -EINVAL;
-       }
-
-       dev = &rte_crypto_devices[dev_id];
-       if (queue_pair_id >= dev->data->nb_queue_pairs) {
-               CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
-               return -EINVAL;
-       }
-
-       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
-
-       return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
-
-}
-
-int
-rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
-{
-       struct rte_cryptodev *dev;
-
-       if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
-               CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
-               return -EINVAL;
-       }
-
-       dev = &rte_crypto_devices[dev_id];
-       if (queue_pair_id >= dev->data->nb_queue_pairs) {
-               CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
-               return -EINVAL;
-       }
-
-       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
-
-       return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
-
-}
-
 int
 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
 {
@@ -969,6 +930,7 @@ rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
        (*dev->dev_ops->dev_infos_get)(dev, dev_info);
 
        dev_info->driver_name = dev->device->driver->name;
+       dev_info->device = dev->device;
 }
 
 
@@ -1120,71 +1082,19 @@ rte_cryptodev_sym_session_create(struct rte_mempool *mp)
        struct rte_cryptodev_sym_session *sess;
 
        /* Allocate a session structure from the session pool */
-       if (rte_mempool_get(mp, (void *)&sess)) {
+       if (rte_mempool_get(mp, (void **)&sess)) {
                CDEV_LOG_ERR("couldn't get object from session mempool");
                return NULL;
        }
 
-       /* Clear device session pointer */
-       memset(sess, 0, (sizeof(void *) * nb_drivers));
+       /* Clear device session pointer.
+        * Include the flag indicating presence of private data
+        */
+       memset(sess, 0, (sizeof(void *) * nb_drivers) + sizeof(uint8_t));
 
        return sess;
 }
 
-int
-rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
-               struct rte_cryptodev_sym_session *sess)
-{
-       struct rte_cryptodev *dev;
-
-       if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
-               CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
-               return -EINVAL;
-       }
-
-       dev = &rte_crypto_devices[dev_id];
-
-       /* The API is optional, not returning error if driver do not suuport */
-       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
-
-       void *sess_priv = get_session_private_data(sess, dev->driver_id);
-
-       if (dev->dev_ops->qp_attach_session(dev, qp_id, sess_priv)) {
-               CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
-                               dev_id, qp_id);
-               return -EPERM;
-       }
-
-       return 0;
-}
-
-int
-rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
-               struct rte_cryptodev_sym_session *sess)
-{
-       struct rte_cryptodev *dev;
-
-       if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
-               CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
-               return -EINVAL;
-       }
-
-       dev = &rte_crypto_devices[dev_id];
-
-       /* The API is optional, not returning error if driver do not suuport */
-       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
-
-       void *sess_priv = get_session_private_data(sess, dev->driver_id);
-
-       if (dev->dev_ops->qp_detach_session(dev, qp_id, sess_priv)) {
-               CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
-                               dev_id, qp_id);
-               return -EPERM;
-       }
-
-       return 0;
-}
-
 int
 rte_cryptodev_sym_session_clear(uint8_t dev_id,
                struct rte_cryptodev_sym_session *sess)
@@ -1226,17 +1136,18 @@ rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
 }
 
 unsigned int
-rte_cryptodev_get_header_session_size(void)
+rte_cryptodev_sym_get_header_session_size(void)
 {
        /*
         * Header contains pointers to the private data
-        * of all registered drivers
+        * of all registered drivers, and a flag which
+        * indicates presence of private data
         */
-       return (sizeof(void *) * nb_drivers);
+       return ((sizeof(void *) * nb_drivers) + sizeof(uint8_t));
 }
 
 unsigned int
-rte_cryptodev_get_private_session_size(uint8_t dev_id)
+rte_cryptodev_sym_get_private_session_size(uint8_t dev_id)
 {
        struct rte_cryptodev *dev;
        unsigned int header_size = sizeof(void *) * nb_drivers;
@@ -1264,6 +1175,38 @@ rte_cryptodev_get_private_session_size(uint8_t dev_id)
 
 }
 
+int __rte_experimental
+rte_cryptodev_sym_session_set_private_data(
+                                       struct rte_cryptodev_sym_session *sess,
+                                       void *data,
+                                       uint16_t size)
+{
+       uint16_t off_set = sizeof(void *) * nb_drivers;
+       uint8_t *private_data_present = (uint8_t *)sess + off_set;
+
+       if (sess == NULL)
+               return -EINVAL;
+
+       *private_data_present = 1;
+       off_set += sizeof(uint8_t);
+       rte_memcpy((uint8_t *)sess + off_set, data, size);
+       return 0;
+}
+
+void * __rte_experimental
+rte_cryptodev_sym_session_get_private_data(
+                                       struct rte_cryptodev_sym_session *sess)
+{
+       uint16_t off_set = sizeof(void *) * nb_drivers;
+       uint8_t *private_data_present = (uint8_t *)sess + off_set;
+
+       if (sess == NULL || !*private_data_present)
+               return NULL;
+
+       off_set += sizeof(uint8_t);
+       return (uint8_t *)sess + off_set;
+}
+
 /** Initialise rte_crypto_op mempool element */
 static void
 rte_crypto_op_init(struct rte_mempool *mempool,