adjust to change in number of arguments of DeclRefExpr::Create
[pet.git] / README
blob4de796c0ab60cfef432629d6fbc71ba7f9b61e5f
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 - LLVM/clang libraries, 2.9 or higher (http://clang.llvm.org/get_started.html)
8         Unless you have some other reasons for wanting to use the svn version,
9         it's best to install the latest release (3.0).
10         The svn version occasionally introduces incompatibilities.
11         Nevertheless, if you encounter any such incompatibilities, please
12         report them so that they can be fixed.
13         Also, if you are following the instructions on how to build
14         the svn version, make sure you also install LLVM
15         (through "make install").  You may want to specify an installation
16         directory using the --prefix configure option.
18 Preparing:
20 Grab the latest release and extract it or get the source from
21 the git repository as follows.  This process requires autoconf,
22 automake and libtool.
24         git clone git://repo.or.cz/pet.git
25         cd pet
26         git submodule init
27         git submodule update
28         ./autogen.sh
30 Compilation:
32         ./configure
33         make
34         make check
36 Use:
38 The main entry point is pet_scop_extract_from_C_source.
39 This function extracts a scop from the C source file with the given name
40 and returns it as a pet_scop.  The scop corresponds to the piece
41 of code delimited by
43     #pragma scop
45 and
47     #pragma endscop
49 The code in between needs to consist only of expression statements,
50 if statements and for statements.  All access relations, loop initializations
51 and conditions need to be piecewise quasi-affine.
53 If the autodetect option has been set, pet will try to automatically
54 detect a scop and no pragmas are required.  On the other hand, pet
55 will not produce any warnings in this case as any code that does not
56 satisfy the requirements is considered to lie outside of the scop.
58 The layout of pet_scop is documented in include/pet.h.