-
Notifications
You must be signed in to change notification settings - Fork 16
hmon: add C++ interface to logic monitor #98
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
Open
arkjedrz
wants to merge
1
commit into
eclipse-score:main
Choose a base branch
from
qorix-group:arkjedrz_logic-monitor-cpp
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,251
−4
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
src/health_monitoring_lib/cpp/include/score/hm/logic/logic_monitor.h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /******************************************************************************** | ||
| * Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| ********************************************************************************/ | ||
| #ifndef SCORE_HM_LOGIC_LOGIC_MONITOR_H | ||
| #define SCORE_HM_LOGIC_LOGIC_MONITOR_H | ||
|
|
||
| #include "score/hm/common.h" | ||
| #include "score/hm/tag.h" | ||
| #include <score/expected.hpp> | ||
| #include <vector> | ||
|
|
||
| namespace score::hm | ||
| { | ||
| // Forward declaration | ||
| class HealthMonitor; | ||
| class HealthMonitorBuilder; | ||
| } // namespace score::hm | ||
|
|
||
| namespace score::hm::logic | ||
| { | ||
|
|
||
| class LogicMonitorBuilder final : public internal::RustDroppable<LogicMonitorBuilder> | ||
| { | ||
| public: | ||
| /// Create a new `LogicMonitorBuilder`. | ||
| /// | ||
| /// - `initial_state` - starting point. | ||
| LogicMonitorBuilder(const StateTag& initial_state); | ||
|
|
||
| LogicMonitorBuilder(const LogicMonitorBuilder&) = delete; | ||
| LogicMonitorBuilder& operator=(const LogicMonitorBuilder&) = delete; | ||
|
|
||
| LogicMonitorBuilder(LogicMonitorBuilder&&) = default; | ||
| LogicMonitorBuilder& operator=(LogicMonitorBuilder&&) = delete; | ||
|
|
||
| /// Add state along with allowed transitions. | ||
| /// If state already exist - it is overwritten. | ||
| LogicMonitorBuilder add_state(const StateTag& state, const std::vector<StateTag>& allowed_states) &&; | ||
|
|
||
| protected: | ||
| std::optional<internal::FFIHandle> _drop_by_rust_impl() | ||
| { | ||
| return monitor_builder_handle_.drop_by_rust(); | ||
| } | ||
|
|
||
| private: | ||
| internal::DroppableFFIHandle monitor_builder_handle_; | ||
|
|
||
| // Allow to hide drop_by_rust implementation | ||
| friend class internal::RustDroppable<LogicMonitorBuilder>; | ||
|
|
||
| // Allow HealthMonitorBuilder to access drop_by_rust implementation | ||
| friend class ::score::hm::HealthMonitorBuilder; | ||
| }; | ||
|
|
||
| class LogicMonitor final | ||
| { | ||
| public: | ||
| LogicMonitor(const LogicMonitor&) = delete; | ||
| LogicMonitor& operator=(const LogicMonitor&) = delete; | ||
|
|
||
| LogicMonitor(LogicMonitor&& other) noexcept = default; | ||
| LogicMonitor& operator=(LogicMonitor&& other) noexcept = default; | ||
|
|
||
| /// Perform transition to a new state. | ||
| /// On success, current state is returned. | ||
| score::cpp::expected<StateTag, Error> transition(const StateTag& state); | ||
|
|
||
| /// Current monitor state. | ||
| score::cpp::expected<StateTag, Error> state(); | ||
|
|
||
| private: | ||
| explicit LogicMonitor(internal::FFIHandle monitor_handle); | ||
|
|
||
| // Only `HealthMonitor` is allowed to create `LogicMonitor` instances. | ||
| friend class score::hm::HealthMonitor; | ||
| internal::DroppableFFIHandle monitor_handle_; | ||
| }; | ||
|
|
||
| } // namespace score::hm::logic | ||
|
|
||
| #endif // SCORE_HM_LOGIC_LOGIC_MONITOR_H | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add unit tests |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| /******************************************************************************** | ||
| * Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| ********************************************************************************/ | ||
| #include "score/hm/logic/logic_monitor.h" | ||
| #include <score/assert.hpp> | ||
|
|
||
| namespace | ||
| { | ||
| extern "C" { | ||
| using namespace score::hm; | ||
| using namespace score::hm::internal; | ||
| using namespace score::hm::logic; | ||
|
|
||
| FFICode logic_monitor_builder_create(const StateTag* initial_state, FFIHandle* logic_monitor_builder_handle_out); | ||
| FFICode logic_monitor_builder_destroy(FFIHandle logic_monitor_builder_handle); | ||
| FFICode logic_monitor_builder_add_state(FFIHandle logic_monitor_builder_handle, | ||
| const StateTag* state, | ||
| const StateTag* allowed_states, | ||
| size_t num_allowed_states); | ||
| FFICode logic_monitor_destroy(FFIHandle logic_monitor_handle); | ||
| FFICode logic_monitor_transition(FFIHandle logic_monitor_handle, const StateTag* target_state); | ||
| FFICode logic_monitor_state(FFIHandle logic_monitor_handle, StateTag* state_out); | ||
arkjedrz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
Comment on lines
+23
to
+32
|
||
|
|
||
| FFIHandle logic_monitor_builder_create_wrapper(const StateTag& initial_state) | ||
| { | ||
| FFIHandle handle{nullptr}; | ||
| auto result{logic_monitor_builder_create(&initial_state, &handle)}; | ||
| SCORE_LANGUAGE_FUTURECPP_ASSERT(result == kSuccess); | ||
| return handle; | ||
| } | ||
| } // namespace | ||
|
|
||
| namespace score::hm::logic | ||
| { | ||
| LogicMonitorBuilder::LogicMonitorBuilder(const StateTag& initial_state) | ||
| : monitor_builder_handle_{logic_monitor_builder_create_wrapper(initial_state), &logic_monitor_builder_destroy} | ||
| { | ||
| } | ||
|
|
||
| LogicMonitorBuilder LogicMonitorBuilder::add_state(const StateTag& state, | ||
| const std::vector<StateTag>& allowed_states) && | ||
| { | ||
| auto monitor_builder_handle{monitor_builder_handle_.as_rust_handle()}; | ||
| SCORE_LANGUAGE_FUTURECPP_PRECONDITION(monitor_builder_handle.has_value()); | ||
|
|
||
| auto result{logic_monitor_builder_add_state( | ||
| monitor_builder_handle.value(), &state, allowed_states.data(), allowed_states.size())}; | ||
| SCORE_LANGUAGE_FUTURECPP_ASSERT(result == kSuccess); | ||
|
|
||
| return std::move(*this); | ||
| } | ||
|
|
||
| LogicMonitor::LogicMonitor(FFIHandle monitor_handle) : monitor_handle_{monitor_handle, &logic_monitor_destroy} {} | ||
|
|
||
| score::cpp::expected<StateTag, Error> LogicMonitor::transition(const StateTag& state) | ||
| { | ||
| auto monitor_handle{monitor_handle_.as_rust_handle()}; | ||
| SCORE_LANGUAGE_FUTURECPP_PRECONDITION(monitor_handle.has_value()); | ||
|
|
||
| auto result{logic_monitor_transition(monitor_handle.value(), &state)}; | ||
| if (result != kSuccess) | ||
| { | ||
| return score::cpp::unexpected(static_cast<Error>(result)); | ||
| } | ||
|
|
||
| return score::cpp::expected<StateTag, Error>(state); | ||
| } | ||
|
|
||
| score::cpp::expected<StateTag, Error> LogicMonitor::state() | ||
| { | ||
| auto monitor_handle{monitor_handle_.as_rust_handle()}; | ||
| SCORE_LANGUAGE_FUTURECPP_PRECONDITION(monitor_handle.has_value()); | ||
|
|
||
| StateTag state_tag; | ||
| auto result{logic_monitor_state(monitor_handle.value(), &state_tag)}; | ||
| if (result != kSuccess) | ||
| { | ||
| return score::cpp::unexpected(static_cast<Error>(result)); | ||
| } | ||
|
|
||
| return score::cpp::expected<StateTag, Error>(state_tag); | ||
| } | ||
|
|
||
| } // namespace score::hm::logic | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.