xref: /petsc/gmakefile (revision 42e5ec60e3f6d3f21d92afbe12a337913bc9ad72) 
1# -*- mode: makefile-gmake -*-
2include petscdir.mk
3
4# If $(PETSC_ARCH) is empty, this defines it and PETSC_DIR
5include ./$(PETSC_ARCH)/lib/petsc/conf/petscvariables
6include ./lib/petsc/conf/variables
7
8OBJDIR := $(PETSC_ARCH)/obj
9LIBDIR := $(PETSC_ARCH)/lib
10
11pkgs := sys vec mat dm ksp snes ts tao
12pkgs_reverse := tao ts snes ksp dm mat vec sys
13
14# $(call SONAME_FUNCTION,libfoo,abiversion)
15SONAME_FUNCTION ?= $(1).$(SL_LINKER_SUFFIX).$(2)
16SONAME_SFX_FUNCTION_?= $(1)$(LIB_NAME_SUFFIX).$(SL_LINKER_SUFFIX).$(2)
17# $(call SL_LINKER_FUNCTION,libfoo,abiversion,libversion)
18SL_LINKER_FUNCTION ?= -shared -Wl,-soname,$(call SONAME_FUNCTION,$(notdir $(1)),$(2))
19
20PETSC_VERSION_MAJOR := $(shell awk '/define PETSC_VERSION_MAJOR/{print $$3;}' ./include/petscversion.h)
21PETSC_VERSION_MINOR := $(shell awk '/define PETSC_VERSION_MINOR/{print $$3;}' ./include/petscversion.h)
22PETSC_VERSION_SUBMINOR := $(shell awk '/define PETSC_VERSION_SUBMINOR/{print $$3;}' ./include/petscversion.h)
23PETSC_VERSION_RELEASE := $(shell awk '/define PETSC_VERSION_RELEASE/{print $$3;}' ./include/petscversion.h)
24
25libpetsc_abi_version := $(PETSC_VERSION_MAJOR).$(if $(filter $(PETSC_VERSION_RELEASE), 0 -2 -3 -4 -5),0)$(PETSC_VERSION_MINOR)
26libpetsc_lib_version := $(libpetsc_abi_version).$(PETSC_VERSION_SUBMINOR)
27soname_function = $(call SONAME_SFX_FUNCTION,$(1),$(libpetsc_abi_version))
28libname_function = $(call SONAME_SFX_FUNCTION,$(1),$(libpetsc_lib_version))
29absbasename_all = $(basename $(basename $(basename $(basename $(abspath $(1))))))# arch/lib/libpetsc.so.3.8.0 -> /path/to/arch/lib/libpetsc
30sl_linker_args = $(call SL_LINKER_FUNCTION,$(call absbasename_all,$@),$(libpetsc_abi_version),$(libpetsc_lib_version))
31
32libpetsc_shared  := $(LIBDIR)/libpetsc$(LIB_NAME_SUFFIX).$(SL_LINKER_SUFFIX)
33libpetsc_soname  := $(call soname_function,$(LIBDIR)/libpetsc)
34libpetsc_libname := $(call libname_function,$(LIBDIR)/libpetsc)
35libpetsc_static  := $(LIBDIR)/libpetsc$(LIB_NAME_SUFFIX).$(AR_LIB_SUFFIX)
36libpetscpkgs_shared  := $(foreach pkg, $(pkgs), $(LIBDIR)/libpetsc$(pkg)$(LIB_NAME_SUFFIX).$(SL_LINKER_SUFFIX))
37libpetscpkgs_soname  := $(foreach pkg, $(pkgs), $(call soname_function,$(LIBDIR)/libpetsc$(pkg)))
38libpetscpkgs_libname := $(foreach pkg, $(pkgs), $(call libname_function,$(LIBDIR)/libpetsc$(pkg)))
39libpetscpkgs_static  := $(foreach pkg, $(pkgs_reverse), $(LIBDIR)/libpetsc$(pkg)$(LIB_NAME_SUFFIX).$(AR_LIB_SUFFIX))
40
41ifeq ($(PETSC_WITH_EXTERNAL_LIB),)
42  libpetscall_shared  := $(libpetscpkgs_shared)
43  libpetscall_soname  := $(libpetscpkgs_soname)
44  libpetscall_libname := $(libpetscpkgs_libname)
45  libpetscall_static  := $(libpetscpkgs_static)
46else
47  libpetscall_shared  := $(libpetsc_shared)
48  libpetscall_soname  := $(libpetsc_soname)
49  libpetscall_libname := $(libpetsc_libname)
50  libpetscall_static  := $(libpetsc_static)
51endif
52libpetscall := $(if $(filter-out no,$(BUILDSHAREDLIB)),$(libpetscall_shared),$(libpetscall_static))
53
54generated      := $(PETSC_ARCH)/lib/petsc/conf/files
55
56libs : $(libpetscall)
57
58.PHONY: libs
59
60.SECONDEXPANSION:		# to expand $$(@D)/.DIR
61
62# Test framework includes rules and variables relevant to both build and test
63include ./gmakefile.test        # This must be below the all target because it includes rules
64
65$(generated) : $(petscconf) $(petscvariables) config/gmakegen.py
66	$(PYTHON) ./config/gmakegen.py --petsc-arch=$(PETSC_ARCH)
67
68# Skip including generated files (which triggers rebuilding them) when we're just going to clean anyway.
69ifneq ($(filter-out help clean distclean check info gmakeinfo checkbadSource checkbadFileChange deletefortranstubs allfortranstubs allfortranstubsinplace alletags clangformat checkclangformat lint get%,$(MAKECMDGOALS:clean%=clean)),)
70include $(generated)
71endif
72
73# implies shared libraries with MS compilers
74ifeq ($(PETSC_DLL_EXPORTS),1)
75$(OBJDIR)/%.o : CCPPFLAGS+=-Dpetsc_EXPORTS
76$(OBJDIR)/%.o : CXXCPPFLAGS+=-Dpetsc_EXPORTS
77$(OBJDIR)/%.o : CUDACPPFLAGS+=-Dpetsc_EXPORTS
78endif
79
80langs := F F90 cxx c
81ifneq ($(CUDAC),)
82langs += cu
83endif
84ifneq ($(HIPC),)
85langs += hip.cpp
86endif
87ifneq ($(SYCLC),)
88langs += sycl.cxx
89endif
90ifneq ($(KOKKOS_LIB),)
91langs += kokkos.cxx
92endif
93
94concatlang = $(foreach lang, $(langs), $(srcs-$(1).$(lang):%.$(lang)=$(OBJDIR)/%.o))
95srcs.o := $(foreach pkg, $(pkgs), $(call concatlang,$(pkg)))
96srcs.tidy := $(foreach pkg, $(pkgs), $(srcs-$(pkg).c:%.c=$(OBJDIR)/%.tidy))
97concatlangsrc = $(foreach lang, $(langs), $(srcs-$(1).$(lang)))
98csrc := $(foreach pkg, $(pkgs),  $(srcs-$(pkg).c))
99showcsrc:
100	-@echo $(csrc)
101
102define SHARED_RECIPE_DLL
103  @$(RM) $@ dllcmd.${PETSC_ARCH}
104  @cygpath -w $^ > dllcmd.${PETSC_ARCH}
105  $(call quiet,CLINKER) $(sl_linker_args) -o $@ @dllcmd.${PETSC_ARCH} $(PETSC_EXTERNAL_LIB_BASIC)
106  @$(RM) dllcmd.${PETSC_ARCH}
107endef
108
109define SHARED_RECIPE_ATFILE
110  $(file > $@.args,$^)
111  $(call quiet,CLINKER) $(sl_linker_args) -o $@ @$@.args $(PETSC_EXTERNAL_LIB_BASIC)
112  @$(RM) $@.args
113endef
114
115define SHARED_RECIPE_DEFAULT
116  $(call quiet,CLINKER) $(sl_linker_args) -o $@ $^ $(PETSC_EXTERNAL_LIB_BASIC)
117endef
118
119GMAKE4 = $(if $(findstring 3.99,$(firstword $(sort 3.99 $(MAKE_VERSION)))),1,)
120SHARED_RECIPE = $(if $(findstring -LD,$(SL_LINKER_FUNCTION)),$(SHARED_RECIPE_DLL),$(if $(PCC_AT_FILE),$(if $(GMAKE4),$(SHARED_RECIPE_ATFILE),$(SHARED_RECIPE_DEFAULT)),$(SHARED_RECIPE_DEFAULT)))
121
122# with-single-library=1 (default)
123$(libpetsc_libname) : $(srcs.o) | $$(@D)/.DIR
124	$(SHARED_RECIPE)
125ifneq ($(DSYMUTIL),true)
126	$(call quiet,DSYMUTIL) $@
127endif
128
129$(libpetsc_static) : obj := $(srcs.o)
130
131define ARCHIVE_RECIPE_WIN32FE_LIB
132  @$(RM) $@ $@.args
133  @cygpath -w $^ > $@.args
134  $(call quiet,AR) $(AR_FLAGS) $@ @$@.args
135  @$(RM) $@.args
136endef
137
138define ARCHIVE_RECIPE_ARGFILE
139  @$(RM) $@
140  $(file > $@.args,$^)
141  $(call quiet,AR) $(AR_FLAGS) $@ @$@.args
142  @$(RM) $@.args
143  $(call quiet,RANLIB) $@
144endef
145
146define ARCHIVE_RECIPE_DEFAULT
147  @$(RM) $@
148  $(call quiet,AR) $(AR_FLAGS) $@ $^
149  $(call quiet,RANLIB) $@
150endef
151
152%$(LIB_NAME_SUFFIX).$(AR_LIB_SUFFIX) : $$(obj) | $$(@D)/.DIR
153	$(if $(findstring win32fe_lib,$(AR)),$(ARCHIVE_RECIPE_WIN32FE_LIB),$(if $(findstring yes,$(AR_ARGFILE)),$(if $(GMAKE4),$(ARCHIVE_RECIPE_ARGFILE),$(ARCHIVE_RECIPE_DEFAULT)),$(ARCHIVE_RECIPE_DEFAULT)))
154
155# with-single-library=0
156libpkg = $(foreach pkg, $1, $(LIBDIR)/libpetsc$(pkg)$(LIB_NAME_SUFFIX).$(SL_LINKER_SUFFIX))
157define pkg_template
158  $(LIBDIR)/libpetsc$(1)$(LIB_NAME_SUFFIX).$(AR_LIB_SUFFIX)  : $(call concatlang,$(1))
159  $(call libname_function,$(LIBDIR)/libpetsc$(1)) : $(call concatlang,$(1))
160endef
161$(foreach pkg,$(pkgs),$(eval $(call pkg_template,$(pkg))))
162$(call libname_function,$(LIBDIR)/libpetscvec)  : libdep := $(call libpkg,sys)
163$(call libname_function,$(LIBDIR)/libpetscmat)  : libdep := $(call libpkg,vec sys)
164$(call libname_function,$(LIBDIR)/libpetscdm)   : libdep := $(call libpkg,mat vec sys)
165$(call libname_function,$(LIBDIR)/libpetscksp)  : libdep := $(call libpkg,dm mat vec sys)
166$(call libname_function,$(LIBDIR)/libpetscsnes) : libdep := $(call libpkg,ksp dm mat vec sys)
167$(call libname_function,$(LIBDIR)/libpetscts)   : libdep := $(call libpkg,snes ksp dm mat vec sys)
168$(call libname_function,$(LIBDIR)/libpetsctao)  : libdep := $(call libpkg,snes ksp dm mat vec sys)
169
170# The package libraries technically depend on each other (not just in an order-only way), but only
171# ABI changes like new or removed symbols requires relinking the dependent libraries.  ABI should
172# only occur when a header is changed, which would trigger recompilation and relinking anyway.
173# RELINK=1 causes dependent libraries to be relinked anyway.
174ifeq ($(RELINK),1)
175  libdep_true = $$(libdep)
176  libdep_order =
177else
178  libdep_true =
179  libdep_order = $$(libdep)
180endif
181$(libpetscpkgs_libname) : $(libdep_true) | $(libdep_order) $$(@D)/.DIR
182	$(SHARED_RECIPE)
183ifneq ($(DSYMUTIL),true)
184	$(call quiet,DSYMUTIL) $@
185endif
186
187%$(LIB_NAME_SUFFIX).$(SL_LINKER_SUFFIX) : $(call libname_function,%) | $(call soname_function,%)
188	@ln -sf $(notdir $<) $@
189
190$(call soname_function,%) : $(call libname_function,%)
191	@ln -sf $(notdir $<) $@
192
193.PRECIOUS: $(call soname_function,%)
194
195$(OBJDIR)/%.o : %.sycl.cxx | $$(@D)/.DIR
196	$(PETSC_COMPILE.sycl.cxx) $(abspath $<) -o $@
197
198$(OBJDIR)/%.o : %.c | $$(@D)/.DIR
199	$(PETSC_COMPILE.c) $(abspath $<) -o $@
200
201$(OBJDIR)/%.o : %.kokkos.cxx | $$(@D)/.DIR
202	$(PETSC_COMPILE.kokkos.cxx) $(abspath $<) -o $@
203
204$(OBJDIR)/%.o : %.cxx | $$(@D)/.DIR
205	$(PETSC_COMPILE.cxx) $(abspath $<) -o $@
206
207$(OBJDIR)/%.o : %.hip.cpp | $$(@D)/.DIR
208	$(PETSC_COMPILE.hip.cpp) $(abspath $<) -o $@
209
210$(OBJDIR)/%.o : %.cu | $$(@D)/.DIR
211	$(PETSC_COMPILE.cu) $(abspath $<) -o $@ # Compile first so that if there is an error, it comes from a normal compile
212	@$(PETSC_GENDEPS.cu) $(abspath $<) -o $(@:%.o=%.d) # Generate the dependencies for later
213
214FCMOD = cd
215$(OBJDIR)/%.o : %.F | $$(@D)/.DIR
216ifeq ($(FC_MODULE_OUTPUT_FLAG),)
217	$(call quiet,FCMOD) $(MODDIR) && $(FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) $(abspath $<) -o $(abspath $@)
218else
219	$(PETSC_COMPILE.F) $(abspath $<) -o $@ $(FC_MODULE_OUTPUT_FLAG)$(MODDIR)
220endif
221	-@$(GFORTRAN_DEP_CLEANUP)
222
223$(OBJDIR)/%.o : %.F90 | $$(@D)/.DIR
224ifeq ($(FC_MODULE_OUTPUT_FLAG),)
225	$(call quiet,FCMOD) $(MODDIR) && $(FC) -c $(FC_FLAGS) $(FFLAGS) $(FCPPFLAGS) $(FC_DEPFLAGS) $(abspath $<) -o $(abspath $@)
226else
227	$(PETSC_COMPILE.F) $(abspath $<) -o $@ $(FC_MODULE_OUTPUT_FLAG)$(MODDIR)
228endif
229	-@$(GFORTRAN_DEP_CLEANUP)
230
231# Combine with Jacob's massive lint project?
232# Only works with ./configure --with-mpi=0 since clang-tidy cannot find MPI include files (love MPI compiler wrappers, the worse thing to come from MPI)
233$(OBJDIR)/%.tidy : %.c | $$(@D)/.DIR
234	@clang-tidy --checks='clang-diagnostic-*,-clang-analyzer-*,-clang-analyzer-security.insecureAPI.rand,-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,clang-analyzer-deadcode.DeadStores,bugprone-too-small-loop-variable'  $(abspath $<) -- ${CCPPFLAGS}
235
236clang-tidy: $(srcs.tidy)
237
238# Hack: manual dependencies on object files
239ifeq ($(MPI_IS_MPIUNI),1)
240  MPIUNI_MOD := $(MODDIR)/mpiuni.mod
241  $(OBJDIR)/src/sys/mpiuni/fsrc/somempifort.o : $(OBJDIR)/src/sys/mpiuni/f90-mod/mpiunimod.o
242endif
243$(OBJDIR)/src/sys/f90-mod/petscsysmod.o   : $(if $(MPIUNI_MOD),$(OBJDIR)/src/sys/mpiuni/f90-mod/mpiunimod.o)
244$(OBJDIR)/src/vec/f90-mod/petscvecmod.o   : $(OBJDIR)/src/sys/f90-mod/petscsysmod.o
245$(OBJDIR)/src/mat/f90-mod/petscmatmod.o   : $(OBJDIR)/src/vec/f90-mod/petscvecmod.o
246$(OBJDIR)/src/dm/f90-mod/petscdmmod.o     : $(OBJDIR)/src/mat/f90-mod/petscmatmod.o
247$(OBJDIR)/src/dm/f90-mod/petscdmdamod.o   : $(OBJDIR)/src/dm/f90-mod/petscdmmod.o
248$(OBJDIR)/src/dm/f90-mod/petscdmplexmod.o : $(OBJDIR)/src/dm/f90-mod/petscdmmod.o
249$(OBJDIR)/src/dm/f90-mod/petscdmswarmmod.o : $(OBJDIR)/src/dm/f90-mod/petscdmmod.o
250$(OBJDIR)/src/ksp/f90-mod/petsckspdefmod.o : $(OBJDIR)/src/dm/f90-mod/petscdmplexmod.o
251$(OBJDIR)/src/ksp/f90-mod/petscpcmod.o    : $(OBJDIR)/src/ksp/f90-mod/petsckspdefmod.o
252$(OBJDIR)/src/ksp/f90-mod/petsckspmod.o   : $(OBJDIR)/src/ksp/f90-mod/petscpcmod.o
253$(OBJDIR)/src/snes/f90-mod/petscsnesmod.o : $(OBJDIR)/src/ksp/f90-mod/petsckspmod.o
254$(OBJDIR)/src/ts/f90-mod/petsctsmod.o     : $(OBJDIR)/src/snes/f90-mod/petscsnesmod.o
255$(OBJDIR)/src/tao/f90-mod/petsctaomod.o   : $(OBJDIR)/src/ts/f90-mod/petsctsmod.o
256# F2003 interface
257$(OBJDIR)/src/sys/objects/f2003-src/fsrc/optionenum.o   : $(OBJDIR)/src/sys/f90-mod/petscsysmod.o
258$(OBJDIR)/src/sys/classes/bag/f2003-src/fsrc/bagenum.o  : $(OBJDIR)/src/sys/f90-mod/petscsysmod.o
259
260# all sources should get recompiled when petscvariables changes (i.e when configure is rerun or when petscvariables is manually edited.)
261$(srcs.o) : $(petscvariables)
262
263.PHONY: clean all print clang-tidy
264
265clean:
266	${RM} -r $(OBJDIR) $(LIBDIR)/libpetsc* $(MODDIR)/petsc*.mod $(MPIUNI_MOD) $(generated)
267
268# make print VAR=the-variable
269print:
270	$(info $($(VAR)))
271	@true
272
273
274allobj.d := $(srcs.o:%.o=%.d)
275# Tell make that allobj.d are all up to date.  Without this, the include
276# below has quadratic complexity, taking more than one second for a
277# do-nothing build of PETSc (much worse for larger projects)
278$(allobj.d) : ;
279
280gmakeinfo:
281	-@echo "=========================================="
282	-@echo " "
283	-@echo "See documentation/faq.html and documentation/bugreporting.html"
284	-@echo "for help with installation problems.  Please send EVERYTHING"
285	-@echo "printed out below when reporting problems.  Please check the"
286	-@echo "mailing list archives and consider subscribing."
287	-@echo " "
288	-@echo "  https://petsc.org/release/community/mailing/"
289	-@echo " "
290	-@echo "=========================================="
291	-@echo Starting make run on `hostname` at `date +'%a, %d %b %Y %H:%M:%S %z'`
292	-@echo Machine characteristics: `uname -a`
293	-@echo "-----------------------------------------"
294	-@echo "Using PETSc directory: ${PETSC_DIR}"
295	-@echo "Using PETSc arch: ${PETSC_ARCH}"
296	-@echo "-----------------------------------------"
297	-@grep "define PETSC_VERSION" ${PETSC_DIR}/include/petscversion.h | ${SED} "s/........//" | head -n 7
298	-@echo "-----------------------------------------"
299	-@echo "Using configure Options: ${CONFIGURE_OPTIONS}"
300	-@echo "Using configuration flags:"
301	-@grep "#define " ${PETSCCONF_H} | tail -n +2
302	-@echo "-----------------------------------------"
303	-@echo "Using C compile: ${PETSC_CCOMPILE_SINGLE}"
304	-@if [  "${MPICC_SHOW}" != "" ]; then \
305             printf  "mpicc -show: %b\n" "${MPICC_SHOW}";\
306          fi; \
307        printf  "C compiler version: %b\n" "${C_VERSION}"; \
308        if [ "${CXX}" != "" ]; then \
309        echo "Using C++ compile: ${PETSC_CXXCOMPILE_SINGLE}";\
310        if [ "${MPICXX_SHOW}" != "" ]; then \
311               printf "mpicxx -show: %b\n" "${MPICXX_SHOW}"; \
312            fi;\
313            printf  "C++ compiler version: %b\n" "${Cxx_VERSION}"; \
314          fi
315	-@if [ "${FC}" != "" ]; then \
316	   echo "Using Fortran compile: ${PETSC_FCOMPILE_SINGLE}";\
317           if [ "${MPIFC_SHOW}" != "" ]; then \
318             printf "mpif90 -show: %b\n" "${MPIFC_SHOW}"; \
319           fi; \
320             printf  "Fortran compiler version: %b\n" "${FC_VERSION}"; \
321         fi
322	-@if [ "${CUDAC}" != "" ]; then \
323	   echo "Using CUDA compile: ${PETSC_CUCOMPILE_SINGLE}";\
324         fi
325	-@if [ "${CLANGUAGE}" = "CXX" ]; then \
326           echo "Using C++ compiler to compile PETSc";\
327        fi
328	-@echo "-----------------------------------------"
329	-@echo "Using C/C++ linker: ${PCC_LINKER}"
330	-@echo "Using C/C++ flags: ${PCC_LINKER_FLAGS}"
331	-@if [ "${FC}" != "" ]; then \
332	   echo "Using Fortran linker: ${FC_LINKER}";\
333	   echo "Using Fortran flags: ${FC_LINKER_FLAGS}";\
334         fi
335	-@echo "-----------------------------------------"
336	-@echo "Using system modules: ${LOADEDMODULES}"
337	-@if [ "${MPI_IS_MPIUNI}" = "1" ]; then \
338           echo Using mpi.h: mpiuni; \
339        else \
340           TESTDIR=`mktemp -q -d -t petscmpi-XXXXXXXX` && \
341           echo '#include <mpi.h>' > $${TESTDIR}/mpitest.c && \
342           BUF=`${CPP} ${PETSC_CPPFLAGS} ${PETSC_CC_INCLUDES} $${TESTDIR}/mpitest.c |grep 'mpi\.h' | ( head -1 ; cat > /dev/null )` && \
343           echo Using mpi.h: $${BUF}; ${RM} -rf $${TESTDIR}; \
344        fi
345	-@echo "-----------------------------------------"
346	-@echo "Using libraries: ${PETSC_LIB}"
347	-@echo "------------------------------------------"
348	-@echo "Using mpiexec: ${MPIEXEC}"
349	-@echo "------------------------------------------"
350	-@echo "Using MAKE: ${MAKE}"
351	-@echo "Default MAKEFLAGS: MAKE_NP:${MAKE_NP} MAKE_LOAD:${MAKE_LOAD} MAKEFLAGS:${MAKEFLAGS}"
352	-@echo "=========================================="
353
354-include $(allobj.d)
355