1# -*- mode: makefile-gmake -*- 2 3CONFIGDIR := config 4 5# TESTSRCDIR is always relative to gmakefile.test 6# This must be before includes 7mkfile_path := $(abspath $(MAKEFILE_LIST)) 8TESTSRCDIR := $(dir $(abspath $(firstword $(MAKEFILE_LIST)))) 9 10# If $(PETSC_ARCH) is empty, this defines it and PETSC_DIR 11include $(PETSC_ARCH)/lib/petsc/conf/petscvariables 12include ./lib/petsc/conf/variables 13 14ifeq ($(TESTDIR),) # Default 15TESTDIR := $(PETSC_ARCH)/tests 16gmakegentest_opts= 17else 18gmakegentest_opts="-t $(TESTDIR)" 19TESTDIR := $(TESTDIR) 20endif 21MODDIR := $(PETSC_ARCH)/include 22TESTLOGFILE = $(TESTDIR)/examples-$(PETSC_ARCH).log 23 24pkgs := sys vec mat dm ksp snes ts tao 25 26petscconf := $(PETSC_ARCH)/include/petscconf.h 27petscvariables := $(PETSC_ARCH)/lib/petsc/conf/petscvariables 28generatedtest := $(PETSC_ARCH)/lib/petsc/conf/testfiles 29 30.SECONDEXPANSION: # to expand $$(@D)/.DIR 31 32TESTFLAGS := # Initialize as simple variable 33 34#workarround old cygwin versions 35ifeq ($(PETSC_CYGWIN_BROKEN_PIPE),1) 36ifeq ($(shell basename $(AR)),ar) 37 V ?=1 38endif 39endif 40V ?= $(if $(findstring s,$(MAKEFLAGS)),0) 41ifeq ($(V),) # Default 42 quiet_HELP := "Use \"$(MAKE) V=1\" to see verbose compile lines, \"$(MAKE) V=0\" to suppress.\n" 43 quiet = @printf $(quiet_HELP)$(eval quiet_HELP:=)" %10s %s\n" "$1$2" "$@"; $($1) 44 quiettest = @printf " %10s %s\n" "TEST" "$(@:$(TESTDIR)/counts/%.counts=%)"; 45else ifeq ($(V),0) # Suppress entire command 46 quiet = @$($1) 47 quiettest = @ 48else # Show the full command line 49 quiet = $($1) 50 quiettest = 51 TESTFLAGS += -v 52endif 53 54ifeq ($(FORCE),1) 55 TESTFLAGS += -f # force test execution 56endif 57ifeq ($(VALGRIND),1) 58 TESTFLAGS += -V # Add valgrind to the flags 59endif 60ifeq ($(REPLACE),1) 61 TESTFLAGS += -m # Replace results by passing -m to petscdiff 62endif 63ifeq ($(ALT),1) 64 TESTFLAGS += -M # Replace alt files by passing -M to petscdiff 65endif 66ifeq ($(DIFF_NUMBERS),1) 67 TESTFLAGS += -j # Pass -j to petscdiff to diff the actual numbers 68endif 69ifdef OPTIONS 70 TESTFLAGS += -a '$(OPTIONS)' # override arguments 71endif 72ifdef EXTRA_OPTIONS 73 TESTFLAGS += -e '$(EXTRA_OPTIONS)' # add extra arguments 74endif 75ifdef NP 76 TESTFLAGS += -n $(NP) # set number of processes 77endif 78# Override the default timeout that may be found at the top of config/petsc_harness.sh 79# This must be an integer. It is given in seconds. 80ifdef TIMEOUT 81 TESTFLAGS += -t $(TIMEOUT) # Override the default timeout 82endif 83 84 85 86$(generatedtest) : $(petscconf) $(petscvariables) $(CONFIGDIR)/gmakegentest.py $(TESTDIR)/.DIR | $$(@D)/.DIR 87 $(PYTHON) $(CONFIGDIR)/gmakegentest.py --petsc-arch=$(PETSC_ARCH) $(gmakegentest_opts) 88 89-include $(generatedtest) 90 91ifeq ($(PETSC_LANGUAGE),CXXONLY) 92 cc_name := CXX 93else 94 cc_name := CC 95endif 96 97PETSC_COMPILE.c = $(call quiet,$(cc_name)) -c $(PCC_FLAGS) $(CFLAGS) $(CCPPFLAGS) $(C_DEPFLAGS) 98PETSC_COMPILE.cxx = $(call quiet,CXX) -c $(CXX_FLAGS) $(CFLAGS) $(CCPPFLAGS) $(CXX_DEPFLAGS) 99PETSC_COMPILE.cu = $(call quiet,CUDAC) -c $(CUDAC_FLAGS) --compiler-options="$(PCC_FLAGS) $(CXXFLAGS) $(CCPPFLAGS)" 100PETSC_GENDEPS.cu = $(call quiet,CUDAC,.dep) --generate-dependencies --output-directory=$(@D) $(CUDAC_FLAGS) --compiler-options="$(PCC_FLAGS) $(CXXFLAGS) $(CCPPFLAGS)" 101PETSC_COMPILE.F = $(call quiet,FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) 102 103testlangs := c cu cxx F F90 104$(foreach lang, $(testlangs), $(eval \ 105 testexe.$(lang) = $(foreach pkg, $(pkgs), $(testsrcs-$(pkg).$(lang):%.$(lang)=$(TESTDIR)/%)))) 106concattestlang = $(foreach lang, $(2), $(testsrcs-$(1).$(lang):%.$(lang)=$(TESTDIR)/%.o)) 107testsrcs.o := $(foreach pkg, $(pkgs), $(call concattestlang,$(pkg),$(testlangs))) 108testsrcs-rel := $(foreach pkg, $(pkgs), $(foreach lang, $(testlangs), $(testsrcs-$(pkg).$(lang)))) 109testsrcs := $(foreach sfile, $(testsrcs-rel), $(TESTSRCDIR)/$(sfile)) 110 111# Refresh testfiles when sources change, but don't balk if the source file is nonexistent (deleted) 112$(generatedtest) : $(testsrcs) 113$(testsrcs) : 114 115$(TESTDIR)/%.o : %.c | $$(@D)/.DIR 116 $(PETSC_COMPILE.c) $(abspath $<) -o $@ 117 118$(TESTDIR)/%.o : %.cxx | $$(@D)/.DIR 119 $(PETSC_COMPILE.cxx) $(abspath $<) -o $@ 120 121$(TESTDIR)/%.o : %.cu | $$(@D)/.DIR 122 $(PETSC_COMPILE.cu) $(abspath $<) -o $@ # Compile first so that if there is an error, it comes from a normal compile 123 @$(PETSC_GENDEPS.cu) $(abspath $<) -o $(@:%.o=%.d) # Generate the dependencies for later 124 125# Test modules go in a different directory 126$(TESTDIR)/%.o : MODDIR = $(@D) 127FCMOD = cd 128$(TESTDIR)/%.o : %.F | $$(@D)/.DIR 129ifeq ($(FC_MODULE_OUTPUT_FLAG),) 130 $(call quiet,FCMOD) $(MODDIR) && $(FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) $(abspath $<) -o $(abspath $@) 131else 132 $(PETSC_COMPILE.F) $(abspath $<) -o $@ $(FC_MODULE_OUTPUT_FLAG)$(MODDIR) 133endif 134 135$(TESTDIR)/%.o : %.F90 | $$(@D)/.DIR 136ifeq ($(FC_MODULE_OUTPUT_FLAG),) 137 $(call quiet,FCMOD) $(MODDIR) && $(FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) $(abspath $<) -o $(abspath $@) 138else 139 $(PETSC_COMPILE.F) $(abspath $<) -o $@ $(FC_MODULE_OUTPUT_FLAG)$(MODDIR) 140endif 141# This is a hack to fix a broken gfortran. 142 -@if test "`head -1 $(@:%.o=%.d) | grep : 2> /dev/null`" == ""; then \ 143 echo "$(@): \\" > $(@:%.o=%.dtemp) ; \ 144 tail -n +2 $(@:%.o=%.d) | grep -v '\.mod: \\' >> $(@:%.o=%.dtemp) ; \ 145 mv $(@:%.o=%.dtemp) $(@:%.o=%.d); \ 146 fi 147 148# link line constructed differently for gmakefile vs gmakefile.test invocation 149ifeq ($(libpetscall),) 150PETSC_TEST_LIB = $(PETSC_LIB) 151else 152PETSC_TEST_LIB = $(C_SH_LIB_PATH) $(PETSC_EXTERNAL_LIB_BASIC) 153endif 154 155# Test executables 156$(testexe.F) $(testexe.F90) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall) 157 $(call quiet,FLINKER) -o $@ $^ $(PETSC_TEST_LIB) 158 159$(testexe.c) $(testexe.cu) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall) 160 $(call quiet,CLINKER) -o $@ $^ $(PETSC_TEST_LIB) 161 162$(testexe.cxx) : $(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall) 163 $(call quiet,CXX) -o $@ $^ $(PETSC_TEST_LIB) 164 165# Fortran source files need petsc*.mod, which isn't explicitly managed in the makefile. 166$(foreach pkg, $(pkgs), $(call concattestlang,$(pkg),F F90)) : $(libpetscall) 167 168# Testing convenience targets 169.PHONY: test pre-clean 170 171test: pre-clean report_tests 172 173pre-clean: 174 @$(RM) -r $(TESTDIR)/counts $(TESTLOGFILE) 175 @touch $(TESTLOGFILE) 176 177.PHONY: $(foreach pkg, $(pkgs), test-$(pkg) $(foreach lang, $(testlangs), test-$(pkg).$(lang) test-rm-$(pkg).$(lang))) 178testpkgs := $(foreach pkg, $(pkgs), test-$(pkg)) 179# Targets to run tests in test-$pkg.$lang and delete the executables, language by language 180$(testpkgs) : test-% : $(foreach lang, $(testlangs), test-rm-%.$(lang)) 181# List of raw test run targets 182alltesttargets := $(foreach tp, $(testpkgs), $(foreach lang, $(testlangs), $($(tp).$(lang)))) 183 184# Run targets 185$(alltesttargets) : % : $(TESTDIR)/counts/%.counts 186.PHONY: $(alltesttargets) 187 188$(TESTDIR)/counts/%.counts : 189 $(quiettest) $< $(TESTFLAGS) 190 191# Targets to run tests and remove executables, by package-lang pairs. 192# Run the tests in each batch using recursive invocation of make because 193# we need all of them to complete before removing the executables. Make 194# doesn't guarantee an exploration order for the graph. Only recursive 195# if there is something to be done. 196alltest-rm := $(foreach pkg, $(pkgs), $(foreach lang, $(testlangs), test-rm-$(pkg).$(lang))) 197$(alltest-rm) : test-rm-% : test-% 198ifneq ($(NO_RM),1) 199 $(call quiet,RM) $(addprefix $(TESTDIR)/,$(basename $($(@:test-rm-%=testsrcs-%)))) 200endif 201 202# Remove intermediate .o files 203# This only removes the files at the end which is insufficient 204#.INTERMEDIATE: $(testsrcs.o:%.o=%) 205 206# all sources should get recompiled when petscvariables changes (i.e when configure is rerun or when petscvariables is manually edited.) 207$(testsrcs.o) : $(petscvariables) 208 209%/.DIR : 210 @mkdir -p $(@D) 211 @touch $@ 212 213.PRECIOUS: %/.DIR 214 215.SUFFIXES: # Clear .SUFFIXES because we don't use implicit rules 216.DELETE_ON_ERROR: # Delete likely-corrupt target file if rule fails 217 218.PHONY: clean cleantest all print 219 220cleantest: 221 ${RM} -r $(TESTDIR) $(generatedtest) 222 223clean: cleantest 224 225# make print VAR=the-variable 226print: 227 @echo $($(VAR)) 228 229alltest.d := $(testsrcs.o:%.o=%.d) 230# Tell make that alltest.d are all up to date. Without this, the include 231# below has quadratic complexity, taking more than one second for a 232# do-nothing build of PETSc (much worse for larger projects) 233$(alltest.d) : ; 234 235-include $(alltest.d) 236 237# Tests can be generated by searching 238# Percent is a wildcard (only one allowed): 239# make -f gmakefile test search=sys%ex2 240# To match internal substrings (matches *ex2*): 241# make -f gmakefile test searchin=ex2 242# Search and searchin can be combined: 243# make -f gmakefile test search='sys%' searchin=ex2 244# For args: 245# make -f gmakefile test argsearch=cuda 246# For general glob-style searching using python: 247# NOTE: uses shell which is possibly slower and is possibly more brittle 248# make -f gmakefile test globsearch='sys*ex2*' 249ifdef search 250 TESTTARGETS := $(filter $(search),$(alltesttargets)) 251 ifdef searchin 252 TESTTARGETS2 := $(foreach v,$(TESTTARGETS),$(if $(findstring $(searchin),$(v)),$(v))) 253 TESTTARGETS := $(TESTTARGETS2) 254 endif 255else ifdef searchin 256 TESTTARGETS := $(foreach v,$(alltesttargets),$(if $(findstring $(searchin),$(v)),$(v))) 257else ifdef argsearch 258 TESTTARGETS := $(foreach v,$(alltesttargets),$(if $(findstring $(argsearch),$($(v)_ARGS)),$(v))) 259else ifdef globsearch 260 TESTTARGETS := $(shell $(PYTHON) -c"import sys,fnmatch; print ' '.join(fnmatch.filter(sys.argv[2].split(),sys.argv[1]))" '$(globsearch)' '$(alltesttargets)') 261else # No filter - run them all, but delete the executables as we go 262 TESTTARGETS := $(testpkgs) 263endif 264 265.PHONY: report_tests print-test 266 267print-test: 268 -@echo $(TESTTARGETS) 269 270report_tests: $(TESTTARGETS) 271 -@$(PYTHON) $(CONFIGDIR)/report_tests.py -m $(MAKE) -d $(PETSC_ARCH)/tests/counts 272 273# Do not how how to invoke test from makefile 274HASGMAKEFILE := $(filter gmakefile,$(MAKEFILE_LIST)) 275ifeq ($(HASGMAKEFILE),gmakefile) 276helpdeps:=help-make help-targets 277makefile="gmakefile" 278else 279helpdeps:=help-make help-targets help-test 280makefile="gmakefile.test" 281endif 282 283help: ${helpdeps} 284 -@echo "Above is from: ${helpdeps}" 285 286help-make: 287 -@echo 288 -@echo "Basic build usage:" 289 -@echo " make -f ${makefile} <options>" 290 -@echo 291 -@echo "Options:" 292 -@echo " V=0 Very quiet builds" 293 -@echo " V=1 Verbose builds" 294 -@echo 295 296help-targets: 297 -@echo "All makefile targets and their dependencies:" 298 -@grep ^[a-z] ${makefile} | grep : | grep -v = 299 -@echo 300 -@echo 301 302help-test: 303 -@echo "Basic test usage:" 304 -@echo " make -f ${makefile} test <options>" 305 -@echo 306 -@echo "Options:" 307 -@echo " NO_RM=1 Do not remove the executables after running" 308 -@echo " REPLACE=1 Replace the output in PETSC_DIR source tree (-m to test scripts)" 309 -@echo " ALT=1 Replace 'alt' output in PETSC_DIR source tree (-M to test scripts)" 310 -@echo " DIFF_NUMBERS=1 Diff the numbers in the output (-j to test scripts and petscdiff)" 311 -@echo " VALGRIND=1 Execute the tests using valgrind (-V to test scripts)" 312 -@echo " TESTDIR='tests' Subdirectory where tests are run ($${PETSC_DIR}/$${PETSC_ARCH}/$${TESTDIR}" 313 -@echo " or $${PREFIX_DIR}/$${TESTDIR}" 314 -@echo " or $${PREFIX_DIR}/share/petsc/examples/$${TESTDIR})" 315 -@echo " OPTIONS='<args>' Override options to scripts (-a to test scripts)" 316 -@echo " EXTRA_OPTIONS='<args>' Add options to scripts (-e to test scripts)" 317 -@echo 318 -@echo "Tests can be generated by searching:" 319 -@echo " Percent is a wildcard (only one allowed):" 320 -@echo " make -f ${makefile} test search=sys%ex2" 321 -@echo 322 -@echo " To match internal substrings (matches *ex2*):" 323 -@echo " make -f ${makefile} test searchin=ex2" 324 -@echo 325 -@echo " Search and searchin can be combined:" 326 -@echo " make -f ${makefile} test search='sys%' searchin=ex2" 327 -@echo 328 -@echo " To match patterns in the arguments:" 329 -@echo " make -f ${makefile} test argsearch=cuda" 330 -@echo 331 -@echo " For general glob-style searching using python:" 332 -@echo " NOTE: uses shell which is possibly slower and more brittle" 333 -@echo " make -f ${makefile} test globsearch='sys*ex2*'" 334 -@echo 335 -@echo " To see which targets match a given pattern (useful for doing a specific target):" 336 -@echo " make -f ${makefile} print-test search=sys%" 337 -@echo " which is equivalent to:" 338 -@echo " make -f ${makefile} print VAR=TESTTARGETS search='sys%'" 339 -@echo 340 -@echo " To build an executable, give full path to location:" 341 -@echo ' make -f ${makefile} $${PETSC_ARCH}/tests/src/sys/examples/tests/ex1' 342 -@echo " or make the test with NO_RM=1" 343 -@echo 344