AST: Cut down on DescriptiveDeclKind usage in DiagnosticsSIL.def

AnthonyLatsis · AnthonyLatsis · commit 5c190b961300 · 2025-04-05T12:31:20.000+01:00
diff --git a/include/swift/AST/DiagnosticsSIL.def b/include/swift/AST/DiagnosticsSIL.def
@@ -315,12 +315,12 @@ ERROR(missing_never_call_closure,none,
       (Type))
 
 ERROR(missing_return_decl,none,
-      "missing return in %1 expected to return %0",
-      (Type, DescriptiveDeclKind))
+      "missing return in %kindonly1 expected to return %0",
+      (Type, const AbstractFunctionDecl *))
 ERROR(missing_never_call_decl,none,
-      "%1 with uninhabited return type %0 is missing "
+      "%kindonly1 with uninhabited return type %0 is missing "
       "call to another never-returning function on all paths",
-      (Type, DescriptiveDeclKind))
+      (Type, const AbstractFunctionDecl *))
 
 NOTE(missing_return_last_expr_note,none,
     "did you mean to return the last expression?", ())
@@ -701,8 +701,9 @@ WARNING(warning_int_to_fp_inexact, none,
 
 // Flow-isolation diagnostics
 ERROR(isolated_after_nonisolated, none,
-      "cannot access %1 %2 here in %select{nonisolated initializer|deinitializer}0",
-      (bool, DescriptiveDeclKind, DeclName))
+      "cannot access %kind1 here in "
+      "%select{nonisolated initializer|deinitializer}0",
+      (bool, const ValueDecl *))
 NOTE(nonisolated_blame, none, "after %1%2 %3, "
      "only nonisolated properties of 'self' can be accessed from "
      "%select{this init|a deinit}0", (bool, StringRef, StringRef, DeclName))
@@ -981,16 +982,16 @@ NOTE(regionbasedisolation_type_use_after_send, none,
       "sending value of non-Sendable type %0 to %1 callee risks causing data races between %1 and local %2 uses",
       (Type, ActorIsolation, ActorIsolation))
 NOTE(regionbasedisolation_type_use_after_send_callee, none,
-     "sending value of non-Sendable type %0 to %1 %2 %3 risks causing data "
-     "races between %1 and local %4 uses",
-     (Type, ActorIsolation, DescriptiveDeclKind, DeclName, ActorIsolation))
+     "sending value of non-Sendable type %0 to %1 %kind2 risks causing data "
+     "races between %1 and local %3 uses",
+     (Type, ActorIsolation, const ValueDecl *, ActorIsolation))
 
 NOTE(regionbasedisolation_named_info_send_yields_race, none,
      "sending %1%0 to %2 callee risks causing data races between %2 and local %3 uses",
      (Identifier, StringRef, ActorIsolation, ActorIsolation))
 NOTE(regionbasedisolation_named_info_send_yields_race_callee, none,
-     "sending %1%0 to %2 %3 %4 risks causing data races between %2 and local %5 uses",
-     (Identifier, StringRef, ActorIsolation, DescriptiveDeclKind, DeclName, ActorIsolation))
+     "sending %1%0 to %2 %kind3 risks causing data races between %2 and local %4 uses",
+     (Identifier, StringRef, ActorIsolation, const ValueDecl *, ActorIsolation))
 
 // Use after send closure.
 NOTE(regionbasedisolation_type_isolated_capture_yields_race, none,
@@ -1013,8 +1014,8 @@ NOTE(regionbasedisolation_typed_use_after_sending, none,
       "Passing value of non-Sendable type %0 as a 'sending' argument risks causing races in between local and caller code",
       (Type))
 NOTE(regionbasedisolation_typed_use_after_sending_callee, none,
-      "Passing value of non-Sendable type %0 as a 'sending' argument to %1 %2 risks causing races in between local and caller code",
-      (Type, DescriptiveDeclKind, DeclName))
+      "Passing value of non-Sendable type %0 as a 'sending' argument to %kind1 risks causing races in between local and caller code",
+      (Type, const ValueDecl *))
 
 //===
 // Sending Never Sendable Emitter
@@ -1023,8 +1024,8 @@ NOTE(regionbasedisolation_named_send_never_sendable, none,
       "sending %1%0 to %2 callee risks causing data races between %2 and %3 uses",
       (Identifier, StringRef, ActorIsolation, StringRef))
 NOTE(regionbasedisolation_named_send_never_sendable_callee, none,
-      "sending %1%0 to %2 %3 %4 risks causing data races between %2 and %5 uses",
-      (Identifier, StringRef, ActorIsolation, DescriptiveDeclKind, DeclName, StringRef))
+      "sending %1%0 to %2 %kind3 risks causing data races between %2 and %4 uses",
+      (Identifier, StringRef, ActorIsolation, const ValueDecl *, StringRef))
 
 NOTE(regionbasedisolation_named_send_into_sending_param, none,
      "%0%1 is passed as a 'sending' parameter; Uses in callee may race with "
@@ -1048,8 +1049,8 @@ NOTE(regionbasedisolation_typed_tns_passed_to_sending_closure_helper_have_value_
      "closure captures %0 which is accessible to code in the current task",
      (DeclName))
 NOTE(regionbasedisolation_typed_tns_passed_to_sending_closure_helper_have_boxed_value_task_isolated, none,
-     "closure captures reference to mutable %1 %0 which is accessible to code in the current task",
-     (DeclName, DescriptiveDeclKind))
+     "closure captures reference to mutable %kind0 which is accessible to code in the current task",
+     (const ValueDecl *))
 NOTE(regionbasedisolation_typed_tns_passed_to_sending_closure_helper_have_value_region, none,
      "closure captures %1 which is accessible to %0 code",
      (StringRef, DeclName))
@@ -1065,8 +1066,8 @@ NOTE(regionbasedisolation_closure_captures_actor, none,
      (DeclName, StringRef))
 
 NOTE(regionbasedisolation_typed_tns_passed_to_sending_callee, none,
-     "Passing %0 value of non-Sendable type %1 as a 'sending' parameter to %2 %3 risks causing races inbetween %0 uses and uses reachable from %3",
-     (StringRef, Type, DescriptiveDeclKind, DeclName))
+     "Passing %0 value of non-Sendable type %1 as a 'sending' parameter to %kind2 risks causing races inbetween %0 uses and uses reachable from %2",
+     (StringRef, Type, const ValueDecl *))
 
 NOTE(regionbasedisolation_named_send_nt_asynclet_capture, none,
       "sending %1 %0 into async let risks causing data races between nonisolated and %1 uses",
@@ -1075,8 +1076,8 @@ NOTE(regionbasedisolation_typed_sendneversendable_via_arg, none,
       "sending %0 value of non-Sendable type %1 to %2 callee risks causing races in between %0 and %2 uses",
       (StringRef, Type, ActorIsolation))
 NOTE(regionbasedisolation_typed_sendneversendable_via_arg_callee, none,
-      "sending %0 value of non-Sendable type %1 to %2 %3 %4 risks causing races in between %0 and %2 uses",
-      (StringRef, Type, ActorIsolation, DescriptiveDeclKind, DeclName))
+      "sending %0 value of non-Sendable type %1 to %2 %kind3 risks causing races in between %0 and %2 uses",
+      (StringRef, Type, ActorIsolation, const ValueDecl *))
 
 // Error that is only used when the send non sendable emitter cannot discover any
 // information to give a better diagnostic.
diff --git a/lib/SILOptimizer/Mandatory/DataflowDiagnostics.cpp b/lib/SILOptimizer/Mandatory/DataflowDiagnostics.cpp
@@ -69,10 +69,9 @@ static void diagnoseMissingReturn(const UnreachableInst *UI,
           Context.Diags.diagnose(expr->getStartLoc(),
                                  diag::missing_return_closure, ResTy);
         } else {
-          auto *DC = FLoc.getAsDeclContext();
-          assert(DC && DC->getAsDecl() && "not a declaration?");
+          auto *FD = FLoc.castToASTNode<AbstractFunctionDecl>();
           Context.Diags.diagnose(expr->getStartLoc(), diag::missing_return_decl,
-                                 ResTy, DC->getAsDecl()->getDescriptiveKind());
+                                 ResTy, FD);
         }
         Context.Diags
             .diagnose(expr->getStartLoc(), diag::missing_return_last_expr_note)
@@ -89,12 +88,10 @@ static void diagnoseMissingReturn(const UnreachableInst *UI,
                                : diag::missing_return_closure;
     diagnose(Context, L.getEndSourceLoc(), diagID, ResTy);
   } else {
-    auto *DC = FLoc.getAsDeclContext();
-    assert(DC && DC->getAsDecl() && "not a declaration?");
+    auto *FD = FLoc.castToASTNode<AbstractFunctionDecl>();
     auto diagID = isNoReturnFn ? diag::missing_never_call_decl
                                : diag::missing_return_decl;
-    diagnose(Context, L.getEndSourceLoc(), diagID, ResTy,
-             DC->getAsDecl()->getDescriptiveKind());
+    diagnose(Context, L.getEndSourceLoc(), diagID, ResTy, FD);
   }
 }
 
diff --git a/lib/SILOptimizer/Mandatory/FlowIsolation.cpp b/lib/SILOptimizer/Mandatory/FlowIsolation.cpp
@@ -484,9 +484,9 @@ void Info::diagnoseAll(AnalysisInfo &info, bool forDeinit,
     VarDecl *var = cast<RefElementAddrInst>(use)->getField();
 
     diag.diagnose(illegalLoc.getSourceLoc(), diag::isolated_after_nonisolated,
-                  forDeinit, var->getDescriptiveKind(), var->getName())
-      .highlight(illegalLoc.getSourceRange())
-      .warnUntilSwiftVersion(6);
+                  forDeinit, var)
+        .highlight(illegalLoc.getSourceRange())
+        .warnUntilSwiftVersion(6);
 
     // after <verb><adjective> <subject>, ... can't use self anymore, etc ...
     //   example:
diff --git a/lib/SILOptimizer/Mandatory/SendNonSendable.cpp b/lib/SILOptimizer/Mandatory/SendNonSendable.cpp
@@ -149,17 +149,16 @@ static std::optional<SILDeclRef> getDeclRefForCallee(SILInstruction *inst) {
   }
 }
 
-static std::optional<std::pair<DescriptiveDeclKind, DeclName>>
-getSendingApplyCalleeInfo(SILInstruction *inst) {
+static std::optional<ValueDecl *> getSendingApplyCallee(SILInstruction *inst) {
   auto declRef = getDeclRefForCallee(inst);
   if (!declRef)
     return {};
 
   auto *decl = declRef->getDecl();
-  if (!decl || !decl->hasName())
+  if (!decl)
     return {};
 
-  return {{decl->getDescriptiveKind(), decl->getName()}};
+  return decl;
 }
 
 static Expr *inferArgumentExprFromApplyExpr(ApplyExpr *sourceApply,
@@ -672,10 +671,9 @@ class UseAfterSendDiagnosticEmitter {
         getFunction());
   }
 
-  /// If we can find a callee decl name, return that. None otherwise.
-  std::optional<std::pair<DescriptiveDeclKind, DeclName>>
-  getSendingCalleeInfo() const {
-    return getSendingApplyCalleeInfo(sendingOp->getUser());
+  /// Attempts to retrieve and return the callee declaration.
+  std::optional<const ValueDecl *> getSendingCallee() const {
+    return getSendingApplyCallee(sendingOp->getUser());
   }
 
   void
@@ -697,12 +695,11 @@ class UseAfterSendDiagnosticEmitter {
       }
     }
 
-    if (auto calleeInfo = getSendingCalleeInfo()) {
+    if (auto callee = getSendingCallee()) {
       diagnoseNote(
           loc, diag::regionbasedisolation_named_info_send_yields_race_callee,
           name, descriptiveKindStr, isolationCrossing.getCalleeIsolation(),
-          calleeInfo->first, calleeInfo->second,
-          isolationCrossing.getCallerIsolation());
+          callee.value(), isolationCrossing.getCallerIsolation());
     } else {
       diagnoseNote(loc, diag::regionbasedisolation_named_info_send_yields_race,
                    name, descriptiveKindStr,
@@ -716,8 +713,7 @@ class UseAfterSendDiagnosticEmitter {
   emitNamedIsolationCrossingError(SILLocation loc, Identifier name,
                                   SILIsolationInfo namedValuesIsolationInfo,
                                   ApplyIsolationCrossing isolationCrossing,
-                                  DeclName calleeDeclName,
-                                  DescriptiveDeclKind calleeDeclKind) {
+                                  const ValueDecl *callee) {
     // Emit the short error.
     diagnoseError(loc, diag::regionbasedisolation_named_send_yields_race, name)
         .highlight(loc.getSourceRange())
@@ -736,7 +732,7 @@ class UseAfterSendDiagnosticEmitter {
     diagnoseNote(
         loc, diag::regionbasedisolation_named_info_send_yields_race_callee,
         name, descriptiveKindStr, isolationCrossing.getCalleeIsolation(),
-        calleeDeclKind, calleeDeclName, isolationCrossing.getCallerIsolation());
+        callee, isolationCrossing.getCallerIsolation());
     emitRequireInstDiagnostics();
   }
 
@@ -759,11 +755,10 @@ class UseAfterSendDiagnosticEmitter {
         .highlight(loc.getSourceRange())
         .limitBehaviorIf(getBehaviorLimit());
 
-    if (auto calleeInfo = getSendingCalleeInfo()) {
+    if (auto callee = getSendingCallee()) {
       diagnoseNote(loc, diag::regionbasedisolation_type_use_after_send_callee,
                    inferredType, isolationCrossing.getCalleeIsolation(),
-                   calleeInfo->first, calleeInfo->second,
-                   isolationCrossing.getCallerIsolation());
+                   callee.value(), isolationCrossing.getCallerIsolation());
     } else {
       diagnoseNote(loc, diag::regionbasedisolation_type_use_after_send,
                    inferredType, isolationCrossing.getCalleeIsolation(),
@@ -793,10 +788,10 @@ class UseAfterSendDiagnosticEmitter {
                   inferredType)
         .highlight(loc.getSourceRange())
         .limitBehaviorIf(getBehaviorLimit());
-    if (auto calleeInfo = getSendingCalleeInfo()) {
+    if (auto callee = getSendingCallee()) {
       diagnoseNote(loc,
                    diag::regionbasedisolation_typed_use_after_sending_callee,
-                   inferredType, calleeInfo->first, calleeInfo->second);
+                   inferredType, callee.value());
     } else {
       diagnoseNote(loc, diag::regionbasedisolation_typed_use_after_sending,
                    inferredType);
@@ -1106,8 +1101,7 @@ struct UseAfterSendDiagnosticInferrer::AutoClosureWalker : ASTWalker {
           if (valueDecl->hasName()) {
             foundTypeInfo.diagnosticEmitter.emitNamedIsolationCrossingError(
                 foundTypeInfo.baseLoc, targetDecl->getBaseIdentifier(),
-                targetDeclIsolationInfo, *isolationCrossing,
-                valueDecl->getName(), valueDecl->getDescriptiveKind());
+                targetDeclIsolationInfo, *isolationCrossing, valueDecl);
             continue;
           }
 
@@ -1322,10 +1316,9 @@ class SendNeverSentDiagnosticEmitter {
         getOperand()->getFunction());
   }
 
-  /// If we can find a callee decl name, return that. None otherwise.
-  std::optional<std::pair<DescriptiveDeclKind, DeclName>>
-  getSendingCalleeInfo() const {
-    return getSendingApplyCalleeInfo(sendingOperand->getUser());
+  /// Attempts to retrieve and return the callee declaration.
+  std::optional<const ValueDecl *> getSendingCallee() const {
+    return getSendingApplyCallee(sendingOperand->getUser());
   }
 
   SILLocation getLoc() const { return sendingOperand->getUser()->getLoc(); }
@@ -1365,12 +1358,12 @@ class SendNeverSentDiagnosticEmitter {
       getIsolationRegionInfo().printForDiagnostics(os);
     }
 
-    if (auto calleeInfo = getSendingCalleeInfo()) {
+    if (auto callee = getSendingCallee()) {
       diagnoseNote(
           loc,
           diag::regionbasedisolation_typed_sendneversendable_via_arg_callee,
           descriptiveKindStr, inferredType, crossing.getCalleeIsolation(),
-          calleeInfo->first, calleeInfo->second);
+          callee.value());
     } else {
       diagnoseNote(
           loc, diag::regionbasedisolation_typed_sendneversendable_via_arg,
@@ -1409,11 +1402,10 @@ class SendNeverSentDiagnosticEmitter {
       getIsolationRegionInfo().printForDiagnostics(os);
     }
 
-    if (auto calleeInfo = getSendingCalleeInfo()) {
+    if (auto callee = getSendingCallee()) {
       diagnoseNote(
           loc, diag::regionbasedisolation_typed_tns_passed_to_sending_callee,
-          descriptiveKindStr, inferredType, calleeInfo->first,
-          calleeInfo->second);
+          descriptiveKindStr, inferredType, callee.value());
     } else {
       diagnoseNote(loc, diag::regionbasedisolation_typed_tns_passed_to_sending,
                    descriptiveKindStr, inferredType);
@@ -1475,8 +1467,7 @@ class SendNeverSentDiagnosticEmitter {
           fArg->getType().is<SILBoxType>()) {
         auto diag = diag::
             regionbasedisolation_typed_tns_passed_to_sending_closure_helper_have_boxed_value_task_isolated;
-        diagnoseNote(actualUse, diag, fArg->getDecl()->getName(),
-                     fArg->getDecl()->getDescriptiveKind());
+        diagnoseNote(actualUse, diag, fArg->getDecl());
         return;
       }
 
@@ -1614,12 +1605,12 @@ class SendNeverSentDiagnosticEmitter {
         descriptiveKindStrWithSpace.push_back(' ');
       }
     }
-    if (auto calleeInfo = getSendingCalleeInfo()) {
+    if (auto callee = getSendingCallee()) {
       diagnoseNote(loc,
                    diag::regionbasedisolation_named_send_never_sendable_callee,
                    name, descriptiveKindStrWithSpace,
-                   isolationCrossing.getCalleeIsolation(), calleeInfo->first,
-                   calleeInfo->second, descriptiveKindStr);
+                   isolationCrossing.getCalleeIsolation(), callee.value(),
+                   descriptiveKindStr);
     } else {
       diagnoseNote(loc, diag::regionbasedisolation_named_send_never_sendable,
                    name, descriptiveKindStrWithSpace,
