1# 2# See https://petsc.org/release/install/ for instructions on installing PETSc 3# 4# This is the top level makefile for compiling PETSc. 5# * make help - useful messages on functionality 6# * make all - compile the PETSc libraries and utilities 7# * make check - runs a quick test that the libraries are built correctly and PETSc applications can run 8# 9# * make install - for use with ./configure is run with the --prefix=directory option 10# * make test - runs a comprehensive test suite (requires gnumake) 11# * make docs - build the entire PETSc website of documentation (locally) 12# * a variety of rules that print library properties useful for building applications (use make help) 13# * a variety of rules for PETSc developers 14# 15# gmakefile - manages the compiling PETSc in parallel 16# gmakefile.test - manages running the comprehensive test suite 17# 18# This makefile does not require GNUmake 19ALL: all 20DIRS = src include interfaces share/petsc/matlab 21 22# next line defines PETSC_DIR and PETSC_ARCH if they are not set 23include ././${PETSC_ARCH}/lib/petsc/conf/petscvariables 24include ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/petscrules 25include ${PETSC_DIR}/lib/petsc/conf/rules.doc 26include ${PETSC_DIR}/lib/petsc/conf/rules.utils 27 28# This makefile contains a lot of PHONY targets with improperly specified prerequisites 29# where correct execution instead depends on the targets being processed in the correct 30# order. 31.NOTPARALLEL: 32 33OMAKE_SELF = $(OMAKE) -f makefile 34OMAKE_SELF_PRINTDIR = $(OMAKE_PRINTDIR) -f makefile 35PETSCCONF_H = ${PETSC_DIR}/${PETSC_ARCH}/include/petscconf.h 36 37#********* Rules for make all ********************************************************************************************************************************** 38 39all: 40 +@${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} chk_upgrade | tee ${PETSC_ARCH}/lib/petsc/conf/make.log 41 @ln -sf ${PETSC_ARCH}/lib/petsc/conf/make.log make.log 42 +@(${OMAKE_SELF_PRINTDIR} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-local; echo "$$?" > ${PETSC_ARCH}/lib/petsc/conf/error.log) 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log 43 +@if [ "`cat ${PETSC_ARCH}/lib/petsc/conf/error.log 2> /dev/null`" != "0" ]; then \ 44 grep -E '(out of memory allocating.*after a total of|gfortran: fatal error: Killed signal terminated program f951|f95: fatal error: Killed signal terminated program f951)' ${PETSC_ARCH}/lib/petsc/conf/make.log | tee ${PETSC_ARCH}/lib/petsc/conf/memoryerror.log > /dev/null; \ 45 if test -s ${PETSC_ARCH}/lib/petsc/conf/memoryerror.log; then \ 46 printf ${PETSC_TEXT_HILIGHT}"**************************ERROR*************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \ 47 echo " Error during compile, you need to increase the memory allocated to the VM and rerun " 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \ 48 printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\ 49 else \ 50 printf ${PETSC_TEXT_HILIGHT}"**************************ERROR*************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \ 51 echo " Error during compile, check ${PETSC_ARCH}/lib/petsc/conf/make.log" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \ 52 echo " Send it and ${PETSC_ARCH}/lib/petsc/conf/configure.log to petsc-maint@mcs.anl.gov" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\ 53 if [ "X${CONDA_ACTIVE}" != "X" ]; then \ 54 echo " Having Conda in your shell may have caused this problem, consider turning off Conda." 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\ 55 fi ; \ 56 printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\ 57 fi \ 58 else \ 59 ${OMAKE_SELF} print_mesg_after_build PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log ;\ 60 fi #solaris make likes to print the whole command that gave error. So split this up into the smallest chunk below 61 @echo "Finishing make run at `date +'%a, %d %b %Y %H:%M:%S %z'`" >> ${PETSC_ARCH}/lib/petsc/conf/make.log 62 @if [ "`cat ${PETSC_ARCH}/lib/petsc/conf/error.log 2> /dev/null`" != "0" ]; then exit 1; fi 63 64all-local: info libs matlabbin petsc4py-build libmesh-build mfem-build slepc-build hpddm-build amrex-build bamg-build 65 66${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/files: 67 @touch -t 197102020000 ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/files 68 69${PETSC_DIR}/${PETSC_ARCH}/tests/testfiles: 70 @${MKDIR} -p ${PETSC_DIR}/${PETSC_ARCH}/tests && touch -t 197102020000 ${PETSC_DIR}/${PETSC_ARCH}/tests/testfiles 71 72chk_upgrade: 73 -@PETSC_DIR=${PETSC_DIR} ${PYTHON} ${PETSC_DIR}/lib/petsc/bin/petscnagupgrade.py 74 75matlabbin: 76 -@if [ "${MATLAB_MEX}" != "" -a "${MATLAB_SOCKET}" != "" -a "${PETSC_SCALAR}" = "real" -a "${PETSC_PRECISION}" = "double" ]; then \ 77 echo "BEGINNING TO COMPILE MATLAB INTERFACE"; \ 78 if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc" ] ; then ${MKDIR} ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc; fi; \ 79 if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab" ] ; then ${MKDIR} ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab; fi; \ 80 cd src/sys/classes/viewer/impls/socket/mex-scripts && ${OMAKE_SELF} mex-scripts PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR}; \ 81 echo "========================================="; \ 82 fi 83 84allfortranstubs: deletefortranstubs 85 @${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py --petsc-dir=${PETSC_DIR} --petsc-arch=${PETSC_ARCH} --bfort=${BFORT} --mode=generate --verbose=${V} 86 -@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py --petsc-dir=${PETSC_DIR} --petsc-arch=${PETSC_ARCH} --mode=merge --verbose=${V} 87 88#copy of allfortranstubs with PETSC_ARCH='' 89allfortranstubsinplace: deletefortranstubs 90 @${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py --petsc-dir=${PETSC_DIR} --petsc-arch='' --bfort=${BFORT} --mode=generate --verbose=${V} 91 -@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py --petsc-dir=${PETSC_DIR} --petsc-arch='' --mode=merge --verbose=${V} 92 93deleteshared: 94 @for LIBNAME in ${SHLIBS}; \ 95 do \ 96 if [ -d ${INSTALL_LIB_DIR}/$${LIBNAME}.dylib.dSYM ]; then \ 97 echo ${RM} -rf ${INSTALL_LIB_DIR}/$${LIBNAME}.dylib.dSYM; \ 98 ${RM} -rf ${INSTALL_LIB_DIR}/$${LIBNAME}.dylib.dSYM; \ 99 fi; \ 100 echo ${RM} ${INSTALL_LIB_DIR}/$${LIBNAME}.${SL_LINKER_SUFFIX}; \ 101 ${RM} ${INSTALL_LIB_DIR}/$${LIBNAME}.${SL_LINKER_SUFFIX}; \ 102 done 103 @if [ -f ${INSTALL_LIB_DIR}/so_locations ]; then \ 104 echo ${RM} ${INSTALL_LIB_DIR}/so_locations; \ 105 ${RM} ${INSTALL_LIB_DIR}/so_locations; \ 106 fi 107 108deletefortranstubs: 109 -@find src -type d -name ftn-auto* | xargs rm -rf 110 -@if [ -n "${PETSC_ARCH}" ] && [ -d ${PETSC_ARCH} ] && [ -d ${PETSC_ARCH}/src ]; then \ 111 find ${PETSC_ARCH}/src -type d -name ftn-auto* | xargs rm -rf ;\ 112 fi 113 114reconfigure: allclean 115 @unset MAKEFLAGS && ${PYTHON} ${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py 116 117chkopts: 118 -@echo "Warning: chkopts target is deprecated and can be removed from user makefiles" 119 120gnumake: 121 +@echo "make gnumake is deprecated, use make libs" 122 +@make libs 123 124# ******** Rules for make check **************************************************************************************************************************** 125 126RUN_TEST = ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff 127 128check_install: check 129check: 130 -@echo "Running PETSc check examples to verify correct installation" 131 -@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}" 132 @if [ "${PETSC_WITH_BATCH}" != "" ]; then \ 133 echo "Running with batch filesystem, cannot run make check"; \ 134 elif [ "${MPIEXEC}" = "/bin/false" ]; then \ 135 echo "*mpiexec not found*. cannot run make check"; \ 136 else \ 137 ${RM} -f check_error;\ 138 ${RUN_TEST} PETSC_OPTIONS="${PETSC_OPTIONS} ${PETSC_TEST_OPTIONS}" PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" check_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/check.log; \ 139 if [ -f check_error ]; then \ 140 echo "Error while running make check"; \ 141 ${RM} -f check_error;\ 142 exit 1; \ 143 fi; \ 144 ${RM} -f check_error;\ 145 fi; 146 147check_build: 148 +@cd src/snes/tutorials >/dev/null; ${RUN_TEST} clean-legacy 149 +@cd src/snes/tutorials >/dev/null; ${RUN_TEST} testex19 150 +@if [ ! "${MPI_IS_MPIUNI}" ]; then cd src/snes/tutorials >/dev/null; ${RUN_TEST} testex19_mpi; fi 151 +@if [ "${HYPRE_LIB}" != "" ] && [ "${PETSC_SCALAR}" = "real" ]; then \ 152 if [ "${CUDA_LIB}" != "" ]; then HYPRE_TEST=runex19_hypre_cuda; \ 153 elif [ "${HIP_LIB}" != "" ]; then HYPRE_TEST=runex19_hypre_hip; \ 154 else HYPRE_TEST=runex19_hypre; fi; \ 155 cd src/snes/tutorials >/dev/null; ${RUN_TEST} $${HYPRE_TEST}; \ 156 fi; 157 +@if [ "${CUDA_LIB}" != "" ]; then \ 158 cd src/snes/tutorials >/dev/null; ${RUN_TEST} runex19_cuda; \ 159 fi; 160 +@if [ "${MPI_IS_MPIUNI}" = "" ]; then \ 161 cd src/snes/tutorials >/dev/null; \ 162 if [ "${KOKKOS_KERNELS_LIB}" != "" ] && [ "${PETSC_SCALAR}" = "real" ] && [ "${PETSC_PRECISION}" = "double" ]; then \ 163 ${RUN_TEST} runex3k_kokkos; \ 164 fi;\ 165 if [ "${MUMPS_LIB}" != "" ]; then \ 166 ${RUN_TEST} runex19_fieldsplit_mumps; \ 167 fi;\ 168 if [ "${SUITESPARSE_LIB}" != "" ]; then \ 169 ${RUN_TEST} runex19_suitesparse; \ 170 fi;\ 171 if [ "${SUPERLU_DIST_LIB}" != "" ]; then \ 172 ${RUN_TEST} runex19_superlu_dist; \ 173 fi;\ 174 if ( [ "${ML_LIB}" != "" ] || [ "${TRILINOS_LIB}" != "" ] ); then \ 175 ${RUN_TEST} runex19_ml; \ 176 fi; \ 177 ${RUN_TEST} clean-legacy; \ 178 cd - > /dev/null; \ 179 if ( [ "${AMREX_LIB}" != "" ] && [ "${CUDA_LIB}" = "" ] ); then \ 180 echo "Running amrex test example to verify correct installation";\ 181 echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}";\ 182 cd src/ksp/ksp/tutorials/amrex >/dev/null;\ 183 ${RUN_TEST} clean-legacy; \ 184 ${RUN_TEST} testamrex; \ 185 ${RUN_TEST} clean-legacy; \ 186 cd - > /dev/null; \ 187 fi;\ 188 fi; 189 +@if [ "${HDF5_LIB}" != "" ]; then \ 190 cd src/vec/vec/tests >/dev/null;\ 191 ${RUN_TEST} clean-legacy; \ 192 ${RUN_TEST} runex47; \ 193 ${RUN_TEST} clean-legacy; \ 194 fi; 195 +@if [ "${MPI4PY}" = "yes" ]; then \ 196 cd src/sys/tests >/dev/null; \ 197 ${RUN_TEST} clean-legacy; \ 198 ${RUN_TEST} testex55; \ 199 ${RUN_TEST} clean-legacy; \ 200 fi; 201 +@if [ "${PETSC4PY}" = "yes" ]; then \ 202 cd src/ksp/ksp/tutorials >/dev/null; \ 203 ${RUN_TEST} clean-legacy; \ 204 ${RUN_TEST} testex100; \ 205 ${RUN_TEST} clean-legacy; \ 206 fi; 207 +@grep -E "^#define PETSC_USE_FORTRAN_BINDINGS 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ 208 if test -s .ftn.log; then \ 209 cd src/snes/tutorials >/dev/null; \ 210 ${RUN_TEST} clean-legacy; \ 211 ${RUN_TEST} testex5f; \ 212 ${RUN_TEST} clean-legacy; \ 213 fi; ${RM} .ftn.log; 214 +@grep -E "^#define PETSC_HAVE_MATLAB 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ 215 if test -s .ftn.log; then \ 216 cd src/vec/vec/tutorials >/dev/null; \ 217 ${RUN_TEST} clean-legacy; \ 218 ${RUN_TEST} testex31; \ 219 ${RUN_TEST} clean-legacy; \ 220 fi; ${RM} .ftn.log; 221 +@if [ "${SLEPC}" = "yes" ]; then \ 222 ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} slepc-check; \ 223 fi; 224 -@echo "Completed PETSc check examples" 225 226# ********* Rules for make install ******************************************************************************************************************* 227 228install: 229 @${PYTHON} ./config/install.py -destDir=${DESTDIR} 230 +${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} PETSC_INSTALL=$@ install-builtafterpetsc 231 232# A smaller install with fewer extras 233install-lib: 234 @${PYTHON} ./config/install.py -destDir=${DESTDIR} -no-examples 235 +${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} PETSC_INSTALL=$@ install-builtafterpetsc 236 237install-builtafterpetsc: 238 +${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} PETSC_INSTALL=${PETSC_INSTALL} petsc4py-install libmesh-install mfem-install slepc-install hpddm-install amrex-install bamg-install 239 240# Creates ${HOME}/petsc.tar.gz [and petsc-with-docs.tar.gz] 241dist: 242 ${PETSC_DIR}/lib/petsc/bin/maint/builddist ${PETSC_DIR} main 243 244# ******** Rules for running the full test suite ******************************************************************************************************** 245 246TESTMODE = testexamples 247ALLTESTS_CHECK_FAILURES = no 248ALLTESTS_MAKEFILE = ${PETSC_DIR}/gmakefile.test 249VALGRIND=0 250alltests: chk_in_petscdir ${PETSC_DIR}/${PETSC_ARCH}/tests/testfiles 251 -@${RM} -rf ${PETSC_ARCH}/lib/petsc/conf/alltests.log alltests.log 252 +@if [ -f ${PETSC_DIR}/share/petsc/examples/gmakefile.test ] ; then \ 253 ALLTESTS_MAKEFILE=${PETSC_DIR}/share/petsc/examples/gmakefile.test ; \ 254 ALLTESTSLOG=alltests.log ;\ 255 else \ 256 ALLTESTS_MAKEFILE=${PETSC_DIR}/gmakefile.test; \ 257 ALLTESTSLOG=${PETSC_ARCH}/lib/petsc/conf/alltests.log ;\ 258 ln -s $${ALLTESTSLOG} alltests.log ;\ 259 fi; \ 260 ${OMAKE} allgtest ALLTESTS_MAKEFILE=$${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} MPIEXEC="${MPIEXEC}" DATAFILESPATH=${DATAFILESPATH} VALGRIND=${VALGRIND} 2>&1 | tee $${ALLTESTSLOG};\ 261 if [ x${ALLTESTS_CHECK_FAILURES} = xyes -a ${PETSC_PRECISION} != single ]; then \ 262 cat $${ALLTESTSLOG} | grep -E '(^not ok|not remade because of errors|^# No tests run)' | wc -l | grep '^[ ]*0$$' > /dev/null; \ 263 fi; 264 265allgtests-tap: allgtest-tap 266 +@${OMAKE} -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} check-test-errors 267 268allgtest-tap: ${PETSC_DIR}/${PETSC_ARCH}/tests/testfiles 269 +@MAKEFLAGS="-j$(MAKE_TEST_NP) -l$(MAKE_LOAD) $(MAKEFLAGS)" ${OMAKE} -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} test OUTPUT=1 270 271allgtest: ${PETSC_DIR}/${PETSC_ARCH}/tests/testfiles 272 +@MAKEFLAGS="-j$(MAKE_TEST_NP) -l$(MAKE_LOAD) $(MAKEFLAGS)" ${OMAKE} -k -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} test V=0 2>&1 | grep -E -v '^(ok [^#]*(# SKIP|# TODO|$$)|[A-Za-z][A-Za-z0-9_]*\.(c|F|cxx|F90).$$)' 273 274test: 275 +${OMAKE} -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} test 276cleantest: 277 +${OMAKE} -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} cleantest 278 279#********* Rules for cleaning *************************************************************************************************************************** 280 281deletelibs: 282 -${RM} -rf ${PETSC_LIB_DIR}/libpetsc*.* 283deletemods: 284 -${RM} -f ${PETSC_DIR}/${PETSC_ARCH}/include/petsc*.mod 285 286allclean: 287 -@${OMAKE} -f gmakefile clean 288 289clean:: allclean 290 291distclean: 292 @if [ -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ]; then \ 293 echo "*** Preserving ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py in ${PETSC_DIR} ***"; \ 294 mv -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ${PETSC_DIR}/; fi 295 @echo "*** Deleting all build files in ${PETSC_DIR}/${PETSC_ARCH} ***" 296 -${RM} -rf ${PETSC_DIR}/${PETSC_ARCH}/ 297 298info: 299 +@${OMAKE} -f gmakefile gmakeinfo 300 301check_usermakefile: 302 -@echo "Testing compile with user makefile" 303 -@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}" 304 @cd src/snes/tutorials; ${RUN_TEST} clean-legacy 305 @cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex19 306 @grep -E "^#define PETSC_USE_FORTRAN_BINDINGS 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ 307 if test -s .ftn.log; then \ 308 cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex5f; \ 309 fi; ${RM} .ftn.log; 310 @cd src/snes/tutorials; ${RUN_TEST} clean-legacy 311 -@echo "Completed compile with user makefile" 312 313#********* Rules for running clangformat ************************************************************************************************************ 314 315checkgitclean: 316 @if ! git diff --quiet; then \ 317 echo "The repository has uncommitted files, cannot run checkclangformat" ;\ 318 git status -s --untracked-files=no ;\ 319 false;\ 320 fi; 321 322# Check that all the source code in the repository satisfies the .clang_format 323checkclangformat: checkclangformatversion checkgitclean clangformat 324 @if ! git diff --quiet; then \ 325 printf "The current commit has source code formatting problems\n" ;\ 326 if [ -z "${CI_PIPELINE_ID}" ]; then \ 327 printf "Please run 'git diff' to check\n"; \ 328 git diff --stat; \ 329 else \ 330 git diff --patch-with-stat > ${PETSC_ARCH}/lib/petsc/conf/checkclangformat.patch; \ 331 git diff --patch-with-stat --color=always | head -1000; \ 332 if [ `wc -l < ${PETSC_ARCH}/lib/petsc/conf/checkclangformat.patch` -gt 1000 ]; then \ 333 printf "The diff has been trimmed, check ${PETSC_ARCH}/lib/petsc/conf/checkclangformat.patch (in CI artifacts) for all changes\n"; \ 334 fi;\ 335 fi;\ 336 false;\ 337 fi; 338 339# Compare ABI/API of two versions of PETSc library with the old one defined by PETSC_{DIR,ARCH}_ABI_OLD 340abitest: 341 @if [ "${PETSC_DIR_ABI_OLD}" = "" ] || [ "${PETSC_ARCH_ABI_OLD}" = "" ]; \ 342 then printf "You must set environment variables PETSC_DIR_ABI_OLD and PETSC_ARCH_ABI_OLD to run abitest\n"; \ 343 exit 1; \ 344 fi; 345 -@echo "Comparing ABI/API of the following two PETSc versions (you must have already configured and built them using GCC and with -g):" 346 -@echo "=========================================================================================" 347 -@echo " Old: PETSC_DIR_ABI_OLD = ${PETSC_DIR_ABI_OLD}" 348 -@echo " PETSC_ARCH_ABI_OLD = ${PETSC_ARCH_ABI_OLD}" 349 -@pushd ${PETSC_DIR_ABI_OLD} >> /dev/null ; echo " Branch = "`git rev-parse --abbrev-ref HEAD` 350 -@echo " New: PETSC_DIR = ${PETSC_DIR}" 351 -@echo " PETSC_ARCH = ${PETSC_ARCH}" 352 -@echo " Branch = "`git rev-parse --abbrev-ref HEAD` 353 -@echo "=========================================================================================" 354 -@$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/abicheck.py -old_dir ${PETSC_DIR_ABI_OLD} -old_arch ${PETSC_ARCH_ABI_OLD} -new_dir ${PETSC_DIR} -new_arch ${PETSC_ARCH} -report_format html 355 356# Compare ABI/API of current PETSC_ARCH/PETSC_DIR with a previous branch 357abitestcomplete: 358 -@if [[ -f "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/configure.log" ]]; then \ 359 OPTIONS=`grep -h -m 1 "Configure Options: " ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/configure.log | sed "s!Configure Options: --configModules=PETSc.Configure --optionsModule=config.compilerOptions!!g"` ;\ 360echo $${OPTIONS} ;\ 361 fi ; \ 362 if [[ "${PETSC_DIR_ABI_OLD}" != "" ]]; then \ 363 PETSC_DIR_OLD=${PETSC_DIR_ABI_OLD}; \ 364 else \ 365 PETSC_DIR_OLD=${PETSC_DIR}/../petsc-abi; \ 366 fi ; \ 367 echo "=================================================================================================" ;\ 368 echo "Doing ABI/API comparison between" ${branch} " and " `git rev-parse --abbrev-ref HEAD` "using " $${OPTIONS} ;\ 369 echo "=================================================================================================" ;\ 370 if [[ ! -d $${PETSC_DIR_OLD} ]]; then \ 371 git clone ${PETSC_DIR} $${PETSC_DIR_OLD} ; \ 372 else \ 373 cd $${PETSC_DIR_OLD} ; \ 374 git pull ; \ 375 fi ; \ 376 cd $${PETSC_DIR_OLD} ; \ 377 git checkout ${branch} ; \ 378 PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` ./configure $${OPTIONS} ; \ 379 PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` make all test ; \ 380 cd ${PETSC_DIR} ; \ 381 ./configure $${OPTIONS}; \ 382 make all test ; \ 383 PETSC_DIR_ABI_OLD=$${PETSC_DIR_OLD} PETSC_ARCH_ABI_OLD=arch-branch-`git rev-parse ${branch}` make abitest 384 385# ******** Rules for running Streams benchmark **************************************************************************************************** 386 387mpistreams: 388 +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistreams 389 390mpistream: 391 +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistream 392 393openmpstreams: 394 +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstreams 395 396openmpstream: 397 +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstream 398 399stream: mpistream 400 401streams: mpistreams 402 403# ******** Rules for generating tag files for Emacs/VIM ******************************************************************************************* 404 405alletags: 406 -@${PYTHON} lib/petsc/bin/maint/generateetags.py 407 -@find config -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON 408 409# obtain gtags from https://www.gnu.org/software/global/ 410allgtags: 411 -@find ${PETSC_DIR}/include ${PETSC_DIR}/src -regex '\(.*makefile\|.*\.\(cc\|hh\|cpp\|cxx\|C\|hpp\|c\|h\|cu\|m\)$$\)' | grep -v ftn-auto | gtags -f - 412 413# ********* Rules for building "classic" documentation; uses rules also in lib/petsc/conf/rules.doc ************************************************** 414 415docs: 416 cd doc; time ${OMAKE_SELF} sphinxhtml 417 418chk_in_petscdir: 419 @if [ ! -f include/petscversion.h ]; then \ 420 printf ${PETSC_TEXT_HILIGHT}"*********************** ERROR **********************************************\n" ; \ 421 echo " This target should be invoked in top level PETSc source dir!"; \ 422 printf "****************************************************************************"${PETSC_TEXT_NORMAL}"\n" ; false; fi 423 424chk_loc: 425 @if [ ${LOC}foo = foo ] ; then \ 426 printf ${PETSC_TEXT_HILIGHT}"*********************** ERROR **********************************************\n" ; \ 427 echo " Please specify LOC variable for eg: make allmanpages LOC=/sandbox/petsc "; \ 428 printf "****************************************************************************"${PETSC_TEXT_NORMAL}"\n" ; false; fi 429 @${MKDIR} ${LOC}/manualpages 430 431chk_c2html: 432 @if [ ${C2HTML}foo = foo ] ; then \ 433 printf ${PETSC_TEXT_HILIGHT}"*********************** ERROR ************************\n" ; \ 434 echo "Require c2html for html docs. Please reconfigure with --download-c2html=1"; \ 435 printf "******************************************************"${PETSC_TEXT_NORMAL}"\n" ;false; fi 436 437 438# the ACTION=manualpages cannot run in parallel because they all write to the same manualpages.cit file 439hloc=include/petsc/private 440allmanpages: chk_loc deletemanualpages 441 -@echo " /* SUBMANSEC = PetscH */ " > ${hloc}/generated_khash.h 442 -@sed -e 's?<T>?I?g' -e 's?<t>?i?g' -e 's?<KeyType>?PetscInt?g' ${hloc}/hashset.txt >> ${hloc}/generated_khash.h 443 -@sed -e 's?<T>?IJ?g' -e 's?<t>?ij?g' -e 's?<KeyType>?struct {PetscInt i, j;}?g' ${hloc}/hashset.txt >> ${hloc}/generated_khash.h 444 -@sed -e 's?<T>?I?g' -e 's?<t>?i?g' -e 's?<KeyType>?PetscInt?g' -e 's?<ValType>?PetscInt?g' ${hloc}/hashmap.txt >> ${hloc}/generated_khash.h 445 -@sed -e 's?<T>?IJ?g' -e 's?<t>?ij?g' -e 's?<KeyType>?struct {PetscInt i, j;}?g' -e 's?<ValType>?PetscInt?g' ${hloc}/hashmap.txt >> ${hloc}/generated_khash.h 446 -@sed -e 's?<T>?IJ?g' -e 's?<t>?ij?g' -e 's?<KeyType>?struct {PetscInt i, j;}?g' -e 's?<ValType>?PetscScalar?g' ${hloc}/hashmap.txt >> ${hloc}/generated_khash.h 447 -@sed -e 's?<T>?IV?g' -e 's?<t>?iv?g' -e 's?<KeyType>?PetscInt?g' -e 's?<ValType>?PetscScalar?g' ${hloc}/hashmap.txt >> ${hloc}/generated_khash.h 448 -@sed -e 's?<T>?Obj?g' -e 's?<t>?obj?g' -e 's?<KeyType>?PetscInt64?g' -e 's?<ValType>?PetscObject?g' ${hloc}/hashmap.txt >> ${hloc}/generated_khash.h 449 -@${RM} ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err 450 -${OMAKE_SELF} ACTION=manualpages tree_src LOC=${LOC} 451 -@sed -e s%man+../%man+manualpages/% ${LOC}/manualpages/manualpages.cit > ${LOC}/manualpages/htmlmap 452 -@cat ${PETSC_DIR}/doc/classic/mpi.www.index >> ${LOC}/manualpages/htmlmap 453 @cat ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err 454 @a=`cat ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err | wc -l`; test ! $$a -gt 0 455 456# 457# This code needs to be rewritten in Python to reduce by a factor of 100 the time it takes to run 458# 459c2html: chk_loc chk_c2html 460 -@if command -v parallel &> /dev/null; then \ 461 ls include/makefile src/*/makefile | xargs dirname | parallel -j ${MAKE_TEST_NP} --load ${MAKE_LOAD} 'cd {}; ${OMAKE_SELF} HTMLMAP=${HTMLMAP} LOC=${LOC} PETSC_DIR=${PETSC_DIR} ACTION=html tree' ; \ 462 else \ 463 ${OMAKE_SELF} HTMLMAP=${HTMLMAP} LOC=${LOC} PETSC_DIR=${PETSC_DIR} ACTION=html tree; \ 464 fi 465 466alldocclean: deletemanualpages allcleanhtml 467 468# Deletes man pages (.md version) 469deletemanualpages: chk_loc 470 -@if [ -d ${LOC} -a -d ${LOC}/manualpages ]; then \ 471 find ${LOC}/manualpages -type f -name "*.md" -exec ${RM} {} \; ;\ 472 ${RM} ${LOC}/manualpages/manualpages.cit ;\ 473 fi 474 475allcleanhtml: 476 -${OMAKE_SELF} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} tree 477 478# ********* Rules for checking code coverage ********************************************************************************************* 479 480gcov: 481 output_file_base_name=${PETSC_ARCH}-gcovr-report.json; \ 482 petsc_arch_dir=${PETSC_DIR}/${PETSC_ARCH}; \ 483 tar_file=$${petsc_arch_dir}/$${output_file_base_name}.tar.bz2; \ 484 cd $${petsc_arch_dir} && \ 485 gcovr --json --output $${petsc_arch_dir}/$${output_file_base_name} --exclude '.*/ftn-auto/.*' --exclude-lines-by-pattern '^\s*SETERR.*' --exclude-throw-branches --exclude-unreachable-branches -j 4 --gcov-executable "${PETSC_COVERAGE_EXEC}" --root ${PETSC_DIR} ./obj ./tests ${PETSC_GCOV_OPTIONS} && \ 486 ${RM} -f $${tar_file} && \ 487 tar --bzip2 -cf $${tar_file} -C $${petsc_arch_dir} ./$${output_file_base_name} && \ 488 ${RM} $${petsc_arch_dir}/$${output_file_base_name} 489 490mergegcov: 491 $(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py --merge-branch `lib/petsc/bin/maint/check-merge-branch.sh` --html --xml ${PETSC_GCOV_OPTIONS} 492 493countfortranfunctions: 494 -@cd ${PETSC_DIR}/src/fortran; grep -E '^void' custom/*.c auto/*.c | \ 495 cut -d'(' -f1 | tr -s ' ' | cut -d' ' -f2 | uniq | grep -E -v "(^$$|Petsc)" | \ 496 sed "s/_$$//" | sort > /tmp/countfortranfunctions 497 498countcfunctions: 499 -@grep PETSC_EXTERN ${PETSC_DIR}/include/*.h | grep "(" | tr -s ' ' | \ 500 cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' | \ 501 tr 'A-Z' 'a-z' | sort | uniq > /tmp/countcfunctions 502 503difffortranfunctions: countfortranfunctions countcfunctions 504 -@echo -------------- Functions missing in the fortran interface --------------------- 505 -@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2 506 -@echo ----------------- Functions missing in the C interface ------------------------ 507 -@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2 508 -@${RM} /tmp/countcfunctions /tmp/countfortranfunctions 509 510checkbadfortranstubs: 511 -@echo "=========================================" 512 -@echo "Functions with MPI_Comm as an Argument" 513 -@echo "=========================================" 514 -@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \ 515 tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3 516 -@echo "=========================================" 517 -@echo "Functions with a String as an Argument" 518 -@echo "=========================================" 519 -@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \ 520 tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3 521 -@echo "=========================================" 522 -@echo "Functions with Pointers to PETSc Objects as Argument" 523 -@echo "=========================================" 524 -@cd ${PETSC_DIR}/src/fortran/auto; \ 525 _p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \ 526 cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \ 527 sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \ 528 for OBJ in $$_p_OBJ; do \ 529 grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \ 530 cut -d'(' -f1 | cut -d' ' -f1,3; \ 531 done 532 533checkpackagetests: 534 -@echo "Missing package tests" 535 -@cat config/examples/*.py > configexamples; pushd config/BuildSystem/config/packages/; packages=`ls *.py | sed "s/\\.py//g"`;popd; for i in $${packages}; do j=`echo $${i} | tr '[:upper:]' '[:lower:]'`; printf $${j} ; grep -E "(with-$${j}|download-$${j})" configexamples | grep -v "=0" | wc -l ; done 536 -@echo "Missing download package tests" 537 -@cat config/examples/*.py > configexamples; pushd config/BuildSystem/config/packages/; packages=`grep -l "download " *.py | sed "s/\\.py//g"`;popd; for i in $${packages}; do j=`echo $${i} | tr '[:upper:]' '[:lower:]'`; printf $${j} ; grep -E "(download-$${j})" configexamples | grep -v "=0" | wc -l ; done 538 539check_petsc4py_rst: 540 @${RM} -f petsc4py_rst.log 541 @echo "Checking src/binding/petsc4py/DESCRIPTION.rst" 542 @rst2html src/binding/petsc4py/DESCRIPTION.rst > /dev/null 2> petsc4py_rst.log 543 @if test -s petsc4py_rst.log; then cat petsc4py_rst.log; exit 1; fi 544 545# TODO: checkTestCoverage: that makes sure every tutorial test has at least one test listed in the file, perhaps handled by gmakegentest.py 546# TODO: check for PetscBeginFunctionUser in non-example source 547# TODO: check for __ at start of #define or symbol 548# TODO: checking for missing manual pages 549# TODO: check for incorrect %d 550# TODO: check for double blank lines 551# TODO: check for ill-formed manual pages 552# TODO: check for { on line after for 553# TODO: check for } then else on following line 554# TODO: check for } else { with SETERRQ on following line or if () { with SETERRQ on following line 555 556checkbadSpelling: 557 -@x=`python3 ../bin/extract.py | aspell list | sort -u` ; 558 559updatedatafiles: 560 -@if [ -d "${HOME}/datafiles" ]; then \ 561 echo " ** Updating datafiles at ${HOME}/datafiles **"; \ 562 cd "${HOME}/datafiles" && git pull -q; fi 563 564.PHONY: info info_h all deletelibs allclean update \ 565 alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanpages \ 566 allcleanhtml countfortranfunctions \ 567 start_configure configure_petsc configure_clean matlabbin install 568