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>
36 #include <rte_bus_vdev.h>
37 #include <rte_malloc.h>
38 #include <rte_cpuflags.h>
39 #include <rte_reorder.h>
40 #include <rte_string_fns.h>
42 #include "rte_cryptodev_scheduler.h"
43 #include "scheduler_pmd_private.h"
45 uint8_t cryptodev_driver_id;
47 struct scheduler_init_params {
48 struct rte_cryptodev_pmd_init_params def_p;
50 enum rte_cryptodev_scheduler_mode mode;
51 uint32_t enable_ordering;
52 uint16_t wc_pool[RTE_MAX_LCORE];
54 char slave_names[RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES]
55 [RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN];
58 #define RTE_CRYPTODEV_VDEV_NAME ("name")
59 #define RTE_CRYPTODEV_VDEV_SLAVE ("slave")
60 #define RTE_CRYPTODEV_VDEV_MODE ("mode")
61 #define RTE_CRYPTODEV_VDEV_ORDERING ("ordering")
62 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG ("max_nb_queue_pairs")
63 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG ("max_nb_sessions")
64 #define RTE_CRYPTODEV_VDEV_SOCKET_ID ("socket_id")
65 #define RTE_CRYPTODEV_VDEV_COREMASK ("coremask")
66 #define RTE_CRYPTODEV_VDEV_CORELIST ("corelist")
68 const char *scheduler_valid_params[] = {
69 RTE_CRYPTODEV_VDEV_NAME,
70 RTE_CRYPTODEV_VDEV_SLAVE,
71 RTE_CRYPTODEV_VDEV_MODE,
72 RTE_CRYPTODEV_VDEV_ORDERING,
73 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
74 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
75 RTE_CRYPTODEV_VDEV_SOCKET_ID,
76 RTE_CRYPTODEV_VDEV_COREMASK,
77 RTE_CRYPTODEV_VDEV_CORELIST
80 struct scheduler_parse_map {
85 const struct scheduler_parse_map scheduler_mode_map[] = {
86 {RTE_STR(SCHEDULER_MODE_NAME_ROUND_ROBIN),
87 CDEV_SCHED_MODE_ROUNDROBIN},
88 {RTE_STR(SCHEDULER_MODE_NAME_PKT_SIZE_DISTR),
89 CDEV_SCHED_MODE_PKT_SIZE_DISTR},
90 {RTE_STR(SCHEDULER_MODE_NAME_FAIL_OVER),
91 CDEV_SCHED_MODE_FAILOVER},
92 {RTE_STR(SCHEDULER_MODE_NAME_MULTI_CORE),
93 CDEV_SCHED_MODE_MULTICORE}
96 const struct scheduler_parse_map scheduler_ordering_map[] = {
102 cryptodev_scheduler_create(const char *name,
103 struct rte_vdev_device *vdev,
104 struct scheduler_init_params *init_params)
106 struct rte_cryptodev *dev;
107 struct scheduler_ctx *sched_ctx;
111 dev = rte_cryptodev_pmd_create(name, &vdev->device,
112 &init_params->def_p);
114 CS_LOG_ERR("driver %s: failed to create cryptodev vdev",
119 dev->driver_id = cryptodev_driver_id;
120 dev->dev_ops = rte_crypto_scheduler_pmd_ops;
122 sched_ctx = dev->data->dev_private;
123 sched_ctx->max_nb_queue_pairs =
124 init_params->def_p.max_nb_queue_pairs;
126 if (init_params->mode == CDEV_SCHED_MODE_MULTICORE) {
129 sched_ctx->nb_wc = init_params->nb_wc;
131 for (i = 0; i < sched_ctx->nb_wc; i++) {
132 sched_ctx->wc_pool[i] = init_params->wc_pool[i];
133 RTE_LOG(INFO, PMD, " Worker core[%u]=%u added\n",
134 i, sched_ctx->wc_pool[i]);
138 if (init_params->mode > CDEV_SCHED_MODE_USERDEFINED &&
139 init_params->mode < CDEV_SCHED_MODE_COUNT) {
140 ret = rte_cryptodev_scheduler_mode_set(dev->data->dev_id,
143 rte_cryptodev_pmd_release_device(dev);
147 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) {
148 if (scheduler_mode_map[i].val != sched_ctx->mode)
151 RTE_LOG(INFO, PMD, " Scheduling mode = %s\n",
152 scheduler_mode_map[i].name);
157 sched_ctx->reordering_enabled = init_params->enable_ordering;
159 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) {
160 if (scheduler_ordering_map[i].val !=
161 sched_ctx->reordering_enabled)
164 RTE_LOG(INFO, PMD, " Packet ordering = %s\n",
165 scheduler_ordering_map[i].name);
170 for (i = 0; i < init_params->nb_slaves; i++) {
171 sched_ctx->init_slave_names[sched_ctx->nb_init_slaves] =
174 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN, 0,
177 if (!sched_ctx->init_slave_names[
178 sched_ctx->nb_init_slaves]) {
179 CS_LOG_ERR("driver %s: Insufficient memory",
184 strncpy(sched_ctx->init_slave_names[
185 sched_ctx->nb_init_slaves],
186 init_params->slave_names[i],
187 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1);
189 sched_ctx->nb_init_slaves++;
193 * Initialize capabilities structure as an empty structure,
194 * in case device information is requested when no slaves are attached
196 sched_ctx->capabilities = rte_zmalloc_socket(NULL,
197 sizeof(struct rte_cryptodev_capabilities),
200 if (!sched_ctx->capabilities) {
201 RTE_LOG(ERR, PMD, "Not enough memory for capability "
210 cryptodev_scheduler_remove(struct rte_vdev_device *vdev)
213 struct rte_cryptodev *dev;
214 struct scheduler_ctx *sched_ctx;
219 name = rte_vdev_device_name(vdev);
220 dev = rte_cryptodev_pmd_get_named_dev(name);
224 sched_ctx = dev->data->dev_private;
226 if (sched_ctx->nb_slaves) {
229 for (i = 0; i < sched_ctx->nb_slaves; i++)
230 rte_cryptodev_scheduler_slave_detach(dev->data->dev_id,
231 sched_ctx->slaves[i].dev_id);
234 return rte_cryptodev_pmd_destroy(dev);
237 /** Parse integer from integer argument */
239 parse_integer_arg(const char *key __rte_unused,
240 const char *value, void *extra_args)
242 int *i = (int *) extra_args;
246 CS_LOG_ERR("Argument has to be positive.\n");
253 /** Parse integer from hexadecimal integer argument */
255 parse_coremask_arg(const char *key __rte_unused,
256 const char *value, void *extra_args)
261 struct scheduler_init_params *params = extra_args;
267 /* Remove all blank characters ahead and after .
268 * Remove 0x/0X if exists.
270 while (isblank(*value))
272 if (value[0] == '0' && ((value[1] == 'x') || (value[1] == 'X')))
275 while ((i > 0) && isblank(value[i - 1]))
281 for (i = i - 1; i >= 0 && idx < RTE_MAX_LCORE; i--) {
283 if (isxdigit(c) == 0) {
284 /* invalid characters */
294 for (j = 0; j < 4 && idx < RTE_MAX_LCORE; j++, idx++) {
296 params->wc_pool[params->nb_wc++] = idx;
303 /** Parse integer from list of integers argument */
305 parse_corelist_arg(const char *key __rte_unused,
306 const char *value, void *extra_args)
308 struct scheduler_init_params *params = extra_args;
312 const char *token = value;
314 while (isdigit(token[0])) {
316 unsigned int core = strtoul(token, &rval, 10);
318 if (core >= RTE_MAX_LCORE) {
319 CS_LOG_ERR("Invalid worker core %u, should be smaller "
320 "than %u.\n", core, RTE_MAX_LCORE);
322 params->wc_pool[params->nb_wc++] = (uint16_t)core;
323 token = (const char *)rval;
324 if (token[0] == '\0')
334 parse_name_arg(const char *key __rte_unused,
335 const char *value, void *extra_args)
337 struct rte_cryptodev_pmd_init_params *params = extra_args;
339 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
340 CS_LOG_ERR("Invalid name %s, should be less than "
341 "%u bytes.\n", value,
342 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
346 strlcpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
353 parse_slave_arg(const char *key __rte_unused,
354 const char *value, void *extra_args)
356 struct scheduler_init_params *param = extra_args;
358 if (param->nb_slaves >= RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES) {
359 CS_LOG_ERR("Too many slaves.\n");
363 strncpy(param->slave_names[param->nb_slaves++], value,
364 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1);
370 parse_mode_arg(const char *key __rte_unused,
371 const char *value, void *extra_args)
373 struct scheduler_init_params *param = extra_args;
376 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) {
377 if (strcmp(value, scheduler_mode_map[i].name) == 0) {
378 param->mode = (enum rte_cryptodev_scheduler_mode)
379 scheduler_mode_map[i].val;
384 if (i == RTE_DIM(scheduler_mode_map)) {
385 CS_LOG_ERR("Unrecognized input.\n");
393 parse_ordering_arg(const char *key __rte_unused,
394 const char *value, void *extra_args)
396 struct scheduler_init_params *param = extra_args;
399 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) {
400 if (strcmp(value, scheduler_ordering_map[i].name) == 0) {
401 param->enable_ordering =
402 scheduler_ordering_map[i].val;
407 if (i == RTE_DIM(scheduler_ordering_map)) {
408 CS_LOG_ERR("Unrecognized input.\n");
416 scheduler_parse_init_params(struct scheduler_init_params *params,
417 const char *input_args)
419 struct rte_kvargs *kvlist = NULL;
426 kvlist = rte_kvargs_parse(input_args,
427 scheduler_valid_params);
431 ret = rte_kvargs_process(kvlist,
432 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
434 ¶ms->def_p.max_nb_queue_pairs);
438 ret = rte_kvargs_process(kvlist,
439 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
441 ¶ms->def_p.max_nb_sessions);
445 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
447 ¶ms->def_p.socket_id);
451 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_COREMASK,
457 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_CORELIST,
463 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
469 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SLAVE,
470 &parse_slave_arg, params);
474 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_MODE,
475 &parse_mode_arg, params);
479 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_ORDERING,
480 &parse_ordering_arg, params);
486 rte_kvargs_free(kvlist);
491 cryptodev_scheduler_probe(struct rte_vdev_device *vdev)
493 struct scheduler_init_params init_params = {
496 sizeof(struct scheduler_ctx),
498 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS,
499 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_SESSIONS
502 .mode = CDEV_SCHED_MODE_NOT_SET,
503 .enable_ordering = 0,
504 .slave_names = { {0} }
508 name = rte_vdev_device_name(vdev);
512 scheduler_parse_init_params(&init_params,
513 rte_vdev_device_args(vdev));
516 return cryptodev_scheduler_create(name,
521 static struct rte_vdev_driver cryptodev_scheduler_pmd_drv = {
522 .probe = cryptodev_scheduler_probe,
523 .remove = cryptodev_scheduler_remove
526 static struct cryptodev_driver scheduler_crypto_drv;
528 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_SCHEDULER_PMD,
529 cryptodev_scheduler_pmd_drv);
530 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_SCHEDULER_PMD,
531 "max_nb_queue_pairs=<int> "
532 "max_nb_sessions=<int> "
535 RTE_PMD_REGISTER_CRYPTO_DRIVER(scheduler_crypto_drv,
536 cryptodev_scheduler_pmd_drv,
537 cryptodev_driver_id);