/*
- * Copyright 2015 Facebook, Inc.
+ * Copyright 2017 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#pragma once
#include <memory>
-#include <sys/uio.h>
+#include <folly/io/IOBuf.h>
+#include <folly/io/async/AsyncSocketBase.h>
#include <folly/io/async/DelayedDestruction.h>
+#include <folly/io/async/EventBase.h>
+#include <folly/io/async/ssl/OpenSSLPtrTypes.h>
+#include <folly/portability/SysUio.h>
+
+#include <openssl/ssl.h>
+
+constexpr bool kOpenSslModeMoveBufferOwnership =
+#ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
+ true
+#else
+ false
+#endif
+;
namespace folly {
class AsyncSocketException;
class EventBase;
-class IOBuf;
class SocketAddress;
/*
* will be acknowledged.
*/
EOR = 0x02,
+ /*
+ * this indicates that only the write side of socket should be shutdown
+ */
+ WRITE_SHUTDOWN = 0x04,
};
/*
static_cast<uint32_t>(a) | static_cast<uint32_t>(b));
}
+/*
+ * compound assignment union operator
+ */
+inline WriteFlags& operator|=(WriteFlags& a, WriteFlags b) {
+ a = a | b;
+ return a;
+}
+
/*
* intersection operator
*/
static_cast<uint32_t>(a) & static_cast<uint32_t>(b));
}
+/*
+ * compound assignment intersection operator
+ */
+inline WriteFlags& operator&=(WriteFlags& a, WriteFlags b) {
+ a = a & b;
+ return a;
+}
+
/*
* exclusion parameter
*/
* timeout, since most callers want to give up if the remote end stops
* responding and no further progress can be made sending the data.
*/
-class AsyncTransport : public DelayedDestruction {
+class AsyncTransport : public DelayedDestruction, public AsyncSocketBase {
public:
typedef std::unique_ptr<AsyncTransport, Destructor> UniquePtr;
virtual bool isPending() const {
return readable();
}
+
/**
* Determine if transport is connected to the endpoint
*
*/
virtual bool isDetachable() const = 0;
- /**
- * Get the EventBase used by this transport.
- *
- * Returns nullptr if this transport is not currently attached to a
- * EventBase.
- */
- virtual EventBase* getEventBase() const = 0;
-
/**
* Set the send timeout.
*
*/
virtual void getLocalAddress(SocketAddress* address) const = 0;
+ virtual void getAddress(SocketAddress* address) const {
+ getLocalAddress(address);
+ }
+
/**
* Get the address of the remote endpoint to which this transport is
* connected.
*/
virtual void getPeerAddress(SocketAddress* address) const = 0;
+ /**
+ * Get the certificate used to authenticate the peer.
+ */
+ virtual ssl::X509UniquePtr getPeerCert() const { return nullptr; }
+
+ /**
+ * The local certificate used for this connection. May be null
+ */
+ virtual const X509* getSelfCert() const {
+ return nullptr;
+ }
+
/**
* @return True iff end of record tracking is enabled
*/
virtual size_t getAppBytesReceived() const = 0;
virtual size_t getRawBytesReceived() const = 0;
+ class BufferCallback {
+ public:
+ virtual ~BufferCallback() {}
+ virtual void onEgressBuffered() = 0;
+ virtual void onEgressBufferCleared() = 0;
+ };
+
+ /**
+ * Callback class to signal when a transport that did not have replay
+ * protection gains replay protection. This is needed for 0-RTT security
+ * protocols.
+ */
+ class ReplaySafetyCallback {
+ public:
+ virtual ~ReplaySafetyCallback() = default;
+
+ /**
+ * Called when the transport becomes replay safe.
+ */
+ virtual void onReplaySafe() = 0;
+ };
+
+ /**
+ * False if the transport does not have replay protection, but will in the
+ * future.
+ */
+ virtual bool isReplaySafe() const { return true; }
+
+ /**
+ * Set the ReplaySafeCallback on this transport.
+ *
+ * This should only be called if isReplaySafe() returns false.
+ */
+ virtual void setReplaySafetyCallback(ReplaySafetyCallback* callback) {
+ if (callback) {
+ CHECK(false) << "setReplaySafetyCallback() not supported";
+ }
+ }
+
protected:
- virtual ~AsyncTransport() {}
+ virtual ~AsyncTransport() = default;
};
-// Transitional intermediate interface. This is deprecated.
-// Wrapper around folly::AsyncTransport, that includes read/write callbacks
-class AsyncTransportWrapper : virtual public AsyncTransport {
+class AsyncReader {
public:
- typedef std::unique_ptr<AsyncTransportWrapper, Destructor> UniquePtr;
-
class ReadCallback {
public:
- virtual ~ReadCallback() {}
+ virtual ~ReadCallback() = default;
/**
* When data becomes available, getReadBuffer() will be invoked to get the
*
* @param len The number of bytes placed in the buffer.
*/
+
virtual void readDataAvailable(size_t len) noexcept = 0;
+ /**
+ * When data becomes available, isBufferMovable() will be invoked to figure
+ * out which API will be used, readBufferAvailable() or
+ * readDataAvailable(). If isBufferMovable() returns true, that means
+ * ReadCallback supports the IOBuf ownership transfer and
+ * readBufferAvailable() will be used. Otherwise, not.
+
+ * By default, isBufferMovable() always return false. If
+ * readBufferAvailable() is implemented and to be invoked, You should
+ * overwrite isBufferMovable() and return true in the inherited class.
+ *
+ * This method allows the AsyncSocket/AsyncSSLSocket do buffer allocation by
+ * itself until data becomes available. Compared with the pre/post buffer
+ * allocation in getReadBuffer()/readDataAvailabe(), readBufferAvailable()
+ * has two advantages. First, this can avoid memcpy. E.g., in
+ * AsyncSSLSocket, the decrypted data was copied from the openssl internal
+ * buffer to the readbuf buffer. With the buffer ownership transfer, the
+ * internal buffer can be directly "moved" to ReadCallback. Second, the
+ * memory allocation can be more precise. The reason is
+ * AsyncSocket/AsyncSSLSocket can allocate the memory of precise size
+ * because they have more context about the available data than
+ * ReadCallback. Think about the getReadBuffer() pre-allocate 4072 bytes
+ * buffer, but the available data is always 16KB (max OpenSSL record size).
+ */
+
+ virtual bool isBufferMovable() noexcept {
+ return false;
+ }
+
+ /**
+ * Suggested buffer size, allocated for read operations,
+ * if callback is movable and supports folly::IOBuf
+ */
+
+ virtual size_t maxBufferSize() const {
+ return 64 * 1024; // 64K
+ }
+
+ /**
+ * readBufferAvailable() will be invoked when data has been successfully
+ * read.
+ *
+ * Note that only either readBufferAvailable() or readDataAvailable() will
+ * be invoked according to the return value of isBufferMovable(). The timing
+ * and aftereffect of readBufferAvailable() are the same as
+ * readDataAvailable()
+ *
+ * @param readBuf The unique pointer of read buffer.
+ */
+
+ virtual void readBufferAvailable(std::unique_ptr<IOBuf> /*readBuf*/)
+ noexcept {}
+
/**
* readEOF() will be invoked when the transport is closed.
*
virtual void readErr(const AsyncSocketException& ex) noexcept = 0;
};
+ // Read methods that aren't part of AsyncTransport.
+ virtual void setReadCB(ReadCallback* callback) = 0;
+ virtual ReadCallback* getReadCallback() const = 0;
+
+ protected:
+ virtual ~AsyncReader() = default;
+};
+
+class AsyncWriter {
+ public:
class WriteCallback {
public:
- virtual ~WriteCallback() {}
+ virtual ~WriteCallback() = default;
/**
* writeSuccess() will be invoked when all of the data has been
const AsyncSocketException& ex) noexcept = 0;
};
- // Read/write methods that aren't part of AsyncTransport
- virtual void setReadCB(ReadCallback* callback) = 0;
- virtual ReadCallback* getReadCallback() const = 0;
-
+ // Write methods that aren't part of AsyncTransport
virtual void write(WriteCallback* callback, const void* buf, size_t bytes,
WriteFlags flags = WriteFlags::NONE) = 0;
virtual void writev(WriteCallback* callback, const iovec* vec, size_t count,
virtual void writeChain(WriteCallback* callback,
std::unique_ptr<IOBuf>&& buf,
WriteFlags flags = WriteFlags::NONE) = 0;
+
+ protected:
+ virtual ~AsyncWriter() = default;
+};
+
+// Transitional intermediate interface. This is deprecated.
+// Wrapper around folly::AsyncTransport, that includes read/write callbacks
+class AsyncTransportWrapper : virtual public AsyncTransport,
+ virtual public AsyncReader,
+ virtual public AsyncWriter {
+ public:
+ using UniquePtr = std::unique_ptr<AsyncTransportWrapper, Destructor>;
+
+ // Alias for inherited members from AsyncReader and AsyncWriter
+ // to keep compatibility.
+ using ReadCallback = AsyncReader::ReadCallback;
+ using WriteCallback = AsyncWriter::WriteCallback;
+ virtual void setReadCB(ReadCallback* callback) override = 0;
+ virtual ReadCallback* getReadCallback() const override = 0;
+ virtual void write(WriteCallback* callback, const void* buf, size_t bytes,
+ WriteFlags flags = WriteFlags::NONE) override = 0;
+ virtual void writev(WriteCallback* callback, const iovec* vec, size_t count,
+ WriteFlags flags = WriteFlags::NONE) override = 0;
+ virtual void writeChain(WriteCallback* callback,
+ std::unique_ptr<IOBuf>&& buf,
+ WriteFlags flags = WriteFlags::NONE) override = 0;
+ /**
+ * The transport wrapper may wrap another transport. This returns the
+ * transport that is wrapped. It returns nullptr if there is no wrapped
+ * transport.
+ */
+ virtual const AsyncTransportWrapper* getWrappedTransport() const {
+ return nullptr;
+ }
+
+ /**
+ * In many cases when we need to set socket properties or otherwise access the
+ * underlying transport from a wrapped transport. This method allows access to
+ * the derived classes of the underlying transport.
+ */
+ template <class T>
+ const T* getUnderlyingTransport() const {
+ const AsyncTransportWrapper* current = this;
+ while (current) {
+ auto sock = dynamic_cast<const T*>(current);
+ if (sock) {
+ return sock;
+ }
+ current = current->getWrappedTransport();
+ }
+ return nullptr;
+ }
+
+ template <class T>
+ T* getUnderlyingTransport() {
+ return const_cast<T*>(static_cast<const AsyncTransportWrapper*>(this)
+ ->getUnderlyingTransport<T>());
+ }
+
+ /**
+ * Return the application protocol being used by the underlying transport
+ * protocol. This is useful for transports which are used to tunnel other
+ * protocols.
+ */
+ virtual std::string getApplicationProtocol() noexcept {
+ return "";
+ }
+
+ /**
+ * Returns the name of the security protocol being used.
+ */
+ virtual std::string getSecurityProtocol() const { return ""; }
};
} // folly
projects / folly.git / blobdiff