Index: net/disk_cache/simple/simple_index_file.h |
diff --git a/net/disk_cache/simple/simple_index_file.h b/net/disk_cache/simple/simple_index_file.h |
deleted file mode 100644 |
index 91f2a48f3686ec15dc80ff008cd8dd493b84d8d8..0000000000000000000000000000000000000000 |
--- a/net/disk_cache/simple/simple_index_file.h |
+++ /dev/null |
@@ -1,190 +0,0 @@ |
-// 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 <vector> |
- |
-#include "base/basictypes.h" |
-#include "base/containers/hash_tables.h" |
-#include "base/files/file_path.h" |
-#include "base/gtest_prod_util.h" |
-#include "base/logging.h" |
-#include "base/memory/scoped_ptr.h" |
-#include "base/pickle.h" |
-#include "base/port.h" |
-#include "net/base/cache_type.h" |
-#include "net/base/net_export.h" |
-#include "net/disk_cache/simple/simple_index.h" |
- |
-namespace base { |
-class SingleThreadTaskRunner; |
-class TaskRunner; |
-} |
- |
-namespace disk_cache { |
- |
-const uint64 kSimpleIndexMagicNumber = GG_UINT64_C(0x656e74657220796f); |
- |
-struct NET_EXPORT_PRIVATE SimpleIndexLoadResult { |
- SimpleIndexLoadResult(); |
- ~SimpleIndexLoadResult(); |
- void Reset(); |
- |
- bool did_load; |
- SimpleIndex::EntrySet entries; |
- bool flush_required; |
-}; |
- |
-// Simple Index File format is a pickle serialized data of IndexMetadata and |
-// EntryMetadata objects. The file format is as follows: one instance of |
-// serialized |IndexMetadata| followed serialized |EntryMetadata| entries |
-// repeated |number_of_entries| amount of times. To know more about the format, |
-// see SimpleIndexFile::Serialize() and SeeSimpleIndexFile::LoadFromDisk() |
-// methods. |
-// |
-// The non-static methods must run on the IO thread. All the real |
-// work is done in the static methods, which are run on the cache thread |
-// or in worker threads. Synchronization between methods is the |
-// responsibility of the caller. |
-class NET_EXPORT_PRIVATE SimpleIndexFile { |
- public: |
- class NET_EXPORT_PRIVATE IndexMetadata { |
- public: |
- IndexMetadata(); |
- IndexMetadata(uint64 number_of_entries, uint64 cache_size); |
- |
- void Serialize(Pickle* pickle) const; |
- bool Deserialize(PickleIterator* it); |
- |
- bool CheckIndexMetadata(); |
- |
- uint64 GetNumberOfEntries() { return number_of_entries_; } |
- |
- private: |
- FRIEND_TEST_ALL_PREFIXES(IndexMetadataTest, Basics); |
- FRIEND_TEST_ALL_PREFIXES(IndexMetadataTest, Serialize); |
- |
- uint64 magic_number_; |
- uint32 version_; |
- uint64 number_of_entries_; |
- uint64 cache_size_; // Total cache storage size in bytes. |
- }; |
- |
- SimpleIndexFile( |
- const scoped_refptr<base::SingleThreadTaskRunner>& cache_thread, |
- const scoped_refptr<base::TaskRunner>& worker_pool, |
- net::CacheType cache_type, |
- const base::FilePath& cache_directory); |
- virtual ~SimpleIndexFile(); |
- |
- // Get index entries based on current disk context. |
- virtual void LoadIndexEntries(base::Time cache_last_modified, |
- const base::Closure& callback, |
- SimpleIndexLoadResult* out_result); |
- |
- // Write the specified set of entries to disk. |
- virtual void WriteToDisk(const SimpleIndex::EntrySet& entry_set, |
- uint64 cache_size, |
- const base::TimeTicks& start, |
- bool app_on_background, |
- const base::Closure& callback); |
- |
- private: |
- friend class WrappedSimpleIndexFile; |
- |
- // Used for cache directory traversal. |
- typedef base::Callback<void (const base::FilePath&)> EntryFileCallback; |
- |
- // When loading the entries from disk, add this many extra hash buckets to |
- // prevent reallocation on the IO thread when merging in new live entries. |
- static const int kExtraSizeForMerge = 512; |
- |
- // Synchronous (IO performing) implementation of LoadIndexEntries. |
- static void SyncLoadIndexEntries(net::CacheType cache_type, |
- base::Time cache_last_modified, |
- const base::FilePath& cache_directory, |
- const base::FilePath& index_file_path, |
- SimpleIndexLoadResult* out_result); |
- |
- // Load the index file from disk returning an EntrySet. |
- static void SyncLoadFromDisk(const base::FilePath& index_filename, |
- base::Time* out_last_cache_seen_by_index, |
- SimpleIndexLoadResult* out_result); |
- |
- // Returns a scoped_ptr for a newly allocated Pickle containing the serialized |
- // data to be written to a file. Note: the pickle is not in a consistent state |
- // immediately after calling this menthod, one needs to call |
- // SerializeFinalData to make it ready to write to a file. |
- static scoped_ptr<Pickle> Serialize( |
- const SimpleIndexFile::IndexMetadata& index_metadata, |
- const SimpleIndex::EntrySet& entries); |
- |
- // Appends cache modification time data to the serialized format. This is |
- // performed on a thread accessing the disk. It is not combined with the main |
- // serialization path to avoid extra thread hops or copying the pickle to the |
- // worker thread. |
- static bool SerializeFinalData(base::Time cache_modified, Pickle* pickle); |
- |
- // Given the contents of an index file |data| of length |data_len|, returns |
- // the corresponding EntrySet. Returns NULL on error. |
- static void Deserialize(const char* data, int data_len, |
- base::Time* out_cache_last_modified, |
- SimpleIndexLoadResult* out_result); |
- |
- // Implemented either in simple_index_file_posix.cc or |
- // simple_index_file_win.cc. base::FileEnumerator turned out to be very |
- // expensive in terms of memory usage therefore it's used only on non-POSIX |
- // environments for convenience (for now). Returns whether the traversal |
- // succeeded. |
- static bool TraverseCacheDirectory( |
- const base::FilePath& cache_path, |
- const EntryFileCallback& entry_file_callback); |
- |
- // Writes the index file to disk atomically. |
- static void SyncWriteToDisk(net::CacheType cache_type, |
- const base::FilePath& cache_directory, |
- const base::FilePath& index_filename, |
- const base::FilePath& temp_index_filename, |
- scoped_ptr<Pickle> pickle, |
- const base::TimeTicks& start_time, |
- bool app_on_background); |
- |
- // Scan the index directory for entries, returning an EntrySet of all entries |
- // found. |
- static void SyncRestoreFromDisk(const base::FilePath& cache_directory, |
- const base::FilePath& index_file_path, |
- SimpleIndexLoadResult* out_result); |
- |
- // Determines if an index file is stale relative to the time of last |
- // modification of the cache directory. Obsolete, used only for a histogram to |
- // compare with the new method. |
- // TODO(pasko): remove this method after getting enough data. |
- static bool LegacyIsIndexFileStale(base::Time cache_last_modified, |
- const base::FilePath& index_file_path); |
- |
- struct PickleHeader : public Pickle::Header { |
- uint32 crc; |
- }; |
- |
- const scoped_refptr<base::SingleThreadTaskRunner> cache_thread_; |
- const scoped_refptr<base::TaskRunner> worker_pool_; |
- const net::CacheType cache_type_; |
- const base::FilePath cache_directory_; |
- const base::FilePath index_file_; |
- const base::FilePath temp_index_file_; |
- |
- static const char kIndexDirectory[]; |
- static const char kIndexFileName[]; |
- static const char kTempIndexFileName[]; |
- |
- DISALLOW_COPY_AND_ASSIGN(SimpleIndexFile); |
-}; |
- |
- |
-} // namespace disk_cache |
- |
-#endif // NET_DISK_CACHE_SIMPLE_SIMPLE_INDEX_FILE_H_ |