greg/pcompress
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
pcompress/pcompress.h

188 lines
6.5 KiB
C
Raw Normal View History

Initial Commit.
2012-05-28 14:49:29 +00:00
/*
* This file is a part of Pcompress, a chunked parallel multi-
* algorithm lossless compression and decompression program.
*
* Copyright (C) 2012 Moinak Ghosh. All rights reserved.
* Use is subject to license terms.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
Update License info to LGPLv3.
2012-07-07 16:48:29 +00:00
* version 3 of the License, or (at your option) any later version.
Initial Commit.
2012-05-28 14:49:29 +00:00
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* moinakg@belenix.org, http://moinakg.wordpress.com/
*
* This program includes partly-modified public domain source
* code from the LZMA SDK: http://www.7-zip.org/sdk.html
*/
#ifndef _PCOMPRESS_H
#define _PCOMPRESS_H
#include <sys/types.h>
#include <pthread.h>
#include <semaphore.h>
#ifdef __cplusplus
extern "C" {
#endif
Add xxHash for Rabin block checksums, slightly faster than CRC64. Fix missing initialization of character counts table. Some file reorganization.
2012-09-02 15:10:32 +00:00
#include <rabin_dedup.h>
Implement HMAC Functionality. Refactor crypto utility functions in a separate file. Add HMAC verification for file header. Add a few extra input validation checks. Include space in chunk header for HMAC.
2012-10-17 18:02:35 +00:00
#include <crypto_utils.h>
Implement Deduplication based on Rabin Fingerprinting: work in progress. Fix bug that prevented pipe mode from being used. Allow building without specialized allocator. Use basic optimize flag in debuig build.
2012-06-29 12:53:55 +00:00
Add support for Skein512 and Skein256 checksums Import Skein code from NIST CD submission Make checksum algorithms pluggable Fix handling of huge buffers (>2GB) in LZP Cleanup of some buffer sizing code Speed up CRC64 calculation in dedupe chunking
2012-08-31 17:06:06 +00:00
#define CHUNK_FLAG_SZ 1
Initial Commit.
2012-05-28 14:49:29 +00:00
#define ALGO_SZ 8
#define MIN_CHUNK 2048
Support for chunk-level encryption using AES and Scrypt based PBE. Couple of minor fixes.
2012-10-15 06:40:00 +00:00
#define VERSION 4
Implement Deduplication based on Rabin Fingerprinting: work in progress. Fix bug that prevented pipe mode from being used. Allow building without specialized allocator. Use basic optimize flag in debuig build.
2012-06-29 12:53:55 +00:00
#define FLAG_DEDUP 1
Support for chunk-level encryption using AES and Scrypt based PBE. Couple of minor fixes.
2012-10-15 06:40:00 +00:00
#define FLAG_DEDUP_FIXED 2
#define FLAG_SINGLE_CHUNK 4
Update Changelog for 1.0 release. Update version string and install doc. Add Fixed-Block Deduplication tests.
2012-11-09 16:12:56 +00:00
#define UTILITY_VERSION "1.0.0"
Support for chunk-level encryption using AES and Scrypt based PBE. Couple of minor fixes.
2012-10-15 06:40:00 +00:00
#define MASK_CRYPTO_ALG 0x30
Implement HMAC Functionality. Refactor crypto utility functions in a separate file. Add HMAC verification for file header. Add a few extra input validation checks. Include space in chunk header for HMAC.
2012-10-17 18:02:35 +00:00
#define MAX_LEVEL 14
Initial Commit.
2012-05-28 14:49:29 +00:00
#define COMPRESSED 1
#define UNCOMPRESSED 0
#define CHSIZE_MASK 0x80
#define BZIP2_A_NUM 16
#define LZMA_A_NUM 32
Fix handling of compression flags in adaptive mode Fix error handling when chunk size is too small for dedupe Bump version to 0.6
2012-08-10 05:17:11 +00:00
#define CHUNK_FLAG_DEDUP 2
Add LZP Pre-Compression support ported from libbsc. Add generic pre-processing wrappers for future support of other pre-processors. Clean up computation of Rabin block sizes. Compute Rabin scratch space accurately to avoid RAM wastage.
2012-08-23 17:28:44 +00:00
#define CHUNK_FLAG_PREPROC 4
Fix handling of compression flags in adaptive mode Fix error handling when chunk size is too small for dedupe Bump version to 0.6
2012-08-10 05:17:11 +00:00
#define COMP_EXTN ".pz"
Add LZP Pre-Compression support ported from libbsc. Add generic pre-processing wrappers for future support of other pre-processors. Clean up computation of Rabin block sizes. Compute Rabin scratch space accurately to avoid RAM wastage.
2012-08-23 17:28:44 +00:00
#define PREPROC_TYPE_LZP 1
#define PREPROC_COMPRESSED 128
Fix handling of compression flags in adaptive mode Fix error handling when chunk size is too small for dedupe Bump version to 0.6
2012-08-10 05:17:11 +00:00
/*
Add support for Skein512 and Skein256 checksums Import Skein code from NIST CD submission Make checksum algorithms pluggable Fix handling of huge buffers (>2GB) in LZP Cleanup of some buffer sizing code Speed up CRC64 calculation in dedupe chunking
2012-08-31 17:06:06 +00:00
* Sizes of chunk header components.
*/
#define COMPRESSED_CHUNKSZ (sizeof (uint64_t))
#define ORIGINAL_CHUNKSZ (sizeof (uint64_t))
#define CHUNK_HDR_SZ (COMPRESSED_CHUNKSZ + cksum_bytes + ORIGINAL_CHUNKSZ + CHUNK_FLAG_SZ)
/*
* lower 3 bits in higher nibble indicate chunk compression algorithm
* in adaptive modes.
Fix handling of compression flags in adaptive mode Fix error handling when chunk size is too small for dedupe Bump version to 0.6
2012-08-10 05:17:11 +00:00
*/
Fix chunk flag setup when compression fails in adaptive mode. Prevent display of non-fatal errors during compression.
2012-11-09 15:37:23 +00:00
#define COMPRESS_NONE 0
Initial Commit.
2012-05-28 14:49:29 +00:00
#define COMPRESS_LZMA 1
#define COMPRESS_BZIP2 2
#define COMPRESS_PPMD 3
Use Libbsc for XML data in adapt2 mode.
2012-11-04 15:43:26 +00:00
#define COMPRESS_BSC 4
Fix handling of compression flags in adaptive mode Fix error handling when chunk size is too small for dedupe Bump version to 0.6
2012-08-10 05:17:11 +00:00
#define CHDR_ALGO_MASK 7
Initial Commit.
2012-05-28 14:49:29 +00:00
Update chunk size computation to reduce memory usage. Implement runtime bypass of custom allocator. Update README.
2012-07-27 16:33:24 +00:00
extern uint32_t zlib_buf_extra(ssize_t buflen);
Fix buffer sizing for LZ4. Fix exit condition checks in LZ4 decompression wrapper.
2012-08-04 12:25:20 +00:00
extern int lz4_buf_extra(ssize_t buflen);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int zlib_compress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *destlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int lzma_compress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *destlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int bzip2_compress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *destlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int adapt_compress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *dstlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int ppmd_compress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *dstlen, int level, uchar_t chdr, void *data);
Add LZFX Compression support, a very fast lightweight compressor. Avoid a branch in the rabin loop.
2012-07-22 18:45:08 +00:00
extern int lz_fx_compress(void *src, size_t srclen, void *dst,
size_t *dstlen, int level, uchar_t chdr, void *data);
Add support for LZ4 compression including multi-pass LZ4. Add missing Read_Adjusted() declaration, was causing a crash with 2GB chunks. Fix minor cut-paste issues in comments.
2012-07-25 15:37:36 +00:00
extern int lz4_compress(void *src, size_t srclen, void *dst,
size_t *dstlen, int level, uchar_t chdr, void *data);
Fix handling of incompressible chunks. Fix handling of various dedup failures. Add NULL compression option for dedup only compression.
2012-08-05 17:05:51 +00:00
extern int none_compress(void *src, size_t srclen, void *dst,
size_t *dstlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int zlib_decompress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *dstlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int lzma_decompress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *dstlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int bzip2_decompress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *dstlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int adapt_decompress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *dstlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int ppmd_decompress(void *src, size_t srclen, void *dst,
Implement Parallel deduplication support. Restructure compression functions to take chunk flag as argument. Add missing error flag printing in LZMA. Only create enough threads as needed by chunk size and file size. Minor cleanups and variable name changes.
2012-07-01 16:14:02 +00:00
size_t *dstlen, int level, uchar_t chdr, void *data);
Add LZFX Compression support, a very fast lightweight compressor. Avoid a branch in the rabin loop.
2012-07-22 18:45:08 +00:00
extern int lz_fx_decompress(void *src, size_t srclen, void *dst,
size_t *dstlen, int level, uchar_t chdr, void *data);
Add support for LZ4 compression including multi-pass LZ4. Add missing Read_Adjusted() declaration, was causing a crash with 2GB chunks. Fix minor cut-paste issues in comments.
2012-07-25 15:37:36 +00:00
extern int lz4_decompress(void *src, size_t srclen, void *dst,
size_t *dstlen, int level, uchar_t chdr, void *data);
Fix handling of incompressible chunks. Fix handling of various dedup failures. Add NULL compression option for dedup only compression.
2012-08-05 17:05:51 +00:00
extern int none_decompress(void *src, size_t srclen, void *dst,
size_t *dstlen, int level, uchar_t chdr, void *data);
Initial Commit.
2012-05-28 14:49:29 +00:00
Add multithreaded LZMA port from p7zip Compute balanced thread count between chunk threads and algo threads Generic way to handle querying algorithm parameters Clean up unnecessary includes
2012-08-18 04:50:52 +00:00
extern int adapt_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern int adapt2_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern int lzma_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern int ppmd_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern int bzip2_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern int zlib_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern int lz_fx_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern int lz4_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern int none_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern void lzma_props(algo_props_t *data, int level, ssize_t chunksize);
Delay allocation of per-thread chunks for performance and memory efficiency. Avoid allocating double-buffer for single-chunk files. Introduce lzmaMt option to indicate multithreaded LZMA. Update README.
2012-08-18 16:30:14 +00:00
extern void lzma_mt_props(algo_props_t *data, int level, ssize_t chunksize);
Add multithreaded LZMA port from p7zip Compute balanced thread count between chunk threads and algo threads Generic way to handle querying algorithm parameters Clean up unnecessary includes
2012-08-18 04:50:52 +00:00
extern void lz4_props(algo_props_t *data, int level, ssize_t chunksize);
Add basic compression statistics and new option to display them.
2012-05-31 16:06:33 +00:00
Bias fingerprint value with occurrence counts for a better sketch Fix latent bug when calling algo deinit in decompression code Reduce diff threshold for slightly greater delta encoding Limit similar buffer size difference for less wasted diffing Change zlib compression wrapper to use faster deflateReset mechanism Reduce optimization level for Dedupe code, it goes faster
2012-08-08 17:10:58 +00:00
extern int zlib_deinit(void **data);
Initial Commit.
2012-05-28 14:49:29 +00:00
extern int adapt_deinit(void **data);
extern int lzma_deinit(void **data);
extern int ppmd_deinit(void **data);
Make LZFX Hash size dynamic. Use smaller min rabin block when using fast compression algos. Add missing check for algo init function return value.
2012-07-23 16:13:12 +00:00
extern int lz_fx_deinit(void **data);
Add support for LZ4 compression including multi-pass LZ4. Add missing Read_Adjusted() declaration, was causing a crash with 2GB chunks. Fix minor cut-paste issues in comments.
2012-07-25 15:37:36 +00:00
extern int lz4_deinit(void **data);
Fix handling of incompressible chunks. Fix handling of various dedup failures. Add NULL compression option for dedup only compression.
2012-08-05 17:05:51 +00:00
extern int none_deinit(void **data);
Initial Commit.
2012-05-28 14:49:29 +00:00
Add basic compression statistics and new option to display them.
2012-05-31 16:06:33 +00:00
extern void adapt_stats(int show);
extern void ppmd_stats(int show);
extern void lzma_stats(int show);
extern void bzip2_stats(int show);
extern void zlib_stats(int show);
Add LZFX Compression support, a very fast lightweight compressor. Avoid a branch in the rabin loop.
2012-07-22 18:45:08 +00:00
extern void lz_fx_stats(int show);
Add support for LZ4 compression including multi-pass LZ4. Add missing Read_Adjusted() declaration, was causing a crash with 2GB chunks. Fix minor cut-paste issues in comments.
2012-07-25 15:37:36 +00:00
extern void lz4_stats(int show);
Fix handling of incompressible chunks. Fix handling of various dedup failures. Add NULL compression option for dedup only compression.
2012-08-05 17:05:51 +00:00
extern void none_stats(int show);
Add basic compression statistics and new option to display them.
2012-05-31 16:06:33 +00:00
Add support for libbsc a high-performance block sorting compressor. Enable external algorithm threading for single chunk compressed files. Update docs.
2012-08-27 16:21:55 +00:00
#ifdef ENABLE_PC_LIBBSC
extern int libbsc_compress(void *src, size_t srclen, void *dst,
size_t *dstlen, int level, uchar_t chdr, void *data);
extern int libbsc_decompress(void *src, size_t srclen, void *dst,
size_t *dstlen, int level, uchar_t chdr, void *data);
extern int libbsc_init(void **data, int *level, int nthreads, ssize_t chunksize);
extern void libbsc_props(algo_props_t *data, int level, ssize_t chunksize);
extern int libbsc_deinit(void **data);
extern void libbsc_stats(int show);
#endif
Initial Commit.
2012-05-28 14:49:29 +00:00
/*
* Per-thread data structure for compression and decompression threads.
*/
struct cmp_data {
uchar_t *cmp_seg;
uchar_t *compressed_chunk;
uchar_t *uncompressed_chunk;
Add support for Fixed-Block deduplication. More refactoring of symbol names.
2012-09-16 05:42:58 +00:00
dedupe_context_t *rctx;
Initial Commit.
2012-05-28 14:49:29 +00:00
ssize_t rbytes;
ssize_t chunksize;
Implement HMAC verification for chunk data and header. Do not ask for decryption passwd twice.
2012-10-18 17:25:41 +00:00
ssize_t len_cmp, len_cmp_be;
Add support for Skein512 and Skein256 checksums Import Skein code from NIST CD submission Make checksum algorithms pluggable Fix handling of huge buffers (>2GB) in LZP Cleanup of some buffer sizing code Speed up CRC64 calculation in dedupe chunking
2012-08-31 17:06:06 +00:00
uchar_t checksum[CKSUM_MAX_BYTES];
Initial Commit.
2012-05-28 14:49:29 +00:00
int level;
unsigned int id;
compress_func_ptr compress;
compress_func_ptr decompress;
int cancel;
sem_t start_sem;
sem_t cmp_done_sem;
sem_t write_done_sem;
void *data;
pthread_t thr;
Implement HMAC verification for chunk data and header. Do not ask for decryption passwd twice.
2012-10-18 17:25:41 +00:00
mac_ctx_t chunk_hmac;
Initial Commit.
2012-05-28 14:49:29 +00:00
};
#ifdef __cplusplus
}
#endif
#endif
Reference in a new issue Copy permalink