Erasure Code API library written in C with pluggable Erasure Code backends.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tim Burke 909d199ae9 Update .gitreview following project rename 5 days ago
doc re-org of README 2 years ago
include 1.6.1 release 3 weeks ago
playbooks/unittests Install Jerasure and ISA-L libs 7 months ago
roles Install yasm in RHEL based systems 2 months ago
src Merge "Remove get_chksum to hush warnings" 4 months ago
test Allow reading of little-endian frags on big-endian 9 months ago
.gitignore Remove remaining m4/ references 4 years ago
.gitreview Update .gitreview following project rename 5 days ago
.mailmap Release 1.6.0 8 months ago
.zuul.yaml Install yasm in RHEL based systems 2 months ago
AUTHORS Release 1.6.0 8 months ago
COPYING Add doxygen config. Update README, copyrights. 4 years ago
ChangeLog 1.6.1 release 3 weeks ago
Makefile.am Fix building with LD_LIBRARY_PATH set 8 months ago
NEWS Add NEWS and README back 3 years ago
README Add NEWS and README back 3 years ago
README.md re-org of README 2 years ago
Xorcode.pc.in autoconf: Add Xorcode pkgconfig, other minor fixes 5 years ago
autogen.sh Add -f argument to autoreconf to regenerate aclocal macros 4 years ago
bindep.txt Use zlib for CRC-32 1 year ago
configure.ac Merge "Stop using ceill() to compute padded data size" 2 years ago
erasurecode.pc.in Add dl to pkg-config metadata 1 year ago
erasurecode_rs_vand.pc.in Add pkg-config template for liberasurecode_rs_vand 4 years ago
get_flags_from_cpuid.c Fix get_supported_flags() arguments 4 years ago

README.md

liberasurecode

liberasurecode is an Erasure Code API library written in C with pluggable Erasure Code backends.


Highlights

  • Unified Erasure Coding interface for common storage workloads.

  • Pluggable Erasure Code backends - liberasurecode supports the following backends:

    • ‘liberasurecode_rs_vand’ - Native, software-only Erasure Coding implementation that supports a Reed-Solomon backend
    • ‘Jerasure’ - Erasure Coding library that supports Reed-Solomon, Cauchy backends [1]
    • ‘ISA-L’ - Intel Storage Acceleration Library - SIMD accelerated Erasure Coding backends [2]
    • ‘SHSS’ - NTT Lab Japan’s hybrid Erasure Coding backend [4]
    • ‘Flat XOR HD’ - built-in to liberasurecode, based on [3]
    • ‘libphazr’ - Phazr.IO’s erasure code backend with built-in privacy [5]
    • ‘NULL’ template backend implemented to help future backend writers
  • True ‘plugin’ architecture - liberasurecode uses Dynamically Loaded (DL) libraries to realize a true ‘plugin’ architecture. This also allows one to build liberasurecode indepdendent of the Erasure Code backend libraries.

  • Cross-platform - liberasurecode is known to work on Linux (Fedora/Debian flavors), Solaris, BSD and Darwin/Mac OS X.

  • Community support - Developed alongside Erasure Code authority Kevin Greenan, liberasurecode is an actively maintained open-source project with growing community involvement (Openstack Swift, Ceph, PyECLib, NTT Labs).


Active Users


Build and Install

Install dependencies -

Debian/Ubuntu hosts:

 $ sudo apt-get install build-essential autoconf automake libtool

Fedora/RedHat/CentOS hosts:

 $ sudo yum install -y gcc make autoconf automake libtool

To build the liberasurecode repository, perform the following from the top-level directory:

 $ ./autogen.sh
 $ ./configure
 $ make
 $ make test
 $ sudo make install

References

[1] Jerasure, C library that supports erasure coding in storage applications, http://jerasure.org

[2] Intel® Storage Acceleration Library (Open Source Version), https://01.org/intel%C2%AE-storage-acceleration-library-open-source-version

[3] Greenan, Kevin M et al, “Flat XOR-based erasure codes in storage systems”, http://www.kaymgee.com/Kevin_Greenan/Publications_files/greenan-msst10.pdf

[4] Kota Tsuyuzaki tsuyuzaki.kota@lab.ntt.co.jp, “NTT SHSS Erasure Coding backend”

[5] Jim Cheung support@phazr.io, “Phazr.IO libphazr erasure code backend with built-in privacy”