.: Replace "Apple Computer, Inc." with "Apple Inc." in copyright headers
[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
35 using namespace JSC;
36
37 namespace WebCore {
38
39 static void collect(void*)
40 {
41     JSLockHolder lock(JSDOMWindow::commonVM());
42     JSDOMWindow::commonVM().heap.collectAllGarbage();
43 }
44
45 GCController& gcController()
46 {
47     DEPRECATED_DEFINE_STATIC_LOCAL(GCController, staticGCController, ());
48     return staticGCController;
49 }
50
51 GCController::GCController()
52 #if !USE(CF)
53     : m_GCTimer(this, &GCController::gcTimerFired)
54 #endif
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     if (!m_GCTimer.isActive())
70         m_GCTimer.startOneShot(0);
71 #endif
72 }
73
74 #if !USE(CF)
75 void GCController::gcTimerFired(Timer<GCController>*)
76 {
77     collect(nullptr);
78 }
79 #endif
80
81 void GCController::garbageCollectNow()
82 {
83     JSLockHolder lock(JSDOMWindow::commonVM());
84     if (!JSDOMWindow::commonVM().heap.isBusy())
85         JSDOMWindow::commonVM().heap.collectAllGarbage();
86 }
87
88 void GCController::garbageCollectOnAlternateThreadForDebugging(bool waitUntilDone)
89 {
90     ThreadIdentifier threadID = createThread(collect, 0, "WebCore: GCController");
91
92     if (waitUntilDone) {
93         waitForThreadCompletion(threadID);
94         return;
95     }
96
97     detachThread(threadID);
98 }
99
100 void GCController::releaseExecutableMemory()
101 {
102     JSLockHolder lock(JSDOMWindow::commonVM());
103
104     // We shouldn't have any JavaScript running on our stack when this function is called.
105     // The following line asserts that, but to be safe we check this in release builds anyway.
106     ASSERT(!JSDOMWindow::commonVM().entryScope);
107     if (JSDOMWindow::commonVM().entryScope)
108         return;
109
110     JSDOMWindow::commonVM().releaseExecutableMemory();
111 }
112
113 void GCController::setJavaScriptGarbageCollectorTimerEnabled(bool enable)
114 {
115     JSDOMWindow::commonVM().heap.setGarbageCollectionTimerEnabled(enable);
116 }
117
118 void GCController::discardAllCompiledCode()
119 {
120     JSLockHolder lock(JSDOMWindow::commonVM());
121     JSDOMWindow::commonVM().discardAllCode();
122 }
123
124 } // namespace WebCore