cryptodev: rename functions to get session size

rte_cryptodev_get_header_session_size() and
rte_cryptodev_get_private_session_size() functions are
targeting symmetric sessions.

With the future addition of asymmetric operations,
these functions need to be renamed from *cryptodev_*_session_*
to *cryptodev_sym_*_session_* to be symmetric specific.

The two original functions are marked as deprecated
and will be removed in 18.08, so applications can still
use the functions in 18.05.

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Shally Verma <shally.verma@caviumnetworks.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Acked-by: Deepak Kumar Jain <deepak.k.jain@intel.com>

diff --git a/app/test-crypto-perf/main.c b/app/test-crypto-perf/main.c
index 26e78ff43acc0a0ec8b685874ada263aa328c421..4ae14390b1cc842cf7fa67410c558f11e4400338 100644 (file)
--- a/app/test-crypto-perf/main.c
+++ b/app/test-crypto-perf/main.c
@@ -97,7 +97,7 @@ cperf_initialize_cryptodev(struct cperf_options *opts, uint8_t *enabled_cdevs,
        uint32_t max_sess_size = 0, sess_size;
 
        for (cdev_id = 0; cdev_id < rte_cryptodev_count(); cdev_id++) {
-               sess_size = rte_cryptodev_get_private_session_size(cdev_id);
+               sess_size = rte_cryptodev_sym_get_private_session_size(cdev_id);
                if (sess_size > max_sess_size)
                        max_sess_size = sess_size;
        }

diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst
index b279a20e5f8814211b650113b0ed4a091a7a85ec..30f0bcf7a8dc4fd4921e91e796aeb24d9a553176 100644 (file)
--- a/doc/guides/prog_guide/cryptodev_lib.rst
+++ b/doc/guides/prog_guide/cryptodev_lib.rst
@@ -454,12 +454,12 @@ mempool for all crypto devices (where the mempool object size is big
 enough to hold the private session of any crypto device), as well as having
 multiple session mempools of different sizes for better memory usage.
 
-An application can use ``rte_cryptodev_get_private_session_size()`` to
+An application can use ``rte_cryptodev_sym_get_private_session_size()`` to
 get the private session size of given crypto device. This function would allow
 an application to calculate the max device session size of all crypto devices
 to create a single session mempool.
 If instead an application creates multiple session mempools, the Crypto device
-framework also provides ``rte_cryptodev_get_header_session_size`` to get
+framework also provides ``rte_cryptodev_sym_get_header_session_size`` to get
 the size of an uninitialized session.
 
 Once the session mempools have been created, ``rte_cryptodev_sym_session_create()``
@@ -662,7 +662,7 @@ using one of the crypto PMDs available in DPDK.
     uint8_t cdev_id = rte_cryptodev_get_dev_id(crypto_name);
 
     /* Get private session data size. */
-    session_size = rte_cryptodev_get_private_session_size(cdev_id);
+    session_size = rte_cryptodev_sym_get_private_session_size(cdev_id);
 
     /*
      * Create session mempool, with two objects per session,

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 2819b486444ca23d0695ee53fdf232d42ab64071..1e2443c76d06650dffc06a71f4741b413feba388 100644 (file)
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -90,3 +90,9 @@ Deprecation Notices
     with them.
   - Some feature flags such as ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` are ambiguous,
     so some will be replaced by more explicit flags.
+  - Function ``rte_cryptodev_get_header_session_size()`` will be deprecated
+    in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_header_session_size()``.
+    It will be removed in 18.08.
+  - Function ``rte_cryptodev_get_private_session_size()`` will be deprecated
+    in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_private_session_size()``.
+    It will be removed in 18.08.

diff --git a/drivers/crypto/aesni_gcm/aesni_gcm_pmd.c b/drivers/crypto/aesni_gcm/aesni_gcm_pmd.c
index bc5ee1b73f61022b1b452feeccdf7dd2cdc3d8d0..80360dd9c29bd20bff0bb0e84d5ebaf3a9baeb9e 100644 (file)
--- a/drivers/crypto/aesni_gcm/aesni_gcm_pmd.c
+++ b/drivers/crypto/aesni_gcm/aesni_gcm_pmd.c
@@ -392,7 +392,7 @@ handle_completed_gcm_crypto_op(struct aesni_gcm_qp *qp,
        if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
                memset(sess, 0, sizeof(struct aesni_gcm_session));
                memset(op->sym->session, 0,
-                               rte_cryptodev_get_header_session_size());
+                               rte_cryptodev_sym_get_header_session_size());
                rte_mempool_put(qp->sess_mp, sess);
                rte_mempool_put(qp->sess_mp, op->sym->session);
                op->sym->session = NULL;

diff --git a/drivers/crypto/aesni_mb/rte_aesni_mb_pmd.c b/drivers/crypto/aesni_mb/rte_aesni_mb_pmd.c
index 2e500784dd776ea1d98a5bcfca256d439b1814ea..bb35c66abb85ed2e01aba6d8a41ac2cc864a81aa 100644 (file)
--- a/drivers/crypto/aesni_mb/rte_aesni_mb_pmd.c
+++ b/drivers/crypto/aesni_mb/rte_aesni_mb_pmd.c
@@ -682,7 +682,7 @@ post_process_mb_job(struct aesni_mb_qp *qp, JOB_AES_HMAC *job)
        if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
                memset(sess, 0, sizeof(struct aesni_mb_session));
                memset(op->sym->session, 0,
-                               rte_cryptodev_get_header_session_size());
+                               rte_cryptodev_sym_get_header_session_size());
                rte_mempool_put(qp->sess_mp, sess);
                rte_mempool_put(qp->sess_mp, op->sym->session);
                op->sym->session = NULL;

diff --git a/drivers/crypto/armv8/rte_armv8_pmd.c b/drivers/crypto/armv8/rte_armv8_pmd.c
index 1fe82ccadce170c409d0918cfab76c5d73cf5d9c..fbb08f729a34d2164f1a267ba53baf591a108c4e 100644 (file)
--- a/drivers/crypto/armv8/rte_armv8_pmd.c
+++ b/drivers/crypto/armv8/rte_armv8_pmd.c
@@ -654,7 +654,7 @@ process_op(struct armv8_crypto_qp *qp, struct rte_crypto_op *op,
        if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
                memset(sess, 0, sizeof(struct armv8_crypto_session));
                memset(op->sym->session, 0,
-                               rte_cryptodev_get_header_session_size());
+                               rte_cryptodev_sym_get_header_session_size());
                rte_mempool_put(qp->sess_mp, sess);
                rte_mempool_put(qp->sess_mp, op->sym->session);
                op->sym->session = NULL;

diff --git a/drivers/crypto/kasumi/rte_kasumi_pmd.c b/drivers/crypto/kasumi/rte_kasumi_pmd.c
index 08ee900511c9b589aa559b8212484c1da9d6c1ce..205dc1de7dfbb0829f486f70df5e6132d67f4332 100644 (file)
--- a/drivers/crypto/kasumi/rte_kasumi_pmd.c
+++ b/drivers/crypto/kasumi/rte_kasumi_pmd.c
@@ -320,7 +320,7 @@ process_ops(struct rte_crypto_op **ops, struct kasumi_session *session,
                if (ops[i]->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
                        memset(session, 0, sizeof(struct kasumi_session));
                        memset(ops[i]->sym->session, 0,
-                                       rte_cryptodev_get_header_session_size());
+                                       rte_cryptodev_sym_get_header_session_size());
                        rte_mempool_put(qp->sess_mp, session);
                        rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
                        ops[i]->sym->session = NULL;

diff --git a/drivers/crypto/openssl/rte_openssl_pmd.c b/drivers/crypto/openssl/rte_openssl_pmd.c
index f584d0d6f14958b9ff0e7b79a8c29b04b5a4d0db..93c6d7e5df94fce0649c081ce607d8c06eb9cec9 100644 (file)
--- a/drivers/crypto/openssl/rte_openssl_pmd.c
+++ b/drivers/crypto/openssl/rte_openssl_pmd.c
@@ -1569,7 +1569,7 @@ process_op(struct openssl_qp *qp, struct rte_crypto_op *op,
                openssl_reset_session(sess);
                memset(sess, 0, sizeof(struct openssl_session));
                memset(op->sym->session, 0,
-                               rte_cryptodev_get_header_session_size());
+                               rte_cryptodev_sym_get_header_session_size());
                rte_mempool_put(qp->sess_mp, sess);
                rte_mempool_put(qp->sess_mp, op->sym->session);
                op->sym->session = NULL;

diff --git a/drivers/crypto/snow3g/rte_snow3g_pmd.c b/drivers/crypto/snow3g/rte_snow3g_pmd.c
index 5edc0fa0fd8363b8bf5d0acad19de35957f474c8..72751e35ef353afc2a0e05ec7f46bc777201335a 100644 (file)
--- a/drivers/crypto/snow3g/rte_snow3g_pmd.c
+++ b/drivers/crypto/snow3g/rte_snow3g_pmd.c
@@ -339,7 +339,7 @@ process_ops(struct rte_crypto_op **ops, struct snow3g_session *session,
                if (ops[i]->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
                        memset(session, 0, sizeof(struct snow3g_session));
                        memset(ops[i]->sym->session, 0,
-                                       rte_cryptodev_get_header_session_size());
+                                       rte_cryptodev_sym_get_header_session_size());
                        rte_mempool_put(qp->sess_mp, session);
                        rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
                        ops[i]->sym->session = NULL;

diff --git a/drivers/crypto/zuc/rte_zuc_pmd.c b/drivers/crypto/zuc/rte_zuc_pmd.c
index cd38f30309e59fe9b004bcf6ae17cdc8f12dda68..a805b227847cc3268b7c2ff1965c09573a7447b9 100644 (file)
--- a/drivers/crypto/zuc/rte_zuc_pmd.c
+++ b/drivers/crypto/zuc/rte_zuc_pmd.c
@@ -327,7 +327,7 @@ process_ops(struct rte_crypto_op **ops, enum zuc_operation op_type,
                if (ops[i]->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
                        memset(sessions[i], 0, sizeof(struct zuc_session));
                        memset(ops[i]->sym->session, 0,
-                                       rte_cryptodev_get_header_session_size());
+                                       rte_cryptodev_sym_get_header_session_size());
                        rte_mempool_put(qp->sess_mp, sessions[i]);
                        rte_mempool_put(qp->sess_mp, ops[i]->sym->session);
                        ops[i]->sym->session = NULL;

diff --git a/examples/ipsec-secgw/ipsec-secgw.c b/examples/ipsec-secgw/ipsec-secgw.c
index c94118ef5b47dde9d75451e077b73cf5b8afd95c..a5da8b280a88be1bbef3031bc3a7d990480014ee 100644 (file)
--- a/examples/ipsec-secgw/ipsec-secgw.c
+++ b/examples/ipsec-secgw/ipsec-secgw.c
@@ -1390,7 +1390,7 @@ cryptodevs_init(void)
 
        uint32_t max_sess_sz = 0, sess_sz;
        for (cdev_id = 0; cdev_id < rte_cryptodev_count(); cdev_id++) {
-               sess_sz = rte_cryptodev_get_private_session_size(cdev_id);
+               sess_sz = rte_cryptodev_sym_get_private_session_size(cdev_id);
                if (sess_sz > max_sess_sz)
                        max_sess_sz = sess_sz;
        }

diff --git a/examples/l2fwd-crypto/main.c b/examples/l2fwd-crypto/main.c
index f4e3e0b1052fe4ca9ffbadff5da318aa06d43523..4bca87b19487b2d9601a2d5c7f7107b9d1db0eab 100644 (file)
--- a/examples/l2fwd-crypto/main.c
+++ b/examples/l2fwd-crypto/main.c
@@ -1982,7 +1982,7 @@ initialize_cryptodevs(struct l2fwd_crypto_options *options, unsigned nb_ports,
        }
 
        for (cdev_id = 0; cdev_id < cdev_count; cdev_id++) {
-               sess_sz = rte_cryptodev_get_private_session_size(cdev_id);
+               sess_sz = rte_cryptodev_sym_get_private_session_size(cdev_id);
                if (sess_sz > max_sess_sz)
                        max_sess_sz = sess_sz;
        }

diff --git a/examples/vhost_crypto/main.c b/examples/vhost_crypto/main.c
index 860200e2943277763f35fb1c896de4c7b377d779..f334d7123eb948a7bedb660296a89f710cb4c4ac 100644 (file)
--- a/examples/vhost_crypto/main.c
+++ b/examples/vhost_crypto/main.c
@@ -450,7 +450,7 @@ main(int argc, char *argv[])
 
        snprintf(name, 127, "SESS_POOL_%u", worker_lcore);
        info.sess_pool = rte_mempool_create(name, SESSION_MAP_ENTRIES,
-                       rte_cryptodev_get_private_session_size(
+                       rte_cryptodev_sym_get_private_session_size(
                        cryptodev_id), 64, 0, NULL, NULL, NULL, NULL,
                        rte_lcore_to_socket_id(worker_lcore), 0);
        if (!info.sess_pool) {

diff --git a/lib/librte_cryptodev/rte_cryptodev.c b/lib/librte_cryptodev/rte_cryptodev.c
index 2f97ce2e8fa3d1dea5d1ae130b911b5669119ad1..7e582124642e939f0d2018cd714bb156d674251c 100644 (file)
--- a/lib/librte_cryptodev/rte_cryptodev.c
+++ b/lib/librte_cryptodev/rte_cryptodev.c
@@ -1226,6 +1226,12 @@ rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
 
 unsigned int
 rte_cryptodev_get_header_session_size(void)
+{
+       return rte_cryptodev_sym_get_header_session_size();
+}
+
+unsigned int
+rte_cryptodev_sym_get_header_session_size(void)
 {
        /*
         * Header contains pointers to the private data
@@ -1237,6 +1243,12 @@ rte_cryptodev_get_header_session_size(void)
 
 unsigned int
 rte_cryptodev_get_private_session_size(uint8_t dev_id)
+{
+       return rte_cryptodev_sym_get_private_session_size(dev_id);
+}
+
+unsigned int
+rte_cryptodev_sym_get_private_session_size(uint8_t dev_id)
 {
        struct rte_cryptodev *dev;
        unsigned int header_size = sizeof(void *) * nb_drivers;

diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index 972f11f72da468137fd5adcf6eefa8a6c3ddd8e2..92ce6d49a213ab5cba656401abe1a988606931d5 100644 (file)
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -972,15 +972,18 @@ rte_cryptodev_sym_session_clear(uint8_t dev_id,
                        struct rte_cryptodev_sym_session *sess);
 
 /**
+ * @deprecated
  * Get the size of the header session, for all registered drivers.
  *
  * @return
  *   Size of the header session.
  */
+__rte_deprecated
 unsigned int
 rte_cryptodev_get_header_session_size(void);
 
 /**
+ * @deprecated
  * Get the size of the private session data for a device.
  *
  * @param      dev_id          The device identifier.
@@ -989,9 +992,33 @@ rte_cryptodev_get_header_session_size(void);
  *   - Size of the private data, if successful
  *   - 0 if device is invalid or does not have private session
  */
+__rte_deprecated
 unsigned int
 rte_cryptodev_get_private_session_size(uint8_t dev_id);
 
+/**
+ * Get the size of the header session, for all registered drivers.
+ *
+ * @return
+ *   Size of the symmetric eader session.
+ */
+unsigned int
+rte_cryptodev_sym_get_header_session_size(void);
+
+/**
+ * Get the size of the private symmetric session data
+ * for a device.
+ *
+ * @param      dev_id          The device identifier.
+ *
+ * @return
+ *   - Size of the private data, if successful
+ *   - 0 if device is invalid or does not have private
+ *   symmetric session
+ */
+unsigned int
+rte_cryptodev_sym_get_private_session_size(uint8_t dev_id);
+
 /**
  * @deprecated
  * Attach queue pair with sym session.

diff --git a/lib/librte_cryptodev/rte_cryptodev_version.map b/lib/librte_cryptodev/rte_cryptodev_version.map
index da6905ee67425a11ea1979c5eb411a3d78ceba42..be8f4c1a7079043f9c72e6a7e8446f2612d21497 100644 (file)
--- a/lib/librte_cryptodev/rte_cryptodev_version.map
+++ b/lib/librte_cryptodev/rte_cryptodev_version.map
@@ -86,6 +86,14 @@ DPDK_17.11 {
 
 } DPDK_17.08;
 
+DPDK_18.05 {
+       global:
+
+       rte_cryptodev_sym_get_header_session_size;
+       rte_cryptodev_sym_get_private_session_size;
+
+} DPDK_17.11;
+
 EXPERIMENTAL {
         global:
 

diff --git a/test/test/test_cryptodev.c b/test/test/test_cryptodev.c
index 940e3378a12a2e75c4f3f38d36e8996a30bd49fb..389f79677d8aee922a0fe712a11eec59c156d1cb 100644 (file)
--- a/test/test/test_cryptodev.c
+++ b/test/test/test_cryptodev.c
@@ -428,7 +428,8 @@ testsuite_setup(void)
        ts_params->conf.nb_queue_pairs = info.max_nb_queue_pairs;
        ts_params->conf.socket_id = SOCKET_ID_ANY;
 
-       unsigned int session_size = rte_cryptodev_get_private_session_size(dev_id);
+       unsigned int session_size =
+               rte_cryptodev_sym_get_private_session_size(dev_id);
 
        /*
         * Create mempool with maximum number of sessions * 2,
@@ -8534,7 +8535,8 @@ test_scheduler_attach_slave_op(void)
                        rte_mempool_free(ts_params->session_mpool);
                        ts_params->session_mpool = NULL;
                }
-               unsigned int session_size = rte_cryptodev_get_private_session_size(i);
+               unsigned int session_size =
+                       rte_cryptodev_sym_get_private_session_size(i);
 
                /*
                 * Create mempool with maximum number of sessions * 2,

diff --git a/test/test/test_event_crypto_adapter.c b/test/test/test_event_crypto_adapter.c
index 6f0e794609b9c5d799c2d453443cfe31c0d4e4c5..066b0adef1709737632c000ef771f33271c591e0 100644 (file)
--- a/test/test/test_event_crypto_adapter.c
+++ b/test/test/test_event_crypto_adapter.c
@@ -523,7 +523,7 @@ configure_cryptodev(void)
         * Create mempool with maximum number of sessions * 2,
         * to include the session headers & private data
         */
-       session_size = rte_cryptodev_get_private_session_size(TEST_CDEV_ID);
+       session_size = rte_cryptodev_sym_get_private_session_size(TEST_CDEV_ID);
        session_size += sizeof(union rte_event_crypto_metadata);
 
        params.session_mpool = rte_mempool_create(