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 struct scheduler_init_params {
45 struct rte_crypto_vdev_init_params def_p;
47 uint8_t slaves[RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES];
48 enum rte_cryptodev_scheduler_mode mode;
49 uint32_t enable_ordering;
52 #define RTE_CRYPTODEV_VDEV_NAME ("name")
53 #define RTE_CRYPTODEV_VDEV_SLAVE ("slave")
54 #define RTE_CRYPTODEV_VDEV_MODE ("mode")
55 #define RTE_CRYPTODEV_VDEV_ORDERING ("ordering")
56 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG ("max_nb_queue_pairs")
57 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG ("max_nb_sessions")
58 #define RTE_CRYPTODEV_VDEV_SOCKET_ID ("socket_id")
60 const char *scheduler_valid_params[] = {
61 RTE_CRYPTODEV_VDEV_NAME,
62 RTE_CRYPTODEV_VDEV_SLAVE,
63 RTE_CRYPTODEV_VDEV_MODE,
64 RTE_CRYPTODEV_VDEV_ORDERING,
65 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
66 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
67 RTE_CRYPTODEV_VDEV_SOCKET_ID
70 struct scheduler_parse_map {
75 const struct scheduler_parse_map scheduler_mode_map[] = {
76 {RTE_STR(SCHEDULER_MODE_NAME_ROUND_ROBIN),
77 CDEV_SCHED_MODE_ROUNDROBIN},
78 {RTE_STR(SCHEDULER_MODE_NAME_PKT_SIZE_DISTR),
79 CDEV_SCHED_MODE_PKT_SIZE_DISTR},
80 {RTE_STR(SCHEDULER_MODE_NAME_FAIL_OVER),
81 CDEV_SCHED_MODE_FAILOVER}
84 const struct scheduler_parse_map scheduler_ordering_map[] = {
90 attach_init_slaves(uint8_t scheduler_id,
91 const uint8_t *slaves, const uint8_t nb_slaves)
95 for (i = 0; i < nb_slaves; i++) {
96 struct rte_cryptodev *dev =
97 rte_cryptodev_pmd_get_dev(slaves[i]);
98 int status = rte_cryptodev_scheduler_slave_attach(
99 scheduler_id, slaves[i]);
101 if (status < 0 || !dev) {
102 CS_LOG_ERR("Failed to attach slave cryptodev "
107 RTE_LOG(INFO, PMD, " Attached Slave %s\n", dev->data->name);
114 cryptodev_scheduler_create(const char *name,
115 struct scheduler_init_params *init_params)
117 char crypto_dev_name[RTE_CRYPTODEV_NAME_MAX_LEN] = {0};
118 struct rte_cryptodev *dev;
119 struct scheduler_ctx *sched_ctx;
123 if (init_params->def_p.name[0] == '\0') {
124 ret = rte_cryptodev_pmd_create_dev_name(
126 RTE_STR(CRYPTODEV_NAME_SCHEDULER_PMD));
129 CS_LOG_ERR("failed to create unique name");
133 strncpy(crypto_dev_name, init_params->def_p.name,
134 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
137 dev = rte_cryptodev_pmd_virtual_dev_init(crypto_dev_name,
138 sizeof(struct scheduler_ctx),
139 init_params->def_p.socket_id);
141 CS_LOG_ERR("driver %s: failed to create cryptodev vdev",
146 dev->dev_type = RTE_CRYPTODEV_SCHEDULER_PMD;
147 dev->dev_ops = rte_crypto_scheduler_pmd_ops;
149 sched_ctx = dev->data->dev_private;
150 sched_ctx->max_nb_queue_pairs =
151 init_params->def_p.max_nb_queue_pairs;
153 ret = attach_init_slaves(dev->data->dev_id, init_params->slaves,
154 init_params->nb_slaves);
156 rte_cryptodev_pmd_release_device(dev);
160 if (init_params->mode > CDEV_SCHED_MODE_USERDEFINED &&
161 init_params->mode < CDEV_SCHED_MODE_COUNT) {
162 ret = rte_cryptodev_scheduler_mode_set(dev->data->dev_id,
165 rte_cryptodev_pmd_release_device(dev);
169 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) {
170 if (scheduler_mode_map[i].val != sched_ctx->mode)
173 RTE_LOG(INFO, PMD, " Scheduling mode = %s\n",
174 scheduler_mode_map[i].name);
179 sched_ctx->reordering_enabled = init_params->enable_ordering;
181 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) {
182 if (scheduler_ordering_map[i].val !=
183 sched_ctx->reordering_enabled)
186 RTE_LOG(INFO, PMD, " Packet ordering = %s\n",
187 scheduler_ordering_map[i].name);
196 cryptodev_scheduler_remove(const char *name)
198 struct rte_cryptodev *dev;
199 struct scheduler_ctx *sched_ctx;
204 dev = rte_cryptodev_pmd_get_named_dev(name);
208 sched_ctx = dev->data->dev_private;
210 if (sched_ctx->nb_slaves) {
213 for (i = 0; i < sched_ctx->nb_slaves; i++)
214 rte_cryptodev_scheduler_slave_detach(dev->data->dev_id,
215 sched_ctx->slaves[i].dev_id);
218 RTE_LOG(INFO, PMD, "Closing Crypto Scheduler device %s on numa "
219 "socket %u\n", name, rte_socket_id());
225 number_of_sockets(void)
229 const struct rte_memseg *ms = rte_eal_get_physmem_layout();
231 for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
232 if (sockets < ms[i].socket_id)
233 sockets = ms[i].socket_id;
236 /* Number of sockets = maximum socket_id + 1 */
240 /** Parse integer from integer argument */
242 parse_integer_arg(const char *key __rte_unused,
243 const char *value, void *extra_args)
245 int *i = (int *) extra_args;
249 CS_LOG_ERR("Argument has to be positive.\n");
258 parse_name_arg(const char *key __rte_unused,
259 const char *value, void *extra_args)
261 struct rte_crypto_vdev_init_params *params = extra_args;
263 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
264 CS_LOG_ERR("Invalid name %s, should be less than "
265 "%u bytes.\n", value,
266 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
270 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
277 parse_slave_arg(const char *key __rte_unused,
278 const char *value, void *extra_args)
280 struct scheduler_init_params *param = extra_args;
281 struct rte_cryptodev *dev =
282 rte_cryptodev_pmd_get_named_dev(value);
285 RTE_LOG(ERR, PMD, "Invalid slave name %s.\n", value);
289 if (param->nb_slaves >= RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES - 1) {
290 CS_LOG_ERR("Too many slaves.\n");
294 param->slaves[param->nb_slaves] = dev->data->dev_id;
301 parse_mode_arg(const char *key __rte_unused,
302 const char *value, void *extra_args)
304 struct scheduler_init_params *param = extra_args;
307 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) {
308 if (strcmp(value, scheduler_mode_map[i].name) == 0) {
309 param->mode = (enum rte_cryptodev_scheduler_mode)
310 scheduler_mode_map[i].val;
315 if (i == RTE_DIM(scheduler_mode_map)) {
316 CS_LOG_ERR("Unrecognized input.\n");
324 parse_ordering_arg(const char *key __rte_unused,
325 const char *value, void *extra_args)
327 struct scheduler_init_params *param = extra_args;
330 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) {
331 if (strcmp(value, scheduler_ordering_map[i].name) == 0) {
332 param->enable_ordering =
333 scheduler_ordering_map[i].val;
338 if (i == RTE_DIM(scheduler_ordering_map)) {
339 CS_LOG_ERR("Unrecognized input.\n");
347 scheduler_parse_init_params(struct scheduler_init_params *params,
348 const char *input_args)
350 struct rte_kvargs *kvlist = NULL;
357 kvlist = rte_kvargs_parse(input_args,
358 scheduler_valid_params);
362 ret = rte_kvargs_process(kvlist,
363 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
365 ¶ms->def_p.max_nb_queue_pairs);
369 ret = rte_kvargs_process(kvlist,
370 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
372 ¶ms->def_p.max_nb_sessions);
376 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
378 ¶ms->def_p.socket_id);
382 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
388 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SLAVE,
389 &parse_slave_arg, params);
393 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_MODE,
394 &parse_mode_arg, params);
398 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_ORDERING,
399 &parse_ordering_arg, params);
403 if (params->def_p.socket_id >= number_of_sockets()) {
404 CDEV_LOG_ERR("Invalid socket id specified to create "
405 "the virtual crypto device on");
411 rte_kvargs_free(kvlist);
416 cryptodev_scheduler_probe(const char *name, const char *input_args)
418 struct scheduler_init_params init_params = {
420 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
421 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
427 .mode = CDEV_SCHED_MODE_NOT_SET,
431 scheduler_parse_init_params(&init_params, input_args);
433 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
434 init_params.def_p.socket_id);
435 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
436 init_params.def_p.max_nb_queue_pairs);
437 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
438 init_params.def_p.max_nb_sessions);
439 if (init_params.def_p.name[0] != '\0')
440 RTE_LOG(INFO, PMD, " User defined name = %s\n",
441 init_params.def_p.name);
443 return cryptodev_scheduler_create(name, &init_params);
446 static struct rte_vdev_driver cryptodev_scheduler_pmd_drv = {
447 .probe = cryptodev_scheduler_probe,
448 .remove = cryptodev_scheduler_remove
451 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_SCHEDULER_PMD,
452 cryptodev_scheduler_pmd_drv);
453 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_SCHEDULER_PMD,
454 "max_nb_queue_pairs=<int> "
455 "max_nb_sessions=<int> "