-
Notifications
You must be signed in to change notification settings - Fork 501
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Now sending uses stack for serialization of small messages/request/responses, and PMR otherwise (#400) - Introduced `libcyphal::config` - Fix for #398 Also: - eliminated deprecated NOSONAR cpp:S4963 - I disabled the rule at Sonar
- Loading branch information
Showing
45 changed files
with
692 additions
and
267 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
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
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
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
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,190 @@ | ||
| /// @copyright | ||
| /// Copyright (C) OpenCyphal Development Team <opencyphal.org> | ||
| /// Copyright Amazon.com Inc. or its affiliates. | ||
| /// SPDX-License-Identifier: MIT | ||
|
|
||
| #ifndef LIBCYPHAL_CONFIG_HPP_INCLUDED | ||
| #define LIBCYPHAL_CONFIG_HPP_INCLUDED | ||
|
|
||
| #include <cstddef> | ||
|
|
||
| namespace libcyphal | ||
| { | ||
|
|
||
| // All below NOSONAR cpp:S799 "Rename this identifier to be shorter or equal to 31 characters." | ||
| // are intentional and are used to keep the names consistent with the rest of the codebase. | ||
| // F.e. `IExecutor_Callback_FunctionMaxSize` is consistent with `IExecutor::Callback::FunctionMaxSize`. | ||
|
|
||
| /// Defines various configuration parameters of libcyphal. | ||
| /// | ||
| /// All methods are `static constexpr` - they are evaluated at compile time. | ||
| /// | ||
| /// Nolint b/c this is the main purpose of this file - define various constants. | ||
| /// NOLINTBEGIN(cppcoreguidelines-avoid-magic-numbers, readability-magic-numbers) | ||
| /// | ||
| struct Config | ||
| { | ||
| /// Defines max footprint of a callback function in use by the executor. | ||
| /// | ||
| static constexpr std::size_t IExecutor_Callback_FunctionMaxSize() // NOSONAR cpp:S799 | ||
| { | ||
| return sizeof(void*) * 8; | ||
| } | ||
|
|
||
| /// Defines footprint size reserved for a callback implementation. | ||
| /// The actual max footprint for the callback implementation is `sizeof(IExecutor::Function)` bigger, | ||
| /// and it depends on `Cfg_IExecutor_Callback_FunctionMaxSize`. | ||
| /// | ||
| static constexpr std::size_t IExecutor_Callback_ReserveSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| return sizeof(void*) * 16; | ||
| } | ||
|
|
||
| /// Defines various configuration parameters for the application layer. | ||
| /// | ||
| struct Application | ||
| { | ||
| struct Node | ||
| { | ||
| /// Defines max footprint of a callback function in use by the heartbeat producer. | ||
| /// | ||
| static constexpr std::size_t HeartbeatProducer_UpdateCallback_FunctionSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| return sizeof(void*) * 4; | ||
| } | ||
|
|
||
| }; // Node | ||
|
|
||
| }; // Application | ||
|
|
||
| /// Defines various configuration parameters for the presentation layer. | ||
| /// | ||
| struct Presentation | ||
| { | ||
| /// Defines max footprint of a callback function in use by the RPC client response promise. | ||
| /// | ||
| static constexpr std::size_t ResponsePromiseBase_Callback_FunctionSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| return sizeof(void*) * 4; | ||
| } | ||
|
|
||
| /// Defines max footprint of a callback function in use by the RPC server response continuation. | ||
| /// | ||
| static constexpr std::size_t ServerBase_ContinuationImpl_FunctionMaxSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| return sizeof(void*) * 5; | ||
| } | ||
|
|
||
| /// Defines max footprint of a callback function in use by the RPC server request notification. | ||
| /// | ||
| static constexpr std::size_t ServerBase_OnRequestCallback_FunctionMaxSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| return sizeof(void*) * 5; | ||
| } | ||
|
|
||
| /// Defines the size serialization/deserialization payload buffer which is considered as a small one, | ||
| /// and therefore could be used with stack buffer. Any payload larger than this size will be PMR allocated. | ||
| /// | ||
| /// Setting it to 0 will force all payload buffers to be PMR allocated (except zero-sized). | ||
| /// | ||
| static constexpr std::size_t SmallPayloadSize() | ||
| { | ||
| /// Size is chosen arbitrary - as compromise between stack and PMR allocation. | ||
| return 256; | ||
| } | ||
|
|
||
| /// Defines max footprint of a callback function in use by the message subscriber receive notification. | ||
| /// | ||
| static constexpr std::size_t Subscriber_OnReceiveCallback_FunctionMaxSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| return sizeof(void*) * 4; | ||
| } | ||
| }; | ||
|
|
||
| /// Defines various configuration parameters for the transport layer. | ||
| /// | ||
| struct Transport | ||
| { | ||
| /// Defines max footprint of a callback function in use by the message RX session notification. | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| /// | ||
| static constexpr std::size_t IMessageRxSession_OnReceiveCallback_FunctionMaxSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| return sizeof(void*) * 4; | ||
| } | ||
|
|
||
| /// Defines max footprint of a callback function in use by the service RX session notification. | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| /// | ||
| static constexpr std::size_t ISvcRxSession_OnReceiveCallback_FunctionMaxSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any lambda or function pointer. | ||
| return sizeof(void*) * 4; | ||
| } | ||
|
|
||
| /// Defines max footprint of a platform-specific error implementation. | ||
| /// | ||
| static constexpr std::size_t PlatformErrorMaxSize() | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store simple implementation. | ||
| return sizeof(void*) * 3; | ||
| } | ||
|
|
||
| /// Defines max footprint of a storage implementation used by the scattered buffer. | ||
| /// | ||
| static constexpr std::size_t ScatteredBuffer_StorageVariantFootprint() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store any implementation. | ||
| return sizeof(void*) * 8; | ||
| } | ||
|
|
||
| /// Defines various configuration parameters for the CAN transport sublayer. | ||
| /// | ||
| struct Can | ||
| { | ||
| /// Defines max footprint of a callback function in use by the CAN transport transient error handler. | ||
| /// | ||
| static constexpr std::size_t ICanTransport_TransientErrorHandlerMaxSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store simple lambda or function pointer. | ||
| return sizeof(void*) * 3; | ||
| } | ||
|
|
||
| }; // Can | ||
|
|
||
| /// Defines various configuration parameters for the UDO transport sublayer. | ||
| /// | ||
| struct Udp | ||
| { | ||
| /// Defines max footprint of a callback function in use by the UDP transport transient error handler. | ||
| /// | ||
| static constexpr std::size_t IUdpTransport_TransientErrorHandlerMaxSize() // NOSONAR cpp:S799 | ||
| { | ||
| /// Size is chosen arbitrary, but it should be enough to store simple lambda or function pointer. | ||
| return sizeof(void*) * 3; | ||
| } | ||
|
|
||
| }; // Udp | ||
|
|
||
| }; // Transport | ||
|
|
||
| }; // Config | ||
|
|
||
| // NOLINTEND(cppcoreguidelines-avoid-magic-numbers, readability-magic-numbers) | ||
|
|
||
| #ifdef LIBCYPHAL_CONFIG | ||
| using config = LIBCYPHAL_CONFIG; | ||
| #else | ||
| using config = Config; | ||
| #endif | ||
|
|
||
| } // namespace libcyphal | ||
|
|
||
| #endif // LIBCYPHAL_CONFIG_HPP_INCLUDED |
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.