buffer: add a check for byteLength in readIntBE() and readIntLE() #11146

seppevs · 2017-02-03T15:08:55Z

The 'byteLength' argument should be required and of type 'number'. It should have a value between 1 and 6.

This is a fix for issue: #10515

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

buffer

jasnell · 2017-02-03T16:07:26Z

Added semver-major due to the addition of the new throw conditions.

jasnell

LGTM with one suggestion

jasnell · 2017-02-03T16:10:43Z

lib/buffer.js

+  if (typeof byteLength !== 'number')
+    throw new TypeError('"byteLength" argument must be a number');
+  else if (byteLength === 0)
+    throw new RangeError('"byteLength" argument cannot equal zero');


Perhaps these can just be condensed into a single check

if (typeof byteLength !== 'number' || byteLength <= 0) throw new TypeError('"byteLength" must be a positive number greater than zero');

Thank you for your suggestion. I made the changes and amended them to the previous commit.

joyeecheung · 2017-02-03T17:13:38Z

lib/buffer.js

@@ -852,6 +852,12 @@ function checkOffset(offset, ext, length) {
    throw new RangeError('Index out of range');
 }

+function checkByteLength(byteLength) {
+  if (typeof byteLength !== 'number' || byteLength <= 0)
+    throw new TypeError('"byteLength" must be a positive number ' +


byteLength <= 0 should be a RangeError I think.

So should we throw 2 separate errors (TypeError when it's not a Number and RangeError when byteLength is <= 0) or just one RangeError?

I think separate errors would be better, because a TypeError for byteLength <= 0 doesn't look right IMO.

According to the docs:

byteLength {Integer} How many bytes to read. Must satisfy: 0 < byteLength <= 6

and

Supports up to 48 bits of accuracy.

So probably check byteLength > 6 too?

Also a doc update would be great :D

good point about the RangeError. Yes, in that case keeping them separate is best.

Thanks again for the feedback. I amended the proposed changes to the previous commit. I also updated the docs.

Trott · 2017-02-03T19:01:24Z

Should a benchmark be run to ascertain the performance impact of this change?

joyeecheung · 2017-02-03T19:03:42Z

doc/api/buffer.md

@@ -1588,6 +1588,14 @@ console.log(buf.readIntBE(0, 6).toString(16));

 // Throws an exception: RangeError: Index out of range
 console.log(buf.readIntBE(1, 6).toString(16));
+
+// Throws an exception: "byteLength" argument must be a number
+console.log(buf.readIntBE(1).toString(16));


Might as well adding TypeError: and RangeError: as the previous example, just to be a little bit more consistent.

joyeecheung · 2017-02-03T19:08:59Z

@Trott +1 on running a benchmark.

FYI: how to compare different implementations using the benchmark suite. The whole buffer benchmarks can take a long time IIRC, so probably running the benchmarks for these specific functions only (using --filter buffer-read) would be enough.

seppevs · 2017-02-03T19:11:32Z

@joyeecheung Thanks for advice on running the benchmark suite. I will look into it.

mscdex · 2017-02-03T20:56:44Z

I think the actual byte length range checking should go inside the if (!noAssert) {} conditional, especially since the docs already say that is what should be happening:

noAssert <Boolean> Skip offset and byteLength validation? Default: false

seppevs · 2017-02-03T21:05:00Z

@mscdex so should both the RangeError and TypeError checks be moved inside the if (!noAssert) {} conditional? Or only the RangeError check?

joyeecheung · 2017-02-03T21:31:48Z

+1 on putting it in noAssert branch, I think both errors should go there.

mscdex · 2017-02-04T02:00:04Z

@seppevs I think putting both in there would be alright, plus it would allow us to avoid any potential performance regressions.

seppevs · 2017-02-04T06:53:43Z

Code is updated. The checks are now inside an if (!noAssert) {} conditional.

I also added a benchmark for the readIntBE() and readIntLE() functions. This is the result:

                                                                                  improvement confidence      p.value
 buffers/buffer-read.js millions=1 type="DoubleBE" buffer="fast" noAssert="false"      4.18 %            1.180142e-01
 buffers/buffer-read.js millions=1 type="DoubleBE" buffer="fast" noAssert="true"       6.47 %        *** 1.310937e-04
 buffers/buffer-read.js millions=1 type="DoubleBE" buffer="slow" noAssert="false"      1.79 %            3.685481e-01
 buffers/buffer-read.js millions=1 type="DoubleBE" buffer="slow" noAssert="true"       8.96 %        *** 2.664556e-06
 buffers/buffer-read.js millions=1 type="DoubleLE" buffer="fast" noAssert="false"      7.43 %         ** 1.084422e-03
 buffers/buffer-read.js millions=1 type="DoubleLE" buffer="fast" noAssert="true"      10.37 %        *** 6.742609e-09
 buffers/buffer-read.js millions=1 type="DoubleLE" buffer="slow" noAssert="false"      3.86 %            6.004415e-02
 buffers/buffer-read.js millions=1 type="DoubleLE" buffer="slow" noAssert="true"       8.18 %        *** 2.057731e-04
 buffers/buffer-read.js millions=1 type="FloatBE" buffer="fast" noAssert="false"       2.29 %            1.665287e-01
 buffers/buffer-read.js millions=1 type="FloatBE" buffer="fast" noAssert="true"        6.29 %        *** 1.050359e-04
 buffers/buffer-read.js millions=1 type="FloatBE" buffer="slow" noAssert="false"       0.83 %            6.219902e-01
 buffers/buffer-read.js millions=1 type="FloatBE" buffer="slow" noAssert="true"        6.67 %        *** 3.224094e-04
 buffers/buffer-read.js millions=1 type="FloatLE" buffer="fast" noAssert="false"       5.02 %          * 1.179036e-02
 buffers/buffer-read.js millions=1 type="FloatLE" buffer="fast" noAssert="true"        6.96 %        *** 1.013249e-04
 buffers/buffer-read.js millions=1 type="FloatLE" buffer="slow" noAssert="false"       4.90 %         ** 3.837246e-03
 buffers/buffer-read.js millions=1 type="FloatLE" buffer="slow" noAssert="true"        9.03 %        *** 2.019258e-04
 buffers/buffer-read.js millions=1 type="Int16BE" buffer="fast" noAssert="false"      -1.44 %            2.589583e-01
 buffers/buffer-read.js millions=1 type="Int16BE" buffer="fast" noAssert="true"        2.65 %            1.183960e-01
 buffers/buffer-read.js millions=1 type="Int16BE" buffer="slow" noAssert="false"      -2.27 %            1.400200e-01
 buffers/buffer-read.js millions=1 type="Int16BE" buffer="slow" noAssert="true"       -0.75 %            6.772607e-01
 buffers/buffer-read.js millions=1 type="Int16LE" buffer="fast" noAssert="false"      -0.15 %            9.077978e-01
 buffers/buffer-read.js millions=1 type="Int16LE" buffer="fast" noAssert="true"        0.94 %            6.569100e-01
 buffers/buffer-read.js millions=1 type="Int16LE" buffer="slow" noAssert="false"      -1.03 %            4.349094e-01
 buffers/buffer-read.js millions=1 type="Int16LE" buffer="slow" noAssert="true"        5.06 %          * 4.460938e-02
 buffers/buffer-read.js millions=1 type="Int32BE" buffer="fast" noAssert="false"      -3.21 %            5.723680e-02
 buffers/buffer-read.js millions=1 type="Int32BE" buffer="fast" noAssert="true"        0.49 %            7.766907e-01
 buffers/buffer-read.js millions=1 type="Int32BE" buffer="slow" noAssert="false"      -4.50 %          * 1.058377e-02
 buffers/buffer-read.js millions=1 type="Int32BE" buffer="slow" noAssert="true"        5.15 %            5.978561e-02
 buffers/buffer-read.js millions=1 type="Int32LE" buffer="fast" noAssert="false"      -1.56 %            3.178323e-01
 buffers/buffer-read.js millions=1 type="Int32LE" buffer="fast" noAssert="true"       -1.23 %            4.050536e-01
 buffers/buffer-read.js millions=1 type="Int32LE" buffer="slow" noAssert="false"      -2.23 %            1.411720e-01
 buffers/buffer-read.js millions=1 type="Int32LE" buffer="slow" noAssert="true"        2.34 %            1.838885e-01
 buffers/buffer-read.js millions=1 type="Int8" buffer="fast" noAssert="false"          1.01 %            6.152630e-01
 buffers/buffer-read.js millions=1 type="Int8" buffer="fast" noAssert="true"          -2.33 %            2.878609e-01
 buffers/buffer-read.js millions=1 type="Int8" buffer="slow" noAssert="false"         -0.85 %            6.657967e-01
 buffers/buffer-read.js millions=1 type="Int8" buffer="slow" noAssert="true"          -2.04 %            1.372518e-01
 buffers/buffer-read.js millions=1 type="IntBE" buffer="fast" noAssert="false"       -14.01 %        *** 3.763754e-16
 buffers/buffer-read.js millions=1 type="IntBE" buffer="fast" noAssert="true"         -3.66 %            1.083440e-01
 buffers/buffer-read.js millions=1 type="IntBE" buffer="slow" noAssert="false"       -13.82 %        *** 5.023712e-14
 buffers/buffer-read.js millions=1 type="IntBE" buffer="slow" noAssert="true"          1.75 %            4.075352e-01
 buffers/buffer-read.js millions=1 type="IntLE" buffer="fast" noAssert="false"       -16.94 %        *** 2.235239e-16
 buffers/buffer-read.js millions=1 type="IntLE" buffer="fast" noAssert="true"         -3.85 %            1.260500e-01
 buffers/buffer-read.js millions=1 type="IntLE" buffer="slow" noAssert="false"       -14.82 %        *** 1.462768e-12
 buffers/buffer-read.js millions=1 type="IntLE" buffer="slow" noAssert="true"         -3.97 %            7.667586e-02
 buffers/buffer-read.js millions=1 type="UInt16BE" buffer="fast" noAssert="false"      0.17 %            9.083551e-01
 buffers/buffer-read.js millions=1 type="UInt16BE" buffer="fast" noAssert="true"       0.90 %            5.520311e-01
 buffers/buffer-read.js millions=1 type="UInt16BE" buffer="slow" noAssert="false"     -2.96 %            6.193972e-02
 buffers/buffer-read.js millions=1 type="UInt16BE" buffer="slow" noAssert="true"       1.09 %            7.355000e-01
 buffers/buffer-read.js millions=1 type="UInt16LE" buffer="fast" noAssert="false"      2.76 %            2.401676e-01
 buffers/buffer-read.js millions=1 type="UInt16LE" buffer="fast" noAssert="true"      -0.13 %            9.458833e-01
 buffers/buffer-read.js millions=1 type="UInt16LE" buffer="slow" noAssert="false"     -4.08 %         ** 7.675214e-03
 buffers/buffer-read.js millions=1 type="UInt16LE" buffer="slow" noAssert="true"       0.77 %            6.838866e-01
 buffers/buffer-read.js millions=1 type="UInt32BE" buffer="fast" noAssert="false"     -1.90 %            5.237900e-01
 buffers/buffer-read.js millions=1 type="UInt32BE" buffer="fast" noAssert="true"       2.11 %            2.404609e-01
 buffers/buffer-read.js millions=1 type="UInt32BE" buffer="slow" noAssert="false"     -1.74 %            2.093449e-01
 buffers/buffer-read.js millions=1 type="UInt32BE" buffer="slow" noAssert="true"       1.73 %            3.353888e-01
 buffers/buffer-read.js millions=1 type="UInt32LE" buffer="fast" noAssert="false"      1.64 %            3.323573e-01
 buffers/buffer-read.js millions=1 type="UInt32LE" buffer="fast" noAssert="true"       0.00 %            9.985634e-01
 buffers/buffer-read.js millions=1 type="UInt32LE" buffer="slow" noAssert="false"     -2.42 %            6.457802e-02
 buffers/buffer-read.js millions=1 type="UInt32LE" buffer="slow" noAssert="true"       0.25 %            8.792678e-01
 buffers/buffer-read.js millions=1 type="UInt8" buffer="fast" noAssert="false"         0.49 %            7.798080e-01
 buffers/buffer-read.js millions=1 type="UInt8" buffer="fast" noAssert="true"         -0.12 %            9.540942e-01
 buffers/buffer-read.js millions=1 type="UInt8" buffer="slow" noAssert="false"        -1.66 %            3.933987e-01
 buffers/buffer-read.js millions=1 type="UInt8" buffer="slow" noAssert="true"         -1.87 %            4.774133e-01

joyeecheung · 2017-02-04T08:13:55Z

benchmark/buffers/buffer-read.js

  var testFunction = new Function('buff', [
    'for (var i = 0; i !== ' + len + '; i++) {',
-    '  buff.' + fn + '(0, ' + JSON.stringify(noAssert) + ');',
+    '  if (\'' + fn + '\' === \'readIntLE\' ' +


The if branch should be moved outside new Function to avoid the runtime cost. Also would be easier to read if we use template literals here, something like:

var call; if (fn === 'readIntLE' || conf.type === 'readIntBE') { call = `buff.${fn}(0, 1, ${noAssert})`; } else { call = `buff.${fn}(0, ${noAssert})`; } var testFunction = new Function('buff', ` for (var i = 0; i !== ${len}; ++i) { ${call}; }`);

Code updated

joyeecheung · 2017-02-04T08:22:29Z

lib/buffer.js

@@ -933,8 +940,12 @@ Buffer.prototype.readUInt32BE = function(offset, noAssert) {


 Buffer.prototype.readIntLE = function(offset, byteLength, noAssert) {
+  if (!noAssert)
+    checkByteLength(byteLength);


Probably best moving checkByteLength and checkOffset in the same branch. Also not sure if the assertion should happen before or after offset and byteLength get converted into numbers, I am inclined to checking it before the conversion.

The checkOffset uses the byteLength, and assumes it is defined and already converted to a number. The offset and byteLength are converted to numbers before the checkOffset function is invoked.

I think it's better to check the byteLength before it's converted to a number. If we do the conversion first, we can't trust the converted value in the checkByteLength function

console.log(undefined >>> 0); // -> 0 console.log(null >>> 0); // -> 0 console.log('a string' >>> 0); // -> 0 console.log(true >>> 0); // -> 1 .... this is in the expected range and would pass the check

So what do you suggest me to do?

I agree that ideally we would combine the two, but there could easily be breakage if the current (prior to this PR) assertions are moved, so that would definitely be another semver-major change if we wanted to make that change at all. Thoughts @nodejs/collaborators?

@seppevs No matter the order of the assertions, I the typechecking part of checkByteLength should be consistent with checkOffset. If checkOffset doesn't check the type, checkByteLength should not do it either. If we do want to check the type, then we need to add this to checkOffset too.

Also if they are consistent, then they can be moved into the same branch I think? If we check the type, they can both be placed before the conversion. If we don't, they can both be placed after the conversion.

So should I check the type, or not? Do you think the type check will affect the performance?

@seppevs I can think of good arguments for both sides, so I think we can wait for thoughts from other collaborators.

jasnell · 2017-03-22T22:00:07Z

What is the status on this one?

@seppevs ... can you please rebase this?

ronkorving · 2017-03-23T01:52:28Z

lib/buffer.js

+function checkByteLength(byteLength) {
+  if (typeof byteLength !== 'number')
+    throw new TypeError('"byteLength" argument must be a number');
+  else if (byteLength < 1 || byteLength > 6)


You don't need the else here.

seppevs · 2017-03-27T08:44:30Z

@jasnell rebase done

jasnell · 2017-03-27T16:23:41Z

Ping @nodejs/buffer @nodejs/ctc ... thoughts on this?

jasnell · 2017-04-04T18:55:49Z

ping @nodejs/ctc

Trott · 2018-01-02T23:50:05Z

Was there discussion about doing the same for readUIntLE and readUIntLE?

@targos That would make sense. Will do...

Trott · 2018-01-03T00:30:50Z

You can likely recoup that 8% by unrolling the loop.

Oh, yes, probably! I'm intrigued, but I am inclined to save that for a subsequent PR. This PR is 11 months old at this point. I'd rather get the functionality landed and then have the performance vs. Crankshaft-script maintenance costs debate separately.

Trott · 2018-01-03T00:39:47Z

Benchmark results with the additional changes:

                                                                                                             improvement confidence      p.value
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="IntBE" buffer="fast" noAssert="false"      -4.06 %        *** 0.0002808920
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="IntBE" buffer="fast" noAssert="true"       -0.87 %            0.5179050330
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="IntBE" buffer="slow" noAssert="false"      -2.66 %            0.2197501164
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="IntBE" buffer="slow" noAssert="true"        0.94 %            0.3536060899
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="IntLE" buffer="fast" noAssert="false"      -3.18 %            0.0840983107
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="IntLE" buffer="fast" noAssert="true"       -0.39 %            0.7203410009
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="IntLE" buffer="slow" noAssert="false"      -0.79 %            0.6929134114
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="IntLE" buffer="slow" noAssert="true"       -1.10 %            0.4140083284
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="UIntBE" buffer="fast" noAssert="false"     -5.58 %        *** 0.0009982531
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="UIntBE" buffer="fast" noAssert="true"       2.90 %            0.1010858492
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="UIntBE" buffer="slow" noAssert="false"     -3.64 %          * 0.0394332017
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="UIntBE" buffer="slow" noAssert="true"      -0.92 %            0.6825518346
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="UIntLE" buffer="fast" noAssert="false"     -2.84 %            0.0620117183
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="UIntLE" buffer="fast" noAssert="true"      -1.18 %            0.2374233691
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="UIntLE" buffer="slow" noAssert="false"     -5.59 %         ** 0.0022420004
 buffers/buffer-read-with-byteLength.js byteLength=1 millions=1 type="UIntLE" buffer="slow" noAssert="true"      -0.38 %            0.8336763163
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="IntBE" buffer="fast" noAssert="false"      -4.56 %        *** 0.0001955189
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="IntBE" buffer="fast" noAssert="true"       -1.70 %            0.1608865221
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="IntBE" buffer="slow" noAssert="false"      -1.56 %            0.3447368715
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="IntBE" buffer="slow" noAssert="true"        0.28 %            0.8424978551
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="IntLE" buffer="fast" noAssert="false"      -4.78 %         ** 0.0025353959
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="IntLE" buffer="fast" noAssert="true"       -3.36 %            0.1101136262
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="IntLE" buffer="slow" noAssert="false"       1.68 %            0.2885417168
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="IntLE" buffer="slow" noAssert="true"       -0.36 %            0.8360745581
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="UIntBE" buffer="fast" noAssert="false"     -2.91 %            0.0563485510
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="UIntBE" buffer="fast" noAssert="true"       2.73 %            0.0570619342
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="UIntBE" buffer="slow" noAssert="false"     -2.16 %            0.1467243882
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="UIntBE" buffer="slow" noAssert="true"       1.09 %            0.5036428118
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="UIntLE" buffer="fast" noAssert="false"     -3.13 %          * 0.0167492226
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="UIntLE" buffer="fast" noAssert="true"       2.18 %            0.3465909913
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="UIntLE" buffer="slow" noAssert="false"     -3.78 %        *** 0.0008500509
 buffers/buffer-read-with-byteLength.js byteLength=2 millions=1 type="UIntLE" buffer="slow" noAssert="true"      -1.13 %            0.5597913248
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="IntBE" buffer="fast" noAssert="false"       1.31 %            0.5323692216
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="IntBE" buffer="fast" noAssert="true"        0.36 %            0.7901715876
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="IntBE" buffer="slow" noAssert="false"      -0.03 %            0.9858863031
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="IntBE" buffer="slow" noAssert="true"       -1.51 %            0.4410258539
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="IntLE" buffer="fast" noAssert="false"      -3.08 %          * 0.0126980478
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="IntLE" buffer="fast" noAssert="true"        0.54 %            0.7528102406
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="IntLE" buffer="slow" noAssert="false"       1.42 %            0.4579209139
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="IntLE" buffer="slow" noAssert="true"       -4.31 %          * 0.0289903090
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="UIntBE" buffer="fast" noAssert="false"     -0.22 %            0.8495333840
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="UIntBE" buffer="fast" noAssert="true"       2.97 %            0.0837406345
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="UIntBE" buffer="slow" noAssert="false"     -1.74 %            0.2207386083
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="UIntBE" buffer="slow" noAssert="true"       0.78 %            0.7013668938
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="UIntLE" buffer="fast" noAssert="false"     -0.83 %            0.5471758131
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="UIntLE" buffer="fast" noAssert="true"       0.57 %            0.7022090281
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="UIntLE" buffer="slow" noAssert="false"     -2.32 %            0.0827266784
 buffers/buffer-read-with-byteLength.js byteLength=4 millions=1 type="UIntLE" buffer="slow" noAssert="true"       2.56 %            0.0564231616
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="IntBE" buffer="fast" noAssert="false"       1.54 %            0.3133448827
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="IntBE" buffer="fast" noAssert="true"        1.99 %            0.2231816540
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="IntBE" buffer="slow" noAssert="false"      -1.60 %            0.3031854740
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="IntBE" buffer="slow" noAssert="true"       -1.76 %            0.2391806630
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="IntLE" buffer="fast" noAssert="false"       1.23 %            0.4651066104
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="IntLE" buffer="fast" noAssert="true"        2.49 %            0.3296908645
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="IntLE" buffer="slow" noAssert="false"       3.36 %            0.1483373386
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="IntLE" buffer="slow" noAssert="true"        0.09 %            0.9615904952
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="UIntBE" buffer="fast" noAssert="false"     -1.27 %            0.4341473943
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="UIntBE" buffer="fast" noAssert="true"       2.97 %            0.0836560690
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="UIntBE" buffer="slow" noAssert="false"     -1.14 %            0.5116753365
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="UIntBE" buffer="slow" noAssert="true"       2.78 %            0.0815530806
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="UIntLE" buffer="fast" noAssert="false"     -2.89 %            0.2026249081
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="UIntLE" buffer="fast" noAssert="true"      -0.88 %            0.4983282113
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="UIntLE" buffer="slow" noAssert="false"     -0.26 %            0.8405160659
 buffers/buffer-read-with-byteLength.js byteLength=6 millions=1 type="UIntLE" buffer="slow" noAssert="true"      -0.34 %            0.7890584482

Trott · 2018-01-03T00:40:10Z

New benchmark results show an even smaller perf hit than before. 🎉

Trott · 2018-01-03T00:40:40Z

I imagine the readUIntLE() and readUIntBE() additions would be uncontroversial, but it might be good for people to re-review, just in case.

Trott · 2018-01-03T00:41:11Z

CI: https://ci.nodejs.org/job/node-test-pull-request/12384/

Trott · 2018-01-04T04:25:49Z

Lone CI failure is a known flaky for which there is a fix pending (#17958). CI is good.

Trott · 2018-01-04T04:26:52Z

Previous reviewers, a re-review is probably in order. Sorry about that. On the upside, I think this is probably good to go at this point. PTAL

BridgeAR · 2018-01-05T02:58:57Z

benchmark/buffers/buffer-read-with-byteLength.js

+
+function main(conf) {
+  const noAssert = conf.noAssert === 'true';
+  const len = +conf.millions * 1e6;


Nit: the + is obsolete.

The 'byteLength' argument should be required and of type 'number'. It should have a value between 1 and 6. This is a fix for issue: nodejs#10515

Split them into their own benhmark file and use different byteLength values.

The 'byteLength' argument should be required and of type 'number'. It should have a value between 1 and 6. PR-URL: nodejs#11146 Fixes: nodejs#10515 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Split them into their own benhmark file and use different byteLength values. PR-URL: nodejs#11146 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

PR-URL: nodejs#11146 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

BridgeAR · 2018-01-05T11:41:51Z

Landed in 9fea7ea, 94d6487, d964ffe

I fixed the commit messages to fit our length requirements.

nodejs-github-bot added the buffer Issues and PRs related to the buffer subsystem. label Feb 3, 2017

jasnell added the semver-major PRs that contain breaking changes and should be released in the next major version. label Feb 3, 2017

jasnell approved these changes Feb 3, 2017

View reviewed changes

seppevs force-pushed the buffer_add_a_check_for_byteLength_in_readIntBE_and_readIntLE branch from ca0c9be to a8d1fa8 Compare February 3, 2017 17:05

joyeecheung reviewed Feb 3, 2017

View reviewed changes

seppevs force-pushed the buffer_add_a_check_for_byteLength_in_readIntBE_and_readIntLE branch 2 times, most recently from f3644da to ed56860 Compare February 3, 2017 19:01

joyeecheung reviewed Feb 3, 2017

View reviewed changes

seppevs force-pushed the buffer_add_a_check_for_byteLength_in_readIntBE_and_readIntLE branch from ed56860 to 46ac4ad Compare February 3, 2017 19:09

seppevs force-pushed the buffer_add_a_check_for_byteLength_in_readIntBE_and_readIntLE branch from 46ac4ad to 25668ef Compare February 4, 2017 06:52

joyeecheung reviewed Feb 4, 2017

View reviewed changes

seppevs force-pushed the buffer_add_a_check_for_byteLength_in_readIntBE_and_readIntLE branch from 25668ef to d71fc82 Compare February 4, 2017 08:31

ronkorving reviewed Mar 23, 2017

View reviewed changes

seppevs force-pushed the buffer_add_a_check_for_byteLength_in_readIntBE_and_readIntLE branch 2 times, most recently from 8d4fbf6 to 10c78f4 Compare March 27, 2017 08:44

joyeecheung approved these changes Mar 29, 2017

View reviewed changes

Trott force-pushed the buffer_add_a_check_for_byteLength_in_readIntBE_and_readIntLE branch 3 times, most recently from 64ff873 to 43e161e Compare January 2, 2018 23:45

joyeecheung approved these changes Jan 4, 2018

View reviewed changes

BridgeAR approved these changes Jan 5, 2018

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 5, 2018

seppevs and others added 3 commits January 4, 2018 19:24

buffer: check byteLength in readIntBE() and readIntLE()

f558b00

The 'byteLength' argument should be required and of type 'number'. It should have a value between 1 and 6. This is a fix for issue: nodejs#10515

benchmark: improve buffer.readIntLE()/readIntBE() benchmarks

bac64ba

Split them into their own benhmark file and use different byteLength values.

buffer: check byteLength in readIntBE() and readIntLE()

710d1dc

Trott force-pushed the buffer_add_a_check_for_byteLength_in_readIntBE_and_readIntLE branch from 4a5d043 to 710d1dc Compare January 5, 2018 03:28

BridgeAR closed this Jan 5, 2018

TimothyGu removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 13, 2018

buffer: add a check for byteLength in readIntBE() and readIntLE() #11146

buffer: add a check for byteLength in readIntBE() and readIntLE() #11146

Conversation

seppevs commented Feb 3, 2017 • edited Loading

Checklist

Affected core subsystem(s)

jasnell commented Feb 3, 2017

jasnell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seppevs Feb 3, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trott commented Feb 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joyeecheung commented Feb 3, 2017

seppevs commented Feb 3, 2017

mscdex commented Feb 3, 2017 • edited Loading

seppevs commented Feb 3, 2017

joyeecheung commented Feb 3, 2017

mscdex commented Feb 4, 2017

seppevs commented Feb 4, 2017 • edited Loading

joyeecheung Feb 4, 2017 • edited Loading

Choose a reason for hiding this comment

seppevs Feb 4, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seppevs Feb 4, 2017 • edited Loading

Choose a reason for hiding this comment

mscdex Feb 6, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell commented Mar 22, 2017

Choose a reason for hiding this comment

seppevs commented Mar 27, 2017

jasnell commented Mar 27, 2017

jasnell commented Apr 4, 2017

Trott commented Jan 2, 2018

Trott commented Jan 3, 2018

Trott commented Jan 3, 2018

Trott commented Jan 3, 2018

Trott commented Jan 3, 2018

Trott commented Jan 3, 2018

Trott commented Jan 4, 2018

Trott commented Jan 4, 2018

Choose a reason for hiding this comment

BridgeAR commented Jan 5, 2018

seppevs commented Feb 3, 2017 •

edited

Loading

seppevs Feb 3, 2017 •

edited

Loading

mscdex commented Feb 3, 2017 •

edited

Loading

seppevs commented Feb 4, 2017 •

edited

Loading

joyeecheung Feb 4, 2017 •

edited

Loading

seppevs Feb 4, 2017 •

edited

Loading

seppevs Feb 4, 2017 •

edited

Loading

mscdex Feb 6, 2017 •

edited

Loading