[WK2] Log total number of network cache queries using diagnostic logging
[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 recordRetrievalRequest(uint64_t webPageID);
51     void recordNotCachingResponse(const Key&, StoreDecision);
52     void recordNotUsingCacheForRequest(uint64_t webPageID, const Key&, const WebCore::ResourceRequest&, RetrieveDecision);
53     void recordRetrievalFailure(uint64_t webPageID, const Key&, const WebCore::ResourceRequest&);
54     void recordRetrievedCachedEntry(uint64_t webPageID, const Key&, const WebCore::ResourceRequest&, CachedEntryReuseFailure);
55
56 private:
57     explicit Statistics(const String& databasePath);
58
59     void initialize(const String& databasePath);
60     void bootstrapFromNetworkCache(const String& networkCachePath);
61     void shrinkIfNeeded();
62
63     void addHashesToDatabase(const Vector<StringCapture>& hashes);
64     void addStoreDecisionsToDatabase(const Vector<std::pair<StringCapture, NetworkCache::StoreDecision>>&);
65     void writeTimerFired();
66
67     typedef std::function<void (bool wasEverRequested, const Optional<StoreDecision>&)> RequestedCompletionHandler;
68     enum class NeedUncachedReason { No, Yes };
69     void queryWasEverRequested(const String&, NeedUncachedReason, const RequestedCompletionHandler&);
70     void markAsRequested(const String& hash);
71
72     struct EverRequestedQuery {
73         String hash;
74         bool needUncachedReason;
75         RequestedCompletionHandler completionHandler;
76     };
77
78     std::atomic<size_t> m_approximateEntryCount { 0 };
79
80 #if PLATFORM(COCOA)
81     mutable DispatchPtr<dispatch_queue_t> m_backgroundIOQueue;
82 #endif
83     mutable HashSet<std::unique_ptr<const EverRequestedQuery>> m_activeQueries;
84     WebCore::SQLiteDatabase m_database;
85     HashSet<String> m_hashesToAdd;
86     HashMap<String, NetworkCache::StoreDecision> m_storeDecisionsToAdd;
87     WebCore::Timer m_writeTimer;
88 };
89
90 }
91 }
92
93 #endif // ENABLE(NETWORK_CACHE)
94
95 #endif // NetworkCacheStatistics_h