Repository navigation
feat: make Unix domain socket path and mode configurable #84
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
pypingou
wants to merge
2
commits into
eclipse-score:main
Choose a base branch
from
pypingou:feature/configurable-socket
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.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /******************************************************************************** | ||
| * Copyright (c) 2025 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_DATAROUTER_DAEMON_SOCKET_CONFIG_H | ||
| #define SCORE_DATAROUTER_DAEMON_SOCKET_CONFIG_H | ||
|
|
||
| #include "score/os/stdlib.h" | ||
|
|
||
| #include <string> | ||
|
|
||
| namespace score { | ||
| namespace platform { | ||
| namespace internal { | ||
| class UnixDomainSockAddr; | ||
| } | ||
| } // namespace platform | ||
| } // namespace score | ||
|
|
||
| namespace score { | ||
| namespace logging { | ||
| namespace config { | ||
|
|
||
| /// \brief Socket configuration resolved from environment variables or defaults | ||
| struct SocketConfiguration { | ||
| std::string path; | ||
| bool is_abstract; | ||
| }; | ||
|
|
||
| /// \brief Get socket configuration from environment variables or platform defaults | ||
| /// \param stdlib OS abstraction for environment variable access | ||
| /// \return Socket configuration with path and abstract mode flag | ||
| /// \note Reads DATAROUTER_SOCKET_PATH and DATAROUTER_SOCKET_MODE environment variables | ||
| /// \note Platform defaults: Linux uses abstract namespace, QNX uses file-based | ||
| SocketConfiguration GetSocketConfiguration(const score::os::Stdlib& stdlib) noexcept; | ||
|
|
||
| /// \brief Create configured UnixDomainSockAddr from environment or defaults | ||
| /// \param stdlib OS abstraction for environment variable access | ||
| /// \return Configured socket address ready for binding or connecting | ||
| score::platform::internal::UnixDomainSockAddr CreateSocketAddress(const score::os::Stdlib& stdlib) noexcept; | ||
|
|
||
| } // namespace config | ||
| } // namespace logging | ||
| } // namespace score | ||
|
|
||
| #endif // SCORE_DATAROUTER_DAEMON_SOCKET_CONFIG_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
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,89 @@ | ||
| /******************************************************************************** | ||
| * Copyright (c) 2025 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 "daemon/socket_config.h" | ||
|
|
||
| #include "unix_domain/unix_domain_common.h" | ||
| #include <iostream> | ||
|
|
||
| namespace score { | ||
| namespace logging { | ||
| namespace config { | ||
|
|
||
| namespace { | ||
| constexpr char kEnvSocketPath[] = "DATAROUTER_SOCKET_PATH"; | ||
| constexpr char kEnvSocketMode[] = "DATAROUTER_SOCKET_MODE"; | ||
|
|
||
| #if defined(__QNX__) | ||
| constexpr char kDefaultSocketPath[] = "/var/run/datarouter.sock"; | ||
| constexpr char kDefaultSocketMode[] = "file"; | ||
| #else | ||
| constexpr char kDefaultSocketPath[] = "datarouter_socket"; | ||
| constexpr char kDefaultSocketMode[] = "abstract"; | ||
| #endif | ||
|
|
||
| } // namespace | ||
|
|
||
| SocketConfiguration GetSocketConfiguration(const score::os::Stdlib& stdlib) noexcept | ||
| { | ||
| const char* env_path = stdlib.getenv(kEnvSocketPath); | ||
| const char* env_mode = stdlib.getenv(kEnvSocketMode); | ||
|
|
||
| std::string path; | ||
| if (env_path != nullptr && env_path[0] != '\0') | ||
| { | ||
| path = env_path; | ||
| } | ||
| else | ||
| { | ||
| path = kDefaultSocketPath; | ||
| } | ||
|
|
||
| std::string mode_str; | ||
| if (env_mode != nullptr) | ||
| { | ||
| mode_str = env_mode; | ||
| } | ||
| else | ||
| { | ||
| mode_str = kDefaultSocketMode; | ||
| } | ||
|
|
||
| bool is_abstract = true; | ||
| if (mode_str == "file" || mode_str == "FILE") | ||
| { | ||
| is_abstract = false; | ||
| } | ||
|
|
||
| const std::size_t max_len = is_abstract | ||
| ? score::platform::internal::UnixDomainSockAddr::kMaxAbstractPathLength | ||
| : score::platform::internal::UnixDomainSockAddr::kMaxPathLength; | ||
| if (path.length() > max_len) | ||
| { | ||
| std::cerr << "Warning: DATAROUTER_SOCKET_PATH too long (max " << max_len | ||
| << " chars), using default: " << kDefaultSocketPath << '\n'; | ||
| path = kDefaultSocketPath; | ||
| } | ||
|
|
||
| return SocketConfiguration{path, is_abstract}; | ||
| } | ||
|
|
||
| score::platform::internal::UnixDomainSockAddr CreateSocketAddress(const score::os::Stdlib& stdlib) noexcept | ||
| { | ||
| auto config = GetSocketConfiguration(stdlib); | ||
| return score::platform::internal::UnixDomainSockAddr(config.path, config.is_abstract); | ||
| } | ||
|
|
||
| } // namespace config | ||
| } // namespace logging | ||
| } // namespace score |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why should the group have write permissions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
non-root clients sharing the socket GID would need write permission to connect. Do you want me to drop it?