1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2020 Intel Corporation
15 #include <netinet/in.h>
17 #include <rte_byteorder.h>
19 #include <rte_debug.h>
21 #include <rte_interrupts.h>
22 #include <rte_memory.h>
23 #include <rte_memcpy.h>
24 #include <rte_memzone.h>
25 #include <rte_launch.h>
26 #include <rte_tailq.h>
28 #include <rte_per_lcore.h>
29 #include <rte_lcore.h>
30 #include <rte_atomic.h>
31 #include <rte_branch_prediction.h>
32 #include <rte_common.h>
33 #include <rte_mempool.h>
34 #include <rte_malloc.h>
36 #include <rte_errno.h>
37 #include <rte_spinlock.h>
38 #include <rte_string_fns.h>
40 #include "rte_crypto.h"
41 #include "rte_cryptodev.h"
42 #include "rte_cryptodev_pmd.h"
43 #include "rte_cryptodev_trace.h"
45 static uint8_t nb_drivers;
47 static struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
49 struct rte_cryptodev *rte_cryptodevs = rte_crypto_devices;
51 static struct rte_cryptodev_global cryptodev_globals = {
52 .devs = rte_crypto_devices,
57 /* spinlock for crypto device callbacks */
58 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
61 * The user application callback description.
63 * It contains callback address to be registered by user application,
64 * the pointer to the parameters for callback, and the event type.
66 struct rte_cryptodev_callback {
67 TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
68 rte_cryptodev_cb_fn cb_fn; /**< Callback address */
69 void *cb_arg; /**< Parameter for callback */
70 enum rte_cryptodev_event_type event; /**< Interrupt event type */
71 uint32_t active; /**< Callback is executing */
75 * The crypto cipher algorithm strings identifiers.
76 * It could be used in application command line.
79 rte_crypto_cipher_algorithm_strings[] = {
80 [RTE_CRYPTO_CIPHER_3DES_CBC] = "3des-cbc",
81 [RTE_CRYPTO_CIPHER_3DES_ECB] = "3des-ecb",
82 [RTE_CRYPTO_CIPHER_3DES_CTR] = "3des-ctr",
84 [RTE_CRYPTO_CIPHER_AES_CBC] = "aes-cbc",
85 [RTE_CRYPTO_CIPHER_AES_CTR] = "aes-ctr",
86 [RTE_CRYPTO_CIPHER_AES_DOCSISBPI] = "aes-docsisbpi",
87 [RTE_CRYPTO_CIPHER_AES_ECB] = "aes-ecb",
88 [RTE_CRYPTO_CIPHER_AES_F8] = "aes-f8",
89 [RTE_CRYPTO_CIPHER_AES_XTS] = "aes-xts",
91 [RTE_CRYPTO_CIPHER_ARC4] = "arc4",
93 [RTE_CRYPTO_CIPHER_DES_CBC] = "des-cbc",
94 [RTE_CRYPTO_CIPHER_DES_DOCSISBPI] = "des-docsisbpi",
96 [RTE_CRYPTO_CIPHER_NULL] = "null",
98 [RTE_CRYPTO_CIPHER_KASUMI_F8] = "kasumi-f8",
99 [RTE_CRYPTO_CIPHER_SNOW3G_UEA2] = "snow3g-uea2",
100 [RTE_CRYPTO_CIPHER_ZUC_EEA3] = "zuc-eea3"
104 * The crypto cipher operation strings identifiers.
105 * It could be used in application command line.
108 rte_crypto_cipher_operation_strings[] = {
109 [RTE_CRYPTO_CIPHER_OP_ENCRYPT] = "encrypt",
110 [RTE_CRYPTO_CIPHER_OP_DECRYPT] = "decrypt"
114 * The crypto auth algorithm strings identifiers.
115 * It could be used in application command line.
118 rte_crypto_auth_algorithm_strings[] = {
119 [RTE_CRYPTO_AUTH_AES_CBC_MAC] = "aes-cbc-mac",
120 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
121 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
122 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
124 [RTE_CRYPTO_AUTH_MD5] = "md5",
125 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
127 [RTE_CRYPTO_AUTH_NULL] = "null",
129 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
130 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
132 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
133 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
134 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
135 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
136 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
137 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
138 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
139 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
141 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
142 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
143 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
147 * The crypto AEAD algorithm strings identifiers.
148 * It could be used in application command line.
151 rte_crypto_aead_algorithm_strings[] = {
152 [RTE_CRYPTO_AEAD_AES_CCM] = "aes-ccm",
153 [RTE_CRYPTO_AEAD_AES_GCM] = "aes-gcm",
154 [RTE_CRYPTO_AEAD_CHACHA20_POLY1305] = "chacha20-poly1305"
158 * The crypto AEAD operation strings identifiers.
159 * It could be used in application command line.
162 rte_crypto_aead_operation_strings[] = {
163 [RTE_CRYPTO_AEAD_OP_ENCRYPT] = "encrypt",
164 [RTE_CRYPTO_AEAD_OP_DECRYPT] = "decrypt"
168 * Asymmetric crypto transform operation strings identifiers.
170 const char *rte_crypto_asym_xform_strings[] = {
171 [RTE_CRYPTO_ASYM_XFORM_NONE] = "none",
172 [RTE_CRYPTO_ASYM_XFORM_RSA] = "rsa",
173 [RTE_CRYPTO_ASYM_XFORM_MODEX] = "modexp",
174 [RTE_CRYPTO_ASYM_XFORM_MODINV] = "modinv",
175 [RTE_CRYPTO_ASYM_XFORM_DH] = "dh",
176 [RTE_CRYPTO_ASYM_XFORM_DSA] = "dsa",
177 [RTE_CRYPTO_ASYM_XFORM_ECDSA] = "ecdsa",
178 [RTE_CRYPTO_ASYM_XFORM_ECPM] = "ecpm",
182 * Asymmetric crypto operation strings identifiers.
184 const char *rte_crypto_asym_op_strings[] = {
185 [RTE_CRYPTO_ASYM_OP_ENCRYPT] = "encrypt",
186 [RTE_CRYPTO_ASYM_OP_DECRYPT] = "decrypt",
187 [RTE_CRYPTO_ASYM_OP_SIGN] = "sign",
188 [RTE_CRYPTO_ASYM_OP_VERIFY] = "verify",
189 [RTE_CRYPTO_ASYM_OP_PRIVATE_KEY_GENERATE] = "priv_key_generate",
190 [RTE_CRYPTO_ASYM_OP_PUBLIC_KEY_GENERATE] = "pub_key_generate",
191 [RTE_CRYPTO_ASYM_OP_SHARED_SECRET_COMPUTE] = "sharedsecret_compute",
195 * The private data structure stored in the session mempool private data.
197 struct rte_cryptodev_sym_session_pool_private_data {
199 /**< number of elements in sess_data array */
200 uint16_t user_data_sz;
201 /**< session user data will be placed after sess_data */
205 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
206 const char *algo_string)
210 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
211 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
212 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
222 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
223 const char *algo_string)
227 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
228 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
229 *algo_enum = (enum rte_crypto_auth_algorithm) i;
239 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
240 const char *algo_string)
244 for (i = 1; i < RTE_DIM(rte_crypto_aead_algorithm_strings); i++) {
245 if (strcmp(algo_string, rte_crypto_aead_algorithm_strings[i]) == 0) {
246 *algo_enum = (enum rte_crypto_aead_algorithm) i;
256 rte_cryptodev_asym_get_xform_enum(enum rte_crypto_asym_xform_type *xform_enum,
257 const char *xform_string)
261 for (i = 1; i < RTE_DIM(rte_crypto_asym_xform_strings); i++) {
262 if (strcmp(xform_string,
263 rte_crypto_asym_xform_strings[i]) == 0) {
264 *xform_enum = (enum rte_crypto_asym_xform_type) i;
274 * The crypto auth operation strings identifiers.
275 * It could be used in application command line.
278 rte_crypto_auth_operation_strings[] = {
279 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
280 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
283 const struct rte_cryptodev_symmetric_capability *
284 rte_cryptodev_sym_capability_get(uint8_t dev_id,
285 const struct rte_cryptodev_sym_capability_idx *idx)
287 const struct rte_cryptodev_capabilities *capability;
288 struct rte_cryptodev_info dev_info;
291 rte_cryptodev_info_get(dev_id, &dev_info);
293 while ((capability = &dev_info.capabilities[i++])->op !=
294 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
295 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
298 if (capability->sym.xform_type != idx->type)
301 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
302 capability->sym.auth.algo == idx->algo.auth)
303 return &capability->sym;
305 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
306 capability->sym.cipher.algo == idx->algo.cipher)
307 return &capability->sym;
309 if (idx->type == RTE_CRYPTO_SYM_XFORM_AEAD &&
310 capability->sym.aead.algo == idx->algo.aead)
311 return &capability->sym;
318 param_range_check(uint16_t size, const struct rte_crypto_param_range *range)
320 unsigned int next_size;
322 /* Check lower/upper bounds */
323 if (size < range->min)
326 if (size > range->max)
329 /* If range is actually only one value, size is correct */
330 if (range->increment == 0)
333 /* Check if value is one of the supported sizes */
334 for (next_size = range->min; next_size <= range->max;
335 next_size += range->increment)
336 if (size == next_size)
342 const struct rte_cryptodev_asymmetric_xform_capability *
343 rte_cryptodev_asym_capability_get(uint8_t dev_id,
344 const struct rte_cryptodev_asym_capability_idx *idx)
346 const struct rte_cryptodev_capabilities *capability;
347 struct rte_cryptodev_info dev_info;
350 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
351 rte_cryptodev_info_get(dev_id, &dev_info);
353 while ((capability = &dev_info.capabilities[i++])->op !=
354 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
355 if (capability->op != RTE_CRYPTO_OP_TYPE_ASYMMETRIC)
358 if (capability->asym.xform_capa.xform_type == idx->type)
359 return &capability->asym.xform_capa;
365 rte_cryptodev_sym_capability_check_cipher(
366 const struct rte_cryptodev_symmetric_capability *capability,
367 uint16_t key_size, uint16_t iv_size)
369 if (param_range_check(key_size, &capability->cipher.key_size) != 0)
372 if (param_range_check(iv_size, &capability->cipher.iv_size) != 0)
379 rte_cryptodev_sym_capability_check_auth(
380 const struct rte_cryptodev_symmetric_capability *capability,
381 uint16_t key_size, uint16_t digest_size, uint16_t iv_size)
383 if (param_range_check(key_size, &capability->auth.key_size) != 0)
386 if (param_range_check(digest_size, &capability->auth.digest_size) != 0)
389 if (param_range_check(iv_size, &capability->auth.iv_size) != 0)
396 rte_cryptodev_sym_capability_check_aead(
397 const struct rte_cryptodev_symmetric_capability *capability,
398 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
401 if (param_range_check(key_size, &capability->aead.key_size) != 0)
404 if (param_range_check(digest_size, &capability->aead.digest_size) != 0)
407 if (param_range_check(aad_size, &capability->aead.aad_size) != 0)
410 if (param_range_check(iv_size, &capability->aead.iv_size) != 0)
416 rte_cryptodev_asym_xform_capability_check_optype(
417 const struct rte_cryptodev_asymmetric_xform_capability *capability,
418 enum rte_crypto_asym_op_type op_type)
420 if (capability->op_types & (1 << op_type))
427 rte_cryptodev_asym_xform_capability_check_modlen(
428 const struct rte_cryptodev_asymmetric_xform_capability *capability,
431 /* no need to check for limits, if min or max = 0 */
432 if (capability->modlen.min != 0) {
433 if (modlen < capability->modlen.min)
437 if (capability->modlen.max != 0) {
438 if (modlen > capability->modlen.max)
442 /* in any case, check if given modlen is module increment */
443 if (capability->modlen.increment != 0) {
444 if (modlen % (capability->modlen.increment))
451 /* spinlock for crypto device enq callbacks */
452 static rte_spinlock_t rte_cryptodev_callback_lock = RTE_SPINLOCK_INITIALIZER;
455 cryptodev_cb_cleanup(struct rte_cryptodev *dev)
457 struct rte_cryptodev_cb_rcu *list;
458 struct rte_cryptodev_cb *cb, *next;
461 if (dev->enq_cbs == NULL && dev->deq_cbs == NULL)
464 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
465 list = &dev->enq_cbs[qp_id];
473 rte_free(list->qsbr);
476 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
477 list = &dev->deq_cbs[qp_id];
485 rte_free(list->qsbr);
488 rte_free(dev->enq_cbs);
490 rte_free(dev->deq_cbs);
495 cryptodev_cb_init(struct rte_cryptodev *dev)
497 struct rte_cryptodev_cb_rcu *list;
498 struct rte_rcu_qsbr *qsbr;
502 /* Max thread set to 1, as one DP thread accessing a queue-pair */
503 const uint32_t max_threads = 1;
505 dev->enq_cbs = rte_zmalloc(NULL,
506 sizeof(struct rte_cryptodev_cb_rcu) *
507 dev->data->nb_queue_pairs, 0);
508 if (dev->enq_cbs == NULL) {
509 CDEV_LOG_ERR("Failed to allocate memory for enq callbacks");
513 dev->deq_cbs = rte_zmalloc(NULL,
514 sizeof(struct rte_cryptodev_cb_rcu) *
515 dev->data->nb_queue_pairs, 0);
516 if (dev->deq_cbs == NULL) {
517 CDEV_LOG_ERR("Failed to allocate memory for deq callbacks");
518 rte_free(dev->enq_cbs);
522 /* Create RCU QSBR variable */
523 size = rte_rcu_qsbr_get_memsize(max_threads);
525 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
526 list = &dev->enq_cbs[qp_id];
527 qsbr = rte_zmalloc(NULL, size, RTE_CACHE_LINE_SIZE);
529 CDEV_LOG_ERR("Failed to allocate memory for RCU on "
530 "queue_pair_id=%d", qp_id);
534 if (rte_rcu_qsbr_init(qsbr, max_threads)) {
535 CDEV_LOG_ERR("Failed to initialize for RCU on "
536 "queue_pair_id=%d", qp_id);
543 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
544 list = &dev->deq_cbs[qp_id];
545 qsbr = rte_zmalloc(NULL, size, RTE_CACHE_LINE_SIZE);
547 CDEV_LOG_ERR("Failed to allocate memory for RCU on "
548 "queue_pair_id=%d", qp_id);
552 if (rte_rcu_qsbr_init(qsbr, max_threads)) {
553 CDEV_LOG_ERR("Failed to initialize for RCU on "
554 "queue_pair_id=%d", qp_id);
564 cryptodev_cb_cleanup(dev);
569 rte_cryptodev_get_feature_name(uint64_t flag)
572 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
573 return "SYMMETRIC_CRYPTO";
574 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
575 return "ASYMMETRIC_CRYPTO";
576 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
577 return "SYM_OPERATION_CHAINING";
578 case RTE_CRYPTODEV_FF_CPU_SSE:
580 case RTE_CRYPTODEV_FF_CPU_AVX:
582 case RTE_CRYPTODEV_FF_CPU_AVX2:
584 case RTE_CRYPTODEV_FF_CPU_AVX512:
586 case RTE_CRYPTODEV_FF_CPU_AESNI:
588 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
589 return "HW_ACCELERATED";
590 case RTE_CRYPTODEV_FF_IN_PLACE_SGL:
591 return "IN_PLACE_SGL";
592 case RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT:
593 return "OOP_SGL_IN_SGL_OUT";
594 case RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT:
595 return "OOP_SGL_IN_LB_OUT";
596 case RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT:
597 return "OOP_LB_IN_SGL_OUT";
598 case RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT:
599 return "OOP_LB_IN_LB_OUT";
600 case RTE_CRYPTODEV_FF_CPU_NEON:
602 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
604 case RTE_CRYPTODEV_FF_SECURITY:
605 return "SECURITY_PROTOCOL";
606 case RTE_CRYPTODEV_FF_RSA_PRIV_OP_KEY_EXP:
607 return "RSA_PRIV_OP_KEY_EXP";
608 case RTE_CRYPTODEV_FF_RSA_PRIV_OP_KEY_QT:
609 return "RSA_PRIV_OP_KEY_QT";
610 case RTE_CRYPTODEV_FF_DIGEST_ENCRYPTED:
611 return "DIGEST_ENCRYPTED";
612 case RTE_CRYPTODEV_FF_SYM_CPU_CRYPTO:
613 return "SYM_CPU_CRYPTO";
614 case RTE_CRYPTODEV_FF_ASYM_SESSIONLESS:
615 return "ASYM_SESSIONLESS";
616 case RTE_CRYPTODEV_FF_SYM_SESSIONLESS:
617 return "SYM_SESSIONLESS";
618 case RTE_CRYPTODEV_FF_NON_BYTE_ALIGNED_DATA:
619 return "NON_BYTE_ALIGNED_DATA";
620 case RTE_CRYPTODEV_FF_CIPHER_MULTIPLE_DATA_UNITS:
621 return "CIPHER_MULTIPLE_DATA_UNITS";
622 case RTE_CRYPTODEV_FF_CIPHER_WRAPPED_KEY:
623 return "CIPHER_WRAPPED_KEY";
629 struct rte_cryptodev *
630 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
632 return &cryptodev_globals.devs[dev_id];
635 struct rte_cryptodev *
636 rte_cryptodev_pmd_get_named_dev(const char *name)
638 struct rte_cryptodev *dev;
644 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
645 dev = &cryptodev_globals.devs[i];
647 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
648 (strcmp(dev->data->name, name) == 0))
655 static inline uint8_t
656 rte_cryptodev_is_valid_device_data(uint8_t dev_id)
658 if (dev_id >= RTE_CRYPTO_MAX_DEVS ||
659 rte_crypto_devices[dev_id].data == NULL)
666 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
668 struct rte_cryptodev *dev = NULL;
670 if (!rte_cryptodev_is_valid_device_data(dev_id))
673 dev = rte_cryptodev_pmd_get_dev(dev_id);
674 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
682 rte_cryptodev_get_dev_id(const char *name)
689 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
690 if (!rte_cryptodev_is_valid_device_data(i))
692 if ((strcmp(cryptodev_globals.devs[i].data->name, name)
694 (cryptodev_globals.devs[i].attached ==
695 RTE_CRYPTODEV_ATTACHED))
703 rte_cryptodev_count(void)
705 return cryptodev_globals.nb_devs;
709 rte_cryptodev_device_count_by_driver(uint8_t driver_id)
711 uint8_t i, dev_count = 0;
713 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++)
714 if (cryptodev_globals.devs[i].driver_id == driver_id &&
715 cryptodev_globals.devs[i].attached ==
716 RTE_CRYPTODEV_ATTACHED)
723 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
726 uint8_t i, count = 0;
727 struct rte_cryptodev *devs = cryptodev_globals.devs;
729 for (i = 0; i < RTE_CRYPTO_MAX_DEVS && count < nb_devices; i++) {
730 if (!rte_cryptodev_is_valid_device_data(i))
733 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
736 cmp = strncmp(devs[i].device->driver->name,
738 strlen(driver_name) + 1);
741 devices[count++] = devs[i].data->dev_id;
749 rte_cryptodev_get_sec_ctx(uint8_t dev_id)
751 if (dev_id < RTE_CRYPTO_MAX_DEVS &&
752 (rte_crypto_devices[dev_id].feature_flags &
753 RTE_CRYPTODEV_FF_SECURITY))
754 return rte_crypto_devices[dev_id].security_ctx;
760 rte_cryptodev_socket_id(uint8_t dev_id)
762 struct rte_cryptodev *dev;
764 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
767 dev = rte_cryptodev_pmd_get_dev(dev_id);
769 return dev->data->socket_id;
773 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
776 char mz_name[RTE_MEMZONE_NAMESIZE];
777 const struct rte_memzone *mz;
780 /* generate memzone name */
781 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
782 if (n >= (int)sizeof(mz_name))
785 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
786 mz = rte_memzone_reserve(mz_name,
787 sizeof(struct rte_cryptodev_data),
789 CDEV_LOG_DEBUG("PRIMARY:reserved memzone for %s (%p)",
792 mz = rte_memzone_lookup(mz_name);
793 CDEV_LOG_DEBUG("SECONDARY:looked up memzone for %s (%p)",
801 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
802 memset(*data, 0, sizeof(struct rte_cryptodev_data));
808 rte_cryptodev_data_free(uint8_t dev_id, struct rte_cryptodev_data **data)
810 char mz_name[RTE_MEMZONE_NAMESIZE];
811 const struct rte_memzone *mz;
814 /* generate memzone name */
815 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
816 if (n >= (int)sizeof(mz_name))
819 mz = rte_memzone_lookup(mz_name);
823 RTE_ASSERT(*data == mz->addr);
826 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
827 CDEV_LOG_DEBUG("PRIMARY:free memzone of %s (%p)",
829 return rte_memzone_free(mz);
831 CDEV_LOG_DEBUG("SECONDARY:don't free memzone of %s (%p)",
839 rte_cryptodev_find_free_device_index(void)
843 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
844 if (rte_crypto_devices[dev_id].attached ==
845 RTE_CRYPTODEV_DETACHED)
848 return RTE_CRYPTO_MAX_DEVS;
851 struct rte_cryptodev *
852 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
854 struct rte_cryptodev *cryptodev;
857 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
858 CDEV_LOG_ERR("Crypto device with name %s already "
863 dev_id = rte_cryptodev_find_free_device_index();
864 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
865 CDEV_LOG_ERR("Reached maximum number of crypto devices");
869 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
871 if (cryptodev->data == NULL) {
872 struct rte_cryptodev_data **cryptodev_data =
873 &cryptodev_globals.data[dev_id];
875 int retval = rte_cryptodev_data_alloc(dev_id, cryptodev_data,
878 if (retval < 0 || *cryptodev_data == NULL)
881 cryptodev->data = *cryptodev_data;
883 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
884 strlcpy(cryptodev->data->name, name,
885 RTE_CRYPTODEV_NAME_MAX_LEN);
887 cryptodev->data->dev_id = dev_id;
888 cryptodev->data->socket_id = socket_id;
889 cryptodev->data->dev_started = 0;
890 CDEV_LOG_DEBUG("PRIMARY:init data");
893 CDEV_LOG_DEBUG("Data for %s: dev_id %d, socket %d, started %d",
894 cryptodev->data->name,
895 cryptodev->data->dev_id,
896 cryptodev->data->socket_id,
897 cryptodev->data->dev_started);
899 /* init user callbacks */
900 TAILQ_INIT(&(cryptodev->link_intr_cbs));
902 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
904 cryptodev_globals.nb_devs++;
911 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
916 if (cryptodev == NULL)
919 dev_id = cryptodev->data->dev_id;
921 /* Close device only if device operations have been set */
922 if (cryptodev->dev_ops) {
923 ret = rte_cryptodev_close(dev_id);
928 ret = rte_cryptodev_data_free(dev_id, &cryptodev_globals.data[dev_id]);
932 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
933 cryptodev_globals.nb_devs--;
938 rte_cryptodev_queue_pair_count(uint8_t dev_id)
940 struct rte_cryptodev *dev;
942 if (!rte_cryptodev_is_valid_device_data(dev_id)) {
943 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
947 dev = &rte_crypto_devices[dev_id];
948 return dev->data->nb_queue_pairs;
952 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
955 struct rte_cryptodev_info dev_info;
959 if ((dev == NULL) || (nb_qpairs < 1)) {
960 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
965 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
966 nb_qpairs, dev->data->dev_id);
968 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
970 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
971 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
973 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
974 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
975 nb_qpairs, dev->data->dev_id);
979 if (dev->data->queue_pairs == NULL) { /* first time configuration */
980 dev->data->queue_pairs = rte_zmalloc_socket(
981 "cryptodev->queue_pairs",
982 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
983 RTE_CACHE_LINE_SIZE, socket_id);
985 if (dev->data->queue_pairs == NULL) {
986 dev->data->nb_queue_pairs = 0;
987 CDEV_LOG_ERR("failed to get memory for qp meta data, "
992 } else { /* re-configure */
994 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
996 qp = dev->data->queue_pairs;
998 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
1001 for (i = nb_qpairs; i < old_nb_queues; i++) {
1002 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
1007 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
1008 RTE_CACHE_LINE_SIZE);
1010 CDEV_LOG_ERR("failed to realloc qp meta data,"
1011 " nb_queues %u", nb_qpairs);
1015 if (nb_qpairs > old_nb_queues) {
1016 uint16_t new_qs = nb_qpairs - old_nb_queues;
1018 memset(qp + old_nb_queues, 0,
1019 sizeof(qp[0]) * new_qs);
1022 dev->data->queue_pairs = qp;
1025 dev->data->nb_queue_pairs = nb_qpairs;
1030 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
1032 struct rte_cryptodev *dev;
1035 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1036 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1040 dev = &rte_crypto_devices[dev_id];
1042 if (dev->data->dev_started) {
1044 "device %d must be stopped to allow configuration", dev_id);
1048 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
1050 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1051 cryptodev_cb_cleanup(dev);
1052 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1054 /* Setup new number of queue pairs and reconfigure device. */
1055 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
1058 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
1063 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1064 diag = cryptodev_cb_init(dev);
1065 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1067 CDEV_LOG_ERR("Callback init failed for dev_id=%d", dev_id);
1071 rte_cryptodev_trace_configure(dev_id, config);
1072 return (*dev->dev_ops->dev_configure)(dev, config);
1076 rte_cryptodev_start(uint8_t dev_id)
1078 struct rte_cryptodev *dev;
1081 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
1083 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1084 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1088 dev = &rte_crypto_devices[dev_id];
1090 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
1092 if (dev->data->dev_started != 0) {
1093 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
1098 diag = (*dev->dev_ops->dev_start)(dev);
1099 rte_cryptodev_trace_start(dev_id, diag);
1101 dev->data->dev_started = 1;
1109 rte_cryptodev_stop(uint8_t dev_id)
1111 struct rte_cryptodev *dev;
1113 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1114 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1118 dev = &rte_crypto_devices[dev_id];
1120 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
1122 if (dev->data->dev_started == 0) {
1123 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
1128 (*dev->dev_ops->dev_stop)(dev);
1129 rte_cryptodev_trace_stop(dev_id);
1130 dev->data->dev_started = 0;
1134 rte_cryptodev_close(uint8_t dev_id)
1136 struct rte_cryptodev *dev;
1139 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1140 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1144 dev = &rte_crypto_devices[dev_id];
1146 /* Device must be stopped before it can be closed */
1147 if (dev->data->dev_started == 1) {
1148 CDEV_LOG_ERR("Device %u must be stopped before closing",
1153 /* We can't close the device if there are outstanding sessions in use */
1154 if (dev->data->session_pool != NULL) {
1155 if (!rte_mempool_full(dev->data->session_pool)) {
1156 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
1157 "has sessions still in use, free "
1158 "all sessions before calling close",
1164 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
1165 retval = (*dev->dev_ops->dev_close)(dev);
1166 rte_cryptodev_trace_close(dev_id, retval);
1175 rte_cryptodev_get_qp_status(uint8_t dev_id, uint16_t queue_pair_id)
1177 struct rte_cryptodev *dev;
1179 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1180 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1184 dev = &rte_crypto_devices[dev_id];
1185 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1186 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1189 void **qps = dev->data->queue_pairs;
1191 if (qps[queue_pair_id]) {
1192 CDEV_LOG_DEBUG("qp %d on dev %d is initialised",
1193 queue_pair_id, dev_id);
1197 CDEV_LOG_DEBUG("qp %d on dev %d is not initialised",
1198 queue_pair_id, dev_id);
1204 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
1205 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
1208 struct rte_cryptodev *dev;
1210 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1211 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1215 dev = &rte_crypto_devices[dev_id];
1216 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1217 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1222 CDEV_LOG_ERR("qp_conf cannot be NULL\n");
1226 if ((qp_conf->mp_session && !qp_conf->mp_session_private) ||
1227 (!qp_conf->mp_session && qp_conf->mp_session_private)) {
1228 CDEV_LOG_ERR("Invalid mempools\n");
1232 if (qp_conf->mp_session) {
1233 struct rte_cryptodev_sym_session_pool_private_data *pool_priv;
1234 uint32_t obj_size = qp_conf->mp_session->elt_size;
1235 uint32_t obj_priv_size = qp_conf->mp_session_private->elt_size;
1236 struct rte_cryptodev_sym_session s = {0};
1238 pool_priv = rte_mempool_get_priv(qp_conf->mp_session);
1239 if (!pool_priv || qp_conf->mp_session->private_data_size <
1240 sizeof(*pool_priv)) {
1241 CDEV_LOG_ERR("Invalid mempool\n");
1245 s.nb_drivers = pool_priv->nb_drivers;
1246 s.user_data_sz = pool_priv->user_data_sz;
1248 if ((rte_cryptodev_sym_get_existing_header_session_size(&s) >
1249 obj_size) || (s.nb_drivers <= dev->driver_id) ||
1250 rte_cryptodev_sym_get_private_session_size(dev_id) >
1252 CDEV_LOG_ERR("Invalid mempool\n");
1257 if (dev->data->dev_started) {
1259 "device %d must be stopped to allow configuration", dev_id);
1263 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
1265 rte_cryptodev_trace_queue_pair_setup(dev_id, queue_pair_id, qp_conf);
1266 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
1270 struct rte_cryptodev_cb *
1271 rte_cryptodev_add_enq_callback(uint8_t dev_id,
1273 rte_cryptodev_callback_fn cb_fn,
1276 struct rte_cryptodev *dev;
1277 struct rte_cryptodev_cb_rcu *list;
1278 struct rte_cryptodev_cb *cb, *tail;
1281 CDEV_LOG_ERR("Callback is NULL on dev_id=%d", dev_id);
1286 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1287 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1292 dev = &rte_crypto_devices[dev_id];
1293 if (qp_id >= dev->data->nb_queue_pairs) {
1294 CDEV_LOG_ERR("Invalid queue_pair_id=%d", qp_id);
1299 cb = rte_zmalloc(NULL, sizeof(*cb), 0);
1301 CDEV_LOG_ERR("Failed to allocate memory for callback on "
1302 "dev=%d, queue_pair_id=%d", dev_id, qp_id);
1307 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1312 /* Add the callbacks in fifo order. */
1313 list = &dev->enq_cbs[qp_id];
1319 /* Stores to cb->fn and cb->param should complete before
1320 * cb is visible to data plane.
1322 __atomic_store_n(&tail->next, cb, __ATOMIC_RELEASE);
1324 /* Stores to cb->fn and cb->param should complete before
1325 * cb is visible to data plane.
1327 __atomic_store_n(&list->next, cb, __ATOMIC_RELEASE);
1330 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1336 rte_cryptodev_remove_enq_callback(uint8_t dev_id,
1338 struct rte_cryptodev_cb *cb)
1340 struct rte_cryptodev *dev;
1341 struct rte_cryptodev_cb **prev_cb, *curr_cb;
1342 struct rte_cryptodev_cb_rcu *list;
1348 CDEV_LOG_ERR("Callback is NULL");
1352 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1353 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1357 dev = &rte_crypto_devices[dev_id];
1358 if (qp_id >= dev->data->nb_queue_pairs) {
1359 CDEV_LOG_ERR("Invalid queue_pair_id=%d", qp_id);
1363 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1364 if (dev->enq_cbs == NULL) {
1365 CDEV_LOG_ERR("Callback not initialized");
1369 list = &dev->enq_cbs[qp_id];
1371 CDEV_LOG_ERR("Callback list is NULL");
1375 if (list->qsbr == NULL) {
1376 CDEV_LOG_ERR("Rcu qsbr is NULL");
1380 prev_cb = &list->next;
1381 for (; *prev_cb != NULL; prev_cb = &curr_cb->next) {
1383 if (curr_cb == cb) {
1384 /* Remove the user cb from the callback list. */
1385 __atomic_store_n(prev_cb, curr_cb->next,
1393 /* Call sync with invalid thread id as this is part of
1396 rte_rcu_qsbr_synchronize(list->qsbr, RTE_QSBR_THRID_INVALID);
1401 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1405 struct rte_cryptodev_cb *
1406 rte_cryptodev_add_deq_callback(uint8_t dev_id,
1408 rte_cryptodev_callback_fn cb_fn,
1411 struct rte_cryptodev *dev;
1412 struct rte_cryptodev_cb_rcu *list;
1413 struct rte_cryptodev_cb *cb, *tail;
1416 CDEV_LOG_ERR("Callback is NULL on dev_id=%d", dev_id);
1421 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1422 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1427 dev = &rte_crypto_devices[dev_id];
1428 if (qp_id >= dev->data->nb_queue_pairs) {
1429 CDEV_LOG_ERR("Invalid queue_pair_id=%d", qp_id);
1434 cb = rte_zmalloc(NULL, sizeof(*cb), 0);
1436 CDEV_LOG_ERR("Failed to allocate memory for callback on "
1437 "dev=%d, queue_pair_id=%d", dev_id, qp_id);
1442 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1447 /* Add the callbacks in fifo order. */
1448 list = &dev->deq_cbs[qp_id];
1454 /* Stores to cb->fn and cb->param should complete before
1455 * cb is visible to data plane.
1457 __atomic_store_n(&tail->next, cb, __ATOMIC_RELEASE);
1459 /* Stores to cb->fn and cb->param should complete before
1460 * cb is visible to data plane.
1462 __atomic_store_n(&list->next, cb, __ATOMIC_RELEASE);
1465 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1471 rte_cryptodev_remove_deq_callback(uint8_t dev_id,
1473 struct rte_cryptodev_cb *cb)
1475 struct rte_cryptodev *dev;
1476 struct rte_cryptodev_cb **prev_cb, *curr_cb;
1477 struct rte_cryptodev_cb_rcu *list;
1483 CDEV_LOG_ERR("Callback is NULL");
1487 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1488 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1492 dev = &rte_crypto_devices[dev_id];
1493 if (qp_id >= dev->data->nb_queue_pairs) {
1494 CDEV_LOG_ERR("Invalid queue_pair_id=%d", qp_id);
1498 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1499 if (dev->enq_cbs == NULL) {
1500 CDEV_LOG_ERR("Callback not initialized");
1504 list = &dev->deq_cbs[qp_id];
1506 CDEV_LOG_ERR("Callback list is NULL");
1510 if (list->qsbr == NULL) {
1511 CDEV_LOG_ERR("Rcu qsbr is NULL");
1515 prev_cb = &list->next;
1516 for (; *prev_cb != NULL; prev_cb = &curr_cb->next) {
1518 if (curr_cb == cb) {
1519 /* Remove the user cb from the callback list. */
1520 __atomic_store_n(prev_cb, curr_cb->next,
1528 /* Call sync with invalid thread id as this is part of
1531 rte_rcu_qsbr_synchronize(list->qsbr, RTE_QSBR_THRID_INVALID);
1536 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1541 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
1543 struct rte_cryptodev *dev;
1545 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1546 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1550 if (stats == NULL) {
1551 CDEV_LOG_ERR("Invalid stats ptr");
1555 dev = &rte_crypto_devices[dev_id];
1556 memset(stats, 0, sizeof(*stats));
1558 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
1559 (*dev->dev_ops->stats_get)(dev, stats);
1564 rte_cryptodev_stats_reset(uint8_t dev_id)
1566 struct rte_cryptodev *dev;
1568 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1569 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1573 dev = &rte_crypto_devices[dev_id];
1575 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1576 (*dev->dev_ops->stats_reset)(dev);
1580 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1582 struct rte_cryptodev *dev;
1584 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1585 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1589 dev = &rte_crypto_devices[dev_id];
1591 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1593 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1594 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1596 dev_info->driver_name = dev->device->driver->name;
1597 dev_info->device = dev->device;
1601 rte_cryptodev_callback_register(uint8_t dev_id,
1602 enum rte_cryptodev_event_type event,
1603 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1605 struct rte_cryptodev *dev;
1606 struct rte_cryptodev_callback *user_cb;
1611 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1612 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1616 dev = &rte_crypto_devices[dev_id];
1617 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1619 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1620 if (user_cb->cb_fn == cb_fn &&
1621 user_cb->cb_arg == cb_arg &&
1622 user_cb->event == event) {
1627 /* create a new callback. */
1628 if (user_cb == NULL) {
1629 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1630 sizeof(struct rte_cryptodev_callback), 0);
1631 if (user_cb != NULL) {
1632 user_cb->cb_fn = cb_fn;
1633 user_cb->cb_arg = cb_arg;
1634 user_cb->event = event;
1635 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1639 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1640 return (user_cb == NULL) ? -ENOMEM : 0;
1644 rte_cryptodev_callback_unregister(uint8_t dev_id,
1645 enum rte_cryptodev_event_type event,
1646 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1649 struct rte_cryptodev *dev;
1650 struct rte_cryptodev_callback *cb, *next;
1655 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1656 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1660 dev = &rte_crypto_devices[dev_id];
1661 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1664 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1666 next = TAILQ_NEXT(cb, next);
1668 if (cb->cb_fn != cb_fn || cb->event != event ||
1669 (cb->cb_arg != (void *)-1 &&
1670 cb->cb_arg != cb_arg))
1674 * if this callback is not executing right now,
1677 if (cb->active == 0) {
1678 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1685 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1690 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1691 enum rte_cryptodev_event_type event)
1693 struct rte_cryptodev_callback *cb_lst;
1694 struct rte_cryptodev_callback dev_cb;
1696 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1697 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1698 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1702 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1703 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1705 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1708 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1712 rte_cryptodev_sym_session_init(uint8_t dev_id,
1713 struct rte_cryptodev_sym_session *sess,
1714 struct rte_crypto_sym_xform *xforms,
1715 struct rte_mempool *mp)
1717 struct rte_cryptodev *dev;
1718 uint32_t sess_priv_sz = rte_cryptodev_sym_get_private_session_size(
1723 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1724 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1728 dev = rte_cryptodev_pmd_get_dev(dev_id);
1730 if (sess == NULL || xforms == NULL || dev == NULL || mp == NULL)
1733 if (mp->elt_size < sess_priv_sz)
1736 index = dev->driver_id;
1737 if (index >= sess->nb_drivers)
1740 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->sym_session_configure, -ENOTSUP);
1742 if (sess->sess_data[index].refcnt == 0) {
1743 ret = dev->dev_ops->sym_session_configure(dev, xforms,
1747 "dev_id %d failed to configure session details",
1753 rte_cryptodev_trace_sym_session_init(dev_id, sess, xforms, mp);
1754 sess->sess_data[index].refcnt++;
1759 rte_cryptodev_asym_session_init(uint8_t dev_id,
1760 struct rte_cryptodev_asym_session *sess,
1761 struct rte_crypto_asym_xform *xforms,
1762 struct rte_mempool *mp)
1764 struct rte_cryptodev *dev;
1768 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1769 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1773 dev = rte_cryptodev_pmd_get_dev(dev_id);
1775 if (sess == NULL || xforms == NULL || dev == NULL)
1778 index = dev->driver_id;
1780 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_configure,
1783 if (sess->sess_private_data[index] == NULL) {
1784 ret = dev->dev_ops->asym_session_configure(dev,
1789 "dev_id %d failed to configure session details",
1795 rte_cryptodev_trace_asym_session_init(dev_id, sess, xforms, mp);
1799 struct rte_mempool *
1800 rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts,
1801 uint32_t elt_size, uint32_t cache_size, uint16_t user_data_size,
1804 struct rte_mempool *mp;
1805 struct rte_cryptodev_sym_session_pool_private_data *pool_priv;
1808 obj_sz = rte_cryptodev_sym_get_header_session_size() + user_data_size;
1809 if (obj_sz > elt_size)
1810 CDEV_LOG_INFO("elt_size %u is expanded to %u\n", elt_size,
1815 mp = rte_mempool_create(name, nb_elts, obj_sz, cache_size,
1816 (uint32_t)(sizeof(*pool_priv)),
1817 NULL, NULL, NULL, NULL,
1820 CDEV_LOG_ERR("%s(name=%s) failed, rte_errno=%d\n",
1821 __func__, name, rte_errno);
1825 pool_priv = rte_mempool_get_priv(mp);
1827 CDEV_LOG_ERR("%s(name=%s) failed to get private data\n",
1829 rte_mempool_free(mp);
1833 pool_priv->nb_drivers = nb_drivers;
1834 pool_priv->user_data_sz = user_data_size;
1836 rte_cryptodev_trace_sym_session_pool_create(name, nb_elts,
1837 elt_size, cache_size, user_data_size, mp);
1842 rte_cryptodev_sym_session_data_size(struct rte_cryptodev_sym_session *sess)
1844 return (sizeof(sess->sess_data[0]) * sess->nb_drivers) +
1849 rte_cryptodev_sym_is_valid_session_pool(struct rte_mempool *mp)
1851 struct rte_cryptodev_sym_session_pool_private_data *pool_priv;
1856 pool_priv = rte_mempool_get_priv(mp);
1858 if (!pool_priv || mp->private_data_size < sizeof(*pool_priv) ||
1859 pool_priv->nb_drivers != nb_drivers ||
1861 rte_cryptodev_sym_get_header_session_size()
1862 + pool_priv->user_data_sz)
1868 struct rte_cryptodev_sym_session *
1869 rte_cryptodev_sym_session_create(struct rte_mempool *mp)
1871 struct rte_cryptodev_sym_session *sess;
1872 struct rte_cryptodev_sym_session_pool_private_data *pool_priv;
1874 if (!rte_cryptodev_sym_is_valid_session_pool(mp)) {
1875 CDEV_LOG_ERR("Invalid mempool\n");
1879 pool_priv = rte_mempool_get_priv(mp);
1881 /* Allocate a session structure from the session pool */
1882 if (rte_mempool_get(mp, (void **)&sess)) {
1883 CDEV_LOG_ERR("couldn't get object from session mempool");
1887 sess->nb_drivers = pool_priv->nb_drivers;
1888 sess->user_data_sz = pool_priv->user_data_sz;
1889 sess->opaque_data = 0;
1891 /* Clear device session pointer.
1892 * Include the flag indicating presence of user data
1894 memset(sess->sess_data, 0,
1895 rte_cryptodev_sym_session_data_size(sess));
1897 rte_cryptodev_trace_sym_session_create(mp, sess);
1901 struct rte_cryptodev_asym_session *
1902 rte_cryptodev_asym_session_create(struct rte_mempool *mp)
1904 struct rte_cryptodev_asym_session *sess;
1905 unsigned int session_size =
1906 rte_cryptodev_asym_get_header_session_size();
1909 CDEV_LOG_ERR("invalid mempool\n");
1913 /* Verify if provided mempool can hold elements big enough. */
1914 if (mp->elt_size < session_size) {
1916 "mempool elements too small to hold session objects");
1920 /* Allocate a session structure from the session pool */
1921 if (rte_mempool_get(mp, (void **)&sess)) {
1922 CDEV_LOG_ERR("couldn't get object from session mempool");
1926 /* Clear device session pointer.
1927 * Include the flag indicating presence of private data
1929 memset(sess, 0, session_size);
1931 rte_cryptodev_trace_asym_session_create(mp, sess);
1936 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1937 struct rte_cryptodev_sym_session *sess)
1939 struct rte_cryptodev *dev;
1942 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1943 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1947 dev = rte_cryptodev_pmd_get_dev(dev_id);
1949 if (dev == NULL || sess == NULL)
1952 driver_id = dev->driver_id;
1953 if (sess->sess_data[driver_id].refcnt == 0)
1955 if (--sess->sess_data[driver_id].refcnt != 0)
1958 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->sym_session_clear, -ENOTSUP);
1960 dev->dev_ops->sym_session_clear(dev, sess);
1962 rte_cryptodev_trace_sym_session_clear(dev_id, sess);
1967 rte_cryptodev_asym_session_clear(uint8_t dev_id,
1968 struct rte_cryptodev_asym_session *sess)
1970 struct rte_cryptodev *dev;
1972 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1973 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1977 dev = rte_cryptodev_pmd_get_dev(dev_id);
1979 if (dev == NULL || sess == NULL)
1982 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_clear, -ENOTSUP);
1984 dev->dev_ops->asym_session_clear(dev, sess);
1986 rte_cryptodev_trace_sym_session_clear(dev_id, sess);
1991 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
1994 struct rte_mempool *sess_mp;
1999 /* Check that all device private data has been freed */
2000 for (i = 0; i < sess->nb_drivers; i++) {
2001 if (sess->sess_data[i].refcnt != 0)
2005 /* Return session to mempool */
2006 sess_mp = rte_mempool_from_obj(sess);
2007 rte_mempool_put(sess_mp, sess);
2009 rte_cryptodev_trace_sym_session_free(sess);
2014 rte_cryptodev_asym_session_free(struct rte_cryptodev_asym_session *sess)
2018 struct rte_mempool *sess_mp;
2023 /* Check that all device private data has been freed */
2024 for (i = 0; i < nb_drivers; i++) {
2025 sess_priv = get_asym_session_private_data(sess, i);
2026 if (sess_priv != NULL)
2030 /* Return session to mempool */
2031 sess_mp = rte_mempool_from_obj(sess);
2032 rte_mempool_put(sess_mp, sess);
2034 rte_cryptodev_trace_asym_session_free(sess);
2039 rte_cryptodev_sym_get_header_session_size(void)
2042 * Header contains pointers to the private data of all registered
2043 * drivers and all necessary information to ensure safely clear
2044 * or free al session.
2046 struct rte_cryptodev_sym_session s = {0};
2048 s.nb_drivers = nb_drivers;
2050 return (unsigned int)(sizeof(s) +
2051 rte_cryptodev_sym_session_data_size(&s));
2055 rte_cryptodev_sym_get_existing_header_session_size(
2056 struct rte_cryptodev_sym_session *sess)
2061 return (unsigned int)(sizeof(*sess) +
2062 rte_cryptodev_sym_session_data_size(sess));
2066 rte_cryptodev_asym_get_header_session_size(void)
2069 * Header contains pointers to the private data
2070 * of all registered drivers, and a flag which
2071 * indicates presence of private data
2073 return ((sizeof(void *) * nb_drivers) + sizeof(uint8_t));
2077 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id)
2079 struct rte_cryptodev *dev;
2080 unsigned int priv_sess_size;
2082 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
2085 dev = rte_cryptodev_pmd_get_dev(dev_id);
2087 if (*dev->dev_ops->sym_session_get_size == NULL)
2090 priv_sess_size = (*dev->dev_ops->sym_session_get_size)(dev);
2092 return priv_sess_size;
2096 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id)
2098 struct rte_cryptodev *dev;
2099 unsigned int header_size = sizeof(void *) * nb_drivers;
2100 unsigned int priv_sess_size;
2102 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
2105 dev = rte_cryptodev_pmd_get_dev(dev_id);
2107 if (*dev->dev_ops->asym_session_get_size == NULL)
2110 priv_sess_size = (*dev->dev_ops->asym_session_get_size)(dev);
2111 if (priv_sess_size < header_size)
2114 return priv_sess_size;
2119 rte_cryptodev_sym_session_set_user_data(
2120 struct rte_cryptodev_sym_session *sess,
2127 if (sess->user_data_sz < size)
2130 rte_memcpy(sess->sess_data + sess->nb_drivers, data, size);
2135 rte_cryptodev_sym_session_get_user_data(
2136 struct rte_cryptodev_sym_session *sess)
2138 if (sess == NULL || sess->user_data_sz == 0)
2141 return (void *)(sess->sess_data + sess->nb_drivers);
2145 sym_crypto_fill_status(struct rte_crypto_sym_vec *vec, int32_t errnum)
2148 for (i = 0; i < vec->num; i++)
2149 vec->status[i] = errnum;
2153 rte_cryptodev_sym_cpu_crypto_process(uint8_t dev_id,
2154 struct rte_cryptodev_sym_session *sess, union rte_crypto_sym_ofs ofs,
2155 struct rte_crypto_sym_vec *vec)
2157 struct rte_cryptodev *dev;
2159 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
2160 sym_crypto_fill_status(vec, EINVAL);
2164 dev = rte_cryptodev_pmd_get_dev(dev_id);
2166 if (*dev->dev_ops->sym_cpu_process == NULL ||
2167 !(dev->feature_flags & RTE_CRYPTODEV_FF_SYM_CPU_CRYPTO)) {
2168 sym_crypto_fill_status(vec, ENOTSUP);
2172 return dev->dev_ops->sym_cpu_process(dev, sess, ofs, vec);
2176 rte_cryptodev_get_raw_dp_ctx_size(uint8_t dev_id)
2178 struct rte_cryptodev *dev;
2179 int32_t size = sizeof(struct rte_crypto_raw_dp_ctx);
2182 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
2185 dev = rte_cryptodev_pmd_get_dev(dev_id);
2187 if (*dev->dev_ops->sym_get_raw_dp_ctx_size == NULL ||
2188 !(dev->feature_flags & RTE_CRYPTODEV_FF_SYM_RAW_DP)) {
2192 priv_size = (*dev->dev_ops->sym_get_raw_dp_ctx_size)(dev);
2196 return RTE_ALIGN_CEIL((size + priv_size), 8);
2200 rte_cryptodev_configure_raw_dp_ctx(uint8_t dev_id, uint16_t qp_id,
2201 struct rte_crypto_raw_dp_ctx *ctx,
2202 enum rte_crypto_op_sess_type sess_type,
2203 union rte_cryptodev_session_ctx session_ctx,
2206 struct rte_cryptodev *dev;
2208 if (!rte_cryptodev_get_qp_status(dev_id, qp_id))
2211 dev = rte_cryptodev_pmd_get_dev(dev_id);
2212 if (!(dev->feature_flags & RTE_CRYPTODEV_FF_SYM_RAW_DP)
2213 || dev->dev_ops->sym_configure_raw_dp_ctx == NULL)
2216 return (*dev->dev_ops->sym_configure_raw_dp_ctx)(dev, qp_id, ctx,
2217 sess_type, session_ctx, is_update);
2221 rte_cryptodev_raw_enqueue_burst(struct rte_crypto_raw_dp_ctx *ctx,
2222 struct rte_crypto_sym_vec *vec, union rte_crypto_sym_ofs ofs,
2223 void **user_data, int *enqueue_status)
2225 return (*ctx->enqueue_burst)(ctx->qp_data, ctx->drv_ctx_data, vec,
2226 ofs, user_data, enqueue_status);
2230 rte_cryptodev_raw_enqueue_done(struct rte_crypto_raw_dp_ctx *ctx,
2233 return (*ctx->enqueue_done)(ctx->qp_data, ctx->drv_ctx_data, n);
2237 rte_cryptodev_raw_dequeue_burst(struct rte_crypto_raw_dp_ctx *ctx,
2238 rte_cryptodev_raw_get_dequeue_count_t get_dequeue_count,
2239 uint32_t max_nb_to_dequeue,
2240 rte_cryptodev_raw_post_dequeue_t post_dequeue,
2241 void **out_user_data, uint8_t is_user_data_array,
2242 uint32_t *n_success_jobs, int *status)
2244 return (*ctx->dequeue_burst)(ctx->qp_data, ctx->drv_ctx_data,
2245 get_dequeue_count, max_nb_to_dequeue, post_dequeue,
2246 out_user_data, is_user_data_array, n_success_jobs, status);
2250 rte_cryptodev_raw_dequeue_done(struct rte_crypto_raw_dp_ctx *ctx,
2253 return (*ctx->dequeue_done)(ctx->qp_data, ctx->drv_ctx_data, n);
2256 /** Initialise rte_crypto_op mempool element */
2258 rte_crypto_op_init(struct rte_mempool *mempool,
2261 __rte_unused unsigned i)
2263 struct rte_crypto_op *op = _op_data;
2264 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
2266 memset(_op_data, 0, mempool->elt_size);
2268 __rte_crypto_op_reset(op, type);
2270 op->phys_addr = rte_mem_virt2iova(_op_data);
2271 op->mempool = mempool;
2275 struct rte_mempool *
2276 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
2277 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
2280 struct rte_crypto_op_pool_private *priv;
2282 unsigned elt_size = sizeof(struct rte_crypto_op) +
2285 if (type == RTE_CRYPTO_OP_TYPE_SYMMETRIC) {
2286 elt_size += sizeof(struct rte_crypto_sym_op);
2287 } else if (type == RTE_CRYPTO_OP_TYPE_ASYMMETRIC) {
2288 elt_size += sizeof(struct rte_crypto_asym_op);
2289 } else if (type == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
2290 elt_size += RTE_MAX(sizeof(struct rte_crypto_sym_op),
2291 sizeof(struct rte_crypto_asym_op));
2293 CDEV_LOG_ERR("Invalid op_type\n");
2297 /* lookup mempool in case already allocated */
2298 struct rte_mempool *mp = rte_mempool_lookup(name);
2301 priv = (struct rte_crypto_op_pool_private *)
2302 rte_mempool_get_priv(mp);
2304 if (mp->elt_size != elt_size ||
2305 mp->cache_size < cache_size ||
2306 mp->size < nb_elts ||
2307 priv->priv_size < priv_size) {
2309 CDEV_LOG_ERR("Mempool %s already exists but with "
2310 "incompatible parameters", name);
2316 mp = rte_mempool_create(
2321 sizeof(struct rte_crypto_op_pool_private),
2330 CDEV_LOG_ERR("Failed to create mempool %s", name);
2334 priv = (struct rte_crypto_op_pool_private *)
2335 rte_mempool_get_priv(mp);
2337 priv->priv_size = priv_size;
2344 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
2346 struct rte_cryptodev *dev = NULL;
2352 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
2353 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
2354 "%s_%u", dev_name_prefix, i);
2359 dev = rte_cryptodev_pmd_get_named_dev(name);
2367 TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
2369 static struct cryptodev_driver_list cryptodev_driver_list =
2370 TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
2373 rte_cryptodev_driver_id_get(const char *name)
2375 struct cryptodev_driver *driver;
2376 const char *driver_name;
2379 RTE_LOG(DEBUG, CRYPTODEV, "name pointer NULL");
2383 TAILQ_FOREACH(driver, &cryptodev_driver_list, next) {
2384 driver_name = driver->driver->name;
2385 if (strncmp(driver_name, name, strlen(driver_name) + 1) == 0)
2392 rte_cryptodev_name_get(uint8_t dev_id)
2394 struct rte_cryptodev *dev;
2396 if (!rte_cryptodev_is_valid_device_data(dev_id)) {
2397 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
2401 dev = rte_cryptodev_pmd_get_dev(dev_id);
2405 return dev->data->name;
2409 rte_cryptodev_driver_name_get(uint8_t driver_id)
2411 struct cryptodev_driver *driver;
2413 TAILQ_FOREACH(driver, &cryptodev_driver_list, next)
2414 if (driver->id == driver_id)
2415 return driver->driver->name;
2420 rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
2421 const struct rte_driver *drv)
2423 crypto_drv->driver = drv;
2424 crypto_drv->id = nb_drivers;
2426 TAILQ_INSERT_TAIL(&cryptodev_driver_list, crypto_drv, next);
2428 return nb_drivers++;