IDA_new/jerasure/README

   1 This is revision 2.0 of Jerasure.  This is pretty much Jerasure 1.2 without the
   2 original Galois Field backend.  Version 2.0 links directly to GF-Complete, which
   3 is more flexible than the original, and *much* faster, because it leverages SIMD
   4 instructions.
   5 Authors: James S. Plank (University of Tennessee)
   6          Kevin M. Greenan (Box)
   7
   8 ------------------------------------------------------------
   9
  10 The online home for jerasure is:
  11
  12   - http://jerasure.org/jerasure/jerasure
  13
  14 ------------------------------------------------------------
  15
  16 External Documentation:
  17
  18 See the file Manual.pdf for the programmer's manual and tutorial.
  19
  20 See http://jerasure.org/jerasure/gf-complete for GF-Complete.
  21
  22 NOTE: You must have GF-Complete installed (or compiled) in order to use Jerasure 2.0.
  23
  24 There are two directories of source code:
  25
  26 The src directory contains the jerasure code.
  27 The Examples directory contains the example programs.
  28
  29 ------------------------------------------------------------
  30
  31 If you do not have Autoconf 2.65 or later installed, you can simply build
  32 from the tarball distribution:
  33
  34 http://www.kaymgee.com/Kevin_Greenan/Software_files/jerasure.tar.gz
  35
  36 Installing if you are allowed to install GF-Complete on your machine:
  37 (You can skip the autoreconf step if you're using a tarball distribution.)
  38
  39 1.) Install GF-Complete
  40 2.) autoreconf --force --install (*skip* if you are building from tarball)
  41 3.) ./configure
  42 4.) make
  43 5.) sudo make install
  44
  45 This will install the library into your machine's lib directory,
  46 the headers into include, and the example programs into bin.
  47
  48 The configuration process assumes shared objects are searched for in
  49 /usr/local/lib. If this is not the case on your system, you can specify a
  50 search path at configuration time. For example:
  51   ./configure LD_LIBRARY_PATH=/usr/local/lib
  52
  53 ------------------------------------------------------------
  54
  55 Installing if you can compile GF-Complete, but you cannot install it:
  56
  57 1.) Install GF-Complete.  Let's suppose the full path to GF-Complete is
  58     in the environment variable  GFP
  59 2A.) On Linux, set the environment variable LD_LIBRARY_PATH so that it
  60      includes $GFP/src/.libs
  61 2B.) On a mac, set the environment variable DYLD_LIBRARY_PATH so that it
  62      includes $GFP/src/.libs
  63 2.) ./configure LDFLAGS=-L$GFP/src/.libs/ CPPFLAGS=-I$GFP/include
  64 3.) make
  65
  66 The examples will be in the directory Examples.  The include files will
  67 be in the directory include, and the library will be called libJerasure.a
  68 in the directory src/.libs.
  69
  70 ------------------------------------------------------------
  71
  72 As long as GF-Complete is installed, Jerasure 2.0 can be used just as previous
  73 versions.  There is no need to define custom Galois Fields.  Jerasure will
  74 determine the default field to use, if one is not specified.
  75
  76 If you would like to explore a using a different Galois Field implementation,
  77 please see the manual.
  78
  79 ------------------------------------------------------------
  80
  81 Testing GF-Complete
  82
  83 If the GF-Complete tools are installed in /usr/local/bin
  84
  85   make check
  86
  87 If the GF-Complete tools are installed elsewhere
  88
  89   make GF_COMPLETE_DIR=$(pwd)/../gf-complete/tools check
  90
  91 To run some tests with valgrind
  92
  93   make VALGRIND='valgrind --tool=memcheck --quiet' \
  94        GF_COMPLETE_DIR=$(pwd)/../gf-complete/tools \
  95        check