xref: /libCEED/Makefile (revision ba4bcd917872bbba2ca5b7fccd7fd5f16d3aa2e4)
1# Copyright (c) 2017-2018, Lawrence Livermore National Security, LLC.
2# Produced at the Lawrence Livermore National Laboratory. LLNL-CODE-734707.
3# All Rights reserved. See files LICENSE and NOTICE for details.
4#
5# This file is part of CEED, a collection of benchmarks, miniapps, software
6# libraries and APIs for efficient high-order finite element and spectral
7# element discretizations for exascale applications. For more information and
8# source code availability see http://github.com/ceed.
9#
10# The CEED research is supported by the Exascale Computing Project 17-SC-20-SC,
11# a collaborative effort of two U.S. Department of Energy organizations (Office
12# of Science and the National Nuclear Security Administration) responsible for
13# the planning and preparation of a capable exascale ecosystem, including
14# software, applications, hardware, advanced system engineering and early
15# testbed platforms, in support of the nation's exascale computing imperative.
16
17ifeq (,$(filter-out undefined default,$(origin CC)))
18  CC = gcc
19endif
20ifeq (,$(filter-out undefined default,$(origin FC)))
21  FC = gfortran
22endif
23NVCC = $(CUDA_DIR)/bin/nvcc
24
25# ASAN must be left empty if you don't want to use it
26ASAN ?=
27
28LDFLAGS ?=
29UNDERSCORE ?= 1
30
31# MFEM_DIR env variable should point to sibling directory
32ifneq ($(wildcard ../mfem/libmfem.*),)
33  MFEM_DIR?=../mfem
34endif
35
36# OCCA_DIR env variable should point to OCCA master (github.com/libocca/occa)
37OCCA_DIR ?= ../occa
38
39# env variable MAGMA_DIR can be used too
40MAGMA_DIR ?= ../magma
41# If CUDA_DIR is not set, check for nvcc, or resort to /usr/local/cuda
42CUDA_DIR  ?= $(or $(patsubst %/,%,$(dir $(patsubst %/,%,$(dir \
43               $(shell which nvcc 2> /dev/null))))),/usr/local/cuda)
44
45# Warning: SANTIZ options still don't run with /gpu/occa
46# export LSAN_OPTIONS=suppressions=.asanignore
47AFLAGS = -fsanitize=address #-fsanitize=undefined -fno-omit-frame-pointer
48
49OPT    = -O -g
50CFLAGS = -std=c99 $(OPT) -Wall -Wextra -Wno-unused-parameter -fPIC -MMD -MP
51NVCCFLAGS = $(OPT)
52# If using the IBM XL Fortran (xlf) replace FFLAGS appropriately:
53ifneq ($(filter %xlf %xlf_r,$(FC)),)
54  FFLAGS = $(OPT) -qpreprocess -qextname -qpic -MMD
55else # gfortran/Intel-style options
56  FFLAGS = -cpp     $(OPT) -Wall -Wextra -Wno-unused-parameter -Wno-unused-dummy-argument -fPIC -MMD -MP
57endif
58
59ifeq ($(UNDERSCORE), 1)
60  CFLAGS += -DUNDERSCORE
61endif
62
63ifeq ($(COVERAGE), 1)
64  CFLAGS += --coverage
65  LDFLAGS += --coverage
66endif
67
68CFLAGS += $(if $(ASAN),$(AFLAGS))
69FFLAGS += $(if $(ASAN),$(AFLAGS))
70LDFLAGS += $(if $(ASAN),$(AFLAGS))
71CPPFLAGS = -I./include
72LDLIBS = -lm
73OBJDIR := build
74LIBDIR := lib
75
76# Installation variables
77prefix ?= /usr/local
78bindir = $(prefix)/bin
79libdir = $(prefix)/lib
80okldir = $(libdir)/okl
81includedir = $(prefix)/include
82pkgconfigdir = $(libdir)/pkgconfig
83INSTALL = install
84INSTALL_PROGRAM = $(INSTALL)
85INSTALL_DATA = $(INSTALL) -m644
86
87# Get number of processors of the machine
88NPROCS := $(shell getconf _NPROCESSORS_ONLN)
89# prepare make options to run in parallel
90MFLAGS := -j $(NPROCS) --warn-undefined-variables \
91                       --no-print-directory --no-keep-going
92
93PROVE ?= prove
94PROVE_OPTS ?= -j $(NPROCS)
95DARWIN := $(filter Darwin,$(shell uname -s))
96SO_EXT := $(if $(DARWIN),dylib,so)
97
98ceed.pc := $(LIBDIR)/pkgconfig/ceed.pc
99libceed := $(LIBDIR)/libceed.$(SO_EXT)
100libceed.c := $(wildcard interface/ceed*.c)
101BACKENDS_BUILTIN := /cpu/self/ref /cpu/self/tmpl /cpu/self/blocked
102BACKENDS := $(BACKENDS_BUILTIN)
103
104# Tests
105tests.c   := $(sort $(wildcard tests/t[0-9][0-9][0-9]-*.c))
106tests.f   := $(sort $(wildcard tests/t[0-9][0-9][0-9]-*.f))
107tests     := $(tests.c:tests/%.c=$(OBJDIR)/%)
108ctests    := $(tests)
109tests     += $(tests.f:tests/%.f=$(OBJDIR)/%)
110#examples
111examples.c := $(sort $(wildcard examples/ceed/*.c))
112examples.f := $(sort $(wildcard examples/ceed/*.f))
113examples  := $(examples.c:examples/ceed/%.c=$(OBJDIR)/%)
114examples  += $(examples.f:examples/ceed/%.f=$(OBJDIR)/%)
115#mfemexamples
116mfemexamples.cpp := $(sort $(wildcard examples/mfem/*.cpp))
117mfemexamples  := $(mfemexamples.cpp:examples/mfem/%.cpp=$(OBJDIR)/mfem-%)
118petscexamples.c := $(sort $(wildcard examples/petsc/*.c))
119petscexamples  := $(petscexamples.c:examples/petsc/%.c=$(OBJDIR)/petsc-%)
120
121# backends/[ref, template, blocked, occa, magma]
122ref.c      := $(sort $(wildcard backends/ref/*.c))
123template.c := $(sort $(wildcard backends/template/*.c))
124blocked.c  := $(sort $(wildcard backends/blocked/*.c))
125occa.c     := $(sort $(wildcard backends/occa/*.c))
126magma_preprocessor := python backends/magma/gccm.py
127magma_pre_src  := $(filter-out %_tmp.c, $(wildcard backends/magma/ceed-*.c))
128magma_dsrc     := $(wildcard backends/magma/magma_d*.c)
129magma_tmp.c    := $(magma_pre_src:%.c=%_tmp.c)
130magma_tmp.cu   := $(magma_pre_src:%.c=%_cuda.cu)
131magma_allsrc.c := $(magma_dsrc) $(magma_tmp.c)
132magma_allsrc.cu:= $(magma_tmp.cu)
133
134# Output using the 216-color rules mode
135rule_file = $(notdir $(1))
136rule_path = $(patsubst %/,%,$(dir $(1)))
137last_path = $(notdir $(patsubst %/,%,$(dir $(1))))
138ansicolor = $(shell echo $(call last_path,$(1)) | cksum | cut -b1-2 | xargs -IS expr 2 \* S + 17)
139emacs_out = @printf "  %10s %s/%s\n" $(1) $(call rule_path,$(2)) $(call rule_file,$(2))
140color_out = @if [ -t 1 ]; then \
141				printf "  %10s \033[38;5;%d;1m%s\033[m/%s\n" \
142					$(1) $(call ansicolor,$(2)) \
143					$(call rule_path,$(2)) $(call rule_file,$(2)); else \
144				printf "  %10s %s\n" $(1) $(2); fi
145# if TERM=dumb, use it, otherwise switch to the term one
146output = $(if $(TERM:dumb=),$(call color_out,$1,$2),$(call emacs_out,$1,$2))
147
148# if V is set to non-nil, turn the verbose mode
149quiet = $(if $(V),$($(1)),$(call output,$1,$@);$($(1)))
150
151# Cancel built-in and old-fashioned implicit rules which we don't use
152.SUFFIXES:
153
154.SECONDEXPANSION: # to expand $$(@D)/.DIR
155
156.SECONDARY: $(magma_tmp.c) $(magma_tmp.cu)
157
158%/.DIR :
159	@mkdir -p $(@D)
160	@touch $@
161
162.PRECIOUS: %/.DIR
163
164lib: $(libceed) $(ceed.pc)
165# run 'lib' target in parallel
166all:;@$(MAKE) $(MFLAGS) V=$(V) lib
167backend_status = $(if $(filter $1,$(BACKENDS)), [backends: $1], [not found])
168info:
169	$(info ------------------------------------)
170	$(info CC        = $(CC))
171	$(info FC        = $(FC))
172	$(info CPPFLAGS  = $(CPPFLAGS))
173	$(info CFLAGS    = $(value CFLAGS))
174	$(info FFLAGS    = $(value FFLAGS))
175	$(info NVCCFLAGS = $(value NVCCFLAGS))
176	$(info LDFLAGS   = $(value LDFLAGS))
177	$(info LDLIBS    = $(LDLIBS))
178	$(info OPT       = $(OPT))
179	$(info AFLAGS    = $(AFLAGS))
180	$(info ASAN      = $(or $(ASAN),(empty)))
181	$(info V         = $(or $(V),(empty)) [verbose=$(if $(V),on,off)])
182	$(info ------------------------------------)
183	$(info OCCA_DIR  = $(OCCA_DIR)$(call backend_status,/cpu/occa /gpu/occa /omp/occa))
184	$(info MAGMA_DIR = $(MAGMA_DIR)$(call backend_status,/gpu/magma))
185	$(info CUDA_DIR  = $(CUDA_DIR)$(call backend_status,/gpu/magma))
186	$(info ------------------------------------)
187	$(info MFEM_DIR  = $(MFEM_DIR))
188	$(info PETSC_DIR = $(PETSC_DIR))
189	$(info ------------------------------------)
190	$(info prefix       = $(prefix))
191	$(info includedir   = $(value includedir))
192	$(info libdir       = $(value libdir))
193	$(info okldir       = $(value okldir))
194	$(info pkgconfigdir = $(value pkgconfigdir))
195	$(info ------------------------------------)
196	@true
197info-backends:
198	$(info make: 'lib' with optional backends: $(filter-out $(BACKENDS_BUILTIN),$(BACKENDS)))
199.PHONY: lib all info info-backends
200
201$(libceed) : LDFLAGS += $(if $(DARWIN), -install_name @rpath/$(notdir $(libceed)))
202
203libceed.c += $(ref.c)
204libceed.c += $(template.c)
205libceed.c += $(blocked.c)
206
207ifneq ($(wildcard $(OCCA_DIR)/lib/libocca.*),)
208  $(libceed) : LDFLAGS += -L$(OCCA_DIR)/lib -Wl,-rpath,$(abspath $(OCCA_DIR)/lib)
209  $(libceed) : LDLIBS += -locca
210  libceed.c += $(occa.c)
211  $(occa.c:%.c=$(OBJDIR)/%.o) : CFLAGS += -I$(OCCA_DIR)/include
212  BACKENDS += /cpu/occa /gpu/occa /omp/occa
213endif
214
215ifneq ($(wildcard $(MAGMA_DIR)/lib/libmagma.*),)
216  CUDA_LIB_DIR := $(wildcard $(foreach d,lib lib64,$(CUDA_DIR)/$d/libcudart.${SO_EXT}))
217  CUDA_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(CUDA_LIB_DIR))))
218  ifneq ($(CUDA_LIB_DIR),)
219  cuda_link = -Wl,-rpath,$(CUDA_LIB_DIR) -L$(CUDA_LIB_DIR) -lcublas -lcusparse -lcudart
220  omp_link = -fopenmp
221  magma_link_static = -L$(MAGMA_DIR)/lib -lmagma $(cuda_link) $(omp_link)
222  magma_link_shared = -L$(MAGMA_DIR)/lib -Wl,-rpath,$(abspath $(MAGMA_DIR)/lib) -lmagma
223  magma_link := $(if $(wildcard $(MAGMA_DIR)/lib/libmagma.${SO_EXT}),$(magma_link_shared),$(magma_link_static))
224  $(libceed)           : LDLIBS += $(magma_link)
225  $(tests) $(examples) : LDLIBS += $(magma_link)
226  libceed.c  += $(magma_allsrc.c)
227  libceed.cu += $(magma_allsrc.cu)
228  $(magma_allsrc.c:%.c=$(OBJDIR)/%.o) : CFLAGS += -DADD_ -I$(MAGMA_DIR)/include -I$(CUDA_DIR)/include
229  $(magma_allsrc.cu:%.cu=$(OBJDIR)/%.o) : NVCCFLAGS += --compiler-options=-fPIC -DADD_ -I$(MAGMA_DIR)/include -I$(MAGMA_DIR)/magmablas -I$(MAGMA_DIR)/control -I$(CUDA_DIR)/include
230  BACKENDS += /gpu/magma
231  endif
232endif
233
234export BACKENDS
235
236# generate magma_tmp.c and magma_cuda.cu from magma.c
237%_tmp.c %_cuda.cu : %.c
238	$(magma_preprocessor) $<
239
240libceed.o = $(libceed.c:%.c=$(OBJDIR)/%.o) $(libceed.cu:%.cu=$(OBJDIR)/%.o)
241$(libceed.o): | info-backends
242$(libceed) : $(libceed.o) | $$(@D)/.DIR
243	$(call quiet,CC) $(LDFLAGS) -shared -o $@ $^ $(LDLIBS)
244
245$(OBJDIR)/%.o : $(CURDIR)/%.c | $$(@D)/.DIR
246	$(call quiet,CC) $(CPPFLAGS) $(CFLAGS) -c -o $@ $(abspath $<)
247
248$(OBJDIR)/%.o : $(CURDIR)/%.cu | $$(@D)/.DIR
249	$(call quiet,NVCC) $(CPPFLAGS) $(NVCCFLAGS) -c -o $@ $(abspath $<)
250
251$(OBJDIR)/% : tests/%.c | $$(@D)/.DIR
252	$(call quiet,LINK.c) -o $@ $(abspath $<) -lceed $(LDLIBS)
253
254$(OBJDIR)/% : tests/%.f | $$(@D)/.DIR
255	$(call quiet,LINK.F) -o $@ $(abspath $<) -lceed $(LDLIBS)
256
257$(OBJDIR)/% : examples/ceed/%.c | $$(@D)/.DIR
258	$(call quiet,LINK.c) -o $@ $(abspath $<) -lceed $(LDLIBS)
259
260$(OBJDIR)/% : examples/ceed/%.f | $$(@D)/.DIR
261	$(call quiet,LINK.F) -o $@ $(abspath $<) -lceed $(LDLIBS)
262
263$(OBJDIR)/mfem-% : examples/mfem/%.cpp $(libceed) | $$(@D)/.DIR
264	$(MAKE) -C examples/mfem CEED_DIR=`pwd` $*
265	mv examples/mfem/$* $@
266
267$(OBJDIR)/petsc-% : examples/petsc/%.c $(libceed) $(ceed.pc) | $$(@D)/.DIR
268	$(MAKE) -C examples/petsc CEED_DIR=`pwd` $*
269	mv examples/petsc/$* $@
270
271$(tests) $(examples) : $(libceed)
272$(tests) $(examples) : LDFLAGS += -Wl,-rpath,$(abspath $(LIBDIR)) -L$(LIBDIR)
273
274run-% : $(OBJDIR)/%
275	@tests/tap.sh $(<:build/%=%)
276# Test core libCEED
277test : $(tests:$(OBJDIR)/%=run-%) $(examples:$(OBJDIR)/%=run-%)
278
279# run test target in parallel
280tst : ;@$(MAKE) $(MFLAGS) V=$(V) test
281# CPU C tests only for backend %
282ctc-% : $(ctests);@$(foreach tst,$(ctests),$(tst) /cpu/$*;)
283
284prove : $(tests) $(examples)
285	$(info Testing backends: $(BACKENDS))
286	$(PROVE) $(PROVE_OPTS) --exec 'tests/tap.sh' $(tests:$(OBJDIR)/%=%) $(examples:$(OBJDIR)/%=%)
287# run prove target in parallel
288prv : ;@$(MAKE) $(MFLAGS) V=$(V) prove
289
290alltests := $(tests) $(examples) $(if $(MFEM_DIR),$(mfemexamples)) $(if $(PETSC_DIR),$(petscexamples))
291prove-all : $(alltests)
292	$(info Testing backends: $(BACKENDS))
293	$(PROVE) $(PROVE_OPTS) --exec 'tests/tap.sh' $(alltests:$(OBJDIR)/%=%)
294
295examples : $(examples)
296
297$(ceed.pc) : pkgconfig-prefix = $(abspath .)
298$(OBJDIR)/ceed.pc : pkgconfig-prefix = $(prefix)
299.INTERMEDIATE : $(OBJDIR)/ceed.pc
300%/ceed.pc : ceed.pc.template | $$(@D)/.DIR
301	@sed "s:%prefix%:$(pkgconfig-prefix):" $< > $@
302
303OCCA        := $(OCCA_DIR)/bin/occa
304OKL_KERNELS := $(wildcard backends/occa/*.okl)
305
306okl-cache :
307	$(OCCA) cache ceed $(OKL_KERNELS)
308
309okl-clear:
310	$(OCCA) clear -y -l ceed
311
312install : $(libceed) $(OBJDIR)/ceed.pc
313	$(INSTALL) -d $(addprefix $(if $(DESTDIR),"$(DESTDIR)"),"$(includedir)"\
314	  "$(libdir)" "$(pkgconfigdir)" $(if $(OCCA_ON),"$(okldir)"))
315	$(INSTALL_DATA) include/ceed.h "$(DESTDIR)$(includedir)/"
316	$(INSTALL_DATA) include/ceedf.h "$(DESTDIR)$(includedir)/"
317	$(INSTALL_DATA) $(libceed) "$(DESTDIR)$(libdir)/"
318	$(INSTALL_DATA) $(OBJDIR)/ceed.pc "$(DESTDIR)$(pkgconfigdir)/"
319	$(if $(OCCA_ON),$(INSTALL_DATA) $(OKL_KERNELS) "$(DESTDIR)$(okldir)/")
320
321.PHONY : cln clean print test tst prove prv examples style install doc okl-cache okl-clear
322
323cln clean :
324	$(RM) -r $(OBJDIR) $(LIBDIR)
325	$(MAKE) -C examples/ceed clean
326	$(MAKE) -C examples/mfem clean
327	$(MAKE) -C examples/petsc clean
328	(cd examples/nek5000 && bash make-nek-examples.sh clean)
329	$(RM) $(magma_tmp.c) $(magma_tmp.cu) backends/magma/*~ backends/magma/*.o
330
331distclean : clean
332	$(RM) -r doc/html
333
334doc :
335	doxygen Doxyfile
336
337style :
338	astyle --style=google --indent=spaces=2 --max-code-length=80 \
339            --keep-one-line-statements --keep-one-line-blocks --lineend=linux \
340            --suffix=none --preserve-date --formatted \
341            --exclude=include/ceedf.h --exclude=tests/t310-basis-f.h \
342            include/*.h interface/*.[ch] tests/*.[ch] backends/*/*.[ch] \
343            examples/*/*.[ch] examples/*/*.[ch]pp -i
344
345print :
346	@echo $(VAR)=$($(VAR))
347
348print-% :
349	$(info [ variable name]: $*)
350	$(info [        origin]: $(origin $*))
351	$(info [         value]: $(value $*))
352	$(info [expanded value]: $($*))
353	$(info )
354	@true
355
356-include $(libceed.c:%.c=build/%.d) $(tests.c:tests/%.c=build/%.d)
357