Blame view

README 3.1 KB
00a17c0a   KMG   Setup autoconf to...
1
This is revision 2.0 of Jerasure.  This is pretty much Jerasure 1.2 without the
e79904ea   David Glessner   This is the squas...
2
original Galois Field backend.  Version 2.0 links directly to GF-Complete, which
9124ad13   Jim Plank   Ran through all o...
3
4
is more flexible than the original, and *much* faster, because it leverages SIMD
instructions.
39ff8b9b   Jim Plank   More formatting.
5
6
7
Authors: James S. Plank (University of Tennessee)
         Kevin M. Greenan (Box)

8a85c829   Jim Plank   Added compilation...
8
9
------------------------------------------------------------

215c2a3b   Loic Dachary   jerasure.org is h...
10
11
12
13
14
15
External Documentation:

See the file Manual.pdf for the programmer's manual and tutorial.

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

00a17c0a   KMG   Setup autoconf to...
16
17
NOTE: You must have GF-Complete installed (or compiled) in order to use Jerasure 2.0.

99ae37b8   Loic Dachary   documentation: up...
18
There are two directories of source code:
00a17c0a   KMG   Setup autoconf to...
19

215c2a3b   Loic Dachary   jerasure.org is h...
20
The src directory contains the jerasure code.
00a17c0a   KMG   Setup autoconf to...
21
The Examples directory contains the example programs.
8a85c829   Jim Plank   Added compilation...
22

00a17c0a   KMG   Setup autoconf to...
23
------------------------------------------------------------
9124ad13   Jim Plank   Ran through all o...
24

00a17c0a   KMG   Setup autoconf to...
25
If you do not have Autoconf 2.65 or later installed, you can simply build
17333662   KMG   Fix README(s)
26
from the tarball distribution:
e79904ea   David Glessner   This is the squas...
27

00a17c0a   KMG   Setup autoconf to...
28
http://www.kaymgee.com/Kevin_Greenan/Software_files/jerasure.tar.gz
8a85c829   Jim Plank   Added compilation...
29
30

Installing if you are allowed to install GF-Complete on your machine:
ff4db573   David Glessner   Fix typo about Au...
31
(You can skip the autoreconf step if you're using a tarball distribution.)
e79904ea   David Glessner   This is the squas...
32
33
34

1.) Install GF-Complete
2.) autoreconf --force --install (*skip* if you are building from tarball)
00a17c0a   KMG   Setup autoconf to...
35
3.) ./configure
8a85c829   Jim Plank   Added compilation...
36
4.) make
e79904ea   David Glessner   This is the squas...
37
5.) sudo make install
00a17c0a   KMG   Setup autoconf to...
38
39

This will install the library into your machine's lib directory,
e79904ea   David Glessner   This is the squas...
40
41
42
43
the headers into include, and the example programs into bin.

The configuration process assumes shared objects are searched for in
/usr/local/lib. If this is not the case on your system, you can specify a
00a17c0a   KMG   Setup autoconf to...
44
search path at configuration time. For example:
8a85c829   Jim Plank   Added compilation...
45
46
47
  ./configure LD_LIBRARY_PATH=/usr/local/lib

------------------------------------------------------------
e79904ea   David Glessner   This is the squas...
48
49
50
51
52

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
8a85c829   Jim Plank   Added compilation...
53
54
55
56
57
58
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
e79904ea   David Glessner   This is the squas...
59

8a85c829   Jim Plank   Added compilation...
60
61
62
63
64
65
66
67
68
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.
00a17c0a   KMG   Setup autoconf to...
69

8a85c829   Jim Plank   Added compilation...
70
If you would like to explore a using a different Galois Field implementation,
00a17c0a   KMG   Setup autoconf to...
71
72
please see the manual.

e79904ea   David Glessner   This is the squas...
73
------------------------------------------------------------
00a17c0a   KMG   Setup autoconf to...
74
75
76

Testing GF-Complete

1f729312   Jim Plank   Formatting.
77
If the GF-Complete tools are installed in /usr/local/bin
4c82912f   Loic Dachary   allow override of...
78
79
80
81
82
83
84

  make check

If the GF-Complete tools are installed elsewhere

  make GF_COMPLETE_DIR=$(pwd)/../gf-complete/tools check

81f4bdd6   Loic Dachary   run tests with ma...
85
To run some tests with valgrind
4c82912f   Loic Dachary   allow override of...
86
87
88

  make VALGRIND='valgrind --tool=memcheck --quiet' \
       GF_COMPLETE_DIR=$(pwd)/../gf-complete/tools \
81f4bdd6   Loic Dachary   run tests with ma...
89
       check