RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-25 20:23:11 +01:00
Code Issues Projects Releases Wiki Activity
8ad43c1b44
llvm-mirror/unittests/Support/raw_ostream_test.cpp
Greg Clayton 8ad43c1b44 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

llvm-svn: 286316
2016-11-09 00:15:54 +00:00

338 lines
14 KiB
C++
Raw Blame History

//===- llvm/unittest/Support/raw_ostream_test.cpp - raw_ostream tests -----===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "gtest/gtest.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/Support/Format.h"
#include "llvm/Support/raw_ostream.h"
using namespace llvm;
namespace {
template<typename T> std::string printToString(const T &Value) {
std::string res;
llvm::raw_string_ostream(res) << Value;
return res;
}
/// printToString - Print the given value to a stream which only has \arg
/// BytesLeftInBuffer bytes left in the buffer. This is useful for testing edge
/// cases in the buffer handling logic.
template<typename T> std::string printToString(const T &Value,
unsigned BytesLeftInBuffer) {
// FIXME: This is relying on internal knowledge of how raw_ostream works to
// get the buffer position right.
SmallString<256> SVec;
assert(BytesLeftInBuffer < 256 && "Invalid buffer count!");
llvm::raw_svector_ostream OS(SVec);
unsigned StartIndex = 256 - BytesLeftInBuffer;
for (unsigned i = 0; i != StartIndex; ++i)
OS << '?';
OS << Value;
return OS.str().substr(StartIndex);
}
template<typename T> std::string printToStringUnbuffered(const T &Value) {
std::string res;
llvm::raw_string_ostream OS(res);
OS.SetUnbuffered();
OS << Value;
return res;
}
TEST(raw_ostreamTest, Types_Buffered) {
// Char
EXPECT_EQ("c", printToString('c'));
// String
EXPECT_EQ("hello", printToString("hello"));
EXPECT_EQ("hello", printToString(std::string("hello")));
// Int
EXPECT_EQ("0", printToString(0));
EXPECT_EQ("2425", printToString(2425));
EXPECT_EQ("-2425", printToString(-2425));
// Long long
EXPECT_EQ("0", printToString(0LL));
EXPECT_EQ("257257257235709", printToString(257257257235709LL));
EXPECT_EQ("-257257257235709", printToString(-257257257235709LL));
// Double
EXPECT_EQ("1.100000e+00", printToString(1.1));
// void*
EXPECT_EQ("0x0", printToString((void*) nullptr));
EXPECT_EQ("0xbeef", printToString((void*) 0xbeefLL));
EXPECT_EQ("0xdeadbeef", printToString((void*) 0xdeadbeefLL));
// Min and max.
EXPECT_EQ("18446744073709551615", printToString(UINT64_MAX));
EXPECT_EQ("-9223372036854775808", printToString(INT64_MIN));
}
TEST(raw_ostreamTest, Types_Unbuffered) {
// Char
EXPECT_EQ("c", printToStringUnbuffered('c'));
// String
EXPECT_EQ("hello", printToStringUnbuffered("hello"));
EXPECT_EQ("hello", printToStringUnbuffered(std::string("hello")));
// Int
EXPECT_EQ("0", printToStringUnbuffered(0));
EXPECT_EQ("2425", printToStringUnbuffered(2425));
EXPECT_EQ("-2425", printToStringUnbuffered(-2425));
// Long long
EXPECT_EQ("0", printToStringUnbuffered(0LL));
EXPECT_EQ("257257257235709", printToStringUnbuffered(257257257235709LL));
EXPECT_EQ("-257257257235709", printToStringUnbuffered(-257257257235709LL));
// Double
EXPECT_EQ("1.100000e+00", printToStringUnbuffered(1.1));
// void*
EXPECT_EQ("0x0", printToStringUnbuffered((void*) nullptr));
EXPECT_EQ("0xbeef", printToStringUnbuffered((void*) 0xbeefLL));
EXPECT_EQ("0xdeadbeef", printToStringUnbuffered((void*) 0xdeadbeefLL));
// Min and max.
EXPECT_EQ("18446744073709551615", printToStringUnbuffered(UINT64_MAX));
EXPECT_EQ("-9223372036854775808", printToStringUnbuffered(INT64_MIN));
}
TEST(raw_ostreamTest, BufferEdge) {
EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 1));
EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 2));
EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 3));
EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 4));
EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 10));
}
TEST(raw_ostreamTest, TinyBuffer) {
std::string Str;
raw_string_ostream OS(Str);
OS.SetBufferSize(1);
OS << "hello";
OS << 1;
OS << 'w' << 'o' << 'r' << 'l' << 'd';
EXPECT_EQ("hello1world", OS.str());
}
TEST(raw_ostreamTest, WriteEscaped) {
std::string Str;
Str = "";
raw_string_ostream(Str).write_escaped("hi");
EXPECT_EQ("hi", Str);
Str = "";
raw_string_ostream(Str).write_escaped("\\\t\n\"");
EXPECT_EQ("\\\\\\t\\n\\\"", Str);
Str = "";
raw_string_ostream(Str).write_escaped("\1\10\200");
EXPECT_EQ("\\001\\010\\200", Str);
}
TEST(raw_ostreamTest, Justify) {
EXPECT_EQ("xyz ", printToString(left_justify("xyz", 6), 6));
EXPECT_EQ("abc", printToString(left_justify("abc", 3), 3));
EXPECT_EQ("big", printToString(left_justify("big", 1), 3));
EXPECT_EQ(" xyz", printToString(right_justify("xyz", 6), 6));
EXPECT_EQ("abc", printToString(right_justify("abc", 3), 3));
EXPECT_EQ("big", printToString(right_justify("big", 1), 3));
}
TEST(raw_ostreamTest, FormatHex) {
EXPECT_EQ("0x1234", printToString(format_hex(0x1234, 6), 6));
EXPECT_EQ("0x001234", printToString(format_hex(0x1234, 8), 8));
EXPECT_EQ("0x00001234", printToString(format_hex(0x1234, 10), 10));
EXPECT_EQ("0x1234", printToString(format_hex(0x1234, 4), 6));
EXPECT_EQ("0xff", printToString(format_hex(255, 4), 4));
EXPECT_EQ("0xFF", printToString(format_hex(255, 4, true), 4));
EXPECT_EQ("0x1", printToString(format_hex(1, 3), 3));
EXPECT_EQ("0x12", printToString(format_hex(0x12, 3), 4));
EXPECT_EQ("0x123", printToString(format_hex(0x123, 3), 5));
EXPECT_EQ("FF", printToString(format_hex_no_prefix(0xFF, 2, true), 4));
EXPECT_EQ("ABCD", printToString(format_hex_no_prefix(0xABCD, 2, true), 4));
EXPECT_EQ("0xffffffffffffffff",
printToString(format_hex(UINT64_MAX, 18), 18));
EXPECT_EQ("0x8000000000000000",
printToString(format_hex((INT64_MIN), 18), 18));
}
TEST(raw_ostreamTest, FormatDecimal) {
EXPECT_EQ(" 0", printToString(format_decimal(0, 4), 4));
EXPECT_EQ(" -1", printToString(format_decimal(-1, 4), 4));
EXPECT_EQ(" -1", printToString(format_decimal(-1, 6), 6));
EXPECT_EQ("1234567890", printToString(format_decimal(1234567890, 10), 10));
EXPECT_EQ(" 9223372036854775807",
printToString(format_decimal(INT64_MAX, 21), 21));
EXPECT_EQ(" -9223372036854775808",
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));
}
}
Reference in New Issue View Git Blame Copy Permalink