Merge pull request #62353 from xymus/dont-index-local-system-modules

[Index] Only index system modules in the SDK, not local ones

Author: xymus

include/swift/AST/Module.h

@@ -859,6 +859,10 @@ class ModuleDecl
   /// applicable.
   StringRef getModuleLoadedFilename() const;
 
+  /// \returns true if this module is defined under the SDK path.
+  /// If no SDK path is defined, this always returns false.
+  bool isSDKModule() const;
+
   /// \returns true if this module is the "swift" standard library module.
   bool isStdlibModule() const;
 

lib/AST/Module.cpp

@@ -1996,6 +1996,23 @@ StringRef ModuleDecl::getModuleLoadedFilename() const {
   return StringRef();
 }
 
+bool ModuleDecl::isSDKModule() const {
+  auto sdkPath = getASTContext().SearchPathOpts.getSDKPath();
+  if (sdkPath.empty())
+    return false;
+
+  auto modulePath = getModuleSourceFilename();
+  auto si = llvm::sys::path::begin(sdkPath),
+       se = llvm::sys::path::end(sdkPath);
+  for (auto mi = llvm::sys::path::begin(modulePath),
+       me = llvm::sys::path::end(modulePath);
+       si != se && mi != me; ++si, ++mi) {
+    if (*si != *mi)
+      return false;
+  }
+  return si == se;
+}
+
 bool ModuleDecl::isStdlibModule() const {
   return !getParent() && getName() == getASTContext().StdlibModuleName;
 }

lib/Index/IndexRecord.cpp

@@ -447,11 +447,13 @@ static void addModuleDependencies(ArrayRef<ImportedModule> imports,
             }
           } else {
             // Serialized AST file.
-            // Only index system modules (essentially stdlib and overlays).
+            // Only index distributed system modules, and the stdlib.
             // We don't officially support binary swift modules, so normally
             // the index data for user modules would get generated while
             // building them.
+            bool isDistributedModule = mod->isSDKModule();
             if (mod->isSystemModule() && indexSystemModules &&
+                (isDistributedModule || mod->isStdlibModule()) &&
                 (!skipStdlib || !mod->isStdlibModule())) {
               emitDataForSwiftSerializedModule(mod, indexStorePath,
                                                indexClangModules,

test/Index/Store/cross-import-overlay.swift

@@ -3,7 +3,7 @@
 // RUN: cp -r %S/../Inputs/CrossImport %t/CrossImport
 // RUN: %{python} %S/../../CrossImport/Inputs/rewrite-module-triples.py %t/CrossImport %module-target-triple
 
-// RUN: %target-swift-frontend -disable-implicit-concurrency-module-import -disable-implicit-string-processing-module-import -c -index-store-path %t/idx -module-cache-path %t/mcp -index-system-modules -index-ignore-stdlib -enable-cross-import-overlays %s -Fsystem %t/CrossImport -o %t/file1.o -module-name cross_import_overlay
+// RUN: %target-swift-frontend -disable-implicit-concurrency-module-import -disable-implicit-string-processing-module-import -c -index-store-path %t/idx -module-cache-path %t/mcp -index-system-modules -index-ignore-stdlib -enable-cross-import-overlays %s -Fsystem %t/CrossImport -o %t/file1.o -module-name cross_import_overlay -sdk %t
 // RUN: c-index-test core -print-unit %t/idx > %t/units
 
 import A

test/Index/index_only_sdk_system_modules.swift

@@ -0,0 +1,60 @@
+// RUN: %empty-directory(%t)
+// RUN: %empty-directory(%t/cache)
+// RUN: %empty-directory(%t/idx)
+// RUN: %empty-directory(%t/sdk)
+// RUN: split-file %s %t
+
+/// Create a Swift module to import.
+// RUN: cp %t/module.modulemap %t/sdk/
+// RUN: %target-swift-frontend -emit-module \
+// RUN:   -enable-library-evolution -swift-version 5 \
+// RUN:   -emit-module-path %t/sdk/LocalSystemModule.swiftmodule \
+// RUN:   -emit-module-interface-path %t/sdk/LocalSystemModule.swiftinterface \
+// RUN:   %t/LocalSystemModule.swift -I %t/sdk \
+// RUN:   -enable-testing
+
+/// Build a test client once with indexing, not setting an SDK.
+// RUN: %target-swift-frontend -typecheck %t/TestClient.swift \
+// RUN:   -I %t/sdk -module-cache-path %t/cache \
+// RUN:   -index-system-modules \
+// RUN:   -index-store-path %t/idx \
+// RUN:   -index-ignore-stdlib \
+// RUN:   -sdk %t/someothersdk -Rmodule-loading 2>&1 \
+// RUN:   | %FileCheck -check-prefix=CHECK-SWIFTMODULE %s
+// CHECK-SWIFTMODULE: source: '{{.*}}LocalSystemModule.swiftmodule'
+
+/// Build the test client again not setting an SDK, this one should still use
+/// the adjacent module that is built for testing.
+// RUN: %target-swift-frontend -typecheck %t/TestClient.swift \
+// RUN:   -I %t/sdk -module-cache-path %t/cache \
+// RUN:   -sdk %t/someothersdk -Rmodule-loading 2>&1 \
+// RUN:   | %FileCheck -check-prefix=CHECK-SWIFTMODULE %s
+
+/// @testable import of a module in the SDK works once but not after it's cached.
+// RUN: %empty-directory(%t/idx)
+// RUN: %target-swift-frontend -typecheck %t/TestClient.swift \
+// RUN:   -I %t/sdk -module-cache-path %t/cache \
+// RUN:   -index-system-modules \
+// RUN:   -index-store-path %t/idx \
+// RUN:   -index-ignore-stdlib \
+// RUN:   -sdk %t/sdk -Rmodule-loading 2>&1 \
+// RUN:   | %FileCheck -check-prefix=CHECK-SWIFTMODULE %s
+
+/// Failing case when building against the cached swiftmodule.
+// RUN: %target-swift-frontend -typecheck %t/TestClient.swift \
+// RUN:   -I %t/sdk -module-cache-path %t/cache \
+// RUN:   -sdk %t/sdk -Rmodule-loading \
+// RUN:   -verify -verify-ignore-unknown -show-diagnostics-after-fatal 2>&1
+
+//--- module.modulemap
+
+module LocalSystemModule [system] { }
+
+//--- LocalSystemModule.swift
+
+@_exported import LocalSystemModule
+
+//--- TestClient.swift
+
+@testable import LocalSystemModule // expected-error {{module 'LocalSystemModule' was not compiled for testing}}
+// expected-remark @-1 {{LocalSystemModule.swiftinterface}}