Source/JavaScriptCore/inspector/agents/InspectorHeapAgent.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. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef InspectorHeapAgent_h
  27 #define InspectorHeapAgent_h
  28
  29 #include "HeapSnapshot.h"
  30 #include "InspectorBackendDispatchers.h"
  31 #include "InspectorFrontendDispatchers.h"
  32 #include "heap/HeapObserver.h"
  33 #include "inspector/InspectorAgentBase.h"
  34 #include <wtf/Forward.h>
  35 #include <wtf/Noncopyable.h>
  36
  37 namespace Inspector {
  38
  39 typedef String ErrorString;
  40
  41 class JS_EXPORT_PRIVATE InspectorHeapAgent final : public InspectorAgentBase, public HeapBackendDispatcherHandler, public JSC::HeapObserver {
  42     WTF_MAKE_NONCOPYABLE(InspectorHeapAgent);
  43 public:
  44     InspectorHeapAgent(AgentContext&);
  45     virtual ~InspectorHeapAgent();
  46
  47     void didCreateFrontendAndBackend(FrontendRouter*, BackendDispatcher*) override;
  48     void willDestroyFrontendAndBackend(DisconnectReason) override;
  49
  50     // HeapBackendDispatcherHandler
  51     void enable(ErrorString&) override;
  52     void disable(ErrorString&) override;
  53     void gc(ErrorString&) override;
  54     void snapshot(ErrorString&, double* timestamp, String* snapshotData) override;
  55     void startTracking(ErrorString&) override;
  56     void stopTracking(ErrorString&) override;
  57
  58     // HeapObserver
  59     void willGarbageCollect() override;
  60     void didGarbageCollect(JSC::HeapOperation) override;
  61
  62 private:
  63     void clearHeapSnapshots();
  64
  65     std::unique_ptr<HeapFrontendDispatcher> m_frontendDispatcher;
  66     RefPtr<HeapBackendDispatcher> m_backendDispatcher;
  67     InspectorEnvironment& m_environment;
  68
  69     bool m_enabled { false };
  70     bool m_tracking { false };
  71     double m_gcStartTime { NAN };
  72 };
  73
  74 } // namespace Inspector
  75
  76 #endif // InspectorHeapAgent_h