The new |view| has to be a view onto the same backing memory region as
+ {{ReadableStreamBYOBRequest/view}}, i.e. its buffer has to equal (or be a
+ transferred version of) {{ReadableStreamBYOBRequest/view}}'s
+ buffer. Its byteOffset has to equal {{ReadableStreamBYOBRequest/view}}'s
+ byteOffset, and its byteLength (representing the number of bytes written)
+ has to be less than or equal to that of {{ReadableStreamBYOBRequest/view}}.
+
After this method is called, view will be transferred and no longer modifiable. @@ -1967,8 +1984,8 @@ following table: 1. If [=this=].[=ReadableStreamBYOBRequest/[[controller]]=] is undefined, throw a {{TypeError}} exception. - 1. If [$IsDetachedBuffer$]([=this=].[=ReadableStreamBYOBRequest/[[view]]=].\[[ArrayBuffer]]) is - true, throw a {{TypeError}} exception. + 1. If ! [$IsDetachedBuffer$]([=this=].[=ReadableStreamBYOBRequest/[[view]]=].\[[ArrayBuffer]]) + is true, throw a {{TypeError}} exception. 1. Assert: [=this=].[=ReadableStreamBYOBRequest/[[view]]=].\[[ByteLength]] > 0. 1. Assert: [=this=].[=ReadableStreamBYOBRequest/[[view]]=].\[[ViewedArrayBuffer]].\[[ByteLength]] > 0. @@ -1981,11 +1998,10 @@ following table: The respondWithNewView(|view|) method steps are: - 1. If |view|.\[[ByteLength]] is 0, throw a {{TypeError}} exception. - 1. If |view|.\[[ViewedArrayBuffer]].\[[ArrayBufferByteLength]] is 0, throw a {{TypeError}} - exception. 1. If [=this=].[=ReadableStreamBYOBRequest/[[controller]]=] is undefined, throw a {{TypeError}} exception. + 1. If ! [$IsDetachedBuffer$](|view|.\[[ViewedArrayBuffer]]) is true, + throw a {{TypeError}} exception. 1. Return ? [$ReadableByteStreamControllerRespondWithNewView$]([=this=].[=ReadableStreamBYOBRequest/[[controller]]=], |view|). @@ -2882,9 +2898,10 @@ The following abstract operations support the implementation of the 1. Let |elementSize| be |pullIntoDescriptor|'s [=pull-into descriptor/element size=]. 1. Assert: |bytesFilled| ≤ |pullIntoDescriptor|'s [=pull-into descriptor/byte length=]. 1. Assert: |bytesFilled| mod |elementSize| is 0. + 1. Let |buffer| be ! [$TransferArrayBuffer$](|pullIntoDescriptor|'s [=pull-into descriptor/buffer=]). 1. Return ! [$Construct$](|pullIntoDescriptor|'s [=pull-into descriptor/view constructor=], « - |pullIntoDescriptor|'s [=pull-into descriptor/buffer=], |pullIntoDescriptor|'s [=pull-into - descriptor/byte offset=], |bytesFilled| ÷ |elementSize| »). + |buffer|, |pullIntoDescriptor|'s [=pull-into descriptor/byte offset=], + |bytesFilled| ÷ |elementSize| »).
This will throw an exception if |O| has an \[[ArrayBufferDetachKey]] + that is not undefined, such as a {{Memory|WebAssembly.Memory}}'s {{Memory/buffer}}. + [[WASM-JS-API-1]]
1. Return a new {{ArrayBuffer}} object, created in [=the current Realm=], whose \[[ArrayBufferData]] internal slot value is |arrayBufferData| and whose \[[ArrayBufferByteLength]] internal slot value is |arrayBufferByteLength|. diff --git a/reference-implementation/lib/ReadableByteStreamController-impl.js b/reference-implementation/lib/ReadableByteStreamController-impl.js index a560dd136..799ea3799 100644 --- a/reference-implementation/lib/ReadableByteStreamController-impl.js +++ b/reference-implementation/lib/ReadableByteStreamController-impl.js @@ -108,6 +108,7 @@ exports.implementation = class ReadableByteStreamControllerImpl { const pullIntoDescriptor = { buffer, + bufferByteLength: autoAllocateChunkSize, byteOffset: 0, byteLength: autoAllocateChunkSize, bytesFilled: 0, diff --git a/reference-implementation/lib/ReadableStreamBYOBReader-impl.js b/reference-implementation/lib/ReadableStreamBYOBReader-impl.js index b4feaa6ad..fe605ea14 100644 --- a/reference-implementation/lib/ReadableStreamBYOBReader-impl.js +++ b/reference-implementation/lib/ReadableStreamBYOBReader-impl.js @@ -1,6 +1,7 @@ 'use strict'; const { newPromise, resolvePromise, rejectPromise, promiseRejectedWith } = require('./helpers/webidl.js'); +const { IsDetachedBuffer } = require('./abstract-ops/ecmascript.js'); const aos = require('./abstract-ops/readable-streams.js'); const { mixin } = require('./helpers/miscellaneous.js'); const ReadableStreamGenericReaderImpl = require('./ReadableStreamGenericReader-impl.js').implementation; @@ -17,6 +18,9 @@ class ReadableStreamBYOBReaderImpl { if (view.buffer.byteLength === 0) { return promiseRejectedWith(new TypeError('view\'s buffer must have non-zero byteLength')); } + if (IsDetachedBuffer(view.buffer) === true) { + return promiseRejectedWith(new TypeError('view\'s buffer has been detached')); + } if (this._stream === undefined) { return promiseRejectedWith(readerLockException('read')); diff --git a/reference-implementation/lib/ReadableStreamBYOBRequest-impl.js b/reference-implementation/lib/ReadableStreamBYOBRequest-impl.js index 2e737fd9b..6fa50f7f9 100644 --- a/reference-implementation/lib/ReadableStreamBYOBRequest-impl.js +++ b/reference-implementation/lib/ReadableStreamBYOBRequest-impl.js @@ -25,17 +25,14 @@ exports.implementation = class ReadableStreamBYOBRequestImpl { } respondWithNewView(view) { - if (view.byteLength === 0) { - throw new TypeError('chunk must have non-zero byteLength'); - } - if (view.buffer.byteLength === 0) { - throw new TypeError('chunk\'s buffer must have non-zero byteLength'); - } - if (this._controller === undefined) { throw new TypeError('This BYOB request has been invalidated'); } + if (IsDetachedBuffer(view.buffer) === true) { + throw new TypeError('The given view\'s buffer has been detached and so cannot be used as a response'); + } + aos.ReadableByteStreamControllerRespondWithNewView(this._controller, view); } }; diff --git a/reference-implementation/lib/abstract-ops/ecmascript.js b/reference-implementation/lib/abstract-ops/ecmascript.js index 636e352da..f2f3028b9 100644 --- a/reference-implementation/lib/abstract-ops/ecmascript.js +++ b/reference-implementation/lib/abstract-ops/ecmascript.js @@ -30,6 +30,11 @@ exports.TransferArrayBuffer = O => { return transferredIshVersion; }; +// Not implemented correctly +exports.CanTransferArrayBuffer = O => { + return !exports.IsDetachedBuffer(O); +}; + // Not implemented correctly exports.IsDetachedBuffer = O => { return isFakeDetached in O; diff --git a/reference-implementation/lib/abstract-ops/readable-streams.js b/reference-implementation/lib/abstract-ops/readable-streams.js index b072d3fdd..988519581 100644 --- a/reference-implementation/lib/abstract-ops/readable-streams.js +++ b/reference-implementation/lib/abstract-ops/readable-streams.js @@ -4,7 +4,8 @@ const assert = require('assert'); const { promiseResolvedWith, promiseRejectedWith, newPromise, resolvePromise, rejectPromise, uponPromise, setPromiseIsHandledToTrue, waitForAllPromise, transformPromiseWith, uponFulfillment, uponRejection } = require('../helpers/webidl.js'); -const { CopyDataBlockBytes, CreateArrayFromList, TransferArrayBuffer } = require('./ecmascript.js'); +const { CanTransferArrayBuffer, CopyDataBlockBytes, CreateArrayFromList, IsDetachedBuffer, TransferArrayBuffer } = + require('./ecmascript.js'); const { IsNonNegativeNumber } = require('./miscellaneous.js'); const { EnqueueValueWithSize, ResetQueue } = require('./queue-with-sizes.js'); const { AcquireWritableStreamDefaultWriter, IsWritableStreamLocked, WritableStreamAbort, @@ -983,8 +984,8 @@ function ReadableByteStreamControllerConvertPullIntoDescriptor(pullIntoDescripto assert(bytesFilled <= pullIntoDescriptor.byteLength); assert(bytesFilled % elementSize === 0); - return new pullIntoDescriptor.viewConstructor( - pullIntoDescriptor.buffer, pullIntoDescriptor.byteOffset, bytesFilled / elementSize); + const buffer = TransferArrayBuffer(pullIntoDescriptor.buffer); + return new pullIntoDescriptor.viewConstructor(buffer, pullIntoDescriptor.byteOffset, bytesFilled / elementSize); } function ReadableByteStreamControllerEnqueue(controller, chunk) { @@ -997,8 +998,23 @@ function ReadableByteStreamControllerEnqueue(controller, chunk) { const buffer = chunk.buffer; const byteOffset = chunk.byteOffset; const byteLength = chunk.byteLength; + if (IsDetachedBuffer(buffer) === true) { + throw new TypeError('chunk\'s buffer is detached and so cannot be enqueued'); + } const transferredBuffer = TransferArrayBuffer(buffer); + if (controller._pendingPullIntos.length > 0) { + const firstPendingPullInto = controller._pendingPullIntos[0]; + if (IsDetachedBuffer(firstPendingPullInto.buffer) === true) { + throw new TypeError( + 'The BYOB request\'s buffer has been detached and so cannot be filled with an enqueued chunk' + ); + } + firstPendingPullInto.buffer = TransferArrayBuffer(firstPendingPullInto.buffer); + } + + ReadableByteStreamControllerInvalidateBYOBRequest(controller); + if (ReadableStreamHasDefaultReader(stream) === true) { if (ReadableStreamGetNumReadRequests(stream) === 0) { ReadableByteStreamControllerEnqueueChunkToQueue(controller, transferredBuffer, byteOffset, byteLength); @@ -1041,8 +1057,7 @@ function ReadableByteStreamControllerError(controller, e) { function ReadableByteStreamControllerFillHeadPullIntoDescriptor(controller, size, pullIntoDescriptor) { assert(controller._pendingPullIntos.length === 0 || controller._pendingPullIntos[0] === pullIntoDescriptor); - - ReadableByteStreamControllerInvalidateBYOBRequest(controller); + assert(controller._byobRequest === null); pullIntoDescriptor.bytesFilled += size; } @@ -1160,9 +1175,17 @@ function ReadableByteStreamControllerPullInto(controller, view, readIntoRequest) const ctor = view.constructor; - const buffer = TransferArrayBuffer(view.buffer); + let buffer; + try { + buffer = TransferArrayBuffer(view.buffer); + } catch (e) { + readIntoRequest.errorSteps(e); + return; + } + const pullIntoDescriptor = { buffer, + bufferByteLength: buffer.byteLength, byteOffset: view.byteOffset, byteLength: view.byteLength, bytesFilled: 0, @@ -1216,12 +1239,29 @@ function ReadableByteStreamControllerPullInto(controller, view, readIntoRequest) function ReadableByteStreamControllerRespond(controller, bytesWritten) { assert(controller._pendingPullIntos.length > 0); + const firstDescriptor = controller._pendingPullIntos[0]; + const state = controller._stream._state; + + if (state === 'closed') { + if (bytesWritten !== 0) { + throw new TypeError('bytesWritten must be 0 when calling respond() on a closed stream'); + } + } else { + assert(state === 'readable'); + if (bytesWritten === 0) { + throw new TypeError('bytesWritten must be greater than 0 when calling respond() on a readable stream'); + } + if (firstDescriptor.bytesFilled + bytesWritten > firstDescriptor.byteLength) { + throw new RangeError('bytesWritten out of range'); + } + } + + firstDescriptor.buffer = TransferArrayBuffer(firstDescriptor.buffer); + ReadableByteStreamControllerRespondInternal(controller, bytesWritten); } function ReadableByteStreamControllerRespondInClosedState(controller, firstDescriptor) { - firstDescriptor.buffer = TransferArrayBuffer(firstDescriptor.buffer); - assert(firstDescriptor.bytesFilled === 0); const stream = controller._stream; @@ -1234,14 +1274,11 @@ function ReadableByteStreamControllerRespondInClosedState(controller, firstDescr } function ReadableByteStreamControllerRespondInReadableState(controller, bytesWritten, pullIntoDescriptor) { - if (pullIntoDescriptor.bytesFilled + bytesWritten > pullIntoDescriptor.byteLength) { - throw new RangeError('bytesWritten out of range'); - } + assert(pullIntoDescriptor.bytesFilled + bytesWritten <= pullIntoDescriptor.byteLength); ReadableByteStreamControllerFillHeadPullIntoDescriptor(controller, bytesWritten, pullIntoDescriptor); if (pullIntoDescriptor.bytesFilled < pullIntoDescriptor.elementSize) { - // TODO: Figure out whether we should detach the buffer or not here. return; } @@ -1254,7 +1291,6 @@ function ReadableByteStreamControllerRespondInReadableState(controller, bytesWri ReadableByteStreamControllerEnqueueChunkToQueue(controller, remainder, 0, remainder.byteLength); } - pullIntoDescriptor.buffer = TransferArrayBuffer(pullIntoDescriptor.buffer); pullIntoDescriptor.bytesFilled -= remainderSize; ReadableByteStreamControllerCommitPullIntoDescriptor(controller._stream, pullIntoDescriptor); @@ -1263,18 +1299,17 @@ function ReadableByteStreamControllerRespondInReadableState(controller, bytesWri function ReadableByteStreamControllerRespondInternal(controller, bytesWritten) { const firstDescriptor = controller._pendingPullIntos[0]; + assert(CanTransferArrayBuffer(firstDescriptor.buffer) === true); - const state = controller._stream._state; + ReadableByteStreamControllerInvalidateBYOBRequest(controller); + const state = controller._stream._state; if (state === 'closed') { - if (bytesWritten !== 0) { - throw new TypeError('bytesWritten must be 0 when calling respond() on a closed stream'); - } - + assert(bytesWritten === 0); ReadableByteStreamControllerRespondInClosedState(controller, firstDescriptor); } else { assert(state === 'readable'); - + assert(bytesWritten > 0); ReadableByteStreamControllerRespondInReadableState(controller, bytesWritten, firstDescriptor); } @@ -1283,24 +1318,42 @@ function ReadableByteStreamControllerRespondInternal(controller, bytesWritten) { function ReadableByteStreamControllerRespondWithNewView(controller, view) { assert(controller._pendingPullIntos.length > 0); + assert(IsDetachedBuffer(view.buffer) === false); const firstDescriptor = controller._pendingPullIntos[0]; + const state = controller._stream._state; + + if (state === 'closed') { + if (view.byteLength !== 0) { + throw new TypeError('The view\'s length must be 0 when calling respondWithNewView() on a closed stream'); + } + } else { + assert(state === 'readable'); + if (view.byteLength === 0) { + throw new TypeError( + 'The view\'s length must be greater than 0 when calling respondWithNewView() on a readable stream' + ); + } + } if (firstDescriptor.byteOffset + firstDescriptor.bytesFilled !== view.byteOffset) { throw new RangeError('The region specified by view does not match byobRequest'); } - if (firstDescriptor.byteLength !== view.byteLength) { + if (firstDescriptor.bufferByteLength !== view.buffer.byteLength) { throw new RangeError('The buffer of view has different capacity than byobRequest'); } + if (firstDescriptor.bytesFilled + view.byteLength > firstDescriptor.byteLength) { + throw new RangeError('The region specified by view is larger than byobRequest'); + } - firstDescriptor.buffer = view.buffer; + firstDescriptor.buffer = TransferArrayBuffer(view.buffer); ReadableByteStreamControllerRespondInternal(controller, view.byteLength); } function ReadableByteStreamControllerShiftPendingPullInto(controller) { + assert(controller._byobRequest === null); const descriptor = controller._pendingPullIntos.shift(); - ReadableByteStreamControllerInvalidateBYOBRequest(controller); return descriptor; } diff --git a/reference-implementation/run-web-platform-tests.js b/reference-implementation/run-web-platform-tests.js index d58969901..7c0e01d96 100644 --- a/reference-implementation/run-web-platform-tests.js +++ b/reference-implementation/run-web-platform-tests.js @@ -33,6 +33,11 @@ async function main() { const testsPath = path.resolve(wptPath, 'streams'); const filterGlobs = process.argv.length >= 3 ? process.argv.slice(2) : ['**/*.html']; + const excludeGlobs = [ + // These tests use ArrayBuffers backed by WebAssembly.Memory objects, which *should* be non-transferable. + // However, our TransferArrayBuffer implementation cannot detect these, and will incorrectly "transfer" them anyway. + 'readable-byte-streams/non-transferable-buffers.any.html' + ]; const anyTestPattern = /\.any\.html$/; const bundledJS = await bundle(entryPath); @@ -61,7 +66,8 @@ async function main() { return false; } - return filterGlobs.some(glob => minimatch(testPath, glob)); + return filterGlobs.some(glob => minimatch(testPath, glob)) && + !excludeGlobs.some(glob => minimatch(testPath, glob)); } }); diff --git a/reference-implementation/web-platform-tests b/reference-implementation/web-platform-tests index 1bdb43faa..7b29ee36c 160000 --- a/reference-implementation/web-platform-tests +++ b/reference-implementation/web-platform-tests @@ -1 +1 @@ -Subproject commit 1bdb43faa7434d36645ab5c64e754b5caefbc9d2 +Subproject commit 7b29ee36cc22bdad06b4f98df73358ca959fe0a7