kernel: Add k_thread_runtime_stats_is_enabled function #80450

rruuaanng · 2024-10-25T14:59:37Z

Add 'k_thread_runtime_stats_is_enabled' to 'usage.c', which's used to check whether runtime statistics collection is enabled for a thread.

It can determine whether the thread has enabled runtime statistics collection when the program is running. It allows users to add conditional statements based on this function when using it.

for example:

void f()
{
    // Assume there is a thread id
    if (k_thread_runtime_stats_is_enabled(id)) {
        /* do something */
    }
    ...
}

And it can provide a complete support when similar operations are needed. for example enable, disable, is_enabled.
For example, its use in the implementation of CLOCK_THREAD_CPUTIME_ID actually lacks k_thread_runtime_stats_is_enabled, which makes the entire function impossible to implement safely. It is necessary.

..

cfriedt

Thanks for all of the POSIX clock work.

Just a question / suggestion regarding runtime function call overhead.

include/zephyr/kernel.h

cfriedt

Just some suggestions around CONFIG_POSIX_THREAD_CPUTIME

lib/posix/options/clock.c

rruuaanng · 2024-10-28T04:26:54Z

I've made change, Please riewer again!

lib/posix/options/clock.c

peter-mitsis

Kernel side seems reasonable to me.

rruuaanng · 2025-03-29T05:22:34Z

INFO: Error found: portability.posix.c_lib_ext on qemu_cortex_m0/nrf51822 (Not enough RAM but is one of the integration platforms)
INFO: Error found: portability.posix.c_lib_ext.minimal on qemu_cortex_m0/nrf51822 (Not enough RAM but is one of the integration platforms)
INFO: Error found: portability.posix.c_lib_ext.newlib on qemu_cortex_m0/nrf51822 (Not enough RAM but is one of the integration platforms)
INFO: Error found: portability.posix.c_lib_ext.picolibc on qemu_cortex_m0/nrf51822 (Not enough RAM but is one of the integration platforms)

Hmmmm...

Ugh... This is exactly why I thought #86634 was a mistake.

Fine. It seems difficult to handle.

cfriedt · 2025-03-29T11:03:15Z

@rruuaanng - it's possible that this has been fixed already. But you will need to rebase to fix merge conflicts anyway.

rruuaanng · 2025-04-01T02:32:05Z

It seems to still exist :(

INFO: Total tests gathered: 9506
INFO: Error found: portability.posix.c_lib_ext on qemu_cortex_m0/nrf51822 (Not enough RAM but is one of the integration platforms)
INFO: Error found: portability.posix.c_lib_ext.minimal on qemu_cortex_m0/nrf51822 (Not enough RAM but is one of the integration platforms)
INFO: Error found: portability.posix.c_lib_ext.newlib on qemu_cortex_m0/nrf51822 (Not enough RAM but is one of the integration platforms)
INFO: Error found: portability.posix.c_lib_ext.picolibc on qemu_cortex_m0/nrf51822 (Not enough RAM but is one of the integration platforms)

other:

#87561

ycsin · 2025-04-22T16:31:35Z

@rruuaanng this needs another rebase

peter-mitsis · 2025-06-30T17:53:39Z

@rruuaanng - Looks like this has conflicts that need to get resolved.

andyross

Tiny nitpick. I'll let others weigh in on the posix changes, seems like that could be a separate PR? +1 for the meat of the PR.

andyross · 2025-07-01T14:47:28Z

include/zephyr/kernel.h

+ * @param thread ID of thread
+ * @return true if usage statistics are enabled for the given thread, otherwise false
+ */
+bool k_thread_runtime_stats_is_enabled(k_tid_t thread);


If this just depends on the thread struct, that header appears in the include paths already. You can make this inline without worry and save a few code bytes for users.

Maybe we should stick to the existing API style? It looks like there are no static inline functions in kernel.h.

Add 'k_thread_runtime_stats_is_enabled' function, whichs used to check whether runtime statistics collection is enabled for a thread. Signed-off-by: James Roy <rruuaanng@outlook.com>

Add test for 'k_thread_runtime_stats_is_enabled(tid)'. Signed-off-by: James Roy <rruuaanng@outlook.com>

Add the `k_thread_runtime_stats_is_enabled` function to check if runtime statistics are enabled. Signed-off-by: James Roy <rruuaanng@outlook.com>

rruuaanng · 2025-07-15T08:14:16Z

I will open a new PR to finish the POSIX part, just to avoid any confusion.

sonarqubecloud · 2025-07-15T08:37:09Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

rruuaanng force-pushed the gh80363 branch 2 times, most recently from fc52903 to 075a033 Compare October 25, 2024 15:12

rruuaanng changed the title ~~kernel: Add k_thread_runtime_stats_enabled function~~ kernel: Add k_thread_runtime_stats_is_enabled function Oct 25, 2024

rruuaanng marked this pull request as ready for review October 25, 2024 15:28

zephyrbot added the area: Kernel label Oct 25, 2024

zephyrbot requested review from andyross, ceolin, cfriedt, dcpleung, nashif, npitre, peter-mitsis and TaiJuWu October 25, 2024 15:28

zephyrbot assigned andyross and peter-mitsis Oct 25, 2024

zephyrbot added the area: POSIX POSIX API Library label Oct 26, 2024

zephyrbot requested a review from ycsin October 26, 2024 10:40

rruuaanng force-pushed the gh80363 branch 2 times, most recently from 70b4aa0 to 04e6d25 Compare October 26, 2024 12:02

cfriedt reviewed Oct 26, 2024

View reviewed changes

include/zephyr/kernel.h Outdated Show resolved Hide resolved

cfriedt requested changes Oct 27, 2024

View reviewed changes

lib/posix/options/clock.c Outdated Show resolved Hide resolved

lib/posix/options/clock.c Outdated Show resolved Hide resolved

lib/posix/options/clock.c Outdated Show resolved Hide resolved

rruuaanng force-pushed the gh80363 branch 2 times, most recently from 5302a73 to e9323cc Compare October 28, 2024 04:18

rruuaanng requested a review from cfriedt October 28, 2024 04:26

rruuaanng force-pushed the gh80363 branch from e9323cc to d339612 Compare October 28, 2024 05:20

ycsin reviewed Oct 28, 2024

View reviewed changes

lib/posix/options/clock.c Outdated Show resolved Hide resolved

rruuaanng force-pushed the gh80363 branch from d339612 to 36fc311 Compare October 28, 2024 10:45

peter-mitsis previously approved these changes Oct 28, 2024

View reviewed changes

ycsin previously approved these changes Oct 29, 2024

View reviewed changes

rruuaanng force-pushed the gh80363 branch from a61b032 to 0b72c3c Compare March 30, 2025 06:16

rruuaanng force-pushed the gh80363 branch from 0b72c3c to e91686e Compare April 12, 2025 04:45

rruuaanng requested review from cfriedt, peter-mitsis and ycsin April 16, 2025 14:20

peter-mitsis previously approved these changes Apr 16, 2025

View reviewed changes

ycsin previously approved these changes Apr 17, 2025

View reviewed changes

cfriedt previously approved these changes Apr 17, 2025

View reviewed changes

rruuaanng dismissed stale reviews from cfriedt, ycsin, and peter-mitsis via 45a24db May 4, 2025 09:35

rruuaanng force-pushed the gh80363 branch from e91686e to 45a24db Compare May 4, 2025 09:35

github-actions bot requested review from danieldegrasse and dkalowsk May 4, 2025 09:37

rruuaanng force-pushed the gh80363 branch from 45a24db to de08f94 Compare July 1, 2025 14:35

andyross previously approved these changes Jul 1, 2025

View reviewed changes

rruuaanng marked this pull request as draft July 3, 2025 13:24

rruuaanng added 3 commits July 15, 2025 15:59

kernel: Add k_thread_runtime_stats_is_enabled function

1b58c3d

Add 'k_thread_runtime_stats_is_enabled' function, whichs used to check whether runtime statistics collection is enabled for a thread. Signed-off-by: James Roy <rruuaanng@outlook.com>

tests: kernel: Add k_thread_runtime_stats_is_enabled function unittest

7bd9a92

Add test for 'k_thread_runtime_stats_is_enabled(tid)'. Signed-off-by: James Roy <rruuaanng@outlook.com>

doc: releases: Add a kernel release entry

e272c98

Add the `k_thread_runtime_stats_is_enabled` function to check if runtime statistics are enabled. Signed-off-by: James Roy <rruuaanng@outlook.com>

rruuaanng dismissed andyross’s stale review via e272c98 July 15, 2025 08:11

rruuaanng force-pushed the gh80363 branch from de08f94 to e272c98 Compare July 15, 2025 08:11

rruuaanng marked this pull request as ready for review July 15, 2025 08:14

kernel: Add k_thread_runtime_stats_is_enabled function #80450

Are you sure you want to change the base?

kernel: Add k_thread_runtime_stats_is_enabled function #80450

Conversation

rruuaanng commented Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cfriedt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cfriedt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rruuaanng commented Oct 28, 2024

Uh oh!

Uh oh!

peter-mitsis left a comment

Choose a reason for hiding this comment

Uh oh!

rruuaanng commented Mar 29, 2025

Uh oh!

cfriedt commented Mar 29, 2025

Uh oh!

rruuaanng commented Apr 1, 2025

Uh oh!

ycsin commented Apr 22, 2025

Uh oh!

peter-mitsis commented Jun 30, 2025

Uh oh!

andyross left a comment

Choose a reason for hiding this comment

Uh oh!

andyross Jul 1, 2025

Choose a reason for hiding this comment

Uh oh!

rruuaanng Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

rruuaanng commented Jul 15, 2025

Uh oh!

sonarqubecloud bot commented Jul 15, 2025

Quality Gate passed

Uh oh!

Uh oh!

rruuaanng commented Oct 25, 2024 •

edited

Loading