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: 85 -@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir 86 @${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py ${BFORT} ${VERBOSE} 87 -@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py -merge ${VERBOSE} 88 -@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir 89 90#copy of allfortranstubs with PETSC_ARCH='' 91allfortranstubstarball: 92 -@${RM} -rf include/petsc/finclude/ftn-auto/*-tmpdir 93 @PETSC_ARCH='' ${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py ${BFORT} ${VERBOSE} 94 -@PETSC_ARCH='' ${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py -merge ${VERBOSE} 95 -@${RM} -rf include/petsc/finclude/ftn-auto/*-tmpdir 96 97deleteshared: 98 @for LIBNAME in ${SHLIBS}; \ 99 do \ 100 if [ -d ${INSTALL_LIB_DIR}/$${LIBNAME}.dylib.dSYM ]; then \ 101 echo ${RM} -rf ${INSTALL_LIB_DIR}/$${LIBNAME}.dylib.dSYM; \ 102 ${RM} -rf ${INSTALL_LIB_DIR}/$${LIBNAME}.dylib.dSYM; \ 103 fi; \ 104 echo ${RM} ${INSTALL_LIB_DIR}/$${LIBNAME}.${SL_LINKER_SUFFIX}; \ 105 ${RM} ${INSTALL_LIB_DIR}/$${LIBNAME}.${SL_LINKER_SUFFIX}; \ 106 done 107 @if [ -f ${INSTALL_LIB_DIR}/so_locations ]; then \ 108 echo ${RM} ${INSTALL_LIB_DIR}/so_locations; \ 109 ${RM} ${INSTALL_LIB_DIR}/so_locations; \ 110 fi 111 112deletefortranstubs: 113 -@find src -type d -name ftn-auto* | xargs rm -rf 114 -@if [ -x ${PETSC_ARCH} ]; then \ 115 find ${PETSC_ARCH}/src -type d -name ftn-auto* | xargs rm -rf ;\ 116 fi 117 118reconfigure: allclean 119 @unset MAKEFLAGS && ${PYTHON} ${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py 120 121chkopts: 122 -@echo "Warning: chkopts target is deprecated and can be removed from user makefiles" 123 124gnumake: 125 +@echo "make gnumake is deprecated, use make libs" 126 +@make libs 127 128# ******** Rules for make check **************************************************************************************************************************** 129 130RUN_TEST = ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff 131 132check_install: check 133check: 134 -@echo "Running check examples to verify correct installation" 135 -@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}" 136 @if [ "${PETSC_WITH_BATCH}" != "" ]; then \ 137 echo "Running with batch filesystem, cannot run make check"; \ 138 elif [ "${MPIEXEC}" = "/bin/false" ]; then \ 139 echo "*mpiexec not found*. cannot run make check"; \ 140 else \ 141 ${RM} -f check_error;\ 142 ${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; \ 143 if [ -f check_error ]; then \ 144 echo "Error while running make check"; \ 145 ${RM} -f check_error;\ 146 exit 1; \ 147 fi; \ 148 ${RM} -f check_error;\ 149 fi; 150 151check_build: 152 +@cd src/snes/tutorials >/dev/null; ${RUN_TEST} clean-legacy 153 +@cd src/snes/tutorials >/dev/null; ${RUN_TEST} testex19 154 +@if [ ! "${MPI_IS_MPIUNI}" ]; then cd src/snes/tutorials >/dev/null; ${RUN_TEST} testex19_mpi; fi 155 +@if [ "${HYPRE_LIB}" != "" ] && [ "${PETSC_SCALAR}" = "real" ]; then \ 156 if [ "${CUDA_LIB}" != "" ]; then HYPRE_TEST=runex19_hypre_cuda; \ 157 elif [ "${HIP_LIB}" != "" ]; then HYPRE_TEST=runex19_hypre_hip; \ 158 else HYPRE_TEST=runex19_hypre; fi; \ 159 cd src/snes/tutorials >/dev/null; ${RUN_TEST} $${HYPRE_TEST}; \ 160 fi; 161 +@if [ "${CUDA_LIB}" != "" ]; then \ 162 cd src/snes/tutorials >/dev/null; ${RUN_TEST} runex19_cuda; \ 163 fi; 164 +@if [ "${MPI_IS_MPIUNI}" = "" ]; then \ 165 cd src/snes/tutorials >/dev/null; \ 166 if [ "${KOKKOS_KERNELS_LIB}" != "" ] && [ "${PETSC_SCALAR}" = "real" ] && [ "${PETSC_PRECISION}" = "double" ]; then \ 167 ${RUN_TEST} runex3k_kokkos; \ 168 fi;\ 169 if [ "${MUMPS_LIB}" != "" ]; then \ 170 ${RUN_TEST} runex19_fieldsplit_mumps; \ 171 fi;\ 172 if [ "${SUITESPARSE_LIB}" != "" ]; then \ 173 ${RUN_TEST} runex19_suitesparse; \ 174 fi;\ 175 if [ "${SUPERLU_DIST_LIB}" != "" ]; then \ 176 ${RUN_TEST} runex19_superlu_dist; \ 177 fi;\ 178 if ( [ "${ML_LIB}" != "" ] || [ "${TRILINOS_LIB}" != "" ] ); then \ 179 ${RUN_TEST} runex19_ml; \ 180 fi; \ 181 ${RUN_TEST} clean-legacy; \ 182 cd - > /dev/null; \ 183 if ( [ "${AMREX_LIB}" != "" ] && [ "${CUDA_LIB}" = "" ] ); then \ 184 echo "Running amrex test example to verify correct installation";\ 185 echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}";\ 186 cd src/ksp/ksp/tutorials/amrex >/dev/null;\ 187 ${RUN_TEST} clean-legacy; \ 188 ${RUN_TEST} testamrex; \ 189 ${RUN_TEST} clean-legacy; \ 190 cd - > /dev/null; \ 191 fi;\ 192 fi; 193 +@if [ "${HDF5_LIB}" != "" ]; then \ 194 cd src/vec/vec/tests >/dev/null;\ 195 ${RUN_TEST} clean-legacy; \ 196 ${RUN_TEST} runex47; \ 197 ${RUN_TEST} clean-legacy; \ 198 fi; 199 +@if [ "${MPI4PY}" = "yes" ]; then \ 200 cd src/sys/tests >/dev/null; \ 201 ${RUN_TEST} clean-legacy; \ 202 ${RUN_TEST} testex55; \ 203 ${RUN_TEST} clean-legacy; \ 204 fi; 205 +@if [ "${PETSC4PY}" = "yes" ]; then \ 206 cd src/ksp/ksp/tutorials >/dev/null; \ 207 ${RUN_TEST} clean-legacy; \ 208 ${RUN_TEST} testex100; \ 209 ${RUN_TEST} clean-legacy; \ 210 fi; 211 +@grep -E "^#define PETSC_USE_FORTRAN_BINDINGS 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ 212 if test -s .ftn.log; then \ 213 cd src/snes/tutorials >/dev/null; \ 214 ${RUN_TEST} clean-legacy; \ 215 ${RUN_TEST} testex5f; \ 216 ${RUN_TEST} clean-legacy; \ 217 fi; ${RM} .ftn.log; 218 +@grep -E "^#define PETSC_HAVE_MATLAB 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ 219 if test -s .ftn.log; then \ 220 cd src/vec/vec/tutorials >/dev/null; \ 221 ${RUN_TEST} clean-legacy; \ 222 ${RUN_TEST} testex31; \ 223 ${RUN_TEST} clean-legacy; \ 224 fi; ${RM} .ftn.log; 225 +@if [ "${SLEPC}" = "yes" ]; then \ 226 ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} slepc-check; \ 227 fi; 228 -@echo "Completed PETSc test examples" 229 230# ********* Rules for make install ******************************************************************************************************************* 231 232install: 233 @${PYTHON} ./config/install.py -destDir=${DESTDIR} 234 +${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} PETSC_INSTALL=$@ install-builtafterpetsc 235 236# A smaller install with fewer extras 237install-lib: 238 @${PYTHON} ./config/install.py -destDir=${DESTDIR} -no-examples 239 +${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} PETSC_INSTALL=$@ install-builtafterpetsc 240 241install-builtafterpetsc: 242 +${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 243 244# Creates ${HOME}/petsc.tar.gz [and petsc-with-docs.tar.gz] 245dist: 246 ${PETSC_DIR}/lib/petsc/bin/maint/builddist ${PETSC_DIR} main 247 248# ******** Rules for running the full test suite ******************************************************************************************************** 249 250TESTMODE = testexamples 251ALLTESTS_CHECK_FAILURES = no 252ALLTESTS_MAKEFILE = ${PETSC_DIR}/gmakefile.test 253VALGRIND=0 254alltests: chk_in_petscdir ${PETSC_DIR}/${PETSC_ARCH}/tests/testfiles 255 -@${RM} -rf ${PETSC_ARCH}/lib/petsc/conf/alltests.log alltests.log 256 +@if [ -f ${PETSC_DIR}/share/petsc/examples/gmakefile.test ] ; then \ 257 ALLTESTS_MAKEFILE=${PETSC_DIR}/share/petsc/examples/gmakefile.test ; \ 258 ALLTESTSLOG=alltests.log ;\ 259 else \ 260 ALLTESTS_MAKEFILE=${PETSC_DIR}/gmakefile.test; \ 261 ALLTESTSLOG=${PETSC_ARCH}/lib/petsc/conf/alltests.log ;\ 262 ln -s $${ALLTESTSLOG} alltests.log ;\ 263 fi; \ 264 ${OMAKE} allgtest ALLTESTS_MAKEFILE=$${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} MPIEXEC="${MPIEXEC}" DATAFILESPATH=${DATAFILESPATH} VALGRIND=${VALGRIND} 2>&1 | tee $${ALLTESTSLOG};\ 265 if [ x${ALLTESTS_CHECK_FAILURES} = xyes -a ${PETSC_PRECISION} != single ]; then \ 266 cat $${ALLTESTSLOG} | grep -E '(^not ok|not remade because of errors|^# No tests run)' | wc -l | grep '^[ ]*0$$' > /dev/null; \ 267 fi; 268 269allgtests-tap: allgtest-tap 270 +@${OMAKE} -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} check-test-errors 271 272allgtest-tap: ${PETSC_DIR}/${PETSC_ARCH}/tests/testfiles 273 +@MAKEFLAGS="-j$(MAKE_TEST_NP) -l$(MAKE_LOAD) $(MAKEFLAGS)" ${OMAKE} -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} test OUTPUT=1 274 275allgtest: ${PETSC_DIR}/${PETSC_ARCH}/tests/testfiles 276 +@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).$$)' 277 278test: 279 +${OMAKE} -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} test 280cleantest: 281 +${OMAKE} -f ${ALLTESTS_MAKEFILE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} cleantest 282 283#********* Rules for cleaning *************************************************************************************************************************** 284 285deletelibs: 286 -${RM} -rf ${PETSC_LIB_DIR}/libpetsc*.* 287deletemods: 288 -${RM} -f ${PETSC_DIR}/${PETSC_ARCH}/include/petsc*.mod 289 290allclean: 291 -@${OMAKE} -f gmakefile clean 292 293clean:: allclean 294 295distclean: 296 @if [ -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ]; then \ 297 echo "*** Preserving ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py in ${PETSC_DIR} ***"; \ 298 mv -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ${PETSC_DIR}/; fi 299 @echo "*** Deleting all build files in ${PETSC_DIR}/${PETSC_ARCH} ***" 300 -${RM} -rf ${PETSC_DIR}/${PETSC_ARCH}/ 301 302info: 303 -@${OMAKE} -f gmakefile gmakeinfo 304 305check_usermakefile: 306 -@echo "Testing compile with user makefile" 307 -@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}" 308 @cd src/snes/tutorials; ${RUN_TEST} clean-legacy 309 @cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex19 310 @grep -E "^#define PETSC_USE_FORTRAN_BINDINGS 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ 311 if test -s .ftn.log; then \ 312 cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex5f; \ 313 fi; ${RM} .ftn.log; 314 @cd src/snes/tutorials; ${RUN_TEST} clean-legacy 315 -@echo "Completed compile with user makefile" 316 317#********* Rules for running clangformat ************************************************************************************************************ 318 319checkgitclean: 320 @if ! git diff --quiet; then \ 321 echo "The repository has uncommitted files, cannot run checkclangformat" ;\ 322 git status -s --untracked-files=no ;\ 323 false;\ 324 fi; 325 326checkclangformatversion: 327 @version=`clang-format --version | cut -d" " -f3 | cut -d"." -f 1` ;\ 328 if [ "$$version" == "version" ]; then version=`clang-format --version | cut -d" " -f4 | cut -d"." -f 1`; fi;\ 329 if [ $$version != 16 ]; then echo "Require clang-format version 16! Currently used clang-format version is $$version" ;false ; fi 330 331# Check that all the source code in the repository satisfies the .clang_format 332checkclangformat: checkclangformatversion checkgitclean clangformat 333 @if ! git diff --quiet; then \ 334 printf "The current commit has source code formatting problems\n" ;\ 335 if [ -z "${CI_PIPELINE_ID}" ]; then \ 336 printf "Please run 'git diff' to check\n"; \ 337 git diff --stat; \ 338 else \ 339 git diff --patch-with-stat > ${PETSC_ARCH}/lib/petsc/conf/checkclangformat.patch; \ 340 git diff --patch-with-stat --color=always | head -1000; \ 341 if [ `wc -l < ${PETSC_ARCH}/lib/petsc/conf/checkclangformat.patch` -gt 1000 ]; then \ 342 printf "The diff has been trimmed, check ${PETSC_ARCH}/lib/petsc/conf/checkclangformat.patch (in CI artifacts) for all changes\n"; \ 343 fi;\ 344 fi;\ 345 false;\ 346 fi; 347 348# Compare ABI/API of two versions of PETSc library with the old one defined by PETSC_{DIR,ARCH}_ABI_OLD 349abitest: 350 @if [ "${PETSC_DIR_ABI_OLD}" = "" ] || [ "${PETSC_ARCH_ABI_OLD}" = "" ]; \ 351 then printf "You must set environment variables PETSC_DIR_ABI_OLD and PETSC_ARCH_ABI_OLD to run abitest\n"; \ 352 exit 1; \ 353 fi; 354 -@echo "Comparing ABI/API of the following two PETSc versions (you must have already configured and built them using GCC and with -g):" 355 -@echo "=========================================================================================" 356 -@echo " Old: PETSC_DIR_ABI_OLD = ${PETSC_DIR_ABI_OLD}" 357 -@echo " PETSC_ARCH_ABI_OLD = ${PETSC_ARCH_ABI_OLD}" 358 -@pushd ${PETSC_DIR_ABI_OLD} >> /dev/null ; echo " Branch = "`git rev-parse --abbrev-ref HEAD` 359 -@echo " New: PETSC_DIR = ${PETSC_DIR}" 360 -@echo " PETSC_ARCH = ${PETSC_ARCH}" 361 -@echo " Branch = "`git rev-parse --abbrev-ref HEAD` 362 -@echo "=========================================================================================" 363 -@$(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 364 365# Compare ABI/API of current PETSC_ARCH/PETSC_DIR with a previous branch 366abitestcomplete: 367 -@if [[ -f "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/configure.log" ]]; then \ 368 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"` ;\ 369echo $${OPTIONS} ;\ 370 fi ; \ 371 if [[ "${PETSC_DIR_ABI_OLD}" != "" ]]; then \ 372 PETSC_DIR_OLD=${PETSC_DIR_ABI_OLD}; \ 373 else \ 374 PETSC_DIR_OLD=${PETSC_DIR}/../petsc-abi; \ 375 fi ; \ 376 echo "=================================================================================================" ;\ 377 echo "Doing ABI/API comparison between" ${branch} " and " `git rev-parse --abbrev-ref HEAD` "using " $${OPTIONS} ;\ 378 echo "=================================================================================================" ;\ 379 if [[ ! -d $${PETSC_DIR_OLD} ]]; then \ 380 git clone ${PETSC_DIR} $${PETSC_DIR_OLD} ; \ 381 else \ 382 cd $${PETSC_DIR_OLD} ; \ 383 git pull ; \ 384 fi ; \ 385 cd $${PETSC_DIR_OLD} ; \ 386 git checkout ${branch} ; \ 387 PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` ./configure $${OPTIONS} ; \ 388 PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` make all test ; \ 389 cd ${PETSC_DIR} ; \ 390 ./configure $${OPTIONS}; \ 391 make all test ; \ 392 PETSC_DIR_ABI_OLD=$${PETSC_DIR_OLD} PETSC_ARCH_ABI_OLD=arch-branch-`git rev-parse ${branch}` make abitest 393 394# ******** Rules for running Streams benchmark **************************************************************************************************** 395 396mpistreams: 397 +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistreams 398 399mpistream: 400 +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistream 401 402openmpstreams: 403 +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstreams 404 405openmpstream: 406 +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstream 407 408stream: mpistream 409 410streams: mpistreams 411 412# ******** Rules for generating tag files for Emacs/VIM ******************************************************************************************* 413 414alletags: 415 -@${PYTHON} lib/petsc/bin/maint/generateetags.py 416 -@find config -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON 417 418# obtain gtags from https://www.gnu.org/software/global/ 419allgtags: 420 -@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 - 421 422# ********* Rules for building "classic" documentation; uses rules also in lib/petsc/conf/rules.doc ************************************************** 423 424docs: 425 cd doc; ${OMAKE_SELF} sphinxhtml 426 427chk_in_petscdir: 428 @if [ ! -f include/petscversion.h ]; then \ 429 printf ${PETSC_TEXT_HILIGHT}"*********************** ERROR **********************************************\n" ; \ 430 echo " This target should be invoked in top level PETSc source dir!"; \ 431 printf "****************************************************************************"${PETSC_TEXT_NORMAL}"\n" ; false; fi 432 433chk_loc: 434 @if [ ${LOC}foo = foo ] ; then \ 435 printf ${PETSC_TEXT_HILIGHT}"*********************** ERROR **********************************************\n" ; \ 436 echo " Please specify LOC variable for eg: make allmanpages LOC=/sandbox/petsc "; \ 437 printf "****************************************************************************"${PETSC_TEXT_NORMAL}"\n" ; false; fi 438 @${MKDIR} ${LOC}/manualpages 439 440chk_c2html: 441 @if [ ${C2HTML}foo = foo ] ; then \ 442 printf ${PETSC_TEXT_HILIGHT}"*********************** ERROR ************************\n" ; \ 443 echo "Require c2html for html docs. Please reconfigure with --download-c2html=1"; \ 444 printf "******************************************************"${PETSC_TEXT_NORMAL}"\n" ;false; fi 445 446 447# the ACTION=manualpages cannot run in parallel because they all write to the same manualpages.cit file 448hloc=include/petsc/private 449allmanpages: chk_loc deletemanualpages 450 -echo " /* SUBMANSEC = PetscH */ " > ${hloc}/generated_khash.h 451 -sed -e 's?<T>?I?g' -e 's?<t>?i?g' -e 's?<KeyType>?PetscInt?g' ${hloc}/hashset.txt >> ${hloc}/generated_khash.h 452 -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 453 -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 454 -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 455 -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 456 -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 457 -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 458 -${RM} ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err 459 -${OMAKE_SELF} ACTION=manualpages tree_src LOC=${LOC} 460 -@sed -e s%man+../%man+manualpages/% ${LOC}/manualpages/manualpages.cit > ${LOC}/manualpages/htmlmap 461 -@cat ${PETSC_DIR}/doc/classic/mpi.www.index >> ${LOC}/manualpages/htmlmap 462 cat ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err 463 a=`cat ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err | wc -l`; test ! $$a -gt 0 464 465allmanexamples: chk_loc allmanpages 466 -${OMAKE_SELF} ACTION=manexamples tree LOC=${LOC} 467 468# 469# Goes through all manual pages adding links to implementations of the method 470# or class, at the end of the file. 471# 472# To find functions implementing methods, we use git grep to look for 473# well-formed PETSc functions 474# - with names containing a single underscore 475# - in files of appropriate types (.cu .c .cxx .h), 476# - in paths including "/impls/", 477# - excluding any line with a semicolon (to avoid matching prototypes), and 478# - excluding any line including "_Private", 479# storing potential matches in implsFuncAll.txt. 480# 481# For each man page we then grep in this file for the item's name followed by 482# a single underscore and process the resulting implsFunc.txt to generate HTML. 483# 484# To find class implementations, we populate implsClassAll.txt with candidates 485# - of the form "struct _p_itemName {", and 486# - not containing a semicolon 487# and then grep for particular values of itemName, generating implsClass.txt, 488# which is processed to generate HTML. 489# 490# Note: PETSC_DOC_OUT_ROOT_PLACEHOLDER must match the term used elsewhere in doc/ 491manimplementations: 492 -@git grep "struct\s\+_[pn]_[^\s]\+.*{" -- *.cpp *.cu *.c *.h *.cxx | grep -v -e ";" -e "/tests/" -e "/tutorials/" > implsClassAll.txt ; \ 493 git grep -n "^\(static \)\?\(PETSC_EXTERN \)\?\(PETSC_INTERN \)\?\(extern \)\?PetscErrorCode \+[^_ ]\+_[^_ ]\+(" -- '*/impls/*.c' '*/impls/*.cpp' '*/impls/*.cu' '*/impls/*.cxx' '*/impls/*.h' | grep -v -e ";" -e "_[Pp]rivate" > implsFuncAll.txt ; \ 494 for i in ${LOC}/manualpages/*/*.md foo; do \ 495 if [ "$$i" != "foo" ] ; then \ 496 itemName=`basename $$i .md`;\ 497 grep "\s$${itemName}_" implsFuncAll.txt > implsFunc.txt ; \ 498 grep "_p_$${itemName}\b" implsClassAll.txt > implsClass.txt ; \ 499 if [ -s implsFunc.txt ] || [ -s implsClass.txt ] ; then \ 500 printf "\n## Implementations\n\n" >> $$i; \ 501 fi ; \ 502 if [ -s implsFunc.txt ] ; then \ 503 sed "s?\(.*\.[ch]x*u*\).*\($${itemName}.*\)(.*)?<A HREF=\"PETSC_DOC_OUT_ROOT_PLACEHOLDER/\1.html#\2\">\2 in \1</A><BR>?" implsFunc.txt >> $$i ; \ 504 fi ; \ 505 if [ -s implsClass.txt ] ; then \ 506 sed "s?\(.*\.[ch]x*u*\):.*struct.*\(_p_$${itemName}\).*{?<A HREF=\"PETSC_DOC_OUT_ROOT_PLACEHOLDER/\1.html#\2\">\2 in \1</A><BR>?" implsClass.txt >> $$i ; \ 507 fi ; \ 508 ${RM} implsFunc.txt implsClass.txt; \ 509 fi ; \ 510 done ; \ 511 ${RM} implsClassAll.txt implsFuncAll.txt 512 513# Build all classic docs except html sources 514alldoc_pre: chk_loc allmanpages allmanexamples 515 -${OMAKE_SELF} LOC=${LOC} manimplementations 516 -${PYTHON} lib/petsc/bin/maint/wwwindex.py ${PETSC_DIR} ${LOC} 517 518# Run after alldoc_pre to build html sources 519alldoc_post: chk_loc chk_c2html 520 -@if command -v parallel &> /dev/null; then \ 521 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' ; \ 522 else \ 523 ${OMAKE_SELF} HTMLMAP=${HTMLMAP} LOC=${LOC} PETSC_DIR=${PETSC_DIR} ACTION=html tree; \ 524 fi 525 526alldocclean: deletemanualpages allcleanhtml 527 528# Deletes man pages (.md version) 529deletemanualpages: chk_loc 530 -@if [ -d ${LOC} -a -d ${LOC}/manualpages ]; then \ 531 find ${LOC}/manualpages -type f -name "*.md" -exec ${RM} {} \; ;\ 532 ${RM} ${LOC}/manualpages/manualpages.cit ;\ 533 fi 534 535allcleanhtml: 536 -${OMAKE_SELF} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} tree 537 538# ********* Rules for checking code coverage ********************************************************************************************* 539 540gcov: 541 output_file_base_name=${PETSC_ARCH}-gcovr-report.json; \ 542 petsc_arch_dir=${PETSC_DIR}/${PETSC_ARCH}; \ 543 tar_file=$${petsc_arch_dir}/$${output_file_base_name}.tar.bz2; \ 544 cd $${petsc_arch_dir} && \ 545 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} && \ 546 ${RM} -f $${tar_file} && \ 547 tar --bzip2 -cf $${tar_file} -C $${petsc_arch_dir} ./$${output_file_base_name} && \ 548 ${RM} $${petsc_arch_dir}/$${output_file_base_name} 549 550mergegcov: 551 $(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py --merge-branch `lib/petsc/bin/maint/check-merge-branch.sh` --html --xml ${PETSC_GCOV_OPTIONS} 552 553countfortranfunctions: 554 -@cd ${PETSC_DIR}/src/fortran; grep -E '^void' custom/*.c auto/*.c | \ 555 cut -d'(' -f1 | tr -s ' ' | cut -d' ' -f2 | uniq | grep -E -v "(^$$|Petsc)" | \ 556 sed "s/_$$//" | sort > /tmp/countfortranfunctions 557 558countcfunctions: 559 -@grep PETSC_EXTERN ${PETSC_DIR}/include/*.h | grep "(" | tr -s ' ' | \ 560 cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' | \ 561 tr 'A-Z' 'a-z' | sort | uniq > /tmp/countcfunctions 562 563difffortranfunctions: countfortranfunctions countcfunctions 564 -@echo -------------- Functions missing in the fortran interface --------------------- 565 -@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2 566 -@echo ----------------- Functions missing in the C interface ------------------------ 567 -@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2 568 -@${RM} /tmp/countcfunctions /tmp/countfortranfunctions 569 570checkbadfortranstubs: 571 -@echo "=========================================" 572 -@echo "Functions with MPI_Comm as an Argument" 573 -@echo "=========================================" 574 -@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \ 575 tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3 576 -@echo "=========================================" 577 -@echo "Functions with a String as an Argument" 578 -@echo "=========================================" 579 -@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \ 580 tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3 581 -@echo "=========================================" 582 -@echo "Functions with Pointers to PETSc Objects as Argument" 583 -@echo "=========================================" 584 -@cd ${PETSC_DIR}/src/fortran/auto; \ 585 _p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \ 586 cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \ 587 sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \ 588 for OBJ in $$_p_OBJ; do \ 589 grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \ 590 cut -d'(' -f1 | cut -d' ' -f1,3; \ 591 done 592 593checkpackagetests: 594 -@echo "Missing package tests" 595 -@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 596 -@echo "Missing download package tests" 597 -@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 598 599check_petsc4py_rst: 600 @${RM} -f petsc4py_rst.log 601 @echo "Checking src/binding/petsc4py/DESCRIPTION.rst" 602 @rst2html src/binding/petsc4py/DESCRIPTION.rst > /dev/null 2> petsc4py_rst.log 603 @if test -s petsc4py_rst.log; then cat petsc4py_rst.log; exit 1; fi 604 605# TODO: checkTestCoverage: that makes sure every tutorial test has at least one test listed in the file, perhaps handled by gmakegentest.py 606# TODO: check for PetscBeginFunctionUser in non-example source 607# TODO: check for __ at start of #define or symbol 608# TODO: checking for missing manual pages 609# TODO: check for incorrect %d 610# TODO: check for double blank lines 611# TODO: check for ill-formed manual pages 612# TODO: check for { on line after for 613# TODO: check for } then else on following line 614# TODO: check for } else { with SETERRQ on following line or if () { with SETERRQ on following line 615 616checkbadSpelling: 617 -@x=`python3 ../bin/extract.py | aspell list | sort -u` ; 618 619updatedatafiles: 620 -@if [ -d "${HOME}/datafiles" ]; then \ 621 echo " ** Updating datafiles at ${HOME}/datafiles **"; \ 622 cd "${HOME}/datafiles" && git pull -q; fi 623 624.PHONY: info info_h all deletelibs allclean update \ 625 alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanpages \ 626 allcleanhtml countfortranfunctions \ 627 start_configure configure_petsc configure_clean matlabbin install 628