libcilkrts/README

   1 Intel(R) Cilk(TM) Plus runtime library
   2
   3 Index:
   4 1. BUILDING
   5 2. USING
   6 3. DOXYGEN DOCUMENTATION
   7 4. QUESTIONS OR BUGS
   8 5. CONTRIBUTIONS
   9
  10 #
  11 #  1. BUILDING:
  12 #
  13
  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.
  17
  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).
  25
  26 Once you have the necessary prerequisites installed, you can use the
  27 following commands to create the library:
  28
  29 % libtoolize
  30 % aclocal
  31 % automake --add-missing
  32 % autoconf
  33 % ./configure
  34 % make
  35 % make install
  36
  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:
  40
  41 % ./configure --prefix=/your/path/to/lib
  42
  43 It is also possible to use CMake if the above method does not apply
  44 well in your environment. Instruction is available in CMakeLists.txt.
  45
  46 #
  47 #  2. USING:
  48 #
  49
  50 The Intel(R) C++ Compiler will automatically try to bring in the
  51 Intel Cilk Plus runtime in any program that uses the relevant
  52 features.  GCC requires explicit linking of both the library and
  53 its dependencies (libpthread, libdl).  For example:
  54
  55 % gcc foo.c -lcilkrts -lpthread -ldl
  56
  57 #
  58 #  3. DOXYGEN DOCUMENTATION:
  59 #
  60
  61 The library source has Doxygen markup.  Generate HTML documentation
  62 based on the markup by changing directory into runtime and running:
  63
  64 % doxygen doxygen.cfg
  65
  66 #
  67 #  4. QUESTIONS OR BUGS:
  68 #
  69
  70 Issues with the Intel Cilk Plus runtime can be addressed in the Intel
  71 Cilk Plus forums:
  72 http://software.intel.com/en-us/forums/intel-cilk-plus/
  73
  74 #
  75 #  5. CONTRIBUTIONS:
  76 #
  77
  78 The Intel Cilk Plus runtime library is dual licensed. The upstream copy
  79 of the library is maintained via the BSD-licensed version available at:
  80 http://cilkplus.org/
  81
  82 Changes to the Intel Cilk Plus runtime are welcome and should be
  83 contributed to the upstream version via http://cilkplus.org/.
  84
  85 Thanks to Tobias Burnus for showing us the magic to make gcc and g++
  86 automatically include the Cilk Plus runtime.
  87
  88 ------------------------
  89 Intel and Cilk are trademarks of Intel Corporation in the U.S. and/or
  90 other countries.