|
| 1 | +// Copyright 2025 gRPC authors. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +#include <grpc/event_engine/event_engine.h> |
| 16 | +#include <grpc/event_engine/memory_allocator.h> |
| 17 | +#include <grpc/impl/channel_arg_names.h> |
| 18 | + |
| 19 | +#include <chrono> |
| 20 | +#include <memory> |
| 21 | +#include <string> |
| 22 | +#include <utility> |
| 23 | +#include <vector> |
| 24 | + |
| 25 | +#include "absl/log/check.h" |
| 26 | +#include "absl/status/status.h" |
| 27 | +#include "absl/status/statusor.h" |
| 28 | +#include "absl/strings/str_cat.h" |
| 29 | +#include "absl/time/time.h" |
| 30 | +#include "gtest/gtest.h" |
| 31 | +#include "src/core/lib/channel/channel_args.h" |
| 32 | +#include "src/core/lib/event_engine/channel_args_endpoint_config.h" |
| 33 | +#include "src/core/lib/event_engine/tcp_socket_utils.h" |
| 34 | +#include "src/core/lib/iomgr/exec_ctx.h" |
| 35 | +#include "src/core/lib/resource_quota/memory_quota.h" |
| 36 | +#include "src/core/lib/resource_quota/resource_quota.h" |
| 37 | +#include "src/core/util/notification.h" |
| 38 | +#include "test/core/event_engine/event_engine_test_utils.h" |
| 39 | +#include "test/core/event_engine/test_suite/event_engine_test_framework.h" |
| 40 | +#include "test/core/test_util/port.h" |
| 41 | + |
| 42 | +class EventEngineEndpointTest : public EventEngineTest {}; |
| 43 | + |
| 44 | +namespace { |
| 45 | + |
| 46 | +using ::grpc_event_engine::experimental::ChannelArgsEndpointConfig; |
| 47 | +using ::grpc_event_engine::experimental::EventEngine; |
| 48 | +using ::grpc_event_engine::experimental::URIToResolvedAddress; |
| 49 | +using Endpoint = ::grpc_event_engine::experimental::EventEngine::Endpoint; |
| 50 | +using WriteArgs = |
| 51 | + ::grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs; |
| 52 | +using WriteEvent = |
| 53 | + ::grpc_event_engine::experimental::EventEngine::Endpoint::WriteEvent; |
| 54 | +using WriteMetric = |
| 55 | + ::grpc_event_engine::experimental::EventEngine::Endpoint::WriteMetric; |
| 56 | +using WriteEventSink = |
| 57 | + ::grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink; |
| 58 | +using Listener = ::grpc_event_engine::experimental::EventEngine::Listener; |
| 59 | +using ::grpc_event_engine::experimental::GetNextSendMessage; |
| 60 | +using ::grpc_event_engine::experimental::NotifyOnDelete; |
| 61 | +using ::grpc_event_engine::experimental::SliceBuffer; |
| 62 | + |
| 63 | +using namespace std::chrono_literals; |
| 64 | + |
| 65 | +// Create a connection using the test EventEngine to a listener created by the |
| 66 | +// test EventEngine and exchange bi-di data over the connection. Each endpoint |
| 67 | +// gets reset as soon as the write is done. This test checks that EventEngine |
| 68 | +// implementations handle lifetimes around endpoints correctly. |
| 69 | + |
| 70 | +TEST_F(EventEngineEndpointTest, WriteEventCallbackEndpointValidityTest) { |
| 71 | + grpc_core::ExecCtx ctx; |
| 72 | + std::shared_ptr<EventEngine> test_ee(this->NewEventEngine()); |
| 73 | + auto memory_quota = std::make_unique<grpc_core::MemoryQuota>("bar"); |
| 74 | + std::string target_addr = absl::StrCat( |
| 75 | + "ipv6:[::1]:", std::to_string(grpc_pick_unused_port_or_die())); |
| 76 | + auto resolved_addr = URIToResolvedAddress(target_addr); |
| 77 | + CHECK_OK(resolved_addr); |
| 78 | + std::unique_ptr<EventEngine::Endpoint> client_endpoint; |
| 79 | + std::unique_ptr<EventEngine::Endpoint> server_endpoint; |
| 80 | + std::unique_ptr<grpc_core::Notification> server_signal; |
| 81 | + |
| 82 | + Listener::AcceptCallback accept_cb = |
| 83 | + [&server_endpoint, &server_signal]( |
| 84 | + std::unique_ptr<Endpoint> ep, |
| 85 | + grpc_core::MemoryAllocator /*memory_allocator*/) { |
| 86 | + server_endpoint = std::move(ep); |
| 87 | + server_signal->Notify(); |
| 88 | + }; |
| 89 | + |
| 90 | + grpc_core::ChannelArgs args; |
| 91 | + auto quota = grpc_core::ResourceQuota::Default(); |
| 92 | + args = args.Set(GRPC_ARG_RESOURCE_QUOTA, quota); |
| 93 | + ChannelArgsEndpointConfig config(args); |
| 94 | + auto listener = *test_ee->CreateListener( |
| 95 | + std::move(accept_cb), |
| 96 | + [](absl::Status status) { |
| 97 | + ASSERT_TRUE(status.ok()) << status.ToString(); |
| 98 | + }, |
| 99 | + config, std::make_unique<grpc_core::MemoryQuota>("foo")); |
| 100 | + |
| 101 | + ASSERT_TRUE(listener->Bind(*resolved_addr).ok()); |
| 102 | + ASSERT_TRUE(listener->Start().ok()); |
| 103 | + |
| 104 | + constexpr int n_iterations = 100; |
| 105 | + for (int i = 0; i < n_iterations; ++i) { |
| 106 | + server_signal = std::make_unique<grpc_core::Notification>(); |
| 107 | + grpc_core::Notification client_signal; |
| 108 | + test_ee->Connect( |
| 109 | + [&client_endpoint, |
| 110 | + &client_signal](absl::StatusOr<std::unique_ptr<Endpoint>> endpoint) { |
| 111 | + ASSERT_TRUE(endpoint.ok()); |
| 112 | + client_endpoint = std::move(*endpoint); |
| 113 | + client_signal.Notify(); |
| 114 | + }, |
| 115 | + *resolved_addr, config, memory_quota->CreateMemoryAllocator("conn-1"), |
| 116 | + 24h); |
| 117 | + |
| 118 | + client_signal.WaitForNotification(); |
| 119 | + server_signal->WaitForNotification(); |
| 120 | + ASSERT_NE(client_endpoint.get(), nullptr); |
| 121 | + ASSERT_NE(server_endpoint.get(), nullptr); |
| 122 | + |
| 123 | + // Start writes with WriteEventCallbacks from the client endpoint and server |
| 124 | + // endpoint and reset both endpoints immediately. It doesn't matter if the |
| 125 | + // callbacks don't get invoked as long as there is no use-after-free |
| 126 | + // behavior. |
| 127 | + auto event_cb = [](EventEngine::Endpoint* ee_ep, WriteEvent /*event*/, |
| 128 | + absl::Time /*time*/, |
| 129 | + std::vector<WriteMetric> /*metrics*/) { |
| 130 | + // some operation on the endpoint to ensure validity |
| 131 | + ASSERT_NE(ee_ep->GetPeerAddress().address(), nullptr); |
| 132 | + }; |
| 133 | + SliceBuffer client_write_slice_buf; |
| 134 | + SliceBuffer server_write_slice_buf; |
| 135 | + WriteArgs client_write_args; |
| 136 | + client_write_args.set_metrics_sink(WriteEventSink( |
| 137 | + client_endpoint->AllWriteMetrics(), |
| 138 | + {WriteEvent::kSendMsg, WriteEvent::kScheduled, WriteEvent::kSent, |
| 139 | + WriteEvent::kAcked, WriteEvent::kClosed}, |
| 140 | + event_cb)); |
| 141 | + WriteArgs server_write_args; |
| 142 | + server_write_args.set_metrics_sink(WriteEventSink( |
| 143 | + client_endpoint->AllWriteMetrics(), |
| 144 | + {WriteEvent::kSendMsg, WriteEvent::kScheduled, WriteEvent::kSent, |
| 145 | + WriteEvent::kAcked, WriteEvent::kClosed}, |
| 146 | + event_cb)); |
| 147 | + AppendStringToSliceBuffer(&client_write_slice_buf, GetNextSendMessage()); |
| 148 | + AppendStringToSliceBuffer(&server_write_slice_buf, GetNextSendMessage()); |
| 149 | + client_endpoint->Write([&](absl::Status /*status*/) {}, |
| 150 | + &client_write_slice_buf, |
| 151 | + std::move(client_write_args)); |
| 152 | + server_endpoint->Write([&](absl::Status /*status*/) {}, |
| 153 | + &server_write_slice_buf, |
| 154 | + std::move(server_write_args)); |
| 155 | + client_endpoint.reset(); |
| 156 | + server_endpoint.reset(); |
| 157 | + } |
| 158 | + listener.reset(); |
| 159 | +} |
| 160 | + |
| 161 | +} // namespace |
0 commit comments