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