MacroAssemblerCodeRef.h [plain text]
#pragma once
#include "ExecutableAllocator.h"
#include "JSCPoison.h"
#include <wtf/DataLog.h>
#include <wtf/PrintStream.h>
#include <wtf/RefPtr.h>
#include <wtf/text/CString.h>
#if CPU(ARM_THUMB2) && ENABLE(JIT)
#define ASSERT_VALID_CODE_POINTER(ptr) \
ASSERT(reinterpret_cast<intptr_t>(ptr) & ~1)
#define ASSERT_VALID_CODE_OFFSET(offset) \
ASSERT(!(offset & 1)) #else
#define ASSERT_VALID_CODE_POINTER(ptr) \
ASSERT(ptr)
#define ASSERT_VALID_CODE_OFFSET(offset) // Anything goes!
#endif
namespace JSC {
class MacroAssemblerCodePtr;
enum OpcodeID : unsigned;
class FunctionPtr {
public:
FunctionPtr() { }
template<typename returnType>
FunctionPtr(returnType(*value)())
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1>
FunctionPtr(returnType(*value)(argType1))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2>
FunctionPtr(returnType(*value)(argType1, argType2))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2, typename argType3>
FunctionPtr(returnType(*value)(argType1, argType2, argType3))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
FunctionPtr(returnType(*value)(argType1, argType2, argType3, argType4))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4, typename argType5>
FunctionPtr(returnType(*value)(argType1, argType2, argType3, argType4, argType5))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4, typename argType5, typename argType6>
FunctionPtr(returnType(*value)(argType1, argType2, argType3, argType4, argType5, argType6))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
#if CALLING_CONVENTION_IS_STDCALL && !OS(WINDOWS)
template<typename returnType>
FunctionPtr(returnType (CDECL *value)())
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1>
FunctionPtr(returnType (CDECL *value)(argType1))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2>
FunctionPtr(returnType (CDECL *value)(argType1, argType2))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2, typename argType3>
FunctionPtr(returnType (CDECL *value)(argType1, argType2, argType3))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
FunctionPtr(returnType (CDECL *value)(argType1, argType2, argType3, argType4))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
#endif
#if COMPILER_SUPPORTS(FASTCALL_CALLING_CONVENTION)
template<typename returnType>
FunctionPtr(returnType (FASTCALL *value)())
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1>
FunctionPtr(returnType (FASTCALL *value)(argType1))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2>
FunctionPtr(returnType (FASTCALL *value)(argType1, argType2))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2, typename argType3>
FunctionPtr(returnType (FASTCALL *value)(argType1, argType2, argType3))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
FunctionPtr(returnType (FASTCALL *value)(argType1, argType2, argType3, argType4))
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
#endif
template<typename FunctionType>
explicit FunctionPtr(FunctionType* value)
: m_value((void*)value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
explicit FunctionPtr(MacroAssemblerCodePtr);
void* value() const
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
return m_value;
}
void* executableAddress() const
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
return m_value;
}
private:
void* m_value { nullptr };
};
class ReturnAddressPtr {
public:
ReturnAddressPtr() { }
explicit ReturnAddressPtr(void* value)
: m_value(value)
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
explicit ReturnAddressPtr(FunctionPtr function)
: m_value(function.value())
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
void* value() const
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
return m_value;
}
void dump(PrintStream& out) const
{
out.print(RawPointer(m_value));
}
private:
void* m_value { nullptr };
};
class MacroAssemblerCodePtr {
public:
MacroAssemblerCodePtr() { }
explicit MacroAssemblerCodePtr(void* value)
#if CPU(ARM_THUMB2)
: m_value(reinterpret_cast<char*>(value) + 1)
#else
: m_value(value)
#endif
{
m_value.assertIsPoisoned();
ASSERT(value);
ASSERT_VALID_CODE_POINTER(m_value);
}
static MacroAssemblerCodePtr createFromExecutableAddress(void* value)
{
ASSERT(value);
ASSERT_VALID_CODE_POINTER(value);
MacroAssemblerCodePtr result;
result.m_value = PoisonedMasmPtr(value);
result.m_value.assertIsPoisoned();
return result;
}
static MacroAssemblerCodePtr createLLIntCodePtr(OpcodeID codeId);
explicit MacroAssemblerCodePtr(ReturnAddressPtr ra)
: m_value(ra.value())
{
ASSERT(ra.value());
m_value.assertIsPoisoned();
ASSERT_VALID_CODE_POINTER(m_value);
}
PoisonedMasmPtr poisonedPtr() const { return m_value; }
template<typename T = void*>
T executableAddress() const
{
m_value.assertIsPoisoned();
return m_value.unpoisoned<T>();
}
#if CPU(ARM_THUMB2)
template<typename T = void*>
T dataLocation() const
{
m_value.assertIsPoisoned();
ASSERT_VALID_CODE_POINTER(m_value);
return bitwise_cast<T>(m_value ? m_value.unpoisoned<char*>() - 1 : nullptr);
}
#else
template<typename T = void*>
T dataLocation() const
{
m_value.assertIsPoisoned();
ASSERT_VALID_CODE_POINTER(m_value);
return m_value.unpoisoned<T>();
}
#endif
bool operator!() const
{
#if ENABLE(POISON_ASSERTS)
if (!isEmptyValue() && !isDeletedValue())
m_value.assertIsPoisoned();
#endif
return !m_value;
}
explicit operator bool() const { return !(!*this); }
bool operator==(const MacroAssemblerCodePtr& other) const
{
#if ENABLE(POISON_ASSERTS)
if (!isEmptyValue() && !isDeletedValue())
m_value.assertIsPoisoned();
if (!other.isEmptyValue() && !other.isDeletedValue())
other.m_value.assertIsPoisoned();
#endif
return m_value == other.m_value;
}
template<typename T, typename = std::enable_if_t<!std::is_same<T, bool>::value>>
operator T() = delete;
void dumpWithName(const char* name, PrintStream& out) const;
void dump(PrintStream& out) const;
enum EmptyValueTag { EmptyValue };
enum DeletedValueTag { DeletedValue };
MacroAssemblerCodePtr(EmptyValueTag)
: m_value(emptyValue())
{ }
MacroAssemblerCodePtr(DeletedValueTag)
: m_value(deletedValue())
{ }
bool isEmptyValue() const { return m_value == emptyValue(); }
bool isDeletedValue() const { return m_value == deletedValue(); }
unsigned hash() const { return IntHash<uintptr_t>::hash(m_value.bits()); }
static void initialize();
private:
static PoisonedMasmPtr emptyValue() { return PoisonedMasmPtr(AlreadyPoisoned, 1); }
static PoisonedMasmPtr deletedValue() { return PoisonedMasmPtr(AlreadyPoisoned, 2); }
PoisonedMasmPtr m_value;
};
struct MacroAssemblerCodePtrHash {
static unsigned hash(const MacroAssemblerCodePtr& ptr) { return ptr.hash(); }
static bool equal(const MacroAssemblerCodePtr& a, const MacroAssemblerCodePtr& b)
{
return a == b;
}
static const bool safeToCompareToEmptyOrDeleted = true;
};
class MacroAssemblerCodeRef {
private:
explicit MacroAssemblerCodeRef(MacroAssemblerCodePtr codePtr)
: m_codePtr(codePtr)
{
ASSERT(m_codePtr);
}
public:
MacroAssemblerCodeRef()
{
}
MacroAssemblerCodeRef(Ref<ExecutableMemoryHandle>&& executableMemory)
: m_codePtr(executableMemory->start())
, m_executableMemory(WTFMove(executableMemory))
{
ASSERT(m_executableMemory->isManaged());
ASSERT(m_executableMemory->start());
ASSERT(m_codePtr);
}
static MacroAssemblerCodeRef createSelfManagedCodeRef(MacroAssemblerCodePtr codePtr)
{
return MacroAssemblerCodeRef(codePtr);
}
static MacroAssemblerCodeRef createLLIntCodeRef(OpcodeID codeId);
ExecutableMemoryHandle* executableMemory() const
{
return m_executableMemory.get();
}
MacroAssemblerCodePtr code() const
{
return m_codePtr;
}
size_t size() const
{
if (!m_executableMemory)
return 0;
return m_executableMemory->sizeInBytes();
}
bool tryToDisassemble(PrintStream& out, const char* prefix = "") const;
bool tryToDisassemble(const char* prefix = "") const;
JS_EXPORT_PRIVATE CString disassembly() const;
explicit operator bool() const { return !!m_codePtr; }
void dump(PrintStream& out) const;
private:
MacroAssemblerCodePtr m_codePtr;
RefPtr<ExecutableMemoryHandle> m_executableMemory;
};
inline FunctionPtr::FunctionPtr(MacroAssemblerCodePtr ptr)
: m_value(ptr.executableAddress())
{
PoisonedMasmPtr::assertIsNotPoisoned(m_value);
ASSERT_VALID_CODE_POINTER(m_value);
}
}
namespace WTF {
template<typename T> struct DefaultHash;
template<> struct DefaultHash<JSC::MacroAssemblerCodePtr> {
typedef JSC::MacroAssemblerCodePtrHash Hash;
};
template<typename T> struct HashTraits;
template<> struct HashTraits<JSC::MacroAssemblerCodePtr> : public CustomHashTraits<JSC::MacroAssemblerCodePtr> { };
}