cryptodev: clarify when session can be cleared
authorFiona Trahe <fiona.trahe@intel.com>
Tue, 22 May 2018 10:36:51 +0000 (11:36 +0100)
committerPablo de Lara <pablo.de.lara.guarch@intel.com>
Tue, 22 May 2018 14:36:12 +0000 (16:36 +0200)
Session data can only be cleared once there are no
inflight operations using the session. It is the application's
responsability to make sure of this.

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
lib/librte_cryptodev/rte_cryptodev.h

index 2fb6563..eb6c66f 100644 (file)
@@ -952,7 +952,9 @@ rte_cryptodev_sym_session_init(uint8_t dev_id,
 
 /**
  * Frees private data for the device id, based on its device type,
- * returning it to its mempool.
+ * returning it to its mempool. It is the application's responsibility
+ * to ensure that private session data is not cleared while there are
+ * still in-flight operations using it.
  *
  * @param   dev_id   ID of device that uses the session.
  * @param   sess     Session containing the reference to the private data