Skip to content

Commit 6b1c6ff

Browse files
mandeseromandesero
committed
ci: add Valgrind testing workflow
This patch adds CI testing with Valgrind in three scenarios: - Full checks enabled. - No leak checks, with memory fill set to `--malloc-fill=0x00` and `--free-fill=0x00`. - No leak checks, with memory fill set to `--malloc-fill=0xFF` and `--free-fill=0xFF`. The use of `0x00` and `0xFF` for memory fill helps to detect dirty reads. `0x00` mimics zero-initialized memory, which can mask some uninitialized memory usage. `0xFF` fills memory with a non-zero values to make such errors easier to spot. Closes tarantool/tarantool#3705
1 parent 739d393 commit 6b1c6ff

File tree

3 files changed

+123
-0
lines changed

3 files changed

+123
-0
lines changed

‎.github/actions/setup-valgrind/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Setup environment for Valgrind on Linux
2+
3+
Action setups the environment on Linux runners (install requirements, setup the
4+
workflow environment, etc) for testing with Valgrind.
5+
6+
## How to use Github Action from Github workflow
7+
8+
Add the following code to the running steps before LuaJIT configuration:
9+
```
10+
- uses: ./.github/actions/setup-valgrind
11+
if: ${{ matrix.OS == 'Linux' }}
12+
```

‎.github/actions/setup-valgrind/action.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Setup CI environment with Valgrind on Linux
2+
description: Extend setup-linux with Valgrind installation
3+
4+
runs:
5+
using: composite
6+
steps:
7+
- name: Setup CI environment (Linux)
8+
uses: ./.github/actions/setup-linux
9+
- name: Install Valgrind
10+
run: |
11+
apt -y install valgrind
12+
shell: bash

‎.github/workflows/valgrind-testing.yaml

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
name: Valgrind testing
2+
3+
on:
4+
push:
5+
branches-ignore:
6+
- '**-notest'
7+
- 'upstream-**'
8+
tags-ignore:
9+
- '**'
10+
11+
concurrency:
12+
# An update of a developer branch cancels the previously
13+
# scheduled workflow run for this branch. However, the default
14+
# branch, and long-term branch (tarantool/release/2.11,
15+
# tarantool/release/2.10, etc) workflow runs are never canceled.
16+
#
17+
# We use a trick here: define the concurrency group as 'workflow
18+
# run ID' + # 'workflow run attempt' because it is a unique
19+
# combination for any run. So it effectively discards grouping.
20+
#
21+
# XXX: we cannot use `github.sha` as a unique identifier because
22+
# pushing a tag may cancel a run that works on a branch push
23+
# event.
24+
group: ${{ startsWith(github.ref, 'refs/heads/tarantool/')
25+
&& format('{0}-{1}', github.run_id, github.run_attempt)
26+
|| format('{0}-{1}', github.workflow, github.ref) }}
27+
cancel-in-progress: true
28+
29+
jobs:
30+
test-valgrind:
31+
strategy:
32+
fail-fast: false
33+
matrix:
34+
# XXX: Let's start with only Linux/x86_64
35+
# We don't test on Linux/ARM64 because the address returned by the
36+
# system allocator may exceed 47 bits. As a result, we are unable to
37+
# allocate memory for `lua_State`. Therefore, testing on this platform
38+
# is currently disabled.
39+
BUILDTYPE: [Debug, Release]
40+
VALGRIND_SCENARIO: [full, malloc-free-fill-0x00, malloc-free-fill-0xff]
41+
include:
42+
- BUILDTYPE: Debug
43+
CMAKEFLAGS: -DCMAKE_BUILD_TYPE=Debug -DLUA_USE_ASSERT=ON -DLUA_USE_APICHECK=ON
44+
- BUILDTYPE: Release
45+
CMAKEFLAGS: -DCMAKE_BUILD_TYPE=RelWithDebInfo
46+
- VALGRIND_SCENARIO: full
47+
VALGRIND_OPTS: --leak-check=full --show-leak-kinds=all --track-origins=yes
48+
JOB_POSTFIX: "leak-check: full"
49+
# The use of `0x00` and `0xFF` for memory fill helps to detect dirty
50+
# reads. `0x00` mimics zero-initialized memory, which can mask some
51+
# uninitialized memory usage. `0xFF` fills memory with a non-zero
52+
# values to make such errors easier to spot.
53+
- VALGRIND_SCENARIO: malloc-free-fill-0x00
54+
VALGRIND_OPTS: --leak-check=no --malloc-fill=0x00 --free-fill=0x00
55+
JOB_POSTFIX: "malloc/free-fill: 0x00"
56+
- VALGRIND_SCENARIO: malloc-free-fill-0xff
57+
VALGRIND_OPTS: --leak-check=no --malloc-fill=0xff --free-fill=0xff
58+
JOB_POSTFIX: "malloc/free-fill: 0xff"
59+
runs-on: [self-hosted, regular, Linux, x86_64]
60+
name: >
61+
LuaJIT with Valgrind (Linux/x86_64)
62+
${{ matrix.BUILDTYPE }}
63+
CC: gcc
64+
GC64:ON SYSMALLOC:ON
65+
${{ matrix.JOB_POSTFIX }}
66+
steps:
67+
- uses: actions/checkout@v4
68+
with:
69+
fetch-depth: 0
70+
submodules: recursive
71+
- name: setup Linux for Valgrind
72+
uses: ./.github/actions/setup-valgrind
73+
- name: configure
74+
# XXX: LuaJIT configuration requires a couple of tweaks:
75+
# LUAJIT_USE_SYSMALLOC=ON: Unfortunately, internal LuaJIT
76+
# memory allocator is not instrumented yet, so to find
77+
# any memory errors it's better to build LuaJIT with
78+
# system provided memory allocator (i.e. run CMake
79+
# configuration phase with -DLUAJIT_USE_SYSMALLOC=ON).
80+
# For more info, see root CMakeLists.txt.
81+
# LUAJIT_ENABLE_GC64=ON: LUAJIT_USE_SYSMALLOC cannot be
82+
# enabled on x64 without GC64, since realloc usually
83+
# doesn't return addresses in the right address range.
84+
# For more info, see root CMakeLists.txt.
85+
run: >
86+
cmake -S . -B ${{ env.BUILDDIR }}
87+
-G Ninja
88+
${{ matrix.CMAKEFLAGS }}
89+
-DLUAJIT_USE_VALGRIND=ON
90+
-DLUAJIT_ENABLE_GC64=ON
91+
-DLUAJIT_USE_SYSMALLOC=ON
92+
- name: build
93+
run: cmake --build . --parallel
94+
working-directory: ${{ env.BUILDDIR }}
95+
- name: test
96+
env:
97+
VALGRIND_OPTS: ${{ matrix.VALGRIND_OPTS }}
98+
run: cmake --build . --parallel --target LuaJIT-test
99+
working-directory: ${{ env.BUILDDIR }}

0 commit comments

Comments
 (0)