[BridgingHeader] Fix auto-chaining when only dependency has bridging header

When enable bridging header auto chaining, it is possible for the
compilation to have a PCH file input for the bridging header from a
binary swift module dependency. In this case, we should not report a
bridging header for current module as bridging header can be leaking out
through swiftinterface file.

To fully distinguish the PCH files passed in through different
situation, here are the situations:
* If no chaining is used, only `-import-objc-header` option is used and
  it can be used to pass either a header file or a PCH file depending if
  GeneratePCH job is requested or not.
* If chaining is enabled, `-import-objc-header` is only used to pass the
  header file and `-import-pch` is used to pass PCH file. Chaining mode
  requires PCH generation if bridging header is used.

rdar://144623388

Author: cachemeifyoucan

include/swift/Frontend/FrontendOptions.h

@@ -286,7 +286,7 @@ class FrontendOptions {
 
   /// If set, the header provided in ImplicitObjCHeaderPath will be rewritten
   /// by the Clang importer as part of semantic analysis.
-  bool SerializeBridgingHeader = false;
+  bool ModuleHasBridgingHeader = false;
 
   /// Indicates whether or not the frontend should print statistics upon
   /// termination.

lib/Frontend/ArgsToFrontendOptionsConverter.cpp

@@ -901,7 +901,7 @@ void ArgsToFrontendOptionsConverter::computeImportObjCHeaderOptions() {
       Opts.ImplicitObjCHeaderPath = A->getValue();
     // If `-import-object-header` is used, it means the module has a direct
     // bridging header dependency and it can be serialized into binary module.
-    Opts.SerializeBridgingHeader |= true;
+    Opts.ModuleHasBridgingHeader |= true;
   }
   if (const Arg *A = Args.getLastArgNoClaim(OPT_import_pch))
     Opts.ImplicitObjCPCHPath = A->getValue();

lib/Frontend/Frontend.cpp

@@ -196,7 +196,7 @@ SerializationOptions CompilerInvocation::computeSerializationOptions(
   serializationOpts.DocOutputPath = outs.ModuleDocOutputPath;
   serializationOpts.SourceInfoOutputPath = outs.ModuleSourceInfoOutputPath;
   serializationOpts.GroupInfoPath = opts.GroupInfoPath.c_str();
-  if (opts.SerializeBridgingHeader && !outs.ModuleOutputPath.empty())
+  if (opts.ModuleHasBridgingHeader && !outs.ModuleOutputPath.empty())
     serializationOpts.SerializeBridgingHeader = true;
   // For batch mode, emit empty header path as placeholder.
   if (serializationOpts.SerializeBridgingHeader &&
@@ -1302,10 +1302,12 @@ ImplicitImportInfo CompilerInstance::getImplicitImportInfo() const {
   }
 
   imports.ShouldImportUnderlyingModule = frontendOpts.ImportUnderlyingModule;
-  if (frontendOpts.ImplicitObjCPCHPath.empty())
-    imports.BridgingHeaderPath = frontendOpts.ImplicitObjCHeaderPath;
-  else
-    imports.BridgingHeaderPath = frontendOpts.ImplicitObjCPCHPath;
+  if (frontendOpts.ModuleHasBridgingHeader) {
+    if (frontendOpts.ImplicitObjCPCHPath.empty())
+      imports.BridgingHeaderPath = frontendOpts.ImplicitObjCHeaderPath;
+    else
+      imports.BridgingHeaderPath = frontendOpts.ImplicitObjCPCHPath;
+  }
   return imports;
 }
 

test/ScanDependencies/bridging-header-autochaining.swift

@@ -43,18 +43,18 @@
 // RUN: %target-swift-frontend -module-name Test -O @%t/MyApp.cmd %t/test.swift \
 // RUN:   -emit-module -o %t/Test.swiftmodule
 
-/// Importing binary module with bridging header built from CAS from a regluar build.
+/// Importing binary module with bridging header from a module that also has bridging header using implicit build method.
 /// This should succeed even it is also importing a bridging header that shares same header dependencies (with proper header guard).
 // RUN: %target-swift-frontend -typecheck -module-name User \
 // RUN:   -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import \
 // RUN:   -Xcc -fmodule-map-file=%t/a.modulemap -Xcc -fmodule-map-file=%t/b.modulemap \
 // RUN:   -I %t %t/user2.swift -import-objc-header %t/Bridging2.h
 
-/// Importing binary module with bridging header built from CAS from a cached build. This should work without additional bridging header deps.
+/// Importing binary module with bridging header from a module that has no bridging header.
 // RUN: %target-swift-frontend -scan-dependencies -module-name User -module-cache-path %t/clang-module-cache -O \
 // RUN:   -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import \
 // RUN:   %t/user.swift -o %t/deps2.json -auto-bridging-header-chaining -scanner-output-dir %t -scanner-debug-write-output \
-// RUN:   -Xcc -fmodule-map-file=%t/a.modulemap -Xcc -fmodule-map-file=%t/b.modulemap -I %t
+// RUN:   -Xcc -fmodule-map-file=%t/a.modulemap -Xcc -fmodule-map-file=%t/b.modulemap -I %t -enable-library-evolution
 
 // RUN: %swift-scan-test -action get_chained_bridging_header -- %target-swift-frontend -emit-module \
 // RUN:   -module-name User -module-cache-path %t/clang-module-cache -O \
@@ -74,12 +74,15 @@
 // RUN:   -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import -disable-implicit-swift-modules \
 // RUN:   -import-pch %t/bridging1.pch \
 // RUN:   -explicit-swift-module-map-file %t/map2.json @%t/User.cmd %t/user.swift \
-// RUN:   -emit-module -o %t/User.swiftmodule
+// RUN:   -emit-module -o %t/User.swiftmodule -emit-module-interface-path %t/User.swiftinterface -enable-library-evolution
 
+/// Make sure the emitted content is compatible with original. The embedded header path needs to be original header and no bridging header module leaking into interface.
 // RUN: llvm-bcanalyzer -dump %t/User.swiftmodule | %FileCheck %s --check-prefix CHECK-NO-HEADER
 // CHECK-NO-HEADER-NOT: <IMPORTED_HEADER
+// RUN: %FileCheck %s --check-prefix NO-OBJC-LEAKING --input-file=%t/User.swiftinterface
+// NO-OBJC-LEAKING-NOT: import __ObjC
 
-/// Importing binary module with bridging header for a cached build while also importing a bridging header.
+/// Importing binary module with bridging header from a module with bridging header using explicit build method with header chaining.
 // RUN: %target-swift-frontend -scan-dependencies -module-name User -O \
 // RUN:   -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import \
 // RUN:   -Xcc -fmodule-map-file=%t/a.modulemap -Xcc -fmodule-map-file=%t/b.modulemap \

tools/swift-ide-test/swift-ide-test.cpp

@@ -4524,6 +4524,9 @@ int main(int argc, char *argv[]) {
     options::ImportObjCHeader;
   InitInvok.getClangImporterOptions().BridgingHeader =
     options::ImportObjCHeader;
+  if (!options::ImportObjCHeader.empty())
+    InitInvok.getFrontendOptions().ModuleHasBridgingHeader = true;
+
   InitInvok.getLangOptions().EnableAccessControl =
     !options::DisableAccessControl;
   InitInvok.getLangOptions().EnableDeserializationSafety =