[BlobAsync] Disk support for blob storage

storage/browser/blob/internal_blob_data.h

 // Copyright 2015 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 STORAGE_BROWSER_BLOB_INTERNAL_BLOB_DATA_H_
 #define STORAGE_BROWSER_BLOB_INTERNAL_BLOB_DATA_H_
 
 #include <stddef.h>
 
 #include <memory>
 #include <string>
 #include <vector>
 
+#include "base/callback_forward.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
-#include "storage/browser/blob/shareable_blob_data_item.h"
+#include "base/optional.h"
+#include "storage/browser/blob/blob_memory_controller.h"
+#include "storage/browser/storage_browser_export.h"
 
 namespace storage {
+class BlobDataHandle;
+class ShareableBlobDataItem;
 class ViewBlobInternalsJob;
 
-// This class represents a blob in the BlobStorageContext.  It is constructed
-// using the internal Builder class.
-class InternalBlobData {
+// This class represents a blob. We export this only for unit tests.
+class STORAGE_EXPORT InternalBlobData {
  public:
+  using PopulatationAllowedCallback =
+      base::Callback<void(BlobStatus,
+                          std::vector<BlobMemoryController::FileCreationInfo>)>;
+
+  // This records a copy from a referenced blob. When we finish building our
+  // blob we perform all of these copies.
+  struct STORAGE_EXPORT ItemCopyEntry {
+    ItemCopyEntry(scoped_refptr<ShareableBlobDataItem> source_item,
+                  size_t source_item_offset,
+                  scoped_refptr<ShareableBlobDataItem> dest_item);
+    ~ItemCopyEntry();
+    ItemCopyEntry(const ItemCopyEntry&);
+
+    scoped_refptr<ShareableBlobDataItem> source_item;
+    size_t source_item_offset = 0;
+    scoped_refptr<ShareableBlobDataItem> dest_item;
+  };
+
+  // This keeps track of our building state for our blob. While building, four
+  // things can be happening mostly simultaneously:
+  // 1. Waiting for blobs we reference to complete,
+  // 2. Waiting for quota to be reserved for memory needed, and
+  // 3. Waiting for quota to be reserved (and files created) for files,
+  // 4. Waiting for user population of data after quota.
+  struct STORAGE_EXPORT BuildingState {
+    // |user_data_population_callback| is !null when user data needs population.
+    BuildingState(bool user_data_present,
+                  PopulatationAllowedCallback user_data_population_callback,
+                  bool dependent_building_blobs_present,
+                  size_t num_building_dependent_blobs,
+                  bool memory_quota_needed,
+                  bool file_quota_needed);
+    ~BuildingState();
+
+    bool MemoryQuotaComplete() const {
+      return !memory_quota_needed || memory_quota_granted;
+    }
+
+    bool FileQuotaComplete() const {
+      return !file_quota_needed || file_quota_granted;
+    }
+
+    bool UserPopulationComplete() const {
+      return !user_data_present || user_data_populated;
+    }
+
+    bool DependentBlobsComplete() const {
+      return num_building_dependent_blobs == 0;
+    }
+
+    bool CanFinishBuilding() const {
+      return MemoryQuotaComplete() && FileQuotaComplete() &&
+             DependentBlobsComplete() && UserPopulationComplete();
+    }
+
+    // If there is file quota needed, then this is all we need for populating
+    // user data. Otherwise we can populate when memory quota is granted.
+    bool CanRequestUserPopulation() const {
+      return !user_data_populated &&
+             ((!file_quota_needed && memory_quota_granted) ||
+              (file_quota_needed && file_quota_granted));
+    }
+
+    const bool user_data_present;
+    // We can have user data that's either populated or unpopulated. If we need
+    // population, this is populated.
+    PopulatationAllowedCallback user_data_population_callback;
+    std::vector<ShareableBlobDataItem*> user_items;
+    bool user_data_populated = false;
+
+    const bool dependent_building_blobs_present;
+    // Stores all blobs that we're depending on for building. This keeps the
+    // blobs alive while we build our blob.
+    std::vector<std::unique_ptr<BlobDataHandle>> dependent_blobs;
+    size_t num_building_dependent_blobs;
+
+    const bool memory_quota_needed;
+    BlobMemoryController::PendingMemoryQuotaRequest memory_quota_request;
+    bool memory_quota_granted = false;
+
+    const bool file_quota_needed;
+    BlobMemoryController::PendingFileQuotaRequest file_quota_request =
+        BlobMemoryController::kInvalidFileQuotaRequest;
+    bool file_quota_granted = false;
+
+    // These are copies from a referenced blob item to our blob items. Some of
+    // these entries may have changed from bytes to files if they were paged.
+    std::vector<ItemCopyEntry> copies;
+
+    // When our blob finishes building these callbacks are called.
+    std::vector<BlobStatusCallback> build_completion_callbacks;
+  };
+
+  InternalBlobData(const std::string& content_type,
+                   const std::string& content_disposition);
   ~InternalBlobData();
 
- protected:
-  friend class BlobStorageContext;
-  friend class BlobStorageRegistry;
-  friend class ViewBlobInternalsJob;
+  // Appends the given shared blob data item to this object. We add |my_uuid|
+  // to the shareable item's uuid set.
+  void AppendSharedBlobItem(const std::string& my_uuid,
+                            scoped_refptr<ShareableBlobDataItem> item);
 
   // Removes the given blob uuid from the internal ShareableBlobDataItems.
   // This is called when this blob is being destroyed.
   void RemoveBlobFromShareableItems(const std::string& blob_uuid);
 
-  const std::vector<scoped_refptr<ShareableBlobDataItem>>& items() const;
-
   // Gets the memory used by this blob that is not shared by other blobs. This
   // also doesn't count duplicate items.
   size_t GetUnsharedMemoryUsage() const;
 
-  // Gets the memory used by this blob.  Total memory includes memory of items
-  // possibly shared with other blobs, or items that appear multiple times in
-  // this blob. Unshared memory is memory used by this blob that is not shared
-  // by other blobs.
-  void GetMemoryUsage(size_t* total_memory, size_t* unshared_memory);
+  // Returns if we're a pending blob that can finish building.
+  bool CanFinishBuilding() const {
+    return status_ == BlobStatus::PENDING &&
+           building_state_->CanFinishBuilding();
+  }
+
+  BlobStatus status() const { return status_; }
+
+  size_t refcount() const { return refcount_; }
+
+  const std::string& content_type() const { return content_type_; }
+
+  const std::string& content_disposition() const {
+    return content_disposition_;
+  }
+
+  // Total size of this blob in bytes.
+  uint64_t total_size() const { return size_; };
+
+  // We record the cumulative offsets of each blob item (except for the first,
+  // which would always be 0) to enable binary searching for an item at a
+  // specific byte offset.
+  const std::vector<uint64_t>& offsets() const { return offsets_; }
+
+  const std::vector<scoped_refptr<ShareableBlobDataItem>>& items() const;
 
  private:
-  friend class Builder;
-  InternalBlobData();
+  friend class BlobStorageContext;
 
+  BlobStatus status_ = BlobStatus::PENDING;
+  size_t refcount_ = 0;
+
+  // Metadata.
   std::string content_type_;
   std::string content_disposition_;
+
   std::vector<scoped_refptr<ShareableBlobDataItem>> items_;
 
-  class Builder {
-   public:
-    Builder();
-    ~Builder();
+  // Size in bytes. IFF we're a single file then this can be uint64_max.
+  uint64_t size_ = 0;
 
-    void AppendSharedBlobItem(scoped_refptr<ShareableBlobDataItem> item);
+  // Only populated if len(items_) > 1.  Used for binary search.
+  // Since the offset of the first item is always 0, we exclude this.
+  std::vector<uint64_t> offsets_;
 
-    // Gets the memory used by this builder that is not shared with other blobs.
-    size_t GetNonsharedMemoryUsage() const;
-
-    // Removes the given blob uuid from the internal ShareableBlobDataItems.
-    // This is called on destruction of the blob if we're still building it.
-    void RemoveBlobFromShareableItems(const std::string& blob_uuid);
-
-    // The builder is invalid after calling this method.
-    std::unique_ptr<::storage::InternalBlobData> Build();
-
-   private:
-    std::unique_ptr<::storage::InternalBlobData> data_;
-
-    DISALLOW_COPY_AND_ASSIGN(Builder);
-  };
+  // Only populated if our status is PENDING_*.
+  std::unique_ptr<BuildingState> building_state_;
 
   DISALLOW_COPY_AND_ASSIGN(InternalBlobData);
 };
 
 }  // namespace storage
 #endif  // STORAGE_BROWSER_BLOB_INTERNAL_BLOB_DATA_H_