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         {       /* DES DOCSIS BPI */
 243                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 244                 {.sym = {
 245                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 246                         {.cipher = {
 247                                 .algo = RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
 248                                 .block_size = 8,
 249                                 .key_size = {
 250                                         .min = 8,
 251                                         .max = 8,
 252                                         .increment = 0
 253                                 },
 254                                 .iv_size = {
 255                                         .min = 8,
 256                                         .max = 8,
 257                                         .increment = 0
 258                                 }
 259                         }, }
 260                 }, }
 261         },
 262         {       /* AES CCM */
 263                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 264                 {.sym = {
 265                         .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
 266                         {.aead = {
 267                                 .algo = RTE_CRYPTO_AEAD_AES_CCM,
 268                                 .block_size = 16,
 269                                 .key_size = {
 270                                         .min = 16,
 271                                         .max = 16,
 272                                         .increment = 0
 273                                 },
 274                                 .digest_size = {
 275                                         .min = 4,
 276                                         .max = 16,
 277                                         .increment = 2
 278                                 },
 279                                 .aad_size = {
 280                                         .min = 0,
 281                                         .max = 46,
 282                                         .increment = 1
 283                                 },
 284                                 .iv_size = {
 285                                         .min = 7,
 286                                         .max = 13,
 287                                         .increment = 1
 288                                 },
 289                         }, }
 290                 }, }
 291         },
 292         {       /* AES CMAC */
 293                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 294                 {.sym = {
 295                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 296                         {.auth = {
 297                                 .algo = RTE_CRYPTO_AUTH_AES_CMAC,
 298                                 .block_size = 16,
 299                                 .key_size = {
 300                                         .min = 16,
 301                                         .max = 16,
 302                                         .increment = 0
 303                                 },
 304                                 .digest_size = {
 305                                         .min = 12,
 306                                         .max = 16,
 307                                         .increment = 4
 308                                 },
 309                                 .iv_size = { 0 }
 310                         }, }
 311                 }, }
 312         },
 313         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
 314 };
 315
 316
 317 /** Configure device */
 318 static int
 319 aesni_mb_pmd_config(__rte_unused struct rte_cryptodev *dev,
 320                 __rte_unused struct rte_cryptodev_config *config)
 321 {
 322         return 0;
 323 }
 324
 325 /** Start device */
 326 static int
 327 aesni_mb_pmd_start(__rte_unused struct rte_cryptodev *dev)
 328 {
 329         return 0;
 330 }
 331
 332 /** Stop device */
 333 static void
 334 aesni_mb_pmd_stop(__rte_unused struct rte_cryptodev *dev)
 335 {
 336 }
 337
 338 /** Close device */
 339 static int
 340 aesni_mb_pmd_close(__rte_unused struct rte_cryptodev *dev)
 341 {
 342         return 0;
 343 }
 344
 345
 346 /** Get device statistics */
 347 static void
 348 aesni_mb_pmd_stats_get(struct rte_cryptodev *dev,
 349                 struct rte_cryptodev_stats *stats)
 350 {
 351         int qp_id;
 352
 353         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
 354                 struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 355
 356                 stats->enqueued_count += qp->stats.enqueued_count;
 357                 stats->dequeued_count += qp->stats.dequeued_count;
 358
 359                 stats->enqueue_err_count += qp->stats.enqueue_err_count;
 360                 stats->dequeue_err_count += qp->stats.dequeue_err_count;
 361         }
 362 }
 363
 364 /** Reset device statistics */
 365 static void
 366 aesni_mb_pmd_stats_reset(struct rte_cryptodev *dev)
 367 {
 368         int qp_id;
 369
 370         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
 371                 struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 372
 373                 memset(&qp->stats, 0, sizeof(qp->stats));
 374         }
 375 }
 376
 377
 378 /** Get device info */
 379 static void
 380 aesni_mb_pmd_info_get(struct rte_cryptodev *dev,
 381                 struct rte_cryptodev_info *dev_info)
 382 {
 383         struct aesni_mb_private *internals = dev->data->dev_private;
 384
 385         if (dev_info != NULL) {
 386                 dev_info->driver_id = dev->driver_id;
 387                 dev_info->feature_flags = dev->feature_flags;
 388                 dev_info->capabilities = aesni_mb_pmd_capabilities;
 389                 dev_info->max_nb_queue_pairs = internals->max_nb_queue_pairs;
 390                 /* No limit of number of sessions */
 391                 dev_info->sym.max_nb_sessions = 0;
 392         }
 393 }
 394
 395 /** Release queue pair */
 396 static int
 397 aesni_mb_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
 398 {
 399         struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 400         struct rte_ring *r = NULL;
 401
 402         if (qp != NULL) {
 403                 r = rte_ring_lookup(qp->name);
 404                 if (r)
 405                         rte_ring_free(r);
 406                 rte_free(qp);
 407                 dev->data->queue_pairs[qp_id] = NULL;
 408         }
 409         return 0;
 410 }
 411
 412 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
 413 static int
 414 aesni_mb_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
 415                 struct aesni_mb_qp *qp)
 416 {
 417         unsigned n = snprintf(qp->name, sizeof(qp->name),
 418                         "aesni_mb_pmd_%u_qp_%u",
 419                         dev->data->dev_id, qp->id);
 420
 421         if (n >= sizeof(qp->name))
 422                 return -1;
 423
 424         return 0;
 425 }
 426
 427 /** Create a ring to place processed operations on */
 428 static struct rte_ring *
 429 aesni_mb_pmd_qp_create_processed_ops_ring(struct aesni_mb_qp *qp,
 430                 const char *str, unsigned int ring_size, int socket_id)
 431 {
 432         struct rte_ring *r;
 433         char ring_name[RTE_CRYPTODEV_NAME_MAX_LEN];
 434
 435         unsigned int n = snprintf(ring_name, sizeof(ring_name),
 436                                 "%s_%s",
 437                                 qp->name, str);
 438
 439         if (n >= sizeof(ring_name))
 440                 return NULL;
 441
 442         r = rte_ring_lookup(ring_name);
 443         if (r) {
 444                 if (rte_ring_get_size(r) >= ring_size) {
 445                         AESNI_MB_LOG(INFO, "Reusing existing ring %s for processed ops",
 446                         ring_name);
 447                         return r;
 448                 }
 449
 450                 AESNI_MB_LOG(ERR, "Unable to reuse existing ring %s for processed ops",
 451                         ring_name);
 452                 return NULL;
 453         }
 454
 455         return rte_ring_create(ring_name, ring_size, socket_id,
 456                         RING_F_SP_ENQ | RING_F_SC_DEQ);
 457 }
 458
 459 /** Setup a queue pair */
 460 static int
 461 aesni_mb_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
 462                 const struct rte_cryptodev_qp_conf *qp_conf,
 463                 int socket_id, struct rte_mempool *session_pool)
 464 {
 465         struct aesni_mb_qp *qp = NULL;
 466         struct aesni_mb_private *internals = dev->data->dev_private;
 467
 468         /* Free memory prior to re-allocation if needed. */
 469         if (dev->data->queue_pairs[qp_id] != NULL)
 470                 aesni_mb_pmd_qp_release(dev, qp_id);
 471
 472         /* Allocate the queue pair data structure. */
 473         qp = rte_zmalloc_socket("AES-NI PMD Queue Pair", sizeof(*qp),
 474                                         RTE_CACHE_LINE_SIZE, socket_id);
 475         if (qp == NULL)
 476                 return -ENOMEM;
 477
 478         qp->id = qp_id;
 479         dev->data->queue_pairs[qp_id] = qp;
 480
 481         if (aesni_mb_pmd_qp_set_unique_name(dev, qp))
 482                 goto qp_setup_cleanup;
 483
 484
 485         qp->op_fns = &job_ops[internals->vector_mode];
 486
 487         qp->ingress_queue = aesni_mb_pmd_qp_create_processed_ops_ring(qp,
 488                         "ingress", qp_conf->nb_descriptors, socket_id);
 489         if (qp->ingress_queue == NULL)
 490                 goto qp_setup_cleanup;
 491
 492         qp->sess_mp = session_pool;
 493
 494         memset(&qp->stats, 0, sizeof(qp->stats));
 495
 496         char mp_name[RTE_MEMPOOL_NAMESIZE];
 497
 498         snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
 499                                 "digest_mp_%u_%u", dev->data->dev_id, qp_id);
 500
 501         /* Initialise multi-buffer manager */
 502         (*qp->op_fns->job.init_mgr)(&qp->mb_mgr);
 503         return 0;
 504
 505 qp_setup_cleanup:
 506         if (qp)
 507                 rte_free(qp);
 508
 509         return -1;
 510 }
 511
 512 /** Return the number of allocated queue pairs */
 513 static uint32_t
 514 aesni_mb_pmd_qp_count(struct rte_cryptodev *dev)
 515 {
 516         return dev->data->nb_queue_pairs;
 517 }
 518
 519 /** Returns the size of the aesni multi-buffer session structure */
 520 static unsigned
 521 aesni_mb_pmd_sym_session_get_size(struct rte_cryptodev *dev __rte_unused)
 522 {
 523         return sizeof(struct aesni_mb_session);
 524 }
 525
 526 /** Configure a aesni multi-buffer session from a crypto xform chain */
 527 static int
 528 aesni_mb_pmd_sym_session_configure(struct rte_cryptodev *dev,
 529                 struct rte_crypto_sym_xform *xform,
 530                 struct rte_cryptodev_sym_session *sess,
 531                 struct rte_mempool *mempool)
 532 {
 533         void *sess_private_data;
 534         struct aesni_mb_private *internals = dev->data->dev_private;
 535         int ret;
 536
 537         if (unlikely(sess == NULL)) {
 538                 AESNI_MB_LOG(ERR, "invalid session struct");
 539                 return -EINVAL;
 540         }
 541
 542         if (rte_mempool_get(mempool, &sess_private_data)) {
 543                 AESNI_MB_LOG(ERR,
 544                                 "Couldn't get object from session mempool");
 545                 return -ENOMEM;
 546         }
 547
 548         ret = aesni_mb_set_session_parameters(&job_ops[internals->vector_mode],
 549                         sess_private_data, xform);
 550         if (ret != 0) {
 551                 AESNI_MB_LOG(ERR, "failed configure session parameters");
 552
 553                 /* Return session to mempool */
 554                 rte_mempool_put(mempool, sess_private_data);
 555                 return ret;
 556         }
 557
 558         set_sym_session_private_data(sess, dev->driver_id,
 559                         sess_private_data);
 560
 561         return 0;
 562 }
 563
 564 /** Clear the memory of session so it doesn't leave key material behind */
 565 static void
 566 aesni_mb_pmd_sym_session_clear(struct rte_cryptodev *dev,
 567                 struct rte_cryptodev_sym_session *sess)
 568 {
 569         uint8_t index = dev->driver_id;
 570         void *sess_priv = get_sym_session_private_data(sess, index);
 571
 572         /* Zero out the whole structure */
 573         if (sess_priv) {
 574                 memset(sess_priv, 0, sizeof(struct aesni_mb_session));
 575                 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
 576                 set_sym_session_private_data(sess, index, NULL);
 577                 rte_mempool_put(sess_mp, sess_priv);
 578         }
 579 }
 580
 581 struct rte_cryptodev_ops aesni_mb_pmd_ops = {
 582                 .dev_configure          = aesni_mb_pmd_config,
 583                 .dev_start              = aesni_mb_pmd_start,
 584                 .dev_stop               = aesni_mb_pmd_stop,
 585                 .dev_close              = aesni_mb_pmd_close,
 586
 587                 .stats_get              = aesni_mb_pmd_stats_get,
 588                 .stats_reset            = aesni_mb_pmd_stats_reset,
 589
 590                 .dev_infos_get          = aesni_mb_pmd_info_get,
 591
 592                 .queue_pair_setup       = aesni_mb_pmd_qp_setup,
 593                 .queue_pair_release     = aesni_mb_pmd_qp_release,
 594                 .queue_pair_count       = aesni_mb_pmd_qp_count,
 595
 596                 .sym_session_get_size   = aesni_mb_pmd_sym_session_get_size,
 597                 .sym_session_configure  = aesni_mb_pmd_sym_session_configure,
 598                 .sym_session_clear      = aesni_mb_pmd_sym_session_clear
 599 };
 600
 601 struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops = &aesni_mb_pmd_ops;