forked from QEF/q-e
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CMakeLists.txt
752 lines (699 loc) · 28.6 KB
/
CMakeLists.txt
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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
# CMake < 3.13 cannot install external targets:
# https://gitlab.kitware.com/cmake/cmake/merge_requests/2152
# CMake < 3.14 generates incorrect dependency graphs with
# alias targets:
# https://gitlab.kitware.com/cmake/cmake/merge_requests/2521
# CMake < 3.20 does not support NVHPC compiler id
# https://cmake.org/cmake/help/latest/release/3.20.html#compilers
# Policy CMP0048: The project() command manages VERSION variables
set(CMAKE_POLICY_DEFAULT_CMP0048 NEW)
project(qe
VERSION 7.1
DESCRIPTION "ESPRESSO: opEn-Source Package for Research in Electronic Structure, Simulation, and Optimization"
LANGUAGES Fortran C)
if(${qe_BINARY_DIR} STREQUAL ${qe_SOURCE_DIR})
message(FATAL_ERROR "QE source folder cannot be safely used as a build folder!")
endif()
# CMake < v3.18 cannot discover the ARM Performance Library
if(CMAKE_SYSTEM_PROCESSOR MATCHES "^(aarch64.*|AARCH64.*|arm64.*|ARM64.*)")
if(CMAKE_VERSION VERSION_LESS 3.18.0)
message("-- CMake versions less than 3.18 cannot automatically discover the ARM Performance Library!")
endif()
endif()
##########################################################
# Define the paths for static libraries and executables
##########################################################
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${qe_BINARY_DIR}/lib
CACHE
PATH "Single output directory for building all libraries.")
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${qe_BINARY_DIR}/bin
CACHE
PATH "Single output directory for building all executables.")
###########################################################
# Build helpers
###########################################################
set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
include_directories("${CMAKE_CURRENT_SOURCE_DIR}/include")
include(cmake/qeHelpers.cmake)
###########################################################
# Build Type
# Ensure that a specific, default build type is set when
# none has been explicitly set by the user
###########################################################
qe_ensure_build_type("Release")
###########################################################
# Modules
###########################################################
include(CheckFunctionExists)
# Must use GNUInstallDirs to install libraries into correct
# locations on all platforms.
include(GNUInstallDirs)
###########################################################
# Build Options
###########################################################
include(CMakeDependentOption)
option(QE_ENABLE_CUDA
"enable CUDA acceleration on NVIDIA GPUs" OFF)
if(QE_ENABLE_CUDA)
option(QE_ENABLE_OPENACC "enable OpenACC acceleration" ON)
# OpenMP enabled by default if CUDA is enable
option(QE_ENABLE_OPENMP
"enable distributed execution support via OpenMP" ON)
else()
option(QE_ENABLE_OPENACC "enable OpenACC acceleration" OFF)
option(QE_ENABLE_OPENMP
"enable distributed execution support via OpenMP" OFF)
endif()
option(QE_ENABLE_MPI
"enable distributed execution support via MPI" ON)
option(QE_ENABLE_MPI_GPU_AWARE
"enable GPU aware MPI operations" OFF)
option(QE_ENABLE_TEST
"enable unit and system tests" ON)
cmake_dependent_option(QE_ENABLE_BENCHMARK
"enable benchmark tests" OFF "QE_ENABLE_TEST" OFF)
option(QE_ENABLE_TRACE
"enable execution tracing output" OFF)
option(QE_ENABLE_PROFILE_NVTX
"enable execution of NVIDIA NVTX profiler plugin" OFF)
option(QE_ENABLE_MPI_INPLACE
"enable inplace MPI calls (ignored when QE_ENABLE_MPI=OFF)" OFF)
option(QE_ENABLE_MPI_MODULE
"use MPI via Fortran module instead of mpif.h header inclusion" OFF)
option(QE_ENABLE_BARRIER
"enable global synchronization between execution units" OFF)
option(QE_LAPACK_INTERNAL
"enable internal reference LAPACK" OFF)
option(QE_ENABLE_SCALAPACK
"enable SCALAPACK execution units" OFF)
cmake_dependent_option(QE_ENABLE_SCALAPACK_QRCP
"enable SCALAPACK QRCP in pw2wannier90 (requires SCALAPACK>=2.1.0 or Intel MKL>=2020)"
OFF "QE_ENABLE_SCALAPACK" OFF)
option(QE_ENABLE_ELPA
"enable ELPA execution units" OFF)
option(QE_ENABLE_LIBXC
"enable LIBXC execution units" OFF)
option(QE_ENABLE_HDF5
"enable HDF5 data collection" OFF)
option(QE_ENABLE_STATIC_BUILD
"enable fully static build of executables" OFF)
option(QE_ENABLE_DOC
"enable documentation building" OFF)
set(QE_FFTW_VENDOR "AUTO" CACHE
STRING "select a specific FFTW library [Intel_DFTI, Intel_FFTW3, ArmPL, IBMESSL, FFTW3, Internal]")
set(QE_ENABLE_SANITIZER "none" CACHE STRING "none,asan,ubsan,tsan,msan")
set(QE_ENABLE_PLUGINS "" CACHE STRING "Semicolon-separated list of plugins")
set (QE_EXTRA_DEFINITIONS "" CACHE STRING "Semicolon-separated list of extra global definitions")
option(QE_ENABLE_FOX
"enable XML I/O via Fox library" OFF)
if(QE_ENABLE_FOX)
if(FOX_ROOT)
set(QE_FOX_INTERNAL OFF)
endif()
option(QE_FOX_INTERNAL
"enable FoX internal library" ON)
endif()
if(WANNIER90_ROOT)
set(QE_WANNIER90_INTERNAL OFF)
endif()
option(QE_WANNIER90_INTERNAL
"enable Wannier90 internal library" ON)
if(MBD_ROOT)
set(QE_MBD_INTERNAL OFF)
endif()
option(QE_MBD_INTERNAL
"enable LibMBD internal library" ON)
if(DEVICEXLIB_ROOT)
set(QE_DEVICEXLIB_INTERNAL OFF)
endif()
option(QE_DEVICEXLIB_INTERNAL
"enable DeviceXlib internal library" ON)
if(ENVIRON_ROOT)
set(ENVIRON_DEFAULT "EXTERNAL")
else()
set(ENVIRON_DEFAULT "NO")
endif()
set(QE_ENABLE_ENVIRON "${ENVIRON_DEFAULT}" CACHE
STRING "select a specific Environ library [NO, EXTERNAL, INTERNAL]")
# TODO change all ifdefs throughout code base to match
# cmake options
# TODO symbols beginning with '__' followed by a capital
# character are reserved for standard library use (at
# least in C, not sure about Fortran), change all feature
# macros to avoid weird behaviors
# Disable all configuration headers used to be generated
# by configure (see <qe>/include/)
qe_add_global_compile_definitions(QE_NO_CONFIG_H)
if(QE_ENABLE_CUDA)
qe_add_global_compile_definitions(__CUDA)
endif()
if(QE_ENABLE_TRACE)
qe_add_global_compile_definitions(__TRACE)
endif()
if(QE_ENABLE_PROFILE_NVTX)
qe_add_global_compile_definitions(__PROFILE_NVTX)
endif()
if(QE_ENABLE_MPI_INPLACE)
qe_add_global_compile_definitions(__USE_INPLACE_MPI)
endif()
if(QE_ENABLE_MPI_MODULE)
qe_add_global_compile_definitions(__MPI_MODULE)
endif()
if(QE_ENABLE_BARRIER)
qe_add_global_compile_definitions(__USE_BARRIER)
endif()
foreach(DEF IN LISTS QE_EXTRA_DEFINITIONS)
qe_add_global_compile_definitions(${DEF})
endforeach()
if(QE_ENABLE_MPI)
# OMPI_SKIP_MPICXX: skip CXX APIs on openmpi, cause trouble to C APIs
qe_add_global_compile_definitions(__MPI OMPI_SKIP_MPICXX)
if(QE_ENABLE_MPI_GPU_AWARE)
qe_add_global_compile_definitions(__GPU_MPI)
endif()
endif()
if(QE_ENABLE_SCALAPACK)
qe_add_global_compile_definitions(__SCALAPACK)
endif()
if(QE_ENABLE_HDF5)
qe_add_global_compile_definitions(__HDF5)
endif()
if(QE_ENABLE_ENVIRON)
qe_add_global_compile_definitions(__ENVIRON)
endif()
if(QE_CLOCK_SECONDS)
qe_add_global_compile_definitions(__CLOCK_SECONDS)
endif()
# Feature checks
check_function_exists(mallinfo HAVE_MALLINFO)
if(HAVE_MALLINFO)
qe_add_global_compile_definitions(HAVE_MALLINFO)
endif()
# Check options consistency
if(QE_ENABLE_STATIC_BUILD AND BUILD_SHARED_LIBS)
message(FATAL_ERROR "Full static build of QE executables requires static QE internal libraries. QE_ENABLE_STATIC_BUILD and BUILD_SHARED_LIBS cannot be both ON")
endif()
if(QE_ENABLE_ELPA AND NOT QE_ENABLE_SCALAPACK)
message(FATAL_ERROR "ELPA requires SCALAPACK support, enable it with '-DQE_ENABLE_SCALAPACK=ON' or disable ELPA with '-DQE_ENABLE_ELPA=OFF'")
endif()
if(QE_ENABLE_SCALAPACK AND NOT QE_ENABLE_MPI)
message(FATAL_ERROR "SCALAPACK requires MPI support, enable it with '-DQE_ENABLE_MPI=ON' or disable SCALAPACK with '-DQE_ENABLE_SCALAPACK=OFF'")
endif()
if(QE_ENABLE_CUDA AND NOT (CMAKE_Fortran_COMPILER_ID MATCHES "PGI" OR CMAKE_Fortran_COMPILER_ID MATCHES "NVHPC"))
message(FATAL_ERROR "NVHPC compiler is mandatory when CUDA is enabled due QE is based on CUDA Fortran language")
endif()
if(QE_ENABLE_OPENACC AND NOT (CMAKE_Fortran_COMPILER_ID MATCHES "PGI" OR CMAKE_Fortran_COMPILER_ID MATCHES "NVHPC"))
message(FATAL_ERROR "NVHPC compiler is mandatory when OpenACC is enabled")
endif()
if(QE_ENABLE_MPI_GPU_AWARE AND NOT (QE_ENABLE_CUDA AND QE_ENABLE_MPI))
message(FATAL_ERROR "GPU aware MPI requires both MPI and CUDA features enabled")
endif()
# if(QE_ENABLE_HDF5 AND NOT QE_ENABLE_MPI)
# message(FATAL_ERROR "HDF5 requires MPI support, enable it with '-DQE_ENABLE_MPI=ON' or disable HDF5 with '-DQE_ENABLE_HDF5=OFF'")
# endif()
# Add optional sanitizers ASAN, UBSAN, MSAN
set(VALID_SANITIZERS "none" "asan" "ubsan" "tsan" "msan")
# Perform sanitizer option check, only works in debug mode
if(NOT QE_ENABLE_SANITIZER IN_LIST VALID_SANITIZERS)
message(FATAL_ERROR "Invalid -DQE_ENABLE_SANITIZER=${QE_ENABLE_SANITIZER}, value must be one of ${VALID_SANITIZERS}")
else()
message(STATUS "Enable sanitizer QE_ENABLE_SANITIZER=${QE_ENABLE_SANITIZER}")
endif()
# only GNU works right now
if(NOT QE_ENABLE_SANITIZER STREQUAL "none" AND NOT CMAKE_Fortran_COMPILER_ID MATCHES "GNU")
message(FATAL_ERROR "-DQE_ENABLE_SANITIZER=${QE_ENABLE_SANITIZER} only works with the GNU compiler")
endif()
# valid plugins checks
set(VALID_QE_PLUGINS "d3q" "pw2qmcpack" "gipaw" "legacy")
# Perform sanitizer option check, only works in debug mode
foreach(PLUGIN IN LISTS QE_ENABLE_PLUGINS)
if(NOT PLUGIN IN_LIST VALID_QE_PLUGINS)
message(FATAL_ERROR "Invalid QE plugin ${PLUGIN}, value must be one of \"${VALID_QE_PLUGINS}\".")
else()
message(STATUS "Enable QE plugin ${PLUGIN}")
endif()
endforeach()
############################################################
# C preprocessor
# Note: reply on the compiler preprocessor whenever possible
############################################################
if(DEFINED ENV{CPP})
set(QE_CPP_DEFAULT $ENV{CPP})
else()
set(QE_CPP_DEFAULT cpp)
endif()
# QE_CPP_DEFAULT is only effective when cached QE_CPP doesn't exist.
set(QE_CPP ${QE_CPP_DEFAULT} CACHE
STRING "C preprocessor for qe_preprocess_source in qeHelpers.cmake")
find_program(QE_CPP_FULL_PATH NAMES ${QE_CPP} DOC "C preprocessor full path")
if(QE_CPP_FULL_PATH)
message(STATUS "C preprocessor used by qe_preprocess_source in qeHelpers.cmake: ${QE_CPP_FULL_PATH}")
else()
set(QE_CPP_SAVED ${QE_CPP})
unset(QE_CPP CACHE)
message(FATAL_ERROR "C preprocessor ${QE_CPP_SAVED} not found. Pass a working one to CMake via QE_CPP!")
endif()
###########################################################
# language standard requirements
###########################################################
# TODO need to require all compilers using the same one
if(CMAKE_Fortran_COMPILER_ID MATCHES "PGI" OR CMAKE_Fortran_COMPILER_ID MATCHES "NVHPC")
set(CMAKE_C_STANDARD 11)
set(CMAKE_C_STANDARD_REQUIRED ON)
set(CMAKE_C_EXTENSIONS OFF)
endif()
###########################################################
# check Fortran compiler -isystem option support
###########################################################
include(CheckFortranCompilerFlag)
check_fortran_compiler_flag("-isystem ." Fortran_ISYSTEM_SUPPORTED)
if(NOT Fortran_ISYSTEM_SUPPORTED AND NOT DEFINED CMAKE_NO_SYSTEM_FROM_IMPORTED)
set(CMAKE_NO_SYSTEM_FROM_IMPORTED ON)
endif()
############################################################
# Compiler vendor specific options
############################################################
if(CMAKE_Fortran_COMPILER_ID MATCHES "GNU")
include(GNUFortranCompiler)
elseif(CMAKE_Fortran_COMPILER_ID MATCHES "PGI" OR CMAKE_Fortran_COMPILER_ID MATCHES "NVHPC")
include(NVFortranCompiler)
elseif(CMAKE_Fortran_COMPILER_ID MATCHES "XL")
include(IBMFortranCompiler)
endif()
if(QE_ENABLE_STATIC_BUILD)
set(CMAKE_FIND_LIBRARY_SUFFIXES ".a")
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
endif()
###########################################################
# CUDA
###########################################################
if(QE_ENABLE_CUDA OR QE_ENABLE_PROFILE_NVTX)
if(CMAKE_Fortran_COMPILER_ID MATCHES "PGI" OR CMAKE_Fortran_COMPILER_ID MATCHES "NVHPC")
add_library(CUDA::cufft INTERFACE IMPORTED)
set_target_properties(CUDA::cufft PROPERTIES INTERFACE_LINK_LIBRARIES "${CUDA_FLAG}lib=cufft")
add_library(CUDA::cublas INTERFACE IMPORTED)
set_target_properties(CUDA::cublas PROPERTIES INTERFACE_LINK_LIBRARIES "${CUDA_FLAG}lib=cublas")
add_library(CUDA::cusolver INTERFACE IMPORTED)
set_target_properties(CUDA::cusolver PROPERTIES INTERFACE_LINK_LIBRARIES "${CUDA_FLAG}lib=cusolver")
add_library(CUDA::curand INTERFACE IMPORTED)
set_target_properties(CUDA::curand PROPERTIES INTERFACE_LINK_LIBRARIES "${CUDA_FLAG}lib=curand")
if(QE_ENABLE_PROFILE_NVTX)
add_library(CUDA::nvToolsExt INTERFACE IMPORTED)
set_target_properties(CUDA::nvToolsExt PROPERTIES INTERFACE_LINK_LIBRARIES "-cuda;libnvToolsExt.so")
set(CMAKE_REQUIRED_LIBRARIES "-cuda;libnvToolsExt.so")
check_function_exists(nvtxRangePushEx NVTX_FOUND)
unset(CMAKE_REQUIRED_LIBRARIES)
if(NOT NVTX_FOUND)
message(FATAL_ERROR "Check nvtxRangePushEx in libnvToolsExt.so failed")
endif()
endif()
else()
find_package(CUDAToolkit REQUIRED)
endif()
endif(QE_ENABLE_CUDA OR QE_ENABLE_PROFILE_NVTX)
###########################################################
# OpenMP
# The following targets will be defined:
add_library(qe_openmp_fortran INTERFACE)
add_library(qe_openmp_c INTERFACE)
qe_install_targets(qe_openmp_fortran qe_openmp_c)
###########################################################
if(QE_ENABLE_OPENMP)
find_package(OpenMP REQUIRED Fortran C)
target_link_libraries(qe_openmp_fortran INTERFACE OpenMP::OpenMP_Fortran)
target_link_libraries(qe_openmp_c INTERFACE OpenMP::OpenMP_C)
endif(QE_ENABLE_OPENMP)
###########################################################
# OpenACC
# The following targets will be defined:
add_library(qe_openacc_fortran INTERFACE)
add_library(qe_openacc_c INTERFACE)
qe_install_targets(qe_openacc_fortran qe_openacc_c)
###########################################################
if(QE_ENABLE_OPENACC)
if(CMAKE_VERSION VERSION_LESS 3.16.0)
message(FATAL_ERROR "CMake versions >= 3.16 required for QE_ENABLE_OPENACC=ON!")
endif()
find_package(OpenACC REQUIRED Fortran C)
target_link_libraries(qe_openacc_fortran INTERFACE OpenACC::OpenACC_Fortran)
target_link_libraries(qe_openacc_c INTERFACE OpenACC::OpenACC_C)
if(GPU_TARGET_COMPILE_OPTIONS)
target_compile_options(qe_openacc_fortran INTERFACE "$<$<COMPILE_LANGUAGE:Fortran>:${GPU_TARGET_COMPILE_OPTIONS}>")
target_compile_options(qe_openacc_c INTERFACE "$<$<COMPILE_LANGUAGE:C>:${GPU_TARGET_COMPILE_OPTIONS}>")
endif()
endif(QE_ENABLE_OPENACC)
###########################################################
# MPI
# The following targets will be defined:
add_library(qe_mpi_fortran INTERFACE)
qe_install_targets(qe_mpi_fortran)
###########################################################
if(QE_ENABLE_MPI)
find_package(MPI REQUIRED Fortran)
target_link_libraries(qe_mpi_fortran
INTERFACE MPI::MPI_Fortran)
message(STATUS "MPI settings used by CTest")
message(" MPIEXEC_EXECUTABLE : ${MPIEXEC_EXECUTABLE}")
message(" MPIEXEC_NUMPROC_FLAG : ${MPIEXEC_NUMPROC_FLAG}")
message(" MPIEXEC_PREFLAGS : ${MPIEXEC_PREFLAGS}")
string(REPLACE ";" " " MPIEXEC_PREFLAGS_PRINT "${MPIEXEC_PREFLAGS}")
message(" Tests run as : ${MPIEXEC_EXECUTABLE} ${MPIEXEC_NUMPROC_FLAG} <NUM_PROCS> ${MPIEXEC_PREFLAGS_PRINT} <EXECUTABLE>")
endif(QE_ENABLE_MPI)
###########################################################
# Git
###########################################################
find_package(Git 2.13 REQUIRED)
if(EXISTS ${qe_SOURCE_DIR}/.git)
message(STATUS "Source files are cloned from a git repository.")
set(IS_GIT_PROJECT 1)
include(GitInfo)
else()
message(STATUS "Source files are not cloned from a git repository.")
endif()
###########################################################
# Lapack
# The following targets will be defined:
add_library(qe_lapack INTERFACE)
qe_install_targets(qe_lapack)
###########################################################
if(NOT QE_LAPACK_INTERNAL)
if(NOT BLA_VENDOR)
if(CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64.*")
message(STATUS "Trying to find LAPACK from Intel MKL")
if(QE_ENABLE_OPENMP)
SET(BLA_VENDOR Intel10_64lp)
else()
SET(BLA_VENDOR Intel10_64lp_seq)
endif()
find_package(LAPACK)
elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "i686.*|i386.*|x86.*")
message(STATUS "Trying to find LAPACK from Intel MKL - 32bit")
SET(BLA_VENDOR Intel10_32)
find_package(LAPACK)
elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "^(aarch64.*|AARCH64.*|arm64.*|ARM64.*)")
message(STATUS "Trying to find LAPACK from ARM Performance Library")
if(QE_ENABLE_OPENMP)
SET(BLA_VENDOR Arm_mp)
else()
SET(BLA_VENDOR Arm)
endif()
find_package(LAPACK)
endif()
if(NOT LAPACK_FOUND)
message(STATUS "Trying to find alternative LAPACK libraries")
SET(BLA_VENDOR All)
if(QE_ENABLE_OPENMP)
set(CMAKE_REQUIRED_LINK_OPTIONS ${OpenMP_Fortran_FLAGS})
endif()
find_package(LAPACK)
unset(CMAKE_REQUIRED_LINK_OPTIONS)
endif()
else()
if(QE_ENABLE_OPENMP)
set(CMAKE_REQUIRED_LINK_OPTIONS ${OpenMP_Fortran_FLAGS})
endif()
find_package(LAPACK)
unset(CMAKE_REQUIRED_LINK_OPTIONS)
endif()
if(LAPACK_FOUND)
list(APPEND _lapack_libs
${BLAS_LIBRARIES}
${BLAS_LINKER_FLAGS}
${LAPACK_LIBRARIES}
${LAPACK_LINKER_FLAGS})
if(QE_ENABLE_OPENMP)
list(APPEND _lapack_libs ${OpenMP_Fortran_LIBRARIES})
endif()
list(REMOVE_DUPLICATES "${_lapack_libs}")
message(STATUS "Found LAPACK: ${_lapack_libs}")
target_link_libraries(qe_lapack INTERFACE ${_lapack_libs})
set(CMAKE_REQUIRED_LIBRARIES ${_lapack_libs})
check_fortran_function_exists(zhpev ZHPEV_FOUND)
unset(CMAKE_REQUIRED_LIBRARIES)
if(NOT ZHPEV_FOUND)
unset(ZHPEV_FOUND CACHE)
message(FATAL_ERROR "Incomplete LAPACK! function zhpev not found!")
endif()
else()
message(FATAL_ERROR "Failed to find a complete set of external BLAS/LAPACK library by FindLAPACK. "
"Variables controlling FindLAPACK can be found at CMake online documentation. "
"Alternatively, '-DQE_LAPACK_INTERNAL=ON' may be used to enable reference LAPACK "
"at a performance loss compared to optimized libraries.")
endif()
else()
message(WARNING "Internal reference LAPACK is enabled! It is less performant than vendor optimized libraries.")
if(CMAKE_Fortran_COMPILER_ID MATCHES "XL")
message(FATAL_ERROR "IBM XL compilers cannot build internal LAPACK with QE "
"due to the conflict in flags for free vs fixed format. "
"Please use an optimized LAPACK or build internal reference LAPACK separately.")
endif()
message(STATUS "Installing LAPACK via submodule")
qe_git_submodule_update(external/lapack)
add_subdirectory(external/lapack)
target_link_libraries(qe_lapack INTERFACE lapack)
# make lapack ready for other external libraries like mbd
set(LAPACK_LIBRARIES lapack)
endif()
###########################################################
# SCALAPACK
# The following targets will be defined:
add_library(qe_scalapack INTERFACE)
qe_install_targets(qe_scalapack)
###########################################################
if(QE_ENABLE_SCALAPACK)
find_package(SCALAPACK REQUIRED QUIET)
message(STATUS "Found SCALAPACK: ${SCALAPACK_LIBRARIES};${SCALAPACK_LINKER_FLAGS}")
target_link_libraries(qe_scalapack
INTERFACE
${SCALAPACK_LIBRARIES}
${SCALAPACK_LINKER_FLAGS})
if(QE_ENABLE_SCALAPACK_QRCP)
include(CheckFortranFunctionExists)
set(CMAKE_REQUIRED_LIBRARIES "${SCALAPACK_LIBRARIES}")
check_fortran_function_exists("pzgeqpf" SCALAPACK_PZGEQPF_WORKS)
unset(CMAKE_REQUIRED_LIBRARIES)
if(SCALAPACK_PZGEQPF_WORKS)
message(STATUS "Found pzgeqpf, add ScaLAPACK pzgeqpf macro")
qe_add_global_compile_definitions(__SCALAPACK_QRCP)
else()
message(FATAL_ERROR "QE_ENABLE_SCALAPACK_QRCP requested but the current ScaLAPACK installation doesn't contain pzgeqpf!")
endif()
endif()
endif(QE_ENABLE_SCALAPACK)
###########################################################
# ELPA
# The following targets will be defined:
add_library(qe_elpa INTERFACE)
qe_install_targets(qe_elpa)
###########################################################
if(QE_ENABLE_ELPA)
find_package(ELPA REQUIRED)
# Check if ELPA version is compatible with QE
if(ELPA_VERSION VERSION_GREATER_EQUAL "2018.11")
set(QE_ELPA_DEFINITIONS __ELPA)
elseif(ELPA_VERSION VERSION_GREATER_EQUAL "2016.11")
set(QE_ELPA_DEFINITIONS __ELPA_2016)
elseif(ELPA_VERSION VERSION_GREATER_EQUAL "2015")
set(QE_ELPA_DEFINITIONS __ELPA_2015)
else()
message(FATAL_ERROR "ELPA verion ${ELPA_VERSION} is not supported.")
endif()
message(STATUS "Add ELPA flag : ${QE_ELPA_DEFINITIONS}")
qe_add_global_compile_definitions(${QE_ELPA_DEFINITIONS})
# Add link libraries and include directories
target_link_libraries(qe_elpa
INTERFACE
${ELPA_LIBRARIES}
${ELPA_LIBRARIES_DEP}
${ELPA_LINKER_FLAGS}
qe_scalapack)
target_include_directories(qe_elpa
INTERFACE
${ELPA_Fortran_MODS_DIR}
${ELPA_INCLUDE_DIRS}
${ELPA_INCLUDE_DIRS_DEP})
endif(QE_ENABLE_ELPA)
###########################################################
# LIBXC
## The following targets will be defined:
add_library(qe_external_libxc INTERFACE)
qe_install_targets(qe_external_libxc)
###########################################################
if(QE_ENABLE_LIBXC)
target_compile_definitions(qe_external_libxc INTERFACE "__LIBXC")
find_package(Libxc 5.1.2 COMPONENTS Fortran)
if (NOT Libxc_FOUND)
message(STATUS "Libxc searching failed in CMake Module mode, trying Config mode")
find_package(Libxc 5.1.2 COMPONENTS Fortran CONFIG)
endif()
if(${Libxc_FOUND})
if (${Libxc_VERSION} VERSION_GREATER_EQUAL "5.1.2" )
message(STATUS "Libxc version ${Libxc_VERSION} found.")
else()
message(FATAL_ERROR "Libxc version ${Libxc_VERSION} found. "
"CMake compilation of QE tested for libxc v5.1.2 or later only.")
endif()
target_link_libraries(qe_external_libxc INTERFACE Libxc::xcf03)
target_include_directories(qe_external_libxc INTERFACE ${Libxc_INCLUDE_DIR})
target_compile_definitions(qe_external_libxc INTERFACE ${Libxc_DEFINITIONS})
else()
message(FATAL_ERROR "Failed to find Libxc package (>=5.1.2) with Fortran enabled.")
endif()
endif(QE_ENABLE_LIBXC)
###########################################################
# HDF5
# The following targets will be defined:
add_library(qe_hdf5_fortran INTERFACE)
add_library(qe_hdf5_c INTERFACE)
qe_install_targets(qe_hdf5_fortran qe_hdf5_c)
###########################################################
if(QE_ENABLE_HDF5)
if(QE_ENABLE_MPI)
option(HDF5_PREFER_PARALLEL "Prefer parallel HDF5" ON)
endif()
if(QE_ENABLE_STATIC_BUILD)
set(HDF5_USE_STATIC_LIBRARIES TRUE)
endif()
find_package(HDF5 REQUIRED Fortran C)
if(NOT HDF5_FOUND)
message(FATAL_ERROR "HDF5 Fortran interface has not been found!")
endif()
if (NOT HDF5_IS_PARALLEL OR NOT QE_ENABLE_MPI)
message(STATUS "Serial HDF5 enabled!")
qe_add_global_compile_definitions(__HDF5_SERIAL)
else()
message(STATUS "Parallel HDF5 enabled!")
endif()
target_link_libraries(qe_hdf5_fortran
INTERFACE
${HDF5_Fortran_LIBRARIES})
target_include_directories(qe_hdf5_fortran
INTERFACE
${HDF5_Fortran_INCLUDE_DIRS})
target_compile_definitions(qe_hdf5_fortran
INTERFACE
${HDF5_Fortran_DEFINITIONS})
target_link_libraries(qe_hdf5_c
INTERFACE
${HDF5_C_LIBRARIES})
target_include_directories(qe_hdf5_c
INTERFACE
${HDF5_C_INCLUDE_DIRS})
target_compile_definitions(qe_hdf5_c
INTERFACE
${HDF5_C_DEFINITIONS})
endif(QE_ENABLE_HDF5)
###########################################################
# Tests
# Any executable target marked as test runner via
# 'add_test()' will be run by the 'test' make target
###########################################################
if(QE_ENABLE_TEST)
include(cmake/unit_test.cmake)
enable_testing()
endif(QE_ENABLE_TEST)
###########################################################
# PROFILERS LIBRARIES
# the target for profiler libray will be defined if
# some profiler is enabled
add_library(qe_ext_prof_tool INTERFACE)
qe_install_targets(qe_ext_prof_tool)
###########################################################
# this should work with nvfortran
if(QE_ENABLE_PROFILE_NVTX)
target_link_libraries(qe_ext_prof_tool
INTERFACE
CUDA::nvToolsExt)
endif(QE_ENABLE_PROFILE_NVTX)
###########################################################
# Components
###########################################################
add_subdirectory(external)
add_subdirectory(FFTXlib)
add_subdirectory(UtilXlib)
add_subdirectory(Modules)
add_subdirectory(LAXlib)
add_subdirectory(XClib)
add_subdirectory(KS_Solvers)
add_subdirectory(dft-d3)
add_subdirectory(PW)
add_subdirectory(CPV)
add_subdirectory(atomic)
add_subdirectory(upflib)
add_subdirectory(COUPLE)
add_subdirectory(LR_Modules)
add_subdirectory(PHonon)
add_subdirectory(PP)
add_subdirectory(EPW)
add_subdirectory(GWW)
add_subdirectory(HP)
add_subdirectory(NEB)
add_subdirectory(PWCOND)
add_subdirectory(TDDFPT)
add_subdirectory(XSpectra)
add_subdirectory(QEHeat)
add_subdirectory(KCW)
add_subdirectory(GUI)
if(QE_ENABLE_DOC)
add_subdirectory(Doc)
endif()
###########################################################
# Tests
###########################################################
if(QE_ENABLE_TEST)
message(STATUS "Enabling tests in test-suite")
add_subdirectory(test-suite)
endif()
###########################################################
# Pkg-config
###########################################################
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/cmake/quantum_espresso.pc.in
${CMAKE_CURRENT_BINARY_DIR}/quantum_espresso.pc
@ONLY)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/quantum_espresso.pc
DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
###########################################################
# Exports
###########################################################
install(EXPORT qeTargets
FILE qeTargets.cmake
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/qe)
include(CMakePackageConfigHelpers)
write_basic_package_version_file(
qeConfigVersion.cmake
VERSION ${PACKAGE_VERSION}
COMPATIBILITY AnyNewerVersion)
configure_file(cmake/qeConfig.cmake.in
${CMAKE_CURRENT_BINARY_DIR}/qeConfig.cmake @ONLY)
install(FILES
${CMAKE_CURRENT_BINARY_DIR}/qeConfigVersion.cmake
${CMAKE_CURRENT_BINARY_DIR}/qeConfig.cmake
DESTINATION
${CMAKE_INSTALL_LIBDIR}/cmake/qe)
###########################################################
# Dependency graph generation
# Defines the custom target 'depgraph'
###########################################################
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/CMakeGraphVizOptions.cmake
${CMAKE_CURRENT_BINARY_DIR}/CMakeGraphVizOptions.cmake COPYONLY)
add_custom_target(depgraph
"${CMAKE_COMMAND}" "--graphviz=depgraph" .
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}")
###########################################################
# Custom make targets
# The collection 'pwall' is defined here
# Each of the followings is defined inside its subdirectory
# pw ph pp hp pwcond neb cp tddfpt gwl ld1 upf epw
# xspectra couple all_currents
###########################################################
add_custom_target(pwall
DEPENDS
pw
ph
pp
pwcond
neb
COMMENT
"same as \"make pw ph pp pwcond neb\"")