blob: 94cd347d09a62c61cca4b98970264c05cefe9661 [file] [log] [blame]
Zachary Turner018338e2017-08-02 22:26:09 +00001//===- llvm/unittest/DebugInfo/MSF/MappedBlockStreamTest.cpp --------------===//
Zachary Turner90b8b8d2016-05-31 22:41:52 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Zachary Turnercb30e702017-06-14 16:41:50 +000010#include "llvm/DebugInfo/MSF/MappedBlockStream.h"
Zachary Turnera3225b02016-07-29 20:56:36 +000011#include "llvm/DebugInfo/MSF/IMSFFile.h"
Zachary Turner120faca2017-02-27 22:11:43 +000012#include "llvm/DebugInfo/MSF/MSFError.h"
Zachary Turnerd9dc2822017-03-02 20:52:51 +000013#include "llvm/Support/BinaryByteStream.h"
14#include "llvm/Support/BinaryStreamReader.h"
15#include "llvm/Support/BinaryStreamRef.h"
16#include "llvm/Support/BinaryStreamWriter.h"
Zachary Turnercb30e702017-06-14 16:41:50 +000017#include "llvm/Testing/Support/Error.h"
18
Zachary Turner90b8b8d2016-05-31 22:41:52 +000019#include "gtest/gtest.h"
20
Zachary Turnerf52a8992016-07-15 20:43:38 +000021#include <unordered_map>
22
Zachary Turner90b8b8d2016-05-31 22:41:52 +000023using namespace llvm;
Zachary Turnerbac69d32016-07-22 19:56:05 +000024using namespace llvm::msf;
Zachary Turner695ed562017-02-28 00:04:07 +000025using namespace llvm::support;
Zachary Turner90b8b8d2016-05-31 22:41:52 +000026
27namespace {
28
NAKAMURA Takumi47d1e372016-06-01 14:26:54 +000029static const uint32_t BlocksAry[] = {0, 1, 2, 5, 4, 3, 6, 7, 8, 9};
Zachary Turner5acb4ac2016-06-10 05:09:12 +000030static uint8_t DataAry[] = {'A', 'B', 'C', 'F', 'E', 'D', 'G', 'H', 'I', 'J'};
NAKAMURA Takumi47d1e372016-06-01 14:26:54 +000031
Zachary Turner120faca2017-02-27 22:11:43 +000032class DiscontiguousStream : public WritableBinaryStream {
Zachary Turner90b8b8d2016-05-31 22:41:52 +000033public:
Zachary Turnerd66889c2016-07-28 19:12:28 +000034 DiscontiguousStream(ArrayRef<uint32_t> Blocks, MutableArrayRef<uint8_t> Data)
Zachary Turner5acb4ac2016-06-10 05:09:12 +000035 : Blocks(Blocks.begin(), Blocks.end()), Data(Data.begin(), Data.end()) {}
Zachary Turner90b8b8d2016-05-31 22:41:52 +000036
Zachary Turnerd66889c2016-07-28 19:12:28 +000037 uint32_t block_size() const { return 1; }
38 uint32_t block_count() const { return Blocks.size(); }
39
Zachary Turner695ed562017-02-28 00:04:07 +000040 endianness getEndian() const override { return little; }
41
Zachary Turnerd66889c2016-07-28 19:12:28 +000042 Error readBytes(uint32_t Offset, uint32_t Size,
Zachary Turner120faca2017-02-27 22:11:43 +000043 ArrayRef<uint8_t> &Buffer) override {
Zachary Turnerd0b44fa2017-02-28 17:49:34 +000044 if (auto EC = checkOffset(Offset, Size))
45 return EC;
Zachary Turnerd66889c2016-07-28 19:12:28 +000046 Buffer = Data.slice(Offset, Size);
47 return Error::success();
Zachary Turner90b8b8d2016-05-31 22:41:52 +000048 }
49
Zachary Turnerd66889c2016-07-28 19:12:28 +000050 Error readLongestContiguousChunk(uint32_t Offset,
Zachary Turner120faca2017-02-27 22:11:43 +000051 ArrayRef<uint8_t> &Buffer) override {
Zachary Turnerd0b44fa2017-02-28 17:49:34 +000052 if (auto EC = checkOffset(Offset, 1))
53 return EC;
Zachary Turnerd66889c2016-07-28 19:12:28 +000054 Buffer = Data.drop_front(Offset);
Zachary Turner5acb4ac2016-06-10 05:09:12 +000055 return Error::success();
56 }
57
Zachary Turner120faca2017-02-27 22:11:43 +000058 uint32_t getLength() override { return Data.size(); }
Zachary Turnerd66889c2016-07-28 19:12:28 +000059
Zachary Turner120faca2017-02-27 22:11:43 +000060 Error writeBytes(uint32_t Offset, ArrayRef<uint8_t> SrcData) override {
Zachary Turnerd0b44fa2017-02-28 17:49:34 +000061 if (auto EC = checkOffset(Offset, SrcData.size()))
62 return EC;
Zachary Turnerd66889c2016-07-28 19:12:28 +000063 ::memcpy(&Data[Offset], SrcData.data(), SrcData.size());
64 return Error::success();
65 }
Zachary Turner120faca2017-02-27 22:11:43 +000066 Error commit() override { return Error::success(); }
Zachary Turnerd66889c2016-07-28 19:12:28 +000067
Zachary Turnera3225b02016-07-29 20:56:36 +000068 MSFStreamLayout layout() const {
69 return MSFStreamLayout{static_cast<uint32_t>(Data.size()), Blocks};
Zachary Turnerd66889c2016-07-28 19:12:28 +000070 }
71
Zachary Turner5b74ff32017-06-03 00:33:35 +000072 BumpPtrAllocator Allocator;
73
Zachary Turner90b8b8d2016-05-31 22:41:52 +000074private:
Zachary Turner92d9e972016-06-07 05:32:48 +000075 std::vector<support::ulittle32_t> Blocks;
Zachary Turner5acb4ac2016-06-10 05:09:12 +000076 MutableArrayRef<uint8_t> Data;
Zachary Turner90b8b8d2016-05-31 22:41:52 +000077};
78
Zachary Turnerc4e4b7e2017-05-25 21:12:00 +000079TEST(MappedBlockStreamTest, NumBlocks) {
80 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +000081 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
82 F.Allocator);
Zachary Turnerc4e4b7e2017-05-25 21:12:00 +000083 EXPECT_EQ(F.block_size(), S->getBlockSize());
84 EXPECT_EQ(F.layout().Blocks.size(), S->getNumBlocks());
Zachary Turnerc4e4b7e2017-05-25 21:12:00 +000085}
86
Zachary Turner90b8b8d2016-05-31 22:41:52 +000087// Tests that a read which is entirely contained within a single block works
88// and does not allocate.
David Majnemerb6aa8752016-06-01 18:13:06 +000089TEST(MappedBlockStreamTest, ReadBeyondEndOfStreamRef) {
Zachary Turnerd66889c2016-07-28 19:12:28 +000090 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +000091 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
92 F.Allocator);
Zachary Turner199f48a2016-07-28 19:11:09 +000093
Zachary Turner120faca2017-02-27 22:11:43 +000094 BinaryStreamReader R(*S);
95 BinaryStreamRef SR;
Zachary Turnercb30e702017-06-14 16:41:50 +000096 EXPECT_THAT_ERROR(R.readStreamRef(SR, 0U), Succeeded());
David Majnemerb6aa8752016-06-01 18:13:06 +000097 ArrayRef<uint8_t> Buffer;
Zachary Turnercb30e702017-06-14 16:41:50 +000098 EXPECT_THAT_ERROR(SR.readBytes(0U, 1U, Buffer), Failed());
99 EXPECT_THAT_ERROR(R.readStreamRef(SR, 1U), Succeeded());
100 EXPECT_THAT_ERROR(SR.readBytes(1U, 1U, Buffer), Failed());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000101}
102
103// Tests that a read which outputs into a full destination buffer works and
104// does not fail due to the length of the output buffer.
105TEST(MappedBlockStreamTest, ReadOntoNonEmptyBuffer) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000106 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000107 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
108 F.Allocator);
Zachary Turnerd66889c2016-07-28 19:12:28 +0000109
Zachary Turner120faca2017-02-27 22:11:43 +0000110 BinaryStreamReader R(*S);
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000111 StringRef Str = "ZYXWVUTSRQPONMLKJIHGFEDCBA";
Zachary Turnercb30e702017-06-14 16:41:50 +0000112 EXPECT_THAT_ERROR(R.readFixedString(Str, 1), Succeeded());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000113 EXPECT_EQ(Str, StringRef("A"));
Zachary Turner5b74ff32017-06-03 00:33:35 +0000114 EXPECT_EQ(0U, F.Allocator.getBytesAllocated());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000115}
116
117// Tests that a read which crosses a block boundary, but where the subsequent
118// blocks are still contiguous in memory to the previous block works and does
119// not allocate memory.
120TEST(MappedBlockStreamTest, ZeroCopyReadContiguousBreak) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000121 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000122 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
123 F.Allocator);
Zachary Turner120faca2017-02-27 22:11:43 +0000124 BinaryStreamReader R(*S);
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000125 StringRef Str;
Zachary Turnercb30e702017-06-14 16:41:50 +0000126 EXPECT_THAT_ERROR(R.readFixedString(Str, 2), Succeeded());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000127 EXPECT_EQ(Str, StringRef("AB"));
Zachary Turner5b74ff32017-06-03 00:33:35 +0000128 EXPECT_EQ(0U, F.Allocator.getBytesAllocated());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000129
130 R.setOffset(6);
Zachary Turnercb30e702017-06-14 16:41:50 +0000131 EXPECT_THAT_ERROR(R.readFixedString(Str, 4), Succeeded());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000132 EXPECT_EQ(Str, StringRef("GHIJ"));
Zachary Turner5b74ff32017-06-03 00:33:35 +0000133 EXPECT_EQ(0U, F.Allocator.getBytesAllocated());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000134}
135
136// Tests that a read which crosses a block boundary and cannot be referenced
137// contiguously works and allocates only the precise amount of bytes
138// requested.
139TEST(MappedBlockStreamTest, CopyReadNonContiguousBreak) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000140 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000141 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
142 F.Allocator);
Zachary Turner120faca2017-02-27 22:11:43 +0000143 BinaryStreamReader R(*S);
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000144 StringRef Str;
Zachary Turnercb30e702017-06-14 16:41:50 +0000145 EXPECT_THAT_ERROR(R.readFixedString(Str, 10), Succeeded());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000146 EXPECT_EQ(Str, StringRef("ABCDEFGHIJ"));
Zachary Turner5b74ff32017-06-03 00:33:35 +0000147 EXPECT_EQ(10U, F.Allocator.getBytesAllocated());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000148}
149
150// Test that an out of bounds read which doesn't cross a block boundary
151// fails and allocates no memory.
152TEST(MappedBlockStreamTest, InvalidReadSizeNoBreak) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000153 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000154 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
155 F.Allocator);
Zachary Turner120faca2017-02-27 22:11:43 +0000156 BinaryStreamReader R(*S);
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000157 StringRef Str;
158
159 R.setOffset(10);
Zachary Turnercb30e702017-06-14 16:41:50 +0000160 EXPECT_THAT_ERROR(R.readFixedString(Str, 1), Failed());
Zachary Turner5b74ff32017-06-03 00:33:35 +0000161 EXPECT_EQ(0U, F.Allocator.getBytesAllocated());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000162}
163
164// Test that an out of bounds read which crosses a contiguous block boundary
165// fails and allocates no memory.
166TEST(MappedBlockStreamTest, InvalidReadSizeContiguousBreak) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000167 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000168 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
169 F.Allocator);
Zachary Turner120faca2017-02-27 22:11:43 +0000170 BinaryStreamReader R(*S);
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000171 StringRef Str;
172
173 R.setOffset(6);
Zachary Turnercb30e702017-06-14 16:41:50 +0000174 EXPECT_THAT_ERROR(R.readFixedString(Str, 5), Failed());
Zachary Turner5b74ff32017-06-03 00:33:35 +0000175 EXPECT_EQ(0U, F.Allocator.getBytesAllocated());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000176}
177
178// Test that an out of bounds read which crosses a discontiguous block
179// boundary fails and allocates no memory.
180TEST(MappedBlockStreamTest, InvalidReadSizeNonContiguousBreak) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000181 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000182 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
183 F.Allocator);
Zachary Turner120faca2017-02-27 22:11:43 +0000184 BinaryStreamReader R(*S);
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000185 StringRef Str;
186
Zachary Turnercb30e702017-06-14 16:41:50 +0000187 EXPECT_THAT_ERROR(R.readFixedString(Str, 11), Failed());
Zachary Turner5b74ff32017-06-03 00:33:35 +0000188 EXPECT_EQ(0U, F.Allocator.getBytesAllocated());
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000189}
190
David Majnemerb6aa8752016-06-01 18:13:06 +0000191// Tests that a read which is entirely contained within a single block but
192// beyond the end of a StreamRef fails.
193TEST(MappedBlockStreamTest, ZeroCopyReadNoBreak) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000194 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000195 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
196 F.Allocator);
Zachary Turner120faca2017-02-27 22:11:43 +0000197 BinaryStreamReader R(*S);
David Majnemerb6aa8752016-06-01 18:13:06 +0000198 StringRef Str;
Zachary Turnercb30e702017-06-14 16:41:50 +0000199 EXPECT_THAT_ERROR(R.readFixedString(Str, 1), Succeeded());
David Majnemerb6aa8752016-06-01 18:13:06 +0000200 EXPECT_EQ(Str, StringRef("A"));
Zachary Turner5b74ff32017-06-03 00:33:35 +0000201 EXPECT_EQ(0U, F.Allocator.getBytesAllocated());
David Majnemerb6aa8752016-06-01 18:13:06 +0000202}
203
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000204// Tests that a read which is not aligned on the same boundary as a previous
205// cached request, but which is known to overlap that request, shares the
206// previous allocation.
207TEST(MappedBlockStreamTest, UnalignedOverlappingRead) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000208 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000209 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
210 F.Allocator);
Zachary Turner120faca2017-02-27 22:11:43 +0000211 BinaryStreamReader R(*S);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000212 StringRef Str1;
213 StringRef Str2;
Zachary Turnercb30e702017-06-14 16:41:50 +0000214 EXPECT_THAT_ERROR(R.readFixedString(Str1, 7), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000215 EXPECT_EQ(Str1, StringRef("ABCDEFG"));
Zachary Turner5b74ff32017-06-03 00:33:35 +0000216 EXPECT_EQ(7U, F.Allocator.getBytesAllocated());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000217
218 R.setOffset(2);
Zachary Turnercb30e702017-06-14 16:41:50 +0000219 EXPECT_THAT_ERROR(R.readFixedString(Str2, 3), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000220 EXPECT_EQ(Str2, StringRef("CDE"));
221 EXPECT_EQ(Str1.data() + 2, Str2.data());
Zachary Turner5b74ff32017-06-03 00:33:35 +0000222 EXPECT_EQ(7U, F.Allocator.getBytesAllocated());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000223}
224
225// Tests that a read which is not aligned on the same boundary as a previous
226// cached request, but which only partially overlaps a previous cached request,
227// still works correctly and allocates again from the shared pool.
228TEST(MappedBlockStreamTest, UnalignedOverlappingReadFail) {
Zachary Turnerd66889c2016-07-28 19:12:28 +0000229 DiscontiguousStream F(BlocksAry, DataAry);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000230 auto S = MappedBlockStream::createStream(F.block_size(), F.layout(), F,
231 F.Allocator);
Zachary Turner120faca2017-02-27 22:11:43 +0000232 BinaryStreamReader R(*S);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000233 StringRef Str1;
234 StringRef Str2;
Zachary Turnercb30e702017-06-14 16:41:50 +0000235 EXPECT_THAT_ERROR(R.readFixedString(Str1, 6), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000236 EXPECT_EQ(Str1, StringRef("ABCDEF"));
Zachary Turner5b74ff32017-06-03 00:33:35 +0000237 EXPECT_EQ(6U, F.Allocator.getBytesAllocated());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000238
239 R.setOffset(4);
Zachary Turnercb30e702017-06-14 16:41:50 +0000240 EXPECT_THAT_ERROR(R.readFixedString(Str2, 4), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000241 EXPECT_EQ(Str2, StringRef("EFGH"));
Zachary Turner5b74ff32017-06-03 00:33:35 +0000242 EXPECT_EQ(10U, F.Allocator.getBytesAllocated());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000243}
244
245TEST(MappedBlockStreamTest, WriteBeyondEndOfStream) {
246 static uint8_t Data[] = {'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J'};
247 static uint8_t LargeBuffer[] = {'0', '1', '2', '3', '4', '5',
248 '6', '7', '8', '9', 'A'};
249 static uint8_t SmallBuffer[] = {'0', '1', '2'};
250 static_assert(sizeof(LargeBuffer) > sizeof(Data),
251 "LargeBuffer is not big enough");
252
Zachary Turnerd66889c2016-07-28 19:12:28 +0000253 DiscontiguousStream F(BlocksAry, Data);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000254 auto S = WritableMappedBlockStream::createStream(F.block_size(), F.layout(),
255 F, F.Allocator);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000256 ArrayRef<uint8_t> Buffer;
257
Zachary Turnercb30e702017-06-14 16:41:50 +0000258 EXPECT_THAT_ERROR(S->writeBytes(0, ArrayRef<uint8_t>(LargeBuffer)), Failed());
259 EXPECT_THAT_ERROR(S->writeBytes(0, ArrayRef<uint8_t>(SmallBuffer)),
260 Succeeded());
261 EXPECT_THAT_ERROR(S->writeBytes(7, ArrayRef<uint8_t>(SmallBuffer)),
262 Succeeded());
263 EXPECT_THAT_ERROR(S->writeBytes(8, ArrayRef<uint8_t>(SmallBuffer)), Failed());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000264}
265
266TEST(MappedBlockStreamTest, TestWriteBytesNoBreakBoundary) {
267 static uint8_t Data[] = {'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J'};
Zachary Turnerd66889c2016-07-28 19:12:28 +0000268 DiscontiguousStream F(BlocksAry, Data);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000269 auto S = WritableMappedBlockStream::createStream(F.block_size(), F.layout(),
270 F, F.Allocator);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000271 ArrayRef<uint8_t> Buffer;
272
Zachary Turnercb30e702017-06-14 16:41:50 +0000273 EXPECT_THAT_ERROR(S->readBytes(0, 1, Buffer), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000274 EXPECT_EQ(Buffer, ArrayRef<uint8_t>('A'));
Zachary Turnercb30e702017-06-14 16:41:50 +0000275 EXPECT_THAT_ERROR(S->readBytes(9, 1, Buffer), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000276 EXPECT_EQ(Buffer, ArrayRef<uint8_t>('J'));
277
Zachary Turnercb30e702017-06-14 16:41:50 +0000278 EXPECT_THAT_ERROR(S->writeBytes(0, ArrayRef<uint8_t>('J')), Succeeded());
279 EXPECT_THAT_ERROR(S->writeBytes(9, ArrayRef<uint8_t>('A')), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000280
Zachary Turnercb30e702017-06-14 16:41:50 +0000281 EXPECT_THAT_ERROR(S->readBytes(0, 1, Buffer), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000282 EXPECT_EQ(Buffer, ArrayRef<uint8_t>('J'));
Zachary Turnercb30e702017-06-14 16:41:50 +0000283 EXPECT_THAT_ERROR(S->readBytes(9, 1, Buffer), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000284 EXPECT_EQ(Buffer, ArrayRef<uint8_t>('A'));
285
Zachary Turnercb30e702017-06-14 16:41:50 +0000286 EXPECT_THAT_ERROR(S->writeBytes(0, ArrayRef<uint8_t>('A')), Succeeded());
287 EXPECT_THAT_ERROR(S->writeBytes(9, ArrayRef<uint8_t>('J')), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000288
Zachary Turnercb30e702017-06-14 16:41:50 +0000289 EXPECT_THAT_ERROR(S->readBytes(0, 1, Buffer), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000290 EXPECT_EQ(Buffer, ArrayRef<uint8_t>('A'));
Zachary Turnercb30e702017-06-14 16:41:50 +0000291 EXPECT_THAT_ERROR(S->readBytes(9, 1, Buffer), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000292 EXPECT_EQ(Buffer, ArrayRef<uint8_t>('J'));
293}
294
295TEST(MappedBlockStreamTest, TestWriteBytesBreakBoundary) {
296 static uint8_t Data[] = {'0', '0', '0', '0', '0', '0', '0', '0', '0', '0'};
297 static uint8_t TestData[] = {'T', 'E', 'S', 'T', 'I', 'N', 'G', '.'};
298 static uint8_t Expected[] = {'T', 'E', 'S', 'N', 'I',
299 'T', 'G', '.', '0', '0'};
300
Zachary Turnerd66889c2016-07-28 19:12:28 +0000301 DiscontiguousStream F(BlocksAry, Data);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000302 auto S = WritableMappedBlockStream::createStream(F.block_size(), F.layout(),
303 F, F.Allocator);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000304 ArrayRef<uint8_t> Buffer;
305
Zachary Turnercb30e702017-06-14 16:41:50 +0000306 EXPECT_THAT_ERROR(S->writeBytes(0, TestData), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000307 // First just compare the memory, then compare the result of reading the
308 // string out.
309 EXPECT_EQ(ArrayRef<uint8_t>(Data), ArrayRef<uint8_t>(Expected));
310
Zachary Turnercb30e702017-06-14 16:41:50 +0000311 EXPECT_THAT_ERROR(S->readBytes(0, 8, Buffer), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000312 EXPECT_EQ(Buffer, ArrayRef<uint8_t>(TestData));
313}
314
315TEST(MappedBlockStreamTest, TestWriteThenRead) {
316 std::vector<uint8_t> DataBytes(10);
317 MutableArrayRef<uint8_t> Data(DataBytes);
318 const uint32_t Blocks[] = {2, 1, 0, 6, 3, 4, 5, 7, 9, 8};
319
Zachary Turnerd66889c2016-07-28 19:12:28 +0000320 DiscontiguousStream F(Blocks, Data);
Zachary Turner5b74ff32017-06-03 00:33:35 +0000321 auto S = WritableMappedBlockStream::createStream(F.block_size(), F.layout(),
322 F, F.Allocator);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000323
324 enum class MyEnum : uint32_t { Val1 = 2908234, Val2 = 120891234 };
Zachary Turner97609bb2016-06-10 21:47:26 +0000325 using support::ulittle32_t;
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000326
327 uint16_t u16[] = {31468, 0};
328 uint32_t u32[] = {890723408, 0};
329 MyEnum Enum[] = {MyEnum::Val1, MyEnum::Val2};
330 StringRef ZStr[] = {"Zero Str", ""};
331 StringRef FStr[] = {"Fixed Str", ""};
NAKAMURA Takumif1b183c2016-06-11 06:37:28 +0000332 uint8_t byteArray0[] = {'1', '2'};
333 uint8_t byteArray1[] = {'0', '0'};
Zachary Turner352cfe42016-07-08 16:57:14 +0000334 ArrayRef<uint8_t> byteArrayRef0(byteArray0);
335 ArrayRef<uint8_t> byteArrayRef1(byteArray1);
Zachary Turner018338e2017-08-02 22:26:09 +0000336 ArrayRef<uint8_t> byteArray[] = {byteArrayRef0, byteArrayRef1};
Reid Kleckner84149c42016-07-28 18:17:01 +0000337 uint32_t intArr0[] = {890723408, 29082234};
338 uint32_t intArr1[] = {890723408, 29082234};
339 ArrayRef<uint32_t> intArray[] = {intArr0, intArr1};
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000340
Zachary Turner120faca2017-02-27 22:11:43 +0000341 BinaryStreamReader Reader(*S);
342 BinaryStreamWriter Writer(*S);
Zachary Turnercb30e702017-06-14 16:41:50 +0000343 EXPECT_THAT_ERROR(Writer.writeInteger(u16[0]), Succeeded());
344 EXPECT_THAT_ERROR(Reader.readInteger(u16[1]), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000345 EXPECT_EQ(u16[0], u16[1]);
Zachary Turnerd4c1efc2016-06-10 22:12:18 +0000346 EXPECT_EQ(std::vector<uint8_t>({0, 0x7A, 0xEC, 0, 0, 0, 0, 0, 0, 0}),
347 DataBytes);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000348
349 Reader.setOffset(0);
350 Writer.setOffset(0);
351 ::memset(DataBytes.data(), 0, 10);
Zachary Turnercb30e702017-06-14 16:41:50 +0000352 EXPECT_THAT_ERROR(Writer.writeInteger(u32[0]), Succeeded());
353 EXPECT_THAT_ERROR(Reader.readInteger(u32[1]), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000354 EXPECT_EQ(u32[0], u32[1]);
Zachary Turnerd4c1efc2016-06-10 22:12:18 +0000355 EXPECT_EQ(std::vector<uint8_t>({0x17, 0x5C, 0x50, 0, 0, 0, 0x35, 0, 0, 0}),
356 DataBytes);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000357
358 Reader.setOffset(0);
359 Writer.setOffset(0);
360 ::memset(DataBytes.data(), 0, 10);
Zachary Turnercb30e702017-06-14 16:41:50 +0000361 EXPECT_THAT_ERROR(Writer.writeEnum(Enum[0]), Succeeded());
362 EXPECT_THAT_ERROR(Reader.readEnum(Enum[1]), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000363 EXPECT_EQ(Enum[0], Enum[1]);
Zachary Turnerd4c1efc2016-06-10 22:12:18 +0000364 EXPECT_EQ(std::vector<uint8_t>({0x2C, 0x60, 0x4A, 0, 0, 0, 0, 0, 0, 0}),
365 DataBytes);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000366
367 Reader.setOffset(0);
368 Writer.setOffset(0);
369 ::memset(DataBytes.data(), 0, 10);
Zachary Turnercb30e702017-06-14 16:41:50 +0000370 EXPECT_THAT_ERROR(Writer.writeCString(ZStr[0]), Succeeded());
371 EXPECT_THAT_ERROR(Reader.readCString(ZStr[1]), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000372 EXPECT_EQ(ZStr[0], ZStr[1]);
Zachary Turnerd4c1efc2016-06-10 22:12:18 +0000373 EXPECT_EQ(
374 std::vector<uint8_t>({'r', 'e', 'Z', ' ', 'S', 't', 'o', 'r', 0, 0}),
375 DataBytes);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000376
377 Reader.setOffset(0);
378 Writer.setOffset(0);
379 ::memset(DataBytes.data(), 0, 10);
Zachary Turnercb30e702017-06-14 16:41:50 +0000380 EXPECT_THAT_ERROR(Writer.writeFixedString(FStr[0]), Succeeded());
381 EXPECT_THAT_ERROR(Reader.readFixedString(FStr[1], FStr[0].size()),
382 Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000383 EXPECT_EQ(FStr[0], FStr[1]);
Zachary Turnerd4c1efc2016-06-10 22:12:18 +0000384 EXPECT_EQ(
385 std::vector<uint8_t>({'x', 'i', 'F', 'd', ' ', 'S', 'e', 't', 0, 'r'}),
386 DataBytes);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000387
388 Reader.setOffset(0);
389 Writer.setOffset(0);
390 ::memset(DataBytes.data(), 0, 10);
Zachary Turnercb30e702017-06-14 16:41:50 +0000391 EXPECT_THAT_ERROR(Writer.writeArray(byteArray[0]), Succeeded());
392 EXPECT_THAT_ERROR(Reader.readArray(byteArray[1], byteArray[0].size()),
393 Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000394 EXPECT_EQ(byteArray[0], byteArray[1]);
Zachary Turnerd4c1efc2016-06-10 22:12:18 +0000395 EXPECT_EQ(std::vector<uint8_t>({0, 0x32, 0x31, 0, 0, 0, 0, 0, 0, 0}),
396 DataBytes);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000397
398 Reader.setOffset(0);
399 Writer.setOffset(0);
400 ::memset(DataBytes.data(), 0, 10);
Zachary Turnercb30e702017-06-14 16:41:50 +0000401 EXPECT_THAT_ERROR(Writer.writeArray(intArray[0]), Succeeded());
402 EXPECT_THAT_ERROR(Reader.readArray(intArray[1], intArray[0].size()),
403 Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000404 EXPECT_EQ(intArray[0], intArray[1]);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000405}
406
407TEST(MappedBlockStreamTest, TestWriteContiguousStreamRef) {
408 std::vector<uint8_t> DestDataBytes(10);
409 MutableArrayRef<uint8_t> DestData(DestDataBytes);
410 const uint32_t DestBlocks[] = {2, 1, 0, 6, 3, 4, 5, 7, 9, 8};
411
412 std::vector<uint8_t> SrcDataBytes(10);
413 MutableArrayRef<uint8_t> SrcData(SrcDataBytes);
414
Zachary Turnerd66889c2016-07-28 19:12:28 +0000415 DiscontiguousStream F(DestBlocks, DestData);
416 auto DestStream = WritableMappedBlockStream::createStream(
Zachary Turner5b74ff32017-06-03 00:33:35 +0000417 F.block_size(), F.layout(), F, F.Allocator);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000418
419 // First write "Test Str" into the source stream.
Zachary Turner695ed562017-02-28 00:04:07 +0000420 MutableBinaryByteStream SourceStream(SrcData, little);
Zachary Turner120faca2017-02-27 22:11:43 +0000421 BinaryStreamWriter SourceWriter(SourceStream);
Zachary Turnercb30e702017-06-14 16:41:50 +0000422 EXPECT_THAT_ERROR(SourceWriter.writeCString("Test Str"), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000423 EXPECT_EQ(SrcDataBytes, std::vector<uint8_t>(
424 {'T', 'e', 's', 't', ' ', 'S', 't', 'r', 0, 0}));
425
426 // Then write the source stream into the dest stream.
Zachary Turner120faca2017-02-27 22:11:43 +0000427 BinaryStreamWriter DestWriter(*DestStream);
Zachary Turnercb30e702017-06-14 16:41:50 +0000428 EXPECT_THAT_ERROR(DestWriter.writeStreamRef(SourceStream), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000429 EXPECT_EQ(DestDataBytes, std::vector<uint8_t>(
430 {'s', 'e', 'T', ' ', 'S', 't', 't', 'r', 0, 0}));
431
432 // Then read the string back out of the dest stream.
433 StringRef Result;
Zachary Turner120faca2017-02-27 22:11:43 +0000434 BinaryStreamReader DestReader(*DestStream);
Zachary Turnercb30e702017-06-14 16:41:50 +0000435 EXPECT_THAT_ERROR(DestReader.readCString(Result), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000436 EXPECT_EQ(Result, "Test Str");
437}
438
439TEST(MappedBlockStreamTest, TestWriteDiscontiguousStreamRef) {
440 std::vector<uint8_t> DestDataBytes(10);
441 MutableArrayRef<uint8_t> DestData(DestDataBytes);
442 const uint32_t DestBlocks[] = {2, 1, 0, 6, 3, 4, 5, 7, 9, 8};
443
444 std::vector<uint8_t> SrcDataBytes(10);
445 MutableArrayRef<uint8_t> SrcData(SrcDataBytes);
446 const uint32_t SrcBlocks[] = {1, 0, 6, 3, 4, 5, 2, 7, 8, 9};
447
Zachary Turnerd66889c2016-07-28 19:12:28 +0000448 DiscontiguousStream DestF(DestBlocks, DestData);
449 DiscontiguousStream SrcF(SrcBlocks, SrcData);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000450
Zachary Turnerd66889c2016-07-28 19:12:28 +0000451 auto Dest = WritableMappedBlockStream::createStream(
Zachary Turner5b74ff32017-06-03 00:33:35 +0000452 DestF.block_size(), DestF.layout(), DestF, DestF.Allocator);
Zachary Turnerd66889c2016-07-28 19:12:28 +0000453 auto Src = WritableMappedBlockStream::createStream(
Zachary Turner5b74ff32017-06-03 00:33:35 +0000454 SrcF.block_size(), SrcF.layout(), SrcF, SrcF.Allocator);
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000455
456 // First write "Test Str" into the source stream.
Zachary Turner120faca2017-02-27 22:11:43 +0000457 BinaryStreamWriter SourceWriter(*Src);
Zachary Turnercb30e702017-06-14 16:41:50 +0000458 EXPECT_THAT_ERROR(SourceWriter.writeCString("Test Str"), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000459 EXPECT_EQ(SrcDataBytes, std::vector<uint8_t>(
460 {'e', 'T', 't', 't', ' ', 'S', 's', 'r', 0, 0}));
461
462 // Then write the source stream into the dest stream.
Zachary Turner120faca2017-02-27 22:11:43 +0000463 BinaryStreamWriter DestWriter(*Dest);
Zachary Turnercb30e702017-06-14 16:41:50 +0000464 EXPECT_THAT_ERROR(DestWriter.writeStreamRef(*Src), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000465 EXPECT_EQ(DestDataBytes, std::vector<uint8_t>(
466 {'s', 'e', 'T', ' ', 'S', 't', 't', 'r', 0, 0}));
467
468 // Then read the string back out of the dest stream.
469 StringRef Result;
Zachary Turner120faca2017-02-27 22:11:43 +0000470 BinaryStreamReader DestReader(*Dest);
Zachary Turnercb30e702017-06-14 16:41:50 +0000471 EXPECT_THAT_ERROR(DestReader.readCString(Result), Succeeded());
Zachary Turner5acb4ac2016-06-10 05:09:12 +0000472 EXPECT_EQ(Result, "Test Str");
473}
474
Zachary Turner5b74ff32017-06-03 00:33:35 +0000475TEST(MappedBlockStreamTest, DataLivesAfterStreamDestruction) {
476 std::vector<uint8_t> DataBytes(10);
477 MutableArrayRef<uint8_t> Data(DataBytes);
478 const uint32_t Blocks[] = {2, 1, 0, 6, 3, 4, 5, 7, 9, 8};
479
480 StringRef Str[] = {"Zero Str", ""};
481
482 DiscontiguousStream F(Blocks, Data);
483 {
484 auto S = WritableMappedBlockStream::createStream(F.block_size(), F.layout(),
485 F, F.Allocator);
486
487 BinaryStreamReader Reader(*S);
488 BinaryStreamWriter Writer(*S);
489 ::memset(DataBytes.data(), 0, 10);
Zachary Turnercb30e702017-06-14 16:41:50 +0000490 EXPECT_THAT_ERROR(Writer.writeCString(Str[0]), Succeeded());
491 EXPECT_THAT_ERROR(Reader.readCString(Str[1]), Succeeded());
Zachary Turner5b74ff32017-06-03 00:33:35 +0000492 EXPECT_EQ(Str[0], Str[1]);
493 }
494
495 EXPECT_EQ(Str[0], Str[1]);
496}
497
Zachary Turner90b8b8d2016-05-31 22:41:52 +0000498} // end anonymous namespace