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 scheduler_init_params *init_params) 93 { 94 char crypto_dev_name[RTE_CRYPTODEV_NAME_MAX_LEN] = {0}; 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 ret = rte_cryptodev_pmd_create_dev_name( 102 crypto_dev_name, 103 RTE_STR(CRYPTODEV_NAME_SCHEDULER_PMD)); 104 105 if (ret < 0) { 106 CS_LOG_ERR("failed to create unique name"); 107 return ret; 108 } 109 } else { 110 strncpy(crypto_dev_name, init_params->def_p.name, 111 RTE_CRYPTODEV_NAME_MAX_LEN - 1); 112 } 113 114 dev = rte_cryptodev_pmd_virtual_dev_init(crypto_dev_name, 115 sizeof(struct scheduler_ctx), 116 init_params->def_p.socket_id); 117 if (dev == NULL) { 118 CS_LOG_ERR("driver %s: failed to create cryptodev vdev", 119 name); 120 return -EFAULT; 121 } 122 123 dev->dev_type = RTE_CRYPTODEV_SCHEDULER_PMD; 124 dev->dev_ops = rte_crypto_scheduler_pmd_ops; 125 126 sched_ctx = dev->data->dev_private; 127 sched_ctx->max_nb_queue_pairs = 128 init_params->def_p.max_nb_queue_pairs; 129 130 if (init_params->mode > CDEV_SCHED_MODE_USERDEFINED && 131 init_params->mode < CDEV_SCHED_MODE_COUNT) { 132 ret = rte_cryptodev_scheduler_mode_set(dev->data->dev_id, 133 init_params->mode); 134 if (ret < 0) { 135 rte_cryptodev_pmd_release_device(dev); 136 return ret; 137 } 138 139 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) { 140 if (scheduler_mode_map[i].val != sched_ctx->mode) 141 continue; 142 143 RTE_LOG(INFO, PMD, " Scheduling mode = %s\n", 144 scheduler_mode_map[i].name); 145 break; 146 } 147 } 148 149 sched_ctx->reordering_enabled = init_params->enable_ordering; 150 151 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) { 152 if (scheduler_ordering_map[i].val != 153 sched_ctx->reordering_enabled) 154 continue; 155 156 RTE_LOG(INFO, PMD, " Packet ordering = %s\n", 157 scheduler_ordering_map[i].name); 158 159 break; 160 } 161 162 for (i = 0; i < init_params->nb_slaves; i++) { 163 sched_ctx->init_slave_names[sched_ctx->nb_init_slaves] = 164 rte_zmalloc_socket( 165 NULL, 166 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN, 0, 167 SOCKET_ID_ANY); 168 169 if (!sched_ctx->init_slave_names[ 170 sched_ctx->nb_init_slaves]) { 171 CS_LOG_ERR("driver %s: Insufficient memory", 172 name); 173 return -ENOMEM; 174 } 175 176 strncpy(sched_ctx->init_slave_names[ 177 sched_ctx->nb_init_slaves], 178 init_params->slave_names[i], 179 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1); 180 181 sched_ctx->nb_init_slaves++; 182 } 183 184 return 0; 185 } 186 187 static int 188 cryptodev_scheduler_remove(struct rte_vdev_device *vdev) 189 { 190 const char *name; 191 struct rte_cryptodev *dev; 192 struct scheduler_ctx *sched_ctx; 193 194 if (vdev == NULL) 195 return -EINVAL; 196 197 name = rte_vdev_device_name(vdev); 198 dev = rte_cryptodev_pmd_get_named_dev(name); 199 if (dev == NULL) 200 return -EINVAL; 201 202 sched_ctx = dev->data->dev_private; 203 204 if (sched_ctx->nb_slaves) { 205 uint32_t i; 206 207 for (i = 0; i < sched_ctx->nb_slaves; i++) 208 rte_cryptodev_scheduler_slave_detach(dev->data->dev_id, 209 sched_ctx->slaves[i].dev_id); 210 } 211 212 RTE_LOG(INFO, PMD, "Closing Crypto Scheduler device %s on numa " 213 "socket %u\n", name, rte_socket_id()); 214 215 return 0; 216 } 217 218 static uint8_t 219 number_of_sockets(void) 220 { 221 int sockets = 0; 222 int i; 223 const struct rte_memseg *ms = rte_eal_get_physmem_layout(); 224 225 for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) { 226 if (sockets < ms[i].socket_id) 227 sockets = ms[i].socket_id; 228 } 229 230 /* Number of sockets = maximum socket_id + 1 */ 231 return ++sockets; 232 } 233 234 /** Parse integer from integer argument */ 235 static int 236 parse_integer_arg(const char *key __rte_unused, 237 const char *value, void *extra_args) 238 { 239 int *i = (int *) extra_args; 240 241 *i = atoi(value); 242 if (*i < 0) { 243 CS_LOG_ERR("Argument has to be positive.\n"); 244 return -EINVAL; 245 } 246 247 return 0; 248 } 249 250 /** Parse name */ 251 static int 252 parse_name_arg(const char *key __rte_unused, 253 const char *value, void *extra_args) 254 { 255 struct rte_crypto_vdev_init_params *params = extra_args; 256 257 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) { 258 CS_LOG_ERR("Invalid name %s, should be less than " 259 "%u bytes.\n", value, 260 RTE_CRYPTODEV_NAME_MAX_LEN - 1); 261 return -EINVAL; 262 } 263 264 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN); 265 266 return 0; 267 } 268 269 /** Parse slave */ 270 static int 271 parse_slave_arg(const char *key __rte_unused, 272 const char *value, void *extra_args) 273 { 274 struct scheduler_init_params *param = extra_args; 275 276 if (param->nb_slaves >= RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES - 1) { 277 CS_LOG_ERR("Too many slaves.\n"); 278 return -ENOMEM; 279 } 280 281 strncpy(param->slave_names[param->nb_slaves++], value, 282 RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN - 1); 283 284 return 0; 285 } 286 287 static int 288 parse_mode_arg(const char *key __rte_unused, 289 const char *value, void *extra_args) 290 { 291 struct scheduler_init_params *param = extra_args; 292 uint32_t i; 293 294 for (i = 0; i < RTE_DIM(scheduler_mode_map); i++) { 295 if (strcmp(value, scheduler_mode_map[i].name) == 0) { 296 param->mode = (enum rte_cryptodev_scheduler_mode) 297 scheduler_mode_map[i].val; 298 break; 299 } 300 } 301 302 if (i == RTE_DIM(scheduler_mode_map)) { 303 CS_LOG_ERR("Unrecognized input.\n"); 304 return -EINVAL; 305 } 306 307 return 0; 308 } 309 310 static int 311 parse_ordering_arg(const char *key __rte_unused, 312 const char *value, void *extra_args) 313 { 314 struct scheduler_init_params *param = extra_args; 315 uint32_t i; 316 317 for (i = 0; i < RTE_DIM(scheduler_ordering_map); i++) { 318 if (strcmp(value, scheduler_ordering_map[i].name) == 0) { 319 param->enable_ordering = 320 scheduler_ordering_map[i].val; 321 break; 322 } 323 } 324 325 if (i == RTE_DIM(scheduler_ordering_map)) { 326 CS_LOG_ERR("Unrecognized input.\n"); 327 return -EINVAL; 328 } 329 330 return 0; 331 } 332 333 static int 334 scheduler_parse_init_params(struct scheduler_init_params *params, 335 const char *input_args) 336 { 337 struct rte_kvargs *kvlist = NULL; 338 int ret = 0; 339 340 if (params == NULL) 341 return -EINVAL; 342 343 if (input_args) { 344 kvlist = rte_kvargs_parse(input_args, 345 scheduler_valid_params); 346 if (kvlist == NULL) 347 return -1; 348 349 ret = rte_kvargs_process(kvlist, 350 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG, 351 &parse_integer_arg, 352 ¶ms->def_p.max_nb_queue_pairs); 353 if (ret < 0) 354 goto free_kvlist; 355 356 ret = rte_kvargs_process(kvlist, 357 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG, 358 &parse_integer_arg, 359 ¶ms->def_p.max_nb_sessions); 360 if (ret < 0) 361 goto free_kvlist; 362 363 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID, 364 &parse_integer_arg, 365 ¶ms->def_p.socket_id); 366 if (ret < 0) 367 goto free_kvlist; 368 369 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME, 370 &parse_name_arg, 371 ¶ms->def_p); 372 if (ret < 0) 373 goto free_kvlist; 374 375 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SLAVE, 376 &parse_slave_arg, params); 377 if (ret < 0) 378 goto free_kvlist; 379 380 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_MODE, 381 &parse_mode_arg, params); 382 if (ret < 0) 383 goto free_kvlist; 384 385 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_ORDERING, 386 &parse_ordering_arg, params); 387 if (ret < 0) 388 goto free_kvlist; 389 390 if (params->def_p.socket_id >= number_of_sockets()) { 391 CDEV_LOG_ERR("Invalid socket id specified to create " 392 "the virtual crypto device on"); 393 goto free_kvlist; 394 } 395 } 396 397 free_kvlist: 398 rte_kvargs_free(kvlist); 399 return ret; 400 } 401 402 static int 403 cryptodev_scheduler_probe(struct rte_vdev_device *vdev) 404 { 405 struct scheduler_init_params init_params = { 406 .def_p = { 407 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS, 408 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS, 409 rte_socket_id(), 410 "" 411 }, 412 .nb_slaves = 0, 413 .mode = CDEV_SCHED_MODE_NOT_SET, 414 .enable_ordering = 0, 415 .slave_names = { {0} } 416 }; 417 const char *name; 418 419 name = rte_vdev_device_name(vdev); 420 if (name == NULL) 421 return -EINVAL; 422 423 scheduler_parse_init_params(&init_params, 424 rte_vdev_device_args(vdev)); 425 426 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", 427 name, 428 init_params.def_p.socket_id); 429 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n", 430 init_params.def_p.max_nb_queue_pairs); 431 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n", 432 init_params.def_p.max_nb_sessions); 433 if (init_params.def_p.name[0] != '\0') 434 RTE_LOG(INFO, PMD, " User defined name = %s\n", 435 init_params.def_p.name); 436 437 return cryptodev_scheduler_create(rte_vdev_device_name(vdev), 438 &init_params); 439 } 440 441 static struct rte_vdev_driver cryptodev_scheduler_pmd_drv = { 442 .probe = cryptodev_scheduler_probe, 443 .remove = cryptodev_scheduler_remove 444 }; 445 446 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_SCHEDULER_PMD, 447 cryptodev_scheduler_pmd_drv); 448 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_SCHEDULER_PMD, 449 "max_nb_queue_pairs=<int> " 450 "max_nb_sessions=<int> " 451 "socket_id=<int> " 452 "slave=<name>"); 453