drivers/crypto/aesni_mb/rte_aesni_mb_pmd_ops.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2015-2017 Intel Corporation
   3  */
   4
   5 #include <string.h>
   6
   7 #include <rte_common.h>
   8 #include <rte_malloc.h>
   9 #include <rte_cryptodev_pmd.h>
  10
  11 #include "rte_aesni_mb_pmd_private.h"
  12
  13
  14 static const struct rte_cryptodev_capabilities aesni_mb_pmd_capabilities[] = {
  15         {       /* MD5 HMAC */
  16                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
  17                 {.sym = {
  18                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
  19                         {.auth = {
  20                                 .algo = RTE_CRYPTO_AUTH_MD5_HMAC,
  21                                 .block_size = 64,
  22                                 .key_size = {
  23                                         .min = 1,
  24                                         .max = 64,
  25                                         .increment = 1
  26                                 },
  27                                 .digest_size = {
  28                                         .min = 12,
  29                                         .max = 12,
  30                                         .increment = 0
  31                                 },
  32                                 .iv_size = { 0 }
  33                         }, }
  34                 }, }
  35         },
  36         {       /* SHA1 HMAC */
  37                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
  38                 {.sym = {
  39                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
  40                         {.auth = {
  41                                 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
  42                                 .block_size = 64,
  43                                 .key_size = {
  44                                         .min = 1,
  45                                         .max = 64,
  46                                         .increment = 1
  47                                 },
  48                                 .digest_size = {
  49                                         .min = 12,
  50                                         .max = 12,
  51                                         .increment = 0
  52                                 },
  53                                 .iv_size = { 0 }
  54                         }, }
  55                 }, }
  56         },
  57         {       /* SHA224 HMAC */
  58                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
  59                 {.sym = {
  60                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
  61                         {.auth = {
  62                                 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC,
  63                                 .block_size = 64,
  64                                 .key_size = {
  65                                         .min = 1,
  66                                         .max = 64,
  67                                         .increment = 1
  68                                 },
  69                                 .digest_size = {
  70                                         .min = 14,
  71                                         .max = 14,
  72                                         .increment = 0
  73                                 },
  74                                 .iv_size = { 0 }
  75                         }, }
  76                 }, }
  77         },
  78         {       /* SHA256 HMAC */
  79                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
  80                 {.sym = {
  81                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
  82                         {.auth = {
  83                                 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
  84                                 .block_size = 64,
  85                                 .key_size = {
  86                                         .min = 1,
  87                                         .max = 64,
  88                                         .increment = 1
  89                                 },
  90                                 .digest_size = {
  91                                         .min = 16,
  92                                         .max = 16,
  93                                         .increment = 0
  94                                 },
  95                                 .iv_size = { 0 }
  96                         }, }
  97                 }, }
  98         },
  99         {       /* SHA384 HMAC */
 100                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 101                 {.sym = {
 102                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 103                         {.auth = {
 104                                 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC,
 105                                 .block_size = 128,
 106                                 .key_size = {
 107                                         .min = 1,
 108                                         .max = 128,
 109                                         .increment = 1
 110                                 },
 111                                 .digest_size = {
 112                                         .min = 24,
 113                                         .max = 24,
 114                                         .increment = 0
 115                                 },
 116                                 .iv_size = { 0 }
 117                         }, }
 118                 }, }
 119         },
 120         {       /* SHA512 HMAC */
 121                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 122                 {.sym = {
 123                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 124                         {.auth = {
 125                                 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC,
 126                                 .block_size = 128,
 127                                 .key_size = {
 128                                         .min = 1,
 129                                         .max = 128,
 130                                         .increment = 1
 131                                 },
 132                                 .digest_size = {
 133                                         .min = 32,
 134                                         .max = 32,
 135                                         .increment = 0
 136                                 },
 137                                 .iv_size = { 0 }
 138                         }, }
 139                 }, }
 140         },
 141         {       /* AES XCBC HMAC */
 142                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 143                 {.sym = {
 144                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 145                         {.auth = {
 146                                 .algo = RTE_CRYPTO_AUTH_AES_XCBC_MAC,
 147                                 .block_size = 16,
 148                                 .key_size = {
 149                                         .min = 16,
 150                                         .max = 16,
 151                                         .increment = 0
 152                                 },
 153                                 .digest_size = {
 154                                         .min = 12,
 155                                         .max = 12,
 156                                         .increment = 0
 157                                 },
 158                                 .iv_size = { 0 }
 159                         }, }
 160                 }, }
 161         },
 162         {       /* AES CBC */
 163                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 164                 {.sym = {
 165                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 166                         {.cipher = {
 167                                 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
 168                                 .block_size = 16,
 169                                 .key_size = {
 170                                         .min = 16,
 171                                         .max = 32,
 172                                         .increment = 8
 173                                 },
 174                                 .iv_size = {
 175                                         .min = 16,
 176                                         .max = 16,
 177                                         .increment = 0
 178                                 }
 179                         }, }
 180                 }, }
 181         },
 182         {       /* AES CTR */
 183                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 184                 {.sym = {
 185                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 186                         {.cipher = {
 187                                 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
 188                                 .block_size = 16,
 189                                 .key_size = {
 190                                         .min = 16,
 191                                         .max = 32,
 192                                         .increment = 8
 193                                 },
 194                                 .iv_size = {
 195                                         .min = 12,
 196                                         .max = 16,
 197                                         .increment = 4
 198                                 }
 199                         }, }
 200                 }, }
 201         },
 202         {       /* AES DOCSIS BPI */
 203                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 204                 {.sym = {
 205                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 206                         {.cipher = {
 207                                 .algo = RTE_CRYPTO_CIPHER_AES_DOCSISBPI,
 208                                 .block_size = 16,
 209                                 .key_size = {
 210                                         .min = 16,
 211                                         .max = 16,
 212                                         .increment = 0
 213                                 },
 214                                 .iv_size = {
 215                                         .min = 16,
 216                                         .max = 16,
 217                                         .increment = 0
 218                                 }
 219                         }, }
 220                 }, }
 221         },
 222         {       /* DES CBC */
 223                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 224                 {.sym = {
 225                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 226                         {.cipher = {
 227                                 .algo = RTE_CRYPTO_CIPHER_DES_CBC,
 228                                 .block_size = 8,
 229                                 .key_size = {
 230                                         .min = 8,
 231                                         .max = 8,
 232                                         .increment = 0
 233                                 },
 234                                 .iv_size = {
 235                                         .min = 8,
 236                                         .max = 8,
 237                                         .increment = 0
 238                                 }
 239                         }, }
 240                 }, }
 241         },
 242         {       /*  3DES CBC */
 243                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 244                 {.sym = {
 245                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 246                         {.cipher = {
 247                                 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
 248                                 .block_size = 8,
 249                                 .key_size = {
 250                                         .min = 8,
 251                                         .max = 24,
 252                                         .increment = 8
 253                                 },
 254                                 .iv_size = {
 255                                         .min = 8,
 256                                         .max = 8,
 257                                         .increment = 0
 258                                 }
 259                         }, }
 260                 }, }
 261         },
 262         {       /* DES DOCSIS BPI */
 263                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 264                 {.sym = {
 265                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 266                         {.cipher = {
 267                                 .algo = RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
 268                                 .block_size = 8,
 269                                 .key_size = {
 270                                         .min = 8,
 271                                         .max = 8,
 272                                         .increment = 0
 273                                 },
 274                                 .iv_size = {
 275                                         .min = 8,
 276                                         .max = 8,
 277                                         .increment = 0
 278                                 }
 279                         }, }
 280                 }, }
 281         },
 282         {       /* AES CCM */
 283                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 284                 {.sym = {
 285                         .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
 286                         {.aead = {
 287                                 .algo = RTE_CRYPTO_AEAD_AES_CCM,
 288                                 .block_size = 16,
 289                                 .key_size = {
 290                                         .min = 16,
 291                                         .max = 16,
 292                                         .increment = 0
 293                                 },
 294                                 .digest_size = {
 295                                         .min = 4,
 296                                         .max = 16,
 297                                         .increment = 2
 298                                 },
 299                                 .aad_size = {
 300                                         .min = 0,
 301                                         .max = 46,
 302                                         .increment = 1
 303                                 },
 304                                 .iv_size = {
 305                                         .min = 7,
 306                                         .max = 13,
 307                                         .increment = 1
 308                                 },
 309                         }, }
 310                 }, }
 311         },
 312         {       /* AES CMAC */
 313                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 314                 {.sym = {
 315                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 316                         {.auth = {
 317                                 .algo = RTE_CRYPTO_AUTH_AES_CMAC,
 318                                 .block_size = 16,
 319                                 .key_size = {
 320                                         .min = 16,
 321                                         .max = 16,
 322                                         .increment = 0
 323                                 },
 324                                 .digest_size = {
 325                                         .min = 12,
 326                                         .max = 16,
 327                                         .increment = 4
 328                                 },
 329                                 .iv_size = { 0 }
 330                         }, }
 331                 }, }
 332         },
 333         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
 334 };
 335
 336
 337 /** Configure device */
 338 static int
 339 aesni_mb_pmd_config(__rte_unused struct rte_cryptodev *dev,
 340                 __rte_unused struct rte_cryptodev_config *config)
 341 {
 342         return 0;
 343 }
 344
 345 /** Start device */
 346 static int
 347 aesni_mb_pmd_start(__rte_unused struct rte_cryptodev *dev)
 348 {
 349         return 0;
 350 }
 351
 352 /** Stop device */
 353 static void
 354 aesni_mb_pmd_stop(__rte_unused struct rte_cryptodev *dev)
 355 {
 356 }
 357
 358 /** Close device */
 359 static int
 360 aesni_mb_pmd_close(__rte_unused struct rte_cryptodev *dev)
 361 {
 362         return 0;
 363 }
 364
 365
 366 /** Get device statistics */
 367 static void
 368 aesni_mb_pmd_stats_get(struct rte_cryptodev *dev,
 369                 struct rte_cryptodev_stats *stats)
 370 {
 371         int qp_id;
 372
 373         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
 374                 struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 375
 376                 stats->enqueued_count += qp->stats.enqueued_count;
 377                 stats->dequeued_count += qp->stats.dequeued_count;
 378
 379                 stats->enqueue_err_count += qp->stats.enqueue_err_count;
 380                 stats->dequeue_err_count += qp->stats.dequeue_err_count;
 381         }
 382 }
 383
 384 /** Reset device statistics */
 385 static void
 386 aesni_mb_pmd_stats_reset(struct rte_cryptodev *dev)
 387 {
 388         int qp_id;
 389
 390         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
 391                 struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 392
 393                 memset(&qp->stats, 0, sizeof(qp->stats));
 394         }
 395 }
 396
 397
 398 /** Get device info */
 399 static void
 400 aesni_mb_pmd_info_get(struct rte_cryptodev *dev,
 401                 struct rte_cryptodev_info *dev_info)
 402 {
 403         struct aesni_mb_private *internals = dev->data->dev_private;
 404
 405         if (dev_info != NULL) {
 406                 dev_info->driver_id = dev->driver_id;
 407                 dev_info->feature_flags = dev->feature_flags;
 408                 dev_info->capabilities = aesni_mb_pmd_capabilities;
 409                 dev_info->max_nb_queue_pairs = internals->max_nb_queue_pairs;
 410                 /* No limit of number of sessions */
 411                 dev_info->sym.max_nb_sessions = 0;
 412         }
 413 }
 414
 415 /** Release queue pair */
 416 static int
 417 aesni_mb_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
 418 {
 419         struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 420         struct rte_ring *r = NULL;
 421
 422         if (qp != NULL) {
 423                 r = rte_ring_lookup(qp->name);
 424                 if (r)
 425                         rte_ring_free(r);
 426                 if (qp->mb_mgr)
 427                         free_mb_mgr(qp->mb_mgr);
 428                 rte_free(qp);
 429                 dev->data->queue_pairs[qp_id] = NULL;
 430         }
 431         return 0;
 432 }
 433
 434 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
 435 static int
 436 aesni_mb_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
 437                 struct aesni_mb_qp *qp)
 438 {
 439         unsigned n = snprintf(qp->name, sizeof(qp->name),
 440                         "aesni_mb_pmd_%u_qp_%u",
 441                         dev->data->dev_id, qp->id);
 442
 443         if (n >= sizeof(qp->name))
 444                 return -1;
 445
 446         return 0;
 447 }
 448
 449 /** Create a ring to place processed operations on */
 450 static struct rte_ring *
 451 aesni_mb_pmd_qp_create_processed_ops_ring(struct aesni_mb_qp *qp,
 452                 const char *str, unsigned int ring_size, int socket_id)
 453 {
 454         struct rte_ring *r;
 455         char ring_name[RTE_CRYPTODEV_NAME_MAX_LEN];
 456
 457         unsigned int n = snprintf(ring_name, sizeof(ring_name),
 458                                 "%s_%s",
 459                                 qp->name, str);
 460
 461         if (n >= sizeof(ring_name))
 462                 return NULL;
 463
 464         r = rte_ring_lookup(ring_name);
 465         if (r) {
 466                 if (rte_ring_get_size(r) >= ring_size) {
 467                         AESNI_MB_LOG(INFO, "Reusing existing ring %s for processed ops",
 468                         ring_name);
 469                         return r;
 470                 }
 471
 472                 AESNI_MB_LOG(ERR, "Unable to reuse existing ring %s for processed ops",
 473                         ring_name);
 474                 return NULL;
 475         }
 476
 477         return rte_ring_create(ring_name, ring_size, socket_id,
 478                         RING_F_SP_ENQ | RING_F_SC_DEQ);
 479 }
 480
 481 /** Setup a queue pair */
 482 static int
 483 aesni_mb_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
 484                 const struct rte_cryptodev_qp_conf *qp_conf,
 485                 int socket_id, struct rte_mempool *session_pool)
 486 {
 487         struct aesni_mb_qp *qp = NULL;
 488         struct aesni_mb_private *internals = dev->data->dev_private;
 489         int ret = -1;
 490
 491         /* Free memory prior to re-allocation if needed. */
 492         if (dev->data->queue_pairs[qp_id] != NULL)
 493                 aesni_mb_pmd_qp_release(dev, qp_id);
 494
 495         /* Allocate the queue pair data structure. */
 496         qp = rte_zmalloc_socket("AES-NI PMD Queue Pair", sizeof(*qp),
 497                                         RTE_CACHE_LINE_SIZE, socket_id);
 498         if (qp == NULL)
 499                 return -ENOMEM;
 500
 501         qp->id = qp_id;
 502         dev->data->queue_pairs[qp_id] = qp;
 503
 504         if (aesni_mb_pmd_qp_set_unique_name(dev, qp))
 505                 goto qp_setup_cleanup;
 506
 507
 508         qp->mb_mgr = alloc_mb_mgr(0);
 509         if (qp->mb_mgr == NULL) {
 510                 ret = -ENOMEM;
 511                 goto qp_setup_cleanup;
 512         }
 513
 514         qp->op_fns = &job_ops[internals->vector_mode];
 515
 516         qp->ingress_queue = aesni_mb_pmd_qp_create_processed_ops_ring(qp,
 517                         "ingress", qp_conf->nb_descriptors, socket_id);
 518         if (qp->ingress_queue == NULL) {
 519                 ret = -1;
 520                 goto qp_setup_cleanup;
 521         }
 522
 523         qp->sess_mp = session_pool;
 524
 525         memset(&qp->stats, 0, sizeof(qp->stats));
 526
 527         char mp_name[RTE_MEMPOOL_NAMESIZE];
 528
 529         snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
 530                                 "digest_mp_%u_%u", dev->data->dev_id, qp_id);
 531
 532         /* Initialise multi-buffer manager */
 533         (*qp->op_fns->job.init_mgr)(qp->mb_mgr);
 534         return 0;
 535
 536 qp_setup_cleanup:
 537         if (qp) {
 538                 if (qp->mb_mgr == NULL)
 539                         free_mb_mgr(qp->mb_mgr);
 540                 rte_free(qp);
 541         }
 542
 543         return ret;
 544 }
 545
 546 /** Return the number of allocated queue pairs */
 547 static uint32_t
 548 aesni_mb_pmd_qp_count(struct rte_cryptodev *dev)
 549 {
 550         return dev->data->nb_queue_pairs;
 551 }
 552
 553 /** Returns the size of the aesni multi-buffer session structure */
 554 static unsigned
 555 aesni_mb_pmd_sym_session_get_size(struct rte_cryptodev *dev __rte_unused)
 556 {
 557         return sizeof(struct aesni_mb_session);
 558 }
 559
 560 /** Configure a aesni multi-buffer session from a crypto xform chain */
 561 static int
 562 aesni_mb_pmd_sym_session_configure(struct rte_cryptodev *dev,
 563                 struct rte_crypto_sym_xform *xform,
 564                 struct rte_cryptodev_sym_session *sess,
 565                 struct rte_mempool *mempool)
 566 {
 567         void *sess_private_data;
 568         struct aesni_mb_private *internals = dev->data->dev_private;
 569         int ret;
 570
 571         if (unlikely(sess == NULL)) {
 572                 AESNI_MB_LOG(ERR, "invalid session struct");
 573                 return -EINVAL;
 574         }
 575
 576         if (rte_mempool_get(mempool, &sess_private_data)) {
 577                 AESNI_MB_LOG(ERR,
 578                                 "Couldn't get object from session mempool");
 579                 return -ENOMEM;
 580         }
 581
 582         ret = aesni_mb_set_session_parameters(&job_ops[internals->vector_mode],
 583                         sess_private_data, xform);
 584         if (ret != 0) {
 585                 AESNI_MB_LOG(ERR, "failed configure session parameters");
 586
 587                 /* Return session to mempool */
 588                 rte_mempool_put(mempool, sess_private_data);
 589                 return ret;
 590         }
 591
 592         set_sym_session_private_data(sess, dev->driver_id,
 593                         sess_private_data);
 594
 595         return 0;
 596 }
 597
 598 /** Clear the memory of session so it doesn't leave key material behind */
 599 static void
 600 aesni_mb_pmd_sym_session_clear(struct rte_cryptodev *dev,
 601                 struct rte_cryptodev_sym_session *sess)
 602 {
 603         uint8_t index = dev->driver_id;
 604         void *sess_priv = get_sym_session_private_data(sess, index);
 605
 606         /* Zero out the whole structure */
 607         if (sess_priv) {
 608                 memset(sess_priv, 0, sizeof(struct aesni_mb_session));
 609                 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
 610                 set_sym_session_private_data(sess, index, NULL);
 611                 rte_mempool_put(sess_mp, sess_priv);
 612         }
 613 }
 614
 615 struct rte_cryptodev_ops aesni_mb_pmd_ops = {
 616                 .dev_configure          = aesni_mb_pmd_config,
 617                 .dev_start              = aesni_mb_pmd_start,
 618                 .dev_stop               = aesni_mb_pmd_stop,
 619                 .dev_close              = aesni_mb_pmd_close,
 620
 621                 .stats_get              = aesni_mb_pmd_stats_get,
 622                 .stats_reset            = aesni_mb_pmd_stats_reset,
 623
 624                 .dev_infos_get          = aesni_mb_pmd_info_get,
 625
 626                 .queue_pair_setup       = aesni_mb_pmd_qp_setup,
 627                 .queue_pair_release     = aesni_mb_pmd_qp_release,
 628                 .queue_pair_count       = aesni_mb_pmd_qp_count,
 629
 630                 .sym_session_get_size   = aesni_mb_pmd_sym_session_get_size,
 631                 .sym_session_configure  = aesni_mb_pmd_sym_session_configure,
 632                 .sym_session_clear      = aesni_mb_pmd_sym_session_clear
 633 };
 634
 635 struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops = &aesni_mb_pmd_ops;