cryptodev: hide asymmetric session structure

The rte_cryptodev_asym_session structure is now moved to an internal
header. This will no longer be used directly by apps,
private session data can be accessed via get API.

Signed-off-by: Ciara Power <ciara.power@intel.com>
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
Acked-by: Anoob Joseph <anoobj@marvell.com>
Acked-by: Akhil Goyal <gakhil@marvell.com>

diff --git a/app/test-crypto-perf/cperf_ops.c b/app/test-crypto-perf/cperf_ops.c
index b125c699defa6e6be4a46f681c72d2013ea132cb..b8f590b397554f8e3b37cbafd805480b3b3e0579 100644 (file)
--- a/app/test-crypto-perf/cperf_ops.c
+++ b/app/test-crypto-perf/cperf_ops.c
@@ -21,7 +21,7 @@ cperf_set_ops_asym(struct rte_crypto_op **ops,
                   uint64_t *tsc_start __rte_unused)
 {
        uint16_t i;
-       struct rte_cryptodev_asym_session *asym_sess = (void *)sess;
+       void *asym_sess = (void *)sess;
 
        for (i = 0; i < nb_ops; i++) {
                struct rte_crypto_asym_op *asym_op = ops[i]->asym;

diff --git a/app/test/test_cryptodev_asym.c b/app/test/test_cryptodev_asym.c
index 283b38ec9a851c5f3b06202927c02338728ed57d..d8906c679c862b3909e4fcb3fece08ea768754d2 100644 (file)
--- a/app/test/test_cryptodev_asym.c
+++ b/app/test/test_cryptodev_asym.c
@@ -46,7 +46,7 @@ struct crypto_testsuite_params_asym {
 };
 
 struct crypto_unittest_params {
-       struct rte_cryptodev_asym_session *sess;
+       void *sess;
        struct rte_crypto_op *op;
 };
 
@@ -67,7 +67,7 @@ static uint32_t test_index;
 static struct crypto_testsuite_params_asym testsuite_params = { NULL };
 
 static int
-queue_ops_rsa_sign_verify(struct rte_cryptodev_asym_session *sess)
+queue_ops_rsa_sign_verify(void *sess)
 {
        struct crypto_testsuite_params_asym *ts_params = &testsuite_params;
        struct rte_mempool *op_mpool = ts_params->op_mpool;
@@ -158,7 +158,7 @@ error_exit:
 }
 
 static int
-queue_ops_rsa_enc_dec(struct rte_cryptodev_asym_session *sess)
+queue_ops_rsa_enc_dec(void *sess)
 {
        struct crypto_testsuite_params_asym *ts_params = &testsuite_params;
        struct rte_mempool *op_mpool = ts_params->op_mpool;
@@ -310,7 +310,7 @@ test_cryptodev_asym_op(struct crypto_testsuite_params_asym *ts_params,
        struct rte_crypto_op *op = NULL;
        struct rte_crypto_op *result_op = NULL;
        struct rte_crypto_asym_xform xform_tc;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        struct rte_cryptodev_asym_capability_idx cap_idx;
        const struct rte_cryptodev_asymmetric_xform_capability *capability;
        uint8_t dev_id = ts_params->valid_devs[0];
@@ -643,7 +643,7 @@ test_rsa_sign_verify(void)
        struct crypto_testsuite_params_asym *ts_params = &testsuite_params;
        struct rte_mempool *sess_mpool = ts_params->session_mpool;
        uint8_t dev_id = ts_params->valid_devs[0];
-       struct rte_cryptodev_asym_session *sess;
+       void *sess = NULL;
        struct rte_cryptodev_info dev_info;
        int status = TEST_SUCCESS;
 
@@ -683,7 +683,7 @@ test_rsa_enc_dec(void)
        struct crypto_testsuite_params_asym *ts_params = &testsuite_params;
        struct rte_mempool *sess_mpool = ts_params->session_mpool;
        uint8_t dev_id = ts_params->valid_devs[0];
-       struct rte_cryptodev_asym_session *sess;
+       void *sess = NULL;
        struct rte_cryptodev_info dev_info;
        int status = TEST_SUCCESS;
 
@@ -723,7 +723,7 @@ test_rsa_sign_verify_crt(void)
        struct crypto_testsuite_params_asym *ts_params = &testsuite_params;
        struct rte_mempool *sess_mpool = ts_params->session_mpool;
        uint8_t dev_id = ts_params->valid_devs[0];
-       struct rte_cryptodev_asym_session *sess;
+       void *sess = NULL;
        struct rte_cryptodev_info dev_info;
        int status = TEST_SUCCESS;
 
@@ -763,7 +763,7 @@ test_rsa_enc_dec_crt(void)
        struct crypto_testsuite_params_asym *ts_params = &testsuite_params;
        struct rte_mempool *sess_mpool = ts_params->session_mpool;
        uint8_t dev_id = ts_params->valid_devs[0];
-       struct rte_cryptodev_asym_session *sess;
+       void *sess = NULL;
        struct rte_cryptodev_info dev_info;
        int status = TEST_SUCCESS;
 
@@ -1045,7 +1045,7 @@ test_dh_gen_shared_sec(struct rte_crypto_asym_xform *xfrm)
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_asym_op *asym_op = NULL;
        struct rte_crypto_op *op = NULL, *result_op = NULL;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        int status = TEST_SUCCESS;
        uint8_t output[TEST_DH_MOD_LEN];
        struct rte_crypto_asym_xform xform = *xfrm;
@@ -1128,7 +1128,7 @@ test_dh_gen_priv_key(struct rte_crypto_asym_xform *xfrm)
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_asym_op *asym_op = NULL;
        struct rte_crypto_op *op = NULL, *result_op = NULL;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        int status = TEST_SUCCESS;
        uint8_t output[TEST_DH_MOD_LEN];
        struct rte_crypto_asym_xform xform = *xfrm;
@@ -1209,7 +1209,7 @@ test_dh_gen_pub_key(struct rte_crypto_asym_xform *xfrm)
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_asym_op *asym_op = NULL;
        struct rte_crypto_op *op = NULL, *result_op = NULL;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        int status = TEST_SUCCESS;
        uint8_t output[TEST_DH_MOD_LEN];
        struct rte_crypto_asym_xform xform = *xfrm;
@@ -1298,7 +1298,7 @@ test_dh_gen_kp(struct rte_crypto_asym_xform *xfrm)
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_asym_op *asym_op = NULL;
        struct rte_crypto_op *op = NULL, *result_op = NULL;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        int status = TEST_SUCCESS;
        uint8_t out_pub_key[TEST_DH_MOD_LEN];
        uint8_t out_prv_key[TEST_DH_MOD_LEN];
@@ -1385,7 +1385,7 @@ test_mod_inv(void)
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_asym_op *asym_op = NULL;
        struct rte_crypto_op *op = NULL, *result_op = NULL;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        int status = TEST_SUCCESS;
        struct rte_cryptodev_asym_capability_idx cap_idx;
        const struct rte_cryptodev_asymmetric_xform_capability *capability;
@@ -1498,7 +1498,7 @@ test_mod_exp(void)
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_asym_op *asym_op = NULL;
        struct rte_crypto_op *op = NULL, *result_op = NULL;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        int status = TEST_SUCCESS;
        struct rte_cryptodev_asym_capability_idx cap_idx;
        const struct rte_cryptodev_asymmetric_xform_capability *capability;
@@ -1647,7 +1647,7 @@ test_dsa_sign(void)
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_asym_op *asym_op = NULL;
        struct rte_crypto_op *op = NULL, *result_op = NULL;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        int status = TEST_SUCCESS;
        uint8_t r[TEST_DH_MOD_LEN];
        uint8_t s[TEST_DH_MOD_LEN];
@@ -1778,7 +1778,7 @@ test_ecdsa_sign_verify(enum curve curve_id)
        struct rte_mempool *sess_mpool = ts_params->session_mpool;
        struct rte_mempool *op_mpool = ts_params->op_mpool;
        struct crypto_testsuite_ecdsa_params input_params;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_op *result_op = NULL;
        uint8_t output_buf_r[TEST_DATA_SIZE];
@@ -1980,7 +1980,7 @@ test_ecpm(enum curve curve_id)
        struct rte_mempool *sess_mpool = ts_params->session_mpool;
        struct rte_mempool *op_mpool = ts_params->op_mpool;
        struct crypto_testsuite_ecpm_params input_params;
-       struct rte_cryptodev_asym_session *sess = NULL;
+       void *sess = NULL;
        uint8_t dev_id = ts_params->valid_devs[0];
        struct rte_crypto_op *result_op = NULL;
        uint8_t output_buf_x[TEST_DATA_SIZE];

diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst
index b4dbd384bf5a603083d02382f02577476cc3acd0..2607a9a7d72f1db855cbdab1cc246bab8f2d149e 100644 (file)
--- a/doc/guides/prog_guide/cryptodev_lib.rst
+++ b/doc/guides/prog_guide/cryptodev_lib.rst
@@ -1155,6 +1155,10 @@ Generate crypto op, create and attach a session, then process packets.
    :end-before: >8 End of create op, create session, and process packets section.
    :dedent: 1
 
+.. note::
+   The ``rte_cryptodev_asym_session`` struct is hidden from the application.
+   The ``sess`` pointer used above is a void pointer.
+
 
 Asymmetric Crypto Device API
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/doc/guides/rel_notes/release_22_03.rst b/doc/guides/rel_notes/release_22_03.rst
index cdfabdc23f1f01ac56738eddc3ef3507585b4ff2..697fe4784194b8ab6a2dfc0af21a686848d133a5 100644 (file)
--- a/doc/guides/rel_notes/release_22_03.rst
+++ b/doc/guides/rel_notes/release_22_03.rst
@@ -187,6 +187,8 @@ API Changes
   mempool object. An API ``rte_cryptodev_asym_session_pool_create`` was added
   to create a mempool with element size big enough to hold the generic asymmetric
   session header and max size for a device private session data.
+  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``.
 

diff --git a/lib/cryptodev/cryptodev_pmd.h b/lib/cryptodev/cryptodev_pmd.h
index 142bfb7c6697939770998ed497d86ff674d8b835..63f9cf5427318a5d958afc52bf33737bc15acb18 100644 (file)
--- a/lib/cryptodev/cryptodev_pmd.h
+++ b/lib/cryptodev/cryptodev_pmd.h
@@ -625,4 +625,17 @@ set_sym_session_private_data(struct rte_cryptodev_sym_session *sess,
        sess->sess_data[driver_id].data = private_data;
 }
 
+/**
+ * @internal
+ * Cryptodev asymmetric crypto session.
+ */
+RTE_STD_C11 struct rte_cryptodev_asym_session {
+       uint8_t driver_id;
+       /**< Session driver ID. */
+       uint16_t max_priv_data_sz;
+       /**< Size of private data used when creating mempool */
+       uint8_t padding[5];
+       uint8_t sess_private_data[0];
+};
+
 #endif /* _CRYPTODEV_PMD_H_ */

diff --git a/lib/cryptodev/rte_cryptodev.c b/lib/cryptodev/rte_cryptodev.c
index b056d88ac24aed893b2519b9c5e3ab0d9eda53f3..562cb4a2c489b91db1212611c3c53608ad3ccd2c 100644 (file)
--- a/lib/cryptodev/rte_cryptodev.c
+++ b/lib/cryptodev/rte_cryptodev.c
@@ -1908,7 +1908,7 @@ rte_cryptodev_sym_session_create(struct rte_mempool *mp)
        return sess;
 }
 
-struct rte_cryptodev_asym_session *
+void *
 rte_cryptodev_asym_session_create(uint8_t dev_id,
                struct rte_crypto_asym_xform *xforms, struct rte_mempool *mp)
 {
@@ -2035,8 +2035,7 @@ rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
 }
 
 int
-rte_cryptodev_asym_session_free(uint8_t dev_id,
-               struct rte_cryptodev_asym_session *sess)
+rte_cryptodev_asym_session_free(uint8_t dev_id, void *sess)
 {
        struct rte_mempool *sess_mp;
        struct rte_cryptodev *dev;

diff --git a/lib/cryptodev/rte_cryptodev.h b/lib/cryptodev/rte_cryptodev.h
index 90e764017db66178b1c82104646e4fda90d725b6..4cf3f6c9d7096bd0c50e007135b55c940ff0022e 100644 (file)
--- a/lib/cryptodev/rte_cryptodev.h
+++ b/lib/cryptodev/rte_cryptodev.h
@@ -918,16 +918,6 @@ struct rte_cryptodev_sym_session {
        /**< Driver specific session material, variable size */
 };
 
-/** Cryptodev asymmetric crypto session */
-RTE_STD_C11 struct rte_cryptodev_asym_session {
-       uint8_t driver_id;
-       /**< Session driver ID. */
-       uint16_t max_priv_data_sz;
-       /**< Size of private data used when creating mempool */
-       uint8_t padding[5];
-       uint8_t sess_private_data[0];
-};
-
 /**
  * Create a symmetric session mempool.
  *
@@ -1009,7 +999,7 @@ rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
  *  - On failure returns NULL
  */
 __rte_experimental
-struct rte_cryptodev_asym_session *
+void *
 rte_cryptodev_asym_session_create(uint8_t dev_id,
                struct rte_crypto_asym_xform *xforms, struct rte_mempool *mp);
 
@@ -1041,8 +1031,7 @@ rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
  */
 __rte_experimental
 int
-rte_cryptodev_asym_session_free(uint8_t dev_id,
-               struct rte_cryptodev_asym_session *sess);
+rte_cryptodev_asym_session_free(uint8_t dev_id, void *sess);
 
 /**
  * Fill out private data for the device id, based on its device type.

diff --git a/lib/cryptodev/rte_cryptodev_trace.h b/lib/cryptodev/rte_cryptodev_trace.h
index a4fa9e8c7e60c98d1df15b3c52167f0e689a1698..4b48c6619976009a8384b5f00c6885ef2b43dcf7 100644 (file)
--- a/lib/cryptodev/rte_cryptodev_trace.h
+++ b/lib/cryptodev/rte_cryptodev_trace.h
@@ -109,8 +109,7 @@ RTE_TRACE_POINT(
 
 RTE_TRACE_POINT(
        rte_cryptodev_trace_asym_session_free,
-       RTE_TRACE_POINT_ARGS(uint8_t dev_id,
-               struct rte_cryptodev_asym_session *sess),
+       RTE_TRACE_POINT_ARGS(uint8_t dev_id, void *sess),
        rte_trace_point_emit_u8(dev_id);
        rte_trace_point_emit_ptr(sess);
 )