RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 01:27:34 +00:00
Code Issues Activity Actions

LibIPC+LibC: Add and use a helper to encode/decoder container sizes

Browse source 
While refactoring the IPC encoders and decoders for fallibility, the
inconsistency in which we transfer container sizes was a frequent thing
to trip over. We currently transfer sizes as any of i32, u32, and u64.
This adds a helper to transfer sizes in one consistent way.

Two special cases here are DeprecatedString and Vector, whose encoding
is depended upon by netdb, so that is also updated here.
This commit is contained in:
Timothy Flynn 2023-01-04 07:08:29 -05:00 • committed by Linus Groh
parent 40165f5846
commit 7c6b5ed161
5 changed files with 48 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

19
Userland/Libraries/LibIPC/Encoder.cpp
View file

@ -10,6 +10,7 @@
#include <AK/DeprecatedString.h>
#include <AK/JsonObject.h>
#include <AK/JsonValue.h>
#include <AK/NumericLimits.h>
#include <AK/URL.h>
#include <LibCore/AnonymousBuffer.h>
#include <LibCore/DateTime.h>
@ -21,6 +22,13 @@
namespace IPC {
ErrorOr<void> Encoder::encode_size(size_t size)
{
if (static_cast<u64>(size) > static_cast<u64>(NumericLimits<u32>::max()))
return Error::from_string_literal("Container exceeds the maximum allowed size");
return encode(static_cast<u32>(size));
}
template<>
ErrorOr<void> encode(Encoder& encoder, float const& value)
{
@ -43,10 +51,11 @@ ErrorOr<void> encode(Encoder& encoder, StringView const& value)
template<>
ErrorOr<void> encode(Encoder& encoder, DeprecatedString const& value)
{
// NOTE: Do not change this encoding without also updating LibC/netdb.cpp.
if (value.is_null())
return encoder.encode(-1);
return encoder.encode(NumericLimits<u32>::max());
TRY(encoder.encode(static_cast<i32>(value.length())));
TRY(encoder.encode_size(value.length()));
TRY(encoder.encode(value.view()));
return {};
}
@ -54,7 +63,7 @@ ErrorOr<void> encode(Encoder& encoder, DeprecatedString const& value)
template<>
ErrorOr<void> encode(Encoder& encoder, ByteBuffer const& value)
{
TRY(encoder.encode(static_cast<i32>(value.size())));
TRY(encoder.encode_size(value.size()));
TRY(encoder.append(value.data(), value.size()));
return {};
}
@ -74,7 +83,7 @@ ErrorOr<void> encode(Encoder& encoder, URL const& value)
template<>
ErrorOr<void> encode(Encoder& encoder, Dictionary const& dictionary)
{
TRY(encoder.encode(static_cast<u64>(dictionary.size())));
TRY(encoder.encode_size(dictionary.size()));
TRY(dictionary.try_for_each_entry([&](auto const& key, auto const& value) -> ErrorOr<void> {
TRY(encoder.encode(key));
@ -109,7 +118,7 @@ ErrorOr<void> encode(Encoder& encoder, Core::AnonymousBuffer const& buffer)
TRY(encoder.encode(buffer.is_valid()));
if (buffer.is_valid()) {
TRY(encoder.encode(static_cast<u32>(buffer.size())));
TRY(encoder.encode_size(buffer.size()));
TRY(encoder.encode(IPC::File { buffer.fd() }));
}