Imported Upstream version 17.05
[deb_dpdk.git] / drivers / crypto / scheduler / scheduler_pmd.c
diff --git a/drivers/crypto/scheduler/scheduler_pmd.c b/drivers/crypto/scheduler/scheduler_pmd.c
new file mode 100644 (file)
index 0000000..0b63c20
--- /dev/null
@@ -0,0 +1,456 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright(c) 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.
+ */
+#include <rte_common.h>
+#include <rte_hexdump.h>
+#include <rte_cryptodev.h>
+#include <rte_cryptodev_pmd.h>
+#include <rte_vdev.h>
+#include <rte_malloc.h>
+#include <rte_cpuflags.h>
+#include <rte_reorder.h>
+
+#include "rte_cryptodev_scheduler.h"
+#include "scheduler_pmd_private.h"
+
+struct scheduler_init_params {
+       struct rte_crypto_vdev_init_params def_p;
+       uint32_t nb_slaves;
+       enum rte_cryptodev_scheduler_mode mode;
+       uint32_t enable_ordering;
+       char slave_names[RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES]
+                       [RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN];
+};
+
+#define RTE_CRYPTODEV_VDEV_NAME                        ("name")
+#define RTE_CRYPTODEV_VDEV_SLAVE               ("slave")
+#define RTE_CRYPTODEV_VDEV_MODE                        ("mode")
+#define RTE_CRYPTODEV_VDEV_ORDERING            ("ordering")
+#define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG       ("max_nb_queue_pairs")
+#define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG     ("max_nb_sessions")
+#define RTE_CRYPTODEV_VDEV_SOCKET_ID           ("socket_id")
+
+const char *scheduler_valid_params[] = {
+       RTE_CRYPTODEV_VDEV_NAME,
+       RTE_CRYPTODEV_VDEV_SLAVE,
+       RTE_CRYPTODEV_VDEV_MODE,
+       RTE_CRYPTODEV_VDEV_ORDERING,
+       RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
+       RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
+       RTE_CRYPTODEV_VDEV_SOCKET_ID
+};
+
+struct scheduler_parse_map {
+       const char *name;
+       uint32_t val;
+};
+
+const struct scheduler_parse_map scheduler_mode_map[] = {
+       {RTE_STR(SCHEDULER_MODE_NAME_ROUND_ROBIN),
+                       CDEV_SCHED_MODE_ROUNDROBIN},
+       {RTE_STR(SCHEDULER_MODE_NAME_PKT_SIZE_DISTR),
+                       CDEV_SCHED_MODE_PKT_SIZE_DISTR},
+       {RTE_STR(SCHEDULER_MODE_NAME_FAIL_OVER),
+                       CDEV_SCHED_MODE_FAILOVER}
+};
+
+const struct scheduler_parse_map scheduler_ordering_map[] = {
+               {"enable", 1},
+               {"disable", 0}
+};
+
+static int
+cryptodev_scheduler_create(const char *name,
+       struct scheduler_init_params *init_params)
+{
+       struct rte_cryptodev *dev;
+       struct scheduler_ctx *sched_ctx;
+       uint32_t i;
+       int ret;
+
+       if (init_params->def_p.name[0] == '\0')
+               snprintf(init_params->def_p.name,
+                               sizeof(init_params->def_p.name),
+                               "%s", name);
+
+       dev = rte_cryptodev_pmd_virtual_dev_init(init_params->def_p.name,
+                       sizeof(struct scheduler_ctx),
+                       init_params->def_p.socket_id);
+       if (dev == NULL) {
+               CS_LOG_ERR("driver %s: failed to create cryptodev vdev",
+                       name);
+               return -EFAULT;
+       }
+
+       dev->dev_type = RTE_CRYPTODEV_SCHEDULER_PMD;
+       dev->dev_ops = rte_crypto_scheduler_pmd_ops;
+
+       sched_ctx = dev->data->dev_private;
+       sched_ctx->max_nb_queue_pairs =
+                       init_params->def_p.max_nb_queue_pairs;
+
+       if (init_params->mode > CDEV_SCHED_MODE_USERDEFINED &&
+                       init_params->mode < CDEV_SCHED_MODE_COUNT) {
+               ret = rte_cryptodev_scheduler_mode_set(dev->data->dev_id,
+                       init_params->mode);
+               if (ret < 0) {
+                       rte_cryptodev_pmd_release_device(dev);
+                       return ret;
+               }
+
+               for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) {
+                       if (scheduler_mode_map[i].val != sched_ctx->mode)
+                               continue;
+
+                       RTE_LOG(INFO, PMD, "  Scheduling mode = %s\n",
+                                       scheduler_mode_map[i].name);
+                       break;
+               }
+       }
+
+       sched_ctx->reordering_enabled = init_params->enable_ordering;
+
+       for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) {
+               if (scheduler_ordering_map[i].val !=
+                               sched_ctx->reordering_enabled)
+                       continue;
+
+               RTE_LOG(INFO, PMD, "  Packet ordering = %s\n",
+                               scheduler_ordering_map[i].name);
+
+               break;
+       }
+
+       for (i = 0; i < init_params->nb_slaves; i++) {
+               sched_ctx->init_slave_names[sched_ctx->nb_init_slaves] =
+                       rte_zmalloc_socket(
+                               NULL,
+                               RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN, 0,
+                               SOCKET_ID_ANY);
+
+               if (!sched_ctx->init_slave_names[
+                               sched_ctx->nb_init_slaves]) {
+                       CS_LOG_ERR("driver %s: Insufficient memory",
+                                       name);
+                       return -ENOMEM;
+               }
+
+               strncpy(sched_ctx->init_slave_names[
+                                       sched_ctx->nb_init_slaves],
+                               init_params->slave_names[i],
+                               RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1);
+
+               sched_ctx->nb_init_slaves++;
+       }
+
+       /*
+        * Initialize capabilities structure as an empty structure,
+        * in case device information is requested when no slaves are attached
+        */
+       sched_ctx->capabilities = rte_zmalloc_socket(NULL,
+                       sizeof(struct rte_cryptodev_capabilities),
+                       0, SOCKET_ID_ANY);
+
+       if (!sched_ctx->capabilities) {
+               RTE_LOG(ERR, PMD, "Not enough memory for capability "
+                               "information\n");
+               return -ENOMEM;
+       }
+
+       return 0;
+}
+
+static int
+cryptodev_scheduler_remove(struct rte_vdev_device *vdev)
+{
+       const char *name;
+       struct rte_cryptodev *dev;
+       struct scheduler_ctx *sched_ctx;
+
+       if (vdev == NULL)
+               return -EINVAL;
+
+       name = rte_vdev_device_name(vdev);
+       dev = rte_cryptodev_pmd_get_named_dev(name);
+       if (dev == NULL)
+               return -EINVAL;
+
+       sched_ctx = dev->data->dev_private;
+
+       if (sched_ctx->nb_slaves) {
+               uint32_t i;
+
+               for (i = 0; i < sched_ctx->nb_slaves; i++)
+                       rte_cryptodev_scheduler_slave_detach(dev->data->dev_id,
+                                       sched_ctx->slaves[i].dev_id);
+       }
+
+       RTE_LOG(INFO, PMD, "Closing Crypto Scheduler device %s on numa "
+               "socket %u\n", name, rte_socket_id());
+
+       return 0;
+}
+
+static uint8_t
+number_of_sockets(void)
+{
+       int sockets = 0;
+       int i;
+       const struct rte_memseg *ms = rte_eal_get_physmem_layout();
+
+       for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
+               if (sockets < ms[i].socket_id)
+                       sockets = ms[i].socket_id;
+       }
+
+       /* Number of sockets = maximum socket_id + 1 */
+       return ++sockets;
+}
+
+/** Parse integer from integer argument */
+static int
+parse_integer_arg(const char *key __rte_unused,
+               const char *value, void *extra_args)
+{
+       int *i = (int *) extra_args;
+
+       *i = atoi(value);
+       if (*i < 0) {
+               CS_LOG_ERR("Argument has to be positive.\n");
+               return -EINVAL;
+       }
+
+       return 0;
+}
+
+/** Parse name */
+static int
+parse_name_arg(const char *key __rte_unused,
+               const char *value, void *extra_args)
+{
+       struct rte_crypto_vdev_init_params *params = extra_args;
+
+       if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
+               CS_LOG_ERR("Invalid name %s, should be less than "
+                               "%u bytes.\n", value,
+                               RTE_CRYPTODEV_NAME_MAX_LEN - 1);
+               return -EINVAL;
+       }
+
+       strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
+
+       return 0;
+}
+
+/** Parse slave */
+static int
+parse_slave_arg(const char *key __rte_unused,
+               const char *value, void *extra_args)
+{
+       struct scheduler_init_params *param = extra_args;
+
+       if (param->nb_slaves >= RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES - 1) {
+               CS_LOG_ERR("Too many slaves.\n");
+               return -ENOMEM;
+       }
+
+       strncpy(param->slave_names[param->nb_slaves++], value,
+                       RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1);
+
+       return 0;
+}
+
+static int
+parse_mode_arg(const char *key __rte_unused,
+               const char *value, void *extra_args)
+{
+       struct scheduler_init_params *param = extra_args;
+       uint32_t i;
+
+       for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) {
+               if (strcmp(value, scheduler_mode_map[i].name) == 0) {
+                       param->mode = (enum rte_cryptodev_scheduler_mode)
+                                       scheduler_mode_map[i].val;
+                       break;
+               }
+       }
+
+       if (i == RTE_DIM(scheduler_mode_map)) {
+               CS_LOG_ERR("Unrecognized input.\n");
+               return -EINVAL;
+       }
+
+       return 0;
+}
+
+static int
+parse_ordering_arg(const char *key __rte_unused,
+               const char *value, void *extra_args)
+{
+       struct scheduler_init_params *param = extra_args;
+       uint32_t i;
+
+       for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) {
+               if (strcmp(value, scheduler_ordering_map[i].name) == 0) {
+                       param->enable_ordering =
+                                       scheduler_ordering_map[i].val;
+                       break;
+               }
+       }
+
+       if (i == RTE_DIM(scheduler_ordering_map)) {
+               CS_LOG_ERR("Unrecognized input.\n");
+               return -EINVAL;
+       }
+
+       return 0;
+}
+
+static int
+scheduler_parse_init_params(struct scheduler_init_params *params,
+               const char *input_args)
+{
+       struct rte_kvargs *kvlist = NULL;
+       int ret = 0;
+
+       if (params == NULL)
+               return -EINVAL;
+
+       if (input_args) {
+               kvlist = rte_kvargs_parse(input_args,
+                               scheduler_valid_params);
+               if (kvlist == NULL)
+                       return -1;
+
+               ret = rte_kvargs_process(kvlist,
+                               RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
+                               &parse_integer_arg,
+                               &params->def_p.max_nb_queue_pairs);
+               if (ret < 0)
+                       goto free_kvlist;
+
+               ret = rte_kvargs_process(kvlist,
+                               RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
+                               &parse_integer_arg,
+                               &params->def_p.max_nb_sessions);
+               if (ret < 0)
+                       goto free_kvlist;
+
+               ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
+                               &parse_integer_arg,
+                               &params->def_p.socket_id);
+               if (ret < 0)
+                       goto free_kvlist;
+
+               ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
+                               &parse_name_arg,
+                               &params->def_p);
+               if (ret < 0)
+                       goto free_kvlist;
+
+               ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SLAVE,
+                               &parse_slave_arg, params);
+               if (ret < 0)
+                       goto free_kvlist;
+
+               ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_MODE,
+                               &parse_mode_arg, params);
+               if (ret < 0)
+                       goto free_kvlist;
+
+               ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_ORDERING,
+                               &parse_ordering_arg, params);
+               if (ret < 0)
+                       goto free_kvlist;
+
+               if (params->def_p.socket_id >= number_of_sockets()) {
+                       CDEV_LOG_ERR("Invalid socket id specified to create "
+                               "the virtual crypto device on");
+                       goto free_kvlist;
+               }
+       }
+
+free_kvlist:
+       rte_kvargs_free(kvlist);
+       return ret;
+}
+
+static int
+cryptodev_scheduler_probe(struct rte_vdev_device *vdev)
+{
+       struct scheduler_init_params init_params = {
+               .def_p = {
+                       RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
+                       RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
+                       rte_socket_id(),
+                       ""
+               },
+               .nb_slaves = 0,
+               .mode = CDEV_SCHED_MODE_NOT_SET,
+               .enable_ordering = 0,
+               .slave_names = { {0} }
+       };
+       const char *name;
+
+       name = rte_vdev_device_name(vdev);
+       if (name == NULL)
+               return -EINVAL;
+
+       scheduler_parse_init_params(&init_params,
+                                   rte_vdev_device_args(vdev));
+
+       RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n",
+                       name,
+                       init_params.def_p.socket_id);
+       RTE_LOG(INFO, PMD, "  Max number of queue pairs = %d\n",
+                       init_params.def_p.max_nb_queue_pairs);
+       RTE_LOG(INFO, PMD, "  Max number of sessions = %d\n",
+                       init_params.def_p.max_nb_sessions);
+       if (init_params.def_p.name[0] != '\0')
+               RTE_LOG(INFO, PMD, "  User defined name = %s\n",
+                       init_params.def_p.name);
+
+       return cryptodev_scheduler_create(name,
+                                       &init_params);
+}
+
+static struct rte_vdev_driver cryptodev_scheduler_pmd_drv = {
+       .probe = cryptodev_scheduler_probe,
+       .remove = cryptodev_scheduler_remove
+};
+
+RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_SCHEDULER_PMD,
+       cryptodev_scheduler_pmd_drv);
+RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_SCHEDULER_PMD,
+       "max_nb_queue_pairs=<int> "
+       "max_nb_sessions=<int> "
+       "socket_id=<int> "
+       "slave=<name>");