Source/WebCore/bindings/js/SerializedScriptValue.h

   1 /*
   2  * Copyright (C) 2009, 2013, 2016 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
  27 #pragma once
  28
  29 #include "ExceptionOr.h"
  30 #include "ImageBuffer.h"
  31 #include <JavaScriptCore/ArrayBuffer.h>
  32 #include <JavaScriptCore/JSCJSValue.h>
  33 #include <JavaScriptCore/Strong.h>
  34 #include <pal/SessionID.h>
  35 #include <wtf/Forward.h>
  36 #include <wtf/Function.h>
  37 #include <wtf/Gigacage.h>
  38 #include <wtf/text/WTFString.h>
  39
  40 typedef const struct OpaqueJSContext* JSContextRef;
  41 typedef const struct OpaqueJSValue* JSValueRef;
  42
  43 #if ENABLE(WEBASSEMBLY)
  44 namespace JSC { namespace Wasm {
  45 class Module;
  46 } }
  47 #endif
  48
  49 namespace WebCore {
  50
  51 class IDBValue;
  52 class ImageBitmap;
  53 class MessagePort;
  54 class SharedBuffer;
  55 enum class SerializationReturnCode;
  56
  57 enum class SerializationErrorMode { NonThrowing, Throwing };
  58 enum class SerializationContext { Default, WorkerPostMessage, WindowPostMessage };
  59
  60 using ArrayBufferContentsArray = Vector<JSC::ArrayBufferContents>;
  61 #if ENABLE(WEBASSEMBLY)
  62 using WasmModuleArray = Vector<RefPtr<JSC::Wasm::Module>>;
  63 #endif
  64
  65 class SerializedScriptValue : public ThreadSafeRefCounted<SerializedScriptValue> {
  66 public:
  67     WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(JSC::ExecState&, JSC::JSValue, SerializationErrorMode = SerializationErrorMode::Throwing);
  68
  69     WEBCORE_EXPORT static ExceptionOr<Ref<SerializedScriptValue>> create(JSC::ExecState&, JSC::JSValue, Vector<JSC::Strong<JSC::JSObject>>&& transfer, Vector<RefPtr<MessagePort>>&, SerializationContext = SerializationContext::Default);
  70
  71     WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(StringView);
  72     static Ref<SerializedScriptValue> adopt(Vector<uint8_t>&& buffer)
  73     {
  74         return adoptRef(*new SerializedScriptValue(WTFMove(buffer)));
  75     }
  76
  77     static Ref<SerializedScriptValue> nullValue();
  78
  79     WEBCORE_EXPORT JSC::JSValue deserialize(JSC::ExecState&, JSC::JSGlobalObject*, SerializationErrorMode = SerializationErrorMode::Throwing);
  80     WEBCORE_EXPORT JSC::JSValue deserialize(JSC::ExecState&, JSC::JSGlobalObject*, const Vector<RefPtr<MessagePort>>&, SerializationErrorMode = SerializationErrorMode::Throwing);
  81     JSC::JSValue deserialize(JSC::ExecState&, JSC::JSGlobalObject*, const Vector<RefPtr<MessagePort>>&, const Vector<String>& blobURLs, const Vector<String>& blobFilePaths, SerializationErrorMode = SerializationErrorMode::Throwing);
  82
  83     static uint32_t wireFormatVersion();
  84
  85     String toString();
  86
  87     // API implementation helpers. These don't expose special behavior for ArrayBuffers or MessagePorts.
  88     WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef, JSValueRef* exception);
  89     WEBCORE_EXPORT JSValueRef deserialize(JSContextRef, JSValueRef* exception);
  90
  91     const Vector<uint8_t>& data() const { return m_data; }
  92     bool hasBlobURLs() const { return !m_blobURLs.isEmpty(); }
  93
  94 #if ENABLE(INDEXED_DATABASE)
  95     Vector<String> blobURLsIsolatedCopy() const;
  96     void writeBlobsToDiskForIndexedDB(PAL::SessionID, CompletionHandler<void(IDBValue&&)>&&);
  97     IDBValue writeBlobsToDiskForIndexedDBSynchronously(PAL::SessionID);
  98 #endif // ENABLE(INDEXED_DATABASE)
  99
 100     static Ref<SerializedScriptValue> createFromWireBytes(Vector<uint8_t>&& data)
 101     {
 102         return adoptRef(*new SerializedScriptValue(WTFMove(data)));
 103     }
 104     const Vector<uint8_t>& toWireBytes() const { return m_data; }
 105
 106     template<class Encoder> void encode(Encoder&) const;
 107     template<class Decoder> static RefPtr<SerializedScriptValue> decode(Decoder&);
 108
 109     WEBCORE_EXPORT ~SerializedScriptValue();
 110
 111 private:
 112     WEBCORE_EXPORT SerializedScriptValue(Vector<unsigned char>&&);
 113     WEBCORE_EXPORT SerializedScriptValue(Vector<unsigned char>&&, std::unique_ptr<ArrayBufferContentsArray>);
 114     SerializedScriptValue(Vector<unsigned char>&&, const Vector<String>& blobURLs, std::unique_ptr<ArrayBufferContentsArray>, std::unique_ptr<ArrayBufferContentsArray> sharedBuffers, Vector<std::pair<std::unique_ptr<ImageBuffer>, bool>>&& imageBuffers
 115 #if ENABLE(WEBASSEMBLY)
 116         , std::unique_ptr<WasmModuleArray>
 117 #endif
 118         );
 119
 120     Vector<unsigned char> m_data;
 121     std::unique_ptr<ArrayBufferContentsArray> m_arrayBufferContentsArray;
 122     std::unique_ptr<ArrayBufferContentsArray> m_sharedBufferContentsArray;
 123     Vector<std::pair<std::unique_ptr<ImageBuffer>, bool>> m_imageBuffers;
 124 #if ENABLE(WEBASSEMBLY)
 125     std::unique_ptr<WasmModuleArray> m_wasmModulesArray;
 126 #endif
 127     Vector<String> m_blobURLs;
 128 };
 129
 130 template<class Encoder>
 131 void SerializedScriptValue::encode(Encoder& encoder) const
 132 {
 133     encoder << m_data;
 134
 135     auto hasArray = m_arrayBufferContentsArray && m_arrayBufferContentsArray->size();
 136     encoder << hasArray;
 137
 138     if (!hasArray)
 139         return;
 140
 141     encoder << static_cast<uint64_t>(m_arrayBufferContentsArray->size());
 142     for (const auto &arrayBufferContents : *m_arrayBufferContentsArray) {
 143         encoder << arrayBufferContents.sizeInBytes();
 144         encoder.encodeFixedLengthData(static_cast<const uint8_t*>(arrayBufferContents.data()), arrayBufferContents.sizeInBytes(), 1);
 145     }
 146 }
 147
 148 template<class Decoder>
 149 RefPtr<SerializedScriptValue> SerializedScriptValue::decode(Decoder& decoder)
 150 {
 151     Vector<uint8_t> data;
 152     if (!decoder.decode(data))
 153         return nullptr;
 154
 155     bool hasArray;
 156     if (!decoder.decode(hasArray))
 157         return nullptr;
 158
 159     if (!hasArray)
 160         return adoptRef(*new SerializedScriptValue(WTFMove(data)));
 161
 162     uint64_t arrayLength;
 163     if (!decoder.decode(arrayLength))
 164         return nullptr;
 165     ASSERT(arrayLength);
 166
 167     auto arrayBufferContentsArray = std::make_unique<ArrayBufferContentsArray>();
 168     while (arrayLength--) {
 169         unsigned bufferSize;
 170         if (!decoder.decode(bufferSize))
 171             return nullptr;
 172
 173         auto buffer = Gigacage::tryMalloc(Gigacage::Primitive, bufferSize);
 174         auto destructor = [] (void* ptr) {
 175             Gigacage::free(Gigacage::Primitive, ptr);
 176         };
 177         if (!decoder.decodeFixedLengthData(static_cast<uint8_t*>(buffer), bufferSize, 1)) {
 178             destructor(buffer);
 179             return nullptr;
 180         }
 181         arrayBufferContentsArray->append({ buffer, bufferSize, WTFMove(destructor) });
 182     }
 183
 184     return adoptRef(*new SerializedScriptValue(WTFMove(data), WTFMove(arrayBufferContentsArray)));
 185 }
 186
 187
 188 }