403 lines
15 KiB
CMake
403 lines
15 KiB
CMake
cmake_minimum_required(VERSION 3.13)
|
|
|
|
option(MI_SECURE "Use full security mitigations (like guard pages, allocation randomization, double-free mitigation, and free-list corruption detection)" OFF)
|
|
option(MI_DEBUG_FULL "Use full internal heap invariant checking in DEBUG mode (expensive)" OFF)
|
|
option(MI_PADDING "Enable padding to detect heap block overflow (always on in DEBUG or SECURE mode, or with Valgrind/ASAN)" OFF)
|
|
option(MI_OVERRIDE "Override the standard malloc interface (e.g. define entry points for malloc() etc)" ON)
|
|
option(MI_XMALLOC "Enable abort() call on memory allocation failure by default" OFF)
|
|
option(MI_SHOW_ERRORS "Show error and warning messages by default (only enabled by default in DEBUG mode)" OFF)
|
|
option(MI_TRACK_VALGRIND "Compile with Valgrind support (adds a small overhead)" OFF)
|
|
option(MI_TRACK_ASAN "Compile with address sanitizer support (adds a small overhead)" OFF)
|
|
option(MI_TRACK_ETW "Compile with Windows event tracing (ETW) support (adds a small overhead)" OFF)
|
|
option(MI_USE_CXX "Use the C++ compiler to compile the library (instead of the C compiler)" OFF)
|
|
option(MI_SEE_ASM "Generate assembly files" OFF)
|
|
option(MI_WIN_REDIRECT "Use redirection module ('mimalloc-redirect') on Windows if compiling mimalloc as a DLL" ON)
|
|
option(MI_LOCAL_DYNAMIC_TLS "Use slightly slower, dlopen-compatible TLS mechanism (Unix)" OFF)
|
|
option(MI_BUILD_STATIC "Build static library" ON)
|
|
option(MI_BUILD_OBJECT "Build object library" ON)
|
|
option(MI_DEBUG_TSAN "Build with thread sanitizer (needs clang)" OFF)
|
|
option(MI_DEBUG_UBSAN "Build with undefined-behavior sanitizer (needs clang++)" OFF)
|
|
option(MI_SKIP_COLLECT_ON_EXIT "Skip collecting memory on program exit" OFF)
|
|
option(MI_NO_PADDING "Force no use of padding even in DEBUG mode etc." OFF)
|
|
|
|
include(CheckIncludeFiles)
|
|
include(GNUInstallDirs)
|
|
|
|
set(mi_sources
|
|
src/alloc.c
|
|
src/alloc-aligned.c
|
|
src/alloc-posix.c
|
|
src/arena.c
|
|
src/bitmap.c
|
|
src/heap.c
|
|
src/init.c
|
|
src/options.c
|
|
src/os.c
|
|
src/page.c
|
|
src/random.c
|
|
src/segment.c
|
|
src/segment-map.c
|
|
src/stats.c
|
|
src/prim/prim.c)
|
|
|
|
set(mi_cflags "")
|
|
set(mi_libraries "")
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Convenience: set default build type depending on the build directory
|
|
# -----------------------------------------------------------------------------
|
|
|
|
message(STATUS "")
|
|
if (NOT CMAKE_BUILD_TYPE)
|
|
if ("${CMAKE_BINARY_DIR}" MATCHES ".*(D|d)ebug$" OR MI_DEBUG_FULL)
|
|
message(STATUS "No build type selected, default to: Debug")
|
|
set(CMAKE_BUILD_TYPE "Debug")
|
|
else()
|
|
message(STATUS "No build type selected, default to: Release")
|
|
set(CMAKE_BUILD_TYPE "Release")
|
|
endif()
|
|
endif()
|
|
|
|
if("${CMAKE_BINARY_DIR}" MATCHES ".*(S|s)ecure$")
|
|
message(STATUS "Default to secure build")
|
|
set(MI_SECURE "ON")
|
|
endif()
|
|
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Process options
|
|
# -----------------------------------------------------------------------------
|
|
|
|
if(CMAKE_C_COMPILER_ID MATCHES "MSVC|Intel")
|
|
set(MI_USE_CXX "ON")
|
|
endif()
|
|
|
|
if(MI_OVERRIDE)
|
|
message(STATUS "Override standard malloc (MI_OVERRIDE=ON)")
|
|
endif()
|
|
|
|
if(WIN32)
|
|
if (MI_WIN_REDIRECT)
|
|
if (MSVC_C_ARCHITECTURE_ID MATCHES "ARM")
|
|
message(STATUS "Cannot use redirection on Windows ARM (MI_WIN_REDIRECT=OFF)")
|
|
set(MI_WIN_REDIRECT OFF)
|
|
endif()
|
|
endif()
|
|
if (NOT MI_WIN_REDIRECT)
|
|
# use a negative define for backward compatibility
|
|
list(APPEND mi_defines MI_WIN_NOREDIRECT=1)
|
|
endif()
|
|
endif()
|
|
|
|
if(MI_SECURE)
|
|
message(STATUS "Set full secure build (MI_SECURE=ON)")
|
|
list(APPEND mi_defines MI_SECURE=4)
|
|
endif()
|
|
|
|
if(MI_TRACK_VALGRIND)
|
|
CHECK_INCLUDE_FILES("valgrind/valgrind.h;valgrind/memcheck.h" MI_HAS_VALGRINDH)
|
|
if (NOT MI_HAS_VALGRINDH)
|
|
set(MI_TRACK_VALGRIND OFF)
|
|
message(WARNING "Cannot find the 'valgrind/valgrind.h' and 'valgrind/memcheck.h' -- install valgrind first")
|
|
message(STATUS "Compile **without** Valgrind support (MI_TRACK_VALGRIND=OFF)")
|
|
else()
|
|
message(STATUS "Compile with Valgrind support (MI_TRACK_VALGRIND=ON)")
|
|
list(APPEND mi_defines MI_TRACK_VALGRIND=1)
|
|
endif()
|
|
endif()
|
|
|
|
if(MI_TRACK_ASAN)
|
|
if (APPLE AND MI_OVERRIDE)
|
|
set(MI_TRACK_ASAN OFF)
|
|
message(WARNING "Cannot enable address sanitizer support on macOS if MI_OVERRIDE is ON (MI_TRACK_ASAN=OFF)")
|
|
endif()
|
|
if (MI_TRACK_VALGRIND)
|
|
set(MI_TRACK_ASAN OFF)
|
|
message(WARNING "Cannot enable address sanitizer support with also Valgrind support enabled (MI_TRACK_ASAN=OFF)")
|
|
endif()
|
|
if(MI_TRACK_ASAN)
|
|
CHECK_INCLUDE_FILES("sanitizer/asan_interface.h" MI_HAS_ASANH)
|
|
if (NOT MI_HAS_ASANH)
|
|
set(MI_TRACK_ASAN OFF)
|
|
message(WARNING "Cannot find the 'sanitizer/asan_interface.h' -- install address sanitizer support first")
|
|
message(STATUS "Compile **without** address sanitizer support (MI_TRACK_ASAN=OFF)")
|
|
else()
|
|
message(STATUS "Compile with address sanitizer support (MI_TRACK_ASAN=ON)")
|
|
list(APPEND mi_defines MI_TRACK_ASAN=1)
|
|
list(APPEND mi_cflags -fsanitize=address)
|
|
list(APPEND mi_libraries -fsanitize=address)
|
|
endif()
|
|
endif()
|
|
endif()
|
|
|
|
if(MI_TRACK_ETW)
|
|
if(NOT WIN32)
|
|
set(MI_TRACK_ETW OFF)
|
|
message(WARNING "Can only enable ETW support on Windows (MI_TRACK_ETW=OFF)")
|
|
endif()
|
|
if (MI_TRACK_VALGRIND OR MI_TRACK_ASAN)
|
|
set(MI_TRACK_ETW OFF)
|
|
message(WARNING "Cannot enable ETW support with also Valgrind or ASAN support enabled (MI_TRACK_ETW=OFF)")
|
|
endif()
|
|
if(MI_TRACK_ETW)
|
|
message(STATUS "Compile with Windows event tracing support (MI_TRACK_ETW=ON)")
|
|
list(APPEND mi_defines MI_TRACK_ETW=1)
|
|
endif()
|
|
endif()
|
|
|
|
if(MI_SEE_ASM)
|
|
message(STATUS "Generate assembly listings (MI_SEE_ASM=ON)")
|
|
list(APPEND mi_cflags -save-temps)
|
|
endif()
|
|
|
|
if(MI_CHECK_FULL)
|
|
message(STATUS "The MI_CHECK_FULL option is deprecated, use MI_DEBUG_FULL instead")
|
|
set(MI_DEBUG_FULL "ON")
|
|
endif()
|
|
|
|
if (MI_SKIP_COLLECT_ON_EXIT)
|
|
message(STATUS "Skip collecting memory on program exit (MI_SKIP_COLLECT_ON_EXIT=ON)")
|
|
list(APPEND mi_defines MI_SKIP_COLLECT_ON_EXIT=1)
|
|
endif()
|
|
|
|
if(MI_DEBUG_FULL)
|
|
message(STATUS "Set debug level to full internal invariant checking (MI_DEBUG_FULL=ON)")
|
|
list(APPEND mi_defines MI_DEBUG=3) # full invariant checking
|
|
endif()
|
|
|
|
if(MI_NO_PADDING)
|
|
message(STATUS "Suppress any padding of heap blocks (MI_NO_PADDING=ON)")
|
|
list(APPEND mi_defines MI_PADDING=0)
|
|
else()
|
|
if(MI_PADDING)
|
|
message(STATUS "Enable explicit padding of heap blocks (MI_PADDING=ON)")
|
|
list(APPEND mi_defines MI_PADDING=1)
|
|
endif()
|
|
endif()
|
|
|
|
if(MI_XMALLOC)
|
|
message(STATUS "Enable abort() calls on memory allocation failure (MI_XMALLOC=ON)")
|
|
list(APPEND mi_defines MI_XMALLOC=1)
|
|
endif()
|
|
|
|
if(MI_SHOW_ERRORS)
|
|
message(STATUS "Enable printing of error and warning messages by default (MI_SHOW_ERRORS=ON)")
|
|
list(APPEND mi_defines MI_SHOW_ERRORS=1)
|
|
endif()
|
|
|
|
if(MI_DEBUG_TSAN)
|
|
if(CMAKE_C_COMPILER_ID MATCHES "Clang")
|
|
message(STATUS "Build with thread sanitizer (MI_DEBUG_TSAN=ON)")
|
|
list(APPEND mi_defines MI_TSAN=1)
|
|
list(APPEND mi_cflags -fsanitize=thread -g -O1)
|
|
list(APPEND mi_libraries -fsanitize=thread)
|
|
else()
|
|
message(WARNING "Can only use thread sanitizer with clang (MI_DEBUG_TSAN=ON but ignored)")
|
|
endif()
|
|
endif()
|
|
|
|
if(MI_DEBUG_UBSAN)
|
|
if(CMAKE_BUILD_TYPE MATCHES "Debug")
|
|
if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
|
|
message(STATUS "Build with undefined-behavior sanitizer (MI_DEBUG_UBSAN=ON)")
|
|
list(APPEND mi_cflags -fsanitize=undefined -g -fno-sanitize-recover=undefined)
|
|
list(APPEND mi_libraries -fsanitize=undefined)
|
|
if (NOT MI_USE_CXX)
|
|
message(STATUS "(switch to use C++ due to MI_DEBUG_UBSAN)")
|
|
set(MI_USE_CXX "ON")
|
|
endif()
|
|
else()
|
|
message(WARNING "Can only use undefined-behavior sanitizer with clang++ (MI_DEBUG_UBSAN=ON but ignored)")
|
|
endif()
|
|
else()
|
|
message(WARNING "Can only use thread sanitizer with a debug build (CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE})")
|
|
endif()
|
|
endif()
|
|
|
|
if(MI_USE_CXX)
|
|
message(STATUS "Use the C++ compiler to compile (MI_USE_CXX=ON)")
|
|
set_source_files_properties(${mi_sources} PROPERTIES LANGUAGE CXX )
|
|
set_source_files_properties(src/static.c test/test-api.c test/test-api-fill test/test-stress PROPERTIES LANGUAGE CXX )
|
|
if(CMAKE_CXX_COMPILER_ID MATCHES "AppleClang|Clang")
|
|
list(APPEND mi_cflags -Wno-deprecated)
|
|
endif()
|
|
if(CMAKE_CXX_COMPILER_ID MATCHES "Intel" AND NOT CMAKE_CXX_COMPILER_ID MATCHES "IntelLLVM")
|
|
list(APPEND mi_cflags -Kc++)
|
|
endif()
|
|
endif()
|
|
|
|
if(CMAKE_SYSTEM_NAME MATCHES "Haiku")
|
|
SET(CMAKE_INSTALL_LIBDIR ~/config/non-packaged/lib)
|
|
SET(CMAKE_INSTALL_INCLUDEDIR ~/config/non-packaged/headers)
|
|
endif()
|
|
|
|
# Compiler flags
|
|
if(CMAKE_C_COMPILER_ID MATCHES "AppleClang|Clang|GNU")
|
|
list(APPEND mi_cflags -Wall -Wextra -Wno-unknown-pragmas -fvisibility=hidden)
|
|
if(NOT MI_USE_CXX)
|
|
list(APPEND mi_cflags -Wstrict-prototypes)
|
|
endif()
|
|
if(CMAKE_C_COMPILER_ID MATCHES "AppleClang|Clang")
|
|
list(APPEND mi_cflags -Wpedantic -Wno-static-in-inline)
|
|
endif()
|
|
endif()
|
|
|
|
if(CMAKE_C_COMPILER_ID MATCHES "Intel")
|
|
list(APPEND mi_cflags -Wall -fvisibility=hidden)
|
|
endif()
|
|
|
|
if(CMAKE_C_COMPILER_ID MATCHES "AppleClang|Clang|GNU|Intel" AND NOT CMAKE_SYSTEM_NAME MATCHES "Haiku")
|
|
if(MI_LOCAL_DYNAMIC_TLS)
|
|
list(APPEND mi_cflags -ftls-model=local-dynamic)
|
|
else()
|
|
list(APPEND mi_cflags -ftls-model=initial-exec)
|
|
endif()
|
|
if(MI_OVERRIDE)
|
|
list(APPEND mi_cflags -fno-builtin-malloc)
|
|
endif()
|
|
endif()
|
|
|
|
if (MSVC AND MSVC_VERSION GREATER_EQUAL 1914)
|
|
list(APPEND mi_cflags /Zc:__cplusplus)
|
|
endif()
|
|
|
|
# extra needed libraries
|
|
if(WIN32)
|
|
list(APPEND mi_libraries psapi shell32 user32 advapi32 bcrypt)
|
|
set(pc_libraries "-lpsapi -lshell32 -luser32 -ladvapi32 -lbcrypt")
|
|
else()
|
|
set(pc_libraries "")
|
|
find_library(MI_LIBPTHREAD pthread)
|
|
if (MI_LIBPTHREAD)
|
|
list(APPEND mi_libraries ${MI_LIBPTHREAD})
|
|
set(pc_libraries "${pc_libraries} -pthread")
|
|
endif()
|
|
find_library(MI_LIBRT rt)
|
|
if(MI_LIBRT)
|
|
list(APPEND mi_libraries ${MI_LIBRT})
|
|
set(pc_libraries "${pc_libraries} -lrt")
|
|
endif()
|
|
find_library(MI_LIBATOMIC atomic)
|
|
if (NOT MI_LIBATOMIC AND MI_USE_LIBATOMIC)
|
|
set(MI_LIBATOMIC atomic)
|
|
endif()
|
|
if (MI_LIBATOMIC)
|
|
list(APPEND mi_libraries ${MI_LIBATOMIC})
|
|
set(pc_libraries "${pc_libraries} -latomic")
|
|
endif()
|
|
endif()
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Install and output names
|
|
# -----------------------------------------------------------------------------
|
|
|
|
# dynamic/shared library and symlinks always go to /usr/local/lib equivalent
|
|
set(mi_install_libdir "${CMAKE_INSTALL_LIBDIR}")
|
|
|
|
# static libraries and object files, includes, and cmake config files
|
|
# are either installed at top level, or use versioned directories for side-by-side installation (default)
|
|
if (MI_INSTALL_TOPLEVEL)
|
|
set(mi_install_objdir "${CMAKE_INSTALL_LIBDIR}")
|
|
set(mi_install_incdir "${CMAKE_INSTALL_INCLUDEDIR}")
|
|
set(mi_install_cmakedir "${CMAKE_INSTALL_LIBDIR}/cmake/mimalloc")
|
|
else()
|
|
set(mi_install_objdir "${CMAKE_INSTALL_LIBDIR}/mimalloc-${mi_version}") # for static library and object files
|
|
set(mi_install_incdir "${CMAKE_INSTALL_INCLUDEDIR}/mimalloc-${mi_version}") # for includes
|
|
set(mi_install_cmakedir "${CMAKE_INSTALL_LIBDIR}/cmake/mimalloc-${mi_version}") # for cmake package info
|
|
endif()
|
|
|
|
set(mi_basename "mimalloc")
|
|
if(MI_SECURE)
|
|
set(mi_basename "${mi_basename}-secure")
|
|
endif()
|
|
if(MI_TRACK_VALGRIND)
|
|
set(mi_basename "${mi_basename}-valgrind")
|
|
endif()
|
|
if(MI_TRACK_ASAN)
|
|
set(mi_basename "${mi_basename}-asan")
|
|
endif()
|
|
|
|
if(MI_BUILD_STATIC)
|
|
list(APPEND mi_build_targets "static")
|
|
endif()
|
|
if(MI_BUILD_OBJECT)
|
|
list(APPEND mi_build_targets "object")
|
|
endif()
|
|
|
|
message(STATUS "")
|
|
message(STATUS "Library base name: ${mi_basename}")
|
|
message(STATUS "Version : ${mi_version}")
|
|
if(MI_USE_CXX)
|
|
message(STATUS "C++ Compiler : ${CMAKE_CXX_COMPILER}")
|
|
else()
|
|
message(STATUS "C Compiler : ${CMAKE_C_COMPILER}")
|
|
endif()
|
|
message(STATUS "Compiler flags : ${mi_cflags}")
|
|
message(STATUS "Compiler defines : ${mi_defines}")
|
|
message(STATUS "Link libraries : ${mi_libraries}")
|
|
message(STATUS "Build targets : ${mi_build_targets}")
|
|
message(STATUS "")
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Main targets
|
|
# -----------------------------------------------------------------------------
|
|
|
|
# static library
|
|
if (MI_BUILD_STATIC)
|
|
add_library(mimalloc-static STATIC ${mi_sources})
|
|
set_property(TARGET mimalloc-static PROPERTY POSITION_INDEPENDENT_CODE ON)
|
|
target_compile_definitions(mimalloc-static PRIVATE ${mi_defines} MI_STATIC_LIB)
|
|
target_compile_options(mimalloc-static PRIVATE ${mi_cflags})
|
|
target_link_libraries(mimalloc-static PRIVATE ${mi_libraries})
|
|
target_include_directories(mimalloc-static PUBLIC
|
|
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
|
|
$<INSTALL_INTERFACE:${mi_install_incdir}>
|
|
)
|
|
if(WIN32)
|
|
# When building both static and shared libraries on Windows, a static library should use a
|
|
# different output name to avoid the conflict with the import library of a shared one.
|
|
string(REPLACE "mimalloc" "mimalloc-static" mi_output_name ${mi_basename})
|
|
set_target_properties(mimalloc-static PROPERTIES OUTPUT_NAME ${mi_output_name})
|
|
else()
|
|
set_target_properties(mimalloc-static PROPERTIES OUTPUT_NAME ${mi_basename})
|
|
endif()
|
|
|
|
endif()
|
|
|
|
|
|
# single object file for more predictable static overriding
|
|
if (MI_BUILD_OBJECT)
|
|
add_library(mimalloc-obj OBJECT src/static.c)
|
|
set_property(TARGET mimalloc-obj PROPERTY POSITION_INDEPENDENT_CODE ON)
|
|
target_compile_definitions(mimalloc-obj PRIVATE ${mi_defines})
|
|
target_compile_options(mimalloc-obj PRIVATE ${mi_cflags})
|
|
target_include_directories(mimalloc-obj PUBLIC
|
|
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
|
|
$<INSTALL_INTERFACE:${mi_install_incdir}>
|
|
)
|
|
|
|
# Copy the generated object file (`static.o`) to the output directory (as `mimalloc.o`)
|
|
if(NOT WIN32)
|
|
set(mimalloc-obj-static "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/mimalloc-obj.dir/src/static.c${CMAKE_C_OUTPUT_EXTENSION}")
|
|
set(mimalloc-obj-out "${CMAKE_CURRENT_BINARY_DIR}/${mi_basename}${CMAKE_C_OUTPUT_EXTENSION}")
|
|
add_custom_command(OUTPUT ${mimalloc-obj-out} DEPENDS mimalloc-obj COMMAND "${CMAKE_COMMAND}" -E copy "${mimalloc-obj-static}" "${mimalloc-obj-out}")
|
|
add_custom_target(mimalloc-obj-target ALL DEPENDS ${mimalloc-obj-out})
|
|
endif()
|
|
|
|
endif()
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Set override properties
|
|
# -----------------------------------------------------------------------------
|
|
if (MI_OVERRIDE)
|
|
if(NOT WIN32)
|
|
# It is only possible to override malloc on Windows when building as a DLL.
|
|
if (MI_BUILD_STATIC)
|
|
target_compile_definitions(mimalloc-static PRIVATE MI_MALLOC_OVERRIDE)
|
|
endif()
|
|
if (MI_BUILD_OBJECT)
|
|
target_compile_definitions(mimalloc-obj PRIVATE MI_MALLOC_OVERRIDE)
|
|
endif()
|
|
endif()
|
|
endif()
|