forked from QuEST-Kit/QuEST
-
Notifications
You must be signed in to change notification settings - Fork 0
/
makefile
353 lines (264 loc) · 9.05 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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# This makefile builds the QuEST library and links/compiles user code
# While attempting to accomodate as many platforms and compilers,
# unforeseen problems are inevitable: please email [email protected]
# or [email protected] about any errors or complications, or
# raise an issue on Github
#======================================================================#
# #
# User settings #
# #
#======================================================================#
# name of the executable to create
EXE = demo
# space-separated names (no file type) of all user source files (.c or .cpp) in the root directory
SOURCES = tutorial_example
# path to QuEST library from root directory
QUEST_DIR = QuEST
# compiler to use, which should support both C and C++, to be wrapped by GPU/MPI compilers
COMPILER = gcc
# type of above compiler, one of {GNU, INTEL, CLANG}, used for setting compiler flags
COMPILER_TYPE = GNU
# hardwares to target: 1 means use, 0 means don't use
MULTITHREADED = 0
DISTRIBUTED = 0
GPUACCELERATED = 0
# GPU hardware dependent, lookup at https://developer.nvidia.com/cuda-gpus, write without fullstop
GPU_COMPUTE_CAPABILITY = 30
# whether to suppress the below warnings about compiler compatibility
SUPPRESS_WARNING = 0
# whether to use single, double or quad floating point precision in the state-vector {1,2,4}
PRECISION = 2
#======================================================================#
# #
# Checking user settings #
# #
#======================================================================#
# suppresses all non-gcc output, useful for calling scripts
SILENT = 0
# always allow cleaning without errors or warnings
ifneq ($(MAKECMDGOALS), clean)
ifneq ($(MAKECMDGOALS), veryclean)
ifneq ($(SILENT), 1)
# check $COMPILER_TYPE is correct
ifneq ($(COMPILER_TYPE), CLANG)
ifneq ($(COMPILER_TYPE), GNU)
ifneq ($(COMPILER_TYPE), INTEL)
$(error COMPILER_TYPE must be one of CLANG, GNU or INTEL)
endif
endif
endif
# distributed GPU not supported
ifeq ($(DISTRIBUTED), 1)
ifeq ($(GPUACCELERATED), 1)
$(error Distributed GPU acceleration not supported)
endif
endif
# GPU doesn't use threading
ifeq ($(MULTITHREADED), 1)
ifeq ($(GPUACCELERATED), 1)
$(warning GPU acceleration makes no use of multithreading. Disabling the latter...)
override MULTITHREADED = 0
endif
endif
# CLANG compilers don't support threading
ifeq ($(MULTITHREADED), 1)
ifeq ($(COMPILER_TYPE), CLANG)
$(warning Clang does not support multithreading. Disabling...)
override MULTITHREADED = 0
endif
endif
# check PRECISION is valid
ifneq ($(PRECISION), 1)
ifneq ($(PRECISION), 2)
ifneq ($(PRECISION), 4)
$(error PRECISION must be set to 1, 2 or 4)
endif
endif
endif
# GPU does not support quad precision
ifeq ($(PRECISION), 4)
ifeq ($(GPUACCELERATED), 1)
$(warning GPUs do not support quad precision. Setting PRECISION=2...)
override PRECISION = 2
endif
endif
# NVCC doesn't support new CLANG compilers
ifeq ($(GPUACCELERATED), 1)
ifeq ($(COMPILER_TYPE), CLANG)
ifeq ($(SUPPRESS_WARNING), 0)
$(info Some versions of Clang are not NVIDIA-GPU compatible. If compilation fails, try Clang 3.7)
endif
endif
endif
# NVCC doesn't support GNU compilers on OSX
ifeq ($(GPUACCELERATED), 1)
ifeq ($(COMPILER_TYPE), GNU)
ifeq ($(SUPPRESS_WARNING), 0)
$(info On some platforms (e.g. OSX), NVIDIA-GPUs are not compatible with GNU compilers. If compilation fails, try an alternative compiler, like Clang 3.7)
endif
endif
endif
# end of allowed cleaning
endif
endif
endif
#======================================================================#
# #
# Compilation #
# #
#======================================================================#
#
# --- libraries
#
LIBS = -lm
QUEST_COMMON_DIR = $(QUEST_DIR)
ifeq ($(GPUACCELERATED), 1)
QUEST_INNER_DIR = $(QUEST_DIR)/GPU
else
QUEST_INNER_DIR = $(QUEST_DIR)/CPU
endif
QUEST_INCLUDE = -I$(QUEST_INNER_DIR) -I$(QUEST_COMMON_DIR)
#
# --- wrapper compilers
#
CUDA_COMPILER = nvcc
MPI_COMPILER = mpicc
#
# --- compiler flags
#
# note:
# several flag names depend not just on the compiler type, but also compiler version
# the user should update these below. For example:
#
# - GNU C++ compilers of version < 4.7 use -std=c++0x instead of -std=c++11
# - INTEL compilers of version < ? use -openmp instead of -qopenmp
# - INTEL compilers of version < ? won't recognise -diad-disable and -cpu-dispatch
# - CLANG compilers don't support openmp (threading) at all
# threading flag
ifeq ($(MULTITHREADED), 1)
ifeq ($(COMPILER_TYPE), GNU)
THREAD_FLAGS = -fopenmp
else ifeq ($(COMPILER_TYPE), INTEL)
THREAD_FLAGS = -qopenmp
endif
else
THREAD_FLAGS =
endif
# c
C_CLANG_FLAGS = -O2 -std=c99 -mavx -Wall -DQuEST_PREC=$(PRECISION)
C_GNU_FLAGS = -O2 -std=c99 -mavx -Wall -DQuEST_PREC=$(PRECISION) $(THREAD_FLAGS)
C_INTEL_FLAGS = -O2 -std=c99 -fprotect-parens -Wall -xAVX -axCORE-AVX2 -diag-disable -cpu-dispatch -DQuEST_PREC=$(PRECISION) $(THREAD_FLAGS)
# c++
CPP_CLANG_FLAGS = -O2 -std=c++11 -mavx -Wall -DQuEST_PREC=$(PRECISION)
CPP_GNU_FLAGS = -O2 -std=c++11 -mavx -Wall -DQuEST_PREC=$(PRECISION) $(THREAD_FLAGS)
CPP_INTEL_FLAGS = -O2 -std=c++11 -fprotect-parens -Wall -xAVX -axCORE-AVX2 -diag-disable -cpu-dispatch -DQuEST_PREC=$(PRECISION) $(THREAD_FLAGS)
# wrappers
CPP_CUDA_FLAGS = -O2 -arch=compute_$(GPU_COMPUTE_CAPABILITY) -code=sm_$(GPU_COMPUTE_CAPABILITY) -DQuEST_PREC=$(PRECISION) -ccbin $(COMPILER)
# choose c/c++ flags based on compiler type
ifeq ($(COMPILER_TYPE), CLANG)
C_FLAGS = $(C_CLANG_FLAGS)
CPP_FLAGS = $(CPP_CLANG_FLAGS)
else ifeq ($(COMPILER_TYPE), GNU)
C_FLAGS = $(C_GNU_FLAGS)
CPP_FLAGS = $(CPP_GNU_FLAGS)
else ifeq ($(COMPILER_TYPE), INTEL)
C_FLAGS = $(C_INTEL_FLAGS)
CPP_FLAGS = $(CPP_INTEL_FLAGS)
endif
#
# --- compiler environment vars
#
MPI_WRAPPED_COMP = I_MPI_CC=$(COMPILER) OMPI_CC=$(COMPILER) MPICH_CC=$(COMPILER)
#
# --- targets
#
OBJ = QuEST.o QuEST_validation.o QuEST_common.o QuEST_qasm.o mt19937ar.o
ifeq ($(GPUACCELERATED), 1)
OBJ += QuEST_gpu.o
else ifeq ($(DISTRIBUTED), 1)
OBJ += QuEST_cpu.o QuEST_cpu_distributed.o
else
OBJ += QuEST_cpu.o QuEST_cpu_local.o
endif
OBJ += $(addsuffix .o, $(SOURCES))
#
# --- rules
#
# notes:
# - if $SOURCES appear as both c and c++ files, the c files will be compiled
# - CUDA won't compile .c files ($COMPILER will), only .cpp and .cu
# - MPICC will compile .c and .cpp files (wrapping $COMPILER)
# GPU
ifeq ($(GPUACCELERATED), 1)
%.o: %.c
$(COMPILER) -x c $(C_FLAGS) $(QUEST_INCLUDE) -c $<
%.o: $(QUEST_INNER_DIR)/%.c
$(COMPILER) -x c $(C_FLAGS) -c $<
%.o: $(QUEST_COMMON_DIR)/%.c
$(COMPILER) -x c $(C_FLAGS) -c $<
%.o: %.cu
$(CUDA_COMPILER) -dc $(CPP_CUDA_FLAGS) $(QUEST_INCLUDE) $<
%.o: $(QUEST_INNER_DIR)/%.cu
$(CUDA_COMPILER) -dc $(CPP_CUDA_FLAGS) $<
%.o: %.cpp
$(CUDA_COMPILER) -dc $(CPP_CUDA_FLAGS) $(QUEST_INCLUDE) $<
%.o: $(QUEST_INNER_DIR)/%.cpp
$(CUDA_COMPILER) -dc $(CPP_CUDA_FLAGS) $<
# distributed
else ifeq ($(DISTRIBUTED), 1)
%.o: %.c
$(MPI_WRAPPED_COMP) $(MPI_COMPILER) -x c $(C_FLAGS) $(QUEST_INCLUDE) -c $<
%.o: $(QUEST_INNER_DIR)/%.c
$(MPI_WRAPPED_COMP) $(MPI_COMPILER) -x c $(C_FLAGS) -c $<
%.o: $(QUEST_COMMON_DIR)/%.c
$(MPI_WRAPPED_COMP) $(MPI_COMPILER) -x c $(C_FLAGS) -c $<
%.o: %.cpp
$(MPI_WRAPPED_COMP) $(MPI_COMPILER) $(CPP_FLAGS) $(QUEST_INCLUDE) -c $<
%.o: $(QUEST_INNER_DIR)/%.cpp
$(MPI_WRAPPED_COMP) $(MPI_COMPILER) $(CPP_FLAGS) -c $<
# CPU
else
%.o: %.c
$(COMPILER) -x c $(C_FLAGS) $(QUEST_INCLUDE) -c $<
%.o: $(QUEST_INNER_DIR)/%.c
$(COMPILER) -x c $(C_FLAGS) -c $<
%.o: $(QUEST_COMMON_DIR)/%.c
$(COMPILER) -x c $(C_FLAGS) -c $<
%.o: %.cpp
$(COMPILER) $(CPP_FLAGS) $(QUEST_INCLUDE) -c $<
%.o: $(QUEST_INNER_DIR)/%.cpp
$(COMPILER) $(CPP_FLAGS) -c $<
endif
#
# --- build
#
# CUDA
ifeq ($(GPUACCELERATED), 1)
all: $(OBJ)
$(CUDA_COMPILER) $(CPP_CUDA_FLAGS) $(QUEST_INCLUDE) -o $(EXE) $(OBJ) $(LIBS)
# MPI
else ifeq ($(DISTRIBUTED), 1)
default: $(EXE)
$(EXE): $(OBJ)
$(MPI_WRAPPED_COMP) $(MPI_COMPILER) $(C_FLAGS) $(QUEST_INCLUDE) -o $(EXE) $(OBJ) $(LIBS)
# C
else
default: $(EXE)
$(EXE): $(OBJ)
$(COMPILER) $(C_FLAGS) $(QUEST_INCLUDE) -o $(EXE) $(OBJ) $(LIBS)
endif
#
# --- clean
#
.PHONY: clean veryclean
clean:
/bin/rm -f *.o $(EXE)
veryclean: clean
/bin/rm -f *.h~ *.c~ makefile~
#
# --- debug
#
print-%:
@echo $*=$($*)
getvalue-%:
@echo $($*)