xref: /petsc/makefile (revision 3df9293f2c7ba181cc598412f1a205d27bdcfd5b)
1#
2# This is the makefile for compiling PETSc. See
3# http://www.mcs.anl.gov/petsc/documentation/installation.html for directions on installing PETSc.
4# See also conf for additional commands.
5#
6ALL: all
7LOCDIR	 = ./
8DIRS	 = src include tutorials interfaces share/petsc/matlab
9CFLAGS	 =
10FFLAGS	 =
11CPPFLAGS =
12FPPFLAGS =
13
14# next line defines PETSC_DIR and PETSC_ARCH if they are not set
15include ././${PETSC_ARCH}/lib/petsc/conf/petscvariables
16include ${PETSC_DIR}/lib/petsc/conf/variables
17include ${PETSC_DIR}/lib/petsc/conf/rules
18include ${PETSC_DIR}/lib/petsc/conf/test.common
19
20# This makefile contains a lot of PHONY targets with improperly specified prerequisites
21# where correct execution instead depends on the targets being processed in the correct
22# order.  This is gross, but this makefile doesn't really do any work.  Sub-makes still
23# benefit from parallelism.
24.NOTPARALLEL:
25
26OMAKE_SELF = $(OMAKE) -f makefile
27OMAKE_SELF_PRINTDIR = $(OMAKE_PRINTDIR) -f makefile
28
29#
30# Basic targets to build PETSc libraries.
31#
32all:
33	+@${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} chk_petscdir chk_upgrade | tee ${PETSC_ARCH}/lib/petsc/conf/make.log
34	@ln -sf ${PETSC_ARCH}/lib/petsc/conf/make.log make.log
35	+@${OMAKE_SELF_PRINTDIR} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-local 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;
36	@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
37	@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
38	+@if test -s ${PETSC_ARCH}/lib/petsc/conf/memoryerror.log; then \
39           printf ${PETSC_TEXT_HILIGHT}"**************************ERROR*************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \
40           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; \
41           printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\
42         elif test -s ${PETSC_ARCH}/lib/petsc/conf/error.log; then \
43           printf ${PETSC_TEXT_HILIGHT}"**************************ERROR*************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \
44           echo "  Error during compile, check ${PETSC_ARCH}/lib/petsc/conf/make.log" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \
45           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;\
46           printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\
47	 else \
48	  ${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 ;\
49        fi #solaris make likes to print the whole command that gave error. So split this up into the smallest chunk below
50	@echo "Finishing make run at `date +'%a, %d %b %Y %H:%M:%S %z'`" >> ${PETSC_ARCH}/lib/petsc/conf/make.log
51	@if test -s ${PETSC_ARCH}/lib/petsc/conf/error.log; then exit 1; fi
52
53all-local: info libs matlabbin petsc4py-build libmesh-build mfem-build slepc-build hpddm-build amrex-build bamg-build
54
55#
56# Prints information about the system and version of PETSc being compiled
57#
58info:
59	-@echo "=========================================="
60	-@echo " "
61	-@echo "See documentation/faq.html and documentation/bugreporting.html"
62	-@echo "for help with installation problems.  Please send EVERYTHING"
63	-@echo "printed out below when reporting problems.  Please check the"
64	-@echo "mailing list archives and consider subscribing."
65	-@echo " "
66	-@echo "  http://www.mcs.anl.gov/petsc/miscellaneous/mailing-lists.html"
67	-@echo " "
68	-@echo "=========================================="
69	-@echo Starting make run on `hostname` at `date +'%a, %d %b %Y %H:%M:%S %z'`
70	-@echo Machine characteristics: `uname -a`
71	-@echo "-----------------------------------------"
72	-@echo "Using PETSc directory: ${PETSC_DIR}"
73	-@echo "Using PETSc arch: ${PETSC_ARCH}"
74	-@echo "-----------------------------------------"
75	-@grep "define PETSC_VERSION" ${PETSC_DIR}/include/petscversion.h | ${SED} "s/........//"
76	-@echo "-----------------------------------------"
77	-@echo "Using configure Options: ${CONFIGURE_OPTIONS}"
78	-@echo "Using configuration flags:"
79	-@grep "\#define " ${PETSCCONF_H}
80	-@echo "-----------------------------------------"
81	-@echo "Using C compile: ${PETSC_CCOMPILE_SINGLE}"
82	-@if [  "${MPICC_SHOW}" != "" ]; then \
83             printf  "mpicc -show: %b\n" "${MPICC_SHOW}";\
84          fi; \
85        printf  "C compiler version: %b\n" "${C_VERSION}"; \
86        if [ "${CXX}" != "" ]; then \
87        echo "Using C++ compile: ${PETSC_CXXCOMPILE_SINGLE}";\
88        if [ "${MPICXX_SHOW}" != "" ]; then \
89               printf "mpicxx -show: %b\n" "${MPICXX_SHOW}"; \
90            fi;\
91            printf  "C++ compiler version: %b\n" "${Cxx_VERSION}"; \
92          fi
93	-@if [ "${FC}" != "" ]; then \
94	   echo "Using Fortran compile: ${PETSC_FCOMPILE_SINGLE}";\
95           if [ "${MPIFC_SHOW}" != "" ]; then \
96             printf "mpif90 -show: %b\n" "${MPIFC_SHOW}"; \
97           fi; \
98             printf  "Fortran compiler version: %b\n" "${FC_VERSION}"; \
99         fi
100	-@if [ "${CUDAC}" != "" ]; then \
101	   echo "Using CUDA compile: ${PETSC_CUCOMPILE_SINGLE}";\
102         fi
103	-@if [ "${CLANGUAGE}" = "CXX" ]; then \
104           echo "Using C++ compiler to compile PETSc";\
105        fi
106	-@echo "-----------------------------------------"
107	-@echo "Using C/C++ linker: ${PCC_LINKER}"
108	-@echo "Using C/C++ flags: ${PCC_LINKER_FLAGS}"
109	-@if [ "${FC}" != "" ]; then \
110	   echo "Using Fortran linker: ${FC_LINKER}";\
111	   echo "Using Fortran flags: ${FC_LINKER_FLAGS}";\
112         fi
113	-@echo "-----------------------------------------"
114	-@echo "Using system modules: ${LOADEDMODULES}"
115	-@if [ "${MPI_IS_MPIUNI}" = "1" ]; then \
116           echo Using mpi.h: mpiuni; \
117        else \
118           TESTDIR=`mktemp -q -d -t petscmpi-XXXXXXXX` && \
119           echo '#include <mpi.h>' > $${TESTDIR}/mpitest.c && \
120           BUF=`${CPP} ${PETSC_CPPFLAGS} ${PETSC_CC_INCLUDES} $${TESTDIR}/mpitest.c |grep 'mpi\.h' | ( head -1 ; cat > /dev/null )` && \
121           echo Using mpi.h: $${BUF}; ${RM} -rf $${TESTDIR}; \
122        fi
123	-@echo "-----------------------------------------"
124	-@echo "Using libraries: ${PETSC_LIB}"
125	-@echo "------------------------------------------"
126	-@echo "Using mpiexec: ${MPIEXEC}"
127	-@echo "------------------------------------------"
128	-@echo "Using MAKE: $(MAKE)"
129	-@echo "Using MAKEFLAGS: -j$(MAKE_NP) -l$(MAKE_LOAD) $(MAKEFLAGS)"
130	-@echo "=========================================="
131
132#
133# Build MatLab binaries
134#
135matlabbin:
136	-@if [ "${MATLAB_MEX}" != "" -a "${MATLAB_SOCKET}" != "" -a "${PETSC_SCALAR}" = "real" -a "${PETSC_PRECISION}" = "double" ]; then \
137          echo "BEGINNING TO COMPILE MATLAB INTERFACE"; \
138            if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc" ] ; then ${MKDIR}  ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc; fi; \
139            if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab" ] ; then ${MKDIR}  ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab; fi; \
140            cd src/sys/classes/viewer/impls/socket/matlab && ${OMAKE_SELF} matlabcodes PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR}; \
141            echo "========================================="; \
142        fi
143#
144# Builds PETSc check examples for a given architecture
145#
146check_install: check
147check:
148	-+@${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
149checkx:
150	-@${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} checkx_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/checkx.log
151check_build:
152	-@echo "Running check examples to verify correct installation"
153	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
154	+@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
155	+@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex19
156	+@if [ "${HYPRE_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ] &&  [ "${PETSC_SCALAR}" = "real" ]; then \
157          cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_hypre; \
158         fi;
159	+@if [ "${CUDA_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ] &&  [ "${PETSC_SCALAR}" = "real" ]; then \
160          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; \
161         fi;
162	+@if [ "${KOKKOS_KERNELS_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ] &&  [ "${PETSC_SCALAR}" = "real" ] && [ "${PETSC_PRECISION}" = "double" ] && [ "${MPI_IS_MPIUNI}" = "" ]; then \
163          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; \
164         fi;
165	+@if [ "${MUMPS_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
166          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; \
167         fi;
168	+@if [ "${SUPERLU_DIST_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
169          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; \
170         fi;
171	+@if [ "${HDF5_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
172          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; \
173         fi;
174	+@if [ "${AMREX_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
175           echo "Running testamres examples to verify correct installation";\
176           echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}";\
177           cd src/ksp/ksp/tutorials/amrex >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy;\
178           ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testamrex;\
179         fi;
180	+@if ( [ "${ML_LIB}" != "" ] ||  [ "${TRILINOS_LIB}" != "" ] ) && [ "${PETSC_WITH_BATCH}" = "" ]; then \
181          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; \
182         fi;
183	+@if [ "${SUITESPARSE_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
184          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; \
185         fi;
186	+@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ex19.rm
187	+@if [ "${MPI4PY}" = "yes" ]; then \
188          cd src/sys/tests >/dev/null; \
189          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex55; \
190         fi;
191	+@if [ "${PETSC4PY}" = "yes" ]; then \
192          cd src/ksp/ksp/tutorials >/dev/null; \
193          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy; \
194          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex100; \
195          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy; \
196         fi;
197	+@egrep "^#define PETSC_HAVE_FORTRAN 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \
198         if test -s .ftn.log; then \
199          cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex5f; \
200         fi; ${RM} .ftn.log;
201	+@egrep "^#define PETSC_HAVE_MATLAB_ENGINE 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \
202         if test -s .ftn.log; then \
203          cd src/vec/vec/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex31; \
204         fi; ${RM} .ftn.log;
205	+@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
206	-@echo "Completed test examples"
207checkx_build:
208	-@echo "Running graphics check example to verify correct X11 installation"
209	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
210	@cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
211	@cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testxex19
212	@cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
213	-@echo "Completed graphics check example"
214check_usermakefile:
215	-@echo "Testing compile with user makefile"
216	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
217	@cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex19
218	@egrep "^#define PETSC_HAVE_FORTRAN 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \
219         if test -s .ftn.log; then \
220          cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex5f; \
221         fi; ${RM} .ftn.log;
222	@cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
223	-@echo "Completed compile with user makefile"
224
225# Compare ABI/API of two versions of PETSc library with the old one defined by PETSC_{DIR,ARCH}_ABI_OLD
226abitest:
227	@if [ "${PETSC_DIR_ABI_OLD}" = "" ] || [ "${PETSC_ARCH_ABI_OLD}" = "" ]; \
228		then printf "You must set environment variables PETSC_DIR_ABI_OLD and PETSC_ARCH_ABI_OLD to run abitest\n"; \
229		exit 1; \
230	fi;
231	-@echo "Comparing ABI/API of the following two PETSc versions (you must have already configured and built them using GCC and with -g):"
232	-@echo "========================================================================================="
233	-@echo "    Old: PETSC_DIR_ABI_OLD  = ${PETSC_DIR_ABI_OLD}"
234	-@echo "         PETSC_ARCH_ABI_OLD = ${PETSC_ARCH_ABI_OLD}"
235	-@pushd ${PETSC_DIR_ABI_OLD} >> /dev/null ; echo "         Branch             = "`git rev-parse --abbrev-ref HEAD`
236	-@echo "    New: PETSC_DIR          = ${PETSC_DIR}"
237	-@echo "         PETSC_ARCH         = ${PETSC_ARCH}"
238	-@echo "         Branch             = "`git rev-parse --abbrev-ref HEAD`
239	-@echo "========================================================================================="
240	-@$(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
241
242# Compare ABI/API of current PETSC_ARCH/PETSC_DIR with a previous branch
243abitestcomplete:
244	-@if [[ -f "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/configure.log" ]]; then \
245          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"` ;\
246echo $${OPTIONS} ;\
247        fi ; \
248        if [[ "${PETSC_DIR_ABI_OLD}" != "" ]]; then \
249          PETSC_DIR_OLD=${PETSC_DIR_ABI_OLD}; \
250        else \
251          PETSC_DIR_OLD=${PETSC_DIR}/../petsc-abi; \
252        fi ; \
253        echo "=================================================================================================" ;\
254        echo "Doing ABI/API comparison between" ${branch} " and " `git rev-parse --abbrev-ref HEAD` "using " $${OPTIONS} ;\
255        echo "=================================================================================================" ;\
256        if [[ ! -d $${PETSC_DIR_OLD} ]]; then \
257          git clone ${PETSC_DIR} $${PETSC_DIR_OLD} ; \
258        else \
259          cd $${PETSC_DIR_OLD} ; \
260          git pull ; \
261        fi ; \
262        cd $${PETSC_DIR_OLD} ; \
263        git checkout ${branch} ; \
264        PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` ./configure $${OPTIONS} ; \
265        PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` make all test ; \
266        cd ${PETSC_DIR} ; \
267        ./configure $${OPTIONS}; \
268        make all test ; \
269        PETSC_DIR_ABI_OLD=$${PETSC_DIR_OLD} PETSC_ARCH_ABI_OLD=arch-branch-`git rev-parse ${branch}` make abitest
270
271# Deletes PETSc libraries
272deletelibs:
273	-${RM} -rf ${PETSC_LIB_DIR}/libpetsc*.*
274deletemods:
275	-${RM} -f ${PETSC_DIR}/${PETSC_ARCH}/include/petsc*.mod
276
277allclean:
278	-@${OMAKE} -f gmakefile clean
279
280clean:: allclean
281
282distclean: chk_petscdir
283	@if [ -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ]; then \
284	  echo "*** Preserving ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py in ${PETSC_DIR} ***"; \
285          mv -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ${PETSC_DIR}/; fi
286	@echo "*** Deleting all build files in ${PETSC_DIR}/${PETSC_ARCH} ***"
287	-${RM} -rf ${PETSC_DIR}/${PETSC_ARCH}/
288
289
290#
291reconfigure: allclean
292	@unset MAKEFLAGS && ${PYTHON} ${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py
293#
294install:
295	@${PYTHON} ./config/install.py -destDir=${DESTDIR}
296	+${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} petsc4py-install libmesh-install mfem-install slepc-install hpddm-install amrex-install bamg-install
297
298mpistreams:
299	+@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistreams
300
301mpistream:
302	+@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistream
303
304openmpstreams:
305	+@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstreams
306
307openmpstream:
308	+@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstream
309
310# for legacy reasons
311stream: mpistream
312
313streams: mpistreams
314
315# ------------------------------------------------------------------
316#
317# All remaining actions are intended for PETSc developers only.
318# PETSc users should not generally need to use these commands.
319#
320#  See the users manual for how the tags files may be used from Emacs and Vi/Vim
321#
322alletags:
323	-@${PYTHON} lib/petsc/bin/maint/generateetags.py
324	-@find config -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON
325
326# obtain gtags from https://www.gnu.org/software/global/
327allgtags:
328	-@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 -
329
330allfortranstubs:
331	-@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir
332	@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py ${BFORT}  ${VERBOSE}
333	-@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py -merge  ${VERBOSE}
334	-@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir
335deletefortranstubs:
336	-@find . -type d -name ftn-auto | xargs rm -rf
337
338# Builds all the documentation - should be done every night
339alldoc: allcite sphinx-docs-all alldoc1 alldoc2 docsetdate
340
341# Build just citations
342allcite: chk_loc deletemanualpages
343	-${PYTHON} lib/petsc/bin/maint/countpetsccits.py
344	-${OMAKE_SELF} ACTION=manualpages_buildcite tree_basic LOC=${LOC}
345	-@sed -e s%man+../%man+manualpages/% ${LOC}/docs/manualpages/manualpages.cit > ${LOC}/docs/manualpages/htmlmap
346	-@cat ${PETSC_DIR}/src/docs/mpi.www.index >> ${LOC}/docs/manualpages/htmlmap
347
348# Build just manual pages + prerequisites
349allmanpages: chk_loc allcite
350	-${RM} ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err
351	-${OMAKE_SELF} ACTION=manualpages tree_basic LOC=${LOC}
352	-a=`cat ${PETSC_DIR}/${PETSC_ARCH}/manualpages.err | wc -l`; test ! $$a -gt 0
353
354# Build just manual examples + prerequisites
355allmanexamples: chk_loc allmanpages
356	-${OMAKE_SELF} ACTION=manexamples tree_basic LOC=${LOC}
357
358# Build everything that goes into 'doc' dir except html sources
359alldoc1: chk_loc chk_concepts_dir allcite allmanpages allmanexamples
360	-${OMAKE_SELF} manimplementations LOC=${LOC}
361	-${PYTHON} lib/petsc/bin/maint/wwwindex.py ${PETSC_DIR} ${LOC}
362	-${OMAKE_SELF} ACTION=getexlist tree_basic LOC=${LOC}
363	-${OMAKE_SELF} ACTION=exampleconcepts tree_basic LOC=${LOC}
364	-${PYTHON} lib/petsc/bin/maint/helpindex.py ${PETSC_DIR} ${LOC}
365
366# Builds .html versions of the source
367# html overwrites some stuff created by update-docs - hence this is done later.
368alldoc2: chk_loc allcite
369	-${OMAKE_SELF} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC}
370	-${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC}
371
372alldoc12: alldoc1 alldoc2
373#
374# Makes links for all manual pages in $LOC/docs/manualpages/all
375allman:
376	@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 \;
377
378DOCSETDATE_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
379
380# modify all generated html files and add in version number, date, canonical URL info.
381docsetdate: chk_petscdir
382	@echo "Updating generated html files with petsc version, date, canonical URL info";\
383        version_release=`grep '^#define PETSC_VERSION_RELEASE ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
384        version_major=`grep '^#define PETSC_VERSION_MAJOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
385        version_minor=`grep '^#define PETSC_VERSION_MINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
386        version_subminor=`grep '^#define PETSC_VERSION_SUBMINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
387        if  [ $${version_release} = 0 ]; then \
388          petscversion=petsc-main; \
389          export petscversion; \
390        elif [ $${version_release} = 1 ]; then \
391          petscversion=petsc-$${version_major}.$${version_minor}.$${version_subminor}; \
392          export petscversion; \
393        else \
394          echo "Unknown PETSC_VERSION_RELEASE: $${version_release}"; \
395          exit; \
396        fi; \
397        datestr=`git log -1 --pretty=format:%ci | cut -d ' ' -f 1`; \
398        export datestr; \
399        gitver=`git describe --match "v*"`; \
400        export gitver; \
401        find * -type d -wholename src/docs/website \
402          -prune -o -type d -wholename src/benchmarks/results \
403          -prune -o -type d -wholename config/BuildSystem/docs/website \
404          -prune -o -type d -wholename include/web \
405          -prune -o -type d -wholename 'arch-*' \
406          -prune -o -type d -wholename lib/petsc/bin/maint \
407          -prune -o -type d -wholename externalpackages \
408          -prune ${DOCSETDATE_PRUNE_LIST} -o -type f -name \*.html \
409          -exec perl -pi -e 's^(<body.*>)^$$1\n   <div id=\"version\" align=right><b>$$ENV{petscversion} $$ENV{datestr}</b></div>\n   <div id="bugreport" align=right><a href="mailto:petsc-maint\@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: $$ENV{petscversion} $$ENV{gitver} {} "><small>Report Typos and Errors</small></a></div>^i' {} \; \
410          -exec perl -pi -e 's^(<head>)^$$1 <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/{}" />^i' {} \; ; \
411        echo "Done fixing version number, date, canonical URL info"
412
413# Use Sphinx to build some documentation.  This uses Python's venv, which should
414# behave similarly to what happens on e.g. ReadTheDocs. You may prefer to use
415# your own Python environment and directly build the Sphinx docs by using
416# the makefile in ${PETSC_SPHINX_ROOT}, paying attention to the requirements.txt
417# there.
418PETSC_SPHINX_ROOT=doc
419PETSC_SPHINX_ENV=${PETSC_ARCH}/sphinx_docs_env
420PETSC_SPHINX_DEST=docs/sphinx_docs
421
422sphinx-docs-all: sphinx-docs-manual sphinx-docs-html
423
424sphinx-docs-fast: chk_loc sphinx-docs-env
425	@. ${PETSC_SPHINX_ENV}/bin/activate && ${OMAKE} -C ${PETSC_SPHINX_ROOT} \
426		BUILDDIR=${LOC}/${PETSC_SPHINX_DEST} html
427
428sphinx-docs-html: chk_loc allcite sphinx-docs-env
429	@. ${PETSC_SPHINX_ENV}/bin/activate && ${OMAKE} -C ${PETSC_SPHINX_ROOT} \
430		BUILDDIR=${LOC}/${PETSC_SPHINX_DEST} html
431
432sphinx-docs-manual: chk_loc sphinx-docs-env
433	@. ${PETSC_SPHINX_ENV}/bin/activate && ${OMAKE} -C ${PETSC_SPHINX_ROOT}  BUILDDIR=${LOC}/${PETSC_SPHINX_DEST} latexpdf
434	@mv ${LOC}/${PETSC_SPHINX_DEST}/latex/manual.pdf ${LOC}/docs/manual.pdf
435	@${RM} -rf ${LOC}/${PETSC_SPHINX_DEST}/latex
436
437sphinx-docs-env: sphinx-docs-check-python sphinx-docs-check-rsvg-convert
438	@if [ ! -d  "${PETSC_SPHINX_ENV}" ]; then \
439        ${PYTHON} -m venv ${PETSC_SPHINX_ENV}; \
440        . ${PETSC_SPHINX_ENV}/bin/activate; \
441        pip install -r ${PETSC_SPHINX_ROOT}/requirements.txt; \
442      fi
443
444sphinx-docs-check-rsvg-convert:
445	@if ! command -v rsvg-convert 2>&1 > /dev/null; then \
446		    printf "rsvg-convert is required for the sphinxcontrib-svg2pdfconverter extension for the Sphinx docs\n"; \
447			  false; \
448	    fi
449
450sphinx-docs-check-python:
451	@${PYTHON} -c 'import sys; sys.exit(sys.version_info[:2] < (3,3))' || \
452    (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)
453
454sphinx-docs-clean: chk_loc
455	${RM} -rf ${PETSC_SPHINX_ENV}
456	${RM} -rf ${LOC}/${PETSC_SPHINX_DEST}
457
458alldocclean: deletemanualpages allcleanhtml sphinx-docs-clean
459
460# Deletes man pages (HTML version)
461deletemanualpages: chk_loc
462	-@if [ -d ${LOC} -a -d ${LOC}/docs/manualpages ]; then \
463          find ${LOC}/docs/manualpages -type f -name "*.html" -exec ${RM} {} \; ;\
464          ${RM} ${LOC}/docs/exampleconcepts ;\
465          ${RM} ${LOC}/docs/manualpages/manualpages.cit ;\
466          ${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC} clean;\
467        fi
468
469allcleanhtml:
470	-${OMAKE_SELF} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} alltree
471
472chk_concepts_dir: chk_loc
473	@if [ ! -d "${LOC}/docs/manualpages/concepts" ]; then \
474	  echo Making directory ${LOC}/docs/manualpages/concepts for library; ${MKDIR} ${LOC}/docs/manualpages/concepts; fi
475
476# Builds simple html versions of the source without links into the $PETSC_ARCH/obj directory, used by make mergecov
477srchtml:
478	-${OMAKE_SELF} ACTION=simplehtml PETSC_DIR=${PETSC_DIR} alltree_src
479
480###########################################################
481# targets to build distribution and update docs
482###########################################################
483
484# Creates ${HOME}/petsc.tar.gz [and petsc-with-docs.tar.gz]
485dist:
486	${PETSC_DIR}/lib/petsc/bin/maint/builddist ${PETSC_DIR} main
487
488# This target works only if you can do 'ssh petsc@login.mcs.anl.gov'
489# also copy the file over to ftp site.
490web-snapshot:
491	@if [ ! -f "${HOME}/petsc-with-docs-main.tar.gz" ]; then \
492	    echo "~/petsc-with-docs-main.tar.gz missing! cannot update petsc-main snapshot on mcs-web-site"; \
493	  else \
494            echo "updating petsc-main snapshot on mcs-web-site"; \
495	    tmpdir=`mktemp -d -t petsc-doc.XXXXXXXX`; \
496	    cd $${tmpdir}; tar -xzf ${HOME}/petsc-with-docs-main.tar.gz; \
497	    /usr/bin/rsync  -e ssh -az --delete $${tmpdir}/petsc-main/ \
498              petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/petsc-main ;\
499	    /bin/cp -f /home/petsc/petsc-main.tar.gz /mcs/ftp/pub/petsc/petsc-main.tar.gz;\
500	    ${RM} -rf $${tmpdir} ;\
501	  fi
502
503# build the tarfile - and then update petsc-main snapshot on mcs-web-site
504update-web-snapshot: dist web-snapshot
505
506# This target updates website main pages
507update-web:
508	@cd ${PETSC_DIR}/src/docs; make PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} bib2html; \
509	/usr/bin/rsync -az -C --exclude=documentation/index.html \
510          --exclude=documentation/installation.html --exclude=download/index.html \
511	  ${PETSC_DIR}/src/docs/website/ petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc
512	@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
513
514###########################################################
515#
516#  See script for details
517#
518gcov:
519	@$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py --run_gcov --petsc_arch ${PETSC_ARCH}
520
521mergegcov:
522	@$(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`
523
524
525########################
526#
527# Create the include dependency graph (requires graphviz to be available)
528#
529includegraph:
530	-@${PETSC_DIR}/src/contrib/style/include-graph.sh includegraph.pdf
531	-@echo Include dependency graph written to includegraph.pdf
532
533#
534# -------------------------------------------------------------------------------
535#
536# Some macros to check if the fortran interface is up-to-date.
537#
538countfortranfunctions:
539	-@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \
540	cut -d'(' -f1 | tr -s  ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \
541	sed "s/_$$//" | sort > /tmp/countfortranfunctions
542
543countcfunctions:
544	-@grep PETSC_EXTERN ${PETSC_DIR}/include/*.h  | grep "(" | tr -s ' ' | \
545	cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' |  \
546	tr 'A-Z' 'a-z' |  sort | uniq > /tmp/countcfunctions
547
548difffortranfunctions: countfortranfunctions countcfunctions
549	-@echo -------------- Functions missing in the fortran interface ---------------------
550	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2
551	-@echo ----------------- Functions missing in the C interface ------------------------
552	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2
553	-@${RM}  /tmp/countcfunctions /tmp/countfortranfunctions
554
555checkbadfortranstubs:
556	-@echo "========================================="
557	-@echo "Functions with MPI_Comm as an Argument"
558	-@echo "========================================="
559	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \
560	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
561	-@echo "========================================="
562	-@echo "Functions with a String as an Argument"
563	-@echo "========================================="
564	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \
565	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
566	-@echo "========================================="
567	-@echo "Functions with Pointers to PETSc Objects as Argument"
568	-@echo "========================================="
569	-@cd ${PETSC_DIR}/src/fortran/auto; \
570	_p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \
571	cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \
572	sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \
573	for OBJ in $$_p_OBJ; do \
574	grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \
575	cut -d'(' -f1 | cut -d' ' -f1,3; \
576	done
577
578checkpackagetests:
579	-@echo "Missing package tests"
580	-@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
581	-@echo "Missing download package tests"
582	-@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
583
584.PHONY: info info_h all deletelibs allclean update \
585        alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanualpages \
586        allhtml allcleanhtml  countfortranfunctions \
587        start_configure configure_petsc configure_clean matlabbin install
588