discardable_shared_memory_manager_unittest.cc 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. // Copyright 2014 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "components/discardable_memory/service/discardable_shared_memory_manager.h"
  5. #include <stddef.h>
  6. #include <stdint.h>
  7. #include <string.h>
  8. #include <memory>
  9. #include "base/memory/raw_ptr.h"
  10. #include "base/test/task_environment.h"
  11. #include "base/threading/simple_thread.h"
  12. #include "base/time/time.h"
  13. #include "testing/gtest/include/gtest/gtest.h"
  14. namespace discardable_memory {
  15. namespace {
  16. const int kInvalidUniqueID = -1;
  17. class TestDiscardableSharedMemory : public base::DiscardableSharedMemory {
  18. public:
  19. TestDiscardableSharedMemory() {}
  20. explicit TestDiscardableSharedMemory(base::UnsafeSharedMemoryRegion region)
  21. : DiscardableSharedMemory(std::move(region)) {}
  22. void SetNow(base::Time now) { now_ = now; }
  23. private:
  24. // Overriden from base::DiscardableSharedMemory:
  25. base::Time Now() const override { return now_; }
  26. base::Time now_;
  27. };
  28. class TestDiscardableSharedMemoryManager
  29. : public DiscardableSharedMemoryManager {
  30. public:
  31. TestDiscardableSharedMemoryManager()
  32. : enforce_memory_policy_pending_(false) {}
  33. void SetNow(base::Time now) { now_ = now; }
  34. void set_enforce_memory_policy_pending(bool enforce_memory_policy_pending) {
  35. enforce_memory_policy_pending_ = enforce_memory_policy_pending;
  36. }
  37. bool enforce_memory_policy_pending() const {
  38. return enforce_memory_policy_pending_;
  39. }
  40. private:
  41. // Overriden from DiscardableSharedMemoryManager:
  42. base::Time Now() const override { return now_; }
  43. void ScheduleEnforceMemoryPolicy() override {
  44. enforce_memory_policy_pending_ = true;
  45. }
  46. base::Time now_;
  47. bool enforce_memory_policy_pending_;
  48. };
  49. class DiscardableSharedMemoryManagerTest : public testing::Test {
  50. protected:
  51. // Overridden from testing::Test:
  52. void SetUp() override {
  53. manager_ = std::make_unique<TestDiscardableSharedMemoryManager>();
  54. }
  55. // DiscardableSharedMemoryManager requires a message loop.
  56. base::test::SingleThreadTaskEnvironment task_environment_;
  57. std::unique_ptr<TestDiscardableSharedMemoryManager> manager_;
  58. };
  59. TEST_F(DiscardableSharedMemoryManagerTest, AllocateForClient) {
  60. const int kDataSize = 1024;
  61. uint8_t data[kDataSize];
  62. memset(data, 0x80, kDataSize);
  63. base::UnsafeSharedMemoryRegion shared_region;
  64. manager_->AllocateLockedDiscardableSharedMemoryForClient(
  65. kInvalidUniqueID, kDataSize, 0, &shared_region);
  66. ASSERT_TRUE(shared_region.IsValid());
  67. TestDiscardableSharedMemory memory(std::move(shared_region));
  68. bool rv = memory.Map(kDataSize);
  69. ASSERT_TRUE(rv);
  70. memcpy(memory.memory(), data, kDataSize);
  71. memory.SetNow(base::Time::FromDoubleT(1));
  72. memory.Unlock(0, 0);
  73. ASSERT_EQ(base::DiscardableSharedMemory::SUCCESS, memory.Lock(0, 0));
  74. EXPECT_EQ(memcmp(data, memory.memory(), kDataSize), 0);
  75. memory.Unlock(0, 0);
  76. }
  77. TEST_F(DiscardableSharedMemoryManagerTest, Purge) {
  78. const int kDataSize = 1024;
  79. base::UnsafeSharedMemoryRegion shared_region1;
  80. manager_->AllocateLockedDiscardableSharedMemoryForClient(
  81. kInvalidUniqueID, kDataSize, 1, &shared_region1);
  82. ASSERT_TRUE(shared_region1.IsValid());
  83. TestDiscardableSharedMemory memory1(std::move(shared_region1));
  84. bool rv = memory1.Map(kDataSize);
  85. ASSERT_TRUE(rv);
  86. base::UnsafeSharedMemoryRegion shared_region2;
  87. manager_->AllocateLockedDiscardableSharedMemoryForClient(
  88. kInvalidUniqueID, kDataSize, 2, &shared_region2);
  89. ASSERT_TRUE(shared_region2.IsValid());
  90. TestDiscardableSharedMemory memory2(std::move(shared_region2));
  91. rv = memory2.Map(kDataSize);
  92. ASSERT_TRUE(rv);
  93. // Enough memory for both allocations.
  94. manager_->SetNow(base::Time::FromDoubleT(1));
  95. manager_->SetMemoryLimit(memory1.mapped_size() + memory2.mapped_size());
  96. memory1.SetNow(base::Time::FromDoubleT(2));
  97. memory1.Unlock(0, 0);
  98. memory2.SetNow(base::Time::FromDoubleT(2));
  99. memory2.Unlock(0, 0);
  100. // Manager should not have to schedule another call to EnforceMemoryPolicy().
  101. manager_->SetNow(base::Time::FromDoubleT(3));
  102. manager_->EnforceMemoryPolicy();
  103. EXPECT_FALSE(manager_->enforce_memory_policy_pending());
  104. // Memory should still be resident.
  105. EXPECT_TRUE(memory1.IsMemoryResident());
  106. EXPECT_TRUE(memory2.IsMemoryResident());
  107. auto lock_rv = memory1.Lock(0, 0);
  108. EXPECT_EQ(base::DiscardableSharedMemory::SUCCESS, lock_rv);
  109. lock_rv = memory2.Lock(0, 0);
  110. EXPECT_EQ(base::DiscardableSharedMemory::SUCCESS, lock_rv);
  111. memory1.SetNow(base::Time::FromDoubleT(4));
  112. memory1.Unlock(0, 0);
  113. memory2.SetNow(base::Time::FromDoubleT(5));
  114. memory2.Unlock(0, 0);
  115. // Just enough memory for one allocation.
  116. manager_->SetNow(base::Time::FromDoubleT(6));
  117. manager_->SetMemoryLimit(memory2.mapped_size());
  118. EXPECT_FALSE(manager_->enforce_memory_policy_pending());
  119. // LRU allocation should still be resident.
  120. EXPECT_FALSE(memory1.IsMemoryResident());
  121. EXPECT_TRUE(memory2.IsMemoryResident());
  122. lock_rv = memory1.Lock(0, 0);
  123. EXPECT_EQ(base::DiscardableSharedMemory::FAILED, lock_rv);
  124. lock_rv = memory2.Lock(0, 0);
  125. EXPECT_EQ(base::DiscardableSharedMemory::SUCCESS, lock_rv);
  126. }
  127. TEST_F(DiscardableSharedMemoryManagerTest, EnforceMemoryPolicy) {
  128. const int kDataSize = 1024;
  129. base::UnsafeSharedMemoryRegion shared_region;
  130. manager_->AllocateLockedDiscardableSharedMemoryForClient(
  131. kInvalidUniqueID, kDataSize, 0, &shared_region);
  132. ASSERT_TRUE(shared_region.IsValid());
  133. TestDiscardableSharedMemory memory(std::move(shared_region));
  134. bool rv = memory.Map(kDataSize);
  135. ASSERT_TRUE(rv);
  136. // Not enough memory for one allocation.
  137. manager_->SetNow(base::Time::FromDoubleT(1));
  138. manager_->SetMemoryLimit(memory.mapped_size() - 1);
  139. // We need to enforce memory policy as our memory usage is currently above
  140. // the limit.
  141. EXPECT_TRUE(manager_->enforce_memory_policy_pending());
  142. manager_->set_enforce_memory_policy_pending(false);
  143. manager_->SetNow(base::Time::FromDoubleT(2));
  144. manager_->EnforceMemoryPolicy();
  145. // Still need to enforce memory policy as nothing can be purged.
  146. EXPECT_TRUE(manager_->enforce_memory_policy_pending());
  147. memory.SetNow(base::Time::FromDoubleT(3));
  148. memory.Unlock(0, 0);
  149. manager_->set_enforce_memory_policy_pending(false);
  150. manager_->SetNow(base::Time::FromDoubleT(4));
  151. manager_->EnforceMemoryPolicy();
  152. // Memory policy should have successfully been enforced.
  153. EXPECT_FALSE(manager_->enforce_memory_policy_pending());
  154. EXPECT_EQ(base::DiscardableSharedMemory::FAILED, memory.Lock(0, 0));
  155. }
  156. TEST_F(DiscardableSharedMemoryManagerTest,
  157. ReduceMemoryAfterSegmentHasBeenDeleted) {
  158. const int kDataSize = 1024;
  159. base::UnsafeSharedMemoryRegion shared_region1;
  160. manager_->AllocateLockedDiscardableSharedMemoryForClient(
  161. kInvalidUniqueID, kDataSize, 1, &shared_region1);
  162. ASSERT_TRUE(shared_region1.IsValid());
  163. TestDiscardableSharedMemory memory1(std::move(shared_region1));
  164. bool rv = memory1.Map(kDataSize);
  165. ASSERT_TRUE(rv);
  166. base::UnsafeSharedMemoryRegion shared_region2;
  167. manager_->AllocateLockedDiscardableSharedMemoryForClient(
  168. kInvalidUniqueID, kDataSize, 2, &shared_region2);
  169. ASSERT_TRUE(shared_region2.IsValid());
  170. TestDiscardableSharedMemory memory2(std::move(shared_region2));
  171. rv = memory2.Map(kDataSize);
  172. ASSERT_TRUE(rv);
  173. // Unlock and delete segment 1.
  174. memory1.SetNow(base::Time::FromDoubleT(1));
  175. memory1.Unlock(0, 0);
  176. memory1.Unmap();
  177. memory1.Close();
  178. manager_->ClientDeletedDiscardableSharedMemory(1, kInvalidUniqueID);
  179. // Make sure the manager is able to reduce memory after the segment 1 was
  180. // deleted.
  181. manager_->SetNow(base::Time::FromDoubleT(2));
  182. manager_->SetMemoryLimit(0);
  183. // Unlock segment 2.
  184. memory2.SetNow(base::Time::FromDoubleT(3));
  185. memory2.Unlock(0, 0);
  186. }
  187. class DiscardableSharedMemoryManagerScheduleEnforceMemoryPolicyTest
  188. : public testing::Test {
  189. protected:
  190. // Overridden from testing::Test:
  191. void SetUp() override {
  192. manager_ = std::make_unique<DiscardableSharedMemoryManager>();
  193. }
  194. // DiscardableSharedMemoryManager requires a message loop.
  195. base::test::SingleThreadTaskEnvironment task_environment_;
  196. std::unique_ptr<DiscardableSharedMemoryManager> manager_;
  197. };
  198. class SetMemoryLimitRunner : public base::DelegateSimpleThread::Delegate {
  199. public:
  200. SetMemoryLimitRunner(DiscardableSharedMemoryManager* manager, size_t limit)
  201. : manager_(manager), limit_(limit) {}
  202. ~SetMemoryLimitRunner() override {}
  203. void Run() override { manager_->SetMemoryLimit(limit_); }
  204. private:
  205. const raw_ptr<DiscardableSharedMemoryManager> manager_;
  206. const size_t limit_;
  207. };
  208. TEST_F(DiscardableSharedMemoryManagerScheduleEnforceMemoryPolicyTest,
  209. SetMemoryLimitOnSimpleThread) {
  210. const int kDataSize = 1024;
  211. base::UnsafeSharedMemoryRegion shared_region;
  212. manager_->AllocateLockedDiscardableSharedMemoryForClient(
  213. kInvalidUniqueID, kDataSize, 0, &shared_region);
  214. ASSERT_TRUE(shared_region.IsValid());
  215. // Set the memory limit to a value that will require EnforceMemoryPolicy()
  216. // to be schedule on a thread without a message loop.
  217. SetMemoryLimitRunner runner(manager_.get(), kDataSize - 1);
  218. base::DelegateSimpleThread thread(&runner, "memory_limit_setter");
  219. thread.Start();
  220. thread.Join();
  221. }
  222. } // namespace
  223. } // namespace discardable_memory