2 * Copyright 2015 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.
19 #include <sys/types.h>
20 #include <sys/socket.h>
21 #include <glog/logging.h>
22 #include <folly/SocketAddress.h>
23 #include <folly/io/ShutdownSocketSet.h>
24 #include <folly/io/IOBuf.h>
25 #include <folly/io/async/AsyncTimeout.h>
26 #include <folly/io/async/AsyncSocketException.h>
27 #include <folly/io/async/AsyncTransport.h>
28 #include <folly/io/async/EventHandler.h>
29 #include <folly/io/async/DelayedDestruction.h>
37 * A class for performing asynchronous I/O on a socket.
39 * AsyncSocket allows users to asynchronously wait for data on a socket, and
40 * to asynchronously send data.
42 * The APIs for reading and writing are intentionally asymmetric. Waiting for
43 * data to read is a persistent API: a callback is installed, and is notified
44 * whenever new data is available. It continues to be notified of new events
45 * until it is uninstalled.
47 * AsyncSocket does not provide read timeout functionality, because it
48 * typically cannot determine when the timeout should be active. Generally, a
49 * timeout should only be enabled when processing is blocked waiting on data
50 * from the remote endpoint. For server sockets, the timeout should not be
51 * active if the server is currently processing one or more outstanding
52 * requests for this socket. For client sockets, the timeout should not be
53 * active if there are no requests pending on the socket. Additionally, if a
54 * client has multiple pending requests, it will ususally want a separate
55 * timeout for each request, rather than a single read timeout.
57 * The write API is fairly intuitive: a user can request to send a block of
58 * data, and a callback will be informed once the entire block has been
59 * transferred to the kernel, or on error. AsyncSocket does provide a send
60 * timeout, since most callers want to give up if the remote end stops
61 * responding and no further progress can be made sending the data.
64 class AsyncSocket : virtual public AsyncTransportWrapper {
66 typedef std::unique_ptr<AsyncSocket, Destructor> UniquePtr;
68 class ConnectCallback {
70 virtual ~ConnectCallback() = default;
73 * connectSuccess() will be invoked when the connection has been
74 * successfully established.
76 virtual void connectSuccess() noexcept = 0;
79 * connectErr() will be invoked if the connection attempt fails.
81 * @param ex An exception describing the error that occurred.
83 virtual void connectErr(const AsyncSocketException& ex)
87 explicit AsyncSocket();
89 * Create a new unconnected AsyncSocket.
91 * connect() must later be called on this socket to establish a connection.
93 explicit AsyncSocket(EventBase* evb);
95 void setShutdownSocketSet(ShutdownSocketSet* ss);
98 * Create a new AsyncSocket and begin the connection process.
100 * @param evb EventBase that will manage this socket.
101 * @param address The address to connect to.
102 * @param connectTimeout Optional timeout in milliseconds for the connection
105 AsyncSocket(EventBase* evb,
106 const folly::SocketAddress& address,
107 uint32_t connectTimeout = 0);
110 * Create a new AsyncSocket and begin the connection process.
112 * @param evb EventBase that will manage this socket.
113 * @param ip IP address to connect to (dotted-quad).
114 * @param port Destination port in host byte order.
115 * @param connectTimeout Optional timeout in milliseconds for the connection
118 AsyncSocket(EventBase* evb,
119 const std::string& ip,
121 uint32_t connectTimeout = 0);
124 * Create a AsyncSocket from an already connected socket file descriptor.
126 * Note that while AsyncSocket enables TCP_NODELAY for sockets it creates
127 * when connecting, it does not change the socket options when given an
128 * existing file descriptor. If callers want TCP_NODELAY enabled when using
129 * this version of the constructor, they need to explicitly call
130 * setNoDelay(true) after the constructor returns.
132 * @param evb EventBase that will manage this socket.
133 * @param fd File descriptor to take over (should be a connected socket).
135 AsyncSocket(EventBase* evb, int fd);
138 * Helper function to create a shared_ptr<AsyncSocket>.
140 * This passes in the correct destructor object, since AsyncSocket's
141 * destructor is protected and cannot be invoked directly.
143 static std::shared_ptr<AsyncSocket> newSocket(EventBase* evb) {
144 return std::shared_ptr<AsyncSocket>(new AsyncSocket(evb),
149 * Helper function to create a shared_ptr<AsyncSocket>.
151 static std::shared_ptr<AsyncSocket> newSocket(
153 const folly::SocketAddress& address,
154 uint32_t connectTimeout = 0) {
155 return std::shared_ptr<AsyncSocket>(
156 new AsyncSocket(evb, address, connectTimeout),
161 * Helper function to create a shared_ptr<AsyncSocket>.
163 static std::shared_ptr<AsyncSocket> newSocket(
165 const std::string& ip,
167 uint32_t connectTimeout = 0) {
168 return std::shared_ptr<AsyncSocket>(
169 new AsyncSocket(evb, ip, port, connectTimeout),
174 * Helper function to create a shared_ptr<AsyncSocket>.
176 static std::shared_ptr<AsyncSocket> newSocket(EventBase* evb, int fd) {
177 return std::shared_ptr<AsyncSocket>(new AsyncSocket(evb, fd),
182 * Destroy the socket.
184 * AsyncSocket::destroy() must be called to destroy the socket.
185 * The normal destructor is private, and should not be invoked directly.
186 * This prevents callers from deleting a AsyncSocket while it is invoking a
189 virtual void destroy() override;
192 * Get the EventBase used by this socket.
194 EventBase* getEventBase() const override {
199 * Get the file descriptor used by the AsyncSocket.
201 virtual int getFd() const {
206 * Extract the file descriptor from the AsyncSocket.
208 * This will immediately cause any installed callbacks to be invoked with an
209 * error. The AsyncSocket may no longer be used after the file descriptor
210 * has been extracted.
212 * Returns the file descriptor. The caller assumes ownership of the
213 * descriptor, and it will not be closed when the AsyncSocket is destroyed.
215 virtual int detachFd();
218 * Uniquely identifies a handle to a socket option value. Each
219 * combination of level and option name corresponds to one socket
224 bool operator<(const OptionKey& other) const {
225 if (level == other.level) {
226 return optname < other.optname;
228 return level < other.level;
230 int apply(int fd, int val) const {
231 return setsockopt(fd, level, optname, &val, sizeof(val));
237 // Maps from a socket option key to its value
238 typedef std::map<OptionKey, int> OptionMap;
240 static const OptionMap emptyOptionMap;
241 static const folly::SocketAddress& anyAddress();
244 * Initiate a connection.
246 * @param callback The callback to inform when the connection attempt
248 * @param address The address to connect to.
249 * @param timeout A timeout value, in milliseconds. If the connection
250 * does not succeed within this period,
251 * callback->connectError() will be invoked.
253 virtual void connect(ConnectCallback* callback,
254 const folly::SocketAddress& address,
256 const OptionMap &options = emptyOptionMap,
257 const folly::SocketAddress& bindAddr = anyAddress()
259 void connect(ConnectCallback* callback, const std::string& ip, uint16_t port,
261 const OptionMap &options = emptyOptionMap) noexcept;
264 * If a connect request is in-flight, cancels it and closes the socket
265 * immediately. Otherwise, this is a no-op.
267 * This does not invoke any connection related callbacks. Call this to
268 * prevent any connect callback while cleaning up, etc.
270 void cancelConnect();
273 * Set the send timeout.
275 * If write requests do not make any progress for more than the specified
276 * number of milliseconds, fail all pending writes and close the socket.
278 * If write requests are currently pending when setSendTimeout() is called,
279 * the timeout interval is immediately restarted using the new value.
281 * (See the comments for AsyncSocket for an explanation of why AsyncSocket
282 * provides setSendTimeout() but not setRecvTimeout().)
284 * @param milliseconds The timeout duration, in milliseconds. If 0, no
285 * timeout will be used.
287 void setSendTimeout(uint32_t milliseconds) override;
290 * Get the send timeout.
292 * @return Returns the current send timeout, in milliseconds. A return value
293 * of 0 indicates that no timeout is set.
295 uint32_t getSendTimeout() const override {
300 * Set the maximum number of reads to execute from the underlying
301 * socket each time the EventBase detects that new ingress data is
302 * available. The default is unlimited, but callers can use this method
303 * to limit the amount of data read from the socket per event loop
306 * @param maxReads Maximum number of reads per data-available event;
307 * a value of zero means unlimited.
309 void setMaxReadsPerEvent(uint16_t maxReads) {
310 maxReadsPerEvent_ = maxReads;
314 * Get the maximum number of reads this object will execute from
315 * the underlying socket each time the EventBase detects that new
316 * ingress data is available.
318 * @returns Maximum number of reads per data-available event; a value
319 * of zero means unlimited.
321 uint16_t getMaxReadsPerEvent() const {
322 return maxReadsPerEvent_;
325 // Read and write methods
326 void setReadCB(ReadCallback* callback) override;
327 ReadCallback* getReadCallback() const override;
329 void write(WriteCallback* callback, const void* buf, size_t bytes,
330 WriteFlags flags = WriteFlags::NONE) override;
331 void writev(WriteCallback* callback, const iovec* vec, size_t count,
332 WriteFlags flags = WriteFlags::NONE) override;
333 void writeChain(WriteCallback* callback,
334 std::unique_ptr<folly::IOBuf>&& buf,
335 WriteFlags flags = WriteFlags::NONE) override;
338 virtual void writeRequest(WriteRequest* req);
339 void writeRequestReady() {
343 // Methods inherited from AsyncTransport
344 void close() override;
345 void closeNow() override;
346 void closeWithReset() override;
347 void shutdownWrite() override;
348 void shutdownWriteNow() override;
350 bool readable() const override;
351 bool isPending() const override;
352 virtual bool hangup() const;
353 bool good() const override;
354 bool error() const override;
355 void attachEventBase(EventBase* eventBase) override;
356 void detachEventBase() override;
357 bool isDetachable() const override;
359 void getLocalAddress(
360 folly::SocketAddress* address) const override;
362 folly::SocketAddress* address) const override;
364 bool isEorTrackingEnabled() const override { return false; }
366 void setEorTracking(bool /*track*/) override {}
368 bool connecting() const override {
369 return (state_ == StateEnum::CONNECTING);
372 size_t getAppBytesWritten() const override {
373 return appBytesWritten_;
376 size_t getRawBytesWritten() const override {
377 return getAppBytesWritten();
380 size_t getAppBytesReceived() const override {
381 return appBytesReceived_;
384 size_t getRawBytesReceived() const override {
385 return getAppBytesReceived();
388 // Methods controlling socket options
391 * Force writes to be transmitted immediately.
393 * This controls the TCP_NODELAY socket option. When enabled, TCP segments
394 * are sent as soon as possible, even if it is not a full frame of data.
395 * When disabled, the data may be buffered briefly to try and wait for a full
398 * By default, TCP_NODELAY is enabled for AsyncSocket objects.
400 * This method will fail if the socket is not currently open.
402 * @return Returns 0 if the TCP_NODELAY flag was successfully updated,
403 * or a non-zero errno value on error.
405 int setNoDelay(bool noDelay);
409 * Set the FD_CLOEXEC flag so that the socket will be closed if the program
410 * later forks and execs.
412 void setCloseOnExec();
415 * Set the Flavor of Congestion Control to be used for this Socket
416 * Please check '/lib/modules/<kernel>/kernel/net/ipv4' for tcp_*.ko
417 * first to make sure the module is available for plugging in
418 * Alternatively you can choose from net.ipv4.tcp_allowed_congestion_control
420 int setCongestionFlavor(const std::string &cname);
423 * Forces ACKs to be sent immediately
425 * @return Returns 0 if the TCP_QUICKACK flag was successfully updated,
426 * or a non-zero errno value on error.
428 int setQuickAck(bool quickack);
431 * Set the send bufsize
433 int setSendBufSize(size_t bufsize);
436 * Set the recv bufsize
438 int setRecvBufSize(size_t bufsize);
441 * Sets a specific tcp personality
442 * Available only on kernels 3.2 and greater
444 #define SO_SET_NAMESPACE 41
445 int setTCPProfile(int profd);
449 * Generic API for reading a socket option.
451 * @param level same as the "level" parameter in getsockopt().
452 * @param optname same as the "optname" parameter in getsockopt().
453 * @param optval pointer to the variable in which the option value should
455 * @param optlen value-result argument, initially containing the size of
456 * the buffer pointed to by optval, and modified on return
457 * to indicate the actual size of the value returned.
458 * @return same as the return value of getsockopt().
460 template <typename T>
461 int getSockOpt(int level, int optname, T* optval, socklen_t* optlen) {
462 return getsockopt(fd_, level, optname, (void*) optval, optlen);
466 * Generic API for setting a socket option.
468 * @param level same as the "level" parameter in getsockopt().
469 * @param optname same as the "optname" parameter in getsockopt().
470 * @param optval the option value to set.
471 * @return same as the return value of setsockopt().
473 template <typename T>
474 int setSockOpt(int level, int optname, const T *optval) {
475 return setsockopt(fd_, level, optname, optval, sizeof(T));
478 virtual void setPeek(bool peek) {
482 enum class StateEnum : uint8_t {
491 * A WriteRequest object tracks information about a pending write operation.
495 WriteRequest(AsyncSocket* socket, WriteCallback* callback) :
496 socket_(socket), callback_(callback) {}
498 virtual void start() {};
500 virtual void destroy() = 0;
502 virtual bool performWrite() = 0;
504 virtual void consume() = 0;
506 virtual bool isComplete() = 0;
508 WriteRequest* getNext() const {
512 WriteCallback* getCallback() const {
516 uint32_t getTotalBytesWritten() const {
517 return totalBytesWritten_;
520 void append(WriteRequest* next) {
521 assert(next_ == nullptr);
525 void fail(const char* fn, const AsyncSocketException& ex) {
526 socket_->failWrite(fn, ex);
529 void bytesWritten(size_t count) {
530 totalBytesWritten_ += count;
531 socket_->appBytesWritten_ += count;
535 // protected destructor, to ensure callers use destroy()
536 virtual ~WriteRequest() {}
538 AsyncSocket* socket_; ///< parent socket
539 WriteRequest* next_{nullptr}; ///< pointer to next WriteRequest
540 WriteCallback* callback_; ///< completion callback
541 uint32_t totalBytesWritten_{0}; ///< total bytes written
545 enum ReadResultEnum {
552 * Protected destructor.
554 * Users of AsyncSocket must never delete it directly. Instead, invoke
555 * destroy() instead. (See the documentation in DelayedDestruction.h for
560 friend std::ostream& operator << (std::ostream& os, const StateEnum& state);
563 /// shutdownWrite() called, but we are still waiting on writes to drain
564 SHUT_WRITE_PENDING = 0x01,
565 /// writes have been completely shut down
568 * Reads have been shutdown.
570 * At the moment we don't distinguish between remote read shutdown
571 * (received EOF from the remote end) and local read shutdown. We can
572 * only receive EOF when a read callback is set, and we immediately inform
573 * it of the EOF. Therefore there doesn't seem to be any reason to have a
574 * separate state of "received EOF but the local side may still want to
577 * We also don't currently provide any API for only shutting down the read
578 * side of a socket. (This is a no-op as far as TCP is concerned, anyway.)
583 class BytesWriteRequest;
585 class WriteTimeout : public AsyncTimeout {
587 WriteTimeout(AsyncSocket* socket, EventBase* eventBase)
588 : AsyncTimeout(eventBase)
591 virtual void timeoutExpired() noexcept {
592 socket_->timeoutExpired();
596 AsyncSocket* socket_;
599 class IoHandler : public EventHandler {
601 IoHandler(AsyncSocket* socket, EventBase* eventBase)
602 : EventHandler(eventBase, -1)
604 IoHandler(AsyncSocket* socket, EventBase* eventBase, int fd)
605 : EventHandler(eventBase, fd)
608 virtual void handlerReady(uint16_t events) noexcept {
609 socket_->ioReady(events);
613 AsyncSocket* socket_;
618 class ImmediateReadCB : public folly::EventBase::LoopCallback {
620 explicit ImmediateReadCB(AsyncSocket* socket) : socket_(socket) {}
621 void runLoopCallback() noexcept override {
622 DestructorGuard dg(socket_);
623 socket_->checkForImmediateRead();
626 AsyncSocket* socket_;
630 * Schedule checkForImmediateRead to be executed in the next loop
633 void scheduleImmediateRead() noexcept {
635 eventBase_->runInLoop(&immediateReadHandler_);
639 // event notification methods
640 void ioReady(uint16_t events) noexcept;
641 virtual void checkForImmediateRead() noexcept;
642 virtual void handleInitialReadWrite() noexcept;
643 virtual void prepareReadBuffer(void** buf, size_t* buflen) noexcept;
644 virtual void handleRead() noexcept;
645 virtual void handleWrite() noexcept;
646 virtual void handleConnect() noexcept;
647 void timeoutExpired() noexcept;
650 * Attempt to read from the socket.
652 * @param buf The buffer to read data into.
653 * @param buflen The length of the buffer.
655 * @return Returns the number of bytes read, or READ_EOF on EOF, or
656 * READ_ERROR on error, or READ_BLOCKING if the operation will
659 virtual ssize_t performRead(void** buf, size_t* buflen, size_t* offset);
662 * Populate an iovec array from an IOBuf and attempt to write it.
664 * @param callback Write completion/error callback.
665 * @param vec Target iovec array; caller retains ownership.
666 * @param count Number of IOBufs to write, beginning at start of buf.
667 * @param buf Chain of iovecs.
668 * @param flags set of flags for the underlying write calls, like cork
670 void writeChainImpl(WriteCallback* callback, iovec* vec,
671 size_t count, std::unique_ptr<folly::IOBuf>&& buf,
675 * Write as much data as possible to the socket without blocking,
676 * and queue up any leftover data to send when the socket can
677 * handle writes again.
679 * @param callback The callback to invoke when the write is completed.
680 * @param vec Array of buffers to write; this method will make a
681 * copy of the vector (but not the buffers themselves)
682 * if the write has to be completed asynchronously.
683 * @param count Number of elements in vec.
684 * @param buf The IOBuf that manages the buffers referenced by
685 * vec, or a pointer to nullptr if the buffers are not
686 * associated with an IOBuf. Note that ownership of
687 * the IOBuf is transferred here; upon completion of
688 * the write, the AsyncSocket deletes the IOBuf.
689 * @param flags Set of write flags.
691 void writeImpl(WriteCallback* callback, const iovec* vec, size_t count,
692 std::unique_ptr<folly::IOBuf>&& buf,
693 WriteFlags flags = WriteFlags::NONE);
696 * Attempt to write to the socket.
698 * @param vec The iovec array pointing to the buffers to write.
699 * @param count The length of the iovec array.
700 * @param flags Set of write flags.
701 * @param countWritten On return, the value pointed to by this parameter
702 * will contain the number of iovec entries that were
704 * @param partialWritten On return, the value pointed to by this parameter
705 * will contain the number of bytes written in the
706 * partially written iovec entry.
708 * @return Returns the total number of bytes written, or -1 on error. If no
709 * data can be written immediately, 0 is returned.
711 virtual ssize_t performWrite(const iovec* vec, uint32_t count,
712 WriteFlags flags, uint32_t* countWritten,
713 uint32_t* partialWritten);
715 bool updateEventRegistration();
718 * Update event registration.
720 * @param enable Flags of events to enable. Set it to 0 if no events
721 * need to be enabled in this call.
722 * @param disable Flags of events
723 * to disable. Set it to 0 if no events need to be disabled in this
726 * @return true iff the update is successful.
728 bool updateEventRegistration(uint16_t enable, uint16_t disable);
730 // Actually close the file descriptor and set it to -1 so we don't
731 // accidentally close it again.
734 // error handling methods
737 void fail(const char* fn, const AsyncSocketException& ex);
738 void failConnect(const char* fn, const AsyncSocketException& ex);
739 void failRead(const char* fn, const AsyncSocketException& ex);
740 void failWrite(const char* fn, WriteCallback* callback, size_t bytesWritten,
741 const AsyncSocketException& ex);
742 void failWrite(const char* fn, const AsyncSocketException& ex);
743 void failAllWrites(const AsyncSocketException& ex);
744 void invalidState(ConnectCallback* callback);
745 void invalidState(ReadCallback* callback);
746 void invalidState(WriteCallback* callback);
748 std::string withAddr(const std::string& s);
750 StateEnum state_; ///< StateEnum describing current state
751 uint8_t shutdownFlags_; ///< Shutdown state (ShutdownFlags)
752 uint16_t eventFlags_; ///< EventBase::HandlerFlags settings
753 int fd_; ///< The socket file descriptor
755 folly::SocketAddress addr_; ///< The address we tried to connect to
756 uint32_t sendTimeout_; ///< The send timeout, in milliseconds
757 uint16_t maxReadsPerEvent_; ///< Max reads per event loop iteration
758 EventBase* eventBase_; ///< The EventBase
759 WriteTimeout writeTimeout_; ///< A timeout for connect and write
760 IoHandler ioHandler_; ///< A EventHandler to monitor the fd
761 ImmediateReadCB immediateReadHandler_; ///< LoopCallback for checking read
763 ConnectCallback* connectCallback_; ///< ConnectCallback
764 ReadCallback* readCallback_; ///< ReadCallback
765 WriteRequest* writeReqHead_; ///< Chain of WriteRequests
766 WriteRequest* writeReqTail_; ///< End of WriteRequest chain
767 ShutdownSocketSet* shutdownSocketSet_;
768 size_t appBytesReceived_; ///< Num of bytes received from socket
769 size_t appBytesWritten_; ///< Num of bytes written to socket
770 bool isBufferMovable_{false};
772 bool peek_{false}; // Peek bytes.