OLD | NEW |
1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef STORAGE_BROWSER_BLOB_BLOB_STORAGE_CONTEXT_H_ | 5 #ifndef STORAGE_BROWSER_BLOB_BLOB_STORAGE_CONTEXT_H_ |
6 #define STORAGE_BROWSER_BLOB_BLOB_STORAGE_CONTEXT_H_ | 6 #define STORAGE_BROWSER_BLOB_BLOB_STORAGE_CONTEXT_H_ |
7 | 7 |
8 #include <stddef.h> | 8 #include <stddef.h> |
9 #include <stdint.h> | 9 #include <stdint.h> |
10 | 10 |
11 #include <map> | 11 #include <map> |
12 #include <memory> | 12 #include <memory> |
13 #include <string> | 13 #include <string> |
14 #include <vector> | 14 #include <vector> |
15 | 15 |
16 #include "base/callback_forward.h" | 16 #include "base/callback_forward.h" |
17 #include "base/gtest_prod_util.h" | 17 #include "base/gtest_prod_util.h" |
18 #include "base/macros.h" | 18 #include "base/macros.h" |
19 #include "base/memory/ref_counted.h" | 19 #include "base/memory/ref_counted.h" |
20 #include "base/memory/weak_ptr.h" | 20 #include "base/memory/weak_ptr.h" |
| 21 #include "base/single_thread_task_runner.h" |
21 #include "storage/browser/blob/blob_data_handle.h" | 22 #include "storage/browser/blob/blob_data_handle.h" |
| 23 #include "storage/browser/blob/blob_memory_controller.h" |
22 #include "storage/browser/blob/blob_storage_registry.h" | 24 #include "storage/browser/blob/blob_storage_registry.h" |
23 #include "storage/browser/blob/internal_blob_data.h" | 25 #include "storage/browser/blob/internal_blob_data.h" |
24 #include "storage/browser/storage_browser_export.h" | 26 #include "storage/browser/storage_browser_export.h" |
25 #include "storage/common/blob_storage/blob_storage_constants.h" | 27 #include "storage/common/blob_storage/blob_storage_constants.h" |
26 #include "storage/common/data_element.h" | 28 #include "storage/common/data_element.h" |
27 | 29 |
28 class GURL; | 30 class GURL; |
29 | 31 |
30 namespace base { | 32 namespace base { |
31 class FilePath; | 33 class FilePath; |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
68 const BlobDataBuilder& builder); | 70 const BlobDataBuilder& builder); |
69 | 71 |
70 // Deprecated, use const ref version above. | 72 // Deprecated, use const ref version above. |
71 std::unique_ptr<BlobDataHandle> AddFinishedBlob( | 73 std::unique_ptr<BlobDataHandle> AddFinishedBlob( |
72 const BlobDataBuilder* builder); | 74 const BlobDataBuilder* builder); |
73 | 75 |
74 // Useful for coining blob urls from within the browser process. | 76 // Useful for coining blob urls from within the browser process. |
75 bool RegisterPublicBlobURL(const GURL& url, const std::string& uuid); | 77 bool RegisterPublicBlobURL(const GURL& url, const std::string& uuid); |
76 void RevokePublicBlobURL(const GURL& url); | 78 void RevokePublicBlobURL(const GURL& url); |
77 | 79 |
78 size_t memory_usage() const { return memory_usage_; } | |
79 size_t blob_count() const { return registry_.blob_count(); } | 80 size_t blob_count() const { return registry_.blob_count(); } |
80 size_t memory_available() const { | |
81 return kBlobStorageMaxMemoryUsage - memory_usage_; | |
82 } | |
83 | 81 |
84 const BlobStorageRegistry& registry() { return registry_; } | 82 const BlobStorageRegistry& registry() { return registry_; } |
85 | 83 |
| 84 void EnableDisk(const base::FilePath storage_directory, |
| 85 scoped_refptr<base::SingleThreadTaskRunner> file_runner); |
| 86 |
| 87 std::unique_ptr<BlobDataHandle> BuildBrokenBlob( |
| 88 const std::string& uuid, |
| 89 const std::string& content_type, |
| 90 const std::string& content_disposition, |
| 91 BlobStatus reason); |
| 92 |
| 93 // If there is data present that needs further population then we will call |
| 94 // |can_populate_memory| when we're ready for the user data to be populated |
| 95 // with the PENDING status. This can happen synchronously or asynchronously. |
| 96 // Othwerwise |can_populate_memory| can be null. |
| 97 // If the handle is broken, then the possible error cases are: |
| 98 // * OUT_OF_MEMORY if we don't have enough memory to store the blob, |
| 99 // * REFERENCED_BLOB_BROKEN if a referenced blob is broken or we're |
| 100 // referencing ourself. |
| 101 std::unique_ptr<BlobDataHandle> BuildBlob( |
| 102 const BlobDataBuilder& content, |
| 103 const BlobStatusCallback& can_populate_memory); |
| 104 |
| 105 void BreakAndFinishBlob(const std::string& uuid, BlobStatus code); |
| 106 |
| 107 // This notifies the construction system that the unpopulated data in the |
| 108 // given blob has been populated. |
| 109 void FinishedPopulatingBlob(const std::string& uuid); |
| 110 |
| 111 protected: |
| 112 friend struct BlobSlice; |
| 113 friend struct BlobFlattener; |
| 114 |
| 115 friend class content::BlobDispatcherHostTest; |
| 116 |
| 117 // Not thread safe. |
| 118 static uint64_t GetAndIncrementItemId(); |
| 119 |
| 120 BlobMemoryController* mutable_memory_controller() { |
| 121 return &memory_controller_; |
| 122 } |
| 123 |
| 124 const BlobMemoryController& memory_controller() { return memory_controller_; } |
| 125 |
86 private: | 126 private: |
87 using BlobRegistryEntry = BlobStorageRegistry::Entry; | 127 using BlobRegistryEntry = BlobStorageRegistry::Entry; |
88 using BlobConstructedCallback = BlobStorageRegistry::BlobConstructedCallback; | |
89 friend class content::BlobDispatcherHost; | 128 friend class content::BlobDispatcherHost; |
90 friend class BlobAsyncBuilderHost; | 129 friend class BlobAsyncBuilderHost; |
91 friend class BlobAsyncBuilderHostTest; | 130 friend class BlobAsyncBuilderHostTest; |
92 friend class BlobDataHandle; | 131 friend class BlobDataHandle; |
93 friend class BlobDataHandle::BlobDataHandleShared; | 132 friend class BlobDataHandle::BlobDataHandleShared; |
94 friend class BlobReaderTest; | 133 friend class BlobReaderTest; |
95 FRIEND_TEST_ALL_PREFIXES(BlobReaderTest, HandleBeforeAsyncCancel); | 134 FRIEND_TEST_ALL_PREFIXES(BlobReaderTest, HandleBeforeAsyncCancel); |
96 FRIEND_TEST_ALL_PREFIXES(BlobReaderTest, ReadFromIncompleteBlob); | 135 FRIEND_TEST_ALL_PREFIXES(BlobReaderTest, ReadFromIncompleteBlob); |
97 friend class BlobStorageContextTest; | 136 friend class BlobStorageContextTest; |
98 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, IncrementDecrementRef); | 137 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, IncrementDecrementRef); |
99 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, OnCancelBuildingBlob); | 138 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, OnCancelBuildingBlob); |
100 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, PublicBlobUrls); | 139 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, PublicBlobUrls); |
101 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, | 140 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, |
102 TestUnknownBrokenAndBuildingBlobReference); | 141 TestUnknownBrokenAndBuildingBlobReference); |
103 friend class ViewBlobInternalsJob; | 142 friend class ViewBlobInternalsJob; |
104 | 143 |
105 // CompletePendingBlob or CancelPendingBlob should be called after this. | 144 std::unique_ptr<BlobDataHandle> CreateHandle(const std::string& uuid, |
106 void CreatePendingBlob(const std::string& uuid, | 145 BlobRegistryEntry* entry); |
107 const std::string& content_type, | |
108 const std::string& content_disposition); | |
109 | 146 |
110 // This includes resolving blob references in the builder. This will run the | 147 bool CanFinishBuilding(BlobRegistryEntry* entry); |
111 // callbacks given in RunOnConstructionComplete. | |
112 void CompletePendingBlob(const BlobDataBuilder& external_builder); | |
113 | 148 |
114 // This will run the callbacks given in RunOnConstructionComplete. | 149 void FinishBuilding(BlobRegistryEntry* entry); |
115 void CancelPendingBlob(const std::string& uuid, | 150 |
116 IPCBlobCreationCancelCode reason); | 151 void OnEnoughSizeForBlobData(const std::string& uuid, bool can_fit); |
| 152 |
| 153 void OnDependentBlobFinished(const std::string& owning_blob_uuid, |
| 154 BlobStatus reason); |
| 155 |
| 156 void ClearAndFreeMemory(const std::string& uuid, BlobRegistryEntry* entry); |
117 | 157 |
118 void IncrementBlobRefCount(const std::string& uuid); | 158 void IncrementBlobRefCount(const std::string& uuid); |
119 void DecrementBlobRefCount(const std::string& uuid); | 159 void DecrementBlobRefCount(const std::string& uuid); |
120 | 160 |
121 // Methods called by BlobDataHandle: | 161 // Methods called by BlobDataHandle: |
122 // This will return an empty snapshot until the blob is complete. | 162 // This will return an empty snapshot until the blob is complete. |
123 // TODO(dmurph): After we make the snapshot method in BlobHandle private, then | 163 // TODO(dmurph): After we make the snapshot method in BlobHandle private, then |
124 // make this DCHECK on the blob not being complete. | 164 // make this DCHECK on the blob not being complete. |
125 std::unique_ptr<BlobDataSnapshot> CreateSnapshot(const std::string& uuid); | 165 std::unique_ptr<BlobDataSnapshot> CreateSnapshot(const std::string& uuid); |
126 bool IsBroken(const std::string& uuid) const; | 166 BlobStatus GetBlobStatus(const std::string& uuid) const; |
127 bool IsBeingBuilt(const std::string& uuid) const; | |
128 // Runs |done| when construction completes, with true if it was successful, | 167 // Runs |done| when construction completes, with true if it was successful, |
129 // and false if there was an error, which is reported in the second argument | 168 // and false if there was an error, which is reported in the second argument |
130 // of the callback. | 169 // of the callback. |
131 void RunOnConstructionComplete(const std::string& uuid, | 170 void RunOnConstructionComplete(const std::string& uuid, |
132 const BlobConstructedCallback& done); | 171 const BlobStatusCallback& done); |
133 | |
134 // Appends the given blob item to the blob builder. The new blob | |
135 // retains ownership of data_item if applicable, and returns false if there | |
136 // was an error and pouplates the error_code. We can either have an error of: | |
137 // OUT_OF_MEMORY: We are out of memory to store this blob. | |
138 // REFERENCED_BLOB_BROKEN: One of the referenced blobs is broken. | |
139 bool AppendAllocatedBlobItem(const std::string& target_blob_uuid, | |
140 scoped_refptr<BlobDataItem> data_item, | |
141 InternalBlobData::Builder* target_blob_data, | |
142 IPCBlobCreationCancelCode* error_code); | |
143 | |
144 // Allocates a shareable blob data item, with blob references resolved. If | |
145 // there isn't enough memory, then a nullptr is returned. | |
146 scoped_refptr<ShareableBlobDataItem> AllocateShareableBlobDataItem( | |
147 const std::string& target_blob_uuid, | |
148 scoped_refptr<BlobDataItem> data_item); | |
149 | |
150 // Deconstructs the blob and appends it's contents to the target blob. Items | |
151 // are shared if possible, and copied if the given offset and length | |
152 // have to split an item. | |
153 bool AppendBlob(const std::string& target_blob_uuid, | |
154 const InternalBlobData& blob, | |
155 uint64_t offset, | |
156 uint64_t length, | |
157 InternalBlobData::Builder* target_blob_data); | |
158 | 172 |
159 BlobStorageRegistry registry_; | 173 BlobStorageRegistry registry_; |
160 | 174 BlobMemoryController memory_controller_; |
161 // Used to keep track of how much memory is being utilized for blob data, | |
162 // we count only the items of TYPE_DATA which are held in memory and not | |
163 // items of TYPE_FILE. | |
164 size_t memory_usage_; | |
165 | 175 |
166 DISALLOW_COPY_AND_ASSIGN(BlobStorageContext); | 176 DISALLOW_COPY_AND_ASSIGN(BlobStorageContext); |
167 }; | 177 }; |
168 | 178 |
169 } // namespace storage | 179 } // namespace storage |
170 | 180 |
171 #endif // STORAGE_BROWSER_BLOB_BLOB_STORAGE_CONTEXT_H_ | 181 #endif // STORAGE_BROWSER_BLOB_BLOB_STORAGE_CONTEXT_H_ |
OLD | NEW |