Blame view

README 3.23 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
The online home for jerasure is:

  - http://jerasure.org/jerasure/jerasure

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

00a17c0a   KMG   Setup autoconf to...
16
17
External Documentation:

99ae37b8   Loic Dachary   documentation: up...
18
See the file Manual.pdf for the programmer's manual and tutorial.
00a17c0a   KMG   Setup autoconf to...
19

215c2a3b   Loic Dachary   jerasure.org is h...
20
See http://jerasure.org/jerasure/gf-complete for GF-Complete.
00a17c0a   KMG   Setup autoconf to...
21

8a85c829   Jim Plank   Added compilation...
22
NOTE: You must have GF-Complete installed (or compiled) in order to use Jerasure 2.0.
00a17c0a   KMG   Setup autoconf to...
23

9124ad13   Jim Plank   Ran through all o...
24
There are two directories of source code:
00a17c0a   KMG   Setup autoconf to...
25

17333662   KMG   Fix README(s)
26
The src directory contains the jerasure code.
e79904ea   David Glessner   This is the squas...
27
The Examples directory contains the example programs.
00a17c0a   KMG   Setup autoconf to...
28

8a85c829   Jim Plank   Added compilation...
29
30
------------------------------------------------------------

ff4db573   David Glessner   Fix typo about Au...
31
If you do not have Autoconf 2.65 or later installed, you can simply build
e79904ea   David Glessner   This is the squas...
32
33
34
from the tarball distribution:

http://www.kaymgee.com/Kevin_Greenan/Software_files/jerasure.tar.gz
00a17c0a   KMG   Setup autoconf to...
35

8a85c829   Jim Plank   Added compilation...
36
Installing if you are allowed to install GF-Complete on your machine:
e79904ea   David Glessner   This is the squas...
37
(You can skip the autoreconf step if you're using a tarball distribution.)
00a17c0a   KMG   Setup autoconf to...
38
39

1.) Install GF-Complete
e79904ea   David Glessner   This is the squas...
40
41
42
43
2.) autoreconf --force --install (*skip* if you are building from tarball)
3.) ./configure
4.) make
5.) sudo make install
00a17c0a   KMG   Setup autoconf to...
44

8a85c829   Jim Plank   Added compilation...
45
46
47
This will install the library into your machine's lib directory,
the headers into include, and the example programs into bin.

e79904ea   David Glessner   This is the squas...
48
49
50
51
52
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
search path at configuration time. For example:
  ./configure LD_LIBRARY_PATH=/usr/local/lib

8a85c829   Jim Plank   Added compilation...
53
54
55
56
57
58
------------------------------------------------------------

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
e79904ea   David Glessner   This is the squas...
59
2A.) On Linux, set the environment variable LD_LIBRARY_PATH so that it
8a85c829   Jim Plank   Added compilation...
60
61
62
63
64
65
66
67
68
     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.
00a17c0a   KMG   Setup autoconf to...
69

8a85c829   Jim Plank   Added compilation...
70
------------------------------------------------------------
00a17c0a   KMG   Setup autoconf to...
71
72

As long as GF-Complete is installed, Jerasure 2.0 can be used just as previous
e79904ea   David Glessner   This is the squas...
73
versions.  There is no need to define custom Galois Fields.  Jerasure will
00a17c0a   KMG   Setup autoconf to...
74
75
76
determine the default field to use, if one is not specified.

If you would like to explore a using a different Galois Field implementation,
1f729312   Jim Plank   Formatting.
77
please see the manual.
4c82912f   Loic Dachary   allow override of...
78
79
80
81
82
83
84

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

Testing GF-Complete

If the GF-Complete tools are installed in /usr/local/bin

81f4bdd6   Loic Dachary   run tests with ma...
85
  make check
4c82912f   Loic Dachary   allow override of...
86
87
88

If the GF-Complete tools are installed elsewhere

81f4bdd6   Loic Dachary   run tests with ma...
89
90
91
92
93
94
95
  make GF_COMPLETE_DIR=$(pwd)/../gf-complete/tools check

To run some tests with valgrind

  make VALGRIND='valgrind --tool=memcheck --quiet' \
       GF_COMPLETE_DIR=$(pwd)/../gf-complete/tools \
       check