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 104concattestlang = $(foreach lang, $(2), $(testsrcs-$(1).$(lang):%.$(lang)=$(TESTDIR)/%.o)) 105testsrcs.o := $(foreach pkg, $(pkgs), $(call concattestlang,$(pkg),$(testlangs))) 106testsrcs-rel := $(foreach pkg, $(pkgs), $(foreach lang, $(testlangs), $(testsrcs-$(pkg).$(lang)))) 107testsrcs := $(foreach sfile, $(testsrcs-rel), $(TESTSRCDIR)/$(sfile)) 108 109# Refresh testfiles when sources change, but don't balk if the source file is nonexistent (deleted) 110$(generatedtest) : $(testsrcs) 111$(testsrcs) : 112 113$(TESTDIR)/%.o : %.c | $$(@D)/.DIR 114 $(PETSC_COMPILE.c) $(abspath $<) -o $@ 115 116$(TESTDIR)/%.o : %.cxx | $$(@D)/.DIR 117 $(PETSC_COMPILE.cxx) $(abspath $<) -o $@ 118 119$(TESTDIR)/%.o : %.cu | $$(@D)/.DIR 120 $(PETSC_COMPILE.cu) $(abspath $<) -o $@ # Compile first so that if there is an error, it comes from a normal compile 121 @$(PETSC_GENDEPS.cu) $(abspath $<) -o $(@:%.o=%.d) # Generate the dependencies for later 122 123# Test modules go in a different directory 124$(TESTDIR)/%.o : MODDIR = $(@D) 125FCMOD = cd 126$(TESTDIR)/%.o : %.F | $$(@D)/.DIR 127ifeq ($(FC_MODULE_OUTPUT_FLAG),) 128 $(call quiet,FCMOD) $(MODDIR) && $(FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) $(abspath $<) -o $(abspath $@) 129else 130 $(PETSC_COMPILE.F) $(abspath $<) -o $@ $(FC_MODULE_OUTPUT_FLAG)$(MODDIR) 131endif 132 133$(TESTDIR)/%.o : %.F90 | $$(@D)/.DIR 134ifeq ($(FC_MODULE_OUTPUT_FLAG),) 135 $(call quiet,FCMOD) $(MODDIR) && $(FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) $(abspath $<) -o $(abspath $@) 136else 137 $(PETSC_COMPILE.F) $(abspath $<) -o $@ $(FC_MODULE_OUTPUT_FLAG)$(MODDIR) 138endif 139# This is a hack to fix a broken gfortran. 140 @echo "$(@): \\" > $(@:%.o=%.dtemp) 141 @grep "\.h " $(@:%.o=%.d) | grep -v : >> $(@:%.o=%.dtemp) 142 @grep "\.F90 " $(@:%.o=%.d) | sed 's/.$$//' >> $(@:%.o=%.dtemp) 143 @mv $(@:%.o=%.dtemp) $(@:%.o=%.d) 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# Test executables 153$(TESTDIR)/%f : $(TESTDIR)/%f.o $$^ $(libpetscall) 154 $(call quiet,FLINKER) -o $@ $^ $(PETSC_TEST_LIB) 155 156$(TESTDIR)/%f90 : $(TESTDIR)/%f90.o $$^ $(libpetscall) 157 $(call quiet,FLINKER) -o $@ $^ $(PETSC_TEST_LIB) 158 159$(TESTDIR)/% : $(TESTDIR)/%.o $$^ $(libpetscall) 160 $(call quiet,CLINKER) -o $@ $^ $(PETSC_TEST_LIB) 161 162# Fortran source files need petsc*.mod, which isn't explicitly managed in the makefile. 163$(foreach pkg, $(pkgs), $(call concattestlang,$(pkg),F F90)) : $(libpetscall) 164 165# Testing convenience targets 166.PHONY: test pre-clean 167 168test: pre-clean report_tests 169 170pre-clean: 171 @$(RM) -r $(TESTDIR)/counts $(TESTLOGFILE) 172 @touch $(TESTLOGFILE) 173 174.PHONY: $(foreach pkg, $(pkgs), test-$(pkg) $(foreach lang, $(testlangs), test-$(pkg).$(lang) test-rm-$(pkg).$(lang))) 175testpkgs := $(foreach pkg, $(pkgs), test-$(pkg)) 176# Targets to run tests in test-$pkg.$lang and delete the executables, language by language 177$(testpkgs) : test-% : $(foreach lang, $(testlangs), test-rm-%.$(lang)) 178# List of raw test run targets 179alltesttargets := $(foreach tp, $(testpkgs), $(foreach lang, $(testlangs), $($(tp).$(lang)))) 180 181# Run targets 182$(alltesttargets) : % : $(TESTDIR)/counts/%.counts 183.PHONY: $(alltesttargets) 184 185$(TESTDIR)/counts/%.counts : 186 $(quiettest) $< $(TESTFLAGS) 187 188# Targets to run tests and remove executables, by package-lang pairs. 189# Run the tests in each batch using recursive invocation of make because 190# we need all of them to complete before removing the executables. Make 191# doesn't guarantee an exploration order for the graph. Only recursive 192# if there is something to be done. 193alltest-rm := $(foreach pkg, $(pkgs), $(foreach lang, $(testlangs), test-rm-$(pkg).$(lang))) 194$(alltest-rm) : test-rm-% : test-% 195ifneq ($(NO_RM),1) 196 $(call quiet,RM) $(addprefix $(TESTDIR)/,$(basename $($(@:test-rm-%=testsrcs-%)))) 197endif 198 199# Remove intermediate .o files 200# This only removes the files at the end which is insufficient 201#.INTERMEDIATE: $(testsrcs.o:%.o=%) 202 203# all sources should get recompiled when petscvariables changes (i.e when configure is rerun or when petscvariables is manually edited.) 204$(testsrcs.o) : $(petscvariables) 205 206%/.DIR : 207 @mkdir -p $(@D) 208 @touch $@ 209 210.PRECIOUS: %/.DIR 211 212.SUFFIXES: # Clear .SUFFIXES because we don't use implicit rules 213.DELETE_ON_ERROR: # Delete likely-corrupt target file if rule fails 214 215.PHONY: clean cleantest all print 216 217cleantest: 218 ${RM} -r $(TESTDIR) $(generatedtest) 219 220clean: cleantest 221 222# make print VAR=the-variable 223print: 224 @echo $($(VAR)) 225 226alltest.d := $(testsrcs.o:%.o=%.d) 227# Tell make that alltest.d are all up to date. Without this, the include 228# below has quadratic complexity, taking more than one second for a 229# do-nothing build of PETSc (much worse for larger projects) 230$(alltest.d) : ; 231 232-include $(alltest.d) 233 234# Tests can be generated by searching 235# Percent is a wildcard (only one allowed): 236# make -f gmakefile test search=sys%ex2 237# To match internal substrings (matches *ex2*): 238# make -f gmakefile test searchin=ex2 239# Search and searchin can be combined: 240# make -f gmakefile test search='sys%' searchin=ex2 241# For args: 242# make -f gmakefile test argsearch=cuda 243# For general glob-style searching using python: 244# NOTE: uses shell which is possibly slower and is possibly more brittle 245# make -f gmakefile test globsearch='sys*ex2*' 246ifdef search 247 TESTTARGETS := $(filter $(search),$(alltesttargets)) 248 ifdef searchin 249 TESTTARGETS2 := $(foreach v,$(TESTTARGETS),$(if $(findstring $(searchin),$(v)),$(v))) 250 TESTTARGETS := $(TESTTARGETS2) 251 endif 252else ifdef searchin 253 TESTTARGETS := $(foreach v,$(alltesttargets),$(if $(findstring $(searchin),$(v)),$(v))) 254else ifdef argsearch 255 TESTTARGETS := $(foreach v,$(alltesttargets),$(if $(findstring $(argsearch),$($(v)_ARGS)),$(v))) 256else ifdef globsearch 257 TESTTARGETS := $(shell $(PYTHON) -c"import sys,fnmatch; print ' '.join(fnmatch.filter(sys.argv[2].split(),sys.argv[1]))" '$(globsearch)' '$(alltesttargets)') 258else # No filter - run them all, but delete the executables as we go 259 TESTTARGETS := $(testpkgs) 260endif 261 262.PHONY: report_tests print-test 263 264print-test: 265 -@echo $(TESTTARGETS) 266 267report_tests: $(TESTTARGETS) 268 -@$(PYTHON) $(CONFIGDIR)/report_tests.py -m $(MAKE) -d $(PETSC_ARCH)/tests/counts 269 270# Do not how how to invoke test from makefile 271HASGMAKEFILE := $(filter gmakefile,$(MAKEFILE_LIST)) 272ifeq ($(HASGMAKEFILE),gmakefile) 273helpdeps:=help-make help-targets 274makefile="gmakefile" 275else 276helpdeps:=help-make help-targets help-test 277makefile="gmakefile.test" 278endif 279 280help: ${helpdeps} 281 -@echo "Above is from: ${helpdeps}" 282 283help-make: 284 -@echo 285 -@echo "Basic build usage:" 286 -@echo " make -f ${makefile} <options>" 287 -@echo 288 -@echo "Options:" 289 -@echo " V=0 Very quiet builds" 290 -@echo " V=1 Verbose builds" 291 -@echo 292 293help-targets: 294 -@echo "All makefile targets and their dependencies:" 295 -@grep ^[a-z] ${makefile} | grep : | grep -v = 296 -@echo 297 -@echo 298 299help-test: 300 -@echo "Basic test usage:" 301 -@echo " make -f ${makefile} test <options>" 302 -@echo 303 -@echo "Options:" 304 -@echo " NO_RM=1 Do not remove the executables after running" 305 -@echo " REPLACE=1 Replace the output in PETSC_DIR source tree (-m to test scripts)" 306 -@echo " ALT=1 Replace 'alt' output in PETSC_DIR source tree (-M to test scripts)" 307 -@echo " DIFF_NUMBERS=1 Diff the numbers in the output (-j to test scripts and petscdiff)" 308 -@echo " VALGRIND=1 Execute the tests using valgrind (-V to test scripts)" 309 -@echo " TESTDIR='tests' Subdirectory where tests are run ($${PETSC_DIR}/$${PETSC_ARCH}/$${TESTDIR}" 310 -@echo " or $${PREFIX_DIR}/$${TESTDIR}" 311 -@echo " or $${PREFIX_DIR}/share/petsc/examples/$${TESTDIR})" 312 -@echo " OPTIONS='<args>' Override options to scripts (-a to test scripts)" 313 -@echo " EXTRA_OPTIONS='<args>' Add options to scripts (-e to test scripts)" 314 -@echo 315 -@echo "Tests can be generated by searching:" 316 -@echo " Percent is a wildcard (only one allowed):" 317 -@echo " make -f ${makefile} test search=sys%ex2" 318 -@echo 319 -@echo " To match internal substrings (matches *ex2*):" 320 -@echo " make -f ${makefile} test searchin=ex2" 321 -@echo 322 -@echo " Search and searchin can be combined:" 323 -@echo " make -f ${makefile} test search='sys%' searchin=ex2" 324 -@echo 325 -@echo " To match patterns in the arguments:" 326 -@echo " make -f ${makefile} test argsearch=cuda" 327 -@echo 328 -@echo " For general glob-style searching using python:" 329 -@echo " NOTE: uses shell which is possibly slower and more brittle" 330 -@echo " make -f ${makefile} test globsearch='sys*ex2*'" 331 -@echo 332 -@echo " To see which targets match a given pattern (useful for doing a specific target):" 333 -@echo " make -f ${makefile} print-test search=sys%" 334 -@echo " which is equivalent to:" 335 -@echo " make -f ${makefile} print VAR=TESTTARGETS search='sys%'" 336 -@echo 337 -@echo " To build an executable, give full path to location:" 338 -@echo ' make -f ${makefile} $${PETSC_ARCH}/tests/src/sys/examples/tests/ex1' 339 -@echo " or make the test with NO_RM=1" 340 -@echo 341