xref: /libCEED/Makefile (revision 8baf801d73b4af53c6a6591441c9a2d5a4ea04b6)
1# Copyright (c) 2017-2024, 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
8# ------------------------------------------------------------
9# Configuration
10# ------------------------------------------------------------
11
12# config.mk stores cached configuration variables
13CONFIG ?= config.mk
14-include $(CONFIG)
15
16# common.mk holds definitions used in various makefiles throughout the project
17COMMON ?= common.mk
18-include $(COMMON)
19
20# Quiet, color output
21quiet ?= $($(1))
22
23# Cancel built-in and old-fashioned implicit rules which we don't use
24.SUFFIXES:
25
26.SECONDEXPANSION: # to expand $$(@D)/.DIR
27
28%/.DIR :
29	@mkdir -p $(@D)
30	@touch $@
31
32.PRECIOUS: %/.DIR
33
34
35# ------------------------------------------------------------
36# Root directories for backend dependencies
37# ------------------------------------------------------------
38
39# XSMM_DIR env variable should point to XSMM main (github.com/hfp/libxsmm)
40XSMM_DIR ?= ../libxsmm
41
42# Often /opt/cuda or /usr/local/cuda, but sometimes present on machines that don't support CUDA
43CUDA_DIR  ?=
44CUDA_ARCH ?=
45
46# Often /opt/rocm, but sometimes present on machines that don't support HIP
47ROCM_DIR ?=
48HIP_ARCH ?=
49
50# env variable MAGMA_DIR can be used too
51MAGMA_DIR ?= ../magma
52
53# OCCA_DIR env variable should point to OCCA main (github.com/libocca/occa)
54OCCA_DIR ?= ../occa/install
55
56
57# ------------------------------------------------------------
58# Compiler flags
59# ------------------------------------------------------------
60
61# Detect user compiler options and set defaults
62ifeq (,$(filter-out undefined default,$(origin CC)))
63  CC = gcc
64endif
65ifeq (,$(filter-out undefined default,$(origin CXX)))
66  CXX = g++
67endif
68ifeq (,$(filter-out undefined default,$(origin FC)))
69  FC = gfortran
70endif
71ifeq (,$(filter-out undefined default,$(origin LINK)))
72  LINK = $(CC)
73endif
74ifeq (,$(filter-out undefined default,$(origin AR)))
75  AR = ar
76endif
77ifeq (,$(filter-out undefined default,$(origin ARFLAGS)))
78  ARFLAGS = crD
79endif
80NVCC ?= $(CUDA_DIR)/bin/nvcc
81NVCC_CXX ?= $(CXX)
82HIPCC ?= $(ROCM_DIR)/bin/hipcc
83SYCLCXX ?= $(CXX)
84SED ?= sed
85ifneq ($(EMSCRIPTEN),)
86  STATIC = 1
87  EXE_SUFFIX = .wasm
88  EM_LDFLAGS = -s TOTAL_MEMORY=256MB
89endif
90
91# ASAN must be left empty if you don't want to use it
92ASAN ?=
93
94# These are the values automatically detected here in the makefile. They are
95# augmented with LDFLAGS and LDLIBS from the environment/passed by command line,
96# if any. If the user sets CEED_LDFLAGS or CEED_LDLIBS, they are used *instead
97# of* what we populate here (thus that's advanced usage and not recommended).
98CEED_LDFLAGS ?=
99CEED_LDLIBS  ?=
100
101UNDERSCORE ?= 1
102
103# Verbose mode, V or VERBOSE
104V ?= $(VERBOSE)
105
106# Warning: SANTIZ options still don't run with /gpu/occa
107AFLAGS ?= -fsanitize=address #-fsanitize=undefined -fno-omit-frame-pointer
108
109# Note: Intel oneAPI C/C++ compiler is now icx/icpx
110CC_VENDOR := $(firstword $(filter gcc (GCC) clang icc icc_orig oneAPI XL emcc,$(subst -, ,$(shell $(CC) --version))))
111CC_VENDOR := $(subst (GCC),gcc,$(subst icc_orig,icc,$(CC_VENDOR)))
112FC_VENDOR := $(if $(FC),$(firstword $(filter GNU ifort ifx XL,$(shell $(FC) --version 2>&1 || $(FC) -qversion))))
113
114# Default extra flags by vendor
115MARCHFLAG.gcc           := -march=native
116MARCHFLAG.clang         := $(MARCHFLAG.gcc)
117MARCHFLAG.icc           :=
118MARCHFLAG.oneAPI        := $(MARCHFLAG.clang)
119OMP_SIMD_FLAG.gcc       := -fopenmp-simd
120OMP_SIMD_FLAG.clang     := $(OMP_SIMD_FLAG.gcc)
121OMP_SIMD_FLAG.icc       := -qopenmp-simd
122OMP_SIMD_FLAG.oneAPI    := $(OMP_SIMD_FLAG.icc)
123OMP_FLAG.gcc            := -fopenmp
124OMP_FLAG.clang          := $(OMP_FLAG.gcc)
125OMP_FLAG.icc            := -qopenmp
126OMP_FLAG.oneAPI         := $(OMP_FLAG.icc)
127SYCL_FLAG.gcc           :=
128SYCL_FLAG.clang         := -fsycl
129SYCL_FLAG.icc           :=
130SYCL_FLAG.oneAPI        := -fsycl -fno-sycl-id-queries-fit-in-int
131OPT.gcc                 := -g -ffp-contract=fast
132OPT.clang               := $(OPT.gcc)
133OPT.icc                 := $(OPT.gcc)
134OPT.oneAPI              := $(OPT.clang)
135OPT.emcc                :=
136CFLAGS.gcc              := $(if $(STATIC),,-fPIC) -std=c99 -Wall -Wextra -Wno-unused-parameter -MMD -MP
137CFLAGS.clang            := $(CFLAGS.gcc)
138CFLAGS.icc              := $(CFLAGS.gcc)
139CFLAGS.oneAPI           := $(CFLAGS.clang)
140CFLAGS.XL               := $(if $(STATIC),,-qpic) -MMD
141CFLAGS.emcc             := $(CFLAGS.clang)
142CXXFLAGS.gcc            := $(if $(STATIC),,-fPIC) -std=c++11 -Wall -Wextra -Wno-unused-parameter -MMD -MP
143CXXFLAGS.clang          := $(CXXFLAGS.gcc)
144CXXFLAGS.icc            := $(CXXFLAGS.gcc)
145CXXFLAGS.oneAPI         := $(CXXFLAGS.clang)
146CXXFLAGS.XL             := $(if $(STATIC),,-qpic) -std=c++11 -MMD
147CXXFLAGS.emcc           := $(CXXFLAGS.clang)
148FFLAGS.GNU              := $(if $(STATIC),,-fPIC) -cpp -Wall -Wextra -Wno-unused-parameter -Wno-unused-dummy-argument -MMD -MP
149FFLAGS.ifort            := $(if $(STATIC),,-fPIC) -cpp
150FFLAGS.ifx              := $(FFLAGS.ifort)
151FFLAGS.XL               := $(if $(STATIC),,-qpic) -ffree-form -qpreprocess -qextname -MMD
152
153# This check works with compilers that use gcc and clang.  It fails with some
154# compilers; e.g., xlc apparently ignores all options when -E is passed, thus
155# succeeds with any flags.  Users can pass MARCHFLAG=... if desired.
156cc_check_flag = $(shell $(CC) -E -Werror $(1) -x c /dev/null > /dev/null 2>&1 && echo 1)
157MARCHFLAG := $(MARCHFLAG.$(CC_VENDOR))
158MARCHFLAG := $(if $(call cc_check_flag,$(MARCHFLAG)),$(MARCHFLAG),-mcpu=native)
159MARCHFLAG := $(if $(call cc_check_flag,$(MARCHFLAG)),$(MARCHFLAG))
160
161OMP_SIMD_FLAG := $(OMP_SIMD_FLAG.$(CC_VENDOR))
162OMP_SIMD_FLAG := $(if $(call cc_check_flag,$(OMP_SIMD_FLAG)),$(OMP_SIMD_FLAG))
163
164# Error checking flags
165PEDANTIC      ?=
166PEDANTICFLAGS ?= -Werror -pedantic
167
168# Compiler flags
169OPT    ?= -O $(MARCHFLAG) $(OPT.$(CC_VENDOR)) $(OMP_SIMD_FLAG)
170CFLAGS ?= $(OPT) $(CFLAGS.$(CC_VENDOR)) $(if $(PEDANTIC),$(PEDANTICFLAGS))
171CXXFLAGS ?= $(OPT) $(CXXFLAGS.$(CC_VENDOR)) $(if $(PEDANTIC),$(PEDANTICFLAGS))
172FFLAGS ?= $(OPT) $(FFLAGS.$(FC_VENDOR))
173LIBCXX ?= -lstdc++
174NVCCFLAGS ?= -ccbin $(CXX) -Xcompiler "$(OPT)" -Xcompiler -fPIC
175ifneq ($(CUDA_ARCH),)
176  NVCCFLAGS += -arch=$(CUDA_ARCH)
177endif
178HIPCCFLAGS ?= $(filter-out $(OMP_SIMD_FLAG),$(OPT)) -fPIC -munsafe-fp-atomics
179ifneq ($(HIP_ARCH),)
180  HIPCCFLAGS += --offload-arch=$(HIP_ARCH)
181endif
182SYCL_FLAG := $(SYCL_FLAG.$(CC_VENDOR))
183SYCLFLAGS ?= $(SYCL_FLAG) -fPIC -std=c++17 $(filter-out -std=c++11,$(CXXFLAGS)) $(filter-out $(OMP_SIMD_FLAG),$(OPT))
184
185OPENMP ?=
186ifneq ($(OPENMP),)
187  OMP_FLAG := $(OMP_FLAG.$(CC_VENDOR))
188  OMP_FLAG := $(if $(call cc_check_flag,$(OMP_FLAG)),$(OMP_FLAG))
189  CFLAGS += $(OMP_FLAG)
190  CEED_LDFLAGS += $(OMP_FLAG)
191endif
192
193ifeq ($(COVERAGE), 1)
194  CFLAGS += --coverage
195  CXXFLAGS += --coverage
196  CEED_LDFLAGS += --coverage
197endif
198
199CFLAGS += $(if $(ASAN),$(AFLAGS))
200FFLAGS += $(if $(ASAN),$(AFLAGS))
201CEED_LDFLAGS += $(if $(ASAN),$(AFLAGS))
202CPPFLAGS += -I./include
203CEED_LDLIBS = -lm
204OBJDIR := build
205for_install := $(filter install,$(MAKECMDGOALS))
206LIBDIR := $(if $(for_install),$(OBJDIR),lib)
207
208# Installation variables
209prefix ?= /usr/local
210bindir = $(prefix)/bin
211libdir = $(prefix)/lib
212includedir = $(prefix)/include
213pkgconfigdir = $(libdir)/pkgconfig
214INSTALL = install
215INSTALL_PROGRAM = $(INSTALL)
216INSTALL_DATA = $(INSTALL) -m644
217
218# Get number of processors of the machine
219NPROCS := $(shell getconf _NPROCESSORS_ONLN)
220# prepare make options to run in parallel
221MFLAGS := -j $(NPROCS) --warn-undefined-variables \
222                       --no-print-directory --no-keep-going
223
224PYTHON ?= python3
225PROVE ?= prove
226PROVE_OPTS ?= -j $(NPROCS)
227DARWIN := $(filter Darwin,$(shell uname -s))
228SO_EXT := $(if $(DARWIN),dylib,so)
229
230ceed.pc := $(LIBDIR)/pkgconfig/ceed.pc
231libceed.so := $(LIBDIR)/libceed.$(SO_EXT)
232libceed.a := $(LIBDIR)/libceed.a
233libceed := $(if $(STATIC),$(libceed.a),$(libceed.so))
234CEED_LIBS = -lceed
235libceeds = $(libceed)
236BACKENDS_BUILTIN := /cpu/self/ref/serial /cpu/self/ref/blocked /cpu/self/opt/serial /cpu/self/opt/blocked
237BACKENDS_MAKE := $(BACKENDS_BUILTIN)
238
239
240# ------------------------------------------------------------
241# Root directories for examples using external libraries
242# ------------------------------------------------------------
243
244# DEAL_II_DIR env variable should point to sibling directory
245ifneq ($(wildcard ../dealii/install/lib/libdeal_II.*),)
246  DEAL_II_DIR ?= ../dealii/install
247endif
248# Export for deal.II testing
249export DEAL_II_DIR
250
251# MFEM_DIR env variable should point to sibling directory
252ifneq ($(wildcard ../mfem/libmfem.*),)
253  MFEM_DIR ?= ../mfem
254endif
255
256# NEK5K_DIR env variable should point to sibling directory
257ifneq ($(wildcard ../Nek5000/*),)
258  NEK5K_DIR ?= $(abspath ../Nek5000)
259endif
260# Exports for NEK5K testing
261export CEED_DIR = $(abspath .)
262export NEK5K_DIR
263MPI ?= 1
264
265# Check for PETSc in ../petsc
266ifneq ($(wildcard ../petsc/lib/libpetsc.*),)
267  PETSC_DIR ?= ../petsc
268endif
269
270# ------------------------------------------------------------
271# Build the library (default target)
272# ------------------------------------------------------------
273
274lib: $(libceed) $(ceed.pc)
275# run 'lib' target in parallel
276par:;@$(MAKE) $(MFLAGS) V=$(V) lib
277
278$(libceed.so) : CEED_LDFLAGS += $(if $(DARWIN), -install_name @rpath/$(notdir $(libceed.so)))
279
280# ------------------------------------------------------------
281# Source files
282# ------------------------------------------------------------
283
284# Interface and gallery
285libceed.c := $(filter-out interface/ceed-cuda.c interface/ceed-hip.c interface/ceed-jit-source-root-$(if $(for_install),default,install).c, $(wildcard interface/ceed*.c backends/*.c gallery/*.c))
286gallery.c := $(wildcard gallery/*/ceed*.c)
287libceed.c += $(gallery.c)
288
289# Backends
290# - CPU
291ref.c          := $(sort $(wildcard backends/ref/*.c))
292blocked.c      := $(sort $(wildcard backends/blocked/*.c))
293ceedmemcheck.c := $(sort $(wildcard backends/memcheck/*.c))
294opt.c          := $(sort $(wildcard backends/opt/*.c))
295avx.c          := $(sort $(wildcard backends/avx/*.c))
296xsmm.c         := $(sort $(wildcard backends/xsmm/*.c))
297# - GPU
298cuda.c         := $(sort $(wildcard backends/cuda/*.c))
299cuda.cpp       := $(sort $(wildcard backends/cuda/*.cpp))
300cuda-ref.c     := $(sort $(wildcard backends/cuda-ref/*.c))
301cuda-ref.cpp   := $(sort $(wildcard backends/cuda-ref/*.cpp))
302cuda-ref.cu    := $(sort $(wildcard backends/cuda-ref/kernels/*.cu))
303cuda-shared.c  := $(sort $(wildcard backends/cuda-shared/*.c))
304cuda-shared.cu := $(sort $(wildcard backends/cuda-shared/kernels/*.cu))
305cuda-gen.c     := $(sort $(wildcard backends/cuda-gen/*.c))
306cuda-gen.cpp   := $(sort $(wildcard backends/cuda-gen/*.cpp))
307cuda-gen.cu    := $(sort $(wildcard backends/cuda-gen/kernels/*.cu))
308hip.c          := $(sort $(wildcard backends/hip/*.c))
309hip.cpp        := $(sort $(wildcard backends/hip/*.cpp))
310hip-ref.c      := $(sort $(wildcard backends/hip-ref/*.c))
311hip-ref.cpp    := $(sort $(wildcard backends/hip-ref/*.cpp))
312hip-ref.hip    := $(sort $(wildcard backends/hip-ref/kernels/*.hip.cpp))
313hip-shared.c   := $(sort $(wildcard backends/hip-shared/*.c))
314hip-gen.c      := $(sort $(wildcard backends/hip-gen/*.c))
315hip-gen.cpp    := $(sort $(wildcard backends/hip-gen/*.cpp))
316sycl-core.cpp  := $(sort $(wildcard backends/sycl/*.sycl.cpp))
317sycl-ref.cpp   := $(sort $(wildcard backends/sycl-ref/*.sycl.cpp))
318sycl-shared.cpp:= $(sort $(wildcard backends/sycl-shared/*.sycl.cpp))
319sycl-gen.cpp   := $(sort $(wildcard backends/sycl-gen/*.sycl.cpp))
320magma.c        := $(sort $(wildcard backends/magma/*.c))
321magma.cpp      := $(sort $(wildcard backends/magma/*.cpp))
322occa.cpp       := $(sort $(shell find backends/occa -type f -name *.cpp))
323
324hip-all.c   := interface/ceed-hip.c $(hip.c) $(hip-ref.c) $(hip-shared.c) $(hip-gen.c)
325hip-all.cpp := $(hip.cpp) $(hip-ref.cpp) $(hip-gen.cpp)
326
327# Tests
328tests.c := $(sort $(wildcard tests/t[0-9][0-9][0-9]-*.c))
329tests.f := $(if $(FC),$(sort $(wildcard tests/t[0-9][0-9][0-9]-*.f90)))
330tests   := $(tests.c:tests/%.c=$(OBJDIR)/%$(EXE_SUFFIX))
331ctests  := $(tests)
332tests   += $(tests.f:tests/%.f90=$(OBJDIR)/%$(EXE_SUFFIX))
333
334# Examples
335examples.c := $(sort $(wildcard examples/ceed/*.c))
336examples.f := $(if $(FC),$(sort $(wildcard examples/ceed/*.f)))
337examples   := $(examples.c:examples/ceed/%.c=$(OBJDIR)/%$(EXE_SUFFIX))
338examples   += $(examples.f:examples/ceed/%.f=$(OBJDIR)/%$(EXE_SUFFIX))
339
340# deal.II Examples
341dealiiexamples := $(OBJDIR)/dealii-bps
342
343# MFEM Examples
344mfemexamples.cpp := $(sort $(wildcard examples/mfem/*.cpp))
345mfemexamples     := $(mfemexamples.cpp:examples/mfem/%.cpp=$(OBJDIR)/mfem-%)
346
347# Nek5K Examples
348nekexamples := $(OBJDIR)/nek-bps
349
350# PETSc Examples
351petscexamples.c := $(wildcard examples/petsc/*.c)
352petscexamples   := $(petscexamples.c:examples/petsc/%.c=$(OBJDIR)/petsc-%)
353
354# Fluid Dynamics Example
355fluidsexamples.c := $(sort $(wildcard examples/fluids/*.c))
356fluidsexamples   := $(fluidsexamples.c:examples/fluids/%.c=$(OBJDIR)/fluids-%)
357
358# Solid Mechanics Example
359solidsexamples.c := $(sort $(wildcard examples/solids/*.c))
360solidsexamples   := $(solidsexamples.c:examples/solids/%.c=$(OBJDIR)/solids-%)
361
362
363# ------------------------------------------------------------
364# View configuration options
365# ------------------------------------------------------------
366
367backend_status = $(if $(filter $1,$(BACKENDS_MAKE)), [backends: $1], [not found])
368
369info:
370	$(info ------------------------------------)
371	$(info CC            = $(CC))
372	$(info CXX           = $(CXX))
373	$(info FC            = $(FC))
374	$(info CPPFLAGS      = $(CPPFLAGS))
375	$(info CFLAGS        = $(CFLAGS))
376	$(info CXXFLAGS      = $(CXXFLAGS))
377	$(info FFLAGS        = $(FFLAGS))
378	$(info NVCCFLAGS     = $(NVCCFLAGS))
379	$(info HIPCCFLAGS    = $(HIPCCFLAGS))
380	$(info SYCLFLAGS     = $(SYCLFLAGS))
381	$(info CEED_LDFLAGS  = $(CEED_LDFLAGS))
382	$(info CEED_LDLIBS   = $(CEED_LDLIBS))
383	$(info AR            = $(AR))
384	$(info ARFLAGS       = $(ARFLAGS))
385	$(info OPT           = $(OPT))
386	$(info AFLAGS        = $(AFLAGS))
387	$(info ASAN          = $(or $(ASAN),(empty)))
388	$(info VERBOSE       = $(or $(V),(empty)) [verbose=$(if $(V),on,off)])
389	$(info ------------------------------------)
390	$(info MEMCHK_STATUS = $(MEMCHK_STATUS)$(call backend_status,$(MEMCHK_BACKENDS)))
391	$(info AVX_STATUS    = $(AVX_STATUS)$(call backend_status,$(AVX_BACKENDS)))
392	$(info XSMM_DIR      = $(XSMM_DIR)$(call backend_status,$(XSMM_BACKENDS)))
393	$(info OCCA_DIR      = $(OCCA_DIR)$(call backend_status,$(OCCA_BACKENDS)))
394	$(info MAGMA_DIR     = $(MAGMA_DIR)$(call backend_status,$(MAGMA_BACKENDS)))
395	$(info CUDA_DIR      = $(CUDA_DIR)$(call backend_status,$(CUDA_BACKENDS)))
396	$(info ROCM_DIR      = $(ROCM_DIR)$(call backend_status,$(HIP_BACKENDS)))
397	$(info SYCL_DIR      = $(SYCL_DIR)$(call backend_status,$(SYCL_BACKENDS)))
398	$(info ------------------------------------)
399	$(info MFEM_DIR      = $(MFEM_DIR))
400	$(info NEK5K_DIR     = $(NEK5K_DIR))
401	$(info PETSC_DIR     = $(PETSC_DIR))
402	$(info DEAL_II_DIR   = $(DEAL_II_DIR))
403	$(info ------------------------------------)
404	$(info prefix        = $(prefix))
405	$(info includedir    = $(value includedir))
406	$(info libdir        = $(value libdir))
407	$(info pkgconfigdir  = $(value pkgconfigdir))
408	$(info ------------------------------------)
409	@true
410
411info-backends:
412	$(info make: 'lib' with optional backends: $(filter-out $(BACKENDS_BUILTIN),$(BACKENDS)))
413	@true
414
415info-backends-all:
416	$(info make: 'lib' with backends: $(BACKENDS))
417	@true
418
419
420# ------------------------------------------------------------
421# Backends
422# ------------------------------------------------------------
423
424# Standard Backends
425libceed.c += $(ref.c)
426libceed.c += $(blocked.c)
427libceed.c += $(opt.c)
428
429# Memcheck Backends
430MEMCHK_STATUS   = Disabled
431MEMCHK         := $(shell echo "$(HASH)include <valgrind/memcheck.h>" | $(CC) $(CPPFLAGS) -E - >/dev/null 2>&1 && echo 1)
432MEMCHK_BACKENDS = /cpu/self/memcheck/serial /cpu/self/memcheck/blocked
433ifeq ($(MEMCHK),1)
434  MEMCHK_STATUS = Enabled
435  libceed.c += $(ceedmemcheck.c)
436  BACKENDS_MAKE += $(MEMCHK_BACKENDS)
437endif
438
439# AVX Backeds
440AVX_STATUS   = Disabled
441AVX_FLAG    := $(if $(filter clang,$(CC_VENDOR)),+avx,-mavx)
442AVX         := $(filter $(AVX_FLAG),$(shell $(CC) $(CFLAGS:-M%=) -v -E -x c /dev/null 2>&1))
443AVX_BACKENDS = /cpu/self/avx/serial /cpu/self/avx/blocked
444ifneq ($(AVX),)
445  AVX_STATUS = Enabled
446  libceed.c += $(avx.c)
447  BACKENDS_MAKE += $(AVX_BACKENDS)
448endif
449
450# Collect list of libraries and paths for use in linking and pkg-config
451PKG_LIBS =
452# Stubs that will not be RPATH'd
453PKG_STUBS_LIBS =
454
455# libXSMM Backends
456XSMM_BACKENDS = /cpu/self/xsmm/serial /cpu/self/xsmm/blocked
457ifneq ($(wildcard $(XSMM_DIR)/lib/libxsmm.*),)
458  PKG_LIBS += -L$(abspath $(XSMM_DIR))/lib -lxsmm
459  MKL ?=
460  ifeq (,$(MKL)$(MKLROOT))
461    BLAS_LIB ?= -lblas -ldl
462  else
463    ifneq ($(MKLROOT),)
464      # Some installs put everything inside an intel64 subdirectory, others not
465      MKL_LIBDIR = $(dir $(firstword $(wildcard $(MKLROOT)/lib/intel64/libmkl_sequential.* $(MKLROOT)/lib/libmkl_sequential.*)))
466      MKL_LINK = -L$(MKL_LIBDIR)
467    endif
468    BLAS_LIB ?= $(MKL_LINK) -Wl,--push-state,--no-as-needed -lmkl_intel_lp64 -lmkl_sequential -lmkl_core -lpthread -lm -ldl -Wl,--pop-state
469  endif
470  PKG_LIBS += $(BLAS_LIB)
471  libceed.c += $(xsmm.c)
472  $(xsmm.c:%.c=$(OBJDIR)/%.o) $(xsmm.c:%=%.tidy) : CPPFLAGS += -I$(XSMM_DIR)/include
473  BACKENDS_MAKE += $(XSMM_BACKENDS)
474endif
475
476# CUDA Backends
477ifneq ($(CUDA_DIR),)
478  CUDA_LIB_DIR := $(wildcard $(foreach d,lib lib64 lib/x86_64-linux-gnu,$(CUDA_DIR)/$d/libcudart.${SO_EXT}))
479  CUDA_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(CUDA_LIB_DIR))))
480endif
481CUDA_LIB_DIR_STUBS := $(CUDA_LIB_DIR)/stubs
482CUDA_BACKENDS = /gpu/cuda/ref /gpu/cuda/shared /gpu/cuda/gen
483ifneq ($(CUDA_LIB_DIR),)
484  $(libceeds) : CPPFLAGS += -I$(CUDA_DIR)/include
485  PKG_LIBS += -L$(abspath $(CUDA_LIB_DIR)) -lcudart -lnvrtc -lcuda -lcublas
486  PKG_STUBS_LIBS += -L$(CUDA_LIB_DIR_STUBS)
487  LIBCEED_CONTAINS_CXX = 1
488  libceed.c     += interface/ceed-cuda.c
489  libceed.c     += $(cuda.c) $(cuda-ref.c) $(cuda-shared.c) $(cuda-gen.c)
490  libceed.cpp   += $(cuda.cpp) $(cuda-ref.cpp) $(cuda-gen.cpp)
491  libceed.cu    += $(cuda-ref.cu) $(cuda-shared.cu) $(cuda-gen.cu)
492  BACKENDS_MAKE += $(CUDA_BACKENDS)
493endif
494
495# HIP Backends
496HIP_LIB_DIR := $(wildcard $(foreach d,lib lib64,$(ROCM_DIR)/$d/libamdhip64.${SO_EXT}))
497HIP_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(HIP_LIB_DIR))))
498HIP_BACKENDS = /gpu/hip/ref /gpu/hip/shared /gpu/hip/gen
499ifneq ($(HIP_LIB_DIR),)
500  HIPCONFIG_CPPFLAGS := $(subst =,,$(shell $(ROCM_DIR)/bin/hipconfig -C))
501  $(hip-all.c:%.c=$(OBJDIR)/%.o) $(hip-all.c:%=%.tidy): CPPFLAGS += $(HIPCONFIG_CPPFLAGS)
502  ifneq ($(CXX), $(HIPCC))
503    $(hip-all.cpp:%.cpp=$(OBJDIR)/%.o) $(hip-all.cpp:%=%.tidy): CPPFLAGS += $(HIPCONFIG_CPPFLAGS)
504  endif
505  PKG_LIBS += -L$(abspath $(HIP_LIB_DIR)) -lamdhip64 -lhipblas
506  LIBCEED_CONTAINS_CXX = 1
507  libceed.c     += $(hip-all.c)
508  libceed.cpp   += $(hip-all.cpp)
509  libceed.hip   += $(hip-ref.hip)
510  BACKENDS_MAKE += $(HIP_BACKENDS)
511endif
512
513# SYCL Backends
514SYCL_BACKENDS = /gpu/sycl/ref /gpu/sycl/shared /gpu/sycl/gen
515ifneq ($(SYCL_DIR),)
516  SYCL_LIB_DIR := $(wildcard $(foreach d,lib lib64,$(SYCL_DIR)/$d/libsycl.${SO_EXT}))
517  SYCL_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(SYCL_LIB_DIR))))
518endif
519ifneq ($(SYCL_LIB_DIR),)
520  PKG_LIBS += $(SYCL_FLAG) -lze_loader
521  LIBCEED_CONTAINS_CXX = 1
522  libceed.sycl += $(sycl-core.cpp) $(sycl-ref.cpp) $(sycl-shared.cpp) $(sycl-gen.cpp)
523  BACKENDS_MAKE += $(SYCL_BACKENDS)
524endif
525
526# MAGMA Backends
527ifneq ($(wildcard $(MAGMA_DIR)/lib/libmagma.*),)
528  MAGMA_ARCH=$(shell nm -g $(MAGMA_DIR)/lib/libmagma.* | grep -c "hipblas")
529  ifeq ($(MAGMA_ARCH), 0)  # CUDA MAGMA
530    ifneq ($(CUDA_LIB_DIR),)
531      cuda_link = $(if $(STATIC),,-Wl,-rpath,$(CUDA_LIB_DIR)) -L$(CUDA_LIB_DIR) -lcublas -lcusparse -lcudart
532      omp_link = -fopenmp
533      magma_link_static = -L$(MAGMA_DIR)/lib -lmagma $(cuda_link) $(omp_link)
534      magma_link_shared = -L$(MAGMA_DIR)/lib $(if $(STATIC),,-Wl,-rpath,$(abspath $(MAGMA_DIR)/lib)) -lmagma
535      magma_link := $(if $(wildcard $(MAGMA_DIR)/lib/libmagma.${SO_EXT}),$(magma_link_shared),$(magma_link_static))
536      PKG_LIBS += $(magma_link)
537      libceed.c   += $(magma.c)
538      libceed.cpp += $(magma.cpp)
539      $(magma.c:%.c=$(OBJDIR)/%.o) $(magma.c:%=%.tidy) : CPPFLAGS += -DADD_ -I$(MAGMA_DIR)/include -I$(CUDA_DIR)/include
540      $(magma.cpp:%.cpp=$(OBJDIR)/%.o) $(magma.cpp:%=%.tidy) : CPPFLAGS += -DADD_ -I$(MAGMA_DIR)/include -I$(CUDA_DIR)/include
541      MAGMA_BACKENDS = /gpu/cuda/magma /gpu/cuda/magma/det
542    endif
543  else  # HIP MAGMA
544    ifneq ($(HIP_LIB_DIR),)
545      omp_link = -fopenmp
546      hip_link = $(if $(STATIC),,-Wl,-rpath,$(HIP_LIB_DIR)) -L$(HIP_LIB_DIR) -lhipblas -lhipsparse -lamdhip64
547      magma_link_static = -L$(MAGMA_DIR)/lib -lmagma $(hip_link) $(omp_link)
548      magma_link_shared = -L$(MAGMA_DIR)/lib $(hip_link) $(omp_link) $(if $(STATIC),,-Wl,-rpath,$(abspath $(MAGMA_DIR)/lib)) -lmagma
549      magma_link := $(if $(wildcard $(MAGMA_DIR)/lib/libmagma.${SO_EXT}),$(magma_link_shared),$(magma_link_static))
550      PKG_LIBS += $(magma_link)
551      libceed.c   += $(magma.c)
552      libceed.cpp += $(magma.cpp)
553      $(magma.c:%.c=$(OBJDIR)/%.o) $(magma.c:%=%.tidy) : CPPFLAGS += $(HIPCONFIG_CPPFLAGS) -I$(MAGMA_DIR)/include -I$(ROCM_DIR)/include -DCEED_MAGMA_USE_HIP -DADD_
554      $(magma.cpp:%.cpp=$(OBJDIR)/%.o) $(magma.cpp:%=%.tidy) : CPPFLAGS += $(HIPCONFIG_CPPFLAGS) -I$(MAGMA_DIR)/include -I$(ROCM_DIR)/include -DCEED_MAGMA_USE_HIP -DADD_
555      MAGMA_BACKENDS = /gpu/hip/magma /gpu/hip/magma/det
556    endif
557  endif
558  LIBCEED_CONTAINS_CXX = 1
559  BACKENDS_MAKE += $(MAGMA_BACKENDS)
560endif
561
562# OCCA Backends
563OCCA_BACKENDS = /cpu/self/occa
564ifneq ($(wildcard $(OCCA_DIR)/lib/libocca.*),)
565  OCCA_MODES := $(shell LD_LIBRARY_PATH=$(OCCA_DIR)/lib $(OCCA_DIR)/bin/occa modes)
566  OCCA_BACKENDS += $(if $(filter OpenMP,$(OCCA_MODES)),/cpu/openmp/occa)
567  OCCA_BACKENDS += $(if $(filter dpcpp,$(OCCA_MODES)),/gpu/dpcpp/occa)
568  OCCA_BACKENDS += $(if $(filter OpenCL,$(OCCA_MODES)),/gpu/opencl/occa)
569  OCCA_BACKENDS += $(if $(filter HIP,$(OCCA_MODES)),/gpu/hip/occa)
570  OCCA_BACKENDS += $(if $(filter CUDA,$(OCCA_MODES)),/gpu/cuda/occa)
571  $(libceeds) : CPPFLAGS += -I$(OCCA_DIR)/include
572  PKG_LIBS += -L$(abspath $(OCCA_DIR))/lib -locca
573  LIBCEED_CONTAINS_CXX = 1
574  libceed.cpp += $(occa.cpp)
575  BACKENDS_MAKE += $(OCCA_BACKENDS)
576endif
577
578BACKENDS ?= $(BACKENDS_MAKE)
579export BACKENDS
580
581
582# ------------------------------------------------------------
583# Linker Flags
584# ------------------------------------------------------------
585_pkg_ldflags = $(filter -L%,$(PKG_LIBS))
586_pkg_ldlibs = $(filter-out -L%,$(PKG_LIBS))
587$(libceeds) : CEED_LDFLAGS += $(_pkg_ldflags) $(if $(STATIC),,$(_pkg_ldflags:-L%=-Wl,-rpath,%)) $(PKG_STUBS_LIBS)
588$(libceeds) : CEED_LDLIBS += $(_pkg_ldlibs)
589ifeq ($(STATIC),1)
590  $(examples) $(tests) : CEED_LDFLAGS += $(EM_LDFLAGS) $(_pkg_ldflags) $(if $(STATIC),,$(_pkg_ldflags:-L%=-Wl,-rpath,%)) $(PKG_STUBS_LIBS)
591  $(examples) $(tests) : CEED_LDLIBS += $(_pkg_ldlibs)
592endif
593
594pkgconfig-libs-private = $(PKG_LIBS)
595ifeq ($(LIBCEED_CONTAINS_CXX),1)
596  $(libceeds) : LINK = $(CXX)
597  ifeq ($(STATIC),1)
598    $(examples) $(tests) : CEED_LDLIBS += $(LIBCXX)
599    pkgconfig-libs-private += $(LIBCXX)
600  endif
601endif
602
603
604# ------------------------------------------------------------
605# Building core library components
606# ------------------------------------------------------------
607
608# File names *-weak.c contain weak symbol definitions, which must be listed last
609# when creating shared or static libraries.
610weak_last = $(filter-out %-weak.o,$(1)) $(filter %-weak.o,$(1))
611
612libceed.o = $(libceed.c:%.c=$(OBJDIR)/%.o) $(libceed.cpp:%.cpp=$(OBJDIR)/%.o) $(libceed.cu:%.cu=$(OBJDIR)/%.o) $(libceed.hip:%.hip.cpp=$(OBJDIR)/%.o) $(libceed.sycl:%.sycl.cpp=$(OBJDIR)/%.o)
613$(filter %fortran.o,$(libceed.o)) : CPPFLAGS += $(if $(filter 1,$(UNDERSCORE)),-DUNDERSCORE)
614$(libceed.o): | info-backends
615$(libceed.so) : $(call weak_last,$(libceed.o)) | $$(@D)/.DIR
616	$(call quiet,LINK) $(LDFLAGS) $(CEED_LDFLAGS) -shared -o $@ $^ $(CEED_LDLIBS) $(LDLIBS)
617
618$(libceed.a) : $(call weak_last,$(libceed.o)) | $$(@D)/.DIR
619	$(call quiet,AR) $(ARFLAGS) $@ $^
620
621$(OBJDIR)/%.o : $(CURDIR)/%.c | $$(@D)/.DIR
622	$(call quiet,CC) $(CPPFLAGS) $(CFLAGS) -c -o $@ $(abspath $<)
623
624$(OBJDIR)/%.o : $(CURDIR)/%.cpp | $$(@D)/.DIR
625	$(call quiet,CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $(abspath $<)
626
627$(OBJDIR)/%.o : $(CURDIR)/%.cu | $$(@D)/.DIR
628	$(call quiet,NVCC) $(filter-out -Wno-unused-function, $(CPPFLAGS)) $(NVCCFLAGS) -c -o $@ $(abspath $<)
629
630$(OBJDIR)/%.o : $(CURDIR)/%.hip.cpp | $$(@D)/.DIR
631	$(call quiet,HIPCC) $(CPPFLAGS) $(HIPCCFLAGS) -c -o $@ $(abspath $<)
632
633$(OBJDIR)/%.o : $(CURDIR)/%.sycl.cpp | $$(@D)/.DIR
634	$(call quiet,SYCLCXX) $(SYCLFLAGS) $(CPPFLAGS) -c -o $@ $(abspath $<)
635
636$(OBJDIR)/%.o : $(CURDIR)/%.sycl.cpp | $$(@D)/.DIR
637	$(call quiet,SYCLCXX) $(SYCLFLAGS) $(CPPFLAGS) -c -o $@ $(abspath $<)
638
639$(OBJDIR)/%$(EXE_SUFFIX) : tests/%.c | $$(@D)/.DIR
640	$(call quiet,LINK.c) $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS) -I./tests/test-include
641
642$(OBJDIR)/%$(EXE_SUFFIX) : tests/%.f90 | $$(@D)/.DIR
643	$(call quiet,LINK.F) -DSOURCE_DIR='"$(abspath $(<D))/"' $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
644
645$(OBJDIR)/%$(EXE_SUFFIX) : examples/ceed/%.c | $$(@D)/.DIR
646	$(call quiet,LINK.c) $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
647
648$(OBJDIR)/%$(EXE_SUFFIX) : examples/ceed/%.f | $$(@D)/.DIR
649	$(call quiet,LINK.F) -DSOURCE_DIR='"$(abspath $(<D))/"' $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
650
651
652# ------------------------------------------------------------
653# Building examples
654# ------------------------------------------------------------
655
656# deal.II
657# Note: Invoking deal.II's CMAKE build system here
658$(OBJDIR)/dealii-bps : examples/deal.II/*.cc examples/deal.II/*.h $(libceed) | $$(@D)/.DIR
659	mkdir -p examples/deal.II/build
660	cmake -B examples/deal.II/build -S examples/deal.II -DDEAL_II_DIR=$(DEAL_II_DIR) -DCEED_DIR=$(PWD)
661	+$(call quiet,MAKE) -C examples/deal.II/build
662	cp examples/deal.II/build/bps $(OBJDIR)/dealii-bps
663
664# MFEM
665$(OBJDIR)/mfem-% : examples/mfem/%.cpp $(libceed) | $$(@D)/.DIR
666	+$(MAKE) -C examples/mfem CEED_DIR=`pwd` \
667	  MFEM_DIR="$(abspath $(MFEM_DIR))" CXX=$(CXX) $*
668	cp examples/mfem/$* $@
669
670# Nek5000
671# Note: Multiple Nek files cannot be built in parallel. The '+' here enables
672#       this single Nek bps file to be built in parallel with other examples,
673#       such as when calling `make prove-all -j2`.
674$(OBJDIR)/nek-bps : examples/nek/bps/bps.usr examples/nek/nek-examples.sh $(libceed) | $$(@D)/.DIR
675	+$(MAKE) -C examples MPI=$(MPI) CEED_DIR=`pwd` NEK5K_DIR="$(abspath $(NEK5K_DIR))" nek
676	mv examples/nek/build/bps $(OBJDIR)/bps
677	cp examples/nek/nek-examples.sh $(OBJDIR)/nek-bps
678
679# PETSc
680# Several executables have common utilities, but we can't build the utilities
681# from separate submake invocations because they'll compete with each
682# other/corrupt output. So we put it in this utility library, but we don't want
683# to manually list source dependencies up at this level, so we'll just always
684# call recursive make to check that this utility is up to date.
685examples/petsc/libutils.a.PHONY: $(libceed) $(ceed.pc)
686	+$(call quiet,MAKE) -C examples/petsc CEED_DIR=`pwd` AR=$(AR) ARFLAGS=$(ARFLAGS) \
687	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $(basename $(@F))
688
689$(OBJDIR)/petsc-% : examples/petsc/%.c examples/petsc/libutils.a.PHONY $(libceed) $(ceed.pc) | $$(@D)/.DIR
690	+$(call quiet,MAKE) -C examples/petsc CEED_DIR=`pwd` \
691	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
692	cp examples/petsc/$* $@
693
694# Fluid dynamics proxy application
695$(OBJDIR)/fluids-% : examples/fluids/%.c examples/fluids/src/*.c examples/fluids/*.h examples/fluids/include/*.h examples/fluids/problems/*.c examples/fluids/qfunctions/*.h $(libceed) $(ceed.pc) examples/fluids/Makefile | $$(@D)/.DIR
696	+$(call quiet,MAKE) -C examples/fluids CEED_DIR=`pwd` \
697	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
698	cp examples/fluids/$* $@
699
700# Solid mechanics proxy application
701$(OBJDIR)/solids-% : examples/solids/%.c examples/solids/%.h \
702    examples/solids/problems/*.c examples/solids/src/*.c \
703    examples/solids/include/*.h examples/solids/problems/*.h examples/solids/qfunctions/*.h \
704    $(libceed) $(ceed.pc) | $$(@D)/.DIR
705	+$(call quiet,MAKE) -C examples/solids CEED_DIR=`pwd` \
706	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
707	cp examples/solids/$* $@
708
709examples : $(allexamples)
710ceedexamples : $(examples)
711nekexamples : $(nekexamples)
712mfemexamples : $(mfemexamples)
713petscexamples : $(petscexamples)
714
715external_examples := \
716	$(if $(MFEM_DIR),$(mfemexamples)) \
717	$(if $(PETSC_DIR),$(petscexamples)) \
718	$(if $(NEK5K_DIR),$(nekexamples)) \
719	$(if $(DEAL_II_DIR),$(dealiiexamples)) \
720	$(if $(PETSC_DIR),$(fluidsexamples)) \
721	$(if $(PETSC_DIR),$(solidsexamples))
722
723allexamples = $(examples) $(external_examples)
724
725$(examples) : $(libceed)
726$(tests) : $(libceed)
727$(tests) $(examples) : override LDFLAGS += $(if $(STATIC),,-Wl,-rpath,$(abspath $(LIBDIR))) -L$(LIBDIR)
728
729
730# ------------------------------------------------------------
731# Testing
732# ------------------------------------------------------------
733
734# Set number processes for testing
735NPROC_TEST ?= 1
736export NPROC_TEST
737
738# Set pool size for testing
739NPROC_POOL ?= 1
740export NPROC_POOL
741
742run-% : $(OBJDIR)/%
743	@$(PYTHON) tests/junit.py --mode tap --ceed-backends $(BACKENDS) --nproc $(NPROC_TEST) --pool-size $(NPROC_POOL) $(<:$(OBJDIR)/%=%)
744
745# The test and prove targets can be controlled via pattern searches.  The
746# default is to run tests and those examples that have no external dependencies.
747# Examples of finer grained control:
748#
749#   make test search='petsc mfem'      # PETSc and MFEM examples
750#   make prove search='t3'             # t3xx series tests
751#   make junit search='ex petsc'       # core ex* and PETSc tests
752search ?= t ex
753realsearch = $(search:%=%%)
754matched = $(foreach pattern,$(realsearch),$(filter $(OBJDIR)/$(pattern),$(tests) $(allexamples)))
755JUNIT_BATCH ?= ''
756
757# Test core libCEED
758test : $(matched:$(OBJDIR)/%=run-%)
759
760# Run test target in parallel
761tst : ;@$(MAKE) $(MFLAGS) V=$(V) test
762# CPU C tests only for backend %
763ctc-% : $(ctests);@$(foreach tst,$(ctests),$(tst) /cpu/$*;)
764
765# Testing with TAP format
766# https://testanything.org/tap-specification.html
767prove : $(matched)
768	$(info Testing backends: $(BACKENDS))
769	$(PROVE) $(PROVE_OPTS) --exec '$(PYTHON) tests/junit.py --mode tap --ceed-backends $(BACKENDS) --nproc $(NPROC_TEST) --pool-size $(NPROC_POOL)' $(matched:$(OBJDIR)/%=%)
770# Run prove target in parallel
771prv : ;@$(MAKE) $(MFLAGS) V=$(V) prove
772
773prove-all :
774	+$(MAKE) prove realsearch=%
775
776junit-% : $(OBJDIR)/%
777	@printf "  %10s %s\n" TEST $(<:$(OBJDIR)/%=%); $(PYTHON) tests/junit.py --ceed-backends $(BACKENDS) --nproc $(NPROC_TEST) --pool-size $(NPROC_POOL) --junit-batch $(JUNIT_BATCH) $(<:$(OBJDIR)/%=%)
778
779junit : $(matched:$(OBJDIR)/%=junit-%)
780
781all: $(alltests)
782
783# Benchmarks
784allbenchmarks = petsc-bps
785bench_targets = $(addprefix bench-,$(allbenchmarks))
786.PHONY: $(bench_targets) benchmarks
787$(bench_targets): bench-%: $(OBJDIR)/%
788	cd benchmarks && ./benchmark.sh --ceed "$(BACKENDS)" -r $(*).sh
789benchmarks: $(bench_targets)
790
791$(ceed.pc) : pkgconfig-prefix = $(abspath .)
792$(OBJDIR)/ceed.pc : pkgconfig-prefix = $(prefix)
793.INTERMEDIATE : $(OBJDIR)/ceed.pc
794%/ceed.pc : ceed.pc.template | $$(@D)/.DIR
795	@$(SED) \
796	    -e "s:%prefix%:$(pkgconfig-prefix):" \
797	    -e "s:%libs_private%:$(pkgconfig-libs-private):" $< > $@
798
799$(OBJDIR)/interface/ceed-jit-source-root-default.o : CPPFLAGS += -DCEED_JIT_SOURCE_ROOT_DEFAULT="\"$(abspath ./include)/\""
800$(OBJDIR)/interface/ceed-jit-source-root-install.o : CPPFLAGS += -DCEED_JIT_SOURCE_ROOT_DEFAULT="\"$(abspath $(includedir))/\""
801
802
803# ------------------------------------------------------------
804# Installation
805# ------------------------------------------------------------
806install : $(libceed) $(OBJDIR)/ceed.pc
807	$(INSTALL) -d $(addprefix $(if $(DESTDIR),"$(DESTDIR)"),"$(includedir)"\
808	  "$(includedir)/ceed/" "$(includedir)/ceed/jit-source/"\
809	  "$(includedir)/ceed/jit-source/cuda/" "$(includedir)/ceed/jit-source/hip/"\
810	  "$(includedir)/ceed/jit-source/gallery/" "$(includedir)/ceed/jit-source/magma/"\
811	  "$(includedir)/ceed/jit-source/sycl/" "$(libdir)" "$(pkgconfigdir)")
812	$(INSTALL_DATA) include/ceed/ceed.h "$(DESTDIR)$(includedir)/ceed/"
813	$(INSTALL_DATA) include/ceed/types.h "$(DESTDIR)$(includedir)/ceed/"
814	$(INSTALL_DATA) include/ceed/ceed-f32.h "$(DESTDIR)$(includedir)/ceed/"
815	$(INSTALL_DATA) include/ceed/ceed-f64.h "$(DESTDIR)$(includedir)/ceed/"
816	$(INSTALL_DATA) include/ceed/fortran.h "$(DESTDIR)$(includedir)/ceed/"
817	$(INSTALL_DATA) include/ceed/backend.h "$(DESTDIR)$(includedir)/ceed/"
818	$(INSTALL_DATA) include/ceed/cuda.h "$(DESTDIR)$(includedir)/ceed/"
819	$(INSTALL_DATA) include/ceed/hip.h "$(DESTDIR)$(includedir)/ceed/"
820	$(INSTALL_DATA) $(libceed) "$(DESTDIR)$(libdir)/"
821	$(INSTALL_DATA) $(OBJDIR)/ceed.pc "$(DESTDIR)$(pkgconfigdir)/"
822	$(INSTALL_DATA) include/ceed.h "$(DESTDIR)$(includedir)/"
823	$(INSTALL_DATA) include/ceedf.h "$(DESTDIR)$(includedir)/"
824	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/cuda/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/cuda/"
825	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/hip/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/hip/"
826	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/gallery/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/gallery/"
827	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/magma/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/magma/"
828	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/sycl/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/sycl/"
829
830
831# ------------------------------------------------------------
832# Cleaning
833# ------------------------------------------------------------
834cln clean :
835	$(RM) -r $(OBJDIR) $(LIBDIR) dist *egg* .pytest_cache *cffi*
836	$(call quiet,MAKE) -C examples clean NEK5K_DIR="$(abspath $(NEK5K_DIR))"
837	$(call quiet,MAKE) -C python/tests clean
838	$(RM) benchmarks/*output.txt
839
840distclean : clean
841	$(RM) -r doc/html doc/sphinx/build $(CONFIG)
842
843
844# ------------------------------------------------------------
845# Documentation
846# ------------------------------------------------------------
847DOXYGEN ?= doxygen
848
849doxygen :
850	$(DOXYGEN) -q Doxyfile
851
852doc-html doc-latexpdf doc-epub doc-livehtml : doc-% : doxygen
853	make -C doc/sphinx $*
854
855doc : doc-html
856
857
858# ------------------------------------------------------------
859# Linting utilities
860# ------------------------------------------------------------
861
862# Style/Format
863CLANG_FORMAT      ?= clang-format
864CLANG_FORMAT_OPTS += -style=file -i
865AUTOPEP8          ?= autopep8
866AUTOPEP8_OPTS     += --in-place --aggressive --max-line-length 120
867
868format.ch := $(filter-out include/ceedf.h $(wildcard tests/t*-f.h), $(shell git ls-files '*.[ch]pp' '*.[ch]' '*.cu'))
869format.py := $(filter-out tests/junit-xml/junit_xml/__init__.py, $(shell git ls-files '*.py'))
870format.ot := $(filter-out doc/sphinx/source/CODE_OF_CONDUCT.md doc/sphinx/source/CONTRIBUTING.md, $(shell git ls-files '*.md' '*.f90'))
871
872format-c  :
873	$(CLANG_FORMAT) $(CLANG_FORMAT_OPTS) $(format.ch)
874
875format-py :
876	$(AUTOPEP8) $(AUTOPEP8_OPTS) $(format.py)
877
878format-ot:
879	@$(SED) -r 's/\s+$$//' -i $(format.ot)
880
881format    : format-c format-py format-ot
882
883# Vermin - python version requirements
884VERMIN            ?= vermin
885VERMIN_OPTS       += -t=3.7- --violations
886
887vermin    :
888	$(VERMIN) $(VERMIN_OPTS) $(format.py)
889
890# Tidy
891CLANG_TIDY ?= clang-tidy
892
893%.c.tidy : %.c
894	$(CLANG_TIDY) $(TIDY_OPTS) $^ -- $(CPPFLAGS) --std=c99 -I$(CUDA_DIR)/include -I$(ROCM_DIR)/include -DCEED_JIT_SOURCE_ROOT_DEFAULT="\"$(abspath ./include)/\""
895
896%.cpp.tidy : %.cpp
897	$(CLANG_TIDY) $(TIDY_OPTS) $^ -- $(CPPFLAGS) --std=c++11 -I$(CUDA_DIR)/include -I$(OCCA_DIR)/include -I$(ROCM_DIR)/include
898
899tidy-c   : $(libceed.c:%=%.tidy)
900tidy-cpp : $(libceed.cpp:%=%.tidy)
901
902tidy : tidy-c tidy-cpp
903
904# Include-What-You-Use
905ifneq ($(wildcard ../iwyu/*),)
906  IWYU_DIR ?= ../iwyu
907  IWYU_CC  ?= $(IWYU_DIR)/build/bin/include-what-you-use
908endif
909iwyu :
910	$(MAKE) -B CC=$(IWYU_CC)
911
912
913# ------------------------------------------------------------
914# Variable printing for debugging
915# ------------------------------------------------------------
916
917print :
918	@echo $(VAR)=$($(VAR))
919
920print-% :
921	$(info [ variable name]: $*)
922	$(info [        origin]: $(origin $*))
923	$(info [        flavor]: $(flavor $*))
924	$(info [         value]: $(value $*))
925	$(info [expanded value]: $($*))
926	$(info )
927	@true
928
929
930# ------------------------------------------------------------
931# Configuration caching
932# ------------------------------------------------------------
933# "make configure" detects any variables passed on the command line or
934# previously set in config.mk, caching them in config.mk as simple
935# (:=) variables.  Variables set in config.mk or on the command line
936# take precedence over the defaults provided in the file.  Typical
937# usage:
938#
939#   make configure CC=/path/to/my/cc CUDA_DIR=/opt/cuda
940#   make
941#   make prove
942#
943# The values in the file can be updated by passing them on the command
944# line, e.g.,
945#
946#   make configure CC=/path/to/other/clang
947
948# All variables to consider for caching
949CONFIG_VARS = CC CXX FC NVCC NVCC_CXX HIPCC \
950  OPT CFLAGS CPPFLAGS CXXFLAGS FFLAGS NVCCFLAGS HIPCCFLAGS SYCLFLAGS \
951  AR ARFLAGS LDFLAGS LDLIBS LIBCXX SED \
952  MAGMA_DIR OCCA_DIR XSMM_DIR CUDA_DIR CUDA_ARCH MFEM_DIR PETSC_DIR NEK5K_DIR ROCM_DIR HIP_ARCH SYCL_DIR
953
954# $(call needs_save,CFLAGS) returns true (a nonempty string) if CFLAGS
955# was set on the command line or in config.mk (where it will appear as
956# a simple variable).
957needs_save = $(or $(filter command line,$(origin $(1))),$(filter simple,$(flavor $(1))))
958
959configure :
960	$(file > $(CONFIG))
961	$(foreach v,$(CONFIG_VARS),$(if $(call needs_save,$(v)),$(file >> $(CONFIG),$(v) := $($(v)))))
962	@echo "Configuration cached in $(CONFIG):"
963	@cat $(CONFIG)
964
965
966# ------------------------------------------------------------
967# Building Python wheels for deployment
968# ------------------------------------------------------------
969wheel : export MARCHFLAG = -march=generic
970wheel : export WHEEL_PLAT = manylinux2010_x86_64
971wheel :
972	docker run -it --user $(shell id -u):$(shell id -g) --rm -v $(PWD):/io -w /io \
973	  -e MARCHFLAG -e WHEEL_PLAT \
974	  quay.io/pypa/$(WHEEL_PLAT) python/make-wheels.sh
975
976# ------------------------------------------------------------
977# Phony targets
978# ------------------------------------------------------------
979# These targets are not files but rather commands to run
980.PHONY : all cln clean doxygen doc format lib install par print test tst prove prv prove-all junit examples tidy iwyu info info-backends info-backends-all configure wheel
981
982
983# Include *.d deps when not -B = --always-make: useful if the paths are wonky in a container
984-include $(if $(filter B,$(MAKEFLAGS)),,$(libceed.c:%.c=$(OBJDIR)/%.d) $(tests.c:tests/%.c=$(OBJDIR)/%.d))
985