[clangd] Log feature configuration (linux+asan+grpc) of the clangd build

[sammccall]

Summary

Included in logs, --version, remote index queries, and LSP serverInfo.

[kadircet]

thanks, lgtm!

clang-tools-extra/clangd/Features.cpp

20

nit: drop parens ?

clang-tools-extra/clangd/Features.h

15

should we also put a IWYU pragma in Features.inc.in such as // IWYU pragma: private, include "Features.h" ? (clangd has special handling for .inc headers, but other tools might not have a code-base-wide view).

clang-tools-extra/clangd/tool/ClangdMain.cpp

681–682

please fix

[thakis]

(fyi: this broke mac builds. i fixed that in b56e5f8a10c1ec4fd3750bdd269fbad778820326)

[sammccall]

Doh, thank you Nico!

[thakis]

Hm, my fix doesn't work either :/ https://logs.chromium.org/logs/chromium/buildbucket/cr-buildbucket.appspot.com/8842935257512920928/+/u/package_clang/stdout?format=raw

-c /opt/s/w/ir/cache/builder/src/third_party/llvm/clang-tools-extra/clangd/xpc/XPCTransport.cpp
 In file included from /opt/s/w/ir/cache/builder/src/third_party/llvm/clang-tools-extra/clangd/xpc/XPCTransport.cpp:10:
 In file included from /opt/s/w/ir/cache/builder/src/third_party/llvm/clang-tools-extra/clangd/xpc/../Transport.h:21:
 /opt/s/w/ir/cache/builder/src/third_party/llvm/clang-tools-extra/clangd/xpc/../Features.h:14:10: fatal error: 'Features.inc' file not found
 #include "Features.inc"
          ^~~~~~~~~~~~~~
 1 error generated.

I guess now clangd/xpc needs an explicit dep on that .inc generating rule.

[thakis]

Tried again in 2f79acb7b701c41494abff588b5f03a74ea2e11d. If someone wants to figure out how to make xpc see Features.inc in the cmake build, that'd work too.

[sammccall]

In D100553#2852981, @thakis wrote:

I guess now clangd/xpc needs an explicit dep on that .inc generating rule.

I think it's rather missing -I for the generated clangd directory.
(The targets in clangd/xpc depend on clangDaemon which requires that generated header - not wonderfully explicit but also seems to be the way this is usually done at least in CMake)

Tried again in 2f79acb7b701c41494abff588b5f03a74ea2e11d. If someone wants to figure out how to make xpc see Features.inc in the cmake build, that'd work too.

Sorry, there was a near-identical break in index/remote/ and I didn't spot the xpc variant.
The idea is that all files under clang-tools-extra/clangd/ should have clangd/ on the include path (both normal and generated files).

Landed a few patches trying to improve this:

• 86c5afa6e601c4a80d46a7a8b892d5c49bcec078 is the missing include from your log
• 0c53f602d5a9d7207abb13e463f68e9d092f47a7 is a few more cases i found
• then 26e1553a107f52667be879e99739a4153f8799d8 just adds the include dirs at the top level (where it's not needed!) since cmake seems to inherit this property to subdirectories

Not sure if these changes are things the gn bot is usually able to sync automatically, but at least CMake should be good and less fragile now, and check-clangd is still passing on the gn bots. I think 2f79acb7b701c41494abff588b5f03a74ea2e11d is now unneccesary (at least for cmake) and may try to revert it, but probably rather on monday than break more things today...

clang-tools-extra/clangd/CMakeLists.txt

add_clang_library(clangDaemon
   ConfigCompile.cpp
   ConfigProvider.cpp
   ConfigYAML.cpp
   Diagnostics.cpp
   DraftStore.cpp
   DumpAST.cpp
   ExpectedTypes.cpp
   FeatureModule.cpp
+  Features.cpp
   FindSymbols.cpp
   FindTarget.cpp
   FileDistance.cpp
   Format.cpp
   FS.cpp
   FuzzyMatch.cpp
   GlobalCompilationDatabase.cpp
   Headers.cpp

clang-tools-extra/clangd/ClangdLSPServer.h

 //===--- ClangdLSPServer.h - LSP server --------------------------*- C++-*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_CLANGDLSPSERVER_H
 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_CLANGDLSPSERVER_H
 
 #include "ClangdServer.h"
 #include "DraftStore.h"
-#include "Features.inc"
 #include "FindSymbols.h"
 #include "GlobalCompilationDatabase.h"
 #include "LSPBinder.h"
 #include "Protocol.h"
 #include "Transport.h"
 #include "support/Context.h"
 #include "support/MemoryTree.h"
 #include "support/Path.h"

clang-tools-extra/clangd/ClangdLSPServer.cpp

 //===--- ClangdLSPServer.cpp - LSP server ------------------------*- C++-*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #include "ClangdLSPServer.h"
 #include "ClangdServer.h"
 #include "CodeComplete.h"
 #include "Diagnostics.h"
 #include "DraftStore.h"
 #include "DumpAST.h"
+#include "Features.h"
 #include "GlobalCompilationDatabase.h"
 #include "LSPBinder.h"
 #include "Protocol.h"
 #include "SemanticHighlighting.h"
 #include "SourceCode.h"
 #include "TUScheduler.h"
 #include "URI.h"
 #include "refactor/Tweak.h"
 #include "support/Context.h"
 #include "support/MemoryTree.h"
 #include "support/Trace.h"
 #include "clang/AST/ASTContext.h"
-#include "clang/Basic/Version.h"
 #include "clang/Tooling/Core/Replacement.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/ScopeExit.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/iterator_range.h"
 #include "llvm/Support/Allocator.h"
 #include "llvm/Support/Errc.h"
for (llvm::StringRef Command : Handlers.CommandHandlers.keys())
     Commands.push_back(Command);
   llvm::sort(Commands);
   ServerCaps["executeCommandProvider"] =
       llvm::json::Object{{"commands", Commands}};
 
   llvm::json::Object Result{
       {{"serverInfo",
         llvm::json::Object{{"name", "clangd"},
-                           {"version", getClangToolFullVersion("clangd")}}},
+                           {"version", llvm::formatv("{0} {1}", versionString(),
+                                                     featureString())}}},
        {"capabilities", std::move(ServerCaps)}}};
   if (Opts.Encoding)
     Result["offsetEncoding"] = *Opts.Encoding;
   Reply(std::move(Result));
 }
 
 void ClangdLSPServer::onInitialized(const InitializedParams &Params) {}
 

clang-tools-extra/clangd/ConfigCompile.cpp

 //
 //===----------------------------------------------------------------------===//
 
 #include "CompileCommands.h"
 #include "Config.h"
 #include "ConfigFragment.h"
 #include "ConfigProvider.h"
 #include "Diagnostics.h"
-#include "Features.inc"
+#include "Features.h"
 #include "TidyProvider.h"
 #include "support/Logger.h"
 #include "support/Path.h"
 #include "support/Trace.h"
 #include "llvm/ADT/None.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/SmallString.h"

clang-tools-extra/clangd/Features.h

+//===--- Features.h - Compile-time configuration ------------------*-C++-*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_FEATURES_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_FEATURES_H
+#include <string>
+
+// Export constants like CLANGD_BUILD_XPC
+#include "Features.inc"
+
+namespace clang {
+namespace clangd {
+
+// Returns a version string for clangd, e.g. "clangd 10.0.0"
+std::string versionString();
+
+// Returns a string describing the compile-time configuration.
+// e.g. mac+debug+asan+grpc
+std::string featureString();
+
+} // namespace clangd
+} // namespace clang
+
+#endif

clang-tools-extra/clangd/Features.cpp

+//===--- Features.cpp - Compile-time configuration ------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "Features.h"
+#include "clang/Basic/Version.h"
+#include "llvm/Support/Compiler.h"
+
+namespace clang {
+namespace clangd {
+
+std::string versionString() { return clang::getClangToolFullVersion("clangd"); }
+
+std::string featureString() {
+  return
+#if defined(_WIN32)
+      "windows"
+#elif defined(__APPLE__)
+      "mac"
+#elif defined(__linux__)
+      "linux"
+#elif defined(LLVM_ON_UNIX)
+      "unix"
+#else
+      "unknown"
+#endif
+
+#ifndef NDEBUG
+      "+debug"
+#endif
+#if LLVM_ADDRESS_SANITIZER_BUILD
+      "+asan"
+#endif
+#if LLVM_THREAD_SANITIZER_BUILD
+      "+tsan"
+#endif
+#if LLVM_MEMORY_SANITIZER_BUILD
+      "+msan"
+#endif
+
+#if CLANGD_ENABLE_REMOTE
+      "+grpc"
+#endif
+#if CLANGD_BUILD_XPC
+      "+xpc"
+#endif
+      ;
+}
+
+} // namespace clangd
+} // namespace clang

clang-tools-extra/clangd/Features.inc.in

+// IWYU pragma: private, include "Features.h"
 #define CLANGD_BUILD_XPC @CLANGD_BUILD_XPC@
 #define CLANGD_ENABLE_REMOTE @CLANGD_ENABLE_REMOTE@
 #define ENABLE_GRPC_REFLECTION @ENABLE_GRPC_REFLECTION@
 #define CLANGD_MALLOC_TRIM @CLANGD_MALLOC_TRIM@

clang-tools-extra/clangd/index/remote/Client.cpp

 //===--- Client.cpp ----------------------------------------------*- C++-*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #include <grpc++/grpc++.h>
 
 #include "Client.h"
+#include "Features.h"
 #include "Service.grpc.pb.h"
 #include "index/Index.h"
 #include "marshalling/Marshalling.h"
 #include "support/Logger.h"
 #include "support/Trace.h"
-#include "clang/Basic/Version.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/Error.h"
 
 #include <atomic>
 #include <chrono>
 #include <memory>
 
bool streamRPC(ClangdRequestT Request,
     // We initialize to true because stream might be broken before we see the
     // final message. In such a case there are actually more results on the
     // stream, but we couldn't get to them.
     bool HasMore = true;
     trace::Span Tracer(RequestT::descriptor()->name());
     const auto RPCRequest = ProtobufMarshaller->toProtobuf(Request);
     SPAN_ATTACH(Tracer, "Request", RPCRequest.DebugString());
     grpc::ClientContext Context;
-    Context.AddMetadata("version", clang::getClangToolFullVersion("clangd"));
+    Context.AddMetadata("version", versionString());
+    Context.AddMetadata("features", featureString());
     std::chrono::system_clock::time_point StartTime =
         std::chrono::system_clock::now();
     auto Deadline = StartTime + DeadlineWaitingTime;
     Context.set_deadline(Deadline);
     auto Reader = (Stub.get()->*RPCCall)(&Context, RPCRequest);
     dlog("Sending {0}: {1}", RequestT::descriptor()->name(),
          RPCRequest.DebugString());
     ReplyT Reply;

clang-tools-extra/clangd/index/remote/server/Server.cpp

 //===--- Server.cpp - gRPC-based Remote Index Server  ---------------------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
-#include "Features.inc"
+#include "Features.h"
 #include "Index.pb.h"
 #include "MonitoringService.grpc.pb.h"
 #include "MonitoringService.pb.h"
 #include "Service.grpc.pb.h"
 #include "Service.pb.h"
 #include "index/Index.h"
 #include "index/Serialization.h"
 #include "index/Symbol.h"

clang-tools-extra/clangd/tool/ClangdMain.cpp

 //===--- ClangdMain.cpp - clangd server loop ------------------------------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #include "ClangdLSPServer.h"
 #include "CodeComplete.h"
 #include "Config.h"
 #include "ConfigProvider.h"
-#include "Features.inc"
+#include "Features.h"
 #include "PathMapping.h"
 #include "Protocol.h"
 #include "TidyProvider.h"
 #include "Transport.h"
 #include "index/Background.h"
 #include "index/Index.h"
 #include "index/Merge.h"
 #include "index/ProjectAware.h"
 #include "index/Serialization.h"
 #include "index/remote/Client.h"
 #include "refactor/Rename.h"
 #include "support/Path.h"
 #include "support/Shutdown.h"
 #include "support/ThreadsafeFS.h"
 #include "support/Trace.h"
-#include "clang/Basic/Version.h"
 #include "clang/Format/Format.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/Process.h"

 int main(int argc, char *argv[]) {
   using namespace clang;
   using namespace clang::clangd;
 
   llvm::InitializeAllTargetInfos();
   llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
   llvm::sys::SetInterruptFunction(&requestShutdown);
   llvm::cl::SetVersionPrinter([](llvm::raw_ostream &OS) {
-    OS << clang::getClangToolFullVersion("clangd") << "\n";
+    OS << versionString() << "\n"
+       << "Features: " << featureString() << "\n";
   });
   const char *FlagsEnvVar = "CLANGD_FLAGS";
   const char *Overview =
       R"(clangd is a language server that provides IDE-like features to editors.
 
 It should be used via an editor plugin rather than invoked directly. For more information, see:
   https://clangd.llvm.org/
   https://microsoft.github.io/language-server-protocol/
)";
   // Use buffered stream to stderr (we still flush each log message). Unbuffered
   // stream can cause significant (non-deterministic) latency for the logger.
   llvm::errs().SetBuffered();
   // Don't flush stdout when logging, this would be both slow and racy!
   llvm::errs().tie(nullptr);
   StreamLogger Logger(llvm::errs(), LogLevel);
   LoggingSession LoggingSession(Logger);
   // Write some initial logs before we start doing any real work.
-  log("{0}", clang::getClangToolFullVersion("clangd"));
+  log("{0}", versionString());
+  log("Features: {0}", featureString());
   log("PID: {0}", llvm::sys::Process::getProcessId());
   {
     SmallString<128> CWD;
     if (auto Err = llvm::sys::fs::current_path(CWD))
       log("Working directory unknown: {0}", Err.message());
     else
       log("Working directory: {0}", CWD);
   }

clang-tools-extra/clangd/unittests/ConfigCompileTests.cpp

 //===-- ConfigCompileTests.cpp --------------------------------------------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #include "Config.h"
 #include "ConfigFragment.h"
 #include "ConfigTesting.h"
-#include "Features.inc"
+#include "Features.h"
 #include "TestFS.h"
 #include "clang/Basic/DiagnosticSema.h"
 #include "llvm/ADT/None.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/SourceMgr.h"
 #include "gmock/gmock.h"