-
Notifications
You must be signed in to change notification settings - Fork 649
/
CMakeLists.txt
1601 lines (1429 loc) · 62.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
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
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# Require cmake that can work with OpenJDK 10 and newer [1].
#
# Note: cmake in thirdparty/ will always meet this minimum.
#
# 1. https://gitlab.kitware.com/cmake/cmake/issues/17938
cmake_minimum_required(VERSION 3.11.2)
project(Kudu)
if (APPLE)
# Print out the CMAKE_OSX_* variables to help debug Apple build issues.
message(STATUS "Using CMAKE_OSX_ARCHITECTURES: ${CMAKE_OSX_ARCHITECTURES}")
message(STATUS "Using CMAKE_OSX_DEPLOYMENT_TARGET: ${CMAKE_OSX_DEPLOYMENT_TARGET}")
message(STATUS "Using CMAKE_OSX_SYSROOT: ${CMAKE_OSX_SYSROOT}")
endif()
# Prevent builds from the top-level source directory. This ensures that build
# output is well isolated from the source tree.
#
# May be overridden by setting KUDU_ALLOW_IN_SOURCE_BUILD; this is only
# recommended for experts!
if("${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}" AND
NOT "${KUDU_ALLOW_IN_SOURCE_BUILD}")
message(FATAL_ERROR
"Kudu may not be built from the top-level source directory. Create a new "
"directory and run cmake from there, passing the path to the top-level "
"source directory as the last argument. "
"To override this, rerun CMake with -DKUDU_ALLOW_IN_SOURCE_BUILD=1. "
"Also, delete 'CMakeCache.txt' and 'CMakeFiles' from the top-level source "
"directory, otherwise future builds will not work.")
endif()
# Provide a 'latest' symlink to this build directory if the "blessed"
# multi-build layout is detected:
#
# build/
# build/<first build directory>
# build/<second build directory>
# ...
if ("${CMAKE_CURRENT_BINARY_DIR}" STREQUAL
"${CMAKE_CURRENT_SOURCE_DIR}/build/latest")
message(FATAL_ERROR "Should not run cmake inside the build/latest symlink. "
"First change directories into the destination of the symlink.")
endif()
string(REPLACE "${CMAKE_CURRENT_SOURCE_DIR}/build/" ""
BLESSED_BUILD_SUBDIR "${CMAKE_CURRENT_BINARY_DIR}")
string(FIND "${BLESSED_BUILD_SUBDIR}" "/" SLASH_POS)
if (SLASH_POS EQUAL -1)
# Create the symlink both during cmake invocation and when the default target
# ('all') is built. The former is useful for scripts that, after running
# cmake, only build a single target (i.e. "make lint").
execute_process(COMMAND ln ${MORE_ARGS} -nsf ${CMAKE_CURRENT_BINARY_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/build/latest)
add_custom_target(latest_symlink ALL
ln ${MORE_ARGS} -nsf ${CMAKE_CURRENT_BINARY_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/build/latest
COMMENT "Recreating ../build/latest symlink")
# 'ALL' above doesn't actually add 'latest_symlink' as a dependency to all
# targets. So, we override add_executable to ensure that whenever any executable
# is built, the symlink is re-created.
function(add_executable name)
# Call through to the original add_executable function.
_add_executable(${name} ${ARGN})
add_dependencies(${name} latest_symlink)
endfunction()
endif()
file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/version.txt" KUDU_VERSION_NUMBER)
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake_modules")
include(CMakeParseArguments)
set(BUILD_SUPPORT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/build-support)
if ("$ENV{THIRDPARTY_DIR}" STREQUAL "")
set(THIRDPARTY_DIR ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty)
else()
set(THIRDPARTY_DIR $ENV{THIRDPARTY_DIR})
endif()
set(THIRDPARTY_TOOLCHAIN_DIR ${THIRDPARTY_DIR}/clang-toolchain)
set(THIRDPARTY_INSTALL_DIR ${THIRDPARTY_DIR}/installed)
set(THIRDPARTY_INSTALL_COMMON_DIR ${THIRDPARTY_INSTALL_DIR}/common)
set(THIRDPARTY_INSTALL_UNINSTRUMENTED_DIR ${THIRDPARTY_INSTALL_DIR}/uninstrumented)
set(THIRDPARTY_INSTALL_TSAN_DIR ${THIRDPARTY_INSTALL_DIR}/tsan)
# Set the Java directory so our C++ tests are able to access its contents.
# This can be useful to, e.g. spawn a Java subprocess.
set(JAVA_DIR ${CMAKE_CURRENT_SOURCE_DIR}/java)
# Adds the EXTRA_GRADLE_FLAGS environment variable to a cmake list and calls `separate_arguments`.
# This solves the problem of escaped spaces in the EXTRA_GRADLE_FLAGS environment variable.
list(APPEND GRADLE_FLAGS $ENV{EXTRA_GRADLE_FLAGS})
separate_arguments(GRADLE_FLAGS)
# When invoking Gradle:
# * Log errors only, reducing the verbosity of the Gradle's output
# * Make the output better fit for plain consoles, avoiding garbled logs
list(APPEND GRADLE_FLAGS --quiet --console=plain)
list(REMOVE_DUPLICATES GRADLE_FLAGS)
# Initialize Gradle to ensure the wrapper is downloaded.
# This is important so that multiple calls to Gradle don't try and
# download the gradle-wrapper.jar at the same time.
set(GRADLE_WRAPPER_JAR ${JAVA_DIR}/gradle/wrapper/gradle-wrapper.jar)
add_custom_command(OUTPUT ${GRADLE_WRAPPER_JAR}
COMMAND ./gradlew --version ${GRADLE_FLAGS}
COMMAND ./gradlew initializeTasks ${GRADLE_FLAGS}
WORKING_DIRECTORY "${JAVA_DIR}")
add_custom_target(init_gradle DEPENDS ${GRADLE_WRAPPER_JAR})
# A target to build the kudu-proto Java module which is used
# by the kudu-subprocess and kudu-hive modules to avoid building
# multiple times and potential race conditions in Gradle code
# generation.
set(PROTO_JAR ${JAVA_DIR}/kudu-proto/build/libs/kudu-proto-${KUDU_VERSION_NUMBER}.jar)
add_custom_command(OUTPUT ${PROTO_JAR}
COMMAND ./gradlew :kudu-proto:jar ${GRADLE_FLAGS}
WORKING_DIRECTORY "${JAVA_DIR}"
DEPENDS init_gradle)
add_custom_target(proto_jar DEPENDS ${PROTO_JAR})
# An artificial target for sequencing of building the subprocess_jar and the
# hms_plugin_jar targets. The sequencing is to work around the following issues
# when running multiple gradle instances in parallel, concurrently building
# the targets:
#
# * Sometimes it ends up with java.lang.ArrayIndexOutOfBoundsException
# while building shadowJar for corresponding Java dependencies,
# and while it's not yet clear whether the issue is in shadowJar
# implementation or elsewhere, it's quite simple to address the issue
# by not running multiple Gradle instances concurrently
#
# * Sometimes the following error is reported, as seen elsewhere [1][2]:
#
# Timeout waiting to lock Java compile cache (...). It is currently in use by another Gradle instance.
#
# [1] https://github.com/gradle/gradle/issues/8375
# [2] https://github.com/gradle/gradle/issues/11861
#
add_custom_target(subprocess_jar_seq DEPENDS subprocess_jar)
# Allow "make install" to not depend on all targets.
#
# Must be declared in the top-level CMakeLists.txt.
set(CMAKE_SKIP_INSTALL_ALL_DEPENDENCY true)
# Codegen-dependent executables need to be linked with -rdynamic; otherwise LLVM
# can't find dependent Kudu symbols at runtime.
#
# Setting the ENABLE_EXPORTS target property for each codegen-dependent
# executable is more precise, but that's a rather long target list, so we'll
# just do it once here for all Kudu executables.
set(CMAKE_ENABLE_EXPORTS true)
# Always generate the compilation database file (compile_commands.json) for use
# with various development tools, such as IWYU and Vim's YouCompleteMe plugin.
# See http://clang.llvm.org/docs/JSONCompilationDatabase.html
set(CMAKE_EXPORT_COMPILE_COMMANDS TRUE)
# Make sure thirdparty stuff is up-to-date.
if ("$ENV{NO_REBUILD_THIRDPARTY}" STREQUAL "")
if (${KUDU_USE_TSAN})
set(TP_ARGS "tsan")
endif()
execute_process(
COMMAND ${THIRDPARTY_DIR}/build-if-necessary.sh ${TP_ARGS}
RESULT_VARIABLE THIRDPARTY_SCRIPT_RESULT)
if (NOT (${THIRDPARTY_SCRIPT_RESULT} EQUAL 0))
message(FATAL_ERROR "Thirdparty was built unsuccessfully, terminating.")
endif()
endif()
############################################################
# Compiler flags
############################################################
# Determine compiler version
include(CompilerInfo)
# compiler flags that are common across debug/release builds
execute_process(COMMAND uname -m OUTPUT_VARIABLE ARCH_NAME)
message(STATUS "Found ARCH_NAME: ${ARCH_NAME}")
if("${ARCH_NAME}" MATCHES "arm64")
# The Apple backend for aarch64 is called arm64.
# Change ARCH_NAME to aarch64 to simplify all of our build checks.
set(ARCH_NAME "aarch64")
endif()
message(STATUS "Using ARCH_NAME: ${ARCH_NAME}")
if("${ARCH_NAME}" MATCHES "x86_64")
# -msse4.2: Enable sse4.2 compiler intrinsics on x86_64
set(CXX_COMMON_FLAGS "-msse4.2")
elseif("${ARCH_NAME}" MATCHES "aarch64")
# Certain platforms such as ARM do not use signed chars by default
# which causes issues with certain bounds checks.
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -fsigned-char")
# Turn off fp-contract on aarch64 to avoid multiply-add operation result difference.
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -ffp-contract=off")
endif()
# -Wall: Enable all warnings.
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -Wall")
# -Wno-sign-compare: suppress warnings for comparison between signed and unsigned
# integers
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -Wno-sign-compare")
# -Wno-comment: suppress warnings about backslash-newline in "//" comments,
# which appear in the Kudu source code due to the use of ASCII art and
# multi-line command line examples in comments.
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -Wno-comment")
# -pthread: enable multithreaded malloc
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -pthread")
# -fno-strict-aliasing
# Assume programs do not follow strict aliasing rules.
# GCC cannot always verify whether strict aliasing rules are indeed followed due to
# fundamental limitations in escape analysis, which can result in subtle bad code generation.
# This has a small perf hit but worth it to avoid hard to debug crashes.
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -fno-strict-aliasing")
# -DBOOST_DATE_TIME_POSIX_TIME_STD_CONFIG
# Enable nanosecond precision for boost's date_time library.
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -DBOOST_DATE_TIME_POSIX_TIME_STD_CONFIG")
# -DBOOST_UUID_RANDOM_PROVIDER_FORCE_POSIX
# For higher portability of the built binaries, switch to /dev/[u]random
# even if getrandom(2) is available. This is to allow for running binaries
# built at OS where getrandom(2) is available at OSes where getrandom(2)
# isn't supported (e.g., that might happen in containerized deployments).
set(CXX_COMMON_FLAGS "${CXX_COMMON_FLAGS} -DBOOST_UUID_RANDOM_PROVIDER_FORCE_POSIX")
# We want access to the PRI* print format macros.
add_definitions(-D__STDC_FORMAT_MACROS)
# We want short macros from util/status.h.
add_definitions(-DKUDU_HEADERS_USE_SHORT_STATUS_MACROS=1)
# Slice includes many gutil dependencies that third-party users of the Kudu
# client library don't have. Our build has them, though.
add_definitions(-DKUDU_HEADERS_USE_RICH_SLICE=1)
# We don't want to use any stubs; that's exclusively for builds using our
# exported client headers).
add_definitions(-DKUDU_HEADERS_NO_STUBS=1)
# The test-related CLI tool will be built if not disabled explicitly.
if("${KUDU_CLI_TEST_TOOL_ENABLED}" STREQUAL "" OR KUDU_CLI_TEST_TOOL_ENABLED)
add_definitions(-DKUDU_CLI_TEST_TOOL_ENABLED)
set(KUDU_CLI_TEST_TOOL_ENABLED 1)
endif()
if(NOT NO_TESTS)
# If building tests, the test-related CLI tool must be built as well for testing.
if(NOT KUDU_CLI_TEST_TOOL_ENABLED)
message(FATAL_ERROR "Must not set -DKUDU_CLI_TEST_TOOL_ENABLED=0 when build with -DNO_TESTS=0")
endif()
endif()
# compiler flags for different build types (run 'cmake -DCMAKE_BUILD_TYPE=<type> .')
# For all builds:
# For CMAKE_BUILD_TYPE=Debug
# -ggdb: Enable gdb debugging
# For CMAKE_BUILD_TYPE=FastDebug
# Same as DEBUG, except with some optimizations on.
# For CMAKE_BUILD_TYPE=Release
# -O3: Enable all compiler optimizations
# -g: Enable symbols for profiler tools (TODO: remove for shipping)
# -DNDEBUG: Turn off dchecks/asserts/debug only code.
# -fno-omit-frame-pointer
# use frame pointers to allow simple stack frame walking for backtraces.
# This has a small perf hit but worth it for the ability to profile in production
# For profile guided optimization (PGO) builds, in addition to the flags for release builds:
# 1. Build first with CMAKE_BUILD_TYPE_PROFILE_GEN:
# -fprofile-generate: Indicates compiler should insert profile guided optimization events
# 2. Run the benchmarks (generates *.gcda profiling data).
# 3. Build again with CMAKE_BUILD_TYPE_PROFILE_BUILD
# -fprofile-use: Compiler will use the profile outputs for optimizations
set(CXX_FLAGS_DEBUG "-ggdb")
set(CXX_FLAGS_FASTDEBUG "-ggdb -O1 -fno-omit-frame-pointer")
set(CXX_FLAGS_RELEASE "-O3 -g -DNDEBUG -fno-omit-frame-pointer")
set(CXX_FLAGS_PROFILE_GEN "${CXX_FLAGS_RELEASE} -fprofile-generate")
set(CXX_FLAGS_PROFILE_BUILD "${CXX_FLAGS_RELEASE} -fprofile-use")
# if no build build type is specified, default to debug builds
if (NOT CMAKE_BUILD_TYPE)
set(CMAKE_BUILD_TYPE Debug)
endif(NOT CMAKE_BUILD_TYPE)
string (TOUPPER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE)
# Alias RELEASE as RELWITHDEBINFO and MINSIZEREL. These are common CMake
# release type names and this provides compatibility with the CLion IDE.
if ("${CMAKE_BUILD_TYPE}" STREQUAL "RELWITHDEBINFO" OR "${CMAKE_BUILD_TYPE}" STREQUAL "MINSIZEREL")
set(CMAKE_BUILD_TYPE RELEASE)
endif ()
# Append to compile flags based on the build type. It's important not to clobber
# CMAKE_CXX_FLAGS because it may contain flags specified by the user.
message("Configured for ${CMAKE_BUILD_TYPE} build (set with cmake -DCMAKE_BUILD_TYPE={release,debug,...})")
if ("${CMAKE_BUILD_TYPE}" STREQUAL "DEBUG")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CXX_FLAGS_DEBUG}")
elseif ("${CMAKE_BUILD_TYPE}" STREQUAL "FASTDEBUG")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CXX_FLAGS_FASTDEBUG}")
elseif ("${CMAKE_BUILD_TYPE}" STREQUAL "RELEASE")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CXX_FLAGS_RELEASE}")
elseif ("${CMAKE_BUILD_TYPE}" STREQUAL "PROFILE_GEN")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CXX_FLAGS_PROFILE_GEN}")
elseif ("${CMAKE_BUILD_TYPE}" STREQUAL "PROFILE_BUILD")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CXX_FLAGS_PROFILE_BUILD}")
else()
message(FATAL_ERROR "Unknown build type: ${CMAKE_BUILD_TYPE}")
endif ()
# Add common flags
set(CMAKE_CXX_FLAGS "${CXX_COMMON_FLAGS} ${CMAKE_CXX_FLAGS}")
if ("${COMPILER_FAMILY}" STREQUAL "clang")
# Ensure that we don't use old versions of clang. There isn't anything
# particularly wrong with those, but no reason to support going back
# this far.
if ("${COMPILER_VERSION}" VERSION_LESS "6.0")
message(FATAL_ERROR "Clang version ${COMPILER_VERSION} too old. "
"Consider using the version of clang in ${THIRDPARTY_TOOLCHAIN_DIR}:\n"
""
" CC=${BUILD_SUPPORT_DIR}/ccache-clang/clang CXX=$CC++ cmake <args>")
endif()
# Using Clang with ccache causes a bunch of spurious warnings that are
# purportedly fixed in the next version of ccache. See the following for details:
#
# http://petereisentraut.blogspot.com/2011/05/ccache-and-clang.html
# http://petereisentraut.blogspot.com/2011/09/ccache-and-clang-part-2.html
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Qunused-arguments")
# Clang generates ambiguous member template warnings when calling the ev++ api.
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-ambiguous-member-template")
# Emit a warning when the method/function marked as deprecated
# in its in-line documentation but lacks the deprecated attribute
# ATTRIBUTE_DEPRECATED in its signature.
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wdocumentation-deprecated-sync")
# Avoid 'taking address of packed member' warnings, which pollute macOs/clang 4.0 builds.
# This is also done in chromium. See:
# https://bugs.chromium.org/p/chromium/issues/detail?id=619640
# Unfortunately older versions of clang complain about not knowing the warning, so
# this also disables the warning about unknown warnings.
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-unknown-warning-option -Wno-address-of-packed-member")
# Only hardcode -fcolor-diagnostics if stderr is opened on a terminal. Otherwise
# the color codes show up as noisy artifacts.
#
# This test is imperfect because 'cmake' and 'make' can be run independently
# (with different terminal options), and we're testing during the former.
#
# We also provide a manual override as -DKUDU_FORCE_COLOR_DIAGNOSTICS=1 or
# by setting an environment variable of the same name.
execute_process(COMMAND test -t 2 RESULT_VARIABLE KUDU_IS_TTY)
if ((NOT "${KUDU_FORCE_COLOR_DIAGNOSTICS}" STREQUAL "") OR
(NOT "$ENV{KUDU_FORCE_COLOR_DIAGNOSTICS}" STREQUAL "") OR
((${KUDU_IS_TTY} EQUAL 0) AND (NOT ("$ENV{TERM}" STREQUAL "dumb"))))
message("Running in a controlling terminal")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fcolor-diagnostics")
else()
message("Running without a controlling terminal or in a dumb terminal")
endif()
elseif("${COMPILER_FAMILY}" STREQUAL "gcc")
# Disallow GCC < 7.0, since it doesn't support the C++17 standard
# well enough for us. https://en.cppreference.com/w/cpp/compiler_support
if ("${COMPILER_VERSION}" VERSION_LESS "7.0")
message(FATAL_ERROR "GCC <7.0 not supported. Consider using "
"thirdparty/clang-toolchain/ to build on older hosts.")
endif()
endif()
# Sanity check linking option.
if (NOT KUDU_LINK)
set(KUDU_LINK "a")
elseif(NOT ("auto" MATCHES "^${KUDU_LINK}" OR
"dynamic" MATCHES "^${KUDU_LINK}" OR
"static" MATCHES "^${KUDU_LINK}"))
message(FATAL_ERROR "Unknown value for KUDU_LINK, must be auto|dynamic|static")
else()
# Remove all but the first letter.
string(SUBSTRING "${KUDU_LINK}" 0 1 KUDU_LINK)
endif()
# If not set, any file that includes kudu_export.h (an autogenerated file) will
# use visibility("hidden") with symbols annotated with KUDU_NO_EXPORT, even when
# compiled with default visibility flags. It is overridden as needed by
# ADD_EXPORTABLE_LIBRARY() when actually compiling exported library variants.
add_definitions("-DKUDU_STATIC_DEFINE")
# Clang does not support using ASAN and TSAN simultaneously.
if ("${KUDU_USE_ASAN}" AND "${KUDU_USE_TSAN}")
message(SEND_ERROR "Can only enable one of ASAN or TSAN at a time")
endif()
# Flag to enable clang address sanitizer (using it along with leak sanitizer).
# This will only build if clang or a recent enough gcc is the chosen compiler.
if (${KUDU_USE_ASAN})
if(NOT (("${COMPILER_FAMILY}" STREQUAL "clang") OR
("${COMPILER_FAMILY}" STREQUAL "gcc" AND "${COMPILER_VERSION}" VERSION_GREATER "4.8")))
message(SEND_ERROR "Cannot use ASAN without clang or gcc >= 4.8")
endif()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address -DADDRESS_SANITIZER")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DLEAK_SANITIZER")
endif()
if (${KUDU_USE_XRAY})
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fxray-instrument")
endif()
# For any C code, use the same flags.
set(CMAKE_C_FLAGS "${CMAKE_CXX_FLAGS}")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17")
# Enable the Clang undefined behavior (UB) sanitizer.
if (${KUDU_USE_UBSAN})
if(NOT (("${COMPILER_FAMILY}" STREQUAL "clang") OR
("${COMPILER_FAMILY}" STREQUAL "gcc" AND "${COMPILER_VERSION}" VERSION_GREATER "4.9")))
message(SEND_ERROR "Cannot use UBSAN without clang or gcc >= 4.9")
endif()
# Enable UB and unsigned integer overflow detection.
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=undefined,integer")
# Disable 'alignment' because unaligned access is really OK on Nehalem and we do it all over the place.
# TODO(todd): enable implicit-integer-sign-change checking after fixing issues.
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-sanitize=alignment,implicit-integer-sign-change,implicit-unsigned-integer-truncation,implicit-signed-integer-truncation")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize-blacklist=${CMAKE_CURRENT_SOURCE_DIR}/build-support/ubsan-blacklist.txt")
# Stop execution after UB or overflow is detected.
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-sanitize-recover=undefined,integer")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DUNDEFINED_SANITIZER")
endif ()
# Flag to enable thread sanitizer (clang or gcc 4.8)
if (${KUDU_USE_TSAN})
if(NOT (("${COMPILER_FAMILY}" STREQUAL "clang") OR
("${COMPILER_FAMILY}" STREQUAL "gcc" AND "${COMPILER_VERSION}" VERSION_GREATER "4.8")))
message(SEND_ERROR "Cannot use TSAN without clang or gcc >= 4.8")
endif()
add_definitions("-fsanitize=thread")
# Enables dynamic_annotations.h to actually generate code
add_definitions("-DDYNAMIC_ANNOTATIONS_ENABLED")
# changes atomicops to use the tsan implementations
add_definitions("-DTHREAD_SANITIZER")
# Disables using the precompiled template specializations for std::string, shared_ptr, etc
# so that the annotations in the header actually take effect.
add_definitions("-D_GLIBCXX_EXTERN_TEMPLATE=0")
# Compile and link against the thirdparty TSAN instrumented libstdcxx.
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,-rpath,${THIRDPARTY_INSTALL_TSAN_DIR}/lib")
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=thread")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -nostdinc++")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${THIRDPARTY_INSTALL_TSAN_DIR}/lib")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -isystem ${THIRDPARTY_INSTALL_TSAN_DIR}/include/c++/v1")
# Strictly speaking, TSAN doesn't require dynamic linking. But it does
# require all code to be position independent, and the easiest way to
# guarantee that is via dynamic linking (not all 3rd party archives are
# compiled with -fPIC e.g. boost).
if(NOT "${ARCH_NAME}" MATCHES "aarch64")
if("${KUDU_LINK}" STREQUAL "a")
message("Using dynamic linking for TSAN")
set(KUDU_LINK "d")
elseif("${KUDU_LINK}" STREQUAL "s")
message(SEND_ERROR "Cannot use TSAN with static linking")
endif()
else()
# workaround for github.com/google/sanitizers/issues/1208
# TSAN with dynamic linking cause all of test cases failed on aarch64,
# we don't apply ENABLE_DIST_TEST on aarch64, so apply static linking direcly
message("Using static linking for TSAN on aarch64")
set(KUDU_LINK "s")
endif()
endif()
# If we still don't know what kind of linking to perform, choose based on
# build type (developers like fast builds).
if ("${KUDU_LINK}" STREQUAL "a")
if ("${CMAKE_BUILD_TYPE}" STREQUAL "DEBUG" OR
"${CMAKE_BUILD_TYPE}" STREQUAL "FASTDEBUG")
message("Using dynamic linking for ${CMAKE_BUILD_TYPE} builds")
set(KUDU_LINK "d")
else()
message("Using static linking for ${CMAKE_BUILD_TYPE} builds")
set(KUDU_LINK "s")
endif()
endif()
include("KuduLinker")
APPEND_LINKER_FLAGS()
if ("${KUDU_USE_ASAN}" OR "${KUDU_USE_TSAN}" OR "${KUDU_USE_UBSAN}")
# GCC 4.8 and 4.9 (latest as of this writing) don't allow you to specify a
# sanitizer blacklist.
if("${COMPILER_FAMILY}" STREQUAL "clang")
add_definitions("-fsanitize-blacklist=${BUILD_SUPPORT_DIR}/sanitize-blacklist.txt")
else()
message(WARNING "GCC does not support specifying a sanitizer blacklist. Known sanitizer check failures will not be suppressed.")
endif()
endif()
if (KUDU_USE_LTO)
if(NOT "${CMAKE_EXE_LINKER_FLAGS}" MATCHES "-fuse-ld=lld" OR
NOT "${COMPILER_FAMILY}" STREQUAL "clang")
message(FATAL_ERROR "must use clang and lld for LTO build")
endif()
if (NOT "${CMAKE_BUILD_TYPE}" STREQUAL "RELEASE")
# Doesn't make much sense to do LTO on a non-release build -- it's slow
# and the only reason you'd want to do it is high performance.
message(FATAL_ERROR "LTO only supported for release builds")
endif()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -flto=thin")
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--thinlto-cache-dir=${CMAKE_CURRENT_BINARY_DIR}/lto.cache")
set(CMAKE_AR "${THIRDPARTY_TOOLCHAIN_DIR}/bin/llvm-ar")
set(CMAKE_RANLIB "${THIRDPARTY_TOOLCHAIN_DIR}/bin/llvm-ranlib")
endif()
# Code coverage
if ("${KUDU_GENERATE_COVERAGE}")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --coverage -DCOVERAGE_BUILD")
if(NOT "${COMPILER_FAMILY}" STREQUAL "clang")
# Use clang for coverage builds so that we can standardize on a single
# compiler. clang also handles flushing coverage from shared libraries
# better than gcc.
message(SEND_ERROR "Must use clang for coverage build")
endif()
endif()
# Having set KUDU_LINK due to build type and/or sanitizer, it's now safe to
# act on its value.
if ("${KUDU_LINK}" STREQUAL "d")
set(BUILD_SHARED_LIBS ON)
# Position independent code is only necessary when producing shared objects.
add_definitions(-fPIC)
endif()
# where to put generated archives (.a files)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/lib")
file(MAKE_DIRECTORY "${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}")
# where to put generated libraries (.so files)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/lib")
file(MAKE_DIRECTORY "${CMAKE_LIBRARY_OUTPUT_DIRECTORY}")
# where to put generated binaries
set(EXECUTABLE_OUTPUT_PATH "${CMAKE_CURRENT_BINARY_DIR}/bin")
file(MAKE_DIRECTORY "${EXECUTABLE_OUTPUT_PATH}")
include_directories(${CMAKE_CURRENT_BINARY_DIR}/src)
include_directories(src)
include_directories(SYSTEM ${THIRDPARTY_INSTALL_COMMON_DIR}/include)
############################################################
# Visibility
############################################################
# For generate_export_header() and add_compiler_export_flags().
include(GenerateExportHeader)
# Honor visibility properties for all target types. See
# "cmake --help-policy CMP0063" for details.
#
# This policy was only added to cmake in version 3.3, so until the cmake in
# thirdparty is updated, we must check if the policy exists before setting it.
if(POLICY CMP0063)
cmake_policy(SET CMP0063 NEW)
endif()
# add_library() wrapper that adds a second variant of the library for use in the
# exported Kudu C++ client. This variant is suffixed with "_exported" and is
# compiled with special visibility flags to hide all symbols except those that
# are part of the public ABI.
#
# There are two different kinds of exported libraries: internal and leaf.
# Internal libraries are static archives while leaf libraries are shared
# objects built from internal libraries. In practice there is only one leaf
# library: the Kudu C++ client itself.
#
# Arguments:
#
# LIB_NAME is the name of the library. It must come first. Required.
#
# SRCS is the list of source files to compile into the library. Required.
#
# DEPS is the list of targets that both library variants depend on. Required.
#
# NONLINK_DEPS is the list of (non-linked) targets that both library variants
# depend on. Optional.
#
# COMPILE_FLAGS is a string containing any additional compilation flags that
# should be added to both library variants. Optional.
#
# EXPORTED_SHARED is a toggle that, if set, indicates that the exported variant
# is a "leaf" library. Otherwise it is an "internal" library. Optional.
#
# EXPORTED_OUTPUT_NAME is a string describing a different file name for the
# exported library variant. If not set, defaults to LIB_NAME. Optional.
#
# EXPORTED_OUTPUT_DIRECTORY is a string describing a different directory where
# the exported library variant should be written. If not set, defaults to the
# directory where this function was called. Optional.
#
# EXPORTED_DEPS is a list of targets that the exported library variant depends
# on. If not set, defaults to DEPS. Optional.
function(ADD_EXPORTABLE_LIBRARY LIB_NAME)
# Parse the arguments.
set(options EXPORTED_SHARED)
set(one_value_args COMPILE_FLAGS EXPORTED_OUTPUT_NAME EXPORTED_OUTPUT_DIRECTORY)
set(multi_value_args SRCS DEPS EXPORTED_DEPS NONLINK_DEPS)
cmake_parse_arguments(ARG "${options}" "${one_value_args}" "${multi_value_args}" ${ARGN})
if(ARG_UNPARSED_ARGUMENTS)
message(SEND_ERROR "Error: unrecognized arguments: ${ARG_UNPARSED_ARGUMENTS}")
endif()
# First add the regular version of the library. It uses
# whatever linkage was defined globally.
add_library(${LIB_NAME} ${ARG_SRCS})
if(ARG_COMPILE_FLAGS)
set_target_properties(${LIB_NAME}
PROPERTIES COMPILE_FLAGS ${ARG_COMPILE_FLAGS})
endif()
target_link_libraries(${LIB_NAME} ${ARG_DEPS})
if(ARG_NONLINK_DEPS)
add_dependencies(${LIB_NAME} ${ARG_NONLINK_DEPS})
endif()
# Now start setting up the exported variant.
set(EXPORTED_LIB_NAME ${LIB_NAME}_exported)
if(ARG_EXPORTED_SHARED)
# Leaf library.
set(EXPORTED_LINKAGE "SHARED")
set(EXPORTED_LINK_PRIVATE "LINK_PRIVATE")
else()
# Internal library.
set(EXPORTED_LINKAGE "STATIC")
set(EXPORTED_LINK_PRIVATE)
endif()
add_library(${EXPORTED_LIB_NAME} ${EXPORTED_LINKAGE} ${ARG_SRCS})
# Compile with visibility flags:
# - default for classes annotated with KUDU_EXPORT.
# - hidden for classes annotated with KUDU_NO_EXPORT.
# - hidden for everything else.
if(POLICY CMP0063)
set_target_properties(${EXPORTED_LIB_NAME}
PROPERTIES C_VISIBILITY_PRESET hidden)
set_target_properties(${EXPORTED_LIB_NAME}
PROPERTIES CXX_VISIBILITY_PRESET hidden)
set_target_properties(${EXPORTED_LIB_NAME}
PROPERTIES VISIBILITY_INLINES_HIDDEN 1)
else()
add_compiler_export_flags(EXPORTED_FLAGS)
endif()
# Exported variants are either static archives that will be linked to a shared
# object, or shared objects. Either way, -fPIC is needed.
if("${KUDU_LINK}" STREQUAL "s")
set(EXPORTED_FLAGS "${EXPORTED_FLAGS} -fPIC")
endif()
# We need to remove some definitions previously added at directory scope.
# There doesn't appear to be a good way to do this in cmake, so we do it via
# the compiler with -U (e.g. "-UFOO" means "undefine the FOO definition").
# Adding insult to injury, the COMPILE_DEFINITIONS property adds a -D prefix
# to anything passed into it, so we're forced to handle the removal via
# COMPILE_FLAGS, which, lucky for us, is emitted on the command line after
# COMPILE_DEFINITIONS.
# Exported variants need KUDU_EXPORT definitions to take effect.
set(EXPORTED_FLAGS "${EXPORTED_FLAGS} -UKUDU_STATIC_DEFINE")
# Exported variants may not use tcmalloc.
set(EXPORTED_FLAGS "${EXPORTED_FLAGS} -UTCMALLOC_ENABLED")
# Exported variants should conform to the C++03 ABI, which doesn't
# include sized deallocation (new in C++14). This reverses the setting from
# non-exported (default) flags.
if(COMPILER_SUPPORTS_SIZED_DEALLOCATION)
# Note: this is retained by the set_target_properties() call below.
target_compile_options(${EXPORTED_LIB_NAME}
PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-fno-sized-deallocation>)
endif()
set_target_properties(${EXPORTED_LIB_NAME}
PROPERTIES COMPILE_FLAGS "${ARG_COMPILE_FLAGS} ${EXPORTED_FLAGS}")
# Handle EXPORTED_OUTPUT_NAME and EXPORTED_OUTPUT_DIRECTORY.
if(ARG_EXPORTED_OUTPUT_NAME)
set_target_properties(${EXPORTED_LIB_NAME}
PROPERTIES LIBRARY_OUTPUT_NAME ${ARG_EXPORTED_OUTPUT_NAME})
endif()
if(ARG_EXPORTED_OUTPUT_DIRECTORY)
set_target_properties(${EXPORTED_LIB_NAME}
PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${ARG_EXPORTED_OUTPUT_DIRECTORY})
endif()
# Set up exported variant dependent targets.
#
# Every linked dependency is suffixed with "_exported". This is fine; the
# exported target graph is expected to be complete, and ADD_THIRDPARTY_LIB
# will provide an "exported variant" for each third party target.
if(ARG_EXPORTED_DEPS)
set(EXPORTED_DEPS ${ARG_EXPORTED_DEPS})
else()
set(EXPORTED_DEPS ${ARG_DEPS})
endif()
foreach(DEP ${EXPORTED_DEPS})
list(APPEND EXPORTED_SUFFIXED_DEPS "${DEP}_exported")
endforeach()
target_link_libraries(${EXPORTED_LIB_NAME} ${EXPORTED_LINK_PRIVATE} ${EXPORTED_SUFFIXED_DEPS})
if(ARG_NONLINK_DEPS)
add_dependencies(${EXPORTED_LIB_NAME} ${ARG_NONLINK_DEPS})
endif()
endfunction()
############################################################
# Features that depend on Linux kernel version
############################################################
# The diagnostic socket is a Linux-specific functionality based on
# the sock_diag netlink subsystem: see the DiagnosticSocket class
# in src/kudu/util/net/diagnostic_socket.cc and its usage elsewhere.
# For more information on the sock_diag netlink subsystem in Linux see [1].
#
# [1] https://man7.org/linux/man-pages/man7/sock_diag.7.html
if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux" AND
"${CMAKE_HOST_SYSTEM_VERSION}" VERSION_GREATER_EQUAL "3.3")
set(KUDU_HAS_DIAGNOSTIC_SOCKET 1)
add_definitions(-DKUDU_HAS_DIAGNOSTIC_SOCKET)
message(STATUS "Diagnostic Socket is AVAILABLE")
else()
message(STATUS "Diagnostic Socket is NOT AVAILABLE")
endif()
############################################################
# Testing
############################################################
# Add a new binary that is compiled just like a unit test but is not executed
# by or registered with "ctest". Useful for writing tests that use the Google
# Test infrastructure but cannot or should not be run pre-commit.
function(ADD_KUDU_TEST_NO_CTEST REL_TEST_NAME)
get_filename_component(TEST_NAME ${REL_TEST_NAME} NAME_WE)
add_executable(${TEST_NAME} "${REL_TEST_NAME}.cc")
target_link_libraries(${TEST_NAME} ${KUDU_TEST_LINK_LIBS})
endfunction()
# Add a new test case, with or without an executable that should be built.
#
# REL_TEST_NAME is the name of the test. It may be a single component
# (e.g. monotime-test) or contain additional components (e.g.
# net/net_util-test). Either way, the last component must be a globally
# unique name.
#
# Additional optional arguments:
#
# TIMEOUT <secs>
# Sets a timeout for running this test.
#
# NOTE: this only affects the test timeout when run via 'ctest'.
# Jenkins builds typically execute tests using dist-test, and that
# does not respect these timeouts. If a test suite is long enough
# to require a bumped timeout, consider enabling sharding of the
# test (see below).
#
# NUM_SHARDS <num shards>
# Sets the number of shards used for running this test.
#
# This configuration splits up the test cases within the binary
# into several separate shards. Each shard becomes a separate
# test case when run by ctest or when submitted for distributed testing.
# This should be used whenever a test binary is long-running and
# consists of many separate test cases.
#
# NOTE: sharding is still recommended even for tests with RUN_SERIAL
# or RESOURCE_LOCK properties. Even though the shards cannot run in
# parallel on a single machine using ctest, they will still run in
# parallel across separate machines using dist-test.
#
# PROCESSORS <num processors>
# RUN_SERIAL true
# These built-in CMake properties should be used when a test is
# a heavy consumer of CPU.
#
# The PROCESSORS flag allows ctest to ensure that tests are only
# scheduled in parallel when an appropriate number of cores are
# available. The default is to assume that a test uses a single core
# (i.e. equivalent to PROCESSORS 1).
#
# RUN_SERIAL ensures that the test does not run in parallel with any
# other test. This should be used for stress tests which start many
# threads and attempt to monopolize the machine.
#
# In order to determine an appropriate setting, you can run the test
# with the KUDU_MEASURE_TEST_CPU_CONSUMPTION environment variable
# set. See build-support/run-test.sh for more details.
#
# DATA_FILES <file1> <file2> ...
# Specify data files that should be copied into the build directory next
# to test executable into the 'testdata' sub-directory, i.e. into
# '<build_dir>/bin/testdata' with current layout of the test binaries.
# The path to the source file should be specified from the location
# of the corresponding CMakeLists.txt file.
#
# Any other arguments will be passed to set_tests_properties().
function(ADD_KUDU_TEST REL_TEST_NAME)
# Parse out properties for which we have special handling.
set(options)
set(one_value_args TIMEOUT NUM_SHARDS)
set(multi_value_args DATA_FILES)
cmake_parse_arguments(ARG "${options}" "${one_value_args}" "${multi_value_args}" ${ARGN})
if(NOT ARG_TIMEOUT)
# Default to 15 minutes.
# NOTE: this should be kept in sync with the default value of KUDU_TEST_TIMEOUT
# in build-support/run-test.sh
set(ARG_TIMEOUT 900)
endif()
if(NOT ARG_NUM_SHARDS)
set(ARG_NUM_SHARDS 1)
endif()
# Any unrecognized arguments go into ${ARG_UNPARSED_ARGUMENTS}, which we forward
# along as properties down below.
if(NO_TESTS)
return()
endif()
get_filename_component(TEST_NAME ${REL_TEST_NAME} NAME_WE)
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${REL_TEST_NAME}.cc)
# This test has a corresponding .cc file, set it up as an executable.
set(TEST_PATH "${EXECUTABLE_OUTPUT_PATH}/${TEST_NAME}")
ADD_KUDU_TEST_NO_CTEST(${REL_TEST_NAME})
elseif(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${REL_TEST_NAME})
# No executable, just invoke the test (probably a script) directly.
get_filename_component(TEST_NAME_WITH_EXT ${REL_TEST_NAME} NAME)
set(TEST_PATH "${EXECUTABLE_OUTPUT_PATH}/${TEST_NAME_WITH_EXT}")
# Ideally this would run only when the test is built, not when cmake runs,
# but add_test() doesn't yield a target (if it did, that target could depend
# on an add_custom_command() that copies the test file into place).
execute_process(COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/${REL_TEST_NAME}
${EXECUTABLE_OUTPUT_PATH})
else()
message(FATAL_ERROR "Neither ${REL_TEST_NAME} nor ${REL_TEST_NAME}.cc were found in ${CMAKE_CURRENT_SOURCE_DIR}/")
endif()
# Copy data files into the build directory.
set(DATA_FILES_DST_SUBDIR testdata)
set(DST_DIR ${EXECUTABLE_OUTPUT_PATH}/${DATA_FILES_DST_SUBDIR})
set(DATA_FILES_LIST)
foreach(DATA_FILE ${ARG_DATA_FILES})
get_filename_component(DATA_FILE_NAME ${DATA_FILE} NAME)
list(APPEND DATA_FILES_LIST ${DATA_FILES_DST_SUBDIR}/${DATA_FILE_NAME})
file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/${DATA_FILE}
# Copy with read and execute permissions, since tests should not modify
# the data files in place, but data files may be scripts used by tests.
DIRECTORY_PERMISSIONS OWNER_READ OWNER_EXECUTE GROUP_READ GROUP_EXECUTE
FILE_PERMISSIONS OWNER_READ OWNER_EXECUTE GROUP_READ GROUP_EXECUTE
DESTINATION ${DST_DIR})
endforeach()
math(EXPR MAX_SHARD "${ARG_NUM_SHARDS} - 1")
foreach(SHARD_NUM RANGE ${MAX_SHARD})
# Only name the targets with a '.<shard>' if the test is sharded.
if(${ARG_NUM_SHARDS} EQUAL 1)
set(TARGET ${TEST_NAME})
else()
set(TARGET ${TEST_NAME}.${SHARD_NUM})
endif()
add_test(${TARGET}
${BUILD_SUPPORT_DIR}/run-test.sh ${TEST_PATH})
if(ARG_UNPARSED_ARGUMENTS)
set_tests_properties(${TARGET} PROPERTIES ${ARG_UNPARSED_ARGUMENTS})
endif()
# Set the ctest timeout to be a bit longer than the timeout we pass to
# our test wrapper. This gives the test wrapper some opportunity to do
# things like dump stacks, compress the log, etc.
math(EXPR EXTENDED_TIMEOUT "${ARG_TIMEOUT} + 30")
# Add the configured timeout to the environment for the test wrapper.
get_test_property(${TARGET} ENVIRONMENT CUR_TEST_ENV)
if(NOT CUR_TEST_ENV)
set(CUR_TEST_ENV "")
endif()
list(APPEND CUR_TEST_ENV "KUDU_TEST_TIMEOUT=${ARG_TIMEOUT}")
list(APPEND CUR_TEST_ENV "GTEST_TOTAL_SHARDS=${ARG_NUM_SHARDS}")
list(APPEND CUR_TEST_ENV "GTEST_SHARD_INDEX=${SHARD_NUM}")
# The only way we can pass information to dist-test is through the environment.
# So, use a comma-delimited environment variable to pass the list of data files
# that need to be uploaded.
if(DATA_FILES_LIST)
string(REPLACE ";" "," DATA_FILES_ENV "${DATA_FILES_LIST}")
list(APPEND CUR_TEST_ENV "KUDU_DATA_FILES=${DATA_FILES_ENV}")
endif()
set_tests_properties(${TARGET} PROPERTIES
TIMEOUT ${EXTENDED_TIMEOUT}
ENVIRONMENT "${CUR_TEST_ENV}")
endforeach(SHARD_NUM)
endfunction()
# A wrapper for add_dependencies() that is compatible with NO_TESTS.
function(ADD_KUDU_TEST_DEPENDENCIES REL_TEST_NAME)
if(NO_TESTS)
return()
endif()
get_filename_component(TEST_NAME ${REL_TEST_NAME} NAME_WE)
add_dependencies(${TEST_NAME} ${ARGN})
endfunction()
enable_testing()
############################################################
# Dependencies
############################################################
function(ADD_THIRDPARTY_LIB LIB_NAME)
set(options)
set(one_value_args SHARED_LIB STATIC_LIB)
set(multi_value_args DEPS)
cmake_parse_arguments(ARG "${options}" "${one_value_args}" "${multi_value_args}" ${ARGN})
if(ARG_UNPARSED_ARGUMENTS)
message(SEND_ERROR "Error: unrecognized arguments: ${ARG_UNPARSED_ARGUMENTS}")
endif()
if(("${KUDU_LINK}" STREQUAL "s" AND ARG_STATIC_LIB) OR (NOT ARG_SHARED_LIB))
if(NOT ARG_STATIC_LIB)
message(FATAL_ERROR "No static or shared library provided for ${LIB_NAME}")
endif()
add_library(${LIB_NAME} STATIC IMPORTED)
set_target_properties(${LIB_NAME}
PROPERTIES IMPORTED_LOCATION "${ARG_STATIC_LIB}")
message("Added static library dependency ${LIB_NAME}: ${ARG_STATIC_LIB}")
else()
add_library(${LIB_NAME} SHARED IMPORTED)
set_target_properties(${LIB_NAME}
PROPERTIES IMPORTED_LOCATION "${ARG_SHARED_LIB}")
message("Added shared library dependency ${LIB_NAME}: ${ARG_SHARED_LIB}")
endif()
if(ARG_DEPS)
set_target_properties(${LIB_NAME}
PROPERTIES IMPORTED_LINK_INTERFACE_LIBRARIES "${ARG_DEPS}")
endif()
# Set up an "exported variant" for this thirdparty library (see "Visibility"
# above). It's the same as the real target, just with an "_exported" suffix.
# We prefer the static archive if it exists (as it's akin to an "internal"
# library), but we'll settle for the shared object if we must.
#
# A shared object exported variant will force any "leaf" library that
# transitively depends on it to also depend on it at runtime; this is
# desirable for some libraries (e.g. cyrus_sasl).
set(LIB_NAME_EXPORTED "${LIB_NAME}_exported")
if(ARG_STATIC_LIB)
add_library(${LIB_NAME_EXPORTED} STATIC IMPORTED)
set_target_properties(${LIB_NAME_EXPORTED}
PROPERTIES IMPORTED_LOCATION "${ARG_STATIC_LIB}")
else()
add_library(${LIB_NAME_EXPORTED} SHARED IMPORTED)
set_target_properties(${LIB_NAME_EXPORTED}
PROPERTIES IMPORTED_LOCATION "${ARG_SHARED_LIB}")
endif()
if(ARG_DEPS)
foreach(DEP ${ARG_DEPS})
list(APPEND EXPORTED_DEPS "${DEP}_exported")
endforeach()
set_target_properties(${LIB_NAME_EXPORTED}
PROPERTIES IMPORTED_LINK_INTERFACE_LIBRARIES "${EXPORTED_DEPS}")
endif()
endfunction()