jerasure library with packaging
 
 
 
 
 
Go to file
David Glessner e84360f811 Quiet configure warning.
(ARCH_64 doesn't appear to be used.)
2014-03-28 08:34:46 -07:00
Examples Fixed some compiler warnings. 2014-02-07 12:12:54 -05:00
include Do SIMD XOR, where possible! 2013-12-20 08:21:46 -08:00
m4 Quiet configure warning. 2014-03-28 08:34:46 -07:00
src add missing return value to functions that require it 2014-03-06 01:38:29 +01:00
AUTHORS Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
COPYING Make autoconf put BSD license in COPYING. 2014-01-07 08:40:05 -08:00
ChangeLog Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
INSTALL Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
License.txt Added new license header for version 2.0 2013-11-23 12:05:19 -08:00
Makefile.am Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
Makefile.in Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
Manual.pdf Added the user manual PDF to Manual.pdf 2014-01-29 16:39:29 -05:00
NEWS Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
PERF.txt Added performance numbers and more text to the README 2013-11-24 18:41:24 -08:00
README Added compilation instructions for when you don't have GF-Complete 2014-02-07 11:39:19 -05:00
README.nd Added compilation instructions for when you don't have GF-Complete 2014-02-07 11:39:19 -05:00
README.txt Added compilation instructions for when you don't have GF-Complete 2014-02-07 11:39:19 -05:00
aclocal.m4 Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
autogen.sh Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
config.guess Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
config.sub Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
configure Quiet configure warning. 2014-03-28 08:34:46 -07:00
configure.ac Make autoconf put BSD license in COPYING. 2014-01-07 08:40:05 -08:00
install-sh Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
ltmain.sh Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
makefile.orig Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00
missing Setup autoconf to work with Jerasure 2013-12-04 23:08:08 -08:00

README.txt

This is revision 2.0 of Jerasure.  This is pretty much Jerasure 1.2 without the
original Galois Field backend.  Version 2.0 links directly to GF-Complete, which 
is more flexible than the original, and *much* faster, because it leverages SIMD
instructions.
Authors: James S. Plank (University of Tennessee)
         Kevin M. Greenan (Box)

------------------------------------------------------------

External Documentation:

See the file Manual.pdf for the programmer's manual and tutorial.  This manual
is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.html.

See https://bitbucket.org/jimplank/gf-complete for GF-Complete.

NOTE: You must have GF-Complete installed (or compiled) in order to use Jerasure 2.0.

There are two directories of source code:

The src directory contains the jerasure code.
The Examples directory contains the example programs.  

------------------------------------------------------------

The makefile assumes that Examples is a subdirectory of the home directory.

Installing if you are allowed to install GF-Complete on your machine:

1.) Install GF-Complete
2.) ./configure
3.) make
4.) sudo make install 

This will install the library into your machine's lib directory,
the headers into include, and the example programs into bin.

------------------------------------------------------------

Installing if you can compile GF-Complete, but you cannot install it:

1.) Install GF-Complete.  Let's suppose the full path to GF-Complete is
    in the environment variable  GFP
2A.) On Linux, set the environment variable LD_LIBRARY_PATH so that it 
     includes $GFP/src/.libs
2B.) On a mac, set the environment variable DYLD_LIBRARY_PATH so that it
     includes $GFP/src/.libs
2.) ./configure LDFLAGS=-L$GFP/src/.libs/ CPPFLAGS=-I$GFP/include
3.) make

The examples will be in the directory Examples.  The include files will
be in the directory include, and the library will be called libJerasure.a
in the directory src/.libs.

------------------------------------------------------------

As long as GF-Complete is installed, Jerasure 2.0 can be used just as previous
versions.  There is no need to define custom Galois Fields.  Jerasure will 
determine the default field to use, if one is not specified.

If you would like to explore a using a different Galois Field implementation,
please see the manual.