Skip to content
Open
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
88 changes: 35 additions & 53 deletions lib/internal/child_process/serialization.js
Original file line number Diff line number Diff line change
@@ -1,78 +1,60 @@
'use strict';

const {
ArrayPrototypePush,
JSONParse,
JSONStringify,
StringPrototypeSplit,
Symbol,
TypedArrayPrototypeSubarray,
} = primordials;
const { Buffer } = require('buffer');
const { StringDecoder } = require('string_decoder');
const { serialize, deserialize } = internalBinding('ipc_serdes');
const {
serialize,
IPCChannelFramer,
kFramerBuffering,
kFramerError,
} = internalBinding('ipc_serdes');
const { streamBaseState, kLastWriteWasAsync } = internalBinding('stream_wrap');

const kMessageBuffer = Symbol('kMessageBuffer');
const kMessageBufferSize = Symbol('kMessageBufferSize');
const kFramer = Symbol('kFramer');
const kJSONBuffer = Symbol('kJSONBuffer');
const kStringDecoder = Symbol('kStringDecoder');

// Messages are parsed in either of the following formats:
// - Newline-delimited JSON, or
// - V8-serialized buffers, prefixed with their length as a big endian uint32
// (aka 'advanced')
// (aka 'advanced'), or
// - newline-delimited JSON.
//
// The 'advanced' read path is framed natively: IPCChannelFramer accumulates
// partial reads in C++ and hands back an array of complete, deserialized
// messages, so JavaScript never reframes the byte stream. The 'json' read path
// stays in JavaScript: its StringDecoder + split('\n') pipeline already avoids
// copies via V8 rope concatenation and O(1) substrings, and is measurably
// faster than reframing the bytes in C++.

// A frame that failed to deserialize has already been consumed by the framer.
// Deliver the messages decoded from the same read, then throw its error.
function* yieldThenThrow(messages, error) {
for (let i = 0; i < messages.length; i++)
yield messages[i];
throw error;
}

const advanced = {
initMessageChannel(channel) {
channel[kMessageBuffer] = [];
channel[kMessageBufferSize] = 0;
channel[kFramer] = new IPCChannelFramer();
channel.buffering = false;
},

*parseChannelMessages(channel, readData) {
if (readData.length === 0) return;

if (channel[kMessageBufferSize] && channel[kMessageBuffer][0].length < 4) {
// Message length split into two buffers, so let's concatenate it.
channel[kMessageBuffer][0] = Buffer.concat([channel[kMessageBuffer][0], readData]);
} else {
ArrayPrototypePush(channel[kMessageBuffer], readData);
}
channel[kMessageBufferSize] += readData.length;

// Index 0 should always be present because we just pushed data into it.
let messageBufferHead = channel[kMessageBuffer][0];
while (messageBufferHead.length >= 4) {
// We call `readUInt32BE` manually here, because this is faster than first converting
// it to a buffer and using `readUInt32BE` on that.
const fullMessageSize = ((
messageBufferHead[0] << 24 |
messageBufferHead[1] << 16 |
messageBufferHead[2] << 8 |
messageBufferHead[3]
) >>> 0) + 4;

if (channel[kMessageBufferSize] < fullMessageSize) break;

const concatenatedBuffer = channel[kMessageBuffer].length === 1 ?
channel[kMessageBuffer][0] :
Buffer.concat(
channel[kMessageBuffer],
channel[kMessageBufferSize],
);

const serializedMessage =
TypedArrayPrototypeSubarray(concatenatedBuffer, 4, fullMessageSize);

messageBufferHead = TypedArrayPrototypeSubarray(concatenatedBuffer, fullMessageSize);
channel[kMessageBufferSize] = messageBufferHead.length;
channel[kMessageBuffer] =
channel[kMessageBufferSize] !== 0 ? [messageBufferHead] : [];

yield deserialize(serializedMessage);
}

channel.buffering = channel[kMessageBufferSize] > 0;
parseChannelMessages(channel, readData) {
if (readData.length === 0) return [];
const framer = channel[kFramer];
const messages = framer.read(readData);
const status = framer.status();
channel.buffering = (status & kFramerBuffering) !== 0;
if ((status & kFramerError) !== 0)
return yieldThenThrow(messages, framer.takeError());
return messages;
},

writeChannelMessage(channel, req, message, handle) {
Expand Down
Loading
Loading