166bdb28937d8b900ebb249f4281d88b23457a65
[WebKit-https.git] / Source / JavaScriptCore / heap / MachineStackMarker.h
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003-2017 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Lesser General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Lesser General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Lesser General Public
17  *  License along with this library; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #pragma once
23
24 #include "MachineContext.h"
25 #include "RegisterState.h"
26 #include <wtf/DoublyLinkedList.h>
27 #include <wtf/Lock.h>
28 #include <wtf/Noncopyable.h>
29 #include <wtf/ScopedLambda.h>
30 #include <wtf/ThreadSpecific.h>
31
32 namespace JSC {
33
34 class CodeBlockSet;
35 class ConservativeRoots;
36 class Heap;
37 class JITStubRoutineSet;
38
39 struct CurrentThreadState {
40     void* stackOrigin { nullptr };
41     void* stackTop { nullptr };
42     RegisterState* registerState { nullptr };
43 };
44     
45 class MachineThreads {
46     WTF_MAKE_NONCOPYABLE(MachineThreads);
47 public:
48     MachineThreads();
49     ~MachineThreads();
50
51     void gatherConservativeRoots(ConservativeRoots&, JITStubRoutineSet&, CodeBlockSet&, CurrentThreadState*);
52
53     JS_EXPORT_PRIVATE void addCurrentThread(); // Only needs to be called by clients that can use the same heap from multiple threads.
54
55     class MachineThread : public DoublyLinkedListNode<MachineThread> {
56         WTF_MAKE_FAST_ALLOCATED;
57     public:
58         MachineThread();
59
60         struct Registers {
61             void* stackPointer() const;
62 #if ENABLE(SAMPLING_PROFILER)
63             void* framePointer() const;
64             void* instructionPointer() const;
65             void* llintPC() const;
66 #endif // ENABLE(SAMPLING_PROFILER)
67             PlatformRegisters regs;
68         };
69
70         Expected<void, Thread::PlatformSuspendError> suspend() { return m_thread->suspend(); }
71         void resume() { m_thread->resume(); }
72         size_t getRegisters(Registers& regs);
73         std::pair<void*, size_t> captureStack(void* stackTop);
74
75         WTF::ThreadIdentifier threadID() const { return m_thread->id(); }
76         void* stackBase() const { return m_stackBase; }
77         void* stackEnd() const { return m_stackEnd; }
78
79         Ref<WTF::Thread> m_thread;
80         void* m_stackBase;
81         void* m_stackEnd;
82         MachineThread* m_next { nullptr };
83         MachineThread* m_prev { nullptr };
84     };
85
86     Lock& getLock() { return m_registeredThreadsMutex; }
87     const DoublyLinkedList<MachineThread>& threadsListHead(const AbstractLocker&) const { ASSERT(m_registeredThreadsMutex.isLocked()); return m_registeredThreads; }
88     MachineThread* machineThreadForCurrentThread();
89
90 private:
91     void gatherFromCurrentThread(ConservativeRoots&, JITStubRoutineSet&, CodeBlockSet&, CurrentThreadState&);
92
93     void tryCopyOtherThreadStack(MachineThread*, void*, size_t capacity, size_t*);
94     bool tryCopyOtherThreadStacks(const AbstractLocker&, void*, size_t capacity, size_t*);
95
96     static void THREAD_SPECIFIC_CALL removeThread(void*);
97
98     void removeThreadIfFound(ThreadIdentifier);
99
100     Lock m_registeredThreadsMutex;
101     DoublyLinkedList<MachineThread> m_registeredThreads;
102     WTF::ThreadSpecificKey m_threadSpecificForMachineThreads;
103 };
104
105 #define DECLARE_AND_COMPUTE_CURRENT_THREAD_STATE(stateName) \
106     CurrentThreadState stateName; \
107     stateName.stackTop = &stateName; \
108     stateName.stackOrigin = wtfThreadData().stack().origin(); \
109     ALLOCATE_AND_GET_REGISTER_STATE(stateName ## _registerState); \
110     stateName.registerState = &stateName ## _registerState
111
112 // The return value is meaningless. We just use it to suppress tail call optimization.
113 int callWithCurrentThreadState(const ScopedLambda<void(CurrentThreadState&)>&);
114
115 } // namespace JSC
116