forked from eclipse-iceoryx/iceoryx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
iox-eclipse-iceoryx#2301 Introduce SpinSemaphore
- Loading branch information
1 parent
04c9938
commit 66eaaf8
Showing
12 changed files
with
335 additions
and
51 deletions.
There are no files selected for viewing
This file contains 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
87 changes: 87 additions & 0 deletions
87
iceoryx_hoofs/concurrent/sync/include/iox/spin_semaphore.hpp
This file contains 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,87 @@ | ||
|
|
||
| // Copyright (c) 2024 by ekxide IO GmbH. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| #ifndef IOX_HOOFS_CONCURRENT_SYNC_SPIN_SEMAPHORE_HPP | ||
| #define IOX_HOOFS_CONCURRENT_SYNC_SPIN_SEMAPHORE_HPP | ||
|
|
||
| #include "iox/atomic.hpp" | ||
| #include "iox/deadline_timer.hpp" | ||
| #include "iox/detail/adaptive_wait.hpp" | ||
| #include "iox/detail/semaphore_helper.hpp" | ||
| #include "iox/optional.hpp" | ||
| #include "iox/semaphore_interface.hpp" | ||
| #include "iox/spin_lock.hpp" | ||
|
|
||
| namespace iox | ||
| { | ||
| namespace concurrent | ||
| { | ||
| class SpinSemaphoreBuilder; | ||
|
|
||
| class SpinSemaphore : public detail::SemaphoreInterface<SpinSemaphore> | ||
| { | ||
| public: | ||
| using Builder = SpinSemaphoreBuilder; | ||
|
|
||
| SpinSemaphore(const SpinSemaphore&) = delete; | ||
| SpinSemaphore(SpinSemaphore&&) = delete; | ||
| SpinSemaphore& operator=(const SpinSemaphore&) = delete; | ||
| SpinSemaphore& operator=(SpinSemaphore&&) = delete; | ||
|
|
||
| ~SpinSemaphore() noexcept; | ||
|
|
||
| private: | ||
| friend class optional<SpinSemaphore>; | ||
| friend class detail::SemaphoreInterface<SpinSemaphore>; | ||
|
|
||
| explicit SpinSemaphore(int32_t initial_value) noexcept; | ||
|
|
||
| expected<void, SemaphoreError> post_impl() noexcept; | ||
|
|
||
| expected<void, SemaphoreError> wait_impl() noexcept; | ||
|
|
||
| expected<bool, SemaphoreError> try_wait_impl() noexcept; | ||
|
|
||
| expected<SemaphoreWaitState, SemaphoreError> timed_wait_impl(const units::Duration& timeout) noexcept; | ||
|
|
||
| private: | ||
| concurrent::Atomic<int32_t> m_count{0}; | ||
| concurrent::Atomic<bool> m_to_be_destroyed{false}; | ||
| optional<concurrent::SpinLock> m_spinlock; | ||
| }; | ||
|
|
||
| class SpinSemaphoreBuilder | ||
| { | ||
| /// @brief Set the initial value of the spin semaphore | ||
| IOX_BUILDER_PARAMETER(uint32_t, initialValue, 0U) | ||
|
|
||
| /// @brief Set if the spin semaphore can be stored in the shared memory | ||
| /// for inter process usage | ||
| IOX_BUILDER_PARAMETER(bool, isInterProcessCapable, true) | ||
|
|
||
| public: | ||
| /// @brief Create a spin semaphore | ||
| /// @param[in] uninitializedSemaphore since the semaphore is not movable the user has to provide | ||
| /// memory to store the semaphore into - packed in an optional | ||
| /// @return an error describing the failure or success | ||
| expected<void, SemaphoreError> create(optional<SpinSemaphore>& uninitializedSemaphore) const noexcept; | ||
| }; | ||
|
|
||
| } // namespace concurrent | ||
| } // namespace iox | ||
|
|
||
| #endif // IOX_HOOFS_CONCURRENT_SYNC_SPIN_LOCK_HPP |
This file contains 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,93 @@ | ||
| // Copyright (c) 2024 by ekxide IO GmbH. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| #include "iox/spin_semaphore.hpp" | ||
| #include "iox/detail/adaptive_wait.hpp" | ||
|
|
||
| namespace iox | ||
| { | ||
| namespace concurrent | ||
| { | ||
| expected<void, SemaphoreError> | ||
| SpinSemaphoreBuilder::create(optional<SpinSemaphore>& uninitializedSemaphore) const noexcept | ||
| { | ||
| uninitializedSemaphore.emplace(static_cast<int32_t>(m_initialValue)); | ||
| return ok(); | ||
| } | ||
|
|
||
| SpinSemaphore::SpinSemaphore(int32_t initial_value) noexcept | ||
| : m_count(initial_value) | ||
| { | ||
| LockBuilder() | ||
| .is_inter_process_capable(true) | ||
| .lock_type(LockType::NORMAL) | ||
| .create(m_spinlock) | ||
| .expect("Failed to create Lock"); | ||
| } | ||
|
|
||
| SpinSemaphore::~SpinSemaphore() noexcept | ||
| { | ||
| m_to_be_destroyed = true; | ||
| } | ||
|
|
||
| expected<void, SemaphoreError> SpinSemaphore::post_impl() noexcept | ||
| { | ||
| std::lock_guard<concurrent::SpinLock> lock(*m_spinlock); | ||
| ++m_count; | ||
| return ok(); | ||
| } | ||
|
|
||
| expected<void, SemaphoreError> SpinSemaphore::wait_impl() noexcept | ||
| { | ||
| detail::adaptive_wait spinner; | ||
| spinner.wait_loop([this] { return !this->tryWait(); }); | ||
| return ok(); | ||
| } | ||
|
|
||
| expected<bool, SemaphoreError> SpinSemaphore::try_wait_impl() noexcept | ||
| { | ||
| std::lock_guard<concurrent::SpinLock> lock(*m_spinlock); | ||
| if (m_to_be_destroyed.load(std::memory_order_relaxed)) | ||
| { | ||
| return ok(true); | ||
| } | ||
| if (m_count.load(std::memory_order_relaxed) > 0) | ||
| { | ||
| --m_count; | ||
| return ok(true); | ||
| } | ||
| return ok(false); | ||
| } | ||
|
|
||
| expected<SemaphoreWaitState, SemaphoreError> SpinSemaphore::timed_wait_impl(const units::Duration& timeout) noexcept | ||
| { | ||
| iox::deadline_timer deadline_timer(timeout); | ||
| detail::adaptive_wait spinner; | ||
|
|
||
| auto ret_val = SemaphoreWaitState::TIMEOUT; | ||
| spinner.wait_loop([this, &deadline_timer, &ret_val] { | ||
| if (this->tryWait()) | ||
| { | ||
| ret_val = SemaphoreWaitState::NO_TIMEOUT; | ||
| return false; | ||
| } | ||
| return !deadline_timer.hasExpired(); | ||
| }); | ||
|
|
||
| return ok(ret_val); | ||
| } | ||
| } // namespace concurrent | ||
| } // namespace iox |
This file contains 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
54 changes: 54 additions & 0 deletions
54
iceoryx_hoofs/posix/sync/include/iox/detail/semaphore_helper.hpp
This file contains 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,54 @@ | ||
| // Copyright (c) 2022 by Apex.AI Inc. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| #ifndef IOX_HOOFS_POSIX_SYNC_SEMAPHORE_HELPER_HPP | ||
| #define IOX_HOOFS_POSIX_SYNC_SEMAPHORE_HELPER_HPP | ||
|
|
||
| #include "iceoryx_platform/semaphore.hpp" | ||
| #include "iox/duration.hpp" | ||
| #include "iox/expected.hpp" | ||
| #include "iox/semaphore_interface.hpp" | ||
|
|
||
| namespace iox | ||
| { | ||
| namespace detail | ||
| { | ||
| /// @brief Increments the semaphore by one | ||
| /// @return Fails when the value of the semaphore overflows or when the | ||
| /// semaphore was removed from outside the process | ||
| expected<void, SemaphoreError> sem_post(iox_sem_t* handle) noexcept; | ||
|
|
||
| /// @brief Decrements the semaphore by one. When the semaphore value is zero | ||
| /// it blocks until the semaphore value is greater zero | ||
| /// @return Fails when semaphore was removed from outside the process | ||
| expected<void, SemaphoreError> sem_wait(iox_sem_t* handle) noexcept; | ||
|
|
||
| /// @brief Tries to decrement the semaphore by one. When the semaphore value is zero | ||
| /// it returns false otherwise it returns true and decrement the value by one. | ||
| /// @return Fails when semaphore was removed from outside the process | ||
| expected<bool, SemaphoreError> sem_try_wait(iox_sem_t* handle) noexcept; | ||
|
|
||
| /// @brief Tries to decrement the semaphore by one. When the semaphore value is zero | ||
| /// it waits until the timeout has passed. | ||
| /// @return If during the timeout time the semaphore value increases to non zero | ||
| /// it returns SemaphoreWaitState::NO_TIMEOUT and decreases the semaphore by one | ||
| /// otherwise returns SemaphoreWaitState::TIMEOUT | ||
| expected<SemaphoreWaitState, SemaphoreError> sem_timed_wait(iox_sem_t* handle, const units::Duration& timeout) noexcept; | ||
|
|
||
| } // namespace detail | ||
| } // namespace iox | ||
|
|
||
| #endif // IOX_HOOFS_POSIX_SYNC_SEMAPHORE_HELPER_HPP |
This file contains 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 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.