From 757f40e28e1c681054dcc1923b19c7fbeb7ae626 Mon Sep 17 00:00:00 2001 From: Ciara Power Date: Fri, 11 Feb 2022 09:29:09 +0000 Subject: [PATCH] cryptodev: modify return value for asym session create Rather than the asym session create function returning a session on success, and a NULL value on error, it is modified to now return int values - 0 on success or -EINVAL/-ENOTSUP/-ENOMEM on failure. The session to be used is passed as input. This adds clarity on the failure of the create function, which enables treating the -ENOTSUP return as TEST_SKIPPED in test apps. Signed-off-by: Ciara Power Acked-by: Fan Zhang Acked-by: Anoob Joseph Acked-by: Akhil Goyal --- app/test-crypto-perf/cperf_ops.c | 12 ++- app/test/test_cryptodev_asym.c | 109 +++++++++++++------------ doc/guides/rel_notes/release_22_03.rst | 3 +- lib/cryptodev/rte_cryptodev.c | 28 ++++--- lib/cryptodev/rte_cryptodev.h | 13 ++- lib/cryptodev/rte_cryptodev_trace.h | 4 +- 6 files changed, 92 insertions(+), 77 deletions(-) diff --git a/app/test-crypto-perf/cperf_ops.c b/app/test-crypto-perf/cperf_ops.c index b8f590b397..479c40eead 100644 --- a/app/test-crypto-perf/cperf_ops.c +++ b/app/test-crypto-perf/cperf_ops.c @@ -734,7 +734,9 @@ cperf_create_session(struct rte_mempool *sess_mp, struct rte_crypto_sym_xform auth_xform; struct rte_crypto_sym_xform aead_xform; struct rte_cryptodev_sym_session *sess = NULL; + void *asym_sess = NULL; struct rte_crypto_asym_xform xform = {0}; + int ret; if (options->op_type == CPERF_ASYM_MODEX) { xform.next = NULL; @@ -744,11 +746,13 @@ cperf_create_session(struct rte_mempool *sess_mp, xform.modex.exponent.data = perf_mod_e; xform.modex.exponent.length = sizeof(perf_mod_e); - sess = (void *)rte_cryptodev_asym_session_create(dev_id, &xform, sess_mp); - if (sess == NULL) + ret = rte_cryptodev_asym_session_create(dev_id, &xform, + sess_mp, &asym_sess); + if (ret < 0) { + RTE_LOG(ERR, USER1, "Asym session create failed\n"); return NULL; - - return sess; + } + return asym_sess; } #ifdef RTE_LIB_SECURITY /* diff --git a/app/test/test_cryptodev_asym.c b/app/test/test_cryptodev_asym.c index e3eb0e33d1..7cda8bb081 100644 --- a/app/test/test_cryptodev_asym.c +++ b/app/test/test_cryptodev_asym.c @@ -317,7 +317,7 @@ test_cryptodev_asym_op(struct crypto_testsuite_params_asym *ts_params, uint8_t input[TEST_DATA_SIZE] = {0}; uint8_t *result = NULL; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; xform_tc.next = NULL; xform_tc.xform_type = data_tc->modex.xform_type; @@ -452,14 +452,14 @@ test_cryptodev_asym_op(struct crypto_testsuite_params_asym *ts_params, } if (!sessionless) { - sess = rte_cryptodev_asym_session_create(dev_id, &xform_tc, - ts_params->session_mpool); - if (!sess) { + ret = rte_cryptodev_asym_session_create(dev_id, &xform_tc, + ts_params->session_mpool, &sess); + if (ret < 0) { snprintf(test_msg, ASYM_TEST_MSG_LEN, "line %u " "FAILED: %s", __LINE__, "Session creation failed"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -645,7 +645,7 @@ test_rsa_sign_verify(void) uint8_t dev_id = ts_params->valid_devs[0]; void *sess = NULL; struct rte_cryptodev_info dev_info; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; /* Test case supports op with exponent key only, * Check in PMD feature flag for RSA exponent key type support. @@ -658,12 +658,12 @@ test_rsa_sign_verify(void) return TEST_SKIPPED; } - sess = rte_cryptodev_asym_session_create(dev_id, &rsa_xform, sess_mpool); + ret = rte_cryptodev_asym_session_create(dev_id, &rsa_xform, sess_mpool, &sess); - if (!sess) { + if (ret < 0) { RTE_LOG(ERR, USER1, "Session creation failed for " "sign_verify\n"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -685,7 +685,7 @@ test_rsa_enc_dec(void) uint8_t dev_id = ts_params->valid_devs[0]; void *sess = NULL; struct rte_cryptodev_info dev_info; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; /* Test case supports op with exponent key only, * Check in PMD feature flag for RSA exponent key type support. @@ -698,11 +698,11 @@ test_rsa_enc_dec(void) return TEST_SKIPPED; } - sess = rte_cryptodev_asym_session_create(dev_id, &rsa_xform, sess_mpool); + ret = rte_cryptodev_asym_session_create(dev_id, &rsa_xform, sess_mpool, &sess); - if (!sess) { + if (ret < 0) { RTE_LOG(ERR, USER1, "Session creation failed for enc_dec\n"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -725,7 +725,7 @@ test_rsa_sign_verify_crt(void) uint8_t dev_id = ts_params->valid_devs[0]; void *sess = NULL; struct rte_cryptodev_info dev_info; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; /* Test case supports op with quintuple format key only, * Check im PMD feature flag for RSA quintuple key type support. @@ -737,12 +737,12 @@ test_rsa_sign_verify_crt(void) return TEST_SKIPPED; } - sess = rte_cryptodev_asym_session_create(dev_id, &rsa_xform_crt, sess_mpool); + ret = rte_cryptodev_asym_session_create(dev_id, &rsa_xform_crt, sess_mpool, &sess); - if (!sess) { + if (ret < 0) { RTE_LOG(ERR, USER1, "Session creation failed for " "sign_verify_crt\n"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -765,7 +765,7 @@ test_rsa_enc_dec_crt(void) uint8_t dev_id = ts_params->valid_devs[0]; void *sess = NULL; struct rte_cryptodev_info dev_info; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; /* Test case supports op with quintuple format key only, * Check in PMD feature flag for RSA quintuple key type support. @@ -777,12 +777,12 @@ test_rsa_enc_dec_crt(void) return TEST_SKIPPED; } - sess = rte_cryptodev_asym_session_create(dev_id, &rsa_xform_crt, sess_mpool); + ret = rte_cryptodev_asym_session_create(dev_id, &rsa_xform_crt, sess_mpool, &sess); - if (!sess) { + if (ret < 0) { RTE_LOG(ERR, USER1, "Session creation failed for " "enc_dec_crt\n"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -1046,7 +1046,7 @@ test_dh_gen_shared_sec(struct rte_crypto_asym_xform *xfrm) struct rte_crypto_asym_op *asym_op = NULL; struct rte_crypto_op *op = NULL, *result_op = NULL; void *sess = NULL; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; uint8_t output[TEST_DH_MOD_LEN]; struct rte_crypto_asym_xform xform = *xfrm; uint8_t peer[] = "01234567890123456789012345678901234567890123456789"; @@ -1073,12 +1073,12 @@ test_dh_gen_shared_sec(struct rte_crypto_asym_xform *xfrm) asym_op->dh.shared_secret.data = output; asym_op->dh.shared_secret.length = sizeof(output); - sess = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool); - if (sess == NULL) { + ret = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u FAILED: %s", __LINE__, "Session creation failed"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -1129,7 +1129,7 @@ test_dh_gen_priv_key(struct rte_crypto_asym_xform *xfrm) struct rte_crypto_asym_op *asym_op = NULL; struct rte_crypto_op *op = NULL, *result_op = NULL; void *sess = NULL; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; uint8_t output[TEST_DH_MOD_LEN]; struct rte_crypto_asym_xform xform = *xfrm; @@ -1151,12 +1151,12 @@ test_dh_gen_priv_key(struct rte_crypto_asym_xform *xfrm) asym_op->dh.priv_key.data = output; asym_op->dh.priv_key.length = sizeof(output); - sess = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool); - if (sess == NULL) { + ret = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u FAILED: %s", __LINE__, "Session creation failed"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -1210,7 +1210,7 @@ test_dh_gen_pub_key(struct rte_crypto_asym_xform *xfrm) struct rte_crypto_asym_op *asym_op = NULL; struct rte_crypto_op *op = NULL, *result_op = NULL; void *sess = NULL; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; uint8_t output[TEST_DH_MOD_LEN]; struct rte_crypto_asym_xform xform = *xfrm; @@ -1240,12 +1240,12 @@ test_dh_gen_pub_key(struct rte_crypto_asym_xform *xfrm) 0); asym_op->dh.priv_key = dh_test_params.priv_key; - sess = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool); - if (sess == NULL) { + ret = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u FAILED: %s", __LINE__, "Session creation failed"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -1299,7 +1299,7 @@ test_dh_gen_kp(struct rte_crypto_asym_xform *xfrm) struct rte_crypto_asym_op *asym_op = NULL; struct rte_crypto_op *op = NULL, *result_op = NULL; void *sess = NULL; - int status = TEST_SUCCESS; + int ret, status = TEST_SUCCESS; uint8_t out_pub_key[TEST_DH_MOD_LEN]; uint8_t out_prv_key[TEST_DH_MOD_LEN]; struct rte_crypto_asym_xform pub_key_xform; @@ -1329,12 +1329,12 @@ test_dh_gen_kp(struct rte_crypto_asym_xform *xfrm) asym_op->dh.priv_key.data = out_prv_key; asym_op->dh.priv_key.length = sizeof(out_prv_key); - sess = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool); - if (sess == NULL) { + ret = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u FAILED: %s", __LINE__, "Session creation failed"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -1418,12 +1418,12 @@ test_mod_inv(void) return TEST_SKIPPED; } - sess = rte_cryptodev_asym_session_create(dev_id, &modinv_xform, sess_mpool); - if (!sess) { + ret = rte_cryptodev_asym_session_create(dev_id, &modinv_xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u " "FAILED: %s", __LINE__, "Session creation failed"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -1542,13 +1542,13 @@ test_mod_exp(void) goto error_exit; } - sess = rte_cryptodev_asym_session_create(dev_id, &modex_xform, sess_mpool); - if (!sess) { + ret = rte_cryptodev_asym_session_create(dev_id, &modex_xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u " "FAILED: %s", __LINE__, "Session creation failed"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } @@ -1652,13 +1652,14 @@ test_dsa_sign(void) uint8_t r[TEST_DH_MOD_LEN]; uint8_t s[TEST_DH_MOD_LEN]; uint8_t dgst[] = "35d81554afaad2cf18f3a1770d5fedc4ea5be344"; + int ret; - sess = rte_cryptodev_asym_session_create(dev_id, &dsa_xform, sess_mpool); - if (sess == NULL) { + ret = rte_cryptodev_asym_session_create(dev_id, &dsa_xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u FAILED: %s", __LINE__, "Session creation failed"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto error_exit; } /* set up crypto op data structure */ @@ -1787,7 +1788,7 @@ test_ecdsa_sign_verify(enum curve curve_id) struct rte_crypto_asym_op *asym_op; struct rte_cryptodev_info dev_info; struct rte_crypto_op *op = NULL; - int status = TEST_SUCCESS, ret; + int ret, status = TEST_SUCCESS; switch (curve_id) { case SECP192R1: @@ -1832,12 +1833,12 @@ test_ecdsa_sign_verify(enum curve curve_id) xform.xform_type = RTE_CRYPTO_ASYM_XFORM_ECDSA; xform.ec.curve_id = input_params.curve; - sess = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool); - if (sess == NULL) { + ret = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u FAILED: %s", __LINE__, "Session creation failed\n"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto exit; } @@ -1989,7 +1990,7 @@ test_ecpm(enum curve curve_id) struct rte_crypto_asym_op *asym_op; struct rte_cryptodev_info dev_info; struct rte_crypto_op *op = NULL; - int status = TEST_SUCCESS, ret; + int ret, status = TEST_SUCCESS; switch (curve_id) { case SECP192R1: @@ -2034,12 +2035,12 @@ test_ecpm(enum curve curve_id) xform.xform_type = RTE_CRYPTO_ASYM_XFORM_ECPM; xform.ec.curve_id = input_params.curve; - sess = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool); - if (sess == NULL) { + ret = rte_cryptodev_asym_session_create(dev_id, &xform, sess_mpool, &sess); + if (ret < 0) { RTE_LOG(ERR, USER1, "line %u FAILED: %s", __LINE__, "Session creation failed\n"); - status = TEST_FAILED; + status = (ret == -ENOTSUP) ? TEST_SKIPPED : TEST_FAILED; goto exit; } diff --git a/doc/guides/rel_notes/release_22_03.rst b/doc/guides/rel_notes/release_22_03.rst index d658da85a9..ff3095d742 100644 --- a/doc/guides/rel_notes/release_22_03.rst +++ b/doc/guides/rel_notes/release_22_03.rst @@ -194,7 +194,8 @@ API Changes The session structure was moved to ``cryptodev_pmd.h``, hiding it from applications. The API ``rte_cryptodev_asym_session_init`` was removed as the initialization - is now moved to ``rte_cryptodev_asym_session_create``. + is now moved to ``rte_cryptodev_asym_session_create``, which was updated to + return an integer value to indicate initialisation errors. ABI Changes diff --git a/lib/cryptodev/rte_cryptodev.c b/lib/cryptodev/rte_cryptodev.c index 91d48d5886..727d271fb9 100644 --- a/lib/cryptodev/rte_cryptodev.c +++ b/lib/cryptodev/rte_cryptodev.c @@ -1912,9 +1912,10 @@ rte_cryptodev_sym_session_create(struct rte_mempool *mp) return sess; } -void * +int rte_cryptodev_asym_session_create(uint8_t dev_id, - struct rte_crypto_asym_xform *xforms, struct rte_mempool *mp) + struct rte_crypto_asym_xform *xforms, struct rte_mempool *mp, + void **session) { struct rte_cryptodev_asym_session *sess; uint32_t session_priv_data_sz; @@ -1926,17 +1927,17 @@ rte_cryptodev_asym_session_create(uint8_t dev_id, if (!rte_cryptodev_is_valid_dev(dev_id)) { CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id); - return NULL; + return -EINVAL; } dev = rte_cryptodev_pmd_get_dev(dev_id); if (dev == NULL) - return NULL; + return -EINVAL; if (!mp) { CDEV_LOG_ERR("invalid mempool\n"); - return NULL; + return -EINVAL; } session_priv_data_sz = rte_cryptodev_asym_get_private_session_size( @@ -1946,22 +1947,23 @@ rte_cryptodev_asym_session_create(uint8_t dev_id, if (pool_priv->max_priv_session_sz < session_priv_data_sz) { CDEV_LOG_DEBUG( "The private session data size used when creating the mempool is smaller than this device's private session data."); - return NULL; + return -EINVAL; } /* Verify if provided mempool can hold elements big enough. */ if (mp->elt_size < session_header_size + session_priv_data_sz) { CDEV_LOG_ERR( "mempool elements too small to hold session objects"); - return NULL; + return -EINVAL; } /* Allocate a session structure from the session pool */ - if (rte_mempool_get(mp, (void **)&sess)) { + if (rte_mempool_get(mp, session)) { CDEV_LOG_ERR("couldn't get object from session mempool"); - return NULL; + return -ENOMEM; } + sess = *session; sess->driver_id = dev->driver_id; sess->user_data_sz = pool_priv->user_data_sz; sess->max_priv_data_sz = pool_priv->max_priv_session_sz; @@ -1969,7 +1971,7 @@ rte_cryptodev_asym_session_create(uint8_t dev_id, /* Clear device session pointer.*/ memset(sess->sess_private_data, 0, session_priv_data_sz + sess->user_data_sz); - RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_configure, NULL); + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_configure, -ENOTSUP); if (sess->sess_private_data[0] == 0) { ret = dev->dev_ops->asym_session_configure(dev, xforms, sess); @@ -1977,12 +1979,12 @@ rte_cryptodev_asym_session_create(uint8_t dev_id, CDEV_LOG_ERR( "dev_id %d failed to configure session details", dev_id); - return NULL; + return ret; } } - rte_cryptodev_trace_asym_session_create(dev_id, xforms, mp); - return sess; + rte_cryptodev_trace_asym_session_create(dev_id, xforms, mp, sess); + return 0; } int diff --git a/lib/cryptodev/rte_cryptodev.h b/lib/cryptodev/rte_cryptodev.h index 1d7bd07680..19e2e70287 100644 --- a/lib/cryptodev/rte_cryptodev.h +++ b/lib/cryptodev/rte_cryptodev.h @@ -996,14 +996,19 @@ rte_cryptodev_sym_session_create(struct rte_mempool *mempool); * processed with this session * @param mp mempool to allocate asymmetric session * objects from + * @param session void ** for session to be used + * * @return - * - On success return pointer to asym-session - * - On failure returns NULL + * - 0 on success. + * - -EINVAL on invalid arguments. + * - -ENOMEM on memory error for session allocation. + * - -ENOTSUP if device doesn't support session configuration. */ __rte_experimental -void * +int rte_cryptodev_asym_session_create(uint8_t dev_id, - struct rte_crypto_asym_xform *xforms, struct rte_mempool *mp); + struct rte_crypto_asym_xform *xforms, struct rte_mempool *mp, + void **session); /** * Frees symmetric crypto session header, after checking that all diff --git a/lib/cryptodev/rte_cryptodev_trace.h b/lib/cryptodev/rte_cryptodev_trace.h index 005a4fe38b..a3f6048e7d 100644 --- a/lib/cryptodev/rte_cryptodev_trace.h +++ b/lib/cryptodev/rte_cryptodev_trace.h @@ -96,10 +96,12 @@ RTE_TRACE_POINT( RTE_TRACE_POINT( rte_cryptodev_trace_asym_session_create, - RTE_TRACE_POINT_ARGS(uint8_t dev_id, void *xforms, void *mempool), + RTE_TRACE_POINT_ARGS(uint8_t dev_id, void *xforms, void *mempool, + void *sess), rte_trace_point_emit_u8(dev_id); rte_trace_point_emit_ptr(xforms); rte_trace_point_emit_ptr(mempool); + rte_trace_point_emit_ptr(sess); ) RTE_TRACE_POINT( -- 2.39.5