Refactor our SimpleIndex file format and serialization to use Pickle instead of the previously bugg…

net/disk_cache/simple/simple_index_file.h

+// 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.
+
+#ifndef NET_DISK_CACHE_SIMPLE_SIMPLE_INDEX_FILE_H_
+#define NET_DISK_CACHE_SIMPLE_SIMPLE_INDEX_FILE_H_
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/callback.h"
+#include "base/files/file_path.h"
+#include "base/hash_tables.h"
+#include "base/logging.h"
+#include "base/pickle.h"
+#include "net/disk_cache/simple/simple_index.h"
+
+namespace base {
+class TaskRunner;
+}
+
+namespace disk_cache {
+
+const uint64 kSimpleIndexInitialMagicNumber = GG_UINT64_C(0x656e74657220796f);
+
+// Simple Index File format is a pickle serialized data of IndexMetadata and
+// EntryMetadata objects. To know more about the pickle format, see
+// SimpleIndexFile::Serialize() and SeeSimpleIndexFile::LoadFromDisk() methods.
+class SimpleIndexFile {
+ public:
+  class IndexMetadata {
+   public:
+    IndexMetadata();
+    IndexMetadata(uint64 number_of_entries, uint64 cache_size);
+
+    void Serialize(Pickle* pickle) const;
+    static bool DeSerialize(PickleIterator* it,
+                            IndexMetadata* out);
+
+    bool CheckIndexMetadata();
+
+    uint64 GetNumberOfEntries() { return number_of_entries_; }
+
+   private:
+    uint64 initial_magic_number_;
+    uint32 version_;
+    uint64 number_of_entries_;
+    uint64 cache_size_;  // Total cache storage size in bytes.
+  };
+
+  static void LoadFromDisk(
+      const base::FilePath& index_filename,
+      const scoped_refptr<base::TaskRunner>& callback_runner,
+      const IndexCompletionCallback& completion_callback);
+
+  // Enumerates all entries' files on disk and regenerates the index.
+  static void RestoreFromDisk(
+      const base::FilePath& index_filename,
+      const scoped_refptr<base::TaskRunner>& callback_runner,
+      const IndexCompletionCallback& completion_callback);
+
+  // Returns a scoped_ptr for a newly allocated Pickle containing the serialized
+  // data to be written to a file.
+  static scoped_ptr<Pickle> Serialize(
+      const SimpleIndexFile::IndexMetadata& index_metadata,
+      const EntrySet& entries);
+
+  // Write the serialized data from |pickle| into the index file.
+  static void WriteToDisk(const base::FilePath& index_filename,
+                          scoped_ptr<Pickle> pickle);

[Philippe, 2013/04/15 13:57:57]

It's not clear to me why this method is taking ownership of |pickle|. After you
call this method (i.e. |pickle| is "moved"), the callee's scoped_ptr is
invalidated which can lead to NULL pointer dereferencing. This might be ok for
now if this is the last operation you do on |pickle| but this seems less than
ideal in the long term.

I think the only sane reason to take onwership of |pickle| would be in case the
method is asynchronous but this does not seem to be the case.

[felipeg, 2013/04/15 14:39:07]

This is used in a callback.
Discussed offline.

+
+ private:
+  struct PickleHeader : public Pickle::Header {

[Philippe, 2013/04/15 13:57:57]

Nit: I don't think you need to expose this in this header.

[felipeg, 2013/04/15 14:39:07]

Yes, but I think it is more readable this way.
PickleHeader is inside the SimpleIndexFile class namespace.

It documents the file format.

+    uint32 crc;
+  };
+
+  static uint32 CalculatePickleCRC(const Pickle& pickle);

[Philippe, 2013/04/15 13:57:57]

Nit: I would move this to an anonymous namespace in the .cc file.

[felipeg, 2013/04/15 14:39:07]

Done.

+
+  SimpleIndexFile() {}

[Philippe, 2013/04/15 13:57:57]

I would replace this constructor and destructor with DISALLOW_COPY_AND_ASSIGN.

[felipeg, 2013/04/15 14:39:07]

Done.

+  ~SimpleIndexFile() {}
+};
+

[Philippe, 2013/04/15 13:57:57]

Nit: extra blank line.

[felipeg, 2013/04/15 14:39:07]

Done.

+
+}  // namespace disk_cache
+
+#endif  // NET_DISK_CACHE_SIMPLE_SIMPLE_INDEX_FILE_H_