drivers/crypto/aesni_mb/rte_aesni_mb_pmd.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2015-2017 Intel Corporation
   3  */
   4
   5 #include <intel-ipsec-mb.h>
   6
   7 #include <rte_common.h>
   8 #include <rte_hexdump.h>
   9 #include <rte_cryptodev.h>
  10 #include <rte_cryptodev_pmd.h>
  11 #include <rte_bus_vdev.h>
  12 #include <rte_malloc.h>
  13 #include <rte_cpuflags.h>
  14
  15 #include "rte_aesni_mb_pmd_private.h"
  16
  17 #define AES_CCM_DIGEST_MIN_LEN 4
  18 #define AES_CCM_DIGEST_MAX_LEN 16
  19
  20 static uint8_t cryptodev_driver_id;
  21
  22 typedef void (*hash_one_block_t)(const void *data, void *digest);
  23 typedef void (*aes_keyexp_t)(const void *key, void *enc_exp_keys, void *dec_exp_keys);
  24
  25 /**
  26  * Calculate the authentication pre-computes
  27  *
  28  * @param one_block_hash        Function pointer to calculate digest on ipad/opad
  29  * @param ipad                  Inner pad output byte array
  30  * @param opad                  Outer pad output byte array
  31  * @param hkey                  Authentication key
  32  * @param hkey_len              Authentication key length
  33  * @param blocksize             Block size of selected hash algo
  34  */
  35 static void
  36 calculate_auth_precomputes(hash_one_block_t one_block_hash,
  37                 uint8_t *ipad, uint8_t *opad,
  38                 uint8_t *hkey, uint16_t hkey_len,
  39                 uint16_t blocksize)
  40 {
  41         unsigned i, length;
  42
  43         uint8_t ipad_buf[blocksize] __rte_aligned(16);
  44         uint8_t opad_buf[blocksize] __rte_aligned(16);
  45
  46         /* Setup inner and outer pads */
  47         memset(ipad_buf, HMAC_IPAD_VALUE, blocksize);
  48         memset(opad_buf, HMAC_OPAD_VALUE, blocksize);
  49
  50         /* XOR hash key with inner and outer pads */
  51         length = hkey_len > blocksize ? blocksize : hkey_len;
  52
  53         for (i = 0; i < length; i++) {
  54                 ipad_buf[i] ^= hkey[i];
  55                 opad_buf[i] ^= hkey[i];
  56         }
  57
  58         /* Compute partial hashes */
  59         (*one_block_hash)(ipad_buf, ipad);
  60         (*one_block_hash)(opad_buf, opad);
  61
  62         /* Clean up stack */
  63         memset(ipad_buf, 0, blocksize);
  64         memset(opad_buf, 0, blocksize);
  65 }
  66
  67 /** Get xform chain order */
  68 static enum aesni_mb_operation
  69 aesni_mb_get_chain_order(const struct rte_crypto_sym_xform *xform)
  70 {
  71         if (xform == NULL)
  72                 return AESNI_MB_OP_NOT_SUPPORTED;
  73
  74         if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
  75                 if (xform->next == NULL)
  76                         return AESNI_MB_OP_CIPHER_ONLY;
  77                 if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
  78                         return AESNI_MB_OP_CIPHER_HASH;
  79         }
  80
  81         if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
  82                 if (xform->next == NULL)
  83                         return AESNI_MB_OP_HASH_ONLY;
  84                 if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
  85                         return AESNI_MB_OP_HASH_CIPHER;
  86         }
  87
  88         if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
  89                 if (xform->aead.algo == RTE_CRYPTO_AEAD_AES_CCM) {
  90                         if (xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
  91                                 return AESNI_MB_OP_AEAD_CIPHER_HASH;
  92                         else
  93                                 return AESNI_MB_OP_AEAD_HASH_CIPHER;
  94                 }
  95         }
  96
  97         return AESNI_MB_OP_NOT_SUPPORTED;
  98 }
  99
 100 /** Set session authentication parameters */
 101 static int
 102 aesni_mb_set_session_auth_parameters(const struct aesni_mb_op_fns *mb_ops,
 103                 struct aesni_mb_session *sess,
 104                 const struct rte_crypto_sym_xform *xform)
 105 {
 106         hash_one_block_t hash_oneblock_fn;
 107
 108         if (xform == NULL) {
 109                 sess->auth.algo = NULL_HASH;
 110                 return 0;
 111         }
 112
 113         if (xform->type != RTE_CRYPTO_SYM_XFORM_AUTH) {
 114                 AESNI_MB_LOG(ERR, "Crypto xform struct not of type auth");
 115                 return -1;
 116         }
 117
 118         /* Set the request digest size */
 119         sess->auth.req_digest_len = xform->auth.digest_length;
 120
 121         /* Select auth generate/verify */
 122         sess->auth.operation = xform->auth.op;
 123
 124         /* Set Authentication Parameters */
 125         if (xform->auth.algo == RTE_CRYPTO_AUTH_AES_XCBC_MAC) {
 126                 sess->auth.algo = AES_XCBC;
 127
 128                 uint16_t xcbc_mac_digest_len =
 129                         get_truncated_digest_byte_length(AES_XCBC);
 130                 if (sess->auth.req_digest_len != xcbc_mac_digest_len) {
 131                         AESNI_MB_LOG(ERR, "Invalid digest size\n");
 132                         return -EINVAL;
 133                 }
 134                 sess->auth.gen_digest_len = sess->auth.req_digest_len;
 135                 (*mb_ops->aux.keyexp.aes_xcbc)(xform->auth.key.data,
 136                                 sess->auth.xcbc.k1_expanded,
 137                                 sess->auth.xcbc.k2, sess->auth.xcbc.k3);
 138                 return 0;
 139         }
 140
 141         if (xform->auth.algo == RTE_CRYPTO_AUTH_AES_CMAC) {
 142                 sess->auth.algo = AES_CMAC;
 143
 144                 sess->auth.gen_digest_len = sess->auth.req_digest_len;
 145                 (*mb_ops->aux.keyexp.aes_cmac_expkey)(xform->auth.key.data,
 146                                 sess->auth.cmac.expkey);
 147
 148                 (*mb_ops->aux.keyexp.aes_cmac_subkey)(sess->auth.cmac.expkey,
 149                                 sess->auth.cmac.skey1, sess->auth.cmac.skey2);
 150                 return 0;
 151         }
 152
 153         switch (xform->auth.algo) {
 154         case RTE_CRYPTO_AUTH_MD5_HMAC:
 155                 sess->auth.algo = MD5;
 156                 hash_oneblock_fn = mb_ops->aux.one_block.md5;
 157                 break;
 158         case RTE_CRYPTO_AUTH_SHA1_HMAC:
 159                 sess->auth.algo = SHA1;
 160                 hash_oneblock_fn = mb_ops->aux.one_block.sha1;
 161                 break;
 162         case RTE_CRYPTO_AUTH_SHA224_HMAC:
 163                 sess->auth.algo = SHA_224;
 164                 hash_oneblock_fn = mb_ops->aux.one_block.sha224;
 165                 break;
 166         case RTE_CRYPTO_AUTH_SHA256_HMAC:
 167                 sess->auth.algo = SHA_256;
 168                 hash_oneblock_fn = mb_ops->aux.one_block.sha256;
 169                 break;
 170         case RTE_CRYPTO_AUTH_SHA384_HMAC:
 171                 sess->auth.algo = SHA_384;
 172                 hash_oneblock_fn = mb_ops->aux.one_block.sha384;
 173                 break;
 174         case RTE_CRYPTO_AUTH_SHA512_HMAC:
 175                 sess->auth.algo = SHA_512;
 176                 hash_oneblock_fn = mb_ops->aux.one_block.sha512;
 177                 break;
 178         default:
 179                 AESNI_MB_LOG(ERR, "Unsupported authentication algorithm selection");
 180                 return -ENOTSUP;
 181         }
 182         uint16_t trunc_digest_size =
 183                         get_truncated_digest_byte_length(sess->auth.algo);
 184         uint16_t full_digest_size =
 185                         get_digest_byte_length(sess->auth.algo);
 186
 187 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
 188         if (sess->auth.req_digest_len > full_digest_size ||
 189                         sess->auth.req_digest_len == 0) {
 190 #else
 191         if (sess->auth.req_digest_len != trunc_digest_size) {
 192 #endif
 193                 AESNI_MB_LOG(ERR, "Invalid digest size\n");
 194                 return -EINVAL;
 195         }
 196
 197         if (sess->auth.req_digest_len != trunc_digest_size &&
 198                         sess->auth.req_digest_len != full_digest_size)
 199                 sess->auth.gen_digest_len = full_digest_size;
 200         else
 201                 sess->auth.gen_digest_len = sess->auth.req_digest_len;
 202
 203         /* Calculate Authentication precomputes */
 204         calculate_auth_precomputes(hash_oneblock_fn,
 205                         sess->auth.pads.inner, sess->auth.pads.outer,
 206                         xform->auth.key.data,
 207                         xform->auth.key.length,
 208                         get_auth_algo_blocksize(sess->auth.algo));
 209
 210         return 0;
 211 }
 212
 213 /** Set session cipher parameters */
 214 static int
 215 aesni_mb_set_session_cipher_parameters(const struct aesni_mb_op_fns *mb_ops,
 216                 struct aesni_mb_session *sess,
 217                 const struct rte_crypto_sym_xform *xform)
 218 {
 219         uint8_t is_aes = 0;
 220         uint8_t is_3DES = 0;
 221         aes_keyexp_t aes_keyexp_fn;
 222
 223         if (xform == NULL) {
 224                 sess->cipher.mode = NULL_CIPHER;
 225                 return 0;
 226         }
 227
 228         if (xform->type != RTE_CRYPTO_SYM_XFORM_CIPHER) {
 229                 AESNI_MB_LOG(ERR, "Crypto xform struct not of type cipher");
 230                 return -EINVAL;
 231         }
 232
 233         /* Select cipher direction */
 234         switch (xform->cipher.op) {
 235         case RTE_CRYPTO_CIPHER_OP_ENCRYPT:
 236                 sess->cipher.direction = ENCRYPT;
 237                 break;
 238         case RTE_CRYPTO_CIPHER_OP_DECRYPT:
 239                 sess->cipher.direction = DECRYPT;
 240                 break;
 241         default:
 242                 AESNI_MB_LOG(ERR, "Invalid cipher operation parameter");
 243                 return -EINVAL;
 244         }
 245
 246         /* Select cipher mode */
 247         switch (xform->cipher.algo) {
 248         case RTE_CRYPTO_CIPHER_AES_CBC:
 249                 sess->cipher.mode = CBC;
 250                 is_aes = 1;
 251                 break;
 252         case RTE_CRYPTO_CIPHER_AES_CTR:
 253                 sess->cipher.mode = CNTR;
 254                 is_aes = 1;
 255                 break;
 256         case RTE_CRYPTO_CIPHER_AES_DOCSISBPI:
 257                 sess->cipher.mode = DOCSIS_SEC_BPI;
 258                 is_aes = 1;
 259                 break;
 260         case RTE_CRYPTO_CIPHER_DES_CBC:
 261                 sess->cipher.mode = DES;
 262                 break;
 263         case RTE_CRYPTO_CIPHER_DES_DOCSISBPI:
 264                 sess->cipher.mode = DOCSIS_DES;
 265                 break;
 266         case RTE_CRYPTO_CIPHER_3DES_CBC:
 267                 sess->cipher.mode = DES3;
 268                 is_3DES = 1;
 269                 break;
 270         default:
 271                 AESNI_MB_LOG(ERR, "Unsupported cipher mode parameter");
 272                 return -ENOTSUP;
 273         }
 274
 275         /* Set IV parameters */
 276         sess->iv.offset = xform->cipher.iv.offset;
 277         sess->iv.length = xform->cipher.iv.length;
 278
 279         /* Check key length and choose key expansion function for AES */
 280         if (is_aes) {
 281                 switch (xform->cipher.key.length) {
 282                 case AES_128_BYTES:
 283                         sess->cipher.key_length_in_bytes = AES_128_BYTES;
 284                         aes_keyexp_fn = mb_ops->aux.keyexp.aes128;
 285                         break;
 286                 case AES_192_BYTES:
 287                         sess->cipher.key_length_in_bytes = AES_192_BYTES;
 288                         aes_keyexp_fn = mb_ops->aux.keyexp.aes192;
 289                         break;
 290                 case AES_256_BYTES:
 291                         sess->cipher.key_length_in_bytes = AES_256_BYTES;
 292                         aes_keyexp_fn = mb_ops->aux.keyexp.aes256;
 293                         break;
 294                 default:
 295                         AESNI_MB_LOG(ERR, "Invalid cipher key length");
 296                         return -EINVAL;
 297                 }
 298
 299                 /* Expanded cipher keys */
 300                 (*aes_keyexp_fn)(xform->cipher.key.data,
 301                                 sess->cipher.expanded_aes_keys.encode,
 302                                 sess->cipher.expanded_aes_keys.decode);
 303
 304         } else if (is_3DES) {
 305                 uint64_t *keys[3] = {sess->cipher.exp_3des_keys.key[0],
 306                                 sess->cipher.exp_3des_keys.key[1],
 307                                 sess->cipher.exp_3des_keys.key[2]};
 308
 309                 switch (xform->cipher.key.length) {
 310                 case  24:
 311                         des_key_schedule(keys[0], xform->cipher.key.data);
 312                         des_key_schedule(keys[1], xform->cipher.key.data+8);
 313                         des_key_schedule(keys[2], xform->cipher.key.data+16);
 314
 315                         /* Initialize keys - 24 bytes: [K1-K2-K3] */
 316                         sess->cipher.exp_3des_keys.ks_ptr[0] = keys[0];
 317                         sess->cipher.exp_3des_keys.ks_ptr[1] = keys[1];
 318                         sess->cipher.exp_3des_keys.ks_ptr[2] = keys[2];
 319                         break;
 320                 case 16:
 321                         des_key_schedule(keys[0], xform->cipher.key.data);
 322                         des_key_schedule(keys[1], xform->cipher.key.data+8);
 323
 324                         /* Initialize keys - 16 bytes: [K1=K1,K2=K2,K3=K1] */
 325                         sess->cipher.exp_3des_keys.ks_ptr[0] = keys[0];
 326                         sess->cipher.exp_3des_keys.ks_ptr[1] = keys[1];
 327                         sess->cipher.exp_3des_keys.ks_ptr[2] = keys[0];
 328                         break;
 329                 case 8:
 330                         des_key_schedule(keys[0], xform->cipher.key.data);
 331
 332                         /* Initialize keys - 8 bytes: [K1 = K2 = K3] */
 333                         sess->cipher.exp_3des_keys.ks_ptr[0] = keys[0];
 334                         sess->cipher.exp_3des_keys.ks_ptr[1] = keys[0];
 335                         sess->cipher.exp_3des_keys.ks_ptr[2] = keys[0];
 336                         break;
 337                 default:
 338                         AESNI_MB_LOG(ERR, "Invalid cipher key length");
 339                         return -EINVAL;
 340                 }
 341
 342 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
 343                 sess->cipher.key_length_in_bytes = 24;
 344 #else
 345                 sess->cipher.key_length_in_bytes = 8;
 346 #endif
 347         } else {
 348                 if (xform->cipher.key.length != 8) {
 349                         AESNI_MB_LOG(ERR, "Invalid cipher key length");
 350                         return -EINVAL;
 351                 }
 352                 sess->cipher.key_length_in_bytes = 8;
 353
 354                 des_key_schedule((uint64_t *)sess->cipher.expanded_aes_keys.encode,
 355                                 xform->cipher.key.data);
 356                 des_key_schedule((uint64_t *)sess->cipher.expanded_aes_keys.decode,
 357                                 xform->cipher.key.data);
 358         }
 359
 360         return 0;
 361 }
 362
 363 static int
 364 aesni_mb_set_session_aead_parameters(const struct aesni_mb_op_fns *mb_ops,
 365                 struct aesni_mb_session *sess,
 366                 const struct rte_crypto_sym_xform *xform)
 367 {
 368         aes_keyexp_t aes_keyexp_fn;
 369
 370         switch (xform->aead.op) {
 371         case RTE_CRYPTO_AEAD_OP_ENCRYPT:
 372                 sess->cipher.direction = ENCRYPT;
 373                 sess->auth.operation = RTE_CRYPTO_AUTH_OP_GENERATE;
 374                 break;
 375         case RTE_CRYPTO_AEAD_OP_DECRYPT:
 376                 sess->cipher.direction = DECRYPT;
 377                 sess->auth.operation = RTE_CRYPTO_AUTH_OP_VERIFY;
 378                 break;
 379         default:
 380                 AESNI_MB_LOG(ERR, "Invalid aead operation parameter");
 381                 return -EINVAL;
 382         }
 383
 384         switch (xform->aead.algo) {
 385         case RTE_CRYPTO_AEAD_AES_CCM:
 386                 sess->cipher.mode = CCM;
 387                 sess->auth.algo = AES_CCM;
 388                 break;
 389         default:
 390                 AESNI_MB_LOG(ERR, "Unsupported aead mode parameter");
 391                 return -ENOTSUP;
 392         }
 393
 394         /* Set IV parameters */
 395         sess->iv.offset = xform->aead.iv.offset;
 396         sess->iv.length = xform->aead.iv.length;
 397
 398         sess->auth.req_digest_len = xform->aead.digest_length;
 399         /* CCM digests must be between 4 and 16 and an even number */
 400         if (sess->auth.req_digest_len < AES_CCM_DIGEST_MIN_LEN ||
 401                         sess->auth.req_digest_len > AES_CCM_DIGEST_MAX_LEN ||
 402                         (sess->auth.req_digest_len & 1) == 1) {
 403                 AESNI_MB_LOG(ERR, "Invalid digest size\n");
 404                 return -EINVAL;
 405         }
 406         sess->auth.gen_digest_len = sess->auth.req_digest_len;
 407
 408         /* Check key length and choose key expansion function for AES */
 409
 410         switch (xform->aead.key.length) {
 411         case AES_128_BYTES:
 412                 sess->cipher.key_length_in_bytes = AES_128_BYTES;
 413                 aes_keyexp_fn = mb_ops->aux.keyexp.aes128;
 414                 break;
 415         default:
 416                 AESNI_MB_LOG(ERR, "Invalid cipher key length");
 417                 return -EINVAL;
 418         }
 419
 420         /* Expanded cipher keys */
 421         (*aes_keyexp_fn)(xform->aead.key.data,
 422                         sess->cipher.expanded_aes_keys.encode,
 423                         sess->cipher.expanded_aes_keys.decode);
 424
 425         return 0;
 426 }
 427
 428 /** Parse crypto xform chain and set private session parameters */
 429 int
 430 aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
 431                 struct aesni_mb_session *sess,
 432                 const struct rte_crypto_sym_xform *xform)
 433 {
 434         const struct rte_crypto_sym_xform *auth_xform = NULL;
 435         const struct rte_crypto_sym_xform *cipher_xform = NULL;
 436         const struct rte_crypto_sym_xform *aead_xform = NULL;
 437         int ret;
 438
 439         /* Select Crypto operation - hash then cipher / cipher then hash */
 440         switch (aesni_mb_get_chain_order(xform)) {
 441         case AESNI_MB_OP_HASH_CIPHER:
 442                 sess->chain_order = HASH_CIPHER;
 443                 auth_xform = xform;
 444                 cipher_xform = xform->next;
 445                 break;
 446         case AESNI_MB_OP_CIPHER_HASH:
 447                 sess->chain_order = CIPHER_HASH;
 448                 auth_xform = xform->next;
 449                 cipher_xform = xform;
 450                 break;
 451         case AESNI_MB_OP_HASH_ONLY:
 452                 sess->chain_order = HASH_CIPHER;
 453                 auth_xform = xform;
 454                 cipher_xform = NULL;
 455                 break;
 456         case AESNI_MB_OP_CIPHER_ONLY:
 457                 /*
 458                  * Multi buffer library operates only at two modes,
 459                  * CIPHER_HASH and HASH_CIPHER. When doing ciphering only,
 460                  * chain order depends on cipher operation: encryption is always
 461                  * the first operation and decryption the last one.
 462                  */
 463                 if (xform->cipher.op == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
 464                         sess->chain_order = CIPHER_HASH;
 465                 else
 466                         sess->chain_order = HASH_CIPHER;
 467                 auth_xform = NULL;
 468                 cipher_xform = xform;
 469                 break;
 470         case AESNI_MB_OP_AEAD_CIPHER_HASH:
 471                 sess->chain_order = CIPHER_HASH;
 472                 sess->aead.aad_len = xform->aead.aad_length;
 473                 aead_xform = xform;
 474                 break;
 475         case AESNI_MB_OP_AEAD_HASH_CIPHER:
 476                 sess->chain_order = HASH_CIPHER;
 477                 sess->aead.aad_len = xform->aead.aad_length;
 478                 aead_xform = xform;
 479                 break;
 480         case AESNI_MB_OP_NOT_SUPPORTED:
 481         default:
 482                 AESNI_MB_LOG(ERR, "Unsupported operation chain order parameter");
 483                 return -ENOTSUP;
 484         }
 485
 486         /* Default IV length = 0 */
 487         sess->iv.length = 0;
 488
 489         ret = aesni_mb_set_session_auth_parameters(mb_ops, sess, auth_xform);
 490         if (ret != 0) {
 491                 AESNI_MB_LOG(ERR, "Invalid/unsupported authentication parameters");
 492                 return ret;
 493         }
 494
 495         ret = aesni_mb_set_session_cipher_parameters(mb_ops, sess,
 496                         cipher_xform);
 497         if (ret != 0) {
 498                 AESNI_MB_LOG(ERR, "Invalid/unsupported cipher parameters");
 499                 return ret;
 500         }
 501
 502         if (aead_xform) {
 503                 ret = aesni_mb_set_session_aead_parameters(mb_ops, sess,
 504                                 aead_xform);
 505                 if (ret != 0) {
 506                         AESNI_MB_LOG(ERR, "Invalid/unsupported aead parameters");
 507                         return ret;
 508                 }
 509         }
 510
 511         return 0;
 512 }
 513
 514 /**
 515  * burst enqueue, place crypto operations on ingress queue for processing.
 516  *
 517  * @param __qp         Queue Pair to process
 518  * @param ops          Crypto operations for processing
 519  * @param nb_ops       Number of crypto operations for processing
 520  *
 521  * @return
 522  * - Number of crypto operations enqueued
 523  */
 524 static uint16_t
 525 aesni_mb_pmd_enqueue_burst(void *__qp, struct rte_crypto_op **ops,
 526                 uint16_t nb_ops)
 527 {
 528         struct aesni_mb_qp *qp = __qp;
 529
 530         unsigned int nb_enqueued;
 531
 532         nb_enqueued = rte_ring_enqueue_burst(qp->ingress_queue,
 533                         (void **)ops, nb_ops, NULL);
 534
 535         qp->stats.enqueued_count += nb_enqueued;
 536
 537         return nb_enqueued;
 538 }
 539
 540 /** Get multi buffer session */
 541 static inline struct aesni_mb_session *
 542 get_session(struct aesni_mb_qp *qp, struct rte_crypto_op *op)
 543 {
 544         struct aesni_mb_session *sess = NULL;
 545
 546         if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
 547                 if (likely(op->sym->session != NULL))
 548                         sess = (struct aesni_mb_session *)
 549                                         get_sym_session_private_data(
 550                                         op->sym->session,
 551                                         cryptodev_driver_id);
 552         } else {
 553                 void *_sess = NULL;
 554                 void *_sess_private_data = NULL;
 555
 556                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
 557                         return NULL;
 558
 559                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess_private_data))
 560                         return NULL;
 561
 562                 sess = (struct aesni_mb_session *)_sess_private_data;
 563
 564                 if (unlikely(aesni_mb_set_session_parameters(qp->op_fns,
 565                                 sess, op->sym->xform) != 0)) {
 566                         rte_mempool_put(qp->sess_mp, _sess);
 567                         rte_mempool_put(qp->sess_mp, _sess_private_data);
 568                         sess = NULL;
 569                 }
 570                 op->sym->session = (struct rte_cryptodev_sym_session *)_sess;
 571                 set_sym_session_private_data(op->sym->session,
 572                                 cryptodev_driver_id, _sess_private_data);
 573         }
 574
 575         if (unlikely(sess == NULL))
 576                 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
 577
 578         return sess;
 579 }
 580
 581 /**
 582  * Process a crypto operation and complete a JOB_AES_HMAC job structure for
 583  * submission to the multi buffer library for processing.
 584  *
 585  * @param       qp      queue pair
 586  * @param       job     JOB_AES_HMAC structure to fill
 587  * @param       m       mbuf to process
 588  *
 589  * @return
 590  * - Completed JOB_AES_HMAC structure pointer on success
 591  * - NULL pointer if completion of JOB_AES_HMAC structure isn't possible
 592  */
 593 static inline int
 594 set_mb_job_params(JOB_AES_HMAC *job, struct aesni_mb_qp *qp,
 595                 struct rte_crypto_op *op, uint8_t *digest_idx)
 596 {
 597         struct rte_mbuf *m_src = op->sym->m_src, *m_dst;
 598         struct aesni_mb_session *session;
 599         uint16_t m_offset = 0;
 600
 601         session = get_session(qp, op);
 602         if (session == NULL) {
 603                 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
 604                 return -1;
 605         }
 606
 607         /* Set crypto operation */
 608         job->chain_order = session->chain_order;
 609
 610         /* Set cipher parameters */
 611         job->cipher_direction = session->cipher.direction;
 612         job->cipher_mode = session->cipher.mode;
 613
 614         job->aes_key_len_in_bytes = session->cipher.key_length_in_bytes;
 615
 616         if (job->cipher_mode == DES3) {
 617                 job->aes_enc_key_expanded =
 618                         session->cipher.exp_3des_keys.ks_ptr;
 619                 job->aes_dec_key_expanded =
 620                         session->cipher.exp_3des_keys.ks_ptr;
 621         } else {
 622                 job->aes_enc_key_expanded =
 623                         session->cipher.expanded_aes_keys.encode;
 624                 job->aes_dec_key_expanded =
 625                         session->cipher.expanded_aes_keys.decode;
 626         }
 627
 628
 629
 630
 631         /* Set authentication parameters */
 632         job->hash_alg = session->auth.algo;
 633         if (job->hash_alg == AES_XCBC) {
 634                 job->u.XCBC._k1_expanded = session->auth.xcbc.k1_expanded;
 635                 job->u.XCBC._k2 = session->auth.xcbc.k2;
 636                 job->u.XCBC._k3 = session->auth.xcbc.k3;
 637         } else if (job->hash_alg == AES_CCM) {
 638                 job->u.CCM.aad = op->sym->aead.aad.data + 18;
 639                 job->u.CCM.aad_len_in_bytes = session->aead.aad_len;
 640         } else if (job->hash_alg == AES_CMAC) {
 641                 job->u.CMAC._key_expanded = session->auth.cmac.expkey;
 642                 job->u.CMAC._skey1 = session->auth.cmac.skey1;
 643                 job->u.CMAC._skey2 = session->auth.cmac.skey2;
 644
 645         } else {
 646                 job->u.HMAC._hashed_auth_key_xor_ipad = session->auth.pads.inner;
 647                 job->u.HMAC._hashed_auth_key_xor_opad = session->auth.pads.outer;
 648         }
 649
 650         /* Mutable crypto operation parameters */
 651         if (op->sym->m_dst) {
 652                 m_src = m_dst = op->sym->m_dst;
 653
 654                 /* append space for output data to mbuf */
 655                 char *odata = rte_pktmbuf_append(m_dst,
 656                                 rte_pktmbuf_data_len(op->sym->m_src));
 657                 if (odata == NULL) {
 658                         AESNI_MB_LOG(ERR, "failed to allocate space in destination "
 659                                         "mbuf for source data");
 660                         op->status = RTE_CRYPTO_OP_STATUS_ERROR;
 661                         return -1;
 662                 }
 663
 664                 memcpy(odata, rte_pktmbuf_mtod(op->sym->m_src, void*),
 665                                 rte_pktmbuf_data_len(op->sym->m_src));
 666         } else {
 667                 m_dst = m_src;
 668                 if (job->hash_alg == AES_CCM)
 669                         m_offset = op->sym->aead.data.offset;
 670                 else
 671                         m_offset = op->sym->cipher.data.offset;
 672         }
 673
 674         /* Set digest output location */
 675         if (job->hash_alg != NULL_HASH &&
 676                         session->auth.operation == RTE_CRYPTO_AUTH_OP_VERIFY) {
 677                 job->auth_tag_output = qp->temp_digests[*digest_idx];
 678                 *digest_idx = (*digest_idx + 1) % MAX_JOBS;
 679         } else {
 680                 if (job->hash_alg == AES_CCM)
 681                         job->auth_tag_output = op->sym->aead.digest.data;
 682                 else
 683                         job->auth_tag_output = op->sym->auth.digest.data;
 684
 685                 if (session->auth.req_digest_len != session->auth.gen_digest_len) {
 686                         job->auth_tag_output = qp->temp_digests[*digest_idx];
 687                         *digest_idx = (*digest_idx + 1) % MAX_JOBS;
 688                 }
 689         }
 690
 691         /* Set digest length */
 692         job->auth_tag_output_len_in_bytes = session->auth.gen_digest_len;
 693
 694         /* Set IV parameters */
 695         job->iv_len_in_bytes = session->iv.length;
 696
 697         /* Data  Parameter */
 698         job->src = rte_pktmbuf_mtod(m_src, uint8_t *);
 699         job->dst = rte_pktmbuf_mtod_offset(m_dst, uint8_t *, m_offset);
 700
 701         if (job->hash_alg == AES_CCM) {
 702                 job->cipher_start_src_offset_in_bytes =
 703                                 op->sym->aead.data.offset;
 704                 job->msg_len_to_cipher_in_bytes = op->sym->aead.data.length;
 705                 job->hash_start_src_offset_in_bytes = op->sym->aead.data.offset;
 706                 job->msg_len_to_hash_in_bytes = op->sym->aead.data.length;
 707
 708                 job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
 709                         session->iv.offset + 1);
 710         } else {
 711                 job->cipher_start_src_offset_in_bytes =
 712                                 op->sym->cipher.data.offset;
 713                 job->msg_len_to_cipher_in_bytes = op->sym->cipher.data.length;
 714
 715                 job->hash_start_src_offset_in_bytes = op->sym->auth.data.offset;
 716                 job->msg_len_to_hash_in_bytes = op->sym->auth.data.length;
 717
 718                 job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
 719                         session->iv.offset);
 720         }
 721
 722         /* Set user data to be crypto operation data struct */
 723         job->user_data = op;
 724
 725         return 0;
 726 }
 727
 728 static inline void
 729 verify_digest(JOB_AES_HMAC *job, struct rte_crypto_op *op,
 730                 struct aesni_mb_session *sess)
 731 {
 732         /* Verify digest if required */
 733         if (job->hash_alg == AES_CCM) {
 734                 if (memcmp(job->auth_tag_output, op->sym->aead.digest.data,
 735                                 sess->auth.req_digest_len) != 0)
 736                         op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
 737         } else {
 738                 if (memcmp(job->auth_tag_output, op->sym->auth.digest.data,
 739                                 sess->auth.req_digest_len) != 0)
 740                         op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
 741         }
 742 }
 743
 744 static inline void
 745 generate_digest(JOB_AES_HMAC *job, struct rte_crypto_op *op,
 746                 struct aesni_mb_session *sess)
 747 {
 748         /* No extra copy neeed */
 749         if (likely(sess->auth.req_digest_len == sess->auth.gen_digest_len))
 750                 return;
 751
 752         /*
 753          * This can only happen for HMAC, so only digest
 754          * for authentication algos is required
 755          */
 756         memcpy(op->sym->auth.digest.data, job->auth_tag_output,
 757                         sess->auth.req_digest_len);
 758 }
 759
 760 /**
 761  * Process a completed job and return rte_mbuf which job processed
 762  *
 763  * @param qp            Queue Pair to process
 764  * @param job   JOB_AES_HMAC job to process
 765  *
 766  * @return
 767  * - Returns processed crypto operation.
 768  * - Returns NULL on invalid job
 769  */
 770 static inline struct rte_crypto_op *
 771 post_process_mb_job(struct aesni_mb_qp *qp, JOB_AES_HMAC *job)
 772 {
 773         struct rte_crypto_op *op = (struct rte_crypto_op *)job->user_data;
 774         struct aesni_mb_session *sess = get_sym_session_private_data(
 775                                                         op->sym->session,
 776                                                         cryptodev_driver_id);
 777
 778         if (likely(op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)) {
 779                 switch (job->status) {
 780                 case STS_COMPLETED:
 781                         op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
 782
 783                         if (job->hash_alg != NULL_HASH) {
 784                                 if (sess->auth.operation ==
 785                                                 RTE_CRYPTO_AUTH_OP_VERIFY)
 786                                         verify_digest(job, op, sess);
 787                                 else
 788                                         generate_digest(job, op, sess);
 789                         }
 790                         break;
 791                 default:
 792                         op->status = RTE_CRYPTO_OP_STATUS_ERROR;
 793                 }
 794         }
 795
 796         /* Free session if a session-less crypto op */
 797         if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
 798                 memset(sess, 0, sizeof(struct aesni_mb_session));
 799                 memset(op->sym->session, 0,
 800                                 rte_cryptodev_sym_get_header_session_size());
 801                 rte_mempool_put(qp->sess_mp, sess);
 802                 rte_mempool_put(qp->sess_mp, op->sym->session);
 803                 op->sym->session = NULL;
 804         }
 805
 806         return op;
 807 }
 808
 809 /**
 810  * Process a completed JOB_AES_HMAC job and keep processing jobs until
 811  * get_completed_job return NULL
 812  *
 813  * @param qp            Queue Pair to process
 814  * @param job           JOB_AES_HMAC job
 815  *
 816  * @return
 817  * - Number of processed jobs
 818  */
 819 static unsigned
 820 handle_completed_jobs(struct aesni_mb_qp *qp, JOB_AES_HMAC *job,
 821                 struct rte_crypto_op **ops, uint16_t nb_ops)
 822 {
 823         struct rte_crypto_op *op = NULL;
 824         unsigned processed_jobs = 0;
 825
 826         while (job != NULL) {
 827                 op = post_process_mb_job(qp, job);
 828
 829                 if (op) {
 830                         ops[processed_jobs++] = op;
 831                         qp->stats.dequeued_count++;
 832                 } else {
 833                         qp->stats.dequeue_err_count++;
 834                         break;
 835                 }
 836                 if (processed_jobs == nb_ops)
 837                         break;
 838
 839                 job = (*qp->op_fns->job.get_completed_job)(qp->mb_mgr);
 840         }
 841
 842         return processed_jobs;
 843 }
 844
 845 static inline uint16_t
 846 flush_mb_mgr(struct aesni_mb_qp *qp, struct rte_crypto_op **ops,
 847                 uint16_t nb_ops)
 848 {
 849         int processed_ops = 0;
 850
 851         /* Flush the remaining jobs */
 852         JOB_AES_HMAC *job = (*qp->op_fns->job.flush_job)(qp->mb_mgr);
 853
 854         if (job)
 855                 processed_ops += handle_completed_jobs(qp, job,
 856                                 &ops[processed_ops], nb_ops - processed_ops);
 857
 858         return processed_ops;
 859 }
 860
 861 static inline JOB_AES_HMAC *
 862 set_job_null_op(JOB_AES_HMAC *job, struct rte_crypto_op *op)
 863 {
 864         job->chain_order = HASH_CIPHER;
 865         job->cipher_mode = NULL_CIPHER;
 866         job->hash_alg = NULL_HASH;
 867         job->cipher_direction = DECRYPT;
 868
 869         /* Set user data to be crypto operation data struct */
 870         job->user_data = op;
 871
 872         return job;
 873 }
 874
 875 static uint16_t
 876 aesni_mb_pmd_dequeue_burst(void *queue_pair, struct rte_crypto_op **ops,
 877                 uint16_t nb_ops)
 878 {
 879         struct aesni_mb_qp *qp = queue_pair;
 880
 881         struct rte_crypto_op *op;
 882         JOB_AES_HMAC *job;
 883
 884         int retval, processed_jobs = 0;
 885
 886         if (unlikely(nb_ops == 0))
 887                 return 0;
 888
 889         uint8_t digest_idx = qp->digest_idx;
 890         do {
 891                 /* Get next free mb job struct from mb manager */
 892                 job = (*qp->op_fns->job.get_next)(qp->mb_mgr);
 893                 if (unlikely(job == NULL)) {
 894                         /* if no free mb job structs we need to flush mb_mgr */
 895                         processed_jobs += flush_mb_mgr(qp,
 896                                         &ops[processed_jobs],
 897                                         nb_ops - processed_jobs);
 898
 899                         if (nb_ops == processed_jobs)
 900                                 break;
 901
 902                         job = (*qp->op_fns->job.get_next)(qp->mb_mgr);
 903                 }
 904
 905                 /*
 906                  * Get next operation to process from ingress queue.
 907                  * There is no need to return the job to the MB_MGR
 908                  * if there are no more operations to process, since the MB_MGR
 909                  * can use that pointer again in next get_next calls.
 910                  */
 911                 retval = rte_ring_dequeue(qp->ingress_queue, (void **)&op);
 912                 if (retval < 0)
 913                         break;
 914
 915                 retval = set_mb_job_params(job, qp, op, &digest_idx);
 916                 if (unlikely(retval != 0)) {
 917                         qp->stats.dequeue_err_count++;
 918                         set_job_null_op(job, op);
 919                 }
 920
 921                 /* Submit job to multi-buffer for processing */
 922                 job = (*qp->op_fns->job.submit)(qp->mb_mgr);
 923
 924                 /*
 925                  * If submit returns a processed job then handle it,
 926                  * before submitting subsequent jobs
 927                  */
 928                 if (job)
 929                         processed_jobs += handle_completed_jobs(qp, job,
 930                                         &ops[processed_jobs],
 931                                         nb_ops - processed_jobs);
 932
 933         } while (processed_jobs < nb_ops);
 934
 935         qp->digest_idx = digest_idx;
 936
 937         if (processed_jobs < 1)
 938                 processed_jobs += flush_mb_mgr(qp,
 939                                 &ops[processed_jobs],
 940                                 nb_ops - processed_jobs);
 941
 942         return processed_jobs;
 943 }
 944
 945 static int cryptodev_aesni_mb_remove(struct rte_vdev_device *vdev);
 946
 947 static int
 948 cryptodev_aesni_mb_create(const char *name,
 949                         struct rte_vdev_device *vdev,
 950                         struct rte_cryptodev_pmd_init_params *init_params)
 951 {
 952         struct rte_cryptodev *dev;
 953         struct aesni_mb_private *internals;
 954         enum aesni_mb_vector_mode vector_mode;
 955
 956         /* Check CPU for support for AES instruction set */
 957         if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
 958                 AESNI_MB_LOG(ERR, "AES instructions not supported by CPU");
 959                 return -EFAULT;
 960         }
 961
 962         dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
 963         if (dev == NULL) {
 964                 AESNI_MB_LOG(ERR, "failed to create cryptodev vdev");
 965                 return -ENODEV;
 966         }
 967
 968         /* Check CPU for supported vector instruction set */
 969         if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX512F))
 970                 vector_mode = RTE_AESNI_MB_AVX512;
 971         else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
 972                 vector_mode = RTE_AESNI_MB_AVX2;
 973         else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
 974                 vector_mode = RTE_AESNI_MB_AVX;
 975         else
 976                 vector_mode = RTE_AESNI_MB_SSE;
 977
 978         dev->driver_id = cryptodev_driver_id;
 979         dev->dev_ops = rte_aesni_mb_pmd_ops;
 980
 981         /* register rx/tx burst functions for data path */
 982         dev->dequeue_burst = aesni_mb_pmd_dequeue_burst;
 983         dev->enqueue_burst = aesni_mb_pmd_enqueue_burst;
 984
 985         dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
 986                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
 987                         RTE_CRYPTODEV_FF_CPU_AESNI;
 988
 989         switch (vector_mode) {
 990         case RTE_AESNI_MB_SSE:
 991                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
 992                 break;
 993         case RTE_AESNI_MB_AVX:
 994                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
 995                 break;
 996         case RTE_AESNI_MB_AVX2:
 997                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
 998                 break;
 999         case RTE_AESNI_MB_AVX512:
1000                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX512;
1001                 break;
1002         default:
1003                 break;
1004         }
1005
1006         /* Set vector instructions mode supported */
1007         internals = dev->data->dev_private;
1008
1009         internals->vector_mode = vector_mode;
1010         internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
1011
1012 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
1013         AESNI_MB_LOG(INFO, "IPSec Multi-buffer library version used: %s\n",
1014                         imb_get_version_str());
1015 #else
1016         AESNI_MB_LOG(INFO, "IPSec Multi-buffer library version used: 0.49.0\n");
1017 #endif
1018
1019         return 0;
1020 }
1021
1022 static int
1023 cryptodev_aesni_mb_probe(struct rte_vdev_device *vdev)
1024 {
1025         struct rte_cryptodev_pmd_init_params init_params = {
1026                 "",
1027                 sizeof(struct aesni_mb_private),
1028                 rte_socket_id(),
1029                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
1030         };
1031         const char *name, *args;
1032         int retval;
1033
1034         name = rte_vdev_device_name(vdev);
1035         if (name == NULL)
1036                 return -EINVAL;
1037
1038         args = rte_vdev_device_args(vdev);
1039
1040         retval = rte_cryptodev_pmd_parse_input_args(&init_params, args);
1041         if (retval) {
1042                 AESNI_MB_LOG(ERR, "Failed to parse initialisation arguments[%s]",
1043                                 args);
1044                 return -EINVAL;
1045         }
1046
1047         return cryptodev_aesni_mb_create(name, vdev, &init_params);
1048 }
1049
1050 static int
1051 cryptodev_aesni_mb_remove(struct rte_vdev_device *vdev)
1052 {
1053         struct rte_cryptodev *cryptodev;
1054         const char *name;
1055
1056         name = rte_vdev_device_name(vdev);
1057         if (name == NULL)
1058                 return -EINVAL;
1059
1060         cryptodev = rte_cryptodev_pmd_get_named_dev(name);
1061         if (cryptodev == NULL)
1062                 return -ENODEV;
1063
1064         return rte_cryptodev_pmd_destroy(cryptodev);
1065 }
1066
1067 static struct rte_vdev_driver cryptodev_aesni_mb_pmd_drv = {
1068         .probe = cryptodev_aesni_mb_probe,
1069         .remove = cryptodev_aesni_mb_remove
1070 };
1071
1072 static struct cryptodev_driver aesni_mb_crypto_drv;
1073
1074 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_MB_PMD, cryptodev_aesni_mb_pmd_drv);
1075 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_MB_PMD, cryptodev_aesni_mb_pmd);
1076 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_MB_PMD,
1077         "max_nb_queue_pairs=<int> "
1078         "socket_id=<int>");
1079 RTE_PMD_REGISTER_CRYPTO_DRIVER(aesni_mb_crypto_drv,
1080                 cryptodev_aesni_mb_pmd_drv.driver,
1081                 cryptodev_driver_id);
1082
1083 RTE_INIT(aesni_mb_init_log)
1084 {
1085         aesni_mb_logtype_driver = rte_log_register("pmd.crypto.aesni_mb");
1086 }