Source/WebKit/UIProcess/ResourceLoadStatisticsPersistentStorage.h

   1 /*
   2  * Copyright (C) 2017-2018 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 <wtf/Forward.h>
  29 #include <wtf/MonotonicTime.h>
  30 #include <wtf/RunLoop.h>
  31 #include <wtf/WallTime.h>
  32 #include <wtf/WeakPtr.h>
  33 #include <wtf/WorkQueue.h>
  34 #include <wtf/text/WTFString.h>
  35
  36 namespace WebCore {
  37 class FileMonitor;
  38 }
  39
  40 namespace WebKit {
  41
  42 class ResourceLoadStatisticsMemoryStore;
  43
  44 // Can only be constructed / destroyed / used from the WebResourceLoadStatisticsStore's statistic queue.
  45 class ResourceLoadStatisticsPersistentStorage : public CanMakeWeakPtr<ResourceLoadStatisticsPersistentStorage> {
  46 public:
  47     ResourceLoadStatisticsPersistentStorage(ResourceLoadStatisticsMemoryStore&, WorkQueue&, const String& storageDirectoryPath);
  48     ~ResourceLoadStatisticsPersistentStorage();
  49
  50     void clear();
  51
  52     enum class ForceImmediateWrite { No, Yes, };
  53     void scheduleOrWriteMemoryStore(ForceImmediateWrite);
  54
  55 private:
  56     String storageDirectoryPath() const;
  57     String resourceLogFilePath() const;
  58
  59     void startMonitoringDisk();
  60     void stopMonitoringDisk();
  61     void monitorDirectoryForNewStatistics();
  62
  63     void writeMemoryStoreToDisk();
  64     void populateMemoryStoreFromDisk();
  65     void excludeFromBackup() const;
  66     void refreshMemoryStoreFromDisk();
  67
  68     ResourceLoadStatisticsMemoryStore& m_memoryStore;
  69     Ref<WorkQueue> m_workQueue;
  70     const String m_storageDirectoryPath;
  71     std::unique_ptr<WebCore::FileMonitor> m_fileMonitor;
  72     WallTime m_lastStatisticsFileSyncTime;
  73     MonotonicTime m_lastStatisticsWriteTime;
  74     bool m_hasPendingWrite { false };
  75 };
  76
  77 }