[SourceKit] Stop using isSystemModule to represent "non-user" modules

Rather than using `ModuleDecl::isSystemModule()` to determine whether a
module is not a user module, instead check whether the module was
defined adjacent to the compiler or if it's part of the SDK.

If no SDK path was given, then `isSystemModule` is still used as a
fallback.

Resolves rdar://89253201.

Author: bnbarham

include/swift/AST/Decl.h

@@ -630,7 +630,7 @@ class alignas(1 << DeclAlignInBits) Decl : public ASTAllocated<Decl> {
     HasAnyUnavailableValues : 1
   );
 
-  SWIFT_INLINE_BITFIELD(ModuleDecl, TypeDecl, 1+1+1+1+1+1+1+1+1+1+1+1+1+1+1,
+  SWIFT_INLINE_BITFIELD(ModuleDecl, TypeDecl, 1+1+1+1+1+1+1+1+1+1+1+1+1+1+1+1,
     /// If the module is compiled as static library.
     StaticLibrary : 1,
 
@@ -680,7 +680,11 @@ class alignas(1 << DeclAlignInBits) Decl : public ASTAllocated<Decl> {
 
     /// If the map from @objc provided name to top level swift::Decl in this
     /// module is populated
-    ObjCNameLookupCachePopulated : 1
+    ObjCNameLookupCachePopulated : 1,
+
+    /// Whether the module is contained in the SDK or stdlib, or its a system
+    /// module and no SDK was specified.
+    IsNonUserModule : 1
   );
 
   SWIFT_INLINE_BITFIELD(PrecedenceGroupDecl, Decl, 1+2,

include/swift/AST/Module.h

@@ -630,10 +630,20 @@ class ModuleDecl
   bool isSystemModule() const {
     return Bits.ModuleDecl.IsSystemModule;
   }
-  void setIsSystemModule(bool flag = true) {
-    Bits.ModuleDecl.IsSystemModule = flag;
-  }
+  void setIsSystemModule(bool flag = true);
+
+  /// \returns true if this module is part of the stdlib or contained within
+  /// the SDK. If no SDK was specified, also falls back to whether the module
+  /// was specified as a system module (ie. it's on the system search path).
+  bool isNonUserModule() const { return Bits.ModuleDecl.IsNonUserModule; }
+
+private:
+  /// Update whether this module is a non-user module, see \c isNonUserModule.
+  /// \p newUnit is the added unit that caused this update, or \c nullptr if
+  /// the update wasn't caused by adding a new unit.
+  void updateNonUserModule(FileUnit *newUnit);
 
+public:
   /// Returns true if the module was rebuilt from a module interface instead
   /// of being built from the full source.
   bool isBuiltFromInterface() const {
@@ -946,10 +956,6 @@ 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;
 
@@ -1074,6 +1080,7 @@ class ModuleEntity {
   std::string getFullName(bool useRealNameIfAliased = false) const;
 
   bool isSystemModule() const;
+  bool isNonUserModule() const;
   bool isBuiltinModule() const;
   const ModuleDecl *getAsSwiftModule() const;
   const clang::Module *getAsClangModule() const;

lib/AST/ASTPrinter.cpp

@@ -5730,8 +5730,7 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
     // Don't print qualifiers for types from the standard library.
     if (M->isStdlibModule() ||
         M->getRealName() == M->getASTContext().Id_ObjectiveC ||
-        M->isSystemModule() ||
-        isLLDBExpressionModule(M))
+        M->isNonUserModule() || isLLDBExpressionModule(M))
       return false;
 
     // Don't print qualifiers for imported types.

lib/AST/Module.cpp

@@ -611,6 +611,49 @@ ModuleDecl::ModuleDecl(Identifier name, ASTContext &ctx,
   Bits.ModuleDecl.HasHermeticSealAtLink = 0;
   Bits.ModuleDecl.IsConcurrencyChecked = 0;
   Bits.ModuleDecl.ObjCNameLookupCachePopulated = 0;
+  Bits.ModuleDecl.IsNonUserModule = 0;
+}
+
+void ModuleDecl::setIsSystemModule(bool flag) {
+  Bits.ModuleDecl.IsSystemModule = flag;
+  updateNonUserModule(/*newFile=*/nullptr);
+}
+
+static bool prefixMatches(StringRef prefix, StringRef path) {
+  auto i = llvm::sys::path::begin(prefix), e = llvm::sys::path::end(prefix);
+  for (auto pi = llvm::sys::path::begin(path), pe = llvm::sys::path::end(path);
+       i != e && pi != pe; ++i, ++pi) {
+    if (*i != *pi)
+      return false;
+  }
+  return i == e;
+}
+
+void ModuleDecl::updateNonUserModule(FileUnit *newUnit) {
+  if (isNonUserModule())
+    return;
+
+  SearchPathOptions searchPathOpts = getASTContext().SearchPathOpts;
+  StringRef sdkPath = searchPathOpts.getSDKPath();
+
+  if (isStdlibModule() || (sdkPath.empty() && isSystemModule())) {
+    Bits.ModuleDecl.IsNonUserModule = true;
+    return;
+  }
+
+  // If we loaded a serialized module, check if it was compiler adjacent or in
+  // the SDK.
+
+  auto *LF = dyn_cast_or_null<LoadedFile>(newUnit);
+  if (!LF)
+    return;
+
+  StringRef runtimePath = searchPathOpts.RuntimeResourcePath;
+  StringRef modulePath = LF->getSourceFilename();
+  if ((!runtimePath.empty() && prefixMatches(runtimePath, modulePath)) ||
+      (!sdkPath.empty() && prefixMatches(sdkPath, modulePath))) {
+    Bits.ModuleDecl.IsNonUserModule = true;
+  }
 }
 
 ImplicitImportList ModuleDecl::getImplicitImports() const {
@@ -632,6 +675,8 @@ void ModuleDecl::addFile(FileUnit &newFile) {
          cast<SourceFile>(newFile).Kind == SourceFileKind::SIL);
   Files.push_back(&newFile);
   clearLookupCache();
+
+  updateNonUserModule(&newFile);
 }
 
 void ModuleDecl::addAuxiliaryFile(SourceFile &sourceFile) {
@@ -2284,23 +2329,6 @@ 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;
 }
@@ -4066,6 +4094,14 @@ bool ModuleEntity::isSystemModule() const {
   return getClangModule(Mod)->IsSystem;
 }
 
+bool ModuleEntity::isNonUserModule() const {
+  assert(!Mod.isNull());
+  if (auto *SwiftMod = Mod.dyn_cast<const ModuleDecl *>())
+    return SwiftMod->isNonUserModule();
+  // TODO: Should handle clang modules as well
+  return getClangModule(Mod)->IsSystem;
+}
+
 bool ModuleEntity::isBuiltinModule() const {
   assert(!Mod.isNull());
   if (auto SwiftMod = Mod.dyn_cast<const ModuleDecl*>())

lib/IDE/CodeCompletionResult.cpp

@@ -293,7 +293,7 @@ ContextFreeCodeCompletionResult::getCodeCompletionDeclKind(const Decl *D) {
 }
 
 bool ContextFreeCodeCompletionResult::getDeclIsSystem(const Decl *D) {
-  return D->getModuleContext()->isSystemModule();
+  return D->getModuleContext()->isNonUserModule();
 }
 
 // MARK: - CodeCompletionResult

lib/IDE/CodeCompletionStringPrinter.cpp

@@ -131,7 +131,7 @@ void CodeCompletionStringPrinter::printTypeRef(Type T, const TypeDecl *TD,
                                                Identifier Name,
                                                PrintNameContext NameContext) {
 
-  NextChunkKind = TD->getModuleContext()->isSystemModule()
+  NextChunkKind = TD->getModuleContext()->isNonUserModule()
                       ? ChunkKind::TypeIdSystem
                       : ChunkKind::TypeIdUser;
 

lib/Index/Index.cpp

@@ -1073,7 +1073,7 @@ class IndexSwiftASTWalker : public SourceEntityWalker {
 
 void IndexSwiftASTWalker::visitDeclContext(DeclContext *Context) {
   IsModuleFile = false;
-  isSystemModule = Context->getParentModule()->isSystemModule();
+  isSystemModule = Context->getParentModule()->isNonUserModule();
   auto accessor = dyn_cast<AccessorDecl>(Context);
   if (accessor)
     ManuallyVisitedAccessorStack.push_back(accessor);
@@ -1101,7 +1101,7 @@ void IndexSwiftASTWalker::visitModule(ModuleDecl &Mod) {
     walk(*SrcFile);
   } else {
     IsModuleFile = true;
-    isSystemModule = Mod.isSystemModule();
+    isSystemModule = Mod.isNonUserModule();
     if (!handleSourceOrModuleFile(Mod))
       return;
     walk(Mod);
@@ -1178,7 +1178,7 @@ bool IndexSwiftASTWalker::visitImports(
       ModuleName = Declaring->getNameStr();
 
     if (!IdxConsumer.startDependency(ModuleName, Path, IsClangModule,
-                                     Mod->isSystemModule()))
+                                     Mod->isNonUserModule()))
       return false;
     if (!IsClangModule)
       if (!visitImports(*Mod, Visited))

lib/Index/IndexRecord.cpp

@@ -640,8 +640,9 @@ static void addModuleDependencies(ArrayRef<ImportedModule> imports,
         bool withoutUnitName = true;
         if (FU->getKind() == FileUnitKind::ClangModule) {
           auto clangModUnit = cast<ClangModuleUnit>(LFU);
-          bool shouldIndexModule = indexClangModules &&
-              (!clangModUnit->isSystemModule() || indexSystemModules);
+          bool shouldIndexModule =
+              indexClangModules &&
+              (!mod->isNonUserModule() || indexSystemModules);
           withoutUnitName = !shouldIndexModule;
           if (auto clangMod = clangModUnit->getUnderlyingClangModule()) {
             moduleName = clangMod->getTopLevelModuleName();
@@ -662,10 +663,7 @@ static void addModuleDependencies(ArrayRef<ImportedModule> imports,
           // 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() ||
-                    mod->getASTContext().SearchPathOpts.getSDKPath().empty();
-          if (mod->isSystemModule() && indexSystemModules &&
-              (isDistributedModule || mod->isStdlibModule()) &&
+          if (mod->isNonUserModule() && indexSystemModules &&
               (!skipStdlib || !mod->isStdlibModule())) {
             emitDataForSwiftSerializedModule(mod, indexStorePath,
                                              indexClangModules,
@@ -697,7 +695,7 @@ static void addModuleDependencies(ArrayRef<ImportedModule> imports,
         }
         clang::index::writer::OpaqueModule opaqMod =
             moduleNameScratch.createString(moduleName);
-        unitWriter.addASTFileDependency(*F, mod->isSystemModule(), opaqMod,
+        unitWriter.addASTFileDependency(*F, mod->isNonUserModule(), opaqMod,
                                         withoutUnitName);
 
         break;
@@ -833,7 +831,7 @@ emitDataForSwiftSerializedModule(ModuleDecl *module,
   }
 
   auto &fileMgr = clangCI.getFileManager();
-  bool isSystem = module->isSystemModule();
+  bool isSystem = module->isNonUserModule();
   // FIXME: Get real values for the following.
   StringRef swiftVersion;
   StringRef sysrootPath = clangCI.getHeaderSearchOpts().Sysroot;
@@ -848,14 +846,13 @@ emitDataForSwiftSerializedModule(ModuleDecl *module,
       targetTriple, sysrootPath, clangRemapper, getModuleInfoFromOpaqueModule);
 
   auto FE = fileMgr.getFile(filename);
-  bool isSystemModule = module->isSystemModule();
   for (auto &pair : records) {
     std::string &recordFile = pair.first;
     std::string &groupName = pair.second;
     if (recordFile.empty())
       continue;
     clang::index::writer::OpaqueModule mod = &groupName;
-    unitWriter.addRecordFile(recordFile, *FE, isSystemModule, mod);
+    unitWriter.addRecordFile(recordFile, *FE, isSystem, mod);
   }
 
   SmallVector<ImportedModule, 8> imports;
@@ -887,7 +884,7 @@ recordSourceFileUnit(SourceFile *primarySourceFile, StringRef indexUnitToken,
                      DiagnosticEngine &diags) {
   auto &fileMgr = clangCI.getFileManager();
   auto *module = primarySourceFile->getParentModule();
-  bool isSystem = module->isSystemModule();
+  bool isSystem = module->isNonUserModule();
   auto mainFile = fileMgr.getFile(primarySourceFile->getFilename());
   auto clangRemapper = pathRemapper.asClangPathRemapper();
   // FIXME: Get real values for the following.
@@ -920,7 +917,7 @@ recordSourceFileUnit(SourceFile *primarySourceFile, StringRef indexUnitToken,
                      auto file = fileMgr.getFile(filename);
                      unitWriter.addRecordFile(
                          recordFile, file ? *file : nullptr,
-                         module->isSystemModule(), /*Module=*/nullptr);
+                         module->isNonUserModule(), /*Module=*/nullptr);
                    });
 
   std::string error;

lib/Refactoring/Refactoring.cpp

@@ -611,15 +611,15 @@ class TextReplacementsRenamer : public Renamer {
 };
 
 static const ValueDecl *getRelatedSystemDecl(const ValueDecl *VD) {
-  if (VD->getModuleContext()->isSystemModule())
+  if (VD->getModuleContext()->isNonUserModule())
     return VD;
   for (auto *Req : VD->getSatisfiedProtocolRequirements()) {
-    if (Req->getModuleContext()->isSystemModule())
+    if (Req->getModuleContext()->isNonUserModule())
       return Req;
   }
   for (auto Over = VD->getOverriddenDecl(); Over;
        Over = Over->getOverriddenDecl()) {
-    if (Over->getModuleContext()->isSystemModule())
+    if (Over->getModuleContext()->isNonUserModule())
       return Over;
   }
   return nullptr;

test/Index/Store/ignore-system-clang-modules.swift

@@ -2,18 +2,18 @@
 
 // Make a basic clang framework to import
 //
-// RUN: %empty-directory(%t/MySystemFramework.framework/Headers)
-// RUN: %empty-directory(%t/MySystemFramework.framework/Modules)
-// RUN: echo 'void someSystemFunc(int arg);' > %t/MySystemFramework.framework/Headers/MySystemFramework.h
-// RUN: echo 'framework module MySystemFramework { umbrella header "MySystemFramework.h" export * }' > %t/MySystemFramework.framework/Modules/module.modulemap
+// RUN: %empty-directory(%t/sdk/MySystemFramework.framework/Headers)
+// RUN: %empty-directory(%t/sdk/MySystemFramework.framework/Modules)
+// RUN: echo 'void someSystemFunc(int arg);' > %t/sdk/MySystemFramework.framework/Headers/MySystemFramework.h
+// RUN: echo 'framework module MySystemFramework { umbrella header "MySystemFramework.h" export * }' > %t/sdk/MySystemFramework.framework/Modules/module.modulemap
 
 import MySystemFramework
 someSystemFunc(2)
 
 // Index this file with and without ignoring system frameworks
 //
-// RUN: %target-swiftc_driver -index-store-path %t/idx1 -o %t/file.o -Fsystem %t -typecheck %s
-// RUN: %target-swiftc_driver -index-store-path %t/idx2 -o %t/file.o -index-ignore-system-modules -Fsystem %t -typecheck %s
+// RUN: %target-swiftc_driver -index-store-path %t/idx1 -o %t/file.o -Fsystem %t/sdk -sdk %t/sdk -typecheck %s
+// RUN: %target-swiftc_driver -index-store-path %t/idx2 -o %t/file.o -index-ignore-system-modules -Fsystem %t/sdk -sdk %t/sdk -typecheck %s
 // RUN: c-index-test core -print-unit %t/idx1 | %FileCheck --check-prefixes=ALLOWSYSTEM,BOTH %s
 // RUN: c-index-test core -print-unit %t/idx2 | %FileCheck --check-prefixes=IGNORESYSTEM,BOTH %s