d024a248fe7e171894dac7e1a8b26417131c2ceb
[WebKit-https.git] / Source / WebKit2 / NetworkProcess / cache / NetworkCacheStatistics.h
1 /*
2  * Copyright (C) 2015 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 #ifndef NetworkCacheStatistics_h
27 #define NetworkCacheStatistics_h
28
29 #if ENABLE(NETWORK_CACHE)
30
31 #include "NetworkCache.h"
32 #include "NetworkCacheKey.h"
33 #include "NetworkCacheStorage.h"
34 #include <WebCore/SQLiteDatabase.h>
35 #include <WebCore/Timer.h>
36
37 namespace WebCore {
38 class ResourceRequest;
39 }
40
41 namespace WebKit {
42 namespace NetworkCache {
43
44 class Statistics {
45 public:
46     static std::unique_ptr<Statistics> open(const String& cachePath);
47
48     void clear();
49
50     void recordNotCachingResponse(const Key&, StoreDecision);
51     void recordNotUsingCacheForRequest(uint64_t webPageID, const Key&, const WebCore::ResourceRequest&, RetrieveDecision);
52     void recordRetrievalFailure(uint64_t webPageID, const Key&, const WebCore::ResourceRequest&);
53     void recordRetrievedCachedEntry(uint64_t webPageID, const Key&, const WebCore::ResourceRequest&, CachedEntryReuseFailure);
54
55 private:
56     explicit Statistics(const String& databasePath);
57
58     void initialize(const String& databasePath);
59     void bootstrapFromNetworkCache(const String& networkCachePath);
60     void shrinkIfNeeded();
61
62     void addHashesToDatabase(const Vector<StringCapture>& hashes);
63     void addStoreDecisionsToDatabase(const Vector<std::pair<StringCapture, NetworkCache::StoreDecision>>&);
64     void writeTimerFired();
65
66     typedef std::function<void (bool wasEverRequested, const Optional<StoreDecision>&)> RequestedCompletionHandler;
67     enum class NeedUncachedReason { No, Yes };
68     void queryWasEverRequested(const String&, NeedUncachedReason, const RequestedCompletionHandler&);
69     void markAsRequested(const String& hash);
70
71     struct EverRequestedQuery {
72         String hash;
73         bool needUncachedReason;
74         RequestedCompletionHandler completionHandler;
75     };
76
77     std::atomic<size_t> m_approximateEntryCount { 0 };
78
79 #if PLATFORM(COCOA)
80     mutable DispatchPtr<dispatch_queue_t> m_backgroundIOQueue;
81 #endif
82     mutable HashSet<std::unique_ptr<const EverRequestedQuery>> m_activeQueries;
83     WebCore::SQLiteDatabase m_database;
84     HashSet<String> m_hashesToAdd;
85     HashMap<String, NetworkCache::StoreDecision> m_storeDecisionsToAdd;
86     WebCore::Timer m_writeTimer;
87 };
88
89 }
90 }
91
92 #endif // ENABLE(NETWORK_CACHE)
93
94 #endif // NetworkCacheStatistics_h