conn_pool: making TCP upstreams pluggable #13548
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # DO NOT EDIT. This file is generated by tools/proto_format/proto_sync.py. | ||
|
|
||
| load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package") | ||
|
|
||
| licenses(["notice"]) # Apache 2 | ||
|
|
||
| api_proto_package( | ||
| deps = ["@com_github_cncf_udpa//udpa/annotations:pkg"], | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package envoy.extensions.upstreams.tcp.generic.v3; | ||
|
|
||
| import "udpa/annotations/status.proto"; | ||
|
|
||
| option java_package = "io.envoyproxy.envoy.extensions.upstreams.tcp.generic.v3"; | ||
| option java_outer_classname = "GenericConnectionPoolProtoOuterClass"; | ||
| option java_multiple_files = true; | ||
| option (udpa.annotations.file_status).package_version_status = ACTIVE; | ||
|
|
||
| // [#protodoc-title: Generic Connection Pool] | ||
|
|
||
| // A connection pool which forwards downstream TCP as TCP or HTTP to upstream, | ||
| // based on CONNECT configuration. | ||
| // [#extension: envoy.upstreams.tcp.generic] | ||
| message GenericConnectionPoolProto { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| #pragma once | ||
|
|
||
| #include "envoy/buffer/buffer.h" | ||
| #include "envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.pb.h" | ||
| #include "envoy/stream_info/stream_info.h" | ||
| #include "envoy/tcp/conn_pool.h" | ||
| #include "envoy/upstream/upstream.h" | ||
|
|
||
| namespace Envoy { | ||
|
|
||
| namespace Upstream { | ||
| class LoadBalancerContext; | ||
| } // namespace Upstream | ||
|
|
||
| namespace TcpProxy { | ||
|
|
||
| class GenericConnectionPoolCallbacks; | ||
| class GenericUpstream; | ||
|
|
||
| // An API for wrapping either a TCP or an HTTP connection pool. | ||
| class GenericConnPool : public Logger::Loggable<Logger::Id::router> { | ||
| public: | ||
| virtual ~GenericConnPool() = default; | ||
|
|
||
| /** | ||
| * Called to create a TCP connection or HTTP stream for "CONNECT" streams. | ||
| * | ||
| * The implementation is then responsible for calling either onGenericPoolReady or | ||
| * onGenericPoolFailure on the supplied GenericConnectionPoolCallbacks. | ||
| * | ||
| * @param callbacks callbacks to communicate stream failure or creation on. | ||
| */ | ||
| virtual void newStream(GenericConnectionPoolCallbacks& callbacks) PURE; | ||
| }; | ||
|
|
||
| // An API for the UpstreamRequest to get callbacks from either an HTTP or TCP | ||
| // connection pool. | ||
| class GenericConnectionPoolCallbacks { | ||
| public: | ||
| virtual ~GenericConnectionPoolCallbacks() = default; | ||
|
|
||
| /** | ||
| * Called when GenericConnPool::newStream has established a new stream. | ||
| * | ||
| * @param info supplies the stream info object associated with the upstream connection. | ||
| * @param upstream supplies the generic upstream for the stream. | ||
| * @param host supplies the description of the host that will carry the request. | ||
| * @param upstream_local_address supplies the local address of the upstream connection. | ||
| * @param ssl_info supplies the ssl information of the upstream connection. | ||
| */ | ||
| virtual void | ||
| onGenericPoolReady(StreamInfo::StreamInfo* info, std::unique_ptr<GenericUpstream>&& upstream, | ||
| Upstream::HostDescriptionConstSharedPtr& host, | ||
| const Network::Address::InstanceConstSharedPtr& upstream_local_address, | ||
| Ssl::ConnectionInfoConstSharedPtr ssl_info) PURE; | ||
|
|
||
| /** | ||
| * Called to indicate a failure for GenericConnPool::newStream to establish a stream. | ||
| * | ||
| * @param reason supplies the failure reason. | ||
| * @param host supplies the description of the host that caused the failure. This may be nullptr | ||
| * if no host was involved in the failure (for example overflow). | ||
| */ | ||
| virtual void onGenericPoolFailure(ConnectionPool::PoolFailureReason reason, | ||
| Upstream::HostDescriptionConstSharedPtr host) PURE; | ||
| }; | ||
|
|
||
| // Interface for a generic Upstream, which can communicate with a TCP or HTTP | ||
| // upstream. | ||
| class GenericUpstream { | ||
| public: | ||
| virtual ~GenericUpstream() = default; | ||
|
|
||
| /** | ||
| * Enable/disable further data from this stream. | ||
| * | ||
| * @param disable true if the stream should be read disabled, false otherwise. | ||
| * @return returns true if the disable is performed, false otherwise | ||
| * (e.g. if the connection is closed) | ||
| */ | ||
| virtual bool readDisable(bool disable) PURE; | ||
|
|
||
| /** | ||
| * Encodes data upstream. | ||
| * @param data supplies the data to encode. The data may be moved by the encoder. | ||
| * @param end_stream supplies whether this is the last data to encode. | ||
| */ | ||
| virtual void encodeData(Buffer::Instance& data, bool end_stream) PURE; | ||
|
|
||
| /** | ||
| * Adds a callback to be called when the data is sent to the kernel. | ||
| * @param cb supplies the callback to be called | ||
| */ | ||
| virtual void addBytesSentCallback(Network::Connection::BytesSentCb cb) PURE; | ||
|
|
||
| /** | ||
| * Called when an event is received on the downstream connection | ||
| * @param event supplies the event which occurred. | ||
| * @return the underlying ConnectionData if the event is not "Connected" and draining | ||
| is supported for this upstream. | ||
| */ | ||
| virtual Tcp::ConnectionPool::ConnectionData* | ||
| onDownstreamEvent(Network::ConnectionEvent event) PURE; | ||
| }; | ||
|
|
||
| using GenericConnPoolPtr = std::unique_ptr<GenericConnPool>; | ||
|
|
||
| /* | ||
| * A factory for creating generic connection pools. | ||
| */ | ||
| class GenericConnPoolFactory : public Envoy::Config::TypedFactory { | ||
| public: | ||
| ~GenericConnPoolFactory() override = default; | ||
|
|
||
| using TunnelingConfig = | ||
| envoy::extensions::filters::network::tcp_proxy::v3::TcpProxy_TunnelingConfig; | ||
|
|
||
| /* | ||
| * @param cluster_name the name of the cluster to use | ||
| * @param cm the cluster manager to get the connection pool from | ||
| * @param config the tunneling config, if doing connect tunneling. | ||
| * @param context the load balancing context for this connection. | ||
| * @param upstream_callbacks the callbacks to provide to the connection if successfully created. | ||
| * @return may be null if there is no cluster with the given name. | ||
| */ | ||
| virtual GenericConnPoolPtr | ||
| createGenericConnPool(const std::string& cluster_name, Upstream::ClusterManager& cm, | ||
| const absl::optional<TunnelingConfig>& config, | ||
| Upstream::LoadBalancerContext* context, | ||
| Tcp::ConnectionPool::UpstreamCallbacks& upstream_callbacks) const PURE; | ||
| }; | ||
|
|
||
| using GenericConnPoolFactoryPtr = std::unique_ptr<GenericConnPoolFactory>; | ||
|
|
||
| } // namespace TcpProxy | ||
| } // namespace Envoy | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -212,8 +212,8 @@ class Utility { | |
| /** | ||
| * Get a Factory from the registry with a particular name (and templated type) with error checking | ||
| * to ensure the name and factory are valid. | ||
| * @param name string identifier for the particular implementation. | ||
| * @return factory the factory requested or nullptr if it does not exist. | ||
| */ | ||
| template <class Factory> static Factory& getAndCheckFactoryByName(const std::string& name) { | ||
| if (name.empty()) { | ||
|
|
@@ -230,6 +230,32 @@ class Utility { | |
| return *factory; | ||
| } | ||
|
|
||
| /** | ||
| * Get a Factory from the registry with a particular name or return nullptr. | ||
|
There was a problem hiding this comment. nit: worth adding a @return statement to the comment? |
||
| * @param name string identifier for the particular implementation. | ||
| */ | ||
| template <class Factory> static Factory* getFactoryByName(const std::string& name) { | ||
| if (name.empty()) { | ||
| return nullptr; | ||
| } | ||
|
|
||
| return Registry::FactoryRegistry<Factory>::getFactory(name); | ||
| } | ||
|
|
||
| /** | ||
| * Get a Factory from the registry or return nullptr. | ||
| * @param message proto that contains fields 'name' and 'typed_config'. | ||
| */ | ||
| template <class Factory, class ProtoMessage> | ||
| static Factory* getFactory(const ProtoMessage& message) { | ||
| Factory* factory = Utility::getFactoryByType<Factory>(message.typed_config()); | ||
| if (factory != nullptr) { | ||
| return factory; | ||
| } | ||
|
|
||
| return Utility::getFactoryByName<Factory>(message.name()); | ||
| } | ||
|
|
||
| /** | ||
| * Get a Factory from the registry with error checking to ensure the name and the factory are | ||
| * valid. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: documentation and argument names disagree: upstream_local_address vs local_address