# HPatchLite **Repository Path**: mirrors_sisong/HPatchLite ## Basic Information - **Project Name**: HPatchLite - **Description**: Lite version of HDiffPatch, tiny code & ram requires when patch on embedded systems,MCU,NB-IoT,... - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 5 - **Forks**: 7 - **Created**: 2022-04-16 - **Last Updated**: 2026-04-13 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # [HPatchLite](https://github.com/sisong/HPatchLite) [![release](https://img.shields.io/badge/release-v1.0.1-blue.svg)](https://github.com/sisong/HPatchLite/releases) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/sisong/HPatchLite/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/sisong/HPatchLite/pulls) [![+issue Welcome](https://img.shields.io/github/issues-raw/sisong/HPatchLite?color=green&label=%2Bissue%20welcome)](https://github.com/sisong/HPatchLite/issues) [![Build Status](https://github.com/sisong/HPatchLite/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/sisong/HPatchLite/actions?query=branch%3Amain) 中文版 | [english](README.md) HPatchLite 是 [HDiffPatch](https://github.com/sisong/HDiffPatch) 的一个精简(Lite)版，为在超小型嵌入式设备(MCU、NB-IoT等)上执行打补丁(patch)功能而优化。 HPatchLite 也支持一种简单的原地更新(inplace-patch)实现，用以支持存储受限的设备。编译后的patch代码(ROM或flash占用)非常的小，用 Mbed Studio 编译后为 662 字节。提示：*设置宏_IS_RUN_MEM_SAFE_CHECK=0，非安全模式可以节省48字节; 如果使用了 [tinyuz](https://github.com/sisong/tinyuz) 并且设置宏_IS_USED_SHARE_hpatch_lite_types=1，可以节省52字节。* 同时，patch时内存(RAM 占用)也可以非常的小，大小为一个解压缩流需要的内存大小 + patch时输入的缓存区大小(>=3字节)。提示：*输入缓存区较小时只影响patch速度。* --- ## 二进制发布包 [从 release 下载](https://github.com/sisong/HPatchLite/releases) : 分别运行在 Windows、Linux、MacOS操作系统的命令行程序。 ## 自己编译 ### Linux or MacOS X ### ``` $ cd $ git clone --recursive https://github.com/sisong/HPatchLite.git $ cd HPatchLite $ make ``` ### Windows ### ``` $ cd $ git clone --recursive https://github.com/sisong/HPatchLite.git ``` 用 [`Visual Studio`](https://visualstudio.microsoft.com) 打开 `HPatchLite/builds/vc/HPatchLite.sln` 编译 --- ## **diff** 命令行使用: ``` 创建补丁: hdiffi [options] oldFile newFile outDiffFile 测试补丁: hdiffi -t oldFile newFile testDiffFile oldFile可以为空, 输入参数为 "" 选项: -m[-matchScore] 所有文件数据都会被加载到内存; 需要的内存大小:(新版本文件大小+ 旧版本文件大小*5(或*9 当旧版本文件大小>=2GB时))+O(1); 匹配分数matchScore>=0,默认为6,一般输入数据的可压缩性越大,这个值就可以越大。 -inplace[-extraSafeSize] 打开创建原地更新补丁包模式, 默认关闭; extraSafeSize: 原地更新的额外安全访问距离; extraSafeSize>=0, 默认 0; 如果 extraSafeSize>0, patch时需要使用额外的空间来缓存新版本的数据，从而增加了diff时匹配旧版本数据的几率，但同时也增加了patch时的 extraSafeSize 大小的内存使用量，并增加了patch代码的复杂度。 -cache 给较慢的匹配开启一个大型缓冲区,来加快匹配速度(不影响补丁大小), 默认不开启; 如果新版本和旧版本不相同数据比较多,那diff速度就会比较快; 该大型缓冲区最大占用O(旧版本文件大小)的内存, 并且需要较多的时间来创建(从而可能降低diff速度)。 -p-parallelThreadNumber 设置线程数 parallelThreadNumber>1 时,开启多线程并行模式; 默认为-p-4;需要占用较多的内存。 -c-compressType[-compressLevel] 设置补丁数据使用的压缩算法和压缩级别等, 默认不压缩; 支持的压缩算法、压缩级别和字典大小等: -c-tuz[-dictSize] (或者 -c-tinyuz) -c-tuzi[-dictSize] (或者 -c-tinyuzi) 压缩字典大小dictSize范围1字节到1GB,可以设置为250,511,1k,4k,64k,1m,64m等,默认为32k；注意: -c-tuz 是默认的压缩器; 但如果你自己编译 tinyuz 的解压缩代码的时候，设置了 tuz_isNeedLiteralLine=0 编译参数, 这时你必须使用 -c-tuzi 压缩器。 -c-zlib[-{1..9}[-dictBits]] 默认级别 9 压缩字典比特数dictBits可以为9到15, 默认为15。 -c-pzlib[-{1..9}[-dictBits]] 默认级别 6 压缩字典比特数dictBits可以为9到15, 默认为15。支持多线程并行压缩,很快！ -c-lzma[-{0..9}[-dictSize]] 默认级别 7 压缩字典大小dictSize可以设置为 4096, 4k, 4m, 128m等, 默认为32k 支持2个线程并行压缩。 -c-lzma2[-{0..9}[-dictSize]] 默认级别 7 压缩字典大小dictSize可以设置为 4096, 4k, 4m, 128m等, 默认为32k 支持多线程并行压缩,很快。警告: lzma和lzma2是不同的压缩编码格式。 -d 只执行diff, 不要执行patch检查, 默认会执行patch检查. -t 只执行patch检查, 检查是否 patch(oldFile,testDiffFile)==newFile ? -f 强制文件写覆盖, 忽略输出的路径是否已经存在; 默认不执行覆盖, 如果输出路径已经存在, 直接返回错误; 如果设置了-f,但路径已经存在并且是一个文件夹, 那么会始终返回错误。 --patch 切换到 hpatchi 模式; 可以支持hpatchi命令行的相关参数和功能。 -v 输出程序版本信息。 -h 或 -? 输出命令行帮助信息 (该说明)。 ``` ## **patch** 命令行使用: ``` 打补丁 : hpatchi [options] oldFile diffFile outNewFile 原地更新: hpatchi [options] oldFile diffFile -INPLACE 如果oldFile为空, 输入参数为 "" 选项: -s[-cacheSize] 默认设置为-s-32k; 缓冲区cacheSize>=3; 可以设置为256,1k,60k,1m等打补丁需要的总内存大小: (cacheSize + 1*解压缩缓冲区 [+ extraSafeSize 用于原地更新])+O(1) -INPLACE 打开原地更新模式, 默认关闭; 警告: 原地更新成功后，旧文件oldFile 会被直接修改为新文件；而如果原地更新失败，旧文件可能会被损坏且无法恢复。 -f 强制文件写覆盖, 忽略输出的路径是否已经存在; 默认不执行覆盖, 如果输出路径已经存在, 直接返回错误; 如果设置了-f,但路径已经存在并且是一个文件夹, 那么会始终返回错误。 -v 输出程序版本信息。 -h 或 -? 输出命令行帮助信息 (该说明)。 ``` --- ## 库 API 使用: 创建 hpatch_lite 补丁: ``` create_lite_diff(newData,OldData,out_lite_diff,compressPlugin,...); ``` 应用补丁: ``` 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); ``` 创建原地更新补丁: ``` create_inplaceB_lite_diff(newData,OldData,out_lite_diff,extraSafeSize,compressPlugin,...); ``` 应用原地更新补丁: ``` hpi_BOOL hpatchi_inplace_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_size_t* out_extraSafeSize); hpi_BOOL hpatchi_inplaceB(hpatchi_listener_t* listener,hpi_pos_t newSize, hpi_byte* temp_cache,hpi_size_t extraSafeSize_in_temp_cache,hpi_size_t temp_cache_size); ``` --- ## 移植补丁算法到嵌入式设备: * 将 `HDiffPatch/libHDiffPatch/HPatchLite/` 整个目录添加或拷贝到你的项目工程中； * 在需要使用补丁算法的地方添加 `hpatch_lite.h` 头文件的引用，并调用该文件中声明的补丁函数。 * 代码要点： 1. 使用 `hpatch_lite_open` 函数打开补丁数据，diff_data 为指向补丁数据的句柄，read_diff 为通过该句柄顺序读取补丁数据的函数。 1. 打开补丁后，可以获得补丁使用的压缩算法类型 compress_type 和能够解压出的数据量 uncompressSize；如果有压缩，那么通过对应的解压缩算法对 diff_data 和 read_diff 进行包装，得到新的可读取未压缩数据的 diff_data 和 read_diff； 1. 填充一个 hpatchi_listener_t 结构，用以调用 `hpatch_lite_patch` ；其中 read_old 用于随机读取老版本的数据，write_new 用于顺序写入新版本的 newSize 大小的数据。 1. 如果使用原地更新，那么将 `hpatch_lite_open` 替换成 `hpatchi_inplace_open`，将 `hpatch_lite_patch` 替换成 `hpatchi_inplaceB`；给 temp_cache 申请内存时，需要额外多申请 **extraSafeSize**。 (最佳实践：如果你需要每次写入对齐的整页数据，那可以在编译时设置_IS_WTITE_NEW_BY_PAGE=1，从而可以调用`hpatchi_inplaceB_by_page`。) --- ## 联系 housisong@hotmail.com