[Core] Unify register name retrieval methods

- Introduce `IRegisterNameAccessor` for platform-agnostic register name access.
- Rename `GetRegString` to `GetRegisterName` for consistency.
- Ensure all methods for retrieving register names are consistent
  across the codebase. 🎉

Author: sangkilc

src/Core/B2R2.Core.fsproj

@@ -19,6 +19,7 @@
     <Compile Include="RegType.fs" />
     <Compile Include="WordSize.fs" />
     <Compile Include="RegisterID.fs" />
+    <Compile Include="IRegisterNameAccessor.fs" />
     <Compile Include="Endian.fs" />
     <Compile Include="OS.fs" />
     <Compile Include="Architecture.fs" />

src/Core/IRegisterNameAccessor.fs

@@ -0,0 +1,39 @@
+(*
+  B2R2 - the Next-Generation Reversing Platform
+
+  Copyright (c) SoftSec Lab. @ KAIST, since 2016
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*)
+
+namespace B2R2
+
+/// <summary>
+/// Provides methods to retrieve register names in a platform-agnostic manner.
+/// </summary>
+type IRegisterNameAccessor =
+  /// <summary>
+  /// Returns a register name from a given RegisterID.
+  /// </summary>
+  abstract GetRegisterName: RegisterID -> string
+
+  /// <summary>
+  /// Returns all register names used in the current architecture.
+  /// </summary>
+  abstract GetAllRegisterNames: unit -> string[]

src/FrontEnd/ARM32/RegisterFactory.fs

@@ -566,13 +566,13 @@ type RegisterFactory() =
     member _.GetRegisterIDAliases rid =
       [| rid |]
 
-    member _.GetRegString rid =
+    member _.GetRegisterName rid =
       Register.ofRegID rid |> Register.toString
 
-    member this.GetAllRegStrings() =
+    member this.GetAllRegisterNames() =
       let regFactory = this :> IRegisterFactory
       regFactory.GetAllRegVars()
-      |> Array.map (regFactory.GetRegisterID >> regFactory.GetRegString)
+      |> Array.map (regFactory.GetRegisterID >> regFactory.GetRegisterName)
 
     member _.GetRegType rid =
       Register.ofRegID rid |> Register.toRegType

src/FrontEnd/ARM64/RegisterFactory.fs

@@ -1461,13 +1461,13 @@ type RegisterFactory() =
       |> Register.getAliases
       |> Array.map Register.toRegID
 
-    member _.GetRegString rid =
+    member _.GetRegisterName rid =
       Register.ofRegID rid |> Register.toString
 
-    member this.GetAllRegStrings() =
+    member this.GetAllRegisterNames() =
       let regFactory = this :> IRegisterFactory
       regFactory.GetAllRegVars()
-      |> Array.map (regFactory.GetRegisterID >> regFactory.GetRegString)
+      |> Array.map (regFactory.GetRegisterID >> regFactory.GetRegisterName)
 
     member _.GetRegType rid =
       Register.ofRegID rid |> Register.toRegType

src/FrontEnd/AVR/RegisterFactory.fs

@@ -153,9 +153,9 @@ type RegisterFactory(wordSize) =
 
     member _.GetRegisterIDAliases _ = Terminator.futureFeature ()
 
-    member _.GetRegString _ = Terminator.futureFeature ()
+    member _.GetRegisterName _ = Terminator.futureFeature ()
 
-    member _.GetAllRegStrings() = Terminator.futureFeature ()
+    member _.GetAllRegisterNames() = Terminator.futureFeature ()
 
     member _.GetRegType _ = Terminator.futureFeature ()
 

src/FrontEnd/BinFile/ELF/CanonicalFrameAddress.fs

@@ -39,7 +39,7 @@ with
   static member ToString(regFactory: IRegisterFactory, cfa) =
     match cfa with
     | RegPlusOffset(rid, offset) ->
-      regFactory.GetRegString rid + (offset.ToString("+0;-#"))
+      regFactory.GetRegisterName rid + (offset.ToString("+0;-#"))
     | Expression exp ->
       PrettyPrinter.ToString exp
     | UnknownCFA -> "unknown"

src/FrontEnd/BinLifter/ILowUIRBuilder.fs

@@ -78,8 +78,8 @@ type ILowUIRBuilder =
         member _.GetRegisterID expr = regFactory.GetRegisterID(expr = expr)
         member _.GetRegisterID name = regFactory.GetRegisterID(name = name)
         member _.GetRegisterIDAliases id = regFactory.GetRegisterIDAliases id
-        member _.GetRegString id = regFactory.GetRegString id
-        member _.GetAllRegStrings() = regFactory.GetAllRegStrings()
+        member _.GetRegisterName id = regFactory.GetRegisterName id
+        member _.GetAllRegisterNames() = regFactory.GetAllRegisterNames()
         member _.GetRegType id = regFactory.GetRegType id
         member _.ProgramCounter = regFactory.ProgramCounter
         member _.StackPointer with get() = regFactory.StackPointer

src/FrontEnd/BinLifter/IRegisterFactory.fs

@@ -31,6 +31,7 @@ open B2R2.BinIR.LowUIR
 /// Provides a platform-agnostic interface for accessing register information.
 /// </summary>
 type IRegisterFactory =
+  inherit IRegisterNameAccessor
   inherit IRegisterVarAccessor
 
   /// Returns RegisterID from a given register var expression.
@@ -49,16 +50,6 @@ type IRegisterFactory =
   /// </summary>
   abstract GetRegisterIDAliases: RegisterID -> RegisterID[]
 
-  /// <summary>
-  /// Returns a register string from a given RegisterID. Depending on the
-  /// underlying architecture of the BinHandle, we may have a different string
-  /// result.
-  /// </summary>
-  abstract GetRegString: RegisterID -> string
-
-  /// Returns all register names.
-  abstract GetAllRegStrings: unit -> string[]
-
   /// <summary>
   /// Returns a RegType from a given RegisterID.
   /// </summary>

src/FrontEnd/EVM/RegisterFactory.fs

@@ -65,10 +65,10 @@ type RegisterFactory() =
 
     member _.GetRegisterIDAliases _ = Terminator.futureFeature ()
 
-    member _.GetRegString rid =
+    member _.GetRegisterName rid =
       Register.ofRegID rid |> Register.toString
 
-    member _.GetAllRegStrings() = [||]
+    member _.GetAllRegisterNames() = [||]
 
     member _.GetRegType rid =
       Register.ofRegID rid |> Register.toRegType

src/FrontEnd/Intel/LowUIRBuilder.fs

@@ -54,8 +54,8 @@ type LowUIRBuilder(isa: ISA,
     member _.GetRegisterID expr = regFactory.GetRegisterID(expr = expr)
     member _.GetRegisterID name = regFactory.GetRegisterID(name = name)
     member _.GetRegisterIDAliases id = regFactory.GetRegisterIDAliases id
-    member _.GetRegString id = regFactory.GetRegString id
-    member _.GetAllRegStrings() = regFactory.GetAllRegStrings()
+    member _.GetRegisterName id = regFactory.GetRegisterName id
+    member _.GetAllRegisterNames() = regFactory.GetAllRegisterNames()
     member _.GetRegType id = regFactory.GetRegType id
     member _.ProgramCounter = regFactory.ProgramCounter
     member _.StackPointer with get() = regFactory.StackPointer