DPDK  25.03.0
rte_comp.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017-2018 Intel Corporation
3  */
4 
5 #ifndef _RTE_COMP_H_
6 #define _RTE_COMP_H_
7 
14 #include <rte_common.h>
15 #include <rte_mbuf.h>
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
28 #define RTE_COMP_FF_STATEFUL_COMPRESSION (1ULL << 0)
29 
30 #define RTE_COMP_FF_STATEFUL_DECOMPRESSION (1ULL << 1)
31 
32 #define RTE_COMP_FF_OOP_SGL_IN_SGL_OUT (1ULL << 2)
33 
36 #define RTE_COMP_FF_OOP_SGL_IN_LB_OUT (1ULL << 3)
37 
41 #define RTE_COMP_FF_OOP_LB_IN_SGL_OUT (1ULL << 4)
42 
45 #define RTE_COMP_FF_ADLER32_CHECKSUM (1ULL << 5)
46 
47 #define RTE_COMP_FF_CRC32_CHECKSUM (1ULL << 6)
48 
49 #define RTE_COMP_FF_CRC32_ADLER32_CHECKSUM (1ULL << 7)
50 
51 #define RTE_COMP_FF_MULTI_PKT_CHECKSUM (1ULL << 8)
52 
53 #define RTE_COMP_FF_SHA1_HASH (1ULL << 9)
54 
55 #define RTE_COMP_FF_SHA2_SHA256_HASH (1ULL << 10)
56 
57 #define RTE_COMP_FF_NONCOMPRESSED_BLOCKS (1ULL << 11)
58 
59 #define RTE_COMP_FF_SHAREABLE_PRIV_XFORM (1ULL << 12)
60 
65 #define RTE_COMP_FF_HUFFMAN_FIXED (1ULL << 13)
66 
67 #define RTE_COMP_FF_HUFFMAN_DYNAMIC (1ULL << 14)
68 
69 #define RTE_COMP_FF_XXHASH32_CHECKSUM (1ULL << 15)
70 
71 #define RTE_COMP_FF_LZ4_DICT_ID (1ULL << 16)
72 
73 #define RTE_COMP_FF_LZ4_CONTENT_WITH_CHECKSUM (1ULL << 17)
74 
75 #define RTE_COMP_FF_LZ4_CONTENT_SIZE (1ULL << 18)
76 
77 #define RTE_COMP_FF_LZ4_BLOCK_INDEPENDENCE (1ULL << 19)
78 
79 #define RTE_COMP_FF_LZ4_BLOCK_WITH_CHECKSUM (1ULL << 20)
80 
104 };
105 
108  RTE_COMP_ALGO_UNSPECIFIED = 0,
127 };
128 
137 };
138 
144 #define RTE_COMP_LEVEL_PMD_DEFAULT (-1)
145 
146 #define RTE_COMP_LEVEL_NONE (0)
147 
148 #define RTE_COMP_LEVEL_MIN (1)
149 
150 #define RTE_COMP_LEVEL_MAX (9)
151 
169 };
170 
179 };
180 
202 };
203 
210 };
211 
225 };
226 
231 };
232 
238 #define RTE_COMP_LZ4_FLAG_DICT_ID (1 << 0)
239 
245 #define RTE_COMP_LZ4_FLAG_CONTENT_CHECKSUM (1 << 2)
246 
253 #define RTE_COMP_LZ4_FLAG_CONTENT_SIZE (1 << 3)
254 
263 #define RTE_COMP_LZ4_FLAG_BLOCK_CHECKSUM (1 << 4)
264 
274 #define RTE_COMP_LZ4_FLAG_BLOCK_INDEPENDENCE (1 << 5)
275 
278  uint8_t flags;
283 };
284 
289  union {
294  };
295  int level;
297  uint8_t window_size;
308 };
309 
318  uint8_t window_size;
323  union {
326  };
331 };
332 
343  union {
348  };
349 };
350 
361  enum rte_comp_op_type op_type;
362  union {
368  void *stream;
377  };
378 
383  struct rte_mbuf *m_src;
391  struct rte_mbuf *m_dst;
407  struct {
408  uint32_t offset;
416  uint32_t length;
422  } src;
423  struct {
424  uint32_t offset;
433  } dst;
434  struct {
435  uint8_t *digest;
444  rte_iova_t iova_addr;
446  } hash;
447  enum rte_comp_flush_flag flush_flag;
451  uint64_t input_chksum;
456  uint64_t output_chksum;
460  uint32_t consumed;
464  uint32_t produced;
468  uint64_t debug_status;
474  uint8_t status;
482 };
483 
493 void
494 rte_comp_op_free(struct rte_comp_op *op);
495 
514 struct rte_mempool *
515 rte_comp_op_pool_create(const char *name,
516  unsigned int nb_elts, unsigned int cache_size,
517  uint16_t user_size, int socket_id)
519 
530 struct rte_comp_op *
532 
546 int
548  struct rte_comp_op **ops, uint16_t nb_ops);
549 
561 void
562 rte_comp_op_bulk_free(struct rte_comp_op **ops, uint16_t nb_ops);
563 
573 const char *
574 rte_comp_get_feature_name(uint64_t flag);
575 
576 #ifdef __cplusplus
577 }
578 #endif
579 
580 #endif /* _RTE_COMP_H_ */
struct rte_mempool * mempool
Definition: rte_comp.h:379
struct rte_mbuf * m_dst
Definition: rte_comp.h:391
struct rte_comp_lz4_params lz4
Definition: rte_comp.h:324
rte_comp_op_status
Definition: rte_comp.h:83
uint64_t rte_iova_t
Definition: rte_common.h:736
void rte_comp_op_bulk_free(struct rte_comp_op **ops, uint16_t nb_ops)
rte_comp_xform_type
Definition: rte_comp.h:205
uint64_t debug_status
Definition: rte_comp.h:468
enum rte_comp_hash_algorithm hash_algo
Definition: rte_comp.h:327
void * stream
Definition: rte_comp.h:368
struct rte_mempool struct rte_comp_op * rte_comp_op_alloc(struct rte_mempool *mempool)
rte_comp_op_type
Definition: rte_comp.h:213
rte_comp_algorithm
Definition: rte_comp.h:107
void rte_comp_op_free(struct rte_comp_op *op)
rte_comp_hash_algorithm
Definition: rte_comp.h:130
struct rte_comp_decompress_xform decompress
Definition: rte_comp.h:346
struct rte_comp_deflate_params deflate
Definition: rte_comp.h:290
#define __rte_cache_aligned
Definition: rte_common.h:705
uint32_t cache_size
Definition: rte_mempool.h:241
char name[RTE_MEMPOOL_NAMESIZE]
Definition: rte_mempool.h:231
struct rte_comp_lz4_params lz4
Definition: rte_comp.h:292
enum rte_comp_checksum_type chksum
Definition: rte_comp.h:302
rte_comp_checksum_type
Definition: rte_comp.h:154
const char * rte_comp_get_feature_name(uint64_t flag)
uint32_t length
Definition: rte_comp.h:416
uint32_t consumed
Definition: rte_comp.h:460
struct rte_comp_compress_xform compress
Definition: rte_comp.h:344
uint8_t * digest
Definition: rte_comp.h:435
uint64_t output_chksum
Definition: rte_comp.h:456
enum rte_comp_huffman huffman
Definition: rte_comp.h:229
#define __rte_dealloc(dealloc, argno)
Definition: rte_common.h:305
uint8_t status
Definition: rte_comp.h:474
rte_iova_t iova_addr
Definition: rte_comp.h:381
#define __rte_malloc
Definition: rte_common.h:294
uint32_t produced
Definition: rte_comp.h:464
enum rte_comp_xform_type type
Definition: rte_comp.h:341
enum rte_comp_algorithm algo
Definition: rte_comp.h:287
struct rte_mbuf * m_src
Definition: rte_comp.h:383
void * private_xform
Definition: rte_comp.h:363
int rte_comp_op_bulk_alloc(struct rte_mempool *mempool, struct rte_comp_op **ops, uint16_t nb_ops)
rte_comp_huffman
Definition: rte_comp.h:172
enum rte_comp_hash_algorithm hash_algo
Definition: rte_comp.h:304
enum rte_comp_checksum_type chksum
Definition: rte_comp.h:316
enum rte_comp_algorithm algo
Definition: rte_comp.h:314
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) __rte_malloc __rte_dealloc(rte_comp_op_free
rte_comp_flush_flag
Definition: rte_comp.h:182
uint64_t input_chksum
Definition: rte_comp.h:451
uint32_t offset
Definition: rte_comp.h:408