Merge pull request #42 from itzmeanjan/add-asan-msan-ubsan

Add ASAN, UBSAN
itzmeanjan · Dec 17, 2023 · 0d7b632 · 0d7b632
2 parents cd26dbe + a1d92dd
commit 0d7b632
Show file tree

Hide file tree

Showing 5 changed files with 168 additions and 199 deletions.
diff --git a/.github/workflows/test_ci.yml b/.github/workflows/test_ci.yml
@@ -35,3 +35,7 @@ jobs:
         popd
     - name: Execute Tests on ${{matrix.os}}
       run: make -j
+    - name: Execute Tests with AddressSanitizer on ${{matrix.os}}
+      run: make asan_test -j
+    - name: Execute Tests with UndefinedBehaviourSanitizer on ${{matrix.os}}
+      run: make ubsan_test -j
diff --git a/Makefile b/Makefile
@@ -3,6 +3,8 @@ CXX_FLAGS = -std=c++20
 WARN_FLAGS = -Wall -Wextra -pedantic
 OPT_FLAGS = -O3 -march=native
 LINK_FLAGS = -flto
+ASAN_FLAGS = -g -O1 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize=address # From https://clang.llvm.org/docs/AddressSanitizer.html
+UBSAN_FLAGS = -g -O1 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize=undefined -fsanitize=nullability # From https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html
 
 SHA3_INC_DIR = ./sha3/include
 SUBTLE_INC_DIR = ./subtle/include
@@ -12,12 +14,18 @@ DEP_IFLAGS = -I $(SHA3_INC_DIR) -I $(SUBTLE_INC_DIR)
 SRC_DIR = include
 KYBER_SOURCES := $(wildcard $(SRC_DIR)/*.hpp)
 BUILD_DIR = build
+ASAN_BUILD_DIR = $(BUILD_DIR)/asan
+UBSAN_BUILD_DIR = $(BUILD_DIR)/ubsan
 
 TEST_DIR = tests
 TEST_SOURCES := $(wildcard $(TEST_DIR)/*.cpp)
 TEST_OBJECTS := $(addprefix $(BUILD_DIR)/, $(notdir $(patsubst %.cpp,%.o,$(TEST_SOURCES))))
+ASAN_TEST_OBJECTS := $(addprefix $(ASAN_BUILD_DIR)/, $(notdir $(patsubst %.cpp,%.o,$(TEST_SOURCES))))
+UBSAN_TEST_OBJECTS := $(addprefix $(UBSAN_BUILD_DIR)/, $(notdir $(patsubst %.cpp,%.o,$(TEST_SOURCES))))
 TEST_LINK_FLAGS = -lgtest -lgtest_main
 TEST_BINARY = $(BUILD_DIR)/test.out
+ASAN_TEST_BINARY = $(ASAN_BUILD_DIR)/test.out
+UBSAN_TEST_BINARY = $(UBSAN_BUILD_DIR)/test.out
 
 BENCHMARK_DIR = benchmarks
 BENCHMARK_SOURCES := $(wildcard $(BENCHMARK_DIR)/*.cpp)
@@ -29,6 +37,12 @@ PERF_BINARY = $(BUILD_DIR)/perf.out
 
 all: test
 
+$(ASAN_BUILD_DIR):
+	mkdir -p $@
+
+$(UBSAN_BUILD_DIR):
+	mkdir -p $@
+
 $(BUILD_DIR):
 	mkdir -p $@
 
@@ -40,12 +54,30 @@ $(SUBTLE_INC_DIR): $(SHA3_INC_DIR)
 $(BUILD_DIR)/%.o: $(TEST_DIR)/%.cpp $(BUILD_DIR) $(SHA3_INC_DIR) $(SUBTLE_INC_DIR)
 	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(I_FLAGS) $(DEP_IFLAGS) -c $< -o $@
 
+$(ASAN_BUILD_DIR)/%.o: $(TEST_DIR)/%.cpp $(ASAN_BUILD_DIR) $(SHA3_INC_DIR) $(SUBTLE_INC_DIR)
+	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(ASAN_FLAGS) $(I_FLAGS) $(DEP_IFLAGS) -c $< -o $@
+
+$(UBSAN_BUILD_DIR)/%.o: $(TEST_DIR)/%.cpp $(UBSAN_BUILD_DIR) $(SHA3_INC_DIR) $(SUBTLE_INC_DIR)
+	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(UBSAN_FLAGS) $(I_FLAGS) $(DEP_IFLAGS) -c $< -o $@
+
 $(TEST_BINARY): $(TEST_OBJECTS)
 	$(CXX) $(OPT_FLAGS) $(LINK_FLAGS) $^ $(TEST_LINK_FLAGS) -o $@
 
+$(ASAN_TEST_BINARY): $(ASAN_TEST_OBJECTS)
+	$(CXX) $(ASAN_FLAGS) $^ $(TEST_LINK_FLAGS) -o $@
+
+$(UBSAN_TEST_BINARY): $(UBSAN_TEST_OBJECTS)
+	$(CXX) $(UBSAN_FLAGS) $^ $(TEST_LINK_FLAGS) -o $@
+
 test: $(TEST_BINARY)
 	./$< --gtest_shuffle --gtest_random_seed=0
 
+asan_test: $(ASAN_TEST_BINARY)
+	./$< --gtest_shuffle --gtest_random_seed=0
+
+ubsan_test: $(UBSAN_TEST_BINARY)
+	./$< --gtest_shuffle --gtest_random_seed=0
+
 $(BUILD_DIR)/%.o: $(BENCHMARK_DIR)/%.cpp $(BUILD_DIR) $(SHA3_INC_DIR) $(SUBTLE_INC_DIR)
 	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(I_FLAGS) $(DEP_IFLAGS) -c $< -o $@