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