drivers/crypto/aesni_gcm/aesni_gcm_pmd.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016-2017 Intel Corporation
   3  */
   4
   5 #include <rte_common.h>
   6 #include <rte_hexdump.h>
   7 #include <rte_cryptodev.h>
   8 #include <rte_cryptodev_pmd.h>
   9 #include <rte_bus_vdev.h>
  10 #include <rte_malloc.h>
  11 #include <rte_cpuflags.h>
  12 #include <rte_byteorder.h>
  13
  14 #include "aesni_gcm_pmd_private.h"
  15
  16 static uint8_t cryptodev_driver_id;
  17
  18 /** Parse crypto xform chain and set private session parameters */
  19 int
  20 aesni_gcm_set_session_parameters(const struct aesni_gcm_ops *gcm_ops,
  21                 struct aesni_gcm_session *sess,
  22                 const struct rte_crypto_sym_xform *xform)
  23 {
  24         const struct rte_crypto_sym_xform *auth_xform;
  25         const struct rte_crypto_sym_xform *aead_xform;
  26         uint16_t digest_length;
  27         uint8_t key_length;
  28         uint8_t *key;
  29
  30         /* AES-GMAC */
  31         if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
  32                 auth_xform = xform;
  33                 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_AES_GMAC) {
  34                         AESNI_GCM_LOG(ERR, "Only AES GMAC is supported as an "
  35                                 "authentication only algorithm");
  36                         return -ENOTSUP;
  37                 }
  38                 /* Set IV parameters */
  39                 sess->iv.offset = auth_xform->auth.iv.offset;
  40                 sess->iv.length = auth_xform->auth.iv.length;
  41
  42                 /* Select Crypto operation */
  43                 if (auth_xform->auth.op == RTE_CRYPTO_AUTH_OP_GENERATE)
  44                         sess->op = AESNI_GMAC_OP_GENERATE;
  45                 else
  46                         sess->op = AESNI_GMAC_OP_VERIFY;
  47
  48                 key_length = auth_xform->auth.key.length;
  49                 key = auth_xform->auth.key.data;
  50                 digest_length = auth_xform->auth.digest_length;
  51
  52         /* AES-GCM */
  53         } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
  54                 aead_xform = xform;
  55
  56                 if (aead_xform->aead.algo != RTE_CRYPTO_AEAD_AES_GCM) {
  57                         AESNI_GCM_LOG(ERR, "The only combined operation "
  58                                                 "supported is AES GCM");
  59                         return -ENOTSUP;
  60                 }
  61
  62                 /* Set IV parameters */
  63                 sess->iv.offset = aead_xform->aead.iv.offset;
  64                 sess->iv.length = aead_xform->aead.iv.length;
  65
  66                 /* Select Crypto operation */
  67                 if (aead_xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
  68                         sess->op = AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION;
  69                 else
  70                         sess->op = AESNI_GCM_OP_AUTHENTICATED_DECRYPTION;
  71
  72                 key_length = aead_xform->aead.key.length;
  73                 key = aead_xform->aead.key.data;
  74
  75                 sess->aad_length = aead_xform->aead.aad_length;
  76                 digest_length = aead_xform->aead.digest_length;
  77         } else {
  78                 AESNI_GCM_LOG(ERR, "Wrong xform type, has to be AEAD or authentication");
  79                 return -ENOTSUP;
  80         }
  81
  82
  83         /* IV check */
  84         if (sess->iv.length != 16 && sess->iv.length != 12 &&
  85                         sess->iv.length != 0) {
  86                 AESNI_GCM_LOG(ERR, "Wrong IV length");
  87                 return -EINVAL;
  88         }
  89
  90         /* Check key length and calculate GCM pre-compute. */
  91         switch (key_length) {
  92         case 16:
  93                 sess->key = AESNI_GCM_KEY_128;
  94                 break;
  95         case 24:
  96                 sess->key = AESNI_GCM_KEY_192;
  97                 break;
  98         case 32:
  99                 sess->key = AESNI_GCM_KEY_256;
 100                 break;
 101         default:
 102                 AESNI_GCM_LOG(ERR, "Invalid key length");
 103                 return -EINVAL;
 104         }
 105
 106         gcm_ops[sess->key].precomp(key, &sess->gdata_key);
 107
 108         /* Digest check */
 109         if (digest_length != 16 &&
 110                         digest_length != 12 &&
 111                         digest_length != 8) {
 112                 AESNI_GCM_LOG(ERR, "Invalid digest length");
 113                 return -EINVAL;
 114         }
 115         sess->digest_length = digest_length;
 116
 117         return 0;
 118 }
 119
 120 /** Get gcm session */
 121 static struct aesni_gcm_session *
 122 aesni_gcm_get_session(struct aesni_gcm_qp *qp, struct rte_crypto_op *op)
 123 {
 124         struct aesni_gcm_session *sess = NULL;
 125         struct rte_crypto_sym_op *sym_op = op->sym;
 126
 127         if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
 128                 if (likely(sym_op->session != NULL))
 129                         sess = (struct aesni_gcm_session *)
 130                                         get_sym_session_private_data(
 131                                         sym_op->session,
 132                                         cryptodev_driver_id);
 133         } else  {
 134                 void *_sess;
 135                 void *_sess_private_data = NULL;
 136
 137                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
 138                         return NULL;
 139
 140                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess_private_data))
 141                         return NULL;
 142
 143                 sess = (struct aesni_gcm_session *)_sess_private_data;
 144
 145                 if (unlikely(aesni_gcm_set_session_parameters(qp->ops,
 146                                 sess, sym_op->xform) != 0)) {
 147                         rte_mempool_put(qp->sess_mp, _sess);
 148                         rte_mempool_put(qp->sess_mp, _sess_private_data);
 149                         sess = NULL;
 150                 }
 151                 sym_op->session = (struct rte_cryptodev_sym_session *)_sess;
 152                 set_sym_session_private_data(sym_op->session,
 153                                 cryptodev_driver_id, _sess_private_data);
 154         }
 155
 156         if (unlikely(sess == NULL))
 157                 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
 158
 159         return sess;
 160 }
 161
 162 /**
 163  * Process a crypto operation, calling
 164  * the GCM API from the multi buffer library.
 165  *
 166  * @param       qp              queue pair
 167  * @param       op              symmetric crypto operation
 168  * @param       session         GCM session
 169  *
 170  * @return
 171  *
 172  */
 173 static int
 174 process_gcm_crypto_op(struct aesni_gcm_qp *qp, struct rte_crypto_op *op,
 175                 struct aesni_gcm_session *session)
 176 {
 177         uint8_t *src, *dst;
 178         uint8_t *iv_ptr;
 179         struct rte_crypto_sym_op *sym_op = op->sym;
 180         struct rte_mbuf *m_src = sym_op->m_src;
 181         uint32_t offset, data_offset, data_length;
 182         uint32_t part_len, total_len, data_len;
 183
 184         if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION ||
 185                         session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
 186                 offset = sym_op->aead.data.offset;
 187                 data_offset = offset;
 188                 data_length = sym_op->aead.data.length;
 189         } else {
 190                 offset = sym_op->auth.data.offset;
 191                 data_offset = offset;
 192                 data_length = sym_op->auth.data.length;
 193         }
 194
 195         RTE_ASSERT(m_src != NULL);
 196
 197         while (offset >= m_src->data_len && data_length != 0) {
 198                 offset -= m_src->data_len;
 199                 m_src = m_src->next;
 200
 201                 RTE_ASSERT(m_src != NULL);
 202         }
 203
 204         data_len = m_src->data_len - offset;
 205         part_len = (data_len < data_length) ? data_len :
 206                         data_length;
 207
 208         /* Destination buffer is required when segmented source buffer */
 209         RTE_ASSERT((part_len == data_length) ||
 210                         ((part_len != data_length) &&
 211                                         (sym_op->m_dst != NULL)));
 212         /* Segmented destination buffer is not supported */
 213         RTE_ASSERT((sym_op->m_dst == NULL) ||
 214                         ((sym_op->m_dst != NULL) &&
 215                                         rte_pktmbuf_is_contiguous(sym_op->m_dst)));
 216
 217
 218         dst = sym_op->m_dst ?
 219                         rte_pktmbuf_mtod_offset(sym_op->m_dst, uint8_t *,
 220                                         data_offset) :
 221                         rte_pktmbuf_mtod_offset(sym_op->m_src, uint8_t *,
 222                                         data_offset);
 223
 224         src = rte_pktmbuf_mtod_offset(m_src, uint8_t *, offset);
 225
 226         iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
 227                                 session->iv.offset);
 228
 229         if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION) {
 230                 qp->ops[session->key].init(&session->gdata_key,
 231                                 &qp->gdata_ctx,
 232                                 iv_ptr,
 233                                 sym_op->aead.aad.data,
 234                                 (uint64_t)session->aad_length);
 235
 236                 qp->ops[session->key].update_enc(&session->gdata_key,
 237                                 &qp->gdata_ctx, dst, src,
 238                                 (uint64_t)part_len);
 239                 total_len = data_length - part_len;
 240
 241                 while (total_len) {
 242                         dst += part_len;
 243                         m_src = m_src->next;
 244
 245                         RTE_ASSERT(m_src != NULL);
 246
 247                         src = rte_pktmbuf_mtod(m_src, uint8_t *);
 248                         part_len = (m_src->data_len < total_len) ?
 249                                         m_src->data_len : total_len;
 250
 251                         qp->ops[session->key].update_enc(&session->gdata_key,
 252                                         &qp->gdata_ctx, dst, src,
 253                                         (uint64_t)part_len);
 254                         total_len -= part_len;
 255                 }
 256
 257                 qp->ops[session->key].finalize(&session->gdata_key,
 258                                 &qp->gdata_ctx,
 259                                 sym_op->aead.digest.data,
 260                                 (uint64_t)session->digest_length);
 261         } else if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
 262                 uint8_t *auth_tag = qp->temp_digest;
 263
 264                 qp->ops[session->key].init(&session->gdata_key,
 265                                 &qp->gdata_ctx,
 266                                 iv_ptr,
 267                                 sym_op->aead.aad.data,
 268                                 (uint64_t)session->aad_length);
 269
 270                 qp->ops[session->key].update_dec(&session->gdata_key,
 271                                 &qp->gdata_ctx, dst, src,
 272                                 (uint64_t)part_len);
 273                 total_len = data_length - part_len;
 274
 275                 while (total_len) {
 276                         dst += part_len;
 277                         m_src = m_src->next;
 278
 279                         RTE_ASSERT(m_src != NULL);
 280
 281                         src = rte_pktmbuf_mtod(m_src, uint8_t *);
 282                         part_len = (m_src->data_len < total_len) ?
 283                                         m_src->data_len : total_len;
 284
 285                         qp->ops[session->key].update_dec(&session->gdata_key,
 286                                         &qp->gdata_ctx,
 287                                         dst, src,
 288                                         (uint64_t)part_len);
 289                         total_len -= part_len;
 290                 }
 291
 292                 qp->ops[session->key].finalize(&session->gdata_key,
 293                                 &qp->gdata_ctx,
 294                                 auth_tag,
 295                                 (uint64_t)session->digest_length);
 296         } else if (session->op == AESNI_GMAC_OP_GENERATE) {
 297                 qp->ops[session->key].init(&session->gdata_key,
 298                                 &qp->gdata_ctx,
 299                                 iv_ptr,
 300                                 src,
 301                                 (uint64_t)data_length);
 302                 qp->ops[session->key].finalize(&session->gdata_key,
 303                                 &qp->gdata_ctx,
 304                                 sym_op->auth.digest.data,
 305                                 (uint64_t)session->digest_length);
 306         } else { /* AESNI_GMAC_OP_VERIFY */
 307                 uint8_t *auth_tag = qp->temp_digest;
 308
 309                 qp->ops[session->key].init(&session->gdata_key,
 310                                 &qp->gdata_ctx,
 311                                 iv_ptr,
 312                                 src,
 313                                 (uint64_t)data_length);
 314
 315                 qp->ops[session->key].finalize(&session->gdata_key,
 316                                 &qp->gdata_ctx,
 317                                 auth_tag,
 318                                 (uint64_t)session->digest_length);
 319         }
 320
 321         return 0;
 322 }
 323
 324 /**
 325  * Process a completed job and return rte_mbuf which job processed
 326  *
 327  * @param job   JOB_AES_HMAC job to process
 328  *
 329  * @return
 330  * - Returns processed mbuf which is trimmed of output digest used in
 331  * verification of supplied digest in the case of a HASH_CIPHER operation
 332  * - Returns NULL on invalid job
 333  */
 334 static void
 335 post_process_gcm_crypto_op(struct aesni_gcm_qp *qp,
 336                 struct rte_crypto_op *op,
 337                 struct aesni_gcm_session *session)
 338 {
 339         op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
 340
 341         /* Verify digest if required */
 342         if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION ||
 343                         session->op == AESNI_GMAC_OP_VERIFY) {
 344                 uint8_t *digest;
 345
 346                 uint8_t *tag = qp->temp_digest;
 347
 348                 if (session->op == AESNI_GMAC_OP_VERIFY)
 349                         digest = op->sym->auth.digest.data;
 350                 else
 351                         digest = op->sym->aead.digest.data;
 352
 353 #ifdef RTE_LIBRTE_PMD_AESNI_GCM_DEBUG
 354                 rte_hexdump(stdout, "auth tag (orig):",
 355                                 digest, session->digest_length);
 356                 rte_hexdump(stdout, "auth tag (calc):",
 357                                 tag, session->digest_length);
 358 #endif
 359
 360                 if (memcmp(tag, digest, session->digest_length) != 0)
 361                         op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
 362         }
 363 }
 364
 365 /**
 366  * Process a completed GCM request
 367  *
 368  * @param qp            Queue Pair to process
 369  * @param op            Crypto operation
 370  * @param job           JOB_AES_HMAC job
 371  *
 372  * @return
 373  * - Number of processed jobs
 374  */
 375 static void
 376 handle_completed_gcm_crypto_op(struct aesni_gcm_qp *qp,
 377                 struct rte_crypto_op *op,
 378                 struct aesni_gcm_session *sess)
 379 {
 380         post_process_gcm_crypto_op(qp, op, sess);
 381
 382         /* Free session if a session-less crypto op */
 383         if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
 384                 memset(sess, 0, sizeof(struct aesni_gcm_session));
 385                 memset(op->sym->session, 0,
 386                                 rte_cryptodev_sym_get_header_session_size());
 387                 rte_mempool_put(qp->sess_mp, sess);
 388                 rte_mempool_put(qp->sess_mp, op->sym->session);
 389                 op->sym->session = NULL;
 390         }
 391 }
 392
 393 static uint16_t
 394 aesni_gcm_pmd_dequeue_burst(void *queue_pair,
 395                 struct rte_crypto_op **ops, uint16_t nb_ops)
 396 {
 397         struct aesni_gcm_session *sess;
 398         struct aesni_gcm_qp *qp = queue_pair;
 399
 400         int retval = 0;
 401         unsigned int i, nb_dequeued;
 402
 403         nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
 404                         (void **)ops, nb_ops, NULL);
 405
 406         for (i = 0; i < nb_dequeued; i++) {
 407
 408                 sess = aesni_gcm_get_session(qp, ops[i]);
 409                 if (unlikely(sess == NULL)) {
 410                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
 411                         qp->qp_stats.dequeue_err_count++;
 412                         break;
 413                 }
 414
 415                 retval = process_gcm_crypto_op(qp, ops[i], sess);
 416                 if (retval < 0) {
 417                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
 418                         qp->qp_stats.dequeue_err_count++;
 419                         break;
 420                 }
 421
 422                 handle_completed_gcm_crypto_op(qp, ops[i], sess);
 423         }
 424
 425         qp->qp_stats.dequeued_count += i;
 426
 427         return i;
 428 }
 429
 430 static uint16_t
 431 aesni_gcm_pmd_enqueue_burst(void *queue_pair,
 432                 struct rte_crypto_op **ops, uint16_t nb_ops)
 433 {
 434         struct aesni_gcm_qp *qp = queue_pair;
 435
 436         unsigned int nb_enqueued;
 437
 438         nb_enqueued = rte_ring_enqueue_burst(qp->processed_pkts,
 439                         (void **)ops, nb_ops, NULL);
 440         qp->qp_stats.enqueued_count += nb_enqueued;
 441
 442         return nb_enqueued;
 443 }
 444
 445 static int aesni_gcm_remove(struct rte_vdev_device *vdev);
 446
 447 static int
 448 aesni_gcm_create(const char *name,
 449                 struct rte_vdev_device *vdev,
 450                 struct rte_cryptodev_pmd_init_params *init_params)
 451 {
 452         struct rte_cryptodev *dev;
 453         struct aesni_gcm_private *internals;
 454         enum aesni_gcm_vector_mode vector_mode;
 455
 456         /* Check CPU for support for AES instruction set */
 457         if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
 458                 AESNI_GCM_LOG(ERR, "AES instructions not supported by CPU");
 459                 return -EFAULT;
 460         }
 461         dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
 462         if (dev == NULL) {
 463                 AESNI_GCM_LOG(ERR, "driver %s: create failed",
 464                         init_params->name);
 465                 return -ENODEV;
 466         }
 467
 468         /* Check CPU for supported vector instruction set */
 469         if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
 470                 vector_mode = RTE_AESNI_GCM_AVX2;
 471         else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
 472                 vector_mode = RTE_AESNI_GCM_AVX;
 473         else
 474                 vector_mode = RTE_AESNI_GCM_SSE;
 475
 476         dev->driver_id = cryptodev_driver_id;
 477         dev->dev_ops = rte_aesni_gcm_pmd_ops;
 478
 479         /* register rx/tx burst functions for data path */
 480         dev->dequeue_burst = aesni_gcm_pmd_dequeue_burst;
 481         dev->enqueue_burst = aesni_gcm_pmd_enqueue_burst;
 482
 483         dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
 484                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
 485                         RTE_CRYPTODEV_FF_CPU_AESNI |
 486                         RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
 487                         RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT;
 488
 489         switch (vector_mode) {
 490         case RTE_AESNI_GCM_SSE:
 491                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
 492                 break;
 493         case RTE_AESNI_GCM_AVX:
 494                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
 495                 break;
 496         case RTE_AESNI_GCM_AVX2:
 497                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
 498                 break;
 499         default:
 500                 break;
 501         }
 502
 503         internals = dev->data->dev_private;
 504
 505         internals->vector_mode = vector_mode;
 506
 507         internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
 508
 509 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
 510         AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: %s\n",
 511                         imb_get_version_str());
 512 #else
 513         AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: 0.49.0\n");
 514 #endif
 515
 516         return 0;
 517 }
 518
 519 static int
 520 aesni_gcm_probe(struct rte_vdev_device *vdev)
 521 {
 522         struct rte_cryptodev_pmd_init_params init_params = {
 523                 "",
 524                 sizeof(struct aesni_gcm_private),
 525                 rte_socket_id(),
 526                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
 527         };
 528         const char *name;
 529         const char *input_args;
 530
 531         name = rte_vdev_device_name(vdev);
 532         if (name == NULL)
 533                 return -EINVAL;
 534         input_args = rte_vdev_device_args(vdev);
 535         rte_cryptodev_pmd_parse_input_args(&init_params, input_args);
 536
 537         return aesni_gcm_create(name, vdev, &init_params);
 538 }
 539
 540 static int
 541 aesni_gcm_remove(struct rte_vdev_device *vdev)
 542 {
 543         struct rte_cryptodev *cryptodev;
 544         const char *name;
 545
 546         name = rte_vdev_device_name(vdev);
 547         if (name == NULL)
 548                 return -EINVAL;
 549
 550         cryptodev = rte_cryptodev_pmd_get_named_dev(name);
 551         if (cryptodev == NULL)
 552                 return -ENODEV;
 553
 554         return rte_cryptodev_pmd_destroy(cryptodev);
 555 }
 556
 557 static struct rte_vdev_driver aesni_gcm_pmd_drv = {
 558         .probe = aesni_gcm_probe,
 559         .remove = aesni_gcm_remove
 560 };
 561
 562 static struct cryptodev_driver aesni_gcm_crypto_drv;
 563
 564 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_GCM_PMD, aesni_gcm_pmd_drv);
 565 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_GCM_PMD, cryptodev_aesni_gcm_pmd);
 566 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_GCM_PMD,
 567         "max_nb_queue_pairs=<int> "
 568         "socket_id=<int>");
 569 RTE_PMD_REGISTER_CRYPTO_DRIVER(aesni_gcm_crypto_drv, aesni_gcm_pmd_drv.driver,
 570                 cryptodev_driver_id);
 571
 572
 573 RTE_INIT(aesni_gcm_init_log)
 574 {
 575         aesni_gcm_logtype_driver = rte_log_register("pmd.crypto.aesni_gcm");
 576 }