[CacheStorage] Pad and bin opaque resource sizes.

content/browser/cache_storage/cache_storage_cache.h

 // Copyright 2014 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 CONTENT_BROWSER_CACHE_STORAGE_CACHE_STORAGE_CACHE_H_
 #define CONTENT_BROWSER_CACHE_STORAGE_CACHE_STORAGE_CACHE_H_
 
 #include <stdint.h>
 
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/files/file_path.h"
 #include "base/id_map.h"
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "content/common/cache_storage/cache_storage_types.h"
 #include "content/common/service_worker/service_worker_types.h"
 #include "net/base/io_buffer.h"
 #include "net/disk_cache/disk_cache.h"
 #include "storage/common/quota/quota_status_code.h"
 
+namespace crypto {
+class SymmetricKey;
+}
+
 namespace net {
 class URLRequestContextGetter;
 }
 
 namespace storage {
 class BlobDataHandle;
 class BlobStorageContext;
 class QuotaManagerProxy;
 }
 
 namespace content {
 class CacheStorage;
 class CacheStorageBlobToDiskCache;
 class CacheStorageCacheHandle;
 class CacheStorageCacheObserver;
 class CacheStorageScheduler;
 class TestCacheStorageCache;
 
 namespace proto {
 class CacheMetadata;
+class CacheResponse;
 }
 
 // Represents a ServiceWorker Cache as seen in
 // https://slightlyoff.github.io/ServiceWorker/spec/service_worker/ The
 // asynchronous methods are executed serially. Callbacks to the public functions
 // will be called so long as the cache object lives.
 class CONTENT_EXPORT CacheStorageCache {
  public:
   using ErrorCallback = base::OnceCallback<void(CacheStorageError)>;
   using ResponseCallback =
       base::OnceCallback<void(CacheStorageError,
                               std::unique_ptr<ServiceWorkerResponse>,
                               std::unique_ptr<storage::BlobDataHandle>)>;
   using Responses = std::vector<ServiceWorkerResponse>;
   using BlobDataHandles = std::vector<std::unique_ptr<storage::BlobDataHandle>>;
   using ResponsesCallback =
       base::OnceCallback<void(CacheStorageError,
                               std::unique_ptr<Responses>,
                               std::unique_ptr<BlobDataHandles>)>;
   using Requests = std::vector<ServiceWorkerFetchRequest>;
   using RequestsCallback =
       base::OnceCallback<void(CacheStorageError, std::unique_ptr<Requests>)>;
   using SizeCallback = base::OnceCallback<void(int64_t)>;
+  using SizePaddingCallback = base::OnceCallback<void(int64_t, int64_t)>;
 
   enum EntryIndex { INDEX_HEADERS = 0, INDEX_RESPONSE_BODY, INDEX_SIDE_DATA };
 
   static std::unique_ptr<CacheStorageCache> CreateMemoryCache(
       const GURL& origin,
       const std::string& cache_name,
       CacheStorage* cache_storage,
       scoped_refptr<net::URLRequestContextGetter> request_context_getter,
       scoped_refptr<storage::QuotaManagerProxy> quota_manager_proxy,
-      base::WeakPtr<storage::BlobStorageContext> blob_context);
+      base::WeakPtr<storage::BlobStorageContext> blob_context,
+      std::unique_ptr<crypto::SymmetricKey> cache_padding_key);
   static std::unique_ptr<CacheStorageCache> CreatePersistentCache(
       const GURL& origin,
       const std::string& cache_name,
       CacheStorage* cache_storage,
       const base::FilePath& path,
       scoped_refptr<net::URLRequestContextGetter> request_context_getter,
       scoped_refptr<storage::QuotaManagerProxy> quota_manager_proxy,
       base::WeakPtr<storage::BlobStorageContext> blob_context,
-      int64_t cache_size);
+      int64_t cache_size,
+      int64_t cache_padding,
+      std::unique_ptr<crypto::SymmetricKey> cache_padding_key);
+  static int64_t CalculateResponsePadding(
+      const ServiceWorkerResponse& response,
+      const crypto::SymmetricKey* padding_key,
+      int side_data_size);
+  static int32_t GetResponsePaddingVersion();
 
   // Returns ERROR_TYPE_NOT_FOUND if not found.
   void Match(std::unique_ptr<ServiceWorkerFetchRequest> request,
              const CacheStorageCacheQueryParams& match_params,
              ResponseCallback callback);
 
   // Returns CACHE_STORAGE_OK and matched responses in this cache. If there are
   // no responses, returns CACHE_STORAGE_OK and an empty vector.
   void MatchAll(std::unique_ptr<ServiceWorkerFetchRequest> request,
                 const CacheStorageCacheQueryParams& match_params,
@@ skipping 61 matching lines @@
 
   // Async operations in progress will cancel and not run their callbacks.
   virtual ~CacheStorageCache();
 
   base::FilePath path() const { return path_; }
 
   std::string cache_name() const { return cache_name_; }
 
   int64_t cache_size() const { return cache_size_; }
 
+  int64_t cache_padding() const { return cache_padding_; }
+
+  const crypto::SymmetricKey* cache_padding_key() const {
+    return cache_padding_key_.get();
+  }
+
+  // Return the total cache size (actual size + padding). If either is unknown
+  // then CacheStorage::kSizeUnknown is returned.
+  int64_t PaddedCacheSize() const;
+
   // Set the one observer that will be notified of changes to this cache.
   // Note: Either the observer must have a lifetime longer than this instance
   // or call SetObserver(nullptr) to stop receiving notification of changes.
   void SetObserver(CacheStorageCacheObserver* observer);
 
   base::WeakPtr<CacheStorageCache> AsWeakPtr();
 
  private:
-  enum class QueryCacheType { REQUESTS, REQUESTS_AND_RESPONSES, CACHE_ENTRIES };
+  // QueryCache types:
+  enum QueryCacheFlags {
+    QUERY_CACHE_REQUESTS = 0x1,
+    QUERY_CACHE_RESPONSES_WITH_BODIES = 0x2,
+    QUERY_CACHE_RESPONSES_NO_BODIES = 0x4,
+    QUERY_CACHE_ENTRIES = 0x8,
+  };
 
   // The backend progresses from uninitialized, to open, to closed, and cannot
   // reverse direction.  The open step may be skipped.
   enum BackendState {
     BACKEND_UNINITIALIZED,  // No backend, create backend on first operation.
     BACKEND_OPEN,           // Backend can be used.
     BACKEND_CLOSED          // Backend cannot be used.  All ops should fail.
   };
 
   friend class base::RefCounted<CacheStorageCache>;
   friend class TestCacheStorageCache;
   friend class CacheStorageCacheTest;
 
   struct PutContext;
   struct QueryCacheContext;
   struct QueryCacheResult;
 
+  using QueryTypes = int32_t;
   using QueryCacheResults = std::vector<QueryCacheResult>;
   using QueryCacheCallback =
       base::OnceCallback<void(CacheStorageError,
                               std::unique_ptr<QueryCacheResults>)>;
   using Entries = std::vector<disk_cache::Entry*>;
   using ScopedBackendPtr = std::unique_ptr<disk_cache::Backend>;
   using BlobToDiskCacheIDMap =
       IDMap<std::unique_ptr<CacheStorageBlobToDiskCache>>;
 
   CacheStorageCache(
       const GURL& origin,
       const std::string& cache_name,
       const base::FilePath& path,
       CacheStorage* cache_storage,
       scoped_refptr<net::URLRequestContextGetter> request_context_getter,
       scoped_refptr<storage::QuotaManagerProxy> quota_manager_proxy,
       base::WeakPtr<storage::BlobStorageContext> blob_context,
-      int64_t cache_size);
+      int64_t cache_size,
+      int64_t cache_padding,
+      std::unique_ptr<crypto::SymmetricKey> cache_padding_key);
 
   // Runs |callback| with matching requests/response data. The data provided
   // in the QueryCacheResults depends on the |query_type|. If |query_type| is
   // CACHE_ENTRIES then only out_entries is valid. If |query_type| is REQUESTS
   // then only out_requests is valid. If |query_type| is
   // REQUESTS_AND_RESPONSES then only out_requests, out_responses, and
   // out_blob_data_handles are valid.
   void QueryCache(std::unique_ptr<ServiceWorkerFetchRequest> request,
                   const CacheStorageCacheQueryParams& options,
-                  QueryCacheType query_type,
+                  QueryTypes query_types,
                   QueryCacheCallback callback);
   void QueryCacheDidOpenFastPath(
       std::unique_ptr<QueryCacheContext> query_cache_context,
       int rv);
   void QueryCacheOpenNextEntry(
       std::unique_ptr<QueryCacheContext> query_cache_context);
   void QueryCacheFilterEntry(
       std::unique_ptr<QueryCacheContext> query_cache_context,
       int rv);
   void QueryCacheDidReadMetadata(
@@ skipping 50 matching lines @@
                                  int buf_len,
                                  std::unique_ptr<disk_cache::Entry*> entry_ptr,
                                  int rv);
   void WriteSideDataDidReadMetaData(
       ErrorCallback callback,
       base::Time expected_response_time,
       scoped_refptr<net::IOBuffer> buffer,
       int buf_len,
       disk_cache::ScopedEntryPtr entry,
       std::unique_ptr<proto::CacheMetadata> headers);
-  void WriteSideDataDidWrite(ErrorCallback callback,
-                             disk_cache::ScopedEntryPtr entry,
-                             int expected_bytes,
-                             int rv);
+  void WriteSideDataDidWrite(
+      ErrorCallback callback,
+      disk_cache::ScopedEntryPtr entry,
+      int expected_bytes,
+      std::unique_ptr<content::proto::CacheResponse> response,
+      int side_data_size_before_write,
+      int rv);
 
   // Puts the request and response object in the cache. The response body (if
   // present) is stored in the cache, but not the request body. Returns OK on
   // success.
   void Put(const CacheStorageBatchOperation& operation, ErrorCallback callback);
   void PutImpl(std::unique_ptr<PutContext> put_context);
-  void PutDidDoomEntry(std::unique_ptr<PutContext> put_context, int rv);
+  void PutDidDeleteEntry(std::unique_ptr<PutContext> put_context,
+                         CacheStorageError error,
+                         std::unique_ptr<QueryCacheResults> query_results);
   void PutDidGetUsageAndQuota(std::unique_ptr<PutContext> put_context,
                               storage::QuotaStatusCode status_code,
                               int64_t usage,
                               int64_t quota);
   void PutDidCreateEntry(std::unique_ptr<disk_cache::Entry*> entry_ptr,
                          std::unique_ptr<PutContext> put_context,
                          int rv);
   void PutDidWriteHeaders(std::unique_ptr<PutContext> put_context,
                           int expected_bytes,
                           int rv);
   void PutDidWriteBlobToCache(std::unique_ptr<PutContext> put_context,
                               BlobToDiskCacheIDMap::KeyType blob_to_cache_key,
                               disk_cache::ScopedEntryPtr entry,
                               bool success);
 
   // Asynchronously calculates the current cache size, notifies the quota
   // manager of any change from the last report, and sets cache_size_ to the new
   // size.
   void UpdateCacheSize(base::OnceClosure callback);
   void UpdateCacheSizeGotSize(std::unique_ptr<CacheStorageCacheHandle>,
                               base::OnceClosure callback,
                               int current_cache_size);
 
   // Returns ERROR_NOT_FOUND if not found. Otherwise deletes and returns OK.
   void Delete(const CacheStorageBatchOperation& operation,
               ErrorCallback callback);
   void DeleteImpl(std::unique_ptr<ServiceWorkerFetchRequest> request,
                   const CacheStorageCacheQueryParams& match_params,
-                  ErrorCallback callback);
+                  QueryCacheCallback callback);

[jkarlin, 2017/07/31 14:03:24]

Why not revert this back to an ErrorCallback? I don't believe any consumer is
using the query results at this point.

[cmumford, 2017/08/10 16:37:11]

Done.

   void DeleteDidQueryCache(
-      ErrorCallback callback,
+      QueryCacheCallback callback,
       CacheStorageError error,
       std::unique_ptr<QueryCacheResults> query_cache_results);
+  void DeleteDidDelete(ErrorCallback callback,
+                       CacheStorageError error,
+                       std::unique_ptr<QueryCacheResults> query_results);
 
   // Keys callbacks.
   void KeysImpl(std::unique_ptr<ServiceWorkerFetchRequest> request,
                 const CacheStorageCacheQueryParams& options,
                 RequestsCallback callback);
   void KeysDidQueryCache(
       RequestsCallback callback,
       CacheStorageError error,
       std::unique_ptr<QueryCacheResults> query_cache_results);
 
   void CloseImpl(base::OnceClosure callback);
 
   void SizeImpl(SizeCallback callback);
 
   void GetSizeThenCloseDidGetSize(SizeCallback callback, int64_t cache_size);
 
   // Loads the backend and calls the callback with the result (true for
   // success). The callback will always be called. Virtual for tests.
   virtual void CreateBackend(ErrorCallback callback);
   void CreateBackendDidCreate(ErrorCallback callback,
                               std::unique_ptr<ScopedBackendPtr> backend_ptr,
                               int rv);
 
+  // Calculate the size and padding of the cache.
+  void CalculateCacheSizePadding(SizePaddingCallback callback);
+  void CalculateCacheSizePaddingGotSize(SizePaddingCallback callback,
+                                        int cache_size);
+  void PaddingDidQueryCache(
+      SizePaddingCallback callback,
+      int cache_size,
+      CacheStorageError error,
+      std::unique_ptr<QueryCacheResults> query_cache_results);
+
+  // Calculate the size (but not padding) of the cache.
+  void CalculateCacheSize(const net::CompletionCallback& callback);
+
   void InitBackend();
   void InitDidCreateBackend(base::OnceClosure callback,
                             CacheStorageError cache_create_error);
   void InitGotCacheSize(base::OnceClosure callback,
                         CacheStorageError cache_create_error,
                         int cache_size);
+  void InitGotCacheSizeAndPadding(base::OnceClosure callback,
+                                  CacheStorageError cache_create_error,
+                                  int64_t cache_size,
+                                  int64_t cache_padding);
 
   std::unique_ptr<storage::BlobDataHandle> PopulateResponseBody(
       disk_cache::ScopedEntryPtr entry,
       ServiceWorkerResponse* response);
 
   // Virtual for testing.
   virtual std::unique_ptr<CacheStorageCacheHandle> CreateCacheHandle();
 
   // Be sure to check |backend_state_| before use.
   std::unique_ptr<disk_cache::Backend> backend_;
 
   GURL origin_;
   const std::string cache_name_;
   base::FilePath path_;
 
   // Raw pointer is safe because CacheStorage owns this object.
   CacheStorage* cache_storage_;
 
   scoped_refptr<net::URLRequestContextGetter> request_context_getter_;
   scoped_refptr<storage::QuotaManagerProxy> quota_manager_proxy_;
   base::WeakPtr<storage::BlobStorageContext> blob_storage_context_;
   BackendState backend_state_ = BACKEND_UNINITIALIZED;
   std::unique_ptr<CacheStorageScheduler> scheduler_;
   bool initializing_ = false;
+  // The actual physical cache size (not including padding).

[jkarlin, 2017/07/31 14:03:24]

Remove the word physical?

[cmumford, 2017/08/10 16:37:11]

Done.

   int64_t cache_size_;
+  int64_t cache_padding_ = 0;
+  std::unique_ptr<crypto::SymmetricKey> cache_padding_key_;
+  int64_t last_reported_size_ = 0;
   size_t max_query_size_bytes_;
   CacheStorageCacheObserver* cache_observer_;
 
   // Owns the elements of the list
   BlobToDiskCacheIDMap active_blob_to_disk_cache_writers_;
 
   // Whether or not to store data in disk or memory.
   bool memory_only_;
 
   base::WeakPtrFactory<CacheStorageCache> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(CacheStorageCache);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_CACHE_STORAGE_CACHE_STORAGE_CACHE_H_