util: improve util.format performance #5360

evanlucas · 2016-02-22T08:57:24Z

By manually copying arguments and breaking the try/catch out, we are able to improve the performance of util.format by 20-100% (depending on the types).

Also includes a util.format benchmark.

The numbers:

running ./node
util/format.js
running ./node_before
util/format.js

util/format.js n=1000000 type=string: ./node: 7866600 ./node_before: 1705900 ... 361.13%
util/format.js n=1000000 type=number: ./node: 7718000 ./node_before: 1778900 ... 333.87%
util/format.js n=1000000 type=object: ./node: 1811800 ./node_before: 800160 .... 126.43%
util/format.js n=1000000 type=unknown: ./node: 13045000 ./node_before: 2650300 . 392.22%
util/format.js n=1000000 type=no-replace: ./node: 1541500 ./node_before: 956760 . 61.11%

EDIT: I updated the numbers after rebasing on master and with @mscdex's changes included as well.

evanlucas · 2016-02-22T08:58:24Z

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

mscdex · 2016-02-22T09:14:41Z

lib/util.js

@@ -21,21 +29,20 @@ exports.format = function(f) {

  if (arguments.length === 1) return f;

+  const len = arguments.length;
+  const args = new Array(len);
+  for (let i = 0; i < len; i++) {


Use var here until v8 can optimize let better.

mscdex · 2016-02-22T09:25:30Z

lib/util.js

@@ -21,21 +29,20 @@ exports.format = function(f) {

  if (arguments.length === 1) return f;

+  const len = arguments.length;
+  const args = new Array(len);
+  for (var i = 0; i < len; i++) {


Sorry, you'll also need to move the var i declaration out and above and change var i = 1; a few lines below to i = 1 to avoid a linter error.

yep, just noticed that locally. Thanks

mscdex · 2016-02-22T09:28:18Z

For bonus points, you can change

for (var x = args[i]; i < len; x = args[++i]) {

to

while (i < len) {
  const x = args[i++];

to avoid an eager deopt due to potential out of bounds access on args.

evanlucas · 2016-02-22T09:40:02Z

Ah, totally missed the case where f is not a string. Added a benchmark and updated for that as well

mscdex · 2016-02-22T09:45:12Z

lib/util.js

+    args[i] = arguments[i];
+  }
+
+  i = 1;
  var str = String(f).replace(formatRegExp, function(x) {


String(f) here can probably just be replaced with just f since it should already be a string at that point.

evanlucas · 2016-02-22T09:45:31Z

ooo good catch

mscdex · 2016-02-22T09:47:13Z

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

mscdex · 2016-02-22T10:56:40Z

Just for fun I replaced the regexp + replace function with a simple loop and improved performance an additional 60-200% in the benchmarks included (and no change in the no-replace case) in this PR.

evanlucas · 2016-02-22T11:08:46Z

wow, nice

jasnell · 2016-03-02T16:52:20Z

Marking this LTS watch but I'd rather this sit for a bit before getting pulled back.

jasnell · 2016-03-02T16:52:25Z

LGTM

evanlucas · 2016-03-04T22:56:23Z

Running CI again: https://ci.nodejs.org/job/node-test-pull-request/1851/

PR-URL: nodejs#5360 Reviewed-By: James M Snell <jasnell@gmail.com>

By manually copying arguments and breaking the try/catch out, we are able to improve the performance of util.format by 20-100% (depending on the types). PR-URL: nodejs#5360 Reviewed-By: James M Snell <jasnell@gmail.com>

Replacing the regexp and replace function with a loop improves performance by ~60-200%. PR-URL: nodejs#5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins · 2016-05-17T22:38:38Z

@jasnell would you want to include this in a future lts?

jasnell · 2016-05-17T23:19:50Z

I believe so yes.

MylesBorins · 2016-07-01T00:11:37Z

@jasnell / @nodejs/lts how much longer to we want this to live before backporting?

jasnell · 2016-07-01T00:17:24Z

I haven't heard of any regressions. We may be good on this one
On Jun 30, 2016 5:11 PM, "Myles Borins" notifications@github.com wrote:

@jasnell https://github.com/jasnell / @nodejs/lts
https://github.com/orgs/nodejs/teams/lts how much longer to we want
this to live before backporting?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#5360 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AAa2eVV5PJs-GWjQjX7nl55qNJMiSNYGks5qRFtAgaJpZM4HfWa3
.

By manually copying arguments and breaking the try/catch out, we are able to improve the performance of util.format by 20-100% (depending on the types). PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

Replacing the regexp and replace function with a loop improves performance by ~60-200%. PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins · 2016-07-11T19:46:43Z

I've gone ahead and added this to v4.x-staging and will include it in the v4.5.0 rc.

@evanlucas please let me know if there are any accompanying patch's we need to make this work

MylesBorins · 2016-07-11T21:31:18Z

@evanlucas as a heads up you need to provide the commit before your initial commit when doing the ... syntax to specify a range.

735e0df...c490b8b does not include 735e0df

By manually copying arguments and breaking the try/catch out, we are able to improve the performance of util.format by 20-100% (depending on the types). PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

Replacing the regexp and replace function with a loop improves performance by ~60-200%. PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

evanlucas · 2016-07-12T10:24:59Z

@thealphanerd there shouldn't be anything else need to land these. Thanks for the heads up on the range syntax as well :]

By manually copying arguments and breaking the try/catch out, we are able to improve the performance of util.format by 20-100% (depending on the types). PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

Replacing the regexp and replace function with a loop improves performance by ~60-200%. PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

evanlucas added util Issues and PRs related to the built-in util module. benchmark Issues and PRs related to the benchmark subsystem. performance Issues and PRs related to the performance of Node.js. labels Feb 22, 2016

mscdex reviewed Feb 22, 2016
View reviewed changes

evanlucas force-pushed the utilformatbench branch from 447e7f1 to 88039b9 Compare February 22, 2016 09:15

mscdex reviewed Feb 22, 2016
View reviewed changes

evanlucas force-pushed the utilformatbench branch from 88039b9 to 429ad25 Compare February 22, 2016 09:27

evanlucas force-pushed the utilformatbench branch 2 times, most recently from 7a00928 to 91fc8b4 Compare February 22, 2016 09:39

mscdex reviewed Feb 22, 2016
View reviewed changes

evanlucas force-pushed the utilformatbench branch from 91fc8b4 to 6fd10fe Compare February 22, 2016 09:46

jasnell added the lts-watch-v4.x label Mar 2, 2016

evanlucas force-pushed the utilformatbench branch from 774a86e to fe2996a Compare March 4, 2016 22:55

evanlucas and others added 3 commits March 4, 2016 17:27

benchmark: add util.format benchmark

735e0df

PR-URL: nodejs#5360 Reviewed-By: James M Snell <jasnell@gmail.com>

util: improve util.format performance

8d72b0d

By manually copying arguments and breaking the try/catch out, we are able to improve the performance of util.format by 20-100% (depending on the types). PR-URL: nodejs#5360 Reviewed-By: James M Snell <jasnell@gmail.com>

util: improve format() performance further

c490b8b

Replacing the regexp and replace function with a loop improves performance by ~60-200%. PR-URL: nodejs#5360 Reviewed-By: James M Snell <jasnell@gmail.com>

evanlucas force-pushed the utilformatbench branch from fe2996a to c490b8b Compare March 4, 2016 23:28

evanlucas closed this Mar 4, 2016

evanlucas deleted the utilformatbench branch March 4, 2016 23:28

evanlucas merged commit c490b8b into nodejs:master Mar 4, 2016

andrasq mentioned this pull request Jul 11, 2016

util: possible way to speed up util.format() #5285

Closed

MylesBorins pushed a commit that referenced this pull request Jul 11, 2016

util: improve format() performance further

a7a623b

Replacing the regexp and replace function with a loop improves performance by ~60-200%. PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins added land-on-v4.x and removed lts-watch-v4.x labels Jul 11, 2016

MylesBorins mentioned this pull request Jul 11, 2016

Audit commits not found on v4.x-staging #7661

Closed

MylesBorins pushed a commit that referenced this pull request Jul 11, 2016

util: improve format() performance further

34dc1cd

Replacing the regexp and replace function with a loop improves performance by ~60-200%. PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins pushed a commit that referenced this pull request Jul 11, 2016

benchmark: add util.format benchmark

d2d5784

PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins pushed a commit that referenced this pull request Jul 12, 2016

benchmark: add util.format benchmark

fc34e9a

PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins pushed a commit that referenced this pull request Jul 12, 2016

util: improve format() performance further

d0bf09d

Replacing the regexp and replace function with a loop improves performance by ~60-200%. PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins pushed a commit that referenced this pull request Jul 12, 2016

benchmark: add util.format benchmark

b0ab564

PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins mentioned this pull request Jul 12, 2016

v4.5.0 proposal #7688

Merged

MylesBorins pushed a commit that referenced this pull request Jul 14, 2016

benchmark: add util.format benchmark

aa7ca85

PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins pushed a commit that referenced this pull request Jul 14, 2016

benchmark: add util.format benchmark

08cd81b

PR-URL: #5360 Reviewed-By: James M Snell <jasnell@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: improve util.format performance #5360

util: improve util.format performance #5360

evanlucas commented Feb 22, 2016

evanlucas commented Feb 22, 2016

mscdex Feb 22, 2016

mscdex Feb 22, 2016

evanlucas Feb 22, 2016

mscdex commented Feb 22, 2016

evanlucas commented Feb 22, 2016

mscdex Feb 22, 2016

evanlucas commented Feb 22, 2016

mscdex commented Feb 22, 2016

mscdex commented Feb 22, 2016

evanlucas commented Feb 22, 2016

jasnell commented Mar 2, 2016

jasnell commented Mar 2, 2016

evanlucas commented Mar 4, 2016

MylesBorins commented May 17, 2016

jasnell commented May 17, 2016

MylesBorins commented Jul 1, 2016

jasnell commented Jul 1, 2016

MylesBorins commented Jul 11, 2016

MylesBorins commented Jul 11, 2016

evanlucas commented Jul 12, 2016

util: improve util.format performance #5360

util: improve util.format performance #5360

Conversation

evanlucas commented Feb 22, 2016

evanlucas commented Feb 22, 2016

mscdex Feb 22, 2016

Choose a reason for hiding this comment

mscdex Feb 22, 2016

Choose a reason for hiding this comment

evanlucas Feb 22, 2016

Choose a reason for hiding this comment

mscdex commented Feb 22, 2016

evanlucas commented Feb 22, 2016

mscdex Feb 22, 2016

Choose a reason for hiding this comment

evanlucas commented Feb 22, 2016

mscdex commented Feb 22, 2016

mscdex commented Feb 22, 2016

evanlucas commented Feb 22, 2016

jasnell commented Mar 2, 2016

jasnell commented Mar 2, 2016

evanlucas commented Mar 4, 2016

MylesBorins commented May 17, 2016

jasnell commented May 17, 2016

MylesBorins commented Jul 1, 2016

jasnell commented Jul 1, 2016

MylesBorins commented Jul 11, 2016

MylesBorins commented Jul 11, 2016

evanlucas commented Jul 12, 2016