More stack limit and reserved zone renaming.
[WebKit-https.git] / Source / JavaScriptCore / interpreter / CLoopStack.cpp
1 /*
2  * Copyright (C) 2008, 2013-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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "CLoopStack.h"
31
32 #if !ENABLE(JIT)
33
34 #include "CLoopStackInlines.h"
35 #include "ConservativeRoots.h"
36 #include "Interpreter.h"
37 #include "JSCInlines.h"
38 #include "Options.h"
39 #include <wtf/Lock.h>
40
41 namespace JSC {
42
43 static size_t committedBytesCount = 0;
44
45 static size_t commitSize()
46 {
47     static size_t size = std::max<size_t>(16 * 1024, pageSize());
48     return size;
49 }
50
51 static StaticLock stackStatisticsMutex;
52
53 CLoopStack::CLoopStack(VM& vm)
54     : m_vm(vm)
55     , m_topCallFrame(vm.topCallFrame)
56     , m_end(0)
57     , m_softReservedZoneSizeInRegisters(0)
58 {
59     size_t capacity = Options::maxPerThreadStackUsage();
60     ASSERT(capacity && isPageAligned(capacity));
61
62     m_reservation = PageReservation::reserve(WTF::roundUpToMultipleOf(commitSize(), capacity), OSAllocator::JSVMStackPages);
63     setCLoopStackLimit(highAddress());
64     m_commitTop = highAddress();
65     
66     m_lastStackTop = baseOfStack();
67
68     m_topCallFrame = 0;
69 }
70
71 CLoopStack::~CLoopStack()
72 {
73     ptrdiff_t sizeToDecommit = reinterpret_cast<char*>(highAddress()) - reinterpret_cast<char*>(m_commitTop);
74     m_reservation.decommit(reinterpret_cast<void*>(m_commitTop), sizeToDecommit);
75     addToCommittedByteCount(-sizeToDecommit);
76     m_reservation.deallocate();
77 }
78
79 bool CLoopStack::grow(Register* newTopOfStack)
80 {
81     Register* newTopOfStackWithReservedZone = newTopOfStack - m_softReservedZoneSizeInRegisters;
82
83     // If we have already committed enough memory to satisfy this request,
84     // just update the end pointer and return.
85     if (newTopOfStackWithReservedZone >= m_commitTop) {
86         setCLoopStackLimit(newTopOfStack);
87         return true;
88     }
89
90     // Compute the chunk size of additional memory to commit, and see if we
91     // have it is still within our budget. If not, we'll fail to grow and
92     // return false.
93     ptrdiff_t delta = reinterpret_cast<char*>(m_commitTop) - reinterpret_cast<char*>(newTopOfStackWithReservedZone);
94     delta = WTF::roundUpToMultipleOf(commitSize(), delta);
95     Register* newCommitTop = m_commitTop - (delta / sizeof(Register));
96     if (newCommitTop < reservationTop())
97         return false;
98
99     // Otherwise, the growth is still within our budget. Commit it and return true.
100     m_reservation.commit(newCommitTop, delta);
101     addToCommittedByteCount(delta);
102     m_commitTop = newCommitTop;
103     setCLoopStackLimit(newTopOfStack);
104     return true;
105 }
106
107 void CLoopStack::gatherConservativeRoots(ConservativeRoots& conservativeRoots, JITStubRoutineSet& jitStubRoutines, CodeBlockSet& codeBlocks)
108 {
109     conservativeRoots.add(topOfStack() + 1, highAddress(), jitStubRoutines, codeBlocks);
110 }
111
112 void CLoopStack::sanitizeStack()
113 {
114 #if !ASAN_ENABLED
115     ASSERT(topOfStack() <= baseOfStack());
116     
117     if (m_lastStackTop < topOfStack()) {
118         char* begin = reinterpret_cast<char*>(m_lastStackTop + 1);
119         char* end = reinterpret_cast<char*>(topOfStack() + 1);
120         memset(begin, 0, end - begin);
121     }
122     
123     m_lastStackTop = topOfStack();
124 #endif
125 }
126
127 void CLoopStack::releaseExcessCapacity()
128 {
129     Register* highAddressWithReservedZone = highAddress() - m_softReservedZoneSizeInRegisters;
130     ptrdiff_t delta = reinterpret_cast<char*>(highAddressWithReservedZone) - reinterpret_cast<char*>(m_commitTop);
131     m_reservation.decommit(m_commitTop, delta);
132     addToCommittedByteCount(-delta);
133     m_commitTop = highAddressWithReservedZone;
134 }
135
136 void CLoopStack::addToCommittedByteCount(long byteCount)
137 {
138     LockHolder locker(stackStatisticsMutex);
139     ASSERT(static_cast<long>(committedBytesCount) + byteCount > -1);
140     committedBytesCount += byteCount;
141 }
142
143 void CLoopStack::setSoftReservedZoneSize(size_t reservedZoneSize)
144 {
145     m_softReservedZoneSizeInRegisters = reservedZoneSize / sizeof(Register);
146     if (m_commitTop >= (m_end + 1) - m_softReservedZoneSizeInRegisters)
147         grow(m_end + 1);
148 }
149
150 size_t CLoopStack::committedByteCount()
151 {
152     LockHolder locker(stackStatisticsMutex);
153     return committedBytesCount;
154 }
155
156 } // namespace JSC
157
158 #endif // !ENABLE(JIT)