xref: /petsc/makefile (revision fe63b34aa1adc344f9c0ca7676ea06c169920c07)
1# $Id: makefile,v 1.213 1998/03/19 02:01:29 balay Exp balay $
2#
3# This is the makefile for installing PETSc. See the file
4# Installation for directions on installing PETSc.
5# See also bmake/common for additional commands.
6#
7
8CFLAGS	 =
9SOURCEC	 =
10SOURCEF	 =
11DOCS	 = maint/addlinks maint/builddist \
12	   maint/buildlinks maint/wwwman maint/xclude maint/crontab\
13	   bmake/common bmake/*/base* maint/autoftp docs/manualpages/sec/* \
14           include/finclude/generateincludes bin/petscviewinfo.text \
15           bin/petscoptsinfo.text
16OBJSC	 =
17OBJSF	 =
18LIBBASE	 = libpetscvec
19DIRS	 = src include docs
20
21include ${PETSC_DIR}/bmake/${PETSC_ARCH}/base
22
23ALL: all
24
25#
26#  Prints information about the system and PETSc being compiled
27#
28info:
29	-@echo "=========================================="
30	-@echo On `date` on `hostname`
31	-@echo Machine characteristics: `uname -a`
32	-@echo "-----------------------------------------"
33	-@echo "Using C compiler: ${CC} ${COPTFLAGS}"
34	-@if [ -n "${CCV}" -a "${CCV}" != "unknown" ] ; then \
35	  echo "Compiler version:" `${CCV}` ; fi
36	-@echo "Using Fortran compiler: ${FC} ${FFLAGS} ${FOPTFLAGS}"
37	-@echo "-----------------------------------------"
38	-@grep PETSC_VERSION_NUMBER include/petsc.h | sed "s/........//"
39	-@echo "-----------------------------------------"
40	-@echo "Using PETSc flags: ${PETSCFLAGS} ${PCONF}"
41	-@echo "-----------------------------------------"
42	-@echo "Using configuration flags: ${CONF}"
43	-@echo "-----------------------------------------"
44	-@echo "Using include paths: ${PETSC_INCLUDE}"
45	-@echo "-----------------------------------------"
46	-@echo "Using PETSc directory: ${PETSC_DIR}"
47	-@echo "Using PETSc arch: ${PETSC_ARCH}"
48	-@echo "------------------------------------------"
49	-@echo "Using C linker: ${CLINKER}"
50	-@echo "Using libraries: ${PETSC_LIB}"
51	-@echo "Using Fortran linker: ${FLINKER}"
52	-@echo "Using Fortran libraries: ${PETSC_FORTRAN_LIB}"
53	-@echo "=========================================="
54
55# Builds PETSc libraries for a given BOPT and architecture
56all: info chkpetsc_dir deletelibs build_kernels build_c build_shared build_fortran
57
58build_c:
59	-@echo "BEGINNING TO COMPILE LIBRARIES IN ALL DIRECTORIES"
60	-@echo "========================================="
61	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} \
62	   ACTION=libfast  tree
63	-@cd ${PETSC_DIR}/src/sys/src ; \
64	${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} rs6000_time
65	${RANLIB} ${PDIR}/*.a
66	-@chmod g+w  ${PDIR}/*.a
67	-@echo "Completed building libraries"
68	-@echo "========================================="
69
70# Builds PETSc test examples for a given BOPT and architecture
71testexamples: info chkopts
72	-@echo "BEGINNING TO COMPILE AND RUN TEST EXAMPLES"
73	-@echo "Due to different numerical round-off on certain"
74	-@echo "machines some of the numbers may not match exactly."
75	-@echo "========================================="
76	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} \
77	   ACTION=testexamples_1  tree
78	-@echo "Completed compiling and running test examples"
79	-@echo "========================================="
80
81# Builds PETSc test examples for a given BOPT and architecture
82testexamples_uni: info chkopts
83	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR EXAMPLES"
84	-@echo "Due to different numerical round-off on certain"
85	-@echo "machines some of the numbers may not match exactly."
86	-@echo "========================================="
87	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} \
88	   ACTION=testexamples_4  tree
89	-@echo "Completed compiling and running uniprocessor test examples"
90	-@echo "========================================="
91
92#
93# Builds PETSc Fortran interface libary
94# Note:	 libfast cannot run on .F files on certain machines, so we
95# use lib and check for errors here.
96fortran: info chkpetsc_dir build_fortran
97
98build_fortran:
99	-@echo "BEGINNING TO COMPILE FORTRAN INTERFACE LIBRARY"
100	-@echo "========================================="
101	-${RM} -f ${PDIR}/libpetscfortran.*
102	-@cd src/fortran/auto; \
103	  ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} libfast
104	-@cd src/fortran/custom; \
105	  ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} lib > trashz 2>&1; \
106	  grep -v clog trashz | grep -v "information sections" | \
107	  egrep -i '(Error|warning|Can)' >> /dev/null;\
108	  if [ "$$?" != 1 ]; then \
109	  cat trashz ; fi; ${RM} trashz
110	${RANLIB} ${PDIR}/libpetscfortran.a
111	-@chmod g+w  ${PDIR}/*.a
112	-@echo "Completed compiling Fortran interface library"
113	-@echo "========================================="
114
115#
116# Builds PETSc Fortran kernels; some numerical kernels have
117# a Fortran version that may give better performance on certain
118# machines. These always provide better performance for complex numbers.
119fortrankernels: info chkpetsc_dir
120	-${RM} -f ${PDIR}/libpetsckernels.*
121	-@echo "BEGINNING TO COMPILE FORTRAN KERNELS LIBRARY"
122	-@echo "========================================="
123	-@cd src/fortran/kernels; \
124	  ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} lib
125	-@chmod g+w  ${PDIR}/*.a
126	-@echo "Completed compiling Fortran kernels library"
127	-@echo "========================================="
128
129# Builds PETSc test examples for a given BOPT and architecture
130testfortran: info chkopts
131	-@echo "BEGINNING TO COMPILE AND RUN FORTRAN TEST EXAMPLES"
132	-@echo "========================================="
133	-@echo "Due to different numerical round-off on certain"
134	-@echo "machines or the way Fortran formats numbers"
135	-@echo "some of the results may not match exactly."
136	-@echo "========================================="
137	-@echo "On some machines you may get messages of the form"
138	-@echo "PetscScalarAddressToFortran:C and Fortran arrays are"
139	-@echo "not commonly aligned or are too far apart to be indexed"
140	-@echo "by an integer. Locations: C xxxc Fortran xxxf"
141	-@echo "Locations/sizeof(Scalar): C yyc Fortran yyf"
142	-@echo "This indicates that you may not be able to use the"
143	-@echo "PETSc routines VecGetArray() and MatGetArray() from Fortran"
144	-@echo "========================================="
145	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} \
146	   ACTION=testexamples_3  tree
147	-@echo "Completed compiling and running Fortran test examples"
148	-@echo "========================================="
149#
150# Builds PETSc Fortran90 interface libary
151# Note:	 libfast cannot run on .F files on certain machines, so we
152# use lib and check for errors here.
153# Note: F90 interface currently only supported in NAG F90 compiler
154fortran90: info chkpetsc_dir fortran
155	-@echo "BEGINNING TO COMPILE FORTRAN90 INTERFACE LIBRARY"
156	-@echo "========================================="
157	-@cd src/fortran/f90; \
158	  ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} lib > trashz 2>&1; \
159	  grep -v clog trashz | grep -v "information sections" | \
160	  egrep -i '(Error|warning|Can)' >> /dev/null;\
161	  if [ "$$?" != 1 ]; then \
162	  cat trashz ; fi; ${RM} trashz
163	${RANLIB} ${PDIR}/libpetscfortran.a
164	-@chmod g+w  ${PDIR}/*.a
165	-@echo "Completed compiling Fortran90 interface library"
166	-@echo "========================================="
167
168# Builds noise routines (not yet publically available)
169# Note:	 libfast cannot run on .F files on certain machines, so we
170# use lib and check for errors here.
171noise: info chkpetsc_dir
172	-@echo "Beginning to compile noise routines"
173	-@echo "========================================="
174	-@cd src/snes/interface/noise; \
175	  ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} lib > trashz 2>&1; \
176	  grep -v clog trashz | grep -v "information sections" | \
177	  egrep -i '(Error|warning|Can)' >> /dev/null;\
178	  if [ "$$?" != 1 ]; then \
179	  cat trashz ; fi; ${RM} trashz
180	${RANLIB} ${PDIR}/libpetscsnes.a
181	-@chmod g+w  ${PDIR}/libpetscsnes.a
182	-@echo "Completed compiling noise routines"
183	-@echo "========================================="
184
185petscblas: info chkpetsc_dir
186	-${RM} -f ${PDIR}/libpetscblas.*
187	-@echo "BEGINNING TO COMPILE C VERSION OF BLAS AND LAPACK"
188	-@echo "========================================="
189	-@cd src/adic/blas; \
190	  ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} libfast
191	-@cd src/adic/lapack; \
192	  ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=libfast tree
193	${RANLIB} ${PDIR}/libpetscblas.a
194	-@chmod g+w  ${PDIR}/*.a
195	-@echo "Completed compiling C version of BLAS and LAPACK"
196	-@echo "========================================="
197
198# If USE_DYNAMIC_LIBRARIES flag is set, build shared libs
199build_shared:
200	-@shared_var=`echo "${PETSCFLAGS}" | sed 's/-DUSE_DYNAMIC_LIBRARIES//g'`; \
201	if [ "${PETSCFLAGS}" != "$$shared_var" ] ; then \
202	${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} shared; fi
203
204# If fortrankernels are used, build them.
205build_kernels:
206	-@kernel_var=`echo "${PETSCFLAGS}" | sed 's/-DUSE_FORTRAN_KERNELS//g'`; \
207	if [ "${PETSCFLAGS}" != "$$kernel_var" ] ; then \
208	${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} fortrankernels; fi
209
210# Ranlib on the libraries
211ranlib:
212	${RANLIB} ${PDIR}/*.a
213
214# Deletes PETSc libraries
215deletelibs: chkopts_basic
216	-${RM} -f ${PDIR}/*
217
218# Deletes man pages (HTML version)
219deletemanualpages:
220	${RM} -f ${PETSC_DIR}/docs/manualpages/man*/* ${PETSC_DIR}/docs/manualpages/www.cit \
221	         ${PETSC_DIR}/docs/manualpages/man*.html
222
223# Deletes man pages (LaTeX version)
224deletelatexpages:
225	${RM} -f ${PETSC_DIR}/docs/tex/rsum/*sum*.tex
226
227# To access the tags in EMACS, type M-x visit-tags-table and specify
228# the file petsc/TAGS.
229# 1) To move to where a PETSc function is defined, enter M-. and the
230#     function name.
231# 2) To search for a string and move to the first occurrence,
232#     use M-x tags-search and the string.
233#     To locate later occurrences, use M-,
234
235TAGS_INCLUDE_FILES  = include/*.h include/pinclude/*.h include/FINCLUDE/*.h
236TAGS_BMAKE_FILES    = bmake/common bmake/*/base*
237TAGS_EXAMPLE_FILES  = src/*/examples/*/*.[c,h,F,f] src/*/examples/*/*/*.[c,h,F,f] \
238                      src/benchmarks/*.c src/contrib/*/examples/*/*.[c,h,F,f]\
239		      src/fortran/f90/tests
240TAGS_DOC_FILES      = docs/tex/manual/routin.tex docs/tex/manual/manual.tex \
241                      docs/tex/manual/manual_tex.tex docs/tex/manual/intro.tex \
242                      docs/tex/manual/part1.tex docs/tex/manual/part2.tex
243TAGS_SRC_FILES      = src/*/*.[c,h] src/*/interface/*.[c,h] src/*/src/*.[c,h] \
244                      src/*/utils/*.[c,h] \
245                      src/*/impls/*.[c,h] src/*/impls/*/*.[c,h] src/*/impls/*/*/*.[c,h] \
246                      src/gvec/impls/*/*/*/*/*.[c,h] src/contrib/*/*.[c,h] \
247                      src/contrib/*/src/*.[c,h] src/fortran/custom/*.[c,h,F] \
248		      src/fortran/f90/*.[c,h,F] src/fortran/kernels/*.[c,h,F] \
249		      src/adic/blas/*.c src/lapack/src[1,2,3]/*.c
250TAGS_MAKEFILE_FILES = include/makefile include/*/makefile \
251                      makefile \
252                      src/makefile src/*/makefile src/*/src/makefile \
253                      src/*/interface/makefile \
254                      src/*/utils/makefile \
255                      src/*/impls/makefile src/*/impls/*/makefile src/*/impls/*/*/makefile \
256                      src/*/examples/makefile src/*/examples/*/makefile src/*/examples/*/*/makefile \
257                      src/gvec/impls/*/*/*/*/makefile src/gvec/impls/*/*/*/makefile \
258                      src/fortran/*/makefile \
259                      src/contrib/*/makefile src/contrib/*/src/makefile \
260                      src/contrib/*/examples/makefile src/contrib/*/examples/*/makefile \
261                      docs/makefile src/adic/*/makefile src/adic/lapack/*/makefile
262
263# Builds all etags files
264alletags:
265	-make etags_complete
266	-make etags
267	-make etags_noexamples
268	-make etags_examples
269	-make etags_makefiles
270
271# Builds the basic etags file.	This should be employed by most users.
272etags:
273	${RM} TAGS
274	etags -f TAGS ${TAGS_INCLUDE_FILES}
275	etags -a -f TAGS ${TAGS_SRC_FILES}
276	etags -a -f TAGS ${TAGS_EXAMPLE_FILES}
277	etags -a -f TAGS ${TAGS_MAKEFILE_FILES}
278	etags -a -f TAGS ${TAGS_BMAKE_FILES}
279	chmod g+w TAGS
280
281# Builds complete etags list; only for PETSc developers.
282etags_complete:
283	${RM} TAGS_COMPLETE
284	etags -f TAGS_COMPLETE ${TAGS_SRC_FILES}
285	etags -a -f TAGS_COMPLETE ${TAGS_INCLUDE_FILES}
286	etags -a -f TAGS_COMPLETE ${TAGS_EXAMPLE_FILES}
287	etags -a -f TAGS_COMPLETE ${TAGS_MAKEFILE_FILES}
288	etags -a -f TAGS_COMPLETE ${TAGS_BMAKE_FILES}
289	etags -a -f TAGS_COMPLETE ${TAGS_DOC_FILES}
290	chmod g+w TAGS_COMPLETE
291
292# Builds the etags file that excludes the examples directories
293etags_noexamples:
294	${RM} TAGS_NO_EXAMPLES
295	etags -f TAGS_NO_EXAMPLES ${TAGS_SRC_FILES}
296	etags -a -f TAGS_NO_EXAMPLES ${TAGS_INCLUDE_FILES}
297	etags -a -f TAGS_NO_EXAMPLES ${TAGS_MAKEFILE_FILES}
298	etags -a -f TAGS_NO_EXAMPLES ${TAGS_BMAKE_FILES}
299	etags -a -f TAGS_NO_EXAMPLES ${TAGS_DOC_FILES}
300	chmod g+w TAGS_NO_EXAMPLES
301
302# Builds the etags file for makefiles
303etags_makefiles:
304	${RM} TAGS_MAKEFILES
305	etags -f TAGS_MAKEFILES ${TAGS_MAKEFILE_FILES}
306	etags -a -f TAGS_MAKEFILES ${TAGS_BMAKE_FILES}
307	chmod g+w TAGS_MAKEFILES
308
309# Builds the etags file for examples
310etags_examples:
311	${RM} TAGS_EXAMPLES
312	etags -f TAGS_EXAMPLES ${TAGS_EXAMPLE_FILES}
313	chmod g+w TAGS_EXAMPLES
314
315#
316# To use the tags file from VI do the following:
317# 1. within vi invoke the command - :set tags=/home/bsmith/petsc/tags
318#    or add  the command to your ~/.exrc file - set tags=/home/bsmith/petsc/tags
319# 2. now to go to a tag do - :tag TAGNAME for eg - :tag MatCreate
320#
321ctags:
322	${RM} tags
323	ctags -w -f tags ${TAGS_INCLUDE_FILES}
324	ctags -w -a -f tags ${TAGS_SRC_FILES}
325	ctags -w -a -f tags ${TAGS_EXAMPLE_FILES}
326	ctags -w -a -f tags ${TAGS_MAKEFILE_FILES}
327	ctags -w -a -f tags ${TAGS_BMAKE_FILES}
328	chmod g+w tags
329
330# ------------------------------------------------------------------
331#
332# All remaining actions are intended for PETSc developers only.
333# PETSc users should not generally need to use these commands.
334#
335
336# Builds all versions of the man pages
337allmanpages: allmanualpages alllatexpages
338allmanualpages: deletemanualpages
339	-make ACTION=manualpages_buildcite tree
340	-cd src/fortran/custom; make manualpages_buildcite
341	-cd src/fortran/custom; make manualpages
342	-make ACTION=manualpages tree
343	-maint/wwwman
344	-maint/examplesindex.tcl
345	-maint/htmlkeywords.tcl
346	-@chmod g+w docs/manualpages/man*/*
347
348alllatexpages: deletelatexpages
349	-make ACTION=latexpages tree
350	-cd src/fortran/custom; make latexpages
351	-@chmod g+w docs/tex/rsum/*
352
353# Builds Fortran stub files
354allfortranstubs:
355	-@include/finclude/generateincludes
356	-@${RM} -f src/fortran/auto/*.c
357	-make ACTION=fortranstubs tree
358	chmod g+w src/fortran/auto/*.c
359
360allci:
361	-@cd src/fortran/custom ; ${OMAKE} BOPT=${BOPT} ci
362	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=ci  tree
363
364allco:
365	-@cd src/fortran/custom ; ${OMAKE} BOPT=${BOPT} co
366	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=co  tree
367
368#
369#   The commands below are for generating ADIC versions of the code;
370# they are not currently used.
371#
372CFLAGS   =  ${CPPFLAGS} ${CONF}
373alladicignore:
374	-@${RM} ${PDIR}/adicignore
375	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adicignore  tree
376
377alladic:
378	-@echo "Beginning to compile ADIC source code in all directories"
379	-@echo "Using ADIC compiler: ${ADIC_CC} ${CFLAGS}"
380	-@echo "========================================="
381	-@cd include ; \
382           ${ADIC_CC} -s -f 1 ${CFLAGS} petsc.h
383	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adic  tree
384	-@cd src/inline ; \
385            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} adic
386	-@cd src/adic/blas ; \
387            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} adic
388	-@cd src/adic/lapack ; \
389            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adic  tree
390
391alladiclib:
392	-@echo "Beginning to compile ADIC libraries in all directories"
393	-@echo "Using compiler: ${CC} ${COPTFLAGS}"
394	-@echo "-----------------------------------------"
395	-@echo "Using PETSc flags: ${PETSCFLAGS} ${PCONF}"
396	-@echo "-----------------------------------------"
397	-@echo "Using configuration flags: ${CONF}"
398	-@echo "-----------------------------------------"
399	-@echo "Using include paths: ${PETSC_INCLUDE}"
400	-@echo "-----------------------------------------"
401	-@echo "Using PETSc directory: ${PETSC_DIR}"
402	-@echo "Using PETSc arch: ${PETSC_ARCH}"
403	-@echo "========================================="
404	-@${RM} -f  ${PDIR}/*adic.a
405	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adiclib  tree
406	-@cd src/adic/blas ; \
407            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} adiclib
408	-@cd src/adic/lapack ; \
409            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adiclib  tree
410	-@cd src/adic/src ; \
411            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} lib
412
413# -------------------------------------------------------------------------------
414#
415# Some macros to check if the fortran interface is up-to-date.
416#
417countfortranfunctions:
418	-@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \
419	cut -d'(' -f1 | tr -s '' ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \
420	sed "s/_$$//" | sort > /tmp/countfortranfunctions
421
422countcfunctions:
423	-@ grep extern ${PETSC_DIR}/include/*.h *.h | grep "(" | tr -s '' ' ' | \
424	cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '' '\012' |  \
425	tr 'A-Z' 'a-z' |  sort > /tmp/countcfunctions
426
427difffortranfunctions: countfortranfunctions countcfunctions
428	-@echo -------------- Functions missing in the fortran interface ---------------------
429	-@diff /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2
430	-@echo ----------------- Functions missing in the C interface ------------------------
431	-@diff /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2
432	-@${RM}  /tmp/countcfunctions /tmp/countfortranfunctions
433
434checkbadfortranstubs:
435	-@echo "========================================="
436	-@echo "Functions with MPI_Comm as an Argument"
437	-@echo "========================================="
438	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \
439	tr -s '' ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
440	-@echo "========================================="
441	-@echo "Functions with a String as an Argument"
442	-@echo "========================================="
443	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \
444	tr -s '' ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
445	-@echo "========================================="
446	-@echo "Functions with Pointers to PETSc Objects as Argument"
447	-@echo "========================================="
448	-@cd ${PETSC_DIR}/src/fortran/auto; \
449	_p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s '' ' ' | \
450	cut -d' ' -f 3 | tr -s '' '\012' | grep -v '{' | cut -d'*' -f1 | \
451	sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \
452	for OBJ in $$_p_OBJ; do \
453	grep "$$OBJ \*" *.c | tr -s '' ' ' | tr -s ':' ' ' | \
454	cut -d'(' -f1 | cut -d' ' -f1,3; \
455	done
456