Skip to content

Conversation

@JonasNorlinder
Copy link
Member

@JonasNorlinder JonasNorlinder commented Nov 28, 2025

Since kernel v2.6.12 the Linux ABI have had support for encoding the clock types in the last three bits. Setting bit to 001 (CPUCLOCK_VIRT) will result in the kernel returning only user time. POSIX compliant implementations of pthread_getcpuclockid for the Linux kernel defaults to construct a clockid that with 010 (CPUCLOCK_SCHED) set, which return system+user time, which is what the POSIX standard mandates, see POSIX.1-2024/IEEE Std 1003.1-2024 §3.90. This patch joins the family of glibc, musl etc. that utilities this bit pattern.

This PR also results in improved performance and thus a reduced observer effect, especially for the 100th percentile (max).

Before patch:

Benchmark                  Mode      Cnt  Score    Error  Units
CPUTime.execute          sample  7506555  0.008 ±  0.001  ms/op
CPUTime.execute:p0.00    sample           0.008           ms/op
CPUTime.execute:p0.50    sample           0.008           ms/op
CPUTime.execute:p0.90    sample           0.008           ms/op
CPUTime.execute:p0.95    sample           0.008           ms/op
CPUTime.execute:p0.99    sample           0.012           ms/op
CPUTime.execute:p0.999   sample           0.015           ms/op
CPUTime.execute:p0.9999  sample           0.021           ms/op
CPUTime.execute:p1.00    sample           1.030           ms/op

After patch:

Benchmark                  Mode      Cnt   Score    Error  Units
CPUTime.execute          sample  8984189  ≈ 10⁻³           ms/op
CPUTime.execute:p0.00    sample           ≈ 10⁻³           ms/op
CPUTime.execute:p0.50    sample           ≈ 10⁻³           ms/op
CPUTime.execute:p0.90    sample           ≈ 10⁻³           ms/op
CPUTime.execute:p0.95    sample           ≈ 10⁻³           ms/op
CPUTime.execute:p0.99    sample            0.001           ms/op
CPUTime.execute:p0.999   sample            0.001           ms/op
CPUTime.execute:p0.9999  sample            0.006           ms/op
CPUTime.execute:p1.00    sample            0.054           ms/op

Testing: java/lang/management/ThreadMXBean/ThreadUserTime.java and the added microbenchmark.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8372584: [Linux]: Replace reading proc to get thread user CPU time with clock_gettime (Enhancement - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/28556/head:pull/28556
$ git checkout pull/28556

Update a local copy of the PR:
$ git checkout pull/28556
$ git pull https://git.openjdk.org/jdk.git pull/28556/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 28556

View PR using the GUI difftool:
$ git pr show -t 28556

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/28556.diff

Using Webrev

Link to Webrev Comment

Fixy

Remove imports added by IDE

Remove imports added by IDE

Don't touch bit 3

Fix name
@bridgekeeper
Copy link

bridgekeeper bot commented Nov 28, 2025

👋 Welcome back jnorlinder! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Nov 28, 2025

@JonasNorlinder This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8372584: [Linux]: Replace reading proc to get thread user CPU time with clock_gettime

Reviewed-by: redestad

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 24 new commits pushed to the master branch:

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@dholmes-ora, @cl4es) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk
Copy link

openjdk bot commented Nov 28, 2025

@JonasNorlinder The following label will be automatically applied to this pull request:

  • hotspot-runtime

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@JonasNorlinder JonasNorlinder marked this pull request as ready for review November 28, 2025 12:05
@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 28, 2025
@mlbridge
Copy link

mlbridge bot commented Nov 28, 2025

Webrevs

@JonasNorlinder
Copy link
Member Author

/issue add JDK-8210452

@openjdk
Copy link

openjdk bot commented Nov 28, 2025

@JonasNorlinder
Adding additional issue to issue list: 8210452: getCurrentThreadUserTime is 30x-400x times slower then getCurrentThreadCpuTime.

@dholmes-ora
Copy link
Member

@JonasNorlinder this PR isn't fixing two issue. I think JDK-8372584 should just be closed as a duplicate of JDK-8210452 (which I had forgotten about and which @larry-cable did not get further with).

Copy link
Member

@dholmes-ora dholmes-ora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good. I'd forgotten that I found about this in 2018.

A few minor nits.

Can't really comment on the benchmark.

// set, which return system+user time, which is what the POSIX standard mandates, see
// POSIX.1-2024/IEEE Std 1003.1-2024 §3.90.
static clockid_t get_thread_clockid(Thread* thread, bool total, bool* success) {
constexpr clockid_t CLOCK_TYPE_MASK = 3;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the mask be covering 3-bits?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No we should not touch bit 3 which encodes if the clock is for a thread of process. See here https://elixir.bootlin.com/linux/v6.17.9/source/include/linux/posix-timers_types.h#L9-L19.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay so

encoding the clock types in the last three bits

needs a bit more explanation.

// It's possible to encounter a terminated native thread that failed
// to detach itself from the VM - which should result in ESRCH.
assert_status(rc == ESRCH, rc, "pthread_getcpuclockid failed");
*success = false;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The normal way I've seen this pattern used is to set it to true rather than assuming it was true to begin with.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using a positive outcome like success to encode the outcome make it possible to return like so return success ? os::Linux::thread_cpu_time(clockid) : -1;. I prefer having the -1 at the end as I find this reads easier. If we encode a failure we would need to write return !failure ? os::Linux::thread_cpu_time(clockid) : -1;. Hence, I would prefer keeping this as is as double-negatives may be harder to parse.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay but you are setting up a usage requirement without documenting anywhere that that requirement exists.

Copy link
Member

@cl4es cl4es left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Microbenchmark looks good

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Dec 1, 2025
@JonasNorlinder
Copy link
Member Author

/issue remove JDK-8210452

@openjdk
Copy link

openjdk bot commented Dec 1, 2025

@JonasNorlinder
Removing additional issue from issue list: 8210452.

Comment on lines +4961 to +4966
// Since kernel v2.6.12 the Linux ABI has had support for encoding the clock types
// in the last three bits. Setting bit to 001 (CPUCLOCK_VIRT) will result in the kernel
// returning only user time. POSIX compliant implementations of pthread_getcpuclockid
// for the Linux kernel defaults to construct a clockid with 010 (CPUCLOCK_SCHED)
// set, which return system+user time, which is what the POSIX standard mandates, see
// POSIX.1-2024/IEEE Std 1003.1-2024 §3.90.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the bit encoding could be made somewhat clearer.

// Since kernel v2.6.12 the Linux ABI has had support for encoding the clock types in
// the last three bits. Bit 2 indicates whether a cpu clock refers to a thread or a process.
// Bits 1 and 0 give the type: PROF=0, VIRT=1, SCHED=2, or FD=3. 
// The clock CPUCLOCK_VIRT (0b001) reports the thread's consumed user time. 
// POSIX compliant implementations of pthread_getcpuclockid return the clock CPUCLOCK_SCHED
// (0b010) which reports the thread's consumed system+user time (as mandated by the POSIX
// standard POSIX.1-2024/IEEE Std 1003.1-2024 §3.90)

// for the Linux kernel defaults to construct a clockid with 010 (CPUCLOCK_SCHED)
// set, which return system+user time, which is what the POSIX standard mandates, see
// POSIX.1-2024/IEEE Std 1003.1-2024 §3.90.
static clockid_t get_thread_clockid(Thread* thread, bool total, bool* success) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static clockid_t get_thread_clockid(Thread* thread, bool total, bool* success) {
// The out parameter `success` is required to be initialized to `true`.
static clockid_t get_thread_clockid(Thread* thread, bool total, bool* success) {
assert(success != nullptr && *success, "incorrect initialization");

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hotspot-runtime [email protected] ready Pull request is ready to be integrated rfr Pull request is ready for review

Development

Successfully merging this pull request may close these issues.

4 participants