Skip to content

Commit c8654d0

Browse files
mceachenmceachen
committed
feat(tests): add memory testing framework with Valgrind and AddressSanitizer support
1 parent 5f667d8 commit c8654d0

7 files changed

Lines changed: 1073 additions & 1 deletion

File tree

‎.github/workflows/memory-tests.yaml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Memory Tests
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
memory-tests:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
17+
18+
- name: Install dependencies
19+
run: |
20+
sudo apt-get update
21+
sudo apt-get install -y build-essential valgrind clang
22+
23+
- name: Vendor SQLite
24+
run: ./scripts/vendor.sh
25+
26+
- name: Run Valgrind memory tests
27+
run: make test-valgrind
28+
29+
- name: Run AddressSanitizer tests
30+
run: make test-asan
31+
env:
32+
CC: clang
33+
34+
- name: Upload logs on failure
35+
if: failure()
36+
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
37+
with:
38+
name: memory-test-logs
39+
path: |
40+
valgrind.log
41+
asan-output.log
42+
retention-days: 7

‎.valgrind.supp‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Valgrind suppressions for sqlite-vec
2+
#
3+
# These suppressions filter out known issues in SQLite internals
4+
# so we can focus on actual memory leaks in sqlite-vec code.
5+
6+
# SQLite memory allocator internals (memsys5, etc.)
7+
{
8+
SQLite-MemSys-Reachable
9+
Memcheck:Leak
10+
match-leak-kinds: reachable
11+
...
12+
fun:sqlite3_*
13+
...
14+
}
15+
16+
# SQLite mutex/threading internals
17+
{
18+
SQLite-Mutex-Uninit
19+
Memcheck:Cond
20+
...
21+
fun:*sqlite3*Mutex*
22+
...
23+
}
24+
25+
# SQLite parser/tokenizer
26+
{
27+
SQLite-Parser-Uninit
28+
Memcheck:Cond
29+
...
30+
fun:sqlite3*Parse*
31+
...
32+
}
33+
34+
# SQLite VDBE engine
35+
{
36+
SQLite-VDBE-Uninit
37+
Memcheck:Cond
38+
...
39+
fun:sqlite3VdbeExec
40+
...
41+
}
42+
43+
# SQLite B-tree operations
44+
{
45+
SQLite-Btree-Uninit
46+
Memcheck:Cond
47+
...
48+
fun:sqlite3Btree*
49+
...
50+
}
51+
52+
# SQLite pager
53+
{
54+
SQLite-Pager-Uninit
55+
Memcheck:Cond
56+
...
57+
fun:sqlite3Pager*
58+
...
59+
}
60+
61+
# SQLite virtual table cursor operations (common in extensions)
62+
{
63+
SQLite-VTab-Reachable
64+
Memcheck:Leak
65+
match-leak-kinds: reachable
66+
...
67+
fun:sqlite3_vtab_*
68+
...
69+
}
70+
71+
# glibc dlopen internals (when loading extensions)
72+
{
73+
Glibc-DLOpen-Reachable
74+
Memcheck:Leak
75+
match-leak-kinds: reachable
76+
...
77+
fun:dlopen*
78+
...
79+
}
80+
81+
# glibc thread-local storage
82+
{
83+
Glibc-TLS-Reachable
84+
Memcheck:Leak
85+
match-leak-kinds: reachable
86+
...
87+
fun:__tls_get_addr
88+
...
89+
}

‎Makefile‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,52 @@ test-loadable-watch:
214214
test-unit:
215215
$(CC) tests/test-unit.c sqlite-vec.c -I./ -Ivendor -o $(prefix)/test-unit && $(prefix)/test-unit
216216

217+
# ███████████████████████████████ MEMORY TESTING ███████████████████████████████
218+
219+
# AddressSanitizer + LeakSanitizer build (Linux/macOS only)
220+
# Usage: make loadable-asan
221+
ASAN_CFLAGS = -fsanitize=address,undefined -fno-omit-frame-pointer -g -O1
222+
ASAN_LDFLAGS = -fsanitize=address,undefined
223+
224+
$(prefix)/vec0-asan.$(LOADABLE_EXTENSION): sqlite-vec.c sqlite-vec.h $(prefix)
225+
$(CC) \
226+
-fPIC -shared \
227+
-fvisibility=hidden \
228+
-Wall -Wextra \
229+
-Ivendor/ \
230+
$(ASAN_CFLAGS) \
231+
$(CFLAGS) $(EXT_CFLAGS) \
232+
$< -o $@ \
233+
$(ASAN_LDFLAGS) $(EXT_LDFLAGS) $(LDLIBS)
234+
235+
loadable-asan: $(prefix)/vec0-asan.$(LOADABLE_EXTENSION)
236+
237+
# Memory test harness for valgrind (builds CLI with debug symbols)
238+
$(prefix)/memory-test: tests/memory-test.c sqlite-vec.c vendor/sqlite3.c | $(prefix)
239+
$(CC) -g -O0 \
240+
-fvisibility=hidden \
241+
-Ivendor/ -I./ \
242+
-DSQLITE_CORE \
243+
-DSQLITE_VEC_STATIC \
244+
-DSQLITE_THREADSAFE=0 \
245+
$(CFLAGS) $(EXT_CFLAGS) \
246+
tests/memory-test.c sqlite-vec.c vendor/sqlite3.c -o $@ \
247+
$(EXT_LDFLAGS) -ldl -lm
248+
249+
# Run valgrind memory leak tests
250+
test-valgrind: $(prefix)/memory-test
251+
@./scripts/valgrind-test.sh
252+
253+
# Run AddressSanitizer tests (builds its own ASan-instrumented binary)
254+
test-asan:
255+
@./scripts/sanitizers-test.sh
256+
257+
# Run all memory tests
258+
test-memory: test-valgrind test-asan
259+
@echo "All memory tests completed"
260+
261+
# ███████████████████████████████ END MEMORY TESTING ███████████████████████████
262+
217263
site-dev:
218264
npm --prefix site run dev
219265

‎scripts/sanitizers-test.sh‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
#!/bin/bash
2+
#
3+
# AddressSanitizer (ASan) and LeakSanitizer (LSan) test runner for sqlite-vec
4+
# Detects buffer overflows, use-after-free, double-free, and memory leaks.
5+
#
6+
# Usage: ./scripts/sanitizers-test.sh
7+
# Or: make test-asan
8+
9+
set -euo pipefail
10+
11+
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" &>/dev/null && pwd)"
12+
ROOT_DIR="$(dirname "$SCRIPT_DIR")"
13+
14+
# Colors for output
15+
RED='\033[0;31m'
16+
GREEN='\033[0;32m'
17+
YELLOW='\033[1;33m'
18+
BLUE='\033[0;34m'
19+
NC='\033[0m' # No Color
20+
21+
# Only run on Linux (macOS has SIP issues with ASan)
22+
if [[ "$OSTYPE" != "linux-gnu"* ]]; then
23+
echo -e "${YELLOW}AddressSanitizer tests currently only supported on Linux.${NC}"
24+
echo -e "${YELLOW}macOS requires additional setup due to SIP restrictions.${NC}"
25+
exit 0
26+
fi
27+
28+
# Check for clang or gcc
29+
CC="${CC:-}"
30+
if [[ -z "$CC" ]]; then
31+
if command -v clang &>/dev/null; then
32+
CC=clang
33+
elif command -v gcc &>/dev/null; then
34+
CC=gcc
35+
else
36+
echo -e "${RED}Error: Neither clang nor gcc found. Install one to run ASan tests.${NC}"
37+
exit 1
38+
fi
39+
fi
40+
41+
echo -e "${BLUE}=== AddressSanitizer + LeakSanitizer Tests ===${NC}"
42+
echo "Using compiler: $CC"
43+
44+
# Configuration
45+
OUTPUT_FILE="$ROOT_DIR/asan-output.log"
46+
MEMORY_TEST="$ROOT_DIR/dist/memory-test-asan"
47+
48+
# ASan/LSan options
49+
export ASAN_OPTIONS="detect_leaks=1:halt_on_error=1:print_stats=1:check_initialization_order=1"
50+
export LSAN_OPTIONS="print_suppressions=0"
51+
52+
# Clean previous output
53+
rm -f "$OUTPUT_FILE"
54+
55+
# ASan compiler flags
56+
ASAN_CFLAGS="-fsanitize=address,undefined -fno-omit-frame-pointer -g -O1"
57+
ASAN_LDFLAGS="-fsanitize=address,undefined"
58+
59+
# Build the ASan-instrumented memory test
60+
echo -e "\n${YELLOW}Building memory-test with AddressSanitizer...${NC}"
61+
62+
$CC $ASAN_CFLAGS \
63+
-fvisibility=hidden \
64+
-I"$ROOT_DIR/vendor/" -I"$ROOT_DIR/" \
65+
-DSQLITE_CORE \
66+
-DSQLITE_VEC_STATIC \
67+
-DSQLITE_THREADSAFE=0 \
68+
"$ROOT_DIR/tests/memory-test.c" \
69+
"$ROOT_DIR/sqlite-vec.c" \
70+
"$ROOT_DIR/vendor/sqlite3.c" \
71+
-o "$MEMORY_TEST" \
72+
$ASAN_LDFLAGS -ldl -lm
73+
74+
if [ ! -f "$MEMORY_TEST" ]; then
75+
echo -e "${RED}Error: ASan build failed. Binary not found at $MEMORY_TEST${NC}"
76+
exit 1
77+
fi
78+
echo -e "${GREEN}ASan build complete${NC}"
79+
80+
# Run the ASan-instrumented memory test
81+
echo -e "\n${YELLOW}Running memory tests with AddressSanitizer...${NC}"
82+
83+
set +e
84+
"$MEMORY_TEST" 2>&1 | tee "$OUTPUT_FILE"
85+
TEST_EXIT=${PIPESTATUS[0]}
86+
set -e
87+
88+
echo ""
89+
90+
# Analyze output for ASan/LSan errors
91+
echo -e "${BLUE}=== Analyzing ASan/LSan output ===${NC}"
92+
93+
RESULT=0
94+
95+
# Check for ASan errors
96+
if grep -q "ERROR: AddressSanitizer" "$OUTPUT_FILE"; then
97+
echo -e "${RED}FAIL: AddressSanitizer found errors:${NC}"
98+
grep -B 2 -A 20 "ERROR: AddressSanitizer" "$OUTPUT_FILE" | head -50 || true
99+
RESULT=1
100+
fi
101+
102+
# Check for LSan errors
103+
if grep -q "ERROR: LeakSanitizer" "$OUTPUT_FILE"; then
104+
echo -e "${RED}FAIL: LeakSanitizer found memory leaks:${NC}"
105+
grep -B 2 -A 30 "ERROR: LeakSanitizer" "$OUTPUT_FILE" | head -60 || true
106+
RESULT=1
107+
fi
108+
109+
# Check for undefined behavior
110+
if grep -q "runtime error:" "$OUTPUT_FILE"; then
111+
echo -e "${RED}FAIL: UndefinedBehaviorSanitizer found issues:${NC}"
112+
grep -B 2 -A 5 "runtime error:" "$OUTPUT_FILE" | head -30 || true
113+
RESULT=1
114+
fi
115+
116+
# Check test exit code
117+
if [[ "$TEST_EXIT" -ne 0 && "$RESULT" -eq 0 ]]; then
118+
echo -e "${RED}FAIL: Tests failed with exit code $TEST_EXIT${NC}"
119+
RESULT=1
120+
fi
121+
122+
if [[ "$RESULT" -eq 0 ]]; then
123+
echo -e "\n${GREEN}PASS: No memory errors detected${NC}"
124+
rm -f "$OUTPUT_FILE"
125+
else
126+
echo -e "\n${RED}Memory issues detected! See $OUTPUT_FILE for full details.${NC}"
127+
fi
128+
129+
# Clean up ASan build artifacts
130+
echo -e "\n${YELLOW}Cleaning up ASan build...${NC}"
131+
rm -f "$MEMORY_TEST"
132+
echo -e "${GREEN}Cleanup complete${NC}"
133+
134+
exit $RESULT

0 commit comments

Comments
 (0)