c0a2bc42aec4c100233aed6bc0c8c284035bb9f3
[WebKit-https.git] / Source / WebCore / bindings / js / GCController.cpp
1 /*
2  * Copyright (C) 2007, 2014 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 "GCController.h"
28
29 #include "JSDOMWindow.h"
30 #include <runtime/VM.h>
31 #include <runtime/JSLock.h>
32 #include <heap/Heap.h>
33 #include <wtf/StdLibExtras.h>
34 #include <wtf/FastMalloc.h>
35 #include <wtf/NeverDestroyed.h>
36
37 using namespace JSC;
38
39 namespace WebCore {
40
41 static void collect(void*)
42 {
43     JSLockHolder lock(JSDOMWindow::commonVM());
44     JSDOMWindow::commonVM().heap.collectAllGarbage();
45 }
46
47 GCController& GCController::singleton()
48 {
49     static NeverDestroyed<GCController> controller;
50     return controller;
51 }
52
53 GCController::GCController()
54     : m_GCTimer(*this, &GCController::gcTimerFired)
55 {
56 }
57
58 void GCController::garbageCollectSoon()
59 {
60     // We only use reportAbandonedObjectGraph on systems with CoreFoundation 
61     // since it uses a run-loop-based timer that is currently only available on
62     // systems with CoreFoundation. If and when the notion of a run loop is pushed 
63     // down into WTF so that more platforms can take advantage of it, we will be 
64     // able to use reportAbandonedObjectGraph on more platforms.
65 #if USE(CF)
66     JSLockHolder lock(JSDOMWindow::commonVM());
67     JSDOMWindow::commonVM().heap.reportAbandonedObjectGraph();
68 #else
69     garbageCollectOnNextRunLoop();
70 #endif
71 }
72
73 void GCController::garbageCollectOnNextRunLoop()
74 {
75     if (!m_GCTimer.isActive())
76         m_GCTimer.startOneShot(0);
77 }
78
79 void GCController::gcTimerFired()
80 {
81     collect(nullptr);
82 }
83
84 void GCController::garbageCollectNow()
85 {
86     JSLockHolder lock(JSDOMWindow::commonVM());
87     if (!JSDOMWindow::commonVM().heap.isBusy()) {
88         JSDOMWindow::commonVM().heap.collectAllGarbage();
89         WTF::releaseFastMallocFreeMemory();
90     }
91 }
92
93 void GCController::garbageCollectOnAlternateThreadForDebugging(bool waitUntilDone)
94 {
95     ThreadIdentifier threadID = createThread(collect, 0, "WebCore: GCController");
96
97     if (waitUntilDone) {
98         waitForThreadCompletion(threadID);
99         return;
100     }
101
102     detachThread(threadID);
103 }
104
105 void GCController::releaseExecutableMemory()
106 {
107     JSLockHolder lock(JSDOMWindow::commonVM());
108
109     // We shouldn't have any JavaScript running on our stack when this function is called.
110     // The following line asserts that, but to be safe we check this in release builds anyway.
111     ASSERT(!JSDOMWindow::commonVM().entryScope);
112     if (JSDOMWindow::commonVM().entryScope)
113         return;
114
115     JSDOMWindow::commonVM().releaseExecutableMemory();
116 }
117
118 void GCController::setJavaScriptGarbageCollectorTimerEnabled(bool enable)
119 {
120     JSDOMWindow::commonVM().heap.setGarbageCollectionTimerEnabled(enable);
121 }
122
123 void GCController::discardAllCompiledCode()
124 {
125     JSLockHolder lock(JSDOMWindow::commonVM());
126     JSDOMWindow::commonVM().discardAllCode();
127 }
128
129 } // namespace WebCore