Update CMake options and README

Author: sebastiankreutzer

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.15)
-project(capi VERSION 0.1)
+project(capi VERSION 0.2)
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 set(CMAKE_VERBOSE_MAKEFILE ON)

README.md

@@ -10,8 +10,6 @@ It consists of two major components:
 - A selection tool, that creates ICs tailored to the target code and measurement objective.
 - A runtime library, enabling runtime-adaptable binary instrumentation based on [LLVM XRay](https://llvm.org/docs/XRay.html). 
 
-
-
 CaPI currently supports the following measurement APIs:
 - GNU interface: compatible with GCC's `-finstrument-functions`
 - TALP (part of the DLB library): Parallel performance metrics of MPI regions
@@ -27,18 +25,25 @@ This project is currently in a pre-release state, frequent changes to the code a
 - ScoreP >=7 (optional)
 - DLB 3.3 (optional, other versions may work)
 - Extrae 3.8.3 (optional, other versions may work)
+- LLVM-Lit (testing only)
 
 ## Build
-You can build CaPI as follows ([Ninja](https://github.com/ninja-build/ninja) is not required and can be substituted with `make`).
+CaPI is built as follows ([Ninja](https://github.com/ninja-build/ninja) is not required and can be substituted with `make`).
 ```
 mkdir build && cd build
-cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=$(which clang) -DCMAKE_CXX_COMPILER=$(which clang++) -DDLB_DIR=$(which dlb)/../.. -DSCOREP_PATH=$(which scorep)/../.. .. 
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=$(which clang) -DCMAKE_CXX_COMPILER=$(which clang++) -DDLB_DIR=$(which dlb)/../.. -DSCOREP_DIR=$(which scorep)/../.. .. 
 ninja
 ```
-Options
-- `ENABLE_TALP=ON/OFF`: Enable/Disable support for TALP interface. Default is `ON`.
-- `ENABLE_XRAY=ON/OFF`: Enable/Disable support for runtime-adaptable instrumentation with LLVM XRay. Default is `ON`.
 
+CMake Options
+- `ENABLE_TALP=ON/OFF`: Enable/Disable support for TALP. Default is `ON`.
+  - `DLB_DIR`: Path to DLB installation.
+- `ENABLE_SCOREP=ON/OFF`: Enable/Disable support for Score-P. Default is `ON`.
+  - `SCOREP_DIR`: Path to Score-P installation.
+- `ENABLE_EXTRAE=ON/OFF`: Enable/Disable support for Extrae. Default is `ON`.
+- `ENABLE_XRAY=ON/OFF`: Enable/Disable support for runtime-adaptable instrumentation with LLVM XRay. Default is `ON`.
+- `ENABLE_TESTING=ON/OFF`: Enable/Disable testing. Requires MetaCG and LLVM-Lit.
+  - Set `metacg_DIR` to MetaCG installation directory.
 ## Examples
 To verify your build, you may test out the instrumentation of proxy applications LULESH and AMG in the `example` folder (located in your current build directory).
 For details, refer to `CAPI_README` in the `lulesh` folder.

cmake/ToolchainOptions.cmake

@@ -39,13 +39,13 @@ if (ENABLE_TESTING)
 endif()
 
 option(ENABLE_XRAY "Enable XRay dynamic instrumentation interface" ON)
-option(SCOREP_SUPPORT "Enable Score-P support" ON)
+option(ENABLE_SCOREP "Enable Score-P support" ON)
 
-if (SCOREP_SUPPORT)
-  set(SCOREP_PATH "" CACHE PATH "Path to ScoreP installation")
+if (ENABLE_SCOREP)
+  set(SCOREP_DIR "" CACHE PATH "Path to ScoreP installation")
 
-  find_library(scorep_mgmt  NAMES scorep_adapter_compiler_mgmt HINTS "${SCOREP_PATH}/lib"  REQUIRED)
-  find_library(scorep_measurement  NAMES scorep_measurement HINTS "${SCOREP_PATH}/lib" REQUIRED)
+  find_library(scorep_mgmt  NAMES scorep_adapter_compiler_mgmt HINTS "${SCOREP_DIR}/lib"  REQUIRED)
+  find_library(scorep_measurement  NAMES scorep_measurement HINTS "${SCOREP_DIR}/lib" REQUIRED)
 
   message(STATUS "Score-P libs: ${scorep_mgmt} ${scorep_measurement}")
 endif()

examples/CMakeLists.txt

@@ -11,7 +11,7 @@ set(CAPI_LIB_DIR ${CMAKE_BINARY_DIR}/lib)
 set(CC_PATH ${LLVM_BINARY_DIR}/bin/clang)
 set(CXX_PATH ${LLVM_BINARY_DIR}/bin/clang++)
 set(LLVM_CONFIG ${LLVM_BINARY_DIR}/bin/llvm-config)
-set(SCOREP_CONFIG ${SCOREP_PATH}/bin/scorep-config)
+set(SCOREP_CONFIG ${SCOREP_DIR}/bin/scorep-config)
 
 configure_file(lulesh/Makefile.in lulesh/Makefile @ONLY)
 

examples/lulesh/CMakeLists.txt

@@ -11,6 +11,6 @@ set(CAPI_LIB_DIR ${CMAKE_BINARY_DIR}/lib)
 set(CC_PATH ${LLVM_BINARY_DIR}/bin/clang)
 set(CXX_PATH ${LLVM_BINARY_DIR}/bin/clang++)
 set(LLVM_CONFIG ${LLVM_BINARY_DIR}/bin/llvm-config)
-set(SCOREP_CONFIG ${SCOREP_PATH}/bin/scorep-config)
+set(SCOREP_CONFIG ${SCOREP_DIR}/bin/scorep-config)
 
 configure_file(Makefile.in Makefile @ONLY)

lib/xray/CMakeLists.txt

@@ -36,7 +36,7 @@ if (ENABLE_TALP)
     install(TARGETS capixray_talp ARCHIVE DESTINATION lib)
 endif()
 
-if (SCOREP_SUPPORT)
+if (ENABLE_SCOREP)
     set(CAPI_XRAY_SCOREP_SOURCES ${CAPI_XRAY_SOURCES} GNUInterface.cpp ScorePInit.cpp)
     add_library(capixray_scorep STATIC ${CAPI_XRAY_SCOREP_SOURCES})
     add_json(capixray_scorep)

scripts/CMakeLists.txt

@@ -14,7 +14,7 @@ function(configure_script input output)
     set(CAPI_LIB_DIR ${CMAKE_BINARY_DIR}/lib)
 
     set(LLVM_CONFIG ${LLVM_BINARY_DIR}/bin/llvm-config)
-    set(SCOREP_CONFIG ${SCOREP_PATH}/bin/scorep-config)
+    set(SCOREP_CONFIG ${SCOREP_DIR}/bin/scorep-config)
     set(CC_PATH ${LLVM_BINARY_DIR}/bin/clang)
     set(CXX_PATH ${LLVM_BINARY_DIR}/bin/clang++)
 

test/passes/CMakeLists.txt

@@ -12,7 +12,7 @@ function(configure_lit_site_cfg input output)
   set(CAPI_MPICC ${CMAKE_BINARY_DIR}/scripts/clang-mpi-inst)
   set(CAPI_MPICXX ${CMAKE_BINARY_DIR}/scripts/clang-mpi-inst++)
 
-  if (SCOREP_SUPPORT)
+  if (ENABLE_SCOREP)
     set(CAPI_SCOREP_SUPPORT True)
   else()
     set(CAPI_SCOREP_SUPPORT False)