2015-03-24 Paolo Carlini <paolo.carlini@oracle.com>
[official-gcc.git] / libcilkrts / README
blob7c101150ece98a3657a89d1c231ddb302ba360a7
1 Intel(R) Cilk(TM) Plus runtime library
3 Index:
4 1. BUILDING
5 2. USING
6 3. DOXYGEN DOCUMENTATION
7 4. QUESTIONS OR BUGS
8 5. CONTRIBUTIONS
11 #  1. BUILDING:
14 To distribute applications that use the Intel Cilk Plus language
15 extensions to non-development systems, you need to build the Intel
16 Cilk Plus runtime library and distribute it with your application.
18 To build the libcilkrts.so runtime library component, you need the
19 autoconf and automake packages, which are available through your
20 favorite package manager.  You also need a C/C++ compiler that
21 supports the Intel Cilk Plus language extensions, since the runtime
22 uses Intel Cilk Plus features internally.  Use either the Intel(R)
23 C++ Compiler (icc command) v12.1 or later, or in GCC 4.9 or later
24 (gcc command).
26 Once you have the necessary prerequisites installed, you can use the
27 following commands to create the library:
29 % libtoolize
30 % aclocal
31 % automake --add-missing
32 % autoconf
33 % ./configure
34 % make
35 % make install
37 This will produce the libcilkrts.so shared object.  To install the
38 library in a custom location, set the prefix while running the
39 configure script:
41 % ./configure --prefix=/your/path/to/lib
44 #  2. USING:
47 The Intel(R) C++ Compiler will automatically try to bring in the
48 Intel Cilk Plus runtime in any program that uses the relevant
49 features.  GCC requires explicit linking of both the library and
50 its dependencies (libpthread, libdl).  For example:
52 % gcc foo.c -lcilkrts -lpthread -ldl
55 #  3. DOXYGEN DOCUMENTATION:
58 The library source has Doxygen markup.  Generate HTML documentation
59 based on the markup by changing directory into runtime and running:
61 % doxygen doxygen.cfg
64 #  4. QUESTIONS OR BUGS:
67 Issues with the Intel Cilk Plus runtime can be addressed in the Intel
68 Cilk Plus forums:
69 http://software.intel.com/en-us/forums/intel-cilk-plus/
72 #  5. CONTRIBUTIONS:
75 The Intel Cilk Plus runtime library is dual licensed. The upstream copy
76 of the library is maintained via the BSD-licensed version available at:
77 http://cilkplus.org/
79 Changes to the Intel Cilk Plus runtime are welcome and should be
80 contributed to the upstream version via http://cilkplus.org/.
82 ------------------------
83 Intel and Cilk are trademarks of Intel Corporation in the U.S. and/or
84 other countries.