mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-07-28 19:59:17 +00:00
LibWeb+WebWorker: Use IPC mechanics for structured serialization
Our structured serialization implementation had its own bespoke encoder and decoder to serialize JS values. It also used a u32 buffer under the hood, which made using its structures a bit awkward. We had previously worked around its data structures in transferable streams, which nested transfers of MessagePort instances. We basically had to add hooks into the MessagePort to route to the correct transfer receiving steps, and we could not invoke the correct AOs directly as the spec dictates. We now use IPC mechanics to encode and decode data. This works because, although we are encoding JS values, we are only ultimately encoding primitive and basic AK types. The resulting data structures actually enforce that we implement transferable streams exactly as the spec is worded (I had planned to do that in a separate commit, but the fallout of this patch actually required that change).
This commit is contained in:
Timothy Flynn
Tim Flynn
parent
7fad8c333d
commit
64abc6101d
Notes:
github-actions[bot]
2025-07-18 14:10:44 +00:00
Author: https://github.com/trflynn89
Commit: 64abc6101d
Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/5492
Reviewed-by: https://github.com/ADKaster
Reviewed-by: https://github.com/shannonbooth
44 changed files with 765 additions and 970 deletions
|
|
@ -8,30 +8,66 @@
|
|||
|
||||
#pragma once
|
||||
|
||||
#include <AK/Result.h>
|
||||
#include <AK/Types.h>
|
||||
#include <AK/MemoryStream.h>
|
||||
#include <AK/Vector.h>
|
||||
#include <LibIPC/Forward.h>
|
||||
#include <LibIPC/Decoder.h>
|
||||
#include <LibIPC/Encoder.h>
|
||||
#include <LibIPC/Message.h>
|
||||
#include <LibJS/Forward.h>
|
||||
#include <LibWeb/Forward.h>
|
||||
#include <LibWeb/HTML/StructuredSerializeTypes.h>
|
||||
#include <LibWeb/WebIDL/ExceptionOr.h>
|
||||
|
||||
// Structured serialize is an entirely different format from IPC because:
|
||||
// - It contains representation of type information
|
||||
// - It may contain circularities
|
||||
// - It is restricted to JS values
|
||||
|
||||
namespace Web::HTML {
|
||||
|
||||
struct TransferDataHolder {
|
||||
Vector<u32> data;
|
||||
Vector<IPC::File> fds;
|
||||
class TransferDataEncoder {
|
||||
public:
|
||||
explicit TransferDataEncoder();
|
||||
explicit TransferDataEncoder(IPC::MessageBuffer&&);
|
||||
|
||||
template<typename T>
|
||||
void encode(T const& value)
|
||||
{
|
||||
MUST(m_encoder.encode(value));
|
||||
}
|
||||
|
||||
void append(SerializationRecord&&);
|
||||
void extend(Vector<TransferDataEncoder>);
|
||||
|
||||
IPC::MessageBuffer const& buffer() const { return m_buffer; }
|
||||
IPC::MessageBuffer take_buffer() { return move(m_buffer); }
|
||||
|
||||
private:
|
||||
IPC::MessageBuffer m_buffer;
|
||||
IPC::Encoder m_encoder;
|
||||
};
|
||||
|
||||
class TransferDataDecoder {
|
||||
public:
|
||||
explicit TransferDataDecoder(SerializationRecord const&);
|
||||
explicit TransferDataDecoder(TransferDataEncoder&&);
|
||||
|
||||
template<typename T>
|
||||
T decode()
|
||||
{
|
||||
static_assert(!IsSame<T, ByteBuffer>, "Use decode_buffer to handle OOM");
|
||||
return MUST(m_decoder.decode<T>());
|
||||
}
|
||||
|
||||
WebIDL::ExceptionOr<ByteBuffer> decode_buffer(JS::Realm&);
|
||||
|
||||
private:
|
||||
IPC::MessageBuffer m_buffer;
|
||||
|
||||
FixedMemoryStream m_stream;
|
||||
Queue<IPC::File> m_files;
|
||||
|
||||
IPC::Decoder m_decoder;
|
||||
};
|
||||
|
||||
struct SerializedTransferRecord {
|
||||
SerializationRecord serialized;
|
||||
Vector<TransferDataHolder> transfer_data_holders;
|
||||
Vector<TransferDataEncoder> transfer_data_holders;
|
||||
};
|
||||
|
||||
struct DeserializedTransferRecord {
|
||||
|
|
@ -39,100 +75,31 @@ struct DeserializedTransferRecord {
|
|||
Vector<GC::Root<JS::Object>> transferred_values;
|
||||
};
|
||||
|
||||
struct DeserializedRecord {
|
||||
Optional<JS::Value> value;
|
||||
size_t position;
|
||||
};
|
||||
WebIDL::ExceptionOr<SerializationRecord> structured_serialize(JS::VM&, JS::Value);
|
||||
WebIDL::ExceptionOr<SerializationRecord> structured_serialize_for_storage(JS::VM&, JS::Value);
|
||||
WebIDL::ExceptionOr<SerializationRecord> structured_serialize_internal(JS::VM&, JS::Value, bool for_storage, SerializationMemory&);
|
||||
|
||||
WebIDL::ExceptionOr<SerializationRecord> structured_serialize(JS::VM& vm, JS::Value);
|
||||
WebIDL::ExceptionOr<SerializationRecord> structured_serialize_for_storage(JS::VM& vm, JS::Value);
|
||||
WebIDL::ExceptionOr<SerializationRecord> structured_serialize_internal(JS::VM& vm, JS::Value, bool for_storage, SerializationMemory&);
|
||||
WebIDL::ExceptionOr<JS::Value> structured_deserialize(JS::VM&, SerializationRecord const&, JS::Realm&, Optional<DeserializationMemory> = {});
|
||||
WebIDL::ExceptionOr<JS::Value> structured_deserialize_internal(JS::VM&, TransferDataDecoder&, JS::Realm&, DeserializationMemory&);
|
||||
|
||||
WebIDL::ExceptionOr<JS::Value> structured_deserialize(JS::VM& vm, SerializationRecord const& serialized, JS::Realm& target_realm, Optional<DeserializationMemory> = {});
|
||||
WebIDL::ExceptionOr<DeserializedRecord> structured_deserialize_internal(JS::VM& vm, ReadonlySpan<u32> const& serialized, JS::Realm& target_realm, DeserializationMemory& memory, Optional<size_t> position = {});
|
||||
|
||||
void serialize_boolean_primitive(SerializationRecord& serialized, JS::Value& value);
|
||||
void serialize_number_primitive(SerializationRecord& serialized, JS::Value& value);
|
||||
WebIDL::ExceptionOr<void> serialize_big_int_primitive(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);
|
||||
WebIDL::ExceptionOr<void> serialize_string_primitive(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);
|
||||
void serialize_boolean_object(SerializationRecord& serialized, JS::Value& value);
|
||||
void serialize_number_object(SerializationRecord& serialized, JS::Value& value);
|
||||
WebIDL::ExceptionOr<void> serialize_big_int_object(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);
|
||||
WebIDL::ExceptionOr<void> serialize_string_object(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);
|
||||
void serialize_date_object(SerializationRecord& serialized, JS::Value& value);
|
||||
WebIDL::ExceptionOr<void> serialize_reg_exp_object(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);
|
||||
|
||||
template<typename T>
|
||||
requires(IsIntegral<T> || IsFloatingPoint<T>)
|
||||
void serialize_primitive_type(SerializationRecord& serialized, T value)
|
||||
{
|
||||
if constexpr (sizeof(T) < sizeof(u32)) {
|
||||
// NOTE: If the value is smaller than a u32, we can just store it directly.
|
||||
serialized.append(static_cast<u32>(value));
|
||||
return;
|
||||
}
|
||||
serialized.append(bit_cast<u32*>(&value), sizeof(T) / 4);
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
requires(IsEnum<T>)
|
||||
void serialize_enum(SerializationRecord& serialized, T value)
|
||||
{
|
||||
serialize_primitive_type<UnderlyingType<T>>(serialized, to_underlying(value));
|
||||
}
|
||||
|
||||
WebIDL::ExceptionOr<void> serialize_bytes(JS::VM& vm, Vector<u32>& vector, ReadonlyBytes bytes);
|
||||
WebIDL::ExceptionOr<void> serialize_string(JS::VM& vm, Vector<u32>& vector, StringView);
|
||||
WebIDL::ExceptionOr<void> serialize_string(JS::VM& vm, Vector<u32>& vector, String const& string);
|
||||
WebIDL::ExceptionOr<void> serialize_string(JS::VM& vm, Vector<u32>& vector, JS::PrimitiveString const& primitive_string);
|
||||
WebIDL::ExceptionOr<void> serialize_array_buffer(JS::VM& vm, Vector<u32>& vector, JS::ArrayBuffer const& array_buffer, bool for_storage);
|
||||
template<OneOf<JS::TypedArrayBase, JS::DataView> ViewType>
|
||||
WebIDL::ExceptionOr<void> serialize_viewed_array_buffer(JS::VM& vm, Vector<u32>& vector, ViewType const& view, bool for_storage, SerializationMemory& memory);
|
||||
|
||||
bool deserialize_boolean_primitive(ReadonlySpan<u32> const& serialized, size_t& position);
|
||||
double deserialize_number_primitive(ReadonlySpan<u32> const& serialized, size_t& position);
|
||||
GC::Ref<JS::BooleanObject> deserialize_boolean_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);
|
||||
GC::Ref<JS::NumberObject> deserialize_number_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);
|
||||
WebIDL::ExceptionOr<GC::Ref<JS::BigIntObject>> deserialize_big_int_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);
|
||||
WebIDL::ExceptionOr<GC::Ref<JS::StringObject>> deserialize_string_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);
|
||||
GC::Ref<JS::Date> deserialize_date_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);
|
||||
WebIDL::ExceptionOr<GC::Ref<JS::RegExpObject>> deserialize_reg_exp_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);
|
||||
|
||||
template<typename T>
|
||||
requires(IsIntegral<T> || IsFloatingPoint<T> || IsEnum<T>)
|
||||
T deserialize_primitive_type(ReadonlySpan<u32> const& serialized, size_t& position)
|
||||
{
|
||||
T value;
|
||||
// NOTE: Make sure we always round up, otherwise Ts that are less than 32 bit will end up with a size of 0.
|
||||
auto size = 1 + ((sizeof(value) - 1) / 4);
|
||||
VERIFY(position + size <= serialized.size());
|
||||
memcpy(&value, serialized.offset_pointer(position), sizeof(value));
|
||||
position += size;
|
||||
return value;
|
||||
}
|
||||
|
||||
WebIDL::ExceptionOr<ByteBuffer> deserialize_bytes(JS::VM& vm, ReadonlySpan<u32> vector, size_t& position);
|
||||
WebIDL::ExceptionOr<String> deserialize_string(JS::VM& vm, ReadonlySpan<u32> vector, size_t& position);
|
||||
WebIDL::ExceptionOr<GC::Ref<JS::PrimitiveString>> deserialize_string_primitive(JS::VM& vm, ReadonlySpan<u32> vector, size_t& position);
|
||||
WebIDL::ExceptionOr<GC::Ref<JS::BigInt>> deserialize_big_int_primitive(JS::VM& vm, ReadonlySpan<u32> vector, size_t& position);
|
||||
|
||||
WebIDL::ExceptionOr<SerializedTransferRecord> structured_serialize_with_transfer(JS::VM& vm, JS::Value value, Vector<GC::Root<JS::Object>> const& transfer_list);
|
||||
WebIDL::ExceptionOr<DeserializedTransferRecord> structured_deserialize_with_transfer(SerializedTransferRecord&, JS::Realm& target_realm);
|
||||
WebIDL::ExceptionOr<SerializedTransferRecord> structured_serialize_with_transfer(JS::VM&, JS::Value, Vector<GC::Root<JS::Object>> const& transfer_list);
|
||||
WebIDL::ExceptionOr<DeserializedTransferRecord> structured_deserialize_with_transfer(SerializedTransferRecord&, JS::Realm&);
|
||||
WebIDL::ExceptionOr<JS::Value> structured_deserialize_with_transfer_internal(TransferDataDecoder&, JS::Realm&);
|
||||
|
||||
}
|
||||
|
||||
namespace IPC {
|
||||
|
||||
template<>
|
||||
ErrorOr<void> encode(Encoder&, ::Web::HTML::SerializedTransferRecord const&);
|
||||
ErrorOr<void> encode(Encoder&, Web::HTML::TransferDataEncoder const&);
|
||||
|
||||
template<>
|
||||
ErrorOr<void> encode(Encoder&, ::Web::HTML::TransferDataHolder const&);
|
||||
ErrorOr<Web::HTML::TransferDataEncoder> decode(Decoder&);
|
||||
|
||||
template<>
|
||||
ErrorOr<::Web::HTML::SerializedTransferRecord> decode(Decoder&);
|
||||
ErrorOr<void> encode(Encoder&, Web::HTML::SerializedTransferRecord const&);
|
||||
|
||||
template<>
|
||||
ErrorOr<::Web::HTML::TransferDataHolder> decode(Decoder&);
|
||||
ErrorOr<Web::HTML::SerializedTransferRecord> decode(Decoder&);
|
||||
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue