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