3e47861f20f1a7b8cfa6c9e6f9e7450adb6a1ced
[WebKit-https.git] / Source / WebKit / NetworkProcess / cache / NetworkCache.h
1 /*
2  * Copyright (C) 2014-2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "NetworkCacheEntry.h"
29 #include "NetworkCacheStorage.h"
30 #include "ShareableResource.h"
31 #include <WebCore/ResourceResponse.h>
32 #include <wtf/CompletionHandler.h>
33 #include <wtf/OptionSet.h>
34 #include <wtf/Seconds.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace WebCore {
38 class LowPowerModeNotifier;
39 class ResourceRequest;
40 class SharedBuffer;
41 }
42
43 namespace WebKit {
44
45 class NetworkProcess;
46
47 namespace NetworkCache {
48
49 class Cache;
50 class SpeculativeLoadManager;
51 class Statistics;
52
53 struct MappedBody {
54 #if ENABLE(SHAREABLE_RESOURCE)
55     RefPtr<ShareableResource> shareableResource;
56     ShareableResource::Handle shareableResourceHandle;
57 #endif
58 };
59
60 enum class RetrieveDecision {
61     Yes,
62     NoDueToHTTPMethod,
63     NoDueToConditionalRequest,
64     NoDueToReloadIgnoringCache,
65     NoDueToStreamingMedia,
66 };
67
68 // FIXME: This enum is used in the Statistics code in a way that prevents removing or reordering anything.
69 enum class StoreDecision {
70     Yes,
71     NoDueToProtocol,
72     NoDueToHTTPMethod,
73     NoDueToAttachmentResponse, // Unused.
74     NoDueToNoStoreResponse,
75     NoDueToHTTPStatusCode,
76     NoDueToNoStoreRequest,
77     NoDueToUnlikelyToReuse,
78     NoDueToStreamingMedia,
79 };
80
81 enum class UseDecision {
82     Use,
83     Validate,
84     NoDueToVaryingHeaderMismatch,
85     NoDueToMissingValidatorFields,
86     NoDueToDecodeFailure,
87     NoDueToExpiredRedirect
88 };
89
90 using GlobalFrameID = std::pair<uint64_t /*webPageID*/, uint64_t /*webFrameID*/>;
91
92 class Cache : public RefCounted<Cache> {
93 public:
94     enum class Option {
95         EfficacyLogging = 1 << 0,
96         // In testing mode we try to eliminate sources of randomness. Cache does not shrink and there are no read timeouts.
97         TestingMode = 1 << 1,
98         RegisterNotify = 1 << 2,
99 #if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
100         SpeculativeRevalidation = 1 << 3,
101 #endif
102     };
103     static RefPtr<Cache> open(NetworkProcess&, const String& cachePath, OptionSet<Option>);
104
105     void setCapacity(size_t);
106
107     // Completion handler may get called back synchronously on failure.
108     struct RetrieveInfo {
109         MonotonicTime startTime;
110         MonotonicTime completionTime;
111         unsigned priority;
112         Storage::Timings storageTimings;
113         bool wasSpeculativeLoad { false };
114
115         WTF_MAKE_FAST_ALLOCATED;
116     };
117     using RetrieveCompletionHandler = Function<void(std::unique_ptr<Entry>, const RetrieveInfo&)>;
118     void retrieve(const WebCore::ResourceRequest&, const GlobalFrameID&, RetrieveCompletionHandler&&);
119     std::unique_ptr<Entry> store(const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, RefPtr<WebCore::SharedBuffer>&&, Function<void(MappedBody&)>&&);
120     std::unique_ptr<Entry> storeRedirect(const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, const WebCore::ResourceRequest& redirectRequest, Optional<Seconds> maxAgeCap);
121     std::unique_ptr<Entry> update(const WebCore::ResourceRequest&, const GlobalFrameID&, const Entry&, const WebCore::ResourceResponse& validatingResponse);
122
123     struct TraversalEntry {
124         const Entry& entry;
125         const Storage::RecordInfo& recordInfo;
126     };
127     void traverse(Function<void(const TraversalEntry*)>&&);
128     void remove(const Key&);
129     void remove(const WebCore::ResourceRequest&);
130     void remove(const Vector<Key>&, Function<void()>&&);
131
132     void clear();
133     void clear(WallTime modifiedSince, Function<void()>&&);
134
135     void retrieveData(const DataKey&, Function<void(const uint8_t*, size_t)>);
136     void storeData(const DataKey&,  const uint8_t* data, size_t);
137     
138     std::unique_ptr<Entry> makeEntry(const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, RefPtr<WebCore::SharedBuffer>&&);
139     std::unique_ptr<Entry> makeRedirectEntry(const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, const WebCore::ResourceRequest& redirectRequest);
140
141     void dumpContentsToFile();
142
143     String recordsPath() const;
144
145 #if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
146     SpeculativeLoadManager* speculativeLoadManager() { return m_speculativeLoadManager.get(); }
147 #endif
148
149     NetworkProcess& networkProcess() { return m_networkProcess.get(); }
150
151     ~Cache();
152
153 private:
154     Cache(NetworkProcess&, Ref<Storage>&&, OptionSet<Option> options);
155
156     Key makeCacheKey(const WebCore::ResourceRequest&);
157
158     static void completeRetrieve(RetrieveCompletionHandler&&, std::unique_ptr<Entry>, RetrieveInfo&);
159
160     String dumpFilePath() const;
161     void deleteDumpFile();
162
163     Optional<Seconds> maxAgeCap(Entry&, const WebCore::ResourceRequest&, PAL::SessionID);
164
165     Ref<Storage> m_storage;
166     Ref<NetworkProcess> m_networkProcess;
167
168 #if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
169     std::unique_ptr<WebCore::LowPowerModeNotifier> m_lowPowerModeNotifier;
170     std::unique_ptr<SpeculativeLoadManager> m_speculativeLoadManager;
171 #endif
172     std::unique_ptr<Statistics> m_statistics;
173
174     unsigned m_traverseCount { 0 };
175 };
176
177 } // namespace NetworkCache
178 } // namespace WebKit