pet_expr_access_set_access: set read/write on non-empty access relation
[pet.git] / README
blob5f76f478a852f68fe44ebc847d7220abaa7cbb96
1 Requirements:
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, 2.9 or higher (http://clang.llvm.org/get_started.html)
9         Unless you have some other reasons for wanting to use the svn version,
10         it's best to install the latest release (3.4).
11         The svn 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.
17         Also, if you are following the instructions on how to build
18         the svn version, make sure you also install LLVM
19         (through "make install").  You may want to specify an installation
20         directory using the --prefix configure option.
22         If you configure LLVM using cmake, you may end up with clang libraries
23         that have been compiled with -fno-rtti without this option appearing
24         in the output of "llvm-config --cxxflags".  You may then run into
25         errors about undefined reference to the 'typeinfo' of some classes.
26         You will then have to add this option manually to CXXFLAGS while
27         configuring pet.
29         If you want to use the ubuntu package libclang-dev, then you need
30         version 3.2 (ubuntu raring) or later.
31         Older versions of this package did not include the required libraries.
33 Preparing:
35 Grab the latest release and extract it or get the source from
36 the git repository as follows.  This process requires autoconf,
37 automake and libtool.
39         git clone git://repo.or.cz/pet.git
40         cd pet
41         git submodule init
42         git submodule update
43         ./autogen.sh
45 Compilation:
47         ./configure
48         make
49         make check
51 Use:
53 The main entry point is pet_scop_extract_from_C_source.
54 This function extracts a scop from the C source file with the given name
55 and returns it as a pet_scop.  The scop corresponds to the piece
56 of code delimited by
58     #pragma scop
60 and
62     #pragma endscop
64 The code in between needs to consist only of expression statements,
65 if statements and for statements.  All access relations and loop initializations
66 need to be piecewise quasi-affine.  Conditions are allowed to be non-affine,
67 in which case a separate statement is constructed to evaluate the condition.
69 If the autodetect option has been set, pet will try to automatically
70 detect a scop and no pragmas are required.  On the other hand, pet
71 will not produce any warnings in this case as any code that does not
72 satisfy the requirements is considered to lie outside of the scop.
74 The layout of pet_scop is documented in include/pet.h.
77 New releases are announced on http://freecode.com/projects/libpet
79 If you use pet, you can let me know by stacking
80 https://www.ohloh.net/p/libpet on ohloh.
82 For bug reports, feature requests and questions,
83 contact isl-development@googlegroups.com
85 If you use pet for your research, you are invited to cite
86 the following paper.
88 @InProceedings{Verdoolaege2012pet,
89     author = {Sven Verdoolaege and Tobias Grosser},
90     title = {Polyhedral Extraction Tool},
91     booktitle = {Second Int. Workshop on Polyhedral Compilation Techniques
92                 (IMPACT'12)},
93     address = {Paris, France},
94     month = jan,
95     year = {2012}