Cilk Plus Installation Guide

From SuperTech Wiki

Intel provides a suite of tools for programming Cilk-based programs. The tool set contains the Intel compiler ICC, the parallelism checker Cilkview, the race condition reporter Cilkscreen, the binary-level instrumentation gadget Pintool, the fine-level instrumentation tool Cilkprof. Here is a guide to install them on a 64-bit Linux.

• Online Resources

1. Open Source Cilk Plus Website: http://www.cilkplus.org/

• Installation

1. Install ICC or GCC: You need a license from Intel® in order to install ICC. A free, open-source version is available in the cilkplus branch of GCC.
   • Installing ICC: These instructions assume your shell is bash.
   1. Go to http://software.intel.com/en-us/articles/intel-software-evaluation-center/.
   2. Select the Linux version of "Intel® C++ Composer XE" (or any Linux product suite listed as containing "Intel® C++ Composer XE") and download the 64-bit version.
   3. Unpack the downloaded file and run the installation script.

      $ /path/to/unpacked/file/install.sh.

      Note: To allow all users to access ICC on the system, run this install script as root.

   4. Follow the on-screen instructions to install ICC.
   5. Set up your environment variables to use ICC.

      $ source /path/to/intel/bin/compilervars.sh intel64.

   • Installing GCC: These instructions walk you through checking out and building the cilkplus branch of GCC. Complete instructions for building GCC from source can be found at http://gcc.gnu.org/install/index.html. These instructions will install GCC into a custom directory, gcc-cilk, so as not to overwrite the existing version of GCC on your system.

   Warning: This process takes a while and uses a couple gigabytes of space.

   1. Check out the latest version of the cilkplus branch of GCC.

      $ svn checkout svn://gcc.gnu.org/svn/gcc/branches/cilkplus gcc-cilk-src

      Note: I encountered problems with my connection timing out when I tried to check out the repository from http://gcc.gnu.org/svn/gcc/branches/cilkplus instead of svn://gcc.gnu.org/svn/gcc/branches/cilkplus. If you encounter similar problems, make sure you are using the "svn" protocol, instead of the "http" protocol. If you have previously checked out the gcc cilkplus source using "http," you can switch your checkout to use "svn" by running the following in the directory containing your checkout.

      $ svn switch --relocate http://gcc.gnu.org/svn/gcc/branches/cilkplus svn://gcc.gnu.org/svn/gcc/branches/cilkplus

   2. Alternatively, you may check out the repository using git:

      $ git clone git://gcc.gnu.org/git/gcc.git gcc-cilk-src

      $ cd gcc-cilk-src

      $ git checkout -b my_cilkplus_branch origin/cilkplus

      $ cd ..

   3. Create two new directories, gcc-cilk-obj and gcc-cilk, in the directory containing gcc-cilk-src.

      $ mkdir gcc-cilk-obj gcc-cilk

   4. Install gmp, mpfr, and mpc on your system. Make sure you have also installed bison, flex, and isl. In general, check http://gcc.gnu.org/install/prerequisites.html for the list of necessary prerequisites.
   5. Configure GCC as follows:

      $ cd gcc-cilk-obj

      $ ../gcc-cilk-src/configure --prefix=../gcc-cilk --enable-languages=c,c++

      Note:: You may want to add --disable-multilib to the configuration options if multilib is not installed on your system. Otherwise, you may encounter errors such as:

      gnu/stubs-32.h: No such file or directory compilation terminated.

   6. Compile GCC:

      $ make

   7. Install GCC into gcc-cilk:

      $ make install

   8. The new GCC binary is /path/to/gcc-cilk/bin/gcc.
   9. Set up environment!

      $ export PATH=path/to/gcc-cilk/bin:$PATH

      $ export LD_LIBRARY_PATH=path/to/gcc-cilk/lib

      $ export LIBRARY_PATH=path/to/gcc-cilk/lib

2. Install Cilkview Cilkscreen: Get it from here: http://software.intel.com/en-us/articles/intel-cilk-plus-software-development-kit/. The include bin directory in PATH.
3. Install Pintool: Download pintool from here: http://www.pintool.org/downloads.html. Install.
4. Install Cilkprof: You need Pin revision 53271 in order to run Cilkprof. These instructions include instructions on downloading and installing this version of Pin for Cilkprof.
   1. Change to the directory in which you would like to install Cilkprof.
   2. Create two new directories, cilkutil and 3rdparty.

      $ mkdir cilkutil 3rdparty

   3. Download Pin revision 53271 for Linux from http://www.pintool.org/downloads.html, and place the downloaded archive into 3rdparty.
   4. Download libzca from http://cilkplus.org/download, and place the downloaded archive into cilkutil.
   5. Unpack the Pin archive inside of 3rdparty.
   6. Rename the folder created from unpacking the archive to pintool.
   7. If you do not have the necessary permissions to access the intel64 subdirectory inside of pintool, run $ chmod -R 755 intel64.
   8. Unpack the libzca archive inside of cilkutil. This will produce a zca directory and a cilkprof directory.
   9. Ensure you have the necessary permissions on the unpacked archive directories, using chmod.

      $ chmod -R 755 *

   10. Build libzca.

       $ cd zca/src

       $ make OUT=linux64

   11. Build cilkprof.

       $ cd ../../cilkprof

       $ make

   12. Download the cilkprof script from http://web.mit.edu/neboat/www/code/cilkprof, and place it in a directory in your PATH environment variable.
   13. Set the CILKUTIL environment variable to point to the cilkutil directory. For example, if your shell is bash, add the line export CILKUTIL=/path/to/cilkutil to your .bashrc.

• Usage
  • Compile with ICC: $ icc cilkprogram.cpp -o cilkprogram
  • Compile with GCC: $ g++ cilkprogram.cpp -o cilkprogram -lcilkrts -ldl
  • Check parallelism: $ cilkview ./cilkprogram
  • Check race condition: $ cilkscreen ./cilkprogram
  • Pintool: TO BE COMPLETED
  • Linux perf tool:
    • Show list of counters: $ perf list
    • check L1 data load miss: $ perf stat -c L1-dcache-load-misses ./cilkprogram
  • Cilkprof: $ cilkprof ./cilkprogram
    • This command generates two csv output files, cilkprogram.bb.csv and cilkprogram.cc.csv, containing work and span profiling data for your Cilk program. At this time, the data in these files are most easily perused using your favorite spreadsheet program. For more information on configuring the output of Cilkprof, run $ cilkprof -h.