cryptodev: remove old get session size functions
[dpdk.git] / lib / librte_cryptodev / rte_cryptodev.c
index cb773c7..381330f 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>
@@ -69,6 +41,8 @@
 #include "rte_cryptodev.h"
 #include "rte_cryptodev_pmd.h"
 
+static uint8_t nb_drivers;
+
 struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
 
 struct rte_cryptodev *rte_cryptodevs = &rte_crypto_devices[0];
@@ -288,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;
@@ -309,19 +304,15 @@ rte_cryptodev_sym_capability_check_cipher(
 int
 rte_cryptodev_sym_capability_check_auth(
                const struct rte_cryptodev_symmetric_capability *capability,
-               uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
-               uint16_t iv_size)
+               uint16_t key_size, uint16_t digest_size, uint16_t iv_size)
 {
-       if (param_range_check(key_size, capability->auth.key_size))
-               return -1;
-
-       if (param_range_check(digest_size, capability->auth.digest_size))
+       if (param_range_check(key_size, &capability->auth.key_size) != 0)
                return -1;
 
-       if (param_range_check(aad_size, capability->auth.aad_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;
@@ -333,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;
@@ -364,6 +355,8 @@ 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:
@@ -374,17 +367,13 @@ rte_cryptodev_get_feature_name(uint64_t flag)
                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;
        }
 }
 
-int
-rte_cryptodev_create_vdev(const char *name, const char *args)
-{
-       return rte_vdev_init(name, args);
-}
-
 struct rte_cryptodev *
 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
 {
@@ -490,6 +479,16 @@ rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
        return count;
 }
 
+void *
+rte_cryptodev_get_sec_ctx(uint8_t dev_id)
+{
+       if (rte_crypto_devices[dev_id].feature_flags &
+                       RTE_CRYPTODEV_FF_SECURITY)
+               return rte_crypto_devices[dev_id].security_ctx;
+
+       return NULL;
+}
+
 int
 rte_cryptodev_socket_id(uint8_t dev_id)
 {
@@ -585,6 +584,9 @@ rte_cryptodev_pmd_allocate(const char *name, int socket_id)
                cryptodev->data->socket_id = socket_id;
                cryptodev->data->dev_started = 0;
 
+               /* init user callbacks */
+               TAILQ_INIT(&(cryptodev->link_intr_cbs));
+
                cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
 
                cryptodev_globals.nb_devs++;
@@ -701,52 +703,7 @@ rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
 }
 
 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,
-               struct rte_mempool *session_pool)
+rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
 {
        struct rte_cryptodev *dev;
        int diag;
@@ -766,8 +723,6 @@ rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config,
 
        RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
 
-       dev->data->session_pool = session_pool;
-
        /* Setup new number of queue pairs and reconfigure device. */
        diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
                        config->socket_id);
@@ -879,7 +834,9 @@ rte_cryptodev_close(uint8_t dev_id)
 
 int
 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
-               const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
+               const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
+               struct rte_mempool *session_pool)
+
 {
        struct rte_cryptodev *dev;
 
@@ -903,7 +860,7 @@ rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
        RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
 
        return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
-                       socket_id);
+                       socket_id, session_pool);
 }
 
 
@@ -965,6 +922,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;
 }
 
 
@@ -1080,56 +1038,51 @@ rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
 }
 
 
-static void
-rte_cryptodev_sym_session_init(struct rte_mempool *mp,
-               const struct rte_cryptodev *dev,
-               struct rte_cryptodev_sym_session *sess)
+int
+rte_cryptodev_sym_session_init(uint8_t dev_id,
+               struct rte_cryptodev_sym_session *sess,
+               struct rte_crypto_sym_xform *xforms,
+               struct rte_mempool *mp)
 {
-       memset(sess, 0, mp->elt_size);
+       struct rte_cryptodev *dev;
+       uint8_t index;
+       int ret;
 
-       sess->driver_id = dev->driver_id;
-       sess->mp = mp;
+       dev = rte_cryptodev_pmd_get_dev(dev_id);
 
-       if (dev->dev_ops->session_initialize)
-               (*dev->dev_ops->session_initialize)(mp, sess);
-}
+       if (sess == NULL || xforms == NULL || dev == NULL)
+               return -EINVAL;
+
+       index = dev->driver_id;
+
+       if (sess->sess_private_data[index] == NULL) {
+               ret = dev->dev_ops->session_configure(dev, xforms, sess, mp);
+               if (ret < 0) {
+                       CDEV_LOG_ERR(
+                               "dev_id %d failed to configure session details",
+                               dev_id);
+                       return ret;
+               }
+       }
 
+       return 0;
+}
 
 struct rte_cryptodev_sym_session *
-rte_cryptodev_sym_session_create(uint8_t dev_id,
-               struct rte_crypto_sym_xform *xform)
+rte_cryptodev_sym_session_create(struct rte_mempool *mp)
 {
-       struct rte_cryptodev *dev;
        struct rte_cryptodev_sym_session *sess;
-       void *_sess;
-
-       if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
-               CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
-               return NULL;
-       }
-
-       dev = &rte_crypto_devices[dev_id];
 
        /* Allocate a session structure from the session pool */
-       if (rte_mempool_get(dev->data->session_pool, &_sess)) {
-               CDEV_LOG_ERR("Couldn't get object from session mempool");
+       if (rte_mempool_get(mp, (void **)&sess)) {
+               CDEV_LOG_ERR("couldn't get object from session mempool");
                return NULL;
        }
 
-       sess = _sess;
-
-       rte_cryptodev_sym_session_init(dev->data->session_pool, dev,
-                                       sess);
-       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
-       if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
-                       NULL) {
-               CDEV_LOG_ERR("dev_id %d failed to configure session details",
-                               dev_id);
-
-               /* Return session to mempool */
-               rte_mempool_put(sess->mp, _sess);
-               return NULL;
-       }
+       /* Clear device session pointer.
+        * Include the flag indicating presence of private data
+        */
+       memset(sess, 0, (sizeof(void *) * nb_drivers) + sizeof(uint8_t));
 
        return sess;
 }
@@ -1149,7 +1102,10 @@ rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_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);
-       if (dev->dev_ops->qp_attach_session(dev, qp_id, sess->_private)) {
+
+       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;
@@ -1173,7 +1129,10 @@ rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_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);
-       if (dev->dev_ops->qp_detach_session(dev, qp_id, sess->_private)) {
+
+       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;
@@ -1181,37 +1140,63 @@ rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
 
        return 0;
 }
-struct rte_cryptodev_sym_session *
-rte_cryptodev_sym_session_free(uint8_t dev_id,
+
+int
+rte_cryptodev_sym_session_clear(uint8_t dev_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 sess;
-       }
+       dev = rte_cryptodev_pmd_get_dev(dev_id);
 
-       dev = &rte_crypto_devices[dev_id];
+       if (dev == NULL || sess == NULL)
+               return -EINVAL;
+
+       dev->dev_ops->session_clear(dev, sess);
+
+       return 0;
+}
 
-       /* Check the session belongs to this device type */
-       if (sess->driver_id != dev->driver_id)
-               return sess;
+int
+rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
+{
+       uint8_t i;
+       void *sess_priv;
+       struct rte_mempool *sess_mp;
+
+       if (sess == NULL)
+               return -EINVAL;
 
-       /* Let device implementation clear session material */
-       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
-       dev->dev_ops->session_clear(dev, (void *)sess->_private);
+       /* Check that all device private data has been freed */
+       for (i = 0; i < nb_drivers; i++) {
+               sess_priv = get_session_private_data(sess, i);
+               if (sess_priv != NULL)
+                       return -EBUSY;
+       }
 
        /* Return session to mempool */
-       rte_mempool_put(sess->mp, (void *)sess);
+       sess_mp = rte_mempool_from_obj(sess);
+       rte_mempool_put(sess_mp, sess);
 
-       return NULL;
+       return 0;
+}
+
+unsigned int
+rte_cryptodev_sym_get_header_session_size(void)
+{
+       /*
+        * Header contains pointers to the private data
+        * of all registered drivers, and a flag which
+        * indicates presence of private data
+        */
+       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;
        unsigned int priv_sess_size;
 
        if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
@@ -1224,10 +1209,50 @@ rte_cryptodev_get_private_session_size(uint8_t dev_id)
 
        priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
 
+       /*
+        * If size is less than session header size,
+        * return the latter, as this guarantees that
+        * sessionless operations will work
+        */
+       if (priv_sess_size < header_size)
+               return header_size;
+
        return priv_sess_size;
 
 }
 
+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,
@@ -1242,7 +1267,7 @@ rte_crypto_op_init(struct rte_mempool *mempool,
 
        __rte_crypto_op_reset(op, type);
 
-       op->phys_addr = rte_mem_virt2phy(_op_data);
+       op->phys_addr = rte_mem_virt2iova(_op_data);
        op->mempool = mempool;
 }
 
@@ -1333,14 +1358,6 @@ TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
 static struct cryptodev_driver_list cryptodev_driver_list =
        TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
 
-struct cryptodev_driver {
-       TAILQ_ENTRY(cryptodev_driver) next; /**< Next in list. */
-       const struct rte_driver *driver;
-       uint8_t id;
-};
-
-static uint8_t nb_drivers;
-
 int
 rte_cryptodev_driver_id_get(const char *name)
 {
@@ -1360,6 +1377,17 @@ rte_cryptodev_driver_id_get(const char *name)
        return -1;
 }
 
+const char *
+rte_cryptodev_name_get(uint8_t dev_id)
+{
+       struct rte_cryptodev *dev = rte_cryptodev_pmd_get_dev(dev_id);
+
+       if (dev == NULL)
+               return NULL;
+
+       return dev->data->name;
+}
+
 const char *
 rte_cryptodev_driver_name_get(uint8_t driver_id)
 {
@@ -1372,15 +1400,13 @@ rte_cryptodev_driver_name_get(uint8_t driver_id)
 }
 
 uint8_t
-rte_cryptodev_allocate_driver(const struct rte_driver *drv)
+rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
+               const struct rte_driver *drv)
 {
-       struct cryptodev_driver *driver;
-
-       driver = malloc(sizeof(*driver));
-       driver->driver = drv;
-       driver->id = nb_drivers;
+       crypto_drv->driver = drv;
+       crypto_drv->id = nb_drivers;
 
-       TAILQ_INSERT_TAIL(&cryptodev_driver_list, driver, next);
+       TAILQ_INSERT_TAIL(&cryptodev_driver_list, crypto_drv, next);
 
        return nb_drivers++;
 }