[DebugInfo] Dump CIE augmentation data as a list of hex bytes

[atanasyan]

Summary

CIE augmentation data might contain non-printable characters. The patch prints the data as a list of hex bytes.

[pete]

Hi Simon

Any idea what the non-LLVM objdump/dwarfdump would print in this case?

Either way, LGTM as this is an improvement over the current code.

Thanks,
Pete

[atanasyan]

In D17759#365376, @pete wrote:

Hi Pete,

Any idea what the non-LLVM objdump/dwarfdump would print in this case?

GNU objdump prints the same list of hex bytes.

Either way, LGTM as this is an improvement over the current code.

Thanks for review.

lib/DebugInfo/DWARF/DWARFDebugFrame.cpp

 //===-- DWARFDebugFrame.h - Parsing of .debug_frame -------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/DebugInfo/DWARF/DWARFDebugFrame.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/SmallString.h"
+#include "llvm/ADT/StringExtras.h"
 #include "llvm/Support/Casting.h"
 #include "llvm/Support/DataTypes.h"
 #include "llvm/Support/Dwarf.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/Format.h"
 #include "llvm/Support/raw_ostream.h"
 #include <string>
 #include <vector>
if (Version >= 4) {
                    (uint32_t)SegmentDescriptorSize);
     }
     OS << format("  Code alignment factor: %u\n",
                  (uint32_t)CodeAlignmentFactor);
     OS << format("  Data alignment factor: %d\n",
                  (int32_t)DataAlignmentFactor);
     OS << format("  Return address column: %d\n",
                  (int32_t)ReturnAddressRegister);
-    if (!AugmentationData.empty())
-      OS << "  Augmentation data:     " << AugmentationData << "\n";
+    if (!AugmentationData.empty()) {
+      OS << "  Augmentation data:    ";
+      for (uint8_t Byte : AugmentationData)
+        OS << ' ' << hexdigit(Byte >> 4) << hexdigit(Byte & 0xf);
+      OS << "\n";
+    }
     OS << "\n";
   }
 
   static bool classof(const FrameEntry *FE) {
     return FE->getKind() == FK_CIE;
   }
 
 private:

test/tools/llvm-objdump/eh_frame-arm64.test

 # RUN: llvm-objdump -dwarf=frames %p/Inputs/eh_frame.macho-arm64 2>/dev/null | FileCheck %s
 
 # CHECK: .eh_frame contents:
 
 # CHECK: 00000000 00000010 ffffffff CIE
 # CHECK:   Version:               1
 # CHECK:   Augmentation:          "zR"
 # CHECK:   Code alignment factor: 1
 # CHECK:   Data alignment factor: -8
 # CHECK:   Return address column: 30
-# CHECK:   Augmentation data:
+# CHECK:   Augmentation data:     10
 
 # CHECK:   DW_CFA_def_cfa: reg31 +0
 
 # CHECK: 00000014 00000020 00000018 FDE cie=00000018 pc=ffffffe4...00000004
 # CHECK:   DW_CFA_advance_loc: 8
 # CHECK:   DW_CFA_def_cfa_offset: +16
 # CHECK:   DW_CFA_offset: reg30 -8
 # CHECK:   DW_CFA_offset: reg29 -16
 # CHECK:   DW_CFA_nop:
 # CHECK:   DW_CFA_nop:
 # CHECK:   DW_CFA_nop:
 # CHECK:   DW_CFA_nop:

test/tools/llvm-objdump/eh_frame-mipsel.test

+# RUN: llvm-objdump -dwarf=frames %p/Inputs/eh_frame.elf-mipsel | FileCheck %s
+
+# CHECK: .eh_frame contents:
+
+# CHECK: 00000000 00000018 ffffffff CIE
+# CHECK:   Version:               1
+# CHECK:   Augmentation:          "zPLR"
+# CHECK:   Code alignment factor: 1
+# CHECK:   Data alignment factor: -4
+# CHECK:   Return address column: 31
+# CHECK:   Augmentation data:     80 90 0B 41 00 00 0B
+
+# CHECK:   DW_CFA_def_cfa: reg29 +0
+
+# CHECK: 0000001c 00000018 00000020 FDE cie=00000020 pc=00400890...004008dc
+# CHECK:   DW_CFA_advance_loc: 4
+# CHECK:   DW_CFA_def_cfa_offset: +24
+# CHECK:   DW_CFA_advance_loc: 4
+# CHECK:   DW_CFA_offset: reg31 -4
+# CHECK:   DW_CFA_nop:
+
+# CHECK: 00000038 00000000 ffffffff CIE
+# CHECK:   Version:               0
+# CHECK:   Augmentation:          ""
+# CHECK:   Code alignment factor: 0
+# CHECK:   Data alignment factor: 0
+# CHECK:   Return address column: 0