README 2.2 KB

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