blob: c6c27ed5c220af9fa2887b2753828456df502417 [file] [log] [blame]
/*
* Copyright (C) 2017-2022 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "CallFrame.h"
#include "VM.h"
#include <wtf/DoublyLinkedList.h>
#include <wtf/Expected.h>
#include <wtf/IterationStatus.h>
#include <wtf/Lock.h>
namespace JSC {
class VMInspector {
WTF_MAKE_FAST_ALLOCATED;
WTF_MAKE_NONCOPYABLE(VMInspector);
VMInspector() = default;
public:
enum class Error {
None,
TimedOut
};
static VMInspector& instance();
void add(VM*);
void remove(VM*);
ALWAYS_INLINE static bool isValidVM(VM* vm)
{
return vm == m_recentVM ? true : isValidVMSlow(vm);
}
Lock& getLock() WTF_RETURNS_LOCK(m_lock) { return m_lock; }
template <typename Functor> void iterate(const Functor& functor) WTF_REQUIRES_LOCK(m_lock)
{
for (VM* vm = m_vmList.head(); vm; vm = vm->next()) {
IterationStatus status = functor(*vm);
if (status == IterationStatus::Done)
return;
}
}
JS_EXPORT_PRIVATE static void forEachVM(Function<IterationStatus(VM&)>&&);
JS_EXPORT_PRIVATE static void dumpVMs();
Expected<bool, Error> isValidExecutableMemory(void*) WTF_REQUIRES_LOCK(m_lock);
Expected<CodeBlock*, Error> codeBlockForMachinePC(void*) WTF_REQUIRES_LOCK(m_lock);
JS_EXPORT_PRIVATE static bool currentThreadOwnsJSLock(VM*);
JS_EXPORT_PRIVATE static void gc(VM*);
JS_EXPORT_PRIVATE static void edenGC(VM*);
JS_EXPORT_PRIVATE static bool isInHeap(Heap*, void*);
JS_EXPORT_PRIVATE static bool isValidCell(Heap*, JSCell*);
JS_EXPORT_PRIVATE static bool isValidCodeBlock(VM*, CodeBlock*);
JS_EXPORT_PRIVATE static CodeBlock* codeBlockForFrame(VM*, CallFrame* topCallFrame, unsigned frameNumber);
JS_EXPORT_PRIVATE static void dumpCallFrame(VM*, CallFrame*, unsigned framesToSkip = 0);
JS_EXPORT_PRIVATE static void dumpRegisters(CallFrame*);
JS_EXPORT_PRIVATE static void dumpStack(VM*, CallFrame* topCallFrame, unsigned framesToSkip = 0);
JS_EXPORT_PRIVATE static void dumpValue(JSValue);
JS_EXPORT_PRIVATE static void dumpCellMemory(JSCell*);
JS_EXPORT_PRIVATE static void dumpCellMemoryToStream(JSCell*, PrintStream&);
JS_EXPORT_PRIVATE static void dumpSubspaceHashes(VM*);
#if USE(JSVALUE64)
static bool verifyCell(VM&, JSCell*);
#endif
private:
JS_EXPORT_PRIVATE static bool isValidVMSlow(VM*);
Lock m_lock;
DoublyLinkedList<VM> m_vmList WTF_GUARDED_BY_LOCK(m_lock);
JS_EXPORT_PRIVATE static VM* m_recentVM;
};
} // namespace JSC