BlockCacheTests.cpp 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178
  1. /*
  2. * Copyright (c) Contributors to the Open 3D Engine Project.
  3. * For complete copyright and license terms please see the LICENSE at the root of this distribution.
  4. *
  5. * SPDX-License-Identifier: Apache-2.0 OR MIT
  6. *
  7. */
  8. #include <AzCore/Casting/numeric_cast.h>
  9. #include <AzCore/UnitTest/TestTypes.h>
  10. #include <AzTest/AzTest.h>
  11. #include <AzCore/IO/Streamer/BlockCache.h>
  12. #include <AzCore/IO/Streamer/FileRequest.h>
  13. #include <AzCore/IO/Streamer/StreamerContext.h>
  14. #include <AzCore/Memory/Memory.h>
  15. #include <AzCore/Memory/PoolAllocator.h>
  16. #include <AzCore/std/smart_ptr/make_shared.h>
  17. #include <AzCore/std/smart_ptr/unique_ptr.h>
  18. #include <AzCore/Task/TaskExecutor.h>
  19. #include <Tests/FileIOBaseTestTypes.h>
  20. #include <Tests/Streamer/StreamStackEntryConformityTests.h>
  21. #include <Tests/Streamer/StreamStackEntryMock.h>
  22. namespace AZ::IO
  23. {
  24. class BlockCacheTestDescription :
  25. public StreamStackEntryConformityTestsDescriptor<BlockCache>
  26. {
  27. public:
  28. BlockCache CreateInstance() override
  29. {
  30. return BlockCache(5 * 1024 * 1024, 64 * 1024, AZCORE_GLOBAL_NEW_ALIGNMENT, false);
  31. }
  32. };
  33. INSTANTIATE_TYPED_TEST_SUITE_P(Streamer_BlockCacheConformityTests, StreamStackEntryConformityTests, BlockCacheTestDescription);
  34. class BlockCacheTest
  35. : public UnitTest::LeakDetectionFixture
  36. {
  37. public:
  38. void SetUp() override
  39. {
  40. m_taskExecutor = AZStd::make_unique<TaskExecutor>();
  41. TaskExecutor::SetInstance(m_taskExecutor.get());
  42. m_prevFileIO = AZ::IO::FileIOBase::GetInstance();
  43. AZ::IO::FileIOBase::SetInstance(&m_fileIO);
  44. m_path = "Test";
  45. m_context = new StreamerContext();
  46. }
  47. void TearDown() override
  48. {
  49. delete[] m_buffer;
  50. m_buffer = nullptr;
  51. m_cache = nullptr;
  52. m_mock = nullptr;
  53. delete m_context;
  54. m_context = nullptr;
  55. AZ::IO::FileIOBase::SetInstance(m_prevFileIO);
  56. TaskExecutor::SetInstance(nullptr);
  57. m_taskExecutor.reset();
  58. }
  59. void CreateTestEnvironmentImplementation(bool onlyEpilogWrites)
  60. {
  61. using ::testing::_;
  62. m_cache = AZStd::make_shared<BlockCache>(m_cacheSize, m_blockSize, AZCORE_GLOBAL_NEW_ALIGNMENT, onlyEpilogWrites);
  63. m_mock = AZStd::make_shared<StreamStackEntryMock>();
  64. m_cache->SetNext(m_mock);
  65. EXPECT_CALL(*m_mock, SetContext(_)).Times(1);
  66. m_cache->SetContext(*m_context);
  67. m_bufferSize = m_readBufferLength >> 2;
  68. m_buffer = new u32[m_bufferSize];
  69. }
  70. void RedirectReadCalls()
  71. {
  72. using ::testing::_;
  73. using ::testing::AnyNumber;
  74. using ::testing::Return;
  75. EXPECT_CALL(*m_mock, ExecuteRequests())
  76. .WillOnce(Return(true))
  77. .WillRepeatedly(Return(false));
  78. EXPECT_CALL(*m_mock, QueueRequest(_))
  79. .WillRepeatedly(Invoke(this, &BlockCacheTest::QueueReadRequest));
  80. }
  81. void QueueReadRequest(FileRequest* request)
  82. {
  83. auto data = AZStd::get_if<Requests::ReadData>(&request->GetCommand());
  84. if (data)
  85. {
  86. if (m_fakeFileFound)
  87. {
  88. u64 size = data->m_size >> 2;
  89. u32* buffer = reinterpret_cast<u32*>(data->m_output);
  90. for (u64 i = 0; i < size; ++i)
  91. {
  92. buffer[i] = aznumeric_caster(data->m_offset + (i << 2));
  93. }
  94. ReadFile(data->m_output, data->m_path, data->m_offset, data->m_size);
  95. request->SetStatus(IStreamerTypes::RequestStatus::Completed);
  96. }
  97. else
  98. {
  99. request->SetStatus(IStreamerTypes::RequestStatus::Failed);
  100. }
  101. m_context->MarkRequestAsCompleted(request);
  102. }
  103. else if (
  104. AZStd::holds_alternative<Requests::FlushData>(request->GetCommand()) ||
  105. AZStd::holds_alternative<Requests::FlushAllData>(request->GetCommand()))
  106. {
  107. request->SetStatus(IStreamerTypes::RequestStatus::Completed);
  108. m_context->MarkRequestAsCompleted(request);
  109. }
  110. else if (AZStd::holds_alternative<Requests::FileMetaDataRetrievalData>(request->GetCommand()))
  111. {
  112. auto& data2 = AZStd::get<Requests::FileMetaDataRetrievalData>(request->GetCommand());
  113. data2.m_found = m_fakeFileFound;
  114. data2.m_fileSize = m_fakeFileLength;
  115. request->SetStatus(m_fakeFileFound ? IStreamerTypes::RequestStatus::Completed : IStreamerTypes::RequestStatus::Failed);
  116. m_context->MarkRequestAsCompleted(request);
  117. }
  118. else
  119. {
  120. // While there are more commands that possible, only the above ones are supported in these tests. Add additional
  121. // commands as needed.
  122. FAIL();
  123. }
  124. }
  125. void RedirectCanceledReadCalls()
  126. {
  127. using ::testing::_;
  128. using ::testing::Return;
  129. EXPECT_CALL(*m_mock, ExecuteRequests())
  130. .WillOnce(Return(true))
  131. .WillRepeatedly(Return(false));
  132. EXPECT_CALL(*m_mock, QueueRequest(_))
  133. .WillRepeatedly(Invoke(this, &BlockCacheTest::QueueCanceledReadRequest));
  134. }
  135. void QueueCanceledReadRequest(FileRequest* request)
  136. {
  137. auto data = AZStd::get_if<Requests::ReadData>(&request->GetCommand());
  138. if (data)
  139. {
  140. ReadFile(data->m_output, data->m_path, data->m_offset, data->m_size);
  141. request->SetStatus(IStreamerTypes::RequestStatus::Canceled);
  142. m_context->MarkRequestAsCompleted(request);
  143. }
  144. else if (AZStd::holds_alternative<Requests::FileMetaDataRetrievalData>(request->GetCommand()))
  145. {
  146. auto& data2 = AZStd::get<Requests::FileMetaDataRetrievalData>(request->GetCommand());
  147. data2.m_found = true;
  148. data2.m_fileSize = m_fakeFileLength;
  149. request->SetStatus(IStreamerTypes::RequestStatus::Completed);
  150. m_context->MarkRequestAsCompleted(request);
  151. }
  152. else
  153. {
  154. FAIL();
  155. }
  156. }
  157. void VerifyReadBuffer(u32* buffer, u64 offset, u64 size)
  158. {
  159. size = size >> 2;
  160. for (u64 i = 0; i < size; ++i)
  161. {
  162. // Using assert here because in case of a problem EXPECT would
  163. // cause a large amount of log noise.
  164. ASSERT_EQ(buffer[i], offset + (i << 2));
  165. }
  166. }
  167. void VerifyReadBuffer(u64 offset, u64 size)
  168. {
  169. VerifyReadBuffer(m_buffer, offset, size);
  170. }
  171. protected:
  172. // To make testing easier, this utility mock unpacks the read requests.
  173. MOCK_METHOD4(ReadFile, bool(void*, const RequestPath&, u64, u64));
  174. void RunProcessLoop()
  175. {
  176. do
  177. {
  178. while (m_context->FinalizeCompletedRequests())
  179. {
  180. }
  181. } while (m_cache->ExecuteRequests());
  182. }
  183. void RunAndCompleteRequest(FileRequest* request, IStreamerTypes::RequestStatus expectedResult)
  184. {
  185. IStreamerTypes::RequestStatus result = IStreamerTypes::RequestStatus::Pending;
  186. request->SetCompletionCallback([&result](const FileRequest& request)
  187. {
  188. // Capture result before internal request is recycled.
  189. result = request.GetStatus();
  190. });
  191. m_cache->QueueRequest(request);
  192. RunProcessLoop();
  193. EXPECT_EQ(expectedResult, result);
  194. }
  195. void ProcessRead(void* output, const RequestPath& path, u64 offset, u64 size, IStreamerTypes::RequestStatus expectedResult)
  196. {
  197. FileRequest* request = m_context->GetNewInternalRequest();
  198. request->CreateRead(nullptr, output, size, path, offset, size);
  199. RunAndCompleteRequest(request, expectedResult);
  200. }
  201. UnitTest::TestFileIOBase m_fileIO;
  202. FileIOBase* m_prevFileIO{};
  203. StreamerContext* m_context;
  204. AZStd::shared_ptr<BlockCache> m_cache;
  205. AZStd::shared_ptr<StreamStackEntryMock> m_mock;
  206. AZStd::unique_ptr<TaskExecutor> m_taskExecutor;
  207. RequestPath m_path;
  208. u32* m_buffer{ nullptr };
  209. size_t m_bufferSize{ 0 };
  210. u64 m_cacheSize{ 5 * 1024 * 1024 };
  211. u32 m_blockSize{ 64 * 1024 };
  212. u64 m_fakeFileLength{ 5 * m_blockSize };
  213. u64 m_readBufferLength{ 10 * 1024 * 1024 };
  214. bool m_fakeFileFound{ true };
  215. };
  216. /////////////////////////////////////////////////////////////
  217. // Prolog and epilog enabled
  218. /////////////////////////////////////////////////////////////
  219. class Streamer_BlockCacheWithPrologAndEpilogTest
  220. : public BlockCacheTest
  221. {
  222. public:
  223. void CreateTestEnvironment()
  224. {
  225. CreateTestEnvironmentImplementation(false);
  226. }
  227. };
  228. // File |------------------------------------------------|
  229. // Request |------------------------------------------------|
  230. // Cache [ x ][ x ][ x ][ x ][ x ]
  231. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_EntireFileRead_FileReadInASingleRead)
  232. {
  233. using ::testing::_;
  234. CreateTestEnvironment();
  235. RedirectReadCalls();
  236. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  237. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength, IStreamerTypes::RequestStatus::Completed);
  238. VerifyReadBuffer(0, m_fakeFileLength);
  239. }
  240. // File |----------------------------------------------|
  241. // Request |----------------------------------------------|
  242. // Cache [ x ][ x ][ x ][ x ][ x ]
  243. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_EntireUnalignedFileRead_FileReadInASingleRead)
  244. {
  245. using ::testing::_;
  246. m_fakeFileLength -= 512;
  247. CreateTestEnvironment();
  248. RedirectReadCalls();
  249. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  250. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength, IStreamerTypes::RequestStatus::Completed);
  251. VerifyReadBuffer(0, m_fakeFileLength);
  252. }
  253. // File |------------------------------------------------|
  254. // Request |-------------------------------------------|
  255. // Cache [ v ][ x ][ x ][ x ][ x ]
  256. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_PrologCacheLargeRequest_FileReadInTwoReads)
  257. {
  258. using ::testing::_;
  259. CreateTestEnvironment();
  260. RedirectReadCalls();
  261. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  262. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_fakeFileLength - m_blockSize));
  263. ProcessRead(m_buffer, m_path, 256, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  264. VerifyReadBuffer(256, m_fakeFileLength - 256);
  265. }
  266. // File |------------------------------------------------|
  267. // Request |-------------------------------------------|
  268. // Cache [ x ][ x ][ x ][ x ][ v ]
  269. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_EpilogCacheLargeRequest_FileReadInTwoReads)
  270. {
  271. using ::testing::_;
  272. CreateTestEnvironment();
  273. RedirectReadCalls();
  274. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength - m_blockSize));
  275. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  276. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  277. VerifyReadBuffer(0, m_fakeFileLength - 256);
  278. }
  279. // File |----------------------------------------------|
  280. // Request |-------------------------------------------|
  281. // Cache [ x ][ x ][ x ][ x ][ v ]
  282. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_UnalignedEpilogCacheLargeRequest_FileReadInTwoReads)
  283. {
  284. using ::testing::_;
  285. m_fakeFileLength -= 512;
  286. CreateTestEnvironment();
  287. RedirectReadCalls();
  288. EXPECT_CALL(*this, ReadFile(_, _, 0, 4 * m_blockSize));
  289. EXPECT_CALL(*this, ReadFile(_, _, 4 * m_blockSize, m_fakeFileLength - 4 * m_blockSize));
  290. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  291. VerifyReadBuffer(0, m_fakeFileLength - 256);
  292. }
  293. // File |------------------------------------------------|
  294. // Request |---------------------------------------|
  295. // Cache [ v ][ x ][ x ][ x ][ v ]
  296. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_PrologAndEpilogCacheLargeRequest_FileReadInThreeReads)
  297. {
  298. using ::testing::_;
  299. CreateTestEnvironment();
  300. RedirectReadCalls();
  301. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  302. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_fakeFileLength - 2 * m_blockSize));
  303. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  304. ProcessRead(m_buffer, m_path, 256, m_fakeFileLength - 512, IStreamerTypes::RequestStatus::Completed);
  305. VerifyReadBuffer(256, m_fakeFileLength - 512);
  306. }
  307. // File |------------------------------------------------|
  308. // Request |---------|
  309. // Cache [ v ][ v ][ x ][ x ][ x ]
  310. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_PrologAndEpilogInTwoBlocks_FileReadInTwoReads)
  311. {
  312. using ::testing::_;
  313. CreateTestEnvironment();
  314. RedirectReadCalls();
  315. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  316. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_blockSize));
  317. ProcessRead(m_buffer, m_path, 256, m_blockSize, IStreamerTypes::RequestStatus::Completed);
  318. VerifyReadBuffer(256, m_blockSize);
  319. }
  320. // File |------------------------------------------------|
  321. // Request |--------|
  322. // Cache [ x ][ x ][ x ][ x ][ x ]
  323. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_ExactBlockRead_FileReadInASingleRead)
  324. {
  325. using ::testing::_;
  326. CreateTestEnvironment();
  327. RedirectReadCalls();
  328. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  329. ProcessRead(m_buffer, m_path, 0, m_blockSize, IStreamerTypes::RequestStatus::Completed);
  330. VerifyReadBuffer(0, m_blockSize);
  331. }
  332. // File |------------------------------------------------|
  333. // Request |------|
  334. // Cache [ v ][ x ][ x ][ x ][ x ]
  335. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_SmallRead_FileReadInASingleRead)
  336. {
  337. using ::testing::_;
  338. CreateTestEnvironment();
  339. RedirectReadCalls();
  340. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  341. ProcessRead(m_buffer, m_path, 0, m_blockSize - 256, IStreamerTypes::RequestStatus::Completed);
  342. VerifyReadBuffer(0, m_blockSize - 256);
  343. }
  344. // File |-----|
  345. // Request |---|
  346. // Cache [ v ][ x ][ x ][ x ][ x ]
  347. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_SmallReadUnalignedFile_FileReadInASingleRead)
  348. {
  349. using ::testing::_;
  350. m_fakeFileLength = m_blockSize - 128;
  351. CreateTestEnvironment();
  352. RedirectReadCalls();
  353. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  354. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  355. VerifyReadBuffer(0, m_fakeFileLength - 256);
  356. }
  357. // File |------------------------------------------------|
  358. // Request |---|
  359. // Cache [ v ][ x ][ x ][ x ][ x ]
  360. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_SmallReadWithOffset_FileReadInASingleRead)
  361. {
  362. using ::testing::_;
  363. CreateTestEnvironment();
  364. RedirectReadCalls();
  365. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  366. ProcessRead(m_buffer, m_path, 256, m_blockSize - 512, IStreamerTypes::RequestStatus::Completed);
  367. VerifyReadBuffer(256, m_blockSize - 512);
  368. }
  369. // File |-----|
  370. // Request |---|
  371. // Cache [ v ][ x ][ x ][ x ][ x ]
  372. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_SmallReadWithOffsetInUnaligedFile_FileReadInASingleRead)
  373. {
  374. using ::testing::_;
  375. m_fakeFileLength = m_blockSize - 128;
  376. CreateTestEnvironment();
  377. RedirectReadCalls();
  378. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  379. ProcessRead(m_buffer, m_path, 256, m_blockSize - 512, IStreamerTypes::RequestStatus::Completed);
  380. VerifyReadBuffer(256, m_blockSize - 512);
  381. }
  382. // File |-----|
  383. // Request |----|
  384. // Cache [ v ][ x ][ x ][ x ][ x ]
  385. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_SmallReadTillEndWithOffsetInUnaligedFile_FileReadInASingleRead)
  386. {
  387. using ::testing::_;
  388. m_fakeFileLength = m_blockSize - 128;
  389. CreateTestEnvironment();
  390. RedirectReadCalls();
  391. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  392. ProcessRead(m_buffer, m_path, 256, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  393. VerifyReadBuffer(256, m_fakeFileLength - 256);
  394. }
  395. // File |------------------------------------------------|
  396. // Request |---|
  397. // Cache [ x ][ v ][ x ][ x ][ x ]
  398. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_SmallReadWithOffsetIntoNextBlock_FileReadInASingleRead)
  399. {
  400. using ::testing::_;
  401. CreateTestEnvironment();
  402. RedirectReadCalls();
  403. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_blockSize));
  404. ProcessRead(m_buffer, m_path, m_blockSize + 256, m_blockSize - 512, IStreamerTypes::RequestStatus::Completed);
  405. VerifyReadBuffer(m_blockSize + 256, m_blockSize - 512);
  406. }
  407. // File |------------------------------------------------|
  408. // Request |------|
  409. // Cache [ x ][ x ][ x ][ x ][ v ]
  410. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_SmallReadWithOffsetIntoLastBlock_FileReadInASingleRead)
  411. {
  412. using ::testing::_;
  413. CreateTestEnvironment();
  414. RedirectReadCalls();
  415. EXPECT_CALL(*this, ReadFile(_, _, 4 * m_blockSize, m_blockSize));
  416. ProcessRead(m_buffer, m_path, 4 * m_blockSize + 256, m_blockSize - 256, IStreamerTypes::RequestStatus::Completed);
  417. VerifyReadBuffer(4 * m_blockSize + 256, m_blockSize - 256);
  418. }
  419. // File |----------------------------------------------|
  420. // Request0 |---------------------------------------|
  421. // Request1 |----|
  422. // Cache [ v ][ x ][ x ][ x ][ v ]
  423. // This test queues up multiple read that overlap so one in-flight cache block is used in two requests.
  424. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_MultipleReadsOverlapping_BothFilesAreCorrectlyRead)
  425. {
  426. using ::testing::_;
  427. using ::testing::Return;
  428. CreateTestEnvironment();
  429. EXPECT_CALL(*m_mock, ExecuteRequests())
  430. .WillOnce(Return(true))
  431. .WillRepeatedly(Return(false));
  432. EXPECT_CALL(*m_mock, QueueRequest(_))
  433. .WillRepeatedly(Invoke(this, &BlockCacheTest::QueueReadRequest));
  434. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  435. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_fakeFileLength - 2 * m_blockSize));
  436. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  437. constexpr size_t secondReadSize = 512;
  438. constexpr size_t buffer1Size = secondReadSize / sizeof(u32);
  439. u32 buffer1[buffer1Size];
  440. FileRequest* request0 = m_context->GetNewInternalRequest();
  441. FileRequest* request1 = m_context->GetNewInternalRequest();
  442. request0->CreateRead(nullptr, m_buffer, m_bufferSize, m_path, 256, m_fakeFileLength - 512);
  443. request1->CreateRead(nullptr, buffer1, buffer1Size, m_path, m_fakeFileLength-768, secondReadSize);
  444. bool allRequestsCompleted = true;
  445. auto completed = [&allRequestsCompleted](const FileRequest& request)
  446. {
  447. // Capture result before request is recycled.
  448. allRequestsCompleted = allRequestsCompleted && request.GetStatus() == IStreamerTypes::RequestStatus::Completed;
  449. };
  450. request0->SetCompletionCallback(completed);
  451. request1->SetCompletionCallback(completed);
  452. m_cache->QueueRequest(request0);
  453. m_cache->QueueRequest(request1);
  454. RunProcessLoop();
  455. EXPECT_TRUE(allRequestsCompleted);
  456. VerifyReadBuffer(256, m_fakeFileLength - 512);
  457. VerifyReadBuffer(buffer1, m_fakeFileLength - 768, secondReadSize);
  458. }
  459. // File |----------------------------------------------|
  460. // Request0 |---------------------------------------|
  461. // Request1 |----|
  462. // Cache [ v ][ x ][ x ][ x ][ v ]
  463. // This test queues up multiple read that overlap so one in-flight cache block is used in two requests. This
  464. // is the same as the previous version except it finishes the first request so there's no wait-request created.
  465. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_MultipleReadsOverlappingAfterComplete_BothFilesAreCorrectlyRead)
  466. {
  467. using ::testing::_;
  468. using ::testing::Return;
  469. CreateTestEnvironment();
  470. EXPECT_CALL(*m_mock, ExecuteRequests())
  471. .WillOnce(Return(true))
  472. .WillOnce(Return(false))
  473. .WillOnce(Return(true))
  474. .WillRepeatedly(Return(false));
  475. EXPECT_CALL(*m_mock, QueueRequest(_))
  476. .WillRepeatedly(Invoke(this, &BlockCacheTest::QueueReadRequest));
  477. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  478. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_fakeFileLength - 2 * m_blockSize));
  479. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  480. constexpr size_t secondReadSize = 512;
  481. constexpr size_t buffer1Size = secondReadSize / sizeof(u32);
  482. u32 buffer1[buffer1Size];
  483. FileRequest* request0 = m_context->GetNewInternalRequest();
  484. FileRequest* request1 = m_context->GetNewInternalRequest();
  485. request0->CreateRead(nullptr, m_buffer, m_bufferSize, m_path, 256, m_fakeFileLength - 512);
  486. request1->CreateRead(nullptr, buffer1, buffer1Size, m_path, m_fakeFileLength - 768, secondReadSize);
  487. bool allRequestsCompleted = true;
  488. auto completed = [&allRequestsCompleted](const FileRequest& request)
  489. {
  490. // Capture result before request is recycled.
  491. allRequestsCompleted = allRequestsCompleted && request.GetStatus() == IStreamerTypes::RequestStatus::Completed;
  492. };
  493. request0->SetCompletionCallback(completed);
  494. request1->SetCompletionCallback(completed);
  495. m_cache->QueueRequest(request0);
  496. RunProcessLoop();
  497. m_cache->QueueRequest(request1);
  498. RunProcessLoop();
  499. EXPECT_TRUE(allRequestsCompleted);
  500. VerifyReadBuffer(256, m_fakeFileLength - 512);
  501. VerifyReadBuffer(buffer1, m_fakeFileLength - 768, secondReadSize);
  502. }
  503. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_FileLengthNotFound_RequestReturnsFailure)
  504. {
  505. using ::testing::_;
  506. using ::testing::Return;
  507. CreateTestEnvironment();
  508. RedirectReadCalls();
  509. m_fakeFileFound = false;
  510. m_fakeFileLength = 0;
  511. ProcessRead(m_buffer, m_path, 0, m_blockSize, IStreamerTypes::RequestStatus::Failed);
  512. }
  513. TEST_F(Streamer_BlockCacheWithPrologAndEpilogTest, ReadFile_DelayedRequest_DelayedRequestAlsoFinishes)
  514. {
  515. using ::testing::_;
  516. using ::testing::Invoke;
  517. using ::testing::Return;
  518. static const constexpr size_t count = 4;
  519. m_cacheSize = (count - 1) * m_blockSize;
  520. CreateTestEnvironment();
  521. EXPECT_CALL(*m_mock, ExecuteRequests())
  522. .WillOnce(Return(true))
  523. .WillRepeatedly(Return(false));
  524. EXPECT_CALL(*m_mock, QueueRequest(_))
  525. .Times(count * 2) // Once for the file meta file retrieval and a second time for the read.
  526. .WillRepeatedly(Invoke(this, &BlockCacheTest::QueueReadRequest));
  527. EXPECT_CALL(*m_mock, UpdateStatus(_))
  528. .WillRepeatedly(Invoke([](StreamStackEntry::Status& status)
  529. {
  530. status.m_numAvailableSlots = 64;
  531. status.m_isIdle = false;
  532. }));
  533. EXPECT_CALL(*this, ReadFile(_, _, _, _)).Times(count);
  534. constexpr size_t scratchBufferSize = 128_kib;
  535. using ScratchBuffer = char[scratchBufferSize];
  536. ScratchBuffer buffers[count];
  537. bool allRequestsCompleted = true;
  538. auto completed = [&allRequestsCompleted](const FileRequest& request)
  539. {
  540. // Capture result before request is recycled.
  541. allRequestsCompleted = allRequestsCompleted && request.GetStatus() == IStreamerTypes::RequestStatus::Completed;
  542. };
  543. for (size_t i = 0; i < count; ++i)
  544. {
  545. StreamStackEntry::Status status;
  546. m_cache->UpdateStatus(status);
  547. EXPECT_EQ(i == (count - 1) ? 0 : (count - i - 1), status.m_numAvailableSlots);
  548. FileRequest* request = m_context->GetNewInternalRequest();
  549. request->CreateRead(nullptr, buffers[i], scratchBufferSize, m_path, (m_blockSize - 256) * i, m_blockSize - 256);
  550. request->SetCompletionCallback(completed);
  551. m_cache->QueueRequest(request);
  552. }
  553. RunProcessLoop();
  554. EXPECT_TRUE(allRequestsCompleted);
  555. }
  556. /////////////////////////////////////////////////////////////
  557. // Prolog and epilog can read, but only the epilog can write.
  558. /////////////////////////////////////////////////////////////
  559. class Streamer_BlockCacheWithOnlyEpilogTest
  560. : public BlockCacheTest
  561. {
  562. public:
  563. void CreateTestEnvironment()
  564. {
  565. CreateTestEnvironmentImplementation(true);
  566. }
  567. };
  568. // File |------------------------------------------------|
  569. // Request |------------------------------------------------|
  570. // Cache [ x ][ x ][ x ][ x ][ x ]
  571. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_EntireFileRead_FileReadInASingleRead)
  572. {
  573. using ::testing::_;
  574. CreateTestEnvironment();
  575. RedirectReadCalls();
  576. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  577. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength, IStreamerTypes::RequestStatus::Completed);
  578. VerifyReadBuffer(0, m_fakeFileLength);
  579. }
  580. // File |----------------------------------------------|
  581. // Request |----------------------------------------------|
  582. // Cache [ x ][ x ][ x ][ x ][ x ]
  583. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_EntireUnalignedFileRead_FileReadInASingleRead)
  584. {
  585. using ::testing::_;
  586. m_fakeFileLength -= 512;
  587. CreateTestEnvironment();
  588. RedirectReadCalls();
  589. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  590. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength, IStreamerTypes::RequestStatus::Completed);
  591. VerifyReadBuffer(0, m_fakeFileLength);
  592. }
  593. // File |------------------------------------------------|
  594. // Request |-------------------------------------------|
  595. // Cache [ v ][ x ][ x ][ x ][ x ]
  596. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_PrologCacheLargeRequest_FileReadInTwoReads)
  597. {
  598. using ::testing::_;
  599. CreateTestEnvironment();
  600. RedirectReadCalls();
  601. EXPECT_CALL(*this, ReadFile(_, _, 256, m_fakeFileLength - 256));
  602. ProcessRead(m_buffer, m_path, 256, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  603. VerifyReadBuffer(256, m_fakeFileLength - 256);
  604. }
  605. // File |------------------------------------------------|
  606. // Request |-------------------------------------------|
  607. // Cache [ x ][ x ][ x ][ x ][ v ]
  608. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_EpilogCacheLargeRequest_FileReadInTwoReads)
  609. {
  610. using ::testing::_;
  611. CreateTestEnvironment();
  612. RedirectReadCalls();
  613. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength - m_blockSize));
  614. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  615. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  616. VerifyReadBuffer(0, m_fakeFileLength - 256);
  617. }
  618. // File |----------------------------------------------|
  619. // Request |-------------------------------------------|
  620. // Cache [ x ][ x ][ x ][ x ][ v ]
  621. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_UnalignedEpilogCacheLargeRequest_FileReadInTwoReads)
  622. {
  623. using ::testing::_;
  624. m_fakeFileLength -= 512;
  625. CreateTestEnvironment();
  626. RedirectReadCalls();
  627. EXPECT_CALL(*this, ReadFile(_, _, 0, 4 * m_blockSize));
  628. EXPECT_CALL(*this, ReadFile(_, _, 4 * m_blockSize, m_fakeFileLength - 4 * m_blockSize));
  629. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  630. VerifyReadBuffer(0, m_fakeFileLength - 256);
  631. }
  632. // File |------------------------------------------------|
  633. // Request |---------------------------------------|
  634. // Cache [ v ][ x ][ x ][ x ][ v ]
  635. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_PrologAndEpilogCacheLargeRequest_FileReadInThreeReads)
  636. {
  637. using ::testing::_;
  638. CreateTestEnvironment();
  639. RedirectReadCalls();
  640. EXPECT_CALL(*this, ReadFile(_, _, 256, m_fakeFileLength - m_blockSize - 256));
  641. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  642. ProcessRead(m_buffer, m_path, 256, m_fakeFileLength - 512, IStreamerTypes::RequestStatus::Completed);
  643. VerifyReadBuffer(256, m_fakeFileLength - 512);
  644. }
  645. // File |------------------------------------------------|
  646. // Request |---------|
  647. // Cache [ v ][ v ][ x ][ x ][ x ]
  648. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_PrologAndEpilogInTwoBlocks_FileReadInTwoReads)
  649. {
  650. using ::testing::_;
  651. CreateTestEnvironment();
  652. RedirectReadCalls();
  653. EXPECT_CALL(*this, ReadFile(_, _, 256, m_blockSize - 256));
  654. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_blockSize));
  655. ProcessRead(m_buffer, m_path, 256, m_blockSize, IStreamerTypes::RequestStatus::Completed);
  656. VerifyReadBuffer(256, m_blockSize);
  657. }
  658. // File |------------------------------------------------|
  659. // Request |--------|
  660. // Cache [ x ][ x ][ x ][ x ][ x ]
  661. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_ExactBlockRead_FileReadInASingleRead)
  662. {
  663. using ::testing::_;
  664. CreateTestEnvironment();
  665. RedirectReadCalls();
  666. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  667. ProcessRead(m_buffer, m_path, 0, m_blockSize, IStreamerTypes::RequestStatus::Completed);
  668. VerifyReadBuffer(0, m_blockSize);
  669. }
  670. // File |------------------------------------------------|
  671. // Request |------|
  672. // Cache [ v ][ x ][ x ][ x ][ x ]
  673. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_SmallRead_FileReadInASingleRead)
  674. {
  675. using ::testing::_;
  676. CreateTestEnvironment();
  677. RedirectReadCalls();
  678. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  679. ProcessRead(m_buffer, m_path, 0, m_blockSize - 256, IStreamerTypes::RequestStatus::Completed);
  680. VerifyReadBuffer(0, m_blockSize - 256);
  681. }
  682. // File |-----|
  683. // Request |---|
  684. // Cache [ v ][ x ][ x ][ x ][ x ]
  685. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_SmallReadUnalignedFile_FileReadInASingleRead)
  686. {
  687. using ::testing::_;
  688. m_fakeFileLength = m_blockSize - 128;
  689. CreateTestEnvironment();
  690. RedirectReadCalls();
  691. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  692. ProcessRead(m_buffer, m_path, 0, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  693. VerifyReadBuffer(0, m_fakeFileLength - 256);
  694. }
  695. // File |------------------------------------------------|
  696. // Request |---|
  697. // Cache [ v ][ x ][ x ][ x ][ x ]
  698. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_SmallReadWithOffset_FileReadInASingleRead)
  699. {
  700. using ::testing::_;
  701. CreateTestEnvironment();
  702. RedirectReadCalls();
  703. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  704. ProcessRead(m_buffer, m_path, 256, m_blockSize - 512, IStreamerTypes::RequestStatus::Completed);
  705. VerifyReadBuffer(256, m_blockSize - 512);
  706. }
  707. // File |-----|
  708. // Request |---|
  709. // Cache [ v ][ x ][ x ][ x ][ x ]
  710. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_SmallReadWithOffsetInUnaligedFile_FileReadInASingleRead)
  711. {
  712. using ::testing::_;
  713. m_fakeFileLength = m_blockSize - 128;
  714. CreateTestEnvironment();
  715. RedirectReadCalls();
  716. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  717. ProcessRead(m_buffer, m_path, 256, m_blockSize - 512, IStreamerTypes::RequestStatus::Completed);
  718. VerifyReadBuffer(256, m_blockSize - 512);
  719. }
  720. // File |-----|
  721. // Request |----|
  722. // Cache [ v ][ x ][ x ][ x ][ x ]
  723. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_SmallReadTillEndWithOffsetInUnaligedFile_FileReadInASingleRead)
  724. {
  725. using ::testing::_;
  726. m_fakeFileLength = m_blockSize - 128;
  727. CreateTestEnvironment();
  728. RedirectReadCalls();
  729. EXPECT_CALL(*this, ReadFile(_, _, 0, m_fakeFileLength));
  730. ProcessRead(m_buffer, m_path, 256, m_fakeFileLength - 256, IStreamerTypes::RequestStatus::Completed);
  731. VerifyReadBuffer(256, m_fakeFileLength - 256);
  732. }
  733. // File |------------------------------------------------|
  734. // Request |---|
  735. // Cache [ x ][ v ][ x ][ x ][ x ]
  736. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_SmallReadWithOffsetIntoNextBlock_FileReadInASingleRead)
  737. {
  738. using ::testing::_;
  739. CreateTestEnvironment();
  740. RedirectReadCalls();
  741. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_blockSize));
  742. ProcessRead(m_buffer, m_path, m_blockSize + 256, m_blockSize - 512, IStreamerTypes::RequestStatus::Completed);
  743. VerifyReadBuffer(m_blockSize + 256, m_blockSize - 512);
  744. }
  745. // File |------------------------------------------------|
  746. // Request |------|
  747. // Cache [ x ][ x ][ x ][ x ][ v ]
  748. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_SmallReadWithOffsetIntoLastBlock_FileReadInASingleRead)
  749. {
  750. using ::testing::_;
  751. CreateTestEnvironment();
  752. RedirectReadCalls();
  753. EXPECT_CALL(*this, ReadFile(_, _, 4 * m_blockSize, m_blockSize));
  754. ProcessRead(m_buffer, m_path, 4 * m_blockSize + 256, m_blockSize - 256, IStreamerTypes::RequestStatus::Completed);
  755. VerifyReadBuffer(4 * m_blockSize + 256, m_blockSize - 256);
  756. }
  757. // File |----------------------------------------------|
  758. // Request0 |---------------------------------------|
  759. // Request1 |----|
  760. // Cache [ v ][ x ][ x ][ x ][ v ]
  761. // This test queues up multiple reads that overlap so one in-flight cache block is used in two requests.
  762. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_MultipleReadsOverlapping_BothFilesAreCorrectlyRead)
  763. {
  764. using ::testing::_;
  765. using ::testing::Return;
  766. CreateTestEnvironment();
  767. EXPECT_CALL(*m_mock, ExecuteRequests())
  768. .WillOnce(Return(true))
  769. .WillRepeatedly(Return(false));
  770. EXPECT_CALL(*m_mock, QueueRequest(_))
  771. .WillRepeatedly(Invoke(this, &BlockCacheTest::QueueReadRequest));
  772. EXPECT_CALL(*this, ReadFile(_, _, 256, m_fakeFileLength - m_blockSize - 256));
  773. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  774. constexpr size_t secondReadSize = 512;
  775. constexpr size_t buffer1Size = secondReadSize / sizeof(u32);
  776. u32 buffer1[buffer1Size];
  777. FileRequest* request0 = m_context->GetNewInternalRequest();
  778. FileRequest* request1 = m_context->GetNewInternalRequest();
  779. request0->CreateRead(nullptr, m_buffer, m_bufferSize, m_path, 256, m_fakeFileLength - 512);
  780. request1->CreateRead(nullptr, buffer1, buffer1Size, m_path, m_fakeFileLength - 768, secondReadSize);
  781. bool allRequestsCompleted = true;
  782. auto completed = [&allRequestsCompleted](const FileRequest& request)
  783. {
  784. // Capture result before request is recycled.
  785. allRequestsCompleted = allRequestsCompleted && request.GetStatus() == IStreamerTypes::RequestStatus::Completed;
  786. };
  787. request0->SetCompletionCallback(completed);
  788. request1->SetCompletionCallback(completed);
  789. m_cache->QueueRequest(request0);
  790. m_cache->QueueRequest(request1);
  791. RunProcessLoop();
  792. EXPECT_TRUE(allRequestsCompleted);
  793. VerifyReadBuffer(256, m_fakeFileLength - 512);
  794. VerifyReadBuffer(buffer1, m_fakeFileLength - 768, secondReadSize);
  795. }
  796. // File |----------------------------------------------|
  797. // Request0 |---------------------------------------|
  798. // Request1 |----|
  799. // Cache [ v ][ x ][ x ][ x ][ v ]
  800. // This test queues up multiple reads that overlap so one in-flight cache block is used in two requests. This
  801. // is the same as the previous version except it finishes the first request so there's no wait-request created.
  802. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_MultipleReadsOverlappingAfterComplete_BothFilesAreCorrectlyRead)
  803. {
  804. using ::testing::_;
  805. using ::testing::Return;
  806. CreateTestEnvironment();
  807. EXPECT_CALL(*m_mock, ExecuteRequests())
  808. .WillOnce(Return(true))
  809. .WillRepeatedly(Return(false));
  810. EXPECT_CALL(*m_mock, QueueRequest(_))
  811. .WillRepeatedly(Invoke(this, &BlockCacheTest::QueueReadRequest));
  812. EXPECT_CALL(*this, ReadFile(_, _, 256, m_fakeFileLength - m_blockSize - 256));
  813. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  814. constexpr size_t secondReadSize = 512;
  815. constexpr size_t buffer1Size = secondReadSize / sizeof(u32);
  816. u32 buffer1[buffer1Size];
  817. FileRequest* request0 = m_context->GetNewInternalRequest();
  818. FileRequest* request1 = m_context->GetNewInternalRequest();
  819. request0->CreateRead(nullptr, m_buffer, m_bufferSize, m_path, 256, m_fakeFileLength - 512);
  820. request1->CreateRead(nullptr, buffer1, buffer1Size, m_path, m_fakeFileLength - 768, secondReadSize);
  821. bool allRequestsCompleted = true;
  822. auto completed = [&allRequestsCompleted](const FileRequest& request)
  823. {
  824. // Capture result before request is recycled.
  825. allRequestsCompleted = allRequestsCompleted && request.GetStatus() == IStreamerTypes::RequestStatus::Completed;
  826. };
  827. request0->SetCompletionCallback(completed);
  828. request1->SetCompletionCallback(completed);
  829. m_cache->QueueRequest(request0);
  830. RunProcessLoop();
  831. m_cache->QueueRequest(request1);
  832. m_context->FinalizeCompletedRequests();
  833. RunProcessLoop();
  834. EXPECT_TRUE(allRequestsCompleted);
  835. VerifyReadBuffer(256, m_fakeFileLength - 512);
  836. VerifyReadBuffer(buffer1, m_fakeFileLength - 768, secondReadSize);
  837. }
  838. // File |----------------------------------------------|
  839. // Request0 |---------------------|
  840. // Request1 |----------------------|
  841. // Cache [ v ][ x ][ x ][ x ][ v ]
  842. // This test queues up multiple reads that overlap so one in-flight cache block is used in two requests with the second
  843. // request using prolog, main and epilog.
  844. TEST_F(Streamer_BlockCacheWithOnlyEpilogTest, ReadFile_FetchPrologFromCache_BothFilesAreCorrectlyRead)
  845. {
  846. using ::testing::_;
  847. using ::testing::Return;
  848. CreateTestEnvironment();
  849. EXPECT_CALL(*m_mock, ExecuteRequests())
  850. .WillOnce(Return(true))
  851. .WillRepeatedly(Return(false));
  852. EXPECT_CALL(*m_mock, QueueRequest(_))
  853. .WillRepeatedly(Invoke(this, &BlockCacheTest::QueueReadRequest));
  854. size_t firstReadSize = m_fakeFileLength - (2 * m_blockSize) - 512;
  855. FileRequest* request0 = m_context->GetNewInternalRequest();
  856. request0->CreateRead(nullptr, m_buffer, m_bufferSize, m_path, 256, firstReadSize);
  857. EXPECT_CALL(*this, ReadFile(_, _, 256, m_fakeFileLength - (3 * m_blockSize) - 256));
  858. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - (3 * m_blockSize), m_blockSize));
  859. size_t secondReadSize = (m_blockSize - 256) + m_blockSize + (m_blockSize - 256);
  860. size_t secondReadOffset = m_fakeFileLength - secondReadSize - 256;
  861. size_t buffer1Size = secondReadSize / sizeof(u32);
  862. auto buffer1 = AZStd::make_unique<u32[]>(buffer1Size);
  863. FileRequest* request1 = m_context->GetNewInternalRequest();
  864. request1->CreateRead(nullptr, buffer1.get(), buffer1Size, m_path, secondReadOffset, secondReadSize);
  865. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - 2 * m_blockSize, m_blockSize));
  866. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  867. bool allRequestsCompleted = true;
  868. auto completed = [&allRequestsCompleted](const FileRequest& request)
  869. {
  870. // Capture result before request is recycled.
  871. allRequestsCompleted = allRequestsCompleted && request.GetStatus() == IStreamerTypes::RequestStatus::Completed;
  872. };
  873. request0->SetCompletionCallback(completed);
  874. request1->SetCompletionCallback(completed);
  875. m_cache->QueueRequest(request0);
  876. m_cache->QueueRequest(request1);
  877. RunProcessLoop();
  878. EXPECT_TRUE(allRequestsCompleted);
  879. VerifyReadBuffer(256, firstReadSize);
  880. VerifyReadBuffer(buffer1.get(), secondReadOffset, secondReadSize);
  881. }
  882. /////////////////////////////////////////////////////////////
  883. // Generic block cache test.
  884. /////////////////////////////////////////////////////////////
  885. class Streamer_BlockCacheGenericTest
  886. : public BlockCacheTest
  887. {
  888. public:
  889. void CreateTestEnvironment()
  890. {
  891. CreateTestEnvironmentImplementation(false);
  892. }
  893. };
  894. TEST_F(Streamer_BlockCacheGenericTest, Cancel_QueueReadAndCancel_SubRequestPushCanceledThroughCache)
  895. {
  896. using ::testing::_;
  897. CreateTestEnvironment();
  898. RedirectCanceledReadCalls();
  899. EXPECT_CALL(*this, ReadFile(_, _, 0, m_blockSize));
  900. EXPECT_CALL(*this, ReadFile(_, _, m_blockSize, m_fakeFileLength - 2 * m_blockSize));
  901. EXPECT_CALL(*this, ReadFile(_, _, m_fakeFileLength - m_blockSize, m_blockSize));
  902. ProcessRead(m_buffer, m_path, 256, m_fakeFileLength - 512, IStreamerTypes::RequestStatus::Canceled);
  903. }
  904. // File |------------------------------------------------|
  905. // Request |---|
  906. // Cache [ v ][ x ][ x ][ x ][ x ]
  907. TEST_F(Streamer_BlockCacheGenericTest, Flush_FlushPreviouslyReadFile_FileIsReadAgain)
  908. {
  909. using ::testing::_;
  910. CreateTestEnvironment();
  911. RedirectReadCalls();
  912. // Initial read to seed the cache.
  913. EXPECT_CALL(*this, ReadFile(_, _, _, _)).Times(1);
  914. ProcessRead(m_buffer, m_path, 256, m_blockSize - 512, IStreamerTypes::RequestStatus::Completed);
  915. // Flush from the cache to remove the previously cached read.
  916. FileRequest* request = m_context->GetNewInternalRequest();
  917. request->CreateFlush(m_path);
  918. RunAndCompleteRequest(request, IStreamerTypes::RequestStatus::Completed);
  919. // The partial read would normally be serviced from the cache, but now triggers another read.
  920. EXPECT_CALL(*this, ReadFile(_, _, _, _)).Times(1);
  921. ProcessRead(m_buffer, m_path, 512, m_blockSize - 1024, IStreamerTypes::RequestStatus::Completed);
  922. }
  923. // File |------------------------------------------------|
  924. // Request |---|
  925. // Cache [ v ][ x ][ x ][ x ][ x ]
  926. TEST_F(Streamer_BlockCacheGenericTest, FlushAll_FlushAllPreviouslyReadFiles_FileIsReadAgain)
  927. {
  928. using ::testing::_;
  929. CreateTestEnvironment();
  930. RedirectReadCalls();
  931. // Initial read to seed the cache.
  932. EXPECT_CALL(*this, ReadFile(_, _, _, _)).Times(1);
  933. ProcessRead(m_buffer, m_path, 256, m_blockSize - 512, IStreamerTypes::RequestStatus::Completed);
  934. // Flush everything from the cache, including the previously cached read.
  935. FileRequest* request = m_context->GetNewInternalRequest();
  936. request->CreateFlushAll();
  937. RunAndCompleteRequest(request, IStreamerTypes::RequestStatus::Completed);
  938. // The partial read would normally be serviced from the cache, but now triggers another read.
  939. EXPECT_CALL(*this, ReadFile(_, _, _, _)).Times(1);
  940. ProcessRead(m_buffer, m_path, 512, m_blockSize - 1024, IStreamerTypes::RequestStatus::Completed);
  941. }
  942. } // namespace AZ::IO