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