Awesome
HPatchLite
english | 中文版
HPatchLite is a lite version of HDiffPatch, tiny code & ram requirements when patch on embedded systems,MCU,NB-IoT,...
The patch code(ROM or flash occupancy) very small, compiled by Mbed Studio is 662 bytes.
Tip: if define _IS_RUN_MEM_SAFE_CHECK=0, unsafe mode can reduce 80 bytes;
if used tinyuz & define _IS_USED_SHARE_hpatch_lite_types=1, can reduce 52 bytes.
At the same time, the patch memory(RAM occupancy) can also be very small,
RAM size = one decompress memory size + input cache size(>=3Byte) when patch.
Tip: The smaller input cache only affects the patch speed.
Releases/Binaries
Download from latest release : Command line app for Windows, Linux, MacOS.
( release files build by projects in path HPatchLite/builds )
Build it yourself
Linux or MacOS X
$ cd <dir>
$ git clone --recursive https://github.com/sisong/HPatchLite.git
$ cd HPatchLite
$ make
Windows
$ cd <dir>
$ git clone --recursive https://github.com/sisong/HPatchLite.git
build HPatchLite/builds/vc/HPatchLite.sln with Visual Studio
diff command line usage:
diff usage: hdiffi [options] oldFile newFile outDiffFile
test usage: hdiffi -t oldFile newFile testDiffFile
oldFile can empty, and input parameter ""
memory options:
-m[-matchScore]
requires (newFileSize+ oldFileSize*5(or *9 when oldFileSize>=2GB))+O(1)
bytes of memory;
matchScore>=0, DEFAULT -m-6
special options:
-cache
set is use a big cache for slow match, DEFAULT false;
if newData not similar to oldData then diff speed++,
big cache max used O(oldFileSize) memory, and build slow(diff speed--)
-p-parallelThreadNumber
if parallelThreadNumber>1 then open multi-thread Parallel mode;
DEFAULT -p-4; requires more memory!
-c-compressType[-compressLevel]
set outDiffFile Compress type, DEFAULT uncompress;
support compress type & level & dict:
-c-tuz[-dictSize] (or -tinyuz)
1<=dictSize<=1g, can like 250,511,1k,4k,64k,1m,64m,512m..., DEFAULT 32k
-c-zlib[-{1..9}[-dictBits]] DEFAULT level 9
dictBits can 9--15, DEFAULT 15.
-c-pzlib[-{1..9}[-dictBits]] DEFAULT level 6
dictBits can 9--15, DEFAULT 15.
support run by multi-thread parallel, fast!
-c-lzma[-{0..9}[-dictSize]] DEFAULT level 7
dictSize can like 4096 or 4k or 4m or 128m etc..., DEFAULT 32k
support run by 2-thread parallel.
-c-lzma2[-{0..9}[-dictSize]] DEFAULT level 7
dictSize can like 4096 or 4k or 4m or 128m etc..., DEFAULT 32k
support run by multi-thread parallel, fast!
WARNING: code not compatible with it compressed by -c-lzma!
-d Diff only, do't run patch check, DEFAULT run patch check.
-t Test only, run patch check, patch(oldFile,testDiffFile)==newFile ?
-f Force overwrite, ignore write path already exists;
DEFAULT (no -f) not overwrite and then return error;
if used -f and write path is exist directory, will always return error.
--patch
swap to hpatchi mode.
-v output Version info.
-h (or -?)
output usage info.
patch command line usage:
patch usage: hpatchi [options] oldFile diffFile outNewFile
if oldFile is empty input parameter ""
options:
-s[-cacheSize]
DEFAULT -s-32k; cacheSize>=3, can like 256,1k, 60k or 1m etc....
requires (cacheSize + 1*decompress buffer size)+O(1) bytes of memory.
-f Force overwrite, ignore write path already exists;
DEFAULT (no -f) not overwrite and then return error;
if used -f and write path is exist directory, will always return error.
-v output Version info.
-h (or -?)
output usage info.
library API usage:
create hpatch_lite diff:
create_lite_diff(newData,OldData,out_lite_diff,compressPlugin,...);
apply patch:
hpi_BOOL hpatch_lite_open(hpi_TInputStreamHandle diff_data,hpi_TInputStream_read read_diff,
hpi_compressType* out_compress_type,hpi_pos_t* out_newSize,hpi_pos_t* out_uncompressSize);
hpi_BOOL hpatch_lite_patch(hpatchi_listener_t* listener,hpi_pos_t newSize,
hpi_byte* temp_cache,hpi_size_t temp_cache_size);