Replaced -disable-copy-prop with multi-var.

nate-chandler · nate-chandler · commit 08bd7c5c99b3 · 2021-12-15T21:36:53.000-08:00
Replaced the -disable-copy-propagation flag with
-enable-copy-propagation=false where the latter is a new multi-var
-enable-copy-propagation= which can take one of three values:
- true
- requested-passes-only
- false
diff --git a/include/swift/Option/FrontendOptions.td b/include/swift/Option/FrontendOptions.td
@@ -215,8 +215,10 @@ def dependency_scan_cache_remarks : Flag<["-"], "Rdependency-scan-cache">,
 def enable_copy_propagation : Flag<["-"], "enable-copy-propagation">,
   HelpText<"Run SIL copy propagation with lexical lifetimes to shorten object "
            "lifetimes while preserving variable lifetimes.">;
-def disable_copy_propagation : Flag<["-"], "disable-copy-propagation">,
-  HelpText<"Don't run SIL copy propagation to preserve object lifetime.">;
+def copy_propagation_state_EQ :
+  Joined<["-"], "enable-copy-propagation=">,
+  HelpText<"Whether to enable copy propagation">,
+  MetaVarName<"true|requested-passes-only|false">;
 
 def enable_infer_public_concurrent_value : Flag<["-"], "enable-infer-public-sendable">,
     HelpText<"Enable inference of Sendable conformances for public structs and enums">;
diff --git a/lib/Frontend/CompilerInvocation.cpp b/lib/Frontend/CompilerInvocation.cpp
@@ -1463,6 +1463,42 @@ static bool ParseSILArgs(SILOptions &Opts, ArgList &Args,
   // -Ounchecked might also set removal of runtime asserts (cond_fail).
   Opts.RemoveRuntimeAsserts |= Args.hasArg(OPT_RemoveRuntimeAsserts);
 
+  Optional<CopyPropagationOption> specifiedCopyPropagationOption;
+  if (Arg *A = Args.getLastArg(OPT_copy_propagation_state_EQ)) {
+    specifiedCopyPropagationOption =
+        llvm::StringSwitch<Optional<CopyPropagationOption>>(A->getValue())
+            .Case("true", CopyPropagationOption::On)
+            .Case("false", CopyPropagationOption::Off)
+            .Case("requested-passes-only",
+                  CopyPropagationOption::RequestedPassesOnly)
+            .Default(None);
+  }
+  if (Args.hasArg(OPT_enable_copy_propagation)) {
+    if (specifiedCopyPropagationOption) {
+      if (*specifiedCopyPropagationOption == CopyPropagationOption::Off) {
+        // Error if copy propagation has been set to ::Off via the meta-var form
+        // and enabled via the flag.
+        Diags.diagnose(SourceLoc(), diag::error_invalid_arg_combination,
+                       "enable-copy-propagation",
+                       "enable-copy-propagation=false");
+        return true;
+      } else if (*specifiedCopyPropagationOption ==
+                 CopyPropagationOption::RequestedPassesOnly) {
+        // Error if copy propagation has been set to ::RequestedPassesOnly via
+        // the meta-var form and enabled via the flag.
+        Diags.diagnose(SourceLoc(), diag::error_invalid_arg_combination,
+                       "enable-copy-propagation",
+                       "enable-copy-propagation=requested-passes-only");
+        return true;
+      }
+    } else {
+      specifiedCopyPropagationOption = CopyPropagationOption::On;
+    }
+  }
+  if (specifiedCopyPropagationOption) {
+    Opts.CopyPropagation = *specifiedCopyPropagationOption;
+  }
+
   Optional<bool> enableLexicalBorrowScopesFlag;
   if (Arg *A = Args.getLastArg(OPT_enable_lexical_borrow_scopes)) {
     enableLexicalBorrowScopesFlag =
@@ -1552,24 +1588,6 @@ static bool ParseSILArgs(SILOptions &Opts, ArgList &Args,
     }
   }
 
-  if (Args.hasArg(OPT_enable_copy_propagation) &&
-      Args.hasArg(OPT_disable_copy_propagation)) {
-    // Error if copy propagation is enabled and copy propagation is disabled.
-    Diags.diagnose(SourceLoc(), diag::error_invalid_arg_combination,
-                   "enable-copy-propagation", "disable-copy-propagation");
-    return true;
-  } else if (Args.hasArg(OPT_enable_copy_propagation) &&
-             !Args.hasArg(OPT_disable_copy_propagation)) {
-    Opts.CopyPropagation = CopyPropagationOption::On;
-  } else if (!Args.hasArg(OPT_enable_copy_propagation) &&
-             Args.hasArg(OPT_disable_copy_propagation)) {
-    Opts.CopyPropagation = CopyPropagationOption::Off;
-  } else /*if (!Args.hasArg(OPT_enable_copy_propagation) &&
-            !Args.hasArg(OPT_disable_copy_propagation))*/
-  {
-    Opts.CopyPropagation = CopyPropagationOption::RequestedPassesOnly;
-  }
-
   Opts.EnableARCOptimizations &= !Args.hasArg(OPT_disable_arc_opts);
   Opts.EnableOSSAModules |= Args.hasArg(OPT_enable_ossa_modules);
   Opts.EnableOSSAOptimizations &= !Args.hasArg(OPT_disable_ossa_opts);
diff --git a/test/DebugInfo/if-branchlocations.swift b/test/DebugInfo/if-branchlocations.swift
@@ -1,4 +1,4 @@
-// RUN: %target-swift-frontend %s -emit-sil -disable-copy-propagation -emit-verbose-sil -g -o - | %FileCheck %s --check-prefixes=CHECK,CHECK-NCP
+// RUN: %target-swift-frontend %s -emit-sil -enable-copy-propagation=false -emit-verbose-sil -g -o - | %FileCheck %s --check-prefixes=CHECK,CHECK-NCP
 // RUN: %target-swift-frontend %s -emit-sil -enable-copy-propagation -enable-lexical-borrow-scopes=false -emit-verbose-sil -g -o - | %FileCheck %s --check-prefixes=CHECK,CHECK-CP
 
 class NSURL {}
diff --git a/test/DebugInfo/linetable-do.swift b/test/DebugInfo/linetable-do.swift
@@ -1,5 +1,5 @@
 // RUN: %target-swift-frontend -Xllvm -sil-full-demangle %s -emit-ir -g -o - | %FileCheck %s
-// RUN: %target-swift-frontend -Xllvm -sil-full-demangle -disable-copy-propagation %s -emit-sil -emit-verbose-sil -g -o - | %FileCheck --check-prefixes=CHECK-SIL,CHECK-NCP %s
+// RUN: %target-swift-frontend -Xllvm -sil-full-demangle -enable-copy-propagation=false %s -emit-sil -emit-verbose-sil -g -o - | %FileCheck --check-prefixes=CHECK-SIL,CHECK-NCP %s
 // RUN: %target-swift-frontend -Xllvm -sil-full-demangle -enable-copy-propagation -enable-lexical-borrow-scopes=false %s -emit-sil -emit-verbose-sil -g -o - | %FileCheck --check-prefixes=CHECK-SIL,CHECK-CP %s
 import StdlibUnittest
 
diff --git a/test/SILOptimizer/closure_lifetime_fixup.swift b/test/SILOptimizer/closure_lifetime_fixup.swift
@@ -1,9 +1,9 @@
 // RUN: %empty-directory(%t)
 // RUN: %target-swift-frontend %S/../Inputs/resilient_struct.swift -enable-library-evolution -emit-module -emit-module-path %t/resilient_struct.swiftmodule
 // RUN: %target-swift-frontend %S/../Inputs/resilient_enum.swift -I %t -enable-library-evolution -emit-module -emit-module-path %t/resilient_enum.swiftmodule
-// RUN: %target-swift-frontend %s -sil-verify-all -emit-sil -disable-copy-propagation -I %t -o - | %FileCheck %s
+// RUN: %target-swift-frontend %s -sil-verify-all -emit-sil -enable-copy-propagation=false -I %t -o - | %FileCheck %s
 
-// Using -disable-copy-propagation to pattern match against older SIL
+// Using -enable-copy-propagation=false to pattern match against older SIL
 // output. At least until -enable-copy-propagation has been around
 // long enough in the same form to be worth rewriting CHECK lines.
 
diff --git a/test/SILOptimizer/closure_lifetime_fixup_concurrency.swift b/test/SILOptimizer/closure_lifetime_fixup_concurrency.swift
@@ -1,5 +1,5 @@
 // RUN: %empty-directory(%t)
-// RUN: %target-swift-frontend %s -sil-verify-all  -disable-availability-checking -emit-sil -disable-copy-propagation -I %t -o - | %FileCheck %s
+// RUN: %target-swift-frontend %s -sil-verify-all  -disable-availability-checking -emit-sil -enable-copy-propagation=false -I %t -o - | %FileCheck %s
 // REQUIRES: concurrency
 
 // CHECK-LABEL: sil @$s34closure_lifetime_fixup_concurrency12testAsyncLetyS2SYaF : $@convention(thin) @async (@guaranteed String) -> @owned String {
diff --git a/test/SILOptimizer/closure_lifetime_fixup_objc.swift b/test/SILOptimizer/closure_lifetime_fixup_objc.swift
@@ -1,7 +1,7 @@
-// RUN: %target-swift-frontend %s -sil-verify-all -emit-sil -disable-copy-propagation -o - -I %S/Inputs/usr/include | %FileCheck %s
+// RUN: %target-swift-frontend %s -sil-verify-all -emit-sil -enable-copy-propagation=false -o - -I %S/Inputs/usr/include | %FileCheck %s
 // REQUIRES: objc_interop
 
-// Using -disable-copy-propagation to pattern match against older SIL
+// Using -enable-copy-propagation=false to pattern match against older SIL
 // output. At least until -enable-copy-propagation has been around
 // long enough in the same form to be worth rewriting CHECK lines.
 
diff --git a/test/SILOptimizer/definite-init-convert-to-escape.swift b/test/SILOptimizer/definite-init-convert-to-escape.swift
@@ -1,7 +1,7 @@
-// RUN: %target-swift-frontend -module-name A -verify -emit-sil -import-objc-header %S/Inputs/Closure.h -disable-copy-propagation -disable-objc-attr-requires-foundation-module %s | %FileCheck %s
-// RUN: %target-swift-frontend -module-name A -verify -emit-sil -import-objc-header %S/Inputs/Closure.h -disable-copy-propagation -disable-objc-attr-requires-foundation-module -Xllvm -sil-disable-convert-escape-to-noescape-switch-peephole %s | %FileCheck %s --check-prefix=NOPEEPHOLE
+// RUN: %target-swift-frontend -module-name A -verify -emit-sil -import-objc-header %S/Inputs/Closure.h -enable-copy-propagation=false -disable-objc-attr-requires-foundation-module %s | %FileCheck %s
+// RUN: %target-swift-frontend -module-name A -verify -emit-sil -import-objc-header %S/Inputs/Closure.h -enable-copy-propagation=false -disable-objc-attr-requires-foundation-module -Xllvm -sil-disable-convert-escape-to-noescape-switch-peephole %s | %FileCheck %s --check-prefix=NOPEEPHOLE
 //
-// Using -disable-copy-propagation to pattern match against older SIL
+// Using -enable-copy-propagation=false to pattern match against older SIL
 // output. At least until -enable-copy-propagation has been around
 // long enough in the same form to be worth rewriting CHECK lines.
 
diff --git a/test/SILOptimizer/definite_init_failable_initializers.swift b/test/SILOptimizer/definite_init_failable_initializers.swift
@@ -1,6 +1,6 @@
-// RUN: %target-swift-frontend -emit-sil -disable-copy-propagation %s | %FileCheck %s
+// RUN: %target-swift-frontend -emit-sil -enable-copy-propagation=false %s | %FileCheck %s
 
-// Using -disable-copy-propagation to pattern match against older SIL
+// Using -enable-copy-propagation=false to pattern match against older SIL
 // output. At least until -enable-copy-propagation has been around
 // long enough in the same form to be worth rewriting CHECK lines.
 
diff --git a/test/SILOptimizer/definite_init_failable_initializers_objc.swift b/test/SILOptimizer/definite_init_failable_initializers_objc.swift
@@ -1,6 +1,6 @@
-// RUN: %target-swift-frontend -emit-sil -disable-copy-propagation -disable-objc-attr-requires-foundation-module %s | %FileCheck %s
+// RUN: %target-swift-frontend -emit-sil -enable-copy-propagation=false -disable-objc-attr-requires-foundation-module %s | %FileCheck %s
 
-// Using -disable-copy-propagation to pattern match against older SIL
+// Using -enable-copy-propagation=false to pattern match against older SIL
 // output. At least until -enable-copy-propagation has been around
 // long enough in the same form to be worth rewriting CHECK lines.
 
diff --git a/test/SILOptimizer/definite_init_objc_factory_init.swift b/test/SILOptimizer/definite_init_objc_factory_init.swift
@@ -1,6 +1,6 @@
-// RUN: %target-swift-frontend(mock-sdk: %clang-importer-sdk) -I %S/../IDE/Inputs/custom-modules %s -emit-sil -disable-copy-propagation | %FileCheck %s
+// RUN: %target-swift-frontend(mock-sdk: %clang-importer-sdk) -I %S/../IDE/Inputs/custom-modules %s -emit-sil -enable-copy-propagation=false | %FileCheck %s
 
-// Using -disable-copy-propagation to pattern match against older SIL
+// Using -enable-copy-propagation=false to pattern match against older SIL
 // output. At least until -enable-copy-propagation has been around
 // long enough in the same form to be worth rewriting CHECK lines.
 
diff --git a/test/SILOptimizer/definite_init_root_class.swift b/test/SILOptimizer/definite_init_root_class.swift
@@ -1,6 +1,6 @@
-// RUN: %target-swift-frontend -emit-sil -disable-copy-propagation %s | %FileCheck %s
+// RUN: %target-swift-frontend -emit-sil -enable-copy-propagation=false %s | %FileCheck %s
 
-// Using -disable-copy-propagation to pattern match against older SIL
+// Using -enable-copy-propagation=false to pattern match against older SIL
 // output. At least until -enable-copy-propagation has been around
 // long enough in the same form to be worth rewriting CHECK lines.
 
diff --git a/tools/sil-opt/SILOpt.cpp b/tools/sil-opt/SILOpt.cpp
@@ -138,13 +138,97 @@ static llvm::cl::opt<bool> EnableOSSAModules(
                    "this is disabled we do not serialize in OSSA "
                    "form when optimizing."));
 
-static llvm::cl::opt<bool>
-    EnableCopyPropagation("enable-copy-propagation", llvm::cl::init(false),
-                          llvm::cl::desc("Enable the copy propagation pass."));
+namespace llvm {
+
+inline raw_ostream &operator<<(raw_ostream &os,
+                               const Optional<CopyPropagationOption> option) {
+  if (option) {
+    switch (*option) {
+    case CopyPropagationOption::Off:
+      os << "off";
+      break;
+    case CopyPropagationOption::RequestedPassesOnly:
+      os << "requested-passes-only";
+      break;
+    case CopyPropagationOption::On:
+      os << "on";
+      break;
+    }
+  } else {
+    os << "<none>";
+  }
+  return os;
+}
+
+namespace cl {
+template <>
+class parser<::Optional<CopyPropagationOption>>
+    : public basic_parser<::Optional<CopyPropagationOption>> {
+public:
+  parser(Option &O) : basic_parser<::Optional<CopyPropagationOption>>(O) {}
+
+  // parse - Return true on error.
+  bool parse(Option &O, StringRef ArgName, StringRef Arg,
+             ::Optional<CopyPropagationOption> &Value) {
+    if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
+        Arg == "1") {
+      Value = CopyPropagationOption::On;
+      return false;
+    }
+    if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
+      Value = CopyPropagationOption::Off;
+      return false;
+    }
+    if (Arg == "requested-passes-only" || Arg == "REQUESTED-PASSES-ONLY" ||
+        Arg == "Requested-Passes-Only") {
+      Value = CopyPropagationOption::RequestedPassesOnly;
+      return false;
+    }
+
+    return O.error("'" + Arg +
+                   "' is invalid for CopyPropagationOption! Try true, false, "
+                   "or requested-passes-only.");
+  }
 
-static llvm::cl::opt<bool> DisableCopyPropagation(
-    "disable-copy-propagation", llvm::cl::init(false),
-    llvm::cl::desc("Disable the copy propagation pass."));
+  void initialize() {}
+
+  enum ValueExpected getValueExpectedFlagDefault() const {
+    return ValueOptional;
+  }
+
+  StringRef getValueName() const override { return "CopyPropagationOption"; }
+
+  // Instantiate the macro PRINT_OPT_DIFF of llvm_project's CommandLine.cpp at
+  // ::Optional<CopyPropagationOption>.
+  void printOptionDiff(const Option &O, ::Optional<CopyPropagationOption> V,
+                       OptionValue<::Optional<CopyPropagationOption>> D,
+                       size_t GlobalWidth) const {
+    size_t MaxOptWidth = 8;
+    printOptionName(O, GlobalWidth);
+    std::string Str;
+    {
+      raw_string_ostream SS(Str);
+      SS << V;
+    }
+    outs() << "= " << Str;
+    size_t NumSpaces = MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0;
+    outs().indent(NumSpaces) << " (default:";
+    if (D.hasValue())
+      outs() << D.getValue();
+    else
+      outs() << "*no default*";
+    outs() << ")\n";
+  }
+};
+} // end namespace cl
+} // end namespace llvm
+
+static llvm::cl::opt<Optional<CopyPropagationOption>, /*ExternalStorage*/ false,
+                     llvm::cl::parser<Optional<CopyPropagationOption>>>
+    CopyPropagationState(
+        "enable-copy-propagation",
+        llvm::cl::desc("Whether to run the copy propagation pass: "
+                       "'true', 'false', or 'requested-passes-only'."));
 
 namespace {
 enum class EnforceExclusivityMode {
@@ -525,16 +609,8 @@ int main(int argc, char **argv) {
   SILOpts.IgnoreAlwaysInline = IgnoreAlwaysInline;
   SILOpts.EnableOSSAModules = EnableOSSAModules;
 
-  if (EnableCopyPropagation && DisableCopyPropagation) {
-    fprintf(stderr, "Error! Cannot specify both -enable-copy-propagation "
-                    "and -disable-copy-propagation.");
-    exit(-1);
-  } else if (EnableCopyPropagation && !DisableCopyPropagation) {
-    SILOpts.CopyPropagation = CopyPropagationOption::On;
-  } else if (!EnableCopyPropagation && DisableCopyPropagation) {
-    SILOpts.CopyPropagation = CopyPropagationOption::Off;
-  } else /*if (!EnableCopyPropagation && !DisableCopyPropagation)*/ {
-    SILOpts.CopyPropagation = CopyPropagationOption::RequestedPassesOnly;
+  if (CopyPropagationState) {
+    SILOpts.CopyPropagation = *CopyPropagationState;
   }
 
   // Unless overridden below, enabling copy propagation means enabling lexical

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// RUN: %target-swift-frontend %s -emit-sil -disable-copy-propagation -emit-verbose-sil -g -o - \| %FileCheck %s --check-prefixes=CHECK,CHECK-NCP`
	`1`	`+// RUN: %target-swift-frontend %s -emit-sil -enable-copy-propagation=false -emit-verbose-sil -g -o - \| %FileCheck %s --check-prefixes=CHECK,CHECK-NCP`
`2`	`2`	`// RUN: %target-swift-frontend %s -emit-sil -enable-copy-propagation -enable-lexical-borrow-scopes=false -emit-verbose-sil -g -o - \| %FileCheck %s --check-prefixes=CHECK,CHECK-CP`
`3`	`3`
`4`	`4`	`class NSURL {}`