[llvm] [CodeGen] Minor refactor of CSRSavedLocation struct [nfc] (PR #170721)

[Philip Reames via llvm-commits]

https://github.com/preames created https://github.com/llvm/llvm-project/pull/170721

Add operator==, clarify invariants with an assert.  

This does convert one llvm_unreachable into an assert which runs earlier in the computation.  I don't believe the difference is observable outside debug builds, and should report the fault closer to introduction.

>From 7f466e90801113fa71d11a8c80492ad653fdce78 Mon Sep 17 00:00:00 2001
From: Philip Reames <preames at rivosinc.com>
Date: Thu, 4 Dec 2025 10:49:43 -0800
Subject: [PATCH] [CodeGen] Minor refactor of CSRSavedLocation struct [nfc]

Add operator==, clarify invariants with an assert.

This does convert one llvm_unreachable into an assert which runs earlier
in the computation.  I don't believe the difference is observable outside
debug builds, and should report the fault closer to introduction.
---
 llvm/lib/CodeGen/CFIInstrInserter.cpp | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)

diff --git a/llvm/lib/CodeGen/CFIInstrInserter.cpp b/llvm/lib/CodeGen/CFIInstrInserter.cpp
index 1a0e222da98cd..54b93a627938f 100644
--- a/llvm/lib/CodeGen/CFIInstrInserter.cpp
+++ b/llvm/lib/CodeGen/CFIInstrInserter.cpp
@@ -90,9 +90,20 @@ class CFIInstrInserter : public MachineFunctionPass {
   /// contains the location where CSR register is saved.
   struct CSRSavedLocation {
     CSRSavedLocation(std::optional<unsigned> R, std::optional<int> O)
-        : Reg(R), Offset(O) {}
+        : Reg(R), Offset(O) {
+      assert((Reg.has_value() ^ Offset.has_value()) &&
+             "Register and offset can not both be valid");
+    }
     std::optional<unsigned> Reg;
     std::optional<int> Offset;
+
+    bool operator==(const CSRSavedLocation &RHS) const {
+      return Reg == RHS.Reg && Offset == RHS.Offset;
+    }
+
+    bool operator!=(const CSRSavedLocation &RHS) const {
+      return !(*this == RHS);
+    }
   };
 
   /// Contains cfa offset and register values valid at entry and exit of basic
@@ -267,11 +278,11 @@ void CFIInstrInserter::calculateOutgoingCFAInfo(MBBCFAInfo &MBBInfo) {
         break;
       }
       if (CSRReg || CSROffset) {
+        CSRSavedLocation Loc(CSRReg, CSROffset);
         auto It = CSRLocMap.find(CFI.getRegister());
         if (It == CSRLocMap.end()) {
-          CSRLocMap.insert(
-              {CFI.getRegister(), CSRSavedLocation(CSRReg, CSROffset)});
-        } else if (It->second.Reg != CSRReg || It->second.Offset != CSROffset) {
+          CSRLocMap.insert({CFI.getRegister(), Loc});
+        } else if (It->second != Loc) {
           reportFatalInternalError(
               "Different saved locations for the same CSR");
         }
@@ -397,11 +408,11 @@ bool CFIInstrInserter::insertCFIInstrs(MachineFunction &MF) {
       if (!RO.Reg && RO.Offset) {
         CFIIndex = MF.addFrameInst(
             MCCFIInstruction::createOffset(nullptr, Reg, *RO.Offset));
-      } else if (RO.Reg && !RO.Offset) {
+      } else {
+        assert((RO.Reg && !RO.Offset) &&
+               "Reg and Offset cannot both be valid/invalid");
         CFIIndex = MF.addFrameInst(
             MCCFIInstruction::createRegister(nullptr, Reg, *RO.Reg));
-      } else {
-        llvm_unreachable("RO.Reg and RO.Offset cannot both be valid/invalid");
       }
       BuildMI(*MBBInfo.MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION))
           .addCFIIndex(CFIIndex);