1/*
2 * Copyright (C) 2017-2019 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#pragma once
27
28#include "CallFrame.h"
29#include "VM.h"
30#include <wtf/DoublyLinkedList.h>
31#include <wtf/Expected.h>
32#include <wtf/Lock.h>
33
34namespace JSC {
35
36class VMInspector {
37 WTF_MAKE_FAST_ALLOCATED;
38 WTF_MAKE_NONCOPYABLE(VMInspector);
39 VMInspector() = default;
40public:
41 enum class Error {
42 None,
43 TimedOut
44 };
45
46 typedef WTF::Locker<Lock> Locker;
47
48 static VMInspector& instance();
49
50 void add(VM*);
51 void remove(VM*);
52
53 Lock& getLock() { return m_lock; }
54
55 enum class FunctorStatus {
56 Continue,
57 Done
58 };
59
60 template <typename Functor>
61 void iterate(const Locker&, const Functor& functor) { iterate(functor); }
62
63 Expected<Locker, Error> lock(Seconds timeout = Seconds::infinity());
64
65 Expected<bool, Error> isValidExecutableMemory(const Locker&, void*);
66 Expected<CodeBlock*, Error> codeBlockForMachinePC(const Locker&, void*);
67
68 JS_EXPORT_PRIVATE static bool currentThreadOwnsJSLock(JSGlobalObject*);
69 JS_EXPORT_PRIVATE static void gc(JSGlobalObject*);
70 JS_EXPORT_PRIVATE static void edenGC(JSGlobalObject*);
71 JS_EXPORT_PRIVATE static bool isInHeap(Heap*, void*);
72 JS_EXPORT_PRIVATE static bool isValidCell(Heap*, JSCell*);
73 JS_EXPORT_PRIVATE static bool isValidCodeBlock(JSGlobalObject*, CodeBlock*);
74 JS_EXPORT_PRIVATE static CodeBlock* codeBlockForFrame(JSGlobalObject*, CallFrame* topCallFrame, unsigned frameNumber);
75 JS_EXPORT_PRIVATE static void dumpCallFrame(JSGlobalObject*, CallFrame*, unsigned framesToSkip = 0);
76 JS_EXPORT_PRIVATE static void dumpRegisters(CallFrame*);
77 JS_EXPORT_PRIVATE static void dumpStack(JSGlobalObject*, CallFrame* topCallFrame, unsigned framesToSkip = 0);
78 JS_EXPORT_PRIVATE static void dumpValue(JSValue);
79 JS_EXPORT_PRIVATE static void dumpCellMemory(JSCell*);
80 JS_EXPORT_PRIVATE static void dumpCellMemoryToStream(JSCell*, PrintStream&);
81 JS_EXPORT_PRIVATE static void dumpSubspaceHashes(VM*);
82
83 enum VerifierAction { ReleaseAssert, Custom };
84
85 using VerifyFunctor = bool(bool condition, const char* description, ...);
86 static bool unusedVerifier(bool, const char*, ...) { return false; }
87
88 template<VerifierAction, VerifyFunctor = unusedVerifier>
89 static bool verifyCellSize(VM&, JSCell*, size_t allocatorCellSize);
90
91 template<VerifierAction, VerifyFunctor = unusedVerifier>
92 static bool verifyCell(VM&, JSCell*);
93
94private:
95 template <typename Functor> void iterate(const Functor& functor)
96 {
97 for (VM* vm = m_vmList.head(); vm; vm = vm->next()) {
98 FunctorStatus status = functor(*vm);
99 if (status == FunctorStatus::Done)
100 return;
101 }
102 }
103
104 Lock m_lock;
105 DoublyLinkedList<VM> m_vmList;
106};
107
108} // namespace JSC
109