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 "storage/browser/blob/blob_data_handle.h" | 21 #include "storage/browser/blob/blob_data_handle.h" |
22 #include "storage/browser/blob/blob_memory_controller.h" | |
22 #include "storage/browser/blob/blob_storage_registry.h" | 23 #include "storage/browser/blob/blob_storage_registry.h" |
23 #include "storage/browser/blob/internal_blob_data.h" | |
24 #include "storage/browser/storage_browser_export.h" | 24 #include "storage/browser/storage_browser_export.h" |
25 #include "storage/common/blob_storage/blob_storage_constants.h" | 25 #include "storage/common/blob_storage/blob_storage_constants.h" |
26 #include "storage/common/data_element.h" | |
27 | 26 |
28 class GURL; | 27 class GURL; |
29 | 28 |
30 namespace base { | 29 namespace base { |
31 class FilePath; | 30 class FilePath; |
32 class Time; | 31 class Time; |
32 class TaskRunner; | |
33 } | 33 } |
34 | 34 |
35 namespace content { | 35 namespace content { |
36 class BlobDispatcherHost; | 36 class BlobDispatcherHost; |
37 class BlobDispatcherHostTest; | 37 class BlobDispatcherHostTest; |
38 } | 38 } |
39 | 39 |
40 namespace storage { | 40 namespace storage { |
41 | 41 |
42 class BlobDataBuilder; | 42 class BlobDataBuilder; |
43 class BlobDataHandle; | |
43 class BlobDataItem; | 44 class BlobDataItem; |
44 class BlobDataSnapshot; | 45 class BlobDataSnapshot; |
45 class ShareableBlobDataItem; | 46 class ShareableBlobDataItem; |
46 | 47 |
47 // This class handles the logistics of blob Storage within the browser process, | 48 // This class handles the logistics of blob Storage within the browser process, |
48 // and maintains a mapping from blob uuid to the data. The class is single | 49 // and maintains a mapping from blob uuid to the data. The class is single |
49 // threaded and should only be used on the IO thread. | 50 // threaded and should only be used on the IO thread. |
50 // In chromium, there is one instance per profile. | 51 // In chromium, there is one instance per profile. |
51 class STORAGE_EXPORT BlobStorageContext | 52 class STORAGE_EXPORT BlobStorageContext |
52 : public base::SupportsWeakPtr<BlobStorageContext> { | 53 : public base::SupportsWeakPtr<BlobStorageContext> { |
(...skipping 15 matching lines...) Expand all Loading... | |
68 const BlobDataBuilder& builder); | 69 const BlobDataBuilder& builder); |
69 | 70 |
70 // Deprecated, use const ref version above. | 71 // Deprecated, use const ref version above. |
71 std::unique_ptr<BlobDataHandle> AddFinishedBlob( | 72 std::unique_ptr<BlobDataHandle> AddFinishedBlob( |
72 const BlobDataBuilder* builder); | 73 const BlobDataBuilder* builder); |
73 | 74 |
74 // Useful for coining blob urls from within the browser process. | 75 // Useful for coining blob urls from within the browser process. |
75 bool RegisterPublicBlobURL(const GURL& url, const std::string& uuid); | 76 bool RegisterPublicBlobURL(const GURL& url, const std::string& uuid); |
76 void RevokePublicBlobURL(const GURL& url); | 77 void RevokePublicBlobURL(const GURL& url); |
77 | 78 |
78 size_t memory_usage() const { return memory_usage_; } | |
79 size_t blob_count() const { return registry_.blob_count(); } | 79 size_t blob_count() const { return registry_.blob_count(); } |
80 size_t memory_available() const { | |
81 return kBlobStorageMaxMemoryUsage - memory_usage_; | |
82 } | |
83 | 80 |
84 const BlobStorageRegistry& registry() { return registry_; } | 81 const BlobStorageRegistry& registry() { return registry_; } |
85 | 82 |
83 void EnableDisk(const base::FilePath& storage_directory, | |
84 scoped_refptr<base::TaskRunner> file_runner); | |
85 | |
86 std::unique_ptr<BlobDataHandle> BuildBrokenBlob( | |
michaeln
2016/07/15 02:12:08
maybe move this up to AddFinishedBlob() and call i
dmurph
2016/07/15 20:18:16
Done.
| |
87 const std::string& uuid, | |
88 const std::string& content_type, | |
89 const std::string& content_disposition, | |
90 BlobStatus reason); | |
91 | |
92 // If there is data present that needs further population then we will call | |
93 // |can_populate_memory| when we're ready for the user data to be populated | |
94 // with the PENDING status. This can happen synchronously or asynchronously. | |
95 // Othwerwise |can_populate_memory| can be null. | |
96 // If the handle is broken, then the possible error cases are: | |
97 // * OUT_OF_MEMORY if we don't have enough memory to store the blob, | |
98 // * REFERENCED_BLOB_BROKEN if a referenced blob is broken or we're | |
99 // referencing ourself. | |
100 std::unique_ptr<BlobDataHandle> BuildBlob( | |
101 const BlobDataBuilder& content, | |
102 const BlobStatusCallback& can_populate_memory); | |
103 | |
104 // Note: Any callbacks waiting on this blob, including the | |
105 // |can_populate_memory| callback given to BuildBlob, will be called with this | |
106 // status code. | |
107 void BreakAndFinishBlob(const std::string& uuid, BlobStatus code); | |
michaeln
2016/07/15 02:12:08
This method used to be called CancelPendingBlob.
dmurph
2016/07/15 20:18:16
Hm, maybe pending should be introduced again.
| |
108 | |
109 // This notifies the construction system that the unpopulated data in the | |
110 // given blob has been populated. | |
111 void FinishedPopulatingBlob(const std::string& uuid); | |
112 | |
113 const BlobMemoryController& memory_controller() { return memory_controller_; } | |
114 | |
86 private: | 115 private: |
87 using BlobRegistryEntry = BlobStorageRegistry::Entry; | 116 using BlobRegistryEntry = BlobStorageRegistry::Entry; |
88 using BlobConstructedCallback = BlobStorageRegistry::BlobConstructedCallback; | |
89 friend class content::BlobDispatcherHost; | 117 friend class content::BlobDispatcherHost; |
118 friend class content::BlobDispatcherHostTest; | |
90 friend class BlobAsyncBuilderHost; | 119 friend class BlobAsyncBuilderHost; |
91 friend class BlobAsyncBuilderHostTest; | 120 friend class BlobAsyncBuilderHostTest; |
92 friend class BlobDataHandle; | 121 friend class BlobDataHandle; |
93 friend class BlobDataHandle::BlobDataHandleShared; | 122 friend class BlobDataHandle::BlobDataHandleShared; |
94 friend class BlobReaderTest; | 123 friend class BlobReaderTest; |
95 FRIEND_TEST_ALL_PREFIXES(BlobReaderTest, HandleBeforeAsyncCancel); | 124 FRIEND_TEST_ALL_PREFIXES(BlobReaderTest, HandleBeforeAsyncCancel); |
96 FRIEND_TEST_ALL_PREFIXES(BlobReaderTest, ReadFromIncompleteBlob); | 125 FRIEND_TEST_ALL_PREFIXES(BlobReaderTest, ReadFromIncompleteBlob); |
97 friend class BlobStorageContextTest; | 126 friend class BlobStorageContextTest; |
127 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, BuildBlobAsync); | |
128 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, BuildBlobAndCancel); | |
98 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, IncrementDecrementRef); | 129 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, IncrementDecrementRef); |
99 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, OnCancelBuildingBlob); | 130 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, OnCancelBuildingBlob); |
100 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, PublicBlobUrls); | 131 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, PublicBlobUrls); |
101 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, | 132 FRIEND_TEST_ALL_PREFIXES(BlobStorageContextTest, |
102 TestUnknownBrokenAndBuildingBlobReference); | 133 TestUnknownBrokenAndBuildingBlobReference); |
103 friend class ViewBlobInternalsJob; | 134 friend class ViewBlobInternalsJob; |
104 | 135 |
105 // CompletePendingBlob or CancelPendingBlob should be called after this. | 136 BlobMemoryController* mutable_memory_controller() { |
106 void CreatePendingBlob(const std::string& uuid, | 137 return &memory_controller_; |
107 const std::string& content_type, | 138 } |
108 const std::string& content_disposition); | |
109 | 139 |
110 // This includes resolving blob references in the builder. This will run the | 140 std::unique_ptr<BlobDataHandle> CreateHandle(const std::string& uuid, |
111 // callbacks given in RunOnConstructionComplete. | 141 BlobRegistryEntry* entry); |
112 void CompletePendingBlob(const BlobDataBuilder& external_builder); | |
113 | 142 |
114 // This will run the callbacks given in RunOnConstructionComplete. | 143 bool CanFinishBuilding(BlobRegistryEntry* entry); |
115 void CancelPendingBlob(const std::string& uuid, | 144 |
116 IPCBlobCreationCancelCode reason); | 145 void FinishBuilding(BlobRegistryEntry* entry); |
146 | |
147 void OnEnoughSizeForBlobData(const std::string& uuid, bool can_fit); | |
148 | |
149 void OnDependentBlobFinished(const std::string& owning_blob_uuid, | |
150 BlobStatus reason); | |
151 | |
152 void ClearAndFreeMemory(const std::string& uuid, BlobRegistryEntry* entry); | |
117 | 153 |
118 void IncrementBlobRefCount(const std::string& uuid); | 154 void IncrementBlobRefCount(const std::string& uuid); |
119 void DecrementBlobRefCount(const std::string& uuid); | 155 void DecrementBlobRefCount(const std::string& uuid); |
120 | 156 |
121 // Methods called by BlobDataHandle: | 157 // Methods called by BlobDataHandle: |
122 // This will return an empty snapshot until the blob is complete. | 158 // This will return an empty snapshot until the blob is complete. |
123 // TODO(dmurph): After we make the snapshot method in BlobHandle private, then | 159 // TODO(dmurph): After we make the snapshot method in BlobHandle private, then |
124 // make this DCHECK on the blob not being complete. | 160 // make this DCHECK on the blob not being complete. |
125 std::unique_ptr<BlobDataSnapshot> CreateSnapshot(const std::string& uuid); | 161 std::unique_ptr<BlobDataSnapshot> CreateSnapshot(const std::string& uuid); |
126 bool IsBroken(const std::string& uuid) const; | 162 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, | 163 // 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 | 164 // and false if there was an error, which is reported in the second argument |
130 // of the callback. | 165 // of the callback. |
131 void RunOnConstructionComplete(const std::string& uuid, | 166 void RunOnConstructionComplete(const std::string& uuid, |
132 const BlobConstructedCallback& done); | 167 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 | 168 |
159 BlobStorageRegistry registry_; | 169 BlobStorageRegistry registry_; |
160 | 170 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 | 171 |
166 DISALLOW_COPY_AND_ASSIGN(BlobStorageContext); | 172 DISALLOW_COPY_AND_ASSIGN(BlobStorageContext); |
167 }; | 173 }; |
168 | 174 |
169 } // namespace storage | 175 } // namespace storage |
170 | 176 |
171 #endif // STORAGE_BROWSER_BLOB_BLOB_STORAGE_CONTEXT_H_ | 177 #endif // STORAGE_BROWSER_BLOB_BLOB_STORAGE_CONTEXT_H_ |
OLD | NEW |