[clangd] Fix remote index build without shared libs mode

[kbobyrev]

Summary

Generated Protobuf library has to be in CLANG_EXPORTS and should also be
installed appropriately. The easiest way to do that is via CMake's
add_clang_library. That unfortunately applies "one directory - one
clang_(library|tool)" policy so .proto files should be in a separate directory
and complicates the layout.

This setup works both in shared and static libs mode.

Resolves: https://github.com/clangd/clangd/issues/351

[kbobyrev]

Slightly adjust the CMake scripts.

[kbobyrev]

Don't create a separate directory for proto files.

[sammccall]

clang-tools-extra/clangd/index/remote/CMakeLists.txt

21

would be nice to avoid specifying this here if it's not needed

clang-tools-extra/clangd/index/remote/server/CMakeLists.txt

8

why this removal?

llvm/cmake/modules/AddLLVM.cmake

412 ↗

(On Diff #260606)

why do you need to parse this and then explicitly pass it through, rather than just letting it fall into ARG_UNPARSED_ARGUMENTS?

llvm/cmake/modules/LLVMProcessSources.cmake

60 ↗

(On Diff #260606)

This name could be better, I think.

What about PARTIAL_SOURCES_INTENDED?

[kbobyrev]

Address review comments.

clang-tools-extra/clangd/index/remote/server/CMakeLists.txt

8

Discussed in the chat.

[sammccall]

clang-tools-extra/clangd/index/remote/server/CMakeLists.txt

8

For the record: redundant with parent package (this is a cleanup-while-here)

clang-tools-extra/clangd/index/remote/CMakeLists.txt

 if (CLANGD_ENABLE_REMOTE)
-  generate_grpc_protos(RemoteIndexProtos "Index.proto")
-  include_directories(${CMAKE_CURRENT_BINARY_DIR})
+  include_directories(${CMAKE_CURRENT_BINARY_DIR}/protos)
   include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../../)
 
   # FIXME(kirillbobyrev): target_compile_definitions is not working with
   # add_clang_library for some reason. Is there any way to make this
   # target-local?
   add_definitions(-DGOOGLE_PROTOBUF_NO_RTTI=1)
 
   add_clang_library(clangdRemoteIndex
     Client.cpp
 
     LINK_LIBS
     RemoteIndexProtos
     clangdRemoteMarshalling
 
     protobuf
     grpc++
     clangDaemon
     )
 
+  add_subdirectory(protos)
   add_subdirectory(marshalling)
   add_subdirectory(server)
 else()
   # Provides a dummy implementation of clangdRemoteIndex.
   add_subdirectory(unimplemented)
 endif()

clang-tools-extra/clangd/index/remote/protos/CMakeLists.txt

+generate_grpc_protos(RemoteIndexProtos "Index.proto")

clang-tools-extra/clangd/index/remote/protos/Index.proto

 //===--- Index.proto - Remote index Protocol Buffers definition -----------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 syntax = "proto3";
 
 package clang.clangd.remote;
 
 service SymbolIndex {
   rpc Lookup(LookupRequest) returns (stream LookupReply) {}
 
   rpc FuzzyFind(FuzzyFindRequest) returns (stream FuzzyFindReply) {}
 
   rpc Refs(RefsRequest) returns (stream RefsReply) {}
 }
 
 message LookupRequest { repeated string ids = 1; }
 
 // The response is a stream of symbol messages and the terminating message
 // indicating the end of stream.
 message LookupReply {
   oneof kind {
     Symbol stream_result = 1;
     bool final_result = 2;
   }
 }
 
 message FuzzyFindRequest {
   string query = 1;
   repeated string scopes = 2;
   bool any_scope = 3;
   uint32 limit = 4;
   bool resricted_for_code_completion = 5;
   repeated string proximity_paths = 6;
   repeated string preferred_types = 7;
 }
 
 // The response is a stream of symbol messages, and one terminating has_more
 // message.
 message FuzzyFindReply {
   oneof kind {
     Symbol stream_result = 1;
     bool final_result = 2; // HasMore
   }
 }
 
 message RefsRequest {
   repeated string ids = 1;
   uint32 filter = 2;
   uint32 limit = 3;
 }
 
 // The response is a stream of reference messages, and one terminating has_more
 // message.
 message RefsReply {
   oneof kind {
     Ref stream_result = 1;
     bool final_result = 2; // HasMore
   }
 }
 
 // FIXME(kirillbobyrev): Properly serialize symbols and refs instead of passing
 // YAML.
 message Ref { string yaml_serialization = 1; }
 message Symbol { string yaml_serialization = 1; }

clang-tools-extra/clangd/index/remote/server/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   LineEditor
   Support
   )
 add_clang_executable(clangd-index-server
   Server.cpp
   )
-target_compile_definitions(clangd-index-server PRIVATE -D GOOGLE_PROTOBUF_NO_RTTI=1)
-clang_target_link_libraries(clangd-index-server
-  PRIVATE
-  clangDaemon
-  )
 target_link_libraries(clangd-index-server
   PRIVATE
-  RemoteIndexProtos
+  clangDaemon
 
+  RemoteIndexProtos
   clangdRemoteMarshalling
+
+  grpc++
   )

llvm/cmake/modules/FindGRPC.cmake

add_custom_command(
         COMMAND ${PROTOC}
         ARGS --grpc_out="${CMAKE_CURRENT_BINARY_DIR}"
           --cpp_out="${CMAKE_CURRENT_BINARY_DIR}"
           --proto_path="${ProtoSourcePath}"
           --plugin=protoc-gen-grpc="${GRPC_CPP_PLUGIN}"
           "${ProtoSourceAbsolutePath}"
           DEPENDS "${ProtoSourceAbsolutePath}")
 
-  add_library(${LibraryName} ${GeneratedProtoSource} ${GeneratedGRPCSource})
-  target_link_libraries(${LibraryName} grpc++ protobuf)
+  add_clang_library(${LibraryName} ${GeneratedProtoSource} ${GeneratedGRPCSource}
+    LINK_LIBS grpc++ protobuf)
 endfunction()