Skip to content

Latest commit

 

History

History
103 lines (87 loc) · 4.42 KB

README.md

File metadata and controls

103 lines (87 loc) · 4.42 KB
Raw

VolumeBackup

Volume backup/restore library and cli tools for Windows and Linux

  • FULL BACKUP and FOREVER INCREMENT BACKUP support
  • *.img,*.vhd,*.vhdx copy format support
  • Volume copy mount support
  • Checkpoint support
  • Zero copy optimization
  • Qt GUI
  • Auto snapshot creation of LVM,BTRFS for Linux and VSS for Windows
  • Auto filesystem type detection
VolumeBackup  C++14  Windows  Linux  MSVC 2015+  GCC 4.9+ 

Require

  • CXX 11
  • MSVC2015+/GCC4.9+
  • Windows/Linux
  • OpenSSL 3.0+
  • libblkid-dev,uuid-dev,liblvm2-dev for Linux

Build

clone this repository and it's dependency recusively:

git clone [email protected]:XUranus/VolumeBackup.git --recursive

build library volumebackup and executable cli tools vbackup,vcopymount and vshow:

mkdir build && cd build
cmake .. && cmake --build .

build and run test coverage:

mkdir build && cd build
# use lcov
cmake .. -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE=lcov
# or use gcovr
# cmake .. -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE=gcovr -DGCOVR_ADDITIONAL_ARGS="--gcov-ignore-parse-errors"
cmake --build .
make volumebackup_coverage_test

build JNI volume copy mount extension library libvolumemount_jni.so:

cmake .. -DJNI_INCLUDE=your_jni_headers_directory_path && cmake --build .

Cli Tools Usage

vtool, vbackup and vcopymount is provided as cli tools to backup/restore a volume

  1. Use vshow to list and query volume info
> vshow --list
Name: \\?\Volume{a501f5cc-311e-423c-bc58-94a6c1b6b509}\
Path: \\.\HarddiskVolume3
C:\

Name: \\?\Volume{aeaadea6-033d-44c7-a6eb-5a5c275e5e5b}\
Path: \\.\HarddiskVolume4

Name: \\?\Volume{52ef083b-6ba4-4683-a73a-23a7290139b0}\
Path: \\.\HarddiskVolume1

> vshow --volume=\\.\HarddiskVolume3
VolumeName:             Windows
VolumeSize:             254792433664
VolumeSerialNumber:     3430564453
MaximumComponentLength: 255
FileSystemName:         NTFS
FileSystemFlags:        65482495

this is what a Windows environment will output, for Linux system, volume path should be like /dev/xxxx

  1. Use vbackup to backup volume.

Specify a volume path and output data/meta directory to store copy and it's meta info (can be same directory), a customed copy name is also required:

vbackup --volume=\\.\HarddiskVolume3 --data=D:\volumecopy\data --meta=D:\volumecopy\meta --name=diskC

If you have backuped a copy fully, you can specify the meta directory of last full copy to perform forever increment backup using path of previous full copy data (previous full backup copy data will be covered this time):

vbackup --volume=\\.\HarddiskVolume3 --data=D:\volumecopy\data --meta=D:\volumecopy\meta2 --name=diskC --prevmeta=D:\volumecopy\meta

For the sake of data consistency, a umounted volume or a snapshot volume is recommend to be used for backup. On Windows, you can use VSS(Volume Shadow Service) to create a shadow copy, the volume path would be in the form of \\.\HarddiskVolumeShadowCopyX, while on Linux, you and use LVM(Logical Volume Management) to create volume snapshot, the path to backup may be look like \dev\mapper\snap-xxxxx-xxxxx-xxxxx-xxxxx.

  1. Use vcopymount to mount a volume copy
vcopymount --mount --name=diskC --data=D:\volumecopy\data --meta=D:\volumecopy\meta --output=D:\cache --target=G:\

--ouput specified the directory to store the mount record file which is required for performing umount operation:

vcopymount --umount=D:\cache\diskC.mount.record.json