| NVIDIA DOCA SDK | Data Center on a Chip Framework Documentation |
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... | |
DOCA COMPRESS library. For more details please refer to the user guide on DOCA devzone.
| 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.
| [in] | task | compress deflate task. The implementation can assume this value is not NULL. |
| [in] | task_user_data | task user data |
| [in] | ctx_user_data | doca_ctx user data |
Definition at line 137 of file doca_compress.h.
| 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.
| [in] | task | decompress deflate task. The implementation can assume this value is not NULL. |
| [in] | task_user_data | task user data |
| [in] | ctx_user_data | doca_ctx user data |
Definition at line 357 of file doca_compress.h.
| 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.
| [in] | task | decompress LZ4 block task. The implementation can assume this value is not NULL. |
| [in] | task_user_data | task user data |
| [in] | ctx_user_data | doca_ctx user data |
Definition at line 862 of file doca_compress.h.
| 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.
| [in] | task | decompress LZ4 stream task. The implementation can assume this value is not NULL. |
| [in] | task_user_data | task user data |
| [in] | ctx_user_data | doca_ctx user data |
Definition at line 579 of file doca_compress.h.
| DOCA_EXPERIMENTAL struct doca_ctx* doca_compress_as_ctx | ( | struct doca_compress * | compress | ) |
Adapt doca_compress instance into a generalized context for use with doca core objects.
| [in] | compress | Compress instance. This must remain valid until after the context is no longer required. |
| DOCA_EXPERIMENTAL doca_error_t doca_compress_cap_get_max_num_tasks | ( | struct doca_compress * | compress, |
| uint32_t * | max_num_tasks | ||
| ) |
Get the maximum number of tasks
This method retrieves the maximum number of tasks for a device. Sum of num tasks should not exceed this number.
| [in] | compress | Compress context to get max number of tasks from |
| [out] | max_num_tasks | Sum of num tasks should not exceed this number ( |
| 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 | ||
| ) |
Get the maximum supported number of elements in DOCA linked-list buffer for compress deflate task.
| [in] | devinfo | The DOCA device information. |
| [out] | max_buf_list_len | The maximum supported number of elements in DOCA linked-list buffer. The value 1 indicates that only a single element is supported. |
| 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.
This method retrieves a compress deflate max size for a device
| [in] | devinfo | doca device info to check |
| [out] | max_buffer_size | The max buffer size for compress deflate operation in bytes. |
| 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.
This method checks if a compress deflate task is supported by a device
| [in] | devinfo | doca device info to check |
| 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 | ||
| ) |
Get the maximum supported number of elements in DOCA linked-list buffer for decompress deflate task.
| [in] | devinfo | The DOCA device information. |
| [out] | max_buf_list_len | The maximum supported number of elements in DOCA linked-list buffer. The value 1 indicates that only a single element is supported. |
| 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.
This method retrieves decompress deflate max size
| [in] | devinfo | doca device info to check |
| [out] | max_buffer_size | The max buffer size for decompress deflate operation in bytes. |
| 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.
This method checks if a decompress deflate task is supported by a device
| [in] | devinfo | doca device info to check |
| 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 | ||
| ) |
Get the maximum supported number of elements in DOCA linked-list buffer for decompress LZ4 block task.
| [in] | devinfo | The DOCA device information. |
| [out] | max_buf_list_len | The maximum supported number of elements in DOCA linked-list buffer. The value 1 indicates that only a single element is supported. |
| 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.
This method retrieves decompress LZ4 block max size
| [in] | devinfo | doca device info to check |
| [out] | max_buffer_size | The max buffer size for decompress LZ4 block operation in bytes. |
| 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.
This method checks if a decompress LZ4 block task is supported by a device
| [in] | devinfo | doca device info to check |
| 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 | ||
| ) |
Get the maximum supported number of elements in DOCA linked-list buffer for decompress LZ4 stream task
| [in] | devinfo | The DOCA device information. |
| [out] | max_buf_list_len | The maximum supported number of elements in DOCA linked-list buffer. The value 1 indicates that only a single element is supported. |
| 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.
This method retrieves decompress LZ4 stream max size
| [in] | devinfo | doca device info to check |
| [out] | max_buffer_size | The max buffer size for decompress LZ4 stream operation in bytes. |
| 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.
This method checks if a decompress LZ4 stream task is supported by a device
| [in] | devinfo | doca device info to check |
| DOCA_EXPERIMENTAL doca_error_t doca_compress_create | ( | struct doca_dev * | dev, |
| struct doca_compress ** | compress | ||
| ) |
Create a DOCA COMPRESS instance.
| [in] | dev | The device to attach to the compress context |
| [out] | compress | Pointer to pointer to be set to point to the created doca_compress instance. |
| DOCA_EXPERIMENTAL doca_error_t doca_compress_destroy | ( | struct doca_compress * | compress | ) |
Destroy a DOCA COMPRESS instance.
| [in] | compress | Pointer to instance to be destroyed. |
| 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.
This method allocates and initializes a compress deflate task. Task parameters can be set later on by setters.
| [in] | compress | The compress context to allocate the task from |
| [in] | src_buff | Source buffer |
| [in] | dst_buff | Destination buffer |
| [in] | user_data | doca_data that can be retrieved from the task (usually when the task is completed). |
| [out] | task | The allocated 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
| [in] | task | The task to convert |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the source from |
| 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.
| [in] | compress | The compress context to config |
| [in] | task_completion_cb | Task completion callback |
| [in] | task_error_cb | Task error callback |
| [in] | num_tasks | Number of compress deflate tasks that the context can allocate |
| 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
| [in] | task | Task to set the destination to |
| [in] | dst_buff | destination buffer to set |
| 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
| [in] | task | Task to set the source to |
| [in] | src_buff | Source buffer to set |
| 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.
This method allocates and initializes a decompress deflate task. Task parameters can be set later on by setters.
| [in] | compress | The compress context to allocate the task from |
| [in] | src_buff | Source buffer |
| [in] | dst_buff | Destination buffer |
| [in] | user_data | doca_data that can be retrieved from the task (usually when the task is completed). |
| [out] | task | The allocated 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
| [in] | task | The task to convert |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the source from |
| 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.
| [in] | compress | The compress context to config |
| [in] | task_completion_cb | Task completion callback |
| [in] | task_error_cb | Task error callback |
| [in] | num_tasks | Number of decompress deflate tasks that the context can allocate |
| 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
| [in] | task | Task to set the destination to |
| [in] | dst_buff | destination buffer to set |
| 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
| [in] | task | Task to set the source to |
| [in] | src_buff | Source buffer to set |
| 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.
This method allocates and initializes a decompress LZ4 block task. Task parameters can be set later on by setters.
| [in] | compress | The compress context to allocate the task from |
| [in] | src_buff | Source buffer |
| [in] | dst_buff | Destination buffer |
| [in] | user_data | doca_data that can be retrieved from the task (usually when the task is completed). |
| [out] | task | The allocated 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
| [in] | task | The task to convert |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the source from |
| 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
| [in] | task | Task to get the checksums from |
| 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.
| [in] | compress | The compress context to config |
| [in] | task_completion_cb | Task completion callback |
| [in] | task_error_cb | Task error callback |
| [in] | num_tasks | Number of decompress LZ4 block tasks that the context can allocate |
| 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
| [in] | task | Task to set the destination to |
| [in] | dst_buff | destination buffer to set |
| 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
| [in] | task | Task to set the source to |
| [in] | src_buff | Source buffer to set |
| 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.
This method allocates and initializes a decompress LZ4 stream task. Task parameters can be set later on by setters.
| [in] | compress | The compress context to allocate the task from |
| [in] | has_block_checksum | 1 if the task should expect blocks in the stream to have a checksum, 0 otherwise |
| [in] | are_blocks_independent | 1 the the task should expect blocks to be independent, 0 otherwise (dependent blocks) |
| [in] | src_buff | Source buffer |
| [in] | dst_buff | Destination buffer |
| [in] | user_data | doca_data that can be retrieved from the task (usually when the task is completed). |
| [out] | task | The allocated 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
| [in] | task | The task to convert |
| 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
| [in] | task | Task to get the are_blocks_independent flag from |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the destination from |
| 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
| [in] | task | Task to get the has_block_checksum flag from |
| 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
| [in] | task | Task to get the source from |
| 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
| [in] | task | Task to get the checksums from |
| 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
| [in] | task | Task to set the source to |
| [in] | are_blocks_independent | 1 the the task should expect blocks to be independent, 0 otherwise (dependent blocks) |
| 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.
| [in] | compress | The compress context to config |
| [in] | task_completion_cb | Task completion callback |
| [in] | task_error_cb | Task error callback |
| [in] | num_tasks | Number of decompress LZ4 stream tasks that the context can allocate |
| 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
| [in] | task | Task to set the destination to |
| [in] | dst_buff | destination buffer to set |
| 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
| [in] | task | Task to set the source to |
| [in] | has_block_checksum | 1 if the task should expect blocks in the stream to have a checksum, 0 otherwise |
| 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
| [in] | task | Task to set the source to |
| [in] | src_buff | Source buffer to set |