[SourceKit] Add a request kind to notify dependencies are updated

Author: rintaro

include/swift/IDE/CompletionInstance.h

@@ -49,6 +49,7 @@ class CompletionInstance {
   llvm::sys::TimePoint<> DependencyCheckedTimestamp;
   llvm::StringMap<llvm::hash_code> InMemoryDependencyHash;
   unsigned CachedReuseCount = 0;
+  std::atomic<bool> CachedCIShouldBeInvalidated;
 
   void cacheCompilerInstance(std::unique_ptr<CompilerInstance> CI,
                              llvm::hash_code ArgsHash);
@@ -80,8 +81,13 @@ class CompletionInstance {
       llvm::function_ref<void(CompilerInstance &, bool)> Callback);
 
 public:
-  CompletionInstance() {}
+  CompletionInstance() : CachedCIShouldBeInvalidated(false) {}
 
+  // Mark the cached compiler instance "should be invalidated". In the next
+  // completion, new compiler instance will be used. (Thread safe.)
+  void markCachedCompilerInstanceShouldBeInvalidated();
+
+  // Update options with \c NewOpts. (Thread safe.)
   void setOptions(Options NewOpts);
 
   /// Calls \p Callback with a \c CompilerInstance which is prepared for the

lib/IDE/CompletionInstance.cpp

@@ -288,6 +288,10 @@ bool CompletionInstance::performCachedOperationIfPossible(
   llvm::PrettyStackTraceString trace(
       "While performing cached completion if possible");
 
+  // Check the invalidation first. Otherwise, in case no 'CacheCI' exists yet,
+  // the flag will remain 'true' even after 'CachedCI' is populated.
+  if (CachedCIShouldBeInvalidated.exchange(false))
+    return false;
   if (!CachedCI)
     return false;
   if (CachedReuseCount >= Opts.MaxASTReuseCount)
@@ -586,6 +590,10 @@ bool CompletionInstance::shouldCheckDependencies() const {
   return threshold <= now;
 }
 
+void CompletionInstance::markCachedCompilerInstanceShouldBeInvalidated() {
+  CachedCIShouldBeInvalidated = true;
+}
+
 void CompletionInstance::setOptions(CompletionInstance::Options NewOpts) {
   std::lock_guard<std::mutex> lock(mtx);
   Opts = NewOpts;

test/SourceKit/CodeComplete/complete_checkdeps_notifyupdate.swift

@@ -0,0 +1,69 @@
+import ClangFW
+import SwiftFW
+
+func foo() {
+  /*HERE*/
+}
+
+// REQUIRES: shell
+
+// RUN: %empty-directory(%t/Frameworks)
+// RUN: %empty-directory(%t/MyProject)
+
+// RUN: COMPILER_ARGS=( \
+// RUN:   -target %target-triple \
+// RUN:   -module-name MyProject \
+// RUN:   -F %t/Frameworks \
+// RUN:   -I %t/MyProject \
+// RUN:   -import-objc-header %t/MyProject/Bridging.h \
+// RUN:   %t/MyProject/Library.swift \
+// RUN:   %s \
+// RUN: )
+// RUN: INPUT_DIR=%S/Inputs/checkdeps
+
+// RUN: cp -R $INPUT_DIR/MyProject %t/
+// RUN: cp -R $INPUT_DIR/ClangFW.framework %t/Frameworks/
+// RUN: %empty-directory(%t/Frameworks/SwiftFW.framework/Modules/SwiftFW.swiftmodule)
+// RUN: %target-swift-frontend -emit-module -module-name SwiftFW -o %t/Frameworks/SwiftFW.framework/Modules/SwiftFW.swiftmodule/%target-swiftmodule-name $INPUT_DIR/SwiftFW_src/Funcs.swift
+
+// RUN: %sourcekitd-test \
+// RUN:   -shell -- echo "### Initial" == \
+// RUN:   -req=complete -pos=5:3 %s -- ${COMPILER_ARGS[@]} == \
+
+// RUN:   -shell -- echo '### Modify framework' == \
+// RUN:   -shell -- %target-swift-frontend -emit-module -module-name SwiftFW -o %t/Frameworks/SwiftFW.framework/Modules/SwiftFW.swiftmodule/%target-swiftmodule-name $INPUT_DIR/SwiftFW_src_mod/Funcs.swift == \
+// RUN:   -req=dependency-updated -- ${COMPILER_ARGS[@]} == \
+// RUN:   -req=complete -pos=5:3 %s -- ${COMPILER_ARGS[@]} == \
+
+// RUN:   -shell -- echo '### Notify without modifying' == \
+// RUN:   -req=dependency-updated -- ${COMPILER_ARGS[@]} == \
+// RUN:   -req=complete -pos=5:3 %s -- ${COMPILER_ARGS[@]} \
+
+// RUN:   | %FileCheck %s
+
+// CHECK-LABEL: ### Initial
+// CHECK: key.results: [
+// CHECK-DAG: key.description: "clangFWFunc()"
+// CHECK-DAG: key.description: "swiftFWFunc()"
+// CHECK-DAG: key.description: "localClangFunc()"
+// CHECK-DAG: key.description: "localSwiftFunc()"
+// CHECK: ]
+// CHECK-NOT: key.reusingastcontext: 1
+
+// CHECK-LABEL: ### Modify framework
+// CHECK: key.results: [
+// CHECK-DAG: key.description: "clangFWFunc()"
+// CHECK-DAG: key.description: "swiftFWFunc_mod()"
+// CHECK-DAG: key.description: "localClangFunc()"
+// CHECK-DAG: key.description: "localSwiftFunc()"
+// CHECK: ]
+// CHECK-NOT: key.reusingastcontext: 1
+
+// CHECK-LABEL: ### Notify without modifying
+// CHECK: key.results: [
+// CHECK-DAG: key.description: "clangFWFunc()"
+// CHECK-DAG: key.description: "swiftFWFunc_mod()"
+// CHECK-DAG: key.description: "localClangFunc()"
+// CHECK-DAG: key.description: "localSwiftFunc()"
+// CHECK: ]
+// CHECK-NOT: key.reusingastcontext: 1

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -659,6 +659,8 @@ class LangSupport {
 
   virtual void globalConfigurationUpdated(std::shared_ptr<GlobalConfig> Config) {};
 
+  virtual void dependencyUpdated() {}
+
   virtual void indexSource(StringRef Filename,
                            IndexingConsumer &Consumer,
                            ArrayRef<const char *> Args) = 0;

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp

@@ -303,6 +303,10 @@ void SwiftLangSupport::globalConfigurationUpdated(
   configureCompletionInstance(CompletionInst, Config);
 }
 
+void SwiftLangSupport::dependencyUpdated() {
+  CompletionInst->markCachedCompilerInstanceShouldBeInvalidated();
+}
+
 UIdent SwiftLangSupport::getUIDForDecl(const Decl *D, bool IsRef) {
   return UIdentVisitor(IsRef).visit(const_cast<Decl*>(D));
 }

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h

@@ -474,6 +474,8 @@ class SwiftLangSupport : public LangSupport {
 
   void globalConfigurationUpdated(std::shared_ptr<GlobalConfig> Config) override;
 
+  void dependencyUpdated() override;
+
   void indexSource(StringRef Filename, IndexingConsumer &Consumer,
                    ArrayRef<const char *> Args) override;
 

tools/SourceKit/tools/sourcekitd-test/TestOptions.cpp

@@ -155,6 +155,7 @@ bool TestOptions::parseArgs(llvm::ArrayRef<const char *> Args) {
         .Case("track-compiles", SourceKitRequest::EnableCompileNotifications)
         .Case("collect-type", SourceKitRequest::CollectExpresstionType)
         .Case("global-config", SourceKitRequest::GlobalConfiguration)
+        .Case("dependency-updated", SourceKitRequest::DependencyUpdated)
         .Default(SourceKitRequest::None);
 
       if (Request == SourceKitRequest::None) {

tools/SourceKit/tools/sourcekitd-test/TestOptions.h

@@ -65,6 +65,7 @@ enum class SourceKitRequest {
   EnableCompileNotifications,
   CollectExpresstionType,
   GlobalConfiguration,
+  DependencyUpdated,
 #define SEMANTIC_REFACTORING(KIND, NAME, ID) KIND,
 #include "swift/IDE/RefactoringKinds.def"
 };

tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp

@@ -1025,6 +1025,11 @@ static int handleTestInvocation(TestOptions Opts, TestOptions &InitOpts) {
   case SourceKitRequest::Statistics:
     sourcekitd_request_dictionary_set_uid(Req, KeyRequest, RequestStatistics);
     break;
+
+  case SourceKitRequest::DependencyUpdated:
+    sourcekitd_request_dictionary_set_uid(Req, KeyRequest,
+                                          RequestDependencyUpdated);
+    break;
   }
 
   if (!SourceFile.empty()) {
@@ -1223,6 +1228,7 @@ static bool handleResponse(sourcekitd_response_t Resp, const TestOptions &Opts,
     case SourceKitRequest::CodeCompleteSetPopularAPI:
     case SourceKitRequest::TypeContextInfo:
     case SourceKitRequest::ConformingMethodList:
+    case SourceKitRequest::DependencyUpdated:
       sourcekitd_response_description_dump_filedesc(Resp, STDOUT_FILENO);
       break;
 

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

@@ -574,6 +574,11 @@ void handleRequestImpl(sourcekitd_object_t ReqObj, ResponseReceiver Rec) {
     return Rec(ResponseBuilder().createResponse());
   }
 
+  if (ReqUID == RequestDependencyUpdated) {
+    getGlobalContext().getSwiftLangSupport().dependencyUpdated();
+    return Rec(ResponseBuilder().createResponse());
+  }
+
   Optional<StringRef> SourceFile = Req.getString(KeySourceFile);
   Optional<StringRef> SourceText = Req.getString(KeySourceText);