Avi Drissman | e4622aa | 2022-09-08 20:36:06 | [diff] [blame] | 1 | // Copyright 2013 The Chromium Authors |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
danakj | 51d26a4 | 2024-04-25 14:23:56 | [diff] [blame] | 5 | #ifdef UNSAFE_BUFFERS_BUILD |
| 6 | // TODO(crbug.com/40284755): Remove this and spanify to fix the errors. |
| 7 | #pragma allow_unsafe_buffers |
| 8 | #endif |
| 9 | |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 10 | #include "base/sync_socket.h" |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 11 | |
Keishi Hattori | 0e45c02 | 2021-11-27 09:25:52 | [diff] [blame] | 12 | #include "base/memory/raw_ptr.h" |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 13 | #include "base/synchronization/waitable_event.h" |
| 14 | #include "base/threading/platform_thread.h" |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 15 | #include "base/threading/simple_thread.h" |
| 16 | #include "base/time/time.h" |
| 17 | #include "testing/gtest/include/gtest/gtest.h" |
| 18 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 19 | namespace base { |
| 20 | |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 21 | namespace { |
| 22 | |
Peter Kasting | e5a38ed | 2021-10-02 03:06:35 | [diff] [blame] | 23 | constexpr TimeDelta kReceiveTimeout = base::Milliseconds(750); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 24 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 25 | class HangingReceiveThread : public DelegateSimpleThread::Delegate { |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 26 | public: |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 27 | explicit HangingReceiveThread(SyncSocket* socket, bool with_timeout) |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 28 | : socket_(socket), |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 29 | thread_(this, "HangingReceiveThread"), |
| 30 | with_timeout_(with_timeout), |
| 31 | started_event_(WaitableEvent::ResetPolicy::MANUAL, |
| 32 | WaitableEvent::InitialState::NOT_SIGNALED), |
| 33 | done_event_(WaitableEvent::ResetPolicy::MANUAL, |
| 34 | WaitableEvent::InitialState::NOT_SIGNALED) { |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 35 | thread_.Start(); |
| 36 | } |
| 37 | |
David Bienvenu | 5f4d4f0 | 2020-09-27 16:55:03 | [diff] [blame] | 38 | HangingReceiveThread(const HangingReceiveThread&) = delete; |
| 39 | HangingReceiveThread& operator=(const HangingReceiveThread&) = delete; |
Chris Watkins | bb7211c | 2017-11-29 07:16:38 | [diff] [blame] | 40 | ~HangingReceiveThread() override = default; |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 41 | |
dcheng | 5648818 | 2014-10-21 10:54:51 | [diff] [blame] | 42 | void Run() override { |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 43 | int data = 0; |
| 44 | ASSERT_EQ(socket_->Peek(), 0u); |
| 45 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 46 | started_event_.Signal(); |
| 47 | |
| 48 | if (with_timeout_) { |
| 49 | ASSERT_EQ(0u, socket_->ReceiveWithTimeout(&data, sizeof(data), |
| 50 | kReceiveTimeout)); |
| 51 | } else { |
| 52 | ASSERT_EQ(0u, socket_->Receive(&data, sizeof(data))); |
| 53 | } |
| 54 | |
| 55 | done_event_.Signal(); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 56 | } |
| 57 | |
| 58 | void Stop() { |
| 59 | thread_.Join(); |
| 60 | } |
| 61 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 62 | WaitableEvent* started_event() { return &started_event_; } |
| 63 | WaitableEvent* done_event() { return &done_event_; } |
| 64 | |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 65 | private: |
Keishi Hattori | 0e45c02 | 2021-11-27 09:25:52 | [diff] [blame] | 66 | raw_ptr<SyncSocket> socket_; |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 67 | DelegateSimpleThread thread_; |
| 68 | bool with_timeout_; |
| 69 | WaitableEvent started_event_; |
| 70 | WaitableEvent done_event_; |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 71 | }; |
| 72 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 73 | // Tests sending data between two SyncSockets. Uses ASSERT() and thus will exit |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 74 | // early upon failure. Callers should use ASSERT_NO_FATAL_FAILURE() if testing |
| 75 | // continues after return. |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 76 | void SendReceivePeek(SyncSocket* socket_a, SyncSocket* socket_b) { |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 77 | int received = 0; |
| 78 | const int kSending = 123; |
avi | 4ec0dff | 2015-11-24 14:26:24 | [diff] [blame] | 79 | static_assert(sizeof(kSending) == sizeof(received), "invalid data size"); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 80 | |
| 81 | ASSERT_EQ(0u, socket_a->Peek()); |
| 82 | ASSERT_EQ(0u, socket_b->Peek()); |
| 83 | |
| 84 | // Verify |socket_a| can send to |socket_a| and |socket_a| can Receive from |
| 85 | // |socket_a|. |
Austin Sullivan | edf168fd | 2024-01-17 21:37:20 | [diff] [blame] | 86 | ASSERT_EQ(sizeof(kSending), |
| 87 | socket_a->Send(as_bytes(make_span(&kSending, 1u)))); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 88 | ASSERT_EQ(sizeof(kSending), socket_b->Peek()); |
Austin Sullivan | edf168fd | 2024-01-17 21:37:20 | [diff] [blame] | 89 | ASSERT_EQ(sizeof(kSending), |
| 90 | socket_b->Receive(as_writable_bytes(make_span(&received, 1u)))); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 91 | ASSERT_EQ(kSending, received); |
| 92 | |
| 93 | ASSERT_EQ(0u, socket_a->Peek()); |
| 94 | ASSERT_EQ(0u, socket_b->Peek()); |
| 95 | |
| 96 | // Now verify the reverse. |
| 97 | received = 0; |
Austin Sullivan | edf168fd | 2024-01-17 21:37:20 | [diff] [blame] | 98 | ASSERT_EQ(sizeof(kSending), |
| 99 | socket_b->Send(as_bytes(make_span(&kSending, 1u)))); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 100 | ASSERT_EQ(sizeof(kSending), socket_a->Peek()); |
Austin Sullivan | edf168fd | 2024-01-17 21:37:20 | [diff] [blame] | 101 | ASSERT_EQ(sizeof(kSending), |
| 102 | socket_a->Receive(as_writable_bytes(make_span(&received, 1u)))); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 103 | ASSERT_EQ(kSending, received); |
| 104 | |
| 105 | ASSERT_EQ(0u, socket_a->Peek()); |
| 106 | ASSERT_EQ(0u, socket_b->Peek()); |
| 107 | |
Robert Sesek | 6ab73b02 | 2020-02-13 16:42:39 | [diff] [blame] | 108 | socket_a->Close(); |
| 109 | socket_b->Close(); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 110 | } |
| 111 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 112 | } // namespace |
| 113 | |
| 114 | class SyncSocketTest : public testing::Test { |
| 115 | public: |
| 116 | void SetUp() override { |
| 117 | ASSERT_TRUE(SyncSocket::CreatePair(&socket_a_, &socket_b_)); |
| 118 | } |
| 119 | |
| 120 | protected: |
| 121 | SyncSocket socket_a_; |
| 122 | SyncSocket socket_b_; |
| 123 | }; |
| 124 | |
| 125 | TEST_F(SyncSocketTest, NormalSendReceivePeek) { |
| 126 | SendReceivePeek(&socket_a_, &socket_b_); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 127 | } |
| 128 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 129 | TEST_F(SyncSocketTest, ClonedSendReceivePeek) { |
| 130 | SyncSocket socket_c(socket_a_.Release()); |
| 131 | SyncSocket socket_d(socket_b_.Release()); |
| 132 | SendReceivePeek(&socket_c, &socket_d); |
Nico Weber | ca5f959 | 2019-01-31 14:35:41 | [diff] [blame] | 133 | } |
brucedawson | d350943 | 2015-09-18 18:28:13 | [diff] [blame] | 134 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 135 | class CancelableSyncSocketTest : public testing::Test { |
| 136 | public: |
| 137 | void SetUp() override { |
| 138 | ASSERT_TRUE(CancelableSyncSocket::CreatePair(&socket_a_, &socket_b_)); |
| 139 | } |
| 140 | |
| 141 | protected: |
| 142 | CancelableSyncSocket socket_a_; |
| 143 | CancelableSyncSocket socket_b_; |
| 144 | }; |
| 145 | |
| 146 | TEST_F(CancelableSyncSocketTest, NormalSendReceivePeek) { |
| 147 | SendReceivePeek(&socket_a_, &socket_b_); |
| 148 | } |
| 149 | |
| 150 | TEST_F(CancelableSyncSocketTest, ClonedSendReceivePeek) { |
| 151 | CancelableSyncSocket socket_c(socket_a_.Release()); |
| 152 | CancelableSyncSocket socket_d(socket_b_.Release()); |
brucedawson | d350943 | 2015-09-18 18:28:13 | [diff] [blame] | 153 | SendReceivePeek(&socket_c, &socket_d); |
| 154 | } |
| 155 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 156 | TEST_F(CancelableSyncSocketTest, ShutdownCancelsReceive) { |
| 157 | HangingReceiveThread thread(&socket_b_, /* with_timeout = */ false); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 158 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 159 | // Wait for the thread to be started. Note that this doesn't guarantee that |
| 160 | // Receive() is called before Shutdown(). |
| 161 | thread.started_event()->Wait(); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 162 | |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 163 | EXPECT_TRUE(socket_b_.Shutdown()); |
| 164 | EXPECT_TRUE(thread.done_event()->TimedWait(kReceiveTimeout)); |
brucedawson | d350943 | 2015-09-18 18:28:13 | [diff] [blame] | 165 | |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 166 | thread.Stop(); |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | TEST_F(CancelableSyncSocketTest, ShutdownCancelsReceiveWithTimeout) { |
| 170 | HangingReceiveThread thread(&socket_b_, /* with_timeout = */ true); |
| 171 | |
| 172 | // Wait for the thread to be started. Note that this doesn't guarantee that |
| 173 | // Receive() is called before Shutdown(). |
| 174 | thread.started_event()->Wait(); |
| 175 | |
| 176 | EXPECT_TRUE(socket_b_.Shutdown()); |
| 177 | EXPECT_TRUE(thread.done_event()->TimedWait(kReceiveTimeout)); |
| 178 | |
| 179 | thread.Stop(); |
| 180 | } |
| 181 | |
| 182 | TEST_F(CancelableSyncSocketTest, ReceiveAfterShutdown) { |
| 183 | socket_a_.Shutdown(); |
| 184 | int data = 0; |
Austin Sullivan | edf168fd | 2024-01-17 21:37:20 | [diff] [blame] | 185 | EXPECT_EQ(0u, socket_a_.Receive(as_writable_bytes(make_span(&data, 1u)))); |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | TEST_F(CancelableSyncSocketTest, ReceiveWithTimeoutAfterShutdown) { |
| 189 | socket_a_.Shutdown(); |
| 190 | TimeTicks start = TimeTicks::Now(); |
| 191 | int data = 0; |
| 192 | EXPECT_EQ(0u, |
| 193 | socket_a_.ReceiveWithTimeout(&data, sizeof(data), kReceiveTimeout)); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 194 | |
| 195 | // Ensure the receive didn't just timeout. |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 196 | EXPECT_LT(TimeTicks::Now() - start, kReceiveTimeout); |
dalecurtis@chromium.org | 62558f1 | 2013-10-19 22:13:19 | [diff] [blame] | 197 | } |
Sergey Ulanov | e963175 | 2017-08-03 19:24:29 | [diff] [blame] | 198 | |
| 199 | } // namespace base |