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