os: add availableParallelism() #45895

cjihrig · 2022-12-17T03:23:06Z

This commit exposes uv_available_parallelism() as an alternative to cpus().length. uv_available_parallelism() is inspired by Rust's available_parallelism().

doc/api/os.md

src/node_os.cc

doc/api/os.md

src/node_os.cc

jasnell · 2022-12-19T16:39:02Z

doc/api/os.md

+* Returns: {integer}
+
+Returns an estimate of the default amount of parallelism a program should use.
+Always returns a value greater than zero.


Some explanation about how that estimate is reached would be helpful here.

Here is the PR that added this functionality to libuv - libuv/libuv@f250c6c. If you have some exact text you'd like to see based on that, I'm happy to add it. The CI has been so flaky (and frustrating) that I don't want to go back and forth with pushing changes, running the CI, making more changes, etc. - I'd rather just ship whatever suggestions you have.

Alternatively, a docs update could be added after the fact since the CI requirements for docs only changes are much lower.

The implementation of uv_available_parallelism() will likely evolve over time so the docs here shouldn't be too specific, or they'll become outdated.

My suggestions are to a) link to the libuv documentation, b) leave it out, or c) say we consult the animating spirits inside the computer.

I'd like to see how option C plays out.

Returns an estimate of the default amount of parallelism a program should use. Always returns a value greater than zero. On Linux, inspects the calling thread’s CPU affinity mask to determine if it has been pinned to specific CPUs. On Windows, the available parallelism may be underreported on systems with more than 64 logical CPUs. On other platforms, reports the number of CPUs that the operating system considers to be online. The heuristics used are expected to evolve over time and may vary across operating systems.

Or, if nothing else, link to the libuv documentation.

Does not answer the question of what it does inside of a cgroup, which is the primary problem with cpus()

It's not mentioned because it's oblivious to the presence of cgroups.

I'm not a fan of adding new features that replicate open bugs in existing functionality.

Also #28855 specifically asks for this problem (cgoups causing process count to be wrong) to be fixed, which is what my question is asking. Obliviousness is exactly the problem. cpus().length is oblivious to cgroups and gives the processor count of the host, not what's available to the container.

If the answer is 'no', we still don't have a solution to the issue that was marked closed.

I'm lousy at reading C code, but I think this is saying:

libuv/libuv@f250c6c
https://www.cygwin.com/bugzilla/show_bug.cgi?id=27645

That sysconf() works on musl (eg, Alpine Linux?) but not on glibc (eg, Ubuntu, CoreOS). But the extra call in the conditional block in the libuv commit above emulates the musl behavior. If I've followed that right, then the answer is 'yes' and it's not oblivious to cgroups.

It's oblivious in the "cache oblivious algorithm" sense: libuv doesn't have to care whether cgroups are active or not; if the container is set up properly, it'll produce the right answer.

jasnell · 2022-12-19T16:46:22Z

LGTM but I would like to see the doc comment addressed.

nodejs-github-bot · 2022-12-20T14:35:11Z

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

With the introduction of os.availableParallelism(), users should no longer rely on os.cpus().length to determine the amount of available parallelism. This commit adds a note to the os.cpus() docs. PR-URL: #45895 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refs: #45895 PR-URL: #45979 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Notable changes: buffer: * (SEMVER-MINOR) add buffer.isUtf8 for utf8 validation (Yagiz Nizipli) #45947 http: * (SEMVER-MINOR) improved timeout defaults handling (Paolo Insogna) #45778 net * add autoSelectFamily global getter and setter (Paolo Insogna) #45777 os: * (SEMVER-MINOR) add availableParallelism() (Colin Ihrig) #45895 util: * add fast path for text-decoder fatal flag (Yagiz Nizipli) #45803 PR-URL: #46061

Refs: #45895 PR-URL: #46003 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

Refs: nodejs#45895 PR-URL: nodejs#46003 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

Refs: #45895 PR-URL: #46003 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

This commit exposes uv_available_parallelism() as an alternative to cpus().length. uv_available_parallelism() is inspired by Rust's available_parallelism(). PR-URL: #45895 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

With the introduction of os.availableParallelism(), users should no longer rely on os.cpus().length to determine the amount of available parallelism. This commit adds a note to the os.cpus() docs. PR-URL: #45895 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refs: #45895 PR-URL: #45979 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Refs: #45895 PR-URL: #46003 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

This commit exposes uv_available_parallelism() as an alternative to cpus().length. uv_available_parallelism() is inspired by Rust's available_parallelism(). PR-URL: #45895 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

With the introduction of os.availableParallelism(), users should no longer rely on os.cpus().length to determine the amount of available parallelism. This commit adds a note to the os.cpus() docs. PR-URL: #45895 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refs: #45895 PR-URL: #45979 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Refs: #45895 PR-URL: #46003 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

Notable changes: * deps: * upgrade npm to 9.3.1 (npm team) #46242 * doc: * add parallelism note to os.cpus() (Colin Ihrig) #45895 * http: * join authorization headers (Marco Ippolito) #45982 * improved timeout defaults handling (Paolo Insogna) #45778 * stream: * implement finished() for ReadableStream and WritableStream (Debadree Chatterjee) #46205 PR-URL: #46396

Refs: nodejs/node#45895

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. os Issues and PRs related to the os subsystem. labels Dec 17, 2022

cjihrig force-pushed the avp branch 2 times, most recently from 16c93ee to 9a3b8a8 Compare December 17, 2022 03:37

MoLow reviewed Dec 17, 2022

View reviewed changes

doc/api/os.md Show resolved Hide resolved

MoLow approved these changes Dec 17, 2022

View reviewed changes

BridgeAR approved these changes Dec 17, 2022

View reviewed changes

cjihrig removed the needs-ci PRs that need a full CI run. label Dec 17, 2022

This comment was marked as outdated.

Sign in to view

cjihrig added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 17, 2022

lpinca approved these changes Dec 17, 2022

View reviewed changes

anonrig reviewed Dec 18, 2022

View reviewed changes

src/node_os.cc Show resolved Hide resolved

bnoordhuis approved these changes Dec 18, 2022

View reviewed changes

doc/api/os.md Outdated Show resolved Hide resolved

src/node_os.cc Show resolved Hide resolved

cjihrig force-pushed the avp branch from 9a3b8a8 to fac2368 Compare December 18, 2022 15:39

This comment was marked as outdated.

Sign in to view

github-actions bot mentioned this pull request Dec 19, 2022

CI Reliability 2022-12-19 nodejs/reliability#462

Open

14 tasks

This comment was marked as outdated.

Sign in to view

jasnell reviewed Dec 19, 2022

View reviewed changes

jasnell approved these changes Dec 19, 2022

View reviewed changes

addaleax approved these changes Dec 19, 2022

View reviewed changes

addaleax added the semver-minor PRs that contain new features and should be released in the next minor version. label Dec 19, 2022

This comment was marked as outdated.

Sign in to view

github-actions bot mentioned this pull request Dec 20, 2022

CI Reliability 2022-12-20 nodejs/reliability#463

Open

14 tasks

SimenB mentioned this pull request Jan 6, 2023

feat: use os.availableParallelism if available jestjs/jest#13738

Merged

juanarbol mentioned this pull request Jan 28, 2023

V18.14.0 proposal #46396

Merged

abhishekumar-tyagi pushed a commit to abhishekumar-tyagi/node that referenced this pull request May 5, 2024

doc: use os.availableParallelism() in async_context and cluster

fa286c6

Refs: nodejs/node#45895

abhishekumar-tyagi pushed a commit to abhishekumar-tyagi/node that referenced this pull request May 5, 2024

test: use os.availableParallelism()

2747363

Refs: nodejs/node#45895

abhishekumar-tyagi pushed a commit to abhishekumar-tyagi/node that referenced this pull request May 5, 2024

benchmark,tools: use os.availableParallelism()

35a551e

Refs: nodejs/node#45895

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

os: add availableParallelism() #45895

os: add availableParallelism() #45895

cjihrig commented Dec 17, 2022

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

jasnell Dec 19, 2022

cjihrig Dec 19, 2022

bnoordhuis Dec 20, 2022

cjihrig Dec 20, 2022

jasnell Dec 20, 2022

jdmarshall Jan 6, 2023

bnoordhuis Jan 6, 2023

jdmarshall Jan 6, 2023 •

edited

Loading

jdmarshall Jan 6, 2023 •

edited

Loading

bnoordhuis Jan 7, 2023

jasnell commented Dec 19, 2022

This comment was marked as outdated.

This comment was marked as outdated.

nodejs-github-bot commented Dec 20, 2022 •

edited by jasnell

Loading

os: add availableParallelism() #45895

os: add availableParallelism() #45895

Conversation

cjihrig commented Dec 17, 2022

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jdmarshall Jan 6, 2023 • edited Loading

Choose a reason for hiding this comment

jdmarshall Jan 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell commented Dec 19, 2022

This comment was marked as outdated.

This comment was marked as outdated.

nodejs-github-bot commented Dec 20, 2022 • edited by jasnell Loading

jdmarshall Jan 6, 2023 •

edited

Loading

jdmarshall Jan 6, 2023 •

edited

Loading

nodejs-github-bot commented Dec 20, 2022 •

edited by jasnell

Loading