4 * Copyright(c) 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.
32 #include <rte_common.h>
33 #include <rte_hexdump.h>
34 #include <rte_cryptodev.h>
35 #include <rte_cryptodev_pmd.h>
37 #include <rte_malloc.h>
38 #include <rte_cpuflags.h>
39 #include <rte_reorder.h>
41 #include "rte_cryptodev_scheduler.h"
42 #include "scheduler_pmd_private.h"
44 uint8_t cryptodev_driver_id;
46 struct scheduler_init_params {
47 struct rte_cryptodev_pmd_init_params def_p;
49 enum rte_cryptodev_scheduler_mode mode;
50 uint32_t enable_ordering;
52 char slave_names[RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES]
53 [RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN];
56 #define RTE_CRYPTODEV_VDEV_NAME ("name")
57 #define RTE_CRYPTODEV_VDEV_SLAVE ("slave")
58 #define RTE_CRYPTODEV_VDEV_MODE ("mode")
59 #define RTE_CRYPTODEV_VDEV_ORDERING ("ordering")
60 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG ("max_nb_queue_pairs")
61 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG ("max_nb_sessions")
62 #define RTE_CRYPTODEV_VDEV_SOCKET_ID ("socket_id")
63 #define RTE_CRYPTODEV_VDEV_COREMASK ("coremask")
64 #define RTE_CRYPTODEV_VDEV_CORELIST ("corelist")
66 const char *scheduler_valid_params[] = {
67 RTE_CRYPTODEV_VDEV_NAME,
68 RTE_CRYPTODEV_VDEV_SLAVE,
69 RTE_CRYPTODEV_VDEV_MODE,
70 RTE_CRYPTODEV_VDEV_ORDERING,
71 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
72 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
73 RTE_CRYPTODEV_VDEV_SOCKET_ID,
74 RTE_CRYPTODEV_VDEV_COREMASK,
75 RTE_CRYPTODEV_VDEV_CORELIST
78 struct scheduler_parse_map {
83 const struct scheduler_parse_map scheduler_mode_map[] = {
84 {RTE_STR(SCHEDULER_MODE_NAME_ROUND_ROBIN),
85 CDEV_SCHED_MODE_ROUNDROBIN},
86 {RTE_STR(SCHEDULER_MODE_NAME_PKT_SIZE_DISTR),
87 CDEV_SCHED_MODE_PKT_SIZE_DISTR},
88 {RTE_STR(SCHEDULER_MODE_NAME_FAIL_OVER),
89 CDEV_SCHED_MODE_FAILOVER},
90 {RTE_STR(SCHEDULER_MODE_NAME_MULTI_CORE),
91 CDEV_SCHED_MODE_MULTICORE}
94 const struct scheduler_parse_map scheduler_ordering_map[] = {
100 cryptodev_scheduler_create(const char *name,
101 struct rte_vdev_device *vdev,
102 struct scheduler_init_params *init_params)
104 struct rte_cryptodev *dev;
105 struct scheduler_ctx *sched_ctx;
109 dev = rte_cryptodev_pmd_create(name, &vdev->device,
110 &init_params->def_p);
112 CS_LOG_ERR("driver %s: failed to create cryptodev vdev",
117 if (init_params->wcmask != 0)
118 RTE_LOG(INFO, PMD, " workers core mask = %"PRIx64"\n",
119 init_params->wcmask);
121 dev->driver_id = cryptodev_driver_id;
122 dev->dev_ops = rte_crypto_scheduler_pmd_ops;
124 sched_ctx = dev->data->dev_private;
125 sched_ctx->max_nb_queue_pairs =
126 init_params->def_p.max_nb_queue_pairs;
128 if (init_params->mode == CDEV_SCHED_MODE_MULTICORE) {
131 sched_ctx->nb_wc = 0;
133 for (i = 0; i < RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKER_CORES; i++) {
134 if (init_params->wcmask & (1ULL << i)) {
135 sched_ctx->wc_pool[sched_ctx->nb_wc++] = i;
137 " Worker core[%u]=%u added\n",
138 sched_ctx->nb_wc-1, i);
143 if (init_params->mode > CDEV_SCHED_MODE_USERDEFINED &&
144 init_params->mode < CDEV_SCHED_MODE_COUNT) {
145 ret = rte_cryptodev_scheduler_mode_set(dev->data->dev_id,
148 rte_cryptodev_pmd_release_device(dev);
152 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) {
153 if (scheduler_mode_map[i].val != sched_ctx->mode)
156 RTE_LOG(INFO, PMD, " Scheduling mode = %s\n",
157 scheduler_mode_map[i].name);
162 sched_ctx->reordering_enabled = init_params->enable_ordering;
164 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) {
165 if (scheduler_ordering_map[i].val !=
166 sched_ctx->reordering_enabled)
169 RTE_LOG(INFO, PMD, " Packet ordering = %s\n",
170 scheduler_ordering_map[i].name);
175 for (i = 0; i < init_params->nb_slaves; i++) {
176 sched_ctx->init_slave_names[sched_ctx->nb_init_slaves] =
179 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN, 0,
182 if (!sched_ctx->init_slave_names[
183 sched_ctx->nb_init_slaves]) {
184 CS_LOG_ERR("driver %s: Insufficient memory",
189 strncpy(sched_ctx->init_slave_names[
190 sched_ctx->nb_init_slaves],
191 init_params->slave_names[i],
192 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1);
194 sched_ctx->nb_init_slaves++;
198 * Initialize capabilities structure as an empty structure,
199 * in case device information is requested when no slaves are attached
201 sched_ctx->capabilities = rte_zmalloc_socket(NULL,
202 sizeof(struct rte_cryptodev_capabilities),
205 if (!sched_ctx->capabilities) {
206 RTE_LOG(ERR, PMD, "Not enough memory for capability "
215 cryptodev_scheduler_remove(struct rte_vdev_device *vdev)
218 struct rte_cryptodev *dev;
219 struct scheduler_ctx *sched_ctx;
224 name = rte_vdev_device_name(vdev);
225 dev = rte_cryptodev_pmd_get_named_dev(name);
229 sched_ctx = dev->data->dev_private;
231 if (sched_ctx->nb_slaves) {
234 for (i = 0; i < sched_ctx->nb_slaves; i++)
235 rte_cryptodev_scheduler_slave_detach(dev->data->dev_id,
236 sched_ctx->slaves[i].dev_id);
239 return rte_cryptodev_pmd_destroy(dev);
242 /** Parse integer from integer argument */
244 parse_integer_arg(const char *key __rte_unused,
245 const char *value, void *extra_args)
247 int *i = (int *) extra_args;
251 CS_LOG_ERR("Argument has to be positive.\n");
258 /** Parse integer from hexadecimal integer argument */
260 parse_coremask_arg(const char *key __rte_unused,
261 const char *value, void *extra_args)
263 struct scheduler_init_params *params = extra_args;
265 params->wcmask = strtoull(value, NULL, 16);
270 /** Parse integer from list of integers argument */
272 parse_corelist_arg(const char *key __rte_unused,
273 const char *value, void *extra_args)
275 struct scheduler_init_params *params = extra_args;
277 params->wcmask = 0ULL;
279 const char *token = value;
281 while (isdigit(token[0])) {
283 unsigned int core = strtoul(token, &rval, 10);
285 params->wcmask |= 1ULL << core;
286 token = (const char *)rval;
287 if (token[0] == '\0')
297 parse_name_arg(const char *key __rte_unused,
298 const char *value, void *extra_args)
300 struct rte_cryptodev_pmd_init_params *params = extra_args;
302 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
303 CS_LOG_ERR("Invalid name %s, should be less than "
304 "%u bytes.\n", value,
305 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
309 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
316 parse_slave_arg(const char *key __rte_unused,
317 const char *value, void *extra_args)
319 struct scheduler_init_params *param = extra_args;
321 if (param->nb_slaves >= RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES) {
322 CS_LOG_ERR("Too many slaves.\n");
326 strncpy(param->slave_names[param->nb_slaves++], value,
327 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1);
333 parse_mode_arg(const char *key __rte_unused,
334 const char *value, void *extra_args)
336 struct scheduler_init_params *param = extra_args;
339 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) {
340 if (strcmp(value, scheduler_mode_map[i].name) == 0) {
341 param->mode = (enum rte_cryptodev_scheduler_mode)
342 scheduler_mode_map[i].val;
347 if (i == RTE_DIM(scheduler_mode_map)) {
348 CS_LOG_ERR("Unrecognized input.\n");
356 parse_ordering_arg(const char *key __rte_unused,
357 const char *value, void *extra_args)
359 struct scheduler_init_params *param = extra_args;
362 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) {
363 if (strcmp(value, scheduler_ordering_map[i].name) == 0) {
364 param->enable_ordering =
365 scheduler_ordering_map[i].val;
370 if (i == RTE_DIM(scheduler_ordering_map)) {
371 CS_LOG_ERR("Unrecognized input.\n");
379 scheduler_parse_init_params(struct scheduler_init_params *params,
380 const char *input_args)
382 struct rte_kvargs *kvlist = NULL;
389 kvlist = rte_kvargs_parse(input_args,
390 scheduler_valid_params);
394 ret = rte_kvargs_process(kvlist,
395 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
397 ¶ms->def_p.max_nb_queue_pairs);
401 ret = rte_kvargs_process(kvlist,
402 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
404 ¶ms->def_p.max_nb_sessions);
408 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
410 ¶ms->def_p.socket_id);
414 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_COREMASK,
420 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_CORELIST,
426 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
432 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SLAVE,
433 &parse_slave_arg, params);
437 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_MODE,
438 &parse_mode_arg, params);
442 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_ORDERING,
443 &parse_ordering_arg, params);
449 rte_kvargs_free(kvlist);
454 cryptodev_scheduler_probe(struct rte_vdev_device *vdev)
456 struct scheduler_init_params init_params = {
459 sizeof(struct scheduler_ctx),
461 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS,
462 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_SESSIONS
465 .mode = CDEV_SCHED_MODE_NOT_SET,
466 .enable_ordering = 0,
467 .slave_names = { {0} }
471 name = rte_vdev_device_name(vdev);
475 scheduler_parse_init_params(&init_params,
476 rte_vdev_device_args(vdev));
479 return cryptodev_scheduler_create(name,
484 static struct rte_vdev_driver cryptodev_scheduler_pmd_drv = {
485 .probe = cryptodev_scheduler_probe,
486 .remove = cryptodev_scheduler_remove
489 static struct cryptodev_driver scheduler_crypto_drv;
491 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_SCHEDULER_PMD,
492 cryptodev_scheduler_pmd_drv);
493 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_SCHEDULER_PMD,
494 "max_nb_queue_pairs=<int> "
495 "max_nb_sessions=<int> "
498 RTE_PMD_REGISTER_CRYPTO_DRIVER(scheduler_crypto_drv,
499 cryptodev_scheduler_pmd_drv,
500 cryptodev_driver_id);