Allow loading package interface if in same package.

elsh · elsh · commit e5ca8e5c0b24 · 2023-11-09T18:44:06.000-08:00
Add a new flag to enable package interface loading.
Use the last value of package-name in case of dupes.
Rename PrintInterfaceContentMode as InterfaceMode.
Update diagnostics.
Test package interface loading with various scenarios.
Test duplicate package-name.
diff --git a/include/swift/AST/DiagnosticsSema.def b/include/swift/AST/DiagnosticsSema.def
@@ -1103,14 +1103,14 @@ ERROR(module_not_testable,Fatal,
 ERROR(module_not_compiled_for_private_import,none,
       "module %0 was not compiled for private import", (Identifier))
 
-ERROR(in_package_module_not_compiled_from_source,none,
-      "module %0 is in package '%1' but was built from interface; "
-      "modules of the same package can only be loaded if built from source: %2",
+ERROR(in_package_module_not_compiled_from_source_or_package_interface,none,
+      "module %0 is in package '%1' but was built from a non-package interface; "
+      "modules of the same package can only be loaded if built from source or package interface: %2",
       (Identifier, StringRef, StringRef))
 
 WARNING(in_package_module_not_compiled_locally,none,
         "module %0 is in package %1 but was loaded from SDK; "
-        "modules of the same package should be built locally from source only: %2",
+        "modules of the same package should be built locally: %2",
         (Identifier, Identifier, StringRef))
 
 ERROR(import_restriction_conflict,none,
diff --git a/include/swift/AST/PrintOptions.h b/include/swift/AST/PrintOptions.h
@@ -118,7 +118,7 @@ struct ShouldPrintChecker {
   virtual ~ShouldPrintChecker() = default;
 };
 
-enum class PrintInterfaceContentMode : uint8_t {
+enum class InterfaceMode : uint8_t {
   Public, // prints public/inlinable decls
   Private, // prints SPI and public/inlinable decls
   Package // prints package, SPI, and public/inlinable decls
@@ -305,7 +305,7 @@ struct PrintOptions {
   /// Whether to skip keywords with a prefix of underscore such as __consuming.
   bool SkipUnderscoredKeywords = false;
 
-  PrintInterfaceContentMode InterfaceContentMode;
+  InterfaceMode InterfaceContentMode;
 
   /// Prints type variables and unresolved types in an expanded notation suitable
   /// for debugging.
@@ -689,7 +689,7 @@ struct PrintOptions {
   static PrintOptions printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
                                               bool preferTypeRepr,
                                               bool printFullConvention,
-                                              PrintInterfaceContentMode interfaceContentMode,
+                                              InterfaceMode interfaceContentMode,
                                               bool useExportedModuleNames,
                                               bool aliasModuleNames,
                                               llvm::SmallSet<StringRef, 4>
diff --git a/include/swift/Basic/LangOptions.h b/include/swift/Basic/LangOptions.h
@@ -216,6 +216,10 @@ namespace swift {
     /// Should access control be respected?
     bool EnableAccessControl = true;
 
+    /// Enable loading a package interface if both client and depdency module are in the
+    /// same package determined by `package-name` flag.
+    bool EnablePackageInterfaceLoad = false;
+
     /// Enable 'availability' restrictions for App Extensions.
     bool EnableAppExtensionRestrictions = false;
 
diff --git a/include/swift/Frontend/ModuleInterfaceSupport.h b/include/swift/Frontend/ModuleInterfaceSupport.h
@@ -56,7 +56,7 @@ struct ModuleInterfaceOptions {
   std::string IgnorablePrivateFlags;
 
   /// Prints package, SPIs, or public/inlinable decls depending on the mode.
-  PrintInterfaceContentMode InterfaceContentMode = PrintInterfaceContentMode::Public;
+  InterfaceMode InterfaceContentMode = InterfaceMode::Public;
 
   /// Print imports with both @_implementationOnly and @_spi, only applies
   /// when PrintSPIs is true.
diff --git a/include/swift/Option/Options.td b/include/swift/Option/Options.td
@@ -758,6 +758,11 @@ def experimental_hermetic_seal_at_link:
   Flags<[FrontendOption, HelpHidden]>,
   HelpText<"Library code can assume that all clients are visible at linktime, and aggressively strip unused code">;
 
+def experimental_package_interface_load:
+  Flag<["-"], "experimental-package-interface-load">,
+  Flags<[FrontendOption, HelpHidden]>,
+  HelpText<"Enables loading a package interface if in the same package specified with package-name">;
+
 // Diagnostic control options
 def suppress_warnings : Flag<["-"], "suppress-warnings">,
   Flags<[FrontendOption]>,
diff --git a/include/swift/Serialization/SerializedModuleLoader.h b/include/swift/Serialization/SerializedModuleLoader.h
@@ -67,11 +67,12 @@ struct SerializedModuleBaseName {
   /// private interface if there is one, else public). Return an empty optional otherwise.
   llvm::Optional<std::string>
   findInterfacePath(llvm::vfs::FileSystem &fs, ASTContext &ctx) const;
-
+  
   /// Returns the .package.swiftinterface path if its package-name also applies to
   /// the the importing module. Returns an empty optional otherwise.
   llvm::Optional<std::string>
-  getPackageInterfacePathIfInSamePackage(llvm::vfs::FileSystem &fs, ASTContext &ctx) const;
+  getPackageInterfacePathIfInSamePackage(llvm::vfs::FileSystem &fs,
+                                         ASTContext &ctx) const;
 };
 
 /// Common functionality shared between \c ImplicitSerializedModuleLoader,
@@ -183,6 +184,7 @@ class SerializedModuleLoaderBase : public ModuleLoader {
   /// Load the module file into a buffer and also collect its module name.
   static std::unique_ptr<llvm::MemoryBuffer>
   getModuleName(ASTContext &Ctx, StringRef modulePath, std::string &Name);
+  
 public:
   virtual ~SerializedModuleLoaderBase();
   SerializedModuleLoaderBase(const SerializedModuleLoaderBase &) = delete;
diff --git a/lib/AST/ASTPrinter.cpp b/lib/AST/ASTPrinter.cpp
@@ -174,7 +174,7 @@ static bool shouldTypeCheck(const PrintOptions &options) {
 PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
                                                    bool preferTypeRepr,
                                                    bool printFullConvention,
-                                                   PrintInterfaceContentMode interfaceContentMode,
+                                                   InterfaceMode interfaceContentMode,
                                                    bool useExportedModuleNames,
                                                    bool aliasModuleNames,
                                                    llvm::SmallSet<StringRef, 4>
@@ -238,7 +238,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
         return false;
 
       // Skip SPI decls if `PrintSPIs`.
-      if (options.InterfaceContentMode == PrintInterfaceContentMode::Public && D->isSPI())
+      if (options.InterfaceContentMode == InterfaceMode::Public && D->isSPI())
         return false;
 
       if (auto *VD = dyn_cast<ValueDecl>(D)) {
@@ -252,7 +252,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
             if (contributesToParentTypeStorage(ASD))
               return true;
 
-          if (options.InterfaceContentMode != PrintInterfaceContentMode::Package || !isPackage(VD))
+          if (options.InterfaceContentMode != InterfaceMode::Package || !isPackage(VD))
             return false;
         }
 
@@ -288,7 +288,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
 
         for (const Requirement &req : ED->getGenericRequirements()) {
           if (!isPublicOrUsableFromInline(req.getFirstType())) {
-            if (options.InterfaceContentMode != PrintInterfaceContentMode::Package || !isPackage(req.getSecondType()))
+            if (options.InterfaceContentMode != InterfaceMode::Package || !isPackage(req.getSecondType()))
               return false;
           }
 
@@ -297,7 +297,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
           case RequirementKind::Superclass:
           case RequirementKind::SameType:
             if (!isPublicOrUsableFromInline(req.getSecondType())) {
-              if (options.InterfaceContentMode != PrintInterfaceContentMode::Package || !isPackage(req.getSecondType()))
+              if (options.InterfaceContentMode != InterfaceMode::Package || !isPackage(req.getSecondType()))
                 return false;
             }
             break;
@@ -1205,7 +1205,7 @@ void PrintAST::printAttributes(const Decl *D) {
     }
 
     // Add SPIs to both private and package interfaces
-    if (Options.InterfaceContentMode != PrintInterfaceContentMode::Public &&
+    if (Options.InterfaceContentMode != InterfaceMode::Public &&
         DeclAttribute::canAttributeAppearOnDeclKind(
           DAK_SPIAccessControl, D->getKind())) {
       interleave(D->getSPIGroups(),
@@ -1294,7 +1294,7 @@ static bool mustPrintPropertyName(VarDecl *decl, const PrintOptions &opts) {
   if (contributesToParentTypeStorage(decl)) return true;
 
   // Print a package decl if in print package mode (for .package.swiftinterface),
-  if (opts.InterfaceContentMode == PrintInterfaceContentMode::Package && isPackage(decl))
+  if (opts.InterfaceContentMode == InterfaceMode::Package && isPackage(decl))
     return true;
 
   // If it's public or @usableFromInline, we must print the name because it's a
@@ -6007,8 +6007,11 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
     Filter |= ModuleDecl::ImportFilterKind::Default;
 
     // For private or package swiftinterfaces, also look through @_spiOnly imports.
-    if (Options.InterfaceContentMode != PrintInterfaceContentMode::Public)
+    if (Options.InterfaceContentMode != InterfaceMode::Public)
       Filter |= ModuleDecl::ImportFilterKind::SPIOnly;
+    // Consider package import for package interface
+    if (Options.InterfaceContentMode == InterfaceMode::Package)
+      Filter |= ModuleDecl::ImportFilterKind::PackageOnly;
 
     SmallVector<ImportedModule, 4> Imports;
     Options.CurrentModule->getImportedModules(Imports, Filter);
diff --git a/lib/AST/Attr.cpp b/lib/AST/Attr.cpp
@@ -1048,7 +1048,7 @@ bool DeclAttribute::printImpl(ASTPrinter &Printer, const PrintOptions &Options,
     return true;
 
   case DAK_SPIAccessControl: {
-    if (Options.InterfaceContentMode == PrintInterfaceContentMode::Public) return false;
+    if (Options.InterfaceContentMode == InterfaceMode::Public) return false;
 
     auto spiAttr = static_cast<const SPIAccessControlAttr*>(this);
     interleave(spiAttr->getSPIGroups(),
@@ -1100,7 +1100,7 @@ bool DeclAttribute::printImpl(ASTPrinter &Printer, const PrintOptions &Options,
     auto Attr = cast<AvailableAttr>(this);
     if (Options.SuppressNoAsyncAvailabilityAttr && Attr->isNoAsync())
       return false;
-    if (Options.InterfaceContentMode == PrintInterfaceContentMode::Public && Attr->IsSPI) {
+    if (Options.InterfaceContentMode == InterfaceMode::Public && Attr->IsSPI) {
       assert(Attr->hasPlatform());
       assert(Attr->Introduced.has_value());
       Printer.printAttrName("@available");
@@ -1196,7 +1196,7 @@ bool DeclAttribute::printImpl(ASTPrinter &Printer, const PrintOptions &Options,
     auto *attr = cast<SpecializeAttr>(this);
     // Don't print the _specialize attribute if it is marked spi and we are
     // asked to skip SPI.
-    if (Options.InterfaceContentMode == PrintInterfaceContentMode::Public && !attr->getSPIGroups().empty())
+    if (Options.InterfaceContentMode == InterfaceMode::Public && !attr->getSPIGroups().empty())
       return false;
 
     // Don't print the _specialize attribute if we are asked to skip the ones
diff --git a/lib/Frontend/CompilerInvocation.cpp b/lib/Frontend/CompilerInvocation.cpp
@@ -417,7 +417,7 @@ static void ParseModuleInterfaceArgs(ModuleInterfaceOptions &Opts,
   if (const Arg *A = Args.getLastArg(OPT_library_level)) {
     StringRef contents = A->getValue();
     if (contents == "spi") {
-      Opts.InterfaceContentMode = PrintInterfaceContentMode::Private;
+      Opts.InterfaceContentMode = InterfaceMode::Private;
     }
   }
   for (auto val: Args.getAllArgValues(OPT_skip_import_in_public_interface)) {
@@ -622,6 +622,12 @@ static bool ParseLangArgs(LangOptions &Opts, ArgList &Args,
     Opts.EnableAccessControl
       = A->getOption().matches(OPT_enable_access_control);
   }
+  if (auto A = Args.getLastArg(OPT_experimental_package_interface_load,
+                               OPT_experimental_package_interface_load)) {
+    Opts.EnablePackageInterfaceLoad
+      = A->getOption().matches(OPT_experimental_package_interface_load);
+  }
+
   Opts.ForceWorkaroundBrokenModules
     |= Args.hasArg(OPT_force_workaround_broken_modules);
 
diff --git a/lib/Frontend/ModuleInterfaceSupport.cpp b/lib/Frontend/ModuleInterfaceSupport.cpp
@@ -71,8 +71,10 @@ static void printToolVersionAndFlagsComment(raw_ostream &out,
 
     ModuleDecl::ImportFilter filter = {ModuleDecl::ImportFilterKind::Default,
                                        ModuleDecl::ImportFilterKind::Exported};
-    if (Opts.InterfaceContentMode != PrintInterfaceContentMode::Public)
+    if (Opts.InterfaceContentMode != InterfaceMode::Public)
       filter |= ModuleDecl::ImportFilterKind::SPIOnly;
+    if (Opts.InterfaceContentMode == InterfaceMode::Package)
+      filter |= ModuleDecl::ImportFilterKind::PackageOnly;
 
     SmallVector<ImportedModule> imports;
     M->getImportedModules(imports, filter);
@@ -99,7 +101,7 @@ static void printToolVersionAndFlagsComment(raw_ostream &out,
         << Opts.IgnorableFlags << "\n";
   }
 
-  auto hasPrivateIgnorableFlags = Opts.InterfaceContentMode != PrintInterfaceContentMode::Public && !Opts.IgnorablePrivateFlags.empty();
+  auto hasPrivateIgnorableFlags = Opts.InterfaceContentMode != InterfaceMode::Public && !Opts.IgnorablePrivateFlags.empty();
   if (hasPrivateIgnorableFlags) {
     out << "// " SWIFT_MODULE_FLAGS_IGNORABLE_PRIVATE_KEY ": "
         << Opts.IgnorablePrivateFlags << "\n";
@@ -245,7 +247,7 @@ static void printImports(raw_ostream &out,
   // imports only if they are also SPI. First, list all implementation-only imports and
   // filter them later.
   llvm::SmallSet<ImportedModule, 4, ImportedModule::Order> ioiImportSet;
-  if (Opts.InterfaceContentMode != PrintInterfaceContentMode::Public && Opts.ExperimentalSPIImports) {
+  if (Opts.InterfaceContentMode != InterfaceMode::Public && Opts.ExperimentalSPIImports) {
 
     SmallVector<ImportedModule, 4> ioiImports, allImports;
     M->getImportedModules(ioiImports,
@@ -266,7 +268,7 @@ static void printImports(raw_ostream &out,
 
   /// Collect @_spiOnly imports that are not imported elsewhere publicly.
   llvm::SmallSet<ImportedModule, 4, ImportedModule::Order> spiOnlyImportSet;
-  if (Opts.InterfaceContentMode != PrintInterfaceContentMode::Public) {
+  if (Opts.InterfaceContentMode != InterfaceMode::Public) {
     SmallVector<ImportedModule, 4> spiOnlyImports, otherImports;
     M->getImportedModules(spiOnlyImports,
                           ModuleDecl::ImportFilterKind::SPIOnly);
@@ -333,7 +335,7 @@ static void printImports(raw_ostream &out,
     if (publicImportSet.count(import))
       out << "@_exported ";
 
-    if (Opts.InterfaceContentMode != PrintInterfaceContentMode::Public) {
+    if (Opts.InterfaceContentMode != InterfaceMode::Public) {
       // An import visible in the private or package swiftinterface only.
       //
       // In the long term, we want to print this attribute for consistency and
@@ -621,7 +623,7 @@ class InheritedProtocolCollector {
       return;
 
     // Skip SPI extensions in the public interface.
-    if (printOptions.InterfaceContentMode == PrintInterfaceContentMode::Public && extension->isSPI())
+    if (printOptions.InterfaceContentMode == InterfaceMode::Public && extension->isSPI())
       return;
 
     const NominalTypeDecl *nominal = extension->getExtendedNominal();
@@ -702,7 +704,7 @@ class InheritedProtocolCollector {
             inherited->isSpecificProtocol(KnownProtocolKind::Actor))
           return TypeWalker::Action::SkipChildren;
 
-        if (inherited->isSPI() && printOptions.InterfaceContentMode == PrintInterfaceContentMode::Public)
+        if (inherited->isSPI() && printOptions.InterfaceContentMode == InterfaceMode::Public)
           return TypeWalker::Action::Continue;
 
         if (isPublicOrUsableFromInline(inherited) &&
@@ -782,7 +784,7 @@ class InheritedProtocolCollector {
       return false;
     assert(nominal->isGenericContext());
 
-    if (printOptions.InterfaceContentMode != PrintInterfaceContentMode::Public)
+    if (printOptions.InterfaceContentMode != InterfaceMode::Public)
       out << "@_spi(" << DummyProtocolName << ")\n";
     out << "@available(*, unavailable)\nextension ";
     nominal->getDeclaredType().print(out, printOptions);
@@ -823,7 +825,7 @@ bool swift::emitSwiftInterface(raw_ostream &out,
 
   printImports(out, Opts, M, aliasModuleNamesTargets);
 
-  bool useExportedModuleNames = Opts.InterfaceContentMode == PrintInterfaceContentMode::Public;
+  bool useExportedModuleNames = Opts.InterfaceContentMode == InterfaceMode::Public;
 
   const PrintOptions printOptions = PrintOptions::printSwiftInterfaceFile(
       M, Opts.PreserveTypesAsWritten, Opts.PrintFullConvention,
diff --git a/lib/FrontendTool/FrontendTool.cpp b/lib/FrontendTool/FrontendTool.cpp
@@ -987,7 +987,7 @@ static bool emitAnyWholeModulePostTypeCheckSupplementaryOutputs(
   if (opts.InputsAndOutputs.hasPrivateModuleInterfaceOutputPath()) {
     // Copy the settings from the module interface to add SPI printing.
     ModuleInterfaceOptions privOpts = Invocation.getModuleInterfaceOptions();
-    privOpts.InterfaceContentMode = PrintInterfaceContentMode::Private;
+    privOpts.InterfaceContentMode = InterfaceMode::Private;
     privOpts.ModulesToSkipInPublicInterface.clear();
 
     hadAnyError |= printModuleInterfaceIfNeeded(
@@ -1000,7 +1000,7 @@ static bool emitAnyWholeModulePostTypeCheckSupplementaryOutputs(
   if (opts.InputsAndOutputs.hasPackageModuleInterfaceOutputPath()) {
     // Copy the settings from the module interface to add package decl printing.
     ModuleInterfaceOptions pkgOpts = Invocation.getModuleInterfaceOptions();
-    pkgOpts.InterfaceContentMode = PrintInterfaceContentMode::Package;
+    pkgOpts.InterfaceContentMode = InterfaceMode::Package;
     pkgOpts.ModulesToSkipInPublicInterface.clear();
 
     hadAnyError |= printModuleInterfaceIfNeeded(
diff --git a/lib/Sema/ImportResolution.cpp b/lib/Sema/ImportResolution.cpp
@@ -751,9 +751,10 @@ void UnboundImport::validateInterfaceWithPackageName(ModuleDecl *topLevelModule,
   ASTContext &ctx = topLevelModule->getASTContext();
   if (!topLevelModule->getPackageName().empty() &&
       topLevelModule->getPackageName().str() == ctx.LangOpts.PackageName &&
-      topLevelModule->isBuiltFromInterface()) {
+      topLevelModule->isBuiltFromInterface() &&
+      !topLevelModule->getModuleSourceFilename().endswith(".package.swiftinterface")) {
       ctx.Diags.diagnose(import.module.getModulePath().front().Loc,
-                         diag::in_package_module_not_compiled_from_source,
+                         diag::in_package_module_not_compiled_from_source_or_package_interface,
                          topLevelModule->getBaseIdentifier(),
                          ctx.LangOpts.PackageName,
                          topLevelModule->getModuleSourceFilename()
diff --git a/lib/Serialization/ScanningLoaders.cpp b/lib/Serialization/ScanningLoaders.cpp
@@ -69,13 +69,11 @@ std::error_code SwiftModuleScanner::findModuleFilesInDirectory(
 
   // Use package.swiftinterface if it exists and its package-name applies to
   // the importer module.
-  auto PkgInPath = getPackageInterfacePathIfInSamePackage(fs, Ctx);
+  auto PkgInPath = BaseName.getPackageInterfacePathIfInSamePackage(fs, Ctx).value_or("");
   if (fs.exists(PkgInPath)) {
     InPath = PkgInPath;
-  }
-
-  // If not in package, use the private interface file if exits.
-  if (fs.exists(InPath)) {
+  } else {
+    // If not in package, use the private interface file if exits.
     auto PrivateInPath =
     BaseName.getName(file_types::TY_PrivateSwiftModuleInterfaceFile);
     if (fs.exists(PrivateInPath)) {
diff --git a/lib/Serialization/SerializedModuleLoader.cpp b/lib/Serialization/SerializedModuleLoader.cpp
diff --git a/test/ModuleInterface/package_interface.swift b/test/ModuleInterface/package_interface.swift
diff --git a/test/Sema/accessibility_package_import_interface.swift b/test/Sema/accessibility_package_import_interface.swift
diff --git a/test/Sema/import_package_module_from_sdk.swift b/test/Sema/import_package_module_from_sdk.swift
diff --git a/test/Serialization/load_package_module.swift b/test/Serialization/load_package_module.swift
