drivers/crypto/aesni_mb/rte_aesni_mb_pmd_ops.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 <string.h>
  34
  35 #include <rte_common.h>
  36 #include <rte_malloc.h>
  37 #include <rte_cryptodev_pmd.h>
  38
  39 #include "rte_aesni_mb_pmd_private.h"
  40
  41
  42 static const struct rte_cryptodev_capabilities aesni_mb_pmd_capabilities[] = {
  43         {       /* MD5 HMAC */
  44                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
  45                 {.sym = {
  46                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
  47                         {.auth = {
  48                                 .algo = RTE_CRYPTO_AUTH_MD5_HMAC,
  49                                 .block_size = 64,
  50                                 .key_size = {
  51                                         .min = 64,
  52                                         .max = 64,
  53                                         .increment = 0
  54                                 },
  55                                 .digest_size = {
  56                                         .min = 12,
  57                                         .max = 12,
  58                                         .increment = 0
  59                                 },
  60                                 .aad_size = { 0 }
  61                         }, }
  62                 }, }
  63         },
  64         {       /* SHA1 HMAC */
  65                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
  66                 {.sym = {
  67                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
  68                         {.auth = {
  69                                 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
  70                                 .block_size = 64,
  71                                 .key_size = {
  72                                         .min = 64,
  73                                         .max = 64,
  74                                         .increment = 0
  75                                 },
  76                                 .digest_size = {
  77                                         .min = 12,
  78                                         .max = 12,
  79                                         .increment = 0
  80                                 },
  81                                 .aad_size = { 0 }
  82                         }, }
  83                 }, }
  84         },
  85         {       /* SHA224 HMAC */
  86                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
  87                 {.sym = {
  88                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
  89                         {.auth = {
  90                                 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC,
  91                                 .block_size = 64,
  92                                 .key_size = {
  93                                         .min = 64,
  94                                         .max = 64,
  95                                         .increment = 0
  96                                 },
  97                                 .digest_size = {
  98                                         .min = 14,
  99                                         .max = 14,
 100                                         .increment = 0
 101                                 },
 102                                 .aad_size = { 0 }
 103                         }, }
 104                 }, }
 105         },
 106         {       /* SHA256 HMAC */
 107                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 108                 {.sym = {
 109                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 110                         {.auth = {
 111                                 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
 112                                 .block_size = 64,
 113                                 .key_size = {
 114                                         .min = 64,
 115                                         .max = 64,
 116                                         .increment = 0
 117                                 },
 118                                 .digest_size = {
 119                                         .min = 16,
 120                                         .max = 16,
 121                                         .increment = 0
 122                                 },
 123                                 .aad_size = { 0 }
 124                         }, }
 125                 }, }
 126         },
 127         {       /* SHA384 HMAC */
 128                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 129                 {.sym = {
 130                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 131                         {.auth = {
 132                                 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC,
 133                                 .block_size = 128,
 134                                 .key_size = {
 135                                         .min = 128,
 136                                         .max = 128,
 137                                         .increment = 0
 138                                 },
 139                                 .digest_size = {
 140                                         .min = 24,
 141                                         .max = 24,
 142                                         .increment = 0
 143                                 },
 144                                 .aad_size = { 0 }
 145                         }, }
 146                 }, }
 147         },
 148         {       /* SHA512 HMAC */
 149                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 150                 {.sym = {
 151                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 152                         {.auth = {
 153                                 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC,
 154                                 .block_size = 128,
 155                                 .key_size = {
 156                                         .min = 128,
 157                                         .max = 128,
 158                                         .increment = 0
 159                                 },
 160                                 .digest_size = {
 161                                         .min = 32,
 162                                         .max = 32,
 163                                         .increment = 0
 164                                 },
 165                                 .aad_size = { 0 }
 166                         }, }
 167                 }, }
 168         },
 169         {       /* AES XCBC HMAC */
 170                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 171                 {.sym = {
 172                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 173                         {.auth = {
 174                                 .algo = RTE_CRYPTO_AUTH_AES_XCBC_MAC,
 175                                 .block_size = 16,
 176                                 .key_size = {
 177                                         .min = 16,
 178                                         .max = 16,
 179                                         .increment = 0
 180                                 },
 181                                 .digest_size = {
 182                                         .min = 12,
 183                                         .max = 12,
 184                                         .increment = 0
 185                                 },
 186                                 .aad_size = { 0 }
 187                         }, }
 188                 }, }
 189         },
 190         {       /* AES CBC */
 191                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 192                 {.sym = {
 193                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 194                         {.cipher = {
 195                                 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
 196                                 .block_size = 16,
 197                                 .key_size = {
 198                                         .min = 16,
 199                                         .max = 32,
 200                                         .increment = 8
 201                                 },
 202                                 .iv_size = {
 203                                         .min = 16,
 204                                         .max = 16,
 205                                         .increment = 0
 206                                 }
 207                         }, }
 208                 }, }
 209         },
 210         {       /* AES CTR */
 211                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 212                 {.sym = {
 213                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 214                         {.cipher = {
 215                                 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
 216                                 .block_size = 16,
 217                                 .key_size = {
 218                                         .min = 16,
 219                                         .max = 32,
 220                                         .increment = 8
 221                                 },
 222                                 .iv_size = {
 223                                         .min = 16,
 224                                         .max = 16,
 225                                         .increment = 0
 226                                 }
 227                         }, }
 228                 }, }
 229         },
 230         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
 231 };
 232
 233
 234 /** Configure device */
 235 static int
 236 aesni_mb_pmd_config(__rte_unused struct rte_cryptodev *dev,
 237                 __rte_unused struct rte_cryptodev_config *config)
 238 {
 239         return 0;
 240 }
 241
 242 /** Start device */
 243 static int
 244 aesni_mb_pmd_start(__rte_unused struct rte_cryptodev *dev)
 245 {
 246         return 0;
 247 }
 248
 249 /** Stop device */
 250 static void
 251 aesni_mb_pmd_stop(__rte_unused struct rte_cryptodev *dev)
 252 {
 253 }
 254
 255 /** Close device */
 256 static int
 257 aesni_mb_pmd_close(__rte_unused struct rte_cryptodev *dev)
 258 {
 259         return 0;
 260 }
 261
 262
 263 /** Get device statistics */
 264 static void
 265 aesni_mb_pmd_stats_get(struct rte_cryptodev *dev,
 266                 struct rte_cryptodev_stats *stats)
 267 {
 268         int qp_id;
 269
 270         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
 271                 struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 272
 273                 stats->enqueued_count += qp->stats.enqueued_count;
 274                 stats->dequeued_count += qp->stats.dequeued_count;
 275
 276                 stats->enqueue_err_count += qp->stats.enqueue_err_count;
 277                 stats->dequeue_err_count += qp->stats.dequeue_err_count;
 278         }
 279 }
 280
 281 /** Reset device statistics */
 282 static void
 283 aesni_mb_pmd_stats_reset(struct rte_cryptodev *dev)
 284 {
 285         int qp_id;
 286
 287         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
 288                 struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 289
 290                 memset(&qp->stats, 0, sizeof(qp->stats));
 291         }
 292 }
 293
 294
 295 /** Get device info */
 296 static void
 297 aesni_mb_pmd_info_get(struct rte_cryptodev *dev,
 298                 struct rte_cryptodev_info *dev_info)
 299 {
 300         struct aesni_mb_private *internals = dev->data->dev_private;
 301
 302         if (dev_info != NULL) {
 303                 dev_info->dev_type = dev->dev_type;
 304                 dev_info->feature_flags = dev->feature_flags;
 305                 dev_info->capabilities = aesni_mb_pmd_capabilities;
 306                 dev_info->max_nb_queue_pairs = internals->max_nb_queue_pairs;
 307                 dev_info->sym.max_nb_sessions = internals->max_nb_sessions;
 308         }
 309 }
 310
 311 /** Release queue pair */
 312 static int
 313 aesni_mb_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
 314 {
 315         struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
 316         struct rte_ring *r = NULL;
 317
 318         if (qp != NULL) {
 319                 r = rte_ring_lookup(qp->name);
 320                 if (r)
 321                         rte_ring_free(r);
 322                 rte_free(qp);
 323                 dev->data->queue_pairs[qp_id] = NULL;
 324         }
 325         return 0;
 326 }
 327
 328 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
 329 static int
 330 aesni_mb_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
 331                 struct aesni_mb_qp *qp)
 332 {
 333         unsigned n = snprintf(qp->name, sizeof(qp->name),
 334                         "aesni_mb_pmd_%u_qp_%u",
 335                         dev->data->dev_id, qp->id);
 336
 337         if (n > sizeof(qp->name))
 338                 return -1;
 339
 340         return 0;
 341 }
 342
 343 /** Create a ring to place processed operations on */
 344 static struct rte_ring *
 345 aesni_mb_pmd_qp_create_processed_ops_ring(struct aesni_mb_qp *qp,
 346                 unsigned ring_size, int socket_id)
 347 {
 348         struct rte_ring *r;
 349
 350         r = rte_ring_lookup(qp->name);
 351         if (r) {
 352                 if (rte_ring_get_size(r) >= ring_size) {
 353                         MB_LOG_INFO("Reusing existing ring %s for processed ops",
 354                                          qp->name);
 355                         return r;
 356                 }
 357
 358                 MB_LOG_ERR("Unable to reuse existing ring %s for processed ops",
 359                                  qp->name);
 360                 return NULL;
 361         }
 362
 363         return rte_ring_create(qp->name, ring_size, socket_id,
 364                         RING_F_SP_ENQ | RING_F_SC_DEQ);
 365 }
 366
 367 /** Setup a queue pair */
 368 static int
 369 aesni_mb_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
 370                 const struct rte_cryptodev_qp_conf *qp_conf,
 371                  int socket_id)
 372 {
 373         struct aesni_mb_qp *qp = NULL;
 374         struct aesni_mb_private *internals = dev->data->dev_private;
 375
 376         /* Free memory prior to re-allocation if needed. */
 377         if (dev->data->queue_pairs[qp_id] != NULL)
 378                 aesni_mb_pmd_qp_release(dev, qp_id);
 379
 380         /* Allocate the queue pair data structure. */
 381         qp = rte_zmalloc_socket("AES-NI PMD Queue Pair", sizeof(*qp),
 382                                         RTE_CACHE_LINE_SIZE, socket_id);
 383         if (qp == NULL)
 384                 return -ENOMEM;
 385
 386         qp->id = qp_id;
 387         dev->data->queue_pairs[qp_id] = qp;
 388
 389         if (aesni_mb_pmd_qp_set_unique_name(dev, qp))
 390                 goto qp_setup_cleanup;
 391
 392         qp->ops = &job_ops[internals->vector_mode];
 393
 394         qp->processed_ops = aesni_mb_pmd_qp_create_processed_ops_ring(qp,
 395                         qp_conf->nb_descriptors, socket_id);
 396         if (qp->processed_ops == NULL)
 397                 goto qp_setup_cleanup;
 398
 399         qp->sess_mp = dev->data->session_pool;
 400
 401         memset(&qp->stats, 0, sizeof(qp->stats));
 402
 403         /* Initialise multi-buffer manager */
 404         (*qp->ops->job.init_mgr)(&qp->mb_mgr);
 405
 406         return 0;
 407
 408 qp_setup_cleanup:
 409         if (qp)
 410                 rte_free(qp);
 411
 412         return -1;
 413 }
 414
 415 /** Start queue pair */
 416 static int
 417 aesni_mb_pmd_qp_start(__rte_unused struct rte_cryptodev *dev,
 418                 __rte_unused uint16_t queue_pair_id)
 419 {
 420         return -ENOTSUP;
 421 }
 422
 423 /** Stop queue pair */
 424 static int
 425 aesni_mb_pmd_qp_stop(__rte_unused struct rte_cryptodev *dev,
 426                 __rte_unused uint16_t queue_pair_id)
 427 {
 428         return -ENOTSUP;
 429 }
 430
 431 /** Return the number of allocated queue pairs */
 432 static uint32_t
 433 aesni_mb_pmd_qp_count(struct rte_cryptodev *dev)
 434 {
 435         return dev->data->nb_queue_pairs;
 436 }
 437
 438 /** Returns the size of the aesni multi-buffer session structure */
 439 static unsigned
 440 aesni_mb_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused)
 441 {
 442         return sizeof(struct aesni_mb_session);
 443 }
 444
 445 /** Configure a aesni multi-buffer session from a crypto xform chain */
 446 static void *
 447 aesni_mb_pmd_session_configure(struct rte_cryptodev *dev,
 448                 struct rte_crypto_sym_xform *xform,     void *sess)
 449 {
 450         struct aesni_mb_private *internals = dev->data->dev_private;
 451
 452         if (unlikely(sess == NULL)) {
 453                 MB_LOG_ERR("invalid session struct");
 454                 return NULL;
 455         }
 456
 457         if (aesni_mb_set_session_parameters(&job_ops[internals->vector_mode],
 458                         sess, xform) != 0) {
 459                 MB_LOG_ERR("failed configure session parameters");
 460                 return NULL;
 461         }
 462
 463         return sess;
 464 }
 465
 466 /** Clear the memory of session so it doesn't leave key material behind */
 467 static void
 468 aesni_mb_pmd_session_clear(struct rte_cryptodev *dev __rte_unused, void *sess)
 469 {
 470         /*
 471          * Current just resetting the whole data structure, need to investigate
 472          * whether a more selective reset of key would be more performant
 473          */
 474         if (sess)
 475                 memset(sess, 0, sizeof(struct aesni_mb_session));
 476 }
 477
 478 struct rte_cryptodev_ops aesni_mb_pmd_ops = {
 479                 .dev_configure          = aesni_mb_pmd_config,
 480                 .dev_start              = aesni_mb_pmd_start,
 481                 .dev_stop               = aesni_mb_pmd_stop,
 482                 .dev_close              = aesni_mb_pmd_close,
 483
 484                 .stats_get              = aesni_mb_pmd_stats_get,
 485                 .stats_reset            = aesni_mb_pmd_stats_reset,
 486
 487                 .dev_infos_get          = aesni_mb_pmd_info_get,
 488
 489                 .queue_pair_setup       = aesni_mb_pmd_qp_setup,
 490                 .queue_pair_release     = aesni_mb_pmd_qp_release,
 491                 .queue_pair_start       = aesni_mb_pmd_qp_start,
 492                 .queue_pair_stop        = aesni_mb_pmd_qp_stop,
 493                 .queue_pair_count       = aesni_mb_pmd_qp_count,
 494
 495                 .session_get_size       = aesni_mb_pmd_session_get_size,
 496                 .session_configure      = aesni_mb_pmd_session_configure,
 497                 .session_clear          = aesni_mb_pmd_session_clear
 498 };
 499
 500 struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops = &aesni_mb_pmd_ops;