[llvm] r286316 - Added the ability to dump hex bytes easily into a raw_ostream.
Greg Clayton via llvm-commits
llvm-commits at lists.llvm.org
Tue Nov 8 16:15:55 PST 2016
Author: gclayton
Date: Tue Nov 8 18:15:54 2016
New Revision: 286316
URL: http://llvm.org/viewvc/llvm-project?rev=286316&view=rev
Log:
Added the ability to dump hex bytes easily into a raw_ostream.
Unit tests were added to verify this functionality keeps working correctly.
Example output for raw hex bytes:
llvm::ArrayRef<uint8_t> Bytes = ...;
llvm::outs() << format_hex_bytes(Bytes);
554889e5 4881ec70 04000048 8d051002
00004c8d 05fd0100 004c8b0d d0020000
Example output for raw hex bytes with offsets:
llvm::outs() << format_hex_bytes(Bytes, 0x100000d10);
0x0000000100000d10: 554889e5 4881ec70 04000048 8d051002
0x0000000100000d20: 00004c8d 05fd0100 004c8b0d d0020000
Example output for raw hex bytes with ASCII with offsets:
llvm::outs() << format_hex_bytes_with_ascii(Bytes, 0x100000d10);
0x0000000100000d10: 554889e5 4881ec70 04000048 8d051002 |UH.?H.?p...H....|
0x0000000100000d20: 00004c8d 05fd0100 004c8b0d d0020000 |..L..?...L..?...|
The default groups bytes into 4 byte groups, but this can be changed to 1 byte:
llvm::outs() << format_hex_bytes(Bytes, 0x100000d10, 16 /*NumPerLine*/, 1 /*ByteGroupSize*/);
0x0000000100000d10: 55 48 89 e5 48 81 ec 70 04 00 00 48 8d 05 10 02
0x0000000100000d20: 00 00 4c 8d 05 fd 01 00 00 4c 8b 0d d0 02 00 00
llvm::outs() << format_hex_bytes(Bytes, 0x100000d10, 16 /*NumPerLine*/, 2 /*ByteGroupSize*/);
0x0000000100000d10: 5548 89e5 4881 ec70 0400 0048 8d05 1002
0x0000000100000d20: 0000 4c8d 05fd 0100 004c 8b0d d002 0000
llvm::outs() << format_hex_bytes(Bytes, 0x100000d10, 8 /*NumPerLine*/, 1 /*ByteGroupSize*/);
0x0000000100000d10: 55 48 89 e5 48 81 ec 70
0x0000000100000d18: 04 00 00 48 8d 05 10 02
0x0000000100000d20: 00 00 4c 8d 05 fd 01 00
0x0000000100000d28: 00 4c 8b 0d d0 02 00 00
https://reviews.llvm.org/D26405
Modified:
llvm/trunk/include/llvm/Support/Format.h
llvm/trunk/include/llvm/Support/raw_ostream.h
llvm/trunk/lib/Support/raw_ostream.cpp
llvm/trunk/unittests/Support/raw_ostream_test.cpp
Modified: llvm/trunk/include/llvm/Support/Format.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/Format.h?rev=286316&r1=286315&r2=286316&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/Format.h (original)
+++ llvm/trunk/include/llvm/Support/Format.h Tue Nov 8 18:15:54 2016
@@ -23,6 +23,7 @@
#ifndef LLVM_SUPPORT_FORMAT_H
#define LLVM_SUPPORT_FORMAT_H
+#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/DataTypes.h"
@@ -202,6 +203,39 @@ inline FormattedNumber format_decimal(in
return FormattedNumber(0, N, Width, false, false, false);
}
+class FormattedHexBytes {
+ llvm::ArrayRef<uint8_t> Bytes;
+ // Display offsets for each line if FirstByteOffset has a value.
+ llvm::Optional<uint64_t> FirstByteOffset;
+ uint32_t NumPerLine; // Number of bytes to show per line.
+ uint8_t ByteGroupSize; // How many hex bytes are grouped without spaces
+ bool Upper; // Show offset and hex bytes as upper case.
+ bool ASCII; // Show the ASCII bytes for the hex bytes to the right.
+ friend class raw_ostream;
+
+public:
+ FormattedHexBytes(llvm::ArrayRef<uint8_t> B, llvm::Optional<uint64_t> O,
+ uint32_t NPL, uint8_t BGS, bool U, bool A)
+ : Bytes(B), FirstByteOffset(O), NumPerLine(NPL), ByteGroupSize(BGS),
+ Upper(U), ASCII(A) {}
+};
+
+inline FormattedHexBytes format_hex_bytes(
+ llvm::ArrayRef<uint8_t> Bytes,
+ llvm::Optional<uint64_t> FirstByteOffset = llvm::Optional<uint64_t>(),
+ uint32_t NumPerLine = 16, uint8_t ByteGroupSize = 4) {
+ return FormattedHexBytes(Bytes, FirstByteOffset, NumPerLine, ByteGroupSize,
+ false /*Upper*/, false /*ASCII*/);
+}
+
+inline FormattedHexBytes format_hex_bytes_with_ascii(
+ llvm::ArrayRef<uint8_t> Bytes,
+ llvm::Optional<uint64_t> FirstByteOffset = llvm::Optional<uint64_t>(),
+ uint32_t NumPerLine = 16, uint8_t ByteGroupSize = 4) {
+ return FormattedHexBytes(Bytes, FirstByteOffset, NumPerLine, ByteGroupSize,
+ false /*Upper*/, true /*ASCII*/);
+}
+
} // end namespace llvm
#endif
Modified: llvm/trunk/include/llvm/Support/raw_ostream.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/raw_ostream.h?rev=286316&r1=286315&r2=286316&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/raw_ostream.h (original)
+++ llvm/trunk/include/llvm/Support/raw_ostream.h Tue Nov 8 18:15:54 2016
@@ -23,6 +23,7 @@ namespace llvm {
class format_object_base;
class FormattedString;
class FormattedNumber;
+class FormattedHexBytes;
template <typename T> class SmallVectorImpl;
namespace sys {
@@ -222,6 +223,9 @@ public:
// Formatted output, see the formatHex() function in Support/Format.h.
raw_ostream &operator<<(const FormattedNumber &);
+ // Formatted output, see the formatHex() function in Support/Format.h.
+ raw_ostream &operator<<(const FormattedHexBytes &);
+
/// indent - Insert 'NumSpaces' spaces.
raw_ostream &indent(unsigned NumSpaces);
Modified: llvm/trunk/lib/Support/raw_ostream.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Support/raw_ostream.cpp?rev=286316&r1=286315&r2=286316&view=diff
==============================================================================
--- llvm/trunk/lib/Support/raw_ostream.cpp (original)
+++ llvm/trunk/lib/Support/raw_ostream.cpp Tue Nov 8 18:15:54 2016
@@ -352,6 +352,61 @@ raw_ostream &raw_ostream::operator<<(con
return *this;
}
+raw_ostream &raw_ostream::operator<<(const FormattedHexBytes &FB) {
+ size_t LineIndex = 0;
+ const size_t Size = FB.Bytes.size();
+ HexPrintStyle OffsetStyle =
+ FB.Upper ? HexPrintStyle::PrefixUpper : HexPrintStyle::PrefixLower;
+ HexPrintStyle ByteStyle =
+ FB.Upper ? HexPrintStyle::Upper : HexPrintStyle::Lower;
+ while (LineIndex < Size) {
+ if (FB.FirstByteOffset.hasValue()) {
+ uint64_t Offset = FB.FirstByteOffset.getValue();
+ llvm::write_hex(*this, Offset + LineIndex, OffsetStyle,
+ sizeof(Offset) * 2 + 2);
+ *this << ": ";
+ }
+ // Print the hex bytes for this line
+ uint32_t I = 0;
+ for (I = 0; I < FB.NumPerLine; ++I) {
+ size_t Index = LineIndex + I;
+ if (Index >= Size)
+ break;
+ if (I && (I % FB.ByteGroupSize) == 0)
+ *this << " ";
+ llvm::write_hex(*this, FB.Bytes[Index], ByteStyle, 2);
+ }
+ uint32_t BytesDisplayed = I;
+ if (FB.ASCII) {
+ // Print any spaces needed for any bytes that we didn't print on this
+ // line so that the ASCII bytes are correctly aligned.
+ for (; I < FB.NumPerLine; ++I) {
+ if (I && (I % FB.ByteGroupSize) == 0)
+ indent(3);
+ else
+ indent(2);
+ }
+ *this << " |";
+ // Print the ASCII char values for each byte on this line
+ for (I = 0; I < FB.NumPerLine; ++I) {
+ size_t Index = LineIndex + I;
+ if (Index >= Size)
+ break;
+ char ch = (char)FB.Bytes[Index];
+ if (isprint(ch))
+ *this << ch;
+ else
+ *this << '.';
+ }
+ *this << '|';
+ }
+ LineIndex += BytesDisplayed;
+ if (LineIndex < Size)
+ *this << '\n';
+ }
+ return *this;
+}
+
/// indent - Insert 'NumSpaces' spaces.
raw_ostream &raw_ostream::indent(unsigned NumSpaces) {
static const char Spaces[] = " "
Modified: llvm/trunk/unittests/Support/raw_ostream_test.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/unittests/Support/raw_ostream_test.cpp?rev=286316&r1=286315&r2=286316&view=diff
==============================================================================
--- llvm/trunk/unittests/Support/raw_ostream_test.cpp (original)
+++ llvm/trunk/unittests/Support/raw_ostream_test.cpp Tue Nov 8 18:15:54 2016
@@ -181,5 +181,157 @@ TEST(raw_ostreamTest, FormatDecimal) {
printToString(format_decimal(INT64_MIN, 21), 21));
}
+std::string
+format_hex_bytes(const void *P, size_t N,
+ llvm::Optional<uint64_t> Offset = llvm::Optional<uint64_t>(),
+ uint32_t NumPerLine = 16, uint8_t ByteGroupSize = 4) {
+ std::string S;
+ if (P && N) {
+ llvm::raw_string_ostream Str(S);
+ Str << llvm::format_hex_bytes(
+ llvm::ArrayRef<uint8_t>(static_cast<const uint8_t *>(P), N), Offset,
+ NumPerLine, ByteGroupSize);
+ Str.flush();
+ }
+ return S;
+}
+
+std::string format_hex_bytes_with_ascii(
+ const void *P, size_t N,
+ llvm::Optional<uint64_t> Offset = llvm::Optional<uint64_t>(),
+ uint32_t NumPerLine = 16, uint8_t ByteGroupSize = 4) {
+ std::string S;
+ if (P && N) {
+ llvm::raw_string_ostream Str(S);
+ Str << llvm::format_hex_bytes_with_ascii(
+ llvm::ArrayRef<uint8_t>(static_cast<const uint8_t *>(P), N), Offset,
+ NumPerLine, ByteGroupSize);
+ Str.flush();
+ }
+ return S;
+}
+
+TEST(raw_ostreamTest, FormattedHexBytes) {
+ char b[] = {'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l',
+ 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x',
+ 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'};
+ // Test raw bytes
+ const llvm::Optional<uint64_t> InvalidOffset;
+ // Test invalid input.
+ EXPECT_EQ("", format_hex_bytes(nullptr, 0));
+ EXPECT_EQ("", format_hex_bytes(b, 0));
+ EXPECT_EQ("", format_hex_bytes(nullptr, 16));
+ //----------------------------------------------------------------------
+ // Test hex byte output with the default 4 byte groups
+ //----------------------------------------------------------------------
+ EXPECT_EQ("61", format_hex_bytes(b, 1));
+ EXPECT_EQ("61626364 65", format_hex_bytes(b, 5));
+ // Test that 16 bytes get written to a line correctly.
+ EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70", format_hex_bytes(b, 16));
+ // Test raw bytes with default 16 bytes per line wrapping.
+ EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70\n71", format_hex_bytes(b, 17));
+ // Test raw bytes with 1 bytes per line wrapping.
+ EXPECT_EQ("61\n62\n63\n64\n65\n66", format_hex_bytes(b, 6, InvalidOffset, 1));
+ // Test raw bytes with 7 bytes per line wrapping.
+ EXPECT_EQ("61626364 656667\n68696a6b 6c6d6e\n6f7071",
+ format_hex_bytes(b, 17, InvalidOffset, 7));
+ // Test raw bytes with 8 bytes per line wrapping.
+ EXPECT_EQ("61626364 65666768\n696a6b6c 6d6e6f70\n71",
+ format_hex_bytes(b, 17, InvalidOffset, 8));
+ //----------------------------------------------------------------------
+ // Test hex byte output with the 1 byte groups
+ //----------------------------------------------------------------------
+ EXPECT_EQ("61 62 63 64 65", format_hex_bytes(b, 5, InvalidOffset, 16, 1));
+ // Test that 16 bytes get written to a line correctly.
+ EXPECT_EQ("61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70",
+ format_hex_bytes(b, 16, InvalidOffset, 16, 1));
+ // Test raw bytes with default 16 bytes per line wrapping.
+ EXPECT_EQ("61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70\n71",
+ format_hex_bytes(b, 17, InvalidOffset, 16, 1));
+ // Test raw bytes with 7 bytes per line wrapping.
+ EXPECT_EQ("61 62 63 64 65 66 67\n68 69 6a 6b 6c 6d 6e\n6f 70 71",
+ format_hex_bytes(b, 17, InvalidOffset, 7, 1));
+ // Test raw bytes with 8 bytes per line wrapping.
+ EXPECT_EQ("61 62 63 64 65 66 67 68\n69 6a 6b 6c 6d 6e 6f 70\n71",
+ format_hex_bytes(b, 17, InvalidOffset, 8, 1));
+ //----------------------------------------------------------------------
+ // Test hex byte output with the 2 byte groups
+ //----------------------------------------------------------------------
+ EXPECT_EQ("6162 6364 65", format_hex_bytes(b, 5, InvalidOffset, 16, 2));
+ // Test that 16 bytes get written to a line correctly.
+ EXPECT_EQ("6162 6364 6566 6768 696a 6b6c 6d6e 6f70",
+ format_hex_bytes(b, 16, InvalidOffset, 16, 2));
+ // Test raw bytes with default 16 bytes per line wrapping.
+ EXPECT_EQ("6162 6364 6566 6768 696a 6b6c 6d6e 6f70\n71",
+ format_hex_bytes(b, 17, InvalidOffset, 16, 2));
+ // Test raw bytes with 7 bytes per line wrapping.
+ EXPECT_EQ("6162 6364 6566 67\n6869 6a6b 6c6d 6e\n6f70 71",
+ format_hex_bytes(b, 17, InvalidOffset, 7, 2));
+ // Test raw bytes with 8 bytes per line wrapping.
+ EXPECT_EQ("6162 6364 6566 6768\n696a 6b6c 6d6e 6f70\n71",
+ format_hex_bytes(b, 17, InvalidOffset, 8, 2));
+
+ //----------------------------------------------------------------------
+ // Test hex bytes with offset with the default 4 byte groups.
+ //----------------------------------------------------------------------
+ EXPECT_EQ("0x0000000000000000: 61", format_hex_bytes(b, 1, 0x0));
+ EXPECT_EQ("0x0000000000001000: 61", format_hex_bytes(b, 1, 0x1000));
+ EXPECT_EQ("0x0000000000001000: 61\n0x0000000000001001: 62",
+ format_hex_bytes(b, 2, 0x1000, 1));
+ //----------------------------------------------------------------------
+ // Test hex bytes with ASCII with the default 4 byte groups.
+ //----------------------------------------------------------------------
+ EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70 |abcdefghijklmnop|",
+ format_hex_bytes_with_ascii(b, 16));
+ EXPECT_EQ("61626364 65666768 |abcdefgh|\n"
+ "696a6b6c 6d6e6f70 |ijklmnop|",
+ format_hex_bytes_with_ascii(b, 16, InvalidOffset, 8));
+ EXPECT_EQ("61626364 65666768 |abcdefgh|\n696a6b6c |ijkl|",
+ format_hex_bytes_with_ascii(b, 12, InvalidOffset, 8));
+ char unprintable[] = {'a', '\x1e', 'b', '\x1f'};
+ // Make sure the ASCII is still lined up correctly when fewer bytes than 16
+ // bytes per line are available. The ASCII should still be aligned as if 16
+ // bytes of hex might be displayed.
+ EXPECT_EQ("611e621f |a.b.|",
+ format_hex_bytes_with_ascii(unprintable, 4));
+ //----------------------------------------------------------------------
+ // Test hex bytes with ASCII with offsets with the default 4 byte groups.
+ //----------------------------------------------------------------------
+ EXPECT_EQ("0x0000000000000000: 61626364 65666768 "
+ "696a6b6c 6d6e6f70 |abcdefghijklmnop|",
+ format_hex_bytes_with_ascii(b, 16, 0));
+ EXPECT_EQ("0x0000000000000000: 61626364 65666768 |abcdefgh|\n"
+ "0x0000000000000008: 696a6b6c 6d6e6f70 |ijklmnop|",
+ format_hex_bytes_with_ascii(b, 16, 0, 8));
+ EXPECT_EQ("0x0000000000000000: 61626364 656667 |abcdefg|\n"
+ "0x0000000000000007: 68696a6b 6c |hijkl|",
+ format_hex_bytes_with_ascii(b, 12, 0, 7));
+
+ //----------------------------------------------------------------------
+ // Test hex bytes with ASCII with offsets with the default 2 byte groups.
+ //----------------------------------------------------------------------
+ EXPECT_EQ("0x0000000000000000: 6162 6364 6566 6768 "
+ "696a 6b6c 6d6e 6f70 |abcdefghijklmnop|",
+ format_hex_bytes_with_ascii(b, 16, 0, 16, 2));
+ EXPECT_EQ("0x0000000000000000: 6162 6364 6566 6768 |abcdefgh|\n"
+ "0x0000000000000008: 696a 6b6c 6d6e 6f70 |ijklmnop|",
+ format_hex_bytes_with_ascii(b, 16, 0, 8, 2));
+ EXPECT_EQ("0x0000000000000000: 6162 6364 6566 67 |abcdefg|\n"
+ "0x0000000000000007: 6869 6a6b 6c |hijkl|",
+ format_hex_bytes_with_ascii(b, 12, 0, 7, 2));
+
+ //----------------------------------------------------------------------
+ // Test hex bytes with ASCII with offsets with the default 1 byte groups.
+ //----------------------------------------------------------------------
+ EXPECT_EQ("0x0000000000000000: 61 62 63 64 65 66 67 68 "
+ "69 6a 6b 6c 6d 6e 6f 70 |abcdefghijklmnop|",
+ format_hex_bytes_with_ascii(b, 16, 0, 16, 1));
+ EXPECT_EQ("0x0000000000000000: 61 62 63 64 65 66 67 68 |abcdefgh|\n"
+ "0x0000000000000008: 69 6a 6b 6c 6d 6e 6f 70 |ijklmnop|",
+ format_hex_bytes_with_ascii(b, 16, 0, 8, 1));
+ EXPECT_EQ("0x0000000000000000: 61 62 63 64 65 66 67 |abcdefg|\n"
+ "0x0000000000000007: 68 69 6a 6b 6c |hijkl|",
+ format_hex_bytes_with_ascii(b, 12, 0, 7, 1));
+}
}
More information about the llvm-commits
mailing list