1ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// Copyright (c) 2011 The Chromium Authors. All rights reserved. 2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Use of this source code is governed by a BSD-style license that can be 3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// found in the LICENSE file. 4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 5c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// See net/disk_cache/disk_cache.h for the public interface. 6c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 7c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#ifndef NET_DISK_CACHE_BLOCK_FILES_H__ 8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#define NET_DISK_CACHE_BLOCK_FILES_H__ 93345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 11c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <vector> 12c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 13c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "base/file_path.h" 143345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#include "base/gtest_prod_util.h" 15ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen#include "base/memory/scoped_ptr.h" 16c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "net/disk_cache/addr.h" 17c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "net/disk_cache/mapped_file.h" 18c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 193f50c38dc070f4bb515c1b64450dae14f316474eKristian Monsennamespace base { 203345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickclass ThreadChecker; 213f50c38dc070f4bb515c1b64450dae14f316474eKristian Monsen} 22c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 233345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merricknamespace disk_cache { 24c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 25c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// This class handles the set of block-files open by the disk cache. 26c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass BlockFiles { 27c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott public: 283345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick explicit BlockFiles(const FilePath& path); 29c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ~BlockFiles(); 30c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 31c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Performs the object initialization. create_files indicates if the backing 32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // files should be created or just open. 33c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool Init(bool create_files); 34c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Returns the file that stores a given address. 36c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott MappedFile* GetFile(Addr address); 37c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 38c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Creates a new entry on a block file. block_type indicates the size of block 39c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // to be used (as defined on cache_addr.h), block_count is the number of 40c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // blocks to allocate, and block_address is the address of the new entry. 41c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool CreateBlock(FileType block_type, int block_count, Addr* block_address); 42c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 43c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Removes an entry from the block files. If deep is true, the storage is zero 44c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // filled; otherwise the entry is removed but the data is not altered (must be 45c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // already zeroed). 46c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott void DeleteBlock(Addr address, bool deep); 47c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 48c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Close all the files and set the internal state to be initializad again. The 49c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // cache is being purged. 50c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott void CloseFiles(); 51c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Sends UMA stats. 53c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void ReportStats(); 54c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 553345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Returns true if the blocks pointed by a given address are currently used. 563345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // This method is only intended for debugging. 573345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick bool IsValid(Addr address); 583345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 59c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott private: 60c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Set force to true to overwrite the file if it exists. 61c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool CreateBlockFile(int index, FileType file_type, bool force); 62c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool OpenBlockFile(int index); 63c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 64c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Attemp to grow this file. Fails if the file cannot be extended anymore. 65c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool GrowBlockFile(MappedFile* file, BlockFileHeader* header); 66c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 67c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Returns the appropriate file to use for a new block. 68c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott MappedFile* FileForNewBlock(FileType block_type, int block_count); 69c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 70c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Returns the next block file on this chain, creating new files if needed. 71c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott MappedFile* NextFile(const MappedFile* file); 72c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 73c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Creates an empty block file and returns its index. 74c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int CreateNextBlockFile(FileType block_type); 75c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 76c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Removes a chained block file that is now empty. 77c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott void RemoveEmptyFile(FileType block_type); 78c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 79c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Restores the header of a potentially inconsistent file. 80c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool FixBlockFileHeader(MappedFile* file); 81c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Retrieves stats for the given file index. 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void GetFileStats(int index, int* used_count, int* load); 84c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 85c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Returns the filename for a given file index. 86c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott FilePath Name(int index); 87c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 88c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool init_; 89c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott char* zero_buffer_; // Buffer to speed-up cleaning deleted entries. 90c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott FilePath path_; // Path to the backing folder. 91c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott std::vector<MappedFile*> block_files_; // The actual files. 923f50c38dc070f4bb515c1b64450dae14f316474eKristian Monsen scoped_ptr<base::ThreadChecker> thread_checker_; 93c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 943345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick FRIEND_TEST_ALL_PREFIXES(DiskCacheTest, BlockFiles_ZeroSizeFile); 95d129b9e5870dc7fa49745121bf987e1b6ead1b51Kristian Monsen FRIEND_TEST_ALL_PREFIXES(DiskCacheTest, BlockFiles_TruncatedFile); 963345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick FRIEND_TEST_ALL_PREFIXES(DiskCacheTest, BlockFiles_InvalidFile); 973345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick FRIEND_TEST_ALL_PREFIXES(DiskCacheTest, BlockFiles_Stats); 98c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 99c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch DISALLOW_COPY_AND_ASSIGN(BlockFiles); 100c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott}; 101c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 102c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} // namespace disk_cache 103c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 104c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif // NET_DISK_CACHE_BLOCK_FILES_H__ 105