Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enforce isolate lock and track allocations on v8 #2726

Merged
merged 2 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/workerd/api/node/zlib-util.h
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,6 @@ class ZlibUtil final: public jsg::Object {
class CompressionStream: public jsg::Object {
public:
explicit CompressionStream(ZlibMode _mode): context_(_mode) {}
CompressionStream() = default;
// TODO(soon): Find a way to add noexcept(false) to this destructor.
~CompressionStream();
KJ_DISALLOW_COPY_AND_MOVE(CompressionStream);
Expand Down
42 changes: 33 additions & 9 deletions src/workerd/api/streams/compression.c++
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,42 @@ void* CompressionAllocator::AllocForZlib(void* data, uInt items, uInt size) {
return AllocForBrotli(data, real_size);
}

// TODO(soon): Enabling V8 reporting breaks CompressionStreamImpl on edgeworker. Investigate.
// This is mostly likely due to running CompressionStream without an isolate lock.
void* CompressionAllocator::AllocForBrotli(void* opaque, size_t size) {
auto* thisAllocator = static_cast<CompressionAllocator*>(opaque);
auto data = kj::heapArray<uint8_t>(size);
auto* allocator = static_cast<CompressionAllocator*>(opaque);
auto data = kj::heapArray<kj::byte>(size);
auto begin = data.begin();
thisAllocator->allocations.insert(begin, kj::mv(data));
auto isolate = v8::Isolate::TryGetCurrent();
kj::Maybe<jsg::ExternalMemoryAdjustment> maybeMemoryAdjustment;
// TODO(soon): Improve this. We want to track external memory allocations
// with the v8 isolate so we can account for these as part of the isolate
// heap memory limits. However, we don't always have an isolate lock or
// current isolate when this is called so we can't just blindly try
// grabbing the isolate. For now we'll only be able to account for the
// allocations when we actually have an isolate. It's a bit tricky but
// we could possibly try implementing a deferred accounting adjustment?
// Basically, defer incrementing the memory allocation reported to the
// isolate until we have the isolate lock again? But that's a bit tricky
// if the adjustment is dropped before that happens. Will have to think
// through how best to approach that.
if (isolate != nullptr) {
auto& js = jsg::Lock::from(isolate);
maybeMemoryAdjustment = js.getExternalMemoryAdjustment(size);
}
allocator->allocations.insert(begin,
{
.data = kj::mv(data),
.memoryAdjustment = kj::mv(maybeMemoryAdjustment),
});
return begin;
}

void CompressionAllocator::FreeForZlib(void* opaque, void* pointer) {
if (KJ_UNLIKELY(pointer == nullptr)) return;
auto* thisAllocator = static_cast<CompressionAllocator*>(opaque);
JSG_REQUIRE(thisAllocator->allocations.erase(pointer), Error, "Zlib allocation should exist"_kj);
auto* allocator = static_cast<CompressionAllocator*>(opaque);
// No need to destroy memoryAdjustment here.
// Dropping the allocation from the hashmap will defer the adjustment
// until the isolate lock is held.
JSG_REQUIRE(allocator->allocations.erase(pointer), Error, "Zlib allocation should exist"_kj);
}

namespace {
Expand Down Expand Up @@ -138,6 +160,9 @@ public:
};
}

protected:
CompressionAllocator allocator;

private:
static int getWindowBits(kj::StringPtr format) {
// We use a windowBits value of 15 combined with the magic value
Expand All @@ -161,7 +186,6 @@ private:
Mode mode;
z_stream ctx = {};
kj::byte buffer[16384];
CompressionAllocator allocator;

// For the eponymous compatibility flag
ContextFlags strictCompression;
Expand Down Expand Up @@ -469,7 +493,7 @@ private:
};
} // namespace

jsg::Ref<CompressionStream> CompressionStream::constructor(jsg::Lock& js, kj::String format) {
jsg::Ref<CompressionStream> CompressionStream::constructor(kj::String format) {
JSG_REQUIRE(format == "deflate" || format == "gzip" || format == "deflate-raw", TypeError,
"The compression format must be either 'deflate', 'deflate-raw' or 'gzip'.");

Expand Down
15 changes: 6 additions & 9 deletions src/workerd/api/streams/compression.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,25 @@ namespace workerd::api {
// isolate pointer and use that to get the external memory adjustment.
class CompressionAllocator final {
public:
CompressionAllocator() = default;
void configure(z_stream* stream);

static void* AllocForZlib(void* data, uInt items, uInt size);
static void* AllocForBrotli(void* data, size_t size);
static void FreeForZlib(void* data, void* pointer);

private:
// TODO(soon): Use this instead of array<byte> after fixing edgeworker.
// struct Allocation {
// kj::Array<kj::byte> data;
// kj::Maybe<jsg::ExternalMemoryAdjustment> memoryAdjustment;
// };

kj::HashMap<void*, kj::Array<kj::byte>> allocations;
struct Allocation {
kj::Array<kj::byte> data;
kj::Maybe<jsg::ExternalMemoryAdjustment> memoryAdjustment = kj::none;
};
kj::HashMap<void*, Allocation> allocations;
};

class CompressionStream: public TransformStream {
public:
using TransformStream::TransformStream;

static jsg::Ref<CompressionStream> constructor(jsg::Lock& js, kj::String format);
static jsg::Ref<CompressionStream> constructor(kj::String format);

JSG_RESOURCE_TYPE(CompressionStream) {
JSG_INHERIT(TransformStream);
Expand Down
Loading