2 * Copyright 2016 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 #include <folly/ExceptionWrapper.h>
17 #include <folly/RWSpinLock.h>
18 #include <folly/Random.h>
19 #include <folly/SocketAddress.h>
20 #include <folly/io/async/AsyncServerSocket.h>
21 #include <folly/io/async/AsyncSocket.h>
22 #include <folly/io/async/AsyncTimeout.h>
23 #include <folly/io/async/EventBase.h>
25 #include <folly/experimental/TestUtil.h>
26 #include <folly/io/IOBuf.h>
27 #include <folly/io/async/test/AsyncSocketTest.h>
28 #include <folly/io/async/test/Util.h>
29 #include <folly/portability/GMock.h>
30 #include <folly/portability/GTest.h>
31 #include <folly/portability/Sockets.h>
32 #include <folly/portability/Unistd.h>
33 #include <folly/test/SocketAddressTestHelper.h>
35 #include <boost/scoped_array.hpp>
37 #include <sys/types.h>
41 using namespace boost;
48 using std::unique_ptr;
49 using std::chrono::milliseconds;
50 using boost::scoped_array;
52 using namespace folly;
53 using namespace testing;
55 namespace fsp = folly::portability::sockets;
57 class DelayedWrite: public AsyncTimeout {
59 DelayedWrite(const std::shared_ptr<AsyncSocket>& socket,
60 unique_ptr<IOBuf>&& bufs, AsyncTransportWrapper::WriteCallback* wcb,
61 bool cork, bool lastWrite = false):
62 AsyncTimeout(socket->getEventBase()),
64 bufs_(std::move(bufs)),
67 lastWrite_(lastWrite) {}
70 void timeoutExpired() noexcept override {
71 WriteFlags flags = cork_ ? WriteFlags::CORK : WriteFlags::NONE;
72 socket_->writeChain(wcb_, std::move(bufs_), flags);
74 socket_->shutdownWrite();
78 std::shared_ptr<AsyncSocket> socket_;
79 unique_ptr<IOBuf> bufs_;
80 AsyncTransportWrapper::WriteCallback* wcb_;
85 ///////////////////////////////////////////////////////////////////////////
87 ///////////////////////////////////////////////////////////////////////////
90 * Test connecting to a server
92 TEST(AsyncSocketTest, Connect) {
93 // Start listening on a local port
96 // Connect using a AsyncSocket
98 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
100 socket->connect(&cb, server.getAddress(), 30);
104 ASSERT_EQ(cb.state, STATE_SUCCEEDED);
105 EXPECT_LE(0, socket->getConnectTime().count());
106 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(30));
109 enum class TFOState {
114 class AsyncSocketConnectTest : public ::testing::TestWithParam<TFOState> {};
116 std::vector<TFOState> getTestingValues() {
117 std::vector<TFOState> vals;
118 vals.emplace_back(TFOState::DISABLED);
121 vals.emplace_back(TFOState::ENABLED);
126 INSTANTIATE_TEST_CASE_P(
128 AsyncSocketConnectTest,
129 ::testing::ValuesIn(getTestingValues()));
132 * Test connecting to a server that isn't listening
134 TEST(AsyncSocketTest, ConnectRefused) {
137 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
139 // Hopefully nothing is actually listening on this address
140 folly::SocketAddress addr("127.0.0.1", 65535);
142 socket->connect(&cb, addr, 30);
146 EXPECT_EQ(STATE_FAILED, cb.state);
147 EXPECT_EQ(AsyncSocketException::NOT_OPEN, cb.exception.getType());
148 EXPECT_LE(0, socket->getConnectTime().count());
149 EXPECT_EQ(std::chrono::milliseconds(30), socket->getConnectTimeout());
153 * Test connection timeout
155 TEST(AsyncSocketTest, ConnectTimeout) {
158 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
160 // Try connecting to server that won't respond.
162 // This depends somewhat on the network where this test is run.
163 // Hopefully this IP will be routable but unresponsive.
164 // (Alternatively, we could try listening on a local raw socket, but that
165 // normally requires root privileges.)
167 SocketAddressTestHelper::isIPv6Enabled() ?
168 SocketAddressTestHelper::kGooglePublicDnsAAddrIPv6 :
169 SocketAddressTestHelper::isIPv4Enabled() ?
170 SocketAddressTestHelper::kGooglePublicDnsAAddrIPv4 :
172 SocketAddress addr(host, 65535);
174 socket->connect(&cb, addr, 1); // also set a ridiculously small timeout
178 ASSERT_EQ(cb.state, STATE_FAILED);
179 ASSERT_EQ(cb.exception.getType(), AsyncSocketException::TIMED_OUT);
181 // Verify that we can still get the peer address after a timeout.
182 // Use case is if the client was created from a client pool, and we want
183 // to log which peer failed.
184 folly::SocketAddress peer;
185 socket->getPeerAddress(&peer);
186 ASSERT_EQ(peer, addr);
187 EXPECT_LE(0, socket->getConnectTime().count());
188 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(1));
192 * Test writing immediately after connecting, without waiting for connect
195 TEST_P(AsyncSocketConnectTest, ConnectAndWrite) {
200 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
202 if (GetParam() == TFOState::ENABLED) {
207 socket->connect(&ccb, server.getAddress(), 30);
211 memset(buf, 'a', sizeof(buf));
213 socket->write(&wcb, buf, sizeof(buf));
215 // Loop. We don't bother accepting on the server socket yet.
216 // The kernel should be able to buffer the write request so it can succeed.
219 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
220 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
222 // Make sure the server got a connection and received the data
224 server.verifyConnection(buf, sizeof(buf));
226 ASSERT_TRUE(socket->isClosedBySelf());
227 ASSERT_FALSE(socket->isClosedByPeer());
228 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(30));
232 * Test connecting using a nullptr connect callback.
234 TEST_P(AsyncSocketConnectTest, ConnectNullCallback) {
239 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
240 if (GetParam() == TFOState::ENABLED) {
244 socket->connect(nullptr, server.getAddress(), 30);
246 // write some data, just so we have some way of verifing
247 // that the socket works correctly after connecting
249 memset(buf, 'a', sizeof(buf));
251 socket->write(&wcb, buf, sizeof(buf));
255 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
257 // Make sure the server got a connection and received the data
259 server.verifyConnection(buf, sizeof(buf));
261 ASSERT_TRUE(socket->isClosedBySelf());
262 ASSERT_FALSE(socket->isClosedByPeer());
266 * Test calling both write() and close() immediately after connecting, without
267 * waiting for connect to finish.
269 * This exercises the STATE_CONNECTING_CLOSING code.
271 TEST_P(AsyncSocketConnectTest, ConnectWriteAndClose) {
276 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
277 if (GetParam() == TFOState::ENABLED) {
281 socket->connect(&ccb, server.getAddress(), 30);
285 memset(buf, 'a', sizeof(buf));
287 socket->write(&wcb, buf, sizeof(buf));
292 // Loop. We don't bother accepting on the server socket yet.
293 // The kernel should be able to buffer the write request so it can succeed.
296 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
297 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
299 // Make sure the server got a connection and received the data
300 server.verifyConnection(buf, sizeof(buf));
302 ASSERT_TRUE(socket->isClosedBySelf());
303 ASSERT_FALSE(socket->isClosedByPeer());
307 * Test calling close() immediately after connect()
309 TEST(AsyncSocketTest, ConnectAndClose) {
312 // Connect using a AsyncSocket
314 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
316 socket->connect(&ccb, server.getAddress(), 30);
318 // Hopefully the connect didn't succeed immediately.
319 // If it did, we can't exercise the close-while-connecting code path.
320 if (ccb.state == STATE_SUCCEEDED) {
321 LOG(INFO) << "connect() succeeded immediately; aborting test "
322 "of close-during-connect behavior";
328 // Loop, although there shouldn't be anything to do.
331 // Make sure the connection was aborted
332 ASSERT_EQ(ccb.state, STATE_FAILED);
334 ASSERT_TRUE(socket->isClosedBySelf());
335 ASSERT_FALSE(socket->isClosedByPeer());
339 * Test calling closeNow() immediately after connect()
341 * This should be identical to the normal close behavior.
343 TEST(AsyncSocketTest, ConnectAndCloseNow) {
346 // Connect using a AsyncSocket
348 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
350 socket->connect(&ccb, server.getAddress(), 30);
352 // Hopefully the connect didn't succeed immediately.
353 // If it did, we can't exercise the close-while-connecting code path.
354 if (ccb.state == STATE_SUCCEEDED) {
355 LOG(INFO) << "connect() succeeded immediately; aborting test "
356 "of closeNow()-during-connect behavior";
362 // Loop, although there shouldn't be anything to do.
365 // Make sure the connection was aborted
366 ASSERT_EQ(ccb.state, STATE_FAILED);
368 ASSERT_TRUE(socket->isClosedBySelf());
369 ASSERT_FALSE(socket->isClosedByPeer());
373 * Test calling both write() and closeNow() immediately after connecting,
374 * without waiting for connect to finish.
376 * This should abort the pending write.
378 TEST(AsyncSocketTest, ConnectWriteAndCloseNow) {
383 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
385 socket->connect(&ccb, server.getAddress(), 30);
387 // Hopefully the connect didn't succeed immediately.
388 // If it did, we can't exercise the close-while-connecting code path.
389 if (ccb.state == STATE_SUCCEEDED) {
390 LOG(INFO) << "connect() succeeded immediately; aborting test "
391 "of write-during-connect behavior";
397 memset(buf, 'a', sizeof(buf));
399 socket->write(&wcb, buf, sizeof(buf));
404 // Loop, although there shouldn't be anything to do.
407 ASSERT_EQ(ccb.state, STATE_FAILED);
408 ASSERT_EQ(wcb.state, STATE_FAILED);
410 ASSERT_TRUE(socket->isClosedBySelf());
411 ASSERT_FALSE(socket->isClosedByPeer());
415 * Test installing a read callback immediately, before connect() finishes.
417 TEST_P(AsyncSocketConnectTest, ConnectAndRead) {
422 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
423 if (GetParam() == TFOState::ENABLED) {
428 socket->connect(&ccb, server.getAddress(), 30);
431 socket->setReadCB(&rcb);
433 if (GetParam() == TFOState::ENABLED) {
434 // Trigger a connection
435 socket->writeChain(nullptr, IOBuf::copyBuffer("hey"));
438 // Even though we haven't looped yet, we should be able to accept
439 // the connection and send data to it.
440 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
442 memset(buf, 'a', sizeof(buf));
443 acceptedSocket->write(buf, sizeof(buf));
444 acceptedSocket->flush();
445 acceptedSocket->close();
447 // Loop, although there shouldn't be anything to do.
450 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
451 ASSERT_EQ(rcb.buffers.size(), 1);
452 ASSERT_EQ(rcb.buffers[0].length, sizeof(buf));
453 ASSERT_EQ(memcmp(rcb.buffers[0].buffer, buf, sizeof(buf)), 0);
455 ASSERT_FALSE(socket->isClosedBySelf());
456 ASSERT_FALSE(socket->isClosedByPeer());
460 * Test installing a read callback and then closing immediately before the
461 * connect attempt finishes.
463 TEST(AsyncSocketTest, ConnectReadAndClose) {
468 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
470 socket->connect(&ccb, server.getAddress(), 30);
472 // Hopefully the connect didn't succeed immediately.
473 // If it did, we can't exercise the close-while-connecting code path.
474 if (ccb.state == STATE_SUCCEEDED) {
475 LOG(INFO) << "connect() succeeded immediately; aborting test "
476 "of read-during-connect behavior";
481 socket->setReadCB(&rcb);
486 // Loop, although there shouldn't be anything to do.
489 ASSERT_EQ(ccb.state, STATE_FAILED); // we aborted the close attempt
490 ASSERT_EQ(rcb.buffers.size(), 0);
491 ASSERT_EQ(rcb.state, STATE_SUCCEEDED); // this indicates EOF
493 ASSERT_TRUE(socket->isClosedBySelf());
494 ASSERT_FALSE(socket->isClosedByPeer());
498 * Test both writing and installing a read callback immediately,
499 * before connect() finishes.
501 TEST_P(AsyncSocketConnectTest, ConnectWriteAndRead) {
506 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
507 if (GetParam() == TFOState::ENABLED) {
511 socket->connect(&ccb, server.getAddress(), 30);
515 memset(buf1, 'a', sizeof(buf1));
517 socket->write(&wcb, buf1, sizeof(buf1));
519 // set a read callback
521 socket->setReadCB(&rcb);
523 // Even though we haven't looped yet, we should be able to accept
524 // the connection and send data to it.
525 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
527 memset(buf2, 'b', sizeof(buf2));
528 acceptedSocket->write(buf2, sizeof(buf2));
529 acceptedSocket->flush();
531 // shut down the write half of acceptedSocket, so that the AsyncSocket
532 // will stop reading and we can break out of the event loop.
533 shutdown(acceptedSocket->getSocketFD(), SHUT_WR);
538 // Make sure the connect succeeded
539 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
541 // Make sure the AsyncSocket read the data written by the accepted socket
542 ASSERT_EQ(rcb.state, STATE_SUCCEEDED);
543 ASSERT_EQ(rcb.buffers.size(), 1);
544 ASSERT_EQ(rcb.buffers[0].length, sizeof(buf2));
545 ASSERT_EQ(memcmp(rcb.buffers[0].buffer, buf2, sizeof(buf2)), 0);
547 // Close the AsyncSocket so we'll see EOF on acceptedSocket
550 // Make sure the accepted socket saw the data written by the AsyncSocket
551 uint8_t readbuf[sizeof(buf1)];
552 acceptedSocket->readAll(readbuf, sizeof(readbuf));
553 ASSERT_EQ(memcmp(buf1, readbuf, sizeof(buf1)), 0);
554 uint32_t bytesRead = acceptedSocket->read(readbuf, sizeof(readbuf));
555 ASSERT_EQ(bytesRead, 0);
557 ASSERT_FALSE(socket->isClosedBySelf());
558 ASSERT_TRUE(socket->isClosedByPeer());
562 * Test writing to the socket then shutting down writes before the connect
565 TEST(AsyncSocketTest, ConnectWriteAndShutdownWrite) {
570 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
572 socket->connect(&ccb, server.getAddress(), 30);
574 // Hopefully the connect didn't succeed immediately.
575 // If it did, we can't exercise the write-while-connecting code path.
576 if (ccb.state == STATE_SUCCEEDED) {
577 LOG(INFO) << "connect() succeeded immediately; skipping test";
581 // Ask to write some data
583 memset(wbuf, 'a', sizeof(wbuf));
585 socket->write(&wcb, wbuf, sizeof(wbuf));
586 socket->shutdownWrite();
589 socket->shutdownWrite();
591 // Even though we haven't looped yet, we should be able to accept
593 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
595 // Since the connection is still in progress, there should be no data to
596 // read yet. Verify that the accepted socket is not readable.
597 struct pollfd fds[1];
598 fds[0].fd = acceptedSocket->getSocketFD();
599 fds[0].events = POLLIN;
601 int rc = poll(fds, 1, 0);
604 // Write data to the accepted socket
605 uint8_t acceptedWbuf[192];
606 memset(acceptedWbuf, 'b', sizeof(acceptedWbuf));
607 acceptedSocket->write(acceptedWbuf, sizeof(acceptedWbuf));
608 acceptedSocket->flush();
613 // The loop should have completed the connection, written the queued data,
614 // and shutdown writes on the socket.
616 // Check that the connection was completed successfully and that the write
617 // callback succeeded.
618 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
619 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
621 // Check that we can read the data that was written to the socket, and that
622 // we see an EOF, since its socket was half-shutdown.
623 uint8_t readbuf[sizeof(wbuf)];
624 acceptedSocket->readAll(readbuf, sizeof(readbuf));
625 ASSERT_EQ(memcmp(wbuf, readbuf, sizeof(wbuf)), 0);
626 uint32_t bytesRead = acceptedSocket->read(readbuf, sizeof(readbuf));
627 ASSERT_EQ(bytesRead, 0);
629 // Close the accepted socket. This will cause it to see EOF
630 // and uninstall the read callback when we loop next.
631 acceptedSocket->close();
633 // Install a read callback, then loop again.
635 socket->setReadCB(&rcb);
638 // This loop should have read the data and seen the EOF
639 ASSERT_EQ(rcb.state, STATE_SUCCEEDED);
640 ASSERT_EQ(rcb.buffers.size(), 1);
641 ASSERT_EQ(rcb.buffers[0].length, sizeof(acceptedWbuf));
642 ASSERT_EQ(memcmp(rcb.buffers[0].buffer,
643 acceptedWbuf, sizeof(acceptedWbuf)), 0);
645 ASSERT_FALSE(socket->isClosedBySelf());
646 ASSERT_FALSE(socket->isClosedByPeer());
650 * Test reading, writing, and shutting down writes before the connect attempt
653 TEST(AsyncSocketTest, ConnectReadWriteAndShutdownWrite) {
658 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
660 socket->connect(&ccb, server.getAddress(), 30);
662 // Hopefully the connect didn't succeed immediately.
663 // If it did, we can't exercise the write-while-connecting code path.
664 if (ccb.state == STATE_SUCCEEDED) {
665 LOG(INFO) << "connect() succeeded immediately; skipping test";
669 // Install a read callback
671 socket->setReadCB(&rcb);
673 // Ask to write some data
675 memset(wbuf, 'a', sizeof(wbuf));
677 socket->write(&wcb, wbuf, sizeof(wbuf));
680 socket->shutdownWrite();
682 // Even though we haven't looped yet, we should be able to accept
684 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
686 // Since the connection is still in progress, there should be no data to
687 // read yet. Verify that the accepted socket is not readable.
688 struct pollfd fds[1];
689 fds[0].fd = acceptedSocket->getSocketFD();
690 fds[0].events = POLLIN;
692 int rc = poll(fds, 1, 0);
695 // Write data to the accepted socket
696 uint8_t acceptedWbuf[192];
697 memset(acceptedWbuf, 'b', sizeof(acceptedWbuf));
698 acceptedSocket->write(acceptedWbuf, sizeof(acceptedWbuf));
699 acceptedSocket->flush();
700 // Shutdown writes to the accepted socket. This will cause it to see EOF
701 // and uninstall the read callback.
702 shutdown(acceptedSocket->getSocketFD(), SHUT_WR);
707 // The loop should have completed the connection, written the queued data,
708 // shutdown writes on the socket, read the data we wrote to it, and see the
711 // Check that the connection was completed successfully and that the read
712 // and write callbacks were invoked as expected.
713 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
714 ASSERT_EQ(rcb.state, STATE_SUCCEEDED);
715 ASSERT_EQ(rcb.buffers.size(), 1);
716 ASSERT_EQ(rcb.buffers[0].length, sizeof(acceptedWbuf));
717 ASSERT_EQ(memcmp(rcb.buffers[0].buffer,
718 acceptedWbuf, sizeof(acceptedWbuf)), 0);
719 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
721 // Check that we can read the data that was written to the socket, and that
722 // we see an EOF, since its socket was half-shutdown.
723 uint8_t readbuf[sizeof(wbuf)];
724 acceptedSocket->readAll(readbuf, sizeof(readbuf));
725 ASSERT_EQ(memcmp(wbuf, readbuf, sizeof(wbuf)), 0);
726 uint32_t bytesRead = acceptedSocket->read(readbuf, sizeof(readbuf));
727 ASSERT_EQ(bytesRead, 0);
729 // Fully close both sockets
730 acceptedSocket->close();
733 ASSERT_FALSE(socket->isClosedBySelf());
734 ASSERT_TRUE(socket->isClosedByPeer());
738 * Test reading, writing, and calling shutdownWriteNow() before the
739 * connect attempt finishes.
741 TEST(AsyncSocketTest, ConnectReadWriteAndShutdownWriteNow) {
746 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
748 socket->connect(&ccb, server.getAddress(), 30);
750 // Hopefully the connect didn't succeed immediately.
751 // If it did, we can't exercise the write-while-connecting code path.
752 if (ccb.state == STATE_SUCCEEDED) {
753 LOG(INFO) << "connect() succeeded immediately; skipping test";
757 // Install a read callback
759 socket->setReadCB(&rcb);
761 // Ask to write some data
763 memset(wbuf, 'a', sizeof(wbuf));
765 socket->write(&wcb, wbuf, sizeof(wbuf));
767 // Shutdown writes immediately.
768 // This should immediately discard the data that we just tried to write.
769 socket->shutdownWriteNow();
771 // Verify that writeError() was invoked on the write callback.
772 ASSERT_EQ(wcb.state, STATE_FAILED);
773 ASSERT_EQ(wcb.bytesWritten, 0);
775 // Even though we haven't looped yet, we should be able to accept
777 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
779 // Since the connection is still in progress, there should be no data to
780 // read yet. Verify that the accepted socket is not readable.
781 struct pollfd fds[1];
782 fds[0].fd = acceptedSocket->getSocketFD();
783 fds[0].events = POLLIN;
785 int rc = poll(fds, 1, 0);
788 // Write data to the accepted socket
789 uint8_t acceptedWbuf[192];
790 memset(acceptedWbuf, 'b', sizeof(acceptedWbuf));
791 acceptedSocket->write(acceptedWbuf, sizeof(acceptedWbuf));
792 acceptedSocket->flush();
793 // Shutdown writes to the accepted socket. This will cause it to see EOF
794 // and uninstall the read callback.
795 shutdown(acceptedSocket->getSocketFD(), SHUT_WR);
800 // The loop should have completed the connection, written the queued data,
801 // shutdown writes on the socket, read the data we wrote to it, and see the
804 // Check that the connection was completed successfully and that the read
805 // callback was invoked as expected.
806 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
807 ASSERT_EQ(rcb.state, STATE_SUCCEEDED);
808 ASSERT_EQ(rcb.buffers.size(), 1);
809 ASSERT_EQ(rcb.buffers[0].length, sizeof(acceptedWbuf));
810 ASSERT_EQ(memcmp(rcb.buffers[0].buffer,
811 acceptedWbuf, sizeof(acceptedWbuf)), 0);
813 // Since we used shutdownWriteNow(), it should have discarded all pending
814 // write data. Verify we see an immediate EOF when reading from the accepted
816 uint8_t readbuf[sizeof(wbuf)];
817 uint32_t bytesRead = acceptedSocket->read(readbuf, sizeof(readbuf));
818 ASSERT_EQ(bytesRead, 0);
820 // Fully close both sockets
821 acceptedSocket->close();
824 ASSERT_FALSE(socket->isClosedBySelf());
825 ASSERT_TRUE(socket->isClosedByPeer());
828 // Helper function for use in testConnectOptWrite()
829 // Temporarily disable the read callback
830 void tmpDisableReads(AsyncSocket* socket, ReadCallback* rcb) {
831 // Uninstall the read callback
832 socket->setReadCB(nullptr);
833 // Schedule the read callback to be reinstalled after 1ms
834 socket->getEventBase()->runInLoop(
835 std::bind(&AsyncSocket::setReadCB, socket, rcb));
839 * Test connect+write, then have the connect callback perform another write.
841 * This tests interaction of the optimistic writing after connect with
842 * additional write attempts that occur in the connect callback.
844 void testConnectOptWrite(size_t size1, size_t size2, bool close = false) {
847 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
851 socket->connect(&ccb, server.getAddress(), 30);
853 // Hopefully the connect didn't succeed immediately.
854 // If it did, we can't exercise the optimistic write code path.
855 if (ccb.state == STATE_SUCCEEDED) {
856 LOG(INFO) << "connect() succeeded immediately; aborting test "
857 "of optimistic write behavior";
861 // Tell the connect callback to perform a write when the connect succeeds
863 scoped_array<char> buf2(new char[size2]);
864 memset(buf2.get(), 'b', size2);
866 ccb.successCallback = [&] { socket->write(&wcb2, buf2.get(), size2); };
867 // Tell the second write callback to close the connection when it is done
868 wcb2.successCallback = [&] { socket->closeNow(); };
871 // Schedule one write() immediately, before the connect finishes
872 scoped_array<char> buf1(new char[size1]);
873 memset(buf1.get(), 'a', size1);
876 socket->write(&wcb1, buf1.get(), size1);
880 // immediately perform a close, before connect() completes
884 // Start reading from the other endpoint after 10ms.
885 // If we're using large buffers, we have to read so that the writes don't
887 std::shared_ptr<AsyncSocket> acceptedSocket = server.acceptAsync(&evb);
889 rcb.dataAvailableCallback = std::bind(tmpDisableReads,
890 acceptedSocket.get(), &rcb);
891 socket->getEventBase()->tryRunAfterDelay(
892 std::bind(&AsyncSocket::setReadCB, acceptedSocket.get(), &rcb),
895 // Loop. We don't bother accepting on the server socket yet.
896 // The kernel should be able to buffer the write request so it can succeed.
899 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
901 ASSERT_EQ(wcb1.state, STATE_SUCCEEDED);
904 ASSERT_EQ(wcb2.state, STATE_SUCCEEDED);
909 // Make sure the read callback received all of the data
910 size_t bytesRead = 0;
911 for (vector<ReadCallback::Buffer>::const_iterator it = rcb.buffers.begin();
912 it != rcb.buffers.end();
914 size_t start = bytesRead;
915 bytesRead += it->length;
916 size_t end = bytesRead;
918 size_t cmpLen = min(size1, end) - start;
919 ASSERT_EQ(memcmp(it->buffer, buf1.get() + start, cmpLen), 0);
921 if (end > size1 && end <= size1 + size2) {
925 if (start >= size1) {
927 buf2Offset = start - size1;
928 cmpLen = end - start;
930 itOffset = size1 - start;
932 cmpLen = end - size1;
934 ASSERT_EQ(memcmp(it->buffer + itOffset, buf2.get() + buf2Offset,
939 ASSERT_EQ(bytesRead, size1 + size2);
942 TEST(AsyncSocketTest, ConnectCallbackWrite) {
943 // Test using small writes that should both succeed immediately
944 testConnectOptWrite(100, 200);
946 // Test using a large buffer in the connect callback, that should block
947 const size_t largeSize = 8*1024*1024;
948 testConnectOptWrite(100, largeSize);
950 // Test using a large initial write
951 testConnectOptWrite(largeSize, 100);
953 // Test using two large buffers
954 testConnectOptWrite(largeSize, largeSize);
956 // Test a small write in the connect callback,
957 // but no immediate write before connect completes
958 testConnectOptWrite(0, 64);
960 // Test a large write in the connect callback,
961 // but no immediate write before connect completes
962 testConnectOptWrite(0, largeSize);
964 // Test connect, a small write, then immediately call close() before connect
966 testConnectOptWrite(211, 0, true);
968 // Test connect, a large immediate write (that will block), then immediately
969 // call close() before connect completes
970 testConnectOptWrite(largeSize, 0, true);
973 ///////////////////////////////////////////////////////////////////////////
974 // write() related tests
975 ///////////////////////////////////////////////////////////////////////////
978 * Test writing using a nullptr callback
980 TEST(AsyncSocketTest, WriteNullCallback) {
985 std::shared_ptr<AsyncSocket> socket =
986 AsyncSocket::newSocket(&evb, server.getAddress(), 30);
987 evb.loop(); // loop until the socket is connected
989 // write() with a nullptr callback
991 memset(buf, 'a', sizeof(buf));
992 socket->write(nullptr, buf, sizeof(buf));
994 evb.loop(); // loop until the data is sent
996 // Make sure the server got a connection and received the data
998 server.verifyConnection(buf, sizeof(buf));
1000 ASSERT_TRUE(socket->isClosedBySelf());
1001 ASSERT_FALSE(socket->isClosedByPeer());
1005 * Test writing with a send timeout
1007 TEST(AsyncSocketTest, WriteTimeout) {
1012 std::shared_ptr<AsyncSocket> socket =
1013 AsyncSocket::newSocket(&evb, server.getAddress(), 30);
1014 evb.loop(); // loop until the socket is connected
1016 // write() a large chunk of data, with no-one on the other end reading
1017 size_t writeLength = 8*1024*1024;
1018 uint32_t timeout = 200;
1019 socket->setSendTimeout(timeout);
1020 scoped_array<char> buf(new char[writeLength]);
1021 memset(buf.get(), 'a', writeLength);
1023 socket->write(&wcb, buf.get(), writeLength);
1029 // Make sure the write attempt timed out as requested
1030 ASSERT_EQ(wcb.state, STATE_FAILED);
1031 ASSERT_EQ(wcb.exception.getType(), AsyncSocketException::TIMED_OUT);
1033 // Check that the write timed out within a reasonable period of time.
1034 // We don't check for exactly the specified timeout, since AsyncSocket only
1035 // times out when it hasn't made progress for that period of time.
1037 // On linux, the first write sends a few hundred kb of data, then blocks for
1038 // writability, and then unblocks again after 40ms and is able to write
1039 // another smaller of data before blocking permanently. Therefore it doesn't
1040 // time out until 40ms + timeout.
1042 // I haven't fully verified the cause of this, but I believe it probably
1043 // occurs because the receiving end delays sending an ack for up to 40ms.
1044 // (This is the default value for TCP_DELACK_MIN.) Once the sender receives
1045 // the ack, it can send some more data. However, after that point the
1046 // receiver's kernel buffer is full. This 40ms delay happens even with
1047 // TCP_NODELAY and TCP_QUICKACK enabled on both endpoints. However, the
1048 // kernel may be automatically disabling TCP_QUICKACK after receiving some
1051 // For now, we simply check that the timeout occurred within 160ms of
1052 // the requested value.
1053 T_CHECK_TIMEOUT(start, end, milliseconds(timeout), milliseconds(160));
1057 * Test writing to a socket that the remote endpoint has closed
1059 TEST(AsyncSocketTest, WritePipeError) {
1064 std::shared_ptr<AsyncSocket> socket =
1065 AsyncSocket::newSocket(&evb, server.getAddress(), 30);
1066 socket->setSendTimeout(1000);
1067 evb.loop(); // loop until the socket is connected
1069 // accept and immediately close the socket
1070 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
1071 acceptedSocket->close();
1073 // write() a large chunk of data
1074 size_t writeLength = 8*1024*1024;
1075 scoped_array<char> buf(new char[writeLength]);
1076 memset(buf.get(), 'a', writeLength);
1078 socket->write(&wcb, buf.get(), writeLength);
1082 // Make sure the write failed.
1083 // It would be nice if AsyncSocketException could convey the errno value,
1084 // so that we could check for EPIPE
1085 ASSERT_EQ(wcb.state, STATE_FAILED);
1086 ASSERT_EQ(wcb.exception.getType(),
1087 AsyncSocketException::INTERNAL_ERROR);
1089 ASSERT_FALSE(socket->isClosedBySelf());
1090 ASSERT_FALSE(socket->isClosedByPeer());
1094 * Test that bytes written is correctly computed in case of write failure
1096 TEST(AsyncSocketTest, WriteErrorCallbackBytesWritten) {
1097 // Send and receive buffer sizes for the sockets.
1098 const int sockBufSize = 8 * 1024;
1100 TestServer server(false, sockBufSize);
1102 AsyncSocket::OptionMap options{
1103 {{SOL_SOCKET, SO_SNDBUF}, sockBufSize},
1104 {{SOL_SOCKET, SO_RCVBUF}, sockBufSize},
1105 {{IPPROTO_TCP, TCP_NODELAY}, 1},
1108 // The current thread will be used by the receiver - use a separate thread
1110 EventBase senderEvb;
1111 std::thread senderThread([&]() { senderEvb.loopForever(); });
1114 std::shared_ptr<AsyncSocket> socket;
1116 senderEvb.runInEventBaseThreadAndWait([&]() {
1117 socket = AsyncSocket::newSocket(&senderEvb);
1118 socket->connect(&ccb, server.getAddress(), 30, options);
1121 // accept the socket on the server side
1122 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
1124 // Send a big (45KB) write so that it is partially written. The first write
1125 // is 16KB (8KB on both sides) and subsequent writes are 8KB each. Reading
1126 // just under 24KB would cause 3-4 writes for the total of 32-40KB in the
1127 // following sequence: 16KB + 8KB + 8KB (+ 8KB). This ensures that not all
1128 // bytes are written when the socket is reset. Having at least 3 writes
1129 // ensures that the total size (45KB) would be exceeed in case of overcounting
1130 // based on the initial write size of 16KB.
1131 constexpr size_t sendSize = 45 * 1024;
1132 auto const sendBuf = std::vector<char>(sendSize, 'a');
1136 senderEvb.runInEventBaseThreadAndWait(
1137 [&]() { socket->write(&wcb, sendBuf.data(), sendSize); });
1139 // Reading 20KB would cause three additional writes of 8KB, but less
1140 // than 45KB total, so the socket is reset before all bytes are written.
1141 constexpr size_t recvSize = 20 * 1024;
1142 uint8_t recvBuf[recvSize];
1143 int bytesRead = acceptedSocket->readAll(recvBuf, sizeof(recvBuf));
1145 acceptedSocket->closeWithReset();
1147 senderEvb.terminateLoopSoon();
1148 senderThread.join();
1150 LOG(INFO) << "Bytes written: " << wcb.bytesWritten;
1152 ASSERT_EQ(STATE_FAILED, wcb.state);
1153 ASSERT_GE(wcb.bytesWritten, bytesRead);
1154 ASSERT_LE(wcb.bytesWritten, sendSize);
1155 ASSERT_EQ(recvSize, bytesRead);
1156 ASSERT(32 * 1024 == wcb.bytesWritten || 40 * 1024 == wcb.bytesWritten);
1160 * Test writing a mix of simple buffers and IOBufs
1162 TEST(AsyncSocketTest, WriteIOBuf) {
1167 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
1169 socket->connect(&ccb, server.getAddress(), 30);
1171 // Accept the connection
1172 std::shared_ptr<AsyncSocket> acceptedSocket = server.acceptAsync(&evb);
1174 acceptedSocket->setReadCB(&rcb);
1176 // Write a simple buffer to the socket
1177 constexpr size_t simpleBufLength = 5;
1178 char simpleBuf[simpleBufLength];
1179 memset(simpleBuf, 'a', simpleBufLength);
1181 socket->write(&wcb, simpleBuf, simpleBufLength);
1183 // Write a single-element IOBuf chain
1184 size_t buf1Length = 7;
1185 unique_ptr<IOBuf> buf1(IOBuf::create(buf1Length));
1186 memset(buf1->writableData(), 'b', buf1Length);
1187 buf1->append(buf1Length);
1188 unique_ptr<IOBuf> buf1Copy(buf1->clone());
1190 socket->writeChain(&wcb2, std::move(buf1));
1192 // Write a multiple-element IOBuf chain
1193 size_t buf2Length = 11;
1194 unique_ptr<IOBuf> buf2(IOBuf::create(buf2Length));
1195 memset(buf2->writableData(), 'c', buf2Length);
1196 buf2->append(buf2Length);
1197 size_t buf3Length = 13;
1198 unique_ptr<IOBuf> buf3(IOBuf::create(buf3Length));
1199 memset(buf3->writableData(), 'd', buf3Length);
1200 buf3->append(buf3Length);
1201 buf2->appendChain(std::move(buf3));
1202 unique_ptr<IOBuf> buf2Copy(buf2->clone());
1203 buf2Copy->coalesce();
1205 socket->writeChain(&wcb3, std::move(buf2));
1206 socket->shutdownWrite();
1208 // Let the reads and writes run to completion
1211 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
1212 ASSERT_EQ(wcb2.state, STATE_SUCCEEDED);
1213 ASSERT_EQ(wcb3.state, STATE_SUCCEEDED);
1215 // Make sure the reader got the right data in the right order
1216 ASSERT_EQ(rcb.state, STATE_SUCCEEDED);
1217 ASSERT_EQ(rcb.buffers.size(), 1);
1218 ASSERT_EQ(rcb.buffers[0].length,
1219 simpleBufLength + buf1Length + buf2Length + buf3Length);
1221 memcmp(rcb.buffers[0].buffer, simpleBuf, simpleBufLength), 0);
1223 memcmp(rcb.buffers[0].buffer + simpleBufLength,
1224 buf1Copy->data(), buf1Copy->length()), 0);
1226 memcmp(rcb.buffers[0].buffer + simpleBufLength + buf1Length,
1227 buf2Copy->data(), buf2Copy->length()), 0);
1229 acceptedSocket->close();
1232 ASSERT_TRUE(socket->isClosedBySelf());
1233 ASSERT_FALSE(socket->isClosedByPeer());
1236 TEST(AsyncSocketTest, WriteIOBufCorked) {
1241 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
1243 socket->connect(&ccb, server.getAddress(), 30);
1245 // Accept the connection
1246 std::shared_ptr<AsyncSocket> acceptedSocket = server.acceptAsync(&evb);
1248 acceptedSocket->setReadCB(&rcb);
1250 // Do three writes, 100ms apart, with the "cork" flag set
1251 // on the second write. The reader should see the first write
1252 // arrive by itself, followed by the second and third writes
1253 // arriving together.
1254 size_t buf1Length = 5;
1255 unique_ptr<IOBuf> buf1(IOBuf::create(buf1Length));
1256 memset(buf1->writableData(), 'a', buf1Length);
1257 buf1->append(buf1Length);
1258 size_t buf2Length = 7;
1259 unique_ptr<IOBuf> buf2(IOBuf::create(buf2Length));
1260 memset(buf2->writableData(), 'b', buf2Length);
1261 buf2->append(buf2Length);
1262 size_t buf3Length = 11;
1263 unique_ptr<IOBuf> buf3(IOBuf::create(buf3Length));
1264 memset(buf3->writableData(), 'c', buf3Length);
1265 buf3->append(buf3Length);
1267 socket->writeChain(&wcb1, std::move(buf1));
1269 DelayedWrite write2(socket, std::move(buf2), &wcb2, true);
1270 write2.scheduleTimeout(100);
1272 DelayedWrite write3(socket, std::move(buf3), &wcb3, false, true);
1273 write3.scheduleTimeout(140);
1276 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
1277 ASSERT_EQ(wcb1.state, STATE_SUCCEEDED);
1278 ASSERT_EQ(wcb2.state, STATE_SUCCEEDED);
1279 if (wcb3.state != STATE_SUCCEEDED) {
1280 throw(wcb3.exception);
1282 ASSERT_EQ(wcb3.state, STATE_SUCCEEDED);
1284 // Make sure the reader got the data with the right grouping
1285 ASSERT_EQ(rcb.state, STATE_SUCCEEDED);
1286 ASSERT_EQ(rcb.buffers.size(), 2);
1287 ASSERT_EQ(rcb.buffers[0].length, buf1Length);
1288 ASSERT_EQ(rcb.buffers[1].length, buf2Length + buf3Length);
1290 acceptedSocket->close();
1293 ASSERT_TRUE(socket->isClosedBySelf());
1294 ASSERT_FALSE(socket->isClosedByPeer());
1298 * Test performing a zero-length write
1300 TEST(AsyncSocketTest, ZeroLengthWrite) {
1305 std::shared_ptr<AsyncSocket> socket =
1306 AsyncSocket::newSocket(&evb, server.getAddress(), 30);
1307 evb.loop(); // loop until the socket is connected
1309 auto acceptedSocket = server.acceptAsync(&evb);
1311 acceptedSocket->setReadCB(&rcb);
1313 size_t len1 = 1024*1024;
1314 size_t len2 = 1024*1024;
1315 std::unique_ptr<char[]> buf(new char[len1 + len2]);
1316 memset(buf.get(), 'a', len1);
1317 memset(buf.get(), 'b', len2);
1323 socket->write(&wcb1, buf.get(), 0);
1324 socket->write(&wcb2, buf.get(), len1);
1325 socket->write(&wcb3, buf.get() + len1, 0);
1326 socket->write(&wcb4, buf.get() + len1, len2);
1329 evb.loop(); // loop until the data is sent
1331 ASSERT_EQ(wcb1.state, STATE_SUCCEEDED);
1332 ASSERT_EQ(wcb2.state, STATE_SUCCEEDED);
1333 ASSERT_EQ(wcb3.state, STATE_SUCCEEDED);
1334 ASSERT_EQ(wcb4.state, STATE_SUCCEEDED);
1335 rcb.verifyData(buf.get(), len1 + len2);
1337 ASSERT_TRUE(socket->isClosedBySelf());
1338 ASSERT_FALSE(socket->isClosedByPeer());
1341 TEST(AsyncSocketTest, ZeroLengthWritev) {
1346 std::shared_ptr<AsyncSocket> socket =
1347 AsyncSocket::newSocket(&evb, server.getAddress(), 30);
1348 evb.loop(); // loop until the socket is connected
1350 auto acceptedSocket = server.acceptAsync(&evb);
1352 acceptedSocket->setReadCB(&rcb);
1354 size_t len1 = 1024*1024;
1355 size_t len2 = 1024*1024;
1356 std::unique_ptr<char[]> buf(new char[len1 + len2]);
1357 memset(buf.get(), 'a', len1);
1358 memset(buf.get(), 'b', len2);
1361 constexpr size_t iovCount = 4;
1362 struct iovec iov[iovCount];
1363 iov[0].iov_base = buf.get();
1364 iov[0].iov_len = len1;
1365 iov[1].iov_base = buf.get() + len1;
1367 iov[2].iov_base = buf.get() + len1;
1368 iov[2].iov_len = len2;
1369 iov[3].iov_base = buf.get() + len1 + len2;
1372 socket->writev(&wcb, iov, iovCount);
1374 evb.loop(); // loop until the data is sent
1376 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
1377 rcb.verifyData(buf.get(), len1 + len2);
1379 ASSERT_TRUE(socket->isClosedBySelf());
1380 ASSERT_FALSE(socket->isClosedByPeer());
1383 ///////////////////////////////////////////////////////////////////////////
1384 // close() related tests
1385 ///////////////////////////////////////////////////////////////////////////
1388 * Test calling close() with pending writes when the socket is already closing.
1390 TEST(AsyncSocketTest, ClosePendingWritesWhileClosing) {
1395 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
1397 socket->connect(&ccb, server.getAddress(), 30);
1399 // accept the socket on the server side
1400 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
1402 // Loop to ensure the connect has completed
1405 // Make sure we are connected
1406 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
1408 // Schedule pending writes, until several write attempts have blocked
1410 memset(buf, 'a', sizeof(buf));
1411 typedef vector< std::shared_ptr<WriteCallback> > WriteCallbackVector;
1412 WriteCallbackVector writeCallbacks;
1414 writeCallbacks.reserve(5);
1415 while (writeCallbacks.size() < 5) {
1416 std::shared_ptr<WriteCallback> wcb(new WriteCallback);
1418 socket->write(wcb.get(), buf, sizeof(buf));
1419 if (wcb->state == STATE_SUCCEEDED) {
1420 // Succeeded immediately. Keep performing more writes
1424 // This write is blocked.
1425 // Have the write callback call close() when writeError() is invoked
1426 wcb->errorCallback = std::bind(&AsyncSocket::close, socket.get());
1427 writeCallbacks.push_back(wcb);
1430 // Call closeNow() to immediately fail the pending writes
1433 // Make sure writeError() was invoked on all of the pending write callbacks
1434 for (WriteCallbackVector::const_iterator it = writeCallbacks.begin();
1435 it != writeCallbacks.end();
1437 ASSERT_EQ((*it)->state, STATE_FAILED);
1440 ASSERT_TRUE(socket->isClosedBySelf());
1441 ASSERT_FALSE(socket->isClosedByPeer());
1444 ///////////////////////////////////////////////////////////////////////////
1445 // ImmediateRead related tests
1446 ///////////////////////////////////////////////////////////////////////////
1448 /* AsyncSocket use to verify immediate read works */
1449 class AsyncSocketImmediateRead : public folly::AsyncSocket {
1451 bool immediateReadCalled = false;
1452 explicit AsyncSocketImmediateRead(folly::EventBase* evb) : AsyncSocket(evb) {}
1454 void checkForImmediateRead() noexcept override {
1455 immediateReadCalled = true;
1456 AsyncSocket::handleRead();
1460 TEST(AsyncSocket, ConnectReadImmediateRead) {
1463 const size_t maxBufferSz = 100;
1464 const size_t maxReadsPerEvent = 1;
1465 const size_t expectedDataSz = maxBufferSz * 3;
1466 char expectedData[expectedDataSz];
1467 memset(expectedData, 'j', expectedDataSz);
1470 ReadCallback rcb(maxBufferSz);
1471 AsyncSocketImmediateRead socket(&evb);
1472 socket.connect(nullptr, server.getAddress(), 30);
1474 evb.loop(); // loop until the socket is connected
1476 socket.setReadCB(&rcb);
1477 socket.setMaxReadsPerEvent(maxReadsPerEvent);
1478 socket.immediateReadCalled = false;
1480 auto acceptedSocket = server.acceptAsync(&evb);
1482 ReadCallback rcbServer;
1483 WriteCallback wcbServer;
1484 rcbServer.dataAvailableCallback = [&]() {
1485 if (rcbServer.dataRead() == expectedDataSz) {
1486 // write back all data read
1487 rcbServer.verifyData(expectedData, expectedDataSz);
1488 acceptedSocket->write(&wcbServer, expectedData, expectedDataSz);
1489 acceptedSocket->close();
1492 acceptedSocket->setReadCB(&rcbServer);
1496 socket.write(&wcb1, expectedData, expectedDataSz);
1498 ASSERT_EQ(wcb1.state, STATE_SUCCEEDED);
1499 rcb.verifyData(expectedData, expectedDataSz);
1500 ASSERT_EQ(socket.immediateReadCalled, true);
1502 ASSERT_FALSE(socket.isClosedBySelf());
1503 ASSERT_FALSE(socket.isClosedByPeer());
1506 TEST(AsyncSocket, ConnectReadUninstallRead) {
1509 const size_t maxBufferSz = 100;
1510 const size_t maxReadsPerEvent = 1;
1511 const size_t expectedDataSz = maxBufferSz * 3;
1512 char expectedData[expectedDataSz];
1513 memset(expectedData, 'k', expectedDataSz);
1516 ReadCallback rcb(maxBufferSz);
1517 AsyncSocketImmediateRead socket(&evb);
1518 socket.connect(nullptr, server.getAddress(), 30);
1520 evb.loop(); // loop until the socket is connected
1522 socket.setReadCB(&rcb);
1523 socket.setMaxReadsPerEvent(maxReadsPerEvent);
1524 socket.immediateReadCalled = false;
1526 auto acceptedSocket = server.acceptAsync(&evb);
1528 ReadCallback rcbServer;
1529 WriteCallback wcbServer;
1530 rcbServer.dataAvailableCallback = [&]() {
1531 if (rcbServer.dataRead() == expectedDataSz) {
1532 // write back all data read
1533 rcbServer.verifyData(expectedData, expectedDataSz);
1534 acceptedSocket->write(&wcbServer, expectedData, expectedDataSz);
1535 acceptedSocket->close();
1538 acceptedSocket->setReadCB(&rcbServer);
1540 rcb.dataAvailableCallback = [&]() {
1541 // we read data and reset readCB
1542 socket.setReadCB(nullptr);
1547 socket.write(&wcb, expectedData, expectedDataSz);
1549 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
1551 /* we shoud've only read maxBufferSz data since readCallback_
1552 * was reset in dataAvailableCallback */
1553 ASSERT_EQ(rcb.dataRead(), maxBufferSz);
1554 ASSERT_EQ(socket.immediateReadCalled, false);
1556 ASSERT_FALSE(socket.isClosedBySelf());
1557 ASSERT_FALSE(socket.isClosedByPeer());
1561 // - Test connect() and have the connect callback set the read callback
1562 // - Test connect() and have the connect callback unset the read callback
1563 // - Test reading/writing/closing/destroying the socket in the connect callback
1564 // - Test reading/writing/closing/destroying the socket in the read callback
1565 // - Test reading/writing/closing/destroying the socket in the write callback
1566 // - Test one-way shutdown behavior
1567 // - Test changing the EventBase
1569 // - TODO: test multiple threads sharing a AsyncSocket, and detaching from it
1570 // in connectSuccess(), readDataAvailable(), writeSuccess()
1573 ///////////////////////////////////////////////////////////////////////////
1574 // AsyncServerSocket tests
1575 ///////////////////////////////////////////////////////////////////////////
1578 * Helper ConnectionEventCallback class for the test code.
1579 * It maintains counters protected by a spin lock.
1581 class TestConnectionEventCallback :
1582 public AsyncServerSocket::ConnectionEventCallback {
1584 virtual void onConnectionAccepted(
1585 const int /* socket */,
1586 const SocketAddress& /* addr */) noexcept override {
1587 folly::RWSpinLock::WriteHolder holder(spinLock_);
1588 connectionAccepted_++;
1591 virtual void onConnectionAcceptError(const int /* err */) noexcept override {
1592 folly::RWSpinLock::WriteHolder holder(spinLock_);
1593 connectionAcceptedError_++;
1596 virtual void onConnectionDropped(
1597 const int /* socket */,
1598 const SocketAddress& /* addr */) noexcept override {
1599 folly::RWSpinLock::WriteHolder holder(spinLock_);
1600 connectionDropped_++;
1603 virtual void onConnectionEnqueuedForAcceptorCallback(
1604 const int /* socket */,
1605 const SocketAddress& /* addr */) noexcept override {
1606 folly::RWSpinLock::WriteHolder holder(spinLock_);
1607 connectionEnqueuedForAcceptCallback_++;
1610 virtual void onConnectionDequeuedByAcceptorCallback(
1611 const int /* socket */,
1612 const SocketAddress& /* addr */) noexcept override {
1613 folly::RWSpinLock::WriteHolder holder(spinLock_);
1614 connectionDequeuedByAcceptCallback_++;
1617 virtual void onBackoffStarted() noexcept override {
1618 folly::RWSpinLock::WriteHolder holder(spinLock_);
1622 virtual void onBackoffEnded() noexcept override {
1623 folly::RWSpinLock::WriteHolder holder(spinLock_);
1627 virtual void onBackoffError() noexcept override {
1628 folly::RWSpinLock::WriteHolder holder(spinLock_);
1632 unsigned int getConnectionAccepted() const {
1633 folly::RWSpinLock::ReadHolder holder(spinLock_);
1634 return connectionAccepted_;
1637 unsigned int getConnectionAcceptedError() const {
1638 folly::RWSpinLock::ReadHolder holder(spinLock_);
1639 return connectionAcceptedError_;
1642 unsigned int getConnectionDropped() const {
1643 folly::RWSpinLock::ReadHolder holder(spinLock_);
1644 return connectionDropped_;
1647 unsigned int getConnectionEnqueuedForAcceptCallback() const {
1648 folly::RWSpinLock::ReadHolder holder(spinLock_);
1649 return connectionEnqueuedForAcceptCallback_;
1652 unsigned int getConnectionDequeuedByAcceptCallback() const {
1653 folly::RWSpinLock::ReadHolder holder(spinLock_);
1654 return connectionDequeuedByAcceptCallback_;
1657 unsigned int getBackoffStarted() const {
1658 folly::RWSpinLock::ReadHolder holder(spinLock_);
1659 return backoffStarted_;
1662 unsigned int getBackoffEnded() const {
1663 folly::RWSpinLock::ReadHolder holder(spinLock_);
1664 return backoffEnded_;
1667 unsigned int getBackoffError() const {
1668 folly::RWSpinLock::ReadHolder holder(spinLock_);
1669 return backoffError_;
1673 mutable folly::RWSpinLock spinLock_;
1674 unsigned int connectionAccepted_{0};
1675 unsigned int connectionAcceptedError_{0};
1676 unsigned int connectionDropped_{0};
1677 unsigned int connectionEnqueuedForAcceptCallback_{0};
1678 unsigned int connectionDequeuedByAcceptCallback_{0};
1679 unsigned int backoffStarted_{0};
1680 unsigned int backoffEnded_{0};
1681 unsigned int backoffError_{0};
1685 * Helper AcceptCallback class for the test code
1686 * It records the callbacks that were invoked, and also supports calling
1687 * generic std::function objects in each callback.
1689 class TestAcceptCallback : public AsyncServerSocket::AcceptCallback {
1698 EventInfo(int fd, const folly::SocketAddress& addr)
1699 : type(TYPE_ACCEPT),
1703 explicit EventInfo(const std::string& msg)
1708 explicit EventInfo(EventType et)
1715 int fd; // valid for TYPE_ACCEPT
1716 folly::SocketAddress address; // valid for TYPE_ACCEPT
1717 string errorMsg; // valid for TYPE_ERROR
1719 typedef std::deque<EventInfo> EventList;
1721 TestAcceptCallback()
1722 : connectionAcceptedFn_(),
1727 std::deque<EventInfo>* getEvents() {
1731 void setConnectionAcceptedFn(
1732 const std::function<void(int, const folly::SocketAddress&)>& fn) {
1733 connectionAcceptedFn_ = fn;
1735 void setAcceptErrorFn(const std::function<void(const std::exception&)>& fn) {
1736 acceptErrorFn_ = fn;
1738 void setAcceptStartedFn(const std::function<void()>& fn) {
1739 acceptStartedFn_ = fn;
1741 void setAcceptStoppedFn(const std::function<void()>& fn) {
1742 acceptStoppedFn_ = fn;
1745 void connectionAccepted(
1746 int fd, const folly::SocketAddress& clientAddr) noexcept override {
1747 events_.emplace_back(fd, clientAddr);
1749 if (connectionAcceptedFn_) {
1750 connectionAcceptedFn_(fd, clientAddr);
1753 void acceptError(const std::exception& ex) noexcept override {
1754 events_.emplace_back(ex.what());
1756 if (acceptErrorFn_) {
1760 void acceptStarted() noexcept override {
1761 events_.emplace_back(TYPE_START);
1763 if (acceptStartedFn_) {
1767 void acceptStopped() noexcept override {
1768 events_.emplace_back(TYPE_STOP);
1770 if (acceptStoppedFn_) {
1776 std::function<void(int, const folly::SocketAddress&)> connectionAcceptedFn_;
1777 std::function<void(const std::exception&)> acceptErrorFn_;
1778 std::function<void()> acceptStartedFn_;
1779 std::function<void()> acceptStoppedFn_;
1781 std::deque<EventInfo> events_;
1786 * Make sure accepted sockets have O_NONBLOCK and TCP_NODELAY set
1788 TEST(AsyncSocketTest, ServerAcceptOptions) {
1789 EventBase eventBase;
1791 // Create a server socket
1792 std::shared_ptr<AsyncServerSocket> serverSocket(
1793 AsyncServerSocket::newSocket(&eventBase));
1794 serverSocket->bind(0);
1795 serverSocket->listen(16);
1796 folly::SocketAddress serverAddress;
1797 serverSocket->getAddress(&serverAddress);
1799 // Add a callback to accept one connection then stop the loop
1800 TestAcceptCallback acceptCallback;
1801 acceptCallback.setConnectionAcceptedFn(
1802 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1803 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
1805 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
1806 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
1808 serverSocket->addAcceptCallback(&acceptCallback, &eventBase);
1809 serverSocket->startAccepting();
1811 // Connect to the server socket
1812 std::shared_ptr<AsyncSocket> socket(
1813 AsyncSocket::newSocket(&eventBase, serverAddress));
1817 // Verify that the server accepted a connection
1818 ASSERT_EQ(acceptCallback.getEvents()->size(), 3);
1819 ASSERT_EQ(acceptCallback.getEvents()->at(0).type,
1820 TestAcceptCallback::TYPE_START);
1821 ASSERT_EQ(acceptCallback.getEvents()->at(1).type,
1822 TestAcceptCallback::TYPE_ACCEPT);
1823 ASSERT_EQ(acceptCallback.getEvents()->at(2).type,
1824 TestAcceptCallback::TYPE_STOP);
1825 int fd = acceptCallback.getEvents()->at(1).fd;
1827 // The accepted connection should already be in non-blocking mode
1828 int flags = fcntl(fd, F_GETFL, 0);
1829 ASSERT_EQ(flags & O_NONBLOCK, O_NONBLOCK);
1832 // The accepted connection should already have TCP_NODELAY set
1834 socklen_t valueLength = sizeof(value);
1835 int rc = getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &value, &valueLength);
1837 ASSERT_EQ(value, 1);
1842 * Test AsyncServerSocket::removeAcceptCallback()
1844 TEST(AsyncSocketTest, RemoveAcceptCallback) {
1845 // Create a new AsyncServerSocket
1846 EventBase eventBase;
1847 std::shared_ptr<AsyncServerSocket> serverSocket(
1848 AsyncServerSocket::newSocket(&eventBase));
1849 serverSocket->bind(0);
1850 serverSocket->listen(16);
1851 folly::SocketAddress serverAddress;
1852 serverSocket->getAddress(&serverAddress);
1854 // Add several accept callbacks
1855 TestAcceptCallback cb1;
1856 TestAcceptCallback cb2;
1857 TestAcceptCallback cb3;
1858 TestAcceptCallback cb4;
1859 TestAcceptCallback cb5;
1860 TestAcceptCallback cb6;
1861 TestAcceptCallback cb7;
1863 // Test having callbacks remove other callbacks before them on the list,
1864 // after them on the list, or removing themselves.
1866 // Have callback 2 remove callback 3 and callback 5 the first time it is
1869 cb1.setConnectionAcceptedFn([&](int /* fd */,
1870 const folly::SocketAddress& /* addr */) {
1871 std::shared_ptr<AsyncSocket> sock2(
1872 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb2: -cb3 -cb5
1874 cb3.setConnectionAcceptedFn(
1875 [&](int /* fd */, const folly::SocketAddress& /* addr */) {});
1876 cb4.setConnectionAcceptedFn(
1877 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1878 std::shared_ptr<AsyncSocket> sock3(
1879 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb4
1881 cb5.setConnectionAcceptedFn(
1882 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1883 std::shared_ptr<AsyncSocket> sock5(
1884 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb7: -cb7
1887 cb2.setConnectionAcceptedFn(
1888 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1889 if (cb2Count == 0) {
1890 serverSocket->removeAcceptCallback(&cb3, nullptr);
1891 serverSocket->removeAcceptCallback(&cb5, nullptr);
1895 // Have callback 6 remove callback 4 the first time it is called,
1896 // and destroy the server socket the second time it is called
1898 cb6.setConnectionAcceptedFn(
1899 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1900 if (cb6Count == 0) {
1901 serverSocket->removeAcceptCallback(&cb4, nullptr);
1902 std::shared_ptr<AsyncSocket> sock6(
1903 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb1
1904 std::shared_ptr<AsyncSocket> sock7(
1905 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb2
1906 std::shared_ptr<AsyncSocket> sock8(
1907 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb6: stop
1910 serverSocket.reset();
1914 // Have callback 7 remove itself
1915 cb7.setConnectionAcceptedFn(
1916 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1917 serverSocket->removeAcceptCallback(&cb7, nullptr);
1920 serverSocket->addAcceptCallback(&cb1, &eventBase);
1921 serverSocket->addAcceptCallback(&cb2, &eventBase);
1922 serverSocket->addAcceptCallback(&cb3, &eventBase);
1923 serverSocket->addAcceptCallback(&cb4, &eventBase);
1924 serverSocket->addAcceptCallback(&cb5, &eventBase);
1925 serverSocket->addAcceptCallback(&cb6, &eventBase);
1926 serverSocket->addAcceptCallback(&cb7, &eventBase);
1927 serverSocket->startAccepting();
1929 // Make several connections to the socket
1930 std::shared_ptr<AsyncSocket> sock1(
1931 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb1
1932 std::shared_ptr<AsyncSocket> sock4(
1933 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb6: -cb4
1935 // Loop until we are stopped
1938 // Check to make sure that the expected callbacks were invoked.
1940 // NOTE: This code depends on the AsyncServerSocket operating calling all of
1941 // the AcceptCallbacks in round-robin fashion, in the order that they were
1942 // added. The code is implemented this way right now, but the API doesn't
1943 // explicitly require it be done this way. If we change the code not to be
1944 // exactly round robin in the future, we can simplify the test checks here.
1945 // (We'll also need to update the termination code, since we expect cb6 to
1946 // get called twice to terminate the loop.)
1947 ASSERT_EQ(cb1.getEvents()->size(), 4);
1948 ASSERT_EQ(cb1.getEvents()->at(0).type,
1949 TestAcceptCallback::TYPE_START);
1950 ASSERT_EQ(cb1.getEvents()->at(1).type,
1951 TestAcceptCallback::TYPE_ACCEPT);
1952 ASSERT_EQ(cb1.getEvents()->at(2).type,
1953 TestAcceptCallback::TYPE_ACCEPT);
1954 ASSERT_EQ(cb1.getEvents()->at(3).type,
1955 TestAcceptCallback::TYPE_STOP);
1957 ASSERT_EQ(cb2.getEvents()->size(), 4);
1958 ASSERT_EQ(cb2.getEvents()->at(0).type,
1959 TestAcceptCallback::TYPE_START);
1960 ASSERT_EQ(cb2.getEvents()->at(1).type,
1961 TestAcceptCallback::TYPE_ACCEPT);
1962 ASSERT_EQ(cb2.getEvents()->at(2).type,
1963 TestAcceptCallback::TYPE_ACCEPT);
1964 ASSERT_EQ(cb2.getEvents()->at(3).type,
1965 TestAcceptCallback::TYPE_STOP);
1967 ASSERT_EQ(cb3.getEvents()->size(), 2);
1968 ASSERT_EQ(cb3.getEvents()->at(0).type,
1969 TestAcceptCallback::TYPE_START);
1970 ASSERT_EQ(cb3.getEvents()->at(1).type,
1971 TestAcceptCallback::TYPE_STOP);
1973 ASSERT_EQ(cb4.getEvents()->size(), 3);
1974 ASSERT_EQ(cb4.getEvents()->at(0).type,
1975 TestAcceptCallback::TYPE_START);
1976 ASSERT_EQ(cb4.getEvents()->at(1).type,
1977 TestAcceptCallback::TYPE_ACCEPT);
1978 ASSERT_EQ(cb4.getEvents()->at(2).type,
1979 TestAcceptCallback::TYPE_STOP);
1981 ASSERT_EQ(cb5.getEvents()->size(), 2);
1982 ASSERT_EQ(cb5.getEvents()->at(0).type,
1983 TestAcceptCallback::TYPE_START);
1984 ASSERT_EQ(cb5.getEvents()->at(1).type,
1985 TestAcceptCallback::TYPE_STOP);
1987 ASSERT_EQ(cb6.getEvents()->size(), 4);
1988 ASSERT_EQ(cb6.getEvents()->at(0).type,
1989 TestAcceptCallback::TYPE_START);
1990 ASSERT_EQ(cb6.getEvents()->at(1).type,
1991 TestAcceptCallback::TYPE_ACCEPT);
1992 ASSERT_EQ(cb6.getEvents()->at(2).type,
1993 TestAcceptCallback::TYPE_ACCEPT);
1994 ASSERT_EQ(cb6.getEvents()->at(3).type,
1995 TestAcceptCallback::TYPE_STOP);
1997 ASSERT_EQ(cb7.getEvents()->size(), 3);
1998 ASSERT_EQ(cb7.getEvents()->at(0).type,
1999 TestAcceptCallback::TYPE_START);
2000 ASSERT_EQ(cb7.getEvents()->at(1).type,
2001 TestAcceptCallback::TYPE_ACCEPT);
2002 ASSERT_EQ(cb7.getEvents()->at(2).type,
2003 TestAcceptCallback::TYPE_STOP);
2007 * Test AsyncServerSocket::removeAcceptCallback()
2009 TEST(AsyncSocketTest, OtherThreadAcceptCallback) {
2010 // Create a new AsyncServerSocket
2011 EventBase eventBase;
2012 std::shared_ptr<AsyncServerSocket> serverSocket(
2013 AsyncServerSocket::newSocket(&eventBase));
2014 serverSocket->bind(0);
2015 serverSocket->listen(16);
2016 folly::SocketAddress serverAddress;
2017 serverSocket->getAddress(&serverAddress);
2019 // Add several accept callbacks
2020 TestAcceptCallback cb1;
2021 auto thread_id = std::this_thread::get_id();
2022 cb1.setAcceptStartedFn([&](){
2023 CHECK_NE(thread_id, std::this_thread::get_id());
2024 thread_id = std::this_thread::get_id();
2026 cb1.setConnectionAcceptedFn(
2027 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2028 ASSERT_EQ(thread_id, std::this_thread::get_id());
2029 serverSocket->removeAcceptCallback(&cb1, &eventBase);
2031 cb1.setAcceptStoppedFn([&](){
2032 ASSERT_EQ(thread_id, std::this_thread::get_id());
2035 // Test having callbacks remove other callbacks before them on the list,
2036 serverSocket->addAcceptCallback(&cb1, &eventBase);
2037 serverSocket->startAccepting();
2039 // Make several connections to the socket
2040 std::shared_ptr<AsyncSocket> sock1(
2041 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb1
2043 // Loop in another thread
2044 auto other = std::thread([&](){
2049 // Check to make sure that the expected callbacks were invoked.
2051 // NOTE: This code depends on the AsyncServerSocket operating calling all of
2052 // the AcceptCallbacks in round-robin fashion, in the order that they were
2053 // added. The code is implemented this way right now, but the API doesn't
2054 // explicitly require it be done this way. If we change the code not to be
2055 // exactly round robin in the future, we can simplify the test checks here.
2056 // (We'll also need to update the termination code, since we expect cb6 to
2057 // get called twice to terminate the loop.)
2058 ASSERT_EQ(cb1.getEvents()->size(), 3);
2059 ASSERT_EQ(cb1.getEvents()->at(0).type,
2060 TestAcceptCallback::TYPE_START);
2061 ASSERT_EQ(cb1.getEvents()->at(1).type,
2062 TestAcceptCallback::TYPE_ACCEPT);
2063 ASSERT_EQ(cb1.getEvents()->at(2).type,
2064 TestAcceptCallback::TYPE_STOP);
2068 void serverSocketSanityTest(AsyncServerSocket* serverSocket) {
2069 EventBase* eventBase = serverSocket->getEventBase();
2072 // Add a callback to accept one connection then stop accepting
2073 TestAcceptCallback acceptCallback;
2074 acceptCallback.setConnectionAcceptedFn(
2075 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2076 serverSocket->removeAcceptCallback(&acceptCallback, eventBase);
2078 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2079 serverSocket->removeAcceptCallback(&acceptCallback, eventBase);
2081 serverSocket->addAcceptCallback(&acceptCallback, eventBase);
2082 serverSocket->startAccepting();
2084 // Connect to the server socket
2085 folly::SocketAddress serverAddress;
2086 serverSocket->getAddress(&serverAddress);
2087 AsyncSocket::UniquePtr socket(new AsyncSocket(eventBase, serverAddress));
2089 // Loop to process all events
2092 // Verify that the server accepted a connection
2093 ASSERT_EQ(acceptCallback.getEvents()->size(), 3);
2094 ASSERT_EQ(acceptCallback.getEvents()->at(0).type,
2095 TestAcceptCallback::TYPE_START);
2096 ASSERT_EQ(acceptCallback.getEvents()->at(1).type,
2097 TestAcceptCallback::TYPE_ACCEPT);
2098 ASSERT_EQ(acceptCallback.getEvents()->at(2).type,
2099 TestAcceptCallback::TYPE_STOP);
2102 /* Verify that we don't leak sockets if we are destroyed()
2103 * and there are still writes pending
2105 * If destroy() only calls close() instead of closeNow(),
2106 * it would shutdown(writes) on the socket, but it would
2107 * never be close()'d, and the socket would leak
2109 TEST(AsyncSocketTest, DestroyCloseTest) {
2115 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&clientEB);
2117 socket->connect(&ccb, server.getAddress(), 30);
2119 // Accept the connection
2120 std::shared_ptr<AsyncSocket> acceptedSocket = server.acceptAsync(&serverEB);
2122 acceptedSocket->setReadCB(&rcb);
2124 // Write a large buffer to the socket that is larger than kernel buffer
2125 size_t simpleBufLength = 5000000;
2126 char* simpleBuf = new char[simpleBufLength];
2127 memset(simpleBuf, 'a', simpleBufLength);
2130 // Let the reads and writes run to completion
2131 int fd = acceptedSocket->getFd();
2133 acceptedSocket->write(&wcb, simpleBuf, simpleBufLength);
2135 acceptedSocket.reset();
2137 // Test that server socket was closed
2138 folly::test::msvcSuppressAbortOnInvalidParams([&] {
2139 ssize_t sz = read(fd, simpleBuf, simpleBufLength);
2141 ASSERT_EQ(errno, EBADF);
2147 * Test AsyncServerSocket::useExistingSocket()
2149 TEST(AsyncSocketTest, ServerExistingSocket) {
2150 EventBase eventBase;
2152 // Test creating a socket, and letting AsyncServerSocket bind and listen
2154 // Manually create a socket
2155 int fd = fsp::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
2158 // Create a server socket
2159 AsyncServerSocket::UniquePtr serverSocket(
2160 new AsyncServerSocket(&eventBase));
2161 serverSocket->useExistingSocket(fd);
2162 folly::SocketAddress address;
2163 serverSocket->getAddress(&address);
2165 serverSocket->bind(address);
2166 serverSocket->listen(16);
2168 // Make sure the socket works
2169 serverSocketSanityTest(serverSocket.get());
2172 // Test creating a socket and binding manually,
2173 // then letting AsyncServerSocket listen
2175 // Manually create a socket
2176 int fd = fsp::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
2179 struct sockaddr_in addr;
2180 addr.sin_family = AF_INET;
2182 addr.sin_addr.s_addr = INADDR_ANY;
2183 ASSERT_EQ(bind(fd, reinterpret_cast<struct sockaddr*>(&addr),
2185 // Look up the address that we bound to
2186 folly::SocketAddress boundAddress;
2187 boundAddress.setFromLocalAddress(fd);
2189 // Create a server socket
2190 AsyncServerSocket::UniquePtr serverSocket(
2191 new AsyncServerSocket(&eventBase));
2192 serverSocket->useExistingSocket(fd);
2193 serverSocket->listen(16);
2195 // Make sure AsyncServerSocket reports the same address that we bound to
2196 folly::SocketAddress serverSocketAddress;
2197 serverSocket->getAddress(&serverSocketAddress);
2198 ASSERT_EQ(boundAddress, serverSocketAddress);
2200 // Make sure the socket works
2201 serverSocketSanityTest(serverSocket.get());
2204 // Test creating a socket, binding and listening manually,
2205 // then giving it to AsyncServerSocket
2207 // Manually create a socket
2208 int fd = fsp::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
2211 struct sockaddr_in addr;
2212 addr.sin_family = AF_INET;
2214 addr.sin_addr.s_addr = INADDR_ANY;
2215 ASSERT_EQ(bind(fd, reinterpret_cast<struct sockaddr*>(&addr),
2217 // Look up the address that we bound to
2218 folly::SocketAddress boundAddress;
2219 boundAddress.setFromLocalAddress(fd);
2221 ASSERT_EQ(listen(fd, 16), 0);
2223 // Create a server socket
2224 AsyncServerSocket::UniquePtr serverSocket(
2225 new AsyncServerSocket(&eventBase));
2226 serverSocket->useExistingSocket(fd);
2228 // Make sure AsyncServerSocket reports the same address that we bound to
2229 folly::SocketAddress serverSocketAddress;
2230 serverSocket->getAddress(&serverSocketAddress);
2231 ASSERT_EQ(boundAddress, serverSocketAddress);
2233 // Make sure the socket works
2234 serverSocketSanityTest(serverSocket.get());
2238 TEST(AsyncSocketTest, UnixDomainSocketTest) {
2239 EventBase eventBase;
2241 // Create a server socket
2242 std::shared_ptr<AsyncServerSocket> serverSocket(
2243 AsyncServerSocket::newSocket(&eventBase));
2245 path.append(folly::to<string>("/anonymous", folly::Random::rand64()));
2246 folly::SocketAddress serverAddress;
2247 serverAddress.setFromPath(path);
2248 serverSocket->bind(serverAddress);
2249 serverSocket->listen(16);
2251 // Add a callback to accept one connection then stop the loop
2252 TestAcceptCallback acceptCallback;
2253 acceptCallback.setConnectionAcceptedFn(
2254 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2255 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
2257 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2258 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
2260 serverSocket->addAcceptCallback(&acceptCallback, &eventBase);
2261 serverSocket->startAccepting();
2263 // Connect to the server socket
2264 std::shared_ptr<AsyncSocket> socket(
2265 AsyncSocket::newSocket(&eventBase, serverAddress));
2269 // Verify that the server accepted a connection
2270 ASSERT_EQ(acceptCallback.getEvents()->size(), 3);
2271 ASSERT_EQ(acceptCallback.getEvents()->at(0).type,
2272 TestAcceptCallback::TYPE_START);
2273 ASSERT_EQ(acceptCallback.getEvents()->at(1).type,
2274 TestAcceptCallback::TYPE_ACCEPT);
2275 ASSERT_EQ(acceptCallback.getEvents()->at(2).type,
2276 TestAcceptCallback::TYPE_STOP);
2277 int fd = acceptCallback.getEvents()->at(1).fd;
2279 // The accepted connection should already be in non-blocking mode
2280 int flags = fcntl(fd, F_GETFL, 0);
2281 ASSERT_EQ(flags & O_NONBLOCK, O_NONBLOCK);
2284 TEST(AsyncSocketTest, ConnectionEventCallbackDefault) {
2285 EventBase eventBase;
2286 TestConnectionEventCallback connectionEventCallback;
2288 // Create a server socket
2289 std::shared_ptr<AsyncServerSocket> serverSocket(
2290 AsyncServerSocket::newSocket(&eventBase));
2291 serverSocket->setConnectionEventCallback(&connectionEventCallback);
2292 serverSocket->bind(0);
2293 serverSocket->listen(16);
2294 folly::SocketAddress serverAddress;
2295 serverSocket->getAddress(&serverAddress);
2297 // Add a callback to accept one connection then stop the loop
2298 TestAcceptCallback acceptCallback;
2299 acceptCallback.setConnectionAcceptedFn(
2300 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2301 serverSocket->removeAcceptCallback(&acceptCallback, nullptr);
2303 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2304 serverSocket->removeAcceptCallback(&acceptCallback, nullptr);
2306 serverSocket->addAcceptCallback(&acceptCallback, &eventBase);
2307 serverSocket->startAccepting();
2309 // Connect to the server socket
2310 std::shared_ptr<AsyncSocket> socket(
2311 AsyncSocket::newSocket(&eventBase, serverAddress));
2315 // Validate the connection event counters
2316 ASSERT_EQ(connectionEventCallback.getConnectionAccepted(), 1);
2317 ASSERT_EQ(connectionEventCallback.getConnectionAcceptedError(), 0);
2318 ASSERT_EQ(connectionEventCallback.getConnectionDropped(), 0);
2320 connectionEventCallback.getConnectionEnqueuedForAcceptCallback(), 1);
2321 ASSERT_EQ(connectionEventCallback.getConnectionDequeuedByAcceptCallback(), 1);
2322 ASSERT_EQ(connectionEventCallback.getBackoffStarted(), 0);
2323 ASSERT_EQ(connectionEventCallback.getBackoffEnded(), 0);
2324 ASSERT_EQ(connectionEventCallback.getBackoffError(), 0);
2327 TEST(AsyncSocketTest, CallbackInPrimaryEventBase) {
2328 EventBase eventBase;
2329 TestConnectionEventCallback connectionEventCallback;
2331 // Create a server socket
2332 std::shared_ptr<AsyncServerSocket> serverSocket(
2333 AsyncServerSocket::newSocket(&eventBase));
2334 serverSocket->setConnectionEventCallback(&connectionEventCallback);
2335 serverSocket->bind(0);
2336 serverSocket->listen(16);
2337 folly::SocketAddress serverAddress;
2338 serverSocket->getAddress(&serverAddress);
2340 // Add a callback to accept one connection then stop the loop
2341 TestAcceptCallback acceptCallback;
2342 acceptCallback.setConnectionAcceptedFn(
2343 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2344 serverSocket->removeAcceptCallback(&acceptCallback, nullptr);
2346 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2347 serverSocket->removeAcceptCallback(&acceptCallback, nullptr);
2349 bool acceptStartedFlag{false};
2350 acceptCallback.setAcceptStartedFn([&acceptStartedFlag](){
2351 acceptStartedFlag = true;
2353 bool acceptStoppedFlag{false};
2354 acceptCallback.setAcceptStoppedFn([&acceptStoppedFlag](){
2355 acceptStoppedFlag = true;
2357 serverSocket->addAcceptCallback(&acceptCallback, nullptr);
2358 serverSocket->startAccepting();
2360 // Connect to the server socket
2361 std::shared_ptr<AsyncSocket> socket(
2362 AsyncSocket::newSocket(&eventBase, serverAddress));
2366 ASSERT_TRUE(acceptStartedFlag);
2367 ASSERT_TRUE(acceptStoppedFlag);
2368 // Validate the connection event counters
2369 ASSERT_EQ(connectionEventCallback.getConnectionAccepted(), 1);
2370 ASSERT_EQ(connectionEventCallback.getConnectionAcceptedError(), 0);
2371 ASSERT_EQ(connectionEventCallback.getConnectionDropped(), 0);
2373 connectionEventCallback.getConnectionEnqueuedForAcceptCallback(), 0);
2374 ASSERT_EQ(connectionEventCallback.getConnectionDequeuedByAcceptCallback(), 0);
2375 ASSERT_EQ(connectionEventCallback.getBackoffStarted(), 0);
2376 ASSERT_EQ(connectionEventCallback.getBackoffEnded(), 0);
2377 ASSERT_EQ(connectionEventCallback.getBackoffError(), 0);
2383 * Test AsyncServerSocket::getNumPendingMessagesInQueue()
2385 TEST(AsyncSocketTest, NumPendingMessagesInQueue) {
2386 EventBase eventBase;
2388 // Counter of how many connections have been accepted
2391 // Create a server socket
2392 auto serverSocket(AsyncServerSocket::newSocket(&eventBase));
2393 serverSocket->bind(0);
2394 serverSocket->listen(16);
2395 folly::SocketAddress serverAddress;
2396 serverSocket->getAddress(&serverAddress);
2398 // Add a callback to accept connections
2399 TestAcceptCallback acceptCallback;
2400 acceptCallback.setConnectionAcceptedFn(
2401 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2403 ASSERT_EQ(4 - count, serverSocket->getNumPendingMessagesInQueue());
2406 // all messages are processed, remove accept callback
2407 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
2410 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2411 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
2413 serverSocket->addAcceptCallback(&acceptCallback, &eventBase);
2414 serverSocket->startAccepting();
2416 // Connect to the server socket, 4 clients, there are 4 connections
2417 auto socket1(AsyncSocket::newSocket(&eventBase, serverAddress));
2418 auto socket2(AsyncSocket::newSocket(&eventBase, serverAddress));
2419 auto socket3(AsyncSocket::newSocket(&eventBase, serverAddress));
2420 auto socket4(AsyncSocket::newSocket(&eventBase, serverAddress));
2426 * Test AsyncTransport::BufferCallback
2428 TEST(AsyncSocketTest, BufferTest) {
2432 AsyncSocket::OptionMap option{{{SOL_SOCKET, SO_SNDBUF}, 128}};
2433 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2435 socket->connect(&ccb, server.getAddress(), 30, option);
2437 char buf[100 * 1024];
2438 memset(buf, 'c', sizeof(buf));
2441 socket->setBufferCallback(&bcb);
2442 socket->write(&wcb, buf, sizeof(buf), WriteFlags::NONE);
2445 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2446 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
2448 ASSERT_TRUE(bcb.hasBuffered());
2449 ASSERT_TRUE(bcb.hasBufferCleared());
2452 server.verifyConnection(buf, sizeof(buf));
2454 ASSERT_TRUE(socket->isClosedBySelf());
2455 ASSERT_FALSE(socket->isClosedByPeer());
2458 TEST(AsyncSocketTest, BufferCallbackKill) {
2461 AsyncSocket::OptionMap option{{{SOL_SOCKET, SO_SNDBUF}, 128}};
2462 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2464 socket->connect(&ccb, server.getAddress(), 30, option);
2467 char buf[100 * 1024];
2468 memset(buf, 'c', sizeof(buf));
2470 socket->setBufferCallback(&bcb);
2472 wcb.successCallback = [&] {
2473 ASSERT_TRUE(socket.unique());
2477 // This will trigger AsyncSocket::handleWrite,
2478 // which calls WriteCallback::writeSuccess,
2479 // which calls wcb.successCallback above,
2480 // which tries to delete socket
2481 // Then, the socket will also try to use this BufferCallback
2482 // And that should crash us, if there is no DestructorGuard on the stack
2483 socket->write(&wcb, buf, sizeof(buf), WriteFlags::NONE);
2486 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2490 TEST(AsyncSocketTest, ConnectTFO) {
2491 // Start listening on a local port
2492 TestServer server(true);
2494 // Connect using a AsyncSocket
2496 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2497 socket->enableTFO();
2499 socket->connect(&cb, server.getAddress(), 30);
2501 std::array<uint8_t, 128> buf;
2502 memset(buf.data(), 'a', buf.size());
2504 std::array<uint8_t, 3> readBuf;
2505 auto sendBuf = IOBuf::copyBuffer("hey");
2508 auto acceptedSocket = server.accept();
2509 acceptedSocket->write(buf.data(), buf.size());
2510 acceptedSocket->flush();
2511 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2512 acceptedSocket->close();
2517 ASSERT_EQ(cb.state, STATE_SUCCEEDED);
2518 EXPECT_LE(0, socket->getConnectTime().count());
2519 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(30));
2520 EXPECT_TRUE(socket->getTFOAttempted());
2522 // Should trigger the connect
2523 WriteCallback write;
2525 socket->writeChain(&write, sendBuf->clone());
2526 socket->setReadCB(&rcb);
2531 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2532 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2533 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2534 ASSERT_EQ(1, rcb.buffers.size());
2535 ASSERT_EQ(sizeof(buf), rcb.buffers[0].length);
2536 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2537 EXPECT_EQ(socket->getTFOFinished(), socket->getTFOSucceded());
2540 TEST(AsyncSocketTest, ConnectTFOSupplyEarlyReadCB) {
2541 // Start listening on a local port
2542 TestServer server(true);
2544 // Connect using a AsyncSocket
2546 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2547 socket->enableTFO();
2549 socket->connect(&cb, server.getAddress(), 30);
2551 socket->setReadCB(&rcb);
2553 std::array<uint8_t, 128> buf;
2554 memset(buf.data(), 'a', buf.size());
2556 std::array<uint8_t, 3> readBuf;
2557 auto sendBuf = IOBuf::copyBuffer("hey");
2560 auto acceptedSocket = server.accept();
2561 acceptedSocket->write(buf.data(), buf.size());
2562 acceptedSocket->flush();
2563 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2564 acceptedSocket->close();
2569 ASSERT_EQ(cb.state, STATE_SUCCEEDED);
2570 EXPECT_LE(0, socket->getConnectTime().count());
2571 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(30));
2572 EXPECT_TRUE(socket->getTFOAttempted());
2574 // Should trigger the connect
2575 WriteCallback write;
2576 socket->writeChain(&write, sendBuf->clone());
2581 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2582 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2583 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2584 ASSERT_EQ(1, rcb.buffers.size());
2585 ASSERT_EQ(sizeof(buf), rcb.buffers[0].length);
2586 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2587 EXPECT_EQ(socket->getTFOFinished(), socket->getTFOSucceded());
2591 * Test connecting to a server that isn't listening
2593 TEST(AsyncSocketTest, ConnectRefusedImmediatelyTFO) {
2596 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2598 socket->enableTFO();
2600 // Hopefully nothing is actually listening on this address
2601 folly::SocketAddress addr("::1", 65535);
2603 socket->connect(&cb, addr, 30);
2607 WriteCallback write1;
2608 // Trigger the connect if TFO attempt is supported.
2609 socket->writeChain(&write1, IOBuf::copyBuffer("hey"));
2610 WriteCallback write2;
2611 socket->writeChain(&write2, IOBuf::copyBuffer("hey"));
2614 if (!socket->getTFOFinished()) {
2615 EXPECT_EQ(STATE_FAILED, write1.state);
2617 EXPECT_EQ(STATE_SUCCEEDED, write1.state);
2618 EXPECT_FALSE(socket->getTFOSucceded());
2621 EXPECT_EQ(STATE_FAILED, write2.state);
2623 EXPECT_EQ(STATE_SUCCEEDED, cb.state);
2624 EXPECT_LE(0, socket->getConnectTime().count());
2625 EXPECT_EQ(std::chrono::milliseconds(30), socket->getConnectTimeout());
2626 EXPECT_TRUE(socket->getTFOAttempted());
2630 * Test calling closeNow() immediately after connecting.
2632 TEST(AsyncSocketTest, ConnectWriteAndCloseNowTFO) {
2633 TestServer server(true);
2637 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2638 socket->enableTFO();
2641 socket->connect(&ccb, server.getAddress(), 30);
2644 std::array<char, 128> buf;
2645 memset(buf.data(), 'a', buf.size());
2650 // Loop, although there shouldn't be anything to do.
2653 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2655 ASSERT_TRUE(socket->isClosedBySelf());
2656 ASSERT_FALSE(socket->isClosedByPeer());
2660 * Test calling close() immediately after connect()
2662 TEST(AsyncSocketTest, ConnectAndCloseTFO) {
2663 TestServer server(true);
2665 // Connect using a AsyncSocket
2667 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2668 socket->enableTFO();
2671 socket->connect(&ccb, server.getAddress(), 30);
2675 // Loop, although there shouldn't be anything to do.
2678 // Make sure the connection was aborted
2679 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2681 ASSERT_TRUE(socket->isClosedBySelf());
2682 ASSERT_FALSE(socket->isClosedByPeer());
2685 class MockAsyncTFOSocket : public AsyncSocket {
2687 using UniquePtr = std::unique_ptr<MockAsyncTFOSocket, Destructor>;
2689 explicit MockAsyncTFOSocket(EventBase* evb) : AsyncSocket(evb) {}
2691 MOCK_METHOD3(tfoSendMsg, ssize_t(int fd, struct msghdr* msg, int msg_flags));
2694 TEST(AsyncSocketTest, TestTFOUnsupported) {
2695 TestServer server(true);
2697 // Connect using a AsyncSocket
2699 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2700 socket->enableTFO();
2703 socket->connect(&ccb, server.getAddress(), 30);
2704 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2707 socket->setReadCB(&rcb);
2709 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2710 .WillOnce(SetErrnoAndReturn(EOPNOTSUPP, -1));
2711 WriteCallback write;
2712 auto sendBuf = IOBuf::copyBuffer("hey");
2713 socket->writeChain(&write, sendBuf->clone());
2714 EXPECT_EQ(STATE_WAITING, write.state);
2716 std::array<uint8_t, 128> buf;
2717 memset(buf.data(), 'a', buf.size());
2719 std::array<uint8_t, 3> readBuf;
2722 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
2723 acceptedSocket->write(buf.data(), buf.size());
2724 acceptedSocket->flush();
2725 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2726 acceptedSocket->close();
2732 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2733 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2735 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2736 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2737 ASSERT_EQ(1, rcb.buffers.size());
2738 ASSERT_EQ(sizeof(buf), rcb.buffers[0].length);
2739 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2740 EXPECT_EQ(socket->getTFOFinished(), socket->getTFOSucceded());
2743 TEST(AsyncSocketTest, ConnectRefusedDelayedTFO) {
2746 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2747 socket->enableTFO();
2749 // Hopefully this fails
2750 folly::SocketAddress fakeAddr("127.0.0.1", 65535);
2751 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2752 .WillOnce(Invoke([&](int fd, struct msghdr*, int) {
2753 sockaddr_storage addr;
2754 auto len = fakeAddr.getAddress(&addr);
2755 int ret = connect(fd, (const struct sockaddr*)&addr, len);
2756 LOG(INFO) << "connecting the socket " << fd << " : " << ret << " : "
2761 // Hopefully nothing is actually listening on this address
2763 socket->connect(&cb, fakeAddr, 30);
2765 WriteCallback write1;
2766 // Trigger the connect if TFO attempt is supported.
2767 socket->writeChain(&write1, IOBuf::copyBuffer("hey"));
2769 if (socket->getTFOFinished()) {
2770 // This test is useless now.
2773 WriteCallback write2;
2774 // Trigger the connect if TFO attempt is supported.
2775 socket->writeChain(&write2, IOBuf::copyBuffer("hey"));
2778 EXPECT_EQ(STATE_FAILED, write1.state);
2779 EXPECT_EQ(STATE_FAILED, write2.state);
2780 EXPECT_FALSE(socket->getTFOSucceded());
2782 EXPECT_EQ(STATE_SUCCEEDED, cb.state);
2783 EXPECT_LE(0, socket->getConnectTime().count());
2784 EXPECT_EQ(std::chrono::milliseconds(30), socket->getConnectTimeout());
2785 EXPECT_TRUE(socket->getTFOAttempted());
2788 TEST(AsyncSocketTest, TestTFOUnsupportedTimeout) {
2789 // Try connecting to server that won't respond.
2791 // This depends somewhat on the network where this test is run.
2792 // Hopefully this IP will be routable but unresponsive.
2793 // (Alternatively, we could try listening on a local raw socket, but that
2794 // normally requires root privileges.)
2795 auto host = SocketAddressTestHelper::isIPv6Enabled()
2796 ? SocketAddressTestHelper::kGooglePublicDnsAAddrIPv6
2797 : SocketAddressTestHelper::isIPv4Enabled()
2798 ? SocketAddressTestHelper::kGooglePublicDnsAAddrIPv4
2800 SocketAddress addr(host, 65535);
2802 // Connect using a AsyncSocket
2804 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2805 socket->enableTFO();
2808 // Set a very small timeout
2809 socket->connect(&ccb, addr, 1);
2810 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2813 socket->setReadCB(&rcb);
2815 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2816 .WillOnce(SetErrnoAndReturn(EOPNOTSUPP, -1));
2817 WriteCallback write;
2818 socket->writeChain(&write, IOBuf::copyBuffer("hey"));
2822 EXPECT_EQ(STATE_FAILED, write.state);
2825 TEST(AsyncSocketTest, TestTFOFallbackToConnect) {
2826 TestServer server(true);
2828 // Connect using a AsyncSocket
2830 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2831 socket->enableTFO();
2834 socket->connect(&ccb, server.getAddress(), 30);
2835 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2838 socket->setReadCB(&rcb);
2840 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2841 .WillOnce(Invoke([&](int fd, struct msghdr*, int) {
2842 sockaddr_storage addr;
2843 auto len = server.getAddress().getAddress(&addr);
2844 return connect(fd, (const struct sockaddr*)&addr, len);
2846 WriteCallback write;
2847 auto sendBuf = IOBuf::copyBuffer("hey");
2848 socket->writeChain(&write, sendBuf->clone());
2849 EXPECT_EQ(STATE_WAITING, write.state);
2851 std::array<uint8_t, 128> buf;
2852 memset(buf.data(), 'a', buf.size());
2854 std::array<uint8_t, 3> readBuf;
2857 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
2858 acceptedSocket->write(buf.data(), buf.size());
2859 acceptedSocket->flush();
2860 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2861 acceptedSocket->close();
2867 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2869 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2870 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2872 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2873 ASSERT_EQ(1, rcb.buffers.size());
2874 ASSERT_EQ(buf.size(), rcb.buffers[0].length);
2875 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2878 TEST(AsyncSocketTest, TestTFOFallbackTimeout) {
2879 // Try connecting to server that won't respond.
2881 // This depends somewhat on the network where this test is run.
2882 // Hopefully this IP will be routable but unresponsive.
2883 // (Alternatively, we could try listening on a local raw socket, but that
2884 // normally requires root privileges.)
2885 auto host = SocketAddressTestHelper::isIPv6Enabled()
2886 ? SocketAddressTestHelper::kGooglePublicDnsAAddrIPv6
2887 : SocketAddressTestHelper::isIPv4Enabled()
2888 ? SocketAddressTestHelper::kGooglePublicDnsAAddrIPv4
2890 SocketAddress addr(host, 65535);
2892 // Connect using a AsyncSocket
2894 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2895 socket->enableTFO();
2898 // Set a very small timeout
2899 socket->connect(&ccb, addr, 1);
2900 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2903 socket->setReadCB(&rcb);
2905 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2906 .WillOnce(Invoke([&](int fd, struct msghdr*, int) {
2907 sockaddr_storage addr2;
2908 auto len = addr.getAddress(&addr2);
2909 return connect(fd, (const struct sockaddr*)&addr2, len);
2911 WriteCallback write;
2912 socket->writeChain(&write, IOBuf::copyBuffer("hey"));
2916 EXPECT_EQ(STATE_FAILED, write.state);
2919 TEST(AsyncSocketTest, TestTFOEagain) {
2920 TestServer server(true);
2922 // Connect using a AsyncSocket
2924 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2925 socket->enableTFO();
2928 socket->connect(&ccb, server.getAddress(), 30);
2930 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2931 .WillOnce(SetErrnoAndReturn(EAGAIN, -1));
2932 WriteCallback write;
2933 socket->writeChain(&write, IOBuf::copyBuffer("hey"));
2937 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2938 EXPECT_EQ(STATE_FAILED, write.state);
2941 // Sending a large amount of data in the first write which will
2942 // definitely not fit into MSS.
2943 TEST(AsyncSocketTest, ConnectTFOWithBigData) {
2944 // Start listening on a local port
2945 TestServer server(true);
2947 // Connect using a AsyncSocket
2949 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2950 socket->enableTFO();
2952 socket->connect(&cb, server.getAddress(), 30);
2954 std::array<uint8_t, 128> buf;
2955 memset(buf.data(), 'a', buf.size());
2957 constexpr size_t len = 10 * 1024;
2958 auto sendBuf = IOBuf::create(len);
2959 sendBuf->append(len);
2960 std::array<uint8_t, len> readBuf;
2963 auto acceptedSocket = server.accept();
2964 acceptedSocket->write(buf.data(), buf.size());
2965 acceptedSocket->flush();
2966 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2967 acceptedSocket->close();
2972 ASSERT_EQ(cb.state, STATE_SUCCEEDED);
2973 EXPECT_LE(0, socket->getConnectTime().count());
2974 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(30));
2975 EXPECT_TRUE(socket->getTFOAttempted());
2977 // Should trigger the connect
2978 WriteCallback write;
2980 socket->writeChain(&write, sendBuf->clone());
2981 socket->setReadCB(&rcb);
2986 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2987 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2988 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2989 ASSERT_EQ(1, rcb.buffers.size());
2990 ASSERT_EQ(sizeof(buf), rcb.buffers[0].length);
2991 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2992 EXPECT_EQ(socket->getTFOFinished(), socket->getTFOSucceded());