Merge pull request #72249 from apple/es/pkg-cmo

elsh · web-flow · commit 56d337d322b0 · 2024-03-13T09:26:35.000-07:00
diff --git a/include/swift/AST/SILOptions.h b/include/swift/AST/SILOptions.h
@@ -126,6 +126,14 @@ class SILOptions {
   /// Controls whether cross module optimization is enabled.
   CrossModuleOptimizationMode CMOMode = CrossModuleOptimizationMode::Off;
 
+  /// Optimization to perform default CMO within a package boundary.
+  /// Unlike the existing CMO, package CMO can be built with
+  /// -enable-library-evolution since package modules are required
+  /// to be built in the same project. To enable this optimization, the
+  /// module also needs to opt in to allow non-resilient access with
+  /// -experimental-allow-non-resilient-access.
+  bool EnableSerializePackage = true;
+
   /// Enables the emission of stack protectors in functions.
   bool EnableStackProtection = true;
 
diff --git a/include/swift/Option/Options.td b/include/swift/Option/Options.td
@@ -984,6 +984,10 @@ def Oplayground : Flag<["-"], "Oplayground">, Group<O_Group>,
   Flags<[HelpHidden, FrontendOption, ModuleInterfaceOption]>,
   HelpText<"Compile with optimizations appropriate for a playground">;
 
+def ExperimentalPackageCMO : Flag<["-"], "experimental-package-cmo">,
+  Flags<[FrontendOption]>,
+  HelpText<"Enable optimization to perform defalut CMO within a package boundary">;
+
 def EnbaleDefaultCMO : Flag<["-"], "enable-default-cmo">,
   Flags<[HelpHidden, FrontendOption]>,
   HelpText<"Perform conservative cross-module optimization">;
diff --git a/include/swift/SIL/SILLinkage.h b/include/swift/SIL/SILLinkage.h
@@ -289,6 +289,26 @@ inline bool hasPublicVisibility(SILLinkage linkage) {
   llvm_unreachable("Unhandled SILLinkage in switch.");
 }
 
+inline bool hasPublicOrPackageVisibility(SILLinkage linkage, bool includePackage) {
+    switch (linkage) {
+    case SILLinkage::Public:
+    case SILLinkage::PublicExternal:
+    case SILLinkage::PublicNonABI:
+        return true;
+    case SILLinkage::Package:
+    case SILLinkage::PackageExternal:
+    case SILLinkage::PackageNonABI:
+        return includePackage;
+    case SILLinkage::Hidden:
+    case SILLinkage::Shared:
+    case SILLinkage::Private:
+    case SILLinkage::HiddenExternal:
+        return false;
+    }
+
+    llvm_unreachable("Unhandled SILLinkage in switch.");
+}
+
 inline bool hasSharedVisibility(SILLinkage linkage) {
   switch (linkage) {
   case SILLinkage::Shared:
diff --git a/lib/Driver/ToolChains.cpp b/lib/Driver/ToolChains.cpp
@@ -300,6 +300,7 @@ void ToolChain::addCommonFrontendArgs(const OutputInfo &OI,
   inputArgs.AddLastArg(arguments, options::OPT_suppress_warnings);
   inputArgs.AddLastArg(arguments, options::OPT_suppress_remarks);
   inputArgs.AddLastArg(arguments, options::OPT_experimental_package_bypass_resilience);
+  inputArgs.AddLastArg(arguments, options::OPT_ExperimentalPackageCMO);
   inputArgs.AddLastArg(arguments, options::OPT_profile_generate);
   inputArgs.AddLastArg(arguments, options::OPT_profile_use);
   inputArgs.AddLastArg(arguments, options::OPT_profile_coverage_mapping);
diff --git a/lib/Frontend/CompilerInvocation.cpp b/lib/Frontend/CompilerInvocation.cpp
@@ -2341,6 +2341,18 @@ static bool ParseSILArgs(SILOptions &Opts, ArgList &Args,
   } else if (Args.hasArg(OPT_EnbaleCMOEverything)) {
     Opts.CMOMode = CrossModuleOptimizationMode::Everything;
   }
+
+  if (Args.hasArg(OPT_ExperimentalPackageCMO)) {
+    if (!FEOpts.AllowNonResilientAccess) {
+      Diags.diagnose(SourceLoc(), diag::ignoring_option_requires_option,
+                     "-experimental-package-cmo",
+                     "-experimental-allow-non-resilient-access");
+    } else {
+      Opts.EnableSerializePackage = true;
+      Opts.CMOMode = CrossModuleOptimizationMode::Default;
+    }
+  }
+
   Opts.EnableStackProtection =
       Args.hasFlag(OPT_enable_stack_protector, OPT_disable_stack_protector,
                    Opts.EnableStackProtection);
diff --git a/lib/IRGen/IRGenSIL.cpp b/lib/IRGen/IRGenSIL.cpp
@@ -2446,8 +2446,10 @@ void IRGenModule::emitSILFunction(SILFunction *f) {
       f->getLoweredFunctionType()->isPolymorphic())
     return;
 
-  // Do not emit bodies of public_external functions.
-  if (hasPublicVisibility(f->getLinkage()) && f->isAvailableExternally())
+  // Do not emit bodies of public_external or package_external functions.
+  if (hasPublicOrPackageVisibility(f->getLinkage(),
+                                   f->getASTContext().SILOpts.EnableSerializePackage) &&
+      f->isAvailableExternally())
     return;
 
   PrettyStackTraceSILFunction stackTrace("emitting IR", f);
diff --git a/lib/SIL/IR/SILFunction.cpp b/lib/SIL/IR/SILFunction.cpp
@@ -898,8 +898,8 @@ bool SILFunction::hasValidLinkageForFragileRef() const {
       isAvailableExternally())
     return false;
 
-  // Otherwise, only public functions can be referenced.
-  return hasPublicVisibility(getLinkage());
+  // Otherwise, only public or package functions can be referenced.
+  return hasPublicOrPackageVisibility(getLinkage(), getModule().getOptions().EnableSerializePackage);
 }
 
 bool
diff --git a/lib/SIL/Verifier/SILVerifier.cpp b/lib/SIL/Verifier/SILVerifier.cpp
@@ -2419,7 +2419,7 @@ class SILVerifier : public SILVerifierBase<SILVerifier> {
     }
     if (F.isSerialized()) {
       require(RefG->isSerialized()
-                || hasPublicVisibility(RefG->getLinkage()),
+                || hasPublicOrPackageVisibility(RefG->getLinkage(), F.getModule().getOptions().EnableSerializePackage),
               "alloc_global inside fragile function cannot "
               "reference a private or hidden symbol");
     }
@@ -2438,7 +2438,7 @@ class SILVerifier : public SILVerifierBase<SILVerifier> {
     }
     if (F.isSerialized()) {
       require(RefG->isSerialized()
-              || hasPublicVisibility(RefG->getLinkage()),
+              || hasPublicOrPackageVisibility(RefG->getLinkage(), F.getModule().getOptions().EnableSerializePackage),
               "global_addr/value inside fragile function cannot "
               "reference a private or hidden symbol");
     }
diff --git a/lib/SILOptimizer/IPO/CrossModuleOptimization.cpp b/lib/SILOptimizer/IPO/CrossModuleOptimization.cpp
@@ -161,14 +161,26 @@ class InstructionVisitor : public SILCloner<InstructionVisitor> {
   }
 };
 
+static bool isVisible(SILLinkage linkage, SILOptions options) {
+  if (options.EnableSerializePackage)
+    return linkage == SILLinkage::Public || linkage == SILLinkage::Package;
+  return linkage == SILLinkage::Public;
+}
+static bool isVisible(AccessLevel accessLevel, SILOptions options) {
+  if (options.EnableSerializePackage)
+    return accessLevel == AccessLevel::Package || accessLevel == AccessLevel::Public;
+  return accessLevel == AccessLevel::Public;
+}
+
 /// Select functions in the module which should be serialized.
 void CrossModuleOptimization::serializeFunctionsInModule() {
 
   FunctionFlags canSerializeFlags;
 
   // Start with public functions.
   for (SILFunction &F : M) {
-    if (F.getLinkage() == SILLinkage::Public || everything) {
+    if (isVisible(F.getLinkage(), M.getOptions()) ||
+        everything) {
       if (canSerializeFunction(&F, canSerializeFlags, /*maxDepth*/ 64)) {
         serializeFunction(&F, canSerializeFlags);
       }
@@ -185,7 +197,6 @@ bool CrossModuleOptimization::canSerializeFunction(
                                FunctionFlags &canSerializeFlags,
                                int maxDepth) {
   auto iter = canSerializeFlags.find(function);
-  
   // Avoid infinite recursion in case it's a cycle in the call graph.
   if (iter != canSerializeFlags.end())
     return iter->second;
@@ -270,7 +281,7 @@ bool CrossModuleOptimization::canSerializeInstruction(SILInstruction *inst,
     // function is completely inlined afterwards.
     // Also, when emitting TBD files, we cannot introduce a new public symbol.
     if ((conservative || M.getOptions().emitTBD) &&
-        !hasPublicVisibility(callee->getLinkage())) {
+        !hasPublicOrPackageVisibility(callee->getLinkage(), M.getOptions().EnableSerializePackage)) {
       return false;
     }
 
@@ -290,13 +301,12 @@ bool CrossModuleOptimization::canSerializeInstruction(SILInstruction *inst,
     // inline.
     if (!canUseFromInline(callee))
       return false;
-  
     return true;
   }
   if (auto *GAI = dyn_cast<GlobalAddrInst>(inst)) {
     SILGlobalVariable *global = GAI->getReferencedGlobal();
     if ((conservative || M.getOptions().emitTBD) &&
-        !hasPublicVisibility(global->getLinkage())) {
+        !hasPublicOrPackageVisibility(global->getLinkage(), M.getOptions().EnableSerializePackage)) {
       return false;
     }
 
@@ -344,7 +354,7 @@ bool CrossModuleOptimization::canSerializeGlobal(SILGlobalVariable *global) {
       // function is completely inlined afterwards.
       // Also, when emitting TBD files, we cannot introduce a new public symbol.
       if ((conservative || M.getOptions().emitTBD) &&
-          !hasPublicVisibility(referencedFunc->getLinkage())) {
+          !hasPublicOrPackageVisibility(referencedFunc->getLinkage(), M.getOptions().EnableSerializePackage)) {
         return false;
       }
 
@@ -368,7 +378,7 @@ bool CrossModuleOptimization::canSerializeType(SILType type) {
         if (conservative && subNT->getEffectiveAccess() < AccessLevel::Package) {
           return true;
         }
-      
+
         // Exclude types which are defined in an @_implementationOnly imported
         // module. Such modules are not transitively available.
         if (!canUseFromInline(subNT)) {
@@ -542,15 +552,15 @@ void CrossModuleOptimization::serializeInstruction(SILInstruction *inst,
       }
     }
     serializeFunction(callee, canSerializeFlags);
-    assert(callee->isSerialized() || callee->getLinkage() == SILLinkage::Public);
+    assert(callee->isSerialized() || isVisible(callee->getLinkage(), M.getOptions()));
     return;
   }
   if (auto *GAI = dyn_cast<GlobalAddrInst>(inst)) {
     SILGlobalVariable *global = GAI->getReferencedGlobal();
     if (canSerializeGlobal(global)) {
       serializeGlobal(global);
     }
-    if (!hasPublicVisibility(global->getLinkage())) {
+    if (!hasPublicOrPackageVisibility(global->getLinkage(), M.getOptions().EnableSerializePackage)) {
       global->setLinkage(SILLinkage::Public);
     }
     return;
@@ -606,7 +616,7 @@ void CrossModuleOptimization::makeDeclUsableFromInline(ValueDecl *decl) {
   if (M.getSwiftModule() != decl->getDeclContext()->getParentModule())
     return;
 
-  if (decl->getFormalAccess() < AccessLevel::Public &&
+  if (!isVisible(decl->getFormalAccess(), M.getOptions()) &&
       !decl->isUsableFromInline()) {
     // Mark the nominal type as "usableFromInline".
     // TODO: find a way to do this without modifying the AST. The AST should be
diff --git a/lib/Serialization/DeserializeSIL.cpp b/lib/Serialization/DeserializeSIL.cpp
@@ -77,6 +77,7 @@ static std::optional<SILLinkage> fromStableSILLinkage(unsigned value) {
   case SIL_LINKAGE_SHARED: return SILLinkage::Shared;
   case SIL_LINKAGE_PRIVATE: return SILLinkage::Private;
   case SIL_LINKAGE_PUBLIC_EXTERNAL: return SILLinkage::PublicExternal;
+  case SIL_LINKAGE_PACKAGE_EXTERNAL: return SILLinkage::PackageExternal;
   case SIL_LINKAGE_HIDDEN_EXTERNAL: return SILLinkage::HiddenExternal;
   }
 
diff --git a/test/SILOptimizer/Inputs/cross-module/default-module.swift b/test/SILOptimizer/Inputs/cross-module/default-module.swift
@@ -1,20 +1,32 @@
-
 import Submodule
 import PrivateCModule
 
 public func incrementByThree(_ x: Int) -> Int {
   return incrementByOne(x) + 2
 }
 
+package func pkgFunc(_ x: Int) -> Int {
+  return subPkgFunc(x) + 2
+}
+
 public func incrementByThreeWithCall(_ x: Int) -> Int {
   return incrementByOneNoCMO(x) + 2
 }
 
+package func pkgFuncNoCMO(_ x: Int) -> Int {
+  return subPkgFuncNoCMO(x) + 2
+}
+
 public func submoduleKlassMember() -> Int {
   let k = SubmoduleKlass()
   return k.i
 }
 
+package func pkgSubmoduleKlassMember() -> Int {
+  let k = PkgSubmoduleKlass()
+  return k.i
+}
+
 public final class ModuleKlass {
   public var i: Int
 
@@ -28,11 +40,29 @@ public func moduleKlassMember() -> Int {
   return k.i
 }
 
+package final class PkgModuleKlass {
+  package var i: Int
+
+  package init() {
+    i = 27
+  }
+}
+
+package func pkgModuleKlassMember() -> Int {
+  let k = PkgModuleKlass()
+  return k.i
+}
+
 public struct ModuleStruct {
   public static var publicFunctionPointer: (Int) -> (Int) = incrementByThree
   public static var privateFunctionPointer: (Int) -> (Int) = { $0 }
 }
 
+package struct PkgModuleStruct {
+  package static var funcPointer: (Int) -> (Int) = pkgFunc
+  package static var closurePointer: (Int) -> (Int) = { $0 }
+}
+
 public func callPrivateCFunc() -> Int {
   return Int(privateCFunc())
 }
diff --git a/test/SILOptimizer/Inputs/cross-module/default-submodule.swift b/test/SILOptimizer/Inputs/cross-module/default-submodule.swift
@@ -3,11 +3,20 @@ public func incrementByOne(_ x: Int) -> Int {
   return x + 1
 }
 
+package func subPkgFunc(_ x: Int) -> Int {
+  return x + 1
+}
+
 @_semantics("optimize.no.crossmodule")
 public func incrementByOneNoCMO(_ x: Int) -> Int {
   return x + 1
 }
 
+@_semantics("optimize.no.crossmodule")
+package func subPkgFuncNoCMO(_ x: Int) -> Int {
+  return x + 1
+}
+
 public final class SubmoduleKlass {
   public var i: Int
 
@@ -16,3 +25,10 @@ public final class SubmoduleKlass {
   }
 }
 
+package final class PkgSubmoduleKlass {
+  package var i: Int
+
+  package init() {
+    i = 27
+  }
+}
diff --git a/test/SILOptimizer/default-cmo.swift b/test/SILOptimizer/default-cmo.swift
@@ -1,11 +1,11 @@
 
 // RUN: %empty-directory(%t) 
 
-// RUN: %target-build-swift -O -wmo -Xfrontend -enable-default-cmo -parse-as-library -emit-module -emit-module-path=%t/Submodule.swiftmodule -module-name=Submodule %S/Inputs/cross-module/default-submodule.swift -c -o %t/submodule.o
-// RUN: %target-build-swift -O -wmo -Xfrontend -enable-default-cmo -parse-as-library -emit-module -emit-module-path=%t/Module.swiftmodule -module-name=Module -I%t -I%S/Inputs/cross-module %S/Inputs/cross-module/default-module.swift -c -o %t/module.o
-// RUN: %target-build-swift -O -wmo -Xfrontend -enable-default-cmo -parse-as-library -emit-tbd -emit-tbd-path %t/ModuleTBD.tbd -emit-module -emit-module-path=%t/ModuleTBD.swiftmodule -module-name=ModuleTBD -I%t -I%S/Inputs/cross-module %S/Inputs/cross-module/default-module.swift -c -o %t/moduletbd.o -Xfrontend -tbd-install_name -Xfrontend module
+// RUN: %target-build-swift -O -wmo -Xfrontend -enable-default-cmo -parse-as-library -emit-module -emit-module-path=%t/Submodule.swiftmodule -module-name=Submodule -package-name Pkg %S/Inputs/cross-module/default-submodule.swift -c -o %t/submodule.o
+// RUN: %target-build-swift -O -wmo -Xfrontend -enable-default-cmo -parse-as-library -emit-module -emit-module-path=%t/Module.swiftmodule -module-name=Module -package-name Pkg -I%t -I%S/Inputs/cross-module %S/Inputs/cross-module/default-module.swift -c -o %t/module.o
+// RUN: %target-build-swift -O -wmo -Xfrontend -enable-default-cmo -parse-as-library -emit-tbd -emit-tbd-path %t/ModuleTBD.tbd -emit-module -emit-module-path=%t/ModuleTBD.swiftmodule -module-name=ModuleTBD -package-name Pkg -I%t -I%S/Inputs/cross-module %S/Inputs/cross-module/default-module.swift -c -o %t/moduletbd.o -Xfrontend -tbd-install_name -Xfrontend module
 
-// RUN: %target-build-swift -O -wmo -module-name=Main -I%t -I%S/Inputs/cross-module %s -emit-sil | %FileCheck %s
+// RUN: %target-build-swift -O -wmo -module-name=Main -package-name Pkg -I%t -I%S/Inputs/cross-module %s -emit-sil | %FileCheck %s
 
 // REQUIRES: swift_in_compiler
 
diff --git a/test/SILOptimizer/package-cmo.swift b/test/SILOptimizer/package-cmo.swift

Original file line number	Diff line number	Diff line change
`@@ -898,8 +898,8 @@ bool SILFunction::hasValidLinkageForFragileRef() const {`
`898`	`898`	`isAvailableExternally())`
`899`	`899`	`return false;`
`900`	`900`
`901`		`- // Otherwise, only public functions can be referenced.`
`902`		`- return hasPublicVisibility(getLinkage());`
	`901`	`+ // Otherwise, only public or package functions can be referenced.`
	`902`	`+ return hasPublicOrPackageVisibility(getLinkage(), getModule().getOptions().EnableSerializePackage);`
`903`	`903`	`}`
`904`	`904`
`905`	`905`	`bool`
Original file line number	Diff line number	Diff line change
`@@ -2419,7 +2419,7 @@ class SILVerifier : public SILVerifierBase<SILVerifier> {`
`2419`	`2419`	`}`
`2420`	`2420`	`if (F.isSerialized()) {`
`2421`	`2421`	`require(RefG->isSerialized()`
`2422`		`- \|\| hasPublicVisibility(RefG->getLinkage()),`
	`2422`	`+ \|\| hasPublicOrPackageVisibility(RefG->getLinkage(), F.getModule().getOptions().EnableSerializePackage),`
`2423`	`2423`	`"alloc_global inside fragile function cannot "`
`2424`	`2424`	`"reference a private or hidden symbol");`
`2425`	`2425`	`}`
`@@ -2438,7 +2438,7 @@ class SILVerifier : public SILVerifierBase<SILVerifier> {`
`2438`	`2438`	`}`
`2439`	`2439`	`if (F.isSerialized()) {`
`2440`	`2440`	`require(RefG->isSerialized()`
`2441`		`- \|\| hasPublicVisibility(RefG->getLinkage()),`
	`2441`	`+ \|\| hasPublicOrPackageVisibility(RefG->getLinkage(), F.getModule().getOptions().EnableSerializePackage),`
`2442`	`2442`	`"global_addr/value inside fragile function cannot "`
`2443`	`2443`	`"reference a private or hidden symbol");`
`2444`	`2444`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,7 @@ static std::optional<SILLinkage> fromStableSILLinkage(unsigned value) {`
`77`	`77`	`case SIL_LINKAGE_SHARED: return SILLinkage::Shared;`
`78`	`78`	`case SIL_LINKAGE_PRIVATE: return SILLinkage::Private;`
`79`	`79`	`case SIL_LINKAGE_PUBLIC_EXTERNAL: return SILLinkage::PublicExternal;`
	`80`	`+ case SIL_LINKAGE_PACKAGE_EXTERNAL: return SILLinkage::PackageExternal;`
`80`	`81`	`case SIL_LINKAGE_HIDDEN_EXTERNAL: return SILLinkage::HiddenExternal;`
`81`	`82`	`}`
`82`	`83`