PDS/homework_1/Makefile

#
# PDS homework_1 Makefile
#
# Copyright (C) 2024 Christos Choutouridis <christos@choutouridis.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation, either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

# ============== Project settings ==============
# Project's name
PROJECT         := PDS_homework_1
# Excecutable's name
TARGET          := knnsearch
# Source directories list(space seperated). Makefile-relative path, UNDER current directory.
SRC_DIR_LIST    := src gtest
# Include directories list(space seperated). Makefile-relative path.
INC_DIR_LIST    := inc \
                   src \
                   gtest \
                   /usr/include/hdf5/serial/
#                   Libs/MATLAB/R2019b/include/ \

# Exclude files list(space seperated). Filenames only.
# EXC_FILE_LIST := bad.cpp old.cpp

# Build directories
BUILD_DIR       := bin
OBJ_DIR         := $(BUILD_DIR)/obj
DEP_DIR         := $(BUILD_DIR)/.dep


# ========== Compiler settings ==========
# Compiler flags for debug and release
DEB_CFLAGS      := -DDEBUG -g3 -Wall -Wextra -std=c11
REL_CFLAGS      := -Wall -Wextra -O3 -std=c11
DEB_CXXFLAGS    := -DDEBUG -g3 -Wall -Wextra -std=c++17
REL_CXXFLAGS    := -Wall -Wextra -O3 -std=c++17

# Pre-defines
# PRE_DEFS := MYCAB=1729 SUPER_MODE
PRE_DEFS		:=

# ============== Linker settings ==============
# Linker flags (example: -pthread -lm)
LDFLAGS         := -pthread -lopenblas \
                   -L/usr/lib/x86_64-linux-gnu/hdf5/serial -lhdf5
#                   -LLibs/MATLAB/R2019b/bin/ -lmat -lmx -Wl,-rpath,Libs/MATLAB/R2019b/bin/ \

# Map output file
MAP_FILE        := output.map
MAP_FLAG        := -Xlinker -Map=$(BUILD_DIR)/$(MAP_FILE)

# ============== Docker settings ==============
# We need:
#  - Bind the entire project directory(the dir that icludes all the code) as volume.
#  - In docker instance, change to working directory(where the makefile is).
DOCKER_VOL_DIR  := ${PWD}
DOCKER_WRK_DIR  :=
DOCKER_RUN      := docker run --rm
DOCKER_FLAGS    := -v $(DOCKER_VOL_DIR):/usr/src/$(PROJECT) -w /usr/src/$(PROJECT)/$(DOCKER_WRK_DIR)

# docker invoke mechanism (edit with care)
#   note:
#   Here, `DOCKER` variable is empty. Rules can assign `DOCKER := DOCKER_CMD` when docker
#   functionality is needed.
DOCKER_CMD      = $(DOCKER_RUN) $(DOCKER_FLAGS) $(IMAGE)
DOCKER          :=

# ============== Tool selection ==============
# compiler and compiler flags.
CSIZE           := size
CFLAGS          := $(DEB_CFLAGS)
CXXFLAGS		:= $(DEB_CXXFLAGS)
CXX             := g++
CC              := gcc

#
# =========== Main body and Patterns ===========
#

#ifeq ($(OS), Windows_NT)
#	TARGET := $(TARGET).exe
#endif
INC     := $(foreach dir,$(INC_DIR_LIST),-I$(dir))
DEF     := $(foreach def,$(PRE_DEFS),-D$(def))
EXC     := $(foreach fil,$(EXC_FILE_LIST),                              \
               $(foreach dir,$(SRC_DIR_LIST),$(wildcard $(dir)/$(fil))) \
           )
# source files. object and dependencies list
# recursive search into current and source directories
SRC     := $(wildcard *.cpp)
SRC     += $(foreach dir,$(SRC_DIR_LIST),$(wildcard $(dir)/*.cpp))
SRC     += $(foreach dir,$(SRC_DIR_LIST),$(wildcard $(dir)/**/*.cpp))
SRC     := $(filter-out $(EXC),$(SRC))
#SRC     := $(abspath $(SRC))

OBJ     := $(foreach file,$(SRC:%.cpp=%.o),$(OBJ_DIR)/$(file))
DEP     := $(foreach file,$(SRC:%.cpp=%.d),$(DEP_DIR)/$(file))


# Make Dependencies pattern.
# This little trick enables recompilation only when dependencies change
# and it does so for changes both in source AND header files ;)
# 
# It is based on Tom Tromey's method.
# 
# Invoke cpp to create makefile rules with dependencies for each source file
$(DEP_DIR)/%.d: %.c
	@mkdir -p $(@D)
	@$(DOCKER) $(CC) -E $(CFLAGS) $(INC) $(DEF) -MM -MT $(OBJ_DIR)/$(<:.c=.o) -MF $@ $<

# c file objects depent on .c AND dependency files, which have an empty recipe 
$(OBJ_DIR)/%.o: %.c $(DEP_DIR)/%.d
	@mkdir -p $(@D)
	$(DOCKER) $(CC) -c $(CFLAGS) $(INC) $(DEF) -o $@ $<

$(DEP_DIR)/%.d: %.cpp
	@mkdir -p $(@D)
	@$(DOCKER) $(CXX) -E $(CXXFLAGS) $(INC) $(DEF) -MM -MT $(OBJ_DIR)/$(<:.cpp=.o) -MF $@ $<

# cpp file objects depent on .cpp AND dependency files, which have an empty recipe 
$(OBJ_DIR)/%.o: %.cpp $(DEP_DIR)/%.d
	@mkdir -p $(@D)
	$(DOCKER) $(CXX) -c $(CXXFLAGS) $(INC) $(DEF) -o $@ $<

# empty recipe for dependency files. This prevents make errors
$(DEP):

# now include all dependencies
# After all they are makefile dependency rules ;)
include $(wildcard $(DEP))

# main target rule
$(BUILD_DIR)/$(TARGET): $(OBJ)
	@mkdir -p $(@D)
	@echo Linking to target: $(TARGET)
	@echo $(DOCKER) $(CXX) '$$(OBJ)' $(LDFLAGS) $(MAP_FLAG) -o $(@D)/$(TARGET)
	@$(DOCKER) $(CXX) $(OBJ) $(LDFLAGS) $(MAP_FLAG) -o $(@D)/$(TARGET)
	@echo
	@echo Print size information
	@$(CSIZE) $(@D)/$(TARGET)
	@echo Done

.PHONY: clean
clean:
	@echo Cleaning build directories
	@rm -rf $(OBJ_DIR)
	@rm -rf $(DEP_DIR)
	@rm -rf $(BUILD_DIR)

#
# ================ Local build rules =================
# example:
# make debug

debug: CFLAGS := $(DEB_CFLAGS)
debug: $(BUILD_DIR)/$(TARGET)

release: CFLAGS := $(REL_CFLAGS)
release: $(BUILD_DIR)/$(TARGET)

all: release

hpc-results/post:
	$(CXX) $(CFLAGS) -o $@ hpc-results/main.cpp 

hpc-clean:
	rm hpc-results/post

#
# ================ Local via docker build rules =================
#
# examples:
# make IMAGE=hpcimage v0
# make IMAGE=hpcimage v1_cilk
#
local_v0: CFLAGS := $(DEB_CFLAGS) -DCODE_VERSION=0
local_v0: CXXFLAGS := $(DEB_CXXFLAGS) -DCODE_VERSION=0
local_v0: TARGET := local_v0
local_v0: $(BUILD_DIR)/$(TARGET)
	cp $(BUILD_DIR)/$(TARGET) out/$(TARGET)

local_v0_opt: CFLAGS := $(REL_CFLAGS) -DCODE_VERSION=0
local_v0_opt: CXXFLAGS := $(REL_CXXFLAGS) -DCODE_VERSION=0
local_v0_opt: TARGET := local_v0_opt
local_v0_opt: $(BUILD_DIR)/$(TARGET)
	cp $(BUILD_DIR)/$(TARGET) out/$(TARGET)
	
local_v1: CFLAGS := $(DEB_CFLAGS) -DCODE_VERSION=1
local_v1: CXXFLAGS := $(DEB_CXXFLAGS) -DCODE_VERSION=1
local_v1: TARGET := local_v1
local_v1: $(BUILD_DIR)/$(TARGET)
	cp $(BUILD_DIR)/$(TARGET) out/$(TARGET)

v0: DOCKER := $(DOCKER_CMD)
v0: CFLAGS := $(REL_CFLAGS) -DCODE_VERSION=0
v0: CXXFLAGS := $(REL_CXXFLAGS) -DCODE_VERSION=0
v0: TARGET := knnsearch_v0
v0: $(BUILD_DIR)/$(TARGET)
	cp $(BUILD_DIR)/$(TARGET) out/$(TARGET)

v1_cilk: DOCKER := $(DOCKER_CMD)
v1_cilk: CXX    := /usr/local/OpenCilk-9.0.1-Linux/bin/clang++
v1_cilk: CFLAGS := $(REL_CFLAGS) -fcilkplus -DCODE_VERSION=1 -DCILK
v1_cilk: CXXFLAGS := $(REL_CXXFLAGS) -fcilkplus -DCODE_VERSION=1 -DCILK
v1_cilk: LDFLAGS += -fcilkplus
v1_cilk: TARGET := knnsearch_cilkv1
v1_cilk: $(BUILD_DIR)/$(TARGET)
	cp $(BUILD_DIR)/$(TARGET) out/$(TARGET)

v1_omp: DOCKER := $(DOCKER_CMD)
v1_omp: CFLAGS := $(REL_CFLAGS) -fopenmp -DCODE_VERSION=1 -DOMP
v1_omp: CXXFLAGS := $(REL_CXXFLAGS) -fopenmp -DCODE_VERSION=1 -DOMP
v1_omp: LDFLAGS += -fopenmp
v1_omp: TARGET := knnsearch_ompv1
v1_omp: $(BUILD_DIR)/$(TARGET)
	cp $(BUILD_DIR)/$(TARGET) out/$(TARGET)

v1: DOCKER := $(DOCKER_CMD)
v1: CFLAGS := $(REL_CFLAGS) -DCODE_VERSION=1
v1: CXXFLAGS := $(REL_CXXFLAGS) -DCODE_VERSION=1
v1: TARGET := knnsearch_v1
v1: $(BUILD_DIR)/$(TARGET)
	cp $(BUILD_DIR)/$(TARGET) out/$(TARGET)

tests: CFLAGS := $(DEB_CFLAGS) -DCODE_VERSION=0 -DTESTING
tests: CXXFLAGS := $(DEB_CXXFLAGS) -DCODE_VERSION=0 -DTESTING
tests: TARGET := tests
tests: $(BUILD_DIR)/$(TARGET)
	cp $(BUILD_DIR)/$(TARGET) out/$(TARGET)
	
	
#
# ========= Inside CSAL Image build rules ===========
#
# 1) first jump into image (make sure you are in the directory where Makefile is):
#    > docker run -it -v ${PWD}:/usr/src/exercise_1 -w /usr/src/exercise_1/ hpcimage
# 2) Clean binaries first **important**
#    > make clean
# 3) for v4 cilk for example:
#    > make csal_v4_cilk
# 4) run executables from `bin/`. Examples:
#    > ./bin/tcount_ompv3 -i mtx/NACA0015.mtx --timing -r 3 -o /dev/null
#    > ./bin/tcount_pthv4 -i mtx/com_Youtube.mtx --timing --dynamic --print_count

csal_v0: CFLAGS := $(REL_CFLAGS) -DCODE_VERSION=0
csal_v0: TARGET := knnsearch_v0
csal_v0: $(BUILD_DIR)/$(TARGET)

csal_v1_cilk: CXX    := /usr/local/OpenCilk-9.0.1-Linux/bin/clang++
csal_v1_cilk: CFLAGS := $(REL_CFLAGS) -fcilkplus -DCODE_VERSION=1 -DCILK
csal_v1_cilk: CXXFLAGS := $(REL_CXXFLAGS) -fcilkplus -DCODE_VERSION=1 -DCILK
csal_v1_cilk: LDFLAGS += -fcilkplus
csal_v1_cilk: TARGET := knnsearch_cilkv1
csal_v1_cilk: $(BUILD_DIR)/$(TARGET)

csal_v1_omp: CFLAGS := $(REL_CFLAGS) -fopenmp -DCODE_VERSION=1 -DOMP
csal_v1_omp: CXXFLAGS := $(REL_CXXFLAGS) -fopenmp -DCODE_VERSION=1 -DOMP
csal_v1_omp: LDFLAGS += -fopenmp
csal_v1_omp: TARGET := knnsearch_ompv1
csal_v1_omp: $(BUILD_DIR)/$(TARGET)

csal_v1: CFLAGS := $(REL_CFLAGS) -DCODE_VERSION=1
csal_v1: CXXFLAGS := $(REL_CXXFLAGS) -DCODE_VERSION=1
csal_v1: TARGET := knnsearch_v1
csal_v1: $(BUILD_DIR)/$(TARGET)


#
# ======== Run from container =========
#
# examples:
#
# make IMAGE=hpcimage EXEC=knnsearch_v1 run
# make IMAGE=hpcimage EXEC=knnsearch_v1 run
#

run:
	$(DOCKER) ./out/$(EXEC)