doc: announce change of security session API
authorAkhil Goyal <akhil.goyal@nxp.com>
Thu, 30 Jul 2020 17:13:30 +0000 (22:43 +0530)
committerThomas Monjalon <thomas@monjalon.net>
Thu, 6 Aug 2020 17:01:17 +0000 (19:01 +0200)
The API ``rte_security_session_create`` takes only single mempool
for session and session private data. So the application need to create
mempool for twice the number of sessions needed and will also lead to
wastage of memory as session private data need more memory compared to session.
Hence the API will be modified to take two mempool pointers - one for session
and one for private data. This is very similar to crypto based session
create APIs.

Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Anoob Joseph <anoobj@marvell.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
doc/guides/rel_notes/deprecation.rst

index 957361a..67f977b 100644 (file)
@@ -187,6 +187,13 @@ Deprecation Notices
 * pmd_dpaa: The API ``rte_pmd_dpaa_set_tx_loopback`` will have extended
   ``port_id`` definition from ``uint8_t`` to ``uint16_t``.
 
+* security: The API ``rte_security_session_create`` takes only single mempool
+  for session and session private data. So the application need to create
+  mempool for twice the number of sessions needed and will also lead to
+  wastage of memory as session private data need more memory compared to session.
+  Hence the API will be modified to take two mempool pointers - one for session
+  and one for private data.
+
 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
   ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
   ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``