unpack: conditionally use a file mapping to write files

Use a file mapping to write files up to 512KB. The limit where using
a file mapping stops being an advantage varies from machine to
machine. 512KB is a reasonable value to use here, close to the lower
bound, to avoid tar becoming slower in some machines.

PR-URL: #230
Credit: @joaocgreis
Close: #230
Reviewed-by: @isaacs

Author: joaocgreis

lib/unpack.js

@@ -10,6 +10,7 @@ const assert = require('assert')
 const EE = require('events').EventEmitter
 const Parser = require('./parse.js')
 const fs = require('fs')
+const { O_CREAT, O_TRUNC, O_WRONLY, UV_FS_O_FILEMAP = 0 } = fs.constants
 const fsm = require('fs-minipass')
 const path = require('path')
 const mkdir = require('./mkdir.js')
@@ -92,6 +93,13 @@ const uint32 = (a, b, c) =>
   : b === b >>> 0 ? b
   : c
 
+/* istanbul ignore next */
+const fMapEnabled = process.platform === 'win32' && !!UV_FS_O_FILEMAP
+const fMapLimit = 512 * 1024
+const fMapFlag = UV_FS_O_FILEMAP | O_TRUNC | O_CREAT | O_WRONLY
+/* istanbul ignore next */
+const getFlag = size => (fMapEnabled && size < fMapLimit) ? fMapFlag : 'w'
+
 class Unpack extends Parser {
   constructor (opt) {
     if (!opt)
@@ -325,6 +333,7 @@ class Unpack extends Parser {
   [FILE] (entry, fullyDone) {
     const mode = entry.mode & 0o7777 || this.fmode
     const stream = new fsm.WriteStream(entry.absolute, {
+      flags: getFlag(entry.size),
       mode: mode,
       autoClose: false
     })
@@ -572,7 +581,7 @@ class UnpackSync extends Unpack {
     let stream
     let fd
     try {
-      fd = fs.openSync(entry.absolute, 'w', mode)
+      fd = fs.openSync(entry.absolute, getFlag(entry.size), mode)
     } catch (er) {
       return oner(er)
     }