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 = 32 * 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 // Tricky: the kernel caches the connection metrics for recently-used
1018 // routes (see tcp_no_metrics_save) so a freshly opened connection can
1019 // have a send buffer size bigger than wmem_default. This makes the test
1020 // flaky on contbuild if writeLength is < wmem_max (20M on our systems).
1021 size_t writeLength = 32 * 1024 * 1024;
1022 uint32_t timeout = 200;
1023 socket->setSendTimeout(timeout);
1024 scoped_array<char> buf(new char[writeLength]);
1025 memset(buf.get(), 'a', writeLength);
1027 socket->write(&wcb, buf.get(), writeLength);
1033 // Make sure the write attempt timed out as requested
1034 ASSERT_EQ(wcb.state, STATE_FAILED);
1035 ASSERT_EQ(wcb.exception.getType(), AsyncSocketException::TIMED_OUT);
1037 // Check that the write timed out within a reasonable period of time.
1038 // We don't check for exactly the specified timeout, since AsyncSocket only
1039 // times out when it hasn't made progress for that period of time.
1041 // On linux, the first write sends a few hundred kb of data, then blocks for
1042 // writability, and then unblocks again after 40ms and is able to write
1043 // another smaller of data before blocking permanently. Therefore it doesn't
1044 // time out until 40ms + timeout.
1046 // I haven't fully verified the cause of this, but I believe it probably
1047 // occurs because the receiving end delays sending an ack for up to 40ms.
1048 // (This is the default value for TCP_DELACK_MIN.) Once the sender receives
1049 // the ack, it can send some more data. However, after that point the
1050 // receiver's kernel buffer is full. This 40ms delay happens even with
1051 // TCP_NODELAY and TCP_QUICKACK enabled on both endpoints. However, the
1052 // kernel may be automatically disabling TCP_QUICKACK after receiving some
1055 // For now, we simply check that the timeout occurred within 160ms of
1056 // the requested value.
1057 T_CHECK_TIMEOUT(start, end, milliseconds(timeout), milliseconds(160));
1061 * Test writing to a socket that the remote endpoint has closed
1063 TEST(AsyncSocketTest, WritePipeError) {
1068 std::shared_ptr<AsyncSocket> socket =
1069 AsyncSocket::newSocket(&evb, server.getAddress(), 30);
1070 socket->setSendTimeout(1000);
1071 evb.loop(); // loop until the socket is connected
1073 // accept and immediately close the socket
1074 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
1075 acceptedSocket->close();
1077 // write() a large chunk of data
1078 size_t writeLength = 32 * 1024 * 1024;
1079 scoped_array<char> buf(new char[writeLength]);
1080 memset(buf.get(), 'a', writeLength);
1082 socket->write(&wcb, buf.get(), writeLength);
1086 // Make sure the write failed.
1087 // It would be nice if AsyncSocketException could convey the errno value,
1088 // so that we could check for EPIPE
1089 ASSERT_EQ(wcb.state, STATE_FAILED);
1090 ASSERT_EQ(wcb.exception.getType(),
1091 AsyncSocketException::INTERNAL_ERROR);
1093 ASSERT_FALSE(socket->isClosedBySelf());
1094 ASSERT_FALSE(socket->isClosedByPeer());
1098 * Test that bytes written is correctly computed in case of write failure
1100 TEST(AsyncSocketTest, WriteErrorCallbackBytesWritten) {
1101 // Send and receive buffer sizes for the sockets.
1102 const int sockBufSize = 8 * 1024;
1104 TestServer server(false, sockBufSize);
1106 AsyncSocket::OptionMap options{
1107 {{SOL_SOCKET, SO_SNDBUF}, sockBufSize},
1108 {{SOL_SOCKET, SO_RCVBUF}, sockBufSize},
1109 {{IPPROTO_TCP, TCP_NODELAY}, 1},
1112 // The current thread will be used by the receiver - use a separate thread
1114 EventBase senderEvb;
1115 std::thread senderThread([&]() { senderEvb.loopForever(); });
1118 std::shared_ptr<AsyncSocket> socket;
1120 senderEvb.runInEventBaseThreadAndWait([&]() {
1121 socket = AsyncSocket::newSocket(&senderEvb);
1122 socket->connect(&ccb, server.getAddress(), 30, options);
1125 // accept the socket on the server side
1126 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
1128 // Send a big (45KB) write so that it is partially written. The first write
1129 // is 16KB (8KB on both sides) and subsequent writes are 8KB each. Reading
1130 // just under 24KB would cause 3-4 writes for the total of 32-40KB in the
1131 // following sequence: 16KB + 8KB + 8KB (+ 8KB). This ensures that not all
1132 // bytes are written when the socket is reset. Having at least 3 writes
1133 // ensures that the total size (45KB) would be exceeed in case of overcounting
1134 // based on the initial write size of 16KB.
1135 constexpr size_t sendSize = 45 * 1024;
1136 auto const sendBuf = std::vector<char>(sendSize, 'a');
1140 senderEvb.runInEventBaseThreadAndWait(
1141 [&]() { socket->write(&wcb, sendBuf.data(), sendSize); });
1143 // Reading 20KB would cause three additional writes of 8KB, but less
1144 // than 45KB total, so the socket is reset before all bytes are written.
1145 constexpr size_t recvSize = 20 * 1024;
1146 uint8_t recvBuf[recvSize];
1147 int bytesRead = acceptedSocket->readAll(recvBuf, sizeof(recvBuf));
1149 acceptedSocket->closeWithReset();
1151 senderEvb.terminateLoopSoon();
1152 senderThread.join();
1154 LOG(INFO) << "Bytes written: " << wcb.bytesWritten;
1156 ASSERT_EQ(STATE_FAILED, wcb.state);
1157 ASSERT_GE(wcb.bytesWritten, bytesRead);
1158 ASSERT_LE(wcb.bytesWritten, sendSize);
1159 ASSERT_EQ(recvSize, bytesRead);
1160 ASSERT(32 * 1024 == wcb.bytesWritten || 40 * 1024 == wcb.bytesWritten);
1164 * Test writing a mix of simple buffers and IOBufs
1166 TEST(AsyncSocketTest, WriteIOBuf) {
1171 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
1173 socket->connect(&ccb, server.getAddress(), 30);
1175 // Accept the connection
1176 std::shared_ptr<AsyncSocket> acceptedSocket = server.acceptAsync(&evb);
1178 acceptedSocket->setReadCB(&rcb);
1180 // Write a simple buffer to the socket
1181 constexpr size_t simpleBufLength = 5;
1182 char simpleBuf[simpleBufLength];
1183 memset(simpleBuf, 'a', simpleBufLength);
1185 socket->write(&wcb, simpleBuf, simpleBufLength);
1187 // Write a single-element IOBuf chain
1188 size_t buf1Length = 7;
1189 unique_ptr<IOBuf> buf1(IOBuf::create(buf1Length));
1190 memset(buf1->writableData(), 'b', buf1Length);
1191 buf1->append(buf1Length);
1192 unique_ptr<IOBuf> buf1Copy(buf1->clone());
1194 socket->writeChain(&wcb2, std::move(buf1));
1196 // Write a multiple-element IOBuf chain
1197 size_t buf2Length = 11;
1198 unique_ptr<IOBuf> buf2(IOBuf::create(buf2Length));
1199 memset(buf2->writableData(), 'c', buf2Length);
1200 buf2->append(buf2Length);
1201 size_t buf3Length = 13;
1202 unique_ptr<IOBuf> buf3(IOBuf::create(buf3Length));
1203 memset(buf3->writableData(), 'd', buf3Length);
1204 buf3->append(buf3Length);
1205 buf2->appendChain(std::move(buf3));
1206 unique_ptr<IOBuf> buf2Copy(buf2->clone());
1207 buf2Copy->coalesce();
1209 socket->writeChain(&wcb3, std::move(buf2));
1210 socket->shutdownWrite();
1212 // Let the reads and writes run to completion
1215 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
1216 ASSERT_EQ(wcb2.state, STATE_SUCCEEDED);
1217 ASSERT_EQ(wcb3.state, STATE_SUCCEEDED);
1219 // Make sure the reader got the right data in the right order
1220 ASSERT_EQ(rcb.state, STATE_SUCCEEDED);
1221 ASSERT_EQ(rcb.buffers.size(), 1);
1222 ASSERT_EQ(rcb.buffers[0].length,
1223 simpleBufLength + buf1Length + buf2Length + buf3Length);
1225 memcmp(rcb.buffers[0].buffer, simpleBuf, simpleBufLength), 0);
1227 memcmp(rcb.buffers[0].buffer + simpleBufLength,
1228 buf1Copy->data(), buf1Copy->length()), 0);
1230 memcmp(rcb.buffers[0].buffer + simpleBufLength + buf1Length,
1231 buf2Copy->data(), buf2Copy->length()), 0);
1233 acceptedSocket->close();
1236 ASSERT_TRUE(socket->isClosedBySelf());
1237 ASSERT_FALSE(socket->isClosedByPeer());
1240 TEST(AsyncSocketTest, WriteIOBufCorked) {
1245 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
1247 socket->connect(&ccb, server.getAddress(), 30);
1249 // Accept the connection
1250 std::shared_ptr<AsyncSocket> acceptedSocket = server.acceptAsync(&evb);
1252 acceptedSocket->setReadCB(&rcb);
1254 // Do three writes, 100ms apart, with the "cork" flag set
1255 // on the second write. The reader should see the first write
1256 // arrive by itself, followed by the second and third writes
1257 // arriving together.
1258 size_t buf1Length = 5;
1259 unique_ptr<IOBuf> buf1(IOBuf::create(buf1Length));
1260 memset(buf1->writableData(), 'a', buf1Length);
1261 buf1->append(buf1Length);
1262 size_t buf2Length = 7;
1263 unique_ptr<IOBuf> buf2(IOBuf::create(buf2Length));
1264 memset(buf2->writableData(), 'b', buf2Length);
1265 buf2->append(buf2Length);
1266 size_t buf3Length = 11;
1267 unique_ptr<IOBuf> buf3(IOBuf::create(buf3Length));
1268 memset(buf3->writableData(), 'c', buf3Length);
1269 buf3->append(buf3Length);
1271 socket->writeChain(&wcb1, std::move(buf1));
1273 DelayedWrite write2(socket, std::move(buf2), &wcb2, true);
1274 write2.scheduleTimeout(100);
1276 DelayedWrite write3(socket, std::move(buf3), &wcb3, false, true);
1277 write3.scheduleTimeout(140);
1280 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
1281 ASSERT_EQ(wcb1.state, STATE_SUCCEEDED);
1282 ASSERT_EQ(wcb2.state, STATE_SUCCEEDED);
1283 if (wcb3.state != STATE_SUCCEEDED) {
1284 throw(wcb3.exception);
1286 ASSERT_EQ(wcb3.state, STATE_SUCCEEDED);
1288 // Make sure the reader got the data with the right grouping
1289 ASSERT_EQ(rcb.state, STATE_SUCCEEDED);
1290 ASSERT_EQ(rcb.buffers.size(), 2);
1291 ASSERT_EQ(rcb.buffers[0].length, buf1Length);
1292 ASSERT_EQ(rcb.buffers[1].length, buf2Length + buf3Length);
1294 acceptedSocket->close();
1297 ASSERT_TRUE(socket->isClosedBySelf());
1298 ASSERT_FALSE(socket->isClosedByPeer());
1302 * Test performing a zero-length write
1304 TEST(AsyncSocketTest, ZeroLengthWrite) {
1309 std::shared_ptr<AsyncSocket> socket =
1310 AsyncSocket::newSocket(&evb, server.getAddress(), 30);
1311 evb.loop(); // loop until the socket is connected
1313 auto acceptedSocket = server.acceptAsync(&evb);
1315 acceptedSocket->setReadCB(&rcb);
1317 size_t len1 = 1024*1024;
1318 size_t len2 = 1024*1024;
1319 std::unique_ptr<char[]> buf(new char[len1 + len2]);
1320 memset(buf.get(), 'a', len1);
1321 memset(buf.get(), 'b', len2);
1327 socket->write(&wcb1, buf.get(), 0);
1328 socket->write(&wcb2, buf.get(), len1);
1329 socket->write(&wcb3, buf.get() + len1, 0);
1330 socket->write(&wcb4, buf.get() + len1, len2);
1333 evb.loop(); // loop until the data is sent
1335 ASSERT_EQ(wcb1.state, STATE_SUCCEEDED);
1336 ASSERT_EQ(wcb2.state, STATE_SUCCEEDED);
1337 ASSERT_EQ(wcb3.state, STATE_SUCCEEDED);
1338 ASSERT_EQ(wcb4.state, STATE_SUCCEEDED);
1339 rcb.verifyData(buf.get(), len1 + len2);
1341 ASSERT_TRUE(socket->isClosedBySelf());
1342 ASSERT_FALSE(socket->isClosedByPeer());
1345 TEST(AsyncSocketTest, ZeroLengthWritev) {
1350 std::shared_ptr<AsyncSocket> socket =
1351 AsyncSocket::newSocket(&evb, server.getAddress(), 30);
1352 evb.loop(); // loop until the socket is connected
1354 auto acceptedSocket = server.acceptAsync(&evb);
1356 acceptedSocket->setReadCB(&rcb);
1358 size_t len1 = 1024*1024;
1359 size_t len2 = 1024*1024;
1360 std::unique_ptr<char[]> buf(new char[len1 + len2]);
1361 memset(buf.get(), 'a', len1);
1362 memset(buf.get(), 'b', len2);
1365 constexpr size_t iovCount = 4;
1366 struct iovec iov[iovCount];
1367 iov[0].iov_base = buf.get();
1368 iov[0].iov_len = len1;
1369 iov[1].iov_base = buf.get() + len1;
1371 iov[2].iov_base = buf.get() + len1;
1372 iov[2].iov_len = len2;
1373 iov[3].iov_base = buf.get() + len1 + len2;
1376 socket->writev(&wcb, iov, iovCount);
1378 evb.loop(); // loop until the data is sent
1380 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
1381 rcb.verifyData(buf.get(), len1 + len2);
1383 ASSERT_TRUE(socket->isClosedBySelf());
1384 ASSERT_FALSE(socket->isClosedByPeer());
1387 ///////////////////////////////////////////////////////////////////////////
1388 // close() related tests
1389 ///////////////////////////////////////////////////////////////////////////
1392 * Test calling close() with pending writes when the socket is already closing.
1394 TEST(AsyncSocketTest, ClosePendingWritesWhileClosing) {
1399 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
1401 socket->connect(&ccb, server.getAddress(), 30);
1403 // accept the socket on the server side
1404 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
1406 // Loop to ensure the connect has completed
1409 // Make sure we are connected
1410 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
1412 // Schedule pending writes, until several write attempts have blocked
1414 memset(buf, 'a', sizeof(buf));
1415 typedef vector< std::shared_ptr<WriteCallback> > WriteCallbackVector;
1416 WriteCallbackVector writeCallbacks;
1418 writeCallbacks.reserve(5);
1419 while (writeCallbacks.size() < 5) {
1420 std::shared_ptr<WriteCallback> wcb(new WriteCallback);
1422 socket->write(wcb.get(), buf, sizeof(buf));
1423 if (wcb->state == STATE_SUCCEEDED) {
1424 // Succeeded immediately. Keep performing more writes
1428 // This write is blocked.
1429 // Have the write callback call close() when writeError() is invoked
1430 wcb->errorCallback = std::bind(&AsyncSocket::close, socket.get());
1431 writeCallbacks.push_back(wcb);
1434 // Call closeNow() to immediately fail the pending writes
1437 // Make sure writeError() was invoked on all of the pending write callbacks
1438 for (WriteCallbackVector::const_iterator it = writeCallbacks.begin();
1439 it != writeCallbacks.end();
1441 ASSERT_EQ((*it)->state, STATE_FAILED);
1444 ASSERT_TRUE(socket->isClosedBySelf());
1445 ASSERT_FALSE(socket->isClosedByPeer());
1448 ///////////////////////////////////////////////////////////////////////////
1449 // ImmediateRead related tests
1450 ///////////////////////////////////////////////////////////////////////////
1452 /* AsyncSocket use to verify immediate read works */
1453 class AsyncSocketImmediateRead : public folly::AsyncSocket {
1455 bool immediateReadCalled = false;
1456 explicit AsyncSocketImmediateRead(folly::EventBase* evb) : AsyncSocket(evb) {}
1458 void checkForImmediateRead() noexcept override {
1459 immediateReadCalled = true;
1460 AsyncSocket::handleRead();
1464 TEST(AsyncSocket, ConnectReadImmediateRead) {
1467 const size_t maxBufferSz = 100;
1468 const size_t maxReadsPerEvent = 1;
1469 const size_t expectedDataSz = maxBufferSz * 3;
1470 char expectedData[expectedDataSz];
1471 memset(expectedData, 'j', expectedDataSz);
1474 ReadCallback rcb(maxBufferSz);
1475 AsyncSocketImmediateRead socket(&evb);
1476 socket.connect(nullptr, server.getAddress(), 30);
1478 evb.loop(); // loop until the socket is connected
1480 socket.setReadCB(&rcb);
1481 socket.setMaxReadsPerEvent(maxReadsPerEvent);
1482 socket.immediateReadCalled = false;
1484 auto acceptedSocket = server.acceptAsync(&evb);
1486 ReadCallback rcbServer;
1487 WriteCallback wcbServer;
1488 rcbServer.dataAvailableCallback = [&]() {
1489 if (rcbServer.dataRead() == expectedDataSz) {
1490 // write back all data read
1491 rcbServer.verifyData(expectedData, expectedDataSz);
1492 acceptedSocket->write(&wcbServer, expectedData, expectedDataSz);
1493 acceptedSocket->close();
1496 acceptedSocket->setReadCB(&rcbServer);
1500 socket.write(&wcb1, expectedData, expectedDataSz);
1502 ASSERT_EQ(wcb1.state, STATE_SUCCEEDED);
1503 rcb.verifyData(expectedData, expectedDataSz);
1504 ASSERT_EQ(socket.immediateReadCalled, true);
1506 ASSERT_FALSE(socket.isClosedBySelf());
1507 ASSERT_FALSE(socket.isClosedByPeer());
1510 TEST(AsyncSocket, ConnectReadUninstallRead) {
1513 const size_t maxBufferSz = 100;
1514 const size_t maxReadsPerEvent = 1;
1515 const size_t expectedDataSz = maxBufferSz * 3;
1516 char expectedData[expectedDataSz];
1517 memset(expectedData, 'k', expectedDataSz);
1520 ReadCallback rcb(maxBufferSz);
1521 AsyncSocketImmediateRead socket(&evb);
1522 socket.connect(nullptr, server.getAddress(), 30);
1524 evb.loop(); // loop until the socket is connected
1526 socket.setReadCB(&rcb);
1527 socket.setMaxReadsPerEvent(maxReadsPerEvent);
1528 socket.immediateReadCalled = false;
1530 auto acceptedSocket = server.acceptAsync(&evb);
1532 ReadCallback rcbServer;
1533 WriteCallback wcbServer;
1534 rcbServer.dataAvailableCallback = [&]() {
1535 if (rcbServer.dataRead() == expectedDataSz) {
1536 // write back all data read
1537 rcbServer.verifyData(expectedData, expectedDataSz);
1538 acceptedSocket->write(&wcbServer, expectedData, expectedDataSz);
1539 acceptedSocket->close();
1542 acceptedSocket->setReadCB(&rcbServer);
1544 rcb.dataAvailableCallback = [&]() {
1545 // we read data and reset readCB
1546 socket.setReadCB(nullptr);
1551 socket.write(&wcb, expectedData, expectedDataSz);
1553 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
1555 /* we shoud've only read maxBufferSz data since readCallback_
1556 * was reset in dataAvailableCallback */
1557 ASSERT_EQ(rcb.dataRead(), maxBufferSz);
1558 ASSERT_EQ(socket.immediateReadCalled, false);
1560 ASSERT_FALSE(socket.isClosedBySelf());
1561 ASSERT_FALSE(socket.isClosedByPeer());
1565 // - Test connect() and have the connect callback set the read callback
1566 // - Test connect() and have the connect callback unset the read callback
1567 // - Test reading/writing/closing/destroying the socket in the connect callback
1568 // - Test reading/writing/closing/destroying the socket in the read callback
1569 // - Test reading/writing/closing/destroying the socket in the write callback
1570 // - Test one-way shutdown behavior
1571 // - Test changing the EventBase
1573 // - TODO: test multiple threads sharing a AsyncSocket, and detaching from it
1574 // in connectSuccess(), readDataAvailable(), writeSuccess()
1577 ///////////////////////////////////////////////////////////////////////////
1578 // AsyncServerSocket tests
1579 ///////////////////////////////////////////////////////////////////////////
1582 * Helper ConnectionEventCallback class for the test code.
1583 * It maintains counters protected by a spin lock.
1585 class TestConnectionEventCallback :
1586 public AsyncServerSocket::ConnectionEventCallback {
1588 virtual void onConnectionAccepted(
1589 const int /* socket */,
1590 const SocketAddress& /* addr */) noexcept override {
1591 folly::RWSpinLock::WriteHolder holder(spinLock_);
1592 connectionAccepted_++;
1595 virtual void onConnectionAcceptError(const int /* err */) noexcept override {
1596 folly::RWSpinLock::WriteHolder holder(spinLock_);
1597 connectionAcceptedError_++;
1600 virtual void onConnectionDropped(
1601 const int /* socket */,
1602 const SocketAddress& /* addr */) noexcept override {
1603 folly::RWSpinLock::WriteHolder holder(spinLock_);
1604 connectionDropped_++;
1607 virtual void onConnectionEnqueuedForAcceptorCallback(
1608 const int /* socket */,
1609 const SocketAddress& /* addr */) noexcept override {
1610 folly::RWSpinLock::WriteHolder holder(spinLock_);
1611 connectionEnqueuedForAcceptCallback_++;
1614 virtual void onConnectionDequeuedByAcceptorCallback(
1615 const int /* socket */,
1616 const SocketAddress& /* addr */) noexcept override {
1617 folly::RWSpinLock::WriteHolder holder(spinLock_);
1618 connectionDequeuedByAcceptCallback_++;
1621 virtual void onBackoffStarted() noexcept override {
1622 folly::RWSpinLock::WriteHolder holder(spinLock_);
1626 virtual void onBackoffEnded() noexcept override {
1627 folly::RWSpinLock::WriteHolder holder(spinLock_);
1631 virtual void onBackoffError() noexcept override {
1632 folly::RWSpinLock::WriteHolder holder(spinLock_);
1636 unsigned int getConnectionAccepted() const {
1637 folly::RWSpinLock::ReadHolder holder(spinLock_);
1638 return connectionAccepted_;
1641 unsigned int getConnectionAcceptedError() const {
1642 folly::RWSpinLock::ReadHolder holder(spinLock_);
1643 return connectionAcceptedError_;
1646 unsigned int getConnectionDropped() const {
1647 folly::RWSpinLock::ReadHolder holder(spinLock_);
1648 return connectionDropped_;
1651 unsigned int getConnectionEnqueuedForAcceptCallback() const {
1652 folly::RWSpinLock::ReadHolder holder(spinLock_);
1653 return connectionEnqueuedForAcceptCallback_;
1656 unsigned int getConnectionDequeuedByAcceptCallback() const {
1657 folly::RWSpinLock::ReadHolder holder(spinLock_);
1658 return connectionDequeuedByAcceptCallback_;
1661 unsigned int getBackoffStarted() const {
1662 folly::RWSpinLock::ReadHolder holder(spinLock_);
1663 return backoffStarted_;
1666 unsigned int getBackoffEnded() const {
1667 folly::RWSpinLock::ReadHolder holder(spinLock_);
1668 return backoffEnded_;
1671 unsigned int getBackoffError() const {
1672 folly::RWSpinLock::ReadHolder holder(spinLock_);
1673 return backoffError_;
1677 mutable folly::RWSpinLock spinLock_;
1678 unsigned int connectionAccepted_{0};
1679 unsigned int connectionAcceptedError_{0};
1680 unsigned int connectionDropped_{0};
1681 unsigned int connectionEnqueuedForAcceptCallback_{0};
1682 unsigned int connectionDequeuedByAcceptCallback_{0};
1683 unsigned int backoffStarted_{0};
1684 unsigned int backoffEnded_{0};
1685 unsigned int backoffError_{0};
1689 * Helper AcceptCallback class for the test code
1690 * It records the callbacks that were invoked, and also supports calling
1691 * generic std::function objects in each callback.
1693 class TestAcceptCallback : public AsyncServerSocket::AcceptCallback {
1702 EventInfo(int fd, const folly::SocketAddress& addr)
1703 : type(TYPE_ACCEPT),
1707 explicit EventInfo(const std::string& msg)
1712 explicit EventInfo(EventType et)
1719 int fd; // valid for TYPE_ACCEPT
1720 folly::SocketAddress address; // valid for TYPE_ACCEPT
1721 string errorMsg; // valid for TYPE_ERROR
1723 typedef std::deque<EventInfo> EventList;
1725 TestAcceptCallback()
1726 : connectionAcceptedFn_(),
1731 std::deque<EventInfo>* getEvents() {
1735 void setConnectionAcceptedFn(
1736 const std::function<void(int, const folly::SocketAddress&)>& fn) {
1737 connectionAcceptedFn_ = fn;
1739 void setAcceptErrorFn(const std::function<void(const std::exception&)>& fn) {
1740 acceptErrorFn_ = fn;
1742 void setAcceptStartedFn(const std::function<void()>& fn) {
1743 acceptStartedFn_ = fn;
1745 void setAcceptStoppedFn(const std::function<void()>& fn) {
1746 acceptStoppedFn_ = fn;
1749 void connectionAccepted(
1750 int fd, const folly::SocketAddress& clientAddr) noexcept override {
1751 events_.emplace_back(fd, clientAddr);
1753 if (connectionAcceptedFn_) {
1754 connectionAcceptedFn_(fd, clientAddr);
1757 void acceptError(const std::exception& ex) noexcept override {
1758 events_.emplace_back(ex.what());
1760 if (acceptErrorFn_) {
1764 void acceptStarted() noexcept override {
1765 events_.emplace_back(TYPE_START);
1767 if (acceptStartedFn_) {
1771 void acceptStopped() noexcept override {
1772 events_.emplace_back(TYPE_STOP);
1774 if (acceptStoppedFn_) {
1780 std::function<void(int, const folly::SocketAddress&)> connectionAcceptedFn_;
1781 std::function<void(const std::exception&)> acceptErrorFn_;
1782 std::function<void()> acceptStartedFn_;
1783 std::function<void()> acceptStoppedFn_;
1785 std::deque<EventInfo> events_;
1790 * Make sure accepted sockets have O_NONBLOCK and TCP_NODELAY set
1792 TEST(AsyncSocketTest, ServerAcceptOptions) {
1793 EventBase eventBase;
1795 // Create a server socket
1796 std::shared_ptr<AsyncServerSocket> serverSocket(
1797 AsyncServerSocket::newSocket(&eventBase));
1798 serverSocket->bind(0);
1799 serverSocket->listen(16);
1800 folly::SocketAddress serverAddress;
1801 serverSocket->getAddress(&serverAddress);
1803 // Add a callback to accept one connection then stop the loop
1804 TestAcceptCallback acceptCallback;
1805 acceptCallback.setConnectionAcceptedFn(
1806 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1807 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
1809 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
1810 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
1812 serverSocket->addAcceptCallback(&acceptCallback, &eventBase);
1813 serverSocket->startAccepting();
1815 // Connect to the server socket
1816 std::shared_ptr<AsyncSocket> socket(
1817 AsyncSocket::newSocket(&eventBase, serverAddress));
1821 // Verify that the server accepted a connection
1822 ASSERT_EQ(acceptCallback.getEvents()->size(), 3);
1823 ASSERT_EQ(acceptCallback.getEvents()->at(0).type,
1824 TestAcceptCallback::TYPE_START);
1825 ASSERT_EQ(acceptCallback.getEvents()->at(1).type,
1826 TestAcceptCallback::TYPE_ACCEPT);
1827 ASSERT_EQ(acceptCallback.getEvents()->at(2).type,
1828 TestAcceptCallback::TYPE_STOP);
1829 int fd = acceptCallback.getEvents()->at(1).fd;
1831 // The accepted connection should already be in non-blocking mode
1832 int flags = fcntl(fd, F_GETFL, 0);
1833 ASSERT_EQ(flags & O_NONBLOCK, O_NONBLOCK);
1836 // The accepted connection should already have TCP_NODELAY set
1838 socklen_t valueLength = sizeof(value);
1839 int rc = getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &value, &valueLength);
1841 ASSERT_EQ(value, 1);
1846 * Test AsyncServerSocket::removeAcceptCallback()
1848 TEST(AsyncSocketTest, RemoveAcceptCallback) {
1849 // Create a new AsyncServerSocket
1850 EventBase eventBase;
1851 std::shared_ptr<AsyncServerSocket> serverSocket(
1852 AsyncServerSocket::newSocket(&eventBase));
1853 serverSocket->bind(0);
1854 serverSocket->listen(16);
1855 folly::SocketAddress serverAddress;
1856 serverSocket->getAddress(&serverAddress);
1858 // Add several accept callbacks
1859 TestAcceptCallback cb1;
1860 TestAcceptCallback cb2;
1861 TestAcceptCallback cb3;
1862 TestAcceptCallback cb4;
1863 TestAcceptCallback cb5;
1864 TestAcceptCallback cb6;
1865 TestAcceptCallback cb7;
1867 // Test having callbacks remove other callbacks before them on the list,
1868 // after them on the list, or removing themselves.
1870 // Have callback 2 remove callback 3 and callback 5 the first time it is
1873 cb1.setConnectionAcceptedFn([&](int /* fd */,
1874 const folly::SocketAddress& /* addr */) {
1875 std::shared_ptr<AsyncSocket> sock2(
1876 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb2: -cb3 -cb5
1878 cb3.setConnectionAcceptedFn(
1879 [&](int /* fd */, const folly::SocketAddress& /* addr */) {});
1880 cb4.setConnectionAcceptedFn(
1881 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1882 std::shared_ptr<AsyncSocket> sock3(
1883 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb4
1885 cb5.setConnectionAcceptedFn(
1886 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1887 std::shared_ptr<AsyncSocket> sock5(
1888 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb7: -cb7
1891 cb2.setConnectionAcceptedFn(
1892 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1893 if (cb2Count == 0) {
1894 serverSocket->removeAcceptCallback(&cb3, nullptr);
1895 serverSocket->removeAcceptCallback(&cb5, nullptr);
1899 // Have callback 6 remove callback 4 the first time it is called,
1900 // and destroy the server socket the second time it is called
1902 cb6.setConnectionAcceptedFn(
1903 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1904 if (cb6Count == 0) {
1905 serverSocket->removeAcceptCallback(&cb4, nullptr);
1906 std::shared_ptr<AsyncSocket> sock6(
1907 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb1
1908 std::shared_ptr<AsyncSocket> sock7(
1909 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb2
1910 std::shared_ptr<AsyncSocket> sock8(
1911 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb6: stop
1914 serverSocket.reset();
1918 // Have callback 7 remove itself
1919 cb7.setConnectionAcceptedFn(
1920 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
1921 serverSocket->removeAcceptCallback(&cb7, nullptr);
1924 serverSocket->addAcceptCallback(&cb1, &eventBase);
1925 serverSocket->addAcceptCallback(&cb2, &eventBase);
1926 serverSocket->addAcceptCallback(&cb3, &eventBase);
1927 serverSocket->addAcceptCallback(&cb4, &eventBase);
1928 serverSocket->addAcceptCallback(&cb5, &eventBase);
1929 serverSocket->addAcceptCallback(&cb6, &eventBase);
1930 serverSocket->addAcceptCallback(&cb7, &eventBase);
1931 serverSocket->startAccepting();
1933 // Make several connections to the socket
1934 std::shared_ptr<AsyncSocket> sock1(
1935 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb1
1936 std::shared_ptr<AsyncSocket> sock4(
1937 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb6: -cb4
1939 // Loop until we are stopped
1942 // Check to make sure that the expected callbacks were invoked.
1944 // NOTE: This code depends on the AsyncServerSocket operating calling all of
1945 // the AcceptCallbacks in round-robin fashion, in the order that they were
1946 // added. The code is implemented this way right now, but the API doesn't
1947 // explicitly require it be done this way. If we change the code not to be
1948 // exactly round robin in the future, we can simplify the test checks here.
1949 // (We'll also need to update the termination code, since we expect cb6 to
1950 // get called twice to terminate the loop.)
1951 ASSERT_EQ(cb1.getEvents()->size(), 4);
1952 ASSERT_EQ(cb1.getEvents()->at(0).type,
1953 TestAcceptCallback::TYPE_START);
1954 ASSERT_EQ(cb1.getEvents()->at(1).type,
1955 TestAcceptCallback::TYPE_ACCEPT);
1956 ASSERT_EQ(cb1.getEvents()->at(2).type,
1957 TestAcceptCallback::TYPE_ACCEPT);
1958 ASSERT_EQ(cb1.getEvents()->at(3).type,
1959 TestAcceptCallback::TYPE_STOP);
1961 ASSERT_EQ(cb2.getEvents()->size(), 4);
1962 ASSERT_EQ(cb2.getEvents()->at(0).type,
1963 TestAcceptCallback::TYPE_START);
1964 ASSERT_EQ(cb2.getEvents()->at(1).type,
1965 TestAcceptCallback::TYPE_ACCEPT);
1966 ASSERT_EQ(cb2.getEvents()->at(2).type,
1967 TestAcceptCallback::TYPE_ACCEPT);
1968 ASSERT_EQ(cb2.getEvents()->at(3).type,
1969 TestAcceptCallback::TYPE_STOP);
1971 ASSERT_EQ(cb3.getEvents()->size(), 2);
1972 ASSERT_EQ(cb3.getEvents()->at(0).type,
1973 TestAcceptCallback::TYPE_START);
1974 ASSERT_EQ(cb3.getEvents()->at(1).type,
1975 TestAcceptCallback::TYPE_STOP);
1977 ASSERT_EQ(cb4.getEvents()->size(), 3);
1978 ASSERT_EQ(cb4.getEvents()->at(0).type,
1979 TestAcceptCallback::TYPE_START);
1980 ASSERT_EQ(cb4.getEvents()->at(1).type,
1981 TestAcceptCallback::TYPE_ACCEPT);
1982 ASSERT_EQ(cb4.getEvents()->at(2).type,
1983 TestAcceptCallback::TYPE_STOP);
1985 ASSERT_EQ(cb5.getEvents()->size(), 2);
1986 ASSERT_EQ(cb5.getEvents()->at(0).type,
1987 TestAcceptCallback::TYPE_START);
1988 ASSERT_EQ(cb5.getEvents()->at(1).type,
1989 TestAcceptCallback::TYPE_STOP);
1991 ASSERT_EQ(cb6.getEvents()->size(), 4);
1992 ASSERT_EQ(cb6.getEvents()->at(0).type,
1993 TestAcceptCallback::TYPE_START);
1994 ASSERT_EQ(cb6.getEvents()->at(1).type,
1995 TestAcceptCallback::TYPE_ACCEPT);
1996 ASSERT_EQ(cb6.getEvents()->at(2).type,
1997 TestAcceptCallback::TYPE_ACCEPT);
1998 ASSERT_EQ(cb6.getEvents()->at(3).type,
1999 TestAcceptCallback::TYPE_STOP);
2001 ASSERT_EQ(cb7.getEvents()->size(), 3);
2002 ASSERT_EQ(cb7.getEvents()->at(0).type,
2003 TestAcceptCallback::TYPE_START);
2004 ASSERT_EQ(cb7.getEvents()->at(1).type,
2005 TestAcceptCallback::TYPE_ACCEPT);
2006 ASSERT_EQ(cb7.getEvents()->at(2).type,
2007 TestAcceptCallback::TYPE_STOP);
2011 * Test AsyncServerSocket::removeAcceptCallback()
2013 TEST(AsyncSocketTest, OtherThreadAcceptCallback) {
2014 // Create a new AsyncServerSocket
2015 EventBase eventBase;
2016 std::shared_ptr<AsyncServerSocket> serverSocket(
2017 AsyncServerSocket::newSocket(&eventBase));
2018 serverSocket->bind(0);
2019 serverSocket->listen(16);
2020 folly::SocketAddress serverAddress;
2021 serverSocket->getAddress(&serverAddress);
2023 // Add several accept callbacks
2024 TestAcceptCallback cb1;
2025 auto thread_id = std::this_thread::get_id();
2026 cb1.setAcceptStartedFn([&](){
2027 CHECK_NE(thread_id, std::this_thread::get_id());
2028 thread_id = std::this_thread::get_id();
2030 cb1.setConnectionAcceptedFn(
2031 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2032 ASSERT_EQ(thread_id, std::this_thread::get_id());
2033 serverSocket->removeAcceptCallback(&cb1, &eventBase);
2035 cb1.setAcceptStoppedFn([&](){
2036 ASSERT_EQ(thread_id, std::this_thread::get_id());
2039 // Test having callbacks remove other callbacks before them on the list,
2040 serverSocket->addAcceptCallback(&cb1, &eventBase);
2041 serverSocket->startAccepting();
2043 // Make several connections to the socket
2044 std::shared_ptr<AsyncSocket> sock1(
2045 AsyncSocket::newSocket(&eventBase, serverAddress)); // cb1
2047 // Loop in another thread
2048 auto other = std::thread([&](){
2053 // Check to make sure that the expected callbacks were invoked.
2055 // NOTE: This code depends on the AsyncServerSocket operating calling all of
2056 // the AcceptCallbacks in round-robin fashion, in the order that they were
2057 // added. The code is implemented this way right now, but the API doesn't
2058 // explicitly require it be done this way. If we change the code not to be
2059 // exactly round robin in the future, we can simplify the test checks here.
2060 // (We'll also need to update the termination code, since we expect cb6 to
2061 // get called twice to terminate the loop.)
2062 ASSERT_EQ(cb1.getEvents()->size(), 3);
2063 ASSERT_EQ(cb1.getEvents()->at(0).type,
2064 TestAcceptCallback::TYPE_START);
2065 ASSERT_EQ(cb1.getEvents()->at(1).type,
2066 TestAcceptCallback::TYPE_ACCEPT);
2067 ASSERT_EQ(cb1.getEvents()->at(2).type,
2068 TestAcceptCallback::TYPE_STOP);
2072 void serverSocketSanityTest(AsyncServerSocket* serverSocket) {
2073 EventBase* eventBase = serverSocket->getEventBase();
2076 // Add a callback to accept one connection then stop accepting
2077 TestAcceptCallback acceptCallback;
2078 acceptCallback.setConnectionAcceptedFn(
2079 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2080 serverSocket->removeAcceptCallback(&acceptCallback, eventBase);
2082 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2083 serverSocket->removeAcceptCallback(&acceptCallback, eventBase);
2085 serverSocket->addAcceptCallback(&acceptCallback, eventBase);
2086 serverSocket->startAccepting();
2088 // Connect to the server socket
2089 folly::SocketAddress serverAddress;
2090 serverSocket->getAddress(&serverAddress);
2091 AsyncSocket::UniquePtr socket(new AsyncSocket(eventBase, serverAddress));
2093 // Loop to process all events
2096 // Verify that the server accepted a connection
2097 ASSERT_EQ(acceptCallback.getEvents()->size(), 3);
2098 ASSERT_EQ(acceptCallback.getEvents()->at(0).type,
2099 TestAcceptCallback::TYPE_START);
2100 ASSERT_EQ(acceptCallback.getEvents()->at(1).type,
2101 TestAcceptCallback::TYPE_ACCEPT);
2102 ASSERT_EQ(acceptCallback.getEvents()->at(2).type,
2103 TestAcceptCallback::TYPE_STOP);
2106 /* Verify that we don't leak sockets if we are destroyed()
2107 * and there are still writes pending
2109 * If destroy() only calls close() instead of closeNow(),
2110 * it would shutdown(writes) on the socket, but it would
2111 * never be close()'d, and the socket would leak
2113 TEST(AsyncSocketTest, DestroyCloseTest) {
2119 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&clientEB);
2121 socket->connect(&ccb, server.getAddress(), 30);
2123 // Accept the connection
2124 std::shared_ptr<AsyncSocket> acceptedSocket = server.acceptAsync(&serverEB);
2126 acceptedSocket->setReadCB(&rcb);
2128 // Write a large buffer to the socket that is larger than kernel buffer
2129 size_t simpleBufLength = 5000000;
2130 char* simpleBuf = new char[simpleBufLength];
2131 memset(simpleBuf, 'a', simpleBufLength);
2134 // Let the reads and writes run to completion
2135 int fd = acceptedSocket->getFd();
2137 acceptedSocket->write(&wcb, simpleBuf, simpleBufLength);
2139 acceptedSocket.reset();
2141 // Test that server socket was closed
2142 folly::test::msvcSuppressAbortOnInvalidParams([&] {
2143 ssize_t sz = read(fd, simpleBuf, simpleBufLength);
2145 ASSERT_EQ(errno, EBADF);
2151 * Test AsyncServerSocket::useExistingSocket()
2153 TEST(AsyncSocketTest, ServerExistingSocket) {
2154 EventBase eventBase;
2156 // Test creating a socket, and letting AsyncServerSocket bind and listen
2158 // Manually create a socket
2159 int fd = fsp::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
2162 // Create a server socket
2163 AsyncServerSocket::UniquePtr serverSocket(
2164 new AsyncServerSocket(&eventBase));
2165 serverSocket->useExistingSocket(fd);
2166 folly::SocketAddress address;
2167 serverSocket->getAddress(&address);
2169 serverSocket->bind(address);
2170 serverSocket->listen(16);
2172 // Make sure the socket works
2173 serverSocketSanityTest(serverSocket.get());
2176 // Test creating a socket and binding manually,
2177 // then letting AsyncServerSocket listen
2179 // Manually create a socket
2180 int fd = fsp::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
2183 struct sockaddr_in addr;
2184 addr.sin_family = AF_INET;
2186 addr.sin_addr.s_addr = INADDR_ANY;
2187 ASSERT_EQ(bind(fd, reinterpret_cast<struct sockaddr*>(&addr),
2189 // Look up the address that we bound to
2190 folly::SocketAddress boundAddress;
2191 boundAddress.setFromLocalAddress(fd);
2193 // Create a server socket
2194 AsyncServerSocket::UniquePtr serverSocket(
2195 new AsyncServerSocket(&eventBase));
2196 serverSocket->useExistingSocket(fd);
2197 serverSocket->listen(16);
2199 // Make sure AsyncServerSocket reports the same address that we bound to
2200 folly::SocketAddress serverSocketAddress;
2201 serverSocket->getAddress(&serverSocketAddress);
2202 ASSERT_EQ(boundAddress, serverSocketAddress);
2204 // Make sure the socket works
2205 serverSocketSanityTest(serverSocket.get());
2208 // Test creating a socket, binding and listening manually,
2209 // then giving it to AsyncServerSocket
2211 // Manually create a socket
2212 int fd = fsp::socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
2215 struct sockaddr_in addr;
2216 addr.sin_family = AF_INET;
2218 addr.sin_addr.s_addr = INADDR_ANY;
2219 ASSERT_EQ(bind(fd, reinterpret_cast<struct sockaddr*>(&addr),
2221 // Look up the address that we bound to
2222 folly::SocketAddress boundAddress;
2223 boundAddress.setFromLocalAddress(fd);
2225 ASSERT_EQ(listen(fd, 16), 0);
2227 // Create a server socket
2228 AsyncServerSocket::UniquePtr serverSocket(
2229 new AsyncServerSocket(&eventBase));
2230 serverSocket->useExistingSocket(fd);
2232 // Make sure AsyncServerSocket reports the same address that we bound to
2233 folly::SocketAddress serverSocketAddress;
2234 serverSocket->getAddress(&serverSocketAddress);
2235 ASSERT_EQ(boundAddress, serverSocketAddress);
2237 // Make sure the socket works
2238 serverSocketSanityTest(serverSocket.get());
2242 TEST(AsyncSocketTest, UnixDomainSocketTest) {
2243 EventBase eventBase;
2245 // Create a server socket
2246 std::shared_ptr<AsyncServerSocket> serverSocket(
2247 AsyncServerSocket::newSocket(&eventBase));
2249 path.append(folly::to<string>("/anonymous", folly::Random::rand64()));
2250 folly::SocketAddress serverAddress;
2251 serverAddress.setFromPath(path);
2252 serverSocket->bind(serverAddress);
2253 serverSocket->listen(16);
2255 // Add a callback to accept one connection then stop the loop
2256 TestAcceptCallback acceptCallback;
2257 acceptCallback.setConnectionAcceptedFn(
2258 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2259 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
2261 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2262 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
2264 serverSocket->addAcceptCallback(&acceptCallback, &eventBase);
2265 serverSocket->startAccepting();
2267 // Connect to the server socket
2268 std::shared_ptr<AsyncSocket> socket(
2269 AsyncSocket::newSocket(&eventBase, serverAddress));
2273 // Verify that the server accepted a connection
2274 ASSERT_EQ(acceptCallback.getEvents()->size(), 3);
2275 ASSERT_EQ(acceptCallback.getEvents()->at(0).type,
2276 TestAcceptCallback::TYPE_START);
2277 ASSERT_EQ(acceptCallback.getEvents()->at(1).type,
2278 TestAcceptCallback::TYPE_ACCEPT);
2279 ASSERT_EQ(acceptCallback.getEvents()->at(2).type,
2280 TestAcceptCallback::TYPE_STOP);
2281 int fd = acceptCallback.getEvents()->at(1).fd;
2283 // The accepted connection should already be in non-blocking mode
2284 int flags = fcntl(fd, F_GETFL, 0);
2285 ASSERT_EQ(flags & O_NONBLOCK, O_NONBLOCK);
2288 TEST(AsyncSocketTest, ConnectionEventCallbackDefault) {
2289 EventBase eventBase;
2290 TestConnectionEventCallback connectionEventCallback;
2292 // Create a server socket
2293 std::shared_ptr<AsyncServerSocket> serverSocket(
2294 AsyncServerSocket::newSocket(&eventBase));
2295 serverSocket->setConnectionEventCallback(&connectionEventCallback);
2296 serverSocket->bind(0);
2297 serverSocket->listen(16);
2298 folly::SocketAddress serverAddress;
2299 serverSocket->getAddress(&serverAddress);
2301 // Add a callback to accept one connection then stop the loop
2302 TestAcceptCallback acceptCallback;
2303 acceptCallback.setConnectionAcceptedFn(
2304 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2305 serverSocket->removeAcceptCallback(&acceptCallback, nullptr);
2307 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2308 serverSocket->removeAcceptCallback(&acceptCallback, nullptr);
2310 serverSocket->addAcceptCallback(&acceptCallback, &eventBase);
2311 serverSocket->startAccepting();
2313 // Connect to the server socket
2314 std::shared_ptr<AsyncSocket> socket(
2315 AsyncSocket::newSocket(&eventBase, serverAddress));
2319 // Validate the connection event counters
2320 ASSERT_EQ(connectionEventCallback.getConnectionAccepted(), 1);
2321 ASSERT_EQ(connectionEventCallback.getConnectionAcceptedError(), 0);
2322 ASSERT_EQ(connectionEventCallback.getConnectionDropped(), 0);
2324 connectionEventCallback.getConnectionEnqueuedForAcceptCallback(), 1);
2325 ASSERT_EQ(connectionEventCallback.getConnectionDequeuedByAcceptCallback(), 1);
2326 ASSERT_EQ(connectionEventCallback.getBackoffStarted(), 0);
2327 ASSERT_EQ(connectionEventCallback.getBackoffEnded(), 0);
2328 ASSERT_EQ(connectionEventCallback.getBackoffError(), 0);
2331 TEST(AsyncSocketTest, CallbackInPrimaryEventBase) {
2332 EventBase eventBase;
2333 TestConnectionEventCallback connectionEventCallback;
2335 // Create a server socket
2336 std::shared_ptr<AsyncServerSocket> serverSocket(
2337 AsyncServerSocket::newSocket(&eventBase));
2338 serverSocket->setConnectionEventCallback(&connectionEventCallback);
2339 serverSocket->bind(0);
2340 serverSocket->listen(16);
2341 folly::SocketAddress serverAddress;
2342 serverSocket->getAddress(&serverAddress);
2344 // Add a callback to accept one connection then stop the loop
2345 TestAcceptCallback acceptCallback;
2346 acceptCallback.setConnectionAcceptedFn(
2347 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2348 serverSocket->removeAcceptCallback(&acceptCallback, nullptr);
2350 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2351 serverSocket->removeAcceptCallback(&acceptCallback, nullptr);
2353 bool acceptStartedFlag{false};
2354 acceptCallback.setAcceptStartedFn([&acceptStartedFlag](){
2355 acceptStartedFlag = true;
2357 bool acceptStoppedFlag{false};
2358 acceptCallback.setAcceptStoppedFn([&acceptStoppedFlag](){
2359 acceptStoppedFlag = true;
2361 serverSocket->addAcceptCallback(&acceptCallback, nullptr);
2362 serverSocket->startAccepting();
2364 // Connect to the server socket
2365 std::shared_ptr<AsyncSocket> socket(
2366 AsyncSocket::newSocket(&eventBase, serverAddress));
2370 ASSERT_TRUE(acceptStartedFlag);
2371 ASSERT_TRUE(acceptStoppedFlag);
2372 // Validate the connection event counters
2373 ASSERT_EQ(connectionEventCallback.getConnectionAccepted(), 1);
2374 ASSERT_EQ(connectionEventCallback.getConnectionAcceptedError(), 0);
2375 ASSERT_EQ(connectionEventCallback.getConnectionDropped(), 0);
2377 connectionEventCallback.getConnectionEnqueuedForAcceptCallback(), 0);
2378 ASSERT_EQ(connectionEventCallback.getConnectionDequeuedByAcceptCallback(), 0);
2379 ASSERT_EQ(connectionEventCallback.getBackoffStarted(), 0);
2380 ASSERT_EQ(connectionEventCallback.getBackoffEnded(), 0);
2381 ASSERT_EQ(connectionEventCallback.getBackoffError(), 0);
2387 * Test AsyncServerSocket::getNumPendingMessagesInQueue()
2389 TEST(AsyncSocketTest, NumPendingMessagesInQueue) {
2390 EventBase eventBase;
2392 // Counter of how many connections have been accepted
2395 // Create a server socket
2396 auto serverSocket(AsyncServerSocket::newSocket(&eventBase));
2397 serverSocket->bind(0);
2398 serverSocket->listen(16);
2399 folly::SocketAddress serverAddress;
2400 serverSocket->getAddress(&serverAddress);
2402 // Add a callback to accept connections
2403 TestAcceptCallback acceptCallback;
2404 acceptCallback.setConnectionAcceptedFn(
2405 [&](int /* fd */, const folly::SocketAddress& /* addr */) {
2407 ASSERT_EQ(4 - count, serverSocket->getNumPendingMessagesInQueue());
2410 // all messages are processed, remove accept callback
2411 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
2414 acceptCallback.setAcceptErrorFn([&](const std::exception& /* ex */) {
2415 serverSocket->removeAcceptCallback(&acceptCallback, &eventBase);
2417 serverSocket->addAcceptCallback(&acceptCallback, &eventBase);
2418 serverSocket->startAccepting();
2420 // Connect to the server socket, 4 clients, there are 4 connections
2421 auto socket1(AsyncSocket::newSocket(&eventBase, serverAddress));
2422 auto socket2(AsyncSocket::newSocket(&eventBase, serverAddress));
2423 auto socket3(AsyncSocket::newSocket(&eventBase, serverAddress));
2424 auto socket4(AsyncSocket::newSocket(&eventBase, serverAddress));
2430 * Test AsyncTransport::BufferCallback
2432 TEST(AsyncSocketTest, BufferTest) {
2436 AsyncSocket::OptionMap option{{{SOL_SOCKET, SO_SNDBUF}, 128}};
2437 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2439 socket->connect(&ccb, server.getAddress(), 30, option);
2441 char buf[100 * 1024];
2442 memset(buf, 'c', sizeof(buf));
2445 socket->setBufferCallback(&bcb);
2446 socket->write(&wcb, buf, sizeof(buf), WriteFlags::NONE);
2449 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2450 ASSERT_EQ(wcb.state, STATE_SUCCEEDED);
2452 ASSERT_TRUE(bcb.hasBuffered());
2453 ASSERT_TRUE(bcb.hasBufferCleared());
2456 server.verifyConnection(buf, sizeof(buf));
2458 ASSERT_TRUE(socket->isClosedBySelf());
2459 ASSERT_FALSE(socket->isClosedByPeer());
2462 TEST(AsyncSocketTest, BufferCallbackKill) {
2465 AsyncSocket::OptionMap option{{{SOL_SOCKET, SO_SNDBUF}, 128}};
2466 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2468 socket->connect(&ccb, server.getAddress(), 30, option);
2471 char buf[100 * 1024];
2472 memset(buf, 'c', sizeof(buf));
2474 socket->setBufferCallback(&bcb);
2476 wcb.successCallback = [&] {
2477 ASSERT_TRUE(socket.unique());
2481 // This will trigger AsyncSocket::handleWrite,
2482 // which calls WriteCallback::writeSuccess,
2483 // which calls wcb.successCallback above,
2484 // which tries to delete socket
2485 // Then, the socket will also try to use this BufferCallback
2486 // And that should crash us, if there is no DestructorGuard on the stack
2487 socket->write(&wcb, buf, sizeof(buf), WriteFlags::NONE);
2490 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2494 TEST(AsyncSocketTest, ConnectTFO) {
2495 // Start listening on a local port
2496 TestServer server(true);
2498 // Connect using a AsyncSocket
2500 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2501 socket->enableTFO();
2503 socket->connect(&cb, server.getAddress(), 30);
2505 std::array<uint8_t, 128> buf;
2506 memset(buf.data(), 'a', buf.size());
2508 std::array<uint8_t, 3> readBuf;
2509 auto sendBuf = IOBuf::copyBuffer("hey");
2512 auto acceptedSocket = server.accept();
2513 acceptedSocket->write(buf.data(), buf.size());
2514 acceptedSocket->flush();
2515 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2516 acceptedSocket->close();
2521 ASSERT_EQ(cb.state, STATE_SUCCEEDED);
2522 EXPECT_LE(0, socket->getConnectTime().count());
2523 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(30));
2524 EXPECT_TRUE(socket->getTFOAttempted());
2526 // Should trigger the connect
2527 WriteCallback write;
2529 socket->writeChain(&write, sendBuf->clone());
2530 socket->setReadCB(&rcb);
2535 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2536 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2537 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2538 ASSERT_EQ(1, rcb.buffers.size());
2539 ASSERT_EQ(sizeof(buf), rcb.buffers[0].length);
2540 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2541 EXPECT_EQ(socket->getTFOFinished(), socket->getTFOSucceded());
2544 TEST(AsyncSocketTest, ConnectTFOSupplyEarlyReadCB) {
2545 // Start listening on a local port
2546 TestServer server(true);
2548 // Connect using a AsyncSocket
2550 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2551 socket->enableTFO();
2553 socket->connect(&cb, server.getAddress(), 30);
2555 socket->setReadCB(&rcb);
2557 std::array<uint8_t, 128> buf;
2558 memset(buf.data(), 'a', buf.size());
2560 std::array<uint8_t, 3> readBuf;
2561 auto sendBuf = IOBuf::copyBuffer("hey");
2564 auto acceptedSocket = server.accept();
2565 acceptedSocket->write(buf.data(), buf.size());
2566 acceptedSocket->flush();
2567 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2568 acceptedSocket->close();
2573 ASSERT_EQ(cb.state, STATE_SUCCEEDED);
2574 EXPECT_LE(0, socket->getConnectTime().count());
2575 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(30));
2576 EXPECT_TRUE(socket->getTFOAttempted());
2578 // Should trigger the connect
2579 WriteCallback write;
2580 socket->writeChain(&write, sendBuf->clone());
2585 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2586 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2587 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2588 ASSERT_EQ(1, rcb.buffers.size());
2589 ASSERT_EQ(sizeof(buf), rcb.buffers[0].length);
2590 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2591 EXPECT_EQ(socket->getTFOFinished(), socket->getTFOSucceded());
2595 * Test connecting to a server that isn't listening
2597 TEST(AsyncSocketTest, ConnectRefusedImmediatelyTFO) {
2600 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2602 socket->enableTFO();
2604 // Hopefully nothing is actually listening on this address
2605 folly::SocketAddress addr("::1", 65535);
2607 socket->connect(&cb, addr, 30);
2611 WriteCallback write1;
2612 // Trigger the connect if TFO attempt is supported.
2613 socket->writeChain(&write1, IOBuf::copyBuffer("hey"));
2614 WriteCallback write2;
2615 socket->writeChain(&write2, IOBuf::copyBuffer("hey"));
2618 if (!socket->getTFOFinished()) {
2619 EXPECT_EQ(STATE_FAILED, write1.state);
2621 EXPECT_EQ(STATE_SUCCEEDED, write1.state);
2622 EXPECT_FALSE(socket->getTFOSucceded());
2625 EXPECT_EQ(STATE_FAILED, write2.state);
2627 EXPECT_EQ(STATE_SUCCEEDED, cb.state);
2628 EXPECT_LE(0, socket->getConnectTime().count());
2629 EXPECT_EQ(std::chrono::milliseconds(30), socket->getConnectTimeout());
2630 EXPECT_TRUE(socket->getTFOAttempted());
2634 * Test calling closeNow() immediately after connecting.
2636 TEST(AsyncSocketTest, ConnectWriteAndCloseNowTFO) {
2637 TestServer server(true);
2641 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2642 socket->enableTFO();
2645 socket->connect(&ccb, server.getAddress(), 30);
2648 std::array<char, 128> buf;
2649 memset(buf.data(), 'a', buf.size());
2654 // Loop, although there shouldn't be anything to do.
2657 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2659 ASSERT_TRUE(socket->isClosedBySelf());
2660 ASSERT_FALSE(socket->isClosedByPeer());
2664 * Test calling close() immediately after connect()
2666 TEST(AsyncSocketTest, ConnectAndCloseTFO) {
2667 TestServer server(true);
2669 // Connect using a AsyncSocket
2671 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2672 socket->enableTFO();
2675 socket->connect(&ccb, server.getAddress(), 30);
2679 // Loop, although there shouldn't be anything to do.
2682 // Make sure the connection was aborted
2683 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2685 ASSERT_TRUE(socket->isClosedBySelf());
2686 ASSERT_FALSE(socket->isClosedByPeer());
2689 class MockAsyncTFOSocket : public AsyncSocket {
2691 using UniquePtr = std::unique_ptr<MockAsyncTFOSocket, Destructor>;
2693 explicit MockAsyncTFOSocket(EventBase* evb) : AsyncSocket(evb) {}
2695 MOCK_METHOD3(tfoSendMsg, ssize_t(int fd, struct msghdr* msg, int msg_flags));
2698 TEST(AsyncSocketTest, TestTFOUnsupported) {
2699 TestServer server(true);
2701 // Connect using a AsyncSocket
2703 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2704 socket->enableTFO();
2707 socket->connect(&ccb, server.getAddress(), 30);
2708 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2711 socket->setReadCB(&rcb);
2713 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2714 .WillOnce(SetErrnoAndReturn(EOPNOTSUPP, -1));
2715 WriteCallback write;
2716 auto sendBuf = IOBuf::copyBuffer("hey");
2717 socket->writeChain(&write, sendBuf->clone());
2718 EXPECT_EQ(STATE_WAITING, write.state);
2720 std::array<uint8_t, 128> buf;
2721 memset(buf.data(), 'a', buf.size());
2723 std::array<uint8_t, 3> readBuf;
2726 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
2727 acceptedSocket->write(buf.data(), buf.size());
2728 acceptedSocket->flush();
2729 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2730 acceptedSocket->close();
2736 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2737 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2739 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2740 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2741 ASSERT_EQ(1, rcb.buffers.size());
2742 ASSERT_EQ(sizeof(buf), rcb.buffers[0].length);
2743 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2744 EXPECT_EQ(socket->getTFOFinished(), socket->getTFOSucceded());
2747 TEST(AsyncSocketTest, ConnectRefusedDelayedTFO) {
2750 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2751 socket->enableTFO();
2753 // Hopefully this fails
2754 folly::SocketAddress fakeAddr("127.0.0.1", 65535);
2755 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2756 .WillOnce(Invoke([&](int fd, struct msghdr*, int) {
2757 sockaddr_storage addr;
2758 auto len = fakeAddr.getAddress(&addr);
2759 int ret = connect(fd, (const struct sockaddr*)&addr, len);
2760 LOG(INFO) << "connecting the socket " << fd << " : " << ret << " : "
2765 // Hopefully nothing is actually listening on this address
2767 socket->connect(&cb, fakeAddr, 30);
2769 WriteCallback write1;
2770 // Trigger the connect if TFO attempt is supported.
2771 socket->writeChain(&write1, IOBuf::copyBuffer("hey"));
2773 if (socket->getTFOFinished()) {
2774 // This test is useless now.
2777 WriteCallback write2;
2778 // Trigger the connect if TFO attempt is supported.
2779 socket->writeChain(&write2, IOBuf::copyBuffer("hey"));
2782 EXPECT_EQ(STATE_FAILED, write1.state);
2783 EXPECT_EQ(STATE_FAILED, write2.state);
2784 EXPECT_FALSE(socket->getTFOSucceded());
2786 EXPECT_EQ(STATE_SUCCEEDED, cb.state);
2787 EXPECT_LE(0, socket->getConnectTime().count());
2788 EXPECT_EQ(std::chrono::milliseconds(30), socket->getConnectTimeout());
2789 EXPECT_TRUE(socket->getTFOAttempted());
2792 TEST(AsyncSocketTest, TestTFOUnsupportedTimeout) {
2793 // Try connecting to server that won't respond.
2795 // This depends somewhat on the network where this test is run.
2796 // Hopefully this IP will be routable but unresponsive.
2797 // (Alternatively, we could try listening on a local raw socket, but that
2798 // normally requires root privileges.)
2799 auto host = SocketAddressTestHelper::isIPv6Enabled()
2800 ? SocketAddressTestHelper::kGooglePublicDnsAAddrIPv6
2801 : SocketAddressTestHelper::isIPv4Enabled()
2802 ? SocketAddressTestHelper::kGooglePublicDnsAAddrIPv4
2804 SocketAddress addr(host, 65535);
2806 // Connect using a AsyncSocket
2808 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2809 socket->enableTFO();
2812 // Set a very small timeout
2813 socket->connect(&ccb, addr, 1);
2814 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2817 socket->setReadCB(&rcb);
2819 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2820 .WillOnce(SetErrnoAndReturn(EOPNOTSUPP, -1));
2821 WriteCallback write;
2822 socket->writeChain(&write, IOBuf::copyBuffer("hey"));
2826 EXPECT_EQ(STATE_FAILED, write.state);
2829 TEST(AsyncSocketTest, TestTFOFallbackToConnect) {
2830 TestServer server(true);
2832 // Connect using a AsyncSocket
2834 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2835 socket->enableTFO();
2838 socket->connect(&ccb, server.getAddress(), 30);
2839 ASSERT_EQ(ccb.state, STATE_SUCCEEDED);
2842 socket->setReadCB(&rcb);
2844 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2845 .WillOnce(Invoke([&](int fd, struct msghdr*, int) {
2846 sockaddr_storage addr;
2847 auto len = server.getAddress().getAddress(&addr);
2848 return connect(fd, (const struct sockaddr*)&addr, len);
2850 WriteCallback write;
2851 auto sendBuf = IOBuf::copyBuffer("hey");
2852 socket->writeChain(&write, sendBuf->clone());
2853 EXPECT_EQ(STATE_WAITING, write.state);
2855 std::array<uint8_t, 128> buf;
2856 memset(buf.data(), 'a', buf.size());
2858 std::array<uint8_t, 3> readBuf;
2861 std::shared_ptr<BlockingSocket> acceptedSocket = server.accept();
2862 acceptedSocket->write(buf.data(), buf.size());
2863 acceptedSocket->flush();
2864 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2865 acceptedSocket->close();
2871 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2873 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2874 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2876 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2877 ASSERT_EQ(1, rcb.buffers.size());
2878 ASSERT_EQ(buf.size(), rcb.buffers[0].length);
2879 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2882 TEST(AsyncSocketTest, TestTFOFallbackTimeout) {
2883 // Try connecting to server that won't respond.
2885 // This depends somewhat on the network where this test is run.
2886 // Hopefully this IP will be routable but unresponsive.
2887 // (Alternatively, we could try listening on a local raw socket, but that
2888 // normally requires root privileges.)
2889 auto host = SocketAddressTestHelper::isIPv6Enabled()
2890 ? SocketAddressTestHelper::kGooglePublicDnsAAddrIPv6
2891 : SocketAddressTestHelper::isIPv4Enabled()
2892 ? SocketAddressTestHelper::kGooglePublicDnsAAddrIPv4
2894 SocketAddress addr(host, 65535);
2896 // Connect using a AsyncSocket
2898 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2899 socket->enableTFO();
2902 // Set a very small timeout
2903 socket->connect(&ccb, addr, 1);
2904 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2907 socket->setReadCB(&rcb);
2909 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2910 .WillOnce(Invoke([&](int fd, struct msghdr*, int) {
2911 sockaddr_storage addr2;
2912 auto len = addr.getAddress(&addr2);
2913 return connect(fd, (const struct sockaddr*)&addr2, len);
2915 WriteCallback write;
2916 socket->writeChain(&write, IOBuf::copyBuffer("hey"));
2920 EXPECT_EQ(STATE_FAILED, write.state);
2923 TEST(AsyncSocketTest, TestTFOEagain) {
2924 TestServer server(true);
2926 // Connect using a AsyncSocket
2928 auto socket = MockAsyncTFOSocket::UniquePtr(new MockAsyncTFOSocket(&evb));
2929 socket->enableTFO();
2932 socket->connect(&ccb, server.getAddress(), 30);
2934 EXPECT_CALL(*socket, tfoSendMsg(_, _, _))
2935 .WillOnce(SetErrnoAndReturn(EAGAIN, -1));
2936 WriteCallback write;
2937 socket->writeChain(&write, IOBuf::copyBuffer("hey"));
2941 EXPECT_EQ(STATE_SUCCEEDED, ccb.state);
2942 EXPECT_EQ(STATE_FAILED, write.state);
2945 // Sending a large amount of data in the first write which will
2946 // definitely not fit into MSS.
2947 TEST(AsyncSocketTest, ConnectTFOWithBigData) {
2948 // Start listening on a local port
2949 TestServer server(true);
2951 // Connect using a AsyncSocket
2953 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
2954 socket->enableTFO();
2956 socket->connect(&cb, server.getAddress(), 30);
2958 std::array<uint8_t, 128> buf;
2959 memset(buf.data(), 'a', buf.size());
2961 constexpr size_t len = 10 * 1024;
2962 auto sendBuf = IOBuf::create(len);
2963 sendBuf->append(len);
2964 std::array<uint8_t, len> readBuf;
2967 auto acceptedSocket = server.accept();
2968 acceptedSocket->write(buf.data(), buf.size());
2969 acceptedSocket->flush();
2970 acceptedSocket->readAll(readBuf.data(), readBuf.size());
2971 acceptedSocket->close();
2976 ASSERT_EQ(cb.state, STATE_SUCCEEDED);
2977 EXPECT_LE(0, socket->getConnectTime().count());
2978 EXPECT_EQ(socket->getConnectTimeout(), std::chrono::milliseconds(30));
2979 EXPECT_TRUE(socket->getTFOAttempted());
2981 // Should trigger the connect
2982 WriteCallback write;
2984 socket->writeChain(&write, sendBuf->clone());
2985 socket->setReadCB(&rcb);
2990 EXPECT_EQ(STATE_SUCCEEDED, write.state);
2991 EXPECT_EQ(0, memcmp(readBuf.data(), sendBuf->data(), readBuf.size()));
2992 EXPECT_EQ(STATE_SUCCEEDED, rcb.state);
2993 ASSERT_EQ(1, rcb.buffers.size());
2994 ASSERT_EQ(sizeof(buf), rcb.buffers[0].length);
2995 EXPECT_EQ(0, memcmp(rcb.buffers[0].buffer, buf.data(), buf.size()));
2996 EXPECT_EQ(socket->getTFOFinished(), socket->getTFOSucceded());
2999 class MockEvbChangeCallback : public AsyncSocket::EvbChangeCallback {
3001 MOCK_METHOD1(evbAttached, void(AsyncSocket*));
3002 MOCK_METHOD1(evbDetached, void(AsyncSocket*));
3005 TEST(AsyncSocketTest, EvbCallbacks) {
3006 auto cb = folly::make_unique<MockEvbChangeCallback>();
3008 std::shared_ptr<AsyncSocket> socket = AsyncSocket::newSocket(&evb);
3011 EXPECT_CALL(*cb, evbDetached(socket.get())).Times(1);
3012 EXPECT_CALL(*cb, evbAttached(socket.get())).Times(1);
3014 socket->setEvbChangedCallback(std::move(cb));
3015 socket->detachEventBase();
3016 socket->attachEventBase(&evb);