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