Skip to content

Prepare the new score::time API#18

Open
lavrovvalera wants to merge 20 commits into
eclipse-score:mainfrom
lavrovvalera:vala_time_gen_api
Open

Prepare the new score::time API#18
lavrovvalera wants to merge 20 commits into
eclipse-score:mainfrom
lavrovvalera:vala_time_gen_api

Conversation

@lavrovvalera

@lavrovvalera lavrovvalera commented Apr 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

score::time — Unified Clock API (Clock<Tag> framework)

closes: #31
closes: #26
closes: #13

Summary

Introduces score::time — a unified, tag-based clock API built around a single scalable
template wrapper Clock<Tag>. Automotive domains (vehicle time, HPLS) and standard library
wrappers (std::chrono::steady_clock, std::chrono::system_clock) share the same call
pattern and test infrastructure. Additional domains can be added by specializing
ClockTraits<Tag>.

Motivation

  • Fragmented APIs — each clock domain had its own unrelated construction pattern.
  • No mockable std::chrono wrapper — unit tests required manual per-component adapters.
  • Factory injection in SUTs — test doubles needed factory objects as constructor
    parameters, leaking test concerns into production code.
  • Mutable snapshots — public data members and non-const accessors triggered static
    analysis suppressions.

Changes

New framework — score/time/clock/

Header Purpose
clock.h Clock<Tag> value wrapper — Now(), Subscribe<E>(), IsAvailable(), GetInstance()
clock_traits.h ClockTraits<Tag> primary template + std::chrono specialisations
clock_snapshot.h ClockSnapshot<TimepointT, StatusT> immutable snapshot
clock_status.h ClockStatus<FlagEnumT> bit-flag status utility
no_status.h NoStatus placeholder for always-ready clocks
subscription_hook.h SubscriptionHook<Tag, E> extension point for PTP callbacks
availability_hook.h AvailabilityHook<Tag> extension point for async readiness
scoped_clock_override.h test_utils::ScopedClockOverride<Tag> RAII mock injection
clock_test_factory.h test_utils::ClockTestFactory<Tag> constructor-injection helper

New clock domains

Package Public Bazel targets Description
score/time/vehicle_time/ :vehicle_time / :vehicle_time_mock / :interface PTP-synchronized vehicle time
score/time/hpls_time/ :hpls_time / :hpls_time_mock / :interface High-Precision Local Steady Clock
score/time/steady_time/ :steady_time / :steady_time_mock / :interface std::chrono::steady_clock wrapper
score/time/system_time/ :system_time / :system_time_mock / :interface std::chrono::system_clock wrapper
score/time/ptp/ :ptp_types TimeSlaveSyncData<Tag>, PDelayMeasurementData<Tag>

Bazel structure and visibility

Each domain uses a two-level layout: <domain>/src/BUILD owns all definitions; the root
<domain>/BUILD exposes only thin alias targets.

  • src:*_clock — domain bundle (backend interface + tag type + Clock<Tag> specialisation); visibility //score/time:__subpackages__
  • src:*_clock_mock — GMock test double; //visibility:public
  • src:*_clock_impl — production wiring (select over platform backends); //visibility:public

Three named public aliases per domain: :*_time (prod), :*_time_mock (test), :interface (header-only).

Legacy removal

score/time/SynchronizedVehicleTime/ and score/time/HighPrecisionLocalSteadyClock/ have
been removed. TimeDaemon consumers must migrate to the new domain packages.

Documentation

Sphinx RST documentation added under docs/time/. The former docs/time/ (TimeDaemon
architecture) is moved to docs/TimeDaemon/.

API example

// Production — no factory, no constructor injection
auto snap = score::time::VehicleClock::GetInstance().Now();
if (snap.Status().IsSet(VehicleTime::StatusFlag::kSynchronized)) {
    UseTime(snap.TimePoint());
}

// Test — RAII override (SUT calls GetInstance() internally)
auto mock = std::make_shared<VehicleClockBackendMock>();
test_utils::ScopedClockOverride<VehicleTime> guard{mock};
EXPECT_CALL(*mock, Now()).WillOnce(Return(snapshot));
MySvc svc{};

// Test — constructor injection (no global state)
auto mock  = std::make_shared<HplsClockBackendMock>();
auto clock = test_utils::ClockTestFactory<HplsTime>::Make(mock);
MyComponent component{clock};
EXPECT_CALL(*mock, Now()).WillOnce(Return(snapshot));

@github-project-automation github-project-automation Bot moved this to In Progress in TIM - Time FT Apr 30, 2026
@github-actions

github-actions Bot commented Apr 30, 2026 •
edited
Loading

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output 
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: e6f53123-d3b4-4f04-9f7d-96d494a7521c
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 2 packages loaded
Loading: 2 packages loaded
    currently loading: 
Loading: 2 packages loaded
    currently loading: 
Loading: 2 packages loaded
    currently loading: 
Analyzing: target //:license-check (3 packages loaded, 0 targets configured)
Analyzing: target //:license-check (3 packages loaded, 0 targets configured)

Analyzing: target //:license-check (78 packages loaded, 10 targets configured)

Analyzing: target //:license-check (104 packages loaded, 254 targets configured)

Analyzing: target //:license-check (153 packages loaded, 2775 targets configured)

Analyzing: target //:license-check (155 packages loaded, 4648 targets configured)

Analyzing: target //:license-check (166 packages loaded, 8193 targets configured)

Analyzing: target //:license-check (166 packages loaded, 8211 targets configured)

Analyzing: target //:license-check (166 packages loaded, 8211 targets configured)

Analyzing: target //:license-check (166 packages loaded, 8211 targets configured)

Analyzing: target //:license-check (169 packages loaded, 8215 targets configured)

Analyzing: target //:license-check (170 packages loaded, 10223 targets configured)

INFO: Analyzed target //:license-check (171 packages loaded, 10349 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 27.183s, Critical Path: 2.44s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@github-actions

github-actions Bot commented Apr 30, 2026

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@lavrovvalera lavrovvalera temporarily deployed to workflow-approval May 2, 2026 20:43 — with GitHub Actions Inactive
@lavrovvalera lavrovvalera temporarily deployed to workflow-approval May 2, 2026 20:43 — with GitHub Actions Inactive
@BlueXMarv3l BlueXMarv3l requested a review from Copilot May 6, 2026 10:21
Copilot AI reviewed May 6, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces the new score::time unified, tag-based clock framework (Clock<Tag>) and migrates TimeDaemon and related components away from the legacy SynchronizedVehicleTime / HighPrecisionLocalSteadyClock APIs toward the new vehicle_time and hpls_time domains. It also adds steady_time and system_time domains, PTP structural types, examples, and extensive PlantUML/Sphinx documentation updates.

Changes:

  • Migrate TimeDaemon SVT verification/ptp stub code to use score::time::HplsClock (new Clock<Tag> API) instead of the legacy HPLSC factory/unique_ptr model.
  • Add new clock domains and core framework pieces (score/time/clock/*, vehicle_time, steady_time, system_time, ptp), including mocks/stubs and unit tests.
  • Remove legacy SynchronizedVehicleTime and HighPrecisionLocalSteadyClock implementation files and update documentation structure/diagrams.

Reviewed changes

Copilot reviewed 185 out of 215 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
score/TimeDaemon/code/verification_machine/svt/validators/timeout_validator.h Switch validator to value-type ReferenceClock and new snapshot API.
score/TimeDaemon/code/verification_machine/svt/validators/timeout_validator.cpp Use ClockSnapshot accessors (TimeSinceEpoch) instead of time_since_epoch().
score/TimeDaemon/code/verification_machine/svt/validators/timeout_validator_test.cpp Update tests to use HplsClockMock and ClockTestFactory.
score/TimeDaemon/code/verification_machine/svt/validators/time_jumps_validator.h Switch validator to value-type ReferenceClock.
score/TimeDaemon/code/verification_machine/svt/validators/time_jumps_validator.cpp Update time reads to new snapshot API.
score/TimeDaemon/code/verification_machine/svt/validators/time_jumps_validator_test.cpp Update tests to new HPLS clock mock/snapshot types.
score/TimeDaemon/code/verification_machine/svt/validators/BUILD Replace legacy HPLSC deps with hpls_time interface/mock targets.
score/TimeDaemon/code/verification_machine/svt/factory.cpp Construct validators using HplsClock::GetInstance() instead of legacy factory.
score/TimeDaemon/code/verification_machine/svt/BUILD Add hpls_time_mock to SVT test deps.
score/TimeDaemon/code/ptp_machine/stub/gptp_stub_machine_integration_test.cpp Migrate integration test timing to HplsClock.
score/TimeDaemon/code/ptp_machine/stub/factory.cpp Build stub machine with HplsClock::GetInstance().
score/TimeDaemon/code/ptp_machine/stub/details/stub_ptp_engine.h Switch engine clock member from unique_ptr to ReferenceClock value.
score/TimeDaemon/code/ptp_machine/stub/details/stub_ptp_engine.cpp Use ClockSnapshot accessors to fill PtpTimeInfo.
score/TimeDaemon/code/ptp_machine/stub/details/BUILD Replace legacy HPLSC interface dep with hpls_time:interface.
score/TimeDaemon/code/ptp_machine/stub/BUILD Swap legacy HPLSC targets for hpls_time prod/mock targets.
score/TimeDaemon/code/ptp_machine/core/BUILD Replace legacy HPLSC dep with hpls_time:interface.
score/TimeDaemon/code/ipc/svt/svt_time_info.h Drop now-unneeded legacy HPLSC include from IPC snapshot types.
score/TimeDaemon/code/ipc/BUILD Adjust visibility from legacy SVT packages to new vehicle_time td_impl pkg.
score/TimeDaemon/code/common/data_types/ptp_time_info.h Redefine ReferenceClock as score::time::HplsClock.
score/TimeDaemon/code/common/data_types/BUILD Update deps to hpls_time:interface.
score/time/vehicle_time/vehicle_clock.cpp Implement VehicleTime hooks/traits wiring into backend iface.
score/time/vehicle_time/vehicle_clock_iface.h Add internal backend interface for VehicleTime domain.
score/time/vehicle_time/details/td_impl/BUILD Add TimeDaemon-backed production impl build targets and tests.
score/time/vehicle_time/details/stub_impl/vehicle_clock_impl.h Add stub backend returning safe defaults.
score/time/vehicle_time/details/stub_impl/vehicle_clock_impl.cpp Provide CreateBackend<VehicleTime>() stub specialization.
score/time/vehicle_time/details/stub_impl/BUILD Build target for VehicleTime stub backend.
score/time/vehicle_time/details/logging_contexts.h Introduce VehicleTime log context header (and add include guards).
score/time/vehicle_time/details/BUILD Aggregate VehicleTime detail test suites.
score/time/system_time/system_clock.h Add SystemClock domain (Clock<std::chrono::system_clock>).
score/time/system_time/system_clock.cpp Implement ClockTraits<std::chrono::system_clock>::CallNow.
score/time/system_time/system_clock_mock.h Add gmock backend for SystemClock.
score/time/system_time/system_clock_iface.h Add backend iface contract for SystemClock.
score/time/system_time/details/system_time_impl/system_clock_impl.h Add production backend calling std::chrono::system_clock::now().
score/time/system_time/details/system_time_impl/system_clock_impl.cpp Provide CreateBackend<std::chrono::system_clock>() specialization.
score/time/system_time/details/system_time_impl/system_clock_impl_test.cpp Unit tests for SystemClock production backend.
score/time/system_time/details/system_time_impl/BUILD Build rules for system_time production backend + tests.
score/time/system_time/details/stub_impl/system_clock_impl.h Add stub backend for tests (epoch-zero snapshots).
score/time/system_time/details/stub_impl/system_clock_impl.cpp Provide stub CreateBackend<std::chrono::system_clock>().
score/time/system_time/details/stub_impl/BUILD Build rules for system_time stub backend.
score/time/system_time/details/BUILD Aggregate system_time detail test suites.
score/time/SynchronizedVehicleTime/synchronized_vehicle_time.cpp Remove legacy SVT implementation source.
score/time/SynchronizedVehicleTime/synchronized_vehicle_time_mock.h Remove legacy SVT mock header.
score/time/SynchronizedVehicleTime/slave_timebase_notification_types.cpp Remove legacy SVT notification types TU.
score/time/SynchronizedVehicleTime/factory.h Remove legacy SVT factory interface.
score/time/SynchronizedVehicleTime/factory_mock.h Remove legacy SVT factory mock.
score/time/SynchronizedVehicleTime/details/tdr/factory_impl_test.cpp Remove legacy SVT factory impl tests.
score/time/SynchronizedVehicleTime/details/logging_contexts.h Remove legacy SVT logging contexts header.
score/time/SynchronizedVehicleTime/details/factory_shm_impl.h Remove legacy SVT shm factory impl.
score/time/SynchronizedVehicleTime/details/factory_mock_helper.h Remove legacy static factory mock helper.
score/time/SynchronizedVehicleTime/details/factory_impl.h Remove legacy SVT factory impl header.
score/time/SynchronizedVehicleTime/details/clock_realtime/factory_impl.cpp Remove legacy realtime SVT factory impl TU.
score/time/SynchronizedVehicleTime/details/clock_realtime/factory_impl_test.cpp Remove legacy realtime SVT factory impl tests.
score/time/SynchronizedVehicleTime/details/clock_realtime/clock_provider.cpp Remove legacy realtime SVT clock provider TU.
score/time/steady_time/steady_clock.h Add SteadyClock domain (Clock<std::chrono::steady_clock>).
score/time/steady_time/steady_clock.cpp Implement ClockTraits<std::chrono::steady_clock>::CallNow.
score/time/steady_time/steady_clock_mock.h Add gmock backend for SteadyClock.
score/time/steady_time/steady_clock_iface.h Add backend iface contract for SteadyClock.
score/time/steady_time/details/stub_impl/steady_clock_impl.h Add stub backend for SteadyClock tests.
score/time/steady_time/details/stub_impl/steady_clock_impl.cpp Provide stub CreateBackend<std::chrono::steady_clock>().
score/time/steady_time/details/stub_impl/BUILD Build rules for steady_time stub backend.
score/time/steady_time/details/steady_time_impl/steady_clock_impl.h Add production backend calling std::chrono::steady_clock::now().
score/time/steady_time/details/steady_time_impl/steady_clock_impl.cpp Provide CreateBackend<std::chrono::steady_clock>() specialization.
score/time/steady_time/details/steady_time_impl/steady_clock_impl_test.cpp Unit tests for steady_time production backend.
score/time/steady_time/details/steady_time_impl/BUILD Build rules for steady_time production backend + tests.
score/time/steady_time/details/BUILD Aggregate steady_time detail test suites.
score/time/ptp/time_slave_sync_data_test.cpp Add unit test for TimeSlaveSyncData streaming/PrintTo.
score/time/ptp/port_identity.h Add PortIdentity type with stream formatting helpers.
score/time/ptp/pdelay_measurement_data_test.cpp Add unit test for PDelayMeasurementData streaming/PrintTo.
score/time/ptp/master_ptp_device_timer.h Define master device timer tag + time_point alias.
score/time/ptp/local_ptp_device_timer.h Define local device timer tag + time_point alias.
score/time/ptp/BUILD Add ptp_types library and unit tests + suite.
score/time/hpls_time/test/benchmark/BUILD Rename benchmark target and swap deps to new hpls_time target.
score/time/hpls_time/test/benchmark/benchmark.cpp Update benchmark to call HplsClock::Now() via new API.
score/time/hpls_time/hpls_time.h Define HplsTime tag (duration/timepoint).
score/time/hpls_time/hpls_clock.h Add HplsClock domain (Clock<HplsTime>) traits.
score/time/hpls_time/hpls_clock.cpp Implement ClockTraits<HplsTime>::CallNow.
score/time/hpls_time/hpls_clock_mock.h Add gmock backend for HplsClock + test utilities integration.
score/time/hpls_time/hpls_clock_iface.h Add backend iface contract for HplsClock.
score/time/hpls_time/details/system_clock/hpls_time_impl.h Add non-QNX production backend for HplsTime.
score/time/hpls_time/details/system_clock/hpls_time_impl.cpp Provide CreateBackend<HplsTime>() specialization for non-QNX backend.
score/time/hpls_time/details/system_clock/hpls_time_impl_test.cpp Update/rename tests for new HplsTimeImpl backend.
score/time/hpls_time/details/system_clock/BUILD Build rules for non-QNX backend and unit tests.
score/time/hpls_time/details/stub_impl/hpls_clock_impl.h Add test-only stub backend for HplsTime.
score/time/hpls_time/details/stub_impl/hpls_clock_impl.cpp Provide stub CreateBackend<HplsTime>().
score/time/hpls_time/details/stub_impl/BUILD Replace prior content with stub backend build rules.
score/time/hpls_time/details/qtime/tick_provider.h Rename/move QNX tick provider API under new namespace/guards.
score/time/hpls_time/details/qtime/tick_provider.cpp Update tick provider implementation include/namespace.
score/time/hpls_time/details/qtime/tick_provider_test.cpp Update tick provider test namespaces and assertions.
score/time/hpls_time/details/qtime/tick_provider_mock.h Add singleton mock wrapper for QNX tick provider.
score/time/hpls_time/details/qtime/tick_provider_mock.cpp Provide mock-routed GetClockCyclesPerSec() and static storage.
score/time/hpls_time/details/qtime/hpls_qclock.h Add QNX production backend for HplsTime.
score/time/hpls_time/details/qtime/hpls_qclock.cpp Implement QNX backend and CreateBackend<HplsTime>().
score/time/hpls_time/details/qtime/factory_test.cpp Add factory test for QNX backend creation.
score/time/hpls_time/details/BUILD Add hpls_time details test suite aggregation and QNX test suites.
score/time/HighPrecisionLocalSteadyClock/high_precision_local_steady_clock.h Remove legacy HPLSC interface header.
score/time/HighPrecisionLocalSteadyClock/high_precision_local_steady_clock_mock.h Remove legacy HPLSC mock header.
score/time/HighPrecisionLocalSteadyClock/high_precision_local_steady_clock_mock.cpp Remove legacy HPLSC mock implementation TU.
score/time/HighPrecisionLocalSteadyClock/factory.h Remove legacy HPLSC factory interface header.
score/time/HighPrecisionLocalSteadyClock/factory_mock.h Remove legacy HPLSC factory mock header.
score/time/HighPrecisionLocalSteadyClock/details/system_clock/system_clock.h Remove legacy system_clock backend header.
score/time/HighPrecisionLocalSteadyClock/details/qtime/tick_provider_mock.h Remove legacy tick provider mock header.
score/time/HighPrecisionLocalSteadyClock/details/qtime/qclock.h Remove legacy QNX qclock header.
score/time/HighPrecisionLocalSteadyClock/details/qtime/qclock.cpp Remove legacy QNX qclock implementation TU.
score/time/HighPrecisionLocalSteadyClock/details/factory_impl.h Remove legacy factory implementation header.
score/time/HighPrecisionLocalSteadyClock/details/factory_impl_stub.cpp Remove legacy utest factory stub TU.
score/time/HighPrecisionLocalSteadyClock/details/BUILD Remove legacy HPLSC details build definitions.
score/time/HighPrecisionLocalSteadyClock/BUILD Remove legacy HPLSC package build definitions.
score/time/clock/subscription_hook.h Add subscription SFINAE hook for event subscription.
score/time/clock/no_status.h Define NoStatus placeholder status type.
score/time/clock/clock_traits.h Add ClockTraits<Tag> primary template.
score/time/clock/clock_test_factory.h Add test-only factory for constructor-injected clocks.
score/time/clock/clock_snapshot.h Add immutable snapshot type with helper accessors.
score/time/clock/BUILD Add clock core + test utilities build targets and unit tests.
score/time/clock/availability_hook.h Add availability SFINAE hook + HasAvailability trait.
score/time/BUILD Add umbrella unit test suite aggregation for all new time packages.
examples/time/system_time/system_time_handler.h Add system_time example handler demonstrating SystemClock.
examples/time/system_time/BUILD Add system_time example binary and handler unit test target.
examples/time/steady_time/steady_time_handler.h Add steady_time example handler demonstrating SteadyClock.
examples/time/steady_time/steady_time_handler_test.cpp Add steady_time handler unit test using clock override.
examples/time/steady_time/BUILD Add steady_time example binary and tests.
examples/time/hpls_time/hpls_time_handler.h Add hpls_time example handler demonstrating HplsClock.
examples/time/hpls_time/hpls_time_handler_test.cpp Add hpls_time handler unit test using clock override.
examples/time/hpls_time/BUILD Add hpls_time example binary and tests.
examples/time/BUILD Add examples/time unit test suite aggregation.
docs/TimeDaemon/_assets/ver_machine/ver_verification_seq.puml Add VerificationMachine workflow diagram.
docs/TimeDaemon/_assets/ver_machine/ver_init_seq.puml Add VerificationMachine init sequence diagram.
docs/TimeDaemon/_assets/ver_machine/ver_class.puml Add VerificationMachine class diagram.
docs/TimeDaemon/_assets/sad_deployment.puml Add deployment view diagram.
docs/TimeDaemon/_assets/ptp_machine/ptp_machine_init_seq.puml Add PTP machine init sequence diagram.
docs/TimeDaemon/_assets/ptp_machine/ptp_machine_get_new_data_seq.puml Add PTP periodic publish workflow diagram.
docs/TimeDaemon/_assets/ptp_machine/ptp_machine_class.puml Add PTP machine class diagram.
docs/TimeDaemon/_assets/mw/mw_time_receive_simple_seq.puml Add simplified middleware receive diagram.
docs/TimeDaemon/_assets/mw/mw_time_receive_seq.puml Add middleware receive flow diagram.
docs/TimeDaemon/_assets/mw/mw_class.puml Add middleware class diagram.
docs/TimeDaemon/_assets/msg_broker/msg_broker_workflow_seq.puml Add message broker workflow sequence diagram.
docs/TimeDaemon/_assets/msg_broker/msg_broker_init_seq.puml Add message broker init sequence diagram.
docs/TimeDaemon/_assets/msg_broker/msg_broker_class.puml Add message broker class diagram.
docs/TimeDaemon/_assets/ipc/ipc_receive_seq.puml Add IPC receive sequence diagram.
docs/TimeDaemon/_assets/ipc/ipc_publish_seq.puml Add IPC publish sequence diagram.
docs/TimeDaemon/_assets/ipc/ipc_init_seq.puml Add IPC init sequence diagram.
docs/TimeDaemon/_assets/ipc/ipc_class.puml Add IPC class diagram.
docs/TimeDaemon/_assets/examples/qvt/qvt_deployment.puml Add example deployment diagram for QVT.
docs/TimeDaemon/_assets/examples/abs_time/abs_time_deployment.puml Add example deployment diagram for absolute time.
docs/TimeDaemon/_assets/examples/abs_time/abs_time_data_control_flow.puml Add absolute time multi-pipeline flow diagram.
docs/TimeDaemon/_assets/dd_deployment.puml Add baseline deployment diagram.
docs/TimeDaemon/_assets/ctrlflow/ctrlflow_workflow_seq.puml Add control flow divider workflow diagram.
docs/TimeDaemon/_assets/ctrlflow/ctrlflow_init_seq.puml Add control flow divider init diagram.
docs/TimeDaemon/_assets/ctrlflow/ctrlflow_class.puml Add control flow divider class diagram.
docs/TimeDaemon/_assets/app/app_workflow_seq.puml Add app workflow sequence diagram.
docs/TimeDaemon/_assets/app/app_init_seq.puml Add app init sequence diagram.
docs/TimeDaemon/_assets/app/app_class.puml Add app class diagram.
docs/time/_assets/uc_testing.puml Add UC diagram for scope-bound clock override in tests.
docs/time/_assets/uc_subscription.puml Add UC diagram for async PTP event subscription.
docs/time/_assets/uc_polling.puml Add UC diagram for polling with status check.
docs/time/_assets/uc_availability.puml Add UC diagram for availability waiting.
docs/index.rst Update docs index to include new TimeDaemon/ docs path.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/time/_assets/uc_availability.puml Outdated
Comment thread score/TimeDaemon/code/verification_machine/svt/validators/timeout_validator.h
BlueXMarv3l
BlueXMarv3l reviewed May 7, 2026
View reviewed changes
Comment thread score/time/vehicle_time/vehicle_clock_test.cpp Outdated
BlueXMarv3l
BlueXMarv3l reviewed May 7, 2026
View reviewed changes
Comment thread score/time/system_time/BUILD
BjoernAtBosch
BjoernAtBosch reviewed May 7, 2026
View reviewed changes

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Basically, I like this "unified API" approach.
Unfortunately, I'm not fully through all this. Some general questions I still have in my mind:

  • Would we need further time bases besides the ones predefined here? And should they be runtime configurable?
  • How do we assume that syncing the system_clock is done? Via NTP?

More to come maybe - need to step out for today ...

Comment thread docs/features/time/index.rst Outdated
+===========================+==============================================================+
| ``kSynchronized`` | Synchronized at least once to the PTP Grand Master |
+---------------------------+--------------------------------------------------------------+
| ``kSynchToGateway`` | Currently in sync with the PTP gateway |

@BjoernAtBosch BjoernAtBosch May 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why is this state required (in comparison to kSynchronized)?

@lavrovvalera lavrovvalera May 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

it is the mirroring form autosar TIMEBASE_STATUS_SYNC_TO_GATEWAY
and means if we are synchronized to the gateway in current frame or not
its more infomrational flag

@BjoernAtBosch BjoernAtBosch May 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would this then be relevant for the Abs/GlobalTime, only? Meaning: The local global clock is synced with the in-vehicle "master" but not with the grandmaster outside?
Would be not relevant for the vehicle time then.
But then the description should be different, e.g.: Currently in sync with the vehicle local master
I'd also not reference the term PTP here, as it is a specific protocol which could change over time whereas the generic concept should be stable

@lavrovvalera lavrovvalera Jun 5, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Need t oclarify if we can really drop it (it is mor ethe legacy flag)

@lavrovvalera lavrovvalera Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Clarified: it will be dropped

Comment thread docs/time/index.rst Outdated
Comment thread docs/time/index.rst Outdated
Comment thread docs/time/index.rst Outdated
Comment thread docs/time/index.rst Outdated
``{kTimeOut, kTimeLeapFuture, kTimeLeapPast}`` is set.

</div>
UC2 — Availability waiting at startup

@BjoernAtBosch BjoernAtBosch May 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not sure if we need the separated availability handling or if that could be solved via sync state kNotSynchonizedDueToStartup

@lavrovvalera lavrovvalera May 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

that has different meaning:
in autosar and here it might be needed to initialize somehting liek ipc
in case the ipc or daemon will no tbe initialize, we jsut don't know anything about the state.
and here isAvailable is responsible exactly for that - is the timebase (with any status) already available or not. It could be treated like "was it initilaized succeefully already".

maybe we could think about renaming of course.

@BjoernAtBosch BjoernAtBosch May 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hmh - yes, but that makes the handling more complicated for users: They need to check multiple things now. And I guess initialization of ipc is something which should be hidden and expect to normally work. Means, imho the availability state would be info relevant during development but not later and could be handled by logging means.

@lavrovvalera lavrovvalera Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Would be still usefuk in case the timebase will be initialized by differnet thread or something

@lavrovvalera lavrovvalera temporarily deployed to workflow-approval May 19, 2026 09:01 — with GitHub Actions Inactive
@lavrovvalera lavrovvalera temporarily deployed to workflow-approval May 19, 2026 09:01 — with GitHub Actions Inactive
lavrovvalera
lavrovvalera commented May 21, 2026
View reviewed changes
Comment thread docs/features/time/_assets/architecture_layers.puml
@lavrovvalera
[VehcileTime] Make initialization explicit
cf25d37 
- Added the hook to the timebases, which needs to be initialized
- Moved the VehcileTime initialization to the dedicated method
- Adjust examples and docs
@lavrovvalera
Cleaning up
a121b82 
- fix name files
- fix formatiing
- remove unneccessary comments
@lavrovvalera
Clean the status interfaces
e084108
@lavrovvalera
Rename hirs > HighResSteady
bef30d4 
- rename the timebase
- update and cleanup docs
@lavrovvalera
Ad subscription to the status change
08b840b
BjoernAtBosch
BjoernAtBosch reviewed Jun 15, 2026
View reviewed changes
Comment thread MODULE.bazel
BjoernAtBosch
BjoernAtBosch reviewed Jun 18, 2026
View reviewed changes
Comment thread score/time/clock/src/clock.h
Comment on lines +140 to +144
template <typename T = Tag, std::enable_if_t<HasInitialization<T>::value, bool> = true>
[[nodiscard]] bool Init() noexcept
{
return InitializationHook<T>::CallInit(*impl_);
}

@BjoernAtBosch BjoernAtBosch Jun 18, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry for observing this just today: Couldn't we get rid of this separate init function? Why can't we do everything in the c-tor/GetInstance call?
What would be the use case if Init() returns false?

  • The docs above tell "the call maybe retried", but retrying could be also handled in the c-tor. Would there be some advantage if the app code does it? Could the app better decide how often and in which intervals to repeat it?
    I mean, with the failing Init() the app would know, that the "com channel" to the time_daemon couldn't be established. But if the time_daemon cannot establish the channel to the time_slave, this would be also signalled via the status flags, or?
  • Apps could write some error/warning log that init wasn't successful, but that could be also handled by the c-tor. But would they refuse to start up?
    For my current view this additional call + check complicates application code.

Instead, I'd think the init could be in the c-tor and if it fails the Now() will always return a timestamp marked as inconsistent. Apps would anyway need to check that state before using a timestamp for the first time.

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

Reviewers

Copilot code review Copilot Copilot left review comments

+2 more reviewers

@BjoernAtBosch BjoernAtBosch BjoernAtBosch left review comments

@BlueXMarv3l BlueXMarv3l BlueXMarv3l left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

TIM - Time FT
Status: In Progress

Milestone

No milestone

4 participants

@lavrovvalera @BjoernAtBosch @BlueXMarv3l