Skip to content

sys: clock: add sys_clock api and remove posix from iso c time #90096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

cfriedt
Copy link
Member

@cfriedt cfriedt commented May 18, 2025

  • sys: clock: additional sys_clock api calls
  • doc: release: 4.2.0: add sys_clock gettime settime nanosleep notes
  • libc: common: time: use sys_clock api rather than posix
  • libc: use the common libc time() implementation for most libcs
  • libc: common: thrd: use sys_clock_nanosleep() instead of nanosleep()
  • tests: lib: move time testsuite to c_lib
  • posix: use kernel sys_clock implementation
  • net: remove dependency on posix for iso c time() function
  • samples: net: remove POSIX_TIMERS and XSI_SINGLE_PROCESS

Should be merged after #90060, #90349

@cfriedt cfriedt force-pushed the remove-posix-from-time-equation branch 2 times, most recently from a403e85 to 83dc940 Compare May 18, 2025 02:00
@cfriedt cfriedt changed the title timeutil: correct position of doxygen end-group comment kernel: add k_clock api May 18, 2025
@cfriedt cfriedt changed the title kernel: add k_clock api kernel: add k_clock api: remove posix dependency from iso c time May 18, 2025
@cfriedt cfriedt force-pushed the remove-posix-from-time-equation branch 13 times, most recently from db7b057 to fe430cf Compare May 18, 2025 17:57
@cfriedt
Copy link
Member Author

cfriedt commented May 18, 2025

  • adding tests for timespec_to_timeout() and timeout_from_timespec()

I'd like to get those in better shape before marking this ready for review.

@cfriedt cfriedt force-pushed the remove-posix-from-time-equation branch from fe430cf to 9a4203b Compare May 20, 2025 18:02
@cfriedt cfriedt force-pushed the remove-posix-from-time-equation branch 2 times, most recently from 5078a47 to 730558c Compare May 20, 2025 20:41
@peter-mitsis
Copy link
Collaborator

Question ... would the proposed k_clock APIs be better served somewhere under /subsys as something like sys_clock APIs? I am wary of them being placed under /kernel.

@cfriedt
Copy link
Member Author

cfriedt commented May 21, 2025

Question ... would the proposed k_clock APIs be better served somewhere under /subsys as something like sys_clock APIs? I am wary of them being placed under /kernel.

sys_clock could maybe work for CLOCK_MONOTONIC and CLOCK_REALTIME, although I think there is a chance that it could start to creep into the kernel as well, if things like per-cpu clocks or CLOCK_THREAD_CPUTIME_ID or CLOCK_PROCESS_CPUTIME_ID become a thing, which is probable.

It might be possible to reuse existing APIs for calculating some of those things though.

@cfriedt cfriedt force-pushed the remove-posix-from-time-equation branch 2 times, most recently from 793d367 to 19947db Compare May 21, 2025 22:24
@cfriedt cfriedt changed the title kernel: add k_clock api: remove posix dependency from iso c time sys: clock: add sys_clock api and remove posix from iso c time May 22, 2025
@cfriedt cfriedt force-pushed the remove-posix-from-time-equation branch 3 times, most recently from 370277c to c5bbd4f Compare May 22, 2025 04:19
@cfriedt cfriedt force-pushed the remove-posix-from-time-equation branch 5 times, most recently from 65e5988 to f42ce7d Compare May 22, 2025 15:58
@cfriedt cfriedt added Release Notes To be mentioned in the release notes area: Base OS Base OS Library (lib/os) area: C Library C Standard Library area: Tests Issues related to a particular existing or missing test area: POSIX POSIX API Library labels May 22, 2025
Copy link
Collaborator

@peter-mitsis peter-mitsis left a comment

Choose a reason for hiding this comment

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

Looks great to me--spotted one minor remnant from the previous version of the change set in a commit message.

@@ -60,13 +60,14 @@ struct itimerspec {
#include <errno.h>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Commit message refers to k_clock instead of sys_clock

cfriedt added 12 commits May 23, 2025 19:51
The C standard does not guarantee that `thrd_success` is equal to
zero, so ensure that the test takes that into account.

Signed-off-by: Chris Friedt <[email protected]>
The specification does not say that the first struct timespec passed to
thrd_sleep() may be NULL.

Preserving the testpoint so that a possible future testsuite can be
run that expects faults to occur when undefined behaviour is used.

Faults are one possible solution to handling undefined behaviour, but
it would be good to come to a concensus about how that should be
handled in Zephyr for standard function calls belonging to ISO C or
POSIX.

Signed-off-by: Chris Friedt <[email protected]>
Use `timespec_from_timeout(K_MSEC(msec), &ts)` instead of leaning on
lazily-crafted timespecs with invalid tv_nsec fields.

Signed-off-by: Chris Friedt <[email protected]>
Additional entries for the sys_clock API, comprised of:

* sys_clock_gettime()
* sys_clock_settime()
* sys_clock_nanosleep()

along with the constants

* SYS_CLOCK_REALTIME
* SYS_CLOCK_MONOTONIC
* SYS_TIMER_ABSTIME

The primary motivation for this API is so that libc and other
libraries have a familiar-enough API to reach to when POSIX
is not available, since POSIX is optional in Zephyr.

By adding this API to lib/os, we also eliminate dependency cycles
between libc and posix, as lib/os is a mutual dependency.

Signed-off-by: Chris Friedt <[email protected]>
Add bullets to release notes for sys_clock_gettime(),
sys_clock_settime(), and sys_clock_nanosleep().

These changes were significant, as they make timekeeping dependencies
more independent between libc and posix, and remove several unnecessary
dependencies on posix for ISO C library routines.

Signed-off-by: Chris Friedt <[email protected]>
Remove POSIX clock_gettime() from the common libc time implementation,
since POSIX should not be a dependency for ISO C.

Instead, use the newly added lib/os sys_clock API.

Specifically, sys_clock_gettime().

Signed-off-by: Chris Friedt <[email protected]>
Use the implementation of time() from the common libc, since there
it no longer pulls in POSIX.

Use is implied for minimal, newlib, and picolibc, and selected
for IAR.

Signed-off-by: Chris Friedt <[email protected]>
Reduce the dependency on POSIX by taking advantage of the newly added
sys_clock_nanosleep().

Signed-off-by: Chris Friedt <[email protected]>
Presumably the time testsuite was separate from the c library set of
testsuites because it had a depedency on POSIX.

Since that dependency no longer exists, colocate the time testsuite
with the other c library testsuites.

Signed-off-by: Chris Friedt <[email protected]>
Use the newly added k_clock API in lib/os for

* clock_gettime()
* clock_settime()
* clock_nanosleep() and nanosleep()
* gettimeofday()

Signed-off-by: Chris Friedt <[email protected]>
The ISO C function time() should not depend on POSIX and this was
corrected recently via the common libc time() implementation.

Remove this dependency from the network subsystem where it has
been unduly needed for some time.

Similarly, XSI_SINGLE_PROCESS was a dependency for time() via
picolibc, because the time() implementation in picolibc relies
on the POSIX gettimeofday() call.

However, since Zephyr's common libc time() implementation no longer
depends on that, it can be removed as a dependency in the network
subsystem as well.

Signed-off-by: Chris Friedt <[email protected]>
Remove POSIX_TIMERS and XSI_SINGLE_PROCESS dependencies from the aws
cloud sample and the lwm2m client sample, as they are no longer
required.

Signed-off-by: Chris Friedt <[email protected]>
@cfriedt cfriedt force-pushed the remove-posix-from-time-equation branch from f42ce7d to d8a0351 Compare May 24, 2025 00:04
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Base OS Base OS Library (lib/os) area: C Library C Standard Library area: POSIX POSIX API Library area: Tests Issues related to a particular existing or missing test Release Notes To be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants