ac08a2fae0d6d4925e83cdd9d1fdf91811d84165
[WebKit-https.git] / Source / JavaScriptCore / interpreter / CLoopStack.h
1 /*
2  * Copyright (C) 2008-2009, 2013-2014, 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 #pragma once
30
31 #if !ENABLE(JIT)
32
33 #include "Register.h"
34 #include <wtf/Noncopyable.h>
35 #include <wtf/PageReservation.h>
36 #include <wtf/VMTags.h>
37
38 namespace JSC {
39
40     class CodeBlockSet;
41     class ConservativeRoots;
42     class JITStubRoutineSet;
43     class VM;
44     class LLIntOffsetsExtractor;
45
46     class CLoopStack {
47         WTF_MAKE_NONCOPYABLE(CLoopStack);
48     public:
49         // Allow 8k of excess registers before we start trying to reap the stack
50         static const ptrdiff_t maxExcessCapacity = 8 * 1024;
51
52         CLoopStack(VM&);
53         ~CLoopStack();
54         
55         bool ensureCapacityFor(Register* newTopOfStack);
56
57         bool containsAddress(Register* address) { return (lowAddress() <= address && address < highAddress()); }
58         static size_t committedByteCount();
59
60         void gatherConservativeRoots(ConservativeRoots&, JITStubRoutineSet&, CodeBlockSet&);
61         void sanitizeStack();
62
63         Register* baseOfStack() const
64         {
65             return highAddress() - 1;
66         }
67
68         size_t size() const { return highAddress() - lowAddress(); }
69
70         void setReservedZoneSize(size_t);
71
72         inline Register* topOfStack();
73
74     private:
75
76         Register* lowAddress() const
77         {
78             return m_end + 1;
79         }
80
81         Register* highAddress() const
82         {
83             return reinterpret_cast_ptr<Register*>(static_cast<char*>(m_reservation.base()) + m_reservation.size());
84         }
85
86         inline Register* topOfFrameFor(CallFrame*);
87
88         Register* reservationTop() const
89         {
90             char* reservationTop = static_cast<char*>(m_reservation.base());
91             return reinterpret_cast_ptr<Register*>(reservationTop);
92         }
93
94         bool grow(Register* newTopOfStack);
95         void shrink(Register* newTopOfStack);
96         void releaseExcessCapacity();
97         void addToCommittedByteCount(long);
98
99         void setCLoopStackLimit(Register* newTopOfStack);
100
101         VM& m_vm;
102         CallFrame*& m_topCallFrame;
103         Register* m_end;
104         Register* m_commitTop;
105         PageReservation m_reservation;
106         Register* m_lastStackTop;
107         ptrdiff_t m_reservedZoneSizeInRegisters;
108
109         friend class LLIntOffsetsExtractor;
110     };
111
112 } // namespace JSC
113
114 #endif // !ENABLE(JIT)