drivers/crypto/zuc/rte_zuc_pmd.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016-2018 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
  13 #include "zuc_pmd_private.h"
  14 #define ZUC_MAX_BURST 16
  15 #define BYTE_LEN 8
  16
  17 static uint8_t cryptodev_driver_id;
  18
  19 /** Get xform chain order. */
  20 static enum zuc_operation
  21 zuc_get_mode(const struct rte_crypto_sym_xform *xform)
  22 {
  23         if (xform == NULL)
  24                 return ZUC_OP_NOT_SUPPORTED;
  25
  26         if (xform->next)
  27                 if (xform->next->next != NULL)
  28                         return ZUC_OP_NOT_SUPPORTED;
  29
  30         if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
  31                 if (xform->next == NULL)
  32                         return ZUC_OP_ONLY_AUTH;
  33                 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
  34                         return ZUC_OP_AUTH_CIPHER;
  35                 else
  36                         return ZUC_OP_NOT_SUPPORTED;
  37         }
  38
  39         if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
  40                 if (xform->next == NULL)
  41                         return ZUC_OP_ONLY_CIPHER;
  42                 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
  43                         return ZUC_OP_CIPHER_AUTH;
  44                 else
  45                         return ZUC_OP_NOT_SUPPORTED;
  46         }
  47
  48         return ZUC_OP_NOT_SUPPORTED;
  49 }
  50
  51
  52 /** Parse crypto xform chain and set private session parameters. */
  53 int
  54 zuc_set_session_parameters(struct zuc_session *sess,
  55                 const struct rte_crypto_sym_xform *xform)
  56 {
  57         const struct rte_crypto_sym_xform *auth_xform = NULL;
  58         const struct rte_crypto_sym_xform *cipher_xform = NULL;
  59         enum zuc_operation mode;
  60
  61         /* Select Crypto operation - hash then cipher / cipher then hash */
  62         mode = zuc_get_mode(xform);
  63
  64         switch (mode) {
  65         case ZUC_OP_CIPHER_AUTH:
  66                 auth_xform = xform->next;
  67
  68                 /* Fall-through */
  69         case ZUC_OP_ONLY_CIPHER:
  70                 cipher_xform = xform;
  71                 break;
  72         case ZUC_OP_AUTH_CIPHER:
  73                 cipher_xform = xform->next;
  74                 /* Fall-through */
  75         case ZUC_OP_ONLY_AUTH:
  76                 auth_xform = xform;
  77                 break;
  78         case ZUC_OP_NOT_SUPPORTED:
  79         default:
  80                 ZUC_LOG(ERR, "Unsupported operation chain order parameter");
  81                 return -ENOTSUP;
  82         }
  83
  84         if (cipher_xform) {
  85                 /* Only ZUC EEA3 supported */
  86                 if (cipher_xform->cipher.algo != RTE_CRYPTO_CIPHER_ZUC_EEA3)
  87                         return -ENOTSUP;
  88
  89                 if (cipher_xform->cipher.iv.length != ZUC_IV_KEY_LENGTH) {
  90                         ZUC_LOG(ERR, "Wrong IV length");
  91                         return -EINVAL;
  92                 }
  93                 sess->cipher_iv_offset = cipher_xform->cipher.iv.offset;
  94
  95                 /* Copy the key */
  96                 memcpy(sess->pKey_cipher, cipher_xform->cipher.key.data,
  97                                 ZUC_IV_KEY_LENGTH);
  98         }
  99
 100         if (auth_xform) {
 101                 /* Only ZUC EIA3 supported */
 102                 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_ZUC_EIA3)
 103                         return -ENOTSUP;
 104
 105                 if (auth_xform->auth.digest_length != ZUC_DIGEST_LENGTH) {
 106                         ZUC_LOG(ERR, "Wrong digest length");
 107                         return -EINVAL;
 108                 }
 109
 110                 sess->auth_op = auth_xform->auth.op;
 111
 112                 if (auth_xform->auth.iv.length != ZUC_IV_KEY_LENGTH) {
 113                         ZUC_LOG(ERR, "Wrong IV length");
 114                         return -EINVAL;
 115                 }
 116                 sess->auth_iv_offset = auth_xform->auth.iv.offset;
 117
 118                 /* Copy the key */
 119                 memcpy(sess->pKey_hash, auth_xform->auth.key.data,
 120                                 ZUC_IV_KEY_LENGTH);
 121         }
 122
 123
 124         sess->op = mode;
 125
 126         return 0;
 127 }
 128
 129 /** Get ZUC session. */
 130 static struct zuc_session *
 131 zuc_get_session(struct zuc_qp *qp, struct rte_crypto_op *op)
 132 {
 133         struct zuc_session *sess = NULL;
 134
 135         if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
 136                 if (likely(op->sym->session != NULL))
 137                         sess = (struct zuc_session *)get_sym_session_private_data(
 138                                         op->sym->session,
 139                                         cryptodev_driver_id);
 140         } else {
 141                 void *_sess = NULL;
 142                 void *_sess_private_data = NULL;
 143
 144                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
 145                         return NULL;
 146
 147                 if (rte_mempool_get(qp->sess_mp_priv,
 148                                 (void **)&_sess_private_data))
 149                         return NULL;
 150
 151                 sess = (struct zuc_session *)_sess_private_data;
 152
 153                 if (unlikely(zuc_set_session_parameters(sess,
 154                                 op->sym->xform) != 0)) {
 155                         rte_mempool_put(qp->sess_mp, _sess);
 156                         rte_mempool_put(qp->sess_mp_priv, _sess_private_data);
 157                         sess = NULL;
 158                 }
 159                 op->sym->session = (struct rte_cryptodev_sym_session *)_sess;
 160                 set_sym_session_private_data(op->sym->session,
 161                                 cryptodev_driver_id, _sess_private_data);
 162         }
 163
 164         if (unlikely(sess == NULL))
 165                 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
 166
 167
 168         return sess;
 169 }
 170
 171 /** Encrypt/decrypt mbufs. */
 172 static uint8_t
 173 process_zuc_cipher_op(struct zuc_qp *qp, struct rte_crypto_op **ops,
 174                 struct zuc_session **sessions,
 175                 uint8_t num_ops)
 176 {
 177         unsigned i;
 178         uint8_t processed_ops = 0;
 179         const void *src[ZUC_MAX_BURST];
 180         void *dst[ZUC_MAX_BURST];
 181         const void *iv[ZUC_MAX_BURST];
 182         uint32_t num_bytes[ZUC_MAX_BURST];
 183         const void *cipher_keys[ZUC_MAX_BURST];
 184         struct zuc_session *sess;
 185
 186         for (i = 0; i < num_ops; i++) {
 187                 if (((ops[i]->sym->cipher.data.length % BYTE_LEN) != 0)
 188                                 || ((ops[i]->sym->cipher.data.offset
 189                                         % BYTE_LEN) != 0)) {
 190                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
 191                         ZUC_LOG(ERR, "Data Length or offset");
 192                         break;
 193                 }
 194
 195                 sess = sessions[i];
 196
 197 #ifdef RTE_LIBRTE_PMD_ZUC_DEBUG
 198                 if (!rte_pktmbuf_is_contiguous(ops[i]->sym->m_src) ||
 199                                 (ops[i]->sym->m_dst != NULL &&
 200                                 !rte_pktmbuf_is_contiguous(
 201                                                 ops[i]->sym->m_dst))) {
 202                         ZUC_LOG(ERR, "PMD supports only contiguous mbufs, "
 203                                 "op (%p) provides noncontiguous mbuf as "
 204                                 "source/destination buffer.\n", ops[i]);
 205                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
 206                         break;
 207                 }
 208 #endif
 209
 210                 src[i] = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
 211                                 (ops[i]->sym->cipher.data.offset >> 3);
 212                 dst[i] = ops[i]->sym->m_dst ?
 213                         rte_pktmbuf_mtod(ops[i]->sym->m_dst, uint8_t *) +
 214                                 (ops[i]->sym->cipher.data.offset >> 3) :
 215                         rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
 216                                 (ops[i]->sym->cipher.data.offset >> 3);
 217                 iv[i] = rte_crypto_op_ctod_offset(ops[i], uint8_t *,
 218                                 sess->cipher_iv_offset);
 219                 num_bytes[i] = ops[i]->sym->cipher.data.length >> 3;
 220
 221                 cipher_keys[i] = sess->pKey_cipher;
 222
 223                 processed_ops++;
 224         }
 225
 226         IMB_ZUC_EEA3_N_BUFFER(qp->mb_mgr, (const void **)cipher_keys,
 227                         (const void **)iv, (const void **)src, (void **)dst,
 228                         num_bytes, processed_ops);
 229
 230         return processed_ops;
 231 }
 232
 233 /** Generate/verify hash from mbufs. */
 234 static int
 235 process_zuc_hash_op(struct zuc_qp *qp, struct rte_crypto_op **ops,
 236                 struct zuc_session **sessions,
 237                 uint8_t num_ops)
 238 {
 239         unsigned i;
 240         uint8_t processed_ops = 0;
 241         uint8_t *src;
 242         uint32_t *dst;
 243         uint32_t length_in_bits;
 244         uint8_t *iv;
 245         struct zuc_session *sess;
 246
 247         for (i = 0; i < num_ops; i++) {
 248                 /* Data must be byte aligned */
 249                 if ((ops[i]->sym->auth.data.offset % BYTE_LEN) != 0) {
 250                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
 251                         ZUC_LOG(ERR, "Offset");
 252                         break;
 253                 }
 254
 255                 sess = sessions[i];
 256
 257                 length_in_bits = ops[i]->sym->auth.data.length;
 258
 259                 src = rte_pktmbuf_mtod(ops[i]->sym->m_src, uint8_t *) +
 260                                 (ops[i]->sym->auth.data.offset >> 3);
 261                 iv = rte_crypto_op_ctod_offset(ops[i], uint8_t *,
 262                                 sess->auth_iv_offset);
 263
 264                 if (sess->auth_op == RTE_CRYPTO_AUTH_OP_VERIFY) {
 265                         dst = (uint32_t *)qp->temp_digest;
 266
 267                         IMB_ZUC_EIA3_1_BUFFER(qp->mb_mgr, sess->pKey_hash,
 268                                         iv, src,
 269                                         length_in_bits, dst);
 270                         /* Verify digest. */
 271                         if (memcmp(dst, ops[i]->sym->auth.digest.data,
 272                                         ZUC_DIGEST_LENGTH) != 0)
 273                                 ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
 274                 } else  {
 275                         dst = (uint32_t *)ops[i]->sym->auth.digest.data;
 276
 277                         IMB_ZUC_EIA3_1_BUFFER(qp->mb_mgr, sess->pKey_hash,
 278                                         iv, src,
 279                                         length_in_bits, dst);
 280                 }
 281                 processed_ops++;
 282         }
 283
 284         return processed_ops;
 285 }
 286
 287 /** Process a batch of crypto ops which shares the same operation type. */
 288 static int
 289 process_ops(struct rte_crypto_op **ops, enum zuc_operation op_type,
 290                 struct zuc_session **sessions,
 291                 struct zuc_qp *qp, uint8_t num_ops,
 292                 uint16_t *accumulated_enqueued_ops)
 293 {
 294         unsigned i;
 295         unsigned enqueued_ops, processed_ops;
 296
 297         switch (op_type) {
 298         case ZUC_OP_ONLY_CIPHER:
 299                 processed_ops = process_zuc_cipher_op(qp, ops,
 300                                 sessions, num_ops);
 301                 break;
 302         case ZUC_OP_ONLY_AUTH:
 303                 processed_ops = process_zuc_hash_op(qp, ops, sessions,
 304                                 num_ops);
 305                 break;
 306         case ZUC_OP_CIPHER_AUTH:
 307                 processed_ops = process_zuc_cipher_op(qp, ops, sessions,
 308                                 num_ops);
 309                 process_zuc_hash_op(qp, ops, sessions, processed_ops);
 310                 break;
 311         case ZUC_OP_AUTH_CIPHER:
 312                 processed_ops = process_zuc_hash_op(qp, ops, sessions,
 313                                 num_ops);
 314                 process_zuc_cipher_op(qp, ops, sessions, processed_ops);
 315                 break;
 316         default:
 317                 /* Operation not supported. */
 318                 processed_ops = 0;
 319         }
 320
 321         for (i = 0; i < num_ops; i++) {
 322                 /*
 323                  * If there was no error/authentication failure,
 324                  * change status to successful.
 325                  */
 326                 if (ops[i]->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
 327                         ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
 328                 /* Free session if a session-less crypto op. */
 329                 if (ops[i]->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
 330                         memset(sessions[i], 0, sizeof(struct zuc_session));
 331                         memset(ops[i]->sym->session, 0,
 332                         rte_cryptodev_sym_get_existing_header_session_size(
 333                                         ops[i]->sym->session));
 334                         rte_mempool_put(qp->sess_mp_priv, sessions[i]);
 335                         rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
 336                         ops[i]->sym->session = NULL;
 337                 }
 338         }
 339
 340         enqueued_ops = rte_ring_enqueue_burst(qp->processed_ops,
 341                         (void **)ops, processed_ops, NULL);
 342         qp->qp_stats.enqueued_count += enqueued_ops;
 343         *accumulated_enqueued_ops += enqueued_ops;
 344
 345         return enqueued_ops;
 346 }
 347
 348 static uint16_t
 349 zuc_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
 350                 uint16_t nb_ops)
 351 {
 352         struct rte_crypto_op *c_ops[ZUC_MAX_BURST];
 353         struct rte_crypto_op *curr_c_op;
 354
 355         struct zuc_session *curr_sess;
 356         struct zuc_session *sessions[ZUC_MAX_BURST];
 357         enum zuc_operation prev_zuc_op = ZUC_OP_NOT_SUPPORTED;
 358         enum zuc_operation curr_zuc_op;
 359         struct zuc_qp *qp = queue_pair;
 360         unsigned i;
 361         uint8_t burst_size = 0;
 362         uint16_t enqueued_ops = 0;
 363         uint8_t processed_ops;
 364
 365         for (i = 0; i < nb_ops; i++) {
 366                 curr_c_op = ops[i];
 367
 368                 curr_sess = zuc_get_session(qp, curr_c_op);
 369                 if (unlikely(curr_sess == NULL)) {
 370                         curr_c_op->status =
 371                                         RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
 372                         break;
 373                 }
 374
 375                 curr_zuc_op = curr_sess->op;
 376
 377                 /*
 378                  * Batch ops that share the same operation type
 379                  * (cipher only, auth only...).
 380                  */
 381                 if (burst_size == 0) {
 382                         prev_zuc_op = curr_zuc_op;
 383                         c_ops[0] = curr_c_op;
 384                         sessions[0] = curr_sess;
 385                         burst_size++;
 386                 } else if (curr_zuc_op == prev_zuc_op) {
 387                         c_ops[burst_size] = curr_c_op;
 388                         sessions[burst_size] = curr_sess;
 389                         burst_size++;
 390                         /*
 391                          * When there are enough ops to process in a batch,
 392                          * process them, and start a new batch.
 393                          */
 394                         if (burst_size == ZUC_MAX_BURST) {
 395                                 processed_ops = process_ops(c_ops, curr_zuc_op,
 396                                                 sessions, qp, burst_size,
 397                                                 &enqueued_ops);
 398                                 if (processed_ops < burst_size) {
 399                                         burst_size = 0;
 400                                         break;
 401                                 }
 402
 403                                 burst_size = 0;
 404                         }
 405                 } else {
 406                         /*
 407                          * Different operation type, process the ops
 408                          * of the previous type.
 409                          */
 410                         processed_ops = process_ops(c_ops, prev_zuc_op,
 411                                         sessions, qp, burst_size,
 412                                         &enqueued_ops);
 413                         if (processed_ops < burst_size) {
 414                                 burst_size = 0;
 415                                 break;
 416                         }
 417
 418                         burst_size = 0;
 419                         prev_zuc_op = curr_zuc_op;
 420
 421                         c_ops[0] = curr_c_op;
 422                         sessions[0] = curr_sess;
 423                         burst_size++;
 424                 }
 425         }
 426
 427         if (burst_size != 0) {
 428                 /* Process the crypto ops of the last operation type. */
 429                 processed_ops = process_ops(c_ops, prev_zuc_op,
 430                                 sessions, qp, burst_size,
 431                                 &enqueued_ops);
 432         }
 433
 434         qp->qp_stats.enqueue_err_count += nb_ops - enqueued_ops;
 435         return enqueued_ops;
 436 }
 437
 438 static uint16_t
 439 zuc_pmd_dequeue_burst(void *queue_pair,
 440                 struct rte_crypto_op **c_ops, uint16_t nb_ops)
 441 {
 442         struct zuc_qp *qp = queue_pair;
 443
 444         unsigned nb_dequeued;
 445
 446         nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
 447                         (void **)c_ops, nb_ops, NULL);
 448         qp->qp_stats.dequeued_count += nb_dequeued;
 449
 450         return nb_dequeued;
 451 }
 452
 453 static int cryptodev_zuc_remove(struct rte_vdev_device *vdev);
 454
 455 static int
 456 cryptodev_zuc_create(const char *name,
 457                 struct rte_vdev_device *vdev,
 458                 struct rte_cryptodev_pmd_init_params *init_params)
 459 {
 460         struct rte_cryptodev *dev;
 461         struct zuc_private *internals;
 462         MB_MGR *mb_mgr;
 463
 464         dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
 465         if (dev == NULL) {
 466                 ZUC_LOG(ERR, "failed to create cryptodev vdev");
 467                 goto init_error;
 468         }
 469
 470         dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
 471                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING;
 472
 473         mb_mgr = alloc_mb_mgr(0);
 474         if (mb_mgr == NULL)
 475                 return -ENOMEM;
 476
 477         if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX512F)) {
 478                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX512;
 479                 init_mb_mgr_avx512(mb_mgr);
 480         } else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2)) {
 481                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
 482                 init_mb_mgr_avx2(mb_mgr);
 483         } else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX)) {
 484                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
 485                 init_mb_mgr_avx(mb_mgr);
 486         } else {
 487                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
 488                 init_mb_mgr_sse(mb_mgr);
 489         }
 490
 491         dev->driver_id = cryptodev_driver_id;
 492         dev->dev_ops = rte_zuc_pmd_ops;
 493
 494         /* Register RX/TX burst functions for data path. */
 495         dev->dequeue_burst = zuc_pmd_dequeue_burst;
 496         dev->enqueue_burst = zuc_pmd_enqueue_burst;
 497
 498         internals = dev->data->dev_private;
 499         internals->mb_mgr = mb_mgr;
 500
 501         internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
 502
 503         return 0;
 504 init_error:
 505         ZUC_LOG(ERR, "driver %s: failed",
 506                         init_params->name);
 507
 508         cryptodev_zuc_remove(vdev);
 509         return -EFAULT;
 510 }
 511
 512 static int
 513 cryptodev_zuc_probe(struct rte_vdev_device *vdev)
 514 {
 515         struct rte_cryptodev_pmd_init_params init_params = {
 516                 "",
 517                 sizeof(struct zuc_private),
 518                 rte_socket_id(),
 519                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
 520         };
 521         const char *name;
 522         const char *input_args;
 523
 524         name = rte_vdev_device_name(vdev);
 525         if (name == NULL)
 526                 return -EINVAL;
 527         input_args = rte_vdev_device_args(vdev);
 528
 529         rte_cryptodev_pmd_parse_input_args(&init_params, input_args);
 530
 531         return cryptodev_zuc_create(name, vdev, &init_params);
 532 }
 533
 534 static int
 535 cryptodev_zuc_remove(struct rte_vdev_device *vdev)
 536 {
 537
 538         struct rte_cryptodev *cryptodev;
 539         const char *name;
 540         struct zuc_private *internals;
 541
 542         name = rte_vdev_device_name(vdev);
 543         if (name == NULL)
 544                 return -EINVAL;
 545
 546         cryptodev = rte_cryptodev_pmd_get_named_dev(name);
 547         if (cryptodev == NULL)
 548                 return -ENODEV;
 549
 550         internals = cryptodev->data->dev_private;
 551
 552         free_mb_mgr(internals->mb_mgr);
 553
 554         return rte_cryptodev_pmd_destroy(cryptodev);
 555 }
 556
 557 static struct rte_vdev_driver cryptodev_zuc_pmd_drv = {
 558         .probe = cryptodev_zuc_probe,
 559         .remove = cryptodev_zuc_remove
 560 };
 561
 562 static struct cryptodev_driver zuc_crypto_drv;
 563
 564 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_ZUC_PMD, cryptodev_zuc_pmd_drv);
 565 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_ZUC_PMD,
 566         "max_nb_queue_pairs=<int> "
 567         "socket_id=<int>");
 568 RTE_PMD_REGISTER_CRYPTO_DRIVER(zuc_crypto_drv, cryptodev_zuc_pmd_drv.driver,
 569                 cryptodev_driver_id);
 570
 571 RTE_INIT(zuc_init_log)
 572 {
 573         zuc_logtype_driver = rte_log_register("pmd.crypto.zuc");
 574 }