[dpdk-dev] [PATCH v2 1/2] cryptodev: add api for attach-detach session with queue pair

[Trahe, Fiona]

Hi Akhil

> -----Original Message-----
> From: akhil.goyal at nxp.com [mailto:akhil.goyal at nxp.com]
> Sent: Thursday, March 23, 2017 8:07 AM
> To: dev at dpdk.org
> Cc: Gonzalez Monroy, Sergio <sergio.gonzalez.monroy at intel.com>; Doherty,
> Declan <declan.doherty at intel.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch at intel.com>; Trahe, Fiona <fiona.trahe at intel.com>;
> hemant.agrawal at nxp.com; Akhil Goyal <akhil.goyal at nxp.com>
> Subject: [PATCH v2 1/2] cryptodev: add api for attach-detach session with
> queue pair
> 
> From: Akhil Goyal <akhil.goyal at nxp.com>
> 
> HW based crypto drivers may only support limited number of
> sessions per queue pair. This requires support for attaching
> sessions to specific queue pair.  New APIs  are introduced to
> attach/detach a session with/from a particular queue pair.
> These are optional APIs.
> 
> Application can call attach API after creating a session
> and can call detach API before deleting a session.
> 
> Application needs to check if max_nb_sessions_per_qp > 0,
> then it should call the attach API.
> 
> max_nb_sessions_per_qp = 0 means infinite sessions per qp
> 
> Signed-off-by: Akhil Goyal <akhil.goyal at nxp.com>
> ---
>  lib/librte_cryptodev/rte_cryptodev.c           | 47
> ++++++++++++++++++++++++++
>  lib/librte_cryptodev/rte_cryptodev.h           | 34 +++++++++++++++++++
>  lib/librte_cryptodev/rte_cryptodev_pmd.h       | 29 ++++++++++++++++
>  lib/librte_cryptodev/rte_cryptodev_version.map |  2 ++
>  4 files changed, 112 insertions(+)
> 
> diff --git a/lib/librte_cryptodev/rte_cryptodev.c
> b/lib/librte_cryptodev/rte_cryptodev.c
> index 0ac23ed..eb72f03 100644
> --- a/lib/librte_cryptodev/rte_cryptodev.c
> +++ b/lib/librte_cryptodev/rte_cryptodev.c
> @@ -1393,6 +1393,53 @@ rte_cryptodev_sym_session_create(uint8_t
> dev_id,
>  	return sess;
>  }
> 
> +int
> +rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
> +		struct rte_cryptodev_sym_session *sess)
> +{
> +	struct rte_cryptodev *dev;
> +
> +	if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
> +		CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
> +		return -EINVAL;
> +	}
> +
> +	dev = &rte_crypto_devices[sess->dev_id];
> +
> +	/* The API is optional, not returning error if driver do not suuport */
> +	RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
> +	if (dev->dev_ops->qp_attach_session(dev, qp_id, sess->_private)) {
> +		CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with
> session",
> +				sess->dev_id, qp_id);
> +		return -EPERM;
> +	}
> +
> +	return 0;
> +}
> +
> +int
> +rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
> +		struct rte_cryptodev_sym_session *sess)
> +{
> +	struct rte_cryptodev *dev;
> +
> +	if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
> +		CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
> +		return -EINVAL;
> +	}
> +
> +	dev = &rte_crypto_devices[sess->dev_id];
> +
> +	/* The API is optional, not returning error if driver do not suuport */
> +	RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session,
> 0);
> +	if (dev->dev_ops->qp_detach_session(dev, qp_id, sess->_private)) {
> +		CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from
> session",
> +				sess->dev_id, qp_id);
> +		return -EPERM;
> +	}
> +
> +	return 0;
> +}
>  struct rte_cryptodev_sym_session *
>  rte_cryptodev_sym_session_free(uint8_t dev_id,
>  		struct rte_cryptodev_sym_session *sess)
> diff --git a/lib/librte_cryptodev/rte_cryptodev.h
> b/lib/librte_cryptodev/rte_cryptodev.h
> index d61a43e..05e5b4e 100644
> --- a/lib/librte_cryptodev/rte_cryptodev.h
> +++ b/lib/librte_cryptodev/rte_cryptodev.h
> @@ -332,6 +332,10 @@ struct rte_cryptodev_info {
>  	struct {
>  		unsigned max_nb_sessions;
>  		/**< Maximum number of sessions supported by device. */
> +		unsigned max_nb_sessions_per_qp;
> +		/**< Maximum number of sessions per queue pair.
> +		 * Default 0 for infinite sessions
> +		 */
>  	} sym;
>  };
> 
> @@ -915,6 +919,36 @@ extern struct rte_cryptodev_sym_session *
>  rte_cryptodev_sym_session_free(uint8_t dev_id,
>  		struct rte_cryptodev_sym_session *session);
> 
> +/**
> + * Attach queue pair with sym session.
> + *
> + * @param	qp_id		Queue pair to which session will be attached.
> + * @param	session		Session pointer previously allocated by
> + *				*rte_cryptodev_sym_session_create*.
> + *
> + * @return
> + *  - On success, zero.
> + *  - On failure, a negative value.
> + */
> +extern int
> +rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
> +		struct rte_cryptodev_sym_session *session);
> +

Just a nit - is there a reason why these 2 fns have extern label?
I see several other fns in same file which also have this, though not 
needed, so maybe just a cut-and-paste?


> +/**
> + * Detach queue pair with sym session.
> + *
> + * @param	qp_id		Queue pair to which session is attached.
> + * @param	session		Session pointer previously allocated by
> + *				*rte_cryptodev_sym_session_create*.
> + *
> + * @return
> + *  - On success, zero.
> + *  - On failure, a negative value.
> + */
> +extern int
> +rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
> +		struct rte_cryptodev_sym_session *session);
> +
> 
>  #ifdef __cplusplus
>  }
> diff --git a/lib/librte_cryptodev/rte_cryptodev_pmd.h
> b/lib/librte_cryptodev/rte_cryptodev_pmd.h
> index 1a417e2..df92817 100644
> --- a/lib/librte_cryptodev/rte_cryptodev_pmd.h
> +++ b/lib/librte_cryptodev/rte_cryptodev_pmd.h
> @@ -381,6 +381,31 @@ typedef void *
> (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
>  typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
>  		void *session_private);
> 
> +/**
> + * Optional API for drivers to attach sessions with queue pair.
> + * @param	dev		Crypto device pointer
> + * @param	qp_id		queue pair id for attaching session
> + * @param	priv_sess       Pointer to cryptodev's private session structure
> + * @return
> + *  - Return 0 on success
> + */
> +typedef int (*cryptodev_sym_queue_pair_attach_session_t)(
> +		  struct rte_cryptodev *dev,
> +		  uint16_t qp_id,
> +		  void *session_private);
> +
> +/**
> + * Optional API for drivers to detach sessions from queue pair.
> + * @param	dev		Crypto device pointer
> + * @param	qp_id		queue pair id for detaching session
> + * @param	priv_sess       Pointer to cryptodev's private session structure
> + * @return
> + *  - Return 0 on success
> + */
> +typedef int (*cryptodev_sym_queue_pair_detach_session_t)(
> +		  struct rte_cryptodev *dev,
> +		  uint16_t qp_id,
> +		  void *session_private);
> 
>  /** Crypto device operations function pointer table */
>  struct rte_cryptodev_ops {
> @@ -415,6 +440,10 @@ struct rte_cryptodev_ops {
>  	/**< Configure a Crypto session. */
>  	cryptodev_sym_free_session_t session_clear;
>  	/**< Clear a Crypto sessions private data. */
> +	cryptodev_sym_queue_pair_attach_session_t qp_attach_session;
> +	/**< Attach queue pair with session. */
> +	cryptodev_sym_queue_pair_attach_session_t qp_detach_session;
> +	/**< Detach queue pair from session. */
>  };
> 
Another nit.
It would be more correct for comments to say Attach session to queue pair / Detach session from queue pair.

Apart from those nits
Acked-by: Fiona Trahe <fiona.trahe at intel.com>

> 
> diff --git a/lib/librte_cryptodev/rte_cryptodev_version.map
> b/lib/librte_cryptodev/rte_cryptodev_version.map
> index 831a15c..9ac510e 100644
> --- a/lib/librte_cryptodev/rte_cryptodev_version.map
> +++ b/lib/librte_cryptodev/rte_cryptodev_version.map
> @@ -70,5 +70,7 @@ DPDK_17.05 {
> 
>  	rte_cryptodev_get_auth_algo_enum;
>  	rte_cryptodev_get_cipher_algo_enum;
> +	rte_cryptodev_queue_pair_attach_sym_session;
> +	rte_cryptodev_queue_pair_detach_sym_session;
> 
>  } DPDK_17.02;
> --
> 2.9.3