cryptodev: fix build with icc
[dpdk.git] / lib / librte_cryptodev / rte_cryptodev.h
index 972a308..1d975e5 100644 (file)
@@ -514,11 +514,6 @@ struct rte_cryptodev_config {
        int socket_id;                  /**< Socket to allocate resources on */
        uint16_t nb_queue_pairs;
        /**< Number of queue pairs to configure on device */
-
-       struct {
-               uint32_t nb_objs;       /**< Number of objects in mempool */
-               uint32_t cache_size;    /**< l-core object cache size */
-       } session_mp;           /**< Session mempool configuration */
 };
 
 /**
@@ -595,6 +590,8 @@ rte_cryptodev_close(uint8_t dev_id);
  *                             *SOCKET_ID_ANY* if there is no NUMA constraint
  *                             for the DMA memory allocated for the receive
  *                             queue pair.
+ * @param      session_pool    Pointer to device session mempool, used
+ *                             for session-less operations.
  *
  * @return
  *   - 0: Success, queue pair correctly set up.
@@ -602,7 +599,8 @@ rte_cryptodev_close(uint8_t dev_id);
  */
 extern int
 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
-               const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
+               const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
+               struct rte_mempool *session_pool);
 
 /**
  * Start a specified queue pair of a device. It is used
@@ -885,66 +883,98 @@ rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
 
 /** Cryptodev symmetric crypto session */
 struct rte_cryptodev_sym_session {
-       RTE_STD_C11
-       struct {
-               uint8_t dev_id;
-               /**< Device Id */
-               uint8_t driver_id;
-               /** Crypto driver identifier session created on */
-               struct rte_mempool *mp;
-               /**< Mempool session allocated from */
-       } __rte_aligned(8);
-       /**< Public symmetric session details */
-
-       __extension__ char _private[0];
+       __extension__ void *sess_private_data[0];
        /**< Private session material */
 };
 
 
 /**
- * Initialise a session for symmetric cryptographic operations.
+ * Create symmetric crypto session header (generic with no private data)
+ *
+ * @param   mempool    Symmetric session mempool to allocate session
+ *                     objects from
+ * @return
+ *  - On success return pointer to sym-session
+ *  - On failure returns NULL
+ */
+struct rte_cryptodev_sym_session *
+rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
+
+/**
+ * Frees symmetric crypto session header, after checking that all
+ * the device private data has been freed, returning it
+ * to its original mempool.
+ *
+ * @param   sess     Session header to be freed.
  *
- * This function is used by the client to initialize immutable
- * parameters of symmetric cryptographic operation.
- * To perform the operation the rte_cryptodev_enqueue_burst function is
- * used.  Each mbuf should contain a reference to the session
- * pointer returned from this function contained within it's crypto_op if a
- * session-based operation is being provisioned. Memory to contain the session
- * information is allocated from within mempool managed by the cryptodev.
+ * @return
+ *  - 0 if successful.
+ *  - -EINVAL if session is NULL.
+ *  - -EBUSY if not all device private data has been freed.
+ */
+int
+rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
+
+/**
+ * Fill out private data for the device id, based on its device type.
  *
- * The rte_cryptodev_session_free must be called to free allocated
- * memory when the session is no longer required.
+ * @param   dev_id   ID of device that we want the session to be used on
+ * @param   sess     Session where the private data will be attached to
+ * @param   xforms   Symmetric crypto transform operations to apply on flow
+ *                   processed with this session
+ * @param   mempool  Mempool where the private data is allocated.
  *
- * @param      dev_id          The device identifier.
- * @param      xform           Crypto transform chain.
+ * @return
+ *  - On success, zero.
+ *  - On failure, a negative value.
+ */
+int
+rte_cryptodev_sym_session_init(uint8_t dev_id,
+                       struct rte_cryptodev_sym_session *sess,
+                       struct rte_crypto_sym_xform *xforms,
+                       struct rte_mempool *mempool);
+
+/**
+ * Frees private data for the device id, based on its device type,
+ * returning it to its mempool.
+ *
+ * @param   dev_id   ID of device that uses the session.
+ * @param   sess     Session containing the reference to the private data
+ *
+ * @return
+ *  - 0 if successful.
+ *  - -EINVAL if device is invalid or session is NULL.
+ */
+int
+rte_cryptodev_sym_session_clear(uint8_t dev_id,
+                       struct rte_cryptodev_sym_session *sess);
 
+/**
+ * Get the size of the header session, for all registered drivers.
  *
  * @return
- *  Pointer to the created session or NULL
+ *   Size of the header session.
  */
-extern struct rte_cryptodev_sym_session *
-rte_cryptodev_sym_session_create(uint8_t dev_id,
-               struct rte_crypto_sym_xform *xform);
+unsigned int
+rte_cryptodev_get_header_session_size(void);
 
 /**
- * Free the memory associated with a previously allocated session.
+ * Get the size of the private session data for a device.
  *
  * @param      dev_id          The device identifier.
- * @param      session         Session pointer previously allocated by
- *                             *rte_cryptodev_sym_session_create*.
  *
  * @return
- *   NULL on successful freeing of session.
- *   Session pointer on failure to free session.
+ *   - Size of the private data, if successful
+ *   - 0 if device is invalid or does not have private session
  */
-extern struct rte_cryptodev_sym_session *
-rte_cryptodev_sym_session_free(uint8_t dev_id,
-               struct rte_cryptodev_sym_session *session);
+unsigned int
+rte_cryptodev_get_private_session_size(uint8_t dev_id);
 
 /**
  * Attach queue pair with sym session.
  *
- * @param      qp_id           Queue pair to which session will be attached.
+ * @param      dev_id          Device to which the session will be attached.
+ * @param      qp_id           Queue pair to which the session will be attached.
  * @param      session         Session pointer previously allocated by
  *                             *rte_cryptodev_sym_session_create*.
  *
@@ -953,13 +983,14 @@ rte_cryptodev_sym_session_free(uint8_t dev_id,
  *  - On failure, a negative value.
  */
 int
-rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
+rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
                struct rte_cryptodev_sym_session *session);
 
 /**
  * Detach queue pair with sym session.
  *
- * @param      qp_id           Queue pair to which session is attached.
+ * @param      dev_id          Device to which the session is attached.
+ * @param      qp_id           Queue pair to which the session is attached.
  * @param      session         Session pointer previously allocated by
  *                             *rte_cryptodev_sym_session_create*.
  *
@@ -968,7 +999,7 @@ rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
  *  - On failure, a negative value.
  */
 int
-rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
+rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
                struct rte_cryptodev_sym_session *session);
 
 /**