1 /*- 2 * BSD LICENSE 3 * 4 * Copyright(c) 2017 Intel Corporation. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 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 15 * distribution. 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. 19 * 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. 31 */ 32 #include <rte_common.h> 33 #include <rte_hexdump.h> 34 #include <rte_cryptodev.h> 35 #include <rte_cryptodev_pmd.h> 36 #include <rte_vdev.h> 37 #include <rte_malloc.h> 38 #include <rte_cpuflags.h> 39 #include <rte_reorder.h> 40 41 #include "rte_cryptodev_scheduler.h" 42 #include "scheduler_pmd_private.h" 43 44 struct scheduler_init_params { 45 struct rte_crypto_vdev_init_params def_p; 46 uint32_t nb_slaves; 47 enum rte_cryptodev_scheduler_mode mode; 48 uint32_t enable_ordering; 49 char slave_names[RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES] 50 [RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN]; 51 }; 52 53 #define RTE_CRYPTODEV_VDEV_NAME ("name") 54 #define RTE_CRYPTODEV_VDEV_SLAVE ("slave") 55 #define RTE_CRYPTODEV_VDEV_MODE ("mode") 56 #define RTE_CRYPTODEV_VDEV_ORDERING ("ordering") 57 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG ("max_nb_queue_pairs") 58 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG ("max_nb_sessions") 59 #define RTE_CRYPTODEV_VDEV_SOCKET_ID ("socket_id") 60 61 const char *scheduler_valid_params[] = { 62 RTE_CRYPTODEV_VDEV_NAME, 63 RTE_CRYPTODEV_VDEV_SLAVE, 64 RTE_CRYPTODEV_VDEV_MODE, 65 RTE_CRYPTODEV_VDEV_ORDERING, 66 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG, 67 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG, 68 RTE_CRYPTODEV_VDEV_SOCKET_ID 69 }; 70 71 struct scheduler_parse_map { 72 const char *name; 73 uint32_t val; 74 }; 75 76 const struct scheduler_parse_map scheduler_mode_map[] = { 77 {RTE_STR(SCHEDULER_MODE_NAME_ROUND_ROBIN), 78 CDEV_SCHED_MODE_ROUNDROBIN}, 79 {RTE_STR(SCHEDULER_MODE_NAME_PKT_SIZE_DISTR), 80 CDEV_SCHED_MODE_PKT_SIZE_DISTR}, 81 {RTE_STR(SCHEDULER_MODE_NAME_FAIL_OVER), 82 CDEV_SCHED_MODE_FAILOVER} 83 }; 84 85 const struct scheduler_parse_map scheduler_ordering_map[] = { 86 {"enable", 1}, 87 {"disable", 0} 88 }; 89 90 static int 91 cryptodev_scheduler_create(const char *name, 92 struct rte_vdev_device *vdev, 93 struct scheduler_init_params *init_params) 94 { 95 struct rte_cryptodev *dev; 96 struct scheduler_ctx *sched_ctx; 97 uint32_t i; 98 int ret; 99 100 if (init_params->def_p.name[0] == '\0') 101 snprintf(init_params->def_p.name, 102 sizeof(init_params->def_p.name), 103 "%s", name); 104 105 dev = rte_cryptodev_pmd_virtual_dev_init(init_params->def_p.name, 106 sizeof(struct scheduler_ctx), 107 init_params->def_p.socket_id, 108 vdev); 109 if (dev == NULL) { 110 CS_LOG_ERR("driver %s: failed to create cryptodev vdev", 111 name); 112 return -EFAULT; 113 } 114 115 dev->dev_type = RTE_CRYPTODEV_SCHEDULER_PMD; 116 dev->dev_ops = rte_crypto_scheduler_pmd_ops; 117 118 sched_ctx = dev->data->dev_private; 119 sched_ctx->max_nb_queue_pairs = 120 init_params->def_p.max_nb_queue_pairs; 121 122 if (init_params->mode > CDEV_SCHED_MODE_USERDEFINED && 123 init_params->mode < CDEV_SCHED_MODE_COUNT) { 124 ret = rte_cryptodev_scheduler_mode_set(dev->data->dev_id, 125 init_params->mode); 126 if (ret < 0) { 127 rte_cryptodev_pmd_release_device(dev); 128 return ret; 129 } 130 131 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) { 132 if (scheduler_mode_map[i].val != sched_ctx->mode) 133 continue; 134 135 RTE_LOG(INFO, PMD, " Scheduling mode = %s\n", 136 scheduler_mode_map[i].name); 137 break; 138 } 139 } 140 141 sched_ctx->reordering_enabled = init_params->enable_ordering; 142 143 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) { 144 if (scheduler_ordering_map[i].val != 145 sched_ctx->reordering_enabled) 146 continue; 147 148 RTE_LOG(INFO, PMD, " Packet ordering = %s\n", 149 scheduler_ordering_map[i].name); 150 151 break; 152 } 153 154 for (i = 0; i < init_params->nb_slaves; i++) { 155 sched_ctx->init_slave_names[sched_ctx->nb_init_slaves] = 156 rte_zmalloc_socket( 157 NULL, 158 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN, 0, 159 SOCKET_ID_ANY); 160 161 if (!sched_ctx->init_slave_names[ 162 sched_ctx->nb_init_slaves]) { 163 CS_LOG_ERR("driver %s: Insufficient memory", 164 name); 165 return -ENOMEM; 166 } 167 168 strncpy(sched_ctx->init_slave_names[ 169 sched_ctx->nb_init_slaves], 170 init_params->slave_names[i], 171 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1); 172 173 sched_ctx->nb_init_slaves++; 174 } 175 176 /* 177 * Initialize capabilities structure as an empty structure, 178 * in case device information is requested when no slaves are attached 179 */ 180 sched_ctx->capabilities = rte_zmalloc_socket(NULL, 181 sizeof(struct rte_cryptodev_capabilities), 182 0, SOCKET_ID_ANY); 183 184 if (!sched_ctx->capabilities) { 185 RTE_LOG(ERR, PMD, "Not enough memory for capability " 186 "information\n"); 187 return -ENOMEM; 188 } 189 190 return 0; 191 } 192 193 static int 194 cryptodev_scheduler_remove(struct rte_vdev_device *vdev) 195 { 196 const char *name; 197 struct rte_cryptodev *dev; 198 struct scheduler_ctx *sched_ctx; 199 200 if (vdev == NULL) 201 return -EINVAL; 202 203 name = rte_vdev_device_name(vdev); 204 dev = rte_cryptodev_pmd_get_named_dev(name); 205 if (dev == NULL) 206 return -EINVAL; 207 208 sched_ctx = dev->data->dev_private; 209 210 if (sched_ctx->nb_slaves) { 211 uint32_t i; 212 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); 216 } 217 218 RTE_LOG(INFO, PMD, "Closing Crypto Scheduler device %s on numa " 219 "socket %u\n", name, rte_socket_id()); 220 221 return 0; 222 } 223 224 /** Parse integer from integer argument */ 225 static int 226 parse_integer_arg(const char *key __rte_unused, 227 const char *value, void *extra_args) 228 { 229 int *i = (int *) extra_args; 230 231 *i = atoi(value); 232 if (*i < 0) { 233 CS_LOG_ERR("Argument has to be positive.\n"); 234 return -EINVAL; 235 } 236 237 return 0; 238 } 239 240 /** Parse name */ 241 static int 242 parse_name_arg(const char *key __rte_unused, 243 const char *value, void *extra_args) 244 { 245 struct rte_crypto_vdev_init_params *params = extra_args; 246 247 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) { 248 CS_LOG_ERR("Invalid name %s, should be less than " 249 "%u bytes.\n", value, 250 RTE_CRYPTODEV_NAME_MAX_LEN - 1); 251 return -EINVAL; 252 } 253 254 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN); 255 256 return 0; 257 } 258 259 /** Parse slave */ 260 static int 261 parse_slave_arg(const char *key __rte_unused, 262 const char *value, void *extra_args) 263 { 264 struct scheduler_init_params *param = extra_args; 265 266 if (param->nb_slaves >= RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES - 1) { 267 CS_LOG_ERR("Too many slaves.\n"); 268 return -ENOMEM; 269 } 270 271 strncpy(param->slave_names[param->nb_slaves++], value, 272 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1); 273 274 return 0; 275 } 276 277 static int 278 parse_mode_arg(const char *key __rte_unused, 279 const char *value, void *extra_args) 280 { 281 struct scheduler_init_params *param = extra_args; 282 uint32_t i; 283 284 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) { 285 if (strcmp(value, scheduler_mode_map[i].name) == 0) { 286 param->mode = (enum rte_cryptodev_scheduler_mode) 287 scheduler_mode_map[i].val; 288 break; 289 } 290 } 291 292 if (i == RTE_DIM(scheduler_mode_map)) { 293 CS_LOG_ERR("Unrecognized input.\n"); 294 return -EINVAL; 295 } 296 297 return 0; 298 } 299 300 static int 301 parse_ordering_arg(const char *key __rte_unused, 302 const char *value, void *extra_args) 303 { 304 struct scheduler_init_params *param = extra_args; 305 uint32_t i; 306 307 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) { 308 if (strcmp(value, scheduler_ordering_map[i].name) == 0) { 309 param->enable_ordering = 310 scheduler_ordering_map[i].val; 311 break; 312 } 313 } 314 315 if (i == RTE_DIM(scheduler_ordering_map)) { 316 CS_LOG_ERR("Unrecognized input.\n"); 317 return -EINVAL; 318 } 319 320 return 0; 321 } 322 323 static int 324 scheduler_parse_init_params(struct scheduler_init_params *params, 325 const char *input_args) 326 { 327 struct rte_kvargs *kvlist = NULL; 328 int ret = 0; 329 330 if (params == NULL) 331 return -EINVAL; 332 333 if (input_args) { 334 kvlist = rte_kvargs_parse(input_args, 335 scheduler_valid_params); 336 if (kvlist == NULL) 337 return -1; 338 339 ret = rte_kvargs_process(kvlist, 340 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG, 341 &parse_integer_arg, 342 ¶ms->def_p.max_nb_queue_pairs); 343 if (ret < 0) 344 goto free_kvlist; 345 346 ret = rte_kvargs_process(kvlist, 347 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG, 348 &parse_integer_arg, 349 ¶ms->def_p.max_nb_sessions); 350 if (ret < 0) 351 goto free_kvlist; 352 353 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID, 354 &parse_integer_arg, 355 ¶ms->def_p.socket_id); 356 if (ret < 0) 357 goto free_kvlist; 358 359 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME, 360 &parse_name_arg, 361 ¶ms->def_p); 362 if (ret < 0) 363 goto free_kvlist; 364 365 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SLAVE, 366 &parse_slave_arg, params); 367 if (ret < 0) 368 goto free_kvlist; 369 370 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_MODE, 371 &parse_mode_arg, params); 372 if (ret < 0) 373 goto free_kvlist; 374 375 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_ORDERING, 376 &parse_ordering_arg, params); 377 if (ret < 0) 378 goto free_kvlist; 379 } 380 381 free_kvlist: 382 rte_kvargs_free(kvlist); 383 return ret; 384 } 385 386 static int 387 cryptodev_scheduler_probe(struct rte_vdev_device *vdev) 388 { 389 struct scheduler_init_params init_params = { 390 .def_p = { 391 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS, 392 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS, 393 rte_socket_id(), 394 "" 395 }, 396 .nb_slaves = 0, 397 .mode = CDEV_SCHED_MODE_NOT_SET, 398 .enable_ordering = 0, 399 .slave_names = { {0} } 400 }; 401 const char *name; 402 403 name = rte_vdev_device_name(vdev); 404 if (name == NULL) 405 return -EINVAL; 406 407 scheduler_parse_init_params(&init_params, 408 rte_vdev_device_args(vdev)); 409 410 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", 411 name, 412 init_params.def_p.socket_id); 413 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n", 414 init_params.def_p.max_nb_queue_pairs); 415 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n", 416 init_params.def_p.max_nb_sessions); 417 if (init_params.def_p.name[0] != '\0') 418 RTE_LOG(INFO, PMD, " User defined name = %s\n", 419 init_params.def_p.name); 420 421 return cryptodev_scheduler_create(name, 422 vdev, 423 &init_params); 424 } 425 426 static struct rte_vdev_driver cryptodev_scheduler_pmd_drv = { 427 .probe = cryptodev_scheduler_probe, 428 .remove = cryptodev_scheduler_remove 429 }; 430 431 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_SCHEDULER_PMD, 432 cryptodev_scheduler_pmd_drv); 433 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_SCHEDULER_PMD, 434 "max_nb_queue_pairs=<int> " 435 "max_nb_sessions=<int> " 436 "socket_id=<int> " 437 "slave=<name>"); 438