PassManager: simplify the options to print intermediate SIL.

* rename -sil-print-only-function to -sil-print-function and -sil-print-only-functions to -sil-print-functions
* to print single functions, don't require -Xllvm -sil-print-all. It's now sufficient to use e.g. -Xllvm -sil-print-function=<f>
But it's still possible to select functions with -sil-print-function(s) for other print options, -sil-print-after.

Author: eeckstein

docs/DebuggingTheCompiler.md

@@ -212,47 +212,31 @@ Often it is not sufficient to dump the SIL at the beginning or end of
 the optimization pipeline. The SILPassManager supports useful options
 to dump the SIL also between pass runs.
 
-The SILPassManager's SIL dumping options vary along two orthogonal
-functional axes:
+A short (non-exhaustive) list of SIL printing options:
 
-1. Options that control if functions/modules are printed.
-2. Options that filter what is printed at those points.
+* `-Xllvm '-sil-print-function=SWIFT_MANGLED_NAME'`: Print the specified
+  function after each pass which modifies the function. Note that for module
+  passes, the function is printed if the pass changed _any_ function (the
+  pass manager doesn't know which functions a module pass has changed).
+  Multiple functions can be specified as a comma separated list.
 
-One generally always specifies an option of type 1 and optionally adds
-an option of type 2 to filter the output.
+* `-Xllvm '-sil-print-functions=NAME'`: Like `-sil-print-function`, except that
+  functions are selected if NAME is _contained_ in their mangled names.
 
-A short (non-exhaustive) list of type 1 options:
+* `-Xllvm -sil-print-all`: Print all functions when ever a function pass
+  modifies a function and print the entire module if a module pass modifies
+  the SILModule.
 
-* `-Xllvm -sil-print-all`: Print functions/modules when ever a
-  function pass modifies a function and Print the entire module
-  (modulo filtering) if a module pass modifies a SILModule.
+* `-Xllvm -sil-print-around=$PASS_NAME`: Print the SIL before and after a pass
+  with name `$PASS_NAME` runs on a function or module.
+  By default it prints the whole module. To print only specific functions, add
+  `-sil-print-function` and/or `-sil-print-functions`.
 
-A short (non-exhaustive) list of type 2 options:
+* `-Xllvm -sil-print-before=$PASS_NAME`: Like `-sil-print-around`, but prints
+  the SIL only _before_ the specfied pass runs.
 
-* `-Xllvm -sil-print-around=$PASS_NAME`: Print a function/module
-  before and after a function pass with name `$PASS_NAME` runs on a
-  function/module or dump a module before a module pass with name
-  `$PASS_NAME` runs on a module.
-
-* `-Xllvm -sil-print-before=$PASS_NAME`: Print a function/module
-  before a function pass with name `$PASS_NAME` runs on a
-  function/module or dump a module before a module pass with name
-  `$PASS_NAME` runs on a module. NOTE: This happens even without
-  sil-print-all set!
-
-* `-Xllvm -sil-print-after=$PASS_NAME`: Print a function/module
-  after a function pass with name `$PASS_NAME` runs on a
-  function/module or dump a module before a module pass with name
-  `$PASS_NAME` runs on a module.
-
-* `-Xllvm '-sil-print-only-function=SWIFT_MANGLED_NAME'`: When ever
-  one would print a function/module, only print the given function.
-
-These options together allow one to visualize how a
-SILFunction/SILModule is optimized by the optimizer as each
-optimization pass runs easily via formulations like:
-
-    swiftc -Xllvm '-sil-print-only-function=$myMainFunction' -Xllvm -sil-print-all
+* `-Xllvm -sil-print-after=$PASS_NAME`: Like `-sil-print-around`, but prints
+  the SIL only _after_ the specfied pass did run.
 
 NOTE: This may emit a lot of text to stderr, so be sure to pipe the
 output to a file.
@@ -586,11 +570,11 @@ it's quite easy to do this manually:
 
 2. Get the SIL before and after the bad optimization.
 
-  a. Add the compiler options
-     `-Xllvm -sil-print-all -Xllvm -sil-print-only-function='<function>'`
+  a. Add the compiler option
+     `-Xllvm -sil-print-function='<function>'`
      where `<function>` is the function name (including the preceding `$`).
      For example:
-     `-Xllvm -sil-print-all -Xllvm -sil-print-only-function='$s4test6testityS2iF'`.
+     `-Xllvm -sil-print-function='$s4test6testityS2iF'`.
      Again, the output can be large, so it's best to redirect stderr to a file.
   b. From the output, copy the SIL of the function *before* the bad
      run into a separate file and the SIL *after* the bad run into a file.

lib/SILOptimizer/PassManager/PassManager.cpp

@@ -60,11 +60,11 @@ llvm::cl::opt<std::string> SILBreakOnPass(
     llvm::cl::desc("Break before running a particular function pass"));
 
 llvm::cl::list<std::string>
-    SILPrintOnlyFun("sil-print-only-function", llvm::cl::CommaSeparated,
+    SILPrintFunction("sil-print-function", llvm::cl::CommaSeparated,
                     llvm::cl::desc("Only print out the sil for this function"));
 
 llvm::cl::opt<std::string>
-    SILPrintOnlyFuns("sil-print-only-functions", llvm::cl::init(""),
+    SILPrintFunctions("sil-print-functions", llvm::cl::init(""),
                      llvm::cl::desc("Only print out the sil for the functions "
                                     "whose name contains this substring"));
 
@@ -157,13 +157,23 @@ static llvm::cl::opt<DebugOnlyPassNumberOpt, true,
               llvm::cl::location(DebugOnlyPassNumberOptLoc),
               llvm::cl::ValueRequired);
 
-static bool doPrintBefore(SILTransform *T, SILFunction *F) {
-  if (!SILPrintOnlyFun.empty() && F && SILPrintOnlyFun.end() ==
-      std::find(SILPrintOnlyFun.begin(), SILPrintOnlyFun.end(), F->getName()))
+static bool isFunctionSelectedForPrinting(SILFunction *F) {
+  if (!SILPrintFunction.empty() && SILPrintFunction.end() ==
+      std::find(SILPrintFunction.begin(), SILPrintFunction.end(), F->getName()))
+    return false;
+
+  if (!F->getName().contains(SILPrintFunctions))
     return false;
 
-  if (!SILPrintOnlyFuns.empty() && F &&
-      !F->getName().contains(SILPrintOnlyFuns))
+  return true;
+}
+
+static bool functionSelectionEmpty() {
+  return SILPrintFunction.empty() && SILPrintFunctions.empty();
+}
+
+static bool doPrintBefore(SILTransform *T, SILFunction *F) {
+  if (F && !isFunctionSelectedForPrinting(F))
     return false;
 
   auto MatchFun = [&](const std::string &Str) -> bool {
@@ -173,21 +183,20 @@ static bool doPrintBefore(SILTransform *T, SILFunction *F) {
   if (SILPrintBefore.end() !=
       std::find_if(SILPrintBefore.begin(), SILPrintBefore.end(), MatchFun))
     return true;
+  if (!SILPrintBefore.empty())
+    return false;
 
   if (SILPrintAround.end() !=
       std::find_if(SILPrintAround.begin(), SILPrintAround.end(), MatchFun))
     return true;
+  if (!SILPrintAround.empty())
+    return false;
 
   return false;
 }
 
-static bool doPrintAfter(SILTransform *T, SILFunction *F, bool Default) {
-  if (!SILPrintOnlyFun.empty() && F && SILPrintOnlyFun.end() ==
-      std::find(SILPrintOnlyFun.begin(), SILPrintOnlyFun.end(), F->getName()))
-    return false;
-
-  if (!SILPrintOnlyFuns.empty() && F &&
-      !F->getName().contains(SILPrintOnlyFuns))
+static bool doPrintAfter(SILTransform *T, SILFunction *F, bool PassChangedSIL) {
+  if (F && !isFunctionSelectedForPrinting(F))
     return false;
 
   auto MatchFun = [&](const std::string &Str) -> bool {
@@ -197,12 +206,16 @@ static bool doPrintAfter(SILTransform *T, SILFunction *F, bool Default) {
   if (SILPrintAfter.end() !=
       std::find_if(SILPrintAfter.begin(), SILPrintAfter.end(), MatchFun))
     return true;
+  if (!SILPrintAfter.empty())
+    return false;
 
   if (SILPrintAround.end() !=
       std::find_if(SILPrintAround.begin(), SILPrintAround.end(), MatchFun))
     return true;
+  if (!SILPrintAround.empty())
+    return false;
 
-  return Default;
+  return PassChangedSIL && (SILPrintAll || !functionSelectionEmpty());
 }
 
 static bool isDisabled(SILTransform *T, SILFunction *F = nullptr) {
@@ -221,16 +234,12 @@ static bool isDisabled(SILTransform *T, SILFunction *F = nullptr) {
 }
 
 static void printModule(SILModule *Mod, bool EmitVerboseSIL) {
-  if (SILPrintOnlyFun.empty() && SILPrintOnlyFuns.empty()) {
+  if (functionSelectionEmpty()) {
     Mod->dump();
     return;
   }
   for (auto &F : *Mod) {
-    if (!SILPrintOnlyFun.empty() && SILPrintOnlyFun.end() !=
-        std::find(SILPrintOnlyFun.begin(), SILPrintOnlyFun.end(), F.getName()))
-      F.dump(EmitVerboseSIL);
-
-    if (!SILPrintOnlyFuns.empty() && F.getName().contains(SILPrintOnlyFuns))
+    if (isFunctionSelectedForPrinting(&F))
       F.dump(EmitVerboseSIL);
   }
 }
@@ -472,7 +481,7 @@ void SILPassManager::runPassOnFunction(unsigned TransIdx, SILFunction *F) {
   }
 
   // If this pass invalidated anything, print and verify.
-  if (doPrintAfter(SFT, F, CurrentPassHasInvalidated && SILPrintAll)) {
+  if (doPrintAfter(SFT, F, CurrentPassHasInvalidated)) {
     dumpPassInfo("*** SIL function after ", TransIdx);
     F->dump(getOptions().EmitVerboseSIL);
   }
@@ -617,8 +626,7 @@ void SILPassManager::runModulePass(unsigned TransIdx) {
   }
 
   // If this pass invalidated anything, print and verify.
-  if (doPrintAfter(SMT, nullptr,
-                   CurrentPassHasInvalidated && SILPrintAll)) {
+  if (doPrintAfter(SMT, nullptr, CurrentPassHasInvalidated)) {
     dumpPassInfo("*** SIL module after", TransIdx);
     printModule(Mod, Options.EmitVerboseSIL);
   }
@@ -731,7 +739,7 @@ SILPassManager::~SILPassManager() {
 }
 
 void SILPassManager::notifyOfNewFunction(SILFunction *F, SILTransform *T) {
-  if (doPrintAfter(T, F, SILPrintAll)) {
+  if (doPrintAfter(T, F, /*PassChangedSIL*/ true)) {
     dumpPassInfo("*** New SIL function in ", T, F);
     F->dump(getOptions().EmitVerboseSIL);
   }

test/SILOptimizer/definite-init-wrongscope.swift

@@ -1,6 +1,6 @@
 // RUN: %target-swift-frontend -primary-file %s -Onone -emit-sil -Xllvm \
 // RUN:   -sil-print-after=raw-sil-inst-lowering -Xllvm \
-// RUN:   -sil-print-only-functions=$s3del1MC4fromAcA12WithDelegate_p_tKcfc \
+// RUN:   -sil-print-functions=$s3del1MC4fromAcA12WithDelegate_p_tKcfc \
 // RUN:   -Xllvm -sil-print-debuginfo -o /dev/null -module-name del 2>&1 | %FileCheck %s
 
 public protocol DelegateA {}

test/SILOptimizer/di-conditional-destroy-scope.swift

@@ -1,6 +1,6 @@
 // RUN: %target-swift-frontend -emit-sil %s -Onone -Xllvm \
 // RUN:   -sil-print-after=raw-sil-inst-lowering -Xllvm \
-// RUN:   -sil-print-only-functions=$s2fs36RecursibleDirectoryContentsGeneratorC4path10fileSystemAcA12AbsolutePathV_AA04FileH0_ptKc33_F8B132991B28208F48606E87DC165393Llfc \
+// RUN:   -sil-print-functions=$s2fs36RecursibleDirectoryContentsGeneratorC4path10fileSystemAcA12AbsolutePathV_AA04FileH0_ptKc33_F8B132991B28208F48606E87DC165393Llfc \
 // RUN:   -Xllvm -sil-print-debuginfo -o /dev/null 2>&1 | %FileCheck %s
 
 // REQUIRES: objc_interop

test/SILOptimizer/stack-nesting-wrong-scope.swift

@@ -1,6 +1,6 @@
 // RUN: %target-swift-frontend -emit-sil %s -Onone -Xllvm \
 // RUN:   -sil-print-after=allocbox-to-stack -Xllvm \
-// RUN:   -sil-print-only-functions=$s3red19ThrowAddrOnlyStructV016throwsOptionalToG0ACyxGSgSi_tcfC \
+// RUN:   -sil-print-functions=$s3red19ThrowAddrOnlyStructV016throwsOptionalToG0ACyxGSgSi_tcfC \
 // RUN:   -Xllvm -sil-print-debuginfo -o %t -module-name red 2>&1 | %FileCheck %s
 
 // CHECK: bb{{[0-9]+}}(%{{[0-9]+}} : @owned $Error):

utils/swift-autocomplete.bash

@@ -58,8 +58,8 @@ _swift_complete()
       -sil-print-pass-name \
       -sil-print-pass-time \
       -sil-opt-pass-count \
-      -sil-print-only-function \
-      -sil-print-only-functions \
+      -sil-print-function \
+      -sil-print-functions \
       -sil-print-before \
       -sil-print-after \
       -sil-print-around \