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