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.

Sign up for GitHub

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

perf: optimize Writable #50012

Merged
merged 1 commit into from
Oct 4, 2023
Merged

perf: optimize Writable #50012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 22 additions & 10 deletions lib/internal/streams/writable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ const kWriteCb = 1 << 26;
const kExpectWriteCb = 1 << 27;
const kAfterWriteTickInfo = 1 << 28;
const kAfterWritePending = 1 << 29;
const kHasBuffer = 1 << 30;

// TODO(benjamingr) it is likely slower to do it this way than with free functions
function makeBitMapDescriptor(bit) {
Expand Down Expand Up @@ -340,6 +341,7 @@ function resetBuffer(state) {
state.buffered = [];
state.bufferedIndex = 0;
state.state |= kAllBuffers | kAllNoop;
state.state &= ~kHasBuffer;
}

WritableState.prototype.getBuffer = function getBuffer() {
Expand Down Expand Up @@ -396,11 +398,13 @@ function Writable(options) {
destroyImpl.construct(this, () => {
const state = this._writableState;

if (!state.writing) {
if ((state.state & kWriting) === 0) {
clearBuffer(this, state);
}

finishMaybe(this, state);
if ((state.state & kEnding) !== 0) {
finishMaybe(this, state);
}
});
}

Expand Down Expand Up @@ -523,6 +527,7 @@ function writeOrBuffer(stream, state, chunk, encoding, callback) {

if ((state.state & (kWriting | kErrored | kCorked | kConstructed)) !== kConstructed) {
state.buffered.push({ chunk, encoding, callback });
state.state |= kHasBuffer;
if ((state.state & kAllBuffers) !== 0 && encoding !== 'buffer') {
state.state &= ~kAllBuffers;
}
Expand Down Expand Up @@ -591,8 +596,9 @@ function onwrite(stream, er) {
// Avoid V8 leak, https://github.com/nodejs/node/pull/34103#issuecomment-652002364
er.stack; // eslint-disable-line no-unused-expressions

if (!state.errored) {
state.errored = er;
if ((state.state & kErrored) === 0) {
state[kErroredValue] = er;
state.state |= kErrored;
}

// In case of duplex streams we need to notify the readable side of the
Expand All @@ -607,12 +613,12 @@ function onwrite(stream, er) {
onwriteError(stream, state, er, cb);
}
} else {
if (state.buffered.length > state.bufferedIndex) {
if ((state.state & kHasBuffer) !== 0) {
clearBuffer(stream, state);
}

if (sync) {
const needDrain = state.length === 0 && (state.state & kNeedDrain) !== 0;
const needDrain = (state.state & kNeedDrain) !== 0 && state.length === 0;
const needTick = needDrain || (state.state & kDestroyed !== 0) || cb !== nop;

// It is a common case that the callback passed to .write() is always
Expand All @@ -625,7 +631,9 @@ function onwrite(stream, er) {
state.state |= kAfterWritePending;
} else {
state.pendingcb--;
finishMaybe(stream, state, true);
if ((state.state & kEnding) !== 0) {
finishMaybe(stream, state, true);
}
}
} else if ((state.state & kAfterWriteTickInfo) !== 0 &&
state[kAfterWriteTickInfoValue].cb === cb) {
Expand All @@ -636,7 +644,9 @@ function onwrite(stream, er) {
state.state |= (kAfterWritePending | kAfterWriteTickInfo);
} else {
state.pendingcb--;
finishMaybe(stream, state, true);
if ((state.state & kEnding) !== 0) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may as well optimize needFinish?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is more about inlining.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could maybe inline needFinish but that would impact readability for little gain

finishMaybe(stream, state, true);
}
}
} else {
afterWrite(stream, state, 1, cb);
Expand Down Expand Up @@ -668,7 +678,9 @@ function afterWrite(stream, state, count, cb) {
errorBuffer(state);
}

finishMaybe(stream, state);
if ((state.state & kEnding) !== 0) {
finishMaybe(stream, state, true);
}
}

// If there's something in the buffer waiting, then invoke callbacks.
Expand All @@ -692,7 +704,7 @@ function errorBuffer(state) {

// If there's something in the buffer waiting, then process it.
function clearBuffer(stream, state) {
if ((state.state & (kDestroyed | kBufferProcessing | kCorked)) !== 0 ||
if ((state.state & (kDestroyed | kBufferProcessing | kCorked | kHasBuffer)) !== kHasBuffer ||
(state.state & kConstructed) === 0) {
return;
}
Expand Down