Merge pull request swiftlang#12297 from benlangmuir/sourcekitd-stats

benlangmuir · web-flow · commit b164fdb111b3 · 2017-10-05T14:12:43.000-07:00
[sourcekitd] Add a request to get statistics from the service
diff --git a/test/SourceKit/Misc/stats.swift b/test/SourceKit/Misc/stats.swift
@@ -0,0 +1,57 @@
+func foo() {}
+
+// RUN: %sourcekitd-test -req=syntax-map %s == -req=stats | %FileCheck %s -check-prefix=SYNTAX_1
+
+// SYNTAX_1: 2 {{.*}} source.statistic.num-requests
+// SYNTAX_1: 0 {{.*}} source.statistic.num-semantic-requests
+// SYNTAX_1: 0 {{.*}} source.statistic.num-ast-builds
+// SYNTAX_1: 1 {{.*}} source.statistic.num-open-documents
+// SYNTAX_1: 1 {{.*}} source.statistic.max-open-documents
+
+// RUN: %sourcekitd-test -req=syntax-map %s == -req=close %s == -req=stats | %FileCheck %s -check-prefix=SYNTAX_2
+
+// SYNTAX_2: 3 {{.*}} source.statistic.num-requests
+// SYNTAX_2: 0 {{.*}} source.statistic.num-semantic-requests
+// SYNTAX_2: 0 {{.*}} source.statistic.num-ast-builds
+// SYNTAX_2: 0 {{.*}} source.statistic.num-open-documents
+// SYNTAX_2: 1 {{.*}} source.statistic.max-open-documents
+
+// RUN: %sourcekitd-test -req=sema %s -- %s == -req=stats | %FileCheck %s -check-prefix=SEMA_1
+
+// SEMA_1: 3 {{.*}} source.statistic.num-requests
+// SEMA_1: 0 {{.*}} source.statistic.num-semantic-requests
+// SEMA_1: 1 {{.*}} source.statistic.num-ast-builds
+// SEMA_1: 1 {{.*}} source.statistic.num-asts-in-memory
+// SEMA_1: 1 {{.*}} source.statistic.max-asts-in-memory
+// SEMA_1: 0 {{.*}} source.statistic.num-ast-cache-hits
+// SEMA_1: 0 {{.*}} source.statistic.num-ast-snaphost-uses
+
+// RUN: %sourcekitd-test -req=sema %s -- %s == -req=edit -pos=1:1 -replace=" " %s == -req=stats | %FileCheck %s -check-prefix=SEMA_2
+
+// SEMA_2: 5 {{.*}} source.statistic.num-requests
+// SEMA_2: 0 {{.*}} source.statistic.num-semantic-requests
+// SEMA_2: 2 {{.*}} source.statistic.num-ast-builds
+// SEMA_2: 1 {{.*}} source.statistic.num-asts-in-memory
+// SEMA_2: 2 {{.*}} source.statistic.max-asts-in-memory
+// SEMA_2: 0 {{.*}} source.statistic.num-ast-cache-hits
+// SEMA_2: 0 {{.*}} source.statistic.num-ast-snaphost-uses
+
+// RUN: %sourcekitd-test -req=sema %s -- %s == -req=cursor -pos=1:6 %s -- %s == -req=stats | %FileCheck %s -check-prefix=SEMA_3
+
+// SEMA_3: 4 {{.*}} source.statistic.num-requests
+// SEMA_3: 1 {{.*}} source.statistic.num-semantic-requests
+// SEMA_3: 1 {{.*}} source.statistic.num-ast-builds
+// SEMA_3: 1 {{.*}} source.statistic.num-asts-in-memory
+// SEMA_3: 1 {{.*}} source.statistic.max-asts-in-memory
+// SEMA_3: 0 {{.*}} source.statistic.num-ast-cache-hits
+// SEMA_3: 1 {{.*}} source.statistic.num-ast-snaphost-uses
+
+// RUN: %sourcekitd-test -req=sema %s -- %s == -req=related-idents -pos=1:6 %s -- %s == -req=stats | %FileCheck %s -check-prefix=SEMA_4
+
+// SEMA_4: 4 {{.*}} source.statistic.num-requests
+// SEMA_4: 1 {{.*}} source.statistic.num-semantic-requests
+// SEMA_4: 1 {{.*}} source.statistic.num-ast-builds
+// SEMA_4: 1 {{.*}} source.statistic.num-asts-in-memory
+// SEMA_4: 1 {{.*}} source.statistic.max-asts-in-memory
+// SEMA_4: 1 {{.*}} source.statistic.num-ast-cache-hits
+// SEMA_4: 0 {{.*}} source.statistic.num-ast-snaphost-uses
diff --git a/tools/SourceKit/include/SourceKit/Core/LangSupport.h b/tools/SourceKit/include/SourceKit/Core/LangSupport.h
@@ -251,6 +251,9 @@ class OptionsDictionary {
   virtual bool valueForOption(UIdent Key, StringRef &Val) = 0;
 };
 
+struct Statistic;
+typedef std::function<void(ArrayRef<Statistic *> stats)> StatisticsReceiver;
+
 struct RefactoringInfo {
   UIdent Kind;
   StringRef KindName;
@@ -626,6 +629,8 @@ class LangSupport {
                           StringRef ModuleName,
                           ArrayRef<const char *> Args,
                           DocInfoConsumer &Consumer) = 0;
+
+  virtual void getStatistics(StatisticsReceiver) = 0;
 };
 
 } // namespace SourceKit
diff --git a/tools/SourceKit/include/SourceKit/Core/ProtocolUIDs.def b/tools/SourceKit/include/SourceKit/Core/ProtocolUIDs.def
@@ -107,6 +107,7 @@ KEY(NameKind, "key.namekind")
 KEY(LocalizationKey, "key.localization_key")
 KEY(IsZeroArgSelector, "key.is_zero_arg_selector")
 KEY(SwiftVersion, "key.swift_version")
+KEY(Value, "key.value")
 
 KEY(EnableDiagnostics, "key.enablediagnostics")
 KEY(GroupName, "key.groupname")
@@ -181,6 +182,7 @@ REQUEST(BuildSettingsRegister, "source.request.buildsettings.register")
 REQUEST(ModuleGroups, "source.request.module.groups")
 REQUEST(NameTranslation, "source.request.name.translation")
 REQUEST(MarkupToXML, "source.request.convert.markup.xml")
+REQUEST(Statistics, "source.request.statistics")
 
 REQUEST(SyntacticRename, "source.request.syntacticrename")
 REQUEST(FindRenameRanges, "source.request.find-syntactic-rename-ranges")
@@ -340,6 +342,9 @@ KIND(Reference, "source.syntacticrename.reference")
 KIND(Call, "source.syntacticrename.call")
 KIND(Unknown, "source.syntacticrename.unknown")
 
+KIND(StatNumRequests, "source.statistic.num-requests")
+KIND(StatNumSemaRequests, "source.statistic.num-semantic-requests")
+
 #undef KIND
 #undef REQUEST
 #undef KEY
diff --git a/tools/SourceKit/include/SourceKit/Support/Statistic.h b/tools/SourceKit/include/SourceKit/Support/Statistic.h
@@ -0,0 +1,48 @@
+//===--- Statistic.h - ------------------------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_SOURCEKIT_SUPPORT_STATISTIC_H
+#define LLVM_SOURCEKIT_SUPPORT_STATISTIC_H
+
+#include "SourceKit/Support/UIdent.h"
+#include <atomic>
+#include <string>
+
+namespace SourceKit {
+
+struct Statistic {
+  const UIdent name;
+  const std::string description;
+  std::atomic<int64_t> value = {0};
+
+  Statistic(UIdent name, std::string description)
+      : name(name), description(std::move(description)) {}
+
+  int64_t operator++() {
+    return 1 + value.fetch_add(1, std::memory_order_relaxed);
+  }
+  int64_t operator--() {
+    return value.fetch_sub(1, std::memory_order_relaxed) - 1;
+  }
+
+  void updateMax(int64_t newValue) {
+    int64_t prev = value.load(std::memory_order_relaxed);
+    // Note: compare_exchange_weak updates 'prev' if it fails.
+    while (newValue > prev && !value.compare_exchange_weak(
+                                  prev, newValue, std::memory_order_relaxed)) {
+    }
+  }
+};
+
+} // namespace SourceKit
+
+#endif // LLVM_SOURCEKIT_SUPPORT_STATISTIC_H
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftASTManager.cpp b/tools/SourceKit/lib/SwiftLang/SwiftASTManager.cpp
@@ -158,13 +158,15 @@ void InvocationOptions::profile(llvm::FoldingSetNodeID &ID) const {
 namespace SourceKit {
   struct ASTUnit::Implementation {
     const uint64_t Generation;
+    SwiftStatistics &Stats;
     SmallVector<ImmutableTextSnapshotRef, 4> Snapshots;
     EditorDiagConsumer CollectDiagConsumer;
     CompilerInstance CompInst;
     OwnedResolver TypeResolver{ nullptr, nullptr };
     WorkQueue Queue{ WorkQueue::Dequeuing::Serial, "sourcekit.swift.ConsumeAST" };
 
-    Implementation(uint64_t Generation) : Generation(Generation) {}
+    Implementation(uint64_t Generation, SwiftStatistics &Statistics)
+        : Generation(Generation), Stats(Statistics) {}
 
     void consumeAsync(SwiftASTConsumerRef ASTConsumer, ASTUnitRef ASTRef);
   };
@@ -185,10 +187,14 @@ namespace SourceKit {
     });
   }
 
-  ASTUnit::ASTUnit(uint64_t Generation) : Impl(*new Implementation(Generation)) {
+  ASTUnit::ASTUnit(uint64_t Generation, SwiftStatistics &Stats)
+      : Impl(*new Implementation(Generation, Stats)) {
+    auto numASTs = ++Stats.numASTsInMem;
+    Stats.maxASTsInMem.updateMax(numASTs);
   }
 
   ASTUnit::~ASTUnit() {
+    --Impl.Stats.numASTsInMem;
     delete &Impl;
   }
 
@@ -307,10 +313,12 @@ struct CacheKeyHashInfo<ASTKey> {
 
 struct SwiftASTManager::Implementation {
   explicit Implementation(SwiftLangSupport &LangSupport)
-    : EditorDocs(LangSupport.getEditorDocuments()),
-      RuntimeResourcePath(LangSupport.getRuntimeResourcePath()) { }
+      : EditorDocs(LangSupport.getEditorDocuments()),
+        Stats(LangSupport.getStatistics()),
+        RuntimeResourcePath(LangSupport.getRuntimeResourcePath()) {}
 
   SwiftEditorDocumentFileMap &EditorDocs;
+  SwiftStatistics &Stats;
   std::string RuntimeResourcePath;
   SourceManager SourceMgr;
   Cache<ASTKey, ASTProducerRef> ASTCache{ "sourcekit.swift.ASTCache" };
@@ -488,6 +496,7 @@ void SwiftASTManager::processASTAsync(SwiftInvocationRef InvokRef,
 
   if (ASTUnitRef Unit = Producer->getExistingAST()) {
     if (ASTConsumer->canUseASTWithSnapshots(Unit->getSnapshots())) {
+      ++Impl.Stats.numASTsUsedWithSnaphots;
       Unit->Impl.consumeAsync(std::move(ASTConsumer), Unit);
       return;
     }
@@ -616,6 +625,8 @@ ASTUnitRef ASTProducer::getASTUnitImpl(SwiftASTManager::Implementation &MgrImpl,
       ASTProducerRef ThisProducer = this;
       MgrImpl.ASTCache.set(InvokRef->Impl.Key, ThisProducer);
     }
+  } else {
+    ++MgrImpl.Stats.numASTCacheHits;
   }
 
   return AST;
@@ -732,6 +743,8 @@ static std::atomic<uint64_t> ASTUnitGeneration{ 0 };
 ASTUnitRef ASTProducer::createASTUnit(SwiftASTManager::Implementation &MgrImpl,
                                       ArrayRef<ImmutableTextSnapshotRef> Snapshots,
                                       std::string &Error) {
+  ++MgrImpl.Stats.numASTBuilds;
+
   Stamps.clear();
   DependencyStamps.clear();
 
@@ -770,7 +783,7 @@ ASTUnitRef ASTProducer::createASTUnit(SwiftASTManager::Implementation &MgrImpl,
     TraceInfo.Args.Args = Opts.Args;
   }
 
-  ASTUnitRef ASTRef = new ASTUnit(++ASTUnitGeneration);
+  ASTUnitRef ASTRef = new ASTUnit(++ASTUnitGeneration, MgrImpl.Stats);
   for (auto &Content : Contents) {
     if (Content.Snapshot)
       ASTRef->Impl.Snapshots.push_back(Content.Snapshot);
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftASTManager.h b/tools/SourceKit/lib/SwiftLang/SwiftASTManager.h
@@ -40,6 +40,7 @@ namespace SourceKit {
   class SwiftEditorDocumentFileMap;
   class SwiftLangSupport;
   class SwiftInvocation;
+  struct SwiftStatistics;
   typedef RefPtr<SwiftInvocation> SwiftInvocationRef;
   class EditorDiagConsumer;
 
@@ -48,7 +49,7 @@ class ASTUnit : public SourceKit::ThreadSafeRefCountedBase<ASTUnit> {
   struct Implementation;
   Implementation &Impl;
 
-  explicit ASTUnit(uint64_t Generation);
+  explicit ASTUnit(uint64_t Generation, SwiftStatistics &Statistics);
   ~ASTUnit();
 
   swift::CompilerInstance &getCompilerInstance() const;
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp b/tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp
@@ -2073,6 +2073,8 @@ void SwiftLangSupport::editorOpen(StringRef Name, llvm::MemoryBuffer *Buf,
       LOG_WARN_FUNC("Document already exists in editorOpen(..): " << Name);
       Snapshot = nullptr;
     }
+    auto numOpen = ++Stats.numOpenDocs;
+    Stats.maxOpenDocs.updateMax(numOpen);
   }
 
   if (!Snapshot) {
@@ -2095,8 +2097,12 @@ void SwiftLangSupport::editorOpen(StringRef Name, llvm::MemoryBuffer *Buf,
 
 void SwiftLangSupport::editorClose(StringRef Name, bool RemoveCache) {
   auto Removed = EditorDocuments.remove(Name);
-  if (!Removed)
+  if (Removed) {
+    --Stats.numOpenDocs;
+  } else {
     IFaceGenContexts.remove(Name);
+  }
+
   if (Removed && RemoveCache)
     Removed->removeCachedAST();
   // FIXME: Report error if Name did not apply to anything ?
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp b/tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp
@@ -715,6 +715,14 @@ std::string SwiftLangSupport::resolvePathSymlinks(StringRef FilePath) {
 #endif
 }
 
+void SwiftLangSupport::getStatistics(StatisticsReceiver receiver) {
+  std::vector<Statistic *> stats = {
+#define SWIFT_STATISTIC(VAR, UID, DESC) &Stats.VAR,
+#include "SwiftStatistics.def"
+  };
+  receiver(stats);
+}
+
 CloseClangModuleFiles::~CloseClangModuleFiles() {
   clang::Preprocessor &PP = loader.getClangPreprocessor();
   clang::ModuleMap &ModMap = PP.getHeaderSearchInfo().getModuleMap();
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h b/tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h
@@ -17,6 +17,7 @@
 #include "SwiftInterfaceGenContext.h"
 #include "SourceKit/Core/LangSupport.h"
 #include "SourceKit/Support/Concurrency.h"
+#include "SourceKit/Support/Statistic.h"
 #include "SourceKit/Support/ThreadSafeRefCntPtr.h"
 #include "SourceKit/Support/Tracing.h"
 #include "swift/Basic/ThreadSafeRefCounted.h"
@@ -250,6 +251,12 @@ class RequestRenameRangeConsumer : public swift::ide::FindRenameRangesConsumer,
                         const swift::DiagnosticInfo &Info) override;
 };
 
+struct SwiftStatistics {
+#define SWIFT_STATISTIC(VAR, UID, DESC)                                        \
+  Statistic VAR{UIdent{"source.statistic." #UID}, DESC};
+#include "SwiftStatistics.def"
+};
+
 class SwiftLangSupport : public LangSupport {
   SourceKit::Context &SKCtx;
   std::string RuntimeResourcePath;
@@ -260,6 +267,7 @@ class SwiftLangSupport : public LangSupport {
   ThreadSafeRefCntPtr<SwiftPopularAPI> PopularAPI;
   CodeCompletion::SessionCacheMap CCSessions;
   ThreadSafeRefCntPtr<SwiftCustomCompletions> CustomCompletions;
+  SwiftStatistics Stats;
 
 public:
   explicit SwiftLangSupport(SourceKit::Context &SKCtx);
@@ -277,6 +285,8 @@ class SwiftLangSupport : public LangSupport {
     return CCCache;
   }
 
+  SwiftStatistics &getStatistics() { return Stats; }
+
   static SourceKit::UIdent getUIDForDecl(const swift::Decl *D,
                                          bool IsRef = false);
   static SourceKit::UIdent getUIDForExtensionOfDecl(const swift::Decl *D);
@@ -492,6 +502,8 @@ class SwiftLangSupport : public LangSupport {
   void findModuleGroups(StringRef ModuleName, ArrayRef<const char *> Args,
                std::function<void(ArrayRef<StringRef>, StringRef Error)> Receiver) override;
 
+  void getStatistics(StatisticsReceiver) override;
+
 private:
   swift::SourceFile *getSyntacticSourceFile(llvm::MemoryBuffer *InputBuf,
                                             ArrayRef<const char *> Args,
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftStatistics.def b/tools/SourceKit/lib/SwiftLang/SwiftStatistics.def
@@ -0,0 +1,28 @@
+//===--- SwiftStatistics.def - ----------------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_STATISTIC
+#error "must define SWIFT_STATISTIC to use"
+#endif
+
+/// SWIFT_STATISTIC(VAR_NAME, UNIQUE_ID, DESCRIPTION)
+
+SWIFT_STATISTIC(numASTBuilds, num-ast-builds, "# of ASTs built or rebuilt")
+SWIFT_STATISTIC(numASTsInMem, num-asts-in-memory, "# of ASTs currently in memory")
+SWIFT_STATISTIC(maxASTsInMem, max-asts-in-memory, "maximum # of ASTs ever in memory at once")
+SWIFT_STATISTIC(numASTCacheHits, num-ast-cache-hits, "# of ASTs found in the cache without rebuilding")
+SWIFT_STATISTIC(numASTsUsedWithSnaphots, num-ast-snaphost-uses, "# of ASTs used with snaphots without rebuilding")
+
+SWIFT_STATISTIC(numOpenDocs, num-open-documents, "# of editor documents currently open")
+SWIFT_STATISTIC(maxOpenDocs, max-open-documents, "maximum # of editor documents ever open at once")
+
+#undef SWIFT_STATISTIC
diff --git a/tools/SourceKit/tools/sourcekitd-test/TestOptions.cpp b/tools/SourceKit/tools/sourcekitd-test/TestOptions.cpp
@@ -127,6 +127,7 @@ bool TestOptions::parseArgs(llvm::ArrayRef<const char *> Args) {
         .Case("find-usr", SourceKitRequest::FindUSR)
         .Case("find-interface", SourceKitRequest::FindInterfaceDoc)
         .Case("open", SourceKitRequest::Open)
+        .Case("close", SourceKitRequest::Close)
         .Case("edit", SourceKitRequest::Edit)
         .Case("print-annotations", SourceKitRequest::PrintAnnotations)
         .Case("print-diags", SourceKitRequest::PrintDiags)
@@ -145,6 +146,7 @@ bool TestOptions::parseArgs(llvm::ArrayRef<const char *> Args) {
         .Case("expand-default", SourceKitRequest::ExpandDefault)
         .Case("localize-string", SourceKitRequest::LocalizeString)
         .Case("markup-xml", SourceKitRequest::MarkupToXML)
+        .Case("stats", SourceKitRequest::Statistics)
         .Default(SourceKitRequest::None);
 
       if (Request == SourceKitRequest::None) {
@@ -153,8 +155,8 @@ bool TestOptions::parseArgs(llvm::ArrayRef<const char *> Args) {
                "complete.update/complete.cache.ondisk/complete.cache.setpopularapi/"
                "cursor/related-idents/syntax-map/structure/format/expand-placeholder/"
                "doc-info/sema/interface-gen/interface-gen-openfind-usr/find-interface/"
-               "open/edit/print-annotations/print-diags/extract-comment/module-groups/"
-               "range/syntactic-rename/find-rename-ranges/translate/markup-xml\n";
+               "open/close/edit/print-annotations/print-diags/extract-comment/module-groups/"
+               "range/syntactic-rename/find-rename-ranges/translate/markup-xml/stats\n";
         return true;
       }
       break;
diff --git a/tools/SourceKit/tools/sourcekitd-test/TestOptions.h b/tools/SourceKit/tools/sourcekitd-test/TestOptions.h
diff --git a/tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp b/tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp
diff --git a/tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp b/tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp
