generic-library/isa-l
1
0
Fork 0
mirror of https://github.com/intel/isa-l.git synced 2025-10-29 12:18:00 +01:00
Code Issues Projects Releases Wiki Activity

doc: Add detail of internal checksum value in gzip/zlib mode

Browse Source 
Change-Id: I8f7fdcec40371e61eb19248cb24c9837d0845a0c
Signed-off-by: Greg Tucker <greg.b.tucker@intel.com>
This commit is contained in:
Greg Tucker
2018-11-27 10:04:40 -07:00
parent 940515d51f
commit e19101f5de
1 changed files with 18 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
include/igzip_lib.h
View File

@@ -358,7 +358,7 @@ struct isal_zstate {
uint32_t hash_mask; uint32_t hash_mask;
enum isal_zstate_state state; //!< Current state in processing the data stream enum isal_zstate_state state; //!< Current state in processing the data stream
struct BitBuf2 bitbuf; //!< Bit Buffer struct BitBuf2 bitbuf; //!< Bit Buffer
uint32_t crc; //!< Current crc uint32_t crc; //!< Current checksum without finalize step if any (adler)
uint8_t has_wrap_hdr; //!< keeps track of wrapper header uint8_t has_wrap_hdr; //!< keeps track of wrapper header
uint8_t has_eob_hdr; //!< keeps track of eob hdr (with BFINAL set) uint8_t has_eob_hdr; //!< keeps track of eob hdr (with BFINAL set)
uint8_t has_eob; //!< keeps track of eob on the last deflate block uint8_t has_eob; //!< keeps track of eob on the last deflate block
@@ -511,7 +511,7 @@ struct inflate_state {
uint32_t dict_length; //!< Length of dictionary used uint32_t dict_length; //!< Length of dictionary used
uint32_t bfinal; //!< Flag identifying final block uint32_t bfinal; //!< Flag identifying final block
uint32_t crc_flag; //!< Flag identifying whether to track of crc uint32_t crc_flag; //!< Flag identifying whether to track of crc
uint32_t crc; //!< Contains crc of output if crc_flag is set uint32_t crc; //!< Contains crc or adler32 of output if crc_flag is set
uint32_t hist_bits; //!< Log base 2 of maximum lookback distance uint32_t hist_bits; //!< Log base 2 of maximum lookback distance
union { union {
int32_t type0_block_len; //!< Length left to read of type 0 block when outbuffer overflow occured int32_t type0_block_len; //!< Length left to read of type 0 block when outbuffer overflow occured
@@ -727,7 +727,8 @@ int isal_deflate_set_dict(struct isal_zstream *stream, uint8_t *dict, uint32_t d
* *
* If the gzip_flag is set to IGZIP_GZIP, a generic gzip header and the gzip * If the gzip_flag is set to IGZIP_GZIP, a generic gzip header and the gzip
* trailer are written around the deflate compressed data. If gzip_flag is set * trailer are written around the deflate compressed data. If gzip_flag is set
* to IGZIP_GZIP_NO_HDR, then only the gzip trailer is written. * to IGZIP_GZIP_NO_HDR, then only the gzip trailer is written. A full-featured
* header is supported by the isal_write_{gzip,zlib}_header() functions.
* *
* @param stream Structure holding state information on the compression streams. * @param stream Structure holding state information on the compression streams.
* @return COMP_OK (if everything is ok), * @return COMP_OK (if everything is ok),
@@ -855,19 +856,22 @@ int isal_read_zlib_header (struct inflate_state *state, struct isal_zlib_header
* (updating next_out and avail_out). The function returns when the input buffer * (updating next_out and avail_out). The function returns when the input buffer
* is empty, the output buffer is full, invalid data is found, or in the case of * is empty, the output buffer is full, invalid data is found, or in the case of
* zlib formatted data if a dictionary is specified. The current state of the * zlib formatted data if a dictionary is specified. The current state of the
* decompression on exit can be read from state->block-state. If the crc_flag is * decompression on exit can be read from state->block-state.
* set to ISAL_GZIP_NO_HDR the gzip crc of the output is stored in *
* state->crc. Alternatively, if the crc_flag is set to ISAL_ZLIB_NO_HDR the * If the crc_flag is set to ISAL_GZIP_NO_HDR the gzip crc of the output is
* adler32 of the output is stored in state->crc. When the crc_flag is set to * stored in state->crc. Alternatively, if the crc_flag is set to
* ISAL_GZIP_NO_HDR_VER or ISAL_ZLIB_NO_HDR_VER, the behaviour is the same, * ISAL_ZLIB_NO_HDR the adler32 of the output is stored in state->crc (checksum
* except the checksum is verified with the checksum after immediately followin * may not be updated until decompression is complete). When the crc_flag is set
* to ISAL_GZIP_NO_HDR_VER or ISAL_ZLIB_NO_HDR_VER, the behavior is the same,
* except the checksum is verified with the checksum after immediately following
* the deflate data. If the crc_flag is set to ISAL_GZIP or ISAL_ZLIB, the * the deflate data. If the crc_flag is set to ISAL_GZIP or ISAL_ZLIB, the
* gzip/zlib header is parsed, state->crc is set to the appropriate checksum, * gzip/zlib header is parsed, state->crc is set to the appropriate checksum,
* and the checksum is verfied. If the crc_flag is set to ISAL_DEFLATE * and the checksum is verified. If the crc_flag is set to ISAL_DEFLATE
* (default), then the data is treated as a raw deflate block. The element * (default), then the data is treated as a raw deflate block.
* state->hist_bits has values from 0 to 15, where values of 1 to 15 are the log *
* base 2 size of the matching window and 0 is the default with maximum history * The element state->hist_bits has values from 0 to 15, where values of 1 to 15
* size. * are the log base 2 size of the matching window and 0 is the default with
* maximum history size.
* *
* If a dictionary is required, a call to isal_inflate_set_dict will set the * If a dictionary is required, a call to isal_inflate_set_dict will set the
* dictionary. * dictionary.