SILPrinter: print block argument decl names in comments

Author: eeckstein

lib/SIL/IR/SILPrinter.cpp

@@ -601,31 +601,41 @@ class SILPrinter : public SILInstructionVisitor<SILPrinter> {
     if (BB->args_empty())
       return;
 
-    for (SILValue V : BB->getArguments()) {
-      if (V->use_empty())
-        continue;
-      *this << "// " << Ctx.getID(V);
-      PrintState.OS.PadToColumn(50);
-      *this << "// user";
-      if (std::next(V->use_begin()) != V->use_end())
-        *this << 's';
-      *this << ": ";
+    for (SILArgument *arg : BB->getArguments()) {
+      StringRef name;
+      if (arg->getDecl() && arg->getDecl()->hasName())
+        name = arg->getDecl()->getBaseName().userFacingName();
 
-      llvm::SmallVector<ID, 32> UserIDs;
-      for (auto *Op : V->getUses())
-        UserIDs.push_back(Ctx.getID(Op->getUser()));
+      if (arg->use_empty() && name.empty())
+        continue;
 
-      // Display the user ids sorted to give a stable use order in the
-      // printer's output if we are asked to do so. This makes diffing large
-      // sections of SIL significantly easier at the expense of not showing
-      // the _TRUE_ order of the users in the use list.
-      if (Ctx.sortSIL()) {
-        std::sort(UserIDs.begin(), UserIDs.end());
+      *this << "// " << Ctx.getID(arg);
+      if (!name.empty()) {
+        *this << " \"" << name << '\"';
       }
+      if (!arg->use_empty()) {
+        PrintState.OS.PadToColumn(50);
+        *this << "// user";
+        if (std::next(arg->use_begin()) != arg->use_end())
+          *this << 's';
+        *this << ": ";
+
+        llvm::SmallVector<ID, 32> UserIDs;
+        for (auto *Op : arg->getUses())
+          UserIDs.push_back(Ctx.getID(Op->getUser()));
+
+        // Display the user ids sorted to give a stable use order in the
+        // printer's output if we are asked to do so. This makes diffing large
+        // sections of SIL significantly easier at the expense of not showing
+        // the _TRUE_ order of the users in the use list.
+        if (Ctx.sortSIL()) {
+          std::sort(UserIDs.begin(), UserIDs.end());
+        }
 
-      interleave(UserIDs.begin(), UserIDs.end(),
-                 [&] (ID id) { *this << id; },
-                 [&] { *this << ", "; });
+        interleave(UserIDs.begin(), UserIDs.end(),
+                   [&] (ID id) { *this << id; },
+                   [&] { *this << ", "; });
+      }
       *this << '\n';
     }
   }

test/SILGen/opaque_result_type.swift

@@ -169,7 +169,7 @@ public class D {
 
 // CHECK-LABEL: sil [ossa] @$s18opaque_result_type10tupleAsAnyQryF : $@convention(thin) () -> @out @_opaqueReturnTypeOf("$s18opaque_result_type10tupleAsAnyQryF", 0) 🦸 {
 public func tupleAsAny() -> some Any {
-// CHECK-NEXT: bb0(%0 : $*()):
+// CHECK:      bb0(%0 : $*()):
 // CHECK-NEXT:   %1 = tuple ()
 // CHECK-NEXT:   return %1 : $()
   return ()

test/SILGen/property_wrappers.swift

@@ -98,7 +98,7 @@ func forceHasMemberwiseInit() {
 // CHECK-LABEL: sil hidden [ossa] @$s17property_wrappers17HasMemberwiseInitVACyxGycfC : $@convention(method) <T where T : DefaultInit> (@thin HasMemberwiseInit<T>.Type) -> @out HasMemberwiseInit<T> {
 
 // Initialization of x
-// CHECK-NOT: return
+// CHECK-NOT: return %
 // CHECK: function_ref @$s17property_wrappers17HasMemberwiseInitV2_x33_{{.*}}7WrapperVySbGvpfi : $@convention(thin) <τ_0_0 where τ_0_0 : DefaultInit> () -> Wrapper<Bool>
 
 // Initialization of y

test/SILOptimizer/constant_propagation_stdlib.swift

@@ -11,7 +11,7 @@ public struct MyInt {
 // CHECK-ONONE:         return [[RESULT]]
 // CHECK-ONONE:       } // end sil function '$s27constant_propagation_stdlib15isConcrete_trueyBi1_AA5MyIntVF'
 // CHECK-O-LABEL:     sil @$s27constant_propagation_stdlib15isConcrete_trueyBi1_AA5MyIntVF : $@convention(thin) (MyInt) -> Builtin.Int1 {
-// CHECK-O-NEXT:      bb0(
+// CHECK-O:           bb0(
 // CHECK-O-NEXT:        [[RESULT:%.*]] = integer_literal $Builtin.Int1, -1
 // CHECK-O-NEXT:        return [[RESULT]]
 // CHECK-O-NEXT:      } // end sil function '$s27constant_propagation_stdlib15isConcrete_trueyBi1_AA5MyIntVF'
@@ -84,7 +84,7 @@ public func isConcrete_concrete_caller(_ x: MyInt) -> Builtin.Int1 {
 // CHECK-ONONE:         return [[RESULT]]
 // CHECK-ONONE:       } // end sil function '$s27constant_propagation_stdlib4main1xBi1__Bi1_Bi1_tAA5MyIntV_tF'
 // CHECK-O-LABEL:     sil @$s27constant_propagation_stdlib4main1xBi1__Bi1_Bi1_tAA5MyIntV_tF : $@convention(thin) (MyInt) -> (Builtin.Int1, Builtin.Int1, Builtin.Int1) {
-// CHECK-O-NEXT:      bb0(
+// CHECK-O:           bb0(
 // CHECK-O-NEXT:        [[VALUE:%.*]] = integer_literal $Builtin.Int1, -1
 // CHECK-O-NEXT:        [[RESULT:%.*]] = tuple ([[VALUE]] : $Builtin.Int1, [[VALUE]] : $Builtin.Int1, [[VALUE]] : $Builtin.Int1)
 // CHECK-O-NEXT:        return [[RESULT]]