Files
apple-foundationdb/flow/CMakeLists.txt
2025-11-18 13:02:35 -08:00

321 lines
11 KiB
CMake

find_package(Threads REQUIRED)
option(FLOW_USE_ZSTD "Enable zstd compression in flow" OFF)
fdb_find_sources(FLOW_SRCS)
if(FLOW_USE_ZSTD)
# NOTE: To enable boost::iostreams with zstd library support, manually add
# zstd.cpp to source files is required. Ref:
# https://www.boost.org/doc/libs/1_79_0/libs/iostreams/doc/installation.html
list(APPEND FLOW_SRCS ../contrib/boost_zstd/zstd.cpp)
endif()
# Remove files with `main` defined so we can create a link test executable.
list(REMOVE_ITEM FLOW_SRCS LinkTest.cpp)
list(REMOVE_ITEM FLOW_SRCS TLSTest.cpp)
list(REMOVE_ITEM FLOW_SRCS MkCertCli.cpp)
list(REMOVE_ITEM FLOW_SRCS acac.cpp)
if(CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64")
list(APPEND FLOW_SRCS aarch64/memcmp.S aarch64/memcpy.S)
endif()
make_directory(${CMAKE_CURRENT_BINARY_DIR}/include/flow)
set(FDB_API_VERSION_FILE
"${CMAKE_CURRENT_SOURCE_DIR}/ApiVersions.cmake"
CACHE STRING "Api version cmake file." FORCE)
include(${FDB_API_VERSION_FILE})
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ApiVersion.h.cmake
${CMAKE_CURRENT_BINARY_DIR}/include/flow/ApiVersion.h)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/SourceVersion.h.cmake
${CMAKE_CURRENT_BINARY_DIR}/include/flow/SourceVersion.h)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config.h.cmake
${CMAKE_CURRENT_BINARY_DIR}/include/flow/config.h)
set(PROTOCOL_VERSION_PYTHON_EXECUTABLE "${Python3_EXECUTABLE}")
find_package(Python3 REQUIRED COMPONENTS Interpreter)
find_package(Jinja2)
if(NOT Jinja2_FOUND)
message(
STATUS
"Jinja2 not found, setting up virtual environment for protocol_version.py"
)
set(PROTOCOL_VERSION_VENV_DIR "${CMAKE_BINARY_DIR}/protocol_version-venv")
execute_process(COMMAND "${Python3_EXECUTABLE}" -m venv
${PROTOCOL_VERSION_VENV_DIR} OUTPUT_QUIET ERROR_QUIET)
find_program(
VENV_Python3_EXECUTABLE
NAMES python3 python3.exe
PATHS ${PROTOCOL_VERSION_VENV_DIR}/Scripts ${PROTOCOL_VERSION_VENV_DIR}/bin
REQUIRED
NO_DEFAULT_PATH NO_CACHE
DOC "Checking Python3 executable in virtual environment")
execute_process(COMMAND "${VENV_Python3_EXECUTABLE}" -m ensurepip
COMMAND_ERROR_IS_FATAL ANY)
execute_process(COMMAND "${VENV_Python3_EXECUTABLE}" -m pip install --upgrade
pip COMMAND_ERROR_IS_FATAL ANY)
execute_process(
COMMAND
"${VENV_Python3_EXECUTABLE}" -m pip install -r
"${CMAKE_CURRENT_SOURCE_DIR}/protocolversion/requirements.txt"
COMMAND_ERROR_IS_FATAL ANY)
set(PROTOCOL_VERSION_PYTHON_EXECUTABLE "${VENV_Python3_EXECUTABLE}")
endif()
set(FDB_PROTOCOL_VERSION_FILE
"${CMAKE_CURRENT_SOURCE_DIR}/ProtocolVersions.cmake"
CACHE STRING "Protocol version cmake file." FORCE)
set(FDB_PROTOCOL_VERSION_HEADER_FILE
"${CMAKE_CURRENT_BINARY_DIR}/include/flow/ProtocolVersion.h")
set(FDB_PROTOCOL_VERSION_JAVA_FILE
"${CMAKE_CURRENT_BINARY_DIR}/include/flow/ProtocolVersion.java")
set(FDB_PROTOCOL_VERSION_PYTHON_FILE
"${CMAKE_CURRENT_BINARY_DIR}/include/flow/protocol_version.py")
add_custom_command(
OUTPUT ${FDB_PROTOCOL_VERSION_HEADER_FILE}
COMMAND
${PROTOCOL_VERSION_PYTHON_EXECUTABLE}
${CMAKE_CURRENT_SOURCE_DIR}/protocolversion/protocol_version.py --source
${FDB_PROTOCOL_VERSION_FILE} --generator cpp --output
${FDB_PROTOCOL_VERSION_HEADER_FILE}
COMMAND
${PROTOCOL_VERSION_PYTHON_EXECUTABLE}
${CMAKE_CURRENT_SOURCE_DIR}/protocolversion/protocol_version.py --source
${FDB_PROTOCOL_VERSION_FILE} --generator java --output
${FDB_PROTOCOL_VERSION_JAVA_FILE}
COMMAND
${PROTOCOL_VERSION_PYTHON_EXECUTABLE}
${CMAKE_CURRENT_SOURCE_DIR}/protocolversion/protocol_version.py --source
${FDB_PROTOCOL_VERSION_FILE} --generator python --output
${FDB_PROTOCOL_VERSION_PYTHON_FILE}
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/protocolversion/protocol_version.py
${CMAKE_CURRENT_SOURCE_DIR}/protocolversion/ProtocolVersion.h.template
${CMAKE_CURRENT_SOURCE_DIR}/ProtocolVersions.cmake)
add_custom_target(ProtocolVersion DEPENDS ${FDB_PROTOCOL_VERSION_HEADER_FILE})
add_flow_target(STATIC_LIBRARY NAME flow SRCS ${FLOW_SRCS})
add_flow_target(STATIC_LIBRARY NAME flow_sampling SRCS ${FLOW_SRCS})
add_dependencies(flow ProtocolVersion)
add_dependencies(flow_sampling ProtocolVersion)
if(FLOW_USE_ZSTD)
include(CompileZstd)
compile_zstd()
target_link_libraries(flow PRIVATE libzstd_static)
target_compile_definitions(flow PUBLIC ZSTD_LIB_SUPPORTED)
endif()
# When creating a static or shared library, undefined symbols will be ignored.
# Since we want to ensure no symbols from other modules are used, create an
# executable so the linker will throw errors if it can't find the declaration of
# a symbol.
add_flow_target(LINK_TEST NAME flowlinktest SRCS LinkTest.cpp)
target_link_libraries(flowlinktest PRIVATE flow stacktrace)
set(IS_ARM_MAC NO)
if(APPLE AND CMAKE_SYSTEM_PROCESSOR STREQUAL "arm64")
set(IS_ARM_MAC YES)
endif()
foreach(ft flow flow_sampling flowlinktest)
target_include_directories(
${ft}
PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include"
"${CMAKE_CURRENT_BINARY_DIR}/include"
"${CMAKE_SOURCE_DIR}/contrib/libb64/include")
if(FLOW_USE_ZSTD)
target_include_directories(${ft} PRIVATE SYSTEM ${ZSTD_LIB_INCLUDE_DIR})
endif()
if(USE_JEMALLOC)
target_include_directories(${ft} PRIVATE ${jemalloc_INCLUDE_DIRS})
endif()
target_link_libraries(${ft} PRIVATE stacktrace)
target_link_libraries(${ft} PUBLIC fmt::fmt SimpleOpt crc32 libb64)
if(UNIX AND NOT APPLE)
target_link_libraries(${ft} PRIVATE folly_memcpy)
target_compile_definitions(${ft} PRIVATE WITH_FOLLY_MEMCPY)
endif()
if(NOT APPLE AND NOT WIN32)
set(FLOW_LIBS ${FLOW_LIBS} rt)
elseif(WIN32)
target_link_libraries(${ft} PUBLIC winmm.lib)
target_link_libraries(${ft} PUBLIC psapi.lib)
endif()
if(CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
set(FLOW_LIBS ${FLOW_LIBS} execinfo devstat)
find_library(EIO eio)
if(EIO)
target_link_libraries(${ft} PUBLIC ${EIO})
endif()
endif()
target_link_libraries(${ft} PRIVATE ${FLOW_LIBS})
if(USE_VALGRIND)
target_link_libraries(${ft} PUBLIC valgrind)
endif()
target_link_libraries(${ft} PUBLIC OpenSSL::SSL)
target_link_libraries(${ft} PUBLIC Threads::Threads ${CMAKE_DL_LIBS})
target_link_libraries(${ft} PUBLIC boost_target)
if(APPLE)
find_library(IO_KIT IOKit)
find_library(CORE_FOUNDATION CoreFoundation)
target_link_libraries(${ft} PRIVATE ${IO_KIT} ${CORE_FOUNDATION})
endif()
find_package(
Coroutines
COMPONENTS Experimental Final
REQUIRED)
target_link_libraries(${ft} PUBLIC std::coroutines)
endforeach()
if(OPEN_FOR_IDE)
# AcAC requires actor transpiler
add_library(acac OBJECT acac.cpp)
else()
add_executable(acac acac.cpp)
endif()
target_link_libraries(acac PUBLIC flow boost_target_program_options)
target_compile_definitions(flow_sampling PRIVATE -DENABLE_SAMPLING)
if(WIN32)
add_dependencies(flow_sampling_actors flow_actors)
endif()
if(OPEN_FOR_IDE)
add_library(mkcert OBJECT MkCertCli.cpp)
else()
add_executable(mkcert MkCertCli.cpp)
endif()
target_link_libraries(mkcert PUBLIC flow)
set(FLOW_BINARY_DIR "${CMAKE_BINARY_DIR}/flow")
if(WITH_SWIFT)
include(GenerateModulemap)
generate_modulemap("${CMAKE_BINARY_DIR}/flow/include" "Flow" flow OMIT
sse2neon.h ppc-asm.h)
add_library(
flow_swift STATIC
FlowCheckedContinuation.swift
stream_support.swift # general stream support types
flow_stream_support.swift # conformances for future types that we vend with
# this module (E.g. CInt, Void)
error_support.swift
task_priority_support.swift
SwiftBridging.swift
SwiftFileB.swift
future_support.swift # general support types
trace_support.swift # general support types
flow_future_support.swift # conformances for future types that we vend with
# this module (E.g. CInt, Void)
reply_support.swift
clock_support.swift
flow_optional_support.swift)
target_include_directories(
flow_swift
PUBLIC "${CMAKE_BINARY_DIR}/flow/include"
"${CMAKE_SOURCE_DIR}/flow/include"
"${CMAKE_BINARY_DIR}/flow/"
"${CMAKE_BINARY_DIR}/fdbclient/include"
"${CMAKE_BINARY_DIR}/fdbserver/include"
"${CMAKE_SOURCE_DIR}/fdbrpc/include"
"${CMAKE_BINARY_DIR}/fdbrpc/include"
"${CMAKE_SOURCE_DIR}/contrib/md5/include"
"${CMAKE_SOURCE_DIR}/contrib/libb64/include"
"${CMAKE_SOURCE_DIR}/contrib/sqlite"
"${Boost_DIR}/../../../include"
"${msgpack_DIR}/include")
include(FindSwiftLibs)
swift_get_linker_search_paths(SWIFT_LINK_PATHS)
target_link_directories(flow PUBLIC "${SWIFT_LINK_PATHS}")
# We need to make sure that Swift, and the concurrency library is linked in
# every module that uses flow, because we implement the Swift hooks in flow.
# TODO(swift): With upcoming CMake 3.26 we can get rid of this as it should
# realize that modules need Swift and use Swift for the linking which will do
# the right thing.
target_link_options(flow PUBLIC "-lswiftCore" "-lswift_Concurrency"
"-lswift_StringProcessing")
# Link with runtime initialization stub (not needed on Darwin).
if(NOT APPLE)
string(REPLACE " " ";" SWIFT_LINK_PATHS_LIST "${SWIFT_LINK_PATHS}")
list(GET SWIFT_LINK_PATHS_LIST -1 LastPath) # get the last element the list
target_link_options(flow PUBLIC "${LastPath}/swiftrt.o")
endif()
# TODO: the TBD validation skip is because of swift_job_run_generic, though it
# seems weird why we need to do that?
target_compile_options(
flow_swift
PRIVATE
"$<$<COMPILE_LANGUAGE:Swift>:SHELL:-Xcc -std=c++20 -Xfrontend -validate-tbd-against-ir=none -Xcc -DNO_INTELLISENSE -Xcc -ivfsoverlay${CMAKE_BINARY_DIR}/flow/include/headeroverlay.yaml>"
)
# Ensure that C++ code in fdbserver can import Swift using a compatibility
# header.
include(SwiftToCXXInterop)
add_swift_to_cxx_header_gen_target(
flow_swift
flow_swift_checked_continuation_header
"${CMAKE_CURRENT_BINARY_DIR}/include/SwiftModules/Flow_CheckedContinuation.h"
SOURCES
"${CMAKE_CURRENT_SOURCE_DIR}/FlowCheckedContinuation.swift"
"${CMAKE_CURRENT_SOURCE_DIR}/flow_optional_support.swift"
FLAGS
-Xcc
-std=c++20
-Xcc
-DNO_INTELLISENSE
-Xcc
-ivfsoverlay${CMAKE_BINARY_DIR}/flow/include/headeroverlay.yaml
# Important: This is needed to avoid including headers that depends on this
# generated header.
-Xcc
-DSWIFT_FUTURE_SUPPORT_H
-Xcc
-DSWIFT_STREAM_SUPPORT_H
-Xcc
-DSWIFT_HIDE_CHECKED_CONTINUTATION)
add_swift_to_cxx_header_gen_target(
flow_swift
flow_swift_header
"${CMAKE_CURRENT_BINARY_DIR}/include/SwiftModules/Flow"
FLAGS
-Xcc
-std=c++20
-Xcc
-DNO_INTELLISENSE
-Xcc
-ivfsoverlay${CMAKE_BINARY_DIR}/flow/include/headeroverlay.yaml)
add_dependencies(flow_swift_checked_continuation_header flow_actors
boost_target ProtocolVersion)
add_dependencies(flow_swift_header flow_swift_checked_continuation_header)
add_dependencies(flow_swift flow_swift_header)
add_dependencies(flow_swift flow_actors)
add_dependencies(flow_swift boost_target)
# TODO(swift): rdar://99107402 - this will only work once CMake 3.25 is
# released: target_link_libraries(flow PRIVATE flow_swift)
add_dependencies(flow flow_swift)
add_dependencies(flow_sampling flow_swift)
endif() # WITH SWIFT