Cmake modernisation

CMakeLists.txt

@@ -7,98 +7,154 @@ project(SVF-example
         LANGUAGES C CXX
 )
 if (DEFINED LLVM_DIR)
-        set(ENV{LLVM_DIR} "${LLVM_DIR}")
+    set(ENV{LLVM_DIR} "${LLVM_DIR}")
+endif()
+if (DEFINED ENV{LLVM_DIR})
+    # We need to match the build environment for LLVM:
+    # In particular, we need C++11 and the -fno-rtti flag
+    set(CMAKE_CXX_STANDARD 17)
+    if(CMAKE_BUILD_TYPE MATCHES "Debug")
+	set(CMAKE_CXX_FLAGS "-fPIC -std=gnu++17 -O0 -fno-rtti -Wno-deprecated")
+    else()
+	set(CMAKE_CXX_FLAGS "-fPIC -std=gnu++17 -O3 -fno-rtti -Wno-deprecated")
     endif()
-    if (DEFINED ENV{LLVM_DIR})
-        # We need to match the build environment for LLVM:
-        # In particular, we need C++11 and the -fno-rtti flag
-        set(CMAKE_CXX_STANDARD 17)
-	if(CMAKE_BUILD_TYPE MATCHES "Debug")
-		set(CMAKE_CXX_FLAGS "-fPIC -std=gnu++17 -O0 -fno-rtti -Wno-deprecated")
-	else()
-		set(CMAKE_CXX_FLAGS "-fPIC -std=gnu++17 -O3 -fno-rtti -Wno-deprecated")
-	endif()
-	set(CMAKE_C_FLAGS "-fPIC")
+    set(CMAKE_C_FLAGS "-fPIC")
+endif()
+
 
 find_package(LLVM REQUIRED CONFIG)
-
-    list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
-    include(AddLLVM)
+message(STATUS "LLVM STATUS:
+  Version       ${LLVM_VERSION}
+  Includes      ${LLVM_INCLUDE_DIRS}
+  Libraries     ${LLVM_LIBRARY_DIRS}
+  Build type    ${LLVM_BUILD_TYPE}
+  Dynamic lib   ${LLVM_LINK_LLVM_DYLIB}"
+)    
+list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
+include(AddLLVM)
 
-    add_definitions(${LLVM_DEFINITIONS})
-    include_directories(${LLVM_INCLUDE_DIRS})
+add_definitions(${LLVM_DEFINITIONS})
+include_directories(${LLVM_INCLUDE_DIRS})
 
-else()
-    message(FATAL_ERROR "\
-WARNING: The LLVM_DIR var was not set (required for an out-of-source build)!\n\
-Please set this to environment variable to point to the LLVM build directory\
-(e.g. on linux: export LLVM_DIR=/path/to/llvm/build/dir)")
+if(NOT "${LLVM_FOUND}")
+    message(FATAL_ERROR "Failed to find supported LLVM version")
 endif()
 
-if (EXISTS "${SVF_DIR}")
+# Add LLVM's include directories and link directory for all targets defined hereafter
+separate_arguments(LLVM_DEFINITIONS_LIST NATIVE_COMMAND ${LLVM_DEFINITIONS})
+include_directories(SYSTEM ${LLVM_INCLUDE_DIRS})
+link_directories(${LLVM_LIBRARY_DIRS})
+add_definitions(${LLVM_DEFINITIONS})
+
+# Check if LLVM was built generating the single libLLVM.so shared library file or as separate static libraries
+if(LLVM_LINK_LLVM_DYLIB)
+    message(STATUS "Linking to LLVM dynamic shared library object")
+    set(llvm_libs LLVM)
 else()
-    set(SVF_DIR $ENV{SVF_DIR})
-    if(EXISTS "${SVF_DIR}")
-    else()
-    message(FATAL_ERROR "\
-WARNING: The SVF_DIR var was not set (required for an out-of-source build)!\n\
-Please set this to environment variable to point to the SVF_DIR directory or set this variable to cmake configuration\n
-(e.g. on linux: export SVF_DIR=/path/to/SVF/dir) \n or \n \n(make the project via: cmake -DSVF_DIR=your_path_to_SVF) ")
-    endif()
+    message(STATUS "Linking to separate LLVM static libraries")
+    llvm_map_components_to_libnames(llvm_libs
+        bitwriter
+        core
+        ipo
+        irreader
+        instcombine
+        instrumentation
+        target
+        linker
+        analysis
+        scalaropts
+        support
+    )
 endif()
 
-if(CMAKE_BUILD_TYPE MATCHES "Debug")
-    MESSAGE (STATUS "building SVF in debug mode")
-    if (EXISTS "${SVF_DIR}/Debug-build")
-        set(SVF_BIN "${SVF_DIR}/Debug-build")
-    else()
-        set(SVF_BIN "${SVF_DIR}/Release-build")
-    endif()
-else()
-    MESSAGE (STATUS "building SVF in release mode")
-    set(SVF_BIN "${SVF_DIR}/Release-build")
+# Make the "add_llvm_library()" command available and configure LLVM/CMake
+list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
+include(AddLLVM)
+
+# LLVM is normally built without RTTI. Be consistent with that.
+if(NOT LLVM_ENABLE_RTTI)
+    add_compile_options("-fno-rtti")
 endif()
-set(SVF_HEADER "${SVF_DIR}/svf/include")
-set(SVF_LLVM_HEADER "${SVF_DIR}/svf-llvm/include")
-set(SVF_LIB "${SVF_BIN}/svf-llvm/libSvfLLVM.a" "${SVF_BIN}/svf/libSvfCore.a")
-set(SVF_BIN_HEADER "${SVF_BIN}/include")
-include_directories(${SVF_HEADER}
-                    ${SVF_LLVM_HEADER}
-                    ${SVF_BIN_HEADER})
-
-#set z3 env
-if (DEFINED Z3_DIR)
-    set(ENV{Z3_DIR} "${Z3_DIR}")
+
+# The same applies for exception handling
+if(NOT LLVM_ENABLE_EH)
+    add_compile_options("-fno-exceptions")
 endif()
-if(CMAKE_BUILD_TYPE MATCHES "Debug")
-    if(EXISTS "${Z3_DIR}/src")
-        find_package(Z3 REQUIRED CONFIG)
-        include_directories(${Z3_CXX_INCLUDE_DIRS})
-    else()
-        find_library(Z3_LIBRARIES NAMES libz3.a libz3.so
-                HINTS $ENV{Z3_DIR}
-                PATH_SUFFIXES bin)
-        find_path(Z3_INCLUDES NAMES z3++.h
-                HINTS $ENV{Z3_DIR}
-                PATH_SUFFIXES include z3)
-        if(NOT Z3_LIBRARIES OR NOT Z3_INCLUDES)
-            message(FATAL_ERROR "Z3 not found!")
-        endif()
-        include_directories(${Z3_INCLUDES})
-        LINK_DIRECTORIES(${Z3_DIR}/bin)
+
+# Find specifically SVF 2.7 (change if needed) prioritising locations pointed to by $SVF_DIR
+
+find_package(SVF CONFIG HINTS ${SVF_DIR})
+message(STATUS "SVF STATUS:
+    Found:                              ${SVF_FOUND}
+    Version:                            ${SVF_VERSION}
+    Build mode:                         ${SVF_BUILD_TYPE}
+    C++ standard:                       ${SVF_CXX_STANDARD}
+    RTTI enabled:                       ${SVF_ENABLE_RTTI}
+    Exceptions enabled:                 ${SVF_ENABLE_EXCEPTIONS}
+    Install root directory:             ${SVF_INSTALL_ROOT}
+    Install binary directory:           ${SVF_INSTALL_BIN_DIR}
+    Install library directory:          ${SVF_INSTALL_LIB_DIR}
+    Install include directory:          ${SVF_INSTALL_INCLUDE_DIR}
+    Install 'extapi.bc' file path:      ${SVF_INSTALL_EXTAPI_FILE}")
+
+
+# Define the actual runtime executable
+llvm_map_components_to_libnames(llvm_libs bitwriter core ipo irreader instcombine instrumentation target linker analysis scalaropts support )
+
+
+# If the SVF CMake package was found, show how to use some "modern" features of this approach; otherwise use old system
+if("${SVF_FOUND}")
+    message(STATUS "Found installed SVF instance; importing using modern CMake methods")
+
+    # Check that SVF & the found LLVM instance match w.r.t. RTTI/exception handling support
+    if(NOT (${SVF_ENABLE_RTTI} STREQUAL ${LLVM_ENABLE_RTTI}))
+        message(FATAL_ERROR "SVF & LLVM RTTI support mismatch (SVF: ${SVF_ENABLE_RTTI}, LLVM: ${LLVM_ENABLE_RTTI})!")
+    endif()
+    if(NOT (${SVF_ENABLE_EXCEPTIONS} STREQUAL ${LLVM_ENABLE_EH}))
+        message(FATAL_ERROR "SVF & LLVM exceptions support mismatch (SVF: ${SVF_ENABLE_EXCEPTIONS}, LLVM: ${LLVM_ENABLE_EH})!")
     endif()
+
+    # Include SVF's include directories for all targets & include the library directories to find the library objects
+    include_directories(SYSTEM ${SVF_INSTALL_INCLUDE_DIR})
+    link_directories(${SVF_INSTALL_LIB_DIR})
+    # Link the LLVM libraries (single dynamic library/multiple static libraries) to the example executable
 else()
-    find_library(Z3_LIBRARIES NAMES libz3.a libz3.so
-            HINTS $ENV{Z3_DIR}
-            PATH_SUFFIXES bin)
-    find_path(Z3_INCLUDES NAMES z3++.h
-            HINTS $ENV{Z3_DIR}
-            PATH_SUFFIXES include z3)
+    message(STATUS "Failed to find installed SVF instance; using legacy import method")
+    message(FATAL_ERROR "SVF & LLVM RTTI support mismatch (SVF: ${SVF_ENABLE_RTTI}, LLVM: ${LLVM_ENABLE_RTTI})!")
+endif()
+
+# Search for system Z3 with CMake support first; otherwise try to find Z3 downloaded/installed by SVF's build script
+find_package(Z3 CONFIG PATHS ${Z3_DIR} ENV Z3_DIR)
+message(STATUS "Z3 STATUS:
+    Z3 found:                   ${Z3_FOUND}
+    Z3 version:                 ${Z3_VERSION}
+    Z3 libraries:               ${Z3_LIBRARIES}
+    Z3 include directory:       ${Z3_CXX_INCLUDE_DIRS}")
+
+if(Z3_FOUND)
+    include_directories(SYSTEM ${Z3_CXX_INCLUDE_DIRS})
+else()
+    message(STATUS "No system Z3 CMake package found; using SVF's Z3 instance")
+    find_library(Z3_LIBRARIES
+        NAMES libz3.a libz3.so
+        HINTS ${Z3_DIR} ENV Z3_DIR
+        PATH_SUFFIXES bin
+    )
+    find_path(Z3_INCLUDES
+        NAMES z3++.h
+        HINTS ${Z3_DIR} ENV Z3_DIR
+        PATH_SUFFIXES include
+    )
+
+    # Ensure this Z3 instance was actually found
     if(NOT Z3_LIBRARIES OR NOT Z3_INCLUDES)
-        message(FATAL_ERROR "Z3 not found!")
+        message(FATAL_ERROR "Failed to find system Z3/SVF's Z3 instance!")
     endif()
-    include_directories(${Z3_INCLUDES})
-    LINK_DIRECTORIES(${Z3_DIR}/bin)
-endif()
 
+    # Getting Z3 from GitHub places compiled library files in /bin, so add that as a search directory
+    include_directories(SYSTEM ${Z3_INCLUDES})
+    link_directories(${Z3_DIR}/bin)
+
+    # Actually link Z3 to the example binary
+endif()
 add_subdirectory(src)

src/CMakeLists.txt

@@ -1,10 +1,2 @@
-llvm_map_components_to_libnames(llvm_libs bitwriter core ipo irreader instcombine instrumentation target linker analysis scalaropts support )
-file (GLOB SOURCES
-   *.cpp
-)
-add_executable(svf-ex ${SOURCES})
-
-target_link_libraries(svf-ex ${SVF_LIB} ${llvm_libs})
-target_link_libraries(svf-ex ${Z3_LIBRARIES})
-set_target_properties( svf-ex PROPERTIES
-                       RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin )
+add_executable(svf-example svf-ex.cpp)
+target_link_libraries(svf-example ${llvm_libs} SvfLLVM SvfCore)