Merge pull request #27 from itzmeanjan/refactor-makefile

Refactor Build System, Source Tree
itzmeanjan · Nov 4, 2024 · fb21648 · fb21648
2 parents b238adf + b235bc9
commit fb21648
Show file tree

Hide file tree

Showing 44 changed files with 10,669 additions and 1,718 deletions.
diff --git a/.clang-format b/.clang-format
@@ -81,7 +81,7 @@ BreakBeforeTernaryOperators: true
 BreakConstructorInitializers: BeforeComma
 BreakInheritanceList: BeforeComma
 BreakStringLiterals: true
-ColumnLimit:     80
+ColumnLimit:     120
 CommentPragmas:  '^ IWYU pragma:'
 CompactNamespaces: false
 ConstructorInitializerIndentWidth: 2

diff --git a/.github/workflows/test_ci.yml b/.github/workflows/test_ci.yml
@@ -1,4 +1,4 @@
-# Collects inspiration from https://github.com/itzmeanjan/dilithium/blob/15c2280f9448b3631a571ee2f33f8b0c695d4788/.github/workflows/test_ci.yml
+# Collects inspiration from https://github.com/itzmeanjan/frodoPIR/blob/aa654db3d11384fce73086cbbd37c63e0cb30e33/.github/workflows/test_ci.yml
 name: Test SHA3 Hash and Extendable Output Functions
 
 on:
@@ -8,31 +8,43 @@ on:
     branches: [ "master" ]
 
 jobs:
-  build-on-nix:
+  build:
     runs-on: ${{matrix.os}}
     strategy:
       matrix:
-        # From https://github.com/actions/runner-images#available-images
-        os: [ubuntu-latest, macos-latest, flyci-macos-large-latest-m1, flyci-macos-large-latest-m2]
+        os: [ubuntu-latest, macos-latest]
+        compiler: [g++, clang++]
+        build_type: [debug, release]
+        test_type: [standard, asan, ubsan]
 
     steps:
     - uses: actions/checkout@v4
     - name: Setup Google-Test
       run: |
         pushd ~
-        git clone https://github.com/google/googletest.git -b v1.14.0
+        git clone https://github.com/google/googletest.git -b v1.15.2
         pushd googletest
         mkdir build
         pushd build
         cmake .. -DBUILD_GMOCK=OFF
-        make
-        sudo make install
+        make -j
+        sudo make -j install
         popd
         popd
         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
+    - name: Execute Tests on ${{matrix.os}}, compiled with ${{matrix.compiler}}
+      if: ${{matrix.test_type == 'standard'}}
+      run: |
+        CXX=${{matrix.compiler}} make test -j
+        make clean
+
+    - name: Execute Tests with ${{matrix.test_type}}, in ${{matrix.build_type}} mode, on ${{matrix.os}}, compiled with ${{matrix.compiler}}
+      if: ${{matrix.test_type != 'standard'}}
+      run: |
+        CXX=${{matrix.compiler}} make ${{matrix.build_type}}_${{matrix.test_type}}_test -j
+        make clean
+
+    - name: Build and run examples
+      run: |
+        make example -j
+        make clean
diff --git a/Makefile b/Makefile
@@ -1,113 +1,40 @@
-CXX ?= clang++
-CXX_FLAGS = -std=c++20
-WARN_FLAGS = -Wall -Wextra -pedantic
-OPT_FLAGS = -O3 -march=native
-LINK_FLAGS = -flto
-I_FLAGS = -I ./include
-PERF_DEFS = -DCYCLES_PER_BYTE
-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 # From https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html
-
-SRC_DIR = include
-SHA3_SOURCES := $(wildcard $(SRC_DIR)/*.hpp)
-BUILD_DIR = build
-
-TEST_DIR = tests
-TEST_BUILD_DIR := $(BUILD_DIR)/$(TEST_DIR)
-ASAN_BUILD_DIR = $(TEST_BUILD_DIR)/asan
-UBSAN_BUILD_DIR = $(TEST_BUILD_DIR)/ubsan
-TEST_SOURCES := $(wildcard $(TEST_DIR)/*.cpp)
-TEST_OBJECTS := $(addprefix $(TEST_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 = $(TEST_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)
-BENCHMARK_BUILD_DIR := $(BUILD_DIR)/$(BENCHMARK_DIR)
-PERF_BUILD_DIR := $(BUILD_DIR)/perfs
-BENCHMARK_OBJECTS := $(addprefix $(BENCHMARK_BUILD_DIR)/, $(notdir $(patsubst %.cpp,%.o,$(BENCHMARK_SOURCES))))
-PERF_OBJECTS := $(addprefix $(PERF_BUILD_DIR)/, $(notdir $(patsubst %.cpp,%.o,$(BENCHMARK_SOURCES))))
-BENCHMARK_LINK_FLAGS = -lbenchmark -lbenchmark_main
-BENCHMARK_BINARY = $(BENCHMARK_BUILD_DIR)/bench.out
-PERF_LINK_FLAGS = -lbenchmark -lbenchmark_main -lpfm
-PERF_BINARY = $(PERF_BUILD_DIR)/perf.out
-GTEST_PARALLEL = ./gtest-parallel/gtest-parallel
-
-all: test
+.DEFAULT_GOAL := help
 
-$(TEST_BUILD_DIR):
-	mkdir -p $@
+# Collects inspiration from https://github.com/0xPolygonMiden/crypto/blob/3909b0199368b13fdfa934a324f984572d521e39/Makefile#L1-L5
+# and https://github.com/gtramontina/sourcing/blob/853252ee184c16bc69dd53e8457107d718aca04f/Makefile#L68-L72
+.PHONY: help
+help:
+	@for file in $(MAKEFILE_LIST); do \
+		grep -E '^[a-zA-Z_-]+:.*?## .*$$' $${file} | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}';\
+	done
 
-$(ASAN_BUILD_DIR):
-	mkdir -p $@
 
-$(UBSAN_BUILD_DIR):
-	mkdir -p $@
+CXX ?= clang++
+CXX_DEFS +=
+CXX_FLAGS := -std=c++20
+WARN_FLAGS := -Wall -Wextra -Wpedantic
+DEBUG_FLAGS := -O1 -g
+RELEASE_FLAGS := -O3 -march=native
+LINK_OPT_FLAGS := -flto
+
+I_FLAGS := -I ./include
+PERF_DEFS = -DCYCLES_PER_BYTE
 
-$(BENCHMARK_BUILD_DIR):
-	mkdir -p $@
+SRC_DIR := include
+SHA3_SOURCES := $(shell find $(SRC_DIR) -name '*.hpp')
+BUILD_DIR := build
 
-$(PERF_BUILD_DIR):
-	mkdir -p $@
+include tests/test.mk
+include benches/bench.mk
+include examples/example.mk
 
 $(GTEST_PARALLEL):
-	git submodule update --init
-
-$(TEST_BUILD_DIR)/%.o: $(TEST_DIR)/%.cpp $(TEST_BUILD_DIR)
-	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(I_FLAGS) -c $< -o $@
-
-$(ASAN_BUILD_DIR)/%.o: $(TEST_DIR)/%.cpp $(ASAN_BUILD_DIR)
-	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(ASAN_FLAGS) $(I_FLAGS) -c $< -o $@
-
-$(UBSAN_BUILD_DIR)/%.o: $(TEST_DIR)/%.cpp $(UBSAN_BUILD_DIR)
-	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(UBSAN_FLAGS) $(I_FLAGS) -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_PARALLEL)
-	$(GTEST_PARALLEL) $< --print_test_times
-
-asan_test: $(ASAN_TEST_BINARY) $(GTEST_PARALLEL)
-	$(GTEST_PARALLEL) $< --print_test_times
-
-ubsan_test: $(UBSAN_TEST_BINARY) $(GTEST_PARALLEL)
-	$(GTEST_PARALLEL) $< --print_test_times
-
-$(BENCHMARK_BUILD_DIR)/%.o: $(BENCHMARK_DIR)/%.cpp $(BENCHMARK_BUILD_DIR)
-	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(I_FLAGS) -c $< -o $@
-
-$(PERF_BUILD_DIR)/%.o: $(BENCHMARK_DIR)/%.cpp $(PERF_BUILD_DIR)
-	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(PERF_DEFS) $(I_FLAGS) -c $< -o $@
-
-$(BENCHMARK_BINARY): $(BENCHMARK_OBJECTS)
-	$(CXX) $(OPT_FLAGS) $(LINK_FLAGS) $^ $(BENCHMARK_LINK_FLAGS) -o $@
-
-benchmark: $(BENCHMARK_BINARY)
-	# Must *not* build google-benchmark with libPFM
-	./$< --benchmark_min_warmup_time=.1 --benchmark_enable_random_interleaving=true --benchmark_repetitions=10 --benchmark_min_time=0.1s --benchmark_counters_tabular=true --benchmark_display_aggregates_only=true
-
-$(PERF_BINARY): $(PERF_OBJECTS)
-	$(CXX) $(OPT_FLAGS) $(LINK_FLAGS) $^ $(PERF_LINK_FLAGS) -o $@
-
-perf: $(PERF_BINARY)
-	# Must build google-benchmark with libPFM, follow https://gist.github.com/itzmeanjan/05dc3e946f635d00c5e0b21aae6203a7
-	./$< --benchmark_min_warmup_time=.1 --benchmark_enable_random_interleaving=true --benchmark_repetitions=10 --benchmark_min_time=0.1s --benchmark_counters_tabular=true --benchmark_display_aggregates_only=true --benchmark_perf_counters=CYCLES
-
-.PHONY: format clean
+	git submodule update --init gtest-parallel
 
-clean:
+.PHONY: clean
+clean: ## Remove build directory
 	rm -rf $(BUILD_DIR)
 
-format: $(SHA3_SOURCES) $(TEST_SOURCES) $(BENCHMARK_SOURCES)
+.PHONY: format
+format: $(SHA3_SOURCES) $(TEST_SOURCES) $(TEST_HEADERS) $(BENCHMARK_SOURCES) $(BENCHMARK_HEADERS) $(EXAMPLE_SOURCES) $(EXAMPLE_HEADERS) ## Format source code
 	clang-format -i $^