luzer: add macOS ARM64 support

The patch adds macOS ARM64 support. Notable changes are:

- Fixed building sanitizers libraries. There's no need to strip
  libraries because they don't have the same object files as Linux.
- Added the -Wno-builtin-memcpy-chk-size option to build the test
  library; otherwise, the build won't work.
- Use the DYLD_INSERT_LIBRARIES environment variable to load the
  ASAN library.
- Added an environment variable ASAN_OPTIONS=abort_on_error=0 for
  regression regression tests. Without option ASAN aborts Lua
  runtime and CTest fails the test. The behaviour is macOS-specific:
  if the option `abort_on_error` is set, the AddressSanitizer calls
  `abort()` instead of `_exit()` after printing the error report [2].
  By default, `abort_on_error` is set to 0 on Linux, but on macOS
  it is set to 1 [3].
- Added a directory with LuaJIT binary executable to HINTS for
  find_program(). Otherwise, `luajit` is not found automatically.
- Added macOS 26 ARM64 [1] to the regression testing on Github
  Actions.

1. https://docs.github.com/en/actions/reference/runners/github-hosted-runners
2. https://github.com/google/sanitizers/wiki/SanitizerCommonFlags
3. https://reviews.llvm.org/D7203

Closes #59

Co-authored-by: Sergey Bronnikov <estetus@gmail.com>

Author: ligurio

.github/workflows/test.yaml

@@ -12,13 +12,23 @@ jobs:
       github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       matrix:
+        os: [ubuntu-24.04, macos-26]
         BUILDTYPE: [Debug, Release]
         LIBLUA:
           - "5.4"
           - "5.3"
           - "5.2"
           - "5.1"
           - "luajit-v2.1"
+        exclude:
+          - os: macos-26
+            LIBLUA: "5.4"
+          - os: macos-26
+            LIBLUA: "5.3"
+          - os: macos-26
+            LIBLUA: "5.2"
+          - os: macos-26
+            LIBLUA: "5.1"
         include:
           - BUILDTYPE: Debug
             CMAKEFLAGS: -DCMAKE_BUILD_TYPE=Debug
@@ -36,24 +46,49 @@ jobs:
             PACKAGES: libluajit-5.1-dev libluajit-5.1-2 luajit
             FLAVORFLAGS: -DLUAJIT_FRIENDLY_MODE=ON -DENABLE_LUAJIT=ON
       fail-fast: false
-    runs-on: ubuntu-24.04
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
 
       - name: Disable processing triggers for man-db
+        if: runner.os == 'Linux'
         run: sudo apt-get remove --purge man-db
 
-      - name: Setup common packages
+      - name: Setup Linux packages
+        if: runner.os == 'Linux'
         run: sudo apt install -y clang-15 libclang-common-15-dev ${{ matrix.PACKAGES }}
 
-      - name: Running CMake
+      - name: Setup macOS packages
+        if: runner.os == 'macOS'
+        run: brew install llvm luajit cmake ninja
+
+      - name: Running CMake (Linux)
+        if: runner.os == 'Linux'
         run: >
           cmake -S . -B build -G Ninja -DENABLE_TESTING=ON
           -DCMAKE_C_COMPILER=clang-15 -DCMAKE_CXX_COMPILER=clang++-15
           ${{ matrix.CMAKEFLAGS }} ${{ matrix.FLAVORFLAGS }}
 
+      - name: Define Brew prefixes (macOS)
+        if: runner.os == 'macOS'
+        run: |
+          echo "BREW_LLVM_PREFIX=`brew --prefix llvm`" >> $GITHUB_ENV
+          echo "BREW_LUAJIT_PREFIX=`brew --prefix luajit`" >> $GITHUB_ENV
+
+      - name: Running CMake (macOS)
+        if: runner.os == 'macOS'
+        run: |
+          cmake -S . -B build -G Ninja \
+            -DCMAKE_C_COMPILER=$BREW_LLVM_PREFIX/bin/clang \
+            -DCMAKE_CXX_COMPILER=$BREW_LLVM_PREFIX/bin/clang++ \
+            -DLUA_INCLUDE_DIR=$BREW_LUAJIT_PREFIX/include/luajit-2.1 \
+            -DLUA_LIBRARIES=$BREW_LUAJIT_PREFIX/lib/libluajit-5.1.dylib \
+            -DENABLE_LUAJIT=ON \
+            -DLUAJIT_FRIENDLY_MODE=ON \
+            ${{ matrix.CMAKEFLAGS }}
+
       - name: Building
-        run: cmake --build build --parallel $(nproc)
+        run: cmake --build build --parallel $(getconf _NPROCESSORS_ONLN)
 
       - name: Testing
         run: cmake --build build --target test

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support LuaJIT metrics.
 - Support OSS Fuzz environment (#73).
 - Support for building on Ubuntu 24.04 AArch64 (ARM64).
+- Support for building on macOS ARM64.
 
 ### Changed
 

CMakeLists.txt

@@ -27,7 +27,6 @@ if(LUA_INCLUDE_DIR AND LUA_LIBRARIES)
   set(LUA_FOUND TRUE)
 elseif(ENABLE_LUAJIT)
   find_package(LuaJIT)
-  set(LUA_HAS_JIT ON CACHE INTERNAL "Use LuaJIT library")
   message(STATUS "Found LuaJIT ${LUA_VERSION_STRING}")
   message(STATUS "Found LuaJIT interpreter ${LUA_EXECUTABLE}")
 else()
@@ -42,6 +41,10 @@ if(NOT LUA_FOUND)
   message(FATAL_ERROR "Lua library is not found")
 endif()
 
+if(ENABLE_LUAJIT)
+  set(LUA_HAS_JIT ON CACHE INTERNAL "Use LuaJIT library")
+endif()
+
 if(LUAJIT_FRIENDLY_MODE AND NOT LUA_HAS_JIT)
   message(FATAL_ERROR "LuaJIT-friendly mode requires option ENABLE_LUAJIT")
 endif()

CONTRIBUTING.md

@@ -1,16 +1,44 @@
 ## Hacking
 
-For developing `luzer` you need to install required packages.
+For developing `luzer` you need to install required packages,
+build the project and run the regression tests.
 
-On Debian: `apt install -y liblua5.1-0-dev llvm-17-dev libclang-common-17-dev
-libclang-rt-17-dev clang-17 cmake`.
+### Setup packages
+
+On Debian: `apt install -y lua5.1 liblua5.1-0-dev llvm-17-dev
+libclang-common-17-dev libclang-rt-17-dev clang-17 cmake`.
 
 Note: with Clang >= 18 you should install a package
 `libclang-rt-XX-dev` and with Clang <= 15 you should install
 a package `libclang-common-XX-dev`, where XX is a Clang version.
 
+On macOS: `brew install llvm cmake luajit`.
+
+### Building
+
+On Debian:
+
 ```sh
 $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DENABLE_TESTING=ON -S . -B build
+```
+
+On macOS:
+
+You may need to set environment variables for directories containing
+LLVM header files and libraries:
+
+```sh
+$ export LDFLAGS="-L$(brew --prefix llvm)/lib"
+$ export CPPFLAGS="-I$(brew --prefix llvm)/include"
+```
+
+```sh
+$ cmake -S . -B build -DCMAKE_C_COMPILER=/opt/homebrew/opt/llvm/bin/clang -DCMAKE_CXX_COMPILER=/opt/homebrew/opt/llvm/bin/clang++ -DLUA_INCLUDE_DIR=/opt/homebrew/include/luajit-2.1 -DLUA_LIBRARIES=/opt/homebrew/lib/libluajit-5.1.dylib -DENABLE_TESTING=ON -DENABLE_LUAJIT=ON -DLUAJIT_FRIENDLY_MODE=ON
+```
+
+### Run regression testing
+
+```sh
 $ cmake --build build --parallel
 $ cmake --build build --target test
 ```

cmake/BuildLibSanitizers.cmake

@@ -26,8 +26,9 @@ macro(GEN_BUILD_TARGET name libsanitizer_path libfuzzer_path
     set(AR ${CMAKE_AR})
   endif()
 
-  # Strip preinit object files in static libraries, otherwise a message
-  # `.preinit_array section is not allowed in DSO` will prevent building DSO.
+  # Strip preinit object files in static libraries on Linux,
+  # otherwise a message `.preinit_array section is not allowed in
+  # DSO` will prevent building DSO.
   add_custom_target(strip_lib_${name}
     COMMENT "Strip sanitizer library ${name}"
     COMMAND ${AR} d ${libsanitizer_name} ${strip}
@@ -36,25 +37,54 @@ macro(GEN_BUILD_TARGET name libsanitizer_path libfuzzer_path
     DEPENDS copy_libs_${name}
   )
 
+  set(LINK_COMMAND
+    ${CMAKE_C_COMPILER}
+    -Wl,--whole-archive
+    ${libfuzzer_name}
+    ${libsanitizer_name}
+    -Wl,--no-whole-archive
+    -lstdc++
+    -lpthread
+    -ldl
+    -shared
+    -o ${sanitizer_dso_name}
+  )
+  if (CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+    set(LINK_COMMAND
+      ${CMAKE_C_COMPILER}
+      ${libfuzzer_name}
+      ${libsanitizer_name}
+      -lstdc++
+      -lpthread
+      -dynamiclib
+      -o ${sanitizer_dso_name}
+    )
+  endif()
   add_custom_target(build_dso_${name} ALL
     COMMENT "Build sanitizer library ${name}"
-    COMMAND ${CMAKE_C_COMPILER} -Wl,--whole-archive ${libfuzzer_name}
-       ${libsanitizer_name} -Wl,--no-whole-archive -lstdc++ -lpthread -ldl
-       -shared -o ${sanitizer_dso_name}
+    COMMAND ${LINK_COMMAND}
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     BYPRODUCTS ${sanitizer_dso_name}
-    DEPENDS strip_lib_${name}
   )
+  if (NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+    add_dependencies(build_dso_${name} strip_lib_${name})
+  else()
+    add_dependencies(build_dso_${name} copy_libs_${name})
+  endif()
 endmacro()
 
-list(APPEND LIBCLANG_ASAN_STRIP
-  asan_preinit.cc.o
-  asan_preinit.cpp.o
-)
-list(APPEND LIBCLANG_UBSAN_STRIP
-  ubsan_init_standalone_preinit.cc.o
-  ubsan_init_standalone_preinit.cpp.o
-)
+set(LIBCLANG_ASAN_STRIP "")
+set(LIBCLANG_UBSAN_STRIP "")
+if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
+  list(APPEND LIBCLANG_ASAN_STRIP
+    asan_preinit.cc.o
+    asan_preinit.cpp.o
+  )
+  list(APPEND LIBCLANG_UBSAN_STRIP
+    ubsan_init_standalone_preinit.cc.o
+    ubsan_init_standalone_preinit.cpp.o
+  )
+endif()
 
 set(ASAN_DSO "libfuzzer_with_asan${CMAKE_SHARED_LIBRARY_SUFFIX}")
 set(UBSAN_DSO "libfuzzer_with_ubsan${CMAKE_SHARED_LIBRARY_SUFFIX}")

cmake/FindLuaJIT.cmake

@@ -43,7 +43,15 @@ find_package_handle_standard_args(LuaJIT
   FAIL_MESSAGE "${ERROR_MESSAGE}"
 )
 
-find_program(LUAJIT_EXECUTABLE luajit)
+if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+  string(JOIN " " LUAJIT_BIN_HINTS
+    /opt/homebrew/bin/
+  )
+endif()
+find_program(LUAJIT_EXECUTABLE
+  NAMES luajit
+  HINTS ${LUAJIT_BIN_HINTS}
+)
 if(NOT EXISTS ${LUAJIT_EXECUTABLE})
   message(WARNING "`luajit` is not found")
 endif()
@@ -58,5 +66,6 @@ unset(LUAJIT_FOUND)
 unset(LUAJIT_LIBRARIES)
 unset(LUAJIT_INCLUDE_DIR)
 unset(LUAJIT_EXECUTABLE)
+unset(LUAJIT_BIN_HINTS)
 
 mark_as_advanced(LUA_INCLUDE_DIR LUA_LIBRARIES)

luzer/CMakeLists.txt

@@ -12,11 +12,14 @@ endif()
 
 set(LIBCLANG_ASAN_NAME "libclang_rt.asan-${ARCH}.a")
 set(LIBCLANG_UBSAN_NAME "libclang_rt.ubsan_standalone-${ARCH}.a")
-# Sanitizers libraries in the OSS Fuzz environment have different
-# names.
+# Sanitizers libraries in the OSS Fuzz environment and macOS have
+# different names.
 if(OSS_FUZZ)
   set(LIBCLANG_ASAN_NAME "libclang_rt.asan.a")
   set(LIBCLANG_UBSAN_NAME "libclang_rt.ubsan_standalone.a")
+elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+  set(LIBCLANG_ASAN_NAME "libclang_rt.asan_abi_osx.a")
+  set(LIBCLANG_UBSAN_NAME "libclang_rt.ubsan_minimal_osx.a")
 endif()
 SetClangLibPath(${LIBCLANG_ASAN_NAME} LIBCLANG_ASAN_LIB)
 SetClangLibPath(${LIBCLANG_UBSAN_NAME} LIBCLANG_UBSAN_LIB)
@@ -41,6 +44,10 @@ add_compile_options(
   -Wpedantic
 )
 if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
+  # It turns out that macOS set _FORTIFY_SOURCE internally, so we
+  # need to undefine it first, otherwise an error "'_FORTIFY_SOURCE'
+  # macro redefined" breaks a building.
+  add_compile_options(-U_FORTIFY_SOURCE)
   add_compile_options(-D_FORTIFY_SOURCE=2)
 endif()
 

luzer/luzer.c

@@ -20,7 +20,11 @@
 #include <libgen.h>
 #include <fcntl.h>
 #include <unistd.h>
+#ifdef __linux__
 #include <linux/limits.h>
+#else
+#include <limits.h>
+#endif
 
 #include "fuzzed_data_provider.h"
 #include "counters.h"
@@ -33,7 +37,11 @@
 
 #define TEST_ONE_INPUT_FUNC "luzer_test_one_input"
 #define CUSTOM_MUTATOR_FUNC "luzer_custom_mutator"
+#ifdef __APPLE__
+#define CUSTOM_MUTATOR_LIB "libcustom_mutator.dylib"
+#else
 #define CUSTOM_MUTATOR_LIB "libcustom_mutator.so"
+#endif /* __APPLE__ */
 #define DEBUG_HOOK_FUNC "luzer_custom_hook"
 
 static lua_State *LL;