421566a0473575e21f46406426a19a8642b1da7d
[WebKit-https.git] / Source / JavaScriptCore / inspector / agents / InspectorHeapAgent.h
1 /*
2  * Copyright (C) 2015-2016 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 #pragma once
27
28 #include "HeapSnapshot.h"
29 #include "InspectorBackendDispatchers.h"
30 #include "InspectorFrontendDispatchers.h"
31 #include "heap/HeapObserver.h"
32 #include "inspector/InspectorAgentBase.h"
33 #include <wtf/Forward.h>
34 #include <wtf/Noncopyable.h>
35
36 namespace Inspector {
37
38 class InjectedScriptManager;
39 typedef String ErrorString;
40
41 class JS_EXPORT_PRIVATE InspectorHeapAgent : 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&) final;
54     void snapshot(ErrorString&, double* timestamp, String* snapshotData) final;
55     void startTracking(ErrorString&) final;
56     void stopTracking(ErrorString&) final;
57     void getPreview(ErrorString&, int heapObjectId, Inspector::Protocol::OptOutput<String>* resultString, RefPtr<Inspector::Protocol::Debugger::FunctionDetails>& functionDetails, RefPtr<Inspector::Protocol::Runtime::ObjectPreview>& objectPreview) final;
58     void getRemoteObject(ErrorString&, int heapObjectId, const String* const optionalObjectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result) final;
59
60     // HeapObserver
61     void willGarbageCollect() override;
62     void didGarbageCollect(JSC::CollectionScope) override;
63
64 protected:
65     void clearHeapSnapshots();
66
67     virtual void dispatchGarbageCollectedEvent(Inspector::Protocol::Heap::GarbageCollection::Type, double startTime, double endTime);
68
69 private:
70     std::optional<JSC::HeapSnapshotNode> nodeForHeapObjectIdentifier(ErrorString&, unsigned heapObjectIdentifier);
71
72     InjectedScriptManager& m_injectedScriptManager;
73     std::unique_ptr<HeapFrontendDispatcher> m_frontendDispatcher;
74     RefPtr<HeapBackendDispatcher> m_backendDispatcher;
75     InspectorEnvironment& m_environment;
76
77     bool m_enabled { false };
78     bool m_tracking { false };
79     double m_gcStartTime { NAN };
80 };
81
82 } // namespace Inspector