api/spec/comp.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2018 Linaro Limited
 */
 
#ifndef ODP_API_SPEC_COMP_H_
#define ODP_API_SPEC_COMP_H_
 
#include <odp/visibility_begin.h>
 
#include <odp/api/event_types.h>
#include <odp/api/packet_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/std_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    ODP_COMP_OP_MODE_SYNC,
 
    ODP_COMP_OP_MODE_ASYNC
} odp_comp_op_mode_t;
 
typedef enum {
    ODP_COMP_OP_COMPRESS,
 
    ODP_COMP_OP_DECOMPRESS
} odp_comp_op_t;
 
typedef enum {
    ODP_COMP_HASH_ALG_NONE,
 
    ODP_COMP_HASH_ALG_SHA1,
 
    ODP_COMP_HASH_ALG_SHA256
} odp_comp_hash_alg_t;
 
typedef enum {
    ODP_COMP_ALG_NULL,
 
    ODP_COMP_ALG_DEFLATE,
 
    ODP_COMP_ALG_ZLIB,
 
    ODP_COMP_ALG_LZS
} odp_comp_alg_t;
 
typedef enum {
    ODP_COMP_STATUS_SUCCESS,
 
    ODP_COMP_STATUS_OUT_OF_SPACE_TERM,
 
    ODP_COMP_STATUS_FAILURE,
} odp_comp_status_t;
 
typedef union odp_comp_hash_algos_t {
    struct {
        uint32_t none   : 1;
 
        uint32_t sha1   : 1;
 
        uint32_t sha256 : 1;
 
    } bit;
 
    uint32_t all_bits;
} odp_comp_hash_algos_t;
 
typedef union odp_comp_algos_t {
    struct {
        uint32_t null       : 1;
 
        uint32_t deflate    : 1;
 
        uint32_t zlib       : 1;
 
        uint32_t lzs        : 1;
    } bit;
 
    uint32_t all_bits;
} odp_comp_algos_t;
 
typedef struct odp_comp_capability_t {
    uint32_t max_sessions;
 
    odp_comp_algos_t comp_algos;
 
    odp_comp_hash_algos_t hash_algos;
 
    odp_support_t sync;
 
    odp_support_t async;
} odp_comp_capability_t;
 
typedef struct odp_comp_hash_alg_capability_t {
    uint32_t digest_len;
} odp_comp_hash_alg_capability_t;
 
typedef struct odp_comp_alg_capability_t {
    uint32_t max_level;
 
    odp_comp_hash_algos_t hash_algo;
 
    odp_percent_t compression_ratio;
} odp_comp_alg_capability_t;
 
typedef enum odp_comp_huffman_code {
    ODP_COMP_HUFFMAN_FIXED,
 
    ODP_COMP_HUFFMAN_DYNAMIC,
 
    ODP_COMP_HUFFMAN_DEFAULT,
} odp_comp_huffman_code_t;
 
typedef struct odp_comp_deflate_param {
    uint32_t comp_level;
 
    odp_comp_huffman_code_t huffman_code;
} odp_comp_deflate_param_t;
 
typedef union odp_comp_alg_param_t {
    odp_comp_deflate_param_t deflate;
 
    struct {
        odp_comp_deflate_param_t deflate;
    } zlib;
} odp_comp_alg_param_t;
 
typedef struct odp_comp_session_param_t {
    odp_comp_op_t op;
 
    odp_comp_op_mode_t mode;
 
    odp_comp_alg_t comp_algo;
 
    odp_comp_hash_alg_t hash_algo;
 
    odp_comp_alg_param_t alg_param;
 
    odp_bool_t packet_order;
 
    odp_queue_t compl_queue;
} odp_comp_session_param_t;
 
typedef struct odp_comp_packet_result_t {
    odp_comp_status_t status;
 
    odp_packet_t pkt_in;
 
    odp_packet_data_range_t output_data_range;
} odp_comp_packet_result_t;
 
typedef struct odp_comp_packet_op_param_t {
    odp_comp_session_t session;
 
    odp_packet_data_range_t in_data_range;
 
    odp_packet_data_range_t out_data_range;
} odp_comp_packet_op_param_t;
 
int odp_comp_capability(odp_comp_capability_t *capa);
 
int odp_comp_alg_capability(odp_comp_alg_t comp,
                odp_comp_alg_capability_t *capa);
 
int odp_comp_hash_alg_capability(odp_comp_hash_alg_t hash,
                 odp_comp_hash_alg_capability_t *capa);
 
void odp_comp_session_param_init(odp_comp_session_param_t *param);
 
odp_comp_session_t
odp_comp_session_create(const odp_comp_session_param_t *param);
 
int odp_comp_session_destroy(odp_comp_session_t session);
 
int odp_comp_op(const odp_packet_t pkt_in[], odp_packet_t pkt_out[],
        int num_pkt, const odp_comp_packet_op_param_t param[]);
 
int odp_comp_op_enq(const odp_packet_t pkt_in[], odp_packet_t pkt_out[],
            int num_pkt, const odp_comp_packet_op_param_t param[]);
 
int odp_comp_result(odp_comp_packet_result_t *result, odp_packet_t packet);
 
odp_packet_t odp_comp_packet_from_event(odp_event_t event);
 
odp_event_t odp_comp_packet_to_event(odp_packet_t pkt);
 
uint64_t odp_comp_session_to_u64(odp_comp_session_t hdl);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif