forked from SmileiPIC/Smilei
-
Notifications
You must be signed in to change notification settings - Fork 0
/
makefile
executable file
·321 lines (268 loc) · 10.9 KB
/
makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
#-----------------------------------------------------
# Variables that can be defined by the user:
#
# SMILEICXX : the MPI C++ executable (for instance mpicxx, mpiicpc, etc.)
# HDF5_ROOT_DIR : the local path to the HDF5 library
# BUILD_DIR : the path to the build directory (default: ./build)
# PYTHON_CONFIG : the executable `python-config` usually shipped with python installation
SMILEICXX ?= mpicxx
HDF5_ROOT_DIR ?= $(HDF5_ROOT)
BUILD_DIR ?= build
PYTHONEXE ?= python
#-----------------------------------------------------
# check whether to use a machine specific definitions
ifneq ($(machine),)
ifneq ($(wildcard scripts/CompileTools/machine/$(machine)),)
-include scripts/CompileTools/machine/$(machine)
endif
endif
PYTHONCONFIG := $(PYTHONEXE) scripts/CompileTools/python-config.py
#-----------------------------------------------------
# Git information
VERSION:=$(shell $(PYTHONEXE) scripts/CompileTools/get-version.py )
#-----------------------------------------------------
# Directories and files
DIRS := $(shell find src -type d)
SRCS := $(shell find src/* -name \*.cpp)
OBJS := $(addprefix $(BUILD_DIR)/, $(SRCS:.cpp=.o))
DEPS := $(addprefix $(BUILD_DIR)/, $(SRCS:.cpp=.d))
SITEDIR = $(shell $(PYTHONEXE) -c 'import site; site._script()' --user-site)
#-----------------------------------------------------
# Flags
# Smilei version
CXXFLAGS += -D__VERSION=\"$(VERSION)\" -D_VECTO
# C++ version
CXXFLAGS += -std=c++11 -Wall #-Wshadow
# HDF5 library
ifneq ($(strip $(HDF5_ROOT_DIR)),)
CXXFLAGS += -I$(HDF5_ROOT_DIR)/include
LDFLAGS := -L$(HDF5_ROOT_DIR)/lib $(LDFLAGS)
endif
LDFLAGS += -lhdf5
# Include subdirs
CXXFLAGS += $(DIRS:%=-I%)
# Python-related flags
CXXFLAGS += -I$(BUILD_DIR)/src/Python
PYSCRIPTS = $(shell find src/Python -name \*.py)
PYHEADERS := $(addprefix $(BUILD_DIR)/, $(PYSCRIPTS:.py=.pyh))
PY_CXXFLAGS := $(shell $(PYTHONCONFIG) --includes)
CXXFLAGS += $(PY_CXXFLAGS)
PY_LDFLAGS := $(shell $(PYTHONCONFIG) --ldflags)
LDFLAGS += $(PY_LDFLAGS)
ifneq ($(strip $(PYTHONHOME)),)
LDFLAGS += -L$(PYTHONHOME)/lib
endif
PICSAR=FALSE
ifeq ($(PICSAR),TRUE)
# New environment variable
FFTW3_LIB ?= $(FFTW_LIB_DIR)
LIBPXR ?= picsar/lib
# Set Picsar link environment
CXXFLAGS += -D_PICSAR
LDFLAGS += -L$(LIBPXR) -lpxr
LDFLAGS += -L$(FFTW3_LIB) -lfftw3_mpi
LDFLAGS += -L$(FFTW3_LIB) -lfftw3_threads
LDFLAGS += -L$(FFTW3_LIB) -lfftw3
LDFLAGS += -lgfortran
endif
CXXFLAGS += -D_VECTO
# Manage options in the "config" parameter
ifneq (,$(findstring debug,$(config)))
CXXFLAGS += -g -pg -D__DEBUG -O0
# With gdb
else ifneq (,$(findstring gdb,$(config)))
CXXFLAGS += -g -D__DEBUG -O0
# With valgrind
else ifneq (,$(findstring valgrind,$(config)))
CXXFLAGS += -g -O3
# Scalasca
else ifneq (,$(findstring scalasca,$(config)))
CXXFLAGS += -g -O3
SMILEICXX = scalasca -instrument $(SMILEICXX)
# With Intel Advisor / Vtune
else ifneq (,$(findstring advisor,$(config)))
CXXFLAGS += -g -O3 -shared-intel -debug inline-debug-info -qopenmp-link dynamic -parallel-source-info=2
# With Intel Inspector
else ifneq (,$(findstring inspector,$(config)))
CXXFLAGS += -g -O0 -I$(INSPECTOR_ROOT_DIR)/include/
LDFLAGS += $(INSPECTOR_ROOT_DIR)/lib64/libittnotify.a
# Optimization report
else ifneq (,$(findstring opt-report,$(config)))
CXXFLAGS += -O3 -qopt-report5
# Default configuration
else
CXXFLAGS += -O3 -g #-xHost -no-prec-div -ipo
endif
# Manage options in the "config" parameter
ifneq (,$(findstring detailed_timers,$(config)))
CXXFLAGS += -D__DETAILED_TIMERS
endif
ifeq (,$(findstring noopenmp,$(config)))
OPENMP_FLAG ?= -fopenmp
LDFLAGS += -lm
OPENMP_FLAG += -D_OMP
LDFLAGS += $(OPENMP_FLAG)
CXXFLAGS += $(OPENMP_FLAG)
else
LDFLAGS += -mt_mpi # intelmpi only
endif
# Manage MPI communications by a single thread (master in MW)
ifneq (,$(findstring no_mpi_tm,$(config)))
CXXFLAGS += -D_NO_MPI_TM
endif
#-----------------------------------------------------
# Set the verbosity prefix
ifeq (,$(findstring verbose,$(config)))
Q := @
else
Q :=
endif
#-----------------------------------------------------
# Rules for building the excutable smilei
EXEC = smilei
default: $(EXEC) $(EXEC)_test
clean:
@echo "Cleaning $(BUILD_DIR)"
$(Q) rm -rf $(BUILD_DIR)
$(Q) rm -rf $(EXEC)-$(VERSION).tgz
distclean: clean uninstall_happi
$(Q) rm -f $(EXEC) $(EXEC)_test
# Create python header files
$(BUILD_DIR)/%.pyh: %.py
@echo "Creating binary char for $<"
$(Q) if [ ! -d "$(@D)" ]; then mkdir -p "$(@D)"; fi;
$(Q) $(PYTHONEXE) scripts/CompileTools/hexdump.py "$<" "$@"
# Calculate dependencies
$(BUILD_DIR)/%.d: %.cpp
@echo "Checking dependencies for $<"
$(Q) if [ ! -d "$(@D)" ]; then mkdir -p "$(@D)"; fi;
$(Q) $(SMILEICXX) $(CXXFLAGS) -MF"$@" -MM -MP -MT"$@ $(@:.d=.o)" $<
$(BUILD_DIR)/src/Diagnostic/DiagnosticScalar.o : src/Diagnostic/DiagnosticScalar.cpp
@echo "SPECIAL COMPILATION FOR $<"
$(Q) $(SMILEICXX) $(CXXFLAGS) -O1 -c $< -o $@
# Compile cpps
$(BUILD_DIR)/%.o : %.cpp
@echo "Compiling $<"
$(Q) $(SMILEICXX) $(CXXFLAGS) -c $< -o $@
# Link the main program
$(EXEC): $(OBJS)
@echo "Linking $@"
$(Q) $(SMILEICXX) $(OBJS) -o $(BUILD_DIR)/$@ $(LDFLAGS)
$(Q) cp $(BUILD_DIR)/$@ $@
# Compile the the main program again for test mode
$(BUILD_DIR)/src/Smilei_test.o: src/Smilei.cpp $(EXEC)
@echo "Compiling src/Smilei.cpp for test mode"
$(Q) $(SMILEICXX) $(CXXFLAGS) -DSMILEI_TESTMODE -c src/Smilei.cpp -o $@
# Link the main program for test mode
$(EXEC)_test : $(OBJS:Smilei.o=Smilei_test.o)
@echo "Linking $@ for test mode"
$(Q) $(SMILEICXX) $(OBJS:Smilei.o=Smilei_test.o) -o $(BUILD_DIR)/$@ $(LDFLAGS)
$(Q) cp $(BUILD_DIR)/$@ $@
# Avoid to check dependencies and to create .pyh if not necessary
FILTER_RULES=clean distclean help env debug doc tar happi uninstall_happi
ifeq ($(filter-out $(wildcard print-*),$(MAKECMDGOALS)),)
ifeq ($(filter $(FILTER_RULES),$(MAKECMDGOALS)),)
# Let's try to make the next lines clear: we include $(DEPS) and pygenerator
-include $(DEPS) pygenerator
# and pygenerator will create all the $(PYHEADERS) (which are files)
pygenerator : $(PYHEADERS)
endif
endif
# these are not file-related rules
.PHONY: pygenerator $(FILTER_RULES)
#-----------------------------------------------------
# Doc rules
doc:
$(Q) if type "sphinx-build" >/dev/null 2>&1; then\
make -C doc/Sphinx BUILDDIR=../../$(BUILD_DIR) html;\
echo "Sphinx documentation in $(BUILD_DIR)/html/index.html";\
else \
echo "Cannot build Sphinx doc because Sphinx is not installed";\
fi
#-----------------------------------------------------
# Archive in tgz file
tar:
@echo "Creating archive $(EXEC)-$(VERSION).tgz"
$(Q) git archive -o $(EXEC)-$(VERSION).tgz --prefix $(EXEC)-$(VERSION)/ HEAD
$(Q) tar -zxf $(EXEC)-$(VERSION).tgz
$(Q) echo $(VERSION) > $(EXEC)-$(VERSION)/.version
$(Q) tar -czf $(EXEC)-$(VERSION).tgz $(EXEC)-$(VERSION) && rm -R $(EXEC)-$(VERSION)
#-----------------------------------------------------
# astyle
style:
@echo "Astyle is applied on all files"
$(Q) astyle --style=1tbs --fill-empty-lines --pad-comma --unpad-paren --pad-paren-in --align-pointer=name --align-reference=name -n -r src/*.cpp,*.h
#-----------------------------------------------------
# Python module rules
# Install the python module in the user python path
happi:
@echo "Installing $(SITEDIR)/smilei.pth"
$(Q) mkdir -p "$(SITEDIR)"
$(Q) echo "$(CURDIR)" > "$(SITEDIR)/smilei.pth"
uninstall_happi:
@echo "Uninstalling $(SITEDIR)/smilei.pth"
$(Q) rm -f "$(SITEDIR)/smilei.pth"
#-----------------------------------------------------
# Info rules
print-% :
$(info $* : $($*)) @true
env: print-SMILEICXX print-PYTHONEXE print-MPIVERSION print-VERSION print-OPENMP_FLAG print-HDF5_ROOT_DIR print-SITEDIR print-PY_CXXFLAGS print-PY_LDFLAGS print-CXXFLAGS print-LDFLAGS
#-----------------------------------------------------
# help
help:
@echo 'TO BUILD SMILEI:'
@echo '----------------'
@echo 'Usage:'
@echo ' make'
@echo 'or, to compile with 4 cpus (for instance):'
@echo ' make -j 4'
@echo
@echo 'Config options:'
@echo ' make config="[ verbose ] [ debug ] [ scalasca ] [ noopenmp ]"'
@echo ' verbose : to print compile command lines'
@echo ' debug : to compile in debug mode (code runs really slow)'
@echo ' detailed_timers : to compile the code with more refined timers (refined time report)'
@echo ' noopenmp : to compile without openmp'
@echo ' no_mpi_tm : to compile with a MPI library without MPI_THREAD_MULTIPLE support'
@echo ' opt-report : to generate a report about optimization, vectorization and inlining (Intel compiler)'
@echo ' scalasca : to compile using scalasca'
@echo ' advisor : to compile for Intel Advisor analysis'
@echo ' vtune : to compile for Intel Vtune analysis'
@echo ' inspector : to compile for Intel Inspector analysis'
@echo
@echo 'Examples:'
@echo ' make config=verbose'
@echo ' make config=debug'
@echo ' make config="debug noopenmp"'
@echo
@echo 'Machine options:'
@echo ' make machine=XXX : include machine file in scripts/CompileTools/machine/XXX'
@echo ' make machine=XXX help : print help for machine'
@echo
@echo 'OTHER PURPOSES:'
@echo '---------------'
@echo ' make doc : builds the documentation'
@echo ' make tar : creates an archive of the sources'
@echo ' make clean : cleans the build directory'
@echo " make happi : install Smilei's python module"
@echo " make uninstall_happi : remove Smilei's python module"
@echo ' make env : print important internal makefile variables'
@echo ' make print-XXX : print internal makefile variable XXX'
@echo ''
@echo 'Environment variables:'
@echo ' SMILEICXX : mpi c++ compiler [$(SMILEICXX)]'
@echo ' HDF5_ROOT_DIR : HDF5 dir. Defaults to the value of HDF5_ROOT [$(HDF5_ROOT_DIR)]'
@echo ' BUILD_DIR : directory used to store build files [$(BUILD_DIR)]'
@echo ' OPENMP_FLAG : openmp flag [$(OPENMP_FLAG)]'
@echo ' PYTHONEXE : python executable [$(PYTHONEXE)]'
@echo ' FFTW3_LIB : FFTW3 libraries directory [$(FFTW3_LIB)]'
@echo ' LIB PXR : Picsar library directory [$(LIBPXR)]'
@echo
@echo 'Intel Inspector environment:'
@echo ' INSPECTOR_ROOT_DIR : only needed to use the inspector API (__itt functions) [$(INSPECTOR_ROOT_DIR)]'
@echo
@echo 'http://www.maisondelasimulation.fr/smilei'
@echo 'https://github.com/SmileiPIC/Smilei'
@echo
@if [ -f scripts/CompileTools/machine/$(machine) ]; then echo "Machine comments for $(machine):"; grep '^#' scripts/CompileTools/machine/$(machine)|| echo "None"; fi
@if [ -f scripts/CompileTools/machine/$(machine) ]; then echo "Machine comments for $(machine):"; grep '^#' scripts/CompileTools/machine/$(machine) || echo "None"; else echo "Available machines:"; ls -1 scripts/CompileTools/machine; fi