Index: clangd/CMakeLists.txt =================================================================== --- clangd/CMakeLists.txt +++ clangd/CMakeLists.txt @@ -19,7 +19,7 @@ Protocol.cpp ProtocolHandlers.cpp Trace.cpp - index/FileSymbols.cpp + index/FileIndex.cpp index/Index.cpp index/MemIndex.cpp index/SymbolCollector.cpp Index: clangd/index/FileIndex.h =================================================================== --- /dev/null +++ clangd/index/FileIndex.h @@ -0,0 +1,68 @@ +//===--- FileIndex.h - Index for files. ---------------------------- C++-*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_INDEX_FILEINDEX_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_INDEX_FILEINDEX_H + +#include "../ClangdUnit.h" +#include "../Context.h" +#include "Index.h" +#include "MemIndex.h" + +namespace clang { +namespace clangd { + +/// \brief A container of Symbols from several source files. It can be updated +/// at source-file granularity, replacing all symbols from one file with a new +/// set. +/// +/// This implements a snapshot semantics for symbols in a file. Each update to a +/// file will create a new snapshot for all symbols in the file. Snapshots are +/// managed with shared pointers that are shared between this class and the +/// users. For each file, this class only stores a pointer pointing to the +/// newest snapshot, and an outdated snapshot is deleted by the last owner of +/// the snapshot, either this class or the symbol index. +/// +/// The snapshot semantics keeps critical sections minimal since we only need +/// locking when we swap or obtain refereces to snapshots. +class FileSymbols { +public: + /// \brief Updates all symbols in a file. If \p Slab is nullptr, symbols for + /// \p Path will be removed. + void update(PathRef Path, std::unique_ptr Slab); + + // The shared_ptr keeps the symbols alive + std::shared_ptr> allSymbols(); + +private: + mutable std::mutex Mutex; + + /// \brief Stores the latest snapshots for all active files. + llvm::StringMap> FileToSlabs; +}; + +/// \brief This manages symbls from files and an in-memory index on all symbols. +class FileIndex : public SymbolIndex { +public: + /// \brief Update symbols in \p Path with symbols in \p AST. If \p AST is + /// nullptr, this removes all symbols from \p Path. + void update(Context &Ctx, PathRef Path, ParsedAST *AST); + + bool fuzzyFind(Context &Ctx, const FuzzyFindRequest &Req, + std::function Callback) const; + +private: + FileSymbols FSymbols; + MemIndex Index; +}; + +} // namespace clangd +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_INDEX_FILEINDEX_H Index: clangd/index/FileIndex.cpp =================================================================== --- /dev/null +++ clangd/index/FileIndex.cpp @@ -0,0 +1,83 @@ +//===--- FileIndex.cpp - Indexes for files. ------------------------ C++-*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "FileIndex.h" +#include "SymbolCollector.h" +#include "clang/Index/IndexingAction.h" + +namespace clang { +namespace clangd { +namespace { + +/// Retrieves namespace and class level symbols in \p Decls. +std::unique_ptr indexAST(ASTContext &Ctx, + llvm::ArrayRef Decls) { + auto Collector = std::make_shared(); + index::IndexingOptions IndexOpts; + IndexOpts.SystemSymbolFilter = + index::IndexingOptions::SystemSymbolFilterKind::All; + IndexOpts.IndexFunctionLocals = false; + + index::indexTopLevelDecls(Ctx, Decls, Collector, IndexOpts); + auto Symbols = llvm::make_unique(); + *Symbols = Collector->takeSymbols(); + return Symbols; +} + +} // namespace + +void FileSymbols::update(PathRef Path, std::unique_ptr Slab) { + std::lock_guard Lock(Mutex); + if (!Slab) + FileToSlabs.erase(Path); + else + FileToSlabs[Path] = std::shared_ptr(Slab.release()); +} + +std::shared_ptr> FileSymbols::allSymbols() { + // The snapshot manages life time of symbol slabs and provides pointers of all + // symbols in all slabs. + struct Snapshot { + std::vector Pointers; + std::vector> KeepAlive; + }; + auto Snap = std::make_shared(); + { + std::lock_guard Lock(Mutex); + + for (const auto &FileAndSlab : FileToSlabs) { + Snap->KeepAlive.push_back(FileAndSlab.second); + for (const auto &Iter : *FileAndSlab.second) + Snap->Pointers.push_back(&Iter.second); + } + } + auto *Pointers = &Snap->Pointers; + // Use aliasing constructor to keep the snapshot alive along with the + // pointers. + return {std::move(Snap), Pointers}; +} + +void FileIndex::update(Context &Ctx, PathRef Path, ParsedAST *AST) { + if (!AST) { + FSymbols.update(Path, nullptr); + } else { + auto Slab = indexAST(AST->getASTContext(), AST->getTopLevelDecls()); + FSymbols.update(Path, std::move(Slab)); + } + auto Symbols = FSymbols.allSymbols(); + Index.build(std::move(Symbols)); +} + +bool FileIndex::fuzzyFind(Context &Ctx, const FuzzyFindRequest &Req, + std::function Callback) const { + return Index.fuzzyFind(Ctx, Req, std::move(Callback)); +} + +} // namespace clangd +} // namespace clang Index: unittests/clangd/CMakeLists.txt =================================================================== --- unittests/clangd/CMakeLists.txt +++ unittests/clangd/CMakeLists.txt @@ -12,7 +12,7 @@ ClangdTests.cpp CodeCompleteTests.cpp ContextTests.cpp - FileSymbolsTests.cpp + FileIndexTests.cpp FuzzyMatchTests.cpp IndexTests.cpp JSONExprTests.cpp Index: unittests/clangd/FileIndexTests.cpp =================================================================== --- /dev/null +++ unittests/clangd/FileIndexTests.cpp @@ -0,0 +1,194 @@ +//===-- FileIndexTests.cpp ---------------------------*- C++ -*-----------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "index/FileIndex.h" +#include "clang/Frontend/CompilerInvocation.h" +#include "clang/Frontend/PCHContainerOperations.h" +#include "clang/Frontend/Utils.h" +#include "gmock/gmock.h" +#include "gtest/gtest.h" + +using testing::UnorderedElementsAre; + +namespace clang { +namespace clangd { + +namespace { + +Symbol symbol(llvm::StringRef ID) { + Symbol Sym; + Sym.ID = SymbolID(ID); + Sym.QualifiedName = ID; + return Sym; +} + +void addNumSymbolsToSlab(int Begin, int End, SymbolSlab *Slab) { + for (int i = Begin; i <= End; i++) + Slab->insert(symbol(std::to_string(i))); +} + +std::vector +getSymbolNames(const std::vector &Symbols) { + std::vector Names; + for (const Symbol *Sym : Symbols) + Names.push_back(Sym->QualifiedName); + return Names; +} + +TEST(FileSymbolsTest, UpdateAndGet) { + FileSymbols FS; + EXPECT_THAT(getSymbolNames(*FS.allSymbols()), UnorderedElementsAre()); + + auto Slab = llvm::make_unique(); + addNumSymbolsToSlab(1, 3, Slab.get()); + + FS.update("f1", std::move(Slab)); + + EXPECT_THAT(getSymbolNames(*FS.allSymbols()), + UnorderedElementsAre("1", "2", "3")); +} + +TEST(FileSymbolsTest, Overlap) { + FileSymbols FS; + + auto Slab = llvm::make_unique(); + addNumSymbolsToSlab(1, 3, Slab.get()); + + FS.update("f1", std::move(Slab)); + + Slab = llvm::make_unique(); + addNumSymbolsToSlab(3, 5, Slab.get()); + + FS.update("f2", std::move(Slab)); + + EXPECT_THAT(getSymbolNames(*FS.allSymbols()), + UnorderedElementsAre("1", "2", "3", "3", "4", "5")); +} + +TEST(FileSymbolsTest, SnapshotAliveAfterRemove) { + FileSymbols FS; + + auto Slab = llvm::make_unique(); + addNumSymbolsToSlab(1, 3, Slab.get()); + + FS.update("f1", std::move(Slab)); + + auto Symbols = FS.allSymbols(); + EXPECT_THAT(getSymbolNames(*Symbols), UnorderedElementsAre("1", "2", "3")); + + FS.update("f1", nullptr); + EXPECT_THAT(getSymbolNames(*FS.allSymbols()), UnorderedElementsAre()); + + EXPECT_THAT(getSymbolNames(*Symbols), UnorderedElementsAre("1", "2", "3")); +} + +std::vector match(const SymbolIndex &I, + const FuzzyFindRequest &Req) { + std::vector Matches; + auto Ctx = Context::empty(); + I.fuzzyFind(Ctx, Req, + [&](const Symbol &Sym) { Matches.push_back(Sym.QualifiedName); }); + return Matches; +} + +/// Create an ParsedAST for \p Code. Returns None if \p Code is empty. +llvm::Optional build(std::string Path, llvm::StringRef Code) { + Context Ctx = Context::empty(); + if (Code.empty()) + return llvm::None; + const char *Args[] = {"clang", "-xc++", Path.c_str()}; + + auto CI = createInvocationFromCommandLine(Args); + + auto Buf = llvm::MemoryBuffer::getMemBuffer(Code); + auto AST = ParsedAST::Build(Ctx, std::move(CI), nullptr, std::move(Buf), + std::make_shared(), + vfs::getRealFileSystem()); + assert(AST.hasValue()); + return std::move(*AST); +} + +TEST(FileIndexTest, IndexAST) { + FileIndex M; + auto Ctx = Context::empty(); + M.update( + Ctx, "f1", + build("f1", "namespace ns { void f() {} class X {}; }").getPointer()); + + FuzzyFindRequest Req; + Req.Query = "ns::"; + EXPECT_THAT(match(M, Req), UnorderedElementsAre("ns::f", "ns::X")); +} + +TEST(FileIndexTest, NoLocal) { + FileIndex M; + auto Ctx = Context::empty(); + M.update( + Ctx, "f1", + build("f1", "namespace ns { void f() { int local = 0; } class X {}; }") + .getPointer()); + + FuzzyFindRequest Req; + Req.Query = ""; + EXPECT_THAT(match(M, Req), UnorderedElementsAre("ns", "ns::f", "ns::X")); +} + +TEST(FileIndexTest, IndexMultiASTAndDeduplicate) { + FileIndex M; + auto Ctx = Context::empty(); + M.update( + Ctx, "f1", + build("f1", "namespace ns { void f() {} class X {}; }").getPointer()); + M.update( + Ctx, "f2", + build("f2", "namespace ns { void ff() {} class X {}; }").getPointer()); + + FuzzyFindRequest Req; + Req.Query = "ns::"; + EXPECT_THAT(match(M, Req), + UnorderedElementsAre("ns::f", "ns::X", "ns::ff")); +} + +TEST(FileIndexTest, RemoveAST) { + FileIndex M; + auto Ctx = Context::empty(); + M.update( + Ctx, "f1", + build("f1", "namespace ns { void f() {} class X {}; }").getPointer()); + + FuzzyFindRequest Req; + Req.Query = "ns::"; + EXPECT_THAT(match(M, Req), UnorderedElementsAre("ns::f", "ns::X")); + + M.update(Ctx, "f1", nullptr); + EXPECT_THAT(match(M, Req), UnorderedElementsAre()); +} + +TEST(FileIndexTest, RemoveNonExisting) { + FileIndex M; + auto Ctx = Context::empty(); + M.update(Ctx, "no", nullptr); + EXPECT_THAT(match(M, FuzzyFindRequest()), UnorderedElementsAre()); +} + +TEST(FileIndexTest, ClassMembers) { + FileIndex M; + auto Ctx = Context::empty(); + M.update(Ctx, "f1", + build("f1", "class X { static int m1; int m2;};").getPointer()); + + FuzzyFindRequest Req; + Req.Query = ""; + EXPECT_THAT(match(M, Req), UnorderedElementsAre("X", "X::m1", "X::m2")); +} + +} // namespace +} // namespace clangd +} // namespace clang + Index: unittests/clangd/FileSymbolsTests.cpp =================================================================== --- unittests/clangd/FileSymbolsTests.cpp +++ /dev/null @@ -1,91 +0,0 @@ -//===-- FileSymbolsTests.cpp -------------------------*- C++ -*-----------===// -// -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. -// -//===----------------------------------------------------------------------===// - -#include "index/FileSymbols.h" -#include "gmock/gmock.h" -#include "gtest/gtest.h" - -using testing::UnorderedElementsAre; - -namespace clang { -namespace clangd { - -namespace { - -Symbol symbol(llvm::StringRef ID) { - Symbol Sym; - Sym.ID = SymbolID(ID); - Sym.QualifiedName = ID; - return Sym; -} - -void addNumSymbolsToSlab(int Begin, int End, SymbolSlab *Slab) { - for (int i = Begin; i <= End; i++) - Slab->insert(symbol(std::to_string(i))); -} - -std::vector -getSymbolNames(const std::vector &Symbols) { - std::vector Names; - for (const Symbol *Sym : Symbols) - Names.push_back(Sym->QualifiedName); - return Names; -} - -TEST(FileSymbolsTest, UpdateAndGet) { - FileSymbols FS; - EXPECT_THAT(getSymbolNames(*FS.allSymbols()), UnorderedElementsAre()); - - auto Slab = llvm::make_unique(); - addNumSymbolsToSlab(1, 3, Slab.get()); - - FS.update("f1", std::move(Slab)); - - EXPECT_THAT(getSymbolNames(*FS.allSymbols()), - UnorderedElementsAre("1", "2", "3")); -} - -TEST(FileSymbolsTest, Overlap) { - FileSymbols FS; - - auto Slab = llvm::make_unique(); - addNumSymbolsToSlab(1, 3, Slab.get()); - - FS.update("f1", std::move(Slab)); - - Slab = llvm::make_unique(); - addNumSymbolsToSlab(3, 5, Slab.get()); - - FS.update("f2", std::move(Slab)); - - EXPECT_THAT(getSymbolNames(*FS.allSymbols()), - UnorderedElementsAre("1", "2", "3", "3", "4", "5")); -} - -TEST(FileSymbolsTest, SnapshotAliveAfterRemove) { - FileSymbols FS; - - auto Slab = llvm::make_unique(); - addNumSymbolsToSlab(1, 3, Slab.get()); - - FS.update("f1", std::move(Slab)); - - auto Symbols = FS.allSymbols(); - EXPECT_THAT(getSymbolNames(*Symbols), UnorderedElementsAre("1", "2", "3")); - - FS.update("f1", nullptr); - EXPECT_THAT(getSymbolNames(*FS.allSymbols()), UnorderedElementsAre()); - - EXPECT_THAT(getSymbolNames(*Symbols), UnorderedElementsAre("1", "2", "3")); -} - -} // namespace -} // namespace clangd -} // namespace clang - Index: unittests/clangd/IndexTests.cpp =================================================================== --- unittests/clangd/IndexTests.cpp +++ unittests/clangd/IndexTests.cpp @@ -9,6 +9,7 @@ #include "index/Index.h" #include "index/MemIndex.h" +#include "llvm/ADT/Optional.h" #include "gmock/gmock.h" #include "gtest/gtest.h"