%YAML 1.2 --- | # GRPC global cmake file # This currently builds C and C++ code. # This file has been automatically generated from a template file. # Please look at the templates directory instead. # This file can be regenerated from the template by running # tools/buildgen/generate_projects.sh # # Copyright 2015 gRPC authors. # # Licensed 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. <% import re proto_re = re.compile('(.*)\\.proto') lib_map = {lib.name: lib for lib in libs} third_party_proto_prefixes = {lib.proto_prefix for lib in external_proto_libraries} gpr_libs = ['gpr'] grpc_libs = ['grpc', 'grpc_unsecure'] grpcxx_libs = ['grpc++', 'grpc++_unsecure'] protoc_libs = ['benchmark_helpers', 'grpc++_reflection', 'grpcpp_channelz'] def third_party_proto_import_path(path): """Removes third_party prefix to match ProtoBuf's relative import path.""" for prefix in third_party_proto_prefixes: if path.startswith(prefix): return path[len(prefix):] return path def proto_replace_ext(filename, ext): """Replace the .proto extension with given extension.""" m = proto_re.match(filename) if not m: return filename return '${_gRPC_PROTO_GENS_DIR}/' + third_party_proto_import_path(m.group(1)) + ext def is_absl_lib(lib_name): """Returns True if the library is one of the abseil libraries.""" return lib_name.startswith("absl/") def get_absl_dep(lib_name): """Gets the corresponding cmake target for given absl library.""" # The "cmake_target" field originates from src/abseil-cpp/preprocessed_builds.yaml.gen.py return lib_map[lib_name].cmake_target def get_transitive_deps(lib_name): """Get list of transitive deps for given library.""" transitive_deps = [] lib_metadata = lib_map.get(lib_name, None) if lib_metadata: transitive_deps = lib_metadata.transitive_deps return list(transitive_deps) def list_abseil_pkg_targets(lib): # TODO(jtattermusch): this function is odd, try to eliminate it. # This returns a list of abseil pkg targets which the given lib and # its non-abseil transitive dependencies depend on. # As a result, internal abseil libraries are excluded from the result. absl_specs = set() transitive_deps_and_self = [lib] + get_transitive_deps(lib) for lib_name in transitive_deps_and_self: if is_absl_lib(lib_name): continue lib_metadata = lib_map.get(lib_name, None) if lib_metadata: for dep in lib_metadata.deps: if is_absl_lib(dep): absl_specs.add(get_absl_dep(dep).replace("::", "_")) return list(sorted(absl_specs)) def lib_name_to_pkgconfig_requires_private_name(lib_name): """If library belongs to pkgconfig Requires.private section, return the name under which to include it.""" # TODO(jtattermusch): extract the metadata to a centralized location. deps_to_pkgconfig_requires_private = { "cares": "libcares", "libssl": "openssl", "re2": "re2", "z": "zlib", } return deps_to_pkgconfig_requires_private.get(lib_name, None) def is_pkgconfig_package(lib_name): """Returns True if a pkgconfig package exists for a given library.""" # TODO(jtattermusch): extract the metadata to a centralized location. if lib_name in ["address_sorting", "utf8_range_lib"]: return False if lib_name == "upb" or lib_name.startswith("upb_"): # TODO(jtattermusch): Add better detection for what are the "upb" libs. return False return True def get_pkgconfig_requires(lib): """Returns "Requires" list for generating the pkgconfig .pc file for given library.""" requires = set() requires.update(list_abseil_pkg_targets(lib)) for lib_name in get_transitive_deps(lib): if not is_pkgconfig_package(lib_name): # these deps go into Libs or Libs.Private continue if is_absl_lib(lib_name): # absl libs have special handling continue if lib_name_to_pkgconfig_requires_private_name(lib_name) is not None: # these deps go into Requires.private continue if lib_name == 'protobuf': # TODO(jtattermusch): add better way of excluding explicit protobuf dependency. continue requires.add(lib_name) return list(sorted(requires)) def get_pkgconfig_requires_private(lib): """Returns the "Requires.private" list for generating the pkgconfig .pc file for given library.""" private_requires = set() for lib_name in get_transitive_deps(lib): if is_absl_lib(lib_name): # absl deps to into Requires continue require_name = lib_name_to_pkgconfig_requires_private_name(lib_name) if require_name: private_requires.add(require_name) return list(sorted(private_requires)) def get_pkgconfig_libs(lib): """The "Libs" list for generating the pkgconfig .pc file for given library.""" libs = set() # add self libs.add("-l" + lib) return list(sorted(libs)) def get_pkgconfig_libs_private(lib): """The "Libs.private" list for generating the pkgconfig .pc file for given library.""" private_libs = [] for lib_name in get_transitive_deps(lib): if is_absl_lib(lib_name): # absl deps to into Requires continue if is_pkgconfig_package(lib_name): continue # Transitive deps are pre-sorted in topological order. # We must maintain that order to prevent linkage errors. private_libs.append("-l" + lib_name) return private_libs def lib_type_for_lib(lib_name): """Returns STATIC/SHARED to force a static or shared lib build depending on the library.""" # grpc_csharp_ext is loaded by C# runtime and it # only makes sense as a shared lib. if lib_name in ['grpc_csharp_ext']: return ' SHARED' # upb always compiles as a static library on Windows elif lib_name in ['upb','upb_collections_lib','upb_json_lib','upb_textformat_lib'] + protoc_libs: return ' ${_gRPC_STATIC_WIN32}' else: return '' def get_deps(target_dict): # TODO(jtattermusch): remove special cases based on target names deps = [] deps.append("${_gRPC_ALLTARGETS_LIBRARIES}") for d in target_dict.get('deps', []): if d == 'z': deps.append("${_gRPC_ZLIB_LIBRARIES}") elif d == 'address_sorting': deps.append("${_gRPC_ADDRESS_SORTING_LIBRARIES}") elif d == 'benchmark': deps.append("${_gRPC_BENCHMARK_LIBRARIES}") elif d == 'libssl': deps.append("${_gRPC_SSL_LIBRARIES}") elif d == 're2': deps.append("${_gRPC_RE2_LIBRARIES}") elif d == 'cares': deps.append("${_gRPC_CARES_LIBRARIES}") elif d == 'protobuf': deps.append("${_gRPC_PROTOBUF_LIBRARIES}") elif d == 'protoc': deps.append("${_gRPC_PROTOBUF_PROTOC_LIBRARIES}") elif is_absl_lib(d): deps.append(get_absl_dep(d)) # TODO(jtattermusch): add handling for upb libraries else: deps.append(d) return deps def is_generate_cmake_target(lib_or_target): """Returns True if a cmake target should be generated for given library/target.""" # TODO(jtattermusch): extract the metadata to a centralized location. if lib_or_target.build not in ["all", "plugin", "plugin_test", "protoc", "tool", "test", "private"]: return False if lib_or_target.boringssl: # Don't generate target for boringssl libs or tests return False if lib_or_target.name in ['cares', 'benchmark', 're2', 'xxhash', 'z']: # we rely on these target to be created by external cmake builds. return False if is_absl_lib(lib_or_target.name): # we rely on absl targets to be created by an external cmake build. return False return True def get_platforms_condition_begin(platforms): if all(platform in platforms for platform in ['linux', 'mac', 'posix', 'windows']): return '' cond = ' OR '.join(['_gRPC_PLATFORM_%s' % platform.upper() for platform in platforms]) return 'if(%s)' % cond def get_platforms_condition_end(platforms): if not get_platforms_condition_begin(platforms): return '' return 'endif()' def platforms_condition_block(platforms): def _func(text): lines = text.split('\n') cond = get_platforms_condition_begin(platforms) if cond: # Remove empty line following <%block> del lines[0] # Indent each line after for i, line in enumerate(lines[:-1]): if line: lines[i] = ' ' + line # Add the condition block lines.insert(0, cond) # Add endif() to the last line lines[-1] += 'endif()' else: # Remove empty line following <%block> del lines[0] # Strip leading whitespace from first line lines[0] = lines[0].lstrip(' ') # Remove empty line before del lines[-1] return '\n'.join(lines) return _func %> <% # These files are added to a set so that they are not duplicated if multiple # targets use them. Generating the same file multiple times with # add_custom_command() is not allowed in CMake. protobuf_gen_files = set() for tgt in targets: for src in tgt.src: if proto_re.match(src): protobuf_gen_files.add(src) for lib in libs: for src in lib.src: if proto_re.match(src): protobuf_gen_files.add(src) %> cmake_minimum_required(VERSION 3.13) set(PACKAGE_NAME "grpc") set(PACKAGE_VERSION "${settings.cpp_version}") set(gRPC_CORE_VERSION "${settings.core_version}") set(gRPC_CORE_SOVERSION "${settings.core_version.major}") set(gRPC_CPP_VERSION "${settings.cpp_version}") set(gRPC_CPP_SOVERSION "${settings.cpp_version.major}.${settings.cpp_version.minor}") set(PACKAGE_STRING "<%text>${PACKAGE_NAME} ${PACKAGE_VERSION}") set(PACKAGE_TARNAME "<%text>${PACKAGE_NAME}-${PACKAGE_VERSION}") set(PACKAGE_BUGREPORT "https://github.com/grpc/grpc/issues/") project(<%text>${PACKAGE_NAME} LANGUAGES C CXX) if(BUILD_SHARED_LIBS AND MSVC) set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON) endif() set(gRPC_INSTALL_BINDIR "bin" CACHE STRING "Installation directory for executables") set(gRPC_INSTALL_LIBDIR "lib" CACHE STRING "Installation directory for libraries") set(gRPC_INSTALL_INCLUDEDIR "include" CACHE STRING "Installation directory for headers") set(gRPC_INSTALL_CMAKEDIR "lib/cmake/<%text>${PACKAGE_NAME}" CACHE STRING "Installation directory for cmake config files") set(gRPC_INSTALL_SHAREDIR "share/grpc" CACHE STRING "Installation directory for root certificates") set(gRPC_BUILD_MSVC_MP_COUNT 0 CACHE STRING "The maximum number of processes for MSVC /MP option") # Options option(gRPC_BUILD_TESTS "Build tests" OFF) option(gRPC_BUILD_CODEGEN "Build codegen" ON) option(gRPC_DOWNLOAD_ARCHIVES "Download archives for empty 3rd party directories" ON) set(gRPC_INSTALL_default ON) if(NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) # Disable gRPC_INSTALL by default if building as a submodule set(gRPC_INSTALL_default OFF) endif() set(gRPC_INSTALL <%text>${gRPC_INSTALL_default} CACHE BOOL "Generate installation target") # We can install dependencies from submodules if we're running # CMake v3.13 or newer. if(CMAKE_VERSION VERSION_LESS 3.13) set(_gRPC_INSTALL_SUPPORTED_FROM_MODULE OFF) else() set(_gRPC_INSTALL_SUPPORTED_FROM_MODULE ON) endif() # Providers for third-party dependencies (gRPC_*_PROVIDER properties): # "module": build the dependency using sources from git submodule (under third_party) # "package": use cmake's find_package functionality to locate a pre-installed dependency set(gRPC_ZLIB_PROVIDER "module" CACHE STRING "Provider of zlib library") set_property(CACHE gRPC_ZLIB_PROVIDER PROPERTY STRINGS "module" "package") set(gRPC_CARES_PROVIDER "module" CACHE STRING "Provider of c-ares library") set_property(CACHE gRPC_CARES_PROVIDER PROPERTY STRINGS "module" "package") set(gRPC_RE2_PROVIDER "module" CACHE STRING "Provider of re2 library") set_property(CACHE gRPC_RE2_PROVIDER PROPERTY STRINGS "module" "package") set(gRPC_SSL_PROVIDER "module" CACHE STRING "Provider of ssl library") set_property(CACHE gRPC_SSL_PROVIDER PROPERTY STRINGS "module" "package") set(gRPC_PROTOBUF_PROVIDER "module" CACHE STRING "Provider of protobuf library") set_property(CACHE gRPC_PROTOBUF_PROVIDER PROPERTY STRINGS "module" "package") if(gRPC_BUILD_TESTS) set(gRPC_BENCHMARK_PROVIDER "module" CACHE STRING "Provider of benchmark library") set_property(CACHE gRPC_BENCHMARK_PROVIDER PROPERTY STRINGS "module" "package") else() set(gRPC_BENCHMARK_PROVIDER "none") endif() set(gRPC_ABSL_PROVIDER "module" CACHE STRING "Provider of absl library") set_property(CACHE gRPC_ABSL_PROVIDER PROPERTY STRINGS "module" "package") <% # Collect all abseil rules used by gpr, grpc, so on. used_abseil_rules = set() for lib in libs: if lib.get("baselib"): for dep in lib.transitive_deps: if is_absl_lib(dep): used_abseil_rules.add(lib_map[dep].cmake_target.replace("::", "_")) %> set(gRPC_ABSL_USED_TARGETS % for rule in sorted(used_abseil_rules): ${rule} % endfor absl_meta ) # The OpenTelemetry plugin supports "package" build only at present. set(gRPC_OPENTELEMETRY_PROVIDER "package") # set(gRPC_OPENTELEMETRY_PROVIDER "module" CACHE STRING "Provider of opentelemetry library") # set_property(CACHE gRPC_OPENTELEMETRY_PROVIDER PROPERTY STRINGS "module" "package") set(gRPC_USE_PROTO_LITE OFF CACHE BOOL "Use the protobuf-lite library") if(UNIX) if(<%text>${CMAKE_SYSTEM_NAME} MATCHES "Linux") set(_gRPC_PLATFORM_LINUX ON) if(NOT CMAKE_CROSSCOMPILING AND CMAKE_SIZEOF_VOID_P EQUAL 4) message("+++ Enabling SSE2 for <%text>${CMAKE_SYSTEM_PROCESSOR}") set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} -msse2") endif() elseif(<%text>${CMAKE_SYSTEM_NAME} MATCHES "Darwin") set(_gRPC_PLATFORM_MAC ON) elseif(<%text>${CMAKE_SYSTEM_NAME} MATCHES "iOS") set(_gRPC_PLATFORM_IOS ON) elseif(<%text>${CMAKE_SYSTEM_NAME} MATCHES "Android") set(_gRPC_PLATFORM_ANDROID ON) else() set(_gRPC_PLATFORM_POSIX ON) endif() endif() if(WIN32) set(_gRPC_PLATFORM_WINDOWS ON) endif() if (APPLE AND NOT DEFINED CMAKE_CXX_STANDARD) # AppleClang defaults to C++98, so we bump it to C++14. message("CMAKE_CXX_STANDARD was undefined, defaulting to C++14.") set(CMAKE_CXX_STANDARD 14) endif () ## Some libraries are shared even with BUILD_SHARED_LIBRARIES=OFF if (NOT DEFINED CMAKE_POSITION_INDEPENDENT_CODE) set(CMAKE_POSITION_INDEPENDENT_CODE TRUE) endif() list(APPEND CMAKE_MODULE_PATH "<%text>${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules") if(MSVC) include(cmake/msvc_static_runtime.cmake) add_definitions(-D_WIN32_WINNT=0x600 -D_SCL_SECURE_NO_WARNINGS -D_CRT_SECURE_NO_WARNINGS -D_WINSOCK_DEPRECATED_NO_WARNINGS) # Set /MP option if (gRPC_BUILD_MSVC_MP_COUNT GREATER 0) set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /MP${gRPC_BUILD_MSVC_MP_COUNT}") elseif (gRPC_BUILD_MSVC_MP_COUNT LESS 0) set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /MP") endif() # needed to compile protobuf set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /wd4065 /wd4506") # TODO(jtattermusch): revisit warnings that were silenced as part of upgrade to protobuf3.6.0 set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /wd4200 /wd4291 /wd4244") # TODO(jtattermusch): revisit C4267 occurrences throughout the code set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /wd4267") # TODO(jtattermusch): needed to build boringssl with VS2017, revisit later set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /wd4987 /wd4774 /wd4819 /wd4996 /wd4619") # Silences thousands of trucation warnings set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /wd4503") # Tell MSVC to build grpc using utf-8 set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /utf-8") # Inconsistent object sizes can cause stack corruption and should be treated as an error set(_gRPC_C_CXX_FLAGS "<%text>${_gRPC_C_CXX_FLAGS} /we4789") # To decrease the size of PDB files set(CMAKE_EXE_LINKER_FLAGS "/opt:ref /opt:icf /pdbcompress") endif() if (MINGW) add_definitions(-D_WIN32_WINNT=0x600) endif() set(CMAKE_C_FLAGS "<%text>${CMAKE_C_FLAGS} ${_gRPC_C_CXX_FLAGS}") set(CMAKE_CXX_FLAGS "<%text>${CMAKE_CXX_FLAGS} ${_gRPC_C_CXX_FLAGS}") if(gRPC_USE_PROTO_LITE) set(_gRPC_PROTOBUF_LIBRARY_NAME "libprotobuf-lite") add_definitions("-DGRPC_USE_PROTO_LITE") else() set(_gRPC_PROTOBUF_LIBRARY_NAME "libprotobuf") endif() if(_gRPC_PLATFORM_LINUX OR _gRPC_PLATFORM_MAC OR _gRPC_PLATFORM_IOS) set(_gRPC_CORE_NOSTDCXX_FLAGS -fno-exceptions -fno-rtti) else() set(_gRPC_CORE_NOSTDCXX_FLAGS "") endif() if(UNIX AND NOT HAIKU) # -pthread does more than -lpthread set(THREADS_PREFER_PTHREAD_FLAG ON) find_package(Threads) set(_gRPC_ALLTARGETS_LIBRARIES <%text>${CMAKE_DL_LIBS} m Threads::Threads) if(_gRPC_PLATFORM_LINUX OR _gRPC_PLATFORM_POSIX) find_library(LIBRT rt) if(LIBRT) set(_gRPC_ALLTARGETS_LIBRARIES <%text>${_gRPC_ALLTARGETS_LIBRARIES} rt) endif() endif() endif() include(CheckCXXSourceCompiles) if(UNIX OR APPLE) # Some systems require the __STDC_FORMAT_MACROS macro to be defined # to get the fixed-width integer type formatter macros. check_cxx_source_compiles("#include #include int main() { int64_t i64{}; std::printf(\"%\" PRId64, i64); }" HAVE_STDC_FORMAT_MACROS) if(NOT HAVE_STDC_FORMAT_MACROS) add_definitions(-D__STDC_FORMAT_MACROS) endif() endif() # configure ccache if requested include(cmake/ccache.cmake) include(cmake/abseil-cpp.cmake) include(cmake/address_sorting.cmake) include(cmake/benchmark.cmake) include(cmake/cares.cmake) include(cmake/protobuf.cmake) include(cmake/re2.cmake) include(cmake/ssl.cmake) include(cmake/upb.cmake) include(cmake/xxhash.cmake) include(cmake/zlib.cmake) include(cmake/download_archive.cmake) if(_gRPC_PLATFORM_LINUX OR _gRPC_PLATFORM_POSIX) include(cmake/systemd.cmake) set(_gRPC_ALLTARGETS_LIBRARIES <%text>${_gRPC_ALLTARGETS_LIBRARIES} <%text>${_gRPC_SYSTEMD_LIBRARIES}) endif() option(gRPC_BUILD_GRPCPP_OTEL_PLUGIN "Build grpcpp_otel_plugin" OFF) if(gRPC_BUILD_GRPCPP_OTEL_PLUGIN) include(cmake/opentelemetry-cpp.cmake) endif() % for external_proto_library in external_proto_libraries: % if len(external_proto_library.urls) > 1: # Setup external proto library at ${external_proto_library.destination} with ${len(external_proto_library.urls)} download URLs % else: # Setup external proto library at ${external_proto_library.destination} if it doesn't exist % endif % for download_url in external_proto_library.urls: if (NOT EXISTS <%text>${CMAKE_CURRENT_SOURCE_DIR}/${external_proto_library.destination} AND gRPC_DOWNLOAD_ARCHIVES) # Download the archive via HTTP, validate the checksum, and extract to ${external_proto_library.destination}. download_archive( <%text>${CMAKE_CURRENT_SOURCE_DIR}/${external_proto_library.destination} ${download_url} ${external_proto_library.hash} ${external_proto_library.strip_prefix} ) endif() % endfor % endfor if(WIN32) set(_gRPC_ALLTARGETS_LIBRARIES <%text>${_gRPC_ALLTARGETS_LIBRARIES} ws2_32 crypt32) set(_gRPC_STATIC_WIN32 STATIC) endif() if(BUILD_SHARED_LIBS AND WIN32) # Currently for shared lib on Windows (i.e. a DLL) certain bits of source code # are generated from protobuf definitions by upbc. This source code does not include # annotations needed to export these functions from grpc.lib so we have to # re-include a small subset of these. # # This is not an ideal situation because these functions will be unavailable # to clients of grpc and the libraries that need this (e.g. grpc++) will # include redundant duplicate code. Hence, the duplication is only activated # for DLL builds - and should be completely removed when source files are # generated with the necessary __declspec annotations. set(gRPC_UPB_GEN_DUPL_SRC src/core/ext/upb-gen/src/proto/grpc/gcp/altscontext.upb_minitable.c src/core/ext/upb-gen/src/proto/grpc/health/v1/health.upb_minitable.c src/core/ext/upb-gen/src/proto/grpc/gcp/transport_security_common.upb_minitable.c ) set(gRPC_ADDITIONAL_DLL_SRC src/core/lib/security/credentials/tls/grpc_tls_certificate_distributor.cc src/core/lib/security/credentials/tls/grpc_tls_certificate_provider.cc src/core/lib/security/credentials/tls/grpc_tls_certificate_verifier.cc src/core/lib/security/credentials/tls/grpc_tls_credentials_options.cc ) set(gRPC_ADDITIONAL_DLL_CXX_SRC src/cpp/common/tls_certificate_provider.cc src/cpp/common/tls_certificate_verifier.cc src/cpp/common/tls_credentials_options.cc ) endif() # BUILD_SHARED_LIBS AND WIN32 # Create directory for proto source files set(_gRPC_PROTO_SRCS_DIR <%text>${CMAKE_BINARY_DIR}/protos) file(MAKE_DIRECTORY <%text>${_gRPC_PROTO_SRCS_DIR}) # Create directory for generated .proto files set(_gRPC_PROTO_GENS_DIR <%text>${CMAKE_BINARY_DIR}/gens) file(MAKE_DIRECTORY <%text>${_gRPC_PROTO_GENS_DIR}) # protobuf_generate_grpc_cpp # -------------------------- # # This method is no longer used by gRPC's CMake build process. However, it # is used by many open source dependencies, that we might want to keep # backward compatibility here. # # Add custom commands to process ``.proto`` files to C++ using protoc and # GRPC plugin:: # # protobuf_generate_grpc_cpp [...] # # ``ARGN`` # ``.proto`` files # function(protobuf_generate_grpc_cpp) if(NOT ARGN) message(SEND_ERROR "Error: PROTOBUF_GENERATE_GRPC_CPP() called without any proto files") return() endif() foreach(FIL <%text>${ARGN}) protobuf_generate_grpc_cpp_with_import_path_correction(<%text>${FIL} <%text>${FIL}) endforeach() endfunction() # protobuf_generate_grpc_cpp_with_import_path_correction # -------------------------- # # Add custom commands to process ``.proto`` files to C++ using protoc and # GRPC plugin:: # # protobuf_generate_grpc_cpp_with_import_path_correction # # ``FILE_LOCATION`` # The relative path of the ``.proto`` file to the project root # ``IMPORT_PATH`` # The proto import path that itself expected to be placed in. For # example, a "bar.proto" file wants to be imported as # `import "foo/bar.proto"`. Then we should place it under # "/foo/bar.proto" instead of # "/third_party/foo/bar.proto". This ensures # correct symbol being generated and C++ include path being correct. # More info can be found at https://github.com/grpc/grpc/pull/25272. # function(protobuf_generate_grpc_cpp_with_import_path_correction FILE_LOCATION IMPORT_PATH) if(NOT FILE_LOCATION) message(SEND_ERROR "Error: PROTOBUF_GENERATE_GRPC_CPP() called without any proto files") return() endif() # Sets the include path for ProtoBuf files set(_protobuf_include_path -I . -I <%text>${_gRPC_PROTOBUF_WELLKNOWN_INCLUDE_DIR}) # The absolute path of the expected place for the input proto file # For example, health proto has package name grpc.health.v1, it's expected to be: # <%text>${_gRPC_PROTO_SRCS_DIR}/grpc/health/v1/health.proto get_filename_component(ABS_FIL <%text>${_gRPC_PROTO_SRCS_DIR}/${IMPORT_PATH} ABSOLUTE) # Get the name of the file, which used to generate output file names for # this command. # Example: "health" for "health.proto" get_filename_component(FIL_WE <%text>${_gRPC_PROTO_SRCS_DIR}/${IMPORT_PATH} NAME_WE) # Get the relative path between the expected place for the proto and the # working directory. In normal cases, it would be equal IMPORT_PATH, but # it's better to be agnostic to all the global folder locations (like the # centralized location <%text>${_gRPC_PROTO_SRCS_DIR}). # Example: grpc/health/v1/health.proto file(RELATIVE_PATH REL_FIL <%text>${_gRPC_PROTO_SRCS_DIR} <%text>${ABS_FIL}) # Get the directory of the relative path. # Example: grpc/health/v1 get_filename_component(REL_DIR <%text>${REL_FIL} DIRECTORY) # Get the directory and name for output filenames generation. # Example: "grpc/health/v1/health", the file name extension is omitted. set(RELFIL_WE "<%text>${REL_DIR}/${FIL_WE}") # Copy the proto file to a centralized location, with the correct import # path. For example, health proto has package name grpc.health.v1, the bash # equivalent would be: # cp src/proto/grpc/health/v1/health.proto <%text>${_gRPC_PROTO_SRCS_DIR}/grpc/health/v1 file(MAKE_DIRECTORY <%text>${_gRPC_PROTO_SRCS_DIR}/${REL_DIR}) file(COPY <%text>${CMAKE_CURRENT_SOURCE_DIR}/${FILE_LOCATION} DESTINATION <%text>${_gRPC_PROTO_SRCS_DIR}/${REL_DIR}) #if cross-compiling, find host plugin if(CMAKE_CROSSCOMPILING) find_program(_gRPC_CPP_PLUGIN grpc_cpp_plugin) else() set(_gRPC_CPP_PLUGIN $) endif() add_custom_command( OUTPUT <%text>"${_gRPC_PROTO_GENS_DIR}/${RELFIL_WE}.grpc.pb.cc" <%text>"${_gRPC_PROTO_GENS_DIR}/${RELFIL_WE}.grpc.pb.h" <%text>"${_gRPC_PROTO_GENS_DIR}/${RELFIL_WE}_mock.grpc.pb.h" <%text>"${_gRPC_PROTO_GENS_DIR}/${RELFIL_WE}.pb.cc" <%text>"${_gRPC_PROTO_GENS_DIR}/${RELFIL_WE}.pb.h" COMMAND <%text>${_gRPC_PROTOBUF_PROTOC_EXECUTABLE} ARGS --grpc_out=<%text>generate_mock_code=true:${_gRPC_PROTO_GENS_DIR} --cpp_out=<%text>${_gRPC_PROTO_GENS_DIR} --plugin=protoc-gen-grpc=<%text>${_gRPC_CPP_PLUGIN} <%text>${_protobuf_include_path} <%text>${REL_FIL} DEPENDS <%text>${CMAKE_CURRENT_SOURCE_DIR}/${FILE_LOCATION} <%text>${ABS_FIL} <%text>${_gRPC_PROTOBUF_PROTOC} <%text>${_gRPC_CPP_PLUGIN} WORKING_DIRECTORY <%text>${_gRPC_PROTO_SRCS_DIR} COMMENT "Running gRPC C++ protocol buffer compiler for <%text>${IMPORT_PATH}" VERBATIM) endfunction() # These options allow users to enable or disable the building of the various # protoc plugins. For example, running CMake with # -DgRPC_BUILD_GRPC_CSHARP_PLUGIN=OFF will disable building the C# plugin. set(_gRPC_PLUGIN_LIST) % for tgt in targets: % if tgt.build == 'protoc': option(gRPC_BUILD_${tgt.name.upper()} "Build ${tgt.name}" ON) if (gRPC_BUILD_${tgt.name.upper()}) list(APPEND _gRPC_PLUGIN_LIST ${tgt.name}) endif () % endif % endfor add_custom_target(plugins DEPENDS <%text>${_gRPC_PLUGIN_LIST} ) add_custom_target(tools_c DEPENDS % for tgt in targets: % if tgt.build == 'tool' and not tgt.language == 'c++': ${tgt.name} % endif % endfor ) add_custom_target(tools_cxx DEPENDS % for tgt in targets: % if tgt.build == 'tool' and tgt.language == 'c++': ${tgt.name} % endif % endfor ) add_custom_target(tools DEPENDS tools_c tools_cxx) % for src in sorted(protobuf_gen_files): protobuf_generate_grpc_cpp_with_import_path_correction( ${src} ${third_party_proto_import_path(src)} ) % endfor if(gRPC_BUILD_TESTS) add_custom_target(buildtests_c) % for tgt in targets: % if is_generate_cmake_target(tgt) and tgt.build == 'test' and not tgt.language == 'c++': <%block filter='platforms_condition_block(tgt.platforms)'> add_dependencies(buildtests_c ${tgt.name}) % endif % endfor add_custom_target(buildtests_cxx) % for tgt in targets: % if is_generate_cmake_target(tgt) and tgt.build == 'test' and tgt.language == 'c++': <%block filter='platforms_condition_block(tgt.platforms)'> add_dependencies(buildtests_cxx ${tgt.name}) % endif % endfor add_custom_target(buildtests DEPENDS buildtests_c buildtests_cxx) endif() <% cmake_libs = [] for lib in libs: if not is_generate_cmake_target(lib): continue cmake_libs.append(lib) %> % for lib in cmake_libs: % if lib.build in ["test", "private"]: if(gRPC_BUILD_TESTS) ${cc_library(lib)} endif() % else: % if lib.build in ["plugin"]: if(gRPC_BUILD_${lib.name.upper()}) % endif ${cc_library(lib)} % if not lib.build in ["tool"]: % if any(proto_re.match(src) for src in lib.src): if(gRPC_BUILD_CODEGEN) % endif ${cc_install(lib)} % if any(proto_re.match(src) for src in lib.src): endif() % endif % endif % if lib.build in ["plugin"]: endif() % endif % endif % endfor % for tgt in targets: % if is_generate_cmake_target(tgt): % if tgt.build in ["test", "private"]: if(gRPC_BUILD_TESTS) <%block filter='platforms_condition_block(tgt.platforms)'> ${cc_binary(tgt)} endif() % elif tgt.build in ["plugin_test"]: if(gRPC_BUILD_TESTS AND ${tgt.plugin_option}) <%block filter='platforms_condition_block(tgt.platforms)'> ${cc_binary(tgt)} endif() % elif tgt.build in ["protoc"]: if(gRPC_BUILD_CODEGEN AND gRPC_BUILD_${tgt.name.upper()}) <%block filter='platforms_condition_block(tgt.platforms)'> ${cc_binary(tgt)} ${cc_install(tgt)} endif() % else: <%block filter='platforms_condition_block(tgt.platforms)'> ${cc_binary(tgt)} % if not tgt.build in ["tool"]: ${cc_install(tgt)} % endif % endif % endif % endfor <%def name="cc_library(lib)"> % if any(proto_re.match(src) for src in lib.src): % if lib.name == 'grpcpp_channelz': # TODO(jtattermusch): remove special case based on target name # grpcpp_channelz doesn't build with protobuf-lite # See https://github.com/grpc/grpc/issues/19473 if(gRPC_BUILD_CODEGEN AND NOT gRPC_USE_PROTO_LITE) % else: if(gRPC_BUILD_CODEGEN) % endif % endif add_library(${lib.name}${lib_type_for_lib(lib.name)} % for src in lib.src: % if not proto_re.match(src): ${src} % else: ${proto_replace_ext(src, '.pb.cc')} ${proto_replace_ext(src, '.grpc.pb.cc')} ${proto_replace_ext(src, '.pb.h')} ${proto_replace_ext(src, '.grpc.pb.h')} % if src in ["src/proto/grpc/testing/compiler_test.proto", "src/proto/grpc/testing/echo.proto"]: ${proto_replace_ext(src, '_mock.grpc.pb.h')} % endif % endif % endfor % if lib.name in ['grpc++_alts', 'grpc++_unsecure', 'grpc++']: <%text>${gRPC_UPB_GEN_DUPL_SRC} % endif % if lib.name in ['grpc_unsecure']: <%text>${gRPC_ADDITIONAL_DLL_SRC} % endif % if lib.name in ['grpc++_unsecure']: <%text>${gRPC_ADDITIONAL_DLL_CXX_SRC} % endif ) target_compile_features(${lib.name} PUBLIC cxx_std_14) set_target_properties(${lib.name} PROPERTIES % if lib.language == 'c++': VERSION <%text>${gRPC_CPP_VERSION} SOVERSION <%text>${gRPC_CPP_SOVERSION} % else: VERSION <%text>${gRPC_CORE_VERSION} SOVERSION <%text>${gRPC_CORE_SOVERSION} % endif ) if(WIN32 AND MSVC) set_target_properties(${lib.name} PROPERTIES COMPILE_PDB_NAME "${lib.name}" COMPILE_PDB_OUTPUT_DIRECTORY <%text>"${CMAKE_BINARY_DIR}" )<% dll_annotations = [] if lib.name in gpr_libs: dll_annotations.append("GPR_DLL_EXPORTS") if lib.name in grpc_libs: dll_annotations.append("GRPC_DLL_EXPORTS") if lib.name in grpcxx_libs: dll_annotations.append("GRPCXX_DLL_EXPORTS") if set(gpr_libs) & set(lib.transitive_deps): dll_annotations.append("GPR_DLL_IMPORTS") if set(grpc_libs) & set(lib.transitive_deps): dll_annotations.append("GRPC_DLL_IMPORTS") if set(grpcxx_libs) & set(lib.transitive_deps): dll_annotations.append("GRPCXX_DLL_IMPORTS") %> % if dll_annotations: if(BUILD_SHARED_LIBS) target_compile_definitions(${lib.name} PRIVATE % for definition in dll_annotations: "${definition}" % endfor ) endif() % endif if(gRPC_INSTALL) install(FILES <%text>${CMAKE_CURRENT_BINARY_DIR}/${lib.name}.pdb DESTINATION <%text>${gRPC_INSTALL_LIBDIR} OPTIONAL ) endif() endif() target_include_directories(${lib.name} PUBLIC <%text>$ $ PRIVATE <%text>${CMAKE_CURRENT_SOURCE_DIR} <%text>${_gRPC_ADDRESS_SORTING_INCLUDE_DIR} <%text>${_gRPC_RE2_INCLUDE_DIR} <%text>${_gRPC_SSL_INCLUDE_DIR} <%text>${_gRPC_UPB_GENERATED_DIR} <%text>${_gRPC_UPB_GRPC_GENERATED_DIR} <%text>${_gRPC_UPB_INCLUDE_DIR} <%text>${_gRPC_XXHASH_INCLUDE_DIR} <%text>${_gRPC_ZLIB_INCLUDE_DIR} % if 'gtest' in lib.transitive_deps or lib.name == 'gtest': # TODO(jtattermusch): avoid special case based on target name third_party/googletest/googletest/include third_party/googletest/googletest third_party/googletest/googlemock/include third_party/googletest/googlemock % endif % if lib.language == 'c++': <%text>${_gRPC_PROTO_GENS_DIR} % endif ) % if len(get_deps(lib)) > 0: target_link_libraries(${lib.name} % for dep in get_deps(lib): ${dep} % endfor ) % endif % if lib.name in ["gpr"]: # TODO(jtattermusch): avoid special case based on target name if(_gRPC_PLATFORM_ANDROID) target_link_libraries(gpr android log ) endif() % endif % if lib.name in ["grpc", "grpc_cronet", "grpc_test_util", \ "grpc_test_util_unsecure", "grpc_unsecure", \ "grpc++_cronet"]: # TODO(jtattermusch): remove special cases based on target names if(_gRPC_PLATFORM_IOS OR _gRPC_PLATFORM_MAC) target_link_libraries(${lib.name} "-framework CoreFoundation") endif() %endif % if len(lib.get('public_headers', [])) > 0: foreach(_hdr % for hdr in lib.get('public_headers', []): ${hdr} % endfor ) string(REPLACE "include/" "" _path <%text>${_hdr}) get_filename_component(_path <%text>${_path} PATH) install(FILES <%text>${_hdr} DESTINATION "<%text>${gRPC_INSTALL_INCLUDEDIR}/${_path}" ) endforeach() % endif % if any(proto_re.match(src) for src in lib.src): endif() % endif <%def name="cc_binary(tgt)"> add_executable(${tgt.name} % for src in tgt.src: % if not proto_re.match(src): ${src} % else: ${proto_replace_ext(src, '.pb.cc')} ${proto_replace_ext(src, '.grpc.pb.cc')} ${proto_replace_ext(src, '.pb.h')} ${proto_replace_ext(src, '.grpc.pb.h')} % endif % endfor )<% dll_annotations = [] if set(gpr_libs) & set(tgt.transitive_deps): dll_annotations.append("GPR_DLL_IMPORTS") if set(grpc_libs) & set(tgt.transitive_deps): dll_annotations.append("GRPC_DLL_IMPORTS") if set(grpcxx_libs) & set(tgt.transitive_deps): dll_annotations.append("GRPCXX_DLL_IMPORTS") %> % if dll_annotations: if(WIN32 AND MSVC) if(BUILD_SHARED_LIBS) target_compile_definitions(${tgt.name} PRIVATE % for definition in dll_annotations: "${definition}" % endfor ) endif() endif() % endif target_compile_features(${tgt.name} PUBLIC cxx_std_14) target_include_directories(${tgt.name} PRIVATE <%text>${CMAKE_CURRENT_SOURCE_DIR} <%text>${CMAKE_CURRENT_SOURCE_DIR}/include <%text>${_gRPC_ADDRESS_SORTING_INCLUDE_DIR} <%text>${_gRPC_RE2_INCLUDE_DIR} <%text>${_gRPC_SSL_INCLUDE_DIR} <%text>${_gRPC_UPB_GENERATED_DIR} <%text>${_gRPC_UPB_GRPC_GENERATED_DIR} <%text>${_gRPC_UPB_INCLUDE_DIR} <%text>${_gRPC_XXHASH_INCLUDE_DIR} <%text>${_gRPC_ZLIB_INCLUDE_DIR} % if 'gtest' in tgt.transitive_deps: third_party/googletest/googletest/include third_party/googletest/googletest third_party/googletest/googlemock/include third_party/googletest/googlemock % endif % if tgt.language == 'c++': <%text>${_gRPC_PROTO_GENS_DIR} % endif ) % if len(get_deps(tgt)) > 0: target_link_libraries(${tgt.name} % for dep in get_deps(tgt): ${dep} % endfor ) % endif <%def name="cc_install(tgt)"> % if tgt.name == 'grpcpp_channelz': # grpcpp_channelz doesn't build with protobuf-lite, so no install required # See https://github.com/grpc/grpc/issues/22826 if(gRPC_INSTALL AND NOT gRPC_USE_PROTO_LITE) % else: if(gRPC_INSTALL) % endif % if tgt.build == 'protoc' and 'grpc_plugin_support' in tgt.get('deps', []): install(TARGETS ${tgt.name} EXPORT gRPCPluginTargets % else: install(TARGETS ${tgt.name} EXPORT gRPCTargets % endif RUNTIME DESTINATION <%text>${gRPC_INSTALL_BINDIR} BUNDLE DESTINATION <%text>${gRPC_INSTALL_BINDIR} LIBRARY DESTINATION <%text>${gRPC_INSTALL_LIBDIR} ARCHIVE DESTINATION <%text>${gRPC_INSTALL_LIBDIR} ) endif() if(gRPC_INSTALL) install(EXPORT gRPCTargets DESTINATION <%text>${gRPC_INSTALL_CMAKEDIR} NAMESPACE gRPC:: ) if(gRPC_BUILD_CODEGEN) install(EXPORT gRPCPluginTargets DESTINATION <%text>${gRPC_INSTALL_CMAKEDIR} NAMESPACE gRPC:: ) endif() endif() include(CMakePackageConfigHelpers) configure_file(cmake/gRPCConfig.cmake.in gRPCConfig.cmake @ONLY) write_basic_package_version_file(<%text>${CMAKE_CURRENT_BINARY_DIR}/gRPCConfigVersion.cmake VERSION <%text>${gRPC_CPP_VERSION} COMPATIBILITY AnyNewerVersion) install(FILES <%text>${CMAKE_CURRENT_BINARY_DIR}/gRPCConfig.cmake <%text>${CMAKE_CURRENT_BINARY_DIR}/gRPCConfigVersion.cmake DESTINATION <%text>${gRPC_INSTALL_CMAKEDIR} ) install(FILES <%text>${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules/Findc-ares.cmake <%text>${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules/Findre2.cmake <%text>${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules/Findsystemd.cmake DESTINATION <%text>${gRPC_INSTALL_CMAKEDIR}/modules ) install(FILES <%text>${CMAKE_CURRENT_SOURCE_DIR}/etc/roots.pem DESTINATION <%text>${gRPC_INSTALL_SHAREDIR}) # Function to generate pkg-config files. function(generate_pkgconfig name description version requires requires_private libs libs_private output_filename) set(PC_NAME "<%text>${name}") set(PC_DESCRIPTION "<%text>${description}") set(PC_VERSION "<%text>${version}") set(PC_REQUIRES "<%text>${requires}") set(PC_REQUIRES_PRIVATE "<%text>${requires_private}") set(PC_LIB "<%text>${libs}") set(PC_LIBS_PRIVATE "<%text>${libs_private}") set(output_filepath "<%text>${grpc_BINARY_DIR}/libs/opt/pkgconfig/${output_filename}") configure_file( "<%text>${grpc_SOURCE_DIR}/cmake/pkg-config-template.pc.in" "<%text>${output_filepath}" @ONLY) install(FILES "<%text>${output_filepath}" DESTINATION "<%text>${gRPC_INSTALL_LIBDIR}/pkgconfig") endfunction() # gpr .pc file generate_pkgconfig( "gpr" "gRPC platform support library" "<%text>${gRPC_CORE_VERSION}" "${" ".join(get_pkgconfig_requires("gpr"))}" "${" ".join(get_pkgconfig_requires_private("gpr"))}" "${" ".join(get_pkgconfig_libs("gpr"))}" "${" ".join(get_pkgconfig_libs_private("gpr"))}" "gpr.pc") # grpc .pc file generate_pkgconfig( "gRPC" "high performance general RPC framework" "<%text>${gRPC_CORE_VERSION}" "${" ".join(get_pkgconfig_requires("grpc"))}" "${" ".join(get_pkgconfig_requires_private("grpc"))}" "${" ".join(get_pkgconfig_libs("grpc"))}" "${" ".join(get_pkgconfig_libs_private("grpc"))}" "grpc.pc") # grpc_unsecure .pc file generate_pkgconfig( "gRPC unsecure" "high performance general RPC framework without SSL" "<%text>${gRPC_CORE_VERSION}" "${" ".join(get_pkgconfig_requires("grpc_unsecure"))}" "${" ".join(get_pkgconfig_requires_private("grpc_unsecure"))}" "${" ".join(get_pkgconfig_libs("grpc_unsecure"))}" "${" ".join(get_pkgconfig_libs_private("grpc_unsecure"))}" "grpc_unsecure.pc") # grpc++ .pc file generate_pkgconfig( "gRPC++" "C++ wrapper for gRPC" "<%text>${gRPC_CPP_VERSION}" "${" ".join(get_pkgconfig_requires("grpc++"))}" "${" ".join(get_pkgconfig_requires_private("grpc++"))}" "${" ".join(get_pkgconfig_libs("grpc++"))}" "${" ".join(get_pkgconfig_libs_private("grpc++"))}" "grpc++.pc") # grpc++_unsecure .pc file generate_pkgconfig( "gRPC++ unsecure" "C++ wrapper for gRPC without SSL" "<%text>${gRPC_CPP_VERSION}" "${" ".join(get_pkgconfig_requires("grpc++_unsecure"))}" "${" ".join(get_pkgconfig_requires_private("grpc++_unsecure"))}" "${" ".join(get_pkgconfig_libs("grpc++_unsecure"))}" "${" ".join(get_pkgconfig_libs_private("grpc++_unsecure"))}" "grpc++_unsecure.pc")