xref: /libCEED/Makefile (revision 1799df4f378bfad15b9733036c48cf4b42fcd943)
1# Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors.
2# All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
3#
4# SPDX-License-Identifier: BSD-2-Clause
5#
6# This file is part of CEED:  http://github.com/ceed
7
8CONFIG ?= config.mk
9-include $(CONFIG)
10COMMON ?= common.mk
11-include $(COMMON)
12
13ifeq (,$(filter-out undefined default,$(origin CC)))
14  CC = gcc
15endif
16ifeq (,$(filter-out undefined default,$(origin CXX)))
17  CXX = g++
18endif
19ifeq (,$(filter-out undefined default,$(origin FC)))
20  FC = gfortran
21endif
22ifeq (,$(filter-out undefined default,$(origin LINK)))
23  LINK = $(CC)
24endif
25ifeq (,$(filter-out undefined default,$(origin AR)))
26  AR = ar
27endif
28ifeq (,$(filter-out undefined default,$(origin ARFLAGS)))
29  ARFLAGS = crD
30endif
31NVCC ?= $(CUDA_DIR)/bin/nvcc
32NVCC_CXX ?= $(CXX)
33HIPCC ?= $(HIP_DIR)/bin/hipcc
34SED ?= sed
35
36# ASAN must be left empty if you don't want to use it
37ASAN ?=
38
39# These are the values automatically detected here in the makefile. They are
40# augmented with LDFLAGS and LDLIBS from the environment/passed by command line,
41# if any. If the user sets CEED_LDFLAGS or CEED_LDLIBS, they are used *instead
42# of* what we populate here (thus that's advanced usage and not recommended).
43CEED_LDFLAGS ?=
44CEED_LDLIBS ?=
45
46UNDERSCORE ?= 1
47
48# Verbose mode, V or VERBOSE
49V ?= $(VERBOSE)
50
51# MFEM_DIR env variable should point to sibling directory
52ifneq ($(wildcard ../mfem/libmfem.*),)
53  MFEM_DIR ?= ../mfem
54endif
55
56# NEK5K_DIR env variable should point to sibling directory
57ifneq ($(wildcard ../Nek5000/*),)
58  NEK5K_DIR ?= $(abspath ../Nek5000)
59endif
60export NEK5K_DIR
61MPI ?= 1
62
63# CEED_DIR env for NEK5K testing
64export CEED_DIR = $(abspath .)
65
66# XSMM_DIR env variable should point to XSMM master (github.com/hfp/libxsmm)
67XSMM_DIR ?= ../libxsmm
68
69# OCCA_DIR env variable should point to OCCA master (github.com/libocca/occa)
70OCCA_DIR ?= ../occa
71
72# env variable MAGMA_DIR can be used too
73MAGMA_DIR ?= ../magma
74
75# Often /opt/cuda or /usr/local/cuda, but sometimes present on machines that don't support CUDA
76CUDA_DIR  ?=
77CUDA_ARCH ?=
78
79# Often /opt/rocm, but sometimes present on machines that don't support HIP
80HIP_DIR ?=
81HIP_ARCH ?=
82
83# Check for PETSc in ../petsc
84ifneq ($(wildcard ../petsc/lib/libpetsc.*),)
85  PETSC_DIR ?= ../petsc
86endif
87
88# Warning: SANTIZ options still don't run with /gpu/occa
89# export LSAN_OPTIONS=suppressions=.asanignore
90AFLAGS = -fsanitize=address #-fsanitize=undefined -fno-omit-frame-pointer
91
92# Note: Intel oneAPI C/C++ compiler is now icx/icpx
93CC_VENDOR := $(subst oneAPI,icc,$(firstword $(filter gcc clang icc oneAPI XL,$(subst -, ,$(shell $(CC) --version)))))
94FC_VENDOR := $(if $(FC),$(firstword $(filter GNU ifort XL,$(shell $(FC) --version 2>&1 || $(FC) -qversion))))
95
96# Default extra flags by vendor
97MARCHFLAG.gcc           := -march=native
98MARCHFLAG.clang         := $(MARCHFLAG.gcc)
99MARCHFLAG.icc           :=
100OMP_SIMD_FLAG.gcc       := -fopenmp-simd
101OMP_SIMD_FLAG.clang     := $(OMP_SIMD_FLAG.gcc)
102OMP_SIMD_FLAG.icc       := -qopenmp-simd
103OPT.gcc                 := -ffp-contract=fast
104OPT.clang               := $(OPT.gcc)
105CFLAGS.gcc              := -fPIC -std=c99 -Wall -Wextra -Wno-unused-parameter -MMD -MP
106CFLAGS.clang            := $(CFLAGS.gcc)
107CFLAGS.icc              := $(CFLAGS.gcc)
108CFLAGS.XL               := -qpic -MMD
109CXXFLAGS.gcc            := -fPIC -std=c++11 -Wall -Wextra -Wno-unused-parameter -MMD -MP
110CXXFLAGS.clang          := $(CXXFLAGS.gcc)
111CXXFLAGS.icc            := $(CXXFLAGS.gcc)
112CXXFLAGS.XL             := -qpic -std=c++11 -MMD
113FFLAGS.GNU              := -fPIC -cpp -Wall -Wextra -Wno-unused-parameter -Wno-unused-dummy-argument -MMD -MP
114FFLAGS.ifort            := -fPIC -cpp
115FFLAGS.XL               := -qpic -ffree-form -qpreprocess -qextname -MMD
116
117# This check works with compilers that use gcc and clang.  It fails with some
118# compilers; e.g., xlc apparently ignores all options when -E is passed, thus
119# succeeds with any flags.  Users can pass MARCHFLAG=... if desired.
120cc_check_flag = $(shell $(CC) -E -Werror $(1) -x c /dev/null > /dev/null 2>&1 && echo 1)
121MARCHFLAG := $(MARCHFLAG.$(CC_VENDOR))
122MARCHFLAG := $(if $(call cc_check_flag,$(MARCHFLAG)),$(MARCHFLAG),-mcpu=native)
123MARCHFLAG := $(if $(call cc_check_flag,$(MARCHFLAG)),$(MARCHFLAG))
124
125OMP_SIMD_FLAG := $(OMP_SIMD_FLAG.$(CC_VENDOR))
126OMP_SIMD_FLAG := $(if $(call cc_check_flag,$(OMP_SIMD_FLAG)),$(OMP_SIMD_FLAG))
127
128OPT    ?= -O -g $(MARCHFLAG) $(OPT.$(CC_VENDOR)) $(OMP_SIMD_FLAG)
129CFLAGS ?= $(OPT) $(CFLAGS.$(CC_VENDOR))
130CXXFLAGS ?= $(OPT) $(CXXFLAGS.$(CC_VENDOR))
131LIBCXX ?= -lstdc++
132NVCCFLAGS ?= -ccbin $(CXX) -Xcompiler "$(OPT)" -Xcompiler -fPIC
133ifneq ($(CUDA_ARCH),)
134  NVCCFLAGS += -arch=$(CUDA_ARCH)
135endif
136HIPCCFLAGS ?= $(filter-out $(OMP_SIMD_FLAG),$(OPT)) -fPIC -munsafe-fp-atomics
137ifneq ($(HIP_ARCH),)
138  HIPCCFLAGS += --amdgpu-target=$(HIP_ARCH)
139endif
140FFLAGS ?= $(OPT) $(FFLAGS.$(FC_VENDOR))
141
142ifeq ($(COVERAGE), 1)
143  CFLAGS += --coverage
144  CXXFLAGS += --coverage
145  CEED_LDFLAGS += --coverage
146endif
147
148CFLAGS += $(if $(ASAN),$(AFLAGS))
149FFLAGS += $(if $(ASAN),$(AFLAGS))
150CEED_LDFLAGS += $(if $(ASAN),$(AFLAGS))
151CPPFLAGS += -I./include
152CEED_LDLIBS = -lm
153OBJDIR := build
154LIBDIR := lib
155
156# Installation variables
157prefix ?= /usr/local
158bindir = $(prefix)/bin
159libdir = $(prefix)/lib
160includedir = $(prefix)/include
161pkgconfigdir = $(libdir)/pkgconfig
162INSTALL = install
163INSTALL_PROGRAM = $(INSTALL)
164INSTALL_DATA = $(INSTALL) -m644
165
166# Get number of processors of the machine
167NPROCS := $(shell getconf _NPROCESSORS_ONLN)
168# prepare make options to run in parallel
169MFLAGS := -j $(NPROCS) --warn-undefined-variables \
170                       --no-print-directory --no-keep-going
171
172PYTHON ?= python3
173PROVE ?= prove
174PROVE_OPTS ?= -j $(NPROCS)
175DARWIN := $(filter Darwin,$(shell uname -s))
176SO_EXT := $(if $(DARWIN),dylib,so)
177
178ceed.pc := $(LIBDIR)/pkgconfig/ceed.pc
179libceed.so := $(LIBDIR)/libceed.$(SO_EXT)
180libceed.a := $(LIBDIR)/libceed.a
181libceed := $(if $(STATIC),$(libceed.a),$(libceed.so))
182CEED_LIBS = -lceed
183libceed.c := $(filter-out interface/ceed-cuda.c interface/ceed-hip.c, $(wildcard interface/ceed*.c backends/*.c gallery/*.c))
184gallery.c := $(wildcard gallery/*/ceed*.c)
185libceed.c += $(gallery.c)
186libceeds = $(libceed)
187BACKENDS_BUILTIN := /cpu/self/ref/serial /cpu/self/ref/blocked /cpu/self/opt/serial /cpu/self/opt/blocked
188BACKENDS_MAKE := $(BACKENDS_BUILTIN)
189TEST_BACKENDS := /cpu/self/tmpl /cpu/self/tmpl/sub
190
191# Tests
192tests.c   := $(sort $(wildcard tests/t[0-9][0-9][0-9]-*.c))
193tests.f   := $(if $(FC),$(sort $(wildcard tests/t[0-9][0-9][0-9]-*.f90)))
194tests     := $(tests.c:tests/%.c=$(OBJDIR)/%)
195ctests    := $(tests)
196tests     += $(tests.f:tests/%.f90=$(OBJDIR)/%)
197# Examples
198examples.c := $(sort $(wildcard examples/ceed/*.c))
199examples.f := $(if $(FC),$(sort $(wildcard examples/ceed/*.f)))
200examples  := $(examples.c:examples/ceed/%.c=$(OBJDIR)/%)
201examples  += $(examples.f:examples/ceed/%.f=$(OBJDIR)/%)
202# MFEM Examples
203mfemexamples.cpp := $(sort $(wildcard examples/mfem/*.cpp))
204mfemexamples  := $(mfemexamples.cpp:examples/mfem/%.cpp=$(OBJDIR)/mfem-%)
205# Nek5K Examples
206nekexamples  := $(OBJDIR)/nek-bps
207# PETSc Examples
208petscexamples.c := $(wildcard examples/petsc/*.c)
209petscexamples   := $(petscexamples.c:examples/petsc/%.c=$(OBJDIR)/petsc-%)
210# Fluid Dynamics Examples
211fluidsexamples.c := $(sort $(wildcard examples/fluids/*.c))
212fluidsexamples  := $(fluidsexamples.c:examples/fluids/%.c=$(OBJDIR)/fluids-%)
213# Solid Mechanics Examples
214solidsexamples.c := $(sort $(wildcard examples/solids/*.c))
215solidsexamples   := $(solidsexamples.c:examples/solids/%.c=$(OBJDIR)/solids-%)
216
217# Backends/[ref, blocked, memcheck, opt, avx, occa, magma]
218ref.c          := $(sort $(wildcard backends/ref/*.c))
219blocked.c      := $(sort $(wildcard backends/blocked/*.c))
220ceedmemcheck.c := $(sort $(wildcard backends/memcheck/*.c))
221opt.c          := $(sort $(wildcard backends/opt/*.c))
222avx.c          := $(sort $(wildcard backends/avx/*.c))
223xsmm.c         := $(sort $(wildcard backends/xsmm/*.c))
224cuda.c         := $(sort $(wildcard backends/cuda/*.c))
225cuda-ref.c     := $(sort $(wildcard backends/cuda-ref/*.c))
226cuda-ref.cpp   := $(sort $(wildcard backends/cuda-ref/*.cpp))
227cuda-ref.cu    := $(sort $(wildcard backends/cuda-ref/kernels/*.cu))
228cuda-shared.c  := $(sort $(wildcard backends/cuda-shared/*.c))
229cuda-shared.cu := $(sort $(wildcard backends/cuda-shared/kernels/*.cu))
230cuda-gen.c     := $(sort $(wildcard backends/cuda-gen/*.c))
231cuda-gen.cpp   := $(sort $(wildcard backends/cuda-gen/*.cpp))
232cuda-gen.cu    := $(sort $(wildcard backends/cuda-gen/kernels/*.cu))
233occa.cpp       := $(sort $(shell find backends/occa -type f -name *.cpp))
234magma.c        := $(sort $(wildcard backends/magma/*.c))
235magma.cu       := $(sort $(wildcard backends/magma/kernels/cuda/*.cu))
236magma.hip      := $(sort $(wildcard backends/magma/kernels/hip/*.hip.cpp))
237hip.c          := $(sort $(wildcard backends/hip/*.c))
238hip.cpp        := $(sort $(wildcard backends/hip/*.cpp))
239hip-ref.c      := $(sort $(wildcard backends/hip-ref/*.c))
240hip-ref.cpp    := $(sort $(wildcard backends/hip-ref/*.cpp))
241hip-ref.hip    := $(sort $(wildcard backends/hip-ref/kernels/*.hip.cpp))
242hip-shared.c   := $(sort $(wildcard backends/hip-shared/*.c))
243hip-gen.c      := $(sort $(wildcard backends/hip-gen/*.c))
244hip-gen.cpp    := $(sort $(wildcard backends/hip-gen/*.cpp))
245
246# Quiet, color output
247quiet ?= $($(1))
248
249# Cancel built-in and old-fashioned implicit rules which we don't use
250.SUFFIXES:
251
252.SECONDEXPANSION: # to expand $$(@D)/.DIR
253
254%/.DIR :
255	@mkdir -p $(@D)
256	@touch $@
257
258.PRECIOUS: %/.DIR
259
260lib: $(libceed) $(ceed.pc)
261# run 'lib' target in parallel
262par:;@$(MAKE) $(MFLAGS) V=$(V) lib
263backend_status = $(if $(filter $1,$(BACKENDS_MAKE)), [backends: $1], [not found])
264info:
265	$(info ------------------------------------)
266	$(info CC            = $(CC))
267	$(info CXX           = $(CXX))
268	$(info FC            = $(FC))
269	$(info CPPFLAGS      = $(CPPFLAGS))
270	$(info CFLAGS        = $(value CFLAGS))
271	$(info CXXFLAGS      = $(value CXXFLAGS))
272	$(info FFLAGS        = $(value FFLAGS))
273	$(info NVCCFLAGS     = $(value NVCCFLAGS))
274	$(info HIPCCFLAGS    = $(value HIPCCFLAGS))
275	$(info CEED_LDFLAGS  = $(value CEED_LDFLAGS))
276	$(info CEED_LDLIBS   = $(value CEED_LDLIBS))
277	$(info AR            = $(AR))
278	$(info ARFLAGS       = $(ARFLAGS))
279	$(info OPT           = $(OPT))
280	$(info AFLAGS        = $(AFLAGS))
281	$(info ASAN          = $(or $(ASAN),(empty)))
282	$(info VERBOSE       = $(or $(V),(empty)) [verbose=$(if $(V),on,off)])
283	$(info ------------------------------------)
284	$(info MEMCHK_STATUS = $(MEMCHK_STATUS)$(call backend_status,$(MEMCHK_BACKENDS)))
285	$(info AVX_STATUS    = $(AVX_STATUS)$(call backend_status,$(AVX_BACKENDS)))
286	$(info XSMM_DIR      = $(XSMM_DIR)$(call backend_status,$(XSMM_BACKENDS)))
287	$(info OCCA_DIR      = $(OCCA_DIR)$(call backend_status,$(OCCA_BACKENDS)))
288	$(info MAGMA_DIR     = $(MAGMA_DIR)$(call backend_status,$(MAGMA_BACKENDS)))
289	$(info CUDA_DIR      = $(CUDA_DIR)$(call backend_status,$(CUDA_BACKENDS)))
290	$(info HIP_DIR       = $(HIP_DIR)$(call backend_status,$(HIP_BACKENDS)))
291	$(info ------------------------------------)
292	$(info MFEM_DIR      = $(MFEM_DIR))
293	$(info NEK5K_DIR     = $(NEK5K_DIR))
294	$(info PETSC_DIR     = $(PETSC_DIR))
295	$(info ------------------------------------)
296	$(info prefix        = $(prefix))
297	$(info includedir    = $(value includedir))
298	$(info libdir        = $(value libdir))
299	$(info pkgconfigdir  = $(value pkgconfigdir))
300	$(info ------------------------------------)
301	@true
302info-backends:
303	$(info make: 'lib' with optional backends: $(filter-out $(BACKENDS_BUILTIN),$(BACKENDS)))
304	@true
305info-backends-all:
306	$(info make: 'lib' with backends: $(filter-out $(TEST_BACKENDS),$(BACKENDS)))
307	@true
308
309$(libceed.so) : CEED_LDFLAGS += $(if $(DARWIN), -install_name @rpath/$(notdir $(libceed.so)))
310
311# Standard Backends
312libceed.c += $(ref.c)
313libceed.c += $(blocked.c)
314libceed.c += $(opt.c)
315
316# Memcheck Backend
317MEMCHK_STATUS = Disabled
318MEMCHK := $(shell echo "$(HASH)include <valgrind/memcheck.h>" | $(CC) $(CPPFLAGS) -E - >/dev/null 2>&1 && echo 1)
319MEMCHK_BACKENDS = /cpu/self/memcheck/serial /cpu/self/memcheck/blocked
320ifeq ($(MEMCHK),1)
321  MEMCHK_STATUS = Enabled
322  libceed.c += $(ceedmemcheck.c)
323  BACKENDS_MAKE += $(MEMCHK_BACKENDS)
324endif
325
326# AVX Backed
327AVX_STATUS = Disabled
328AVX_FLAG := $(if $(filter clang,$(CC_VENDOR)),+avx,-mavx)
329AVX := $(filter $(AVX_FLAG),$(shell $(CC) $(CFLAGS) -v -E -x c /dev/null 2>&1))
330AVX_BACKENDS = /cpu/self/avx/serial /cpu/self/avx/blocked
331ifneq ($(AVX),)
332  AVX_STATUS = Enabled
333  libceed.c += $(avx.c)
334  BACKENDS_MAKE += $(AVX_BACKENDS)
335endif
336
337# Collect list of libraries and paths for use in linking and pkg-config
338PKG_LIBS =
339# Stubs that will not be RPATH'd
340PKG_STUBS_LIBS =
341
342# libXSMM Backends
343XSMM_BACKENDS = /cpu/self/xsmm/serial /cpu/self/xsmm/blocked
344ifneq ($(wildcard $(XSMM_DIR)/lib/libxsmm.*),)
345  PKG_LIBS += -L$(abspath $(XSMM_DIR))/lib -lxsmm -ldl
346  MKL ?=
347  ifeq (,$(MKL)$(MKLROOT))
348    BLAS_LIB = -lblas
349  else
350    ifneq ($(MKLROOT),)
351      # Some installs put everything inside an intel64 subdirectory, others not
352      MKL_LIBDIR = $(dir $(firstword $(wildcard $(MKLROOT)/lib/intel64/libmkl_sequential.* $(MKLROOT)/lib/libmkl_sequential.*)))
353      MKL_LINK = -L$(MKL_LIBDIR)
354      PKG_LIB_DIRS += $(MKL_LIBDIR)
355    endif
356    BLAS_LIB = $(MKL_LINK) -Wl,--push-state,--no-as-needed -lmkl_intel_lp64 -lmkl_sequential -lmkl_core -lpthread -lm -ldl -Wl,--pop-state
357  endif
358  PKG_LIBS += $(BLAS_LIB)
359  libceed.c += $(xsmm.c)
360  $(xsmm.c:%.c=$(OBJDIR)/%.o) $(xsmm.c:%=%.tidy) : CPPFLAGS += -I$(XSMM_DIR)/include
361  BACKENDS_MAKE += $(XSMM_BACKENDS)
362endif
363
364# OCCA Backends
365OCCA_BACKENDS = /cpu/self/occa
366ifneq ($(wildcard $(OCCA_DIR)/lib/libocca.*),)
367  OCCA_MODES := $(shell $(OCCA_DIR)/bin/occa modes)
368  OCCA_BACKENDS += $(if $(filter OpenMP,$(OCCA_MODES)),/cpu/openmp/occa)
369# OCCA_BACKENDS += $(if $(filter OpenCL,$(OCCA_MODES)),/gpu/opencl/occa)
370  OCCA_BACKENDS += $(if $(filter HIP,$(OCCA_MODES)),/gpu/hip/occa)
371  OCCA_BACKENDS += $(if $(filter CUDA,$(OCCA_MODES)),/gpu/cuda/occa)
372
373  $(libceeds) : CPPFLAGS += -I$(OCCA_DIR)/include
374  PKG_LIBS += -L$(abspath $(OCCA_DIR))/lib -locca
375  LIBCEED_CONTAINS_CXX = 1
376  libceed.cpp += $(occa.cpp)
377  BACKENDS_MAKE += $(OCCA_BACKENDS)
378endif
379
380# CUDA Backends
381CUDA_LIB_DIR := $(wildcard $(foreach d,lib lib64,$(CUDA_DIR)/$d/libcudart.${SO_EXT}))
382CUDA_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(CUDA_LIB_DIR))))
383CUDA_LIB_DIR_STUBS := $(CUDA_LIB_DIR)/stubs
384CUDA_BACKENDS = /gpu/cuda/ref /gpu/cuda/shared /gpu/cuda/gen
385ifneq ($(CUDA_LIB_DIR),)
386  $(libceeds) : CPPFLAGS += -I$(CUDA_DIR)/include
387  PKG_LIBS += -L$(abspath $(CUDA_LIB_DIR)) -lcudart -lnvrtc -lcuda -lcublas
388  PKG_STUBS_LIBS += -L$(CUDA_LIB_DIR_STUBS)
389  LIBCEED_CONTAINS_CXX = 1
390  libceed.c     += interface/ceed-cuda.c
391  libceed.c     += $(cuda.c) $(cuda-ref.c) $(cuda-shared.c) $(cuda-gen.c)
392  libceed.cpp   += $(cuda-ref.cpp) $(cuda-gen.cpp)
393  libceed.cu    += $(cuda-ref.cu) $(cuda-shared.cu) $(cuda-gen.cu)
394  BACKENDS_MAKE += $(CUDA_BACKENDS)
395endif
396
397# HIP Backends
398HIP_LIB_DIR := $(wildcard $(foreach d,lib lib64,$(HIP_DIR)/$d/libamdhip64.${SO_EXT}))
399HIP_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(HIP_LIB_DIR))))
400HIP_BACKENDS = /gpu/hip/ref /gpu/hip/shared /gpu/hip/gen
401ifneq ($(HIP_LIB_DIR),)
402  $(libceeds) : HIPCCFLAGS += -I./include
403  ifneq ($(CXX), $(HIPCC))
404    CPPFLAGS += $(subst =,,$(shell $(HIP_DIR)/bin/hipconfig -C))
405  endif
406  $(libceeds) : CPPFLAGS += -I$(HIP_DIR)/include
407  PKG_LIBS += -L$(abspath $(HIP_LIB_DIR)) -lamdhip64 -lhipblas
408  LIBCEED_CONTAINS_CXX = 1
409  libceed.c     += interface/ceed-hip.c
410  libceed.c     += $(hip.c) $(hip-ref.c) $(hip-shared.c) $(hip-gen.c)
411  libceed.cpp   += $(hip.cpp) $(hip-ref.cpp) $(hip-gen.cpp)
412  libceed.hip   += $(hip-ref.hip)
413  BACKENDS_MAKE += $(HIP_BACKENDS)
414endif
415
416# MAGMA Backend
417ifneq ($(wildcard $(MAGMA_DIR)/lib/libmagma.*),)
418  MAGMA_ARCH=$(shell nm -g $(MAGMA_DIR)/lib/libmagma.* | grep -c "hipblas")
419  ifeq ($(MAGMA_ARCH), 0) #CUDA MAGMA
420    ifneq ($(CUDA_LIB_DIR),)
421      cuda_link = -Wl,-rpath,$(CUDA_LIB_DIR) -L$(CUDA_LIB_DIR) -lcublas -lcusparse -lcudart
422      omp_link = -fopenmp
423      magma_link_static = -L$(MAGMA_DIR)/lib -lmagma $(cuda_link) $(omp_link)
424      magma_link_shared = -L$(MAGMA_DIR)/lib -Wl,-rpath,$(abspath $(MAGMA_DIR)/lib) -lmagma
425      magma_link := $(if $(wildcard $(MAGMA_DIR)/lib/libmagma.${SO_EXT}),$(magma_link_shared),$(magma_link_static))
426      PKG_LIBS += $(magma_link)
427      libceed.c  += $(magma.c)
428      libceed.cu += $(magma.cu)
429      $(magma.c:%.c=$(OBJDIR)/%.o) $(magma.c:%=%.tidy) : CPPFLAGS += -DADD_ -I$(MAGMA_DIR)/include -I$(CUDA_DIR)/include
430      $(magma.cu:%.cu=$(OBJDIR)/%.o) : CPPFLAGS += --compiler-options=-fPIC -DADD_ -I$(MAGMA_DIR)/include -I$(MAGMA_DIR)/magmablas -I$(CUDA_DIR)/include
431      MAGMA_BACKENDS = /gpu/cuda/magma /gpu/cuda/magma/det
432    endif
433  else  # HIP MAGMA
434    ifneq ($(HIP_LIB_DIR),)
435      hip_link = -Wl,-rpath,$(HIP_LIB_DIR) -L$(HIP_LIB_DIR) -lhipblas -lhipsparse -lamdhip64
436      omp_link = -fopenmp
437      magma_link_static = -L$(MAGMA_DIR)/lib -lmagma $(hip_link) $(omp_link)
438      magma_link_shared = -L$(MAGMA_DIR)/lib -Wl,-rpath,$(abspath $(MAGMA_DIR)/lib) -lmagma
439      magma_link := $(if $(wildcard $(MAGMA_DIR)/lib/libmagma.${SO_EXT}),$(magma_link_shared),$(magma_link_static))
440      PKG_LIBS += $(magma_link)
441      libceed.c  += $(magma.c)
442      libceed.hip += $(magma.hip)
443      ifneq ($(CXX), $(HIPCC))
444        $(magma.c:%.c=$(OBJDIR)/%.o) $(magma.c:%=%.tidy) : CPPFLAGS += -I$(MAGMA_DIR)/include -I$(HIP_DIR)/include -DHAVE_HIP -DADD_
445      else
446        $(magma.c:%.c=$(OBJDIR)/%.o) $(magma.c:%=%.tidy) : HIPCCFLAGS += -I$(MAGMA_DIR)/include -I$(HIP_DIR)/include -DHAVE_HIP -DADD_
447      endif
448      $(magma.hip:%.hip.cpp=$(OBJDIR)/%.o) : HIPCCFLAGS += -I$(MAGMA_DIR)/include -I$(MAGMA_DIR)/magmablas -I$(HIP_DIR)/include -DHAVE_HIP -DADD_
449      MAGMA_BACKENDS = /gpu/hip/magma /gpu/hip/magma/det
450    endif
451  endif
452  LIBCEED_CONTAINS_CXX = 1
453  BACKENDS_MAKE += $(MAGMA_BACKENDS)
454endif
455
456BACKENDS ?= $(BACKENDS_MAKE)
457export BACKENDS
458
459_pkg_ldflags = $(filter -L%,$(PKG_LIBS))
460_pkg_ldlibs = $(filter-out -L%,$(PKG_LIBS))
461$(libceeds) : CEED_LDFLAGS += $(_pkg_ldflags) $(_pkg_ldflags:-L%=-Wl,-rpath,%) $(PKG_STUBS_LIBS)
462$(libceeds) : CEED_LDLIBS += $(_pkg_ldlibs)
463ifeq ($(STATIC),1)
464$(examples) $(tests) : CEED_LDFLAGS += $(_pkg_ldflags) $(_pkg_ldflags:-L%=-Wl,-rpath,%) $(PKG_STUBS_LIBS)
465$(examples) $(tests) : CEED_LDLIBS += $(_pkg_ldlibs)
466endif
467
468pkgconfig-libs-private = $(PKG_LIBS)
469ifeq ($(LIBCEED_CONTAINS_CXX),1)
470  $(libceeds) : LINK = $(CXX)
471  ifeq ($(STATIC),1)
472    $(examples) $(tests) : CEED_LDLIBS += $(LIBCXX)
473	  pkgconfig-libs-private += $(LIBCXX)
474  endif
475endif
476
477# File names *-weak.c contain weak symbol definitions, which must be listed last
478# when creating shared or static libraries.
479weak_last = $(filter-out %-weak.o,$(1)) $(filter %-weak.o,$(1))
480
481libceed.o = $(libceed.c:%.c=$(OBJDIR)/%.o) $(libceed.cpp:%.cpp=$(OBJDIR)/%.o) $(libceed.cu:%.cu=$(OBJDIR)/%.o) $(libceed.hip:%.hip.cpp=$(OBJDIR)/%.o)
482$(filter %fortran.o,$(libceed.o)) : CPPFLAGS += $(if $(filter 1,$(UNDERSCORE)),-DUNDERSCORE)
483$(libceed.o): | info-backends
484$(libceed.so) : $(call weak_last,$(libceed.o)) | $$(@D)/.DIR
485	$(call quiet,LINK) $(LDFLAGS) $(CEED_LDFLAGS) -shared -o $@ $^ $(CEED_LDLIBS) $(LDLIBS)
486
487$(libceed.a) : $(call weak_last,$(libceed.o)) | $$(@D)/.DIR
488	$(call quiet,AR) $(ARFLAGS) $@ $^
489
490$(OBJDIR)/%.o : $(CURDIR)/%.c | $$(@D)/.DIR
491	$(call quiet,CC) $(CPPFLAGS) $(CFLAGS) -c -o $@ $(abspath $<)
492
493$(OBJDIR)/%.o : $(CURDIR)/%.cpp | $$(@D)/.DIR
494	$(call quiet,CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $(abspath $<)
495
496$(OBJDIR)/%.o : $(CURDIR)/%.cu | $$(@D)/.DIR
497	$(call quiet,NVCC) $(filter-out -Wno-unused-function, $(CPPFLAGS)) $(NVCCFLAGS) -c -o $@ $(abspath $<)
498
499$(OBJDIR)/%.o : $(CURDIR)/%.hip.cpp | $$(@D)/.DIR
500	$(call quiet,HIPCC) $(HIPCCFLAGS) -c -o $@ $(abspath $<)
501
502$(OBJDIR)/% : tests/%.c | $$(@D)/.DIR
503	$(call quiet,LINK.c) $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
504
505$(OBJDIR)/% : tests/%.f90 | $$(@D)/.DIR
506	$(call quiet,LINK.F) -DSOURCE_DIR='"$(abspath $(<D))/"' $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
507
508$(OBJDIR)/% : examples/ceed/%.c | $$(@D)/.DIR
509	$(call quiet,LINK.c) $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
510
511$(OBJDIR)/% : examples/ceed/%.f | $$(@D)/.DIR
512	$(call quiet,LINK.F) -DSOURCE_DIR='"$(abspath $(<D))/"' $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
513
514$(OBJDIR)/mfem-% : examples/mfem/%.cpp $(libceed) | $$(@D)/.DIR
515	+$(MAKE) -C examples/mfem CEED_DIR=`pwd` \
516	  MFEM_DIR="$(abspath $(MFEM_DIR))" CXX=$(CXX) $*
517	cp examples/mfem/$* $@
518
519# Note: Multiple Nek files cannot be built in parallel. The '+' here enables
520#       this single Nek bps file to be built in parallel with other examples,
521#       such as when calling `make prove-all -j2`.
522$(OBJDIR)/nek-bps : examples/nek/bps/bps.usr examples/nek/nek-examples.sh $(libceed) | $$(@D)/.DIR
523	+$(MAKE) -C examples MPI=$(MPI) CEED_DIR=`pwd` NEK5K_DIR="$(abspath $(NEK5K_DIR))" nek
524	mv examples/nek/build/bps $(OBJDIR)/bps
525	cp examples/nek/nek-examples.sh $(OBJDIR)/nek-bps
526
527# Several executables have common utilities, but we can't build the utilities
528# from separate submake invocations because they'll compete with each
529# other/corrupt output. So we put it in this utility library, but we don't want
530# to manually list source dependencies up at this level, so we'll just always
531# call recursive make to check that this utility is up to date.
532examples/petsc/libutils.a.PHONY: $(libceed) $(ceed.pc)
533	+$(call quiet,MAKE) -C examples/petsc CEED_DIR=`pwd` AR=$(AR) ARFLAGS=$(ARFLAGS) \
534	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $(basename $(@F))
535
536$(OBJDIR)/petsc-% : examples/petsc/%.c examples/petsc/libutils.a.PHONY $(libceed) $(ceed.pc) | $$(@D)/.DIR
537	+$(call quiet,MAKE) -C examples/petsc CEED_DIR=`pwd` \
538	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
539	cp examples/petsc/$* $@
540
541$(OBJDIR)/fluids-% : examples/fluids/%.c examples/fluids/src/*.c examples/fluids/*.h examples/fluids/problems/*.c examples/fluids/qfunctions/*.h $(libceed) $(ceed.pc) | $$(@D)/.DIR
542	+$(call quiet,MAKE) -C examples/fluids CEED_DIR=`pwd` \
543	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
544	cp examples/fluids/$* $@
545
546$(OBJDIR)/solids-% : examples/solids/%.c examples/solids/%.h \
547    examples/solids/problems/*.c examples/solids/src/*.c \
548    examples/solids/include/*.h examples/solids/problems/*.h examples/solids/qfunctions/*.h \
549    $(libceed) $(ceed.pc) | $$(@D)/.DIR
550	+$(call quiet,MAKE) -C examples/solids CEED_DIR=`pwd` \
551	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
552	cp examples/solids/$* $@
553
554$(examples) : $(libceed)
555$(tests) : $(libceed)
556$(tests) $(examples) : override LDFLAGS += -Wl,-rpath,$(abspath $(LIBDIR)) -L$(LIBDIR)
557
558run-% : $(OBJDIR)/%
559	@tests/tap.sh $(<:$(OBJDIR)/%=%)
560
561external_examples := \
562	$(if $(MFEM_DIR),$(mfemexamples)) \
563	$(if $(PETSC_DIR),$(petscexamples)) \
564	$(if $(NEK5K_DIR),$(nekexamples)) \
565	$(if $(PETSC_DIR),$(fluidsexamples)) \
566	$(if $(PETSC_DIR),$(solidsexamples))
567
568allexamples = $(examples) $(external_examples)
569
570# The test and prove targets can be controlled via pattern searches.  The
571# default is to run tests and those examples that have no external dependencies.
572# Examples of finer grained control:
573#
574#   make test search='petsc mfem'      # PETSc and MFEM examples
575#   make prove search='t3'             # t3xx series tests
576#   make junit search='ex petsc'       # core ex* and PETSc tests
577search ?= t ex
578realsearch = $(search:%=%%)
579matched = $(foreach pattern,$(realsearch),$(filter $(OBJDIR)/$(pattern),$(tests) $(allexamples)))
580
581# Test core libCEED
582test : $(matched:$(OBJDIR)/%=run-%)
583
584# Run test target in parallel
585tst : ;@$(MAKE) $(MFLAGS) V=$(V) test
586# CPU C tests only for backend %
587ctc-% : $(ctests);@$(foreach tst,$(ctests),$(tst) /cpu/$*;)
588
589prove : $(matched)
590	$(info Testing backends: $(BACKENDS))
591	$(PROVE) $(PROVE_OPTS) --exec 'tests/tap.sh' $(matched:$(OBJDIR)/%=%)
592# Run prove target in parallel
593prv : ;@$(MAKE) $(MFLAGS) V=$(V) prove
594
595prove-all :
596	+$(MAKE) prove realsearch=%
597
598junit-% : $(OBJDIR)/%
599	@printf "  %10s %s\n" TEST $(<:$(OBJDIR)/%=%); $(PYTHON) tests/junit.py $(<:$(OBJDIR)/%=%)
600
601junit : $(matched:$(OBJDIR)/%=junit-%)
602
603all: $(alltests)
604
605examples : $(allexamples)
606ceedexamples : $(examples)
607nekexamples : $(nekexamples)
608mfemexamples : $(mfemexamples)
609petscexamples : $(petscexamples)
610
611# Benchmarks
612allbenchmarks = petsc-bps
613bench_targets = $(addprefix bench-,$(allbenchmarks))
614.PHONY: $(bench_targets) benchmarks
615$(bench_targets): bench-%: $(OBJDIR)/%
616	cd benchmarks && ./benchmark.sh --ceed "$(BACKENDS_MAKE)" -r $(*).sh
617benchmarks: $(bench_targets)
618
619$(ceed.pc) : pkgconfig-prefix = $(abspath .)
620$(OBJDIR)/ceed.pc : pkgconfig-prefix = $(prefix)
621.INTERMEDIATE : $(OBJDIR)/ceed.pc
622%/ceed.pc : ceed.pc.template | $$(@D)/.DIR
623	@$(SED) \
624	    -e "s:%prefix%:$(pkgconfig-prefix):" \
625	    -e "s:%libs_private%:$(pkgconfig-libs-private):" $< > $@
626
627ifeq ($(filter install,$(MAKECMDGOALS)),install)
628  $(OBJDIR)/interface/ceed-jit-source-root-default.o : CPPFLAGS += -DCEED_JIT_SOUCE_ROOT_DEFAULT="\"$(abspath $(includedir))/\""
629else
630  $(OBJDIR)/interface/ceed-jit-source-root-default.o : CPPFLAGS += -DCEED_JIT_SOUCE_ROOT_DEFAULT="\"$(abspath ./include)/\""
631endif
632
633$(OBJDIR)/interface/ceed-jit-source-root-default.o : $(if $(filter install,$(MAKECMDGOALS)),.FORCE)
634
635.FORCE:
636
637install : $(libceed) $(OBJDIR)/ceed.pc
638	$(INSTALL) -d $(addprefix $(if $(DESTDIR),"$(DESTDIR)"),"$(includedir)"\
639	  "$(includedir)/ceed/" "$(includedir)/ceed/jit-source/"\
640	  "$(includedir)/ceed/jit-source/cuda/" "$(includedir)/ceed/jit-source/hip/"\
641	  "$(includedir)/ceed/jit-source/gallery/" "$(libdir)" "$(pkgconfigdir)")
642	$(INSTALL_DATA) include/ceed/ceed.h "$(DESTDIR)$(includedir)/ceed/"
643	$(INSTALL_DATA) include/ceed/ceed-f32.h "$(DESTDIR)$(includedir)/ceed/"
644	$(INSTALL_DATA) include/ceed/ceed-f64.h "$(DESTDIR)$(includedir)/ceed/"
645	$(INSTALL_DATA) include/ceed/fortran.h "$(DESTDIR)$(includedir)/ceed/"
646	$(INSTALL_DATA) include/ceed/backend.h "$(DESTDIR)$(includedir)/ceed/"
647	$(INSTALL_DATA) include/ceed/cuda.h "$(DESTDIR)$(includedir)/ceed/"
648	$(INSTALL_DATA) include/ceed/hip.h "$(DESTDIR)$(includedir)/ceed/"
649	$(INSTALL_DATA) include/ceed/hash.h "$(DESTDIR)$(includedir)/ceed/"
650	$(INSTALL_DATA) include/ceed/khash.h "$(DESTDIR)$(includedir)/ceed/"
651	$(INSTALL_DATA) $(libceed) "$(DESTDIR)$(libdir)/"
652	$(INSTALL_DATA) $(OBJDIR)/ceed.pc "$(DESTDIR)$(pkgconfigdir)/"
653	$(INSTALL_DATA) include/ceed.h "$(DESTDIR)$(includedir)/"
654	$(INSTALL_DATA) include/ceedf.h "$(DESTDIR)$(includedir)/"
655	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/cuda/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/cuda/"
656	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/hip/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/hip/"
657	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/gallery/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/gallery/"
658
659.PHONY : all cln clean doxygen doc lib install par print test tst prove prv prove-all junit examples style style-c style-py tidy iwyu info info-backends info-backends-all
660
661cln clean :
662	$(RM) -r $(OBJDIR) $(LIBDIR) dist *egg* .pytest_cache *cffi*
663	$(call quiet,MAKE) -C examples clean NEK5K_DIR="$(abspath $(NEK5K_DIR))"
664	$(call quiet,MAKE) -C python/tests clean
665	$(RM) benchmarks/*output.txt
666
667distclean : clean
668	$(RM) -r doc/html doc/sphinx/build $(CONFIG)
669
670DOXYGEN ?= doxygen
671doxygen :
672	$(DOXYGEN) -q Doxyfile
673
674doc-html doc-latexpdf doc-epub doc-livehtml : doc-% : doxygen
675	make -C doc/sphinx $*
676
677doc : doc-html
678
679style-c :
680	@astyle --options=.astylerc \
681          $(filter-out include/ceedf.h $(wildcard tests/t*-f.h), \
682            $(wildcard include/*.h interface/*.[ch] tests/*.[ch] backends/*/*.[ch] \
683              examples/*/*/*.[ch] examples/*/*.[ch] examples/*/*.[ch]pp gallery/*/*.[ch]))
684
685AUTOPEP8 = autopep8
686style-py : AUTOPEP8_ARGS = --in-place --aggressive
687style-py :
688	@$(AUTOPEP8) $(AUTOPEP8_ARGS) $(wildcard *.py python**/*.py python/tests/*.py examples**/*.py doc/sphinx/source**/*.py benchmarks/*.py)
689
690style : style-c style-py
691
692CLANG_TIDY ?= clang-tidy
693
694%.c.tidy : %.c
695	$(CLANG_TIDY) $(TIDY_OPTS) $^ -- $(CPPFLAGS) --std=c99 -I$(CUDA_DIR)/include -I$(HIP_DIR)/include
696
697%.cpp.tidy : %.cpp
698	$(CLANG_TIDY) $(TIDY_OPTS) $^ -- $(CPPFLAGS) --std=c++11 -I$(CUDA_DIR)/include -I$(OCCA_DIR)/include -I$(HIP_DIR)/include
699
700tidy_c   : $(libceed.c:%=%.tidy)
701tidy_cpp : $(libceed.cpp:%=%.tidy)
702
703tidy : tidy_c tidy_cpp
704
705ifneq ($(wildcard ../iwyu/*),)
706  IWYU_DIR ?= ../iwyu
707  IWYU_CC  ?= $(IWYU_DIR)/build/bin/include-what-you-use
708endif
709
710iwyu : CC=$(IWYU_CC)
711iwyu : lib
712
713print :
714	@echo $(VAR)=$($(VAR))
715
716print-% :
717	$(info [ variable name]: $*)
718	$(info [        origin]: $(origin $*))
719	$(info [        flavor]: $(flavor $*))
720	$(info [         value]: $(value $*))
721	$(info [expanded value]: $($*))
722	$(info )
723	@true
724
725# "make configure" detects any variables passed on the command line or
726# previously set in config.mk, caching them in config.mk as simple
727# (:=) variables.  Variables set in config.mk or on the command line
728# take precedence over the defaults provided in the file.  Typical
729# usage:
730#
731#   make configure CC=/path/to/my/cc CUDA_DIR=/opt/cuda
732#   make
733#   make prove
734#
735# The values in the file can be updated by passing them on the command
736# line, e.g.,
737#
738#   make configure CC=/path/to/other/clang
739
740# All variables to consider for caching
741CONFIG_VARS = CC CXX FC NVCC NVCC_CXX HIPCC \
742	OPT CFLAGS CPPFLAGS CXXFLAGS FFLAGS NVCCFLAGS HIPCCFLAGS \
743	AR ARFLAGS LDFLAGS LDLIBS LIBCXX SED \
744	MAGMA_DIR OCCA_DIR XSMM_DIR CUDA_DIR CUDA_ARCH MFEM_DIR PETSC_DIR NEK5K_DIR HIP_DIR HIP_ARCH
745
746# $(call needs_save,CFLAGS) returns true (a nonempty string) if CFLAGS
747# was set on the command line or in config.mk (where it will appear as
748# a simple variable).
749needs_save = $(or $(filter command line,$(origin $(1))),$(filter simple,$(flavor $(1))))
750
751configure :
752	$(file > $(CONFIG))
753	$(foreach v,$(CONFIG_VARS),$(if $(call needs_save,$(v)),$(file >> $(CONFIG),$(v) := $($(v)))))
754	@echo "Configuration cached in $(CONFIG):"
755	@cat $(CONFIG)
756
757wheel : export MARCHFLAG = -march=generic
758wheel : export WHEEL_PLAT = manylinux2010_x86_64
759wheel :
760	docker run -it --user $(shell id -u):$(shell id -g) --rm -v $(PWD):/io -w /io \
761		-e MARCHFLAG -e WHEEL_PLAT \
762		quay.io/pypa/$(WHEEL_PLAT) python/make-wheels.sh
763
764.PHONY : configure wheel
765
766# Include *.d deps when not -B = --always-make: useful if the paths are wonky in a container
767-include $(if $(filter B,$(MAKEFLAGS)),,$(libceed.c:%.c=$(OBJDIR)/%.d) $(tests.c:tests/%.c=$(OBJDIR)/%.d))
768