ParityUtils

註：Demo script 位於 script/ 中，可以使用 ./script/demo-all.sh 來完成 requirement 1 到 4 的展示

A collection of command-line utilities for generating parity files to enable data recovery and integrity checks.

And ParityUtils also supports GUI (still under development)

Simple Use Case

Generate a Parity File for a bunch of files

# Generate a parity file
backup A.bin B.bin C.bin D.bin --verbose --output P.bin

# Remove A.bin
rm -f A.bin

# Restore A.bin file from a parity file
restore B.bin C.bin D.bin --verbose --output A.bin

More information

backup --help
restore --help

Project Structure

The project is structured as follows:

ParityUtils/
├── lib/                # Future directory for external libraries (currently not used)
├── bin/                # Pre-built binaries for x86_64 architecture on Linux
├── gnulib/             # Future directory for GNU libraries (currently not used)
├── script/             # Useful shell scripts for testing the features
├── README.md           # Project documentation
├── Makefile            # Build configuration file
└── src/                # Source files for the project
    ├── backup.c        # Source code for backup utility
    ├── backup_gui.c    # GTK-3.0 GUI support
    ├── common.c        # Common utility functions
    ├── metadata.c      # Metadata handling functions
    ├── parity.c        # Top level parity encoding/decoding functions
    ├── parity_core.c   # Core/low level parity functions
    ├── restore.c       # Source code for restore utility
    ├── system.h        # System definitions and headers
    ├── version.c       # Versioning information
    ├── version.h       # Version header
    ├── backup.h        # Header for backup utility
    ├── backup_gui.h    # Header for backup GUI utility
    ├── common.h        # Header for common functions
    ├── metadata.h      # Header for metadata functions
    ├── parity.h        # Header for parity functions
    ├── parity_core.h   # Header for core parity functions
    └── restore.h       # Header for restore utility

How to build

This project uses developer-predefined Makefile to build the project, but in the near future it will be migrated to GNU Autotools to help generating more precise Makefile and also import gnulib to follow the GNU style utilities.

Below example shows how to build the project on Ubuntu 22.04.

Dependencies

# Basic build tools
sudo apt install build-essential git make

# SHA256 library
sudo apt install libssl-dev

# For GTK GUI support, install the following packages (Optional)
sudo apt install libgtk-3-dev libcairo2-dev libadwaita-1-dev

Compile the project

Clone the project from the repository:

git clone https://github.com/jackiesogi/ParityUtils.git
cd ParityUtils

To compile the project, use the following commands:

• To compile the command-line version without GTK GUI:

make all

• To compile the command-line version with GTK GUI:

make gui

• To compile the command-line version with GTK GUI and debug symbols:

make install

• To clean up object files and executables in the src directory:

make clean

How to test if the parity file is correct

chmod +x ./script/*
./script/requirement-1.sh
./script/requirement-2.sh
./script/requirement-3.sh
./script/requirement-4.sh