luzer: add macOS ARM64 support

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

Author: mzfr

.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-latest]
         BUILDTYPE: [Debug, Release]
         LIBLUA:
           - "5.4"
           - "5.3"
           - "5.2"
           - "5.1"
           - "luajit-v2.1"
+        exclude:
+          - os: macos-latest
+            LIBLUA: "5.4"
+          - os: macos-latest
+            LIBLUA: "5.3"
+          - os: macos-latest
+            LIBLUA: "5.2"
+          - os: macos-latest
+            LIBLUA: "5.1"
         include:
           - BUILDTYPE: Debug
             CMAKEFLAGS: -DCMAKE_BUILD_TYPE=Debug
@@ -36,24 +46,43 @@ 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: Running CMake (macOS)
+        if: runner.os == 'macOS'
+        run: >
+          cmake -S . -B build -G Ninja
+            -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_LUAJIT=ON
+            -DLUAJIT_FRIENDLY_MODE=ON
+            ${{ matrix.CMAKEFLAGS }}
+
       - name: Building
-        run: cmake --build build --parallel $(nproc)
+        run: cmake --build build --parallel
 
       - name: Testing
         run: cmake --build build --target test

CHANGELOG.md

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

CMakeLists.txt

@@ -16,7 +16,7 @@ endif()
 set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 include(SetClangRTLib)
 
-if(LUA_INCLUDE_DIR AND LUA_LIBRARIES)
+if(LUA_INCLUDE_DIR AND LUA_LIBRARIES AND NOT ENABLE_LUAJIT)
   # When a path to a Lua library is passed outside, we should
   # mimic a real CMake library to don't break code that depends on
   # LUA_LIBRARIES.
@@ -27,7 +27,10 @@ if(LUA_INCLUDE_DIR AND LUA_LIBRARIES)
 elseif(ENABLE_LUAJIT)
   include(FindLuaJIT)
   set(LUA_NAME "luajit")
-  find_program(LUA_EXECUTABLE "${LUA_NAME}")
+  find_program(LUA_EXECUTABLE
+    NAMES ${LUA_NAME}
+    HINTS /opt/homebrew/bin/
+  )
   if(NOT EXISTS ${LUA_EXECUTABLE})
     message(FATAL_ERROR "`${LUA_NAME}` is required")
   endif()

CONTRIBUTING.md

@@ -1,6 +1,7 @@
 ## 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`.
@@ -11,6 +12,15 @@ a package `libclang-common-XX-dev`, where XX is a Clang version.
 
 ```sh
 $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DENABLE_TESTING=ON -S . -B build
+```
+
+On macOS: `brew install llvm cmake luajit`
+
+```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
+```
+
+```sh
 $ cmake --build build --parallel
 $ cmake --build build --target test
 ```

cmake/BuildLibSanitizers.cmake

@@ -36,28 +36,57 @@ 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.so")
-set(UBSAN_DSO "libfuzzer_with_ubsan.so")
+set(ASAN_DSO "libfuzzer_with_asan${CMAKE_SHARED_LIBRARY_SUFFIX}")
+set(UBSAN_DSO "libfuzzer_with_ubsan${CMAKE_SHARED_LIBRARY_SUFFIX}")
 
 GEN_BUILD_TARGET("asan"
   ${LIBCLANG_ASAN_LIB}

cmake/SetClangRTLib.cmake

@@ -2,7 +2,11 @@ function(SetHwArchString outvar)
   if (CMAKE_SIZEOF_VOID_P EQUAL 4)
     set(hw_arch "i386")
   elseif (CMAKE_SIZEOF_VOID_P EQUAL 8)
-    set(hw_arch "x86_64")
+    if (CMAKE_SYSTEM_PROCESSOR MATCHES "^(aarch64|arm64)")
+      set(hw_arch "arm64")
+    else()
+      set(hw_arch "x86_64")
+    endif()
   else ()
     message(FATAL_ERROR "Unsupported architecture.")
   endif ()

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.
-if(OSS_FUZZ)
+# Sanitizers libraries in the OSS Fuzz environment and macOS have
+# different names.
+if (DEFINED ENV{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)
@@ -39,10 +42,12 @@ add_compile_options(
   -Wextra
   -Wno-unused-parameter
   -Wpedantic
+  # 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.
+  -U_FORTIFY_SOURCE
+  -D_FORTIFY_SOURCE=2
 )
-if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
-  add_compile_options(-D_FORTIFY_SOURCE=2)
-endif()
 
 set(LUZER_SOURCES luzer.c
                   compat.c

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;