Allow mimalloc in static builds (KhronosGroup#6267)

Allow users to explicitly request that mimalloc be used in static
builds.

Author: jeremy-lunarg

README.md

@@ -317,9 +317,7 @@ Effcee itself depends on [RE2][re2], and RE2 depends on [Abseil][abseil-cpp].
 #### Dependency on mimalloc
 
 SPIRV-Tools may be configured to use the [mimalloc][mimalloc] library to improve memory
-allocation performance. In order to avoid unexpectedly changing allocation behavior of
-applications that link SPIRV-Tools libraries statically, this option has no effect on
-the static libraries.
+allocation performance.
 
 In the CMake build, usage of mimalloc is controlled by the `SPIRV_TOOLS_USE_MIMALLOC`
 option. This variable defaults on `ON` when building for Windows and `OFF` when building
@@ -328,6 +326,11 @@ expected to work normally, but this has not been tested as thoroughly and extens
 the Windows version. In the future, the `SPIRV_TOOLS_USE_MIMALLOC` option may default to
 `ON` for non-Windows platforms as well.
 
+In order to avoid unexpectedly changing allocation behavior of applications that link
+SPIRV-Tools libraries statically, mimalloc is disabled by default on static libraries.
+The option 'SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD' can be used to force the usage of
+mimalloc on static libraries.
+
 *Note*: mimalloc is currently only supported when building with CMake. When using Bazel,
 mimalloc is not used.
 

external/CMakeLists.txt

@@ -38,17 +38,23 @@ endif()
 # Used on Windows by default, but allow opt-in on other platforms
 if (WIN32)
   set(SPIRV_TOOLS_USE_MIMALLOC_DEFAULT_VALUE ON)
+  set(SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD_DEFAULT_VALUE OFF)
 else()
   set(SPIRV_TOOLS_USE_MIMALLOC_DEFAULT_VALUE OFF)
+  set(SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD_DEFAULT_VALUE OFF)
 endif()
 
 # To avoid unexpected side effects on users of the static library, mimalloc
-# may only be used when building executables and shared libraries.
+# must be explicitly enabled when building static libraries.
 include(CMakeDependentOption)
 cmake_dependent_option(SPIRV_TOOLS_USE_MIMALLOC
   "Executables and shared libraries use mimalloc instead of the default allocator"
   ${SPIRV_TOOLS_USE_MIMALLOC_DEFAULT_VALUE} "MIMALLOC_DIR" OFF)
 
+cmake_dependent_option(SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD
+  "Static libraries use mimalloc instead of the default allocator"
+  ${SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD_DEFAULT_VALUE} SPIRV_TOOLS_USE_MIMALLOC OFF)
+
 if (SPIRV_TOOLS_USE_MIMALLOC)
   if (NOT WIN32)
     push_variable(MI_OVERRIDE 0)

source/CMakeLists.txt

@@ -351,6 +351,9 @@ target_compile_definitions(${SPIRV_TOOLS}-shared
 
 if(SPIRV_TOOLS_BUILD_STATIC)
   add_library(${SPIRV_TOOLS}-static STATIC ${SPIRV_SOURCES})
+  if (SPIRV_TOOLS_USE_MIMALLOC AND SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD)
+    target_link_libraries(${SPIRV_TOOLS}-shared PRIVATE mimalloc-static)
+  endif()
   spirv_tools_default_target_options(${SPIRV_TOOLS}-static)
   # The static target does not have the '-static' suffix.
   set_target_properties(${SPIRV_TOOLS}-static PROPERTIES OUTPUT_NAME "${SPIRV_TOOLS}")
@@ -383,7 +386,7 @@ if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
 endif()
 
 if(ENABLE_SPIRV_TOOLS_INSTALL)
-  if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+  if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
     list(APPEND SPIRV_TOOLS_TARGETS mimalloc-static)
   endif()
   install(TARGETS ${SPIRV_TOOLS_TARGETS} EXPORT ${SPIRV_TOOLS}Targets)

source/diff/CMakeLists.txt

@@ -18,13 +18,13 @@ set(SPIRV_TOOLS_DIFF_SOURCES
   diff.cpp
 )
 
-if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
   list(APPEND SPIRV_TOOLS_DIFF_SOURCES ${spirv-tools_SOURCE_DIR}/source/mimalloc.cpp)
 endif()
 
 add_library(SPIRV-Tools-diff ${SPIRV_TOOLS_LIBRARY_TYPE} ${SPIRV_TOOLS_DIFF_SOURCES})
 
-if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
   target_link_libraries(SPIRV-Tools-diff PRIVATE mimalloc-static)
 endif()
 
@@ -49,7 +49,7 @@ spvtools_check_symbol_exports(SPIRV-Tools-diff)
 if(ENABLE_SPIRV_TOOLS_INSTALL)
   set(SPIRV-Tools-diff-InstallTargets SPIRV-Tools-diff)
 
-  if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+  if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
     list(APPEND SPIRV-Tools-diff-InstallTargets mimalloc-static)
   endif()
 

source/fuzz/CMakeLists.txt

@@ -438,13 +438,13 @@ if(SPIRV_BUILD_FUZZER)
 
   spvtools_pch(SPIRV_TOOLS_FUZZ_SOURCES pch_source_fuzz)
 
-  if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+  if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
     list(APPEND SPIRV_TOOLS_DIFF_SOURCES ${spirv-tools_SOURCE_DIR}/source/mimalloc.cpp)
   endif()
 
   add_library(SPIRV-Tools-fuzz ${SPIRV_TOOLS_FUZZ_SOURCES})
 
-  if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+  if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
     target_link_libraries(SPIRV-Tools-fuzz PRIVATE mimalloc-static)
   endif()
 
@@ -480,7 +480,7 @@ if(SPIRV_BUILD_FUZZER)
   if(ENABLE_SPIRV_TOOLS_INSTALL)
       set(SPIRV-Tools-fuzz-InstallTargets SPIRV-Tools-fuzz)
 
-      if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+      if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
         list(APPEND SPIRV-Tools-fuzz-InstallTargets mimalloc-static)
       endif()
 

source/opt/CMakeLists.txt

@@ -262,13 +262,13 @@ endif()
 
 spvtools_pch(SPIRV_TOOLS_OPT_SOURCES pch_source_opt)
 
-if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
   list(APPEND SPIRV_TOOLS_OPT_SOURCES ${spirv-tools_SOURCE_DIR}/source/mimalloc.cpp)
 endif()
 
 add_library(SPIRV-Tools-opt ${SPIRV_TOOLS_LIBRARY_TYPE} ${SPIRV_TOOLS_OPT_SOURCES})
 
-if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
   target_link_libraries(SPIRV-Tools-opt PRIVATE mimalloc-static)
 endif()
 
@@ -290,7 +290,7 @@ spvtools_check_symbol_exports(SPIRV-Tools-opt)
 if(ENABLE_SPIRV_TOOLS_INSTALL)
   set(SPIRV-Tools-opt-InstallTargets SPIRV-Tools-opt)
 
-  if (SPIRV_TOOLS_USE_MIMALLOC AND NOT SPIRV_TOOLS_BUILD_STATIC)
+  if (SPIRV_TOOLS_USE_MIMALLOC AND (NOT SPIRV_TOOLS_BUILD_STATIC OR SPIRV_TOOLS_USE_MIMALLOC_IN_STATIC_BUILD))
     list(APPEND SPIRV-Tools-opt-InstallTargets mimalloc-static)
   endif()