Add an option to fill container for ref

[usaxena95]

Summary

This allows index implementations to fill container details when required specially when computing containerID is expensive.

[kadircet]

Can you also update the remote-index protos & marshalling logic in:

• clang-tools-extra/clangd/index/remote/Index.proto
• clang-tools-extra/clangd/index/remote/marshalling/Marshalling.cpp

clang-tools-extra/clangd/index/Index.h

75

let's drop the SymbolID for also mention Index implementations may chose to populate containers no matter what.

76

can you default this to false?

[usaxena95]

Addressed comments.

[kadircet]

thanks, lgtm!

clang-tools-extra/clangd/XRefs.cpp

incomingCalls(const CallHierarchyItem &Item, const SymbolIndex *Index) {
   // In this function, we find incoming calls based on the index only.
   // In principle, the AST could have more up-to-date information about
   // occurrences within the current file. However, going from a SymbolID
   // to an AST node isn't cheap, particularly when the declaration isn't
   // in the main file.
   // FIXME: Consider also using AST information when feasible.
   RefsRequest Request;
   Request.IDs.insert(*ID);
+  Request.WantContainer = true;
   // We could restrict more specifically to calls by introducing a new RefKind,
   // but non-call references (such as address-of-function) can still be
   // interesting as they can indicate indirect calls.
   Request.Filter = RefKind::Reference;
   // Initially store the ranges in a map keyed by SymbolID of the caller.
   // This allows us to group different calls with the same caller
   // into the same CallHierarchyIncomingCall.
   llvm::DenseMap<SymbolID, std::vector<Range>> CallsIn;

clang-tools-extra/clangd/index/Index.h

 
 struct RefsRequest {
   llvm::DenseSet<SymbolID> IDs;
   RefKind Filter = RefKind::All;
   /// If set, limit the number of refers returned from the index. The index may
   /// choose to return less than this, e.g. it tries to avoid returning stale
   /// results.
   llvm::Optional<uint32_t> Limit;
+  /// If set, populates the container of the reference.
+  /// Index implementations may chose to populate containers no matter what.
+  bool WantContainer = false;
 };
 
 struct RelationsRequest {
   llvm::DenseSet<SymbolID> Subjects;
   RelationKind Predicate;
   /// If set, limit the number of relations returned from the index.
   llvm::Optional<uint32_t> Limit;
 };

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

oneof kind {
     FinalResult final_result = 2;
   }
 }
 
 message RefsRequest {
   repeated string ids = 1;
   optional uint32 filter = 2;
   optional uint32 limit = 3;
+  optional bool want_container = 4;
 }
 
 // The response is a stream of reference messages, and one terminating has_more
 // message.
 message RefsReply {
   oneof kind {
     Ref stream_result = 1;
     FinalResult final_result = 2;

clang-tools-extra/clangd/index/remote/marshalling/Marshalling.cpp

if (!IDs)
     return IDs.takeError();
   Req.IDs = std::move(*IDs);
   if (Message->has_filter())
     Req.Filter = static_cast<clangd::RefKind>(Message->filter());
   else
     Req.Filter = clangd::RefKind::All;
   if (Message->limit())
     Req.Limit = Message->limit();
+  Req.WantContainer = Message->want_container();
   return Req;
 }
 
 llvm::Expected<clangd::RelationsRequest>
 Marshaller::fromProtobuf(const RelationsRequest *Message) {
   clangd::RelationsRequest Req;
   auto IDs = getIDs(Message->subjects());
   if (!IDs)

 
 RefsRequest Marshaller::toProtobuf(const clangd::RefsRequest &From) {
   RefsRequest RPCRequest;
   for (const auto &ID : From.IDs)
     RPCRequest.add_ids(ID.str());
   RPCRequest.set_filter(static_cast<uint32_t>(From.Filter));
   if (From.Limit)
     RPCRequest.set_limit(*From.Limit);
+  RPCRequest.set_want_container(From.WantContainer);
   return RPCRequest;
 }
 
 RelationsRequest Marshaller::toProtobuf(const clangd::RelationsRequest &From) {
   RelationsRequest RPCRequest;
   for (const auto &ID : From.Subjects)
     RPCRequest.add_subjects(ID.str());
   RPCRequest.set_predicate(static_cast<uint32_t>(From.Predicate));