Merge pull request #37450 from ahoppen/pr/count-instructions-for-completion-request

[SourceKit] Report number of instructions executed since SourceKit was started in statistics request

Author: ahoppen

include/swift/Basic/Statistic.h

@@ -70,6 +70,10 @@ class Stmt;
 class TypeRepr;
 struct FingerprintAndMembers;
 
+/// Get the number of instructions executed since this process was launched.
+/// Returns 0 if the number of instructions executed could not be determined.
+uint64_t getInstructionsExecuted();
+
 // There are a handful of cases where the swift compiler can introduce
 // counter-measurement noise via nondeterminism, especially via
 // parallelism; inhibiting all such cases reliably using existing avenues

lib/Basic/Statistic.cpp

@@ -10,19 +10,17 @@
 //
 //===----------------------------------------------------------------------===//
 
-#include "clang/AST/Decl.h"
+#include "swift/Basic/Statistic.h"
+#include "swift/Config.h"
 #include "clang/Basic/SourceLocation.h"
 #include "clang/Basic/SourceManager.h"
-#include "swift/Basic/Statistic.h"
-#include "swift/AST/Decl.h"
-#include "swift/AST/Expr.h"
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/Config/config.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/Process.h"
-#include "llvm/Support/raw_ostream.h"
 #include "llvm/Support/SaveAndRestore.h"
+#include "llvm/Support/raw_ostream.h"
 #include <chrono>
 #include <limits>
 
@@ -59,6 +57,16 @@ bool environmentVariableRequestedMaximumDeterminism() {
   return false;
 }
 
+uint64_t getInstructionsExecuted() {
+#if defined(HAVE_PROC_PID_RUSAGE) && defined(RUSAGE_INFO_V4)
+  struct rusage_info_v4 ru;
+  if (proc_pid_rusage(getpid(), RUSAGE_INFO_V4, (rusage_info_t *)&ru) == 0) {
+    return ru.ri_instructions;
+  }
+#endif
+  return 0;
+}
+
 static std::string
 makeFileName(StringRef Prefix,
              StringRef ProgramName,
@@ -510,12 +518,9 @@ FrontendStatsTracer::~FrontendStatsTracer()
 // associated fields in the provided AlwaysOnFrontendCounters.
 void updateProcessWideFrontendCounters(
     UnifiedStatsReporter::AlwaysOnFrontendCounters &C) {
-#if defined(HAVE_PROC_PID_RUSAGE) && defined(RUSAGE_INFO_V4)
-  struct rusage_info_v4 ru;
-  if (0 == proc_pid_rusage(getpid(), RUSAGE_INFO_V4, (rusage_info_t *)&ru)) {
-    C.NumInstructionsExecuted = ru.ri_instructions;
+  if (auto instrExecuted = getInstructionsExecuted()) {
+    C.NumInstructionsExecuted = instrExecuted;
   }
-#endif
 
 #if defined(HAVE_MALLOC_ZONE_STATISTICS) && defined(HAVE_MALLOC_MALLOC_H)
   // On Darwin we have a lifetime max that's maintained by malloc we can

test/SourceKit/Misc/stats.swift

@@ -2,6 +2,7 @@ func foo() {}
 
 // RUN: %sourcekitd-test -req=syntax-map %s == -req=stats | %FileCheck %s -check-prefix=SYNTAX_1
 
+// SYNTAX_1:   {{.*}} source.statistic.instruction-count
 // SYNTAX_1: 2 {{.*}} source.statistic.num-requests
 // SYNTAX_1: 0 {{.*}} source.statistic.num-semantic-requests
 // SYNTAX_1: 0 {{.*}} source.statistic.num-ast-builds

tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp

@@ -29,6 +29,7 @@
 
 #include "swift/Basic/ExponentialGrowthAppendingBinaryByteStream.h"
 #include "swift/Basic/Mangler.h"
+#include "swift/Basic/Statistic.h"
 #include "swift/Basic/Version.h"
 #include "swift/Demangling/Demangler.h"
 #include "swift/Demangling/ManglingMacros.h"
@@ -918,6 +919,11 @@ void handleRequestImpl(sourcekitd_object_t ReqObj, ResponseReceiver Rec) {
         dict.set(KeyValue, stat->value);
       };
 
+      Statistic instructionCount(
+          UIdentFromSKDUID(KindStatInstructionCount),
+          "# of instructions executed since the SourceKit process was started");
+      instructionCount.value.store(swift::getInstructionsExecuted());
+      addStat(&instructionCount);
       addStat(&numRequests);
       addStat(&numSemaRequests);
       std::for_each(stats.begin(), stats.end(), addStat);

utils/gyb_sourcekit_support/UIDs.py

@@ -178,7 +178,7 @@ def __init__(self, internal_name, external_name):
     KEY('ExpressionLength', 'key.expression_length'),
     KEY('ExpressionType', 'key.expression_type'),
     KEY('CanonicalizeType', 'key.canonicalize_type'),
-    KEY('InternalDiagnostic', "key.internal_diagnostic"),
+    KEY('InternalDiagnostic', 'key.internal_diagnostic'),
     KEY('VFSName', 'key.vfs.name'),
     KEY('VFSOptions', 'key.vfs.options'),
     KEY('Files', 'key.files'),
@@ -457,6 +457,7 @@ def __init__(self, internal_name, external_name):
     KIND('Unknown', 'source.syntacticrename.unknown'),
     KIND('StatNumRequests', 'source.statistic.num-requests'),
     KIND('StatNumSemaRequests', 'source.statistic.num-semantic-requests'),
+    KIND('StatInstructionCount', 'source.statistic.instruction-count'),
     KIND('SyntaxTreeOff', 'source.syntaxtree.transfer.off'),
     KIND('SyntaxTreeFull', 'source.syntaxtree.transfer.full'),
     KIND('Swift', 'source.lang.swift'),