xref: /libCEED/Makefile (revision da72e7fc536c2662a0d480daeaab698083485d9d)
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 := /cpu/self/ref /cpu/self/tmpl /cpu/self/opt
102
103# Tests
104tests.c   := $(sort $(wildcard tests/t[0-9][0-9][0-9]-*.c))
105tests.f   := $(sort $(wildcard tests/t[0-9][0-9][0-9]-*.f))
106tests     := $(tests.c:tests/%.c=$(OBJDIR)/%)
107ctests    := $(tests)
108tests     += $(tests.f:tests/%.f=$(OBJDIR)/%)
109#examples
110examples.c := $(sort $(wildcard examples/ceed/*.c))
111examples.f := $(sort $(wildcard examples/ceed/*.f))
112examples  := $(examples.c:examples/ceed/%.c=$(OBJDIR)/%)
113examples  += $(examples.f:examples/ceed/%.f=$(OBJDIR)/%)
114#mfemexamples
115mfemexamples.cpp := $(sort $(wildcard examples/mfem/*.cpp))
116mfemexamples  := $(mfemexamples.cpp:examples/mfem/%.cpp=$(OBJDIR)/mfem-%)
117petscexamples.c := $(sort $(wildcard examples/petsc/*.c))
118petscexamples  := $(petscexamples.c:examples/petsc/%.c=$(OBJDIR)/petsc-%)
119
120# backends/[ref, template, optimized, occa, magma]
121ref.c      := $(sort $(wildcard backends/ref/*.c))
122template.c := $(sort $(wildcard backends/template/*.c))
123optimized.c:= $(sort $(wildcard backends/optimized/*.c))
124occa.c     := $(sort $(wildcard backends/occa/*.c))
125magma_preprocessor := python backends/magma/gccm.py
126magma_pre_src  := $(filter-out %_tmp.c, $(wildcard backends/magma/ceed-*.c))
127magma_dsrc     := $(wildcard backends/magma/magma_d*.c)
128magma_tmp.c    := $(magma_pre_src:%.c=%_tmp.c)
129magma_tmp.cu   := $(magma_pre_src:%.c=%_cuda.cu)
130magma_allsrc.c := $(magma_dsrc) $(magma_tmp.c)
131magma_allsrc.cu:= $(magma_tmp.cu)
132
133# Output using the 216-color rules mode
134rule_file = $(notdir $(1))
135rule_path = $(patsubst %/,%,$(dir $(1)))
136last_path = $(notdir $(patsubst %/,%,$(dir $(1))))
137ansicolor = $(shell echo $(call last_path,$(1)) | cksum | cut -b1-2 | xargs -IS expr 2 \* S + 17)
138emacs_out = @printf "  %10s %s/%s\n" $(1) $(call rule_path,$(2)) $(call rule_file,$(2))
139color_out = @if [ -t 1 ]; then \
140				printf "  %10s \033[38;5;%d;1m%s\033[m/%s\n" \
141					$(1) $(call ansicolor,$(2)) \
142					$(call rule_path,$(2)) $(call rule_file,$(2)); else \
143				printf "  %10s %s\n" $(1) $(2); fi
144# if TERM=dumb, use it, otherwise switch to the term one
145output = $(if $(TERM:dumb=),$(call color_out,$1,$2),$(call emacs_out,$1,$2))
146
147# if V is set to non-nil, turn the verbose mode
148quiet = $(if $(V),$($(1)),$(call output,$1,$@);$($(1)))
149
150# Cancel built-in and old-fashioned implicit rules which we don't use
151.SUFFIXES:
152
153.SECONDEXPANSION: # to expand $$(@D)/.DIR
154
155.SECONDARY: $(magma_tmp.c) $(magma_tmp.cu)
156
157%/.DIR :
158	@mkdir -p $(@D)
159	@touch $@
160
161.PRECIOUS: %/.DIR
162
163lib: $(libceed) $(ceed.pc)
164# run 'lib' target in parallel
165all:;@$(MAKE) $(MFLAGS) V=$(V) lib
166info:
167	$(info ------------------------------------)
168	$(info CC        = $(CC))
169	$(info FC        = $(FC))
170	$(info CPPFLAGS  = $(CPPFLAGS))
171	$(info CFLAGS    = $(value CFLAGS))
172	$(info FFLAGS    = $(value FFLAGS))
173	$(info NVCCFLAGS = $(value NVCCFLAGS))
174	$(info LDFLAGS   = $(value LDFLAGS))
175	$(info LDLIBS    = $(LDLIBS))
176	$(info OPT       = $(OPT))
177	$(info AFLAGS    = $(AFLAGS))
178	$(info ASAN      = $(or $(ASAN),(empty)))
179	$(info V         = $(or $(V),(empty)) [verbose=$(if $(V),on,off)])
180	$(info ------------------------------------)
181	$(info CUDA_DIR  = $(CUDA_DIR))
182	$(info OCCA_DIR  = $(OCCA_DIR))
183	$(info MAGMA_DIR = $(MAGMA_DIR))
184	$(info $1    Enabled backends:$(if $(OCCA_ON), OCCA)$(if \
185	  $(MAGMA_ON), 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	$(if $(OCCA_ON),\
199	  $(info libCEED: OCCA backend enabled [OCCA_DIR=$(OCCA_DIR)]))
200	$(if $(MAGMA_ON),\
201	  $(info libCEED: MAGMA backend enabled [MAGMA_DIR=$(MAGMA_DIR)]))
202	@true
203.PHONY: lib all info info-backends
204
205$(libceed) : LDFLAGS += $(if $(DARWIN), -install_name @rpath/$(notdir $(libceed)))
206
207libceed.c += $(ref.c)
208libceed.c += $(template.c)
209libceed.c += $(optimized.c)
210
211override OCCA_ON =
212ifneq ($(wildcard $(OCCA_DIR)/lib/libocca.*),)
213  override OCCA_ON = YES
214  $(libceed) : LDFLAGS += -L$(OCCA_DIR)/lib -Wl,-rpath,$(abspath $(OCCA_DIR)/lib)
215  $(libceed) : LDLIBS += -locca
216  libceed.c += $(occa.c)
217  $(occa.c:%.c=$(OBJDIR)/%.o) : CFLAGS += -I$(OCCA_DIR)/include
218  BACKENDS += /cpu/occa /gpu/occa /omp/occa
219endif
220
221override MAGMA_ON =
222ifneq ($(wildcard $(MAGMA_DIR)/lib/libmagma.*),)
223  CUDA_LIB_DIR := $(wildcard $(foreach d,lib lib64,$(CUDA_DIR)/$d/libcudart.${SO_EXT}))
224  CUDA_LIB_DIR := $(patsubst %/,%,$(dir $(firstword $(CUDA_LIB_DIR))))
225  ifneq ($(CUDA_LIB_DIR),)
226  override MAGMA_ON = YES
227  cuda_link = -Wl,-rpath,$(CUDA_LIB_DIR) -L$(CUDA_LIB_DIR) -lcublas -lcusparse -lcudart
228  omp_link = -fopenmp
229  magma_link_static = -L$(MAGMA_DIR)/lib -lmagma $(cuda_link) $(omp_link)
230  magma_link_shared = -L$(MAGMA_DIR)/lib -Wl,-rpath,$(abspath $(MAGMA_DIR)/lib) -lmagma
231  magma_link := $(if $(wildcard $(MAGMA_DIR)/lib/libmagma.${SO_EXT}),$(magma_link_shared),$(magma_link_static))
232  $(libceed)           : LDLIBS += $(magma_link)
233  $(tests) $(examples) : LDLIBS += $(magma_link)
234  libceed.c  += $(magma_allsrc.c)
235  libceed.cu += $(magma_allsrc.cu)
236  $(magma_allsrc.c:%.c=$(OBJDIR)/%.o) : CFLAGS += -DADD_ -I$(MAGMA_DIR)/include -I$(CUDA_DIR)/include
237  $(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
238  BACKENDS += /gpu/magma
239  endif
240endif
241
242export BACKENDS
243
244# generate magma_tmp.c and magma_cuda.cu from magma.c
245$(magma_tmp.c) $(magma_tmp.cu): $(magma_pre_src)
246	$(magma_preprocessor) $<
247
248libceed.o = $(libceed.c:%.c=$(OBJDIR)/%.o) $(libceed.cu:%.cu=$(OBJDIR)/%.o)
249$(libceed.o): | info-backends
250$(libceed) : $(libceed.o) | $$(@D)/.DIR
251	$(call quiet,CC) $(LDFLAGS) -shared -o $@ $^ $(LDLIBS)
252
253$(OBJDIR)/%.o : %.c | $$(@D)/.DIR
254	$(call quiet,CC) $(CPPFLAGS) $(CFLAGS) -c -o $@ $(abspath $<)
255
256$(OBJDIR)/%.o : %.cu | $$(@D)/.DIR
257	$(call quiet,NVCC) $(CPPFLAGS) $(NVCCFLAGS) -c -o $@ $(abspath $<)
258
259$(OBJDIR)/% : tests/%.c | $$(@D)/.DIR
260	$(call quiet,LINK.c) -o $@ $(abspath $<) -lceed $(LDLIBS)
261
262$(OBJDIR)/% : tests/%.f | $$(@D)/.DIR
263	$(call quiet,LINK.F) -o $@ $(abspath $<) -lceed $(LDLIBS)
264
265$(OBJDIR)/% : examples/ceed/%.c | $$(@D)/.DIR
266	$(call quiet,LINK.c) -o $@ $(abspath $<) -lceed $(LDLIBS)
267
268$(OBJDIR)/% : examples/ceed/%.f | $$(@D)/.DIR
269	$(call quiet,LINK.F) -o $@ $(abspath $<) -lceed $(LDLIBS)
270
271$(OBJDIR)/mfem-% : examples/mfem/%.cpp $(libceed) | $$(@D)/.DIR
272	$(MAKE) -C examples/mfem CEED_DIR=`pwd` $*
273	mv examples/mfem/$* $@
274
275$(OBJDIR)/petsc-% : examples/petsc/%.c $(libceed) $(ceed.pc) | $$(@D)/.DIR
276	$(MAKE) -C examples/petsc CEED_DIR=`pwd` $*
277	mv examples/petsc/$* $@
278
279$(tests) $(examples) : $(libceed)
280$(tests) $(examples) : LDFLAGS += -Wl,-rpath,$(abspath $(LIBDIR)) -L$(LIBDIR)
281
282run-% : $(OBJDIR)/%
283	@tests/tap.sh $(<:build/%=%)
284# Test core libCEED
285test : $(tests:$(OBJDIR)/%=run-%) $(examples:$(OBJDIR)/%=run-%)
286
287# run test target in parallel
288tst : ;@$(MAKE) $(MFLAGS) V=$(V) test
289# CPU C tests only for backend %
290ctc-% : $(ctests);@$(foreach tst,$(ctests),$(tst) /cpu/$*;)
291
292prove : $(tests) $(examples)
293	$(info Testing backends: $(BACKENDS))
294	$(PROVE) $(PROVE_OPTS) --exec 'tests/tap.sh' $(tests:$(OBJDIR)/%=%) $(examples:$(OBJDIR)/%=%)
295# run prove target in parallel
296prv : ;@$(MAKE) $(MFLAGS) V=$(V) prove
297
298alltests := $(tests) $(examples) $(if $(MFEM_DIR),$(mfemexamples)) $(if $(PETSC_DIR),$(petscexamples))
299prove-all : $(alltests)
300	$(info Testing backends: $(BACKENDS))
301	$(PROVE) $(PROVE_OPTS) --exec 'tests/tap.sh' $(alltests:$(OBJDIR)/%=%)
302
303examples : $(examples)
304
305$(ceed.pc) : pkgconfig-prefix = $(abspath .)
306$(OBJDIR)/ceed.pc : pkgconfig-prefix = $(prefix)
307.INTERMEDIATE : $(OBJDIR)/ceed.pc
308%/ceed.pc : ceed.pc.template | $$(@D)/.DIR
309	@sed "s:%prefix%:$(pkgconfig-prefix):" $< > $@
310
311OCCA        := $(OCCA_DIR)/bin/occa
312OKL_KERNELS := $(wildcard backends/occa/*.okl)
313
314okl-cache :
315	$(OCCA) cache ceed $(OKL_KERNELS)
316
317okl-clear:
318	$(OCCA) clear -y -l ceed
319
320install : $(libceed) $(OBJDIR)/ceed.pc
321	$(INSTALL) -d $(addprefix $(if $(DESTDIR),"$(DESTDIR)"),"$(includedir)"\
322	  "$(libdir)" "$(pkgconfigdir)" $(if $(OCCA_ON),"$(okldir)"))
323	$(INSTALL_DATA) include/ceed.h "$(DESTDIR)$(includedir)/"
324	$(INSTALL_DATA) include/ceedf.h "$(DESTDIR)$(includedir)/"
325	$(INSTALL_DATA) $(libceed) "$(DESTDIR)$(libdir)/"
326	$(INSTALL_DATA) $(OBJDIR)/ceed.pc "$(DESTDIR)$(pkgconfigdir)/"
327	$(if $(OCCA_ON),$(INSTALL_DATA) $(OKL_KERNELS) "$(DESTDIR)$(okldir)/")
328
329.PHONY : cln clean print test tst prove prv examples style install doc okl-cache okl-clear
330
331cln clean :
332	$(RM) -r $(OBJDIR) $(LIBDIR)
333	$(MAKE) -C examples/ceed clean
334	$(MAKE) -C examples/mfem clean
335	$(MAKE) -C examples/petsc clean
336	(cd examples/nek5000 && bash make-nek-examples.sh clean)
337	$(RM) $(magma_tmp.c) $(magma_tmp.cu) backends/magma/*~ backends/magma/*.o
338
339distclean : clean
340	$(RM) -r doc/html
341
342doc :
343	doxygen Doxyfile
344
345style :
346	astyle --style=google --indent=spaces=2 --max-code-length=80 \
347            --keep-one-line-statements --keep-one-line-blocks --lineend=linux \
348            --suffix=none --preserve-date --formatted \
349            --exclude=include/ceedf.h \
350            include/*.h interface/*.[ch] tests/*.[ch] backends/*/*.[ch] \
351            examples/*/*.[ch] examples/*/*.[ch]pp
352
353print :
354	@echo $(VAR)=$($(VAR))
355
356print-% :
357	$(info [ variable name]: $*)
358	$(info [        origin]: $(origin $*))
359	$(info [         value]: $(value $*))
360	$(info [expanded value]: $($*))
361	$(info )
362	@true
363
364-include $(libceed.c:%.c=build/%.d) $(tests.c:tests/%.c=build/%.d)
365