2cbc3f3045012b0011aa3bb36221c95f807aef8f
[WebKit-https.git] / Source / JavaScriptCore / inspector / agents / InspectorHeapAgent.cpp
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 #include "config.h"
27 #include "InspectorHeapAgent.h"
28
29 #include "InspectorEnvironment.h"
30 #include "VM.h"
31 #include <wtf/RunLoop.h>
32 #include <wtf/Stopwatch.h>
33
34 using namespace JSC;
35
36 namespace Inspector {
37
38 InspectorHeapAgent::InspectorHeapAgent(AgentContext& context)
39     : InspectorAgentBase(ASCIILiteral("Heap"))
40     , m_frontendDispatcher(std::make_unique<HeapFrontendDispatcher>(context.frontendRouter))
41     , m_backendDispatcher(HeapBackendDispatcher::create(context.backendDispatcher, this))
42     , m_environment(context.environment)
43 {
44 }
45
46 InspectorHeapAgent::~InspectorHeapAgent()
47 {
48 }
49
50 void InspectorHeapAgent::didCreateFrontendAndBackend(FrontendRouter*, BackendDispatcher*)
51 {
52 }
53
54 void InspectorHeapAgent::willDestroyFrontendAndBackend(DisconnectReason)
55 {
56     ErrorString ignored;
57     disable(ignored);
58 }
59
60 void InspectorHeapAgent::enable(ErrorString&)
61 {
62     if (m_enabled)
63         return;
64
65     m_enabled = true;
66
67     m_environment.vm().heap.addObserver(this);
68 }
69
70 void InspectorHeapAgent::disable(ErrorString&)
71 {
72     if (!m_enabled)
73         return;
74
75     m_enabled = false;
76
77     m_environment.vm().heap.removeObserver(this);
78 }
79
80 void InspectorHeapAgent::gc(ErrorString&)
81 {
82     VM& vm = m_environment.vm();
83     JSLockHolder lock(vm);
84     sanitizeStackForVM(&vm);
85     vm.heap.collectAllGarbage();
86 }
87
88 static Inspector::Protocol::Heap::GarbageCollection::Type protocolTypeForHeapOperation(HeapOperation operation)
89 {
90     switch (operation) {
91     case FullCollection:
92         return Inspector::Protocol::Heap::GarbageCollection::Type::Full;
93     case EdenCollection:
94         return Inspector::Protocol::Heap::GarbageCollection::Type::Partial;
95     default:
96         ASSERT_NOT_REACHED();
97         return Inspector::Protocol::Heap::GarbageCollection::Type::Full;
98     }
99 }
100
101 void InspectorHeapAgent::willGarbageCollect()
102 {
103     ASSERT(m_enabled);
104     ASSERT(std::isnan(m_gcStartTime));
105
106     m_gcStartTime = m_environment.executionStopwatch()->elapsedTime();
107 }
108
109 void InspectorHeapAgent::didGarbageCollect(HeapOperation operation)
110 {
111     ASSERT(m_enabled);
112     ASSERT(!std::isnan(m_gcStartTime));
113
114     // FIXME: Include number of bytes freed by collection.
115
116     double startTime = m_gcStartTime;
117     double endTime = m_environment.executionStopwatch()->elapsedTime();
118
119     // Dispatch the event asynchronously because this method may be
120     // called between collection and sweeping and we don't want to
121     // create unexpected JavaScript allocations that the Sweeper does
122     // not expect to encounter. JavaScript allocations could happen
123     // with WebKitLegacy's in process inspector which shares the same
124     // VM as the inspected page.
125
126     RunLoop::current().dispatch([this, startTime, endTime, operation]() {
127         auto collection = Inspector::Protocol::Heap::GarbageCollection::create()
128             .setType(protocolTypeForHeapOperation(operation))
129             .setStartTime(startTime)
130             .setEndTime(endTime)
131             .release();
132
133         m_frontendDispatcher->garbageCollected(WTFMove(collection));
134     });
135
136     m_gcStartTime = NAN;
137 }
138
139 } // namespace Inspector