commit 6deae0fd90c1dbd10b0b9a4120ff4e3b06ecbfd3
parent 8b9b8eeb9849265df1e44309e39e010fef2147be
Author: Kagami Sascha Rosylight <krosylight@proton.me>
Date: Mon, 20 Oct 2025 23:41:17 +0000
Bug 1994230 - Part 3: Split Zlib algorithms to a separate file r=smaug
Differential Revision: https://phabricator.services.mozilla.com/D268588
Diffstat:
6 files changed, 511 insertions(+), 444 deletions(-)
diff --git a/dom/compression/CompressionStream.cpp b/dom/compression/CompressionStream.cpp
@@ -6,18 +6,12 @@
#include "mozilla/dom/CompressionStream.h"
-#include "CompressionStreamHelper.h"
+#include "FormatZlib.h"
#include "js/TypeDecls.h"
-#include "mozilla/Assertions.h"
-#include "mozilla/Attributes.h"
-#include "mozilla/dom/BufferSourceBinding.h"
-#include "mozilla/dom/BufferSourceBindingFwd.h"
#include "mozilla/dom/CompressionStreamBinding.h"
#include "mozilla/dom/ReadableStream.h"
#include "mozilla/dom/TextDecoderStream.h"
#include "mozilla/dom/TransformStream.h"
-#include "mozilla/dom/TransformerCallbackHelpers.h"
-#include "mozilla/dom/UnionTypes.h"
#include "mozilla/dom/WritableStream.h"
// See the zlib manual in https://www.zlib.net/manual.html or in
@@ -26,198 +20,6 @@
namespace mozilla::dom {
using namespace compression;
-class CompressionStreamAlgorithms : public TransformerAlgorithmsWrapper {
- public:
- NS_DECL_ISUPPORTS_INHERITED
- NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(CompressionStreamAlgorithms,
- TransformerAlgorithmsBase)
-
- static Result<already_AddRefed<CompressionStreamAlgorithms>, nsresult> Create(
- CompressionFormat format) {
- RefPtr<CompressionStreamAlgorithms> alg = new CompressionStreamAlgorithms();
- MOZ_TRY(alg->Init(format));
- return alg.forget();
- }
-
- private:
- CompressionStreamAlgorithms() = default;
-
- [[nodiscard]] nsresult Init(CompressionFormat format) {
- int8_t err = deflateInit2(&mZStream, Z_DEFAULT_COMPRESSION, Z_DEFLATED,
- ZLibWindowBits(format), 8 /* default memLevel */,
- Z_DEFAULT_STRATEGY);
- if (err == Z_MEM_ERROR) {
- return NS_ERROR_OUT_OF_MEMORY;
- }
- MOZ_ASSERT(err == Z_OK);
- return NS_OK;
- }
-
- // Step 3 of
- // https://wicg.github.io/compression/#dom-compressionstream-compressionstream
- // Let transformAlgorithm be an algorithm which takes a chunk argument and
- // runs the compress and enqueue a chunk algorithm with this and chunk.
- MOZ_CAN_RUN_SCRIPT
- void TransformCallbackImpl(JS::Handle<JS::Value> aChunk,
- TransformStreamDefaultController& aController,
- ErrorResult& aRv) override {
- AutoJSAPI jsapi;
- if (!jsapi.Init(aController.GetParentObject())) {
- aRv.ThrowUnknownError("Internal error");
- return;
- }
- JSContext* cx = jsapi.cx();
-
- // https://wicg.github.io/compression/#compress-and-enqueue-a-chunk
-
- // Step 1: If chunk is not a BufferSource type, then throw a TypeError.
- RootedUnion<OwningBufferSource> bufferSource(cx);
- if (!bufferSource.Init(cx, aChunk)) {
- aRv.MightThrowJSException();
- aRv.StealExceptionFromJSContext(cx);
- return;
- }
-
- // Step 2: Let buffer be the result of compressing chunk with cs's format
- // and context.
- // Step 3 - 5: (Done in CompressAndEnqueue)
- ProcessTypedArraysFixed(
- bufferSource,
- [&](const Span<uint8_t>& aData) MOZ_CAN_RUN_SCRIPT_BOUNDARY {
- CompressAndEnqueue(cx, aData, Flush::No, aController, aRv);
- });
- }
-
- // Step 4 of
- // https://wicg.github.io/compression/#dom-compressionstream-compressionstream
- // Let flushAlgorithm be an algorithm which takes no argument and runs the
- // compress flush and enqueue algorithm with this.
- MOZ_CAN_RUN_SCRIPT void FlushCallbackImpl(
- TransformStreamDefaultController& aController,
- ErrorResult& aRv) override {
- AutoJSAPI jsapi;
- if (!jsapi.Init(aController.GetParentObject())) {
- aRv.ThrowUnknownError("Internal error");
- return;
- }
- JSContext* cx = jsapi.cx();
-
- // https://wicg.github.io/compression/#compress-flush-and-enqueue
-
- // Step 1: Let buffer be the result of compressing an empty input with cs's
- // format and context, with the finish flag.
- // Step 2 - 4: (Done in CompressAndEnqueue)
- CompressAndEnqueue(cx, Span<const uint8_t>(), Flush::Yes, aController, aRv);
- }
-
- private:
- // Shared by:
- // https://wicg.github.io/compression/#compress-and-enqueue-a-chunk
- // https://wicg.github.io/compression/#compress-flush-and-enqueue
- MOZ_CAN_RUN_SCRIPT void CompressAndEnqueue(
- JSContext* aCx, Span<const uint8_t> aInput, Flush aFlush,
- TransformStreamDefaultController& aController, ErrorResult& aRv) {
- MOZ_ASSERT_IF(aFlush == Flush::Yes, !aInput.Length());
-
- mZStream.avail_in = aInput.Length();
- mZStream.next_in = const_cast<uint8_t*>(aInput.Elements());
-
- JS::RootedVector<JSObject*> array(aCx);
-
- do {
- static uint16_t kBufferSize = 16384;
- UniquePtr<uint8_t[], JS::FreePolicy> buffer(
- static_cast<uint8_t*>(JS_malloc(aCx, kBufferSize)));
- if (!buffer) {
- aRv.ThrowTypeError("Out of memory");
- return;
- }
-
- mZStream.avail_out = kBufferSize;
- mZStream.next_out = buffer.get();
-
- int8_t err = deflate(&mZStream, intoZLibFlush(aFlush));
-
- // From the manual: deflate() returns ...
- switch (err) {
- case Z_OK:
- case Z_STREAM_END:
- case Z_BUF_ERROR:
- // * Z_OK if some progress has been made
- // * Z_STREAM_END if all input has been consumed and all output has
- // been produced (only when flush is set to Z_FINISH)
- // * Z_BUF_ERROR if no progress is possible (for example avail_in or
- // avail_out was zero). Note that Z_BUF_ERROR is not fatal, and
- // deflate() can be called again with more input and more output space
- // to continue compressing.
- //
- // (But of course no input should be given after Z_FINISH)
- break;
- case Z_STREAM_ERROR:
- default:
- // * Z_STREAM_ERROR if the stream state was inconsistent
- // (which is fatal)
- MOZ_ASSERT_UNREACHABLE("Unexpected compression error code");
- aRv.ThrowTypeError("Unexpected compression error");
- return;
- }
-
- // Stream should end only when flushed, see above
- // The reverse is not true as zlib may have big data to be flushed that is
- // larger than the buffer size
- MOZ_ASSERT_IF(err == Z_STREAM_END, aFlush == Flush::Yes);
-
- // At this point we either exhausted the input or the output buffer
- MOZ_ASSERT(!mZStream.avail_in || !mZStream.avail_out);
-
- size_t written = kBufferSize - mZStream.avail_out;
- if (!written) {
- break;
- }
-
- // Step 3: If buffer is empty, return.
- // (We'll implicitly return when the array is empty.)
-
- // Step 4: Split buffer into one or more non-empty pieces and convert them
- // into Uint8Arrays.
- // (The buffer is 'split' by having a fixed sized buffer above.)
-
- JS::Rooted<JSObject*> view(aCx, nsJSUtils::MoveBufferAsUint8Array(
- aCx, written, std::move(buffer)));
- if (!view || !array.append(view)) {
- JS_ClearPendingException(aCx);
- aRv.ThrowTypeError("Out of memory");
- return;
- }
- } while (mZStream.avail_out == 0);
- // From the manual:
- // If deflate returns with avail_out == 0, this function must be called
- // again with the same value of the flush parameter and more output space
- // (updated avail_out)
-
- // Step 5: For each Uint8Array array, enqueue array in cs's transform.
- for (const auto& view : array) {
- JS::Rooted<JS::Value> value(aCx, JS::ObjectValue(*view));
- aController.Enqueue(aCx, value, aRv);
- if (aRv.Failed()) {
- return;
- }
- }
- }
-
- ~CompressionStreamAlgorithms() override { deflateEnd(&mZStream); };
-
- z_stream mZStream = {};
-};
-
-NS_IMPL_CYCLE_COLLECTION_INHERITED(CompressionStreamAlgorithms,
- TransformerAlgorithmsBase)
-NS_IMPL_ADDREF_INHERITED(CompressionStreamAlgorithms, TransformerAlgorithmsBase)
-NS_IMPL_RELEASE_INHERITED(CompressionStreamAlgorithms,
- TransformerAlgorithmsBase)
-NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(CompressionStreamAlgorithms)
-NS_INTERFACE_MAP_END_INHERITING(TransformerAlgorithmsBase)
-
NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(CompressionStream, mGlobal, mStream)
NS_IMPL_CYCLE_COLLECTING_ADDREF(CompressionStream)
NS_IMPL_CYCLE_COLLECTING_RELEASE(CompressionStream)
diff --git a/dom/compression/CompressionStreamHelper.h b/dom/compression/CompressionStreamHelper.h
@@ -1,58 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
-/* vim:set ts=2 sw=2 sts=2 et cindent: */
-/* This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-
-#ifndef DOM_COMPRESSION_STREAM_HELPER_H_
-#define DOM_COMPRESSION_STREAM_HELPER_H_
-
-#include "BaseAlgorithms.h"
-#include "mozilla/dom/CompressionStreamBinding.h"
-#include "zlib.h"
-
-namespace mozilla::dom::compression {
-
-inline uint8_t intoZLibFlush(Flush aFlush) {
- switch (aFlush) {
- case Flush::No: {
- return Z_NO_FLUSH;
- }
- case Flush::Yes: {
- return Z_FINISH;
- }
- default: {
- MOZ_ASSERT_UNREACHABLE("Unknown flush mode");
- return Z_NO_FLUSH;
- }
- }
-}
-
-// From the docs in
-// https://searchfox.org/mozilla-central/source/modules/zlib/src/zlib.h
-inline int8_t ZLibWindowBits(CompressionFormat format) {
- switch (format) {
- case CompressionFormat::Deflate:
- // The windowBits parameter is the base two logarithm of the window size
- // (the size of the history buffer). It should be in the range 8..15 for
- // this version of the library. Larger values of this parameter result
- // in better compression at the expense of memory usage.
- return 15;
- case CompressionFormat::Deflate_raw:
- // windowBits can also be –8..–15 for raw deflate. In this case,
- // -windowBits determines the window size.
- return -15;
- case CompressionFormat::Gzip:
- // windowBits can also be greater than 15 for optional gzip encoding.
- // Add 16 to windowBits to write a simple gzip header and trailer around
- // the compressed data instead of a zlib wrapper.
- return 31;
- default:
- MOZ_ASSERT_UNREACHABLE("Unknown compression format");
- return 0;
- }
-}
-
-} // namespace mozilla::dom::compression
-
-#endif // DOM_COMPRESSION_STREAM_HELPER_H_
diff --git a/dom/compression/DecompressionStream.cpp b/dom/compression/DecompressionStream.cpp
@@ -6,7 +6,8 @@
#include "mozilla/dom/DecompressionStream.h"
-#include "CompressionStreamHelper.h"
+#include "BaseAlgorithms.h"
+#include "FormatZlib.h"
#include "js/TypeDecls.h"
#include "mozilla/Assertions.h"
#include "mozilla/StaticPrefs_dom.h"
@@ -21,192 +22,6 @@
namespace mozilla::dom {
using namespace compression;
-// See the zlib manual in https://www.zlib.net/manual.html or in
-// https://searchfox.org/mozilla-central/source/modules/zlib/src/zlib.h
-class ZLibDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
- public:
- NS_DECL_ISUPPORTS_INHERITED
- NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ZLibDecompressionStreamAlgorithms,
- DecompressionStreamAlgorithms)
-
- static Result<already_AddRefed<ZLibDecompressionStreamAlgorithms>, nsresult>
- Create(CompressionFormat format) {
- RefPtr<ZLibDecompressionStreamAlgorithms> alg =
- new ZLibDecompressionStreamAlgorithms();
- MOZ_TRY(alg->Init(format));
- return alg.forget();
- }
-
- private:
- ZLibDecompressionStreamAlgorithms() = default;
-
- [[nodiscard]] nsresult Init(CompressionFormat format) {
- int8_t err = inflateInit2(&mZStream, ZLibWindowBits(format));
- if (err == Z_MEM_ERROR) {
- return NS_ERROR_OUT_OF_MEMORY;
- }
- MOZ_ASSERT(err == Z_OK);
- return NS_OK;
- }
-
- private:
- // Shared by:
- // https://wicg.github.io/compression/#decompress-and-enqueue-a-chunk
- // https://wicg.github.io/compression/#decompress-flush-and-enqueue
- // All data errors throw TypeError by step 2: If this results in an error,
- // then throw a TypeError.
- MOZ_CAN_RUN_SCRIPT void DecompressAndEnqueue(
- JSContext* aCx, Span<const uint8_t> aInput, Flush aFlush,
- TransformStreamDefaultController& aController,
- ErrorResult& aRv) override {
- MOZ_ASSERT_IF(aFlush == Flush::Yes, !aInput.Length());
-
- mZStream.avail_in = aInput.Length();
- mZStream.next_in = const_cast<uint8_t*>(aInput.Elements());
-
- JS::RootedVector<JSObject*> array(aCx);
-
- do {
- UniquePtr<uint8_t[], JS::FreePolicy> buffer(
- static_cast<uint8_t*>(JS_malloc(aCx, kBufferSize)));
- if (!buffer) {
- aRv.ThrowTypeError("Out of memory");
- return;
- }
-
- mZStream.avail_out = kBufferSize;
- mZStream.next_out = buffer.get();
-
- int8_t err = inflate(&mZStream, intoZLibFlush(aFlush));
-
- // From the manual: inflate() returns ...
- switch (err) {
- case Z_DATA_ERROR:
- // Z_DATA_ERROR if the input data was corrupted (input stream not
- // conforming to the zlib format or incorrect check value, in which
- // case strm->msg points to a string with a more specific error)
- aRv.ThrowTypeError("The input data is corrupted: "_ns +
- nsDependentCString(mZStream.msg));
- return;
- case Z_MEM_ERROR:
- // Z_MEM_ERROR if there was not enough memory
- aRv.ThrowTypeError("Out of memory");
- return;
- case Z_NEED_DICT:
- // Z_NEED_DICT if a preset dictionary is needed at this point
- //
- // From the `deflate` section of
- // https://wicg.github.io/compression/#supported-formats:
- // * The FDICT flag is not supported by these APIs, and will error the
- // stream if set.
- // And FDICT means preset dictionary per
- // https://datatracker.ietf.org/doc/html/rfc1950#page-5.
- aRv.ThrowTypeError(
- "The stream needs a preset dictionary but such setup is "
- "unsupported");
- return;
- case Z_STREAM_END:
- // Z_STREAM_END if the end of the compressed data has been reached and
- // all uncompressed output has been produced
- //
- // https://wicg.github.io/compression/#supported-formats has error
- // conditions for each compression format when additional input comes
- // after stream end.
- // Note that additional calls for inflate() immediately emits
- // Z_STREAM_END after this point.
- mObservedStreamEnd = true;
- break;
- case Z_OK:
- case Z_BUF_ERROR:
- // * Z_OK if some progress has been made
- // * Z_BUF_ERROR if no progress was possible or if there was not
- // enough room in the output buffer when Z_FINISH is used. Note that
- // Z_BUF_ERROR is not fatal, and inflate() can be called again with
- // more input and more output space to continue decompressing.
- //
- // (But of course no input should be given after Z_FINISH)
- break;
- case Z_STREAM_ERROR:
- default:
- // * Z_STREAM_ERROR if the stream state was inconsistent
- // (which is fatal)
- MOZ_ASSERT_UNREACHABLE("Unexpected decompression error code");
- aRv.ThrowTypeError("Unexpected decompression error");
- return;
- }
-
- // At this point we either exhausted the input or the output buffer, or
- // met the stream end.
- MOZ_ASSERT(!mZStream.avail_in || !mZStream.avail_out ||
- mObservedStreamEnd);
-
- size_t written = kBufferSize - mZStream.avail_out;
- if (!written) {
- break;
- }
-
- // Step 3: If buffer is empty, return.
- // (We'll implicitly return when the array is empty.)
-
- // Step 4: Split buffer into one or more non-empty pieces and convert them
- // into Uint8Arrays.
- // (The buffer is 'split' by having a fixed sized buffer above.)
-
- JS::Rooted<JSObject*> view(aCx, nsJSUtils::MoveBufferAsUint8Array(
- aCx, written, std::move(buffer)));
- if (!view || !array.append(view)) {
- JS_ClearPendingException(aCx);
- aRv.ThrowTypeError("Out of memory");
- return;
- }
- } while (mZStream.avail_out == 0 && !mObservedStreamEnd);
- // From the manual:
- // * It must update next_out and avail_out when avail_out has dropped to
- // zero.
- // * inflate() should normally be called until it returns Z_STREAM_END or an
- // error.
-
- // Step 5: For each Uint8Array array, enqueue array in ds's transform.
- for (const auto& view : array) {
- JS::Rooted<JS::Value> value(aCx, JS::ObjectValue(*view));
- aController.Enqueue(aCx, value, aRv);
- if (aRv.Failed()) {
- return;
- }
- }
-
- // Step 6: If the end of the compressed input has been reached, and ds's
- // context has not fully consumed chunk, then throw a TypeError.
- if (mObservedStreamEnd && mZStream.avail_in > 0) {
- aRv.ThrowTypeError("Unexpected input after the end of stream");
- return;
- }
-
- // Step 3 of
- // https://wicg.github.io/compression/#decompress-flush-and-enqueue
- // If the end of the compressed input has not been reached, then throw a
- // TypeError.
- if (aFlush == Flush::Yes && !mObservedStreamEnd) {
- aRv.ThrowTypeError("The input is ended without reaching the stream end");
- return;
- }
- }
-
- ~ZLibDecompressionStreamAlgorithms() override { inflateEnd(&mZStream); }
-
- z_stream mZStream = {};
- bool mObservedStreamEnd = false;
-};
-
-NS_IMPL_CYCLE_COLLECTION_INHERITED(ZLibDecompressionStreamAlgorithms,
- DecompressionStreamAlgorithms)
-NS_IMPL_ADDREF_INHERITED(ZLibDecompressionStreamAlgorithms,
- DecompressionStreamAlgorithms)
-NS_IMPL_RELEASE_INHERITED(ZLibDecompressionStreamAlgorithms,
- DecompressionStreamAlgorithms)
-NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(ZLibDecompressionStreamAlgorithms)
-NS_INTERFACE_MAP_END_INHERITING(DecompressionStreamAlgorithms)
-
// See the zstd manual in https://facebook.github.io/zstd/zstd_manual.html or in
// https://searchfox.org/mozilla-central/source/third_party/zstd/lib/zstd.h
class ZstdDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
diff --git a/dom/compression/FormatZlib.cpp b/dom/compression/FormatZlib.cpp
@@ -0,0 +1,410 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "FormatZlib.h"
+
+#include "BaseAlgorithms.h"
+#include "mozilla/dom/BufferSourceBinding.h"
+#include "mozilla/dom/BufferSourceBindingFwd.h"
+#include "mozilla/dom/CompressionStreamBinding.h"
+#include "mozilla/dom/TransformStreamDefaultController.h"
+#include "mozilla/dom/UnionTypes.h"
+
+namespace mozilla::dom::compression {
+
+NS_IMPL_CYCLE_COLLECTION_INHERITED(CompressionStreamAlgorithms,
+ TransformerAlgorithmsBase)
+NS_IMPL_ADDREF_INHERITED(CompressionStreamAlgorithms, TransformerAlgorithmsBase)
+NS_IMPL_RELEASE_INHERITED(CompressionStreamAlgorithms,
+ TransformerAlgorithmsBase)
+NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(CompressionStreamAlgorithms)
+NS_INTERFACE_MAP_END_INHERITING(TransformerAlgorithmsBase)
+
+NS_IMPL_CYCLE_COLLECTION_INHERITED(ZLibDecompressionStreamAlgorithms,
+ DecompressionStreamAlgorithms)
+NS_IMPL_ADDREF_INHERITED(ZLibDecompressionStreamAlgorithms,
+ DecompressionStreamAlgorithms)
+NS_IMPL_RELEASE_INHERITED(ZLibDecompressionStreamAlgorithms,
+ DecompressionStreamAlgorithms)
+NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(ZLibDecompressionStreamAlgorithms)
+NS_INTERFACE_MAP_END_INHERITING(DecompressionStreamAlgorithms)
+
+inline uint8_t intoZLibFlush(Flush aFlush) {
+ switch (aFlush) {
+ case Flush::No: {
+ return Z_NO_FLUSH;
+ }
+ case Flush::Yes: {
+ return Z_FINISH;
+ }
+ default: {
+ MOZ_ASSERT_UNREACHABLE("Unknown flush mode");
+ return Z_NO_FLUSH;
+ }
+ }
+}
+
+// From the docs in
+// https://searchfox.org/mozilla-central/source/modules/zlib/src/zlib.h
+inline int8_t ZLibWindowBits(CompressionFormat format) {
+ switch (format) {
+ case CompressionFormat::Deflate:
+ // The windowBits parameter is the base two logarithm of the window size
+ // (the size of the history buffer). It should be in the range 8..15 for
+ // this version of the library. Larger values of this parameter result
+ // in better compression at the expense of memory usage.
+ return 15;
+ case CompressionFormat::Deflate_raw:
+ // windowBits can also be –8..–15 for raw deflate. In this case,
+ // -windowBits determines the window size.
+ return -15;
+ case CompressionFormat::Gzip:
+ // windowBits can also be greater than 15 for optional gzip encoding.
+ // Add 16 to windowBits to write a simple gzip header and trailer around
+ // the compressed data instead of a zlib wrapper.
+ return 31;
+ default:
+ MOZ_ASSERT_UNREACHABLE("Unknown compression format");
+ return 0;
+ }
+}
+
+Result<already_AddRefed<CompressionStreamAlgorithms>, nsresult>
+CompressionStreamAlgorithms::Create(CompressionFormat format) {
+ RefPtr<CompressionStreamAlgorithms> alg = new CompressionStreamAlgorithms();
+ MOZ_TRY(alg->Init(format));
+ return alg.forget();
+}
+
+[[nodiscard]] nsresult CompressionStreamAlgorithms::Init(
+ CompressionFormat format) {
+ int8_t err = deflateInit2(&mZStream, Z_DEFAULT_COMPRESSION, Z_DEFLATED,
+ ZLibWindowBits(format), 8 /* default memLevel */,
+ Z_DEFAULT_STRATEGY);
+ if (err == Z_MEM_ERROR) {
+ return NS_ERROR_OUT_OF_MEMORY;
+ }
+ MOZ_ASSERT(err == Z_OK);
+ return NS_OK;
+}
+
+// Step 3 of
+// https://wicg.github.io/compression/#dom-compressionstream-compressionstream
+// Let transformAlgorithm be an algorithm which takes a chunk argument and
+// runs the compress and enqueue a chunk algorithm with this and chunk.
+MOZ_CAN_RUN_SCRIPT
+void CompressionStreamAlgorithms::TransformCallbackImpl(
+ JS::Handle<JS::Value> aChunk, TransformStreamDefaultController& aController,
+ ErrorResult& aRv) {
+ AutoJSAPI jsapi;
+ if (!jsapi.Init(aController.GetParentObject())) {
+ aRv.ThrowUnknownError("Internal error");
+ return;
+ }
+ JSContext* cx = jsapi.cx();
+
+ // https://wicg.github.io/compression/#compress-and-enqueue-a-chunk
+
+ // Step 1: If chunk is not a BufferSource type, then throw a TypeError.
+ RootedUnion<OwningBufferSource> bufferSource(cx);
+ if (!bufferSource.Init(cx, aChunk)) {
+ aRv.MightThrowJSException();
+ aRv.StealExceptionFromJSContext(cx);
+ return;
+ }
+
+ // Step 2: Let buffer be the result of compressing chunk with cs's format
+ // and context.
+ // Step 3 - 5: (Done in CompressAndEnqueue)
+ ProcessTypedArraysFixed(
+ bufferSource,
+ [&](const Span<uint8_t>& aData) MOZ_CAN_RUN_SCRIPT_BOUNDARY {
+ CompressAndEnqueue(cx, aData, Flush::No, aController, aRv);
+ });
+}
+
+// Step 4 of
+// https://wicg.github.io/compression/#dom-compressionstream-compressionstream
+// Let flushAlgorithm be an algorithm which takes no argument and runs the
+// compress flush and enqueue algorithm with this.
+MOZ_CAN_RUN_SCRIPT void CompressionStreamAlgorithms::FlushCallbackImpl(
+ TransformStreamDefaultController& aController, ErrorResult& aRv) {
+ AutoJSAPI jsapi;
+ if (!jsapi.Init(aController.GetParentObject())) {
+ aRv.ThrowUnknownError("Internal error");
+ return;
+ }
+ JSContext* cx = jsapi.cx();
+
+ // https://wicg.github.io/compression/#compress-flush-and-enqueue
+
+ // Step 1: Let buffer be the result of compressing an empty input with cs's
+ // format and context, with the finish flag.
+ // Step 2 - 4: (Done in CompressAndEnqueue)
+ CompressAndEnqueue(cx, Span<const uint8_t>(), Flush::Yes, aController, aRv);
+}
+
+// Shared by:
+// https://wicg.github.io/compression/#compress-and-enqueue-a-chunk
+// https://wicg.github.io/compression/#compress-flush-and-enqueue
+MOZ_CAN_RUN_SCRIPT void CompressionStreamAlgorithms::CompressAndEnqueue(
+ JSContext* aCx, Span<const uint8_t> aInput, Flush aFlush,
+ TransformStreamDefaultController& aController, ErrorResult& aRv) {
+ MOZ_ASSERT_IF(aFlush == Flush::Yes, !aInput.Length());
+
+ mZStream.avail_in = aInput.Length();
+ mZStream.next_in = const_cast<uint8_t*>(aInput.Elements());
+
+ JS::RootedVector<JSObject*> array(aCx);
+
+ do {
+ static uint16_t kBufferSize = 16384;
+ UniquePtr<uint8_t[], JS::FreePolicy> buffer(
+ static_cast<uint8_t*>(JS_malloc(aCx, kBufferSize)));
+ if (!buffer) {
+ aRv.ThrowTypeError("Out of memory");
+ return;
+ }
+
+ mZStream.avail_out = kBufferSize;
+ mZStream.next_out = buffer.get();
+
+ int8_t err = deflate(&mZStream, intoZLibFlush(aFlush));
+
+ // From the manual: deflate() returns ...
+ switch (err) {
+ case Z_OK:
+ case Z_STREAM_END:
+ case Z_BUF_ERROR:
+ // * Z_OK if some progress has been made
+ // * Z_STREAM_END if all input has been consumed and all output has
+ // been produced (only when flush is set to Z_FINISH)
+ // * Z_BUF_ERROR if no progress is possible (for example avail_in or
+ // avail_out was zero). Note that Z_BUF_ERROR is not fatal, and
+ // deflate() can be called again with more input and more output space
+ // to continue compressing.
+ //
+ // (But of course no input should be given after Z_FINISH)
+ break;
+ case Z_STREAM_ERROR:
+ default:
+ // * Z_STREAM_ERROR if the stream state was inconsistent
+ // (which is fatal)
+ MOZ_ASSERT_UNREACHABLE("Unexpected compression error code");
+ aRv.ThrowTypeError("Unexpected compression error");
+ return;
+ }
+
+ // Stream should end only when flushed, see above
+ // The reverse is not true as zlib may have big data to be flushed that is
+ // larger than the buffer size
+ MOZ_ASSERT_IF(err == Z_STREAM_END, aFlush == Flush::Yes);
+
+ // At this point we either exhausted the input or the output buffer
+ MOZ_ASSERT(!mZStream.avail_in || !mZStream.avail_out);
+
+ size_t written = kBufferSize - mZStream.avail_out;
+ if (!written) {
+ break;
+ }
+
+ // Step 3: If buffer is empty, return.
+ // (We'll implicitly return when the array is empty.)
+
+ // Step 4: Split buffer into one or more non-empty pieces and convert them
+ // into Uint8Arrays.
+ // (The buffer is 'split' by having a fixed sized buffer above.)
+
+ JS::Rooted<JSObject*> view(aCx, nsJSUtils::MoveBufferAsUint8Array(
+ aCx, written, std::move(buffer)));
+ if (!view || !array.append(view)) {
+ JS_ClearPendingException(aCx);
+ aRv.ThrowTypeError("Out of memory");
+ return;
+ }
+ } while (mZStream.avail_out == 0);
+ // From the manual:
+ // If deflate returns with avail_out == 0, this function must be called
+ // again with the same value of the flush parameter and more output space
+ // (updated avail_out)
+
+ // Step 5: For each Uint8Array array, enqueue array in cs's transform.
+ for (const auto& view : array) {
+ JS::Rooted<JS::Value> value(aCx, JS::ObjectValue(*view));
+ aController.Enqueue(aCx, value, aRv);
+ if (aRv.Failed()) {
+ return;
+ }
+ }
+}
+
+CompressionStreamAlgorithms::~CompressionStreamAlgorithms() {
+ deflateEnd(&mZStream);
+};
+
+Result<already_AddRefed<ZLibDecompressionStreamAlgorithms>, nsresult>
+ZLibDecompressionStreamAlgorithms::Create(CompressionFormat format) {
+ RefPtr<ZLibDecompressionStreamAlgorithms> alg =
+ new ZLibDecompressionStreamAlgorithms();
+ MOZ_TRY(alg->Init(format));
+ return alg.forget();
+}
+
+[[nodiscard]] nsresult ZLibDecompressionStreamAlgorithms::Init(
+ CompressionFormat format) {
+ int8_t err = inflateInit2(&mZStream, ZLibWindowBits(format));
+ if (err == Z_MEM_ERROR) {
+ return NS_ERROR_OUT_OF_MEMORY;
+ }
+ MOZ_ASSERT(err == Z_OK);
+ return NS_OK;
+}
+
+// Shared by:
+// https://wicg.github.io/compression/#decompress-and-enqueue-a-chunk
+// https://wicg.github.io/compression/#decompress-flush-and-enqueue
+// All data errors throw TypeError by step 2: If this results in an error,
+// then throw a TypeError.
+MOZ_CAN_RUN_SCRIPT void ZLibDecompressionStreamAlgorithms::DecompressAndEnqueue(
+ JSContext* aCx, Span<const uint8_t> aInput, Flush aFlush,
+ TransformStreamDefaultController& aController, ErrorResult& aRv) {
+ MOZ_ASSERT_IF(aFlush == Flush::Yes, !aInput.Length());
+
+ mZStream.avail_in = aInput.Length();
+ mZStream.next_in = const_cast<uint8_t*>(aInput.Elements());
+
+ JS::RootedVector<JSObject*> array(aCx);
+
+ do {
+ UniquePtr<uint8_t[], JS::FreePolicy> buffer(
+ static_cast<uint8_t*>(JS_malloc(aCx, kBufferSize)));
+ if (!buffer) {
+ aRv.ThrowTypeError("Out of memory");
+ return;
+ }
+
+ mZStream.avail_out = kBufferSize;
+ mZStream.next_out = buffer.get();
+
+ int8_t err = inflate(&mZStream, intoZLibFlush(aFlush));
+
+ // From the manual: inflate() returns ...
+ switch (err) {
+ case Z_DATA_ERROR:
+ // Z_DATA_ERROR if the input data was corrupted (input stream not
+ // conforming to the zlib format or incorrect check value, in which
+ // case strm->msg points to a string with a more specific error)
+ aRv.ThrowTypeError("The input data is corrupted: "_ns +
+ nsDependentCString(mZStream.msg));
+ return;
+ case Z_MEM_ERROR:
+ // Z_MEM_ERROR if there was not enough memory
+ aRv.ThrowTypeError("Out of memory");
+ return;
+ case Z_NEED_DICT:
+ // Z_NEED_DICT if a preset dictionary is needed at this point
+ //
+ // From the `deflate` section of
+ // https://wicg.github.io/compression/#supported-formats:
+ // * The FDICT flag is not supported by these APIs, and will error the
+ // stream if set.
+ // And FDICT means preset dictionary per
+ // https://datatracker.ietf.org/doc/html/rfc1950#page-5.
+ aRv.ThrowTypeError(
+ "The stream needs a preset dictionary but such setup is "
+ "unsupported");
+ return;
+ case Z_STREAM_END:
+ // Z_STREAM_END if the end of the compressed data has been reached and
+ // all uncompressed output has been produced
+ //
+ // https://wicg.github.io/compression/#supported-formats has error
+ // conditions for each compression format when additional input comes
+ // after stream end.
+ // Note that additional calls for inflate() immediately emits
+ // Z_STREAM_END after this point.
+ mObservedStreamEnd = true;
+ break;
+ case Z_OK:
+ case Z_BUF_ERROR:
+ // * Z_OK if some progress has been made
+ // * Z_BUF_ERROR if no progress was possible or if there was not
+ // enough room in the output buffer when Z_FINISH is used. Note that
+ // Z_BUF_ERROR is not fatal, and inflate() can be called again with
+ // more input and more output space to continue decompressing.
+ //
+ // (But of course no input should be given after Z_FINISH)
+ break;
+ case Z_STREAM_ERROR:
+ default:
+ // * Z_STREAM_ERROR if the stream state was inconsistent
+ // (which is fatal)
+ MOZ_ASSERT_UNREACHABLE("Unexpected decompression error code");
+ aRv.ThrowTypeError("Unexpected decompression error");
+ return;
+ }
+
+ // At this point we either exhausted the input or the output buffer, or
+ // met the stream end.
+ MOZ_ASSERT(!mZStream.avail_in || !mZStream.avail_out || mObservedStreamEnd);
+
+ size_t written = kBufferSize - mZStream.avail_out;
+ if (!written) {
+ break;
+ }
+
+ // Step 3: If buffer is empty, return.
+ // (We'll implicitly return when the array is empty.)
+
+ // Step 4: Split buffer into one or more non-empty pieces and convert them
+ // into Uint8Arrays.
+ // (The buffer is 'split' by having a fixed sized buffer above.)
+
+ JS::Rooted<JSObject*> view(aCx, nsJSUtils::MoveBufferAsUint8Array(
+ aCx, written, std::move(buffer)));
+ if (!view || !array.append(view)) {
+ JS_ClearPendingException(aCx);
+ aRv.ThrowTypeError("Out of memory");
+ return;
+ }
+ } while (mZStream.avail_out == 0 && !mObservedStreamEnd);
+ // From the manual:
+ // * It must update next_out and avail_out when avail_out has dropped to
+ // zero.
+ // * inflate() should normally be called until it returns Z_STREAM_END or an
+ // error.
+
+ // Step 5: For each Uint8Array array, enqueue array in ds's transform.
+ for (const auto& view : array) {
+ JS::Rooted<JS::Value> value(aCx, JS::ObjectValue(*view));
+ aController.Enqueue(aCx, value, aRv);
+ if (aRv.Failed()) {
+ return;
+ }
+ }
+
+ // Step 6: If the end of the compressed input has been reached, and ds's
+ // context has not fully consumed chunk, then throw a TypeError.
+ if (mObservedStreamEnd && mZStream.avail_in > 0) {
+ aRv.ThrowTypeError("Unexpected input after the end of stream");
+ return;
+ }
+
+ // Step 3 of
+ // https://wicg.github.io/compression/#decompress-flush-and-enqueue
+ // If the end of the compressed input has not been reached, then throw a
+ // TypeError.
+ if (aFlush == Flush::Yes && !mObservedStreamEnd) {
+ aRv.ThrowTypeError("The input is ended without reaching the stream end");
+ return;
+ }
+}
+
+ZLibDecompressionStreamAlgorithms::~ZLibDecompressionStreamAlgorithms() {
+ inflateEnd(&mZStream);
+}
+
+} // namespace mozilla::dom::compression
diff --git a/dom/compression/FormatZlib.h b/dom/compression/FormatZlib.h
@@ -0,0 +1,97 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef DOM_COMPRESSION_FORMATZLIB_H_
+#define DOM_COMPRESSION_FORMATZLIB_H_
+
+#include "BaseAlgorithms.h"
+#include "mozilla/dom/TransformerCallbackHelpers.h"
+#include "zlib.h"
+
+// See the zlib manual in https://www.zlib.net/manual.html or in
+// https://searchfox.org/mozilla-central/source/modules/zlib/src/zlib.h
+
+namespace mozilla::dom {
+enum class CompressionFormat : uint8_t;
+}
+
+namespace mozilla::dom::compression {
+
+class CompressionStreamAlgorithms : public TransformerAlgorithmsWrapper {
+ public:
+ NS_DECL_ISUPPORTS_INHERITED
+ NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(CompressionStreamAlgorithms,
+ TransformerAlgorithmsBase)
+
+ static Result<already_AddRefed<CompressionStreamAlgorithms>, nsresult> Create(
+ CompressionFormat format);
+
+ private:
+ CompressionStreamAlgorithms() = default;
+
+ [[nodiscard]] nsresult Init(CompressionFormat format);
+
+ // Step 3 of
+ // https://wicg.github.io/compression/#dom-compressionstream-compressionstream
+ // Let transformAlgorithm be an algorithm which takes a chunk argument and
+ // runs the compress and enqueue a chunk algorithm with this and chunk.
+ MOZ_CAN_RUN_SCRIPT
+ void TransformCallbackImpl(JS::Handle<JS::Value> aChunk,
+ TransformStreamDefaultController& aController,
+ ErrorResult& aRv) override;
+
+ // Step 4 of
+ // https://wicg.github.io/compression/#dom-compressionstream-compressionstream
+ // Let flushAlgorithm be an algorithm which takes no argument and runs the
+ // compress flush and enqueue algorithm with this.
+ MOZ_CAN_RUN_SCRIPT void FlushCallbackImpl(
+ TransformStreamDefaultController& aController, ErrorResult& aRv) override;
+
+ // Shared by:
+ // https://wicg.github.io/compression/#compress-and-enqueue-a-chunk
+ // https://wicg.github.io/compression/#compress-flush-and-enqueue
+ MOZ_CAN_RUN_SCRIPT void CompressAndEnqueue(
+ JSContext* aCx, Span<const uint8_t> aInput, Flush aFlush,
+ TransformStreamDefaultController& aController, ErrorResult& aRv);
+
+ ~CompressionStreamAlgorithms() override;
+
+ z_stream mZStream = {};
+};
+
+class ZLibDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
+ public:
+ NS_DECL_ISUPPORTS_INHERITED
+ NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ZLibDecompressionStreamAlgorithms,
+ DecompressionStreamAlgorithms)
+
+ static Result<already_AddRefed<ZLibDecompressionStreamAlgorithms>, nsresult>
+ Create(CompressionFormat format);
+
+ private:
+ ZLibDecompressionStreamAlgorithms() = default;
+
+ [[nodiscard]] nsresult Init(CompressionFormat format);
+
+ private:
+ // Shared by:
+ // https://wicg.github.io/compression/#decompress-and-enqueue-a-chunk
+ // https://wicg.github.io/compression/#decompress-flush-and-enqueue
+ // All data errors throw TypeError by step 2: If this results in an error,
+ // then throw a TypeError.
+ MOZ_CAN_RUN_SCRIPT void DecompressAndEnqueue(
+ JSContext* aCx, Span<const uint8_t> aInput, Flush aFlush,
+ TransformStreamDefaultController& aController, ErrorResult& aRv) override;
+
+ ~ZLibDecompressionStreamAlgorithms() override;
+
+ z_stream mZStream = {};
+ bool mObservedStreamEnd = false;
+};
+
+} // namespace mozilla::dom::compression
+
+#endif // DOM_COMPRESSION_FORMATZLIB_H_
diff --git a/dom/compression/moz.build b/dom/compression/moz.build
@@ -16,6 +16,7 @@ UNIFIED_SOURCES += [
"BaseAlgorithms.cpp",
"CompressionStream.cpp",
"DecompressionStream.cpp",
+ "FormatZlib.cpp",
]
FINAL_LIBRARY = "xul"
