rte_comp.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2017-2018 Intel Corporation
 */
 
#ifndef _RTE_COMP_H_
#define _RTE_COMP_H_

 
#include <rte_common.h>
#include <rte_mbuf.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define RTE_COMP_FF_STATEFUL_COMPRESSION    (1ULL << 0)
#define RTE_COMP_FF_STATEFUL_DECOMPRESSION  (1ULL << 1)
#define RTE_COMP_FF_OOP_SGL_IN_SGL_OUT      (1ULL << 2)
#define RTE_COMP_FF_OOP_SGL_IN_LB_OUT       (1ULL << 3)
#define RTE_COMP_FF_OOP_LB_IN_SGL_OUT       (1ULL << 4)
#define RTE_COMP_FF_ADLER32_CHECKSUM        (1ULL << 5)
#define RTE_COMP_FF_CRC32_CHECKSUM      (1ULL << 6)
#define RTE_COMP_FF_CRC32_ADLER32_CHECKSUM  (1ULL << 7)
#define RTE_COMP_FF_MULTI_PKT_CHECKSUM      (1ULL << 8)
#define RTE_COMP_FF_SHA1_HASH           (1ULL << 9)
#define RTE_COMP_FF_SHA2_SHA256_HASH        (1ULL << 10)
#define RTE_COMP_FF_NONCOMPRESSED_BLOCKS    (1ULL << 11)
#define RTE_COMP_FF_SHAREABLE_PRIV_XFORM    (1ULL << 12)
#define RTE_COMP_FF_HUFFMAN_FIXED       (1ULL << 13)
#define RTE_COMP_FF_HUFFMAN_DYNAMIC     (1ULL << 14)
#define RTE_COMP_FF_XXHASH32_CHECKSUM       (1ULL << 15)
#define RTE_COMP_FF_LZ4_DICT_ID         (1ULL << 16)
#define RTE_COMP_FF_LZ4_CONTENT_WITH_CHECKSUM   (1ULL << 17)
#define RTE_COMP_FF_LZ4_CONTENT_SIZE        (1ULL << 18)
#define RTE_COMP_FF_LZ4_BLOCK_INDEPENDENCE  (1ULL << 19)
#define RTE_COMP_FF_LZ4_BLOCK_WITH_CHECKSUM (1ULL << 20)

enum rte_comp_op_status {
    RTE_COMP_OP_STATUS_SUCCESS = 0,
    RTE_COMP_OP_STATUS_NOT_PROCESSED,
    RTE_COMP_OP_STATUS_INVALID_ARGS,
    RTE_COMP_OP_STATUS_ERROR,
    RTE_COMP_OP_STATUS_INVALID_STATE,
    RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED,
    RTE_COMP_OP_STATUS_OUT_OF_SPACE_RECOVERABLE,
    RTE_COMP_OP_STATUS_CHECKSUM_VALIDATION_FAILED,
};

enum rte_comp_algorithm {
    RTE_COMP_ALGO_UNSPECIFIED = 0,
    RTE_COMP_ALGO_NULL,
    RTE_COMP_ALGO_DEFLATE,
    RTE_COMP_ALGO_LZS,
    RTE_COMP_ALGO_LZ4,
};

enum rte_comp_hash_algorithm {
    RTE_COMP_HASH_ALGO_NONE = 0,
    RTE_COMP_HASH_ALGO_SHA1,
    RTE_COMP_HASH_ALGO_SHA2_256,
};

#define RTE_COMP_LEVEL_PMD_DEFAULT  (-1)
#define RTE_COMP_LEVEL_NONE     (0)
#define RTE_COMP_LEVEL_MIN      (1)
#define RTE_COMP_LEVEL_MAX      (9)

enum rte_comp_checksum_type {
    RTE_COMP_CHECKSUM_NONE,
    RTE_COMP_CHECKSUM_CRC32,
    RTE_COMP_CHECKSUM_ADLER32,
    RTE_COMP_CHECKSUM_CRC32_ADLER32,
    RTE_COMP_CHECKSUM_XXHASH32,
    RTE_COMP_CHECKSUM_3GPP_PDCP_UDC,
};

enum rte_comp_huffman {
    RTE_COMP_HUFFMAN_DEFAULT,
    RTE_COMP_HUFFMAN_FIXED,
    RTE_COMP_HUFFMAN_DYNAMIC,
};

enum rte_comp_flush_flag {
    RTE_COMP_FLUSH_NONE,
    RTE_COMP_FLUSH_SYNC,
    RTE_COMP_FLUSH_FULL,
    RTE_COMP_FLUSH_FINAL
};

enum rte_comp_xform_type {
    RTE_COMP_COMPRESS,
    RTE_COMP_DECOMPRESS,
};

enum rte_comp_op_type {
    RTE_COMP_OP_STATELESS,
    RTE_COMP_OP_STATEFUL
};

struct rte_comp_deflate_params {
    enum rte_comp_huffman huffman;
    uint8_t *dictionary;
    uint16_t dictionary_len;
};

struct rte_comp_inflate_params {
    uint8_t *dictionary;
    uint16_t dictionary_len;
};

#define RTE_COMP_LZ4_FLAG_DICT_ID (1 << 0)

#define RTE_COMP_LZ4_FLAG_CONTENT_CHECKSUM (1 << 2)

#define RTE_COMP_LZ4_FLAG_CONTENT_SIZE (1 << 3)

#define RTE_COMP_LZ4_FLAG_BLOCK_CHECKSUM (1 << 4)

#define RTE_COMP_LZ4_FLAG_BLOCK_INDEPENDENCE (1 << 5)

struct rte_comp_lz4_params {
    uint8_t flags;
};

struct rte_comp_compress_xform {
    enum rte_comp_algorithm algo;
    union {
        struct rte_comp_deflate_params deflate;
        struct rte_comp_lz4_params lz4;
    }; 
    int level;
    uint8_t window_size;
    enum rte_comp_checksum_type chksum;
    enum rte_comp_hash_algorithm hash_algo;
};

struct rte_comp_decompress_xform {
    enum rte_comp_algorithm algo;
    enum rte_comp_checksum_type chksum;
    uint8_t window_size;
    union {
        struct rte_comp_inflate_params inflate;
        struct rte_comp_lz4_params lz4;
    }; 
    enum rte_comp_hash_algorithm hash_algo;
};

struct rte_comp_xform {
    enum rte_comp_xform_type type;
    union {
        struct rte_comp_compress_xform compress;
        struct rte_comp_decompress_xform decompress;
    };
};

struct __rte_cache_aligned rte_comp_op {
    enum rte_comp_op_type op_type;
    union {
        void *private_xform;
        void *stream;
    };
 
    struct rte_mempool *mempool;
    rte_iova_t iova_addr;
    struct rte_mbuf *m_src;
    struct rte_mbuf *m_dst;
 
    struct {
        uint32_t offset;
        uint32_t length;
    } src;
    struct {
        uint32_t offset;
    } dst;
    struct {
        uint8_t *digest;
        rte_iova_t iova_addr;
    } hash;
    enum rte_comp_flush_flag flush_flag;
    uint64_t input_chksum;
    uint64_t output_chksum;
    uint32_t consumed;
    uint32_t produced;
    uint64_t debug_status;
    uint8_t status;
};

void
rte_comp_op_free(struct rte_comp_op *op);

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, 1);

struct rte_comp_op *
rte_comp_op_alloc(struct rte_mempool *mempool);

int
rte_comp_op_bulk_alloc(struct rte_mempool *mempool,
        struct rte_comp_op **ops, uint16_t nb_ops);

void
rte_comp_op_bulk_free(struct rte_comp_op **ops, uint16_t nb_ops);

const char *
rte_comp_get_feature_name(uint64_t flag);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTE_COMP_H_ */