NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_compress.h File Reference
#include <inttypes.h>
#include <doca_compat.h>
#include <doca_error.h>
#include <doca_types.h>
Include dependency graph for doca_compress.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef 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. More...
 
typedef 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. More...
 
typedef 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. More...
 
typedef 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. More...
 

Functions

DOCA_EXPERIMENTAL doca_error_t doca_compress_create (struct doca_dev *dev, struct doca_compress **compress)
 
DOCA_EXPERIMENTAL doca_error_t doca_compress_destroy (struct doca_compress *compress)
 
DOCA_EXPERIMENTAL struct doca_ctx * doca_compress_as_ctx (struct doca_compress *compress)
 
DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_get_max_num_tasks (struct doca_compress *compress, uint32_t *max_num_tasks)
 
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. More...
 
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. More...
 
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_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. More...
 
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. More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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. More...
 
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. More...
 
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_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. More...
 
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. More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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. More...
 
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. More...
 
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_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. More...
 
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. More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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. More...
 
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. More...
 
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_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. More...
 
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. More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...