Asynchronous initialization in Simple Index.

net/disk_cache/simple/simple_index.cc

 // Copyright (c) 2013 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 "net/disk_cache/simple/simple_index.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/message_loop.h"
 #include "base/task_runner.h"
@@ skipping 25 matching lines @@
       disk_cache::kSimpleIndexInitialMagicNumber &&
       header.version == disk_cache::kSimpleVersion;
 }
 
 }  // namespace
 
 namespace disk_cache {
 
 SimpleIndex::SimpleIndex(
     const scoped_refptr<base::TaskRunner>& cache_thread,
+    const scoped_refptr<base::TaskRunner>& io_thread,
     const base::FilePath& path)
     : path_(path),
-      cache_thread_(cache_thread) {
-  index_filename_ = path_.AppendASCII("simple-index");
+      cache_size_(0),
+      initialized_(false),
+      index_filename_(path_.AppendASCII("simple-index")),
+      cache_thread_(cache_thread),
+      io_thread_(io_thread) { }

[gavinp, 2013/04/10 10:51:56]

I think I'm more used to {} or {
}

A quick grepfight on the former shows:

gavin@avclub:~/chrome/src$ git grep -n -e '{}' -- '*' | wc
  26694  182935 18669027
gavin@avclub:~/chrome/src$ git grep -n -e '{ }' -- '*' | wc
   1437    7904  125774

[felipeg, 2013/04/10 14:21:45]

Done.

+
+void SimpleIndex::Initialize() {
+  base::WorkerPool::PostTask(FROM_HERE,
+                             base::Bind(&SimpleIndex::LoadFromDisk,
+                                        base::Unretained(this)),
+                             true);
 }
 
-bool SimpleIndex::Initialize() {
+void SimpleIndex::LoadFromDisk() {

[gavinp, 2013/04/10 10:51:56]

Method ordering in the .cc file should match the .h file.

   if (!OpenIndexFile())
     return RestoreFromDisk();
   uLong incremental_crc = crc32(0L, Z_NULL, 0);
   int64 index_file_offset = 0;
   SimpleIndexFile::Header header;
   if (base::ReadPlatformFile(index_file_,
                              index_file_offset,
                              reinterpret_cast<char*>(&header),
                              sizeof(header)) != sizeof(header)) {
     return RestoreFromDisk();
@@ skipping 33 matching lines @@
   const uint32 crc_read = footer.crc;
   const uint32 crc_calculated = incremental_crc;
   if (crc_read != crc_calculated)
     return RestoreFromDisk();
 
   int entries_buffer_offset = 0;
   while(entries_buffer_offset < entries_buffer_size) {
     SimpleIndexFile::EntryMetadata entry_metadata;
     SimpleIndexFile::EntryMetadata::DeSerialize(
         &entries_buffer.get()[entries_buffer_offset], &entry_metadata);
-    InsertInternal(entry_metadata);
+    InsertInternal(&initializing_set_, entry_metadata);
     entries_buffer_offset += SimpleIndexFile::kEntryMetadataSize;
   }
-  DCHECK_EQ(header.number_of_entries, entries_set_.size());
+  DCHECK_EQ(header.number_of_entries, initializing_set_.size());
   CloseIndexFile();
-  return true;
+
+  io_thread_->PostTask(FROM_HERE,
+                       base::Bind(&SimpleIndex::MergeInitializingSet,
+                                  base::Unretained(this)));
 }
 
 void SimpleIndex::Insert(const std::string& key) {
   // Upon insert we don't know yet the size of the entry.
   // It will be updated later when the SynchronousEntryImpl finish and the
   // UpdateEntrySize will be called.
-  InsertInternal(SimpleIndexFile::EntryMetadata(GetEntryHashForKey(key),
+  const std::string hash_key = GetEntryHashForKey(key);
+  InsertInternal(&entries_set_, SimpleIndexFile::EntryMetadata(hash_key,
                                                 base::Time::Now(), 0));

[gavinp, 2013/04/10 10:51:56]

indent.

[felipeg, 2013/04/10 14:21:45]

Done.

+  if (!initialized_)
+    removals_set_.erase(hash_key);
 }
 
 void SimpleIndex::Remove(const std::string& key) {
   UpdateEntrySize(key, 0);
-  entries_set_.erase(GetEntryHashForKey(key));
+  const std::string hash_key = GetEntryHashForKey(key);
+  entries_set_.erase(hash_key);
+
+  if (!initialized_)
+    removals_set_.insert(hash_key);
 }
 
 bool SimpleIndex::Has(const std::string& key) const {
-  return entries_set_.count(GetEntryHashForKey(key)) != 0;
+  // If not initialized, always return true, forcing it to go to the disk.
+  return !initialized_ || entries_set_.count(GetEntryHashForKey(key)) != 0;
 }
 
 bool SimpleIndex::UseIfExists(const std::string& key) {
+  // Always update the last used time, even if it is during initialization.
+  // It will be merged later.
   EntrySet::iterator it = entries_set_.find(GetEntryHashForKey(key));
   if (it == entries_set_.end())
-    return false;
+    // If not initialized, always return true, forcing it to go to the disk.
+    return !initialized_;
   it->second.SetLastUsedTime(base::Time::Now());
   return true;
 }
 
 bool SimpleIndex::UpdateEntrySize(const std::string& key, uint64 entry_size) {
   EntrySet::iterator it = entries_set_.find(GetEntryHashForKey(key));
   if (it == entries_set_.end())
     return false;
 
   // Update the total cache size with the new entry size.
   cache_size_ -= it->second.entry_size;
   cache_size_ += entry_size;
   it->second.entry_size = entry_size;
 
   return true;
 }
 
+// static
 void SimpleIndex::InsertInternal(
+    EntrySet* entry_set,
     const SimpleIndexFile::EntryMetadata& entry_metadata) {
-  entries_set_.insert(make_pair(entry_metadata.GetHashKey(), entry_metadata));
+  DCHECK(entry_set);
+  entry_set->insert(make_pair(entry_metadata.GetHashKey(), entry_metadata));
 }
 
-bool SimpleIndex::RestoreFromDisk() {
+void SimpleIndex::RestoreFromDisk() {
   using file_util::FileEnumerator;
   LOG(INFO) << "Simple Cache Index is being restored from disk.";
   CloseIndexFile();
   file_util::Delete(index_filename_, /* recursive = */ false);
-  entries_set_.clear();
+  DCHECK_EQ(0U, initializing_set_.size());
+
   const base::FilePath::StringType file_pattern = FILE_PATH_LITERAL("*_[0-2]");
   FileEnumerator enumerator(path_,
                             false /* recursive */,
                             FileEnumerator::FILES,
                             file_pattern);
 
   for (base::FilePath file_path = enumerator.Next(); !file_path.empty();
        file_path = enumerator.Next()) {
     const base::FilePath::StringType base_name = file_path.BaseName().value();
     // Converting to std::string is OK since we never use UTF8 wide chars in our
     // file names.
     const std::string hash_name(base_name.begin(), base_name.end());
     const std::string hash_key = hash_name.substr(0, kEntryHashKeySize);
 
     FileEnumerator::FindInfo find_info = {};
     enumerator.GetFindInfo(&find_info);
     base::Time last_used_time;
 #if defined(OS_POSIX)
     // For POSIX systems, a last access time is available. However, it's not
     // guaranteed to be more accurate than mtime. It is no worse though.
     last_used_time = base::Time::FromTimeT(find_info.stat.st_atime);
 #endif
     if (last_used_time.is_null())
       last_used_time = FileEnumerator::GetLastModifiedTime(find_info);
 
     int64 file_size = FileEnumerator::GetFilesize(find_info);
-    EntrySet::iterator it = entries_set_.find(hash_key);
-    if (it == entries_set_.end()) {
-      InsertInternal(SimpleIndexFile::EntryMetadata(
+    EntrySet::iterator it = initializing_set_.find(hash_key);
+    if (it == initializing_set_.end()) {
+      InsertInternal(&initializing_set_, SimpleIndexFile::EntryMetadata(
           hash_key, last_used_time, file_size));
     } else {
       // Summing up the total size of the entry through all the *_[0-2] files
       it->second.entry_size += file_size;
     }
   }
 
-  // TODO(felipeg): Detect unrecoverable problems and return false here.
-  return true;
+  io_thread_->PostTask(FROM_HERE,
+                       base::Bind(&SimpleIndex::MergeInitializingSet,
+                                  base::Unretained(this)));
+}
+
+void SimpleIndex::MergeInitializingSet() {
+  // First, remove the entries that are in the |removals_set_| from both sets.
+  for (base::hash_set<std::string>::const_iterator it = removals_set_.begin();
+       it != removals_set_.end(); ++it) {
+    entries_set_.erase(*it);
+    initializing_set_.erase(*it);
+  }
+
+  // Recalculate the cache size while merging the two sets.
+  cache_size_ = 0;
+  for (EntrySet::const_iterator it = initializing_set_.begin();
+       it != initializing_set_.end(); ++it) {
+    // If there is already an entry in the current entries_set_, we need to
+    // merge the new data there with the data loaded in the initialization.
+    EntrySet::iterator current_entry = entries_set_.find(it->first);
+    if (current_entry != entries_set_.end()) {
+      // When Merging, existing valid data in the |current_entry| will prevail.
+      SimpleIndexFile::EntryMetadata::Merge(
+          it->second, &(current_entry->second));
+      cache_size_ += current_entry->second.entry_size;
+    } else {
+      InsertInternal(&entries_set_, it->second);
+      cache_size_ += it->second.entry_size;
+    }
+  }
+  initializing_set_.clear();
+
+  initialized_ = true;
 }
 
 void SimpleIndex::Serialize(std::string* out_buffer) {
   DCHECK(out_buffer);
   SimpleIndexFile::Header header;
   SimpleIndexFile::Footer footer;
 
   header.initial_magic_number = kSimpleIndexInitialMagicNumber;
   header.version = kSimpleVersion;
   header.number_of_entries = entries_set_.size();
@@ skipping 13 matching lines @@
   }
 
   // Then, CRC.
   footer.crc = crc32(crc32(0, Z_NULL, 0),
                      reinterpret_cast<const Bytef*>(out_buffer->data()),
                      implicit_cast<uInt>(out_buffer->size()));
 
   out_buffer->append(reinterpret_cast<const char*>(&footer), sizeof(footer));
 }
 
-void SimpleIndex::Cleanup() {
+void SimpleIndex::WriteToDisk() {
   scoped_ptr<std::string> buffer(new std::string());
   Serialize(buffer.get());
   cache_thread_->PostTask(FROM_HERE,
                             base::Bind(&SimpleIndex::UpdateFile,
                                        index_filename_,
                                        path_.AppendASCII("index_temp"),
                                        base::Passed(&buffer)));
 }
 
 SimpleIndex::~SimpleIndex() {
@@ skipping 32 matching lines @@
                << temp_filename.value();
     file_util::Delete(temp_filename, /* recursive = */ false);
     return;
   }
   // Swap temp and index_file.
   bool result = file_util::ReplaceFile(temp_filename, index_filename);
   DCHECK(result);
 }
 
 }  // namespace disk_cache