Source/JavaScriptCore/assembler/MacroAssemblerCodeRef.h

   1 /*
   2  * Copyright (C) 2009-2018 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 "ExecutableAllocator.h"
  29 #include "JSCPoison.h"
  30 #include "PtrTag.h"
  31 #include <wtf/DataLog.h>
  32 #include <wtf/PrintStream.h>
  33 #include <wtf/RefPtr.h>
  34 #include <wtf/text/CString.h>
  35
  36 // ASSERT_VALID_CODE_POINTER checks that ptr is a non-null pointer, and that it is a valid
  37 // instruction address on the platform (for example, check any alignment requirements).
  38 #if CPU(ARM_THUMB2) && ENABLE(JIT)
  39 // ARM instructions must be 16-bit aligned. Thumb2 code pointers to be loaded into
  40 // into the processor are decorated with the bottom bit set, while traditional ARM has
  41 // the lower bit clear. Since we don't know what kind of pointer, we check for both
  42 // decorated and undecorated null.
  43 #define ASSERT_VALID_CODE_POINTER(ptr) \
  44     ASSERT(reinterpret_cast<intptr_t>(ptr) & ~1)
  45 #define ASSERT_VALID_CODE_OFFSET(offset) \
  46     ASSERT(!(offset & 1)) // Must be multiple of 2.
  47 #else
  48 #define ASSERT_VALID_CODE_POINTER(ptr) \
  49     ASSERT(ptr)
  50 #define ASSERT_VALID_CODE_OFFSET(offset) // Anything goes!
  51 #endif
  52
  53 namespace JSC {
  54
  55 class MacroAssemblerCodePtr;
  56
  57 enum OpcodeID : unsigned;
  58
  59 // FunctionPtr:
  60 //
  61 // FunctionPtr should be used to wrap pointers to C/C++ functions in JSC
  62 // (particularly, the stub functions).
  63 class FunctionPtr {
  64 public:
  65     FunctionPtr() { }
  66
  67     template<typename ReturnType, typename... Arguments>
  68     FunctionPtr(ReturnType(*value)(Arguments...), PtrTag tag = SlowPathPtrTag)
  69         : m_value(tagCFunctionPtr<void*>(value, tag))
  70     {
  71         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
  72         ASSERT_VALID_CODE_POINTER(m_value);
  73     }
  74
  75 // MSVC doesn't seem to treat functions with different calling conventions as
  76 // different types; these methods already defined for fastcall, below.
  77 #if CALLING_CONVENTION_IS_STDCALL && !OS(WINDOWS)
  78
  79     template<typename ReturnType, typename... Arguments>
  80     FunctionPtr(ReturnType(CDECL *value)(Arguments...), PtrTag tag = SlowPathPtrTag)
  81         : m_value(tagCFunctionPtr<void*>(value, tag))
  82     {
  83         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
  84         ASSERT_VALID_CODE_POINTER(m_value);
  85     }
  86
  87 #endif // CALLING_CONVENTION_IS_STDCALL && !OS(WINDOWS)
  88
  89 #if COMPILER_SUPPORTS(FASTCALL_CALLING_CONVENTION)
  90
  91     template<typename ReturnType, typename... Arguments>
  92     FunctionPtr(ReturnType(FASTCALL *value)(Arguments...), PtrTag tag = SlowPathPtrTag)
  93         : m_value(tagCFunctionPtr<void*>(value, tag))
  94     {
  95         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
  96         ASSERT_VALID_CODE_POINTER(m_value);
  97     }
  98
  99 #endif // COMPILER_SUPPORTS(FASTCALL_CALLING_CONVENTION)
 100
 101     template<typename FunctionType>
 102     explicit FunctionPtr(FunctionType* value, PtrTag tag = SlowPathPtrTag)
 103         // Using a C-ctyle cast here to avoid compiler error on RVTC:
 104         // Error:  #694: reinterpret_cast cannot cast away const or other type qualifiers
 105         // (I guess on RVTC function pointers have a different constness to GCC/MSVC?)
 106         : m_value(tagCodePtr<void*>(value, tag))
 107     {
 108         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
 109         ASSERT_VALID_CODE_POINTER(m_value);
 110     }
 111
 112     explicit FunctionPtr(MacroAssemblerCodePtr);
 113
 114     void* value() const
 115     {
 116         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
 117         return removeCodePtrTag(m_value);
 118     }
 119     void* executableAddress() const
 120     {
 121         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
 122         return m_value;
 123     }
 124
 125 private:
 126     void* m_value { nullptr };
 127 };
 128
 129 // ReturnAddressPtr:
 130 //
 131 // ReturnAddressPtr should be used to wrap return addresses generated by processor
 132 // 'call' instructions exectued in JIT code.  We use return addresses to look up
 133 // exception and optimization information, and to repatch the call instruction
 134 // that is the source of the return address.
 135 class ReturnAddressPtr {
 136 public:
 137     ReturnAddressPtr() { }
 138
 139     explicit ReturnAddressPtr(void* value)
 140         : m_value(value)
 141     {
 142         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
 143         ASSERT_VALID_CODE_POINTER(m_value);
 144     }
 145
 146     explicit ReturnAddressPtr(FunctionPtr function)
 147         : m_value(function.value())
 148     {
 149         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
 150         ASSERT_VALID_CODE_POINTER(m_value);
 151     }
 152
 153     void* value() const
 154     {
 155         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
 156         return m_value;
 157     }
 158
 159     void dump(PrintStream& out) const
 160     {
 161         out.print(RawPointer(m_value));
 162     }
 163
 164 private:
 165     void* m_value { nullptr };
 166 };
 167
 168 // MacroAssemblerCodePtr:
 169 //
 170 // MacroAssemblerCodePtr should be used to wrap pointers to JIT generated code.
 171 class MacroAssemblerCodePtr {
 172 public:
 173     MacroAssemblerCodePtr() { }
 174
 175     explicit MacroAssemblerCodePtr(void* value)
 176 #if CPU(ARM_THUMB2)
 177         // Decorate the pointer as a thumb code pointer.
 178         : m_value(reinterpret_cast<char*>(value) + 1)
 179 #else
 180         : m_value(value)
 181 #endif
 182     {
 183         m_value.assertIsPoisoned();
 184         ASSERT(value);
 185         ASSERT_VALID_CODE_POINTER(m_value.unpoisoned());
 186     }
 187
 188     static MacroAssemblerCodePtr createFromExecutableAddress(void* value)
 189     {
 190         ASSERT(value);
 191         ASSERT_VALID_CODE_POINTER(value);
 192         MacroAssemblerCodePtr result;
 193         result.m_value = PoisonedMasmPtr(value);
 194         result.m_value.assertIsPoisoned();
 195         return result;
 196     }
 197
 198     static MacroAssemblerCodePtr createLLIntCodePtr(OpcodeID codeId);
 199
 200     explicit MacroAssemblerCodePtr(ReturnAddressPtr ra)
 201         : m_value(ra.value())
 202     {
 203         ASSERT(ra.value());
 204         m_value.assertIsPoisoned();
 205         ASSERT_VALID_CODE_POINTER(m_value.unpoisoned());
 206     }
 207
 208     PoisonedMasmPtr poisonedPtr() const { return m_value; }
 209
 210     template<typename T = void*>
 211     T executableAddress() const
 212     {
 213         m_value.assertIsPoisoned();
 214         return m_value.unpoisoned<T>();
 215     }
 216 #if CPU(ARM_THUMB2)
 217     // To use this pointer as a data address remove the decoration.
 218     template<typename T = void*>
 219     T dataLocation() const
 220     {
 221         m_value.assertIsPoisoned();
 222         ASSERT_VALID_CODE_POINTER(m_value.unpoisoned());
 223         return bitwise_cast<T>(m_value ? m_value.unpoisoned<char*>() - 1 : nullptr);
 224     }
 225 #else
 226     template<typename T = void*>
 227     T dataLocation() const
 228     {
 229         m_value.assertIsPoisoned();
 230         ASSERT_VALID_CODE_POINTER(m_value);
 231         return bitwise_cast<T>(m_value ? removeCodePtrTag(m_value.unpoisoned()) : nullptr);
 232     }
 233 #endif
 234
 235     bool operator!() const
 236     {
 237 #if ENABLE(POISON_ASSERTS)
 238         if (!isEmptyValue() && !isDeletedValue())
 239             m_value.assertIsPoisoned();
 240 #endif
 241         return !m_value;
 242     }
 243     explicit operator bool() const { return !(!*this); }
 244
 245     bool operator==(const MacroAssemblerCodePtr& other) const
 246     {
 247 #if ENABLE(POISON_ASSERTS)
 248         if (!isEmptyValue() && !isDeletedValue())
 249             m_value.assertIsPoisoned();
 250         if (!other.isEmptyValue() && !other.isDeletedValue())
 251             other.m_value.assertIsPoisoned();
 252 #endif
 253         return m_value == other.m_value;
 254     }
 255
 256     // Disallow any casting operations (except for booleans). Instead, the client
 257     // should be asking for poisonedPtr() or executableAddress() explicitly.
 258     template<typename T, typename = std::enable_if_t<!std::is_same<T, bool>::value>>
 259     operator T() = delete;
 260
 261     void dumpWithName(const char* name, PrintStream& out) const;
 262
 263     void dump(PrintStream& out) const;
 264
 265     enum EmptyValueTag { EmptyValue };
 266     enum DeletedValueTag { DeletedValue };
 267
 268     MacroAssemblerCodePtr(EmptyValueTag)
 269         : m_value(emptyValue())
 270     { }
 271
 272     MacroAssemblerCodePtr(DeletedValueTag)
 273         : m_value(deletedValue())
 274     { }
 275
 276     bool isEmptyValue() const { return m_value == emptyValue(); }
 277     bool isDeletedValue() const { return m_value == deletedValue(); }
 278
 279     unsigned hash() const { return IntHash<uintptr_t>::hash(m_value.bits()); }
 280
 281     static void initialize();
 282
 283 private:
 284     static PoisonedMasmPtr emptyValue() { return PoisonedMasmPtr(AlreadyPoisoned, 1); }
 285     static PoisonedMasmPtr deletedValue() { return PoisonedMasmPtr(AlreadyPoisoned, 2); }
 286
 287     PoisonedMasmPtr m_value;
 288 };
 289
 290 struct MacroAssemblerCodePtrHash {
 291     static unsigned hash(const MacroAssemblerCodePtr& ptr) { return ptr.hash(); }
 292     static bool equal(const MacroAssemblerCodePtr& a, const MacroAssemblerCodePtr& b)
 293     {
 294         return a == b;
 295     }
 296     static const bool safeToCompareToEmptyOrDeleted = true;
 297 };
 298
 299 // MacroAssemblerCodeRef:
 300 //
 301 // A reference to a section of JIT generated code.  A CodeRef consists of a
 302 // pointer to the code, and a ref pointer to the pool from within which it
 303 // was allocated.
 304 class MacroAssemblerCodeRef {
 305 private:
 306     // This is private because it's dangerous enough that we want uses of it
 307     // to be easy to find - hence the static create method below.
 308     explicit MacroAssemblerCodeRef(MacroAssemblerCodePtr codePtr)
 309         : m_codePtr(codePtr)
 310     {
 311         ASSERT(m_codePtr);
 312     }
 313
 314 public:
 315     MacroAssemblerCodeRef()
 316     {
 317     }
 318
 319     MacroAssemblerCodeRef(Ref<ExecutableMemoryHandle>&& executableMemory, PtrTag tag)
 320         : m_codePtr(tagCodePtr(executableMemory->start(), tag))
 321         , m_executableMemory(WTFMove(executableMemory))
 322     {
 323         ASSERT(m_executableMemory->isManaged());
 324         ASSERT(m_executableMemory->start());
 325         ASSERT(m_codePtr);
 326     }
 327
 328     // Use this only when you know that the codePtr refers to code that is
 329     // already being kept alive through some other means. Typically this means
 330     // that codePtr is immortal.
 331     static MacroAssemblerCodeRef createSelfManagedCodeRef(MacroAssemblerCodePtr codePtr)
 332     {
 333         return MacroAssemblerCodeRef(codePtr);
 334     }
 335
 336     // Helper for creating self-managed code refs from LLInt.
 337     static MacroAssemblerCodeRef createLLIntCodeRef(OpcodeID codeId);
 338
 339     ExecutableMemoryHandle* executableMemory() const
 340     {
 341         return m_executableMemory.get();
 342     }
 343
 344     MacroAssemblerCodePtr code() const
 345     {
 346         return m_codePtr;
 347     }
 348
 349     MacroAssemblerCodePtr retaggedCode(PtrTag oldTag, PtrTag newTag) const
 350     {
 351         return MacroAssemblerCodePtr(retagCodePtr(m_codePtr.executableAddress(), oldTag, newTag));
 352     }
 353
 354     size_t size() const
 355     {
 356         if (!m_executableMemory)
 357             return 0;
 358         return m_executableMemory->sizeInBytes();
 359     }
 360
 361     bool tryToDisassemble(PrintStream& out, const char* prefix = "") const;
 362
 363     bool tryToDisassemble(const char* prefix = "") const;
 364
 365     JS_EXPORT_PRIVATE CString disassembly() const;
 366
 367     explicit operator bool() const { return !!m_codePtr; }
 368
 369     void dump(PrintStream& out) const;
 370
 371 private:
 372     MacroAssemblerCodePtr m_codePtr;
 373     RefPtr<ExecutableMemoryHandle> m_executableMemory;
 374 };
 375
 376 inline FunctionPtr::FunctionPtr(MacroAssemblerCodePtr ptr)
 377     : m_value(ptr.executableAddress())
 378 {
 379     PoisonedMasmPtr::assertIsNotPoisoned(m_value);
 380     ASSERT_VALID_CODE_POINTER(m_value);
 381 }
 382
 383 } // namespace JSC
 384
 385 namespace WTF {
 386
 387 template<typename T> struct DefaultHash;
 388 template<> struct DefaultHash<JSC::MacroAssemblerCodePtr> {
 389     typedef JSC::MacroAssemblerCodePtrHash Hash;
 390 };
 391
 392 template<typename T> struct HashTraits;
 393 template<> struct HashTraits<JSC::MacroAssemblerCodePtr> : public CustomHashTraits<JSC::MacroAssemblerCodePtr> { };
 394
 395 } // namespace WTF