Skip to content

Commit 0aa403b

Browse files
bnoordhuisMylesBorins
authored andcommitted
buffer: optimize readDouble and readFloat methods
Compute the floating point number in JavaScript to avoid having to call out to the C++ runtime. The improvements are not insubstantial: improvement confidence p.value value="big" endian="BE" type="Double" noAssert="false" 292.86 % *** 1.688367e-08 value="big" endian="BE" type="Double" noAssert="true" 353.19 % *** 6.079414e-10 value="big" endian="BE" type="Float" noAssert="false" 406.21 % *** 1.730122e-07 value="big" endian="BE" type="Float" noAssert="true" 450.81 % *** 6.909242e-07 value="big" endian="LE" type="Double" noAssert="false" 268.39 % *** 8.625486e-09 value="big" endian="LE" type="Double" noAssert="true" 310.66 % *** 2.798332e-15 value="big" endian="LE" type="Float" noAssert="false" 382.99 % *** 3.412057e-07 value="big" endian="LE" type="Float" noAssert="true" 394.60 % *** 1.406742e-07 value="inf" endian="BE" type="Double" noAssert="false" 312.91 % *** 7.407943e-12 value="inf" endian="BE" type="Double" noAssert="true" 392.47 % *** 3.821179e-08 value="inf" endian="BE" type="Float" noAssert="false" 466.01 % *** 8.953363e-08 value="inf" endian="BE" type="Float" noAssert="true" 460.76 % *** 5.381256e-09 value="inf" endian="LE" type="Double" noAssert="false" 279.50 % *** 2.390682e-09 value="inf" endian="LE" type="Double" noAssert="true" 335.30 % *** 3.587173e-09 value="inf" endian="LE" type="Float" noAssert="false" 439.77 % *** 1.057133e-07 value="inf" endian="LE" type="Float" noAssert="true" 426.72 % *** 4.353408e-09 value="nan" endian="BE" type="Double" noAssert="false" 271.18 % *** 2.281526e-05 value="nan" endian="BE" type="Double" noAssert="true" 312.63 % *** 1.974975e-07 value="nan" endian="BE" type="Float" noAssert="false" 429.17 % *** 2.416228e-07 value="nan" endian="BE" type="Float" noAssert="true" 461.39 % *** 1.956714e-08 value="nan" endian="LE" type="Double" noAssert="false" 267.03 % *** 9.938479e-12 value="nan" endian="LE" type="Double" noAssert="true" 276.93 % *** 7.842481e-08 value="nan" endian="LE" type="Float" noAssert="false" 415.97 % *** 8.082710e-07 value="nan" endian="LE" type="Float" noAssert="true" 433.68 % *** 1.030200e-07 value="small" endian="BE" type="Double" noAssert="false" 273.20 % *** 9.071652e-11 value="small" endian="BE" type="Double" noAssert="true" 326.25 % *** 3.120167e-08 value="small" endian="BE" type="Float" noAssert="false" 845.61 % *** 8.044170e-08 value="small" endian="BE" type="Float" noAssert="true" 868.61 % *** 2.944539e-08 value="small" endian="LE" type="Double" noAssert="false" 251.29 % *** 5.613930e-09 value="small" endian="LE" type="Double" noAssert="true" 286.82 % *** 8.149603e-10 value="small" endian="LE" type="Float" noAssert="false" 824.87 % *** 1.199729e-08 value="small" endian="LE" type="Float" noAssert="true" 834.35 % *** 4.799620e-08 value="zero" endian="BE" type="Double" noAssert="false" 216.70 % *** 3.872293e-12 value="zero" endian="BE" type="Double" noAssert="true" 239.31 % *** 6.439601e-09 value="zero" endian="BE" type="Float" noAssert="false" 353.75 % *** 3.639974e-07 value="zero" endian="BE" type="Float" noAssert="true" 388.86 % *** 7.074318e-10 value="zero" endian="LE" type="Double" noAssert="false" 179.34 % *** 5.230763e-06 value="zero" endian="LE" type="Double" noAssert="true" 199.66 % *** 2.177589e-11 value="zero" endian="LE" type="Float" noAssert="false" 299.55 % *** 9.961978e-08 value="zero" endian="LE" type="Float" noAssert="true" 333.30 % *** 2.470764e-08 PR-URL: #17775 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent 1b8d3ec commit 0aa403b

File tree

3 files changed

+111
-72
lines changed

3 files changed

+111
-72
lines changed
+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
'use strict';
2+
const common = require('../common.js');
3+
4+
const bench = common.createBenchmark(main, {
5+
noAssert: ['false', 'true'],
6+
type: ['Double', 'Float'],
7+
endian: ['BE', 'LE'],
8+
value: ['zero', 'big', 'small', 'inf', 'nan'],
9+
millions: [1]
10+
});
11+
12+
function main(conf) {
13+
const noAssert = conf.noAssert === 'true';
14+
const len = +conf.millions * 1e6;
15+
const buff = Buffer.alloc(8);
16+
const type = conf.type || 'Double';
17+
const endian = conf.endian;
18+
const fn = `read${type}${endian}`;
19+
const values = {
20+
Double: {
21+
zero: 0,
22+
big: 2 ** 1023,
23+
small: 2 ** -1074,
24+
inf: Infinity,
25+
nan: NaN,
26+
},
27+
Float: {
28+
zero: 0,
29+
big: 2 ** 127,
30+
small: 2 ** -149,
31+
inf: Infinity,
32+
nan: NaN,
33+
},
34+
};
35+
const value = values[type][conf.value];
36+
37+
buff[`write${type}${endian}`](value, 0, noAssert);
38+
const testFunction = new Function('buff', `
39+
for (var i = 0; i !== ${len}; i++) {
40+
buff.${fn}(0, ${JSON.stringify(noAssert)});
41+
}
42+
`);
43+
bench.start();
44+
testFunction(buff);
45+
bench.end(len / 1e6);
46+
}

lib/buffer.js

+65-24
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,6 @@ const {
3131
indexOfBuffer,
3232
indexOfNumber,
3333
indexOfString,
34-
readDoubleBE: _readDoubleBE,
35-
readDoubleLE: _readDoubleLE,
36-
readFloatBE: _readFloatBE,
37-
readFloatLE: _readFloatLE,
3834
swap16: _swap16,
3935
swap32: _swap32,
4036
swap64: _swap64,
@@ -1197,35 +1193,80 @@ Buffer.prototype.readInt32BE = function readInt32BE(offset, noAssert) {
11971193
};
11981194

11991195

1200-
Buffer.prototype.readFloatLE = function readFloatLE(offset, noAssert) {
1201-
offset = offset >>> 0;
1202-
if (!noAssert)
1203-
checkOffset(offset, 4, this.length);
1204-
return _readFloatLE(this, offset);
1196+
// For the casual reader who has not at the current time memorized the
1197+
// IEEE-754 standard in full detail: floating point numbers consist of
1198+
// a fraction, an exponent and a sign bit: 23+8+1 bits for single precision
1199+
// numbers and 52+11+1 bits for double precision numbers.
1200+
//
1201+
// A zero exponent is either a positive or negative zero, if the fraction
1202+
// is zero, or a denormalized number when it is non-zero. Multiplying the
1203+
// fraction by the smallest possible denormal yields the denormalized number.
1204+
//
1205+
// An all-bits-one exponent is either a positive or negative infinity, if
1206+
// the fraction is zero, or NaN when it is non-zero. The standard allows
1207+
// both quiet and signalling NaNs but since NaN is a canonical value in
1208+
// JavaScript, we cannot (and do not) distinguish between the two.
1209+
//
1210+
// Other exponents are regular numbers and are computed by subtracting the bias
1211+
// from the exponent (127 for single precision, 1023 for double precision),
1212+
// yielding an exponent in the ranges -126-127 and -1022-1024 respectively.
1213+
//
1214+
// Of interest is that the fraction of a normal number has an extra bit of
1215+
// precision that is not stored but is reconstructed by adding one after
1216+
// multiplying the fraction with the result of 2**-bits_in_fraction.
1217+
1218+
1219+
function toDouble(x0, x1) {
1220+
const frac = x0 + 0x100000000 * (x1 & 0xFFFFF);
1221+
const expt = (x1 >>> 20) & 2047;
1222+
const sign = (x1 >>> 31) ? -1 : 1;
1223+
if (expt === 0) {
1224+
if (frac === 0) return sign * 0;
1225+
return sign * frac * 2 ** -1074;
1226+
} else if (expt === 2047) {
1227+
if (frac === 0) return sign * Infinity;
1228+
return NaN;
1229+
}
1230+
return sign * 2 ** (expt - 1023) * (1 + frac * 2 ** -52);
1231+
}
1232+
1233+
1234+
function toFloat(x) {
1235+
const frac = x & 0x7FFFFF;
1236+
const expt = (x >>> 23) & 255;
1237+
const sign = (x >>> 31) ? -1 : 1;
1238+
if (expt === 0) {
1239+
if (frac === 0) return sign * 0;
1240+
return sign * frac * 2 ** -149;
1241+
} else if (expt === 255) {
1242+
if (frac === 0) return sign * Infinity;
1243+
return NaN;
1244+
}
1245+
return sign * 2 ** (expt - 127) * (1 + frac * 2 ** -23);
1246+
}
1247+
1248+
1249+
Buffer.prototype.readDoubleBE = function(offset, noAssert) {
1250+
const x1 = this.readUInt32BE(offset + 0, noAssert);
1251+
const x0 = this.readUInt32BE(offset + 4, noAssert);
1252+
return toDouble(x0, x1);
12051253
};
12061254

12071255

1208-
Buffer.prototype.readFloatBE = function readFloatBE(offset, noAssert) {
1209-
offset = offset >>> 0;
1210-
if (!noAssert)
1211-
checkOffset(offset, 4, this.length);
1212-
return _readFloatBE(this, offset);
1256+
Buffer.prototype.readDoubleLE = function(offset, noAssert) {
1257+
const x0 = this.readUInt32LE(offset + 0, noAssert);
1258+
const x1 = this.readUInt32LE(offset + 4, noAssert);
1259+
return toDouble(x0, x1);
12131260
};
12141261

12151262

1216-
Buffer.prototype.readDoubleLE = function readDoubleLE(offset, noAssert) {
1217-
offset = offset >>> 0;
1218-
if (!noAssert)
1219-
checkOffset(offset, 8, this.length);
1220-
return _readDoubleLE(this, offset);
1263+
Buffer.prototype.readFloatBE = function(offset, noAssert) {
1264+
return toFloat(this.readUInt32BE(offset, noAssert));
12211265
};
12221266

12231267

1224-
Buffer.prototype.readDoubleBE = function readDoubleBE(offset, noAssert) {
1225-
offset = offset >>> 0;
1226-
if (!noAssert)
1227-
checkOffset(offset, 8, this.length);
1228-
return _readDoubleBE(this, offset);
1268+
Buffer.prototype.readFloatLE = function(offset, noAssert) {
1269+
return toFloat(this.readUInt32LE(offset, noAssert));
12291270
};
12301271

12311272

src/node_buffer.cc

-48
Original file line numberDiff line numberDiff line change
@@ -718,49 +718,6 @@ static inline void Swizzle(char* start, unsigned int len) {
718718
}
719719

720720

721-
template <typename T, enum Endianness endianness>
722-
void ReadFloatGeneric(const FunctionCallbackInfo<Value>& args) {
723-
THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]);
724-
SPREAD_BUFFER_ARG(args[0], ts_obj);
725-
726-
uint32_t offset = args[1]->Uint32Value();
727-
CHECK_LE(offset + sizeof(T), ts_obj_length);
728-
729-
union NoAlias {
730-
T val;
731-
char bytes[sizeof(T)];
732-
};
733-
734-
union NoAlias na;
735-
const char* ptr = static_cast<const char*>(ts_obj_data) + offset;
736-
memcpy(na.bytes, ptr, sizeof(na.bytes));
737-
if (endianness != GetEndianness())
738-
Swizzle(na.bytes, sizeof(na.bytes));
739-
740-
args.GetReturnValue().Set(na.val);
741-
}
742-
743-
744-
void ReadFloatLE(const FunctionCallbackInfo<Value>& args) {
745-
ReadFloatGeneric<float, kLittleEndian>(args);
746-
}
747-
748-
749-
void ReadFloatBE(const FunctionCallbackInfo<Value>& args) {
750-
ReadFloatGeneric<float, kBigEndian>(args);
751-
}
752-
753-
754-
void ReadDoubleLE(const FunctionCallbackInfo<Value>& args) {
755-
ReadFloatGeneric<double, kLittleEndian>(args);
756-
}
757-
758-
759-
void ReadDoubleBE(const FunctionCallbackInfo<Value>& args) {
760-
ReadFloatGeneric<double, kBigEndian>(args);
761-
}
762-
763-
764721
template <typename T, enum Endianness endianness>
765722
void WriteFloatGeneric(const FunctionCallbackInfo<Value>& args) {
766723
Environment* env = Environment::GetCurrent(args);
@@ -1275,11 +1232,6 @@ void Initialize(Local<Object> target,
12751232
env->SetMethod(target, "indexOfNumber", IndexOfNumber);
12761233
env->SetMethod(target, "indexOfString", IndexOfString);
12771234

1278-
env->SetMethod(target, "readDoubleBE", ReadDoubleBE);
1279-
env->SetMethod(target, "readDoubleLE", ReadDoubleLE);
1280-
env->SetMethod(target, "readFloatBE", ReadFloatBE);
1281-
env->SetMethod(target, "readFloatLE", ReadFloatLE);
1282-
12831235
env->SetMethod(target, "writeDoubleBE", WriteDoubleBE);
12841236
env->SetMethod(target, "writeDoubleLE", WriteDoubleLE);
12851237
env->SetMethod(target, "writeFloatBE", WriteFloatBE);

0 commit comments

Comments
 (0)