1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*
* Copyright (C) 2009, 2013, 2016 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 "Blob.h"
#include "DetachedRTCDataChannel.h"
#include "ExceptionOr.h"
#include <JavaScriptCore/ArrayBuffer.h>
#include <JavaScriptCore/JSCJSValue.h>
#include <JavaScriptCore/Strong.h>
#include <wtf/Forward.h>
#include <wtf/Function.h>
#include <wtf/Gigacage.h>
#include <wtf/text/WTFString.h>
#if ENABLE(MEDIA_STREAM)
#include "MediaStreamTrackDataHolder.h"
#endif
#if ENABLE(MEDIA_SOURCE_IN_WORKERS)
#include "MediaSourceHandle.h"
#endif
#if ENABLE(WEB_CODECS)
#include "WebCodecsAudioData.h"
#include "WebCodecsAudioInternalData.h"
#include "WebCodecsEncodedAudioChunk.h"
#include "WebCodecsEncodedVideoChunk.h"
#include "WebCodecsVideoFrame.h"
#endif
typedef const struct OpaqueJSContext* JSContextRef;
typedef const struct OpaqueJSValue* JSValueRef;
#if ENABLE(WEBASSEMBLY)
namespace JSC { namespace Wasm {
class Module;
class MemoryHandle;
} }
#endif
namespace JSC {
class ErrorInstance;
class JSGlobalObject;
}
namespace WebCore {
#if ENABLE(OFFSCREEN_CANVAS_IN_WORKERS)
class DetachedOffscreenCanvas;
class OffscreenCanvas;
#endif
class CryptoKey;
class IDBValue;
class MessagePort;
class DetachedImageBitmap;
class FragmentedSharedBuffer;
enum class SerializationReturnCode;
enum class SerializationErrorMode { NonThrowing, Throwing };
enum class SerializationContext { Default, WorkerPostMessage, WindowPostMessage, CloneAcrossWorlds };
enum class SerializationForStorage : bool { No, Yes };
using ArrayBufferContentsArray = Vector<JSC::ArrayBufferContents>;
#if ENABLE(WEBASSEMBLY)
using WasmModuleArray = Vector<RefPtr<JSC::Wasm::Module>>;
using WasmMemoryHandleArray = Vector<RefPtr<JSC::SharedArrayBufferContents>>;
#endif
struct ErrorInformation {
String errorTypeString;
String message;
unsigned line { 0 };
unsigned column { 0 };
String sourceURL;
String stack;
};
std::optional<ErrorInformation> extractErrorInformationFromErrorInstance(JSC::JSGlobalObject*, JSC::ErrorInstance&);
DECLARE_ALLOCATOR_WITH_HEAP_IDENTIFIER(SerializedScriptValue);
class SerializedScriptValue : public ThreadSafeRefCounted<SerializedScriptValue> {
WTF_MAKE_FAST_ALLOCATED_WITH_HEAP_IDENTIFIER(SerializedScriptValue);
public:
WEBCORE_EXPORT static ExceptionOr<Ref<SerializedScriptValue>> create(JSC::JSGlobalObject&, JSC::JSValue, Vector<JSC::Strong<JSC::JSObject>>&& transfer, Vector<Ref<MessagePort>>&, SerializationForStorage = SerializationForStorage::No, SerializationContext = SerializationContext::Default);
WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(JSC::JSGlobalObject&, JSC::JSValue, SerializationForStorage = SerializationForStorage::No, SerializationErrorMode = SerializationErrorMode::Throwing, SerializationContext = SerializationContext::Default);
static RefPtr<SerializedScriptValue> convert(JSC::JSGlobalObject& globalObject, JSC::JSValue value) { return create(globalObject, value, SerializationForStorage::Yes); }
WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(StringView);
static Ref<SerializedScriptValue> nullValue();
WEBCORE_EXPORT JSC::JSValue deserialize(JSC::JSGlobalObject&, JSC::JSGlobalObject*, SerializationErrorMode = SerializationErrorMode::Throwing, bool* didFail = nullptr);
WEBCORE_EXPORT JSC::JSValue deserialize(JSC::JSGlobalObject&, JSC::JSGlobalObject*, const Vector<Ref<MessagePort>>&, SerializationErrorMode = SerializationErrorMode::Throwing, bool* didFail = nullptr);
JSC::JSValue deserialize(JSC::JSGlobalObject&, JSC::JSGlobalObject*, const Vector<Ref<MessagePort>>&, const Vector<String>& blobURLs, const Vector<String>& blobFilePaths, SerializationErrorMode = SerializationErrorMode::Throwing, bool* didFail = nullptr);
WEBCORE_EXPORT String toString() const;
// API implementation helpers. These don't expose special behavior for ArrayBuffers or MessagePorts.
WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef, JSValueRef* exception);
WEBCORE_EXPORT JSValueRef deserialize(JSContextRef, JSValueRef* exception);
WEBCORE_EXPORT static Vector<uint8_t> serializeCryptoKey(JSContextRef, const WebCore::CryptoKey&);
bool hasBlobURLs() const { return !m_internals.blobHandles.isEmpty(); }
Vector<String> blobURLs() const;
Vector<URLKeepingBlobAlive> blobHandles() const { return crossThreadCopy(m_internals.blobHandles); }
void writeBlobsToDiskForIndexedDB(bool isEphemeral, CompletionHandler<void(IDBValue&&)>&&);
IDBValue writeBlobsToDiskForIndexedDBSynchronously(bool isEphemeral);
static Ref<SerializedScriptValue> createFromWireBytes(Vector<uint8_t>&& data)
{
return adoptRef(*new SerializedScriptValue(WTFMove(data)));
}
const Vector<uint8_t>& wireBytes() const { return m_internals.data; }
size_t memoryCost() const { return m_internals.memoryCost; }
WEBCORE_EXPORT ~SerializedScriptValue();
private:
friend struct IPC::ArgumentCoder<SerializedScriptValue, void>;
static ExceptionOr<Ref<SerializedScriptValue>> create(JSC::JSGlobalObject&, JSC::JSValue, Vector<JSC::Strong<JSC::JSObject>>&& transfer, Vector<Ref<MessagePort>>&, SerializationForStorage, SerializationErrorMode, SerializationContext);
WEBCORE_EXPORT SerializedScriptValue(Vector<unsigned char>&&, std::unique_ptr<ArrayBufferContentsArray>&& = nullptr
#if ENABLE(WEB_RTC)
, Vector<std::unique_ptr<DetachedRTCDataChannel>>&& = { }
#endif
#if ENABLE(MEDIA_SOURCE_IN_WORKERS)
, Vector<RefPtr<DetachedMediaSourceHandle>>&& = { }
#endif
#if ENABLE(WEB_CODECS)
, Vector<RefPtr<WebCodecsEncodedVideoChunkStorage>>&& = { }
, Vector<WebCodecsVideoFrameData>&& = { }
, Vector<RefPtr<WebCodecsEncodedAudioChunkStorage>>&& = { }
, Vector<WebCodecsAudioInternalData>&& = { }
#endif
#if ENABLE(MEDIA_STREAM)
, Vector<std::unique_ptr<MediaStreamTrackDataHolder>>&& = { }
#endif
);
SerializedScriptValue(Vector<unsigned char>&&, Vector<URLKeepingBlobAlive>&& blobHandles, std::unique_ptr<ArrayBufferContentsArray>, std::unique_ptr<ArrayBufferContentsArray> sharedBuffers, Vector<std::optional<DetachedImageBitmap>>&&
#if ENABLE(OFFSCREEN_CANVAS_IN_WORKERS)
, Vector<std::unique_ptr<DetachedOffscreenCanvas>>&& = { }
, Vector<RefPtr<OffscreenCanvas>>&& = { }
#endif
, Vector<Ref<MessagePort>>&& = { }
#if ENABLE(WEB_RTC)
, Vector<std::unique_ptr<DetachedRTCDataChannel>>&& = { }
#endif
#if ENABLE(MEDIA_SOURCE_IN_WORKERS)
, Vector<RefPtr<DetachedMediaSourceHandle>>&& = { }
#endif
#if ENABLE(WEBASSEMBLY)
, WasmModuleArray&& = { }
, std::unique_ptr<WasmMemoryHandleArray> = nullptr
#endif
#if ENABLE(WEB_CODECS)
, Vector<RefPtr<WebCodecsEncodedVideoChunkStorage>>&& = { }
, Vector<WebCodecsVideoFrameData>&& = { }
, Vector<RefPtr<WebCodecsEncodedAudioChunkStorage>>&& = { }
, Vector<WebCodecsAudioInternalData>&& = { }
#endif
#if ENABLE(MEDIA_STREAM)
, Vector<std::unique_ptr<MediaStreamTrackDataHolder>>&& = { }
#endif
);
size_t computeMemoryCost() const;
struct Internals {
Vector<unsigned char> data;
std::unique_ptr<ArrayBufferContentsArray> arrayBufferContentsArray;
#if ENABLE(WEB_RTC)
Vector<std::unique_ptr<DetachedRTCDataChannel>> detachedRTCDataChannels;
#endif
#if ENABLE(WEB_CODECS)
Vector<RefPtr<WebCodecsEncodedVideoChunkStorage>> serializedVideoChunks;
Vector<RefPtr<WebCodecsEncodedAudioChunkStorage>> serializedAudioChunks;
Vector<WebCodecsVideoFrameData> serializedVideoFrames { };
Vector<WebCodecsAudioInternalData> serializedAudioData { };
#endif
#if ENABLE(MEDIA_SOURCE_IN_WORKERS)
Vector<RefPtr<DetachedMediaSourceHandle>> detachedMediaSourceHandles { };
#endif
#if ENABLE(MEDIA_STREAM)
Vector<std::unique_ptr<MediaStreamTrackDataHolder>> serializedMediaStreamTracks { };
#endif
std::unique_ptr<ArrayBufferContentsArray> sharedBufferContentsArray { };
Vector<std::optional<DetachedImageBitmap>> detachedImageBitmaps { };
#if ENABLE(OFFSCREEN_CANVAS_IN_WORKERS)
Vector<std::unique_ptr<DetachedOffscreenCanvas>> detachedOffscreenCanvases { };
Vector<RefPtr<OffscreenCanvas>> inMemoryOffscreenCanvases { };
#endif
Vector<Ref<MessagePort>> inMemoryMessagePorts { };
#if ENABLE(WEBASSEMBLY)
std::unique_ptr<WasmModuleArray> wasmModulesArray { };
std::unique_ptr<WasmMemoryHandleArray> wasmMemoryHandlesArray { };
#endif
Vector<URLKeepingBlobAlive> blobHandles { };
size_t memoryCost { 0 };
};
friend struct IPC::ArgumentCoder<Internals, void>;
static Ref<SerializedScriptValue> create(Internals&& internals)
{
return adoptRef(*new SerializedScriptValue(WTFMove(internals)));
}
WEBCORE_EXPORT explicit SerializedScriptValue(Internals&&);
Internals m_internals;
};
}
|
