Author: ibiryukov Date: Thu Sep 13 02:44:11 2018 New Revision: 342123 URL: http://llvm.org/viewvc/llvm-project?rev=342123&view=rev Log: [clangd] Rename global-symbol-builder to clangd-indexer.
Summary: Given that the indexer binary is put directly into ./bin directory when built, 'clangd-' prefix seems to provide better context to the reader than 'global-'. The new name is also shorter and easier to type. Reviewers: ioeric, sammccall, kadircet Reviewed By: ioeric, sammccall Subscribers: kbobyrev, ilya-biryukov, mgorny, MaskRay, jkorous, arphaman, cfe-commits Differential Revision: https://reviews.llvm.org/D51987 Added: clang-tools-extra/trunk/clangd/indexer/ clang-tools-extra/trunk/clangd/indexer/CMakeLists.txt - copied, changed from r342052, clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt clang-tools-extra/trunk/clangd/indexer/IndexerMain.cpp - copied, changed from r342052, clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp Removed: clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp Modified: clang-tools-extra/trunk/clangd/CMakeLists.txt clang-tools-extra/trunk/test/CMakeLists.txt clang-tools-extra/trunk/test/clangd/index-tools.test Modified: clang-tools-extra/trunk/clangd/CMakeLists.txt URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/CMakeLists.txt?rev=342123&r1=342122&r2=342123&view=diff ============================================================================== --- clang-tools-extra/trunk/clangd/CMakeLists.txt (original) +++ clang-tools-extra/trunk/clangd/CMakeLists.txt Thu Sep 13 02:44:11 2018 @@ -73,7 +73,7 @@ if( LLVM_LIB_FUZZING_ENGINE OR LLVM_USE_ add_subdirectory(fuzzer) endif() add_subdirectory(tool) -add_subdirectory(global-symbol-builder) +add_subdirectory(indexer) add_subdirectory(index/dex/dexp) if (LLVM_INCLUDE_BENCHMARKS) Removed: clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt?rev=342122&view=auto ============================================================================== --- clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt (original) +++ clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt (removed) @@ -1,20 +0,0 @@ -include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../) - -set(LLVM_LINK_COMPONENTS - Support - ) - -add_clang_executable(global-symbol-builder - GlobalSymbolBuilderMain.cpp - ) - -target_link_libraries(global-symbol-builder - PRIVATE - clangAST - clangIndex - clangDaemon - clangBasic - clangFrontend - clangLex - clangTooling -) Removed: clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp?rev=342122&view=auto ============================================================================== --- clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp (original) +++ clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp (removed) @@ -1,285 +0,0 @@ -//===--- GlobalSymbolBuilderMain.cpp -----------------------------*- C++-*-===// -// -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. -// -//===----------------------------------------------------------------------===// -// -// GlobalSymbolBuilder is a tool to extract symbols from a whole project. -// This tool is **experimental** only. Don't use it in production code. -// -//===----------------------------------------------------------------------===// - -#include "RIFF.h" -#include "index/CanonicalIncludes.h" -#include "index/Index.h" -#include "index/Merge.h" -#include "index/Serialization.h" -#include "index/SymbolCollector.h" -#include "index/SymbolYAML.h" -#include "clang/Frontend/CompilerInstance.h" -#include "clang/Frontend/FrontendActions.h" -#include "clang/Index/IndexDataConsumer.h" -#include "clang/Index/IndexingAction.h" -#include "clang/Tooling/CommonOptionsParser.h" -#include "clang/Tooling/Execution.h" -#include "clang/Tooling/Tooling.h" -#include "llvm/Support/CommandLine.h" -#include "llvm/Support/MemoryBuffer.h" -#include "llvm/Support/Path.h" -#include "llvm/Support/Signals.h" -#include "llvm/Support/ThreadPool.h" -#include "llvm/Support/YAMLTraits.h" - -using namespace llvm; -using namespace clang::tooling; -using clang::clangd::SymbolSlab; - -namespace clang { -namespace clangd { -namespace { - -static llvm::cl::opt<std::string> AssumedHeaderDir( - "assume-header-dir", - llvm::cl::desc("The index includes header that a symbol is defined in. " - "If the absolute path cannot be determined (e.g. an " - "in-memory VFS) then the relative path is resolved against " - "this directory, which must be absolute. If this flag is " - "not given, such headers will have relative paths."), - llvm::cl::init("")); - -static llvm::cl::opt<bool> MergeOnTheFly( - "merge-on-the-fly", - llvm::cl::desc( - "Merges symbols for each processed translation unit as soon " - "they become available. This results in a smaller memory " - "usage and an almost instant reduce stage. Optimal for running as a " - "standalone tool, but cannot be used with multi-process executors like " - "MapReduce."), - llvm::cl::init(true), llvm::cl::Hidden); - -enum IndexFormat { YAML, Binary }; -static llvm::cl::opt<IndexFormat> Format( - "format", llvm::cl::desc("Format of the index to be written"), - llvm::cl::values(clEnumValN(YAML, "yaml", "human-readable YAML format"), - clEnumValN(Binary, "binary", "binary RIFF format")), - llvm::cl::init(YAML)); - -/// Responsible for aggregating symbols from each processed file and producing -/// the final results. All methods in this class must be thread-safe, -/// 'consumeSymbols' may be called from multiple threads. -class SymbolsConsumer { -public: - virtual ~SymbolsConsumer() = default; - - /// Consume a SymbolSlab build for a file. - virtual void consumeSymbols(SymbolSlab Symbols) = 0; - /// Produce a resulting symbol slab, by combining occurrences of the same - /// symbols across translation units. - virtual SymbolSlab mergeResults() = 0; -}; - -class SymbolIndexActionFactory : public tooling::FrontendActionFactory { -public: - SymbolIndexActionFactory(SymbolsConsumer &Consumer) : Consumer(Consumer) {} - - clang::FrontendAction *create() override { - // Wraps the index action and reports collected symbols to the execution - // context at the end of each translation unit. - class WrappedIndexAction : public WrapperFrontendAction { - public: - WrappedIndexAction(std::shared_ptr<SymbolCollector> C, - std::unique_ptr<CanonicalIncludes> Includes, - const index::IndexingOptions &Opts, - SymbolsConsumer &Consumer) - : WrapperFrontendAction( - index::createIndexingAction(C, Opts, nullptr)), - Consumer(Consumer), Collector(C), Includes(std::move(Includes)), - PragmaHandler(collectIWYUHeaderMaps(this->Includes.get())) {} - - std::unique_ptr<ASTConsumer> - CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override { - CI.getPreprocessor().addCommentHandler(PragmaHandler.get()); - return WrapperFrontendAction::CreateASTConsumer(CI, InFile); - } - - bool BeginInvocation(CompilerInstance &CI) override { - // We want all comments, not just the doxygen ones. - CI.getLangOpts().CommentOpts.ParseAllComments = true; - return WrapperFrontendAction::BeginInvocation(CI); - } - - void EndSourceFileAction() override { - WrapperFrontendAction::EndSourceFileAction(); - - const auto &CI = getCompilerInstance(); - if (CI.hasDiagnostics() && - CI.getDiagnostics().hasUncompilableErrorOccurred()) { - llvm::errs() - << "Found uncompilable errors in the translation unit. Igoring " - "collected symbols...\n"; - return; - } - - Consumer.consumeSymbols(Collector->takeSymbols()); - } - - private: - SymbolsConsumer &Consumer; - std::shared_ptr<SymbolCollector> Collector; - std::unique_ptr<CanonicalIncludes> Includes; - std::unique_ptr<CommentHandler> PragmaHandler; - }; - - index::IndexingOptions IndexOpts; - IndexOpts.SystemSymbolFilter = - index::IndexingOptions::SystemSymbolFilterKind::All; - IndexOpts.IndexFunctionLocals = false; - auto CollectorOpts = SymbolCollector::Options(); - CollectorOpts.FallbackDir = AssumedHeaderDir; - CollectorOpts.CollectIncludePath = true; - CollectorOpts.CountReferences = true; - CollectorOpts.Origin = SymbolOrigin::Static; - auto Includes = llvm::make_unique<CanonicalIncludes>(); - addSystemHeadersMapping(Includes.get()); - CollectorOpts.Includes = Includes.get(); - return new WrappedIndexAction( - std::make_shared<SymbolCollector>(std::move(CollectorOpts)), - std::move(Includes), IndexOpts, Consumer); - } - - SymbolsConsumer &Consumer; -}; - -/// Stashes per-file results inside ExecutionContext, merges all of them at the -/// end. Useful for running on MapReduce infrastructure to avoid keeping symbols -/// from multiple files in memory. -class ToolExecutorConsumer : public SymbolsConsumer { -public: - ToolExecutorConsumer(ToolExecutor &Executor) : Executor(Executor) {} - - void consumeSymbols(SymbolSlab Symbols) override { - for (const auto &Sym : Symbols) - Executor.getExecutionContext()->reportResult(Sym.ID.str(), - SymbolToYAML(Sym)); - } - - SymbolSlab mergeResults() override { - SymbolSlab::Builder UniqueSymbols; - Executor.getToolResults()->forEachResult( - [&](llvm::StringRef Key, llvm::StringRef Value) { - llvm::yaml::Input Yin(Value); - auto Sym = clang::clangd::SymbolFromYAML(Yin); - clang::clangd::SymbolID ID; - Key >> ID; - if (const auto *Existing = UniqueSymbols.find(ID)) - UniqueSymbols.insert(mergeSymbol(*Existing, Sym)); - else - UniqueSymbols.insert(Sym); - }); - return std::move(UniqueSymbols).build(); - } - -private: - ToolExecutor &Executor; -}; - -/// Merges symbols for each translation unit as soon as the file is processed. -/// Optimal choice for standalone tools. -class OnTheFlyConsumer : public SymbolsConsumer { -public: - void consumeSymbols(SymbolSlab Symbols) override { - std::lock_guard<std::mutex> Lock(Mut); - for (auto &&Sym : Symbols) { - if (const auto *Existing = Result.find(Sym.ID)) - Result.insert(mergeSymbol(*Existing, Sym)); - else - Result.insert(Sym); - } - } - - SymbolSlab mergeResults() override { - std::lock_guard<std::mutex> Lock(Mut); - return std::move(Result).build(); - } - -private: - std::mutex Mut; - SymbolSlab::Builder Result; -}; - -} // namespace -} // namespace clangd -} // namespace clang - -int main(int argc, const char **argv) { - llvm::sys::PrintStackTraceOnErrorSignal(argv[0]); - - const char *Overview = R"( - This is an **experimental** tool to extract symbols from a whole project - for clangd (global code completion). It will be changed and deprecated - eventually. Don't use it in production code! - - Example usage for building index for the whole project using CMake compile - commands: - - $ global-symbol-builder --executor=all-TUs compile_commands.json > index.yaml - - Example usage for file sequence index without flags: - - $ global-symbol-builder File1.cpp File2.cpp ... FileN.cpp > index.yaml - - Note: only symbols from header files will be collected. - )"; - - auto Executor = clang::tooling::createExecutorFromCommandLineArgs( - argc, argv, cl::GeneralCategory, Overview); - - if (!Executor) { - llvm::errs() << llvm::toString(Executor.takeError()) << "\n"; - return 1; - } - - if (!clang::clangd::AssumedHeaderDir.empty() && - !llvm::sys::path::is_absolute(clang::clangd::AssumedHeaderDir)) { - llvm::errs() << "--assume-header-dir must be an absolute path.\n"; - return 1; - } - - if (clang::clangd::MergeOnTheFly && !Executor->get()->isSingleProcess()) { - llvm::errs() - << "Found multi-process executor, forcing the use of intermediate YAML " - "serialization instead of the on-the-fly merge.\n"; - clang::clangd::MergeOnTheFly = false; - } - - std::unique_ptr<clang::clangd::SymbolsConsumer> Consumer; - if (clang::clangd::MergeOnTheFly) - Consumer = llvm::make_unique<clang::clangd::OnTheFlyConsumer>(); - else - Consumer = - llvm::make_unique<clang::clangd::ToolExecutorConsumer>(**Executor); - - // Map phase: emit symbols found in each translation unit. - auto Err = Executor->get()->execute( - llvm::make_unique<clang::clangd::SymbolIndexActionFactory>(*Consumer)); - if (Err) { - llvm::errs() << llvm::toString(std::move(Err)) << "\n"; - } - // Reduce phase: combine symbols with the same IDs. - auto UniqueSymbols = Consumer->mergeResults(); - // Output phase: emit result symbols. - switch (clang::clangd::Format) { - case clang::clangd::IndexFormat::YAML: - SymbolsToYAML(UniqueSymbols, llvm::outs()); - break; - case clang::clangd::IndexFormat::Binary: { - clang::clangd::IndexFileOut Out; - Out.Symbols = &UniqueSymbols; - llvm::outs() << Out; - } - } - return 0; -} Copied: clang-tools-extra/trunk/clangd/indexer/CMakeLists.txt (from r342052, clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt) URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/indexer/CMakeLists.txt?p2=clang-tools-extra/trunk/clangd/indexer/CMakeLists.txt&p1=clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt&r1=342052&r2=342123&rev=342123&view=diff ============================================================================== --- clang-tools-extra/trunk/clangd/global-symbol-builder/CMakeLists.txt (original) +++ clang-tools-extra/trunk/clangd/indexer/CMakeLists.txt Thu Sep 13 02:44:11 2018 @@ -4,11 +4,11 @@ set(LLVM_LINK_COMPONENTS Support ) -add_clang_executable(global-symbol-builder - GlobalSymbolBuilderMain.cpp +add_clang_executable(clangd-indexer + IndexerMain.cpp ) -target_link_libraries(global-symbol-builder +target_link_libraries(clangd-indexer PRIVATE clangAST clangIndex Copied: clang-tools-extra/trunk/clangd/indexer/IndexerMain.cpp (from r342052, clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp) URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/indexer/IndexerMain.cpp?p2=clang-tools-extra/trunk/clangd/indexer/IndexerMain.cpp&p1=clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp&r1=342052&r2=342123&rev=342123&view=diff ============================================================================== --- clang-tools-extra/trunk/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp (original) +++ clang-tools-extra/trunk/clangd/indexer/IndexerMain.cpp Thu Sep 13 02:44:11 2018 @@ -225,11 +225,11 @@ int main(int argc, const char **argv) { Example usage for building index for the whole project using CMake compile commands: - $ global-symbol-builder --executor=all-TUs compile_commands.json > index.yaml + $ clangd-indexer --executor=all-TUs compile_commands.json > index.yaml Example usage for file sequence index without flags: - $ global-symbol-builder File1.cpp File2.cpp ... FileN.cpp > index.yaml + $ clangd-indexer File1.cpp File2.cpp ... FileN.cpp > index.yaml Note: only symbols from header files will be collected. )"; Modified: clang-tools-extra/trunk/test/CMakeLists.txt URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/test/CMakeLists.txt?rev=342123&r1=342122&r2=342123&view=diff ============================================================================== --- clang-tools-extra/trunk/test/CMakeLists.txt (original) +++ clang-tools-extra/trunk/test/CMakeLists.txt Thu Sep 13 02:44:11 2018 @@ -55,7 +55,7 @@ set(CLANG_TOOLS_TEST_DEPS # These individual tools have no tests, add them here to make them compile # together with check-clang-tools, so that we won't break them in the future. - global-symbol-builder + clangd-indexer # Unit tests ExtraToolsUnitTests Modified: clang-tools-extra/trunk/test/clangd/index-tools.test URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/test/clangd/index-tools.test?rev=342123&r1=342122&r2=342123&view=diff ============================================================================== --- clang-tools-extra/trunk/test/clangd/index-tools.test (original) +++ clang-tools-extra/trunk/test/clangd/index-tools.test Thu Sep 13 02:44:11 2018 @@ -1,3 +1,3 @@ -# RUN: global-symbol-builder %p/Inputs/BenchmarkSource.cpp -- -I%p/Inputs > %t.index +# RUN: clangd-indexer %p/Inputs/BenchmarkSource.cpp -- -I%p/Inputs > %t.index # FIXME: By default, benchmarks are excluded from the list of default targets hence not built. Find a way to depend on benchmarks to run the next command. # RUN: if [ -f %clangd-benchmark-dir/IndexBenchmark ]; then %clangd-benchmark-dir/IndexBenchmark %t.index %p/Inputs/requests.log --benchmark_min_time=0.01 ; fi _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
