SILPrinter: improve printing of debug locations

* Indicate auto-generated locations: instead of "loc", print "loc *" for auto-generated locations
* Print the debug location and scope of SILFunctions

Author: eeckstein

lib/SIL/IR/SILPrinter.cpp

@@ -1012,7 +1012,10 @@ class SILPrinter : public SILInstructionVisitor<SILPrinter> {
     if (!DL.filename.empty()) {
       if (PrintComma)
         *this << ", ";
-      *this << "loc " << QuotedString(DL.filename) << ':' << DL.line << ':'
+      *this << "loc ";
+      if (Loc.isAutoGenerated())
+        *this << "* ";
+      *this << QuotedString(DL.filename) << ':' << DL.line << ':'
             << (unsigned)DL.column;
     }
   }
@@ -3012,7 +3015,14 @@ void SILFunction::print(SILPrintContext &PrintCtx) const {
     }
   }
 
-  OS << "// " << demangleSymbol(getName()) << '\n';
+  OS << "// " << demangleSymbol(getName());
+  if (PrintCtx.printDebugInfo()) {
+    auto &SM = getModule().getASTContext().SourceMgr;
+    SILPrinter P(PrintCtx);
+    P.printDebugLocRef(getLocation(), SM);
+    P.printDebugScopeRef(getDebugScope(), SM);
+  }
+  OS << '\n';
   printClangQualifiedNameCommentIfPresent(OS, getClangDecl());
 
   OS << "sil ";

lib/SIL/Parser/ParseSIL.cpp

@@ -2117,6 +2117,12 @@ bool SILParser::parseSILLocation(SILLocation &Loc) {
   if (parseVerbatim("loc"))
     return true;
 
+  bool isAutoGenerated = false;
+  if (P.Tok.isAnyOperator() && P.Tok.getText().startswith("*")) {
+    isAutoGenerated = true;
+    P.consumeStartingCharacterOfCurrentToken();
+  }
+
   if (P.Tok.getKind() != tok::string_literal) {
     P.diagnose(P.Tok, diag::expected_tok_in_sil_instr, "string");
     return true;
@@ -2140,7 +2146,7 @@ bool SILParser::parseSILLocation(SILLocation &Loc) {
 
   Loc = RegularLocation(fnl);
 
-  if (*fnl == *SILLocation::getCompilerGeneratedLoc())
+  if (isAutoGenerated)
     Loc.markAutoGenerated();
 
   return false;

test/DebugInfo/linetable-assign.swift

@@ -4,9 +4,9 @@
 public func g<T>(_ t: T) {}
 public func f(_ i: Int32) {
   // CHECK: function_ref @$s4main1fyys5Int32VFyycfU_
-  // CHECK-SAME: loc "{{.*}}":13:3,
+  // CHECK-SAME: loc * "{{.*}}":13:3,
   // CHECK: %[[CLOSURE:.*]] = partial_apply
-  // CHECK-SAME: loc "{{.*}}":13:3,{{.*}}auto_gen
+  // CHECK-SAME: loc * "{{.*}}":13:3,{{.*}}auto_gen
   // CHECK: store %[[CLOSURE]]
   // CHECK-SAME: loc "{{.*}}":12:3,  
   var closure = // line 12

test/DebugInfo/sroa_mem2reg.sil

@@ -36,11 +36,11 @@ bb0(%0 : $Int64, %1 : $Int64):
   // CHECK-SROA: alloc_stack $Int64, var
   // CHECK-SROA-SAME:        (name "my_struct", loc "sroa.swift":8:9
   // CHECK-SROA-SAME:        type $*MyStruct, expr op_fragment:#MyStruct.x
-  // CHECK-SROA-SAME:        loc "<compiler-generated>":0:0
+  // CHECK-SROA-SAME:        loc * "<compiler-generated>":0:0
   // CHECK-SROA: alloc_stack $Int64, var
   // CHECK-SROA-SAME:        (name "my_struct", loc "sroa.swift":8:9
   // CHECK-SROA-SAME:        type $*MyStruct, expr op_fragment:#MyStruct.y
-  // CHECK-SROA-SAME:        loc "<compiler-generated>":0:0
+  // CHECK-SROA-SAME:        loc * "<compiler-generated>":0:0
   %5 = metatype $@thin MyStruct.Type, loc "sroa.swift":8:21, scope 2
   %6 = integer_literal $Builtin.Int64, 0, loc "sroa.swift":8:33, scope 2
   %7 = struct $Int64 (%6 : $Builtin.Int64), loc "sroa.swift":8:33, scope 2

test/SILGen/concurrent_prologue.swift

@@ -6,11 +6,11 @@
 
 @MainActor func f() async -> Int {
 // CHECK: {{^sil .*}}@$s1a1fSiyYaF
-// CHECK: %0 = metatype      {{.*}}loc "{{.*}}.swift":[[@LINE-2]]:17,{{.*}}:auto_gen
-// CHECK: %1 = function_ref  {{.*}}loc "{{.*}}.swift":[[@LINE-3]]:17,{{.*}}:auto_gen
-// CHECK: %2 = apply %1(%0)  {{.*}}loc "{{.*}}.swift":[[@LINE-4]]:17,{{.*}}:auto_gen
-// CHECK: begin_borrow       {{.*}}loc "{{.*}}.swift":[[@LINE-5]]:17,{{.*}}:auto_gen
-// CHECK: hop_to_executor    {{.*}}loc "{{.*}}.swift":[[@LINE-6]]:17,{{.*}}
+// CHECK: %0 = metatype      {{.*}}loc * "{{.*}}.swift":[[@LINE-2]]:17,{{.*}}:auto_gen
+// CHECK: %1 = function_ref  {{.*}}loc * "{{.*}}.swift":[[@LINE-3]]:17,{{.*}}:auto_gen
+// CHECK: %2 = apply %1(%0)  {{.*}}loc * "{{.*}}.swift":[[@LINE-4]]:17,{{.*}}:auto_gen
+// CHECK: begin_borrow       {{.*}}loc * "{{.*}}.swift":[[@LINE-5]]:17,{{.*}}:auto_gen
+// CHECK: hop_to_executor    {{.*}}loc * "{{.*}}.swift":[[@LINE-6]]:17,{{.*}}
 // CHECK: // end sil function '$s1a1fSiyYaF'
   return 23
 }

test/SILGen/sil_locations.swift

@@ -213,7 +213,7 @@ func captures_tuple<T, U>(x: (T, U)) -> () -> (T, U) {
   // CHECK-LABEL: sil hidden [ossa] @$s13sil_locations14captures_tuple{{[_0-9a-zA-Z]*}}F
   // CHECK: tuple_element_addr {{.*}}, loc "{{.*}}":[[@LINE-3]]:27
   // CHECK: copy_addr {{.*}}, loc "{{.*}}":[[@LINE-4]]:27
-  // CHECK: function_ref {{.*}}, loc "{{.*}}":[[@LINE-4]]:10
+  // CHECK: function_ref {{.*}}, loc * "{{.*}}":[[@LINE-4]]:10
 
   // CHECK-LABEL: sil private [ossa] @$s13sil_locations14captures_tuple{{.*}}fU_
   // CHECK: copy_addr {{.*}}, loc "{{.*}}":[[@LINE-7]]:11
@@ -438,8 +438,8 @@ func testKeyPathGetterSetterAutogen() -> Struct.InnerStruct {
   return s[keyPath: kp]
   // Autogenerated keypath getter
   // CHECK-LABEL: sil shared [thunk] [ossa] @$s13sil_locations6StructV14structProperty{{[_0-9a-zA-Z]*}}TK
-  // CHECK: load {{.*}} loc "<compiler-generated>":0:0{{.*}}<invalid loc>:auto_gen
+  // CHECK: load {{.*}} loc * "<compiler-generated>":0:0{{.*}}<invalid loc>:auto_gen
   // Autogenerated keypath setter
   // CHECK-LABEL: sil shared [thunk] [ossa] @$s13sil_locations6StructV14structProperty{{[_0-9a-zA-Z]*}}Tk
-  // CHECK: load {{.*}} loc "<compiler-generated>":0:0{{.*}}<invalid loc>:auto_gen
+  // CHECK: load {{.*}} loc * "<compiler-generated>":0:0{{.*}}<invalid loc>:auto_gen
 }