Skip to content

fs: synchronize close with other I/O for streams#30837

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

Closed
addaleax wants to merge 2 commits into from
Closed

fs: synchronize close with other I/O for streams #30837

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1f7bf0
fs: synchronize close with other I/O for streams
addaleax Dec 7, 2019
a1453c5
fixup! fs: synchronize close with other I/O for streams
addaleax Dec 10, 2019
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
52 changes: 46 additions & 6 deletions lib/internal/fs/streams.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@ const{
NumberIsSafeInteger,
ObjectDefineProperty,
ObjectSetPrototypeOf,
Symbol,
} = primordials;

const{
ERR_OUT_OF_RANGE
ERR_OUT_OF_RANGE,
ERR_STREAM_DESTROYED
} = require('internal/errors').codes;
const internalUtil = require('internal/util');
const{validateNumber } = require('internal/validators');
Expand All@@ -22,6 +24,8 @@ const{
} = require('internal/fs/utils');
const{Readable, Writable } = require('stream');
const{toPathIfFileURL } = require('internal/url');
const kIoDone = Symbol('kIoDone');
const kIsPerformingIO = Symbol('kIsPerformingIO');

const kMinPoolSpace = 128;

Expand DownExpand Up@@ -86,6 +90,7 @@ function ReadStream(path, options){
this.pos = undefined;
this.bytesRead = 0;
this.closed = false;
this[kIsPerformingIO] = false;

if (this.start !== undefined){
checkPosition(this.start, 'start');
Expand DownExpand Up@@ -155,6 +160,8 @@ ReadStream.prototype._read = function(n){
});
}

if (this.destroyed) return;

if (!pool || pool.length - pool.used < kMinPoolSpace){
// Discard the old pool.
allocNewPool(this.readableHighWaterMark);
Expand All@@ -178,7 +185,12 @@ ReadStream.prototype._read = function(n){
return this.push(null);

// the actual read.
this[kIsPerformingIO] = true;
fs.read(this.fd, pool, pool.used, toRead, this.pos, (er, bytesRead) =>{
this[kIsPerformingIO] = false;
// Tell ._destroy() that it's safe to close the fd now.
if (this.destroyed) return this.emit(kIoDone, er);
Copy link
Member

@bnoordhuisbnoordhuisDec 8, 2019

Choose a reason for hiding this comment

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

This is observable when emit() is monkey-patched, which isn't entirely uncommon. Not a reason per se not to introduce this pattern (it's pretty elegant) but I thought I'd point it out anyway.


if (er){
if (this.autoClose){
this.destroy();
Expand DownExpand Up@@ -224,8 +236,12 @@ ReadStream.prototype._destroy = function(err, cb){
return;
}

if (this[kIsPerformingIO]){
this.once(kIoDone, (er) => closeFsStream(this, cb, err || er));
return;
}

closeFsStream(this, cb, err);
this.fd = null;
};

function closeFsStream(stream, cb, err){
Expand All@@ -236,6 +252,8 @@ function closeFsStream(stream, cb, err){
if (!er)
stream.emit('close');
});

stream.fd = null;
}

ReadStream.prototype.close = function(cb){
Expand DownExpand Up@@ -274,6 +292,7 @@ function WriteStream(path, options){
this.pos = undefined;
this.bytesWritten = 0;
this.closed = false;
this[kIsPerformingIO] = false;

if (this.start !== undefined){
checkPosition(this.start, 'start');
Expand DownExpand Up@@ -339,7 +358,17 @@ WriteStream.prototype._write = function(data, encoding, cb){
});
}

if (this.destroyed) return cb(new ERR_STREAM_DESTROYED('write'));

this[kIsPerformingIO] = true;
fs.write(this.fd, data, 0, data.length, this.pos, (er, bytes) =>{
this[kIsPerformingIO] = false;
// Tell ._destroy() that it's safe to close the fd now.
if (this.destroyed){
cb(er);
return this.emit(kIoDone, er);
}

if (er){
if (this.autoClose){
this.destroy();
Expand All@@ -362,7 +391,8 @@ WriteStream.prototype._writev = function(data, cb){
});
}

const self = this;
if (this.destroyed) return cb(new ERR_STREAM_DESTROYED('write'));

const len = data.length;
const chunks = new Array(len);
let size = 0;
Expand All@@ -374,12 +404,22 @@ WriteStream.prototype._writev = function(data, cb){
size += chunk.length;
}

fs.writev(this.fd, chunks, this.pos, function(er, bytes){
this[kIsPerformingIO] = true;
fs.writev(this.fd, chunks, this.pos, (er, bytes) =>{
this[kIsPerformingIO] = false;
// Tell ._destroy() that it's safe to close the fd now.
if (this.destroyed){
cb(er);
return this.emit(kIoDone, er);
}

if (er){
self.destroy();
if (this.autoClose){
this.destroy();
}
return cb(er);
}
self.bytesWritten += bytes;
this.bytesWritten += bytes;
cb();
});

Expand Down