forked from pika-org/pika
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CMakeLists.txt
1915 lines (1678 loc) · 58 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
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) 2020 Mikael Simberg
# Copyright (c) 2007-2020 Hartmut Kaiser
# Copyright (c) 2011-2014 Thomas Heller
# Copyright (c) 2007-2008 Chirag Dekate
# Copyright (c) 2011 Bryce Lelbach
# Copyright (c) 2011 Vinay C Amatya
# Copyright (c) 2013 Jeroen Habraken
# Copyright (c) 2014-2016 Andreas Schaefer
# Copyright (c) 2017 Abhimanyu Rawat
# Copyright (c) 2017 Google
# Copyright (c) 2017 Taeguk Kwon
#
# SPDX-License-Identifier: BSL-1.0
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
# Overrides must go before the project() statement, otherwise they are ignored.
# ##############################################################################
# C++ overrides
# ##############################################################################
set(CMAKE_USER_MAKE_RULES_OVERRIDE_CXX
"${CMAKE_CURRENT_SOURCE_DIR}/cmake/pika_cxx_overrides.cmake"
)
# ##############################################################################
# Build type (needs to be handled before project command below)
# ##############################################################################
if(NOT CMAKE_BUILD_TYPE)
set(CMAKE_BUILD_TYPE
"Release"
CACHE
STRING
"Configuration type (one of Debug, RelWithDebInfo, Release, MinSizeRel)"
FORCE
)
endif()
# ##############################################################################
# project metadata
# ##############################################################################
project(pika CXX)
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
# ##############################################################################
# Build all of pika
# ##############################################################################
set(PIKA_VERSION_MAJOR 0)
set(PIKA_VERSION_MINOR 1)
set(PIKA_VERSION_PATCH 0)
set(PIKA_VERSION_DATE 20210714)
set(PIKA_VERSION_TAG "-trunk")
set(PIKA_VERSION
"${PIKA_VERSION_MAJOR}.${PIKA_VERSION_MINOR}.${PIKA_VERSION_PATCH}"
)
set(PIKA_LIBRARY_VERSION "${PIKA_VERSION}")
set(PIKA_SOVERSION ${PIKA_VERSION_MAJOR})
set(PIKA_PACKAGE_NAME pika)
# To keep track of the pika root when other subprojects are declared
set(PIKA_SOURCE_DIR "${PROJECT_SOURCE_DIR}")
set(PIKA_BINARY_DIR "${PROJECT_BINARY_DIR}")
# ##############################################################################
# CMake configuration
# ##############################################################################
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${PROJECT_SOURCE_DIR}/cmake")
include(GNUInstallDirs)
include(pika_utils)
# explicitly set certain policies
cmake_policy(VERSION 3.18)
pika_set_cmake_policy(CMP0042 NEW)
pika_set_cmake_policy(CMP0060 NEW)
pika_set_cmake_policy(CMP0074 NEW)
# We save the passed compiler flag to a special variable. This is needed for our
# build system unit tests. Some flags might influence the created symbols
# (_GLIBCXX_DEBUG i look at you)
set(CMAKE_CXX_FLAGS_SAFE ${CMAKE_CXX_FLAGS})
include(pika_check_cxx_standard)
include(CheckCXXCompilerFlag)
include(CMakeDependentOption)
# include additional macro definitions
include(pika_add_config_test)
include(pika_add_definitions)
include(pika_create_symbolic_link)
pika_force_out_of_tree_build(
"This project requires an out-of-source-tree build. See README.rst. Clean your CMake cache and CMakeFiles if this message persists."
)
if(NOT PIKA_CMAKE_LOGLEVEL)
set(PIKA_CMAKE_LOGLEVEL "WARN")
endif()
# print initial diagnostics
pika_info("CMake version: ${CMAKE_VERSION}")
pika_info("pika version: ${PIKA_VERSION}")
# ##############################################################################
# reset cached variables that need to be re-filled
unset(PIKA_EXPORT_TARGETS CACHE)
unset(PIKA_EXPORT_INTERNAL_TARGETS CACHE)
unset(PIKA_LIBS CACHE)
unset(PIKA_ENABLED_MODULES CACHE)
# ##############################################################################
# Set up dummy compiler flags targets
# ##############################################################################
include(pika_compiler_flags_targets)
# ##############################################################################
# Setup platform for which pika should be compiled.
#
include(pika_set_platform)
if("${PIKA_PLATFORM_UC}" STREQUAL "ANDROID")
unset(PIKA_LIBRARY_VERSION)
unset(PIKA_SOVERSION)
endif()
if(MSVC)
pika_option(
PIKA_WITH_VS_STARTUP_PROJECT STRING
"Define the startup project for the pika solution (default: ALL_BUILD)."
"ALL_BUILD" ADVANCED
)
if(PIKA_WITH_VS_STARTUP_PROJECT)
set(VS_STARTUP_PROJECT ${PIKA_WITH_VS_STARTUP_PROJECT})
endif()
endif()
# ##############################################################################
# ##############################################################################
# Set our build options cache variables which are customizable by users
#
pika_option(
PIKA_WITH_DEPRECATION_WARNINGS BOOL
"Enable warnings for deprecated facilities. (default: ON)" ON ADVANCED
)
if(PIKA_WITH_DEPRECATION_WARNINGS)
# enable deprecation warnings globally
pika_add_config_cond_define(PIKA_HAVE_DEPRECATION_WARNINGS 1)
endif()
# Generic build options
set(DEFAULT_MALLOC "system")
if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
set(DEFAULT_MALLOC "tcmalloc")
endif()
if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
set(PIKA_WITH_STACKOVERFLOW_DETECTION_DEFAULT OFF)
string(TOUPPER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE_UC)
if("${CMAKE_BUILD_TYPE_UC}" STREQUAL "DEBUG")
set(PIKA_WITH_STACKOVERFLOW_DETECTION_DEFAULT ON)
endif()
pika_option(
PIKA_WITH_STACKOVERFLOW_DETECTION
BOOL
"Enable stackoverflow detection for pika threads/coroutines. (default: OFF, debug: ON)"
${PIKA_WITH_STACKOVERFLOW_DETECTION_DEFAULT}
ADVANCED
)
if(PIKA_WITH_STACKOVERFLOW_DETECTION)
pika_add_config_define(PIKA_HAVE_STACKOVERFLOW_DETECTION)
endif()
endif()
pika_option(
PIKA_WITH_MALLOC
STRING
"Define which allocator should be linked in. Options are: system, tcmalloc, jemalloc, mimalloc, tbbmalloc, and custom (default: tcmalloc)"
${DEFAULT_MALLOC}
STRINGS "system;tcmalloc;jemalloc;mimalloc;tbbmalloc;custom"
)
# On some systems jemalloc requires an explicit prefix for the API functions
# (i.e. 'malloc' is called 'je_malloc', etc.)
if(${PIKA_WITH_MALLOC} STREQUAL "jemalloc")
if(MSVC)
set(PIKA_WITH_JEMALLOC_PREFIX_DEFAULT "je_")
else()
set(PIKA_WITH_JEMALLOC_PREFIX_DEFAULT "<none>")
endif()
pika_option(
PIKA_WITH_JEMALLOC_PREFIX STRING
"Optional naming prefix for jemalloc API functions"
${PIKA_WITH_JEMALLOC_PREFIX_DEFAULT} ADVANCED
)
endif()
# Logging configuration
pika_option(
PIKA_WITH_LOGGING BOOL "Build pika with logging enabled (default: ON)." ON
ADVANCED
)
if(PIKA_WITH_LOGGING)
pika_add_config_define(PIKA_HAVE_LOGGING)
endif()
# Compiler related build options
pika_option(
PIKA_WITH_GCC_VERSION_CHECK BOOL
"Don't ignore version reported by gcc (default: ON)" ON ADVANCED
)
pika_option(
PIKA_WITH_COMPILER_WARNINGS BOOL "Enable compiler warnings (default: ON)" ON
ADVANCED
)
pika_option(
PIKA_WITH_COMPILER_WARNINGS_AS_ERRORS BOOL
"Turn compiler warnings into errors (default: OFF)" OFF ADVANCED
)
pika_option(
PIKA_WITH_EXECUTABLE_PREFIX STRING "Executable prefix (default: none)." ""
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_BINARY_DIR
PATH
"Root directory for libraries and executables for the build. This does not affect the installed location of libraries and executables."
"${PROJECT_BINARY_DIR}"
CATEGORY "Build Targets"
ADVANCED
)
if(WIN32)
set(PIKA_WITH_PSEUDO_DEPENDENCIES
OFF
CACHE INTERNAL "" FORCE
)
else()
set(PIKA_WITH_PSEUDO_DEPENDENCIES
ON
CACHE INTERNAL "" FORCE
)
endif()
pika_option(
PIKA_WITH_UNITY_BUILD BOOL
"Enable unity build for certain build targets (default: ON)" ON ADVANCED
)
if(PIKA_WITH_UNITY_BUILD)
set(PIKA_WITH_UNITY_BUILD_OPTION UNITY_BUILD)
endif()
pika_option(
PIKA_WITH_PRECOMPILED_HEADERS
BOOL
"Enable precompiled headers for certain build targets (experimental) (default: OFF)"
OFF
ADVANCED
)
if(PIKA_WITH_PRECOMPILED_HEADERS)
set(PIKA_WITH_PRECOMPILED_HEADERS_INTERNAL ON)
# Only create the targets here. They will be set up later once all modules are
# known.
add_library(pika_precompiled_headers OBJECT libs/src/dummy.cpp)
add_executable(pika_exe_precompiled_headers libs/src/dummy.cpp)
set_target_properties(pika_precompiled_headers PROPERTIES FOLDER "Core")
set_target_properties(pika_exe_precompiled_headers PROPERTIES FOLDER "Core")
endif()
# ##############################################################################
pika_option(
PIKA_WITH_EXAMPLES BOOL "Build examples (default: OFF)" OFF
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_TESTS BOOL "Build tests (default: OFF)" OFF
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_TESTS_BENCHMARKS BOOL "Build benchmark tests (default: ON)" ON
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_TESTS_REGRESSIONS BOOL "Build regression tests (default: ON)" ON
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_TESTS_UNIT BOOL "Build unit tests (default: ON)" ON
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_TESTS_HEADERS BOOL "Build header tests (default: ON)" ON ADVANCED
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_TESTS_EXTERNAL_BUILD BOOL
"Build external CMake build tests (default: ON)" ON ADVANCED
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_TESTS_EXAMPLES BOOL "Add examples as tests (default: ON)" ON
ADVANCED CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_COMPILE_ONLY_TESTS BOOL
"Create build system support for compile time only tests (default: ON)" ON
CATEGORY "Build Targets"
)
pika_option(
PIKA_WITH_FAIL_COMPILE_TESTS BOOL
"Create build system support for fail compile tests (default: ON)" ON
CATEGORY "Build Targets"
)
# disable all tests if PIKA_WITH_TESTS=OFF
if(NOT PIKA_WITH_TESTS)
pika_set_option(
PIKA_WITH_TESTS_BENCHMARKS
VALUE OFF
FORCE
)
pika_set_option(
PIKA_WITH_TESTS_REGRESSIONS
VALUE OFF
FORCE
)
pika_set_option(
PIKA_WITH_TESTS_UNIT
VALUE OFF
FORCE
)
pika_set_option(
PIKA_WITH_TESTS_HEADERS
VALUE OFF
FORCE
)
pika_set_option(
PIKA_WITH_TESTS_EXTERNAL_BUILD
VALUE OFF
FORCE
)
pika_set_option(
PIKA_WITH_TESTS_EXAMPLES
VALUE OFF
FORCE
)
endif()
pika_option(
PIKA_WITH_TOOLS BOOL "Build tools (default: OFF)" OFF ADVANCED
CATEGORY "Build Targets"
)
set(PIKA_FULL_RPATH_DEFAULT ON)
if(APPLE OR WIN32)
set(PIKA_FULL_RPATH_DEFAULT OFF)
endif()
pika_option(
PIKA_WITH_FULL_RPATH
BOOL
"Build and link libraries and executables with full RPATHs (default: ${PIKA_FULL_RPATH_DEFAULT})"
${PIKA_FULL_RPATH_DEFAULT}
ADVANCED
)
# ##############################################################################
# CUDA/HIP configuration
# ##############################################################################
set(CUDA_OPTION_STRING "Enable support for CUDA (default: OFF)")
set(HIP_OPTION_STRING "Enable support for HIP (default: OFF)")
pika_option(PIKA_WITH_CUDA BOOL "${CUDA_OPTION_STRING}" OFF ADVANCED)
# No need for the user to specify the option explicitly
pika_option(PIKA_WITH_HIP BOOL "${HIP_OPTION_STRING}" OFF ADVANCED)
if("${CMAKE_CXX_COMPILER}" MATCHES "hipcc$")
set(PIKA_WITH_HIP
ON
CACHE BOOL "${HIP_OPTION_STRING}" FORCE
)
endif()
if(PIKA_WITH_CUDA AND PIKA_WITH_HIP)
pika_error(
"PIKA_WITH_CUDA=ON and PIKA_WITH_HIP=ON. Only one of them can be on at the same time.\
Note: PIKA_WITH_HIP is automatically enabled when compiling with hipcc."
)
endif()
if(PIKA_WITH_CUDA OR PIKA_WITH_HIP)
pika_add_config_define(PIKA_HAVE_GPU_SUPPORT)
set(PIKA_WITH_GPU_SUPPORT ON)
set(PIKA_WITH_GPU_SUPPORT
ON
CACHE INTERNAL "" FORCE
)
else()
set(PIKA_WITH_GPU_SUPPORT
OFF
CACHE INTERNAL "" FORCE
)
endif()
# ##############################################################################
# datapar configuration
# ##############################################################################
pika_option(
PIKA_WITH_DATAPAR_VC
BOOL
"Enable data parallel algorithm support using the external Vc library (default: OFF)"
OFF
ADVANCED
)
if(PIKA_WITH_DATAPAR_VC)
pika_option(
PIKA_WITH_DATAPAR_VC_NO_LIBRARY BOOL
"Don't link with the Vc static library (default: OFF)" OFF ADVANCED
)
endif()
if(PIKA_WITH_DATAPAR_VC)
pika_warn(
"Vc support is deprecated. This option will be removed in a future release. It will be replaced with SIMD support from the C++ standard library"
)
include(pika_setup_vc)
endif()
if(NOT PIKA_WITH_DATAPAR_VC)
pika_info("No vectorization library configured")
else()
pika_option(
PIKA_WITH_DATAPAR BOOL
"Enable data parallel algorithm support (default: ON)" ON ADVANCED
)
endif()
# ##############################################################################
# Threadlevel Nice option
# ##############################################################################
pika_option(
PIKA_WITH_NICE_THREADLEVEL
BOOL
"Set pika worker threads to have high NICE level (may impact performance) (default: OFF)"
OFF
ADVANCED
)
if(PIKA_WITH_NICE_THREADLEVEL)
pika_info("Nice threadlevel is enabled.")
pika_add_config_define(PIKA_HAVE_NICE_THREADLEVEL)
else()
pika_info("Nice threadlevel is disabled.")
endif()
# ##############################################################################
# Utility configuration
# ##############################################################################
set(PIKA_HIDDEN_VISIBILITY_DEFAULT ON)
if(CMAKE_COMPILER_IS_GNUCXX)
if("${PIKA_PLATFORM_UC}" STREQUAL "ANDROID")
set(PIKA_HIDDEN_VISIBILITY_DEFAULT OFF)
endif()
endif()
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
set(PIKA_HIDDEN_VISIBILITY_DEFAULT OFF)
endif()
if(APPLE)
set(PIKA_HIDDEN_VISIBILITY_DEFAULT OFF)
endif()
pika_option(
PIKA_WITH_HIDDEN_VISIBILITY
BOOL
"Use -fvisibility=hidden for builds on platforms which support it (default: ${PIKA_HIDDEN_VISIBILITY_DEFAULT})"
${PIKA_HIDDEN_VISIBILITY_DEFAULT}
ADVANCED
)
pika_option(
PIKA_WITH_AUTOMATIC_SERIALIZATION_REGISTRATION
BOOL
"Use automatic serialization registration for actions and functions. This affects compatibility between pika applications compiled with different compilers (default: ON)"
ON
ADVANCED
)
if(PIKA_WITH_AUTOMATIC_SERIALIZATION_REGISTRATION)
pika_add_config_define(PIKA_HAVE_AUTOMATIC_SERIALIZATION_REGISTRATION)
endif()
pika_option(
PIKA_WITH_ZERO_COPY_SERIALIZATION_THRESHOLD
STRING
"The threshold in bytes to when perform zero copy optimizations (default: 128)"
"128"
ADVANCED
)
pika_add_config_define(
PIKA_ZERO_COPY_SERIALIZATION_THRESHOLD
${PIKA_WITH_ZERO_COPY_SERIALIZATION_THRESHOLD}
)
pika_option(
PIKA_WITH_DISABLED_SIGNAL_EXCEPTION_HANDLERS
BOOL
"Disables the mechanism that produces debug output for caught signals and unhandled exceptions (default: OFF)"
OFF
ADVANCED
)
if(PIKA_WITH_DISABLED_SIGNAL_EXCEPTION_HANDLERS)
pika_add_config_define(PIKA_HAVE_DISABLED_SIGNAL_EXCEPTION_HANDLERS)
endif()
# Thread Manager related build options
set(PIKA_MAX_CPU_COUNT_DEFAULT "")
pika_option(
PIKA_WITH_MAX_CPU_COUNT
STRING
"pika applications will not use more that this number of OS-Threads (empty string means dynamic) (default: \"${PIKA_MAX_CPU_COUNT_DEFAULT}\")"
"${PIKA_MAX_CPU_COUNT_DEFAULT}"
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_MAX_CPU_COUNT)
pika_add_config_define(PIKA_HAVE_MAX_CPU_COUNT ${PIKA_WITH_MAX_CPU_COUNT})
endif()
if((NOT PIKA_WITH_MAX_CPU_COUNT) OR (PIKA_WITH_MAX_CPU_COUNT GREATER 64))
pika_add_config_define(PIKA_HAVE_MORE_THAN_64_THREADS)
endif()
set(PIKA_MAX_NUMA_DOMAIN_COUNT_DEFAULT "8")
pika_option(
PIKA_WITH_MAX_NUMA_DOMAIN_COUNT
STRING
"pika applications will not run on machines with more NUMA domains (default: ${PIKA_MAX_NUMA_DOMAIN_COUNT_DEFAULT})"
${PIKA_MAX_NUMA_DOMAIN_COUNT_DEFAULT}
CATEGORY "Thread Manager"
ADVANCED
)
pika_add_config_define(
PIKA_HAVE_MAX_NUMA_DOMAIN_COUNT ${PIKA_WITH_MAX_NUMA_DOMAIN_COUNT}
)
pika_option(
PIKA_WITH_THREAD_STACK_MMAP BOOL
"Use mmap for stack allocation on appropriate platforms" ON
CATEGORY "Thread Manager"
ADVANCED
)
pika_option(
PIKA_WITH_THREAD_MANAGER_IDLE_BACKOFF BOOL
"pika scheduler threads do exponential backoff on idle queues (default: ON)"
ON
CATEGORY "Thread Manager"
ADVANCED
)
pika_option(
PIKA_WITH_STACKTRACES BOOL
"Attach backtraces to pika exceptions (default: ON)" ON
CATEGORY "Thread Manager"
ADVANCED
)
pika_option(
PIKA_WITH_THREAD_BACKTRACE_ON_SUSPENSION BOOL
"Enable thread stack back trace being captured on suspension (default: OFF)"
OFF
CATEGORY "Thread Manager"
ADVANCED
)
# We create a target to contain libraries like rt, dl etc. in order to remove
# global variables
add_library(pika_base_libraries INTERFACE)
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Intel")
target_link_libraries(pika_base_libraries INTERFACE imf svml irng intlc)
endif()
if(PIKA_WITH_STACKTRACES OR PIKA_WITH_THREAD_BACKTRACE_ON_SUSPENSION)
pika_info("Stack traces are enabled.")
pika_add_config_define(PIKA_HAVE_STACKTRACES)
if(WIN32)
target_link_libraries(pika_base_libraries INTERFACE dbghelp)
endif()
pika_option(
PIKA_WITH_THREAD_BACKTRACE_DEPTH STRING
"Thread stack back trace depth being captured (default: 20)" "20"
CATEGORY "Thread Manager"
ADVANCED
)
pika_add_config_define(
PIKA_HAVE_THREAD_BACKTRACE_DEPTH ${PIKA_WITH_THREAD_BACKTRACE_DEPTH}
)
if(("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
AND ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang"
OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
)
# This option is OFF by default as we have seen random segfaults out in the
# wild if this is enabled.
pika_option(
PIKA_WITH_STACKTRACES_STATIC_SYMBOLS BOOL
"Thread stack back trace will resolve static symbols (default: OFF)" OFF
CATEGORY "Thread Manager"
ADVANCED
)
pika_add_config_define(
PIKA_HAVE_STACKTRACES_STATIC_SYMBOLS
${PIKA_WITH_STACKTRACES_STATIC_SYMBOLS}
)
# Demangling can segfault in certain configurations.
pika_option(
PIKA_WITH_STACKTRACES_DEMANGLE_SYMBOLS BOOL
"Thread stack back trace symbols will be demangled (default: ON)" ON
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_STACKTRACES_DEMANGLE_SYMBOLS)
pika_add_config_define(PIKA_HAVE_STACKTRACES_DEMANGLE_SYMBOLS)
endif()
endif()
endif()
if(PIKA_WITH_THREAD_BACKTRACE_ON_SUSPENSION)
pika_add_config_define(PIKA_HAVE_THREAD_BACKTRACE_ON_SUSPENSION)
pika_option(
PIKA_WITH_THREAD_FULLBACKTRACE_ON_SUSPENSION BOOL
"Enable thread stack back trace being captured on suspension (default: OFF)"
OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_THREAD_FULLBACKTRACE_ON_SUSPENSION)
pika_add_config_define(PIKA_HAVE_THREAD_FULLBACKTRACE_ON_SUSPENSION)
endif()
endif()
pika_option(
PIKA_WITH_THREAD_TARGET_ADDRESS BOOL
"Enable storing target address in thread for NUMA awareness (default: OFF)"
OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_THREAD_TARGET_ADDRESS)
pika_add_config_define(PIKA_HAVE_THREAD_TARGET_ADDRESS)
endif()
pika_option(
PIKA_WITH_THREAD_QUEUE_WAITTIME BOOL
"Enable collecting queue wait times for threads (default: OFF)" OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_THREAD_QUEUE_WAITTIME)
pika_add_config_define(PIKA_HAVE_THREAD_QUEUE_WAITTIME)
endif()
pika_option(
PIKA_WITH_THREAD_IDLE_RATES
BOOL
"Enable measuring the percentage of overhead times spent in the scheduler (default: OFF)"
OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_THREAD_IDLE_RATES)
pika_option(
PIKA_WITH_BACKGROUND_THREAD_COUNTERS
BOOL
"Enable performance counters related to adaptive parcel coalescing (default: OFF)."
OFF
ADVANCED
)
if(PIKA_WITH_BACKGROUND_THREAD_COUNTERS)
pika_add_config_define(PIKA_HAVE_BACKGROUND_THREAD_COUNTERS)
endif()
endif()
pika_option(
PIKA_WITH_THREAD_CREATION_AND_CLEANUP_RATES BOOL
"Enable measuring thread creation and cleanup times (default: OFF)" OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_THREAD_IDLE_RATES)
pika_add_config_define(PIKA_HAVE_THREAD_IDLE_RATES)
if(PIKA_WITH_THREAD_CREATION_AND_CLEANUP_RATES)
pika_add_config_define(PIKA_HAVE_THREAD_CREATION_AND_CLEANUP_RATES)
endif()
endif()
pika_option(
PIKA_WITH_THREAD_CUMULATIVE_COUNTS
BOOL
"Enable keeping track of cumulative thread counts in the schedulers (default: ON)"
ON
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_THREAD_CUMULATIVE_COUNTS)
pika_add_config_define(PIKA_HAVE_THREAD_CUMULATIVE_COUNTS)
endif()
pika_option(
PIKA_WITH_THREAD_STEALING_COUNTS
BOOL
"Enable keeping track of counts of thread stealing incidents in the schedulers (default: OFF)"
OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_THREAD_STEALING_COUNTS)
pika_add_config_define(PIKA_HAVE_THREAD_STEALING_COUNTS)
endif()
pika_option(
PIKA_WITH_COROUTINE_COUNTERS BOOL
"Enable keeping track of coroutine creation and rebind counts (default: OFF)"
OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_COROUTINE_COUNTERS)
pika_add_config_define(PIKA_HAVE_COROUTINE_COUNTERS)
endif()
pika_option(
PIKA_WITH_THREAD_LOCAL_STORAGE BOOL
"Enable thread local storage for all pika threads (default: OFF)" OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_THREAD_LOCAL_STORAGE)
pika_add_config_define(PIKA_HAVE_THREAD_LOCAL_STORAGE)
endif()
pika_option(
PIKA_WITH_SCHEDULER_LOCAL_STORAGE BOOL
"Enable scheduler local storage for all pika schedulers (default: OFF)" OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_SCHEDULER_LOCAL_STORAGE)
pika_add_config_define(PIKA_HAVE_SCHEDULER_LOCAL_STORAGE)
endif()
pika_option(
PIKA_WITH_SPINLOCK_POOL_NUM STRING
"Number of elements a spinlock pool manages (default: 128)" 128
CATEGORY "Thread Manager"
ADVANCED
)
pika_add_config_define(
PIKA_HAVE_SPINLOCK_POOL_NUM ${PIKA_WITH_SPINLOCK_POOL_NUM}
)
pika_option(
PIKA_WITH_SPINLOCK_DEADLOCK_DETECTION BOOL
"Enable spinlock deadlock detection (default: OFF)" OFF
CATEGORY "Thread Manager"
ADVANCED
)
if(PIKA_WITH_SPINLOCK_DEADLOCK_DETECTION)
pika_add_config_define(PIKA_HAVE_SPINLOCK_DEADLOCK_DETECTION)
endif()
pika_option(
PIKA_WITH_ITTNOTIFY BOOL "Enable Amplifier (ITT) instrumentation support." OFF
CATEGORY "Profiling"
)
pika_option(
PIKA_WITH_MPI
BOOL
"Enable support for returning futures from MPI asynchronous calls (default: ON)"
OFF
CATEGORY "MPI"
)
if(PIKA_WITH_MPI)
# mpi settings
pika_option(
PIKA_WITH_MPI_ENV
STRING
"List of environment variables checked to detect MPI (default: MV2_COMM_WORLD_RANK;PMI_RANK;OMPI_COMM_WORLD_SIZE;ALPS_APP_PE;PMIX_RANK;PALS_NODEID)."
"MV2_COMM_WORLD_RANK;PMI_RANK;OMPI_COMM_WORLD_SIZE;ALPS_APP_PE;PMIX_RANK;PALS_NODEID"
CATEGORY "MPI"
ADVANCED
)
# This list is to detect whether we run inside an mpi environment.
if(PIKA_WITH_MPI_ENV)
string(REPLACE ";" "," pika_mpi_env_ "${PIKA_WITH_MPI_ENV}")
pika_add_config_define(PIKA_HAVE_MPI_ENV "\"${pika_mpi_env_}\"")
endif()
pika_option(
PIKA_WITH_MPI_MULTITHREADED BOOL
"Turn on MPI multithreading support (default: ON)." ON
CATEGORY "MPI"
ADVANCED
)
if(PIKA_WITH_MPI_MULTITHREADED)
pika_add_config_define(PIKA_HAVE_MPI_MULTITHREADED)
endif()
if(MSVC)
# FIXME: add OpenMPI specific flag here for now as the
# pika_add_compile_flag() below does not add the extra options to the top
# level directory
pika_add_config_define(OMPI_IMPORTS)
endif()
endif()
# External libraries/frameworks used by sme of the examples and benchmarks
pika_option(
PIKA_WITH_EXAMPLES_OPENMP BOOL
"Enable examples requiring OpenMP support (default: OFF)." OFF
CATEGORY "Build Targets"
ADVANCED
)
if(PIKA_WITH_EXAMPLES_OPENMP)
find_package(OpenMP REQUIRED)
endif()
pika_option(
PIKA_WITH_EXAMPLES_TBB BOOL
"Enable examples requiring TBB support (default: OFF)." OFF
CATEGORY "Build Targets"
ADVANCED
)
if(PIKA_WITH_EXAMPLES_TBB)
find_package(TBB)
if(NOT TBB_FOUND)
set(PIKA_WITH_EXAMPLES_TBB OFF)
endif()
endif()
pika_option(
PIKA_WITH_EXAMPLES_QTHREADS BOOL
"Enable examples requiring QThreads support (default: OFF)." OFF
CATEGORY "Build Targets"
ADVANCED
)
if(PIKA_WITH_EXAMPLES_QTHREADS)
find_package(QThreads)
if(NOT QTHREADS_FOUND)
set(PIKA_WITH_EXAMPLES_QTHREADS OFF)
endif()
endif()
pika_option(
PIKA_WITH_EXAMPLES_HDF5 BOOL
"Enable examples requiring HDF5 support (default: OFF)." OFF
CATEGORY "Build Targets"
ADVANCED
)
if(PIKA_WITH_EXAMPLES_HDF5)
find_package(HDF5 COMPONENTS CXX)
if(NOT HDF5_FOUND)
set(PIKA_WITH_EXAMPLES_HDF5 OFF)
endif()
endif()
# Disabling the Qt example on BG/Q as GUIs don't make sense there anyways
if(NOT "${PIKA_PLATFORM_UC}" STREQUAL "BLUEGENEQ")
pika_option(
PIKA_WITH_EXAMPLES_QT4 BOOL
"Enable examples requiring Qt4 support (default: OFF)." OFF
CATEGORY "Build Targets"
ADVANCED
)
if(PIKA_WITH_EXAMPLES_QT4)
find_package(Qt4)
if(NOT QT4_FOUND)
set(PIKA_WITH_EXAMPLES_QT4 OFF)
endif()
endif()
endif()
# Debugging related build options
pika_option(
PIKA_WITH_VALGRIND BOOL "Enable Valgrind instrumentation support." OFF
CATEGORY "Debugging"
)
pika_option(
PIKA_WITH_SANITIZERS BOOL "Configure with sanitizer instrumentation support."
OFF CATEGORY "Debugging"
)
set(PIKA_WITH_VERIFY_LOCKS_DEFAULT OFF)
if(${CMAKE_BUILD_TYPE} STREQUAL "Debug")
set(PIKA_WITH_VERIFY_LOCKS_DEFAULT ON)
endif()
pika_option(
PIKA_WITH_VERIFY_LOCKS BOOL
"Enable lock verification code (default: OFF, enabled in debug builds)"
${PIKA_WITH_VERIFY_LOCKS_DEFAULT}
CATEGORY "Debugging"
ADVANCED
)
pika_option(
PIKA_WITH_VERIFY_LOCKS_BACKTRACE
BOOL
"Enable thread stack back trace being captured on lock registration (to be used in combination with PIKA_WITH_VERIFY_LOCKS=ON, default: OFF)"
OFF
CATEGORY "Debugging"
ADVANCED
)
pika_option(
PIKA_WITH_THREAD_DEBUG_INFO
BOOL
"Enable thread debugging information (default: OFF, implicitly enabled in debug builds)"
OFF
CATEGORY "Debugging"
ADVANCED
)
pika_option(
PIKA_WITH_THREAD_GUARD_PAGE BOOL "Enable thread guard page (default: ON)" ON
CATEGORY "Debugging"
ADVANCED
)
if(PIKA_WITH_VERIFY_LOCKS)
pika_add_config_define(PIKA_HAVE_VERIFY_LOCKS)
if(PIKA_WITH_VERIFY_LOCKS_BACKTRACE)
pika_add_config_define(PIKA_HAVE_VERIFY_LOCKS_BACKTRACE)
endif()
endif()
# Additional debug support
if(NOT WIN32 AND PIKA_WITH_THREAD_GUARD_PAGE)
pika_add_config_define(PIKA_HAVE_THREAD_GUARD_PAGE)
endif()
if(NOT WIN32 AND PIKA_WITH_THREAD_STACK_MMAP)
pika_add_config_define(PIKA_HAVE_THREAD_STACK_MMAP)
endif()
if(PIKA_WITH_THREAD_MANAGER_IDLE_BACKOFF)
pika_add_config_define(PIKA_HAVE_THREAD_MANAGER_IDLE_BACKOFF)
endif()
pika_option(
PIKA_WITH_THREAD_DESCRIPTION_FULL BOOL
"Use function address for thread description (default: OFF)" OFF
CATEGORY "Debugging"
ADVANCED
)
pika_option(
PIKA_WITH_ATTACH_DEBUGGER_ON_TEST_FAILURE BOOL
"Break the debugger if a test has failed (default: OFF)" OFF
CATEGORY "Debugging"
ADVANCED
)
if(PIKA_WITH_ATTACH_DEBUGGER_ON_TEST_FAILURE)
pika_add_config_define(PIKA_HAVE_ATTACH_DEBUGGER_ON_TEST_FAILURE)
endif()
pika_option(
PIKA_WITH_TESTS_DEBUG_LOG BOOL
"Turn on debug logs (--pika:debug-pika-log) for tests (default: OFF)" OFF
CATEGORY "Debugging"
ADVANCED
)
pika_option(
PIKA_WITH_TESTS_DEBUG_LOG_DESTINATION STRING
"Destination for test debug logs (default: cout)" "cout"
CATEGORY "Debugging"
ADVANCED
)
pika_option(
PIKA_WITH_TESTS_MAX_THREADS_PER_LOCALITY
STRING