README

   1 Requirements:
   2
   3 - pkg-config (http://www.freedesktop.org/wiki/Software/pkg-config)
   4         (not needed when compiling a release using the included isl)
   5 - gmp (http://gmplib.org/)
   6 - libyaml (http://pyyaml.org/wiki/LibYAML)
   7         (only needed if you want to compile the pet executable)
   8 - LLVM/clang libraries, 3.5 or higher (http://clang.llvm.org/get_started.html)
   9         Unless you have some other reasons for wanting to use the git version,
  10         it's best to install the latest release (16.0).
  11         The git version occasionally introduces incompatibilities.
  12         Nevertheless, if you encounter any such incompatibilities, please
  13         report them so that they can be fixed.
  14         However, development versions from before the latest release
  15         are not supported.
  16
  17         Also, if you are following the instructions on how to build
  18         from source, make sure you also install LLVM
  19         (through "make install").  You may want to specify an installation
  20         directory using the CMAKE_INSTALL_PREFIX cmake option.
  21         You may also want to set the LLVM_BUILD_LLVM_DYLIB option
  22         to enable the creation of a single shared library.
  23
  24         If you configure older versions of LLVM using cmake, you may end up
  25         with clang libraries that have been compiled with -fno-rtti without
  26         this option appearing in the output of "llvm-config --cxxflags".
  27         You may then run into errors about undefined reference to the
  28         'typeinfo' of some classes.
  29         You will then have to add this option manually to CXXFLAGS while
  30         configuring pet.
  31
  32         If you want to use the ubuntu package libclang-dev, then you need
  33         version 3.2 (ubuntu raring) or later.
  34         Older versions of this package did not include the required libraries.
  35         You may also need to install the llvm package for llvm-config.
  36
  37 Preparing:
  38
  39 Grab the latest release and extract it or get the source from
  40 the git repository as follows.  This process requires autoconf,
  41 automake, libtool and pkg-config.
  42
  43         git clone git://repo.or.cz/pet.git
  44         cd pet
  45         ./get_submodules.sh
  46         ./autogen.sh
  47
  48 Compilation:
  49
  50         ./configure
  51         make
  52         make check
  53
  54 Use:
  55
  56 The main entry points are pet_scop_extract_from_C_source and
  57 pet_transform_C_source.
  58 The first function extracts a scop from the C source file with the given name
  59 and returns it as a pet_scop.  The scop corresponds to the piece
  60 of code delimited by
  61
  62     #pragma scop
  63
  64 and
  65
  66     #pragma endscop
  67
  68 The code in between needs to consist only of expression statements,
  69 if statements and for statements.  All access relations and loop initializations
  70 need to be piecewise quasi-affine.  Conditions are allowed to be non-affine,
  71 in which case a separate statement is constructed to evaluate the condition.
  72
  73 The second function (pet_transform_C_source) iterates over all scops.
  74
  75 If the autodetect option has been set, pet will try to automatically
  76 detect a scop and no pragmas are required.  On the other hand, pet
  77 will not produce any warnings in this case as any code that does not
  78 satisfy the requirements is considered to lie outside of the scop.
  79
  80 The layout of pet_scop is documented in include/pet.h.
  81
  82 An example application is given by pet_loopback.c,
  83 which prints out code from the pet_scop without any transformation.
  84
  85
  86 New releases are announced on http://groups.google.com/group/isl-announce
  87
  88 If you use pet, you can let me know by stacking
  89 https://www.openhub.net/p/libpet on ohloh.
  90
  91 For bug reports, feature requests and questions,
  92 contact isl-development@googlegroups.com
  93
  94 If you use pet for your research, you are invited to cite
  95 the following paper.
  96
  97 @InProceedings{Verdoolaege2012pet,
  98     author = {Sven Verdoolaege and Tobias Grosser},
  99     title = {Polyhedral Extraction Tool},
 100     booktitle = {Second Int. Workshop on Polyhedral Compilation Techniques
 101                 (IMPACT'12)},
 102     address = {Paris, France},
 103     month = jan,
 104     year = {2012}
 105 }