process: implement process.hrtime.bigint() #21256

joyeecheung · 2018-06-11T09:47:41Z

The first commit is from #21255

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

nodejs-github-bot · 2018-06-11T09:47:42Z

@joyeecheung build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/38/pipeline

joyeecheung · 2018-06-11T09:52:35Z

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

joyeecheung · 2018-06-11T09:54:28Z

test/parallel/test-process-hrtime-bigint.js

+  message: 'The "time" argument must be of type bigint. Received type object'
+});
+
+// The default behavior, return an Array "tuple" of numbers


Oops, copy-paste error..

devsnek

is it still a perf boost to use the ArrayBuffer when it's just one value?

joyeecheung · 2018-06-11T14:10:58Z

@devsnek I don't think it makes much difference, probably can save an allocation depending on the situation though.

TimothyGu · 2018-06-11T15:41:45Z

doc/api/process.md

+
+setTimeout(() => {
+  const diff = process.hrtime.bigint(time);
+  // 1552n


Was this supposed to be 1000000552n?

TimothyGu · 2018-06-11T15:42:34Z

doc/api/process.md

+
+If `time` is specified, it must be the result of a previous
+`process.hrtime.bigint()` call. The returned result will be the difference
+between the current time and the specified time.


While useful for the array-based method, I don’t think this feature is that useful now one can just subtract the times directly…

@TimothyGu Yeah come to think of it, it does seem unnecessary. I'll remove it.

TimothyGu · 2018-06-11T15:44:22Z

src/node.cc

+void HrtimeBigInt(const FunctionCallbackInfo<Value>& args) {
+  Local<ArrayBuffer> ab = args[0].As<BigUint64Array>()->Buffer();
+  uint64_t* fields = static_cast<uint64_t*>(ab->GetContents().Data());
+  fields[0] = uv_hrtime();


I’d also appreciate some benchmarking showing that the ArrayBuffer-based approach is faster than just returning the bigint.

@TimothyGu There are no APIs for constructing a BigInt out of a uint64_t at the moment, it seems.

I could add one for uint64_t, but there is a discussion going on about the general API design of BigInt: https://bugs.chromium.org/p/v8/issues/detail?id=7712 A simple overload would be ambiguous anyway.

targos · 2018-06-12T17:05:53Z

doc/api/process.md

+
+Unlike [`process.hrtime()`][], it does not support an additional `time`
+argument since the difference can just be computed directly
+by substraction of the two `bigint`s.


subtraction

vsemozhetbyt · 2018-06-12T19:39:07Z

doc/api/process.md

+  // 191052633396993n
+
+  console.log(`Benchmark took ${end - start} nanoseconds`);
+  // benchmark took 1154389282 nanoseconds


benchmark -> Benchmark?

apapirovski

I'm +1 on the addition but I'm not a fan of the scoping. Has there been some discussion around this? Personally I'm not a huge fan of putting bigint functions on top of existing functions. The naming ends up being pretty non-obvious plus it's an extra property lookup. Even hrtimeBigInt is more appealing to me, personally.

joyeecheung · 2018-06-13T05:20:48Z

@apapirovski The naming is following the convention of fs.realpath.native, this is the best I can think of in terms of readability since adding another overload to the process.hrtime([time]) would be quite confusing and unlike the fs.*stats methods, it is unlikely to need another variant (e.g. temporal) in the future.

The extra lookup can be avoided if the user assign the function to an identifier first (also if they are already using process.hrtime then the overhead of that extra lookup may be irrelevant considering process is already pretty complex).

Another idea would be to expose a symbol similar to util.promisify.custom but that may bring in too much redirection overhead and it's hard to get it play along with other symbols if we stick to that pattern.

joyeecheung · 2018-06-13T05:26:34Z

For reference: there is also whatwg/webidl#525 and w3c/IndexedDB#231

cc @littledan do you have any suggestion regarding how to expose variants of existing APIs that support BigInt?

TimothyGu

LGTM other than the doc nit.

TimothyGu · 2018-06-15T23:20:44Z

src/node.cc

@@ -1580,6 +1581,9 @@ static void Kill(const FunctionCallbackInfo<Value>& args) {
 #define NANOS_PER_SEC 1000000000

 // Hrtime exposes libuv's uv_hrtime() high-resolution timer.
+
+// This is the legacy version of hrtime before BigInt was introduced in
+// JavaScript.


Hmm, seeing this we probably want a note in the documentation for process.hrtime() that the BigInt equivalent is preferred.

joyeecheung · 2018-06-16T14:27:48Z

Rebased and addressed nits: https://ci.nodejs.org/job/node-test-pull-request/15494/

joyeecheung · 2018-06-17T11:29:54Z

CI is green. @apapirovski is your review in #21256 (review) blocking?

apapirovski

@joyeecheung nope, it wasn't. :)

joyeecheung · 2018-06-17T14:40:13Z

Landed in 1d8a231, thanks!

PR-URL: #21256 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>

targos · 2018-06-19T06:59:15Z

Depends on #21105 to land on v10.x-staging.

PR-URL: #21256 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>

Notable changes: * console: * The `console.timeLog()` method has been implemented. (#21312) * deps: * Upgrade to libuv 1.22.0. (#21731) * Upgrade to ICU 62.1 (Unicode 11, CLDR 33.1). (#21728) * http: * Added support for passing both `timeout` and `agent` options to `http.request`. (#21204) * napi: * Added experimental support for functions dealing with bigint numbers. (#21226) * process: * The `process.hrtime.bigint()` method has been implemented. (#21256) * Added the `--title` command line argument to set the process title on startup. (#21477) * trace_events: * Added process_name metadata. (#21477)

Notable changes: * console: * The `console.timeLog()` method has been implemented. (#21312) * deps: * Upgrade to libuv 1.22.0. (#21731) * Upgrade to ICU 62.1 (Unicode 11, CLDR 33.1). (#21728) * http: * Added support for passing both `timeout` and `agent` options to `http.request`. (#21204) * napi: * Added experimental support for functions dealing with bigint numbers. (#21226) * process: * The `process.hrtime.bigint()` method has been implemented. (#21256) * Added the `--title` command line argument to set the process title on startup. (#21477) * trace_events: * Added process_name metadata. (#21477) * Added new collaborators * codebytere - Shelley Vohr PR-URL: #21851

Notable changes: * console: * The `console.timeLog()` method has been implemented. (#21312) * deps: * Upgrade to libuv 1.22.0. (#21731) * Upgrade to ICU 62.1 (Unicode 11, CLDR 33.1). (#21728) * http: * Added support for passing both `timeout` and `agent` options to `http.request`. (#21204) * inspector: * Expose the original console API in `require('inspector').console`. (#21659) * napi: * Added experimental support for functions dealing with bigint numbers. (#21226) * process: * The `process.hrtime.bigint()` method has been implemented. (#21256) * Added the `--title` command line argument to set the process title on startup. (#21477) * trace_events: * Added process_name metadata. (#21477) * Added new collaborators * codebytere - Shelley Vohr PR-URL: #21851

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Jun 11, 2018

joyeecheung force-pushed the bigint-hrtime branch from 84cd2cd to f7ba146 Compare June 11, 2018 09:52

joyeecheung commented Jun 11, 2018

View reviewed changes

devsnek approved these changes Jun 11, 2018

View reviewed changes

joyeecheung added the semver-minor PRs that contain new features and should be released in the next minor version. label Jun 11, 2018

TimothyGu reviewed Jun 11, 2018

View reviewed changes

devsnek approved these changes Jun 12, 2018

View reviewed changes

targos approved these changes Jun 12, 2018

View reviewed changes

vsemozhetbyt reviewed Jun 12, 2018

View reviewed changes

apapirovski reviewed Jun 13, 2018

View reviewed changes

cjihrig approved these changes Jun 13, 2018

View reviewed changes

jasnell approved these changes Jun 13, 2018

View reviewed changes

addaleax approved these changes Jun 14, 2018

View reviewed changes

TimothyGu approved these changes Jun 15, 2018

View reviewed changes

joyeecheung added 2 commits June 16, 2018 17:47

process: implement process.hrtime.bigint()

30533c7

fixup! process: implement process.hrtime.bigint()

b4d45ba

joyeecheung force-pushed the bigint-hrtime branch from 1ff4825 to b4d45ba Compare June 16, 2018 09:51

apapirovski approved these changes Jun 17, 2018

View reviewed changes

jasnell approved these changes Jun 17, 2018

View reviewed changes

joyeecheung closed this Jun 17, 2018

targos added the backport-requested-v10.x label Jun 19, 2018

targos mentioned this pull request Jun 20, 2018

process: split bootstrappers by threads that can run them #21378

Closed

2 tasks

targos removed the backport-requested-v10.x label Jul 14, 2018

targos mentioned this pull request Jul 17, 2018

v10.7.0 proposal #21851

Merged

MylesBorins added dont-land-on-v6.x labels Aug 10, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

process: implement process.hrtime.bigint() #21256

process: implement process.hrtime.bigint() #21256

joyeecheung commented Jun 11, 2018 •

edited

Loading

nodejs-github-bot commented Jun 11, 2018

joyeecheung commented Jun 11, 2018

joyeecheung Jun 11, 2018

devsnek left a comment

joyeecheung commented Jun 11, 2018 •

edited

Loading

TimothyGu Jun 11, 2018

TimothyGu Jun 11, 2018

joyeecheung Jun 11, 2018

TimothyGu Jun 11, 2018

joyeecheung Jun 11, 2018

joyeecheung Jun 11, 2018 •

edited

Loading

targos Jun 12, 2018

vsemozhetbyt Jun 12, 2018

apapirovski left a comment

joyeecheung commented Jun 13, 2018

joyeecheung commented Jun 13, 2018

TimothyGu left a comment

TimothyGu Jun 15, 2018

joyeecheung commented Jun 16, 2018

joyeecheung commented Jun 17, 2018

apapirovski left a comment

joyeecheung commented Jun 17, 2018

targos commented Jun 19, 2018

process: implement process.hrtime.bigint() #21256

process: implement process.hrtime.bigint() #21256

Conversation

joyeecheung commented Jun 11, 2018 • edited Loading

Checklist

nodejs-github-bot commented Jun 11, 2018

joyeecheung commented Jun 11, 2018

Choose a reason for hiding this comment

devsnek left a comment

Choose a reason for hiding this comment

joyeecheung commented Jun 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joyeecheung Jun 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apapirovski left a comment

Choose a reason for hiding this comment

joyeecheung commented Jun 13, 2018

joyeecheung commented Jun 13, 2018

TimothyGu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joyeecheung commented Jun 16, 2018

joyeecheung commented Jun 17, 2018

apapirovski left a comment

Choose a reason for hiding this comment

joyeecheung commented Jun 17, 2018

targos commented Jun 19, 2018

joyeecheung commented Jun 11, 2018 •

edited

Loading

joyeecheung commented Jun 11, 2018 •

edited

Loading

joyeecheung Jun 11, 2018 •

edited

Loading