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