Makefile

# 
# Makefile - make file for rarray
#
# Copyright (c) 2013-2024  Ramses van Zon
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# To install the header files:             make install [PREFIX=directory]
#
# This is the only required action.  If (optionally) you want to run
# the tests and benchmarks, first run './configure' to detect the
# compiler and certain libraries and create config.mk with the
# results, then you can do the following:
#
# To build and run tests:                 make test valgrindtest
# To build and run the benchmarks:        make benchmarks
# To rebuild the header:                  make header
# To rebuild the documentation:           make doc
#

-include config.mk

SRC=src
HS=headersources

PREFIX?=/usr

LDFLAGS?=
LDLIBS?= 
LDFLAGSOPT?=
LDLIBSOPT?=
CXXFLAGS?=-std=c++11 -Og
DBGFLAGS?=-g
CXXFLAGSOPT?=-O3
MORECPPFLAGSOPT?=-DNOBLITZ -DNOBOOST -DNOEIGEN3 -DNOARMADILLO -DNOOPENBLAS
MORELDFLAGSOPT?=
FC?=gfortran
FFLAGS?=-O2
NOELIDECONSTRUCTORS?=

CPPFLAGS+= -I. -I${HS}

# allow coverage of tests
LDFLAGSCOV?=-fprofile-arcs -ftest-coverage
CXXFLAGSCOV?=-fprofile-arcs -ftest-coverage
LIBSCOV?=
GCOV?=gcov -trkm
FILTERCOV?=awk

VALGRIND?=valgrind --leak-check=full

BENCHMARK2DNAME=benchmark2Daccess
BENCHMARK4DNAME=benchmark4Daccess
BENCHMARK2DNAMEF=benchmark2Dfrtrn
BENCHMARK4DNAMEF=benchmark4Dfrtrn
BENCHMARK2DNAME23=benchmark2Daccess23
BENCHMARK4DNAME23=benchmark4Daccess23
PASS=optbarrier

.PHONY: help
help:
	@echo ""
	@echo "This makefile can install, test, and benchmark the rarray library."
	@echo ""
	@echo "  To install the header files:            make install [PREFIX=directory]"
	@echo ""
	@echo "This is the only required action.  If (optionally) you want to run tests and benchmarks, first run './configure' to detect the compiler and certain libraries and create config.mk with the results, then you can do the following:"
	@echo ""
	@echo "  To build and run tests:                 make test valgrindtest"
	@echo "  To build and run benchmarks:            make benchmarks"
	@echo "  To rebuild the header:                  make header"
	@echo "  To rebuild the documentation:           make doc"
	@echo "  To build and run c++23 tests:           make test23 valgrindtest23"
	@echo ""

.PHONY: header
header: rarray

.PHONY: all
all: header test valgrindtest test23 valgrindtest23 benchmarks

.PHONY: test
test: run_testsuite  run_testsuite_bc  run_test_shared_buffer  run_test_offsets \
      run_test_shared_shape  run_test_rarray

.PHONY: test23
test23: run_testsuite23  run_testsuite_bc23 run_test_rarray23

.PHONY: valgrindtest
valgrindtest: run_valgrind_testsuite  run_valgrind_testsuite_bc \
              run_valgrind_test_shared_buffer  run_valgrind_test_offsets \
              run_valgrind_test_shared_shape  run_valgrind_test_rarray 

.PHONY: valgrindtest23
valgrindtest23: run_valgrind_testsuite23  run_valgrind_testsuite_bc23 \
              run_valgrind_test_rarray23 

.PHONY: benchmarks
benchmarks: run_benchmark2d  run_benchmark4d

.PHONY: doc
doc: rarraydoc.pdf doc-devel/html/index.html
rarraydoc.pdf: rarraydoc.tex
	pdflatex $^ && pdflatex $^

doc-devel/html/index.html: Doxyfile.devel rarray
	doxygen $<

.PHONY: lint
lint: clang-tidy-output/clang-tidy-rarray.out
clang-tidy-output/clang-tidy-rarray.out: headersources/rarray.h
	mkdir -p clang-tidy-output && clang-tidy -checks=modernize-*,cppcoreguidelines-*, $< -extra-arg-before=-xc++ > $@

hardinclude: ${SRC}/hardinclude.cc
	${CXX} ${CPPFLAGS} ${CXXFLAGS} -o $@ $^

VERSION:
	git describe --abbrev=0 > $@

${HS}/versionheader.h: VERSION
	echo "// define rarray version (i.e. latest git tag)" > $@
	echo "#define RA_VERSION \"" | tr -d '\n' >> $@
	cat VERSION | tr -d '\n' >> $@
	echo "\"" >> $@
	echo "#define RA_VERSION_NUMBER " | tr -d '\n' >> $@
	cat VERSION | tr -dc '0-9.\n' | awk -F\. '{print 1000000*$$1 + 1000*$$2 + $$3}' >> $@

MYDIR := $(shell dirname "$(abspath $(lastword $(MAKEFILE_LIST)))")
rarray: ${HS}/rarray.h ${HS}/rarraymacros.h ${HS}/rarraytypes.h ${HS}/rarraydelmacros.h ${HS}/shared_buffer.h ${HS}/shared_shape.h ${HS}/offsets.h ${HS}/rarrayio.h ${HS}/versionheader.h hardinclude
	cd ${HS} ; "${MYDIR}"/hardinclude rarray.h rarraymacros.h rarraytypes.h rarraydelmacros.h shared_buffer.h shared_shape.h rarrayio.h offsets.h versionheader.h > "${MYDIR}"/rarray

.PHONY: install
install: rarray rarraydoc.pdf
	mkdir -p ${PREFIX}/include
	cp -f rarray ${PREFIX}/include/rarray
	mkdir -p ${PREFIX}/share/rarray
	cp -f rarraydoc.pdf ${PREFIX}/share/rarray

testsuite: testsuite.o
	${CXX} ${LDFLAGS} ${LDFLAGSCOV} -o $@ $< ${LIBSCOV}

testsuite23: testsuite23.o
	echo 'echo "Skipped; c++23 not supported"' > $@ && chmod +x $@
	${CXX23} ${LDFLAGS} ${LDFLAGSCOV} -o $@ $< ${LIBSCOV}

testsuite.o: ${SRC}/testsuite.cc rarray catch.hpp
	${CXX} ${CPPFLAGS} ${CXXFLAGS} ${CXXFLAGSCOV} -g -O0 -c -o $@ $<

testsuite23.o: ${SRC}/testsuite.cc rarray catch.hpp
	${CXX23} ${CPPFLAGS} ${CXXFLAGS} ${CXXFLAGSCOV} -g -O0 -c -o $@ $<

testsuite_bc: testsuite_bc.o
	${CXX} ${LDFLAGS} ${LDFLAGSCOV} -o $@ $< ${LIBSCOV}

testsuite_bc23: testsuite_bc23.o
	echo 'echo "Skipped; c++23 not supported"' > $@ && chmod +x $@
	${CXX23} ${LDFLAGS} ${LDFLAGSCOV} -o $@ $< ${LIBSCOV}

testsuite_bc.o: ${SRC}/testsuite.cc rarray catch.hpp
	${CXX} ${CPPFLAGS} ${CXXFLAGS} ${CXXFLAGSCOV} -DRA_BOUNDSCHECK -g -O0 -c -o $@ $<

testsuite_bc23.o: ${SRC}/testsuite.cc rarray catch.hpp
	${CXX23} ${CPPFLAGS} ${CXXFLAGS} ${CXXFLAGSCOV} -DRA_BOUNDSCHECK -g -O0 -c -o $@ $<

catch.hpp:
	curl -Lo catch.hpp https://github.com/catchorg/Catch2/releases/download/v2.11.1/catch.hpp
	sed -i 's/\(static constexpr std::size_t sigStackSize = 32768\).*/\1;\/\//' catch.hpp

test_shared_buffer.o: ${SRC}/test_shared_buffer.cc ${HS}/shared_buffer.h catch.hpp
	${CXX} ${CPPFLAGS} ${CXXFLAGS} ${DBGFLAGS} ${CXXFLAGSCOV} -c -o $@ $<

test_shared_buffer: test_shared_buffer.o
	${CXX} ${LDFLAGS} ${LDFLAGSCOV} -o $@ $^ ${LIBSCOV}

test_offsets.o: ${SRC}/test_offsets.cc ${HS}/offsets.h catch.hpp
	${CXX} ${CPPFLAGS} ${CXXFLAGS} ${CXXFLAGSCOV} ${DBGFLAGS} -c -o $@ $<

test_offsets: test_offsets.o
	${CXX} ${LDFLAGS} ${LDFLAGSCOV} ${DBGFLAGS} -o $@ $^ ${LIBSCOV}

test_shared_shape.o: ${SRC}/test_shared_shape.cc ${HS}/shared_shape.h ${HS}/offsets.h
	${CXX} ${CPPFLAGS} ${CXXFLAGS} ${CXXFLAGSCOV} ${DBGFLAGS} ${NOELIDECONSTRUCTORS} -c -o $@ $<

test_shared_shape: test_shared_shape.o
	${CXX} ${LDFLAGS} ${LDFLAGSCOV} ${DBGFLAGS} -o $@ $^ ${LIBSCOV}

test_rarray.o: ${SRC}/test_rarray.cc rarray
	${CXX} ${CPPFLAGS} ${CXXFLAGS} -DRA_BOUNDSCHECK ${DBGFLAGS} -c -o $@ $<

test_rarray23.o: ${SRC}/test_rarray.cc rarray
	${CXX23} ${CPPFLAGS} ${CXXFLAGS} -DRA_BOUNDSCHECK ${DBGFLAGS} -c -o $@ $<

test_rarray: test_rarray.o
	${CXX} ${LDFLAGS} -o $@ $^

test_rarray23: test_rarray23.o
	echo 'echo "Skipped; c++23 not supported"' > $@ && chmod +x $@
	${CXX23} ${LDFLAGS} -o $@ $^

.PHONY: clean
clean:
	${RM} test_shared_buffer.o test_offsets.o test_shared_shape.o test_rarray.o test_rarray23.o testsuite.o testsuite23.o testsuite_bc.o testsuite_bc23.o benchmark2Daccess.o benchmark2Daccess23.o benchmark4Daccess.o benchmark4Daccess23.o benchmark2Dfrtrn.o benchmark4Dfrtrn.o optbarrier.o optbarrierf.o rarraydoc.log rarraydoc.out rarraydoc.aux rarraydoc.toc catch.hpp *.gcno *.gcda *.gcov clang-tidy-output/clang-tidy-rarray.out hardinclude.o hardinclude

.PHONY: distclean
distclean:
	make clean
	make rarray doc	
	make clean
	${RM} test_shared_buffer test_offsets test_shared_shape test_rarray test_rarray23 testsuite testsuite_bc testsuite23 testsuite_bc23 hardinclude benchmark2Daccess benchmark4Daccess benchmark2Daccess23 benchmark4Daccess23 benchmark2Dfrtrn benchmark4Dfrtrn config.mk coverage/*
	rmdir coverage

coverage:
	mkdir -p coverage

coverage23:
	mkdir -p coverage23

.PHONY: run_test_shared_buffer
run_test_shared_buffer: test_shared_buffer coverage
	./test_shared_buffer -d yes
	${GCOV} ./test_shared_buffer.o | \
	( ${FILTERCOV} '/0:Source:headersources\/shared_buffer.h/{f=1}/0:Colorization:/{f=0}f' || true ) \
	> coverage/$@

.PHONY: run_valgrind_test_shared_buffer
run_valgrind_test_shared_buffer: test_shared_buffer
	${VALGRIND} ./test_shared_buffer -e

.PHONY: run_test_offsets
run_test_offsets: test_offsets coverage
	./test_offsets -d yes
	${GCOV} ./test_offsets.o | \
	( ${FILTERCOV} '/0:Source:headersources\/offsets.h/{f=1}/0:Colorization:/{f=0}f' || true ) \
	> coverage/$@

.PHONY: run_valgrind_test_offsets
run_valgrind_test_offsets: test_offsets
	${VALGRIND} ./test_offsets -e

.PHONY: run_test_shared_shape
run_test_shared_shape: test_shared_shape coverage
	./test_shared_shape
	${GCOV} ./test_shared_shape.o | \
	( ${FILTERCOV} '/0:Source:headersources\/shared_shape.h/{f=1}/0:Colorization:/{f=0}f' || true ) \
	> coverage/$@

.PHONY: run_valgrind_test_shared_shape
run_valgrind_test_shared_shape: test_shared_shape
	${VALGRIND} ./test_shared_shape -e

.PHONY: run_test_rarray
run_test_rarray: test_rarray 
	./test_rarray

.PHONY: run_test_rarray23
run_test_rarray23: test_rarray23
	./test_rarray23

.PHONY: run_valgrind_test_rarray
run_valgrind_test_rarray: test_rarray
	${VALGRIND} ./test_rarray -e

.PHONY: run_valgrind_test_rarray23
run_valgrind_test_rarray23: test_rarray23
	${VALGRIND} ./test_rarray23 -e

.PHONY: run_testsuite
run_testsuite: testsuite coverage
	./testsuite -d yes
	${GCOV} ./testsuite.o | \
	( ${FILTERCOV} '/0:Source:rarray/{f=1}/0:Colorization:/{f=0}f' || true ) \
	> coverage/$@

.PHONY: run_testsuite23
run_testsuite23: testsuite23 coverage23
	./testsuite23 -d yes
	${GCOV} ./testsuite23.o | \
	( ${FILTERCOV} '/0:Source:rarray/{f=1}/0:Colorization:/{f=0}f' || true ) \
	> coverage23/$@

.PHONY: run_valgrind_testsuite
run_valgrind_testsuite: testsuite
	${VALGRIND} ./testsuite 

.PHONY: run_valgrind_testsuite23
run_valgrind_testsuite23: testsuite23
	${VALGRIND} ./testsuite23 

.PHONY: run_testsuite_bc
run_testsuite_bc: testsuite_bc coverage
	./testsuite_bc
	${GCOV} ./testsuite_bc.o | \
	( ${FILTERCOV} '/0:Source:rarray/{f=1}/0:Colorization:/{f=0}f' || true ) \
	> coverage/$@

.PHONY: run_testsuite_bc23
run_testsuite_bc23: testsuite_bc23 coverage23
	./testsuite_bc23
	${GCOV} ./testsuite_bc23.o | \
	( ${FILTERCOV} '/0:Source:rarray/{f=1}/0:Colorization:/{f=0}f' || true ) \
	> coverage23/$@

.PHONY: run_valgrind_testsuite_bc
run_valgrind_testsuite_bc: testsuite_bc
	${VALGRIND} ./testsuite_bc 

.PHONY: run_valgrind_testsuite_bc23
run_valgrind_testsuite_bc23: testsuite_bc23
	${VALGRIND} ./testsuite_bc23 

.PHONY: run_benchmark2d
run_benchmark2d: $(BENCHMARK2DNAME) $(BENCHMARK2DNAMEF) $(BENCHMARK2DNAME23) 
	@echo Comparison benchmark on a 2d array example
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 1 || true)  
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 2 || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 3  || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 4  || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 5  || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 6  || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 7  || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 8  || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 9 || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 10 || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME23) 11  || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAMEF) || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME) 1 || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME23) 11 || true) 
	@(ulimit -s 4000000 && ./$(BENCHMARK2DNAME23) 10 || true) 

.PHONY: run_benchmark4d
run_benchmark4d: $(BENCHMARK4DNAME) $(BENCHMARK4DNAMEF) $(BENCHMARK4DNAME23) 
	@echo Comparison benchmark on a 4d array example
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 1  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 2 || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 3  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 4  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 5  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 6  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 7  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 8  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 9  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 10  || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME23) 11 || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAMEF) || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME) 1 || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME23) 11 || true) 
	@(ulimit -s 8000000 && ./$(BENCHMARK4DNAME23) 10 || true) 

$(BENCHMARK2DNAME): $(BENCHMARK2DNAME).o $(PASS).o config.mk
	$(CXX) $(LDFLAGSOPT) -o $@ $(BENCHMARK2DNAME).o $(PASS).o $(LDLIBS)

$(BENCHMARK4DNAME): $(BENCHMARK4DNAME).o $(PASS).o config.mk
	$(CXX) $(LDFLAGSOPT) -o $@ $(BENCHMARK4DNAME).o $(PASS).o $(LDLIBS)

$(BENCHMARK2DNAMEF): ${SRC}/$(BENCHMARK2DNAMEF).f90 $(PASS)f.o config.mk
	$(FC) $(FFLAGSOPT) -o $@ ${SRC}/$(BENCHMARK2DNAMEF).f90 $(PASS)f.o 

$(BENCHMARK4DNAMEF): ${SRC}/$(BENCHMARK4DNAMEF).f90 $(PASS)f.o config.mk
	$(FC) $(FFLAGSOPT) -o $@ ${SRC}/$(BENCHMARK4DNAMEF).f90 $(PASS)f.o 

$(BENCHMARK2DNAME23): $(BENCHMARK2DNAME23).o $(PASS).o config.mk
	echo 'echo "Skipped; c++23 not supported"' > $@ && chmod +x $@
	$(CXX23) $(LDFLAGSOPT) -o $@ $(BENCHMARK2DNAME23).o $(PASS).o $(LDLIBS)

$(BENCHMARK4DNAME23): $(BENCHMARK4DNAME23).o $(PASS).o config.mk
	echo 'echo "Skipped; c++23 not supported"' > $@ && chmod +x $@
	$(CXX23) $(LDFLAGSOPT) -o $@ $(BENCHMARK4DNAME23).o $(PASS).o $(LDLIBS)

$(PASS)f.o: ${SRC}/$(PASS)f.f90 config.mk
	$(FC) -c ${DBGFLAGS} -o $@ $<

$(BENCHMARK2DNAME).o: ${SRC}/$(BENCHMARK2DNAME).cc rarray ${HS}/rarraymacros.h ${HS}/rarraytypes.h ${HS}/rarraydelmacros.h ${HS}/elapsed.h config.mk
	$(CXX17) $(CPPFLAGS) $(CPPFLAGSOPT) $(MORECPPFLAGSOPT) $(CXXFLAGS) $(CXXFLAGSOPT) -c -o $@ $<

$(BENCHMARK4DNAME).o: ${SRC}/$(BENCHMARK4DNAME).cc rarray ${HS}/rarraymacros.h ${HS}/rarraytypes.h ${HS}/rarraydelmacros.h ${HS}/elapsed.h config.mk
	$(CXX17) $(CPPFLAGS) $(CPPFLAGSOPT) $(MORECPPFLAGSOPT) $(CXXFLAGS) $(CXXFLAGSOPT) -c -o $@ $<

$(BENCHMARK2DNAME23).o: ${SRC}/$(BENCHMARK2DNAME).cc rarray ${HS}/rarraymacros.h ${HS}/rarraytypes.h ${HS}/rarraydelmacros.h ${HS}/elapsed.h config.mk
	$(CXX23) $(CPPFLAGS) $(CPPFLAGSOPT) $(MORECPPFLAGSOPT) $(CXXFLAGS) $(CXXFLAGSOPT) -c -o $@ $<

$(BENCHMARK4DNAME23).o: ${SRC}/$(BENCHMARK4DNAME).cc rarray ${HS}/rarraymacros.h ${HS}/rarraytypes.h ${HS}/rarraydelmacros.h ${HS}/elapsed.h config.mk
	$(CXX23) $(CPPFLAGS) $(CPPFLAGSOPT) $(MORECPPFLAGSOPT) $(CXXFLAGS) $(CXXFLAGSOPT) -c -o $@ $<

$(PASS).o: ${SRC}/$(PASS).cc config.mk
	$(CXX) -c -o $@ $<