1 /*- 2 * BSD LICENSE 3 * 4 * Copyright(c) 2016 Intel Corporation. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * * Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in 14 * the documentation and/or other materials provided with the 15 * distribution. 16 * * Neither the name of Intel Corporation nor the names of its 17 * contributors may be used to endorse or promote products derived 18 * from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #include <string.h> 34 35 #include <rte_common.h> 36 #include <rte_malloc.h> 37 #include <rte_cryptodev_pmd.h> 38 39 #include "rte_openssl_pmd_private.h" 40 41 42 static const struct rte_cryptodev_capabilities openssl_pmd_capabilities[] = { 43 { /* MD5 HMAC */ 44 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 45 {.sym = { 46 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 47 {.auth = { 48 .algo = RTE_CRYPTO_AUTH_MD5_HMAC, 49 .block_size = 64, 50 .key_size = { 51 .min = 64, 52 .max = 64, 53 .increment = 0 54 }, 55 .digest_size = { 56 .min = 16, 57 .max = 16, 58 .increment = 0 59 }, 60 .aad_size = { 0 } 61 }, } 62 }, } 63 }, 64 { /* MD5 */ 65 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 66 {.sym = { 67 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 68 {.auth = { 69 .algo = RTE_CRYPTO_AUTH_MD5, 70 .block_size = 64, 71 .key_size = { 72 .min = 0, 73 .max = 0, 74 .increment = 0 75 }, 76 .digest_size = { 77 .min = 16, 78 .max = 16, 79 .increment = 0 80 }, 81 .aad_size = { 0 } 82 }, } 83 }, } 84 }, 85 { /* SHA1 HMAC */ 86 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 87 {.sym = { 88 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 89 {.auth = { 90 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC, 91 .block_size = 64, 92 .key_size = { 93 .min = 64, 94 .max = 64, 95 .increment = 0 96 }, 97 .digest_size = { 98 .min = 20, 99 .max = 20, 100 .increment = 0 101 }, 102 .aad_size = { 0 } 103 }, } 104 }, } 105 }, 106 { /* SHA1 */ 107 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 108 {.sym = { 109 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 110 {.auth = { 111 .algo = RTE_CRYPTO_AUTH_SHA1, 112 .block_size = 64, 113 .key_size = { 114 .min = 0, 115 .max = 0, 116 .increment = 0 117 }, 118 .digest_size = { 119 .min = 20, 120 .max = 20, 121 .increment = 0 122 }, 123 .aad_size = { 0 } 124 }, } 125 }, } 126 }, 127 { /* SHA224 HMAC */ 128 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 129 {.sym = { 130 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 131 {.auth = { 132 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC, 133 .block_size = 64, 134 .key_size = { 135 .min = 64, 136 .max = 64, 137 .increment = 0 138 }, 139 .digest_size = { 140 .min = 28, 141 .max = 28, 142 .increment = 0 143 }, 144 .aad_size = { 0 } 145 }, } 146 }, } 147 }, 148 { /* SHA224 */ 149 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 150 {.sym = { 151 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 152 {.auth = { 153 .algo = RTE_CRYPTO_AUTH_SHA224, 154 .block_size = 64, 155 .key_size = { 156 .min = 0, 157 .max = 0, 158 .increment = 0 159 }, 160 .digest_size = { 161 .min = 28, 162 .max = 28, 163 .increment = 0 164 }, 165 .aad_size = { 0 } 166 }, } 167 }, } 168 }, 169 { /* SHA256 HMAC */ 170 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 171 {.sym = { 172 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 173 {.auth = { 174 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC, 175 .block_size = 64, 176 .key_size = { 177 .min = 64, 178 .max = 64, 179 .increment = 0 180 }, 181 .digest_size = { 182 .min = 32, 183 .max = 32, 184 .increment = 0 185 }, 186 .aad_size = { 0 } 187 }, } 188 }, } 189 }, 190 { /* SHA256 */ 191 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 192 {.sym = { 193 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 194 {.auth = { 195 .algo = RTE_CRYPTO_AUTH_SHA256, 196 .block_size = 64, 197 .key_size = { 198 .min = 0, 199 .max = 0, 200 .increment = 0 201 }, 202 .digest_size = { 203 .min = 32, 204 .max = 32, 205 .increment = 0 206 }, 207 .aad_size = { 0 } 208 }, } 209 }, } 210 }, 211 { /* SHA384 HMAC */ 212 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 213 {.sym = { 214 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 215 {.auth = { 216 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC, 217 .block_size = 128, 218 .key_size = { 219 .min = 128, 220 .max = 128, 221 .increment = 0 222 }, 223 .digest_size = { 224 .min = 48, 225 .max = 48, 226 .increment = 0 227 }, 228 .aad_size = { 0 } 229 }, } 230 }, } 231 }, 232 { /* SHA384 */ 233 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 234 {.sym = { 235 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 236 {.auth = { 237 .algo = RTE_CRYPTO_AUTH_SHA384, 238 .block_size = 128, 239 .key_size = { 240 .min = 0, 241 .max = 0, 242 .increment = 0 243 }, 244 .digest_size = { 245 .min = 48, 246 .max = 48, 247 .increment = 0 248 }, 249 .aad_size = { 0 } 250 }, } 251 }, } 252 }, 253 { /* SHA512 HMAC */ 254 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 255 {.sym = { 256 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 257 {.auth = { 258 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC, 259 .block_size = 128, 260 .key_size = { 261 .min = 128, 262 .max = 128, 263 .increment = 0 264 }, 265 .digest_size = { 266 .min = 64, 267 .max = 64, 268 .increment = 0 269 }, 270 .aad_size = { 0 } 271 }, } 272 }, } 273 }, 274 { /* SHA512 */ 275 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 276 {.sym = { 277 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 278 {.auth = { 279 .algo = RTE_CRYPTO_AUTH_SHA512, 280 .block_size = 128, 281 .key_size = { 282 .min = 0, 283 .max = 0, 284 .increment = 0 285 }, 286 .digest_size = { 287 .min = 64, 288 .max = 64, 289 .increment = 0 290 }, 291 .aad_size = { 0 } 292 }, } 293 }, } 294 }, 295 { /* AES CBC */ 296 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 297 {.sym = { 298 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER, 299 {.cipher = { 300 .algo = RTE_CRYPTO_CIPHER_AES_CBC, 301 .block_size = 16, 302 .key_size = { 303 .min = 16, 304 .max = 32, 305 .increment = 8 306 }, 307 .iv_size = { 308 .min = 16, 309 .max = 16, 310 .increment = 0 311 } 312 }, } 313 }, } 314 }, 315 { /* AES CTR */ 316 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 317 {.sym = { 318 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER, 319 {.cipher = { 320 .algo = RTE_CRYPTO_CIPHER_AES_CTR, 321 .block_size = 16, 322 .key_size = { 323 .min = 16, 324 .max = 32, 325 .increment = 8 326 }, 327 .iv_size = { 328 .min = 16, 329 .max = 16, 330 .increment = 0 331 } 332 }, } 333 }, } 334 }, 335 { /* AES GCM (AUTH) */ 336 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 337 {.sym = { 338 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 339 {.auth = { 340 .algo = RTE_CRYPTO_AUTH_AES_GCM, 341 .block_size = 16, 342 .key_size = { 343 .min = 16, 344 .max = 32, 345 .increment = 8 346 }, 347 .digest_size = { 348 .min = 16, 349 .max = 16, 350 .increment = 0 351 }, 352 .aad_size = { 353 .min = 0, 354 .max = 65535, 355 .increment = 1 356 } 357 }, } 358 }, } 359 }, 360 { /* AES GCM (CIPHER) */ 361 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 362 {.sym = { 363 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER, 364 {.cipher = { 365 .algo = RTE_CRYPTO_CIPHER_AES_GCM, 366 .block_size = 16, 367 .key_size = { 368 .min = 16, 369 .max = 32, 370 .increment = 8 371 }, 372 .iv_size = { 373 .min = 12, 374 .max = 16, 375 .increment = 4 376 } 377 }, } 378 }, } 379 }, 380 { /* AES GMAC (AUTH) */ 381 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 382 {.sym = { 383 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH, 384 {.auth = { 385 .algo = RTE_CRYPTO_AUTH_AES_GMAC, 386 .block_size = 16, 387 .key_size = { 388 .min = 16, 389 .max = 32, 390 .increment = 8 391 }, 392 .digest_size = { 393 .min = 16, 394 .max = 16, 395 .increment = 0 396 }, 397 .aad_size = { 398 .min = 8, 399 .max = 65532, 400 .increment = 4 401 } 402 }, } 403 }, } 404 }, 405 { /* 3DES CBC */ 406 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 407 {.sym = { 408 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER, 409 {.cipher = { 410 .algo = RTE_CRYPTO_CIPHER_3DES_CBC, 411 .block_size = 8, 412 .key_size = { 413 .min = 16, 414 .max = 24, 415 .increment = 8 416 }, 417 .iv_size = { 418 .min = 8, 419 .max = 8, 420 .increment = 0 421 } 422 }, } 423 }, } 424 }, 425 { /* 3DES CTR */ 426 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 427 {.sym = { 428 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER, 429 {.cipher = { 430 .algo = RTE_CRYPTO_CIPHER_3DES_CTR, 431 .block_size = 8, 432 .key_size = { 433 .min = 16, 434 .max = 24, 435 .increment = 8 436 }, 437 .iv_size = { 438 .min = 8, 439 .max = 8, 440 .increment = 0 441 } 442 }, } 443 }, } 444 }, 445 { /* DES DOCSIS BPI */ 446 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC, 447 {.sym = { 448 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER, 449 {.cipher = { 450 .algo = RTE_CRYPTO_CIPHER_DES_DOCSISBPI, 451 .block_size = 8, 452 .key_size = { 453 .min = 8, 454 .max = 8, 455 .increment = 0 456 }, 457 .iv_size = { 458 .min = 8, 459 .max = 8, 460 .increment = 0 461 } 462 }, } 463 }, } 464 }, 465 466 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() 467 }; 468 469 470 /** Configure device */ 471 static int 472 openssl_pmd_config(__rte_unused struct rte_cryptodev *dev, 473 __rte_unused struct rte_cryptodev_config *config) 474 { 475 return 0; 476 } 477 478 /** Start device */ 479 static int 480 openssl_pmd_start(__rte_unused struct rte_cryptodev *dev) 481 { 482 return 0; 483 } 484 485 /** Stop device */ 486 static void 487 openssl_pmd_stop(__rte_unused struct rte_cryptodev *dev) 488 { 489 } 490 491 /** Close device */ 492 static int 493 openssl_pmd_close(__rte_unused struct rte_cryptodev *dev) 494 { 495 return 0; 496 } 497 498 499 /** Get device statistics */ 500 static void 501 openssl_pmd_stats_get(struct rte_cryptodev *dev, 502 struct rte_cryptodev_stats *stats) 503 { 504 int qp_id; 505 506 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) { 507 struct openssl_qp *qp = dev->data->queue_pairs[qp_id]; 508 509 stats->enqueued_count += qp->stats.enqueued_count; 510 stats->dequeued_count += qp->stats.dequeued_count; 511 512 stats->enqueue_err_count += qp->stats.enqueue_err_count; 513 stats->dequeue_err_count += qp->stats.dequeue_err_count; 514 } 515 } 516 517 /** Reset device statistics */ 518 static void 519 openssl_pmd_stats_reset(struct rte_cryptodev *dev) 520 { 521 int qp_id; 522 523 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) { 524 struct openssl_qp *qp = dev->data->queue_pairs[qp_id]; 525 526 memset(&qp->stats, 0, sizeof(qp->stats)); 527 } 528 } 529 530 531 /** Get device info */ 532 static void 533 openssl_pmd_info_get(struct rte_cryptodev *dev, 534 struct rte_cryptodev_info *dev_info) 535 { 536 struct openssl_private *internals = dev->data->dev_private; 537 538 if (dev_info != NULL) { 539 dev_info->dev_type = dev->dev_type; 540 dev_info->feature_flags = dev->feature_flags; 541 dev_info->capabilities = openssl_pmd_capabilities; 542 dev_info->max_nb_queue_pairs = internals->max_nb_qpairs; 543 dev_info->sym.max_nb_sessions = internals->max_nb_sessions; 544 } 545 } 546 547 /** Release queue pair */ 548 static int 549 openssl_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id) 550 { 551 if (dev->data->queue_pairs[qp_id] != NULL) { 552 rte_free(dev->data->queue_pairs[qp_id]); 553 dev->data->queue_pairs[qp_id] = NULL; 554 } 555 return 0; 556 } 557 558 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */ 559 static int 560 openssl_pmd_qp_set_unique_name(struct rte_cryptodev *dev, 561 struct openssl_qp *qp) 562 { 563 unsigned int n = snprintf(qp->name, sizeof(qp->name), 564 "openssl_pmd_%u_qp_%u", 565 dev->data->dev_id, qp->id); 566 567 if (n > sizeof(qp->name)) 568 return -1; 569 570 return 0; 571 } 572 573 574 /** Create a ring to place processed operations on */ 575 static struct rte_ring * 576 openssl_pmd_qp_create_processed_ops_ring(struct openssl_qp *qp, 577 unsigned int ring_size, int socket_id) 578 { 579 struct rte_ring *r; 580 581 r = rte_ring_lookup(qp->name); 582 if (r) { 583 if (rte_ring_get_size(r) >= ring_size) { 584 OPENSSL_LOG_INFO( 585 "Reusing existing ring %s for processed ops", 586 qp->name); 587 return r; 588 } 589 590 OPENSSL_LOG_ERR( 591 "Unable to reuse existing ring %s for processed ops", 592 qp->name); 593 return NULL; 594 } 595 596 return rte_ring_create(qp->name, ring_size, socket_id, 597 RING_F_SP_ENQ | RING_F_SC_DEQ); 598 } 599 600 601 /** Setup a queue pair */ 602 static int 603 openssl_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id, 604 const struct rte_cryptodev_qp_conf *qp_conf, 605 int socket_id) 606 { 607 struct openssl_qp *qp = NULL; 608 609 /* Free memory prior to re-allocation if needed. */ 610 if (dev->data->queue_pairs[qp_id] != NULL) 611 openssl_pmd_qp_release(dev, qp_id); 612 613 /* Allocate the queue pair data structure. */ 614 qp = rte_zmalloc_socket("OPENSSL PMD Queue Pair", sizeof(*qp), 615 RTE_CACHE_LINE_SIZE, socket_id); 616 if (qp == NULL) 617 return -ENOMEM; 618 619 qp->id = qp_id; 620 dev->data->queue_pairs[qp_id] = qp; 621 622 if (openssl_pmd_qp_set_unique_name(dev, qp)) 623 goto qp_setup_cleanup; 624 625 qp->processed_ops = openssl_pmd_qp_create_processed_ops_ring(qp, 626 qp_conf->nb_descriptors, socket_id); 627 if (qp->processed_ops == NULL) 628 goto qp_setup_cleanup; 629 630 qp->sess_mp = dev->data->session_pool; 631 632 memset(&qp->stats, 0, sizeof(qp->stats)); 633 634 return 0; 635 636 qp_setup_cleanup: 637 if (qp) 638 rte_free(qp); 639 640 return -1; 641 } 642 643 /** Start queue pair */ 644 static int 645 openssl_pmd_qp_start(__rte_unused struct rte_cryptodev *dev, 646 __rte_unused uint16_t queue_pair_id) 647 { 648 return -ENOTSUP; 649 } 650 651 /** Stop queue pair */ 652 static int 653 openssl_pmd_qp_stop(__rte_unused struct rte_cryptodev *dev, 654 __rte_unused uint16_t queue_pair_id) 655 { 656 return -ENOTSUP; 657 } 658 659 /** Return the number of allocated queue pairs */ 660 static uint32_t 661 openssl_pmd_qp_count(struct rte_cryptodev *dev) 662 { 663 return dev->data->nb_queue_pairs; 664 } 665 666 /** Returns the size of the session structure */ 667 static unsigned 668 openssl_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused) 669 { 670 return sizeof(struct openssl_session); 671 } 672 673 /** Configure the session from a crypto xform chain */ 674 static void * 675 openssl_pmd_session_configure(struct rte_cryptodev *dev __rte_unused, 676 struct rte_crypto_sym_xform *xform, void *sess) 677 { 678 if (unlikely(sess == NULL)) { 679 OPENSSL_LOG_ERR("invalid session struct"); 680 return NULL; 681 } 682 683 if (openssl_set_session_parameters( 684 sess, xform) != 0) { 685 OPENSSL_LOG_ERR("failed configure session parameters"); 686 return NULL; 687 } 688 689 return sess; 690 } 691 692 693 /** Clear the memory of session so it doesn't leave key material behind */ 694 static void 695 openssl_pmd_session_clear(struct rte_cryptodev *dev __rte_unused, void *sess) 696 { 697 /* 698 * Current just resetting the whole data structure, need to investigate 699 * whether a more selective reset of key would be more performant 700 */ 701 if (sess) { 702 openssl_reset_session(sess); 703 memset(sess, 0, sizeof(struct openssl_session)); 704 } 705 } 706 707 struct rte_cryptodev_ops openssl_pmd_ops = { 708 .dev_configure = openssl_pmd_config, 709 .dev_start = openssl_pmd_start, 710 .dev_stop = openssl_pmd_stop, 711 .dev_close = openssl_pmd_close, 712 713 .stats_get = openssl_pmd_stats_get, 714 .stats_reset = openssl_pmd_stats_reset, 715 716 .dev_infos_get = openssl_pmd_info_get, 717 718 .queue_pair_setup = openssl_pmd_qp_setup, 719 .queue_pair_release = openssl_pmd_qp_release, 720 .queue_pair_start = openssl_pmd_qp_start, 721 .queue_pair_stop = openssl_pmd_qp_stop, 722 .queue_pair_count = openssl_pmd_qp_count, 723 724 .session_get_size = openssl_pmd_session_get_size, 725 .session_configure = openssl_pmd_session_configure, 726 .session_clear = openssl_pmd_session_clear 727 }; 728 729 struct rte_cryptodev_ops *rte_openssl_pmd_ops = &openssl_pmd_ops; 730