[5.1 08-28-2019] Cherry-picking recent Swift framework ABI checker enhancements

include/swift/AST/DiagnosticsModuleDiffer.def

@@ -96,6 +96,8 @@ ERROR(decl_new_witness_table_entry,none,"%0 now requires %select{|no}1 new witne
 
 ERROR(new_decl_without_intro,none,"%0 is a new API without @available attribute", (StringRef))
 
+ERROR(objc_name_change,none,"%0 has ObjC name change from %1 to %2", (StringRef, StringRef, StringRef))
+
 #ifndef DIAG_NO_UNDEF
 # if defined(DIAG)
 #  undef DIAG

include/swift/Frontend/FrontendOptions.h

@@ -76,6 +76,9 @@ class FrontendOptions {
   /// binary module has already been built for use by the compiler.
   std::string PrebuiltModuleCachePath;
 
+  /// For these modules, we should prefer using Swift interface when importing them.
+  std::vector<std::string> PreferInterfaceForModules;
+
   /// Emit index data for imported serialized swift system modules.
   bool IndexSystemModules = false;
 

include/swift/Frontend/ParseableInterfaceModuleLoader.h

@@ -128,15 +128,18 @@ class ParseableInterfaceModuleLoader : public SerializedModuleLoaderBase {
   explicit ParseableInterfaceModuleLoader(
       ASTContext &ctx, StringRef cacheDir, StringRef prebuiltCacheDir,
       DependencyTracker *tracker, ModuleLoadingMode loadMode,
+      ArrayRef<std::string> PreferInterfaceForModules,
       bool RemarkOnRebuildFromInterface)
   : SerializedModuleLoaderBase(ctx, tracker, loadMode),
   CacheDir(cacheDir), PrebuiltCacheDir(prebuiltCacheDir),
-  RemarkOnRebuildFromInterface(RemarkOnRebuildFromInterface)
+  RemarkOnRebuildFromInterface(RemarkOnRebuildFromInterface),
+  PreferInterfaceForModules(PreferInterfaceForModules)
   {}
 
   std::string CacheDir;
   std::string PrebuiltCacheDir;
   bool RemarkOnRebuildFromInterface;
+  ArrayRef<std::string> PreferInterfaceForModules;
 
   std::error_code findModuleFilesInDirectory(
     AccessPathElem ModuleID, StringRef DirPath, StringRef ModuleFilename,
@@ -150,10 +153,12 @@ class ParseableInterfaceModuleLoader : public SerializedModuleLoaderBase {
   static std::unique_ptr<ParseableInterfaceModuleLoader>
   create(ASTContext &ctx, StringRef cacheDir, StringRef prebuiltCacheDir,
          DependencyTracker *tracker, ModuleLoadingMode loadMode,
+         ArrayRef<std::string> PreferInterfaceForModules = {},
          bool RemarkOnRebuildFromInterface = false) {
     return std::unique_ptr<ParseableInterfaceModuleLoader>(
       new ParseableInterfaceModuleLoader(ctx, cacheDir, prebuiltCacheDir,
                                          tracker, loadMode,
+                                         PreferInterfaceForModules,
                                          RemarkOnRebuildFromInterface));
   }
 

include/swift/IDE/DigesterEnums.def

@@ -143,18 +143,22 @@ KEY_STRING(ModuleName, moduleName)
 KEY_STRING(SuperclassUsr, superclassUsr)
 KEY_STRING(EnumRawTypeName, enumRawTypeName)
 KEY_STRING(GenericSig, genericSig)
+KEY_STRING(SugaredGenericSig, sugared_genericSig)
 KEY_STRING(FuncSelfKind, funcSelfKind)
 KEY_STRING(ParamValueOwnership, paramValueOwnership)
 KEY_STRING(IntromacOS, intro_Macosx)
 KEY_STRING(IntroiOS, intro_iOS)
 KEY_STRING(IntrotvOS, intro_tvOS)
 KEY_STRING(IntrowatchOS, intro_watchOS)
 KEY_STRING(Introswift, intro_swift)
+KEY_STRING(ObjCName, objc_name)
 
 KEY_STRING_ARR(SuperclassNames, superclassNames)
+KEY_STRING_ARR(ToolArgs, tool_arguments)
 
 KEY_UINT(SelfIndex, selfIndex)
 KEY_UINT(FixedBinaryOrder, fixedbinaryorder)
+KEY_UINT(JsonFormatVer, json_format_version)
 
 KEY(children)
 KEY(conformances)

lib/Frontend/Frontend.cpp

@@ -361,7 +361,8 @@ bool CompilerInstance::setUpModuleLoaders() {
     StringRef PrebuiltModuleCachePath = FEOpts.PrebuiltModuleCachePath;
     auto PIML = ParseableInterfaceModuleLoader::create(
         *Context, ModuleCachePath, PrebuiltModuleCachePath,
-        getDependencyTracker(), MLM, FEOpts.RemarkOnRebuildFromModuleInterface);
+        getDependencyTracker(), MLM, FEOpts.PreferInterfaceForModules,
+        FEOpts.RemarkOnRebuildFromModuleInterface);
     Context->addModuleLoader(std::move(PIML));
   }
   Context->addModuleLoader(std::move(SML));

lib/Frontend/ParseableInterfaceModuleLoader.cpp

@@ -1425,11 +1425,14 @@ std::error_code ParseableInterfaceModuleLoader::findModuleFilesInDirectory(
   }
 
   // Create an instance of the Impl to do the heavy lifting.
+  auto ModuleName = ModuleID.first.str();
   ParseableInterfaceModuleLoaderImpl Impl(
-                Ctx, ModPath, InPath, ModuleID.first.str(),
+                Ctx, ModPath, InPath, ModuleName,
                 CacheDir, PrebuiltCacheDir, ModuleID.second,
                 RemarkOnRebuildFromInterface, dependencyTracker,
-                LoadMode);
+                llvm::is_contained(PreferInterfaceForModules,
+                                   ModuleName) ?
+                  ModuleLoadingMode::PreferParseable : LoadMode);
 
   // Ask the impl to find us a module that we can load or give us an error
   // telling us that we couldn't load it.

test/api-digester/Inputs/cake.swift

@@ -3,6 +3,7 @@
 public protocol P1 {}
 public protocol P2 {}
 public protocol P3: P2, P1 {}
+
 @frozen
 public struct S1: P1 {
   public static func foo1() {}
@@ -123,3 +124,18 @@ public class PlatformIntroClass {}
 
 @available(swift, introduced: 5)
 public class SwiftIntroClass {}
+
+@objc(NewObjCClass)
+public class SwiftObjcClass {
+  @objc(ObjCFool:ObjCA:ObjCB:)
+  public func foo(a:Int, b:Int, c: Int) {}
+}
+
+@available(iOS 10.2, tvOS 10.3, watchOS 3.4, *)
+@available(macOS, unavailable)
+public class UnavailableOnMac {}
+
+@available(macOS, unavailable)
+extension SwiftObjcClass {
+  public func functionUnavailableOnMac() {}
+}

test/api-digester/Inputs/cake_baseline/cake.swift

@@ -195,3 +195,9 @@ public class Zoo {
 }
 
 public func returnFunctionTypeOwnershipChange() -> (C1) -> () { return { _ in } }
+
+@objc(OldObjCClass)
+public class SwiftObjcClass {
+  @objc(OldObjCFool:OldObjCA:OldObjCB:)
+  public func foo(a:Int, b:Int, c: Int) {}
+}

test/api-digester/Inputs/cake_current/cake.swift

@@ -202,3 +202,9 @@ public class Zoo {
 }
 
 public func returnFunctionTypeOwnershipChange() -> (__owned C1) -> () { return { _ in } }
+
+@objc(NewObjCClass)
+public class SwiftObjcClass {
+  @objc(NewObjCFool:NewObjCA:NewObjCB:)
+  public func foo(a:Int, b:Int, c: Int) {}
+}

test/api-digester/Outputs/Cake-abi.txt

@@ -1,12 +1,11 @@
 
 /* Generic Signature Changes */
-cake: Func P1.P1Constraint() has generic signature change from <τ_0_0 where τ_0_0 : P1, τ_0_0 : P2> to <τ_0_0 where τ_0_0 : P1>
-cake: Protocol P3 has generic signature change from <τ_0_0 : P1, τ_0_0 : P2> to <τ_0_0 : P1, τ_0_0 : P4>
+cake: Func P1.P1Constraint() has generic signature change from <Self where Self : cake.P1, Self : cake.P2> to <Self where Self : cake.P1>
+cake: Protocol P3 has generic signature change from <Self : cake.P1, Self : cake.P2> to <Self : cake.P1, Self : cake.P4>
 
 /* RawRepresentable Changes */
 
 /* Removed Decls */
-Swift: Extension Int has been removed
 cake: Accessor GlobalVarChangedToLet.Modify() has been removed
 cake: Accessor GlobalVarChangedToLet.Set() has been removed
 cake: Accessor RemoveSetters.Value.Modify() has been removed
@@ -18,6 +17,7 @@ cake: AssociatedType RequiementChanges.removedType has been removed
 cake: Class C3 has been removed
 cake: Constructor Somestruct2.init(_:) has been removed
 cake: Func C4.foo() has been removed
+cake: Func Int.IntEnhancer() has been removed
 cake: Func RequiementChanges.removedFunc() has been removed
 cake: Var RequiementChanges.removedVar has been removed
 
@@ -27,25 +27,27 @@ cake: InfixOperator ..*.. has been changed to a PrefixOperator
 cake: Protocol ProtocolToEnum has been changed to a Enum
 
 /* Renamed Decls */
+cake: Class SwiftObjcClass has ObjC name change from OldObjCClass to NewObjCClass
 cake: Func S1.foo5(x:y:) has been renamed to Func foo5(x:y:z:)
+cake: Func SwiftObjcClass.foo(a:b:c:) has ObjC name change from OldObjCFool:OldObjCA:OldObjCB: to NewObjCFool:NewObjCA:NewObjCB:
 cake: Struct Somestruct2 has been renamed to Struct NSSomestruct2
 
 /* Type Changes */
-cake: Accessor Zoo.current.Get() has return type change from Cat to Dog
-cake: AssociatedType AssociatedTypePro.T3 has default type change from C1 to C6
-cake: Class TChangesFromIntToString has type witness type for AssociatedTypesProtocol.T changing from Int to String
-cake: Constructor S1.init(_:) has parameter 0 type change from Int to Double
-cake: Func C1.foo2(_:) has parameter 0 type change from Int to () -> ()
+cake: Accessor Zoo.current.Get() has return type change from cake.Cat to cake.Dog
+cake: AssociatedType AssociatedTypePro.T3 has default type change from cake.C1 to cake.C6
+cake: Class TChangesFromIntToString has type witness type for AssociatedTypesProtocol.T changing from Swift.Int to Swift.String
+cake: Constructor S1.init(_:) has parameter 0 type change from Swift.Int to Swift.Double
+cake: Func C1.foo2(_:) has parameter 0 type change from Swift.Int to () -> ()
 cake: Func C7.foo(_:_:) has removed default argument from parameter 0
 cake: Func C7.foo(_:_:) has removed default argument from parameter 1
 cake: Func EscapingFunctionType.addedEscaping(_:) has added @escaping in parameter 0
 cake: Func EscapingFunctionType.removedEscaping(_:) has removed @escaping in parameter 0
-cake: Func Somestruct2.foo1(_:) has parameter 0 type change from C3 to C1
-cake: Func Zoo.getCurrentAnimalInlinable() has return type change from Cat to Dog
+cake: Func Somestruct2.foo1(_:) has parameter 0 type change from cake.C3 to cake.C1
+cake: Func Zoo.getCurrentAnimalInlinable() has return type change from cake.Cat to cake.Dog
 cake: Func ownershipChange(_:_:) has parameter 0 changing from InOut to Default
 cake: Func ownershipChange(_:_:) has parameter 1 changing from Shared to Owned
-cake: Func returnFunctionTypeOwnershipChange() has return type change from (C1) -> () to (__owned C1) -> ()
-cake: Var Zoo.current has declared type change from Cat to Dog
+cake: Func returnFunctionTypeOwnershipChange() has return type change from (cake.C1) -> () to (__owned cake.C1) -> ()
+cake: Var Zoo.current has declared type change from cake.Cat to cake.Dog
 
 /* Decl Attribute changes */
 cake: Accessor GlobalLetChangedToVar.Modify() is a new API without @available attribute
@@ -103,13 +105,13 @@ cake: Struct fixedLayoutStruct has removed conformance to P1
 
 /* Protocol Requirement Change */
 cake: Accessor HasMutatingMethodClone.bar.Get() now requires  new witness table entry
-cake: AssociatedType AssociatedTypePro.T1 has removed default type Int
+cake: AssociatedType AssociatedTypePro.T1 has removed default type Swift.Int
 cake: AssociatedType RequiementChanges.addedTypeWithoutDefault has been added as a protocol requirement
 cake: Func HasMutatingMethodClone.foo() now requires  new witness table entry
 cake: Func RequiementChanges.addedFunc() has been added as a protocol requirement
 cake: Var RequiementChanges.addedVar has been added as a protocol requirement
 
 /* Class Inheritance Change */
-cake: Class C4 has changed its super class from OldType to NewType
-cake: Class SubGenericClass has changed its super class from GenericClass<P1> to GenericClass<P2>
-cake: Class SuperClassRemoval has removed its super class C3
+cake: Class C4 has changed its super class from APINotesTest.OldType to APINotesTest.NewType
+cake: Class SubGenericClass has changed its super class from cake.GenericClass<cake.P1> to cake.GenericClass<cake.P2>
+cake: Class SuperClassRemoval has removed its super class cake.C3

test/api-digester/Outputs/Cake-binary-vs-interface.txt

@@ -0,0 +1,11 @@
+cake: Func FrozenKind.__derived_enum_equals(_:_:) has been removed
+cake: Accessor GlobalLetChangedToVar.Get() is a new API without @available attribute
+cake: Accessor GlobalVarChangedToLet.Get() is a new API without @available attribute
+cake: Accessor GlobalVarChangedToLet.Modify() is a new API without @available attribute
+cake: Accessor GlobalVarChangedToLet.Set() is a new API without @available attribute
+cake: Enum FrozenKind is now with @frozen
+cake: Enum IceKind is now with @frozen
+cake: Func FrozenKind.==(_:_:) is a new API without @available attribute
+cake: Var C1.CIIns1 is no longer a stored property
+cake: Var C1.CIIns2 is no longer a stored property
+cake: Var RemoveSetters.Value is no longer a stored property

test/api-digester/Outputs/Cake.txt

@@ -1,18 +1,18 @@
 
 /* Generic Signature Changes */
-cake: Func P1.P1Constraint() has generic signature change from <Self where Self : P1, Self : P2> to <Self where Self : P1>
-cake: Protocol P3 has generic signature change from <Self : P1, Self : P2> to <Self : P1, Self : P4>
+cake: Func P1.P1Constraint() has generic signature change from <Self where Self : cake.P1, Self : cake.P2> to <Self where Self : cake.P1>
+cake: Protocol P3 has generic signature change from <Self : cake.P1, Self : cake.P2> to <Self : cake.P1, Self : cake.P4>
 
 /* RawRepresentable Changes */
 
 /* Removed Decls */
-Swift: Extension Int has been removed
 cake: Accessor GlobalVarChangedToLet.Set() has been removed
 cake: Accessor RemoveSetters.Value.Set() has been removed
 cake: Accessor RemoveSetters.subscript(_:).Set() has been removed
 cake: AssociatedType RequiementChanges.removedType has been removed
 cake: Constructor Somestruct2.init(_:) has been removed
 cake: Func C4.foo() has been removed
+cake: Func Int.IntEnhancer() has been removed
 cake: Func RequiementChanges.removedFunc() has been removed
 cake: Var RequiementChanges.removedVar has been removed
 
@@ -22,18 +22,20 @@ cake: InfixOperator ..*.. has been changed to a PrefixOperator
 cake: Protocol ProtocolToEnum has been changed to a Enum
 
 /* Renamed Decls */
+cake: Class SwiftObjcClass has ObjC name change from OldObjCClass to NewObjCClass
 cake: Func S1.foo5(x:y:) has been renamed to Func foo5(x:y:z:)
+cake: Func SwiftObjcClass.foo(a:b:c:) has ObjC name change from OldObjCFool:OldObjCA:OldObjCB: to NewObjCFool:NewObjCA:NewObjCB:
 cake: Struct Somestruct2 has been renamed to Struct NSSomestruct2
 
 /* Type Changes */
-cake: AssociatedType AssociatedTypePro.T3 has default type change from C1 to C6
-cake: Constructor S1.init(_:) has parameter 0 type change from Int to Double
-cake: Func C1.foo2(_:) has parameter 0 type change from Int to () -> ()
+cake: AssociatedType AssociatedTypePro.T3 has default type change from cake.C1 to cake.C6
+cake: Constructor S1.init(_:) has parameter 0 type change from Swift.Int to Swift.Double
+cake: Func C1.foo2(_:) has parameter 0 type change from Swift.Int to () -> ()
 cake: Func C7.foo(_:_:) has removed default argument from parameter 0
 cake: Func C7.foo(_:_:) has removed default argument from parameter 1
 cake: Func ownershipChange(_:_:) has parameter 0 changing from InOut to Default
 cake: Func ownershipChange(_:_:) has parameter 1 changing from Shared to Owned
-cake: TypeAlias TChangesFromIntToString.T has underlying type change from Int to String
+cake: TypeAlias TChangesFromIntToString.T has underlying type change from Swift.Int to Swift.String
 
 /* Decl Attribute changes */
 cake: Func C1.foo1() is now not static
@@ -52,16 +54,16 @@ cake: Protocol P3 has removed inherited protocol P2
 cake: Struct fixedLayoutStruct has removed conformance to P1
 
 /* Protocol Requirement Change */
-cake: AssociatedType AssociatedTypePro.T1 has removed default type Int
+cake: AssociatedType AssociatedTypePro.T1 has removed default type Swift.Int
 cake: AssociatedType RequiementChanges.addedTypeWithoutDefault has been added as a protocol requirement
 cake: Func RequiementChanges.addedFunc() has been added as a protocol requirement
 cake: Var RequiementChanges.addedVar has been added as a protocol requirement
 cake: Accessor ClassWithOpenMember.property.Get() is no longer open for subclassing
 
 /* Class Inheritance Change */
-cake: Class C4 has changed its super class from OldType to NewType
-cake: Class SubGenericClass has changed its super class from GenericClass<P1> to GenericClass<P2>
-cake: Class SuperClassRemoval has removed its super class C3
+cake: Class C4 has changed its super class from APINotesTest.OldType to APINotesTest.NewType
+cake: Class SubGenericClass has changed its super class from cake.GenericClass<cake.P1> to cake.GenericClass<cake.P2>
+cake: Class SuperClassRemoval has removed its super class cake.C3
 cake: Func ClassWithOpenMember.bar() is no longer open for subclassing
 cake: Func ClassWithOpenMember.foo() is no longer open for subclassing
 cake: Var ClassWithOpenMember.property is no longer open for subclassing

test/api-digester/Outputs/apinotes-diags-3-4.txt

@@ -2,21 +2,21 @@
 /* Generic Signature Changes */
 
 /* RawRepresentable Changes */
-APINotesTest(APINotesTest.h): TypeAlias AnimalAttributeName(NSString) is now String representable
 
 /* Removed Decls */
+APINotesTest(APINotesTest.h): TypeAlias AnimalAttributeName has been removed
 
 /* Moved Decls */
 
 /* Renamed Decls */
 APINotesTest(APINotesTest.h): Var globalAttributeName has been renamed to Var AnimalAttributeName.globalAttributeName
 
 /* Type Changes */
-APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingAttributes(_:) has parameter 0 type change from [String : Any] to [AnimalAttributeName : Any]
-APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingAttributesArray(_:) has parameter 0 type change from [String] to [AnimalAttributeName]
-APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingOptionalAttributes(_:) has parameter 0 type change from [String : Any]? to [AnimalAttributeName : Any]?
-APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingOptionalAttributesArray(_:) has parameter 0 type change from [String]? to [AnimalAttributeName]?
-APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.animalStatusSingleAttribute(_:) has parameter 0 type change from String to AnimalAttributeName
-APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.animalStatusSingleOptionalAttribute(_:) has parameter 0 type change from String? to AnimalAttributeName?
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingAttributes(_:) has parameter 0 type change from [Swift.String : Any] to [APINotesTest.AnimalAttributeName : Any]
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingAttributesArray(_:) has parameter 0 type change from [Swift.String] to [APINotesTest.AnimalAttributeName]
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingOptionalAttributes(_:) has parameter 0 type change from [Swift.String : Any]? to [APINotesTest.AnimalAttributeName : Any]?
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingOptionalAttributesArray(_:) has parameter 0 type change from [Swift.String]? to [APINotesTest.AnimalAttributeName]?
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.animalStatusSingleAttribute(_:) has parameter 0 type change from Swift.String to APINotesTest.AnimalAttributeName
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.animalStatusSingleOptionalAttribute(_:) has parameter 0 type change from Swift.String? to APINotesTest.AnimalAttributeName?
 
 /* Decl Attribute changes */