Skip to content
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

[core] Implement dup2 wrapper #50439

Merged
merged 24 commits into from
Feb 28, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/ray/common/status.h
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,8 @@ class RAY_EXPORT Status {
// Returns the string "OK" for success.
std::string ToString() const;

std::string StatusString() const { return ToString(); }
Copy link
Collaborator

Choose a reason for hiding this comment

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

What's the difference between StatusString and ToString

Copy link
Contributor Author

@dentiny dentiny Feb 12, 2025

Choose a reason for hiding this comment

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

Functionality-wise no difference, the reason to have this function is for pretty print status for GTEST macros.

In nuro, we have another way to handle:

template <typename Status>
struct ConsumeStatus {...};

template <>
struct ConsumeStatus<Status> {...};
template <>
struct ConsumeStatus<StatusOr> {...};
// other status classes to handle

Having a StatusString is easier to implement.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you elaborate, I don't think I get it. Why cannot the caller call ToString()?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We use it in the macro

CHECK_OK(s) << s.StatusString();

it's a macro thus duck typing, so we have to have the same function name for both Status and StatusOr

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Calling ToString is OK for Status, but improper for StatusOr, because we haven't implement the stringify function for value-type

Copy link
Collaborator

Choose a reason for hiding this comment

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

Got it. Please turn the above explanation to a comment so people know why you need two.

Copy link
Contributor Author

@dentiny dentiny Feb 28, 2025

Choose a reason for hiding this comment

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

Why need a comment here? Exposing status stringify seems natural to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Anyway I added a comment for necessity from duck-type template/macro.


// Return a string representation of the status code, without the message
// text or posix code information.
std::string CodeAsString() const;
Expand Down
2 changes: 2 additions & 0 deletions src/ray/common/status_or.h
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ class StatusOr {

ABSL_MUST_USE_RESULT std::string message() const { return status_.message(); }

std::string StatusString() const { return status_.StatusString(); }

// Returns a reference to the current `ray::Status` contained within the
// `ray::StatusOr<T>`. If `ray::StatusOr<T>` contains a `T`, then this
// function returns `ray::Ok()`.
Expand Down
4 changes: 2 additions & 2 deletions src/ray/common/test/testing.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@

#pragma once

#define RAY_EXPECT_OK(s) EXPECT_TRUE((s).ok())
#define RAY_EXPECT_OK(s) EXPECT_TRUE((s).ok()) << s.StatusString()

#define RAY_ASSERT_OK(s) ASSERT_TRUE((s).ok())
#define RAY_ASSERT_OK(s) ASSERT_TRUE((s).ok()) << s.StatusString()
13 changes: 13 additions & 0 deletions src/ray/util/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -325,3 +325,16 @@ ray_cc_library(
"@com_google_absl//absl/synchronization",
],
)

ray_cc_library(
name = "dup2_wrapper",
hdrs = ["dup2_wrapper.h"],
srcs = select({
"@platforms//os:windows": ["dup2_wrapper_windows.cc"],
"//conditions:default": ["dup2_wrapper_posix.cc"],
Copy link
Collaborator

Choose a reason for hiding this comment

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

What's the difference between this approach and the other approach the current codebase is using which is ifdef

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No difference,

  • select clause works at file level, ifdef works at source code level
  • I use select here because implementation for two platforms are completely different and almost nothing to share

}),
deps = [
":compat",
":logging",
],
)
43 changes: 43 additions & 0 deletions src/ray/util/dup2_wrapper.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright 2025 The Ray Authors.
//
// 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.

#pragma once

#include <memory>

#include "ray/util/compat.h"

namespace ray {

class ScopedDup2Wrapper {
public:
// Duplicate [oldfd] to [newfd], same semantics with syscall `dup2`.
static std::unique_ptr<ScopedDup2Wrapper> New(MEMFD_TYPE_NON_UNIQUE oldfd,
MEMFD_TYPE_NON_UNIQUE newfd);

ScopedDup2Wrapper(const ScopedDup2Wrapper &) = delete;
ScopedDup2Wrapper &operator=(const ScopedDup2Wrapper &) = delete;

// Restore oldfd.
~ScopedDup2Wrapper();

private:
ScopedDup2Wrapper(MEMFD_TYPE_NON_UNIQUE oldfd, MEMFD_TYPE_NON_UNIQUE restorefd)
: oldfd_(oldfd), restorefd_(restorefd) {}

MEMFD_TYPE_NON_UNIQUE oldfd_;
MEMFD_TYPE_NON_UNIQUE restorefd_;
};

} // namespace ray
43 changes: 43 additions & 0 deletions src/ray/util/dup2_wrapper_posix.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright 2025 The Ray Authors.
//
// 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.

#include <unistd.h>

#include <cstring>

#include "ray/util/dup2_wrapper.h"
#include "ray/util/logging.h"

namespace ray {

/*static*/ std::unique_ptr<ScopedDup2Wrapper> ScopedDup2Wrapper::New(int oldfd,
int newfd) {
const int restorefd = dup(oldfd);
RAY_CHECK_NE(restorefd, -1) << "Fails to duplicate oldfd " << oldfd << " because "
<< strerror(errno);

const int ret = dup2(oldfd, newfd);
RAY_CHECK_NE(ret, -1) << "Fails to duplicate oldfd " << oldfd << " to " << newfd
<< " because " << strerror(errno);

return std::unique_ptr<ScopedDup2Wrapper>(new ScopedDup2Wrapper(oldfd, restorefd));
}

ScopedDup2Wrapper::~ScopedDup2Wrapper() {
const int ret = dup2(oldfd_, restorefd_);
RAY_CHECK_NE(ret, -1) << "Fails to duplicate oldfd " << oldfd_ << " to " << restorefd_
<< " because " << strerror(errno);
}

} // namespace ray
54 changes: 54 additions & 0 deletions src/ray/util/dup2_wrapper_windows.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Copyright 2025 The Ray Authors.
//
// 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.

#include "ray/util/dup2_wrapper.h"

namespace ray {

/*static*/ std::unique_ptr<ScopedDup2Wrapper> ScopedDup2Wrapper::New(HANDLE oldfd,
HANLE newfd) {
HANDLE restorefd = NULL;
BOOL success = DuplicateHandle(GetCurrentProcess(),
oldfd,
GetCurrentProcess(),
&restorefd,
0,
FALSE,
DUPLICATE_SAME_ACCESS);
RAY_CHECK(success);

success = DuplicateHandle(GetCurrentProcess(),
oldfd,
GetCurrentProcess(),
&newfd,
0,
FALSE,
DUPLICATE_SAME_ACCESS);
RAY_CHECK(success);

return std::unique_ptr<ScopedDup2Wrapper>(new ScopedDup2Wrapper(oldfd, restorefd));
}

ScopedDup2Wrapper::~ScopedDup2Wrapper() {
BOOL success = DuplicateHandle(GetCurrentProcess(),
oldfd_,
GetCurrentProcess(),
&restorefd_,
0,
FALSE,
DUPLICATE_SAME_ACCESS);
RAY_CHECK(success);
}

} // namespace ray
15 changes: 15 additions & 0 deletions src/ray/util/tests/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -323,3 +323,18 @@ ray_cc_test(
size = "small",
tags = ["team:core"],
)

ray_cc_test(
name = "dup2_wrapper_test",
srcs = ["dup2_wrapper_test.cc"],
deps = [
"//src/ray/common/test:testing",
"//src/ray/util:compat",
"//src/ray/util:dup2_wrapper",
"//src/ray/util:filesystem",
"//src/ray/util:temporary_directory",
"@com_google_googletest//:gtest_main",
],
size = "small",
tags = ["team:core"],
)
84 changes: 84 additions & 0 deletions src/ray/util/tests/dup2_wrapper_test.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
// Copyright 2025 The Ray Authors.
//
// 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.

#include "ray/util/dup2_wrapper.h"

#include <gtest/gtest.h>

#include <string_view>

#include "ray/common/test/testing.h"
#include "ray/util/compat.h"
#include "ray/util/filesystem.h"
#include "ray/util/temporary_directory.h"

#if defined(__APPLE__) || defined(__linux__)
#include <fcntl.h>
#include <unistd.h>
#elif defined(_WIN32)
#include <windows.h>
#endif

namespace ray {

namespace {

constexpr std::string_view kContent = "helloworld\n";

TEST(ScopedDup2WrapperTest, BasicTest) {
ScopedTemporaryDirectory temp_dir;
const auto dir = temp_dir.GetDirectory();
const auto path = dir / "test_file";
const std::string path_string = path.string();

#if defined(__APPLE__) || defined(__linux__)
int fd = open(path_string.data(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
ASSERT_NE(fd, -1);
#elif defined(_WIN32)
HANDLE fd = CreateFile(path_string, // File name
GENERIC_READ | GENERIC_WRITE, // Access mode: read/write
0, // No sharing
NULL, // Default security attributes
OPEN_ALWAYS, // Open file if it exists, create if it doesn't
FILE_ATTRIBUTE_NORMAL, // File attributes
NULL); // No template file

// Check if the file was successfully opened or created
ASSERT_NE(fd, INVALID_HANDLE_VALUE);
#endif

{
auto dup2_wrapper = ScopedDup2Wrapper::New(/*oldfd=*/fd, /*newfd=*/GetStderrHandle());

// Write to stdout should appear in file.
std::cerr << kContent << std::flush;
const auto actual_content = ReadEntireFile(path_string);
RAY_ASSERT_OK(actual_content);
EXPECT_EQ(*actual_content, kContent);
}

testing::internal::CaptureStderr();
std::cerr << kContent << std::flush;
const std::string stderr_content = testing::internal::GetCapturedStderr();
EXPECT_EQ(stderr_content, kContent);

// Not changed since last write.
const auto actual_content = ReadEntireFile(path_string);
RAY_ASSERT_OK(actual_content);
EXPECT_EQ(*actual_content, kContent);
}

} // namespace

} // namespace ray