1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/reporting/resources/resource_manager.h"
#include <cstdint>
#include <utility>
#include "base/functional/bind.h"
#include "base/memory/scoped_refptr.h"
#include "base/sequence_checker.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/thread_pool.h"
#include "base/test/task_environment.h"
#include "base/time/time.h"
#include "components/reporting/util/test_support_callbacks.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::Eq;
namespace reporting {
namespace {
class ResourceInterfaceTest : public ::testing::TestWithParam<uint64_t> {
protected:
void SetUp() override {
resource_ = base::MakeRefCounted<ResourceManager>(GetParam());
// Make sure parameters define reasonably large total resource size.
ASSERT_GE(resource_->GetTotal(), 1u * 1024LLu * 1024LLu);
}
void TearDown() override { EXPECT_THAT(resource_->GetUsed(), Eq(0u)); }
base::test::TaskEnvironment task_environment_{
base::test::TaskEnvironment::TimeSource::MOCK_TIME};
scoped_refptr<ResourceManager> resource_;
};
TEST_P(ResourceInterfaceTest, NestedReservationTest) {
uint64_t size = resource_->GetTotal();
while ((size / 2) > 0u) {
size /= 2;
EXPECT_TRUE(resource_->Reserve(size));
}
for (; size < resource_->GetTotal(); size *= 2) {
resource_->Discard(size);
}
}
TEST_P(ResourceInterfaceTest, SimultaneousReservationTest) {
uint64_t size = resource_->GetTotal();
// Schedule reservations.
test::TestCallbackWaiter reserve_waiter;
while ((size / 2) > 0u) {
size /= 2;
reserve_waiter.Attach();
base::ThreadPool::PostTask(
FROM_HERE, {base::TaskPriority::BEST_EFFORT},
base::BindOnce(
[](size_t size, scoped_refptr<ResourceManager> resource_manager,
test::TestCallbackWaiter* waiter) {
EXPECT_TRUE(resource_manager->Reserve(size));
waiter->Signal();
},
size, resource_, &reserve_waiter));
}
reserve_waiter.Wait();
// Schedule discards.
test::TestCallbackWaiter discard_waiter;
for (; size < resource_->GetTotal(); size *= 2) {
discard_waiter.Attach();
base::ThreadPool::PostTask(
FROM_HERE, {base::TaskPriority::BEST_EFFORT},
base::BindOnce(
[](size_t size, scoped_refptr<ResourceManager> resource_manager,
test::TestCallbackWaiter* waiter) {
resource_manager->Discard(size);
waiter->Signal();
},
size, resource_, &discard_waiter));
}
discard_waiter.Wait();
}
TEST_P(ResourceInterfaceTest, SimultaneousScopedReservationTest) {
uint64_t size = resource_->GetTotal();
test::TestCallbackWaiter waiter;
while ((size / 2) > 0u) {
size /= 2;
waiter.Attach();
base::ThreadPool::PostTask(
FROM_HERE, {base::TaskPriority::BEST_EFFORT},
base::BindOnce(
[](size_t size, scoped_refptr<ResourceManager> resource_manager,
test::TestCallbackWaiter* waiter) {
{ ScopedReservation(size, resource_manager); }
waiter->Signal();
},
size, resource_, &waiter));
}
waiter.Wait();
}
TEST_P(ResourceInterfaceTest, MoveScopedReservationTest) {
uint64_t size = resource_->GetTotal();
ScopedReservation scoped_reservation(size / 2, resource_);
EXPECT_TRUE(scoped_reservation.reserved());
{
ScopedReservation moved_scoped_reservation(std::move(scoped_reservation));
EXPECT_TRUE(moved_scoped_reservation.reserved());
EXPECT_FALSE(scoped_reservation.reserved());
}
EXPECT_FALSE(scoped_reservation.reserved());
}
TEST_P(ResourceInterfaceTest, ScopedReservationBasicReduction) {
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation scoped_reservation(size, resource_);
EXPECT_TRUE(scoped_reservation.reserved());
EXPECT_TRUE(scoped_reservation.Reduce(size / 2));
}
TEST_P(ResourceInterfaceTest, ScopedReservationReductionWithLargerNewSize) {
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation scoped_reservation(size, resource_);
EXPECT_TRUE(scoped_reservation.reserved());
EXPECT_FALSE(scoped_reservation.Reduce(size + 1));
}
TEST_P(ResourceInterfaceTest, ScopedReservationReductionWithNegativeNewSize) {
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation scoped_reservation(size, resource_);
EXPECT_TRUE(scoped_reservation.reserved());
EXPECT_FALSE(scoped_reservation.Reduce(-(size / 2)));
}
TEST_P(ResourceInterfaceTest, ScopedReservationRepeatingReductions) {
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation scoped_reservation(size, resource_);
EXPECT_TRUE(scoped_reservation.reserved());
for (; size >= 2; size /= 2) {
EXPECT_TRUE(scoped_reservation.Reduce(size / 2));
}
EXPECT_TRUE(scoped_reservation.Reduce(size / 2));
EXPECT_FALSE(scoped_reservation.reserved());
}
TEST_P(ResourceInterfaceTest, ScopedReservationBasicHandOver) {
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation scoped_reservation(size, resource_);
ASSERT_TRUE(scoped_reservation.reserved());
{
ScopedReservation another_reservation(size - 1, resource_);
ASSERT_TRUE(another_reservation.reserved());
EXPECT_THAT(resource_->GetUsed(), Eq(resource_->GetTotal() - 1));
EXPECT_TRUE(scoped_reservation.reserved());
EXPECT_TRUE(another_reservation.reserved());
scoped_reservation.HandOver(another_reservation);
EXPECT_THAT(resource_->GetUsed(), Eq(resource_->GetTotal() - 1));
}
// Destruction of |anoter_reservation| does not change the amount used.
EXPECT_THAT(resource_->GetUsed(), Eq(resource_->GetTotal() - 1));
}
TEST_P(ResourceInterfaceTest, ScopedReservationRepeatingHandOvers) {
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation scoped_reservation(size, resource_);
EXPECT_TRUE(scoped_reservation.reserved());
for (; size >= 2; size /= 2) {
ScopedReservation another_reservation(size / 2, resource_);
scoped_reservation.HandOver(another_reservation);
}
EXPECT_THAT(resource_->GetUsed(), Eq(resource_->GetTotal() - 1));
}
TEST_P(ResourceInterfaceTest, ScopedReservationRepeatingCopyHandOvers) {
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation scoped_reservation(size, resource_);
EXPECT_TRUE(scoped_reservation.reserved());
for (; size >= 2; size /= 2) {
ScopedReservation another_reservation(size / 2, scoped_reservation);
EXPECT_TRUE(another_reservation.reserved());
scoped_reservation.HandOver(another_reservation);
}
EXPECT_THAT(resource_->GetUsed(), Eq(resource_->GetTotal() - 1));
}
TEST_P(ResourceInterfaceTest, ScopedReservationFailureToCopyFromEmpty) {
ScopedReservation scoped_reservation;
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation another_reservation(size, scoped_reservation);
EXPECT_FALSE(scoped_reservation.reserved());
}
TEST_P(ResourceInterfaceTest, ScopedReservationRepeatingHandOversToEmpty) {
ScopedReservation scoped_reservation;
EXPECT_FALSE(scoped_reservation.reserved());
uint64_t size = resource_->GetTotal();
for (; size >= 2; size /= 2) {
ScopedReservation another_reservation(size / 2, resource_);
scoped_reservation.HandOver(another_reservation);
}
EXPECT_THAT(resource_->GetUsed(), Eq(resource_->GetTotal() - 1));
}
TEST_P(ResourceInterfaceTest, ScopedReservationEmptyHandOver) {
uint64_t size = resource_->GetTotal() / 2;
ScopedReservation scoped_reservation(size, resource_);
ASSERT_TRUE(scoped_reservation.reserved());
{
ScopedReservation another_reservation(size - 1, resource_);
ASSERT_TRUE(another_reservation.reserved());
EXPECT_THAT(resource_->GetUsed(), Eq(resource_->GetTotal() - 1));
EXPECT_TRUE(scoped_reservation.reserved());
EXPECT_TRUE(another_reservation.reserved());
another_reservation.Reduce(0);
ASSERT_FALSE(another_reservation.reserved());
scoped_reservation.HandOver(another_reservation);
EXPECT_THAT(resource_->GetUsed(), Eq(size));
}
// Destruction of |anoter_reservation| does not change the amount used.
EXPECT_THAT(resource_->GetUsed(), Eq(size));
}
TEST_P(ResourceInterfaceTest, ReservationOverMaxTest) {
EXPECT_FALSE(resource_->Reserve(resource_->GetTotal() + 1));
EXPECT_TRUE(resource_->Reserve(resource_->GetTotal()));
resource_->Discard(resource_->GetTotal());
}
// Helper class with the following behavior:
// - Once created, immediately posts `Start` action on a dedicated task runner
// - `Start` registers a callback for `size` resource
// - When Callback happens (on the same task runner), the work is done;
// `done` is called and then teh `Actor` commits suiside.
class Actor {
public:
Actor(uint64_t size,
base::OnceClosure done,
scoped_refptr<ResourceManager> resource_manager)
: size_(size),
done_(std::move(done)),
resource_manager_(resource_manager) {
DETACH_FROM_SEQUENCE(sequence_checker_);
EXPECT_TRUE(done_);
sequenced_task_runner_->PostTask(
FROM_HERE, base::BindOnce(&Actor::Start, base::Unretained(this)));
}
~Actor() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
EXPECT_FALSE(done_);
}
void Start() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Pretend that the reservation was unavailable, schedule callback when it
// becomes available.
resource_manager_->RegisterCallback(
size_,
base::BindOnce(&Actor::OnResourceRelease, base::Unretained(this)));
}
void Execute() {
auto done = std::move(done_);
resource_manager_->Discard(size_);
delete this;
// Signal after deletion, to prevent potential test flake.
std::move(done).Run();
}
void OnResourceRelease() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_); // Same task runner!
if (!resource_manager_->Reserve(size_)) {
// Still not available, reschedule callback.
resource_manager_->RegisterCallback(
size_,
base::BindOnce(&Actor::OnResourceRelease, base::Unretained(this)));
return;
}
// Reserved. Pause, then release and delete itself.
sequenced_task_runner_->PostDelayedTask(
FROM_HERE, base::BindOnce(&Actor::Execute, base::Unretained(this)),
base::Seconds(1));
}
private:
const uint64_t size_;
base::OnceClosure done_;
scoped_refptr<ResourceManager> resource_manager_;
const scoped_refptr<base::SequencedTaskRunner> sequenced_task_runner_{
base::ThreadPool::CreateSequencedTaskRunner(
{base::TaskPriority::BEST_EFFORT})};
SEQUENCE_CHECKER(sequence_checker_);
};
TEST_P(ResourceInterfaceTest, ReservationWithWaits) {
static constexpr size_t kActorsCount = 64;
// Occupy whole resource.
ASSERT_TRUE(resource_->Reserve(resource_->GetTotal()));
// Create a number of Actors reserving 1/2 of total resource.
// Only two of them could fit simultaneously, others will wait and retry
// getting the resource after being called back.
test::TestCallbackAutoWaiter waiter;
waiter.Attach(kActorsCount - 1);
for (size_t i = 0; i < kActorsCount; ++i) {
new Actor(resource_->GetTotal() / 2,
base::BindOnce(&test::TestCallbackAutoWaiter::Signal,
base::Unretained(&waiter)),
resource_);
}
// Release resource.
resource_->Discard(resource_->GetTotal());
// All waiting Actors are called back to get resource, finish work,
// and then the waiter will be signaled.
task_environment_.FastForwardUntilNoTasksRemain();
}
TEST_P(ResourceInterfaceTest, ReservationWithWaitsOnEmptyReservation) {
// Similar to the previous test, but with no reservation other than
// the Actors.
static constexpr size_t kActorsCount = 64;
// Create a number of Actors reserving 1/2 of total resource.
// Only two of them could fit simultaneously, others will wait and retry
// getting the resource after being called back.
test::TestCallbackAutoWaiter waiter;
waiter.Attach(kActorsCount - 1);
for (size_t i = 0; i < kActorsCount; ++i) {
new Actor(resource_->GetTotal() / 2,
base::BindOnce(&test::TestCallbackAutoWaiter::Signal,
base::Unretained(&waiter)),
resource_);
}
// Waiting Actors are called back to get resource, finish work,
// and then the waiter will be signaled.
task_environment_.FastForwardUntilNoTasksRemain();
}
INSTANTIATE_TEST_SUITE_P(VariousResources,
ResourceInterfaceTest,
testing::Values(16u * 1024LLu * 1024LLu,
4u * 1024LLu * 1024LLu));
} // namespace
} // namespace reporting
|