Skip to content

buffer: move SlowBuffer to EOL #58008

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.

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
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions benchmark/buffers/buffer-iterate.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
'use strict';
const SlowBuffer = require('buffer').SlowBuffer;
const { Buffer } = require('buffer');
const common = require('../common.js');
const assert = require('assert');

Expand All @@ -19,7 +19,7 @@ const methods = {
function main({ size, type, method, n }) {
const buffer = type === 'fast' ?
Buffer.alloc(size) :
SlowBuffer(size).fill(0);
Buffer.allocUnsafeSlow(size).fill(0);

const fn = methods[method];

Expand Down
3 changes: 2 additions & 1 deletion benchmark/buffers/buffer-read-with-byteLength.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict';
const common = require('../common.js');
const { Buffer } = require('buffer');

const types = [
'IntBE',
Expand All @@ -18,7 +19,7 @@ const bench = common.createBenchmark(main, {
function main({ n, buf, type, byteLength }) {
const buff = buf === 'fast' ?
Buffer.alloc(8) :
require('buffer').SlowBuffer(8);
Buffer.allocUnsafeSlow(8);
const fn = `read${type}`;

buff.writeDoubleLE(0, 0);
Expand Down
3 changes: 2 additions & 1 deletion benchmark/buffers/buffer-read.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict';
const common = require('../common.js');
const { Buffer } = require('buffer');

const types = [
'BigUInt64LE',
Expand Down Expand Up @@ -27,7 +28,7 @@ const bench = common.createBenchmark(main, {
function main({ n, buf, type }) {
const buff = buf === 'fast' ?
Buffer.alloc(8) :
require('buffer').SlowBuffer(8);
Buffer.allocUnsafeSlow(8);
const fn = `read${type}`;

buff.writeDoubleLE(0, 0);
Expand Down
4 changes: 2 additions & 2 deletions benchmark/buffers/buffer-slice.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
'use strict';
const common = require('../common.js');
const SlowBuffer = require('buffer').SlowBuffer;
const { Buffer } = require('buffer');

const bench = common.createBenchmark(main, {
type: ['fast', 'slow', 'subarray'],
n: [1e6],
});

const buf = Buffer.allocUnsafe(1024);
const slowBuf = new SlowBuffer(1024);
const slowBuf = Buffer.allocUnsafeSlow(1024);

function main({ n, type }) {
const b = type === 'slow' ? slowBuf : buf;
Expand Down
4 changes: 2 additions & 2 deletions benchmark/buffers/buffer-write.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use strict';
const common = require('../common.js');

const { Buffer } = require('buffer');
const types = [
'BigUInt64LE',
'BigUInt64BE',
Expand Down Expand Up @@ -73,7 +73,7 @@ const byteLength = {
function main({ n, buf, type }) {
const buff = buf === 'fast' ?
Buffer.alloc(8) :
require('buffer').SlowBuffer(8);
Buffer.allocUnsafeSlow(8);
const fn = `write${type}`;

if (!/\d/.test(fn))
Expand Down
32 changes: 5 additions & 27 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5340,28 +5340,6 @@ console.log(newBuf.toString('ascii'));
Because the Euro (`€`) sign is not representable in US-ASCII, it is replaced
with `?` in the transcoded `Buffer`.

### Class: `SlowBuffer`

<!-- YAML
deprecated: v6.0.0
-->

> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`][] instead.

See [`Buffer.allocUnsafeSlow()`][]. This was never a class in the sense that
the constructor always returned a `Buffer` instance, rather than a `SlowBuffer`
instance.

#### `new SlowBuffer(size)`

<!-- YAML
deprecated: v6.0.0
-->

* `size` {integer} The desired length of the new `SlowBuffer`.

See [`Buffer.allocUnsafeSlow()`][].

### Buffer constants

<!-- YAML
Expand Down Expand Up @@ -5494,11 +5472,11 @@ added: v5.10.0

Node.js can be started using the `--zero-fill-buffers` command-line option to
cause all newly-allocated `Buffer` instances to be zero-filled upon creation by
default. Without the option, buffers created with [`Buffer.allocUnsafe()`][],
[`Buffer.allocUnsafeSlow()`][], and `new SlowBuffer(size)` are not zero-filled.
Use of this flag can have a measurable negative impact on performance. Use the
`--zero-fill-buffers` option only when necessary to enforce that newly allocated
`Buffer` instances cannot contain old data that is potentially sensitive.
default. Without the option, buffers created with [`Buffer.allocUnsafe()`][] and
[`Buffer.allocUnsafeSlow()`][] are not zero-filled. Use of this flag can have a
measurable negative impact on performance. Use the `--zero-fill-buffers` option
only when necessary to enforce that newly allocated `Buffer` instances cannot
contain old data that is potentially sensitive.

```console
$ node --zero-fill-buffers
Expand Down
4 changes: 1 addition & 3 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3111,8 +3111,7 @@ node --watch --watch-preserve-output test.js
added: v6.0.0
-->

Automatically zero-fills all newly allocated [`Buffer`][] and [`SlowBuffer`][]
instances.
Automatically zero-fills all newly allocated [`Buffer`][] instances.

## Environment variables

Expand Down Expand Up @@ -3887,7 +3886,6 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12
[`ERR_UNSUPPORTED_TYPESCRIPT_SYNTAX`]: errors.md#err_unsupported_typescript_syntax
[`NODE_OPTIONS`]: #node_optionsoptions
[`NO_COLOR`]: https://no-color.org
[`SlowBuffer`]: buffer.md#class-slowbuffer
[`Web Storage`]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API
[`WebSocket`]: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
[`YoungGenerationSizeFromSemiSpaceSize`]: https://chromium.googlesource.com/v8/v8.git/+/refs/tags/10.3.129/src/heap/heap.cc#328
Expand Down
8 changes: 5 additions & 3 deletions doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,9 @@ Type: End-of-Life

<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/58008
description: End-of-Life.
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/55175
description: Runtime deprecation.
Expand All @@ -706,9 +709,9 @@ changes:
description: Documentation-only deprecation.
-->

Type: Runtime
Type: End-of-Life

The [`SlowBuffer`][] class is deprecated. Please use
The `SlowBuffer` class has been removed. Please use
[`Buffer.allocUnsafeSlow(size)`][] instead.

### DEP0031: `ecdh.setPublicKey()`
Expand Down Expand Up @@ -3921,7 +3924,6 @@ upon `require('node:module').builtinModules`.
[`ReadStream.open()`]: fs.md#class-fsreadstream
[`Server.getConnections()`]: net.md#servergetconnectionscallback
[`Server.listen({fd: <number>})`]: net.md#serverlistenhandle-backlog-callback
[`SlowBuffer`]: buffer.md#class-slowbuffer
[`String.prototype.toWellFormed`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toWellFormed
[`WriteStream.open()`]: fs.md#class-fswritestream
[`assert.CallTracker`]: assert.md#class-assertcalltracker
Expand Down
7 changes: 4 additions & 3 deletions doc/contributing/writing-and-running-benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ the code inside the `main` function if it's more than just declaration.
```js
'use strict';
const common = require('../common.js');
const { SlowBuffer } = require('node:buffer');
const { Buffer } = require('node:buffer');

const configs = {
// Number of operations, specified here so they show up in the report.
Expand Down Expand Up @@ -603,10 +603,11 @@ function main(conf) {
bench.start();

// Do operations here
const BufferConstructor = conf.type === 'fast' ? Buffer : SlowBuffer;

for (let i = 0; i < conf.n; i++) {
new BufferConstructor(conf.size);
conf.type === 'fast' ?
Buffer.allocUnsafe(conf.size) :
Buffer.allocUnsafeSlow(conf.size);
}

// End the timer, pass in the number of operations
Expand Down
2 changes: 1 addition & 1 deletion doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ If set to 0 then V8 will choose an appropriate size of the thread pool based on
If the value provided is larger than V8's maximum, then the largest value will be chosen.
.
.It Fl -zero-fill-buffers
Automatically zero-fills all newly allocated Buffer and SlowBuffer instances.
Automatically zero-fills all newly allocated Buffer instances.
.
.It Fl c , Fl -check
Check the script's syntax without executing it.
Expand Down
22 changes: 3 additions & 19 deletions lib/buffer.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ const {
TypedArrayPrototypeSet,
TypedArrayPrototypeSlice,
Uint8Array,
Uint8ArrayPrototype,
} = primordials;

const {
Expand Down Expand Up @@ -89,7 +88,6 @@ const {
kIsEncodingSymbol,
defineLazyProperties,
encodingsMap,
deprecate,
} = require('internal/util');
const {
isAnyArrayBuffer,
Expand Down Expand Up @@ -411,25 +409,15 @@ Buffer.allocUnsafe = function allocUnsafe(size) {
};

/**
* Equivalent to SlowBuffer(num), by default creates a non-zero-filled
* Buffer instance that is not allocated off the pre-initialized pool.
* If `--zero-fill-buffers` is set, will zero-fill the buffer.
* By default creates a non-zero-filled Buffer instance that is not allocated
* off the pre-initialized pool. If `--zero-fill-buffers` is set, will zero-fill
* the buffer.
*/
Buffer.allocUnsafeSlow = function allocUnsafeSlow(size) {
validateNumber(size, 'size', 0, kMaxLength);
return createUnsafeBuffer(size);
};

// If --zero-fill-buffers command line argument is set, a zero-filled
// buffer is returned.
function SlowBuffer(size) {
validateNumber(size, 'size', 0, kMaxLength);
return createUnsafeBuffer(size);
}

ObjectSetPrototypeOf(SlowBuffer.prototype, Uint8ArrayPrototype);
ObjectSetPrototypeOf(SlowBuffer, Uint8Array);

function allocate(size) {
if (size <= 0) {
return new FastBuffer();
Expand Down Expand Up @@ -1331,10 +1319,6 @@ function isAscii(input) {

module.exports = {
Buffer,
SlowBuffer: deprecate(
SlowBuffer,
'SlowBuffer() is deprecated. Please use Buffer.allocUnsafeSlow()',
'DEP0030'),
transcode,
isUtf8,
isAscii,
Expand Down
3 changes: 1 addition & 2 deletions src/node_options.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1052,8 +1052,7 @@ PerProcessOptionsParser::PerProcessOptionsParser(
&PerProcessOptions::v8_thread_pool_size,
kAllowedInEnvvar);
AddOption("--zero-fill-buffers",
"automatically zero-fill all newly allocated Buffer and "
"SlowBuffer instances",
"automatically zero-fill all newly allocated Buffer instances",
&PerProcessOptions::zero_fill_all_buffers,
kAllowedInEnvvar);
AddOption("--debug-arraybuffer-allocations",
Expand Down
7 changes: 2 additions & 5 deletions test/parallel/test-buffer-alloc.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const assert = require('assert');
const vm = require('vm');

const {
SlowBuffer,
Buffer,
kMaxLength,
} = require('buffer');

Expand Down Expand Up @@ -1104,9 +1104,6 @@ assert.throws(() => Buffer.from(null), {
// Test prototype getters don't throw
assert.strictEqual(Buffer.prototype.parent, undefined);
assert.strictEqual(Buffer.prototype.offset, undefined);
assert.strictEqual(SlowBuffer.prototype.parent, undefined);
assert.strictEqual(SlowBuffer.prototype.offset, undefined);


{
// Test that large negative Buffer length inputs don't affect the pool offset.
Expand Down Expand Up @@ -1139,7 +1136,7 @@ assert.throws(() => {
a.copy(b, 0, 0x100000000, 0x100000001);
}, outOfRangeError);

// Unpooled buffer (replaces SlowBuffer)
// Unpooled buffer
{
const ubuf = Buffer.allocUnsafeSlow(10);
assert(ubuf);
Expand Down
3 changes: 1 addition & 2 deletions test/parallel/test-buffer-bytelength.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const common = require('../common');
const assert = require('assert');
const SlowBuffer = require('buffer').SlowBuffer;
const { Buffer } = require('buffer');
const vm = require('vm');

[
Expand All @@ -24,7 +24,6 @@ const vm = require('vm');
});

assert(ArrayBuffer.isView(new Buffer(10)));
assert(ArrayBuffer.isView(new SlowBuffer(10)));
assert(ArrayBuffer.isView(Buffer.alloc(10)));
assert(ArrayBuffer.isView(Buffer.allocUnsafe(10)));
assert(ArrayBuffer.isView(Buffer.allocUnsafeSlow(10)));
Expand Down
3 changes: 1 addition & 2 deletions test/parallel/test-buffer-failed-alloc-typed-arrays.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

require('../common');
const assert = require('assert');
const SlowBuffer = require('buffer').SlowBuffer;
const { Buffer } = require('buffer');

// Test failed or zero-sized Buffer allocations not affecting typed arrays.
// This test exists because of a regression that occurred. Because Buffer
Expand All @@ -15,7 +15,6 @@ const zeroArray = new Uint32Array(10).fill(0);
const sizes = [1e20, 0, 0.1, -1, 'a', undefined, null, NaN];
const allocators = [
Buffer,
SlowBuffer,
Buffer.alloc,
Buffer.allocUnsafe,
Buffer.allocUnsafeSlow,
Expand Down
4 changes: 2 additions & 2 deletions test/parallel/test-buffer-inspect.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ buffer.INSPECT_MAX_BYTES = 2;
let b = Buffer.allocUnsafe(4);
b.fill('1234');

let s = buffer.SlowBuffer(4);
let s = Buffer.allocUnsafeSlow(4);
s.fill('1234');

let expected = '<Buffer 31 32 ... 2 more bytes>';
Expand All @@ -41,7 +41,7 @@ assert.strictEqual(util.inspect(s), expected);
b = Buffer.allocUnsafe(2);
b.fill('12');

s = buffer.SlowBuffer(2);
s = Buffer.allocUnsafeSlow(2);
s.fill('12');

expected = '<Buffer 31 32>';
Expand Down
6 changes: 0 additions & 6 deletions test/parallel/test-buffer-no-negative-allocation.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

require('../common');
const assert = require('assert');
const { SlowBuffer } = require('buffer');

const msg = {
code: 'ERR_OUT_OF_RANGE',
Expand Down Expand Up @@ -30,8 +29,3 @@ assert.throws(() => Buffer.allocUnsafeSlow(-Buffer.poolSize), msg);
assert.throws(() => Buffer.allocUnsafeSlow(-100), msg);
assert.throws(() => Buffer.allocUnsafeSlow(-1), msg);
assert.throws(() => Buffer.allocUnsafeSlow(NaN), msg);

assert.throws(() => SlowBuffer(-Buffer.poolSize), msg);
assert.throws(() => SlowBuffer(-100), msg);
assert.throws(() => SlowBuffer(-1), msg);
assert.throws(() => SlowBuffer(NaN), msg);
2 changes: 0 additions & 2 deletions test/parallel/test-buffer-over-max-length.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ require('../common');
const assert = require('assert');

const buffer = require('buffer');
const SlowBuffer = buffer.SlowBuffer;

const kMaxLength = buffer.kMaxLength;
const bufferMaxSizeMsg = {
Expand All @@ -13,7 +12,6 @@ const bufferMaxSizeMsg = {
};

assert.throws(() => Buffer(kMaxLength + 1), bufferMaxSizeMsg);
assert.throws(() => SlowBuffer(kMaxLength + 1), bufferMaxSizeMsg);
assert.throws(() => Buffer.alloc(kMaxLength + 1), bufferMaxSizeMsg);
assert.throws(() => Buffer.allocUnsafe(kMaxLength + 1), bufferMaxSizeMsg);
assert.throws(() => Buffer.allocUnsafeSlow(kMaxLength + 1), bufferMaxSizeMsg);
Loading
Loading