Add memory sanitizer CI (#2254)
diff --git a/.github/workflows/ci-unix-static-sanitized-memory.yml b/.github/workflows/ci-unix-static-sanitized-memory.yml
new file mode 100644
index 0000000..d77be84
--- /dev/null
+++ b/.github/workflows/ci-unix-static-sanitized-memory.yml
@@ -0,0 +1,111 @@
+# Memory sanitizer needs to be in its own file because it is slower than other sanitizers.
+name: CI Unix Static Sanitized Memory
+on:
+ push:
+ pull_request:
+ paths:
+ - ".github/actions/**"
+ - ".github/workflows/ci-unix-static-sanitized-memory.yml"
+
+permissions:
+ contents: read
+
+jobs:
+ build-static-sanitized-memory:
+ runs-on: ubuntu-latest
+
+ env:
+ CC: clang
+ CXX: clang++
+
+ steps:
+ - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+ - uses: ./.github/actions/setup-linux
+ if: runner.os == 'Linux'
+ id: setup_linux
+ with:
+ codec-aom: "LOCAL"
+ codec-dav1d: "LOCAL"
+ libyuv: "LOCAL"
+ extra-cache-key: memory
+ - id: cache-hit
+ run: echo "hit=${{ (runner.os == 'Linux' && steps.setup_linux.outputs.ext-cache-hit == 'true') || (runner.os == 'macOS' && steps.setup_macos.outputs.ext-cache-hit == 'true') }}" >> "$GITHUB_OUTPUT"
+
+ - name: Build cxx and cxxabi
+ run: |
+ # clone LLVM
+ git clone --depth=1 --branch llvmorg-19.1.7 https://github.com/llvm/llvm-project
+ # configure cmake
+ cmake -G Ninja -S llvm-project/runtimes -B llvm-project/msan_out \
+ -DCMAKE_BUILD_TYPE=Release \
+ -DLLVM_ENABLE_RUNTIMES="libcxx;libcxxabi;libunwind" \
+ -DCMAKE_C_COMPILER=clang \
+ -DCMAKE_CXX_COMPILER=clang++ \
+ -DLLVM_USE_SANITIZER=MemoryWithOrigins \
+ -DLIBCXXABI_USE_LLVM_UNWINDER=OFF
+ # build the libraries
+ cmake --build llvm-project/msan_out -- cxx cxxabi unwind
+ - name: Set FLAGS for memory sanitizer
+ run: |
+ echo "CI_CFLAGS=-fsanitize=memory -L${{ github.workspace }}/llvm-project/msan_out/lib -I${{ github.workspace }}/llvm-project/msan_out/include" >> $GITHUB_ENV
+ echo "CI_CXXFLAGS=-fsanitize=memory -stdlib=libc++ -L${{ github.workspace }}/llvm-project/msan_out/lib -I${{ github.workspace }}/llvm-project/msan_out/include -I${{ github.workspace }}/llvm-project/msan_out/include/c++/v1" >> $GITHUB_ENV
+ echo "CI_LDFLAGS=-fsanitize=memory -L${{ github.workspace }}/llvm-project/msan_out/lib -lc++abi" >> $GITHUB_ENV
+ echo "CI_LD_LIBRARY_PATH=$LD_LIBRARY_PATH:${{ github.workspace }}/llvm-project/msan_out/lib" >> $GITHUB_ENV
+
+ - name: Build jpeg
+ if: ${{ steps.cache-hit.outputs.hit == 'false' }}
+ working-directory: ./ext
+ run: |
+ sed -i -e 's/cmake -S \(.*\)/cmake -S \1 -DWITH_SIMD=OFF/g' libjpeg.cmd
+ ./libjpeg.cmd
+ env:
+ CFLAGS: ${{ env.CI_CFLAGS }}
+ CXXFLAGS: ${{ env.CI_CXXFLAGS }}
+ LDFLAGS: ${{ env.CI_LDFLAGS }}
+ LD_LIBRARY_PATH: ${{ env.CI_LD_LIBRARY_PATH }}
+
+ - name: Build aom
+ if: ${{ steps.cache-hit.outputs.hit == 'false' }}
+ working-directory: ./ext
+ run: |
+ sed -i -e 's/cmake -G Ninja \(.*\) \.\./cmake -G Ninja \1 -DAOM_TARGET_CPU=generic -DSANITIZE=memory ../g' aom.cmd
+ ./aom.cmd
+ env:
+ CFLAGS: ${{ env.CI_CFLAGS }}
+ CXXFLAGS: ${{ env.CI_CXXFLAGS }}
+ LDFLAGS: ${{ env.CI_LDFLAGS }}
+ LD_LIBRARY_PATH: ${{ env.CI_LD_LIBRARY_PATH }}
+
+ - name: Build dav1d
+ if: ${{ steps.cache-hit.outputs.hit == 'false' }}
+ working-directory: ./ext
+ run: |
+ sed -i -e 's/meson setup \(.*\) \.\./meson setup \1 -Db_sanitize=memory -Db_lundef=false -Denable_asm=false ../g' dav1d.cmd
+ ./dav1d.cmd
+ env:
+ CFLAGS: ${{ env.CI_CFLAGS }}
+ CXXFLAGS: ${{ env.CI_CXXFLAGS }}
+ LIBRARY_PATH: ${{ env.CI_LD_LIBRARY_PATH }}
+
+ - name: Prepare libavif (cmake)
+ run: >
+ cmake -S . -B build -G Ninja
+ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_SHARED_LIBS=OFF
+ -DAVIF_CODEC_AOM=LOCAL -DAVIF_CODEC_DAV1D=LOCAL
+ -DAVIF_JPEG=LOCAL -DAVIF_LIBSHARPYUV=LOCAL
+ -DAVIF_LIBYUV=LOCAL -DAVIF_ZLIBPNG=LOCAL
+ -DAVIF_BUILD_EXAMPLES=ON -DAVIF_BUILD_APPS=ON
+ -DAVIF_BUILD_TESTS=ON -DAVIF_GTEST=LOCAL
+ env:
+ CFLAGS: ${{ env.CI_CFLAGS }}
+ CXXFLAGS: ${{ env.CI_CXXFLAGS }}
+ LDFLAGS: ${{ env.CI_LDFLAGS }}
+ - name: Build libavif (ninja)
+ working-directory: ./build
+ run: ninja
+ - name: Run AVIF Tests
+ working-directory: ./build
+ run: ctest -j $(getconf _NPROCESSORS_ONLN) --output-on-failure
+ env:
+ MSAN_OPTIONS: allocator_may_return_null=1
+ LD_LIBRARY_PATH: ${{ env.CI_LD_LIBRARY_PATH }}
diff --git a/.github/workflows/ci-unix-static-sanitized.yml b/.github/workflows/ci-unix-static-sanitized.yml
index 157478b..1d22407 100644
--- a/.github/workflows/ci-unix-static-sanitized.yml
+++ b/.github/workflows/ci-unix-static-sanitized.yml
@@ -19,7 +19,8 @@
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest]
- sanitizer: [address, thread, undefined] # TODO(yguyon): Add memory
+ # Memory sanitizer needs to be in its own file because it is slower than other sanitizers.
+ sanitizer: [address, thread, undefined]
env:
CC: clang
diff --git a/tests/gtest/avifallocationtest.cc b/tests/gtest/avifallocationtest.cc
index d44b243..c4ad7cd 100644
--- a/tests/gtest/avifallocationtest.cc
+++ b/tests/gtest/avifallocationtest.cc
@@ -188,6 +188,17 @@
AVIF_RESULT_UNSUPPORTED_DEPTH);
}
+#if defined(__has_feature)
+#if __has_feature(memory_sanitizer)
+#define TEST_EXTREMES 0
+#else
+#define TEST_EXTREMES 1
+#endif
+#else
+#define TEST_EXTREMES 1
+#endif
+
+#if TEST_EXTREMES
TEST(AvifAllocTest, Extremes) {
void* p1 = avifAlloc(1);
EXPECT_NE(p1, nullptr);
@@ -195,6 +206,7 @@
EXPECT_EQ(avifAlloc(std::numeric_limits<size_t>::max()), nullptr);
}
+#endif
} // namespace
} // namespace avif
