xref: /libCEED/Makefile (revision a5ef5560233b41639b8f63aaa7afe24f9b67de19)
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-basic:
370	$(info -----------------------------------------)
371	$(info |     ___ __    ______________________  |)
372	$(info |    / (_) /_  / ____/ ____/ ____/ __ \ |)
373	$(info |   / / / __ \/ /   / __/ / __/ / / / / |)
374	$(info |  / / / /_/ / /___/ /___/ /___/ /_/ /  |)
375	$(info | /_/_/_.___/\____/_____/_____/_____/   |)
376	$(info -----------------------------------------)
377	$(info )
378	$(info -----------------------------------------)
379	$(info )
380	$(info Built-in Backends:)
381	$(info   $(BACKENDS_BUILTIN))
382	$(info )
383	$(info Additional Backends:)
384	$(info   $(filter-out $(BACKENDS_BUILTIN),$(BACKENDS)))
385	$(info )
386	$(info -----------------------------------------)
387	$(info )
388	@true
389
390info:
391	$(info -----------------------------------------)
392	$(info |     ___ __    ______________________  |)
393	$(info |    / (_) /_  / ____/ ____/ ____/ __ \ |)
394	$(info |   / / / __ \/ /   / __/ / __/ / / / / |)
395	$(info |  / / / /_/ / /___/ /___/ /___/ /_/ /  |)
396	$(info | /_/_/_.___/\____/_____/_____/_____/   |)
397	$(info -----------------------------------------)
398	$(info )
399	$(info -----------------------------------------)
400	$(info )
401	$(info Built-in Backends:)
402	$(info   $(BACKENDS_BUILTIN))
403	$(info )
404	$(info Additional Backends:)
405	$(info   $(filter-out $(BACKENDS_BUILTIN),$(BACKENDS)))
406	$(info )
407	$(info -----------------------------------------)
408	$(info )
409	$(info Compiler Flags:)
410	$(info CC            = $(CC))
411	$(info CXX           = $(CXX))
412	$(info FC            = $(FC))
413	$(info CPPFLAGS      = $(CPPFLAGS))
414	$(info CFLAGS        = $(CFLAGS))
415	$(info CXXFLAGS      = $(CXXFLAGS))
416	$(info FFLAGS        = $(FFLAGS))
417	$(info NVCCFLAGS     = $(NVCCFLAGS))
418	$(info HIPCCFLAGS    = $(HIPCCFLAGS))
419	$(info SYCLFLAGS     = $(SYCLFLAGS))
420	$(info CEED_LDFLAGS  = $(CEED_LDFLAGS))
421	$(info CEED_LDLIBS   = $(CEED_LDLIBS))
422	$(info AR            = $(AR))
423	$(info ARFLAGS       = $(ARFLAGS))
424	$(info OPT           = $(OPT))
425	$(info AFLAGS        = $(AFLAGS))
426	$(info ASAN          = $(or $(ASAN),(empty)))
427	$(info VERBOSE       = $(or $(V),(empty)) [verbose=$(if $(V),on,off)])
428	$(info )
429	$(info -----------------------------------------)
430	$(info )
431	$(info Backend Dependencies:)
432	$(info MEMCHK_STATUS = $(MEMCHK_STATUS)$(call backend_status,$(MEMCHK_BACKENDS)))
433	$(info AVX_STATUS    = $(AVX_STATUS)$(call backend_status,$(AVX_BACKENDS)))
434	$(info XSMM_DIR      = $(XSMM_DIR)$(call backend_status,$(XSMM_BACKENDS)))
435	$(info CUDA_DIR      = $(CUDA_DIR)$(call backend_status,$(CUDA_BACKENDS)))
436	$(info ROCM_DIR      = $(ROCM_DIR)$(call backend_status,$(HIP_BACKENDS)))
437	$(info SYCL_DIR      = $(SYCL_DIR)$(call backend_status,$(SYCL_BACKENDS)))
438	$(info MAGMA_DIR     = $(MAGMA_DIR)$(call backend_status,$(MAGMA_BACKENDS)))
439	$(info OCCA_DIR      = $(OCCA_DIR)$(call backend_status,$(OCCA_BACKENDS)))
440	$(info )
441	$(info -----------------------------------------)
442	$(info )
443	$(info Example Dependencies:)
444	$(info MFEM_DIR      = $(MFEM_DIR))
445	$(info NEK5K_DIR     = $(NEK5K_DIR))
446	$(info PETSC_DIR     = $(PETSC_DIR))
447	$(info DEAL_II_DIR   = $(DEAL_II_DIR))
448	$(info )
449	$(info -----------------------------------------)
450	$(info )
451	$(info Install Options:)
452	$(info prefix        = $(prefix))
453	$(info includedir    = $(value includedir))
454	$(info libdir        = $(value libdir))
455	$(info pkgconfigdir  = $(value pkgconfigdir))
456	$(info )
457	$(info -----------------------------------------)
458	@true
459
460info-backends:
461	$(info make: 'lib' with optional backends: $(filter-out $(BACKENDS_BUILTIN),$(BACKENDS)))
462	@true
463
464info-backends-all:
465	$(info make: 'lib' with backends: $(BACKENDS))
466	@true
467
468
469# ------------------------------------------------------------
470# Backends
471# ------------------------------------------------------------
472
473# Standard Backends
474libceed.c += $(ref.c)
475libceed.c += $(blocked.c)
476libceed.c += $(opt.c)
477
478# Memcheck Backends
479MEMCHK_STATUS   = Disabled
480MEMCHK         := $(shell echo "$(HASH)include <valgrind/memcheck.h>" | $(CC) $(CPPFLAGS) -E - >/dev/null 2>&1 && echo 1)
481MEMCHK_BACKENDS = /cpu/self/memcheck/serial /cpu/self/memcheck/blocked
482ifeq ($(MEMCHK),1)
483  MEMCHK_STATUS = Enabled
484  libceed.c += $(ceedmemcheck.c)
485  BACKENDS_MAKE += $(MEMCHK_BACKENDS)
486endif
487
488# AVX Backeds
489AVX_STATUS   = Disabled
490AVX_FLAG    := $(if $(filter clang,$(CC_VENDOR)),+avx,-mavx)
491AVX         := $(filter $(AVX_FLAG),$(shell $(CC) $(CFLAGS:-M%=) -v -E -x c /dev/null 2>&1))
492AVX_BACKENDS = /cpu/self/avx/serial /cpu/self/avx/blocked
493ifneq ($(AVX),)
494  AVX_STATUS = Enabled
495  libceed.c += $(avx.c)
496  BACKENDS_MAKE += $(AVX_BACKENDS)
497endif
498
499# Collect list of libraries and paths for use in linking and pkg-config
500PKG_LIBS =
501# Stubs that will not be RPATH'd
502PKG_STUBS_LIBS =
503
504# libXSMM Backends
505XSMM_BACKENDS = /cpu/self/xsmm/serial /cpu/self/xsmm/blocked
506ifneq ($(wildcard $(XSMM_DIR)/lib/libxsmm.*),)
507  PKG_LIBS += -L$(abspath $(XSMM_DIR))/lib -lxsmm
508  MKL ?=
509  ifeq (,$(MKL)$(MKLROOT))
510    BLAS_LIB ?= -lblas -ldl
511  else
512    ifneq ($(MKLROOT),)
513      # Some installs put everything inside an intel64 subdirectory, others not
514      MKL_LIBDIR = $(dir $(firstword $(wildcard $(MKLROOT)/lib/intel64/libmkl_sequential.* $(MKLROOT)/lib/libmkl_sequential.*)))
515      MKL_LINK = -L$(MKL_LIBDIR)
516    endif
517    BLAS_LIB ?= $(MKL_LINK) -Wl,--push-state,--no-as-needed -lmkl_intel_lp64 -lmkl_sequential -lmkl_core -lpthread -lm -ldl -Wl,--pop-state
518  endif
519  PKG_LIBS += $(BLAS_LIB)
520  libceed.c += $(xsmm.c)
521  $(xsmm.c:%.c=$(OBJDIR)/%.o) $(xsmm.c:%=%.tidy) : CPPFLAGS += -I$(XSMM_DIR)/include
522  BACKENDS_MAKE += $(XSMM_BACKENDS)
523endif
524
525# CUDA Backends
526ifneq ($(CUDA_DIR),)
527  CUDA_LIB_DIR := $(wildcard $(foreach d,lib lib64 lib/x86_64-linux-gnu,$(CUDA_DIR)/$d/libcudart.${SO_EXT}))
528  CUDA_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(CUDA_LIB_DIR))))
529endif
530CUDA_LIB_DIR_STUBS := $(CUDA_LIB_DIR)/stubs
531CUDA_BACKENDS = /gpu/cuda/ref /gpu/cuda/shared /gpu/cuda/gen
532ifneq ($(CUDA_LIB_DIR),)
533  $(libceeds) : CPPFLAGS += -I$(CUDA_DIR)/include
534  PKG_LIBS += -L$(abspath $(CUDA_LIB_DIR)) -lcudart -lnvrtc -lcuda -lcublas
535  PKG_STUBS_LIBS += -L$(CUDA_LIB_DIR_STUBS)
536  LIBCEED_CONTAINS_CXX = 1
537  libceed.c     += interface/ceed-cuda.c
538  libceed.c     += $(cuda.c) $(cuda-ref.c) $(cuda-shared.c) $(cuda-gen.c)
539  libceed.cpp   += $(cuda.cpp) $(cuda-ref.cpp) $(cuda-gen.cpp)
540  libceed.cu    += $(cuda-ref.cu) $(cuda-shared.cu) $(cuda-gen.cu)
541  BACKENDS_MAKE += $(CUDA_BACKENDS)
542endif
543
544# HIP Backends
545HIP_LIB_DIR := $(wildcard $(foreach d,lib lib64,$(ROCM_DIR)/$d/libamdhip64.${SO_EXT}))
546HIP_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(HIP_LIB_DIR))))
547HIP_BACKENDS = /gpu/hip/ref /gpu/hip/shared /gpu/hip/gen
548ifneq ($(HIP_LIB_DIR),)
549  HIPCONFIG_CPPFLAGS := $(subst =,,$(shell $(ROCM_DIR)/bin/hipconfig -C))
550  $(hip-all.c:%.c=$(OBJDIR)/%.o) $(hip-all.c:%=%.tidy): CPPFLAGS += $(HIPCONFIG_CPPFLAGS)
551  ifneq ($(CXX), $(HIPCC))
552    $(hip-all.cpp:%.cpp=$(OBJDIR)/%.o) $(hip-all.cpp:%=%.tidy): CPPFLAGS += $(HIPCONFIG_CPPFLAGS)
553  endif
554  PKG_LIBS += -L$(abspath $(HIP_LIB_DIR)) -lamdhip64 -lhipblas
555  LIBCEED_CONTAINS_CXX = 1
556  libceed.c     += $(hip-all.c)
557  libceed.cpp   += $(hip-all.cpp)
558  libceed.hip   += $(hip-ref.hip)
559  BACKENDS_MAKE += $(HIP_BACKENDS)
560endif
561
562# SYCL Backends
563SYCL_BACKENDS = /gpu/sycl/ref /gpu/sycl/shared /gpu/sycl/gen
564ifneq ($(SYCL_DIR),)
565  SYCL_LIB_DIR := $(wildcard $(foreach d,lib lib64,$(SYCL_DIR)/$d/libsycl.${SO_EXT}))
566  SYCL_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(SYCL_LIB_DIR))))
567endif
568ifneq ($(SYCL_LIB_DIR),)
569  PKG_LIBS += $(SYCL_FLAG) -lze_loader
570  LIBCEED_CONTAINS_CXX = 1
571  libceed.sycl += $(sycl-core.cpp) $(sycl-ref.cpp) $(sycl-shared.cpp) $(sycl-gen.cpp)
572  BACKENDS_MAKE += $(SYCL_BACKENDS)
573endif
574
575# MAGMA Backends
576ifneq ($(wildcard $(MAGMA_DIR)/lib/libmagma.*),)
577  MAGMA_ARCH=$(shell nm -g $(MAGMA_DIR)/lib/libmagma.* | grep -c "hipblas")
578  ifeq ($(MAGMA_ARCH), 0)  # CUDA MAGMA
579    ifneq ($(CUDA_LIB_DIR),)
580      cuda_link = $(if $(STATIC),,-Wl,-rpath,$(CUDA_LIB_DIR)) -L$(CUDA_LIB_DIR) -lcublas -lcusparse -lcudart
581      omp_link = -fopenmp
582      magma_link_static = -L$(MAGMA_DIR)/lib -lmagma $(cuda_link) $(omp_link)
583      magma_link_shared = -L$(MAGMA_DIR)/lib $(if $(STATIC),,-Wl,-rpath,$(abspath $(MAGMA_DIR)/lib)) -lmagma
584      magma_link := $(if $(wildcard $(MAGMA_DIR)/lib/libmagma.${SO_EXT}),$(magma_link_shared),$(magma_link_static))
585      PKG_LIBS += $(magma_link)
586      libceed.c   += $(magma.c)
587      libceed.cpp += $(magma.cpp)
588      $(magma.c:%.c=$(OBJDIR)/%.o) $(magma.c:%=%.tidy) : CPPFLAGS += -DADD_ -I$(MAGMA_DIR)/include -I$(CUDA_DIR)/include
589      $(magma.cpp:%.cpp=$(OBJDIR)/%.o) $(magma.cpp:%=%.tidy) : CPPFLAGS += -DADD_ -I$(MAGMA_DIR)/include -I$(CUDA_DIR)/include
590      MAGMA_BACKENDS = /gpu/cuda/magma /gpu/cuda/magma/det
591    endif
592  else  # HIP MAGMA
593    ifneq ($(HIP_LIB_DIR),)
594      omp_link = -fopenmp
595      hip_link = $(if $(STATIC),,-Wl,-rpath,$(HIP_LIB_DIR)) -L$(HIP_LIB_DIR) -lhipblas -lhipsparse -lamdhip64
596      magma_link_static = -L$(MAGMA_DIR)/lib -lmagma $(hip_link) $(omp_link)
597      magma_link_shared = -L$(MAGMA_DIR)/lib $(hip_link) $(omp_link) $(if $(STATIC),,-Wl,-rpath,$(abspath $(MAGMA_DIR)/lib)) -lmagma
598      magma_link := $(if $(wildcard $(MAGMA_DIR)/lib/libmagma.${SO_EXT}),$(magma_link_shared),$(magma_link_static))
599      PKG_LIBS += $(magma_link)
600      libceed.c   += $(magma.c)
601      libceed.cpp += $(magma.cpp)
602      $(magma.c:%.c=$(OBJDIR)/%.o) $(magma.c:%=%.tidy) : CPPFLAGS += $(HIPCONFIG_CPPFLAGS) -I$(MAGMA_DIR)/include -I$(ROCM_DIR)/include -DCEED_MAGMA_USE_HIP -DADD_
603      $(magma.cpp:%.cpp=$(OBJDIR)/%.o) $(magma.cpp:%=%.tidy) : CPPFLAGS += $(HIPCONFIG_CPPFLAGS) -I$(MAGMA_DIR)/include -I$(ROCM_DIR)/include -DCEED_MAGMA_USE_HIP -DADD_
604      MAGMA_BACKENDS = /gpu/hip/magma /gpu/hip/magma/det
605    endif
606  endif
607  LIBCEED_CONTAINS_CXX = 1
608  BACKENDS_MAKE += $(MAGMA_BACKENDS)
609endif
610
611# OCCA Backends
612OCCA_BACKENDS = /cpu/self/occa
613ifneq ($(wildcard $(OCCA_DIR)/lib/libocca.*),)
614  OCCA_MODES := $(shell LD_LIBRARY_PATH=$(OCCA_DIR)/lib $(OCCA_DIR)/bin/occa modes)
615  OCCA_BACKENDS += $(if $(filter OpenMP,$(OCCA_MODES)),/cpu/openmp/occa)
616  OCCA_BACKENDS += $(if $(filter dpcpp,$(OCCA_MODES)),/gpu/dpcpp/occa)
617  OCCA_BACKENDS += $(if $(filter OpenCL,$(OCCA_MODES)),/gpu/opencl/occa)
618  OCCA_BACKENDS += $(if $(filter HIP,$(OCCA_MODES)),/gpu/hip/occa)
619  OCCA_BACKENDS += $(if $(filter CUDA,$(OCCA_MODES)),/gpu/cuda/occa)
620  $(libceeds) : CPPFLAGS += -I$(OCCA_DIR)/include
621  PKG_LIBS += -L$(abspath $(OCCA_DIR))/lib -locca
622  LIBCEED_CONTAINS_CXX = 1
623  libceed.cpp += $(occa.cpp)
624  BACKENDS_MAKE += $(OCCA_BACKENDS)
625endif
626
627BACKENDS ?= $(BACKENDS_MAKE)
628export BACKENDS
629
630
631# ------------------------------------------------------------
632# Linker Flags
633# ------------------------------------------------------------
634_pkg_ldflags = $(filter -L%,$(PKG_LIBS))
635_pkg_ldlibs = $(filter-out -L%,$(PKG_LIBS))
636$(libceeds) : CEED_LDFLAGS += $(_pkg_ldflags) $(if $(STATIC),,$(_pkg_ldflags:-L%=-Wl,-rpath,%)) $(PKG_STUBS_LIBS)
637$(libceeds) : CEED_LDLIBS += $(_pkg_ldlibs)
638ifeq ($(STATIC),1)
639  $(examples) $(tests) : CEED_LDFLAGS += $(EM_LDFLAGS) $(_pkg_ldflags) $(if $(STATIC),,$(_pkg_ldflags:-L%=-Wl,-rpath,%)) $(PKG_STUBS_LIBS)
640  $(examples) $(tests) : CEED_LDLIBS += $(_pkg_ldlibs)
641endif
642
643pkgconfig-libs-private = $(PKG_LIBS)
644ifeq ($(LIBCEED_CONTAINS_CXX),1)
645  $(libceeds) : LINK = $(CXX)
646  ifeq ($(STATIC),1)
647    $(examples) $(tests) : CEED_LDLIBS += $(LIBCXX)
648    pkgconfig-libs-private += $(LIBCXX)
649  endif
650endif
651
652
653# ------------------------------------------------------------
654# Building core library components
655# ------------------------------------------------------------
656
657# File names *-weak.c contain weak symbol definitions, which must be listed last
658# when creating shared or static libraries.
659weak_last = $(filter-out %-weak.o,$(1)) $(filter %-weak.o,$(1))
660
661libceed.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)
662$(filter %fortran.o,$(libceed.o)) : CPPFLAGS += $(if $(filter 1,$(UNDERSCORE)),-DUNDERSCORE)
663$(libceed.o): | info-backends
664$(libceed.so) : $(call weak_last,$(libceed.o)) | $$(@D)/.DIR
665	$(call quiet,LINK) $(LDFLAGS) $(CEED_LDFLAGS) -shared -o $@ $^ $(CEED_LDLIBS) $(LDLIBS)
666
667$(libceed.a) : $(call weak_last,$(libceed.o)) | $$(@D)/.DIR
668	$(call quiet,AR) $(ARFLAGS) $@ $^
669
670$(OBJDIR)/%.o : $(CURDIR)/%.c | $$(@D)/.DIR
671	$(call quiet,CC) $(CPPFLAGS) $(CFLAGS) -c -o $@ $(abspath $<)
672
673$(OBJDIR)/%.o : $(CURDIR)/%.cpp | $$(@D)/.DIR
674	$(call quiet,CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $(abspath $<)
675
676$(OBJDIR)/%.o : $(CURDIR)/%.cu | $$(@D)/.DIR
677	$(call quiet,NVCC) $(filter-out -Wno-unused-function, $(CPPFLAGS)) $(NVCCFLAGS) -c -o $@ $(abspath $<)
678
679$(OBJDIR)/%.o : $(CURDIR)/%.hip.cpp | $$(@D)/.DIR
680	$(call quiet,HIPCC) $(CPPFLAGS) $(HIPCCFLAGS) -c -o $@ $(abspath $<)
681
682$(OBJDIR)/%.o : $(CURDIR)/%.sycl.cpp | $$(@D)/.DIR
683	$(call quiet,SYCLCXX) $(SYCLFLAGS) $(CPPFLAGS) -c -o $@ $(abspath $<)
684
685$(OBJDIR)/%.o : $(CURDIR)/%.sycl.cpp | $$(@D)/.DIR
686	$(call quiet,SYCLCXX) $(SYCLFLAGS) $(CPPFLAGS) -c -o $@ $(abspath $<)
687
688$(OBJDIR)/%$(EXE_SUFFIX) : tests/%.c | $$(@D)/.DIR
689	$(call quiet,LINK.c) $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS) -I./tests/test-include
690
691$(OBJDIR)/%$(EXE_SUFFIX) : tests/%.f90 | $$(@D)/.DIR
692	$(call quiet,LINK.F) -DSOURCE_DIR='"$(abspath $(<D))/"' $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
693
694$(OBJDIR)/%$(EXE_SUFFIX) : examples/ceed/%.c | $$(@D)/.DIR
695	$(call quiet,LINK.c) $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
696
697$(OBJDIR)/%$(EXE_SUFFIX) : examples/ceed/%.f | $$(@D)/.DIR
698	$(call quiet,LINK.F) -DSOURCE_DIR='"$(abspath $(<D))/"' $(CEED_LDFLAGS) -o $@ $(abspath $<) $(CEED_LIBS) $(CEED_LDLIBS) $(LDLIBS)
699
700
701# ------------------------------------------------------------
702# Building examples
703# ------------------------------------------------------------
704
705# deal.II
706# Note: Invoking deal.II's CMAKE build system here
707$(OBJDIR)/dealii-bps : examples/deal.II/*.cc examples/deal.II/*.h $(libceed) | $$(@D)/.DIR
708	mkdir -p examples/deal.II/build
709	cmake -B examples/deal.II/build -S examples/deal.II -DDEAL_II_DIR=$(DEAL_II_DIR) -DCEED_DIR=$(PWD)
710	+$(call quiet,MAKE) -C examples/deal.II/build
711	cp examples/deal.II/build/bps $(OBJDIR)/dealii-bps
712
713# MFEM
714$(OBJDIR)/mfem-% : examples/mfem/%.cpp $(libceed) | $$(@D)/.DIR
715	+$(MAKE) -C examples/mfem CEED_DIR=`pwd` \
716	  MFEM_DIR="$(abspath $(MFEM_DIR))" CXX=$(CXX) $*
717	cp examples/mfem/$* $@
718
719# Nek5000
720# Note: Multiple Nek files cannot be built in parallel. The '+' here enables
721#       this single Nek bps file to be built in parallel with other examples,
722#       such as when calling `make prove-all -j2`.
723$(OBJDIR)/nek-bps : examples/nek/bps/bps.usr examples/nek/nek-examples.sh $(libceed) | $$(@D)/.DIR
724	+$(MAKE) -C examples MPI=$(MPI) CEED_DIR=`pwd` NEK5K_DIR="$(abspath $(NEK5K_DIR))" nek
725	mv examples/nek/build/bps $(OBJDIR)/bps
726	cp examples/nek/nek-examples.sh $(OBJDIR)/nek-bps
727
728# PETSc
729# Several executables have common utilities, but we can't build the utilities
730# from separate submake invocations because they'll compete with each
731# other/corrupt output. So we put it in this utility library, but we don't want
732# to manually list source dependencies up at this level, so we'll just always
733# call recursive make to check that this utility is up to date.
734examples/petsc/libutils.a.PHONY: $(libceed) $(ceed.pc)
735	+$(call quiet,MAKE) -C examples/petsc CEED_DIR=`pwd` AR=$(AR) ARFLAGS=$(ARFLAGS) \
736	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $(basename $(@F))
737
738$(OBJDIR)/petsc-% : examples/petsc/%.c examples/petsc/libutils.a.PHONY $(libceed) $(ceed.pc) | $$(@D)/.DIR
739	+$(call quiet,MAKE) -C examples/petsc CEED_DIR=`pwd` \
740	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
741	cp examples/petsc/$* $@
742
743# Fluid dynamics proxy application
744$(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
745	+$(call quiet,MAKE) -C examples/fluids CEED_DIR=`pwd` \
746	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
747	cp examples/fluids/$* $@
748
749# Solid mechanics proxy application
750$(OBJDIR)/solids-% : examples/solids/%.c examples/solids/%.h \
751    examples/solids/problems/*.c examples/solids/src/*.c \
752    examples/solids/include/*.h examples/solids/problems/*.h examples/solids/qfunctions/*.h \
753    $(libceed) $(ceed.pc) | $$(@D)/.DIR
754	+$(call quiet,MAKE) -C examples/solids CEED_DIR=`pwd` \
755	  PETSC_DIR="$(abspath $(PETSC_DIR))" OPT="$(OPT)" $*
756	cp examples/solids/$* $@
757
758examples : $(allexamples)
759ceedexamples : $(examples)
760nekexamples : $(nekexamples)
761mfemexamples : $(mfemexamples)
762petscexamples : $(petscexamples)
763
764external_examples := \
765	$(if $(MFEM_DIR),$(mfemexamples)) \
766	$(if $(PETSC_DIR),$(petscexamples)) \
767	$(if $(NEK5K_DIR),$(nekexamples)) \
768	$(if $(DEAL_II_DIR),$(dealiiexamples)) \
769	$(if $(PETSC_DIR),$(fluidsexamples)) \
770	$(if $(PETSC_DIR),$(solidsexamples))
771
772allexamples = $(examples) $(external_examples)
773
774$(examples) : $(libceed)
775$(tests) : $(libceed)
776$(tests) $(examples) : override LDFLAGS += $(if $(STATIC),,-Wl,-rpath,$(abspath $(LIBDIR))) -L$(LIBDIR)
777
778
779# ------------------------------------------------------------
780# Testing
781# ------------------------------------------------------------
782
783# Set number processes for testing
784NPROC_TEST ?= 1
785export NPROC_TEST
786
787# Set pool size for testing
788NPROC_POOL ?= 1
789export NPROC_POOL
790
791run-% : $(OBJDIR)/%
792	@$(PYTHON) tests/junit.py --mode tap --ceed-backends $(BACKENDS) --nproc $(NPROC_TEST) --pool-size $(NPROC_POOL) $(<:$(OBJDIR)/%=%)
793
794# The test and prove targets can be controlled via pattern searches.  The
795# default is to run tests and those examples that have no external dependencies.
796# Examples of finer grained control:
797#
798#   make test search='petsc mfem'      # PETSc and MFEM examples
799#   make prove search='t3'             # t3xx series tests
800#   make junit search='ex petsc'       # core ex* and PETSc tests
801search ?= t ex
802realsearch = $(search:%=%%)
803matched = $(foreach pattern,$(realsearch),$(filter $(OBJDIR)/$(pattern),$(tests) $(allexamples)))
804JUNIT_BATCH ?= ''
805
806# Test core libCEED
807test : $(matched:$(OBJDIR)/%=run-%)
808
809# Run test target in parallel
810tst : ;@$(MAKE) $(MFLAGS) V=$(V) test
811# CPU C tests only for backend %
812ctc-% : $(ctests);@$(foreach tst,$(ctests),$(tst) /cpu/$*;)
813
814# Testing with TAP format
815# https://testanything.org/tap-specification.html
816prove : $(matched)
817	$(info Testing backends: $(BACKENDS))
818	$(PROVE) $(PROVE_OPTS) --exec '$(PYTHON) tests/junit.py --mode tap --ceed-backends $(BACKENDS) --nproc $(NPROC_TEST) --pool-size $(NPROC_POOL)' $(matched:$(OBJDIR)/%=%)
819# Run prove target in parallel
820prv : ;@$(MAKE) $(MFLAGS) V=$(V) prove
821
822prove-all :
823	+$(MAKE) prove realsearch=%
824
825junit-% : $(OBJDIR)/%
826	@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)/%=%)
827
828junit : $(matched:$(OBJDIR)/%=junit-%)
829
830all: $(alltests)
831
832# Benchmarks
833allbenchmarks = petsc-bps
834bench_targets = $(addprefix bench-,$(allbenchmarks))
835.PHONY: $(bench_targets) benchmarks
836$(bench_targets): bench-%: $(OBJDIR)/%
837	cd benchmarks && ./benchmark.sh --ceed "$(BACKENDS)" -r $(*).sh
838benchmarks: $(bench_targets)
839
840$(ceed.pc) : pkgconfig-prefix = $(abspath .)
841$(OBJDIR)/ceed.pc : pkgconfig-prefix = $(prefix)
842.INTERMEDIATE : $(OBJDIR)/ceed.pc
843%/ceed.pc : ceed.pc.template | $$(@D)/.DIR
844	@$(SED) \
845	    -e "s:%prefix%:$(pkgconfig-prefix):" \
846	    -e "s:%libs_private%:$(pkgconfig-libs-private):" $< > $@
847
848$(OBJDIR)/interface/ceed-jit-source-root-default.o : CPPFLAGS += -DCEED_JIT_SOURCE_ROOT_DEFAULT="\"$(abspath ./include)/\""
849$(OBJDIR)/interface/ceed-jit-source-root-install.o : CPPFLAGS += -DCEED_JIT_SOURCE_ROOT_DEFAULT="\"$(abspath $(includedir))/\""
850
851
852# ------------------------------------------------------------
853# Installation
854# ------------------------------------------------------------
855install : $(libceed) $(OBJDIR)/ceed.pc
856	$(INSTALL) -d $(addprefix $(if $(DESTDIR),"$(DESTDIR)"),"$(includedir)"\
857	  "$(includedir)/ceed/" "$(includedir)/ceed/jit-source/"\
858	  "$(includedir)/ceed/jit-source/cuda/" "$(includedir)/ceed/jit-source/hip/"\
859	  "$(includedir)/ceed/jit-source/gallery/" "$(includedir)/ceed/jit-source/magma/"\
860	  "$(includedir)/ceed/jit-source/sycl/" "$(libdir)" "$(pkgconfigdir)")
861	$(INSTALL_DATA) include/ceed/ceed.h "$(DESTDIR)$(includedir)/ceed/"
862	$(INSTALL_DATA) include/ceed/types.h "$(DESTDIR)$(includedir)/ceed/"
863	$(INSTALL_DATA) include/ceed/ceed-f32.h "$(DESTDIR)$(includedir)/ceed/"
864	$(INSTALL_DATA) include/ceed/ceed-f64.h "$(DESTDIR)$(includedir)/ceed/"
865	$(INSTALL_DATA) include/ceed/fortran.h "$(DESTDIR)$(includedir)/ceed/"
866	$(INSTALL_DATA) include/ceed/backend.h "$(DESTDIR)$(includedir)/ceed/"
867	$(INSTALL_DATA) include/ceed/cuda.h "$(DESTDIR)$(includedir)/ceed/"
868	$(INSTALL_DATA) include/ceed/hip.h "$(DESTDIR)$(includedir)/ceed/"
869	$(INSTALL_DATA) $(libceed) "$(DESTDIR)$(libdir)/"
870	$(INSTALL_DATA) $(OBJDIR)/ceed.pc "$(DESTDIR)$(pkgconfigdir)/"
871	$(INSTALL_DATA) include/ceed.h "$(DESTDIR)$(includedir)/"
872	$(INSTALL_DATA) include/ceedf.h "$(DESTDIR)$(includedir)/"
873	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/cuda/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/cuda/"
874	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/hip/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/hip/"
875	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/gallery/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/gallery/"
876	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/magma/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/magma/"
877	$(INSTALL_DATA) $(wildcard include/ceed/jit-source/sycl/*.h) "$(DESTDIR)$(includedir)/ceed/jit-source/sycl/"
878
879
880# ------------------------------------------------------------
881# Cleaning
882# ------------------------------------------------------------
883cln clean :
884	$(RM) -r $(OBJDIR) $(LIBDIR) dist *egg* .pytest_cache *cffi*
885	$(call quiet,MAKE) -C examples clean NEK5K_DIR="$(abspath $(NEK5K_DIR))"
886	$(call quiet,MAKE) -C python/tests clean
887	$(RM) benchmarks/*output.txt
888
889distclean : clean
890	$(RM) -r doc/html doc/sphinx/build $(CONFIG)
891
892
893# ------------------------------------------------------------
894# Documentation
895# ------------------------------------------------------------
896DOXYGEN ?= doxygen
897
898doxygen :
899	$(DOXYGEN) -q Doxyfile
900
901doc-html doc-latexpdf doc-epub doc-livehtml : doc-% : doxygen
902	make -C doc/sphinx $*
903
904doc : doc-html
905
906
907# ------------------------------------------------------------
908# Linting utilities
909# ------------------------------------------------------------
910
911# Style/Format
912CLANG_FORMAT      ?= clang-format
913CLANG_FORMAT_OPTS += -style=file -i
914AUTOPEP8          ?= autopep8
915AUTOPEP8_OPTS     += --in-place --aggressive --max-line-length 120
916
917format.ch := $(filter-out include/ceedf.h $(wildcard tests/t*-f.h), $(shell git ls-files '*.[ch]pp' '*.[ch]' '*.cu'))
918format.py := $(filter-out tests/junit-xml/junit_xml/__init__.py, $(shell git ls-files '*.py'))
919format.ot := $(filter-out doc/sphinx/source/CODE_OF_CONDUCT.md doc/sphinx/source/CONTRIBUTING.md, $(shell git ls-files '*.md' '*.f90'))
920
921format-c  :
922	$(CLANG_FORMAT) $(CLANG_FORMAT_OPTS) $(format.ch)
923
924format-py :
925	$(AUTOPEP8) $(AUTOPEP8_OPTS) $(format.py)
926
927format-ot:
928	@$(SED) -r 's/\s+$$//' -i $(format.ot)
929
930format    : format-c format-py format-ot
931
932# Vermin - python version requirements
933VERMIN            ?= vermin
934VERMIN_OPTS       += -t=3.7- --violations
935
936vermin    :
937	$(VERMIN) $(VERMIN_OPTS) $(format.py)
938
939# Tidy
940CLANG_TIDY ?= clang-tidy
941
942%.c.tidy : %.c
943	$(CLANG_TIDY) $(TIDY_OPTS) $^ -- $(CPPFLAGS) --std=c99 -I$(CUDA_DIR)/include -I$(ROCM_DIR)/include -DCEED_JIT_SOURCE_ROOT_DEFAULT="\"$(abspath ./include)/\""
944
945%.cpp.tidy : %.cpp
946	$(CLANG_TIDY) $(TIDY_OPTS) $^ -- $(CPPFLAGS) --std=c++11 -I$(CUDA_DIR)/include -I$(OCCA_DIR)/include -I$(ROCM_DIR)/include
947
948tidy-c   : $(libceed.c:%=%.tidy)
949tidy-cpp : $(libceed.cpp:%=%.tidy)
950
951tidy : tidy-c tidy-cpp
952
953# Include-What-You-Use
954ifneq ($(wildcard ../iwyu/*),)
955  IWYU_DIR ?= ../iwyu
956  IWYU_CC  ?= $(IWYU_DIR)/build/bin/include-what-you-use
957endif
958iwyu :
959	$(MAKE) -B CC=$(IWYU_CC)
960
961
962# ------------------------------------------------------------
963# Variable printing for debugging
964# ------------------------------------------------------------
965
966print :
967	@echo $(VAR)=$($(VAR))
968
969print-% :
970	$(info [ variable name]: $*)
971	$(info [        origin]: $(origin $*))
972	$(info [        flavor]: $(flavor $*))
973	$(info [         value]: $(value $*))
974	$(info [expanded value]: $($*))
975	$(info )
976	@true
977
978
979# ------------------------------------------------------------
980# Configuration caching
981# ------------------------------------------------------------
982# "make configure" detects any variables passed on the command line or
983# previously set in config.mk, caching them in config.mk as simple
984# (:=) variables.  Variables set in config.mk or on the command line
985# take precedence over the defaults provided in the file.  Typical
986# usage:
987#
988#   make configure CC=/path/to/my/cc CUDA_DIR=/opt/cuda
989#   make
990#   make prove
991#
992# The values in the file can be updated by passing them on the command
993# line, e.g.,
994#
995#   make configure CC=/path/to/other/clang
996
997# All variables to consider for caching
998CONFIG_VARS = CC CXX FC NVCC NVCC_CXX HIPCC \
999  OPT CFLAGS CPPFLAGS CXXFLAGS FFLAGS NVCCFLAGS HIPCCFLAGS SYCLFLAGS \
1000  AR ARFLAGS LDFLAGS LDLIBS LIBCXX SED \
1001  MAGMA_DIR OCCA_DIR XSMM_DIR CUDA_DIR CUDA_ARCH MFEM_DIR PETSC_DIR NEK5K_DIR ROCM_DIR HIP_ARCH SYCL_DIR
1002
1003# $(call needs_save,CFLAGS) returns true (a nonempty string) if CFLAGS
1004# was set on the command line or in config.mk (where it will appear as
1005# a simple variable).
1006needs_save = $(or $(filter command line,$(origin $(1))),$(filter simple,$(flavor $(1))))
1007
1008configure :
1009	$(file > $(CONFIG))
1010	$(foreach v,$(CONFIG_VARS),$(if $(call needs_save,$(v)),$(file >> $(CONFIG),$(v) := $($(v)))))
1011	@echo "Configuration cached in $(CONFIG):"
1012	@cat $(CONFIG)
1013
1014
1015# ------------------------------------------------------------
1016# Building Python wheels for deployment
1017# ------------------------------------------------------------
1018wheel : export MARCHFLAG = -march=generic
1019wheel : export WHEEL_PLAT = manylinux2010_x86_64
1020wheel :
1021	docker run -it --user $(shell id -u):$(shell id -g) --rm -v $(PWD):/io -w /io \
1022	  -e MARCHFLAG -e WHEEL_PLAT \
1023	  quay.io/pypa/$(WHEEL_PLAT) python/make-wheels.sh
1024
1025# ------------------------------------------------------------
1026# Phony targets
1027# ------------------------------------------------------------
1028# These targets are not files but rather commands to run
1029.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
1030
1031
1032# Include *.d deps when not -B = --always-make: useful if the paths are wonky in a container
1033-include $(if $(filter B,$(MAKEFLAGS)),,$(libceed.c:%.c=$(OBJDIR)/%.d) $(tests.c:tests/%.c=$(OBJDIR)/%.d))
1034