X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;ds=sidebyside;f=lib%2Flibrte_compressdev%2Frte_comp.h;h=95306c5d036494f740b3225be2c206d6dc99bb5c;hb=68c1f26d4236cca0fc144a36cd5a5cc3f1b58bfe;hp=9826086b1cff5785a0f111c99c4a201da3466a99;hpb=cb26360ec127331f0b0f914335526a14285f8874;p=dpdk.git

diff --git a/lib/librte_compressdev/rte_comp.h b/lib/librte_compressdev/rte_comp.h
index 9826086b1c..95306c5d03 100644
--- a/lib/librte_compressdev/rte_comp.h
+++ b/lib/librte_compressdev/rte_comp.h
@@ -30,28 +30,43 @@ extern "C" {
 /**< Stateful compression is supported */
 #define RTE_COMP_FF_STATEFUL_DECOMPRESSION	(1ULL << 1)
 /**< Stateful decompression is supported */
-#define	RTE_COMP_FF_MBUF_SCATTER_GATHER		(1ULL << 2)
-/**< Scatter-gather mbufs are supported */
-#define RTE_COMP_FF_ADLER32_CHECKSUM		(1ULL << 3)
+#define RTE_COMP_FF_OOP_SGL_IN_SGL_OUT		(1ULL << 2)
+/**< Out-of-place Scatter-gather (SGL) buffers,
+ * with multiple segments, are supported in input and output
+ */
+#define RTE_COMP_FF_OOP_SGL_IN_LB_OUT		(1ULL << 3)
+/**< Out-of-place Scatter-gather (SGL) buffers are supported
+ * in input, combined with linear buffers (LB), with a
+ * single segment, in output
+ */
+#define RTE_COMP_FF_OOP_LB_IN_SGL_OUT		(1ULL << 4)
+/**< Out-of-place Scatter-gather (SGL) buffers are supported
+ * in output, combined with linear buffers (LB) in input
+ */
+#define RTE_COMP_FF_ADLER32_CHECKSUM		(1ULL << 5)
 /**< Adler-32 Checksum is supported */
-#define RTE_COMP_FF_CRC32_CHECKSUM		(1ULL << 4)
+#define RTE_COMP_FF_CRC32_CHECKSUM		(1ULL << 6)
 /**< CRC32 Checksum is supported */
-#define RTE_COMP_FF_CRC32_ADLER32_CHECKSUM	(1ULL << 5)
+#define RTE_COMP_FF_CRC32_ADLER32_CHECKSUM	(1ULL << 7)
 /**< Adler-32/CRC32 Checksum is supported */
-#define RTE_COMP_FF_MULTI_PKT_CHECKSUM		(1ULL << 6)
+#define RTE_COMP_FF_MULTI_PKT_CHECKSUM		(1ULL << 8)
 /**< Generation of checksum across multiple stateless packets is supported */
-#define RTE_COMP_FF_SHA1_HASH			(1ULL << 7)
+#define RTE_COMP_FF_SHA1_HASH			(1ULL << 9)
 /**< SHA1 Hash is supported */
-#define RTE_COMP_FF_SHA2_SHA256_HASH		(1ULL << 8)
+#define RTE_COMP_FF_SHA2_SHA256_HASH		(1ULL << 10)
 /**< SHA256 Hash of SHA2 family is supported */
-#define RTE_COMP_FF_NONCOMPRESSED_BLOCKS	(1ULL << 9)
+#define RTE_COMP_FF_NONCOMPRESSED_BLOCKS	(1ULL << 11)
 /**< Creation of non-compressed blocks using RTE_COMP_LEVEL_NONE is supported */
-#define RTE_COMP_FF_SHAREABLE_PRIV_XFORM	(1ULL << 10)
+#define RTE_COMP_FF_SHAREABLE_PRIV_XFORM	(1ULL << 12)
 /**< Private xforms created by the PMD can be shared
  * across multiple stateless operations. If not set, then app needs
  * to create as many priv_xforms as it expects to have stateless
  * operations in-flight.
  */
+#define RTE_COMP_FF_HUFFMAN_FIXED		(1ULL << 13)
+/**< Fixed huffman encoding is supported */
+#define RTE_COMP_FF_HUFFMAN_DYNAMIC		(1ULL << 14)
+/**< Dynamic huffman encoding is supported */
 
 /** Status of comp operation */
 enum rte_comp_op_status {
@@ -295,7 +310,7 @@ struct rte_comp_op {
 	struct rte_mbuf *m_src;
 	/**< source mbuf
 	 * The total size of the input buffer(s) can be retrieved using
-	 * rte_pktmbuf_data_len(m_src). The max data size which can fit in a
+	 * rte_pktmbuf_pkt_len(m_src). The max data size which can fit in a
 	 * single mbuf is limited by the uint16_t rte_mbuf.data_len to 64k-1.
 	 * If the input data is bigger than this it can be passed to the PMD in
 	 * a chain of mbufs if the PMD's capabilities indicate it supports this.
@@ -303,11 +318,17 @@ struct rte_comp_op {
 	struct rte_mbuf *m_dst;
 	/**< destination mbuf
 	 * The total size of the output buffer(s) can be retrieved using
-	 * rte_pktmbuf_data_len(m_dst). The max data size which can fit in a
+	 * rte_pktmbuf_pkt_len(m_dst). The max data size which can fit in a
 	 * single mbuf is limited by the uint16_t rte_mbuf.data_len to 64k-1.
 	 * If the output data is expected to be bigger than this a chain of
 	 * mbufs can be passed to the PMD if the PMD's capabilities indicate
 	 * it supports this.
+	 *
+	 * @note, if incompressible data is passed to an engine for compression
+	 * using RTE_COMP_ALGO_DEFLATE, it's possible for the output data
+	 * to be larger than the uncompressed data, due to the inclusion
+	 * of the DEFLATE header blocks. The size of m_dst should accommodate
+	 * this, else OUT_OF_SPACE errors can be expected in this case.
 	 */
 
 	struct {
@@ -315,6 +336,8 @@ struct rte_comp_op {
 		/**< Starting point for compression or decompression,
 		 * specified as number of bytes from start of packet in
 		 * source buffer.
+		 * This offset starts from the first segment
+		 * of the buffer, in case the m_src is a chain of mbufs.
 		 * Starting point for checksum generation in compress direction.
 		 */
 		uint32_t length;
@@ -328,7 +351,10 @@ struct rte_comp_op {
 		uint32_t offset;
 		/**< Starting point for writing output data, specified as
 		 * number of bytes from start of packet in dest
-		 * buffer. Starting point for checksum generation in
+		 * buffer.
+		 * This offset starts from the first segment
+		 * of the buffer, in case the m_dst is a chain of mbufs.
+		 * Starting point for checksum generation in
 		 * decompress direction.
 		 */
 	} dst;
@@ -400,7 +426,8 @@ struct rte_comp_op {
  *  - On success pointer to mempool
  *  - On failure NULL
  */
-struct rte_mempool * __rte_experimental
+__rte_experimental
+struct rte_mempool *
 rte_comp_op_pool_create(const char *name,
 		unsigned int nb_elts, unsigned int cache_size,
 		uint16_t user_size, int socket_id);
@@ -415,7 +442,8 @@ rte_comp_op_pool_create(const char *name,
  * - On success returns a valid rte_comp_op structure
  * - On failure returns NULL
  */
-struct rte_comp_op * __rte_experimental
+__rte_experimental
+struct rte_comp_op *
 rte_comp_op_alloc(struct rte_mempool *mempool);
 
 /**
@@ -428,10 +456,11 @@ rte_comp_op_alloc(struct rte_mempool *mempool);
  * @param nb_ops
  *   Number of operations to allocate
  * @return
- *   - 0: Success
- *   - -ENOENT: Not enough entries in the mempool; no ops are retrieved.
+ *   - nb_ops: Success, the nb_ops requested was allocated
+ *   - 0: Not enough entries in the mempool; no ops are retrieved.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_comp_op_bulk_alloc(struct rte_mempool *mempool,
 		struct rte_comp_op **ops, uint16_t nb_ops);
 
@@ -443,9 +472,25 @@ rte_comp_op_bulk_alloc(struct rte_mempool *mempool,
  * @param op
  *   Compress operation
  */
-void __rte_experimental
+__rte_experimental
+void
 rte_comp_op_free(struct rte_comp_op *op);
 
+/**
+ * Bulk free operation structures
+ * If operations have been allocated from an rte_mempool, then the operations
+ * will be returned to the mempool.
+ * The array entry will be cleared.
+ *
+ * @param ops
+ *   Array of Compress operations
+ * @param nb_ops
+ *   Number of operations to free
+ */
+__rte_experimental
+void
+rte_comp_op_bulk_free(struct rte_comp_op **ops, uint16_t nb_ops);
+
 /**
  * Get the name of a compress service feature flag
  *
@@ -455,7 +500,8 @@ rte_comp_op_free(struct rte_comp_op *op);
  * @return
  *   The name of this flag, or NULL if it's not a valid feature flag.
  */
-const char * __rte_experimental
+__rte_experimental
+const char *
 rte_comp_get_feature_name(uint64_t flag);
 
 #ifdef __cplusplus