Revert "buffer: move SlowBuffer to EOL"

This reverts commit 0579e0e

PR-URL: #58211
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Joyee Cheung <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>

Author: panva

benchmark/buffers/buffer-iterate.js

@@ -1,5 +1,5 @@
 'use strict';
-const { Buffer } = require('buffer');
+const SlowBuffer = require('buffer').SlowBuffer;
 const common = require('../common.js');
 const assert = require('assert');
 
@@ -19,7 +19,7 @@ const methods = {
 function main({ size, type, method, n }) {
   const buffer = type === 'fast' ?
     Buffer.alloc(size) :
-    Buffer.allocUnsafeSlow(size).fill(0);
+    SlowBuffer(size).fill(0);
 
   const fn = methods[method];
 

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

@@ -1,6 +1,5 @@
 'use strict';
 const common = require('../common.js');
-const { Buffer } = require('buffer');
 
 const types = [
   'IntBE',
@@ -19,7 +18,7 @@ const bench = common.createBenchmark(main, {
 function main({ n, buf, type, byteLength }) {
   const buff = buf === 'fast' ?
     Buffer.alloc(8) :
-    Buffer.allocUnsafeSlow(8);
+    require('buffer').SlowBuffer(8);
   const fn = `read${type}`;
 
   buff.writeDoubleLE(0, 0);

benchmark/buffers/buffer-read.js

@@ -1,6 +1,5 @@
 'use strict';
 const common = require('../common.js');
-const { Buffer } = require('buffer');
 
 const types = [
   'BigUInt64LE',
@@ -28,7 +27,7 @@ const bench = common.createBenchmark(main, {
 function main({ n, buf, type }) {
   const buff = buf === 'fast' ?
     Buffer.alloc(8) :
-    Buffer.allocUnsafeSlow(8);
+    require('buffer').SlowBuffer(8);
   const fn = `read${type}`;
 
   buff.writeDoubleLE(0, 0);

benchmark/buffers/buffer-slice.js

@@ -1,14 +1,14 @@
 'use strict';
 const common = require('../common.js');
-const { Buffer } = require('buffer');
+const SlowBuffer = require('buffer').SlowBuffer;
 
 const bench = common.createBenchmark(main, {
   type: ['fast', 'slow', 'subarray'],
   n: [1e6],
 });
 
 const buf = Buffer.allocUnsafe(1024);
-const slowBuf = Buffer.allocUnsafeSlow(1024);
+const slowBuf = new SlowBuffer(1024);
 
 function main({ n, type }) {
   const b = type === 'slow' ? slowBuf : buf;

benchmark/buffers/buffer-write.js

@@ -1,6 +1,6 @@
 'use strict';
 const common = require('../common.js');
-const { Buffer } = require('buffer');
+
 const types = [
   'BigUInt64LE',
   'BigUInt64BE',
@@ -73,7 +73,7 @@ const byteLength = {
 function main({ n, buf, type }) {
   const buff = buf === 'fast' ?
     Buffer.alloc(8) :
-    Buffer.allocUnsafeSlow(8);
+    require('buffer').SlowBuffer(8);
   const fn = `write${type}`;
 
   if (!/\d/.test(fn))

doc/api/buffer.md

@@ -5340,6 +5340,28 @@ 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
@@ -5472,11 +5494,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()`][] 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.
+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.
 
 ```console
 $ node --zero-fill-buffers

doc/api/cli.md

@@ -3111,7 +3111,8 @@ node --watch --watch-preserve-output test.js
 added: v6.0.0
 -->
 
-Automatically zero-fills all newly allocated [`Buffer`][] instances.
+Automatically zero-fills all newly allocated [`Buffer`][] and [`SlowBuffer`][]
+instances.
 
 ## Environment variables
 
@@ -3886,6 +3887,7 @@ 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

doc/api/deprecations.md

@@ -695,9 +695,6 @@ Type: End-of-Life
 
 <!-- YAML
 changes:
-  - version: v24.0.0
-    pr-url: https://github.com/nodejs/node/pull/58008
-    description: End-of-Life.
   - version: v24.0.0
     pr-url: https://github.com/nodejs/node/pull/55175
     description: Runtime deprecation.
@@ -709,9 +706,9 @@ changes:
     description: Documentation-only deprecation.
 -->
 
-Type: End-of-Life
+Type: Runtime
 
-The `SlowBuffer` class has been removed. Please use
+The [`SlowBuffer`][] class is deprecated. Please use
 [`Buffer.allocUnsafeSlow(size)`][] instead.
 
 ### DEP0031: `ecdh.setPublicKey()`
@@ -3921,6 +3918,7 @@ 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

doc/contributing/writing-and-running-benchmarks.md

@@ -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 { Buffer } = require('node:buffer');
+const { SlowBuffer } = require('node:buffer');
 
 const configs = {
   // Number of operations, specified here so they show up in the report.
@@ -603,11 +603,10 @@ function main(conf) {
   bench.start();
 
   // Do operations here
+  const BufferConstructor = conf.type === 'fast' ? Buffer : SlowBuffer;
 
   for (let i = 0; i < conf.n; i++) {
-    conf.type === 'fast' ?
-      Buffer.allocUnsafe(conf.size) :
-      Buffer.allocUnsafeSlow(conf.size);
+    new BufferConstructor(conf.size);
   }
 
   // End the timer, pass in the number of operations

doc/node.1

@@ -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 instances.
+Automatically zero-fills all newly allocated Buffer and SlowBuffer instances.
 .
 .It Fl c , Fl -check
 Check the script's syntax without executing it.

lib/buffer.js

@@ -52,6 +52,7 @@ const {
   TypedArrayPrototypeSet,
   TypedArrayPrototypeSlice,
   Uint8Array,
+  Uint8ArrayPrototype,
 } = primordials;
 
 const {
@@ -88,6 +89,7 @@ const {
   kIsEncodingSymbol,
   defineLazyProperties,
   encodingsMap,
+  deprecate,
 } = require('internal/util');
 const {
   isAnyArrayBuffer,
@@ -409,15 +411,25 @@ Buffer.allocUnsafe = function allocUnsafe(size) {
 };
 
 /**
- * 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.
+ * 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.
  */
 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();
@@ -1319,6 +1331,10 @@ function isAscii(input) {
 
 module.exports = {
   Buffer,
+  SlowBuffer: deprecate(
+    SlowBuffer,
+    'SlowBuffer() is deprecated. Please use Buffer.allocUnsafeSlow()',
+    'DEP0030'),
   transcode,
   isUtf8,
   isAscii,

src/node_options.cc

@@ -1052,7 +1052,8 @@ PerProcessOptionsParser::PerProcessOptionsParser(
             &PerProcessOptions::v8_thread_pool_size,
             kAllowedInEnvvar);
   AddOption("--zero-fill-buffers",
-            "automatically zero-fill all newly allocated Buffer instances",
+            "automatically zero-fill all newly allocated Buffer and "
+            "SlowBuffer instances",
             &PerProcessOptions::zero_fill_all_buffers,
             kAllowedInEnvvar);
   AddOption("--debug-arraybuffer-allocations",

test/parallel/test-buffer-alloc.js

@@ -5,7 +5,7 @@ const assert = require('assert');
 const vm = require('vm');
 
 const {
-  Buffer,
+  SlowBuffer,
   kMaxLength,
 } = require('buffer');
 
@@ -1104,6 +1104,9 @@ 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.
@@ -1136,7 +1139,7 @@ assert.throws(() => {
   a.copy(b, 0, 0x100000000, 0x100000001);
 }, outOfRangeError);
 
-// Unpooled buffer
+// Unpooled buffer (replaces SlowBuffer)
 {
   const ubuf = Buffer.allocUnsafeSlow(10);
   assert(ubuf);

test/parallel/test-buffer-bytelength.js

@@ -2,7 +2,7 @@
 
 const common = require('../common');
 const assert = require('assert');
-const { Buffer } = require('buffer');
+const SlowBuffer = require('buffer').SlowBuffer;
 const vm = require('vm');
 
 [
@@ -24,6 +24,7 @@ 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)));

test/parallel/test-buffer-failed-alloc-typed-arrays.js

@@ -2,7 +2,7 @@
 
 require('../common');
 const assert = require('assert');
-const { Buffer } = require('buffer');
+const SlowBuffer = require('buffer').SlowBuffer;
 
 // Test failed or zero-sized Buffer allocations not affecting typed arrays.
 // This test exists because of a regression that occurred. Because Buffer
@@ -15,6 +15,7 @@ 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,

test/parallel/test-buffer-inspect.js

@@ -30,7 +30,7 @@ buffer.INSPECT_MAX_BYTES = 2;
 let b = Buffer.allocUnsafe(4);
 b.fill('1234');
 
-let s = Buffer.allocUnsafeSlow(4);
+let s = buffer.SlowBuffer(4);
 s.fill('1234');
 
 let expected = '<Buffer 31 32 ... 2 more bytes>';
@@ -41,7 +41,7 @@ assert.strictEqual(util.inspect(s), expected);
 b = Buffer.allocUnsafe(2);
 b.fill('12');
 
-s = Buffer.allocUnsafeSlow(2);
+s = buffer.SlowBuffer(2);
 s.fill('12');
 
 expected = '<Buffer 31 32>';

test/parallel/test-buffer-no-negative-allocation.js

@@ -2,6 +2,7 @@
 
 require('../common');
 const assert = require('assert');
+const { SlowBuffer } = require('buffer');
 
 const msg = {
   code: 'ERR_OUT_OF_RANGE',
@@ -29,3 +30,8 @@ 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);

test/parallel/test-buffer-over-max-length.js

@@ -4,6 +4,7 @@ require('../common');
 const assert = require('assert');
 
 const buffer = require('buffer');
+const SlowBuffer = buffer.SlowBuffer;
 
 const kMaxLength = buffer.kMaxLength;
 const bufferMaxSizeMsg = {
@@ -12,6 +13,7 @@ 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);