# # This is the makefile for compiling PETSc. See # http://www.mcs.anl.gov/petsc/documentation/installation.html for directions on installing PETSc. # See also conf for additional commands. # ALL: all LOCDIR = ./ DIRS = src include tutorials interfaces share/petsc/matlab CFLAGS = FFLAGS = CPPFLAGS = FPPFLAGS = # next line defines PETSC_DIR and PETSC_ARCH if they are not set include ././${PETSC_ARCH}/lib/petsc/conf/petscvariables include ${PETSC_DIR}/lib/petsc/conf/variables include ${PETSC_DIR}/lib/petsc/conf/rules include ${PETSC_DIR}/lib/petsc/conf/test.common # This makefile contains a lot of PHONY targets with improperly specified prerequisites # where correct execution instead depends on the targets being processed in the correct # order. This is gross, but this makefile doesn't really do any work. Sub-makes still # benefit from parallelism. .NOTPARALLEL: OMAKE_SELF = $(OMAKE) -f makefile OMAKE_SELF_PRINTDIR = $(OMAKE_PRINTDIR) -f makefile # # Basic targets to build PETSc libraries. # all: +@${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} chk_petscdir chk_upgrade | tee ${PETSC_ARCH}/lib/petsc/conf/make.log @ln -sf ${PETSC_ARCH}/lib/petsc/conf/make.log make.log +@${OMAKE_SELF_PRINTDIR} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-local 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; @egrep '(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 @egrep -i "( error | error: |no such file or directory)" ${PETSC_ARCH}/lib/petsc/conf/make.log | tee ${PETSC_ARCH}/lib/petsc/conf/error.log > /dev/null +@if test -s ${PETSC_ARCH}/lib/petsc/conf/memoryerror.log; then \ printf ${PETSC_TEXT_HILIGHT}"**************************ERROR*************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \ 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; \ printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\ elif test -s ${PETSC_ARCH}/lib/petsc/conf/error.log; then \ printf ${PETSC_TEXT_HILIGHT}"**************************ERROR*************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \ echo " Error during compile, check ${PETSC_ARCH}/lib/petsc/conf/make.log" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \ 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;\ printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\ else \ ${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 ;\ fi #solaris make likes to print the whole command that gave error. So split this up into the smallest chunk below @echo "Finishing make run at `date +'%a, %d %b %Y %H:%M:%S %z'`" >> ${PETSC_ARCH}/lib/petsc/conf/make.log @if test -s ${PETSC_ARCH}/lib/petsc/conf/error.log; then exit 1; fi all-local: info libs matlabbin petsc4py-build libmesh-build mfem-build slepc-build hpddm-build amrex-build bamg-build # # Prints information about the system and version of PETSc being compiled # info: -@echo "==========================================" -@echo " " -@echo "See documentation/faq.html and documentation/bugreporting.html" -@echo "for help with installation problems. Please send EVERYTHING" -@echo "printed out below when reporting problems. Please check the" -@echo "mailing list archives and consider subscribing." -@echo " " -@echo " https://petsc.org/release/community/mailing/" -@echo " " -@echo "==========================================" -@echo Starting make run on `hostname` at `date +'%a, %d %b %Y %H:%M:%S %z'` -@echo Machine characteristics: `uname -a` -@echo "-----------------------------------------" -@echo "Using PETSc directory: ${PETSC_DIR}" -@echo "Using PETSc arch: ${PETSC_ARCH}" -@echo "-----------------------------------------" -@grep "define PETSC_VERSION" ${PETSC_DIR}/include/petscversion.h | ${SED} "s/........//" -@echo "-----------------------------------------" -@echo "Using configure Options: ${CONFIGURE_OPTIONS}" -@echo "Using configuration flags:" -@grep "\#define " ${PETSCCONF_H} -@echo "-----------------------------------------" -@echo "Using C compile: ${PETSC_CCOMPILE_SINGLE}" -@if [ "${MPICC_SHOW}" != "" ]; then \ printf "mpicc -show: %b\n" "${MPICC_SHOW}";\ fi; \ printf "C compiler version: %b\n" "${C_VERSION}"; \ if [ "${CXX}" != "" ]; then \ echo "Using C++ compile: ${PETSC_CXXCOMPILE_SINGLE}";\ if [ "${MPICXX_SHOW}" != "" ]; then \ printf "mpicxx -show: %b\n" "${MPICXX_SHOW}"; \ fi;\ printf "C++ compiler version: %b\n" "${Cxx_VERSION}"; \ fi -@if [ "${FC}" != "" ]; then \ echo "Using Fortran compile: ${PETSC_FCOMPILE_SINGLE}";\ if [ "${MPIFC_SHOW}" != "" ]; then \ printf "mpif90 -show: %b\n" "${MPIFC_SHOW}"; \ fi; \ printf "Fortran compiler version: %b\n" "${FC_VERSION}"; \ fi -@if [ "${CUDAC}" != "" ]; then \ echo "Using CUDA compile: ${PETSC_CUCOMPILE_SINGLE}";\ fi -@if [ "${CLANGUAGE}" = "CXX" ]; then \ echo "Using C++ compiler to compile PETSc";\ fi -@echo "-----------------------------------------" -@echo "Using C/C++ linker: ${PCC_LINKER}" -@echo "Using C/C++ flags: ${PCC_LINKER_FLAGS}" -@if [ "${FC}" != "" ]; then \ echo "Using Fortran linker: ${FC_LINKER}";\ echo "Using Fortran flags: ${FC_LINKER_FLAGS}";\ fi -@echo "-----------------------------------------" -@echo "Using system modules: ${LOADEDMODULES}" -@if [ "${MPI_IS_MPIUNI}" = "1" ]; then \ echo Using mpi.h: mpiuni; \ else \ TESTDIR=`mktemp -q -d -t petscmpi-XXXXXXXX` && \ echo '#include ' > $${TESTDIR}/mpitest.c && \ BUF=`${CPP} ${PETSC_CPPFLAGS} ${PETSC_CC_INCLUDES} $${TESTDIR}/mpitest.c |grep 'mpi\.h' | ( head -1 ; cat > /dev/null )` && \ echo Using mpi.h: $${BUF}; ${RM} -rf $${TESTDIR}; \ fi -@echo "-----------------------------------------" -@echo "Using libraries: ${PETSC_LIB}" -@echo "------------------------------------------" -@echo "Using mpiexec: ${MPIEXEC}" -@echo "------------------------------------------" -@echo "Using MAKE: $(MAKE)" -@echo "Using MAKEFLAGS: -j$(MAKE_NP) -l$(MAKE_LOAD) $(MAKEFLAGS)" -@echo "==========================================" # # Build MatLab binaries # matlabbin: -@if [ "${MATLAB_MEX}" != "" -a "${MATLAB_SOCKET}" != "" -a "${PETSC_SCALAR}" = "real" -a "${PETSC_PRECISION}" = "double" ]; then \ echo "BEGINNING TO COMPILE MATLAB INTERFACE"; \ if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc" ] ; then ${MKDIR} ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc; fi; \ if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab" ] ; then ${MKDIR} ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab; fi; \ cd src/sys/classes/viewer/impls/socket/matlab && ${OMAKE_SELF} matlabcodes PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR}; \ echo "========================================="; \ fi # # Builds PETSc check examples for a given architecture # check_install: check check: -+@${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} check_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/check.log checkx: -@${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} checkx_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/checkx.log check_build: -@echo "Running check examples to verify correct installation" -@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}" +@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} clean-legacy +@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} testex19 +@if [ "${HYPRE_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ] && [ "${PETSC_SCALAR}" = "real" ]; then \ if [ "${CUDA_LIB}" != "" ]; then HYPRE_TEST=runex19_hypre_cuda; \ elif [ "${HIP_LIB}" != "" ]; then HYPRE_TEST=runex19_hypre_hip; \ else HYPRE_TEST=runex19_hypre; \ fi; \ cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff $${HYPRE_TEST}; \ fi; +@if [ "${CUDA_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \ cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_cuda; \ fi; +@if [ "${KOKKOS_KERNELS_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ] && [ "${PETSC_SCALAR}" = "real" ] && [ "${PETSC_PRECISION}" = "double" ] && [ "${MPI_IS_MPIUNI}" = "" ]; then \ cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex3k_kokkos; \ fi; +@if [ "${MUMPS_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \ cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_fieldsplit_mumps; \ fi; +@if [ "${SUPERLU_DIST_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \ cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_superlu_dist; \ fi; +@if [ "${HDF5_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \ cd src/vec/vec/tests >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex47; \ fi; +@if [ "${AMREX_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \ echo "Running testamres examples to verify correct installation";\ echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}";\ cd src/ksp/ksp/tutorials/amrex >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} clean-legacy;\ ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} testamrex;\ fi; +@if ( [ "${ML_LIB}" != "" ] || [ "${TRILINOS_LIB}" != "" ] ) && [ "${PETSC_WITH_BATCH}" = "" ]; then \ cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_ml; \ fi; +@if [ "${SUITESPARSE_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \ cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_suitesparse; \ fi; +@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ex19.rm +@if [ "${MPI4PY}" = "yes" ]; then \ cd src/sys/tests >/dev/null; \ ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} testex55; \ fi; +@if [ "${PETSC4PY}" = "yes" ]; then \ cd src/ksp/ksp/tutorials >/dev/null; \ ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} clean-legacy; \ ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} testex100; \ ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} clean-legacy; \ fi; +@egrep "^#define PETSC_HAVE_FORTRAN 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ if test -s .ftn.log; then \ cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} testex5f; \ fi; ${RM} .ftn.log; +@egrep "^#define PETSC_HAVE_MATLAB_ENGINE 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ if test -s .ftn.log; then \ cd src/vec/vec/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} testex31; \ fi; ${RM} .ftn.log; +@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} clean-legacy -@echo "Completed test examples" checkx_build: -@echo "Running graphics check example to verify correct X11 installation" -@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}" @cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} clean-legacy @cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} testxex19 @cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} clean-legacy -@echo "Completed graphics check example" check_usermakefile: -@echo "Testing compile with user makefile" -@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}" @cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex19 @egrep "^#define PETSC_HAVE_FORTRAN 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \ if test -s .ftn.log; then \ cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex5f; \ fi; ${RM} .ftn.log; @cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} clean-legacy -@echo "Completed compile with user makefile" # Compare ABI/API of two versions of PETSc library with the old one defined by PETSC_{DIR,ARCH}_ABI_OLD abitest: @if [ "${PETSC_DIR_ABI_OLD}" = "" ] || [ "${PETSC_ARCH_ABI_OLD}" = "" ]; \ then printf "You must set environment variables PETSC_DIR_ABI_OLD and PETSC_ARCH_ABI_OLD to run abitest\n"; \ exit 1; \ fi; -@echo "Comparing ABI/API of the following two PETSc versions (you must have already configured and built them using GCC and with -g):" -@echo "=========================================================================================" -@echo " Old: PETSC_DIR_ABI_OLD = ${PETSC_DIR_ABI_OLD}" -@echo " PETSC_ARCH_ABI_OLD = ${PETSC_ARCH_ABI_OLD}" -@pushd ${PETSC_DIR_ABI_OLD} >> /dev/null ; echo " Branch = "`git rev-parse --abbrev-ref HEAD` -@echo " New: PETSC_DIR = ${PETSC_DIR}" -@echo " PETSC_ARCH = ${PETSC_ARCH}" -@echo " Branch = "`git rev-parse --abbrev-ref HEAD` -@echo "=========================================================================================" -@$(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 # Compare ABI/API of current PETSC_ARCH/PETSC_DIR with a previous branch abitestcomplete: -@if [[ -f "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/configure.log" ]]; then \ 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"` ;\ echo $${OPTIONS} ;\ fi ; \ if [[ "${PETSC_DIR_ABI_OLD}" != "" ]]; then \ PETSC_DIR_OLD=${PETSC_DIR_ABI_OLD}; \ else \ PETSC_DIR_OLD=${PETSC_DIR}/../petsc-abi; \ fi ; \ echo "=================================================================================================" ;\ echo "Doing ABI/API comparison between" ${branch} " and " `git rev-parse --abbrev-ref HEAD` "using " $${OPTIONS} ;\ echo "=================================================================================================" ;\ if [[ ! -d $${PETSC_DIR_OLD} ]]; then \ git clone ${PETSC_DIR} $${PETSC_DIR_OLD} ; \ else \ cd $${PETSC_DIR_OLD} ; \ git pull ; \ fi ; \ cd $${PETSC_DIR_OLD} ; \ git checkout ${branch} ; \ PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` ./configure $${OPTIONS} ; \ PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` make all test ; \ cd ${PETSC_DIR} ; \ ./configure $${OPTIONS}; \ make all test ; \ PETSC_DIR_ABI_OLD=$${PETSC_DIR_OLD} PETSC_ARCH_ABI_OLD=arch-branch-`git rev-parse ${branch}` make abitest # Deletes PETSc libraries deletelibs: -${RM} -rf ${PETSC_LIB_DIR}/libpetsc*.* deletemods: -${RM} -f ${PETSC_DIR}/${PETSC_ARCH}/include/petsc*.mod allclean: -@${OMAKE} -f gmakefile clean clean:: allclean distclean: chk_petscdir @if [ -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ]; then \ echo "*** Preserving ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py in ${PETSC_DIR} ***"; \ mv -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ${PETSC_DIR}/; fi @echo "*** Deleting all build files in ${PETSC_DIR}/${PETSC_ARCH} ***" -${RM} -rf ${PETSC_DIR}/${PETSC_ARCH}/ # reconfigure: allclean @unset MAKEFLAGS && ${PYTHON} ${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py # install: @${PYTHON} ./config/install.py -destDir=${DESTDIR} +${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} petsc4py-install libmesh-install mfem-install slepc-install hpddm-install amrex-install bamg-install mpistreams: +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistreams mpistream: +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistream openmpstreams: +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstreams openmpstream: +@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstream # for legacy reasons stream: mpistream streams: mpistreams # ------------------------------------------------------------------ # # All remaining actions are intended for PETSc developers only. # PETSc users should not generally need to use these commands. # # See the users manual for how the tags files may be used from Emacs and Vi/Vim # alletags: -@${PYTHON} lib/petsc/bin/maint/generateetags.py -@find config -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON # obtain gtags from https://www.gnu.org/software/global/ allgtags: -@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 - allfortranstubs: -@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir @${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py ${BFORT} ${VERBOSE} -@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py -merge ${VERBOSE} -@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir deletefortranstubs: -@find . -type d -name ftn-auto | xargs rm -rf # Builds all the documentation - should be done every night alldoc: allcite sphinx-docs-all alldoc1 alldoc2 docsetdate # Build just citations allcite: chk_loc deletemanualpages -${OMAKE_SELF} ACTION=manualpages_buildcite tree_basic LOC=${LOC} -@sed -e s%man+../%man+manualpages/% ${LOC}/docs/manualpages/manualpages.cit > ${LOC}/docs/manualpages/htmlmap -@cat ${PETSC_DIR}/src/docs/mpi.www.index >> ${LOC}/docs/manualpages/htmlmap # Build just manual pages + prerequisites allmanpages: chk_loc allcite -${RM} ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err -${OMAKE_SELF} ACTION=manualpages tree_basic LOC=${LOC} -a=`cat ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err | wc -l`; test ! $$a -gt 0 # Build just manual examples + prerequisites allmanexamples: chk_loc allmanpages -${OMAKE_SELF} ACTION=manexamples tree_basic LOC=${LOC} # Build everything that goes into 'doc' dir except html sources alldoc1: chk_loc chk_concepts_dir allcite allmanpages allmanexamples -${OMAKE_SELF} manimplementations LOC=${LOC} -${PYTHON} lib/petsc/bin/maint/wwwindex.py ${PETSC_DIR} ${LOC} -${OMAKE_SELF} ACTION=getexlist tree_basic LOC=${LOC} -${OMAKE_SELF} ACTION=exampleconcepts tree_basic LOC=${LOC} -${PYTHON} lib/petsc/bin/maint/helpindex.py ${PETSC_DIR} ${LOC} # Builds .html versions of the source # html overwrites some stuff created by update-docs - hence this is done later. alldoc2: chk_loc allcite -${OMAKE_SELF} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC} -${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC} alldoc12: alldoc1 alldoc2 # # Makes links for all manual pages in $LOC/docs/manualpages/all allman: @cd ${LOC}/docs/manualpages; rm -rf all ; mkdir all ; find * -type d -wholename all -prune -o -name index.html -prune -o -type f -name \*.html -exec ln -s -f ../{} all \; DOCSETDATE_PRUNE_LIST=-o -type f -wholename share/petsc/saws/linearsolveroptions.html -prune -o -type f -wholename tutorials/HandsOnExercise.html -prune -o -type f -wholename tutorials/TAOHandsOnExercise.html -prune # modify all generated html files and add in version number, date, canonical URL info. docsetdate: chk_petscdir @echo "Updating generated html files with petsc version, date, canonical URL info";\ version_release=`grep '^#define PETSC_VERSION_RELEASE ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \ version_major=`grep '^#define PETSC_VERSION_MAJOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \ version_minor=`grep '^#define PETSC_VERSION_MINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \ version_subminor=`grep '^#define PETSC_VERSION_SUBMINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \ if [ $${version_release} = 0 ]; then \ petscversion=petsc-main; \ export petscversion; \ elif [ $${version_release} = 1 ]; then \ petscversion=petsc-$${version_major}.$${version_minor}.$${version_subminor}; \ export petscversion; \ else \ echo "Unknown PETSC_VERSION_RELEASE: $${version_release}"; \ exit; \ fi; \ datestr=`git log -1 --pretty=format:%ci | cut -d ' ' -f 1`; \ export datestr; \ gitver=`git describe --match "v*"`; \ export gitver; \ find * -type d -wholename src/docs/website \ -prune -o -type d -wholename src/benchmarks/results \ -prune -o -type d -wholename config/BuildSystem/docs/website \ -prune -o -type d -wholename include/web \ -prune -o -type d -wholename 'arch-*' \ -prune -o -type d -wholename lib/petsc/bin/maint \ -prune -o -type d -wholename externalpackages \ -prune ${DOCSETDATE_PRUNE_LIST} -o -type f -name \*.html \ -exec perl -pi -e 's^()^$$1\n
$$ENV{petscversion} $$ENV{datestr}
\n ^i' {} \; \ -exec perl -pi -e 's^()^$$1 ^i' {} \; ; \ echo "Done fixing version number, date, canonical URL info" # Use Sphinx to build some documentation. This uses Python's venv, which should # behave similarly to what happens on e.g. ReadTheDocs. You may prefer to use # your own Python environment and directly build the Sphinx docs by using # the makefile in ${PETSC_SPHINX_ROOT}, paying attention to the requirements.txt # there. PETSC_SPHINX_ROOT=doc PETSC_SPHINX_ENV=${PETSC_ARCH}/sphinx_docs_env PETSC_SPHINX_DEST=docs/sphinx_docs sphinx-docs-all: sphinx-docs-manual sphinx-docs-html sphinx-docs-fast: chk_loc sphinx-docs-env @. ${PETSC_SPHINX_ENV}/bin/activate && ${OMAKE} -C ${PETSC_SPHINX_ROOT} \ BUILDDIR=${LOC}/${PETSC_SPHINX_DEST} html sphinx-docs-html: chk_loc allcite sphinx-docs-env @. ${PETSC_SPHINX_ENV}/bin/activate && ${OMAKE} -C ${PETSC_SPHINX_ROOT} \ BUILDDIR=${LOC}/${PETSC_SPHINX_DEST} html sphinx-docs-manual: chk_loc sphinx-docs-env @. ${PETSC_SPHINX_ENV}/bin/activate && ${OMAKE} -C ${PETSC_SPHINX_ROOT} BUILDDIR=${LOC}/${PETSC_SPHINX_DEST} latexpdf @mv ${LOC}/${PETSC_SPHINX_DEST}/latex/manual.pdf ${LOC}/docs/manual.pdf @${RM} -rf ${LOC}/${PETSC_SPHINX_DEST}/latex sphinx-docs-env: sphinx-docs-check-python sphinx-docs-check-rsvg-convert @if [ ! -d "${PETSC_SPHINX_ENV}" ]; then \ ${PYTHON} -m venv ${PETSC_SPHINX_ENV}; \ . ${PETSC_SPHINX_ENV}/bin/activate; \ pip install -r ${PETSC_SPHINX_ROOT}/requirements.txt; \ fi sphinx-docs-check-rsvg-convert: @if ! command -v rsvg-convert 2>&1 > /dev/null; then \ printf "rsvg-convert is required for the sphinxcontrib-svg2pdfconverter extension for the Sphinx docs\n"; \ false; \ fi sphinx-docs-check-python: @${PYTHON} -c 'import sys; sys.exit(sys.version_info[:2] < (3,3))' || \ (printf 'Working Python 3.3 or later is required to build the Sphinx docs in a virtual environment\nTry e.g.\n make ... PYTHON=python3\n' && false) sphinx-docs-clean: chk_loc ${RM} -rf ${PETSC_SPHINX_ENV} ${RM} -rf ${LOC}/${PETSC_SPHINX_DEST} alldocclean: deletemanualpages allcleanhtml sphinx-docs-clean # Deletes man pages (HTML version) deletemanualpages: chk_loc -@if [ -d ${LOC} -a -d ${LOC}/docs/manualpages ]; then \ find ${LOC}/docs/manualpages -type f -name "*.html" -exec ${RM} {} \; ;\ ${RM} ${LOC}/docs/exampleconcepts ;\ ${RM} ${LOC}/docs/manualpages/manualpages.cit ;\ ${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC} clean;\ fi allcleanhtml: -${OMAKE_SELF} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} alltree chk_concepts_dir: chk_loc @if [ ! -d "${LOC}/docs/manualpages/concepts" ]; then \ echo Making directory ${LOC}/docs/manualpages/concepts for library; ${MKDIR} ${LOC}/docs/manualpages/concepts; fi # Builds simple html versions of the source without links into the $PETSC_ARCH/obj directory, used by make mergecov srchtml: -${OMAKE_SELF} ACTION=simplehtml PETSC_DIR=${PETSC_DIR} alltree_src ########################################################### # targets to build distribution and update docs ########################################################### # Creates ${HOME}/petsc.tar.gz [and petsc-with-docs.tar.gz] dist: ${PETSC_DIR}/lib/petsc/bin/maint/builddist ${PETSC_DIR} main # This target works only if you can do 'ssh petsc@login.mcs.anl.gov' # also copy the file over to ftp site. web-snapshot: @if [ ! -f "${HOME}/petsc-with-docs-main.tar.gz" ]; then \ echo "~/petsc-with-docs-main.tar.gz missing! cannot update petsc-main snapshot on mcs-web-site"; \ else \ echo "updating petsc-main snapshot on mcs-web-site"; \ tmpdir=`mktemp -d -t petsc-doc.XXXXXXXX`; \ cd $${tmpdir}; tar -xzf ${HOME}/petsc-with-docs-main.tar.gz; \ /usr/bin/rsync -e ssh -az --delete $${tmpdir}/petsc-main/ \ petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/petsc-main ;\ /bin/cp -f /home/petsc/petsc-main.tar.gz /mcs/ftp/pub/petsc/petsc-main.tar.gz;\ ${RM} -rf $${tmpdir} ;\ fi # build the tarfile - and then update petsc-main snapshot on mcs-web-site update-web-snapshot: dist web-snapshot # This target updates website main pages update-web: @cd ${PETSC_DIR}/src/docs; make PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} bib2html; \ /usr/bin/rsync -az -C --exclude=documentation/index.html \ --exclude=documentation/installation.html --exclude=download/index.html \ ${PETSC_DIR}/src/docs/website/ petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc @cd ${PETSC_DIR}/src/docs/tex; /usr/bin/rsync -az petscapp.bib petsc.bib petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/publications ########################################################### # # See script for details # gcov: @$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py --run_gcov --petsc_arch ${PETSC_ARCH} mergegcov: @$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py --merge_gcov --petsc_arch ${PETSC_ARCH} --merge_branch `lib/petsc/bin/maint/check-merge-branch.sh` ######################## # # Create the include dependency graph (requires graphviz to be available) # includegraph: -@${PETSC_DIR}/src/contrib/style/include-graph.sh includegraph.pdf -@echo Include dependency graph written to includegraph.pdf # # ------------------------------------------------------------------------------- # # Some macros to check if the fortran interface is up-to-date. # countfortranfunctions: -@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \ cut -d'(' -f1 | tr -s ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \ sed "s/_$$//" | sort > /tmp/countfortranfunctions countcfunctions: -@grep PETSC_EXTERN ${PETSC_DIR}/include/*.h | grep "(" | tr -s ' ' | \ cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' | \ tr 'A-Z' 'a-z' | sort | uniq > /tmp/countcfunctions difffortranfunctions: countfortranfunctions countcfunctions -@echo -------------- Functions missing in the fortran interface --------------------- -@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2 -@echo ----------------- Functions missing in the C interface ------------------------ -@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2 -@${RM} /tmp/countcfunctions /tmp/countfortranfunctions checkbadfortranstubs: -@echo "=========================================" -@echo "Functions with MPI_Comm as an Argument" -@echo "=========================================" -@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \ tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3 -@echo "=========================================" -@echo "Functions with a String as an Argument" -@echo "=========================================" -@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \ tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3 -@echo "=========================================" -@echo "Functions with Pointers to PETSc Objects as Argument" -@echo "=========================================" -@cd ${PETSC_DIR}/src/fortran/auto; \ _p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \ cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \ sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \ for OBJ in $$_p_OBJ; do \ grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \ cut -d'(' -f1 | cut -d' ' -f1,3; \ done checkpackagetests: -@echo "Missing package tests" -@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} ; egrep "(with-$${j}|download-$${j})" configexamples | grep -v "=0" | wc -l ; done -@echo "Missing download package tests" -@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} ; egrep "(download-$${j})" configexamples | grep -v "=0" | wc -l ; done .PHONY: info info_h all deletelibs allclean update \ alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanualpages \ allhtml allcleanhtml countfortranfunctions \ start_configure configure_petsc configure_clean matlabbin install