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";
627 struct rte_cryptodev *
628 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
630 return &cryptodev_globals.devs[dev_id];
633 struct rte_cryptodev *
634 rte_cryptodev_pmd_get_named_dev(const char *name)
636 struct rte_cryptodev *dev;
642 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
643 dev = &cryptodev_globals.devs[i];
645 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
646 (strcmp(dev->data->name, name) == 0))
653 static inline uint8_t
654 rte_cryptodev_is_valid_device_data(uint8_t dev_id)
656 if (dev_id >= RTE_CRYPTO_MAX_DEVS ||
657 rte_crypto_devices[dev_id].data == NULL)
664 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
666 struct rte_cryptodev *dev = NULL;
668 if (!rte_cryptodev_is_valid_device_data(dev_id))
671 dev = rte_cryptodev_pmd_get_dev(dev_id);
672 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
680 rte_cryptodev_get_dev_id(const char *name)
687 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
688 if (!rte_cryptodev_is_valid_device_data(i))
690 if ((strcmp(cryptodev_globals.devs[i].data->name, name)
692 (cryptodev_globals.devs[i].attached ==
693 RTE_CRYPTODEV_ATTACHED))
701 rte_cryptodev_count(void)
703 return cryptodev_globals.nb_devs;
707 rte_cryptodev_device_count_by_driver(uint8_t driver_id)
709 uint8_t i, dev_count = 0;
711 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++)
712 if (cryptodev_globals.devs[i].driver_id == driver_id &&
713 cryptodev_globals.devs[i].attached ==
714 RTE_CRYPTODEV_ATTACHED)
721 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
724 uint8_t i, count = 0;
725 struct rte_cryptodev *devs = cryptodev_globals.devs;
727 for (i = 0; i < RTE_CRYPTO_MAX_DEVS && count < nb_devices; i++) {
728 if (!rte_cryptodev_is_valid_device_data(i))
731 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
734 cmp = strncmp(devs[i].device->driver->name,
736 strlen(driver_name) + 1);
739 devices[count++] = devs[i].data->dev_id;
747 rte_cryptodev_get_sec_ctx(uint8_t dev_id)
749 if (dev_id < RTE_CRYPTO_MAX_DEVS &&
750 (rte_crypto_devices[dev_id].feature_flags &
751 RTE_CRYPTODEV_FF_SECURITY))
752 return rte_crypto_devices[dev_id].security_ctx;
758 rte_cryptodev_socket_id(uint8_t dev_id)
760 struct rte_cryptodev *dev;
762 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
765 dev = rte_cryptodev_pmd_get_dev(dev_id);
767 return dev->data->socket_id;
771 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
774 char mz_name[RTE_MEMZONE_NAMESIZE];
775 const struct rte_memzone *mz;
778 /* generate memzone name */
779 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
780 if (n >= (int)sizeof(mz_name))
783 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
784 mz = rte_memzone_reserve(mz_name,
785 sizeof(struct rte_cryptodev_data),
787 CDEV_LOG_DEBUG("PRIMARY:reserved memzone for %s (%p)",
790 mz = rte_memzone_lookup(mz_name);
791 CDEV_LOG_DEBUG("SECONDARY:looked up memzone for %s (%p)",
799 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
800 memset(*data, 0, sizeof(struct rte_cryptodev_data));
806 rte_cryptodev_data_free(uint8_t dev_id, struct rte_cryptodev_data **data)
808 char mz_name[RTE_MEMZONE_NAMESIZE];
809 const struct rte_memzone *mz;
812 /* generate memzone name */
813 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
814 if (n >= (int)sizeof(mz_name))
817 mz = rte_memzone_lookup(mz_name);
821 RTE_ASSERT(*data == mz->addr);
824 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
825 CDEV_LOG_DEBUG("PRIMARY:free memzone of %s (%p)",
827 return rte_memzone_free(mz);
829 CDEV_LOG_DEBUG("SECONDARY:don't free memzone of %s (%p)",
837 rte_cryptodev_find_free_device_index(void)
841 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
842 if (rte_crypto_devices[dev_id].attached ==
843 RTE_CRYPTODEV_DETACHED)
846 return RTE_CRYPTO_MAX_DEVS;
849 struct rte_cryptodev *
850 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
852 struct rte_cryptodev *cryptodev;
855 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
856 CDEV_LOG_ERR("Crypto device with name %s already "
861 dev_id = rte_cryptodev_find_free_device_index();
862 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
863 CDEV_LOG_ERR("Reached maximum number of crypto devices");
867 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
869 if (cryptodev->data == NULL) {
870 struct rte_cryptodev_data **cryptodev_data =
871 &cryptodev_globals.data[dev_id];
873 int retval = rte_cryptodev_data_alloc(dev_id, cryptodev_data,
876 if (retval < 0 || *cryptodev_data == NULL)
879 cryptodev->data = *cryptodev_data;
881 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
882 strlcpy(cryptodev->data->name, name,
883 RTE_CRYPTODEV_NAME_MAX_LEN);
885 cryptodev->data->dev_id = dev_id;
886 cryptodev->data->socket_id = socket_id;
887 cryptodev->data->dev_started = 0;
888 CDEV_LOG_DEBUG("PRIMARY:init data");
891 CDEV_LOG_DEBUG("Data for %s: dev_id %d, socket %d, started %d",
892 cryptodev->data->name,
893 cryptodev->data->dev_id,
894 cryptodev->data->socket_id,
895 cryptodev->data->dev_started);
897 /* init user callbacks */
898 TAILQ_INIT(&(cryptodev->link_intr_cbs));
900 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
902 cryptodev_globals.nb_devs++;
909 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
914 if (cryptodev == NULL)
917 dev_id = cryptodev->data->dev_id;
919 /* Close device only if device operations have been set */
920 if (cryptodev->dev_ops) {
921 ret = rte_cryptodev_close(dev_id);
926 ret = rte_cryptodev_data_free(dev_id, &cryptodev_globals.data[dev_id]);
930 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
931 cryptodev_globals.nb_devs--;
936 rte_cryptodev_queue_pair_count(uint8_t dev_id)
938 struct rte_cryptodev *dev;
940 if (!rte_cryptodev_is_valid_device_data(dev_id)) {
941 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
945 dev = &rte_crypto_devices[dev_id];
946 return dev->data->nb_queue_pairs;
950 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
953 struct rte_cryptodev_info dev_info;
957 if ((dev == NULL) || (nb_qpairs < 1)) {
958 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
963 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
964 nb_qpairs, dev->data->dev_id);
966 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
968 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
969 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
971 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
972 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
973 nb_qpairs, dev->data->dev_id);
977 if (dev->data->queue_pairs == NULL) { /* first time configuration */
978 dev->data->queue_pairs = rte_zmalloc_socket(
979 "cryptodev->queue_pairs",
980 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
981 RTE_CACHE_LINE_SIZE, socket_id);
983 if (dev->data->queue_pairs == NULL) {
984 dev->data->nb_queue_pairs = 0;
985 CDEV_LOG_ERR("failed to get memory for qp meta data, "
990 } else { /* re-configure */
992 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
994 qp = dev->data->queue_pairs;
996 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
999 for (i = nb_qpairs; i < old_nb_queues; i++) {
1000 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
1005 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
1006 RTE_CACHE_LINE_SIZE);
1008 CDEV_LOG_ERR("failed to realloc qp meta data,"
1009 " nb_queues %u", nb_qpairs);
1013 if (nb_qpairs > old_nb_queues) {
1014 uint16_t new_qs = nb_qpairs - old_nb_queues;
1016 memset(qp + old_nb_queues, 0,
1017 sizeof(qp[0]) * new_qs);
1020 dev->data->queue_pairs = qp;
1023 dev->data->nb_queue_pairs = nb_qpairs;
1028 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
1030 struct rte_cryptodev *dev;
1033 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1034 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1038 dev = &rte_crypto_devices[dev_id];
1040 if (dev->data->dev_started) {
1042 "device %d must be stopped to allow configuration", dev_id);
1046 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
1048 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1049 cryptodev_cb_cleanup(dev);
1050 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1052 /* Setup new number of queue pairs and reconfigure device. */
1053 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
1056 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
1061 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1062 diag = cryptodev_cb_init(dev);
1063 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1065 CDEV_LOG_ERR("Callback init failed for dev_id=%d", dev_id);
1069 rte_cryptodev_trace_configure(dev_id, config);
1070 return (*dev->dev_ops->dev_configure)(dev, config);
1074 rte_cryptodev_start(uint8_t dev_id)
1076 struct rte_cryptodev *dev;
1079 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
1081 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1082 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1086 dev = &rte_crypto_devices[dev_id];
1088 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
1090 if (dev->data->dev_started != 0) {
1091 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
1096 diag = (*dev->dev_ops->dev_start)(dev);
1097 rte_cryptodev_trace_start(dev_id, diag);
1099 dev->data->dev_started = 1;
1107 rte_cryptodev_stop(uint8_t dev_id)
1109 struct rte_cryptodev *dev;
1111 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1112 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1116 dev = &rte_crypto_devices[dev_id];
1118 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
1120 if (dev->data->dev_started == 0) {
1121 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
1126 (*dev->dev_ops->dev_stop)(dev);
1127 rte_cryptodev_trace_stop(dev_id);
1128 dev->data->dev_started = 0;
1132 rte_cryptodev_close(uint8_t dev_id)
1134 struct rte_cryptodev *dev;
1137 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1138 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1142 dev = &rte_crypto_devices[dev_id];
1144 /* Device must be stopped before it can be closed */
1145 if (dev->data->dev_started == 1) {
1146 CDEV_LOG_ERR("Device %u must be stopped before closing",
1151 /* We can't close the device if there are outstanding sessions in use */
1152 if (dev->data->session_pool != NULL) {
1153 if (!rte_mempool_full(dev->data->session_pool)) {
1154 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
1155 "has sessions still in use, free "
1156 "all sessions before calling close",
1162 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
1163 retval = (*dev->dev_ops->dev_close)(dev);
1164 rte_cryptodev_trace_close(dev_id, retval);
1173 rte_cryptodev_get_qp_status(uint8_t dev_id, uint16_t queue_pair_id)
1175 struct rte_cryptodev *dev;
1177 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1178 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1182 dev = &rte_crypto_devices[dev_id];
1183 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1184 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1187 void **qps = dev->data->queue_pairs;
1189 if (qps[queue_pair_id]) {
1190 CDEV_LOG_DEBUG("qp %d on dev %d is initialised",
1191 queue_pair_id, dev_id);
1195 CDEV_LOG_DEBUG("qp %d on dev %d is not initialised",
1196 queue_pair_id, dev_id);
1202 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
1203 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
1206 struct rte_cryptodev *dev;
1208 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1209 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1213 dev = &rte_crypto_devices[dev_id];
1214 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1215 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1220 CDEV_LOG_ERR("qp_conf cannot be NULL\n");
1224 if ((qp_conf->mp_session && !qp_conf->mp_session_private) ||
1225 (!qp_conf->mp_session && qp_conf->mp_session_private)) {
1226 CDEV_LOG_ERR("Invalid mempools\n");
1230 if (qp_conf->mp_session) {
1231 struct rte_cryptodev_sym_session_pool_private_data *pool_priv;
1232 uint32_t obj_size = qp_conf->mp_session->elt_size;
1233 uint32_t obj_priv_size = qp_conf->mp_session_private->elt_size;
1234 struct rte_cryptodev_sym_session s = {0};
1236 pool_priv = rte_mempool_get_priv(qp_conf->mp_session);
1237 if (!pool_priv || qp_conf->mp_session->private_data_size <
1238 sizeof(*pool_priv)) {
1239 CDEV_LOG_ERR("Invalid mempool\n");
1243 s.nb_drivers = pool_priv->nb_drivers;
1244 s.user_data_sz = pool_priv->user_data_sz;
1246 if ((rte_cryptodev_sym_get_existing_header_session_size(&s) >
1247 obj_size) || (s.nb_drivers <= dev->driver_id) ||
1248 rte_cryptodev_sym_get_private_session_size(dev_id) >
1250 CDEV_LOG_ERR("Invalid mempool\n");
1255 if (dev->data->dev_started) {
1257 "device %d must be stopped to allow configuration", dev_id);
1261 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
1263 rte_cryptodev_trace_queue_pair_setup(dev_id, queue_pair_id, qp_conf);
1264 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
1268 struct rte_cryptodev_cb *
1269 rte_cryptodev_add_enq_callback(uint8_t dev_id,
1271 rte_cryptodev_callback_fn cb_fn,
1274 struct rte_cryptodev *dev;
1275 struct rte_cryptodev_cb_rcu *list;
1276 struct rte_cryptodev_cb *cb, *tail;
1279 CDEV_LOG_ERR("Callback is NULL on dev_id=%d", dev_id);
1284 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1285 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1290 dev = &rte_crypto_devices[dev_id];
1291 if (qp_id >= dev->data->nb_queue_pairs) {
1292 CDEV_LOG_ERR("Invalid queue_pair_id=%d", qp_id);
1297 cb = rte_zmalloc(NULL, sizeof(*cb), 0);
1299 CDEV_LOG_ERR("Failed to allocate memory for callback on "
1300 "dev=%d, queue_pair_id=%d", dev_id, qp_id);
1305 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1310 /* Add the callbacks in fifo order. */
1311 list = &dev->enq_cbs[qp_id];
1317 /* Stores to cb->fn and cb->param should complete before
1318 * cb is visible to data plane.
1320 __atomic_store_n(&tail->next, cb, __ATOMIC_RELEASE);
1322 /* Stores to cb->fn and cb->param should complete before
1323 * cb is visible to data plane.
1325 __atomic_store_n(&list->next, cb, __ATOMIC_RELEASE);
1328 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1334 rte_cryptodev_remove_enq_callback(uint8_t dev_id,
1336 struct rte_cryptodev_cb *cb)
1338 struct rte_cryptodev *dev;
1339 struct rte_cryptodev_cb **prev_cb, *curr_cb;
1340 struct rte_cryptodev_cb_rcu *list;
1346 CDEV_LOG_ERR("Callback is NULL");
1350 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1351 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1355 dev = &rte_crypto_devices[dev_id];
1356 if (qp_id >= dev->data->nb_queue_pairs) {
1357 CDEV_LOG_ERR("Invalid queue_pair_id=%d", qp_id);
1361 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1362 if (dev->enq_cbs == NULL) {
1363 CDEV_LOG_ERR("Callback not initialized");
1367 list = &dev->enq_cbs[qp_id];
1369 CDEV_LOG_ERR("Callback list is NULL");
1373 if (list->qsbr == NULL) {
1374 CDEV_LOG_ERR("Rcu qsbr is NULL");
1378 prev_cb = &list->next;
1379 for (; *prev_cb != NULL; prev_cb = &curr_cb->next) {
1381 if (curr_cb == cb) {
1382 /* Remove the user cb from the callback list. */
1383 __atomic_store_n(prev_cb, curr_cb->next,
1391 /* Call sync with invalid thread id as this is part of
1394 rte_rcu_qsbr_synchronize(list->qsbr, RTE_QSBR_THRID_INVALID);
1399 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1403 struct rte_cryptodev_cb *
1404 rte_cryptodev_add_deq_callback(uint8_t dev_id,
1406 rte_cryptodev_callback_fn cb_fn,
1409 struct rte_cryptodev *dev;
1410 struct rte_cryptodev_cb_rcu *list;
1411 struct rte_cryptodev_cb *cb, *tail;
1414 CDEV_LOG_ERR("Callback is NULL on dev_id=%d", dev_id);
1419 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1420 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1425 dev = &rte_crypto_devices[dev_id];
1426 if (qp_id >= dev->data->nb_queue_pairs) {
1427 CDEV_LOG_ERR("Invalid queue_pair_id=%d", qp_id);
1432 cb = rte_zmalloc(NULL, sizeof(*cb), 0);
1434 CDEV_LOG_ERR("Failed to allocate memory for callback on "
1435 "dev=%d, queue_pair_id=%d", dev_id, qp_id);
1440 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1445 /* Add the callbacks in fifo order. */
1446 list = &dev->deq_cbs[qp_id];
1452 /* Stores to cb->fn and cb->param should complete before
1453 * cb is visible to data plane.
1455 __atomic_store_n(&tail->next, cb, __ATOMIC_RELEASE);
1457 /* Stores to cb->fn and cb->param should complete before
1458 * cb is visible to data plane.
1460 __atomic_store_n(&list->next, cb, __ATOMIC_RELEASE);
1463 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1469 rte_cryptodev_remove_deq_callback(uint8_t dev_id,
1471 struct rte_cryptodev_cb *cb)
1473 struct rte_cryptodev *dev;
1474 struct rte_cryptodev_cb **prev_cb, *curr_cb;
1475 struct rte_cryptodev_cb_rcu *list;
1481 CDEV_LOG_ERR("Callback is NULL");
1485 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1486 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1490 dev = &rte_crypto_devices[dev_id];
1491 if (qp_id >= dev->data->nb_queue_pairs) {
1492 CDEV_LOG_ERR("Invalid queue_pair_id=%d", qp_id);
1496 rte_spinlock_lock(&rte_cryptodev_callback_lock);
1497 if (dev->enq_cbs == NULL) {
1498 CDEV_LOG_ERR("Callback not initialized");
1502 list = &dev->deq_cbs[qp_id];
1504 CDEV_LOG_ERR("Callback list is NULL");
1508 if (list->qsbr == NULL) {
1509 CDEV_LOG_ERR("Rcu qsbr is NULL");
1513 prev_cb = &list->next;
1514 for (; *prev_cb != NULL; prev_cb = &curr_cb->next) {
1516 if (curr_cb == cb) {
1517 /* Remove the user cb from the callback list. */
1518 __atomic_store_n(prev_cb, curr_cb->next,
1526 /* Call sync with invalid thread id as this is part of
1529 rte_rcu_qsbr_synchronize(list->qsbr, RTE_QSBR_THRID_INVALID);
1534 rte_spinlock_unlock(&rte_cryptodev_callback_lock);
1539 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
1541 struct rte_cryptodev *dev;
1543 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1544 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1548 if (stats == NULL) {
1549 CDEV_LOG_ERR("Invalid stats ptr");
1553 dev = &rte_crypto_devices[dev_id];
1554 memset(stats, 0, sizeof(*stats));
1556 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
1557 (*dev->dev_ops->stats_get)(dev, stats);
1562 rte_cryptodev_stats_reset(uint8_t dev_id)
1564 struct rte_cryptodev *dev;
1566 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1567 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1571 dev = &rte_crypto_devices[dev_id];
1573 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1574 (*dev->dev_ops->stats_reset)(dev);
1578 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1580 struct rte_cryptodev *dev;
1582 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1583 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1587 dev = &rte_crypto_devices[dev_id];
1589 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1591 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1592 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1594 dev_info->driver_name = dev->device->driver->name;
1595 dev_info->device = dev->device;
1599 rte_cryptodev_callback_register(uint8_t dev_id,
1600 enum rte_cryptodev_event_type event,
1601 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1603 struct rte_cryptodev *dev;
1604 struct rte_cryptodev_callback *user_cb;
1609 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1610 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1614 dev = &rte_crypto_devices[dev_id];
1615 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1617 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1618 if (user_cb->cb_fn == cb_fn &&
1619 user_cb->cb_arg == cb_arg &&
1620 user_cb->event == event) {
1625 /* create a new callback. */
1626 if (user_cb == NULL) {
1627 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1628 sizeof(struct rte_cryptodev_callback), 0);
1629 if (user_cb != NULL) {
1630 user_cb->cb_fn = cb_fn;
1631 user_cb->cb_arg = cb_arg;
1632 user_cb->event = event;
1633 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1637 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1638 return (user_cb == NULL) ? -ENOMEM : 0;
1642 rte_cryptodev_callback_unregister(uint8_t dev_id,
1643 enum rte_cryptodev_event_type event,
1644 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1647 struct rte_cryptodev *dev;
1648 struct rte_cryptodev_callback *cb, *next;
1653 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1654 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1658 dev = &rte_crypto_devices[dev_id];
1659 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1662 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1664 next = TAILQ_NEXT(cb, next);
1666 if (cb->cb_fn != cb_fn || cb->event != event ||
1667 (cb->cb_arg != (void *)-1 &&
1668 cb->cb_arg != cb_arg))
1672 * if this callback is not executing right now,
1675 if (cb->active == 0) {
1676 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1683 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1688 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1689 enum rte_cryptodev_event_type event)
1691 struct rte_cryptodev_callback *cb_lst;
1692 struct rte_cryptodev_callback dev_cb;
1694 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1695 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1696 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1700 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1701 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1703 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1706 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1710 rte_cryptodev_sym_session_init(uint8_t dev_id,
1711 struct rte_cryptodev_sym_session *sess,
1712 struct rte_crypto_sym_xform *xforms,
1713 struct rte_mempool *mp)
1715 struct rte_cryptodev *dev;
1716 uint32_t sess_priv_sz = rte_cryptodev_sym_get_private_session_size(
1721 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1722 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1726 dev = rte_cryptodev_pmd_get_dev(dev_id);
1728 if (sess == NULL || xforms == NULL || dev == NULL || mp == NULL)
1731 if (mp->elt_size < sess_priv_sz)
1734 index = dev->driver_id;
1735 if (index >= sess->nb_drivers)
1738 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->sym_session_configure, -ENOTSUP);
1740 if (sess->sess_data[index].refcnt == 0) {
1741 ret = dev->dev_ops->sym_session_configure(dev, xforms,
1745 "dev_id %d failed to configure session details",
1751 rte_cryptodev_trace_sym_session_init(dev_id, sess, xforms, mp);
1752 sess->sess_data[index].refcnt++;
1757 rte_cryptodev_asym_session_init(uint8_t dev_id,
1758 struct rte_cryptodev_asym_session *sess,
1759 struct rte_crypto_asym_xform *xforms,
1760 struct rte_mempool *mp)
1762 struct rte_cryptodev *dev;
1766 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1767 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1771 dev = rte_cryptodev_pmd_get_dev(dev_id);
1773 if (sess == NULL || xforms == NULL || dev == NULL)
1776 index = dev->driver_id;
1778 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_configure,
1781 if (sess->sess_private_data[index] == NULL) {
1782 ret = dev->dev_ops->asym_session_configure(dev,
1787 "dev_id %d failed to configure session details",
1793 rte_cryptodev_trace_asym_session_init(dev_id, sess, xforms, mp);
1797 struct rte_mempool *
1798 rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts,
1799 uint32_t elt_size, uint32_t cache_size, uint16_t user_data_size,
1802 struct rte_mempool *mp;
1803 struct rte_cryptodev_sym_session_pool_private_data *pool_priv;
1806 obj_sz = rte_cryptodev_sym_get_header_session_size() + user_data_size;
1807 if (obj_sz > elt_size)
1808 CDEV_LOG_INFO("elt_size %u is expanded to %u\n", elt_size,
1813 mp = rte_mempool_create(name, nb_elts, obj_sz, cache_size,
1814 (uint32_t)(sizeof(*pool_priv)),
1815 NULL, NULL, NULL, NULL,
1818 CDEV_LOG_ERR("%s(name=%s) failed, rte_errno=%d\n",
1819 __func__, name, rte_errno);
1823 pool_priv = rte_mempool_get_priv(mp);
1825 CDEV_LOG_ERR("%s(name=%s) failed to get private data\n",
1827 rte_mempool_free(mp);
1831 pool_priv->nb_drivers = nb_drivers;
1832 pool_priv->user_data_sz = user_data_size;
1834 rte_cryptodev_trace_sym_session_pool_create(name, nb_elts,
1835 elt_size, cache_size, user_data_size, mp);
1840 rte_cryptodev_sym_session_data_size(struct rte_cryptodev_sym_session *sess)
1842 return (sizeof(sess->sess_data[0]) * sess->nb_drivers) +
1847 rte_cryptodev_sym_is_valid_session_pool(struct rte_mempool *mp)
1849 struct rte_cryptodev_sym_session_pool_private_data *pool_priv;
1854 pool_priv = rte_mempool_get_priv(mp);
1856 if (!pool_priv || mp->private_data_size < sizeof(*pool_priv) ||
1857 pool_priv->nb_drivers != nb_drivers ||
1859 rte_cryptodev_sym_get_header_session_size()
1860 + pool_priv->user_data_sz)
1866 struct rte_cryptodev_sym_session *
1867 rte_cryptodev_sym_session_create(struct rte_mempool *mp)
1869 struct rte_cryptodev_sym_session *sess;
1870 struct rte_cryptodev_sym_session_pool_private_data *pool_priv;
1872 if (!rte_cryptodev_sym_is_valid_session_pool(mp)) {
1873 CDEV_LOG_ERR("Invalid mempool\n");
1877 pool_priv = rte_mempool_get_priv(mp);
1879 /* Allocate a session structure from the session pool */
1880 if (rte_mempool_get(mp, (void **)&sess)) {
1881 CDEV_LOG_ERR("couldn't get object from session mempool");
1885 sess->nb_drivers = pool_priv->nb_drivers;
1886 sess->user_data_sz = pool_priv->user_data_sz;
1887 sess->opaque_data = 0;
1889 /* Clear device session pointer.
1890 * Include the flag indicating presence of user data
1892 memset(sess->sess_data, 0,
1893 rte_cryptodev_sym_session_data_size(sess));
1895 rte_cryptodev_trace_sym_session_create(mp, sess);
1899 struct rte_cryptodev_asym_session *
1900 rte_cryptodev_asym_session_create(struct rte_mempool *mp)
1902 struct rte_cryptodev_asym_session *sess;
1903 unsigned int session_size =
1904 rte_cryptodev_asym_get_header_session_size();
1907 CDEV_LOG_ERR("invalid mempool\n");
1911 /* Verify if provided mempool can hold elements big enough. */
1912 if (mp->elt_size < session_size) {
1914 "mempool elements too small to hold session objects");
1918 /* Allocate a session structure from the session pool */
1919 if (rte_mempool_get(mp, (void **)&sess)) {
1920 CDEV_LOG_ERR("couldn't get object from session mempool");
1924 /* Clear device session pointer.
1925 * Include the flag indicating presence of private data
1927 memset(sess, 0, session_size);
1929 rte_cryptodev_trace_asym_session_create(mp, sess);
1934 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1935 struct rte_cryptodev_sym_session *sess)
1937 struct rte_cryptodev *dev;
1940 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1941 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1945 dev = rte_cryptodev_pmd_get_dev(dev_id);
1947 if (dev == NULL || sess == NULL)
1950 driver_id = dev->driver_id;
1951 if (sess->sess_data[driver_id].refcnt == 0)
1953 if (--sess->sess_data[driver_id].refcnt != 0)
1956 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->sym_session_clear, -ENOTSUP);
1958 dev->dev_ops->sym_session_clear(dev, sess);
1960 rte_cryptodev_trace_sym_session_clear(dev_id, sess);
1965 rte_cryptodev_asym_session_clear(uint8_t dev_id,
1966 struct rte_cryptodev_asym_session *sess)
1968 struct rte_cryptodev *dev;
1970 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1971 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1975 dev = rte_cryptodev_pmd_get_dev(dev_id);
1977 if (dev == NULL || sess == NULL)
1980 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_clear, -ENOTSUP);
1982 dev->dev_ops->asym_session_clear(dev, sess);
1984 rte_cryptodev_trace_sym_session_clear(dev_id, sess);
1989 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
1992 struct rte_mempool *sess_mp;
1997 /* Check that all device private data has been freed */
1998 for (i = 0; i < sess->nb_drivers; i++) {
1999 if (sess->sess_data[i].refcnt != 0)
2003 /* Return session to mempool */
2004 sess_mp = rte_mempool_from_obj(sess);
2005 rte_mempool_put(sess_mp, sess);
2007 rte_cryptodev_trace_sym_session_free(sess);
2012 rte_cryptodev_asym_session_free(struct rte_cryptodev_asym_session *sess)
2016 struct rte_mempool *sess_mp;
2021 /* Check that all device private data has been freed */
2022 for (i = 0; i < nb_drivers; i++) {
2023 sess_priv = get_asym_session_private_data(sess, i);
2024 if (sess_priv != NULL)
2028 /* Return session to mempool */
2029 sess_mp = rte_mempool_from_obj(sess);
2030 rte_mempool_put(sess_mp, sess);
2032 rte_cryptodev_trace_asym_session_free(sess);
2037 rte_cryptodev_sym_get_header_session_size(void)
2040 * Header contains pointers to the private data of all registered
2041 * drivers and all necessary information to ensure safely clear
2042 * or free al session.
2044 struct rte_cryptodev_sym_session s = {0};
2046 s.nb_drivers = nb_drivers;
2048 return (unsigned int)(sizeof(s) +
2049 rte_cryptodev_sym_session_data_size(&s));
2053 rte_cryptodev_sym_get_existing_header_session_size(
2054 struct rte_cryptodev_sym_session *sess)
2059 return (unsigned int)(sizeof(*sess) +
2060 rte_cryptodev_sym_session_data_size(sess));
2064 rte_cryptodev_asym_get_header_session_size(void)
2067 * Header contains pointers to the private data
2068 * of all registered drivers, and a flag which
2069 * indicates presence of private data
2071 return ((sizeof(void *) * nb_drivers) + sizeof(uint8_t));
2075 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id)
2077 struct rte_cryptodev *dev;
2078 unsigned int priv_sess_size;
2080 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
2083 dev = rte_cryptodev_pmd_get_dev(dev_id);
2085 if (*dev->dev_ops->sym_session_get_size == NULL)
2088 priv_sess_size = (*dev->dev_ops->sym_session_get_size)(dev);
2090 return priv_sess_size;
2094 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id)
2096 struct rte_cryptodev *dev;
2097 unsigned int header_size = sizeof(void *) * nb_drivers;
2098 unsigned int priv_sess_size;
2100 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
2103 dev = rte_cryptodev_pmd_get_dev(dev_id);
2105 if (*dev->dev_ops->asym_session_get_size == NULL)
2108 priv_sess_size = (*dev->dev_ops->asym_session_get_size)(dev);
2109 if (priv_sess_size < header_size)
2112 return priv_sess_size;
2117 rte_cryptodev_sym_session_set_user_data(
2118 struct rte_cryptodev_sym_session *sess,
2125 if (sess->user_data_sz < size)
2128 rte_memcpy(sess->sess_data + sess->nb_drivers, data, size);
2133 rte_cryptodev_sym_session_get_user_data(
2134 struct rte_cryptodev_sym_session *sess)
2136 if (sess == NULL || sess->user_data_sz == 0)
2139 return (void *)(sess->sess_data + sess->nb_drivers);
2143 sym_crypto_fill_status(struct rte_crypto_sym_vec *vec, int32_t errnum)
2146 for (i = 0; i < vec->num; i++)
2147 vec->status[i] = errnum;
2151 rte_cryptodev_sym_cpu_crypto_process(uint8_t dev_id,
2152 struct rte_cryptodev_sym_session *sess, union rte_crypto_sym_ofs ofs,
2153 struct rte_crypto_sym_vec *vec)
2155 struct rte_cryptodev *dev;
2157 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
2158 sym_crypto_fill_status(vec, EINVAL);
2162 dev = rte_cryptodev_pmd_get_dev(dev_id);
2164 if (*dev->dev_ops->sym_cpu_process == NULL ||
2165 !(dev->feature_flags & RTE_CRYPTODEV_FF_SYM_CPU_CRYPTO)) {
2166 sym_crypto_fill_status(vec, ENOTSUP);
2170 return dev->dev_ops->sym_cpu_process(dev, sess, ofs, vec);
2174 rte_cryptodev_get_raw_dp_ctx_size(uint8_t dev_id)
2176 struct rte_cryptodev *dev;
2177 int32_t size = sizeof(struct rte_crypto_raw_dp_ctx);
2180 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
2183 dev = rte_cryptodev_pmd_get_dev(dev_id);
2185 if (*dev->dev_ops->sym_get_raw_dp_ctx_size == NULL ||
2186 !(dev->feature_flags & RTE_CRYPTODEV_FF_SYM_RAW_DP)) {
2190 priv_size = (*dev->dev_ops->sym_get_raw_dp_ctx_size)(dev);
2194 return RTE_ALIGN_CEIL((size + priv_size), 8);
2198 rte_cryptodev_configure_raw_dp_ctx(uint8_t dev_id, uint16_t qp_id,
2199 struct rte_crypto_raw_dp_ctx *ctx,
2200 enum rte_crypto_op_sess_type sess_type,
2201 union rte_cryptodev_session_ctx session_ctx,
2204 struct rte_cryptodev *dev;
2206 if (!rte_cryptodev_get_qp_status(dev_id, qp_id))
2209 dev = rte_cryptodev_pmd_get_dev(dev_id);
2210 if (!(dev->feature_flags & RTE_CRYPTODEV_FF_SYM_RAW_DP)
2211 || dev->dev_ops->sym_configure_raw_dp_ctx == NULL)
2214 return (*dev->dev_ops->sym_configure_raw_dp_ctx)(dev, qp_id, ctx,
2215 sess_type, session_ctx, is_update);
2219 rte_cryptodev_raw_enqueue_burst(struct rte_crypto_raw_dp_ctx *ctx,
2220 struct rte_crypto_sym_vec *vec, union rte_crypto_sym_ofs ofs,
2221 void **user_data, int *enqueue_status)
2223 return (*ctx->enqueue_burst)(ctx->qp_data, ctx->drv_ctx_data, vec,
2224 ofs, user_data, enqueue_status);
2228 rte_cryptodev_raw_enqueue_done(struct rte_crypto_raw_dp_ctx *ctx,
2231 return (*ctx->enqueue_done)(ctx->qp_data, ctx->drv_ctx_data, n);
2235 rte_cryptodev_raw_dequeue_burst(struct rte_crypto_raw_dp_ctx *ctx,
2236 rte_cryptodev_raw_get_dequeue_count_t get_dequeue_count,
2237 rte_cryptodev_raw_post_dequeue_t post_dequeue,
2238 void **out_user_data, uint8_t is_user_data_array,
2239 uint32_t *n_success_jobs, int *status)
2241 return (*ctx->dequeue_burst)(ctx->qp_data, ctx->drv_ctx_data,
2242 get_dequeue_count, post_dequeue, out_user_data,
2243 is_user_data_array, n_success_jobs, status);
2247 rte_cryptodev_raw_dequeue_done(struct rte_crypto_raw_dp_ctx *ctx,
2250 return (*ctx->dequeue_done)(ctx->qp_data, ctx->drv_ctx_data, n);
2253 /** Initialise rte_crypto_op mempool element */
2255 rte_crypto_op_init(struct rte_mempool *mempool,
2258 __rte_unused unsigned i)
2260 struct rte_crypto_op *op = _op_data;
2261 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
2263 memset(_op_data, 0, mempool->elt_size);
2265 __rte_crypto_op_reset(op, type);
2267 op->phys_addr = rte_mem_virt2iova(_op_data);
2268 op->mempool = mempool;
2272 struct rte_mempool *
2273 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
2274 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
2277 struct rte_crypto_op_pool_private *priv;
2279 unsigned elt_size = sizeof(struct rte_crypto_op) +
2282 if (type == RTE_CRYPTO_OP_TYPE_SYMMETRIC) {
2283 elt_size += sizeof(struct rte_crypto_sym_op);
2284 } else if (type == RTE_CRYPTO_OP_TYPE_ASYMMETRIC) {
2285 elt_size += sizeof(struct rte_crypto_asym_op);
2286 } else if (type == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
2287 elt_size += RTE_MAX(sizeof(struct rte_crypto_sym_op),
2288 sizeof(struct rte_crypto_asym_op));
2290 CDEV_LOG_ERR("Invalid op_type\n");
2294 /* lookup mempool in case already allocated */
2295 struct rte_mempool *mp = rte_mempool_lookup(name);
2298 priv = (struct rte_crypto_op_pool_private *)
2299 rte_mempool_get_priv(mp);
2301 if (mp->elt_size != elt_size ||
2302 mp->cache_size < cache_size ||
2303 mp->size < nb_elts ||
2304 priv->priv_size < priv_size) {
2306 CDEV_LOG_ERR("Mempool %s already exists but with "
2307 "incompatible parameters", name);
2313 mp = rte_mempool_create(
2318 sizeof(struct rte_crypto_op_pool_private),
2327 CDEV_LOG_ERR("Failed to create mempool %s", name);
2331 priv = (struct rte_crypto_op_pool_private *)
2332 rte_mempool_get_priv(mp);
2334 priv->priv_size = priv_size;
2341 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
2343 struct rte_cryptodev *dev = NULL;
2349 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
2350 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
2351 "%s_%u", dev_name_prefix, i);
2356 dev = rte_cryptodev_pmd_get_named_dev(name);
2364 TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
2366 static struct cryptodev_driver_list cryptodev_driver_list =
2367 TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
2370 rte_cryptodev_driver_id_get(const char *name)
2372 struct cryptodev_driver *driver;
2373 const char *driver_name;
2376 RTE_LOG(DEBUG, CRYPTODEV, "name pointer NULL");
2380 TAILQ_FOREACH(driver, &cryptodev_driver_list, next) {
2381 driver_name = driver->driver->name;
2382 if (strncmp(driver_name, name, strlen(driver_name) + 1) == 0)
2389 rte_cryptodev_name_get(uint8_t dev_id)
2391 struct rte_cryptodev *dev;
2393 if (!rte_cryptodev_is_valid_device_data(dev_id)) {
2394 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
2398 dev = rte_cryptodev_pmd_get_dev(dev_id);
2402 return dev->data->name;
2406 rte_cryptodev_driver_name_get(uint8_t driver_id)
2408 struct cryptodev_driver *driver;
2410 TAILQ_FOREACH(driver, &cryptodev_driver_list, next)
2411 if (driver->id == driver_id)
2412 return driver->driver->name;
2417 rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
2418 const struct rte_driver *drv)
2420 crypto_drv->driver = drv;
2421 crypto_drv->id = nb_drivers;
2423 TAILQ_INSERT_TAIL(&cryptodev_driver_list, crypto_drv, next);
2425 return nb_drivers++;