Avoid using non-existing symbols in .map

to fix:

"ld.lld: error: version script assignment of 'UMF_1.0' to symbol
'umfLevelZeroMemoryProviderOps' failed: symbol not defined"

when using lld linker

Author: igchor

CMakeLists.txt

@@ -390,6 +390,18 @@ else()
     )
 endif()
 
+set(UMF_OPTIONAL_SYMBOLS_LINUX "")
+set(UMF_OPTIONAL_SYMBOLS_WINDOWS "")
+
+# Conditional configuration for Level Zero provider
+if(UMF_BUILD_LEVEL_ZERO_PROVIDER)
+    add_optional_symbol(umfLevelZeroMemoryProviderOps)
+endif()
+
+if(NOT UMF_DISABLE_HWLOC)
+    add_optional_symbol(umfOsMemoryProviderOps)
+endif()
+
 add_subdirectory(src)
 
 if(UMF_BUILD_TESTS)
@@ -408,17 +420,6 @@ if(UMF_BUILD_EXAMPLES)
     endif()
 endif()
 
-# Conditional configuration for Level Zero provider
-if(UMF_BUILD_LEVEL_ZERO_PROVIDER)
-    set(OPTIONAL_SYMBOLS "umfLevelZeroMemoryProviderOps")
-else()
-    set(OPTIONAL_SYMBOLS "")
-endif()
-
-# Configure the DEF file based on whether Level Zero provider is built
-configure_file("${CMAKE_CURRENT_SOURCE_DIR}/src/libumf.def.in"
-               "${CMAKE_CURRENT_BINARY_DIR}/src/libumf.def" @ONLY)
-
 if(UMF_FORMAT_CODE_STYLE)
     find_program(CLANG_FORMAT NAMES clang-format-15 clang-format-15.0
                                     clang-format)
@@ -599,8 +600,10 @@ endif()
 # Configure make install/uninstall and packages
 # --------------------------------------------------------------------------- #
 install(FILES ${CMAKE_SOURCE_DIR}/LICENSE.TXT
-              ${CMAKE_SOURCE_DIR}/third-party-programs.txt
         DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/doc/${PROJECT_NAME}/")
+install(
+    FILES ${CMAKE_SOURCE_DIR}/licensing/third-party-programs.txt
+    DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/doc/${PROJECT_NAME}/licensing/")
 
 install(DIRECTORY examples DESTINATION "${CMAKE_INSTALL_DOCDIR}")
 

cmake/helpers.cmake

@@ -417,3 +417,12 @@ macro(add_sanitizer_flag flag)
 
     set(CMAKE_REQUIRED_FLAGS ${SAVED_CMAKE_REQUIRED_FLAGS})
 endmacro()
+
+function(add_optional_symbol symbol)
+    set(UMF_OPTIONAL_SYMBOLS_WINDOWS
+        "${UMF_OPTIONAL_SYMBOLS_WINDOWS} \n    ${symbol}"
+        PARENT_SCOPE)
+    set(UMF_OPTIONAL_SYMBOLS_LINUX
+        "${UMF_OPTIONAL_SYMBOLS_LINUX} \n    ${symbol};"
+        PARENT_SCOPE)
+endfunction()

third-party-programs.txt renamed to licensing/third-party-programs.txt

@@ -112,8 +112,29 @@ if(NOT UMF_DISABLE_HWLOC)
         provider/provider_os_memory_windows.c)
 
     set(UMF_LIBS ${UMF_LIBS} ${LIBHWLOC_LIBRARIES})
+
+    if(NOT WINDOWS)
+        add_optional_symbol(umfMemspaceCreateFromNumaArray)
+        add_optional_symbol(umfMemspaceHighestBandwidthGet)
+        add_optional_symbol(umfMemspaceHighestCapacityGet)
+        add_optional_symbol(umfMemspaceHostAllGet)
+        add_optional_symbol(umfMemspaceLowestLatencyGet)
+    endif()
 endif()
 
+if(WINDOWS)
+    message(STATUS "UMF_OPTIONAL_SYMBOLS: ${UMF_OPTIONAL_SYMBOLS_WINDOWS}")
+else()
+    message(STATUS "UMF_OPTIONAL_SYMBOLS: ${UMF_OPTIONAL_SYMBOLS_LINUX}")
+endif()
+
+# Configure the DEF file based on whether Level Zero provider is built
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/libumf.def.in"
+               "${CMAKE_CURRENT_BINARY_DIR}/libumf.def" @ONLY)
+
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/libumf.map.in"
+               "${CMAKE_CURRENT_BINARY_DIR}/libumf.map" @ONLY)
+
 set(UMF_PRIVATE_LIBRARY_DIRS ${UMF_PRIVATE_LIBRARY_DIRS}
                              ${LIBHWLOC_LIBRARY_DIRS})
 
@@ -140,7 +161,7 @@ if(UMF_BUILD_SHARED_LIBRARY)
         TYPE SHARED
         SRCS ${UMF_SOURCES}
         LIBS ${UMF_LIBS} ${HWLOC_LIB}
-        LINUX_MAP_FILE ${CMAKE_CURRENT_SOURCE_DIR}/libumf.map
+        LINUX_MAP_FILE ${CMAKE_CURRENT_BINARY_DIR}/libumf.map
         WINDOWS_DEF_FILE ${CMAKE_CURRENT_BINARY_DIR}/libumf.def)
     set(UMF_COMMON_COMPILE_DEFINITIONS ${UMF_COMMON_COMPILE_DEFINITIONS}
                                        "UMF_SHARED_LIBRARY")

src/CMakeLists.txt

@@ -42,7 +42,6 @@ EXPORTS
     umfMempolicySetInterleavePartSize
     umfMemspaceDestroy
     umfOpenIPCHandle    
-    umfOsMemoryProviderOps
     umfPoolAlignedMalloc
     umfPoolByPtr
     umfPoolCalloc
@@ -59,4 +58,4 @@ EXPORTS
     umfProxyPoolOps
     umfPutIPCHandle
     umfScalablePoolOps
-    @OPTIONAL_SYMBOLS@
+    @UMF_OPTIONAL_SYMBOLS_WINDOWS@

src/libumf.def.in

@@ -11,7 +11,6 @@ UMF_1.0 {
         umfFree;
         umfGetIPCHandle;
         umfGetLastFailedMemoryProvider;
-        umfLevelZeroMemoryProviderOps;
         umfMemoryTrackerGetAllocInfo;
         umfMemoryProviderAlloc;
         umfMemoryProviderAllocationMerge;
@@ -35,14 +34,8 @@ UMF_1.0 {
         umfMempolicyDestroy;
         umfMempolicySetCustomSplitPartitions;
         umfMempolicySetInterleavePartSize;
-        umfMemspaceCreateFromNumaArray;
         umfMemspaceDestroy;
-        umfMemspaceHighestBandwidthGet;
-        umfMemspaceHighestCapacityGet;
-        umfMemspaceHostAllGet;
-        umfMemspaceLowestLatencyGet;
         umfOpenIPCHandle;
-        umfOsMemoryProviderOps;
         umfPoolAlignedMalloc;
         umfPoolByPtr;
         umfPoolCalloc;
@@ -59,6 +52,7 @@ UMF_1.0 {
         umfProxyPoolOps;
         umfPutIPCHandle;
         umfScalablePoolOps;
+        @UMF_OPTIONAL_SYMBOLS_LINUX@
     local:
         *;
 };

src/libumf.map renamed to src/libumf.map.in

@@ -146,7 +146,8 @@ def _create_match_list(self) -> List[str]:
         examples.insert(0, "share/doc/umf/examples")
         share.extend(examples)
         share.append("share/doc/umf/LICENSE.TXT")
-        share.append("share/doc/umf/third-party-programs.txt")
+        share.append("share/doc/umf/licensing")
+        share.append("share/doc/umf/licensing/third-party-programs.txt")
 
         all_files = bin + include + lib + share
         if platform.system() == "Windows":