NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_compress.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
3  *
4  * This software product is a proprietary product of NVIDIA CORPORATION &
5  * AFFILIATES (the "Company") and all right, title, and interest in and to the
6  * software product, including all associated intellectual property rights, are
7  * and shall remain exclusively with the Company.
8  *
9  * This software product is governed by the End User License Agreement
10  * provided with the software product.
11  *
12  */
13 
22 #ifndef DOCA_COMPRESS_H_
23 #define DOCA_COMPRESS_H_
24 
25 #include <inttypes.h>
26 
27 #include <doca_compat.h>
28 #include <doca_error.h>
29 #include <doca_types.h>
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /**********************************************************************************************************************
36  * DOCA core opaque types
37  *********************************************************************************************************************/
38 
39 struct doca_buf;
40 struct doca_ctx;
41 struct doca_dev;
42 struct doca_devinfo;
43 
44 /*********************************************************************************************************************
45  * DOCA COMPRESS Context
46  *********************************************************************************************************************/
47 
51 struct doca_compress;
52 
68 DOCA_EXPERIMENTAL
69 doca_error_t doca_compress_create(struct doca_dev *dev, struct doca_compress **compress);
70 
82 DOCA_EXPERIMENTAL
83 doca_error_t doca_compress_destroy(struct doca_compress *compress);
84 
94 DOCA_EXPERIMENTAL
95 struct doca_ctx *doca_compress_as_ctx(struct doca_compress *compress);
96 
114 DOCA_EXPERIMENTAL
115 doca_error_t doca_compress_cap_get_max_num_tasks(struct doca_compress *compress, uint32_t *max_num_tasks);
116 
117 /************************************************************************/
118 /* COMPRESS DEFLATE TASK */
119 /************************************************************************/
120 
124 struct doca_compress_task_compress_deflate;
125 
137 typedef void (*doca_compress_task_compress_deflate_completion_cb_t)(struct doca_compress_task_compress_deflate *task,
138  union doca_data task_user_data,
139  union doca_data ctx_user_data);
140 
157 DOCA_EXPERIMENTAL
158 doca_error_t doca_compress_cap_task_compress_deflate_is_supported(const struct doca_devinfo *devinfo);
159 
177 DOCA_EXPERIMENTAL
178 doca_error_t doca_compress_cap_task_compress_deflate_get_max_buf_size(const struct doca_devinfo *devinfo,
179  uint64_t *max_buffer_size);
180 
195 DOCA_EXPERIMENTAL
196 doca_error_t doca_compress_cap_task_compress_deflate_get_max_buf_list_len(const struct doca_devinfo *devinfo,
197  uint32_t *max_buf_list_len);
198 
216 DOCA_EXPERIMENTAL
217 doca_error_t doca_compress_task_compress_deflate_set_conf(
218  struct doca_compress *compress,
219  doca_compress_task_compress_deflate_completion_cb_t task_completion_cb,
220  doca_compress_task_compress_deflate_completion_cb_t task_error_cb,
221  uint32_t num_tasks);
222 
247 DOCA_EXPERIMENTAL
248 doca_error_t doca_compress_task_compress_deflate_alloc_init(struct doca_compress *compress,
249  struct doca_buf const *src_buff,
250  struct doca_buf *dst_buff,
251  union doca_data user_data,
252  struct doca_compress_task_compress_deflate **task);
253 
261 DOCA_EXPERIMENTAL
262 struct doca_task *doca_compress_task_compress_deflate_as_task(struct doca_compress_task_compress_deflate *task);
263 
272 DOCA_EXPERIMENTAL
273 void doca_compress_task_compress_deflate_set_src(struct doca_compress_task_compress_deflate *task,
274  struct doca_buf const *src_buff);
275 
284 DOCA_EXPERIMENTAL
285 struct doca_buf const *doca_compress_task_compress_deflate_get_src(
286  const struct doca_compress_task_compress_deflate *task);
287 
296 DOCA_EXPERIMENTAL
297 void doca_compress_task_compress_deflate_set_dst(struct doca_compress_task_compress_deflate *task,
298  struct doca_buf *dst_buff);
299 
308 DOCA_EXPERIMENTAL
309 struct doca_buf *doca_compress_task_compress_deflate_get_dst(const struct doca_compress_task_compress_deflate *task);
310 
321 DOCA_EXPERIMENTAL
322 uint32_t doca_compress_task_compress_deflate_get_crc_cs(const struct doca_compress_task_compress_deflate *task);
323 
334 DOCA_EXPERIMENTAL
335 uint32_t doca_compress_task_compress_deflate_get_adler_cs(const struct doca_compress_task_compress_deflate *task);
336 
337 /************************************************************************/
338 /* DECOMPRESS DEFLATE TASK */
339 /************************************************************************/
340 
344 struct doca_compress_task_decompress_deflate;
345 
357 typedef void (*doca_compress_task_decompress_deflate_completion_cb_t)(struct doca_compress_task_decompress_deflate *task,
358  union doca_data task_user_data,
359  union doca_data ctx_user_data);
360 
377 DOCA_EXPERIMENTAL
378 doca_error_t doca_compress_cap_task_decompress_deflate_is_supported(const struct doca_devinfo *devinfo);
379 
397 DOCA_EXPERIMENTAL
398 doca_error_t doca_compress_cap_task_decompress_deflate_get_max_buf_size(const struct doca_devinfo *devinfo,
399  uint64_t *max_buffer_size);
400 
415 DOCA_EXPERIMENTAL
416 doca_error_t doca_compress_cap_task_decompress_deflate_get_max_buf_list_len(const struct doca_devinfo *devinfo,
417  uint32_t *max_buf_list_len);
418 
437 DOCA_EXPERIMENTAL
438 doca_error_t doca_compress_task_decompress_deflate_set_conf(
439  struct doca_compress *compress,
440  doca_compress_task_decompress_deflate_completion_cb_t task_completion_cb,
441  doca_compress_task_decompress_deflate_completion_cb_t task_error_cb,
442  uint32_t num_tasks);
443 
467 DOCA_EXPERIMENTAL
468 doca_error_t doca_compress_task_decompress_deflate_alloc_init(struct doca_compress *compress,
469  struct doca_buf const *src_buff,
470  struct doca_buf *dst_buff,
471  union doca_data user_data,
472  struct doca_compress_task_decompress_deflate **task);
473 
481 DOCA_EXPERIMENTAL
482 struct doca_task *doca_compress_task_decompress_deflate_as_task(struct doca_compress_task_decompress_deflate *task);
483 
492 DOCA_EXPERIMENTAL
493 void doca_compress_task_decompress_deflate_set_src(struct doca_compress_task_decompress_deflate *task,
494  struct doca_buf const *src_buff);
495 
504 DOCA_EXPERIMENTAL
505 struct doca_buf const *doca_compress_task_decompress_deflate_get_src(
506  const struct doca_compress_task_decompress_deflate *task);
507 
516 DOCA_EXPERIMENTAL
517 void doca_compress_task_decompress_deflate_set_dst(struct doca_compress_task_decompress_deflate *task,
518  struct doca_buf *dst_buff);
519 
528 DOCA_EXPERIMENTAL
529 struct doca_buf *doca_compress_task_decompress_deflate_get_dst(const struct doca_compress_task_decompress_deflate *task);
530 
541 DOCA_EXPERIMENTAL
542 uint32_t doca_compress_task_decompress_deflate_get_crc_cs(const struct doca_compress_task_decompress_deflate *task);
543 
554 DOCA_EXPERIMENTAL
555 uint32_t doca_compress_task_decompress_deflate_get_adler_cs(const struct doca_compress_task_decompress_deflate *task);
556 
557 /************************************************************************/
558 /* DECOMPRESS LZ4 STREAM TASK */
559 /************************************************************************/
560 
566 struct doca_compress_task_decompress_lz4_stream;
567 
579 typedef void (*doca_compress_task_decompress_lz4_stream_completion_cb_t)(
580  struct doca_compress_task_decompress_lz4_stream *task,
581  union doca_data task_user_data,
582  union doca_data ctx_user_data);
583 
600 DOCA_EXPERIMENTAL
601 doca_error_t doca_compress_cap_task_decompress_lz4_stream_is_supported(const struct doca_devinfo *devinfo);
602 
620 DOCA_EXPERIMENTAL
621 doca_error_t doca_compress_cap_task_decompress_lz4_stream_get_max_buf_size(const struct doca_devinfo *devinfo,
622  uint64_t *max_buffer_size);
623 
638 DOCA_EXPERIMENTAL
639 doca_error_t doca_compress_cap_task_decompress_lz4_stream_get_max_buf_list_len(const struct doca_devinfo *devinfo,
640  uint32_t *max_buf_list_len);
641 
659 DOCA_EXPERIMENTAL
660 doca_error_t doca_compress_task_decompress_lz4_stream_set_conf(
661  struct doca_compress *compress,
662  doca_compress_task_decompress_lz4_stream_completion_cb_t task_completion_cb,
663  doca_compress_task_decompress_lz4_stream_completion_cb_t task_error_cb,
664  uint32_t num_tasks);
665 
694 DOCA_EXPERIMENTAL
695 doca_error_t doca_compress_task_decompress_lz4_stream_alloc_init(struct doca_compress *compress,
696  uint8_t has_block_checksum,
697  uint8_t are_blocks_independent,
698  struct doca_buf const *src_buff,
699  struct doca_buf *dst_buff,
700  union doca_data user_data,
701  struct doca_compress_task_decompress_lz4_stream **task);
702 
710 DOCA_EXPERIMENTAL
711 struct doca_task *doca_compress_task_decompress_lz4_stream_as_task(
712  struct doca_compress_task_decompress_lz4_stream *task);
713 
722 DOCA_EXPERIMENTAL
723 void doca_compress_task_decompress_lz4_stream_set_has_block_checksum(
724  struct doca_compress_task_decompress_lz4_stream *task,
725  uint8_t has_block_checksum);
726 
736 DOCA_EXPERIMENTAL
737 uint8_t doca_compress_task_decompress_lz4_stream_get_has_block_checksum(
738  const struct doca_compress_task_decompress_lz4_stream *task);
739 
748 DOCA_EXPERIMENTAL
749 void doca_compress_task_decompress_lz4_stream_set_are_blocks_independent(
750  struct doca_compress_task_decompress_lz4_stream *task,
751  uint8_t are_blocks_independent);
752 
761 DOCA_EXPERIMENTAL
762 uint8_t doca_compress_task_decompress_lz4_stream_get_are_blocks_independent(
763  const struct doca_compress_task_decompress_lz4_stream *task);
764 
773 DOCA_EXPERIMENTAL
774 void doca_compress_task_decompress_lz4_stream_set_src(struct doca_compress_task_decompress_lz4_stream *task,
775  struct doca_buf const *src_buff);
776 
785 DOCA_EXPERIMENTAL
786 struct doca_buf const *doca_compress_task_decompress_lz4_stream_get_src(
787  const struct doca_compress_task_decompress_lz4_stream *task);
788 
797 DOCA_EXPERIMENTAL
798 void doca_compress_task_decompress_lz4_stream_set_dst(struct doca_compress_task_decompress_lz4_stream *task,
799  struct doca_buf *dst_buff);
800 
809 DOCA_EXPERIMENTAL
810 struct doca_buf *doca_compress_task_decompress_lz4_stream_get_dst(
811  const struct doca_compress_task_decompress_lz4_stream *task);
812 
823 DOCA_EXPERIMENTAL
824 uint32_t doca_compress_task_decompress_lz4_stream_get_crc_cs(
825  const struct doca_compress_task_decompress_lz4_stream *task);
826 
837 DOCA_EXPERIMENTAL
838 uint32_t doca_compress_task_decompress_lz4_stream_get_xxh_cs(
839  const struct doca_compress_task_decompress_lz4_stream *task);
840 
841 /************************************************************************/
842 /* DECOMPRESS LZ4 BLOCK TASK */
843 /************************************************************************/
844 
849 struct doca_compress_task_decompress_lz4_block;
850 
862 typedef void (*doca_compress_task_decompress_lz4_block_completion_cb_t)(
863  struct doca_compress_task_decompress_lz4_block *task,
864  union doca_data task_user_data,
865  union doca_data ctx_user_data);
866 
883 DOCA_EXPERIMENTAL
884 doca_error_t doca_compress_cap_task_decompress_lz4_block_is_supported(const struct doca_devinfo *devinfo);
885 
903 DOCA_EXPERIMENTAL
904 doca_error_t doca_compress_cap_task_decompress_lz4_block_get_max_buf_size(const struct doca_devinfo *devinfo,
905  uint64_t *max_buffer_size);
906 
921 DOCA_EXPERIMENTAL
922 doca_error_t doca_compress_cap_task_decompress_lz4_block_get_max_buf_list_len(const struct doca_devinfo *devinfo,
923  uint32_t *max_buf_list_len);
924 
942 DOCA_EXPERIMENTAL
943 doca_error_t doca_compress_task_decompress_lz4_block_set_conf(
944  struct doca_compress *compress,
945  doca_compress_task_decompress_lz4_block_completion_cb_t task_completion_cb,
946  doca_compress_task_decompress_lz4_block_completion_cb_t task_error_cb,
947  uint32_t num_tasks);
948 
973 DOCA_EXPERIMENTAL
974 doca_error_t doca_compress_task_decompress_lz4_block_alloc_init(struct doca_compress *compress,
975  struct doca_buf const *src_buff,
976  struct doca_buf *dst_buff,
977  union doca_data user_data,
978  struct doca_compress_task_decompress_lz4_block **task);
979 
987 DOCA_EXPERIMENTAL
988 struct doca_task *doca_compress_task_decompress_lz4_block_as_task(struct doca_compress_task_decompress_lz4_block *task);
989 
998 DOCA_EXPERIMENTAL
999 void doca_compress_task_decompress_lz4_block_set_src(struct doca_compress_task_decompress_lz4_block *task,
1000  struct doca_buf const *src_buff);
1001 
1010 DOCA_EXPERIMENTAL
1011 struct doca_buf const *doca_compress_task_decompress_lz4_block_get_src(
1012  const struct doca_compress_task_decompress_lz4_block *task);
1013 
1022 DOCA_EXPERIMENTAL
1023 void doca_compress_task_decompress_lz4_block_set_dst(struct doca_compress_task_decompress_lz4_block *task,
1024  struct doca_buf *dst_buff);
1025 
1034 DOCA_EXPERIMENTAL
1035 struct doca_buf *doca_compress_task_decompress_lz4_block_get_dst(
1036  const struct doca_compress_task_decompress_lz4_block *task);
1037 
1048 DOCA_EXPERIMENTAL
1049 uint32_t doca_compress_task_decompress_lz4_block_get_crc_cs(const struct doca_compress_task_decompress_lz4_block *task);
1050 
1061 DOCA_EXPERIMENTAL
1062 uint32_t doca_compress_task_decompress_lz4_block_get_xxh_cs(const struct doca_compress_task_decompress_lz4_block *task);
1063 
1064 #ifdef __cplusplus
1065 } /* extern "C" */
1066 #endif
1067 
1068 #endif /* DOCA_COMPRESS_H_ */
1069 
task_error_cb
static void task_error_cb(struct doca_task *se_task, union doca_data task_user_data, union doca_data ctx_user_data)
Definition: common_common.c:65
task_completion_cb
static void task_completion_cb(struct doca_task *se_task, union doca_data task_user_data, union doca_data ctx_user_data)
Definition: common_common.c:48
doca_compat.h
doca_error.h
doca_types.h
DOCA_EXPERIMENTAL
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
doca_compress_task_decompress_lz4_stream_get_xxh_cs
DOCA_EXPERIMENTAL uint32_t doca_compress_task_decompress_lz4_stream_get_xxh_cs(const struct doca_compress_task_decompress_lz4_stream *task)
get decompress LZ4 stream task xxHash-32 checksum
doca_compress_cap_task_decompress_lz4_stream_get_max_buf_list_len
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_lz4_stream_get_max_buf_list_len(const struct doca_devinfo *devinfo, uint32_t *max_buf_list_len)
doca_compress_task_compress_deflate_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_compress_task_compress_deflate_set_conf(struct doca_compress *compress, doca_compress_task_compress_deflate_completion_cb_t task_completion_cb, doca_compress_task_compress_deflate_completion_cb_t task_error_cb, uint32_t num_tasks)
This method sets the compress deflate task configuration.
doca_compress_cap_task_compress_deflate_get_max_buf_list_len
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_compress_deflate_get_max_buf_list_len(const struct doca_devinfo *devinfo, uint32_t *max_buf_list_len)
doca_compress_cap_task_decompress_lz4_stream_get_max_buf_size
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_lz4_stream_get_max_buf_size(const struct doca_devinfo *devinfo, uint64_t *max_buffer_size)
Get decompress LZ4 stream max size.
doca_compress_task_decompress_lz4_stream_get_src
DOCA_EXPERIMENTAL struct doca_buf const * doca_compress_task_decompress_lz4_stream_get_src(const struct doca_compress_task_decompress_lz4_stream *task)
get decompress LZ4 stream task source
doca_compress_task_decompress_lz4_stream_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_compress_task_decompress_lz4_stream_alloc_init(struct doca_compress *compress, uint8_t has_block_checksum, uint8_t are_blocks_independent, struct doca_buf const *src_buff, struct doca_buf *dst_buff, union doca_data user_data, struct doca_compress_task_decompress_lz4_stream **task)
Allocate decompress LZ4 stream task.
doca_compress_task_decompress_lz4_block_get_src
DOCA_EXPERIMENTAL struct doca_buf const * doca_compress_task_decompress_lz4_block_get_src(const struct doca_compress_task_decompress_lz4_block *task)
get decompress LZ4 block task source
doca_compress_task_compress_deflate_completion_cb_t
void(* doca_compress_task_compress_deflate_completion_cb_t)(struct doca_compress_task_compress_deflate *task, union doca_data task_user_data, union doca_data ctx_user_data)
Function to execute on compress deflate task completion.
Definition: doca_compress.h:137
doca_compress_destroy
DOCA_EXPERIMENTAL doca_error_t doca_compress_destroy(struct doca_compress *compress)
doca_compress_task_decompress_deflate_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_compress_task_decompress_deflate_set_conf(struct doca_compress *compress, doca_compress_task_decompress_deflate_completion_cb_t task_completion_cb, doca_compress_task_decompress_deflate_completion_cb_t task_error_cb, uint32_t num_tasks)
This method sets the decompress deflate task configuration.
doca_compress_task_compress_deflate_get_crc_cs
DOCA_EXPERIMENTAL uint32_t doca_compress_task_compress_deflate_get_crc_cs(const struct doca_compress_task_compress_deflate *task)
get compress deflate task CRC checksum
doca_compress_task_decompress_deflate_get_dst
DOCA_EXPERIMENTAL struct doca_buf * doca_compress_task_decompress_deflate_get_dst(const struct doca_compress_task_decompress_deflate *task)
get decompress deflate task destination
doca_compress_cap_task_compress_deflate_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_compress_deflate_is_supported(const struct doca_devinfo *devinfo)
Check if a compress deflate task is supported by a device.
doca_compress_cap_task_decompress_lz4_block_get_max_buf_size
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_lz4_block_get_max_buf_size(const struct doca_devinfo *devinfo, uint64_t *max_buffer_size)
Get decompress LZ4 block max size.
doca_compress_task_decompress_deflate_completion_cb_t
void(* doca_compress_task_decompress_deflate_completion_cb_t)(struct doca_compress_task_decompress_deflate *task, union doca_data task_user_data, union doca_data ctx_user_data)
Function to execute on decompress deflate task completion.
Definition: doca_compress.h:357
doca_compress_cap_task_decompress_deflate_get_max_buf_size
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_deflate_get_max_buf_size(const struct doca_devinfo *devinfo, uint64_t *max_buffer_size)
Get decompress deflate max size.
doca_compress_task_decompress_lz4_stream_set_src
DOCA_EXPERIMENTAL void doca_compress_task_decompress_lz4_stream_set_src(struct doca_compress_task_decompress_lz4_stream *task, struct doca_buf const *src_buff)
set decompress LZ4 stream task source
doca_compress_cap_task_compress_deflate_get_max_buf_size
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_compress_deflate_get_max_buf_size(const struct doca_devinfo *devinfo, uint64_t *max_buffer_size)
Get compress deflate max size.
doca_compress_task_decompress_deflate_as_task
DOCA_EXPERIMENTAL struct doca_task * doca_compress_task_decompress_deflate_as_task(struct doca_compress_task_decompress_deflate *task)
convert decompress deflate task to doca_task
doca_compress_task_compress_deflate_set_src
DOCA_EXPERIMENTAL void doca_compress_task_compress_deflate_set_src(struct doca_compress_task_compress_deflate *task, struct doca_buf const *src_buff)
set compress deflate task source
doca_compress_task_decompress_lz4_block_completion_cb_t
void(* doca_compress_task_decompress_lz4_block_completion_cb_t)(struct doca_compress_task_decompress_lz4_block *task, union doca_data task_user_data, union doca_data ctx_user_data)
Function to execute on decompress LZ4 block task completion.
Definition: doca_compress.h:862
doca_compress_task_decompress_deflate_get_adler_cs
DOCA_EXPERIMENTAL uint32_t doca_compress_task_decompress_deflate_get_adler_cs(const struct doca_compress_task_decompress_deflate *task)
get decompress deflate task adler checksum
doca_compress_create
DOCA_EXPERIMENTAL doca_error_t doca_compress_create(struct doca_dev *dev, struct doca_compress **compress)
doca_compress_task_compress_deflate_set_dst
DOCA_EXPERIMENTAL void doca_compress_task_compress_deflate_set_dst(struct doca_compress_task_compress_deflate *task, struct doca_buf *dst_buff)
set compress deflate task destination
doca_compress_task_decompress_lz4_block_as_task
DOCA_EXPERIMENTAL struct doca_task * doca_compress_task_decompress_lz4_block_as_task(struct doca_compress_task_decompress_lz4_block *task)
convert decompress LZ4 block task to doca_task
doca_compress_task_decompress_deflate_get_src
DOCA_EXPERIMENTAL struct doca_buf const * doca_compress_task_decompress_deflate_get_src(const struct doca_compress_task_decompress_deflate *task)
get decompress deflate task source
doca_compress_task_decompress_lz4_stream_completion_cb_t
void(* doca_compress_task_decompress_lz4_stream_completion_cb_t)(struct doca_compress_task_decompress_lz4_stream *task, union doca_data task_user_data, union doca_data ctx_user_data)
Function to execute on decompress LZ4 stream task completion.
Definition: doca_compress.h:579
doca_compress_task_decompress_lz4_block_set_src
DOCA_EXPERIMENTAL void doca_compress_task_decompress_lz4_block_set_src(struct doca_compress_task_decompress_lz4_block *task, struct doca_buf const *src_buff)
set decompress LZ4 block task source
doca_compress_task_decompress_deflate_get_crc_cs
DOCA_EXPERIMENTAL uint32_t doca_compress_task_decompress_deflate_get_crc_cs(const struct doca_compress_task_decompress_deflate *task)
get decompress deflate task CRC checksum
doca_compress_cap_task_decompress_lz4_block_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_lz4_block_is_supported(const struct doca_devinfo *devinfo)
Check if a decompress LZ4 block task is supported by a device.
doca_compress_task_decompress_lz4_block_get_crc_cs
DOCA_EXPERIMENTAL uint32_t doca_compress_task_decompress_lz4_block_get_crc_cs(const struct doca_compress_task_decompress_lz4_block *task)
get decompress LZ4 block task CRC checksum
doca_compress_task_decompress_lz4_stream_get_dst
DOCA_EXPERIMENTAL struct doca_buf * doca_compress_task_decompress_lz4_stream_get_dst(const struct doca_compress_task_decompress_lz4_stream *task)
get decompress LZ4 stream task destination
doca_compress_as_ctx
DOCA_EXPERIMENTAL struct doca_ctx * doca_compress_as_ctx(struct doca_compress *compress)
doca_compress_task_decompress_lz4_block_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_compress_task_decompress_lz4_block_alloc_init(struct doca_compress *compress, struct doca_buf const *src_buff, struct doca_buf *dst_buff, union doca_data user_data, struct doca_compress_task_decompress_lz4_block **task)
Allocate decompress LZ4 block task.
doca_compress_task_decompress_lz4_stream_set_are_blocks_independent
DOCA_EXPERIMENTAL void doca_compress_task_decompress_lz4_stream_set_are_blocks_independent(struct doca_compress_task_decompress_lz4_stream *task, uint8_t are_blocks_independent)
set decompress LZ4 stream task are_blocks_independent flag
doca_compress_task_decompress_lz4_block_get_xxh_cs
DOCA_EXPERIMENTAL uint32_t doca_compress_task_decompress_lz4_block_get_xxh_cs(const struct doca_compress_task_decompress_lz4_block *task)
get decompress LZ4 block task xxHash-32 checksum
doca_compress_task_compress_deflate_as_task
DOCA_EXPERIMENTAL struct doca_task * doca_compress_task_compress_deflate_as_task(struct doca_compress_task_compress_deflate *task)
convert compress deflate task to doca_task
doca_compress_task_compress_deflate_get_dst
DOCA_EXPERIMENTAL struct doca_buf * doca_compress_task_compress_deflate_get_dst(const struct doca_compress_task_compress_deflate *task)
get compress deflate task destination
doca_compress_cap_get_max_num_tasks
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_get_max_num_tasks(struct doca_compress *compress, uint32_t *max_num_tasks)
doca_compress_cap_task_decompress_lz4_stream_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_lz4_stream_is_supported(const struct doca_devinfo *devinfo)
Check if a decompress LZ4 stream task is supported by a device.
doca_compress_task_decompress_deflate_set_src
DOCA_EXPERIMENTAL void doca_compress_task_decompress_deflate_set_src(struct doca_compress_task_decompress_deflate *task, struct doca_buf const *src_buff)
set decompress deflate task source
doca_compress_task_decompress_lz4_block_get_dst
DOCA_EXPERIMENTAL struct doca_buf * doca_compress_task_decompress_lz4_block_get_dst(const struct doca_compress_task_decompress_lz4_block *task)
get decompress LZ4 block task destination
doca_compress_cap_task_decompress_deflate_get_max_buf_list_len
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_deflate_get_max_buf_list_len(const struct doca_devinfo *devinfo, uint32_t *max_buf_list_len)
doca_compress_task_decompress_lz4_stream_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_compress_task_decompress_lz4_stream_set_conf(struct doca_compress *compress, doca_compress_task_decompress_lz4_stream_completion_cb_t task_completion_cb, doca_compress_task_decompress_lz4_stream_completion_cb_t task_error_cb, uint32_t num_tasks)
This method sets the decompress LZ4 stream task configuration.
doca_compress_task_decompress_lz4_stream_get_crc_cs
DOCA_EXPERIMENTAL uint32_t doca_compress_task_decompress_lz4_stream_get_crc_cs(const struct doca_compress_task_decompress_lz4_stream *task)
get decompress LZ4 stream task CRC checksum
doca_compress_task_decompress_lz4_stream_set_has_block_checksum
DOCA_EXPERIMENTAL void doca_compress_task_decompress_lz4_stream_set_has_block_checksum(struct doca_compress_task_decompress_lz4_stream *task, uint8_t has_block_checksum)
set decompress LZ4 stream task has_block_checksum flag
doca_compress_task_decompress_lz4_stream_as_task
DOCA_EXPERIMENTAL struct doca_task * doca_compress_task_decompress_lz4_stream_as_task(struct doca_compress_task_decompress_lz4_stream *task)
convert decompress LZ4 stream task to doca_task
doca_compress_task_decompress_lz4_stream_get_has_block_checksum
DOCA_EXPERIMENTAL uint8_t doca_compress_task_decompress_lz4_stream_get_has_block_checksum(const struct doca_compress_task_decompress_lz4_stream *task)
get decompress LZ4 stream task has_block_checksum flag
doca_compress_task_compress_deflate_get_adler_cs
DOCA_EXPERIMENTAL uint32_t doca_compress_task_compress_deflate_get_adler_cs(const struct doca_compress_task_compress_deflate *task)
get compress deflate task adler checksum
doca_compress_task_decompress_lz4_stream_get_are_blocks_independent
DOCA_EXPERIMENTAL uint8_t doca_compress_task_decompress_lz4_stream_get_are_blocks_independent(const struct doca_compress_task_decompress_lz4_stream *task)
get decompress LZ4 stream task are_blocks_independent flag
doca_compress_cap_task_decompress_deflate_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_deflate_is_supported(const struct doca_devinfo *devinfo)
Check if a decompress deflate task is supported by a device.
doca_compress_cap_task_decompress_lz4_block_get_max_buf_list_len
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_task_decompress_lz4_block_get_max_buf_list_len(const struct doca_devinfo *devinfo, uint32_t *max_buf_list_len)
doca_compress_task_compress_deflate_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_compress_task_compress_deflate_alloc_init(struct doca_compress *compress, struct doca_buf const *src_buff, struct doca_buf *dst_buff, union doca_data user_data, struct doca_compress_task_compress_deflate **task)
Allocate compress deflate task.
doca_compress_task_decompress_lz4_block_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_compress_task_decompress_lz4_block_set_conf(struct doca_compress *compress, doca_compress_task_decompress_lz4_block_completion_cb_t task_completion_cb, doca_compress_task_decompress_lz4_block_completion_cb_t task_error_cb, uint32_t num_tasks)
This method sets the decompress LZ4 block task configuration.
doca_compress_task_decompress_lz4_block_set_dst
DOCA_EXPERIMENTAL void doca_compress_task_decompress_lz4_block_set_dst(struct doca_compress_task_decompress_lz4_block *task, struct doca_buf *dst_buff)
set decompress LZ4 block task destination
doca_compress_task_decompress_deflate_set_dst
DOCA_EXPERIMENTAL void doca_compress_task_decompress_deflate_set_dst(struct doca_compress_task_decompress_deflate *task, struct doca_buf *dst_buff)
set decompress deflate task destination
doca_compress_task_decompress_lz4_stream_set_dst
DOCA_EXPERIMENTAL void doca_compress_task_decompress_lz4_stream_set_dst(struct doca_compress_task_decompress_lz4_stream *task, struct doca_buf *dst_buff)
set decompress LZ4 stream task destination
doca_compress_task_decompress_deflate_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_compress_task_decompress_deflate_alloc_init(struct doca_compress *compress, struct doca_buf const *src_buff, struct doca_buf *dst_buff, union doca_data user_data, struct doca_compress_task_decompress_deflate **task)
Allocate decompress deflate task.
doca_compress_task_compress_deflate_get_src
DOCA_EXPERIMENTAL struct doca_buf const * doca_compress_task_compress_deflate_get_src(const struct doca_compress_task_compress_deflate *task)
get compress deflate task source
doca_error_t
enum doca_error doca_error_t
DOCA API return codes.
doca_data
Convenience type for representing opaque data.
Definition: doca_types.h:56