Skip to content

Commit

Permalink
buffer: do not leak memory if buffer is too big
Browse files Browse the repository at this point in the history
A recent pull request changed this method to throw when the buffer was
too big, but this meant that the `free` finalizer would never get
called, leading to a memory leak.

Included is a test which provokes this behavior using `v8.serialize`.
Technically the behavior is allocator-dependent, but I suspect any
reasonable allocator will choose to free (or at the very least, reuse)
the 1 GiB memory.

Refs: nodejs#40243
  • Loading branch information
kvakil committed Jul 22, 2022
1 parent 0484022 commit 4c2d9a6
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/node_buffer.cc
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,7 @@ MaybeLocal<Object> New(Environment* env,
if (length > kMaxLength) {
Isolate* isolate(env->isolate());
isolate->ThrowException(ERR_BUFFER_TOO_LARGE(isolate));
free(data);
return Local<Object>();
}
}
Expand Down
32 changes: 32 additions & 0 deletions test/pummel/test-v8-serialize-buffer-too-large.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
'use strict';
const common = require('../common');

// On IBMi, the rss memory always returns zero
if (common.isIBMi)
common.skip('On IBMi, the rss memory always returns zero');

const v8 = require('v8');
const { kMaxLength } = require('buffer');

const PADDING_STRING = 'a'.repeat(3000);

const i = 22;
const toSerialize = {};

for (let j = 0; j < 2 ** i; j++) {
toSerialize[j] = PADDING_STRING;
}

const assert = require('assert');

const rssBefore = process.memoryUsage.rss();

// Fail to serialize a few times.
const expectedError = { code: 'ERR_BUFFER_TOO_LARGE' };
assert.throws(() => v8.serialize(toSerialize), expectedError);
assert.throws(() => v8.serialize(toSerialize), expectedError);
assert.throws(() => v8.serialize(toSerialize), expectedError);

// Check that (at least some of) the memory got freed.
const rssAfter = process.memoryUsage.rss();
assert(rssAfter - rssBefore <= 2 * kMaxLength);

0 comments on commit 4c2d9a6

Please sign in to comment.