Implement QuotaTemporaryStorageEvictor.

It's based on http://codereview.chromium.org/7029009/.

BUG=61676
TEST=QuotaTemporaryStorageEvictorTest.*

Review URL: http://codereview.chromium.org/7002024

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@86597 0039d316-1c4b-4281-b951-d872f2087c98

webkit/quota/quota_manager.h

@@ -38,6 +38,8 @@ class QuotaManagerProxy;
 // An interface called by QuotaTemporaryStorageEvictor.
 class QuotaEvictionHandler {
  public:
+  virtual ~QuotaEvictionHandler() {}
+
   typedef Callback1<const GURL&>::Type GetLRUOriginCallback;
   typedef Callback1<QuotaStatusCode>::Type EvictOriginDataCallback;
   typedef Callback4<QuotaStatusCode,
@@ -59,9 +61,6 @@ class QuotaEvictionHandler {
 
   virtual void GetUsageAndQuotaForEviction(
       GetUsageAndQuotaForEvictionCallback* callback) = 0;
-
- protected:
-  virtual ~QuotaEvictionHandler() {}
 };
 
 // The quota manager class.  This class is instantiated per profile and

webkit/quota/quota_temporary_storage_evictor.cc

+// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "webkit/quota/quota_temporary_storage_evictor.h"
+
+#include "base/message_loop_proxy.h"
+#include "googleurl/src/gurl.h"
+#include "webkit/quota/quota_manager.h"
+
+namespace quota {
+
+const double QuotaTemporaryStorageEvictor::kUsageRatioToStartEviction = 0.7;
+const int64 QuotaTemporaryStorageEvictor::
+    kDefaultMinAvailableDiskSpaceToStartEviction = 1000 * 1000 * 500;
+
+QuotaTemporaryStorageEvictor::QuotaTemporaryStorageEvictor(
+    QuotaEvictionHandler* quota_eviction_handler,
+    int64 interval_ms,
+    scoped_refptr<base::MessageLoopProxy> io_thread)
+    : min_available_disk_space_to_start_eviction_(
+          kDefaultMinAvailableDiskSpaceToStartEviction),
+      quota_eviction_handler_(quota_eviction_handler),
+      interval_ms_(interval_ms),
+      repeated_eviction_(false),
+      io_thread_(io_thread),
+      callback_factory_(ALLOW_THIS_IN_INITIALIZER_LIST(this)) {
+  DCHECK(quota_eviction_handler);
+}
+
+QuotaTemporaryStorageEvictor::~QuotaTemporaryStorageEvictor() {
+}
+
+void QuotaTemporaryStorageEvictor::Start() {
+  DCHECK(io_thread_->BelongsToCurrentThread());
+  StartEvictionTimerWithDelay(0);
+}
+
+void QuotaTemporaryStorageEvictor::StartEvictionTimerWithDelay(int delay_ms) {
+  if (timer_.IsRunning())
+    return;
+  timer_.Start(base::TimeDelta::FromMilliseconds(delay_ms), this,
+               &QuotaTemporaryStorageEvictor::ConsiderEviction);
+}
+
+void QuotaTemporaryStorageEvictor::ConsiderEviction() {
+  // Get usage and disk space, then continue.
+  quota_eviction_handler_->GetUsageAndQuotaForEviction(callback_factory_.
+      NewCallback(
+          &QuotaTemporaryStorageEvictor::OnGotUsageAndQuotaForEviction));
+}
+
+void QuotaTemporaryStorageEvictor::OnGotUsageAndQuotaForEviction(
+    QuotaStatusCode status,
+    int64 usage,
+    int64 quota,
+    int64 available_disk_space) {
+  DCHECK(io_thread_->BelongsToCurrentThread());
+
+  if (status == kQuotaStatusOk &&
+      (usage > quota * kUsageRatioToStartEviction ||
+       min_available_disk_space_to_start_eviction_ > available_disk_space)) {
+    // Space is getting tight. Get the least recently used origin and continue.
+    quota_eviction_handler_->GetLRUOrigin(kStorageTypeTemporary,
+        callback_factory_.NewCallback(
+            &QuotaTemporaryStorageEvictor::OnGotLRUOrigin));
+  } else if (repeated_eviction_) {
+    // No action required, sleep for a while and check again later.
+    StartEvictionTimerWithDelay(interval_ms_);
+  }
+
+  // TODO(dmikurube): Add stats on # of {error, eviction, skipped}.
+  // TODO(dmikurube): Add error handling for the case status != kQuotaStatusOk.
+}
+
+void QuotaTemporaryStorageEvictor::OnGotLRUOrigin(const GURL& origin) {
+  DCHECK(io_thread_->BelongsToCurrentThread());
+
+  if (origin.is_empty()) {
+    if (repeated_eviction_)
+      StartEvictionTimerWithDelay(interval_ms_);
+    return;
+  }
+
+  quota_eviction_handler_->EvictOriginData(origin, kStorageTypeTemporary,
+      callback_factory_.NewCallback(
+          &QuotaTemporaryStorageEvictor::OnEvictionComplete));
+}
+
+void QuotaTemporaryStorageEvictor::OnEvictionComplete(
+    QuotaStatusCode status) {
+  DCHECK(io_thread_->BelongsToCurrentThread());
+
+  // We many need to get rid of more space so reconsider immediately.
+  ConsiderEviction();
+}
+
+}  // namespace quota

webkit/quota/quota_temporary_storage_evictor.h

+// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef WEBKIT_QUOTA_QUOTA_TEMPORARY_STORAGE_EVICTOR_H_
+#define WEBKIT_QUOTA_QUOTA_TEMPORARY_STORAGE_EVICTOR_H_
+#pragma once
+
+#include "base/memory/scoped_callback_factory.h"
+#include "base/timer.h"
+#include "webkit/quota/quota_types.h"
+
+class GURL;
+
+namespace base {
+class MessageLoopProxy;
+}
+
+namespace quota {
+
+class QuotaEvictionHandler;
+
+class QuotaTemporaryStorageEvictor {
+ public:
+  QuotaTemporaryStorageEvictor(
+      QuotaEvictionHandler* quota_eviction_handler,
+      int64 interval_ms,
+      scoped_refptr<base::MessageLoopProxy> io_thread);
+  virtual ~QuotaTemporaryStorageEvictor();
+
+  void Start();
+
+  bool repeated_eviction() const { return repeated_eviction_; }
+  void set_repeated_eviction(bool repeated_eviction) {
+    repeated_eviction_ = repeated_eviction;
+  }
+
+ private:
+  friend class QuotaTemporaryStorageEvictorTest;
+
+  void StartEvictionTimerWithDelay(int delay_ms);
+  void ConsiderEviction();
+  void OnGotUsageAndQuotaForEviction(
+      QuotaStatusCode status,
+      int64 usage,
+      int64 quota,
+      int64 available_disk_space);
+  void OnGotLRUOrigin(const GURL& origin);
+  void OnEvictionComplete(QuotaStatusCode status);
+
+  static const double kUsageRatioToStartEviction;
+  static const int64 kDefaultMinAvailableDiskSpaceToStartEviction;
+
+  const int64 min_available_disk_space_to_start_eviction_;
+
+  // Not owned; quota_eviction_handler owns us.
+  QuotaEvictionHandler* quota_eviction_handler_;
+
+  int64 interval_ms_;
+  bool repeated_eviction_;
+  scoped_refptr<base::MessageLoopProxy> io_thread_;
+
+  base::OneShotTimer<QuotaTemporaryStorageEvictor> timer_;
+
+  base::ScopedCallbackFactory<QuotaTemporaryStorageEvictor> callback_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(QuotaTemporaryStorageEvictor);
+};
+
+}  // namespace quota
+
+#endif  // WEBKIT_QUOTA_QUOTA_TEMPORARY_STORAGE_EVICTOR_H_

webkit/quota/quota_temporary_storage_evictor_unittest.cc

+// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "testing/gtest/include/gtest/gtest.h"
+
+#include <list>
+#include <map>
+
+#include "base/memory/scoped_ptr.h"
+#include "base/message_loop.h"
+#include "base/message_loop_proxy.h"
+#include "base/task.h"
+#include "webkit/quota/mock_storage_client.h"
+#include "webkit/quota/quota_manager.h"
+#include "webkit/quota/quota_temporary_storage_evictor.h"
+
+namespace quota {
+
+class QuotaTemporaryStorageEvictorTest;
+
+namespace {
+
+class MockQuotaEvictionHandler : public quota::QuotaEvictionHandler {
+ public:
+  MockQuotaEvictionHandler(QuotaTemporaryStorageEvictorTest *test)
+      : quota_(0),
+        available_space_(0),
+        test_(test) {}
+
+  virtual void EvictOriginData(
+      const GURL& origin,
+      StorageType type,
+      EvictOriginDataCallback* callback) OVERRIDE {
+    int64 origin_usage = EnsureOriginRemoved(origin);
+    if (origin_usage >= 0)
+      available_space_ += origin_usage;
+    callback->Run(quota::kQuotaStatusOk);
+    delete callback;
+  }
+
+  virtual void GetUsageAndQuotaForEviction(
+      GetUsageAndQuotaForEvictionCallback* callback) OVERRIDE {
+    if (task_for_get_usage_and_quota_.get())
+      task_for_get_usage_and_quota_->Run();
+    callback->Run(quota::kQuotaStatusOk, GetUsage(), quota_, available_space_);
+    delete callback;
+  }
+
+  virtual void GetLRUOrigin(
+      StorageType type,
+      GetLRUOriginCallback* callback) OVERRIDE {
+    if (origin_order_.empty())
+      callback->Run(GURL());
+    else
+      callback->Run(origin_order_.front());
+    delete callback;
+  }
+
+  int64 GetUsage() const {
+    int64 total_usage = 0;
+    for (std::map<GURL, int64>::const_iterator p = origins_.begin();
+         p != origins_.end();
+         ++p)
+      total_usage += p->second;
+    return total_usage;
+  }
+
+  void set_quota(int64 quota) {
+    quota_ = quota;
+  }
+  void set_available_space(int64 available_space) {
+    available_space_ = available_space;
+  }
+  void set_task_for_get_usage_and_quota(CancelableTask* task) {
+    task_for_get_usage_and_quota_.reset(task);
+  }
+
+  // Simulates an access to |origin|.  It reorders the internal LRU list.
+  // It internally uses AddOrigin().
+  void AccessOrigin(const GURL& origin) {
+    std::map<GURL, int64>::iterator found = origins_.find(origin);
+    EXPECT_TRUE(origins_.end() != found);
+    AddOrigin(origin, found->second);
+  }
+
+  // Simulates adding or overwriting the |origin| to the internal origin set
+  // with the |usage|.  It also adds or moves the |origin| to the end of the
+  // LRU list.
+  void AddOrigin(const GURL& origin, int64 usage) {
+    EnsureOriginRemoved(origin);
+    origin_order_.push_back(origin);
+    origins_[origin] = usage;
+  }
+
+ private:
+  int64 EnsureOriginRemoved(const GURL& origin) {
+    int64 origin_usage;
+    if (origins_.find(origin) == origins_.end())
+      return -1;
+    else
+      origin_usage = origins_[origin];
+
+    origins_.erase(origin);
+    origin_order_.remove(origin);
+    return origin_usage;
+  }
+
+  int64 quota_;
+  int64 available_space_;
+  std::list<GURL> origin_order_;
+  std::map<GURL, int64> origins_;
+
+  QuotaTemporaryStorageEvictorTest *test_;
+  scoped_ptr<CancelableTask> task_for_get_usage_and_quota_;
+};
+
+}  // anonymous namespace
+
+class QuotaTemporaryStorageEvictorTest : public testing::Test {
+ public:
+  QuotaTemporaryStorageEvictorTest()
+      : num_get_usage_and_quota_for_eviction_(0),
+        runnable_factory_(ALLOW_THIS_IN_INITIALIZER_LIST(this)) {}
+
+  void SetUp() {
+    quota_eviction_handler_.reset(new MockQuotaEvictionHandler(this));
+
+    // Run multiple evictions in a single RunAllPending() when interval_ms == 0
+    temporary_storage_evictor_.reset(new QuotaTemporaryStorageEvictor(
+        quota_eviction_handler_.get(),
+        0, base::MessageLoopProxy::CreateForCurrentThread()));
+  }
+
+  void TearDown() {
+    temporary_storage_evictor_.reset();
+    quota_eviction_handler_.reset();
+    MessageLoop::current()->RunAllPending();
+  }
+
+  void TaskForRepeatedEvictionTest(
+      const std::pair<GURL, int64>& origin_to_be_added,
+      const GURL& origin_to_be_accessed,
+      int expected_usage_after_first,
+      int expected_usage_after_second) {
+    switch (num_get_usage_and_quota_for_eviction_) {
+    case 1:
+      EXPECT_EQ(expected_usage_after_first,
+                quota_eviction_handler()->GetUsage());
+      quota_eviction_handler()->AddOrigin(origin_to_be_added.first,
+                                          origin_to_be_added.second);
+      if (!origin_to_be_accessed.is_empty())
+        quota_eviction_handler()->AccessOrigin(origin_to_be_accessed);
+      break;
+    case 2:
+      EXPECT_EQ(expected_usage_after_second,
+                quota_eviction_handler()->GetUsage());
+      temporary_storage_evictor()->set_repeated_eviction(false);
+      break;
+    }
+    ++num_get_usage_and_quota_for_eviction_;
+  }
+
+ protected:
+  MockQuotaEvictionHandler* quota_eviction_handler() const {
+    return static_cast<MockQuotaEvictionHandler*>(
+        quota_eviction_handler_.get());
+  }
+
+  QuotaTemporaryStorageEvictor* temporary_storage_evictor() const {
+    return temporary_storage_evictor_.get();
+  }
+
+  int num_get_usage_and_quota_for_eviction() const {
+    return num_get_usage_and_quota_for_eviction_;
+  }
+
+  int64 default_min_available_disk_space_to_start_eviction() const {
+    return QuotaTemporaryStorageEvictor::
+        kDefaultMinAvailableDiskSpaceToStartEviction;
+  }
+
+  scoped_ptr<QuotaEvictionHandler> quota_eviction_handler_;
+  scoped_ptr<QuotaTemporaryStorageEvictor> temporary_storage_evictor_;
+
+  int num_get_usage_and_quota_for_eviction_;
+
+  ScopedRunnableMethodFactory<QuotaTemporaryStorageEvictorTest>
+      runnable_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(QuotaTemporaryStorageEvictorTest);
+};
+
+TEST_F(QuotaTemporaryStorageEvictorTest, SimpleEvictionTest) {
+  quota_eviction_handler()->AddOrigin(GURL("http://www.z.com"), 3000);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.y.com"), 200);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.x.com"), 500);
+  quota_eviction_handler()->set_quota(4000);
+  quota_eviction_handler()->set_available_space(1000000000);
+  EXPECT_EQ(3000 + 200 + 500, quota_eviction_handler()->GetUsage());
+  temporary_storage_evictor()->Start();
+  MessageLoop::current()->RunAllPending();
+  EXPECT_EQ(200 + 500, quota_eviction_handler()->GetUsage());
+}
+
+TEST_F(QuotaTemporaryStorageEvictorTest, MultipleEvictionTest) {
+  quota_eviction_handler()->AddOrigin(GURL("http://www.z.com"), 20);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.y.com"), 2900);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.x.com"), 450);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.w.com"), 400);
+  quota_eviction_handler()->set_quota(4000);
+  quota_eviction_handler()->set_available_space(1000000000);
+  EXPECT_EQ(20 + 2900 + 450 + 400, quota_eviction_handler()->GetUsage());
+  temporary_storage_evictor()->Start();
+  MessageLoop::current()->RunAllPending();
+  EXPECT_EQ(450 + 400, quota_eviction_handler()->GetUsage());
+}
+
+TEST_F(QuotaTemporaryStorageEvictorTest, RepeatedEvictionTest) {
+  const int64 a_size = 400;
+  const int64 b_size = 150;
+  const int64 c_size = 120;
+  const int64 d_size = 292;
+  const int64 initial_total_size = a_size + b_size + c_size + d_size;
+  const int64 e_size = 275;
+
+  quota_eviction_handler()->AddOrigin(GURL("http://www.d.com"), d_size);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.c.com"), c_size);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.b.com"), b_size);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.a.com"), a_size);
+  quota_eviction_handler()->set_quota(1000);
+  quota_eviction_handler()->set_available_space(1000000000);
+  quota_eviction_handler()->set_task_for_get_usage_and_quota(
+      runnable_factory_.NewRunnableMethod(
+          &QuotaTemporaryStorageEvictorTest::TaskForRepeatedEvictionTest,
+          std::make_pair(GURL("http://www.e.com"), e_size),
+          GURL(),
+          initial_total_size - d_size,
+          initial_total_size - d_size + e_size - c_size));
+  EXPECT_EQ(initial_total_size, quota_eviction_handler()->GetUsage());
+  temporary_storage_evictor()->set_repeated_eviction(true);
+  temporary_storage_evictor()->Start();
+  MessageLoop::current()->RunAllPending();
+  EXPECT_EQ(initial_total_size - d_size + e_size - c_size - b_size,
+            quota_eviction_handler()->GetUsage());
+  EXPECT_EQ(4, num_get_usage_and_quota_for_eviction());
+}
+
+TEST_F(QuotaTemporaryStorageEvictorTest, RepeatedEvictionWithAccessOriginTest) {
+  const int64 a_size = 400;
+  const int64 b_size = 150;
+  const int64 c_size = 120;
+  const int64 d_size = 292;
+  const int64 initial_total_size = a_size + b_size + c_size + d_size;
+  const int64 e_size = 275;
+
+  quota_eviction_handler()->AddOrigin(GURL("http://www.d.com"), d_size);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.c.com"), c_size);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.b.com"), b_size);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.a.com"), a_size);
+  quota_eviction_handler()->set_quota(1000);
+  quota_eviction_handler()->set_available_space(1000000000);
+  quota_eviction_handler()->set_task_for_get_usage_and_quota(
+      runnable_factory_.NewRunnableMethod(
+          &QuotaTemporaryStorageEvictorTest::TaskForRepeatedEvictionTest,
+          std::make_pair(GURL("http://www.e.com"), e_size),
+          GURL("http://www.c.com"),
+          initial_total_size - d_size,
+          initial_total_size - d_size + e_size - b_size));
+  EXPECT_EQ(initial_total_size, quota_eviction_handler()->GetUsage());
+  temporary_storage_evictor()->set_repeated_eviction(true);
+  temporary_storage_evictor()->Start();
+  MessageLoop::current()->RunAllPending();
+  EXPECT_EQ(initial_total_size - d_size + e_size - b_size - a_size,
+            quota_eviction_handler()->GetUsage());
+  EXPECT_EQ(4, num_get_usage_and_quota_for_eviction());
+}
+
+TEST_F(QuotaTemporaryStorageEvictorTest, DiskSpaceEvictionTest) {
+  quota_eviction_handler()->AddOrigin(GURL("http://www.z.com"), 294);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.y.com"), 120);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.x.com"), 150);
+  quota_eviction_handler()->AddOrigin(GURL("http://www.w.com"), 300);
+  quota_eviction_handler()->set_quota(10000);
+  quota_eviction_handler()->set_available_space(
+      default_min_available_disk_space_to_start_eviction() - 350);
+  EXPECT_EQ(294 + 120 + 150 + 300, quota_eviction_handler()->GetUsage());
+  temporary_storage_evictor()->Start();
+  MessageLoop::current()->RunAllPending();
+  EXPECT_EQ(150 + 300, quota_eviction_handler()->GetUsage());
+}
+
+}  // namespace quota

webkit/quota/webkit_quota.gypi

@@ -21,6 +21,8 @@
         'quota_manager.h',
         'quota_task.cc',
         'quota_task.h',
+        'quota_temporary_storage_evictor.cc',
+        'quota_temporary_storage_evictor.h',
         'quota_types.h',
         'special_storage_policy.cc',
         'special_storage_policy.h',

webkit/tools/test_shell/test_shell.gypi

@@ -438,6 +438,7 @@
         '../../quota/mock_storage_client.h',
         '../../quota/quota_database_unittest.cc',
         '../../quota/quota_manager_unittest.cc',
+        '../../quota/quota_temporary_storage_evictor_unittest.cc',
         '../webcore_unit_tests/BMPImageDecoder_unittest.cpp',
         '../webcore_unit_tests/ICOImageDecoder_unittest.cpp',
         'event_listener_unittest.cc',