[refactor]: cmake library installation (#228)

* [refactor] update CMake configuration for improved modularity and clarity

- Set CMAKE_POSITION_INDEPENDENT_CODE to ON for better compatibility.
- Transitioned from global include directories to target-specific includes for better encapsulation.
- Changed library definitions from INTERFACE to OBJECT for modular libraries to avoid transitive dependencies.
- Updated target linking to use the unified PROJECT_NAME for consistency across executables.
- Enhanced installation targets for unified libraries and improved include directory management.
- Cleaned up unnecessary global includes and streamlined dependency management across various components.

* fix compile error on mac

* fix anonymous struct

* fix shared lib compile

* add an option for shared lib

* fix macOS compilation issue

Author: 1a1a11a

CMakeLists.txt

@@ -15,6 +15,7 @@ set(CMAKE_CXX_EXTENSIONS Off)
 
 # export compile commands, useful for IDEs
 set(EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 # Define build options
 # echo madvise | sudo tee /sys/kernel/mm/transparent_hugepage/enabled
@@ -25,6 +26,7 @@ option(SUPPORT_TTL "whether support TTL" OFF)
 option(OPT_SUPPORT_ZSTD_TRACE "whether support zstd trace" ON)
 option(ENABLE_LRB "enable LRB" OFF)
 option(ENABLE_3L_CACHE "enable 3LCache" OFF)
+option(BUILD_SHARED_LIBS "build shared library" ON)
 set(LOG_LEVEL "default" CACHE STRING "change the logging level")
 set_property(CACHE LOG_LEVEL PROPERTY STRINGS ERROR WARN INFO DEBUG VERBOSE DEFAULT)
 
@@ -112,28 +114,31 @@ include(GNUInstallDirs)
 set(dependency_libs "")
 
 find_package(Threads REQUIRED)
-set(dependency_libs ${dependency_libs} ${CMAKE_THREAD_LIBS_INIT})
+list(APPEND dependency_libs ${CMAKE_THREAD_LIBS_INIT})
+
+# Link standard math and dl libraries universally
+list(APPEND dependency_libs m dl)
 
 find_package(GLib REQUIRED)
-include_directories(${GLib_INCLUDE_DIRS})
-set(dependency_libs ${dependency_libs} ${GLib_LIBRARY})
+# Don't add GLib includes globally - add them to specific targets
+# include_directories(${GLib_INCLUDE_DIRS})
+list(APPEND dependency_libs ${GLib_LIBRARY})
 
 find_package(argp REQUIRED)
-include_directories(${ARGP_INCLUDE_DIRS})
-set(dependency_libs ${dependency_libs} ${ARGP_LIBRARY})
+# Don't add argp includes globally
+# include_directories(${ARGP_INCLUDE_DIRS})
+list(APPEND dependency_libs ${ARGP_LIBRARY})
 
 if(OPT_SUPPORT_ZSTD_TRACE)
     add_compile_definitions(SUPPORT_ZSTD_TRACE=1)
     find_package(ZSTD)
-
-    include_directories(${ZSTD_INCLUDE_DIR})
-
+    message(STATUS "ZSTD_INCLUDE_DIR ${ZSTD_INCLUDE_DIR}, ZSTD_LIBRARIES ${ZSTD_LIBRARIES}")
     if("${ZSTD_LIBRARIES}" STREQUAL "")
         message(FATAL_ERROR "zstd not found")
+    else()
+        include_directories(${ZSTD_INCLUDE_DIR})
+        list(APPEND dependency_libs ${ZSTD_LIBRARIES})
     endif()
-
-    set(dependency_libs ${dependency_libs} ${ZSTD_LIBRARIES})
-    message(STATUS "ZSTD_INCLUDE_DIR ${ZSTD_INCLUDE_DIR}, ZSTD_LIBRARIES ${ZSTD_LIBRARIES}")
 endif()
 
 # TCMalloc (libgoogle-perftools-dev google-perftools)
@@ -146,9 +151,10 @@ if(NOT ${CMAKE_BUILD_TYPE} MATCHES "Debug")
     if("${Tcmalloc_LIBRARY}" STREQUAL "")
         message(STATUS "!!! cannot find tcmalloc")
     else()
-        set(dependency_libs ${dependency_libs} ${Tcmalloc_LIBRARIES})
+        list(APPEND dependency_libs ${Tcmalloc_LIBRARIES})
         # tcmalloc flags will be set per target instead of globally
         set(tcmalloc_flags "-fno-builtin-malloc -fno-builtin-calloc -fno-builtin-realloc -fno-builtin-free")
+        list(APPEND LIBCACHESIM_C_FLAGS ${tcmalloc_flags})
     endif()
 endif()
 
@@ -157,7 +163,7 @@ find_package(Threads)
 if(ENABLE_GLCACHE)
     find_package(xgboost REQUIRED)
     include_directories(${XGBOOST_INCLUDE_DIR})
-    set(dependency_libs ${dependency_libs} xgboost::xgboost)
+    list(APPEND dependency_libs xgboost::xgboost)
     add_compile_definitions(ENABLE_GLCACHE=1)
     message(STATUS "XGBOOST_INCLUDE_DIR=${XGBOOST_INCLUDE_DIR}")
 endif()
@@ -168,13 +174,13 @@ foreach(FEATURE ENABLE_LRB ENABLE_3L_CACHE)
         if(NOT LIGHTGBM_PATH)
             message(FATAL_ERROR "LIGHTGBM_PATH not found")
         endif()
-        include_directories(${LIGHTGBM_PATH})
+        # include_directories(${LIGHTGBM_PATH})
 
         find_library(LIGHTGBM_LIB _lightgbm)
         if(NOT LIGHTGBM_LIB)
             message(FATAL_ERROR "LIGHTGBM_LIB not found")
         endif()
-        set(dependency_libs ${dependency_libs} ${LIGHTGBM_LIB})
+        list(APPEND dependency_libs ${LIGHTGBM_LIB})
         add_compile_definitions(${FEATURE}=1)
     endif()
 endforeach()
@@ -214,18 +220,11 @@ message(STATUS "============= Status of optional features ==============")
 message(STATUS "========================================================")
 
 # Define include directories for reuse in subdirectories
-set(libCacheSim_include_dir ${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/include ${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/utils/include ${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim)
-set(libCacheSim_binary_include_dir ${CMAKE_CURRENT_BINARY_DIR}/libCacheSim/include)
-
-include_directories(${libCacheSim_include_dir})
-include_directories(${libCacheSim_binary_include_dir})
-# Restructured to avoid transitive dependency duplicates
-# profiler_lib already includes cache_lib_c, cache_lib_cpp, traceReader_lib (which includes utils_lib)
-# Only include top-level libraries to avoid duplicates
-set(all_modules cache_lib_c cache_lib_cpp traceReader_lib profiler_lib dataStructure_lib utils_lib traceAnalyzer_lib mrcProfiler_lib)
-# For linking: use minimal sets to avoid transitive dependency duplicates
-set(core_libs cache_lib_c cache_lib_cpp traceReader_lib dataStructure_lib utils_lib)
-set(high_level_libs profiler_lib traceAnalyzer_lib)
+set(libCacheSim_include_dir
+    ${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/include
+    ${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/utils/include
+    ${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim
+)
 
 add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/cache)
 add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/dataStructure)
@@ -251,24 +250,74 @@ endif()
 
 # libCacheSim unified library compilation and installation
 # Create a single library that combines all modular libraries
-add_library(${PROJECT_NAME} INTERFACE)
-
-# Link all modular libraries into the unified library
-target_link_libraries(${PROJECT_NAME} INTERFACE ${high_level_libs})
+add_library(${PROJECT_NAME} STATIC
+    $<TARGET_OBJECTS:cache_lib_c>
+    $<TARGET_OBJECTS:cache_lib_cpp>
+    $<TARGET_OBJECTS:traceReader_lib>
+    $<TARGET_OBJECTS:profiler_lib>
+    $<TARGET_OBJECTS:dataStructure_lib>
+    $<TARGET_OBJECTS:utils_lib>
+    $<TARGET_OBJECTS:traceAnalyzer_lib>
+    $<TARGET_OBJECTS:mrcProfiler_lib>
+)
 
 # Set include directories for the unified library
 target_include_directories(${PROJECT_NAME} INTERFACE
-    $<BUILD_INTERFACE:${libCacheSim_include_dir}>
-    $<BUILD_INTERFACE:${libCacheSim_binary_include_dir}>
+    # Use separate BUILD_INTERFACE for each directory to avoid list expansion issues
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/include>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/utils/include>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/>
     $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
 )
 
-# Link dependencies for the unified library
-target_link_libraries(${PROJECT_NAME} INTERFACE ${dependency_libs})
+
+# Link the static library to all required dependencies
+target_link_libraries(${PROJECT_NAME} PUBLIC ${dependency_libs})
 
 # Set version and properties
 set_target_properties(${PROJECT_NAME} PROPERTIES VERSION ${${PROJECT_NAME}_VERSION})
 
+# Install the static library
+install(TARGETS ${PROJECT_NAME}
+    EXPORT ${PROJECT_NAME}Targets
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
+
+
+if(BUILD_SHARED_LIBS)
+    add_library(${PROJECT_NAME}_shared SHARED
+        $<TARGET_OBJECTS:cache_lib_c>
+        $<TARGET_OBJECTS:cache_lib_cpp>
+        $<TARGET_OBJECTS:traceReader_lib>
+        $<TARGET_OBJECTS:profiler_lib>
+        $<TARGET_OBJECTS:dataStructure_lib>
+        $<TARGET_OBJECTS:utils_lib>
+        $<TARGET_OBJECTS:traceAnalyzer_lib>
+        $<TARGET_OBJECTS:mrcProfiler_lib>
+    )
+
+    target_include_directories(${PROJECT_NAME}_shared INTERFACE
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/include>
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/utils/include>
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/libCacheSim/>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+    )
+
+    target_link_libraries(${PROJECT_NAME}_shared PUBLIC ${dependency_libs})
+
+    set_target_properties(${PROJECT_NAME}_shared PROPERTIES VERSION ${${PROJECT_NAME}_VERSION})
+
+    install(TARGETS ${PROJECT_NAME}_shared
+        EXPORT ${PROJECT_NAME}Targets
+        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+    )
+endif()
+
+
 # Configuration files
 configure_file(${PROJECT_SOURCE_DIR}/${PROJECT_NAME}.pc.in ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc @ONLY)
 configure_file(${PROJECT_SOURCE_DIR}/${PROJECT_NAME}.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/Find${PROJECT_NAME}.cmake @ONLY)
@@ -281,17 +330,8 @@ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/Find${PROJECT_NAME}.cmake
     DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME} COMPONENT dev)
 
-# Install all modular libraries and the unified interface library
-install(TARGETS ${PROJECT_NAME} ${all_modules}
-    EXPORT ${PROJECT_NAME}Targets
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-)
-
 # Install the export file
 install(EXPORT ${PROJECT_NAME}Targets
     FILE ${PROJECT_NAME}Targets.cmake
     DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
-)
-
+)

libCacheSim/bin/MRC/CMakeLists.txt

@@ -15,5 +15,6 @@ set(mrc_sources_c
 )
 
 add_executable(MRC ${mrc_sources_c})
-target_link_libraries(MRC ${core_libs} ${dependency_libs})
+target_include_directories(MRC PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(MRC ${PROJECT_NAME})
 install(TARGETS MRC RUNTIME DESTINATION bin)

libCacheSim/bin/cachesim/CMakeLists.txt

@@ -9,8 +9,6 @@ set(cachesim_sources_c
     ../cli_reader_utils.c
 )
 add_executable(cachesim ${cachesim_sources_c})
-target_include_directories(cachesim PRIVATE ../)
-# Link just profiler_lib which now provides all needed libraries transitively
-target_link_libraries(cachesim profiler_lib)
-# target_link_options(cachesim PRIVATE "-Wl,--export-dynamic")  # Not supported on macOS
+target_include_directories(cachesim PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS} ../)
+target_link_libraries(cachesim ${PROJECT_NAME})
 install(TARGETS cachesim RUNTIME DESTINATION bin)

libCacheSim/bin/customized/SOSP23/CMakeLists.txt

@@ -9,14 +9,23 @@ set(traceOneHit_sources_cpp
     ../../cli_reader_utils.c
 )
 add_executable(traceOneHit ${traceOneHit_sources_cpp})
-target_include_directories(traceOneHit PRIVATE ../../)
-target_link_libraries(traceOneHit dataStructure_lib traceReader_lib ${Boost_LIBRARIES} ${dependency_libs})
+target_include_directories(traceOneHit PRIVATE
+    ../../
+    ${libCacheSim_include_dir}
+    ${GLib_INCLUDE_DIRS}
+)
+# target_link_libraries(traceOneHit dataStructure_lib traceReader_lib ${Boost_LIBRARIES} ${dependency_libs})
+target_link_libraries(traceOneHit dataStructure_lib traceReader_lib utils_lib ${Boost_LIBRARIES} ${dependency_libs})
 
 set(flash_sources_cpp
     flash/flash.cpp
     oneHit/cli_parser.c
     ../../cli_reader_utils.c
 )
 add_executable(flash ${flash_sources_cpp})
-target_include_directories(flash PRIVATE ../../)
-target_link_libraries(flash ${core_libs} ${dependency_libs})
+target_include_directories(flash PRIVATE
+    ../../
+    ${libCacheSim_include_dir}
+    ${GLib_INCLUDE_DIRS}
+)
+target_link_libraries(flash ${PROJECT_NAME} ${dependency_libs})

libCacheSim/bin/debug/CMakeLists.txt

@@ -3,11 +3,14 @@
 # ==============================================================================
 
 add_executable(debug main.cpp)
-target_link_libraries(debug ${core_libs} ${dependency_libs})
+target_include_directories(debug PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(debug ${PROJECT_NAME})
 
 add_executable(debug_aligned aligned.c)
-target_link_libraries(debug_aligned ${core_libs} ${dependency_libs})
+target_include_directories(debug_aligned PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(debug_aligned ${PROJECT_NAME})
 
 add_executable(debug_fileOp fileOp.cpp)
-target_link_libraries(debug_fileOp ${core_libs} ${dependency_libs})
+target_include_directories(debug_fileOp PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(debug_fileOp ${PROJECT_NAME})
 

libCacheSim/bin/distUtil/CMakeLists.txt

@@ -8,5 +8,6 @@ set(distUtil_sources_c
     ../cli_reader_utils.c
 )
 add_executable(distUtil ${distUtil_sources_c})
-target_link_libraries(distUtil profiler_lib)
+target_include_directories(distUtil PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(distUtil ${PROJECT_NAME})
 install(TARGETS distUtil RUNTIME DESTINATION bin)

libCacheSim/bin/mrcProfiler/CMakeLists.txt

@@ -13,17 +13,15 @@ add_executable(mrcProfiler ${mrcProfiler_sources_cpp})
 target_compile_options(mrcProfiler PRIVATE
     $<$<COMPILE_LANGUAGE:C>:${LIBCACHESIM_C_FLAGS}>
     $<$<COMPILE_LANGUAGE:CXX>:${LIBCACHESIM_CXX_FLAGS}>
-    ${tcmalloc_flags}
 )
-
-target_link_libraries(mrcProfiler mrcProfiler_lib m dl)
-
-# target_link_options(mrcProfiler PRIVATE "-Wl,--export-dynamic")  # Not supported on macOS
-install(TARGETS mrcProfiler RUNTIME DESTINATION bin)
+target_include_directories(mrcProfiler PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(mrcProfiler ${PROJECT_NAME})
 
 set_target_properties(mrcProfiler
         PROPERTIES
         CXX_STANDARD 17
         CXX_STANDARD_REQUIRED YES
         CXX_EXTENSIONS NO
 )
+
+install(TARGETS mrcProfiler RUNTIME DESTINATION bin)

libCacheSim/bin/traceAnalyzer/CMakeLists.txt

@@ -8,7 +8,8 @@ set(traceAnalyzer_sources_cpp
     ../cli_reader_utils.c
 )
 add_executable(traceAnalyzer ${traceAnalyzer_sources_cpp})
-target_link_libraries(traceAnalyzer traceAnalyzer_lib ${core_libs} ${dependency_libs})
+target_include_directories(traceAnalyzer PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(traceAnalyzer ${PROJECT_NAME})
 install(TARGETS traceAnalyzer RUNTIME DESTINATION bin)
 
 set_target_properties(traceAnalyzer

libCacheSim/bin/traceUtils/CMakeLists.txt

@@ -3,14 +3,20 @@
 # ==============================================================================
 
 add_library(cliReaderLib ../cli_reader_utils.c)
-
+target_include_directories(cliReaderLib PRIVATE
+    ${libCacheSim_include_dir}
+    ${GLib_INCLUDE_DIRS}
+)
+target_compile_options(cliReaderLib PRIVATE ${LIBCACHESIM_C_FLAGS})
+target_link_libraries(cliReaderLib PRIVATE ${PROJECT_NAME})
 
 set(tracePrint_sources_cpp
     tracePrintMain.cpp
     cli_parser.cpp
 )
 add_executable(tracePrint ${tracePrint_sources_cpp})
-target_link_libraries(tracePrint cliReaderLib ${core_libs} ${dependency_libs})
+target_include_directories(tracePrint PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(tracePrint ${PROJECT_NAME} cliReaderLib)
 set_target_properties(tracePrint
         PROPERTIES
         CXX_STANDARD 17
@@ -28,7 +34,8 @@ set(traceConv_sources_cpp
     utils.cpp
 )
 add_executable(traceConv ${traceConv_sources_cpp})
-target_link_libraries(traceConv cliReaderLib ${core_libs} ${dependency_libs})
+target_include_directories(traceConv PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(traceConv ${PROJECT_NAME} cliReaderLib)
 set_target_properties(traceConv
         PROPERTIES
         CXX_STANDARD 17
@@ -43,7 +50,8 @@ set(traceFilter_sources_cpp
     cli_parser.cpp
 )
 add_executable(traceFilter ${traceFilter_sources_cpp})
-target_link_libraries(traceFilter cliReaderLib ${core_libs} ${dependency_libs})
+target_include_directories(traceFilter PRIVATE ${libCacheSim_include_dir} ${GLib_INCLUDE_DIRS})
+target_link_libraries(traceFilter ${PROJECT_NAME} cliReaderLib)
 set_target_properties(traceFilter
         PROPERTIES
         CXX_STANDARD 17
@@ -52,4 +60,3 @@ set_target_properties(traceFilter
         )
 
 install(TARGETS traceFilter RUNTIME DESTINATION bin)
-