Merge pull request #1262 from microsoft/dev-main

update main to v2.3.0

Author: daanx

.github/workflows/release.yaml

@@ -0,0 +1,55 @@
+on:
+  workflow_dispatch:   # run the workflow manually 
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true # Cancel any in-progress runs of this workflow when a new run is triggered on the same ref (branch or tag)
+
+permissions:
+  contents: write
+
+env:
+  RELEASE: Release v3.3.0
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+  
+name: Release
+jobs:
+  build:
+    name: Bundle
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        branch: [v1.9.8,v2.3.0,v3.3.0]  # [dev,dev2,dev3]
+        # we build on the oldest ubuntu version for better binary compatibility.
+        os: [windows-latest, macOS-latest, macos-15-intel, ubuntu-22.04, ubuntu-22.04-arm]  
+
+    steps:
+      # Checkout: https://github.com/actions/checkout
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ matrix.branch }}
+          fetch-tags: true
+          fetch-depth: 0
+
+      # Build
+      - name: Build (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          ./bin/bundle.bat
+
+      - name: Build (Linux, macOS)
+        if: runner.os != 'Windows'
+        run: |
+          ./bin/bundle.sh
+                
+      # Create a release: https://github.com/softprops/action-gh-release (MIT license)
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        if: ${{ env.RELEASE != '' && env.RELEASE != 'no' }} 
+        with:
+          name: ${{ env.RELEASE }}
+          draft: true
+          body_path: doc/release-notes.md
+          files: |
+            out/bundle/*.tar.gz            

.github/workflows/test.yaml

@@ -0,0 +1,163 @@
+on:
+  workflow_dispatch:   # allow running the workflow manually 
+  push:
+    branches:
+      - 'dev*'
+    tags:
+      - 'v*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true # Cancel any in-progress runs of this workflow when a new run is triggered on the same ref (branch or tag)
+  
+name: Test
+jobs:
+  build:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        tests: [basic,extra]
+        os: [windows-latest, macos-latest, ubuntu-latest, macos-14, macos-15-intel, ubuntu-22.04-arm, windows-11-arm]
+        exclude:
+          - os: macos-14
+            tests: extra          
+        
+    steps:
+      # Checkout: https://github.com/actions/checkout
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      # Basic
+      - name: Debug
+        if: matrix.tests == 'basic'
+        run: |
+          cmake . -B out/debug -DCMAKE_BUILD_TYPE=Debug -DMI_DEBUG_FULL=ON
+          cmake --build out/debug --parallel 4 --config Debug
+          ctest --test-dir out/debug --verbose --timeout 240 -C Debug
+
+      - name: Release
+        if: matrix.tests == 'basic'
+        run: |
+          cmake . -B out/release -DCMAKE_BUILD_TYPE=Release -DMI_OPT_ARCH=ON
+          cmake --build out/release --parallel 4 --config Release
+          ctest --test-dir out/release --verbose --timeout 240 -C Release
+
+      - name: Secure
+        if: matrix.tests == 'basic'
+        run: |
+          cmake . -B out/secure -DCMAKE_BUILD_TYPE=Release -DMI_SECURE=ON
+          cmake --build out/secure --parallel 4 --config Release
+          ctest --test-dir out/secure --verbose --timeout 240 -C Release
+
+      # Basic, C++
+      - name: Debug, C++
+        if: matrix.tests == 'basic' && runner.os != 'Windows'   # windows already uses C++ by default
+        run: |
+          cmake . -B out/debug-cxx -DCMAKE_BUILD_TYPE=Debug -DMI_DEBUG_FULL=ON -DMI_USE_CXX=ON
+          cmake --build out/debug-cxx --parallel 8 --config Debug
+          ctest --test-dir out/debug-cxx --verbose --timeout 240 -C Debug
+
+      - name: Release, C++
+        if: matrix.tests == 'basic' && runner.os == 'Linux'      # windows already uses C++ by default; macOS interpose does not work well with C++
+        run: |
+          cmake . -B out/release-cxx -DCMAKE_BUILD_TYPE=Release -DMI_OPT_ARCH=ON -DMI_USE_CXX=ON
+          cmake --build out/release-cxx --parallel 8 --config Release
+          ctest --test-dir out/release-cxx --verbose --timeout 240 -C Release
+
+      # Extra, Windows x86
+      - name: Debug, Win32
+        if: matrix.tests == 'extra' && runner.os == 'Windows' && !endsWith(matrix.os,'arm')
+        run: |
+          cmake . -B out/debug-x86 -DCMAKE_BUILD_TYPE=Debug -A Win32
+          cmake --build out/debug-x86 --parallel 4 --config Debug
+          ctest --test-dir out/debug-x86 --verbose --timeout 240 -C Debug
+
+      - name: Release, Win32
+        if: matrix.tests == 'extra' && runner.os == 'Windows' && !endsWith(matrix.os,'arm')
+        run: |
+          cmake . -B out/release-x86 -DCMAKE_BUILD_TYPE=Release -A Win32
+          cmake --build out/release-x86 --parallel 4 --config Release
+          ctest --test-dir out/release-x86 --verbose --timeout 240 -C Release
+
+      - name: Debug, clang-cl
+        if: matrix.tests == 'extra' && runner.os == 'Windows' && !endsWith(matrix.os,'arm')
+        run: |
+          cmake . -B out/debug-clang -DCMAKE_BUILD_TYPE=Debug -A Win32 -T ClangCl
+          cmake --build out/debug-clang --parallel 4 --config Debug
+          ctest --test-dir out/debug-clang --verbose --timeout 240 -C Debug
+
+      - name: Release, clang-cl
+        if: matrix.tests == 'extra' && runner.os == 'Windows' && !endsWith(matrix.os,'arm')
+        run: |
+          cmake . -B out/release-clang -DCMAKE_BUILD_TYPE=Release -A Win32 -T ClangCl
+          cmake --build out/release-clang --parallel 4 --config Release
+          ctest --test-dir out/release-clang --verbose --timeout 240 -C Release          
+
+      # Extra
+      - name: Release, SIMD
+        if: matrix.tests == 'extra'
+        run: |
+          cmake . -B out/release-simd -DCMAKE_BUILD_TYPE=Release -DMI_OPT_ARCH=ON -DMI_OPT_SIMD=ON
+          cmake --build out/release-simd --parallel 8 --config Release
+          ctest --test-dir out/release-simd --verbose --timeout 240 -C Release
+
+      - name: Release, C++, SIMD
+        if: matrix.tests == 'basic' && runner.os != 'Windows' && runner.os != 'macOS'
+        run: |
+          cmake . -B out/release-cxx -DCMAKE_BUILD_TYPE=Release -DMI_OPT_ARCH=ON -DMI_OPT_SIMD=ON -DMI_USE_CXX=ON
+          cmake --build out/release-cxx --parallel 8 --config Release
+          ctest --test-dir out/release-cxx --verbose --timeout 240 -C Release
+
+      - name: Debug, C++, clang++
+        if: matrix.tests == 'extra' && runner.os == 'Linux'
+        run: |
+          CC=clang CXX=clang++ cmake . -B out/debug-clang-cxx -DCMAKE_BUILD_TYPE=Debug -DMI_DEBUG_FULL=ON -DMI_USE_CXX=ON
+          cmake --build out/debug-clang-cxx --parallel 8 --config Debug
+          ctest --test-dir out/debug-clang-cxx --verbose --timeout 240 -C Debug
+
+      - name: Release, C++, clang++
+        if: matrix.tests == 'extra' && runner.os == 'Linux'
+        run: |
+          CC=clang CXX=clang++ cmake . -B out/release-clang-cxx -DCMAKE_BUILD_TYPE=Release -DMI_OPT_ARCH=ON -DMI_USE_CXX=ON
+          cmake --build out/release-clang-cxx --parallel 8 --config Release
+          ctest --test-dir out/release-clang-cxx --verbose --timeout 240 -C Release
+
+      - name: Debug, ASAN
+        if: matrix.tests == 'extra' && runner.os == 'Linux'
+        run: |
+          CC=clang CXX=clang++ cmake . -B out/debug-asan -DCMAKE_BUILD_TYPE=Debug -DMI_DEBUG_FULL=ON -DMI_TRACK_ASAN=ON
+          cmake --build out/debug-asan --parallel 8 --config Debug
+          ctest --test-dir out/debug-asan --verbose --timeout 240 -C Debug
+
+      - name: Debug, UBSAN
+        if: matrix.tests == 'extra' && runner.os == 'Linux'
+        run: |
+          CC=clang CXX=clang++ cmake . -B out/debug-ubsan -DCMAKE_BUILD_TYPE=Debug -DMI_DEBUG_FULL=ON -DMI_DEBUG_UBSAN=ON
+          cmake --build out/debug-ubsan --parallel 8 --config Debug
+          ctest --test-dir out/debug-ubsan --verbose --timeout 240 -C Debug
+
+      - name: Debug, TSAN
+        if: matrix.tests == 'extra' && runner.os == 'Linux'
+        run: |
+          CC=clang CXX=clang++ cmake . -B out/debug-tsan -DCMAKE_BUILD_TYPE=Debug -DMI_DEBUG_FULL=ON -DMI_DEBUG_TSAN=ON
+          cmake --build out/debug-tsan --parallel 8 --config Debug
+          ctest --test-dir out/debug-tsan --verbose --timeout 240 -C Debug
+
+      - name: Debug, Guarded
+        if: matrix.tests == 'extra' && matrix.os != 'windows-11-arm' && runner.os != 'macOS'
+        run: |
+          cmake . -B out/debug-guarded -DCMAKE_BUILD_TYPE=Debug -DMI_DEBUG_FULL=ON -DMI_GUARDED=ON
+          cmake --build out/debug-guarded --parallel 8 --config Debug
+          ctest --test-dir out/debug-guarded --verbose --timeout 240 -C Debug
+        env:
+          MIMALLOC_GUARDED_SAMPLE_RATE: 100
+
+      - name: Release, Guarded
+        if: matrix.tests == 'extra' && runner.os == 'Linux' && startsWith(github.ref_name,'dev3')
+        run: |
+          cmake . -B out/release-guarded -DCMAKE_BUILD_TYPE=Release -DMI_OPT_ARCH=ON -DMI_GUARDED=ON
+          cmake --build out/release-guarded --parallel 8 --config Release
+          ctest --test-dir out/release-guarded --verbose --timeout 240 -C Release
+        env:
+          MIMALLOC_GUARDED_SAMPLE_RATE: 100

CMakeLists.txt

@@ -9,7 +9,7 @@ option(MI_PADDING           "Enable padding to detect heap block overflow (alway
 option(MI_OVERRIDE          "Override the standard malloc interface (i.e. define entry points for 'malloc', 'free', 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_GUARDED           "Build with guard pages behind certain object allocations (implies MI_NO_PADDING=ON)" OFF)
+option(MI_GUARDED           "Build with guard pages behind certain object allocations (enabled by default in a debug build)" OFF)
 option(MI_USE_CXX           "Use the C++ compiler to compile the library (instead of the C compiler)" OFF)
 option(MI_OPT_ARCH          "Only for optimized builds: turn on architecture specific optimizations (for arm64: '-march=armv8.1-a' (2016))" OFF)
 option(MI_SEE_ASM           "Generate assembly files" OFF)
@@ -128,7 +128,7 @@ set(MI_OPT_ARCH_FLAGS "")
 set(MI_ARCH "unknown")
 if(CMAKE_SYSTEM_PROCESSOR MATCHES "^(x86|i[3456]86)$" OR CMAKE_GENERATOR_PLATFORM MATCHES "^(x86|Win32)$")
   set(MI_ARCH "x86")
-elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "^(x86_64|x64|amd64|AMD64)$" OR CMAKE_GENERATOR_PLATFORM STREQUAL "x64" OR "x86_64" IN_LIST CMAKE_OSX_ARCHITECTURES) # must be before arm64
+elseif((CMAKE_SYSTEM_PROCESSOR MATCHES "^(x86_64|x64|amd64|AMD64)$" OR CMAKE_GENERATOR_PLATFORM STREQUAL "x64" OR "x86_64" IN_LIST CMAKE_OSX_ARCHITECTURES) AND NOT CMAKE_GENERATOR_PLATFORM STREQUAL "ARM64") # must be before arm64
   set(MI_ARCH "x64")
 elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "^(aarch64|arm64|armv[89].?|ARM64)$" OR CMAKE_GENERATOR_PLATFORM STREQUAL "ARM64" OR "arm64" IN_LIST CMAKE_OSX_ARCHITECTURES)
   set(MI_ARCH "arm64")
@@ -273,15 +273,6 @@ if(MI_TRACK_ETW)
   endif()
 endif()
 
-if(MI_GUARDED)
-  message(STATUS "Compile guard pages behind certain object allocations (MI_GUARDED=ON)")
-  list(APPEND mi_defines MI_GUARDED=1)
-  if(NOT MI_NO_PADDING)
-    message(STATUS "  Disabling padding due to guard pages (MI_NO_PADDING=ON)")
-    set(MI_NO_PADDING ON)
-  endif()
-endif()
-
 if(MI_SEE_ASM)
   message(STATUS "Generate assembly listings (MI_SEE_ASM=ON)")
   list(APPEND mi_cflags -save-temps)
@@ -303,19 +294,31 @@ endif()
 
 if(MI_DEBUG_FULL)
   message(STATUS "Set debug level to full assertion and internal invariant checking (MI_DEBUG_FULL=ON, expensive)")
+  set(MI_DEBUG ON)
   list(APPEND mi_defines MI_DEBUG=3)   # full invariant checking (mi_assert, mi_assert_internal, and mi_assert_expensive)
 elseif(MI_DEBUG_INTERNAL)
   message(STATUS "Set debug level to internal assertion and invariant checking (MI_DEBUG_INTERNAL=ON)")
+  set(MI_DEBUG ON)
   list(APPEND mi_defines MI_DEBUG=2)   # invariant checking (mi_assert and mi_assert_internal)
 elseif(MI_DEBUG)
   message(STATUS "Set debug level to assertion checking (MI_DEBUG=ON)")
   list(APPEND mi_defines MI_DEBUG=1)   # assertion checking (mi_assert)
 elseif(CMAKE_BUILD_TYPE MATCHES "Debug")
   message(STATUS "Set debug level to internal assertion and invariant checking (CMAKE_BUILD_TYPE=Debug)")
   set(MI_DEBUG_INTERNAL ON)
+  set(MI_DEBUG ON)
   list(APPEND mi_defines MI_DEBUG=2)   # invariant checking (mi_assert and mi_assert_internal)
 endif()
 
+if(MI_DEBUG AND !MI_GUARDED)
+  message(STATUS "Enable MI_GUARDED (since MI_DEBUG=ON)")
+  set(MI_GUARDED=ON)
+endif()
+if(MI_GUARDED)
+  message(STATUS "Compile guard pages behind certain object allocations (MI_GUARDED=ON)")
+  list(APPEND mi_defines MI_GUARDED=1)
+endif()
+
 if(MI_NO_PADDING)
   message(STATUS "Suppress any padding of heap blocks (MI_NO_PADDING=ON)")
   list(APPEND mi_defines MI_PADDING=0)
@@ -381,7 +384,7 @@ endif()
 if(CMAKE_SYSTEM_NAME MATCHES "Linux|Android")
   if(MI_NO_THP)
     message(STATUS "Disable transparent huge pages support (MI_NO_THP=ON)")
-    list(APPEND mi_defines MI_NO_THP=1)
+    list(APPEND mi_defines MI_DEFAULT_ALLOW_THP=0)
   endif()
 endif()
 
@@ -465,7 +468,7 @@ if (MSVC AND MSVC_VERSION GREATER_EQUAL 1914)
   list(APPEND mi_cflags /Zc:__cplusplus)
   if(MI_OPT_ARCH AND NOT MI_CLANG_CL)
     if(MI_ARCH STREQUAL "arm64")
-      set(MI_OPT_ARCH_FLAGS "/arch:armv8.1")           # fast atomics
+      set(MI_OPT_ARCH_FLAGS "/arch:armv8.1")           # fast atomics (LSE)
     endif()
   endif()
 endif()
@@ -605,7 +608,7 @@ if(MI_BUILD_SHARED)
     # On windows, the import library name for the dll would clash with the static mimalloc.lib library
     # so we postfix the dll import library with `.dll.lib` (and also the .pdb debug file)
     set_property(TARGET mimalloc PROPERTY ARCHIVE_OUTPUT_NAME "${mi_libname}.dll" )
-    install(FILES "$<TARGET_FILE_DIR:mimalloc>/${mi_libname}.dll.lib" DESTINATION ${CMAKE_INSTALL_LIBDIR})
+    install(FILES "$<TARGET_FILE_DIR:mimalloc>/${mi_libname}.dll.lib" DESTINATION ${CMAKE_INSTALL_LIBDIR}/mimalloc-${mi_version})
     set_property(TARGET mimalloc PROPERTY PDB_NAME "${mi_libname}.dll")
     # don't try to install the pdb since it may not be generated depending on the configuration
     # install(FILES "$<TARGET_FILE_DIR:mimalloc>/${mi_libname}.dll.pdb" DESTINATION ${CMAKE_INSTALL_LIBDIR})
@@ -768,13 +771,10 @@ if (MI_OVERRIDE)
   if (MI_BUILD_SHARED)
     target_compile_definitions(mimalloc PRIVATE MI_MALLOC_OVERRIDE)
   endif()
-  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()
+  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()

azure-pipelines.yml

@@ -4,6 +4,7 @@
 # https://aka.ms/yaml
 
 trigger:
+  batch: true
   branches:
     include:
     - main
@@ -236,9 +237,9 @@ jobs:
       Debug:
         BuildType: debug
         cmakeExtraArgs: -DCMAKE_BUILD_TYPE=Debug -DMI_DEBUG_FULL=ON
-      Release:
-        BuildType: release
-        cmakeExtraArgs: -DCMAKE_BUILD_TYPE=Release
+      # Release:
+      #   BuildType: release
+      #   cmakeExtraArgs: -DCMAKE_BUILD_TYPE=Release
   steps:
   - task: CMake@1
     inputs: