llvm-project/mlir/lib/Tools/lsp-server-support/CompilationDatabase.cpp
Bertik23 a3a25996b1
[LLVM][MLIR] Move LSP server support library from MLIR into LLVM (#157885)
This is a second PR on this patch (first #155572), that fixes the
linking problem for `flang-aarch64-dylib` test.

The SupportLSP library was made a component library.

---

This PR moves the generic Language Server Protocol (LSP) server support
code that was copied from clangd into MLIR, into the LLVM tree so it can
be reused by multiple subprojects.

Centralizing the generic LSP support in LLVM lowers the barrier to
building new LSP servers across the LLVM ecosystem and avoids each
subproject maintaining its own copy.

The code originated in clangd and was copied into MLIR for its LSP
server. MLIR had this code seperate to be reused by all of their LSP
server. This PR relocates the MLIR copy into LLVM as a shared component
into LLVM/Support. If this is not a suitable place, please suggest a
better one.

A follow up to this move could be deduplication with the original clangd
implementation and converge on a single shared LSP support library used
by clangd, MLIR, and future servers.
What changes

mlir/include/mlir/Tools/lsp-server-support/{Logging, Protocol,
Transport}.h moved to llvm/include/llvm/Support/LSP
mlir/lib/Tools/lsp-server-support/{Logging, Protocol, Transport}.cpp
moved to llvm/lib/Support/LSP

and their namespace was changed from mlir to llvm

I ran clang-tidy --fix and clang-format on the whole moved files (last
two commits), as they are basically new files and should hold up to the
code style used by LLVM.

MLIR LSP servers where updated to include these files from their new
location and account for the namespace change.

This PR is made as part of the LLVM IR LSP project
([RFC](https://discourse.llvm.org/t/rfc-ir-visualization-with-vs-code-extension-using-an-lsp-server/87773))
2025-09-11 17:17:52 +00:00

119 lines
4.0 KiB
C++

//===- CompilationDatabase.cpp - LSP Compilation Database -----------------===//
//
// 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 "mlir/Tools/lsp-server-support/CompilationDatabase.h"
#include "mlir/Support/FileUtilities.h"
#include "llvm/ADT/SetVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/LSP/Logging.h"
#include "llvm/Support/LSP/Protocol.h"
#include "llvm/Support/YAMLTraits.h"
using namespace mlir;
using namespace mlir::lsp;
using llvm::lsp::Logger;
//===----------------------------------------------------------------------===//
// YamlFileInfo
//===----------------------------------------------------------------------===//
namespace {
struct YamlFileInfo {
/// The absolute path to the file.
std::string filename;
/// The include directories available for the file.
std::vector<std::string> includeDirs;
};
} // namespace
//===----------------------------------------------------------------------===//
// CompilationDatabase
//===----------------------------------------------------------------------===//
LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(YamlFileInfo)
namespace llvm {
namespace yaml {
template <>
struct MappingTraits<YamlFileInfo> {
static void mapping(IO &io, YamlFileInfo &info) {
// Parse the filename and normalize it to the form we will expect from
// incoming URIs.
io.mapRequired("filepath", info.filename);
// Normalize the filename to avoid incompatability with incoming URIs.
if (Expected<lsp::URIForFile> uri =
lsp::URIForFile::fromFile(info.filename))
info.filename = uri->file().str();
// Parse the includes from the yaml stream. These are in the form of a
// semi-colon delimited list.
std::string combinedIncludes;
io.mapRequired("includes", combinedIncludes);
for (StringRef include : llvm::split(combinedIncludes, ";")) {
if (!include.empty())
info.includeDirs.push_back(include.str());
}
}
};
} // end namespace yaml
} // end namespace llvm
CompilationDatabase::CompilationDatabase(ArrayRef<std::string> databases) {
for (StringRef filename : databases)
loadDatabase(filename);
}
const CompilationDatabase::FileInfo &
CompilationDatabase::getFileInfo(StringRef filename) const {
auto it = files.find(filename);
return it == files.end() ? defaultFileInfo : it->second;
}
void CompilationDatabase::loadDatabase(StringRef filename) {
if (filename.empty())
return;
// Set up the input file.
std::string errorMessage;
std::unique_ptr<llvm::MemoryBuffer> inputFile =
openInputFile(filename, &errorMessage);
if (!inputFile) {
Logger::error("Failed to open compilation database: {0}", errorMessage);
return;
}
llvm::yaml::Input yaml(inputFile->getBuffer());
// Parse the yaml description and add any new files to the database.
std::vector<YamlFileInfo> parsedFiles;
yaml >> parsedFiles;
SetVector<StringRef> knownIncludes;
for (auto &file : parsedFiles) {
auto it = files.try_emplace(file.filename, std::move(file.includeDirs));
// If we encounter a duplicate file, log a warning and ignore it.
if (!it.second) {
Logger::info("Duplicate file in compilation database: {0}",
file.filename);
continue;
}
// Track the includes for the file.
knownIncludes.insert_range(it.first->second.includeDirs);
}
// Add all of the known includes to the default file info. We don't know any
// information about how to treat these files, but these may be project files
// that we just don't yet have information for. In these cases, providing some
// heuristic information provides a better user experience, and generally
// shouldn't lead to any negative side effects.
for (StringRef include : knownIncludes)
defaultFileInfo.includeDirs.push_back(include.str());
}