lib/librte_cryptodev/rte_cryptodev.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2015-2016 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
  33 #include <sys/types.h>
  34 #include <sys/queue.h>
  35 #include <ctype.h>
  36 #include <stdio.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <stdarg.h>
  40 #include <errno.h>
  41 #include <stdint.h>
  42 #include <inttypes.h>
  43 #include <netinet/in.h>
  44
  45 #include <rte_byteorder.h>
  46 #include <rte_log.h>
  47 #include <rte_debug.h>
  48 #include <rte_dev.h>
  49 #include <rte_interrupts.h>
  50 #include <rte_pci.h>
  51 #include <rte_memory.h>
  52 #include <rte_memcpy.h>
  53 #include <rte_memzone.h>
  54 #include <rte_launch.h>
  55 #include <rte_tailq.h>
  56 #include <rte_eal.h>
  57 #include <rte_per_lcore.h>
  58 #include <rte_lcore.h>
  59 #include <rte_atomic.h>
  60 #include <rte_branch_prediction.h>
  61 #include <rte_common.h>
  62 #include <rte_mempool.h>
  63 #include <rte_malloc.h>
  64 #include <rte_mbuf.h>
  65 #include <rte_errno.h>
  66 #include <rte_spinlock.h>
  67 #include <rte_string_fns.h>
  68
  69 #include "rte_crypto.h"
  70 #include "rte_cryptodev.h"
  71 #include "rte_cryptodev_pmd.h"
  72
  73 struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
  74
  75 struct rte_cryptodev *rte_cryptodevs = &rte_crypto_devices[0];
  76
  77 static struct rte_cryptodev_global cryptodev_globals = {
  78                 .devs                   = &rte_crypto_devices[0],
  79                 .data                   = { NULL },
  80                 .nb_devs                = 0,
  81                 .max_devs               = RTE_CRYPTO_MAX_DEVS
  82 };
  83
  84 struct rte_cryptodev_global *rte_cryptodev_globals = &cryptodev_globals;
  85
  86 /* spinlock for crypto device callbacks */
  87 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
  88
  89
  90 /**
  91  * The user application callback description.
  92  *
  93  * It contains callback address to be registered by user application,
  94  * the pointer to the parameters for callback, and the event type.
  95  */
  96 struct rte_cryptodev_callback {
  97         TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
  98         rte_cryptodev_cb_fn cb_fn;              /**< Callback address */
  99         void *cb_arg;                           /**< Parameter for callback */
 100         enum rte_cryptodev_event_type event;    /**< Interrupt event type */
 101         uint32_t active;                        /**< Callback is executing */
 102 };
 103
 104 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG                ("max_nb_queue_pairs")
 105 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG              ("max_nb_sessions")
 106 #define RTE_CRYPTODEV_VDEV_SOCKET_ID                    ("socket_id")
 107
 108 static const char *cryptodev_vdev_valid_params[] = {
 109         RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
 110         RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
 111         RTE_CRYPTODEV_VDEV_SOCKET_ID
 112 };
 113
 114 static uint8_t
 115 number_of_sockets(void)
 116 {
 117         int sockets = 0;
 118         int i;
 119         const struct rte_memseg *ms = rte_eal_get_physmem_layout();
 120
 121         for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
 122                 if (sockets < ms[i].socket_id)
 123                         sockets = ms[i].socket_id;
 124         }
 125
 126         /* Number of sockets = maximum socket_id + 1 */
 127         return ++sockets;
 128 }
 129
 130 /** Parse integer from integer argument */
 131 static int
 132 parse_integer_arg(const char *key __rte_unused,
 133                 const char *value, void *extra_args)
 134 {
 135         int *i = (int *) extra_args;
 136
 137         *i = atoi(value);
 138         if (*i < 0) {
 139                 CDEV_LOG_ERR("Argument has to be positive.");
 140                 return -1;
 141         }
 142
 143         return 0;
 144 }
 145
 146 int
 147 rte_cryptodev_parse_vdev_init_params(struct rte_crypto_vdev_init_params *params,
 148                 const char *input_args)
 149 {
 150         struct rte_kvargs *kvlist = NULL;
 151         int ret = 0;
 152
 153         if (params == NULL)
 154                 return -EINVAL;
 155
 156         if (input_args) {
 157                 kvlist = rte_kvargs_parse(input_args,
 158                                 cryptodev_vdev_valid_params);
 159                 if (kvlist == NULL)
 160                         return -1;
 161
 162                 ret = rte_kvargs_process(kvlist,
 163                                         RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
 164                                         &parse_integer_arg,
 165                                         &params->max_nb_queue_pairs);
 166                 if (ret < 0)
 167                         goto free_kvlist;
 168
 169                 ret = rte_kvargs_process(kvlist,
 170                                         RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
 171                                         &parse_integer_arg,
 172                                         &params->max_nb_sessions);
 173                 if (ret < 0)
 174                         goto free_kvlist;
 175
 176                 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
 177                                         &parse_integer_arg,
 178                                         &params->socket_id);
 179                 if (ret < 0)
 180                         goto free_kvlist;
 181
 182                 if (params->socket_id >= number_of_sockets()) {
 183                         CDEV_LOG_ERR("Invalid socket id specified to create "
 184                                 "the virtual crypto device on");
 185                         goto free_kvlist;
 186                 }
 187         }
 188
 189 free_kvlist:
 190         rte_kvargs_free(kvlist);
 191         return ret;
 192 }
 193
 194 const char *
 195 rte_cryptodev_get_feature_name(uint64_t flag)
 196 {
 197         switch (flag) {
 198         case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
 199                 return "SYMMETRIC_CRYPTO";
 200         case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
 201                 return "ASYMMETRIC_CRYPTO";
 202         case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
 203                 return "SYM_OPERATION_CHAINING";
 204         case RTE_CRYPTODEV_FF_CPU_SSE:
 205                 return "CPU_SSE";
 206         case RTE_CRYPTODEV_FF_CPU_AVX:
 207                 return "CPU_AVX";
 208         case RTE_CRYPTODEV_FF_CPU_AVX2:
 209                 return "CPU_AVX2";
 210         case RTE_CRYPTODEV_FF_CPU_AESNI:
 211                 return "CPU_AESNI";
 212         case RTE_CRYPTODEV_FF_HW_ACCELERATED:
 213                 return "HW_ACCELERATED";
 214
 215         default:
 216                 return NULL;
 217         }
 218 }
 219
 220
 221 int
 222 rte_cryptodev_create_vdev(const char *name, const char *args)
 223 {
 224         return rte_eal_vdev_init(name, args);
 225 }
 226
 227 int
 228 rte_cryptodev_get_dev_id(const char *name) {
 229         unsigned i;
 230
 231         if (name == NULL)
 232                 return -1;
 233
 234         for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
 235                 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
 236                                 == 0) &&
 237                                 (rte_cryptodev_globals->devs[i].attached ==
 238                                                 RTE_CRYPTODEV_ATTACHED))
 239                         return i;
 240
 241         return -1;
 242 }
 243
 244 uint8_t
 245 rte_cryptodev_count(void)
 246 {
 247         return rte_cryptodev_globals->nb_devs;
 248 }
 249
 250 uint8_t
 251 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
 252 {
 253         uint8_t i, dev_count = 0;
 254
 255         for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
 256                 if (rte_cryptodev_globals->devs[i].dev_type == type &&
 257                         rte_cryptodev_globals->devs[i].attached ==
 258                                         RTE_CRYPTODEV_ATTACHED)
 259                         dev_count++;
 260
 261         return dev_count;
 262 }
 263
 264 int
 265 rte_cryptodev_socket_id(uint8_t dev_id)
 266 {
 267         struct rte_cryptodev *dev;
 268
 269         if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
 270                 return -1;
 271
 272         dev = rte_cryptodev_pmd_get_dev(dev_id);
 273
 274         return dev->data->socket_id;
 275 }
 276
 277 static inline int
 278 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
 279                 int socket_id)
 280 {
 281         char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
 282         const struct rte_memzone *mz;
 283         int n;
 284
 285         /* generate memzone name */
 286         n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
 287         if (n >= (int)sizeof(mz_name))
 288                 return -EINVAL;
 289
 290         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 291                 mz = rte_memzone_reserve(mz_name,
 292                                 sizeof(struct rte_cryptodev_data),
 293                                 socket_id, 0);
 294         } else
 295                 mz = rte_memzone_lookup(mz_name);
 296
 297         if (mz == NULL)
 298                 return -ENOMEM;
 299
 300         *data = mz->addr;
 301         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
 302                 memset(*data, 0, sizeof(struct rte_cryptodev_data));
 303
 304         return 0;
 305 }
 306
 307 static uint8_t
 308 rte_cryptodev_find_free_device_index(void)
 309 {
 310         uint8_t dev_id;
 311
 312         for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
 313                 if (rte_crypto_devices[dev_id].attached ==
 314                                 RTE_CRYPTODEV_DETACHED)
 315                         return dev_id;
 316         }
 317         return RTE_CRYPTO_MAX_DEVS;
 318 }
 319
 320 struct rte_cryptodev *
 321 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
 322 {
 323         struct rte_cryptodev *cryptodev;
 324         uint8_t dev_id;
 325
 326         if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
 327                 CDEV_LOG_ERR("Crypto device with name %s already "
 328                                 "allocated!", name);
 329                 return NULL;
 330         }
 331
 332         dev_id = rte_cryptodev_find_free_device_index();
 333         if (dev_id == RTE_CRYPTO_MAX_DEVS) {
 334                 CDEV_LOG_ERR("Reached maximum number of crypto devices");
 335                 return NULL;
 336         }
 337
 338         cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
 339
 340         if (cryptodev->data == NULL) {
 341                 struct rte_cryptodev_data *cryptodev_data =
 342                                 cryptodev_globals.data[dev_id];
 343
 344                 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
 345                                 socket_id);
 346
 347                 if (retval < 0 || cryptodev_data == NULL)
 348                         return NULL;
 349
 350                 cryptodev->data = cryptodev_data;
 351
 352                 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
 353                                 "%s", name);
 354
 355                 cryptodev->data->dev_id = dev_id;
 356                 cryptodev->data->socket_id = socket_id;
 357                 cryptodev->data->dev_started = 0;
 358
 359                 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
 360
 361                 cryptodev_globals.nb_devs++;
 362         }
 363
 364         return cryptodev;
 365 }
 366
 367 int
 368 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
 369 {
 370         int ret;
 371
 372         if (cryptodev == NULL)
 373                 return -EINVAL;
 374
 375         ret = rte_cryptodev_close(cryptodev->data->dev_id);
 376         if (ret < 0)
 377                 return ret;
 378
 379         cryptodev->attached = RTE_CRYPTODEV_DETACHED;
 380         cryptodev_globals.nb_devs--;
 381         return 0;
 382 }
 383
 384 struct rte_cryptodev *
 385 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
 386                 int socket_id)
 387 {
 388         struct rte_cryptodev *cryptodev;
 389
 390         /* allocate device structure */
 391         cryptodev = rte_cryptodev_pmd_allocate(name, socket_id);
 392         if (cryptodev == NULL)
 393                 return NULL;
 394
 395         /* allocate private device structure */
 396         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 397                 cryptodev->data->dev_private =
 398                                 rte_zmalloc_socket("cryptodev device private",
 399                                                 dev_private_size,
 400                                                 RTE_CACHE_LINE_SIZE,
 401                                                 socket_id);
 402
 403                 if (cryptodev->data->dev_private == NULL)
 404                         rte_panic("Cannot allocate memzone for private device"
 405                                         " data");
 406         }
 407
 408         /* initialise user call-back tail queue */
 409         TAILQ_INIT(&(cryptodev->link_intr_cbs));
 410
 411         return cryptodev;
 412 }
 413
 414 int
 415 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
 416                         struct rte_pci_device *pci_dev)
 417 {
 418         struct rte_cryptodev_driver *cryptodrv;
 419         struct rte_cryptodev *cryptodev;
 420
 421         char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
 422
 423         int retval;
 424
 425         cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
 426         if (cryptodrv == NULL)
 427                 return -ENODEV;
 428
 429         rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
 430                         sizeof(cryptodev_name));
 431
 432         cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
 433         if (cryptodev == NULL)
 434                 return -ENOMEM;
 435
 436         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 437                 cryptodev->data->dev_private =
 438                                 rte_zmalloc_socket(
 439                                                 "cryptodev private structure",
 440                                                 cryptodrv->dev_private_size,
 441                                                 RTE_CACHE_LINE_SIZE,
 442                                                 rte_socket_id());
 443
 444                 if (cryptodev->data->dev_private == NULL)
 445                         rte_panic("Cannot allocate memzone for private "
 446                                         "device data");
 447         }
 448
 449         cryptodev->pci_dev = pci_dev;
 450         cryptodev->driver = cryptodrv;
 451
 452         /* init user callbacks */
 453         TAILQ_INIT(&(cryptodev->link_intr_cbs));
 454
 455         /* Invoke PMD device initialization function */
 456         retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
 457         if (retval == 0)
 458                 return 0;
 459
 460         CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
 461                         " failed", pci_drv->driver.name,
 462                         (unsigned) pci_dev->id.vendor_id,
 463                         (unsigned) pci_dev->id.device_id);
 464
 465         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
 466                 rte_free(cryptodev->data->dev_private);
 467
 468         cryptodev->attached = RTE_CRYPTODEV_DETACHED;
 469         cryptodev_globals.nb_devs--;
 470
 471         return -ENXIO;
 472 }
 473
 474 int
 475 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
 476 {
 477         const struct rte_cryptodev_driver *cryptodrv;
 478         struct rte_cryptodev *cryptodev;
 479         char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
 480         int ret;
 481
 482         if (pci_dev == NULL)
 483                 return -EINVAL;
 484
 485         rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
 486                         sizeof(cryptodev_name));
 487
 488         cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
 489         if (cryptodev == NULL)
 490                 return -ENODEV;
 491
 492         cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
 493         if (cryptodrv == NULL)
 494                 return -ENODEV;
 495
 496         /* Invoke PMD device uninit function */
 497         if (*cryptodrv->cryptodev_uninit) {
 498                 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
 499                 if (ret)
 500                         return ret;
 501         }
 502
 503         /* free crypto device */
 504         rte_cryptodev_pmd_release_device(cryptodev);
 505
 506         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
 507                 rte_free(cryptodev->data->dev_private);
 508
 509         cryptodev->pci_dev = NULL;
 510         cryptodev->driver = NULL;
 511         cryptodev->data = NULL;
 512
 513         return 0;
 514 }
 515
 516 uint16_t
 517 rte_cryptodev_queue_pair_count(uint8_t dev_id)
 518 {
 519         struct rte_cryptodev *dev;
 520
 521         dev = &rte_crypto_devices[dev_id];
 522         return dev->data->nb_queue_pairs;
 523 }
 524
 525 static int
 526 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
 527                 int socket_id)
 528 {
 529         struct rte_cryptodev_info dev_info;
 530         void **qp;
 531         unsigned i;
 532
 533         if ((dev == NULL) || (nb_qpairs < 1)) {
 534                 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
 535                                                         dev, nb_qpairs);
 536                 return -EINVAL;
 537         }
 538
 539         CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
 540                         nb_qpairs, dev->data->dev_id);
 541
 542         memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
 543
 544         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
 545         (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
 546
 547         if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
 548                 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
 549                                 nb_qpairs, dev->data->dev_id);
 550             return -EINVAL;
 551         }
 552
 553         if (dev->data->queue_pairs == NULL) { /* first time configuration */
 554                 dev->data->queue_pairs = rte_zmalloc_socket(
 555                                 "cryptodev->queue_pairs",
 556                                 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
 557                                 RTE_CACHE_LINE_SIZE, socket_id);
 558
 559                 if (dev->data->queue_pairs == NULL) {
 560                         dev->data->nb_queue_pairs = 0;
 561                         CDEV_LOG_ERR("failed to get memory for qp meta data, "
 562                                                         "nb_queues %u",
 563                                                         nb_qpairs);
 564                         return -(ENOMEM);
 565                 }
 566         } else { /* re-configure */
 567                 int ret;
 568                 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
 569
 570                 qp = dev->data->queue_pairs;
 571
 572                 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
 573                                 -ENOTSUP);
 574
 575                 for (i = nb_qpairs; i < old_nb_queues; i++) {
 576                         ret = (*dev->dev_ops->queue_pair_release)(dev, i);
 577                         if (ret < 0)
 578                                 return ret;
 579                 }
 580
 581                 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
 582                                 RTE_CACHE_LINE_SIZE);
 583                 if (qp == NULL) {
 584                         CDEV_LOG_ERR("failed to realloc qp meta data,"
 585                                                 " nb_queues %u", nb_qpairs);
 586                         return -(ENOMEM);
 587                 }
 588
 589                 if (nb_qpairs > old_nb_queues) {
 590                         uint16_t new_qs = nb_qpairs - old_nb_queues;
 591
 592                         memset(qp + old_nb_queues, 0,
 593                                 sizeof(qp[0]) * new_qs);
 594                 }
 595
 596                 dev->data->queue_pairs = qp;
 597
 598         }
 599         dev->data->nb_queue_pairs = nb_qpairs;
 600         return 0;
 601 }
 602
 603 int
 604 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
 605 {
 606         struct rte_cryptodev *dev;
 607
 608         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 609                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 610                 return -EINVAL;
 611         }
 612
 613         dev = &rte_crypto_devices[dev_id];
 614         if (queue_pair_id >= dev->data->nb_queue_pairs) {
 615                 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
 616                 return -EINVAL;
 617         }
 618
 619         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
 620
 621         return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
 622
 623 }
 624
 625 int
 626 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
 627 {
 628         struct rte_cryptodev *dev;
 629
 630         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 631                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 632                 return -EINVAL;
 633         }
 634
 635         dev = &rte_crypto_devices[dev_id];
 636         if (queue_pair_id >= dev->data->nb_queue_pairs) {
 637                 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
 638                 return -EINVAL;
 639         }
 640
 641         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
 642
 643         return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
 644
 645 }
 646
 647 static int
 648 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
 649                 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
 650
 651 int
 652 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
 653 {
 654         struct rte_cryptodev *dev;
 655         int diag;
 656
 657         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 658                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 659                 return -EINVAL;
 660         }
 661
 662         dev = &rte_crypto_devices[dev_id];
 663
 664         if (dev->data->dev_started) {
 665                 CDEV_LOG_ERR(
 666                     "device %d must be stopped to allow configuration", dev_id);
 667                 return -EBUSY;
 668         }
 669
 670         /* Setup new number of queue pairs and reconfigure device. */
 671         diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
 672                         config->socket_id);
 673         if (diag != 0) {
 674                 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
 675                                 dev_id, diag);
 676                 return diag;
 677         }
 678
 679         /* Setup Session mempool for device */
 680         return rte_cryptodev_sym_session_pool_create(dev,
 681                         config->session_mp.nb_objs,
 682                         config->session_mp.cache_size,
 683                         config->socket_id);
 684 }
 685
 686
 687 int
 688 rte_cryptodev_start(uint8_t dev_id)
 689 {
 690         struct rte_cryptodev *dev;
 691         int diag;
 692
 693         CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
 694
 695         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 696                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 697                 return -EINVAL;
 698         }
 699
 700         dev = &rte_crypto_devices[dev_id];
 701
 702         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
 703
 704         if (dev->data->dev_started != 0) {
 705                 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
 706                         dev_id);
 707                 return 0;
 708         }
 709
 710         diag = (*dev->dev_ops->dev_start)(dev);
 711         if (diag == 0)
 712                 dev->data->dev_started = 1;
 713         else
 714                 return diag;
 715
 716         return 0;
 717 }
 718
 719 void
 720 rte_cryptodev_stop(uint8_t dev_id)
 721 {
 722         struct rte_cryptodev *dev;
 723
 724         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 725                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 726                 return;
 727         }
 728
 729         dev = &rte_crypto_devices[dev_id];
 730
 731         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
 732
 733         if (dev->data->dev_started == 0) {
 734                 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
 735                         dev_id);
 736                 return;
 737         }
 738
 739         dev->data->dev_started = 0;
 740         (*dev->dev_ops->dev_stop)(dev);
 741 }
 742
 743 int
 744 rte_cryptodev_close(uint8_t dev_id)
 745 {
 746         struct rte_cryptodev *dev;
 747         int retval;
 748
 749         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 750                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 751                 return -1;
 752         }
 753
 754         dev = &rte_crypto_devices[dev_id];
 755
 756         /* Device must be stopped before it can be closed */
 757         if (dev->data->dev_started == 1) {
 758                 CDEV_LOG_ERR("Device %u must be stopped before closing",
 759                                 dev_id);
 760                 return -EBUSY;
 761         }
 762
 763         /* We can't close the device if there are outstanding sessions in use */
 764         if (dev->data->session_pool != NULL) {
 765                 if (!rte_mempool_full(dev->data->session_pool)) {
 766                         CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
 767                                         "has sessions still in use, free "
 768                                         "all sessions before calling close",
 769                                         (unsigned)dev_id);
 770                         return -EBUSY;
 771                 }
 772         }
 773
 774         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
 775         retval = (*dev->dev_ops->dev_close)(dev);
 776
 777         if (retval < 0)
 778                 return retval;
 779
 780         return 0;
 781 }
 782
 783 int
 784 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
 785                 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
 786 {
 787         struct rte_cryptodev *dev;
 788
 789         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 790                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 791                 return -EINVAL;
 792         }
 793
 794         dev = &rte_crypto_devices[dev_id];
 795         if (queue_pair_id >= dev->data->nb_queue_pairs) {
 796                 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
 797                 return -EINVAL;
 798         }
 799
 800         if (dev->data->dev_started) {
 801                 CDEV_LOG_ERR(
 802                     "device %d must be stopped to allow configuration", dev_id);
 803                 return -EBUSY;
 804         }
 805
 806         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
 807
 808         return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
 809                         socket_id);
 810 }
 811
 812
 813 int
 814 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
 815 {
 816         struct rte_cryptodev *dev;
 817
 818         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 819                 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
 820                 return -ENODEV;
 821         }
 822
 823         if (stats == NULL) {
 824                 CDEV_LOG_ERR("Invalid stats ptr");
 825                 return -EINVAL;
 826         }
 827
 828         dev = &rte_crypto_devices[dev_id];
 829         memset(stats, 0, sizeof(*stats));
 830
 831         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
 832         (*dev->dev_ops->stats_get)(dev, stats);
 833         return 0;
 834 }
 835
 836 void
 837 rte_cryptodev_stats_reset(uint8_t dev_id)
 838 {
 839         struct rte_cryptodev *dev;
 840
 841         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 842                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 843                 return;
 844         }
 845
 846         dev = &rte_crypto_devices[dev_id];
 847
 848         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
 849         (*dev->dev_ops->stats_reset)(dev);
 850 }
 851
 852
 853 void
 854 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
 855 {
 856         struct rte_cryptodev *dev;
 857
 858         if (dev_id >= cryptodev_globals.nb_devs) {
 859                 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
 860                 return;
 861         }
 862
 863         dev = &rte_crypto_devices[dev_id];
 864
 865         memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
 866
 867         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
 868         (*dev->dev_ops->dev_infos_get)(dev, dev_info);
 869
 870         dev_info->pci_dev = dev->pci_dev;
 871         if (dev->driver)
 872                 dev_info->driver_name = dev->driver->pci_drv.driver.name;
 873 }
 874
 875
 876 int
 877 rte_cryptodev_callback_register(uint8_t dev_id,
 878                         enum rte_cryptodev_event_type event,
 879                         rte_cryptodev_cb_fn cb_fn, void *cb_arg)
 880 {
 881         struct rte_cryptodev *dev;
 882         struct rte_cryptodev_callback *user_cb;
 883
 884         if (!cb_fn)
 885                 return -EINVAL;
 886
 887         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 888                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 889                 return -EINVAL;
 890         }
 891
 892         dev = &rte_crypto_devices[dev_id];
 893         rte_spinlock_lock(&rte_cryptodev_cb_lock);
 894
 895         TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
 896                 if (user_cb->cb_fn == cb_fn &&
 897                         user_cb->cb_arg == cb_arg &&
 898                         user_cb->event == event) {
 899                         break;
 900                 }
 901         }
 902
 903         /* create a new callback. */
 904         if (user_cb == NULL) {
 905                 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
 906                                 sizeof(struct rte_cryptodev_callback), 0);
 907                 if (user_cb != NULL) {
 908                         user_cb->cb_fn = cb_fn;
 909                         user_cb->cb_arg = cb_arg;
 910                         user_cb->event = event;
 911                         TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
 912                 }
 913         }
 914
 915         rte_spinlock_unlock(&rte_cryptodev_cb_lock);
 916         return (user_cb == NULL) ? -ENOMEM : 0;
 917 }
 918
 919 int
 920 rte_cryptodev_callback_unregister(uint8_t dev_id,
 921                         enum rte_cryptodev_event_type event,
 922                         rte_cryptodev_cb_fn cb_fn, void *cb_arg)
 923 {
 924         int ret;
 925         struct rte_cryptodev *dev;
 926         struct rte_cryptodev_callback *cb, *next;
 927
 928         if (!cb_fn)
 929                 return -EINVAL;
 930
 931         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
 932                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
 933                 return -EINVAL;
 934         }
 935
 936         dev = &rte_crypto_devices[dev_id];
 937         rte_spinlock_lock(&rte_cryptodev_cb_lock);
 938
 939         ret = 0;
 940         for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
 941
 942                 next = TAILQ_NEXT(cb, next);
 943
 944                 if (cb->cb_fn != cb_fn || cb->event != event ||
 945                                 (cb->cb_arg != (void *)-1 &&
 946                                 cb->cb_arg != cb_arg))
 947                         continue;
 948
 949                 /*
 950                  * if this callback is not executing right now,
 951                  * then remove it.
 952                  */
 953                 if (cb->active == 0) {
 954                         TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
 955                         rte_free(cb);
 956                 } else {
 957                         ret = -EAGAIN;
 958                 }
 959         }
 960
 961         rte_spinlock_unlock(&rte_cryptodev_cb_lock);
 962         return ret;
 963 }
 964
 965 void
 966 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
 967         enum rte_cryptodev_event_type event)
 968 {
 969         struct rte_cryptodev_callback *cb_lst;
 970         struct rte_cryptodev_callback dev_cb;
 971
 972         rte_spinlock_lock(&rte_cryptodev_cb_lock);
 973         TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
 974                 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
 975                         continue;
 976                 dev_cb = *cb_lst;
 977                 cb_lst->active = 1;
 978                 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
 979                 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
 980                                                 dev_cb.cb_arg);
 981                 rte_spinlock_lock(&rte_cryptodev_cb_lock);
 982                 cb_lst->active = 0;
 983         }
 984         rte_spinlock_unlock(&rte_cryptodev_cb_lock);
 985 }
 986
 987
 988 static void
 989 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
 990                 void *opaque_arg,
 991                 void *_sess,
 992                 __rte_unused unsigned i)
 993 {
 994         struct rte_cryptodev_sym_session *sess = _sess;
 995         struct rte_cryptodev *dev = opaque_arg;
 996
 997         memset(sess, 0, mp->elt_size);
 998
 999         sess->dev_id = dev->data->dev_id;
1000         sess->dev_type = dev->dev_type;
1001         sess->mp = mp;
1002
1003         if (dev->dev_ops->session_initialize)
1004                 (*dev->dev_ops->session_initialize)(mp, sess);
1005 }
1006
1007 static int
1008 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1009                 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1010 {
1011         char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1012         unsigned priv_sess_size;
1013
1014         unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1015                         dev->data->dev_id);
1016         if (n > sizeof(mp_name)) {
1017                 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1018                 return -ENOMEM;
1019         }
1020
1021         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1022         priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1023         if (priv_sess_size == 0) {
1024                 CDEV_LOG_ERR("%s returned and invalid private session size ",
1025                                                 dev->data->name);
1026                 return -ENOMEM;
1027         }
1028
1029         unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1030                         priv_sess_size;
1031
1032         dev->data->session_pool = rte_mempool_lookup(mp_name);
1033         if (dev->data->session_pool != NULL) {
1034                 if ((dev->data->session_pool->elt_size != elt_size) ||
1035                                 (dev->data->session_pool->cache_size <
1036                                 obj_cache_size) ||
1037                                 (dev->data->session_pool->size < nb_objs)) {
1038
1039                         CDEV_LOG_ERR("%s mempool already exists with different"
1040                                         " initialization parameters", mp_name);
1041                         dev->data->session_pool = NULL;
1042                         return -ENOMEM;
1043                 }
1044         } else {
1045                 dev->data->session_pool = rte_mempool_create(
1046                                 mp_name, /* mempool name */
1047                                 nb_objs, /* number of elements*/
1048                                 elt_size, /* element size*/
1049                                 obj_cache_size, /* Cache size*/
1050                                 0, /* private data size */
1051                                 NULL, /* obj initialization constructor */
1052                                 NULL, /* obj initialization constructor arg */
1053                                 rte_cryptodev_sym_session_init,
1054                                 /**< obj constructor*/
1055                                 dev, /* obj constructor arg */
1056                                 socket_id, /* socket id */
1057                                 0); /* flags */
1058
1059                 if (dev->data->session_pool == NULL) {
1060                         CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1061                         return -ENOMEM;
1062                 }
1063         }
1064
1065         CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1066         return 0;
1067 }
1068
1069 struct rte_cryptodev_sym_session *
1070 rte_cryptodev_sym_session_create(uint8_t dev_id,
1071                 struct rte_crypto_sym_xform *xform)
1072 {
1073         struct rte_cryptodev *dev;
1074         struct rte_cryptodev_sym_session *sess;
1075         void *_sess;
1076
1077         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1078                 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1079                 return NULL;
1080         }
1081
1082         dev = &rte_crypto_devices[dev_id];
1083
1084         /* Allocate a session structure from the session pool */
1085         if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1086                 CDEV_LOG_ERR("Couldn't get object from session mempool");
1087                 return NULL;
1088         }
1089
1090         sess = (struct rte_cryptodev_sym_session *)_sess;
1091
1092         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1093         if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1094                         NULL) {
1095                 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1096                                 dev_id);
1097
1098                 /* Return session to mempool */
1099                 rte_mempool_put(sess->mp, _sess);
1100                 return NULL;
1101         }
1102
1103         return sess;
1104 }
1105
1106 struct rte_cryptodev_sym_session *
1107 rte_cryptodev_sym_session_free(uint8_t dev_id,
1108                 struct rte_cryptodev_sym_session *sess)
1109 {
1110         struct rte_cryptodev *dev;
1111
1112         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1113                 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1114                 return sess;
1115         }
1116
1117         dev = &rte_crypto_devices[dev_id];
1118
1119         /* Check the session belongs to this device type */
1120         if (sess->dev_type != dev->dev_type)
1121                 return sess;
1122
1123         /* Let device implementation clear session material */
1124         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1125         dev->dev_ops->session_clear(dev, (void *)sess->_private);
1126
1127         /* Return session to mempool */
1128         rte_mempool_put(sess->mp, (void *)sess);
1129
1130         return NULL;
1131 }
1132
1133 /** Initialise rte_crypto_op mempool element */
1134 static void
1135 rte_crypto_op_init(struct rte_mempool *mempool,
1136                 void *opaque_arg,
1137                 void *_op_data,
1138                 __rte_unused unsigned i)
1139 {
1140         struct rte_crypto_op *op = _op_data;
1141         enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1142
1143         memset(_op_data, 0, mempool->elt_size);
1144
1145         __rte_crypto_op_reset(op, type);
1146
1147         op->phys_addr = rte_mem_virt2phy(_op_data);
1148         op->mempool = mempool;
1149 }
1150
1151
1152 struct rte_mempool *
1153 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1154                 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1155                 int socket_id)
1156 {
1157         struct rte_crypto_op_pool_private *priv;
1158
1159         unsigned elt_size = sizeof(struct rte_crypto_op) +
1160                         sizeof(struct rte_crypto_sym_op) +
1161                         priv_size;
1162
1163         /* lookup mempool in case already allocated */
1164         struct rte_mempool *mp = rte_mempool_lookup(name);
1165
1166         if (mp != NULL) {
1167                 priv = (struct rte_crypto_op_pool_private *)
1168                                 rte_mempool_get_priv(mp);
1169
1170                 if (mp->elt_size != elt_size ||
1171                                 mp->cache_size < cache_size ||
1172                                 mp->size < nb_elts ||
1173                                 priv->priv_size <  priv_size) {
1174                         mp = NULL;
1175                         CDEV_LOG_ERR("Mempool %s already exists but with "
1176                                         "incompatible parameters", name);
1177                         return NULL;
1178                 }
1179                 return mp;
1180         }
1181
1182         mp = rte_mempool_create(
1183                         name,
1184                         nb_elts,
1185                         elt_size,
1186                         cache_size,
1187                         sizeof(struct rte_crypto_op_pool_private),
1188                         NULL,
1189                         NULL,
1190                         rte_crypto_op_init,
1191                         &type,
1192                         socket_id,
1193                         0);
1194
1195         if (mp == NULL) {
1196                 CDEV_LOG_ERR("Failed to create mempool %s", name);
1197                 return NULL;
1198         }
1199
1200         priv = (struct rte_crypto_op_pool_private *)
1201                         rte_mempool_get_priv(mp);
1202
1203         priv->priv_size = priv_size;
1204         priv->type = type;
1205
1206         return mp;
1207 }