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