Move the printing logic of UnwindTable to UnwindTablePrinter

Author: Amirhossein Pashaeehir

llvm/include/llvm/DebugInfo/DWARF/DWARFUnwindTablePrinter.h

@@ -0,0 +1,102 @@
+//===- DWARFUnwindTablePrinter.h --------------------------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_DEBUGINFO_DWARF_DWARFUNWINDTABLEPRINTER_H
+#define LLVM_DEBUGINFO_DWARF_DWARFUNWINDTABLEPRINTER_H
+
+#include "llvm/DebugInfo/DWARF/LowLevel/DWARFUnwindTable.h"
+#include "llvm/Support/Compiler.h"
+
+namespace llvm {
+
+struct DIDumpOptions;
+
+namespace dwarf {
+
+/// Print an unwind location expression as text and use the register information
+/// if some is provided.
+///
+/// \param R the unwind location to print.
+///
+/// \param OS the stream to use for output.
+///
+/// \param MRI register information that helps emit register names insteead
+/// of raw register numbers.
+///
+/// \param IsEH true if the DWARF Call Frame Information is from .eh_frame
+/// instead of from .debug_frame. This is needed for register number
+/// conversion because some register numbers differ between the two sections
+/// for certain architectures like x86.
+LLVM_ABI void printUnwindLocation(const UnwindLocation &R, raw_ostream &OS,
+                                  DIDumpOptions DumpOpts);
+LLVM_ABI raw_ostream &operator<<(raw_ostream &OS, const UnwindLocation &R);
+
+/// Print all registers + locations that are currently defined in a register
+/// locations.
+///
+/// \param RL the register locations to print.
+///
+/// \param OS the stream to use for output.
+///
+/// \param MRI register information that helps emit register names insteead
+/// of raw register numbers.
+///
+/// \param IsEH true if the DWARF Call Frame Information is from .eh_frame
+/// instead of from .debug_frame. This is needed for register number
+/// conversion because some register numbers differ between the two sections
+/// for certain architectures like x86.
+LLVM_ABI void printRegisterLocations(const RegisterLocations &RL,
+                                     raw_ostream &OS, DIDumpOptions DumpOpts);
+LLVM_ABI raw_ostream &operator<<(raw_ostream &OS, const RegisterLocations &RL);
+
+/// Print an UnwindRow to the stream.
+///
+/// \param Row the UnwindRow to print.
+///
+/// \param OS the stream to use for output.
+///
+/// \param MRI register information that helps emit register names insteead
+/// of raw register numbers.
+///
+/// \param IsEH true if the DWARF Call Frame Information is from .eh_frame
+/// instead of from .debug_frame. This is needed for register number
+/// conversion because some register numbers differ between the two sections
+/// for certain architectures like x86.
+///
+/// \param IndentLevel specify the indent level as an integer. The UnwindRow
+/// will be output to the stream preceded by 2 * IndentLevel number of spaces.
+LLVM_ABI void printUnwindRow(const UnwindRow &Row, raw_ostream &OS,
+                             DIDumpOptions DumpOpts, unsigned IndentLevel = 0);
+LLVM_ABI raw_ostream &operator<<(raw_ostream &OS, const UnwindRow &Row);
+
+/// Print a UnwindTable to the stream.
+///
+/// \param Rows the UnwindTable to print.
+///
+/// \param OS the stream to use for output.
+///
+/// \param MRI register information that helps emit register names instead
+/// of raw register numbers.
+///
+/// \param IsEH true if the DWARF Call Frame Information is from .eh_frame
+/// instead of from .debug_frame. This is needed for register number
+/// conversion because some register numbers differ between the two sections
+/// for certain architectures like x86.
+///
+/// \param IndentLevel specify the indent level as an integer. The UnwindRow
+/// will be output to the stream preceded by 2 * IndentLevel number of spaces.
+LLVM_ABI void printUnwindTable(const UnwindTable &Rows, raw_ostream &OS,
+                               DIDumpOptions DumpOpts,
+                               unsigned IndentLevel = 0);
+LLVM_ABI raw_ostream &operator<<(raw_ostream &OS, const UnwindTable &Rows);
+
+} // end namespace dwarf
+
+} // end namespace llvm
+
+#endif // LLVM_DEBUGINFO_DWARF_DWARFUNWINDTABLEPRINTER_H

llvm/include/llvm/DebugInfo/DWARF/LowLevel/DWARFUnwindTable.h

@@ -9,6 +9,7 @@
 #ifndef LLVM_DEBUGINFO_DWARF_DWARFUNWINDTABLE_H
 #define LLVM_DEBUGINFO_DWARF_DWARFUNWINDTABLE_H
 
+#include "llvm/ADT/SmallVector.h"
 #include "llvm/DebugInfo/DWARF/LowLevel/DWARFCFIProgram.h"
 #include "llvm/DebugInfo/DWARF/LowLevel/DWARFExpression.h"
 #include "llvm/Support/Compiler.h"
@@ -122,6 +123,11 @@ class UnwindLocation {
   Location getLocation() const { return Kind; }
   uint32_t getRegister() const { return RegNum; }
   int32_t getOffset() const { return Offset; }
+  bool hasAddressSpace() const {
+    if(AddrSpace)
+      return true;
+    return false;
+  }
   uint32_t getAddressSpace() const {
     assert(Kind == RegPlusOffset && AddrSpace);
     return *AddrSpace;
@@ -145,25 +151,10 @@ class UnwindLocation {
   std::optional<DWARFExpression> getDWARFExpressionBytes() const {
     return Expr;
   }
-  /// Dump a location expression as text and use the register information if
-  /// some is provided.
-  ///
-  /// \param OS the stream to use for output.
-  ///
-  /// \param MRI register information that helps emit register names insteead
-  /// of raw register numbers.
-  ///
-  /// \param IsEH true if the DWARF Call Frame Information is from .eh_frame
-  /// instead of from .debug_frame. This is needed for register number
-  /// conversion because some register numbers differ between the two sections
-  /// for certain architectures like x86.
-  LLVM_ABI void dump(raw_ostream &OS, DIDumpOptions DumpOpts) const;
 
   LLVM_ABI bool operator==(const UnwindLocation &RHS) const;
 };
 
-LLVM_ABI raw_ostream &operator<<(raw_ostream &OS, const UnwindLocation &R);
-
 /// A class that can track all registers with locations in a UnwindRow object.
 ///
 /// Register locations use a map where the key is the register number and the
@@ -189,6 +180,13 @@ class RegisterLocations {
     return Pos->second;
   }
 
+  SmallVector<uint32_t, 4> getRegisters() const {
+    SmallVector<uint32_t, 4> Registers;
+    for(auto &&[Register, _]: Locations)
+      Registers.push_back(Register);
+    return Registers;
+  }
+
   /// Set the location for the register in \a RegNum to \a Location.
   ///
   /// \param RegNum the register number to set the location for.
@@ -204,19 +202,6 @@ class RegisterLocations {
   /// \param RegNum the register number to remove the location for.
   void removeRegisterLocation(uint32_t RegNum) { Locations.erase(RegNum); }
 
-  /// Dump all registers + locations that are currently defined in this object.
-  ///
-  /// \param OS the stream to use for output.
-  ///
-  /// \param MRI register information that helps emit register names insteead
-  /// of raw register numbers.
-  ///
-  /// \param IsEH true if the DWARF Call Frame Information is from .eh_frame
-  /// instead of from .debug_frame. This is needed for register number
-  /// conversion because some register numbers differ between the two sections
-  /// for certain architectures like x86.
-  LLVM_ABI void dump(raw_ostream &OS, DIDumpOptions DumpOpts) const;
-
   /// Returns true if we have any register locations in this object.
   bool hasLocations() const { return !Locations.empty(); }
 
@@ -227,8 +212,6 @@ class RegisterLocations {
   }
 };
 
-LLVM_ABI raw_ostream &operator<<(raw_ostream &OS, const RegisterLocations &RL);
-
 /// A class that represents a single row in the unwind table that is decoded by
 /// parsing the DWARF Call Frame Information opcodes.
 ///
@@ -281,27 +264,8 @@ class UnwindRow {
   const UnwindLocation &getCFAValue() const { return CFAValue; }
   RegisterLocations &getRegisterLocations() { return RegLocs; }
   const RegisterLocations &getRegisterLocations() const { return RegLocs; }
-
-  /// Dump the UnwindRow to the stream.
-  ///
-  /// \param OS the stream to use for output.
-  ///
-  /// \param MRI register information that helps emit register names insteead
-  /// of raw register numbers.
-  ///
-  /// \param IsEH true if the DWARF Call Frame Information is from .eh_frame
-  /// instead of from .debug_frame. This is needed for register number
-  /// conversion because some register numbers differ between the two sections
-  /// for certain architectures like x86.
-  ///
-  /// \param IndentLevel specify the indent level as an integer. The UnwindRow
-  /// will be output to the stream preceded by 2 * IndentLevel number of spaces.
-  LLVM_ABI void dump(raw_ostream &OS, DIDumpOptions DumpOpts,
-                     unsigned IndentLevel = 0) const;
 };
 
-LLVM_ABI raw_ostream &operator<<(raw_ostream &OS, const UnwindRow &Row);
-
 /// A class that contains all UnwindRow objects for an FDE or a single unwind
 /// row for a CIE. To unwind an address the rows, which are sorted by start
 /// address, can be searched to find the UnwindRow with the lowest starting
@@ -325,23 +289,6 @@ class UnwindTable {
     return Rows[Index];
   }
 
-  /// Dump the UnwindTable to the stream.
-  ///
-  /// \param OS the stream to use for output.
-  ///
-  /// \param MRI register information that helps emit register names instead
-  /// of raw register numbers.
-  ///
-  /// \param IsEH true if the DWARF Call Frame Information is from .eh_frame
-  /// instead of from .debug_frame. This is needed for register number
-  /// conversion because some register numbers differ between the two sections
-  /// for certain architectures like x86.
-  ///
-  /// \param IndentLevel specify the indent level as an integer. The UnwindRow
-  /// will be output to the stream preceded by 2 * IndentLevel number of spaces.
-  LLVM_ABI void dump(raw_ostream &OS, DIDumpOptions DumpOpts,
-                     unsigned IndentLevel = 0) const;
-
 private:
   RowContainer Rows;
 };
@@ -367,8 +314,6 @@ LLVM_ABI Expected<UnwindTable::RowContainer>
 parseRows(const CFIProgram &CFIP, UnwindRow &CurrRow,
           const RegisterLocations *InitialLocs);
 
-LLVM_ABI raw_ostream &operator<<(raw_ostream &OS, const UnwindTable &Rows);
-
 } // end namespace dwarf
 
 } // end namespace llvm

llvm/lib/DebugInfo/DWARF/CMakeLists.txt

@@ -28,6 +28,7 @@ add_llvm_component_library(LLVMDebugInfoDWARF
   DWARFTypeUnit.cpp
   DWARFUnitIndex.cpp
   DWARFUnit.cpp
+  DWARFUnwindTablePrinter.cpp
   DWARFVerifier.cpp
 
   ADDITIONAL_HEADER_DIRS

llvm/lib/DebugInfo/DWARF/DWARFDebugFrame.cpp

@@ -15,6 +15,7 @@
 #include "llvm/DebugInfo/DWARF/DWARFCFIPrinter.h"
 #include "llvm/DebugInfo/DWARF/DWARFDataExtractor.h"
 #include "llvm/DebugInfo/DWARF/DWARFExpressionPrinter.h"
+#include "llvm/DebugInfo/DWARF/DWARFUnwindTablePrinter.h"
 #include "llvm/DebugInfo/DWARF/LowLevel/DWARFCFIProgram.h"
 #include "llvm/DebugInfo/DWARF/LowLevel/DWARFExpression.h"
 #include "llvm/Support/Compiler.h"
@@ -136,7 +137,7 @@ void CIE::dump(raw_ostream &OS, DIDumpOptions DumpOpts) const {
   OS << "\n";
 
   if (Expected<UnwindTable> RowsOrErr = createUnwindTable(this))
-    RowsOrErr->dump(OS, DumpOpts, 1);
+    printUnwindTable(*RowsOrErr, OS, DumpOpts, 1);
   else {
     DumpOpts.RecoverableErrorHandler(joinErrors(
         createStringError(errc::invalid_argument,
@@ -164,7 +165,7 @@ void FDE::dump(raw_ostream &OS, DIDumpOptions DumpOpts) const {
   OS << "\n";
 
   if (Expected<UnwindTable> RowsOrErr = createUnwindTable(this))
-    RowsOrErr->dump(OS, DumpOpts, 1);
+    printUnwindTable(*RowsOrErr, OS, DumpOpts, 1);
   else {
     DumpOpts.RecoverableErrorHandler(joinErrors(
         createStringError(errc::invalid_argument,