blob: 08ff2b6053ca4042426ef0f854531adf36edec81 [file] [log] [blame]
AppaRao Pulibd030d02020-03-20 03:34:29 +05301/*
2// Copyright (c) 2020 Intel Corporation
3//
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
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
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.
15*/
16#pragma once
Nan Zhou77665bd2022-10-12 20:28:58 +000017
18#include "async_resolve.hpp"
Ed Tanousb2896142024-01-31 15:25:47 -080019#include "http_body.hpp"
Nan Zhou77665bd2022-10-12 20:28:58 +000020#include "http_response.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080021#include "logging.hpp"
22#include "ssl_key_handler.hpp"
Nan Zhou77665bd2022-10-12 20:28:58 +000023
Ed Tanous0d5f5cf2022-03-12 15:30:55 -080024#include <boost/asio/connect.hpp>
Ed Tanousbb49eb52022-06-28 12:02:42 -070025#include <boost/asio/io_context.hpp>
Sunitha Harish29a82b02021-02-18 15:54:16 +053026#include <boost/asio/ip/address.hpp>
27#include <boost/asio/ip/basic_endpoint.hpp>
Ed Tanousbb49eb52022-06-28 12:02:42 -070028#include <boost/asio/ip/tcp.hpp>
AppaRao Pulie38778a2022-06-27 23:09:03 +000029#include <boost/asio/ssl/context.hpp>
30#include <boost/asio/ssl/error.hpp>
Ed Tanous003301a2024-04-16 09:59:19 -070031#include <boost/asio/ssl/stream.hpp>
Ed Tanousd43cd0c2020-09-30 20:46:53 -070032#include <boost/asio/steady_timer.hpp>
Ed Tanousbb49eb52022-06-28 12:02:42 -070033#include <boost/beast/core/flat_static_buffer.hpp>
Ed Tanousd43cd0c2020-09-30 20:46:53 -070034#include <boost/beast/http/message.hpp>
Ed Tanous4d698612024-02-06 14:57:24 -080035#include <boost/beast/http/message_generator.hpp>
Ed Tanousbb49eb52022-06-28 12:02:42 -070036#include <boost/beast/http/parser.hpp>
37#include <boost/beast/http/read.hpp>
Ed Tanousbb49eb52022-06-28 12:02:42 -070038#include <boost/beast/http/write.hpp>
Carson Labradof52c03c2022-03-23 18:50:15 +000039#include <boost/container/devector.hpp>
Ed Tanousbb49eb52022-06-28 12:02:42 -070040#include <boost/system/error_code.hpp>
Ed Tanous27b0cf92023-08-07 12:02:40 -070041#include <boost/url/format.hpp>
42#include <boost/url/url.hpp>
Ed Tanous4a7fbef2024-04-06 16:03:49 -070043#include <boost/url/url_view_base.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050044
AppaRao Pulibd030d02020-03-20 03:34:29 +053045#include <cstdlib>
46#include <functional>
AppaRao Pulibd030d02020-03-20 03:34:29 +053047#include <memory>
AppaRao Puli2a5689a2020-04-29 15:24:31 +053048#include <queue>
AppaRao Pulibd030d02020-03-20 03:34:29 +053049#include <string>
50
51namespace crow
52{
Ed Tanous27b0cf92023-08-07 12:02:40 -070053// With Redfish Aggregation it is assumed we will connect to another
54// instance of BMCWeb which can handle 100 simultaneous connections.
Carson Labrado66d90c22022-12-07 22:34:33 +000055constexpr size_t maxPoolSize = 20;
56constexpr size_t maxRequestQueueSize = 500;
Carson Labrado17dcc312022-07-28 22:17:28 +000057constexpr unsigned int httpReadBodyLimit = 131072;
Carson Labrado4d942722022-06-22 22:16:10 +000058constexpr unsigned int httpReadBufferSize = 4096;
AppaRao Puli2a5689a2020-04-29 15:24:31 +053059
AppaRao Pulibd030d02020-03-20 03:34:29 +053060enum class ConnState
61{
AppaRao Puli2a5689a2020-04-29 15:24:31 +053062 initialized,
Sunitha Harish29a82b02021-02-18 15:54:16 +053063 resolveInProgress,
64 resolveFailed,
AppaRao Puli2a5689a2020-04-29 15:24:31 +053065 connectInProgress,
66 connectFailed,
AppaRao Pulibd030d02020-03-20 03:34:29 +053067 connected,
AppaRao Pulie38778a2022-06-27 23:09:03 +000068 handshakeInProgress,
69 handshakeFailed,
AppaRao Puli2a5689a2020-04-29 15:24:31 +053070 sendInProgress,
71 sendFailed,
Sunitha Harish6eaa1d22021-02-19 13:38:31 +053072 recvInProgress,
AppaRao Puli2a5689a2020-04-29 15:24:31 +053073 recvFailed,
74 idle,
Ayushi Smritife44eb02020-05-15 15:24:45 +053075 closed,
Sunitha Harish6eaa1d22021-02-19 13:38:31 +053076 suspended,
77 terminated,
78 abortConnection,
AppaRao Pulie38778a2022-06-27 23:09:03 +000079 sslInitFailed,
Sunitha Harish6eaa1d22021-02-19 13:38:31 +053080 retry
AppaRao Pulibd030d02020-03-20 03:34:29 +053081};
82
Carson Labradoa7a80292022-06-01 16:01:52 +000083static inline boost::system::error_code
84 defaultRetryHandler(unsigned int respCode)
85{
86 // As a default, assume 200X is alright
Ed Tanous62598e32023-07-17 17:06:25 -070087 BMCWEB_LOG_DEBUG("Using default check for response code validity");
Carson Labradoa7a80292022-06-01 16:01:52 +000088 if ((respCode < 200) || (respCode >= 300))
89 {
90 return boost::system::errc::make_error_code(
91 boost::system::errc::result_out_of_range);
92 }
93
94 // Return 0 if the response code is valid
95 return boost::system::errc::make_error_code(boost::system::errc::success);
96};
97
Ed Tanous27b0cf92023-08-07 12:02:40 -070098// We need to allow retry information to be set before a message has been
99// sent and a connection pool has been created
Carson Labradod14a48f2023-02-22 00:24:54 +0000100struct ConnectionPolicy
Carson Labradof52c03c2022-03-23 18:50:15 +0000101{
102 uint32_t maxRetryAttempts = 5;
Carson Labradod14a48f2023-02-22 00:24:54 +0000103
104 // the max size of requests in bytes. 0 for unlimited
105 boost::optional<uint64_t> requestByteLimit = httpReadBodyLimit;
106
107 size_t maxConnections = 1;
108
Carson Labradof52c03c2022-03-23 18:50:15 +0000109 std::string retryPolicyAction = "TerminateAfterRetries";
Carson Labradod14a48f2023-02-22 00:24:54 +0000110
111 std::chrono::seconds retryIntervalSecs = std::chrono::seconds(0);
Carson Labradoa7a80292022-06-01 16:01:52 +0000112 std::function<boost::system::error_code(unsigned int respCode)>
113 invalidResp = defaultRetryHandler;
Carson Labradof52c03c2022-03-23 18:50:15 +0000114};
115
116struct PendingRequest
117{
Ed Tanousb2896142024-01-31 15:25:47 -0800118 boost::beast::http::request<bmcweb::HttpBody> req;
Carson Labrado039a47e2022-04-05 16:03:20 +0000119 std::function<void(bool, uint32_t, Response&)> callback;
Carson Labrado039a47e2022-04-05 16:03:20 +0000120 PendingRequest(
Ed Tanousb2896142024-01-31 15:25:47 -0800121 boost::beast::http::request<bmcweb::HttpBody>&& reqIn,
Carson Labradod14a48f2023-02-22 00:24:54 +0000122 const std::function<void(bool, uint32_t, Response&)>& callbackIn) :
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400123 req(std::move(reqIn)), callback(callbackIn)
Carson Labradof52c03c2022-03-23 18:50:15 +0000124 {}
125};
126
Ed Tanouse01d0c32023-06-30 13:21:32 -0700127namespace http = boost::beast::http;
Carson Labradof52c03c2022-03-23 18:50:15 +0000128class ConnectionInfo : public std::enable_shared_from_this<ConnectionInfo>
AppaRao Pulibd030d02020-03-20 03:34:29 +0530129{
130 private:
Carson Labradof52c03c2022-03-23 18:50:15 +0000131 ConnState state = ConnState::initialized;
132 uint32_t retryCount = 0;
Carson Labradof52c03c2022-03-23 18:50:15 +0000133 std::string subId;
Carson Labradod14a48f2023-02-22 00:24:54 +0000134 std::shared_ptr<ConnectionPolicy> connPolicy;
Ed Tanousa716aa72023-08-01 11:35:53 -0700135 boost::urls::url host;
Ed Tanous19bb3622024-07-05 10:07:40 -0500136 ensuressl::VerifyCertificate verifyCert;
Carson Labradof52c03c2022-03-23 18:50:15 +0000137 uint32_t connId;
Carson Labradof52c03c2022-03-23 18:50:15 +0000138 // Data buffers
Ed Tanousb2896142024-01-31 15:25:47 -0800139 http::request<bmcweb::HttpBody> req;
140 using parser_type = http::response_parser<bmcweb::HttpBody>;
Ed Tanouse01d0c32023-06-30 13:21:32 -0700141 std::optional<parser_type> parser;
Carson Labrado4d942722022-06-22 22:16:10 +0000142 boost::beast::flat_static_buffer<httpReadBufferSize> buffer;
Carson Labrado039a47e2022-04-05 16:03:20 +0000143 Response res;
Sunitha Harish6eaa1d22021-02-19 13:38:31 +0530144
Carson Labradof52c03c2022-03-23 18:50:15 +0000145 // Ascync callables
Carson Labrado039a47e2022-04-05 16:03:20 +0000146 std::function<void(bool, uint32_t, Response&)> callback;
Ed Tanousf8ca6d72022-06-28 12:12:03 -0700147
Abhilash Rajuf3cb5df2023-11-30 03:54:11 -0600148 boost::asio::io_context& ioc;
149
Ed Tanous25b54db2024-04-17 15:40:31 -0700150 using Resolver = std::conditional_t<BMCWEB_DNS_RESOLVER == "systemd-dbus",
151 async_resolve::Resolver,
152 boost::asio::ip::tcp::resolver>;
Ed Tanousf8ca6d72022-06-28 12:12:03 -0700153 Resolver resolver;
154
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800155 boost::asio::ip::tcp::socket conn;
Ed Tanous003301a2024-04-16 09:59:19 -0700156 std::optional<boost::asio::ssl::stream<boost::asio::ip::tcp::socket&>>
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800157 sslConn;
AppaRao Pulie38778a2022-06-27 23:09:03 +0000158
Carson Labradof52c03c2022-03-23 18:50:15 +0000159 boost::asio::steady_timer timer;
Ed Tanous84b35602021-09-08 20:06:32 -0700160
Carson Labradof52c03c2022-03-23 18:50:15 +0000161 friend class ConnectionPool;
AppaRao Pulibd030d02020-03-20 03:34:29 +0530162
Sunitha Harish29a82b02021-02-18 15:54:16 +0530163 void doResolve()
164 {
Sunitha Harish29a82b02021-02-18 15:54:16 +0530165 state = ConnState::resolveInProgress;
Ed Tanousa716aa72023-08-01 11:35:53 -0700166 BMCWEB_LOG_DEBUG("Trying to resolve: {}, id: {}", host, connId);
Sunitha Harish29a82b02021-02-18 15:54:16 +0530167
Ed Tanousa716aa72023-08-01 11:35:53 -0700168 resolver.async_resolve(host.encoded_host_address(), host.port(),
Ed Tanousf8ca6d72022-06-28 12:12:03 -0700169 std::bind_front(&ConnectionInfo::afterResolve,
170 this, shared_from_this()));
Sunitha Harish29a82b02021-02-18 15:54:16 +0530171 }
172
Ed Tanousf8ca6d72022-06-28 12:12:03 -0700173 void afterResolve(const std::shared_ptr<ConnectionInfo>& /*self*/,
174 const boost::system::error_code& ec,
175 const Resolver::results_type& endpointList)
AppaRao Pulibd030d02020-03-20 03:34:29 +0530176 {
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700177 if (ec || (endpointList.empty()))
178 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700179 BMCWEB_LOG_ERROR("Resolve failed: {} {}", ec.message(), host);
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700180 state = ConnState::resolveFailed;
181 waitAndRetry();
182 return;
183 }
Ed Tanousa716aa72023-08-01 11:35:53 -0700184 BMCWEB_LOG_DEBUG("Resolved {}, id: {}", host, connId);
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530185 state = ConnState::connectInProgress;
186
Ed Tanousa716aa72023-08-01 11:35:53 -0700187 BMCWEB_LOG_DEBUG("Trying to connect to: {}, id: {}", host, connId);
Sunitha Harish29a82b02021-02-18 15:54:16 +0530188
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800189 timer.expires_after(std::chrono::seconds(30));
190 timer.async_wait(std::bind_front(onTimeout, weak_from_this()));
191
192 boost::asio::async_connect(
193 conn, endpointList,
194 std::bind_front(&ConnectionInfo::afterConnect, this,
195 shared_from_this()));
AppaRao Pulie38778a2022-06-27 23:09:03 +0000196 }
197
198 void afterConnect(const std::shared_ptr<ConnectionInfo>& /*self*/,
Ed Tanous81c4e332023-05-18 10:30:34 -0700199 const boost::beast::error_code& ec,
AppaRao Pulie38778a2022-06-27 23:09:03 +0000200 const boost::asio::ip::tcp::endpoint& endpoint)
201 {
Carson Labrado513d1ff2022-07-19 00:38:15 +0000202 // The operation already timed out. We don't want do continue down
203 // this branch
204 if (ec && ec == boost::asio::error::operation_aborted)
205 {
206 return;
207 }
208
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800209 timer.cancel();
AppaRao Pulie38778a2022-06-27 23:09:03 +0000210 if (ec)
211 {
Ed Tanous62598e32023-07-17 17:06:25 -0700212 BMCWEB_LOG_ERROR("Connect {}:{}, id: {} failed: {}",
Ed Tanousa716aa72023-08-01 11:35:53 -0700213 endpoint.address().to_string(), endpoint.port(),
214 connId, ec.message());
AppaRao Pulie38778a2022-06-27 23:09:03 +0000215 state = ConnState::connectFailed;
216 waitAndRetry();
217 return;
218 }
Ed Tanousa716aa72023-08-01 11:35:53 -0700219 BMCWEB_LOG_DEBUG("Connected to: {}:{}, id: {}",
220 endpoint.address().to_string(), endpoint.port(),
221 connId);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000222 if (sslConn)
223 {
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800224 doSslHandshake();
AppaRao Pulie38778a2022-06-27 23:09:03 +0000225 return;
226 }
227 state = ConnState::connected;
228 sendMessage();
229 }
230
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800231 void doSslHandshake()
AppaRao Pulie38778a2022-06-27 23:09:03 +0000232 {
233 if (!sslConn)
234 {
235 return;
236 }
237 state = ConnState::handshakeInProgress;
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800238 timer.expires_after(std::chrono::seconds(30));
239 timer.async_wait(std::bind_front(onTimeout, weak_from_this()));
AppaRao Pulie38778a2022-06-27 23:09:03 +0000240 sslConn->async_handshake(
241 boost::asio::ssl::stream_base::client,
242 std::bind_front(&ConnectionInfo::afterSslHandshake, this,
243 shared_from_this()));
244 }
245
246 void afterSslHandshake(const std::shared_ptr<ConnectionInfo>& /*self*/,
Ed Tanous81c4e332023-05-18 10:30:34 -0700247 const boost::beast::error_code& ec)
AppaRao Pulie38778a2022-06-27 23:09:03 +0000248 {
Carson Labrado513d1ff2022-07-19 00:38:15 +0000249 // The operation already timed out. We don't want do continue down
250 // this branch
251 if (ec && ec == boost::asio::error::operation_aborted)
252 {
253 return;
254 }
255
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800256 timer.cancel();
AppaRao Pulie38778a2022-06-27 23:09:03 +0000257 if (ec)
258 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700259 BMCWEB_LOG_ERROR("SSL Handshake failed - id: {} error: {}", connId,
260 ec.message());
AppaRao Pulie38778a2022-06-27 23:09:03 +0000261 state = ConnState::handshakeFailed;
262 waitAndRetry();
263 return;
264 }
Ed Tanousa716aa72023-08-01 11:35:53 -0700265 BMCWEB_LOG_DEBUG("SSL Handshake successful - id: {}", connId);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000266 state = ConnState::connected;
267 sendMessage();
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530268 }
269
Carson Labradof52c03c2022-03-23 18:50:15 +0000270 void sendMessage()
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530271 {
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530272 state = ConnState::sendInProgress;
273
AppaRao Pulibd030d02020-03-20 03:34:29 +0530274 // Set a timeout on the operation
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800275 timer.expires_after(std::chrono::seconds(30));
276 timer.async_wait(std::bind_front(onTimeout, weak_from_this()));
AppaRao Pulibd030d02020-03-20 03:34:29 +0530277 // Send the HTTP request to the remote host
AppaRao Pulie38778a2022-06-27 23:09:03 +0000278 if (sslConn)
279 {
Ed Tanouscd504a92024-08-19 11:46:20 -0700280 boost::beast::http::async_write(
281 *sslConn, req,
AppaRao Pulie38778a2022-06-27 23:09:03 +0000282 std::bind_front(&ConnectionInfo::afterWrite, this,
283 shared_from_this()));
284 }
285 else
286 {
Ed Tanouscd504a92024-08-19 11:46:20 -0700287 boost::beast::http::async_write(
288 conn, req,
AppaRao Pulie38778a2022-06-27 23:09:03 +0000289 std::bind_front(&ConnectionInfo::afterWrite, this,
290 shared_from_this()));
291 }
292 }
AppaRao Pulibd030d02020-03-20 03:34:29 +0530293
AppaRao Pulie38778a2022-06-27 23:09:03 +0000294 void afterWrite(const std::shared_ptr<ConnectionInfo>& /*self*/,
295 const boost::beast::error_code& ec, size_t bytesTransferred)
296 {
Carson Labrado513d1ff2022-07-19 00:38:15 +0000297 // The operation already timed out. We don't want do continue down
298 // this branch
299 if (ec && ec == boost::asio::error::operation_aborted)
300 {
301 return;
302 }
303
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800304 timer.cancel();
AppaRao Pulie38778a2022-06-27 23:09:03 +0000305 if (ec)
306 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700307 BMCWEB_LOG_ERROR("sendMessage() failed: {} {}", ec.message(), host);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000308 state = ConnState::sendFailed;
309 waitAndRetry();
310 return;
311 }
Ed Tanous62598e32023-07-17 17:06:25 -0700312 BMCWEB_LOG_DEBUG("sendMessage() bytes transferred: {}",
313 bytesTransferred);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000314
315 recvMessage();
AppaRao Pulibd030d02020-03-20 03:34:29 +0530316 }
317
318 void recvMessage()
319 {
Sunitha Harish6eaa1d22021-02-19 13:38:31 +0530320 state = ConnState::recvInProgress;
321
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400322 parser_type& thisParser =
323 parser.emplace(std::piecewise_construct, std::make_tuple());
Carson Labradod14a48f2023-02-22 00:24:54 +0000324
Ed Tanouse01d0c32023-06-30 13:21:32 -0700325 thisParser.body_limit(connPolicy->requestByteLimit);
Sunitha Harish6eaa1d22021-02-19 13:38:31 +0530326
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800327 timer.expires_after(std::chrono::seconds(30));
328 timer.async_wait(std::bind_front(onTimeout, weak_from_this()));
329
AppaRao Pulibd030d02020-03-20 03:34:29 +0530330 // Receive the HTTP response
AppaRao Pulie38778a2022-06-27 23:09:03 +0000331 if (sslConn)
332 {
333 boost::beast::http::async_read(
Ed Tanouse01d0c32023-06-30 13:21:32 -0700334 *sslConn, buffer, thisParser,
AppaRao Pulie38778a2022-06-27 23:09:03 +0000335 std::bind_front(&ConnectionInfo::afterRead, this,
336 shared_from_this()));
337 }
338 else
339 {
340 boost::beast::http::async_read(
Ed Tanouse01d0c32023-06-30 13:21:32 -0700341 conn, buffer, thisParser,
AppaRao Pulie38778a2022-06-27 23:09:03 +0000342 std::bind_front(&ConnectionInfo::afterRead, this,
343 shared_from_this()));
344 }
345 }
AppaRao Pulibd030d02020-03-20 03:34:29 +0530346
AppaRao Pulie38778a2022-06-27 23:09:03 +0000347 void afterRead(const std::shared_ptr<ConnectionInfo>& /*self*/,
348 const boost::beast::error_code& ec,
349 const std::size_t& bytesTransferred)
350 {
Carson Labrado513d1ff2022-07-19 00:38:15 +0000351 // The operation already timed out. We don't want do continue down
352 // this branch
353 if (ec && ec == boost::asio::error::operation_aborted)
354 {
355 return;
356 }
357
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800358 timer.cancel();
AppaRao Pulie38778a2022-06-27 23:09:03 +0000359 if (ec && ec != boost::asio::ssl::error::stream_truncated)
360 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700361 BMCWEB_LOG_ERROR("recvMessage() failed: {} from {}", ec.message(),
362 host);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000363 state = ConnState::recvFailed;
364 waitAndRetry();
365 return;
366 }
Ed Tanous62598e32023-07-17 17:06:25 -0700367 BMCWEB_LOG_DEBUG("recvMessage() bytes transferred: {}",
368 bytesTransferred);
Ed Tanouse01d0c32023-06-30 13:21:32 -0700369 if (!parser)
370 {
371 return;
372 }
Ed Tanous52e31622024-01-23 16:31:11 -0800373 BMCWEB_LOG_DEBUG("recvMessage() data: {}", parser->get().body().str());
AppaRao Pulie38778a2022-06-27 23:09:03 +0000374
375 unsigned int respCode = parser->get().result_int();
Ed Tanous62598e32023-07-17 17:06:25 -0700376 BMCWEB_LOG_DEBUG("recvMessage() Header Response Code: {}", respCode);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000377
Abhilash Rajuf3cb5df2023-11-30 03:54:11 -0600378 // Handle the case of stream_truncated. Some servers close the ssl
379 // connection uncleanly, so check to see if we got a full response
380 // before we handle this as an error.
381 if (!parser->is_done())
382 {
383 state = ConnState::recvFailed;
384 waitAndRetry();
385 return;
386 }
387
AppaRao Pulie38778a2022-06-27 23:09:03 +0000388 // Make sure the received response code is valid as defined by
389 // the associated retry policy
Carson Labradod14a48f2023-02-22 00:24:54 +0000390 if (connPolicy->invalidResp(respCode))
AppaRao Pulie38778a2022-06-27 23:09:03 +0000391 {
392 // The listener failed to receive the Sent-Event
Ed Tanous62598e32023-07-17 17:06:25 -0700393 BMCWEB_LOG_ERROR(
394 "recvMessage() Listener Failed to "
Ed Tanousa716aa72023-08-01 11:35:53 -0700395 "receive Sent-Event. Header Response Code: {} from {}",
396 respCode, host);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000397 state = ConnState::recvFailed;
398 waitAndRetry();
399 return;
400 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700401
AppaRao Pulie38778a2022-06-27 23:09:03 +0000402 // Send is successful
403 // Reset the counter just in case this was after retrying
404 retryCount = 0;
Sunitha Harish6eaa1d22021-02-19 13:38:31 +0530405
AppaRao Pulie38778a2022-06-27 23:09:03 +0000406 // Keep the connection alive if server supports it
407 // Else close the connection
Ed Tanous62598e32023-07-17 17:06:25 -0700408 BMCWEB_LOG_DEBUG("recvMessage() keepalive : {}", parser->keep_alive());
AppaRao Pulibd030d02020-03-20 03:34:29 +0530409
AppaRao Pulie38778a2022-06-27 23:09:03 +0000410 // Copy the response into a Response object so that it can be
411 // processed by the callback function.
Ed Tanous27b0cf92023-08-07 12:02:40 -0700412 res.response = parser->release();
AppaRao Pulie38778a2022-06-27 23:09:03 +0000413 callback(parser->keep_alive(), connId, res);
Carson Labrado513d1ff2022-07-19 00:38:15 +0000414 res.clear();
AppaRao Pulibd030d02020-03-20 03:34:29 +0530415 }
416
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800417 static void onTimeout(const std::weak_ptr<ConnectionInfo>& weakSelf,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800418 const boost::system::error_code& ec)
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800419 {
420 if (ec == boost::asio::error::operation_aborted)
421 {
Ed Tanous62598e32023-07-17 17:06:25 -0700422 BMCWEB_LOG_DEBUG(
423 "async_wait failed since the operation is aborted");
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800424 return;
425 }
426 if (ec)
427 {
Ed Tanous62598e32023-07-17 17:06:25 -0700428 BMCWEB_LOG_ERROR("async_wait failed: {}", ec.message());
Ed Tanous27b0cf92023-08-07 12:02:40 -0700429 // If the timer fails, we need to close the socket anyway, same
430 // as if it expired.
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800431 }
432 std::shared_ptr<ConnectionInfo> self = weakSelf.lock();
433 if (self == nullptr)
434 {
435 return;
436 }
437 self->waitAndRetry();
438 }
439
Sunitha Harish6eaa1d22021-02-19 13:38:31 +0530440 void waitAndRetry()
AppaRao Pulibd030d02020-03-20 03:34:29 +0530441 {
Carson Labradod14a48f2023-02-22 00:24:54 +0000442 if ((retryCount >= connPolicy->maxRetryAttempts) ||
AppaRao Pulie38778a2022-06-27 23:09:03 +0000443 (state == ConnState::sslInitFailed))
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530444 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700445 BMCWEB_LOG_ERROR("Maximum number of retries reached. {}", host);
Ed Tanous62598e32023-07-17 17:06:25 -0700446 BMCWEB_LOG_DEBUG("Retry policy: {}", connPolicy->retryPolicyAction);
Carson Labrado039a47e2022-04-05 16:03:20 +0000447
Carson Labradod14a48f2023-02-22 00:24:54 +0000448 if (connPolicy->retryPolicyAction == "TerminateAfterRetries")
Ayushi Smritife44eb02020-05-15 15:24:45 +0530449 {
450 // TODO: delete subscription
451 state = ConnState::terminated;
Ayushi Smritife44eb02020-05-15 15:24:45 +0530452 }
Carson Labradod14a48f2023-02-22 00:24:54 +0000453 if (connPolicy->retryPolicyAction == "SuspendRetries")
Ayushi Smritife44eb02020-05-15 15:24:45 +0530454 {
455 state = ConnState::suspended;
Ayushi Smritife44eb02020-05-15 15:24:45 +0530456 }
Carson Labrado513d1ff2022-07-19 00:38:15 +0000457
458 // We want to return a 502 to indicate there was an error with
459 // the external server
460 res.result(boost::beast::http::status::bad_gateway);
461 callback(false, connId, res);
462 res.clear();
463
Ed Tanous27b0cf92023-08-07 12:02:40 -0700464 // Reset the retrycount to zero so that client can try
465 // connecting again if needed
Ed Tanous3174e4d2020-10-07 11:41:22 -0700466 retryCount = 0;
Ayushi Smritife44eb02020-05-15 15:24:45 +0530467 return;
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530468 }
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530469
Sunitha Harish6eaa1d22021-02-19 13:38:31 +0530470 retryCount++;
471
Ed Tanous62598e32023-07-17 17:06:25 -0700472 BMCWEB_LOG_DEBUG("Attempt retry after {} seconds. RetryCount = {}",
Ed Tanousa716aa72023-08-01 11:35:53 -0700473 connPolicy->retryIntervalSecs.count(), retryCount);
Carson Labradod14a48f2023-02-22 00:24:54 +0000474 timer.expires_after(connPolicy->retryIntervalSecs);
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700475 timer.async_wait(std::bind_front(&ConnectionInfo::onTimerDone, this,
476 shared_from_this()));
477 }
Sunitha Harish6eaa1d22021-02-19 13:38:31 +0530478
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700479 void onTimerDone(const std::shared_ptr<ConnectionInfo>& /*self*/,
480 const boost::system::error_code& ec)
481 {
482 if (ec == boost::asio::error::operation_aborted)
483 {
Ed Tanous62598e32023-07-17 17:06:25 -0700484 BMCWEB_LOG_DEBUG(
485 "async_wait failed since the operation is aborted{}",
486 ec.message());
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700487 }
488 else if (ec)
489 {
Ed Tanous62598e32023-07-17 17:06:25 -0700490 BMCWEB_LOG_ERROR("async_wait failed: {}", ec.message());
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700491 // Ignore the error and continue the retry loop to attempt
492 // sending the event as per the retry policy
493 }
494
495 // Let's close the connection and restart from resolve.
Abhilash Rajuf3cb5df2023-11-30 03:54:11 -0600496 shutdownConn(true);
497 }
498
499 void restartConnection()
500 {
501 BMCWEB_LOG_DEBUG("{}, id: {} restartConnection", host,
502 std::to_string(connId));
503 initializeConnection(host.scheme() == "https");
504 doResolve();
Ayushi Smritife44eb02020-05-15 15:24:45 +0530505 }
506
AppaRao Pulie38778a2022-06-27 23:09:03 +0000507 void shutdownConn(bool retry)
Ayushi Smritife44eb02020-05-15 15:24:45 +0530508 {
Carson Labradof52c03c2022-03-23 18:50:15 +0000509 boost::beast::error_code ec;
Ed Tanous0d5f5cf2022-03-12 15:30:55 -0800510 conn.shutdown(boost::asio::ip::tcp::socket::shutdown_both, ec);
Carson Labradof52c03c2022-03-23 18:50:15 +0000511 conn.close();
512
513 // not_connected happens sometimes so don't bother reporting it.
514 if (ec && ec != boost::beast::errc::not_connected)
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530515 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700516 BMCWEB_LOG_ERROR("{}, id: {} shutdown failed: {}", host, connId,
Ed Tanous62598e32023-07-17 17:06:25 -0700517 ec.message());
Carson Labradof52c03c2022-03-23 18:50:15 +0000518 }
Carson Labrado5cab68f2022-07-11 22:26:21 +0000519 else
520 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700521 BMCWEB_LOG_DEBUG("{}, id: {} closed gracefully", host, connId);
Carson Labrado5cab68f2022-07-11 22:26:21 +0000522 }
Ed Tanousca723762022-06-28 19:40:39 -0700523
Carson Labrado513d1ff2022-07-19 00:38:15 +0000524 if (retry)
AppaRao Pulie38778a2022-06-27 23:09:03 +0000525 {
Carson Labrado513d1ff2022-07-19 00:38:15 +0000526 // Now let's try to resend the data
527 state = ConnState::retry;
Abhilash Rajuf3cb5df2023-11-30 03:54:11 -0600528 restartConnection();
Carson Labrado513d1ff2022-07-19 00:38:15 +0000529 }
530 else
531 {
532 state = ConnState::closed;
AppaRao Pulie38778a2022-06-27 23:09:03 +0000533 }
Carson Labradof52c03c2022-03-23 18:50:15 +0000534 }
535
AppaRao Pulie38778a2022-06-27 23:09:03 +0000536 void doClose(bool retry = false)
Carson Labradof52c03c2022-03-23 18:50:15 +0000537 {
AppaRao Pulie38778a2022-06-27 23:09:03 +0000538 if (!sslConn)
539 {
540 shutdownConn(retry);
541 return;
542 }
Carson Labradof52c03c2022-03-23 18:50:15 +0000543
AppaRao Pulie38778a2022-06-27 23:09:03 +0000544 sslConn->async_shutdown(
545 std::bind_front(&ConnectionInfo::afterSslShutdown, this,
546 shared_from_this(), retry));
547 }
548
549 void afterSslShutdown(const std::shared_ptr<ConnectionInfo>& /*self*/,
550 bool retry, const boost::system::error_code& ec)
551 {
AppaRao Pulie38778a2022-06-27 23:09:03 +0000552 if (ec)
Carson Labradof52c03c2022-03-23 18:50:15 +0000553 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700554 BMCWEB_LOG_ERROR("{}, id: {} shutdown failed: {}", host, connId,
Ed Tanous62598e32023-07-17 17:06:25 -0700555 ec.message());
Carson Labradof52c03c2022-03-23 18:50:15 +0000556 }
Carson Labrado5cab68f2022-07-11 22:26:21 +0000557 else
558 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700559 BMCWEB_LOG_DEBUG("{}, id: {} closed gracefully", host, connId);
Carson Labrado5cab68f2022-07-11 22:26:21 +0000560 }
AppaRao Pulie38778a2022-06-27 23:09:03 +0000561 shutdownConn(retry);
562 }
Ed Tanousca723762022-06-28 19:40:39 -0700563
AppaRao Pulie38778a2022-06-27 23:09:03 +0000564 void setCipherSuiteTLSext()
565 {
566 if (!sslConn)
567 {
568 return;
569 }
Ravi Tejae7c29912023-07-31 09:39:32 -0500570
571 if (host.host_type() != boost::urls::host_type::name)
572 {
573 // Avoid setting SNI hostname if its IP address
574 return;
575 }
576 // Create a null terminated string for SSL
Ed Tanousa716aa72023-08-01 11:35:53 -0700577 std::string hostname(host.encoded_host_address());
AppaRao Pulie38778a2022-06-27 23:09:03 +0000578 // NOTE: The SSL_set_tlsext_host_name is defined in tlsv1.h header
579 // file but its having old style casting (name is cast to void*).
580 // Since bmcweb compiler treats all old-style-cast as error, its
581 // causing the build failure. So replaced the same macro inline and
582 // did corrected the code by doing static_cast to viod*. This has to
583 // be fixed in openssl library in long run. Set SNI Hostname (many
584 // hosts need this to handshake successfully)
585 if (SSL_ctrl(sslConn->native_handle(), SSL_CTRL_SET_TLSEXT_HOSTNAME,
586 TLSEXT_NAMETYPE_host_name,
Ed Tanousa716aa72023-08-01 11:35:53 -0700587 static_cast<void*>(hostname.data())) == 0)
AppaRao Pulie38778a2022-06-27 23:09:03 +0000588
589 {
590 boost::beast::error_code ec{static_cast<int>(::ERR_get_error()),
591 boost::asio::error::get_ssl_category()};
592
Ed Tanousa716aa72023-08-01 11:35:53 -0700593 BMCWEB_LOG_ERROR("SSL_set_tlsext_host_name {}, id: {} failed: {}",
594 host, connId, ec.message());
AppaRao Pulie38778a2022-06-27 23:09:03 +0000595 // Set state as sslInit failed so that we close the connection
596 // and take appropriate action as per retry configuration.
597 state = ConnState::sslInitFailed;
598 waitAndRetry();
599 return;
600 }
AppaRao Pulibd030d02020-03-20 03:34:29 +0530601 }
602
Abhilash Rajuf3cb5df2023-11-30 03:54:11 -0600603 void initializeConnection(bool ssl)
AppaRao Pulie38778a2022-06-27 23:09:03 +0000604 {
Abhilash Rajuf3cb5df2023-11-30 03:54:11 -0600605 conn = boost::asio::ip::tcp::socket(ioc);
606 if (ssl)
AppaRao Pulie38778a2022-06-27 23:09:03 +0000607 {
608 std::optional<boost::asio::ssl::context> sslCtx =
Ed Tanous19bb3622024-07-05 10:07:40 -0500609 ensuressl::getSSLClientContext(verifyCert);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000610
611 if (!sslCtx)
612 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700613 BMCWEB_LOG_ERROR("prepareSSLContext failed - {}, id: {}", host,
614 connId);
AppaRao Pulie38778a2022-06-27 23:09:03 +0000615 // Don't retry if failure occurs while preparing SSL context
Ed Tanous27b0cf92023-08-07 12:02:40 -0700616 // such as certificate is invalid or set cipher failure or
617 // set host name failure etc... Setting conn state to
618 // sslInitFailed and connection state will be transitioned
619 // to next state depending on retry policy set by
620 // subscription.
AppaRao Pulie38778a2022-06-27 23:09:03 +0000621 state = ConnState::sslInitFailed;
622 waitAndRetry();
623 return;
624 }
625 sslConn.emplace(conn, *sslCtx);
626 setCipherSuiteTLSext();
627 }
628 }
Abhilash Rajuf3cb5df2023-11-30 03:54:11 -0600629
630 public:
631 explicit ConnectionInfo(
632 boost::asio::io_context& iocIn, const std::string& idIn,
633 const std::shared_ptr<ConnectionPolicy>& connPolicyIn,
Ed Tanous19bb3622024-07-05 10:07:40 -0500634 const boost::urls::url_view_base& hostIn,
635 ensuressl::VerifyCertificate verifyCertIn, unsigned int connIdIn) :
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400636 subId(idIn), connPolicy(connPolicyIn), host(hostIn),
637 verifyCert(verifyCertIn), connId(connIdIn), ioc(iocIn), resolver(iocIn),
638 conn(iocIn), timer(iocIn)
Abhilash Rajuf3cb5df2023-11-30 03:54:11 -0600639 {
640 initializeConnection(host.scheme() == "https");
641 }
Carson Labradof52c03c2022-03-23 18:50:15 +0000642};
AppaRao Pulibd030d02020-03-20 03:34:29 +0530643
Carson Labradof52c03c2022-03-23 18:50:15 +0000644class ConnectionPool : public std::enable_shared_from_this<ConnectionPool>
645{
646 private:
647 boost::asio::io_context& ioc;
AppaRao Pulie38778a2022-06-27 23:09:03 +0000648 std::string id;
Carson Labradod14a48f2023-02-22 00:24:54 +0000649 std::shared_ptr<ConnectionPolicy> connPolicy;
Ed Tanousa716aa72023-08-01 11:35:53 -0700650 boost::urls::url destIP;
Carson Labradof52c03c2022-03-23 18:50:15 +0000651 std::vector<std::shared_ptr<ConnectionInfo>> connections;
652 boost::container::devector<PendingRequest> requestQueue;
Ed Tanous19bb3622024-07-05 10:07:40 -0500653 ensuressl::VerifyCertificate verifyCert;
Carson Labradof52c03c2022-03-23 18:50:15 +0000654
655 friend class HttpClient;
656
Carson Labrado244256c2022-04-27 17:16:32 +0000657 // Configure a connections's request, callback, and retry info in
658 // preparation to begin sending the request
Carson Labradof52c03c2022-03-23 18:50:15 +0000659 void setConnProps(ConnectionInfo& conn)
AppaRao Pulibd030d02020-03-20 03:34:29 +0530660 {
Carson Labradof52c03c2022-03-23 18:50:15 +0000661 if (requestQueue.empty())
AppaRao Pulibd030d02020-03-20 03:34:29 +0530662 {
Ed Tanous62598e32023-07-17 17:06:25 -0700663 BMCWEB_LOG_ERROR(
664 "setConnProps() should not have been called when requestQueue is empty");
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530665 return;
AppaRao Pulibd030d02020-03-20 03:34:29 +0530666 }
AppaRao Pulibd030d02020-03-20 03:34:29 +0530667
Ed Tanous52e31622024-01-23 16:31:11 -0800668 PendingRequest& nextReq = requestQueue.front();
Carson Labrado244256c2022-04-27 17:16:32 +0000669 conn.req = std::move(nextReq.req);
670 conn.callback = std::move(nextReq.callback);
Carson Labradof52c03c2022-03-23 18:50:15 +0000671
Ed Tanousa716aa72023-08-01 11:35:53 -0700672 BMCWEB_LOG_DEBUG("Setting properties for connection {}, id: {}",
673 conn.host, conn.connId);
Carson Labradof52c03c2022-03-23 18:50:15 +0000674
675 // We can remove the request from the queue at this point
676 requestQueue.pop_front();
677 }
678
Carson Labradof52c03c2022-03-23 18:50:15 +0000679 // Gets called as part of callback after request is sent
680 // Reuses the connection if there are any requests waiting to be sent
681 // Otherwise closes the connection if it is not a keep-alive
682 void sendNext(bool keepAlive, uint32_t connId)
683 {
684 auto conn = connections[connId];
Carson Labrado46a81462022-04-27 21:11:37 +0000685
686 // Allow the connection's handler to be deleted
687 // This is needed because of Redfish Aggregation passing an
688 // AsyncResponse shared_ptr to this callback
689 conn->callback = nullptr;
690
Carson Labradof52c03c2022-03-23 18:50:15 +0000691 // Reuse the connection to send the next request in the queue
692 if (!requestQueue.empty())
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530693 {
Ed Tanous62598e32023-07-17 17:06:25 -0700694 BMCWEB_LOG_DEBUG(
Ed Tanous8ece0e42024-01-02 13:16:50 -0800695 "{} requests remaining in queue for {}, reusing connection {}",
Ed Tanousa716aa72023-08-01 11:35:53 -0700696 requestQueue.size(), destIP, connId);
Carson Labradof52c03c2022-03-23 18:50:15 +0000697
698 setConnProps(*conn);
699
700 if (keepAlive)
701 {
702 conn->sendMessage();
703 }
704 else
705 {
706 // Server is not keep-alive enabled so we need to close the
707 // connection and then start over from resolve
708 conn->doClose();
Abhilash Raju2ecde742024-06-01 02:01:01 -0500709 conn->restartConnection();
Carson Labradof52c03c2022-03-23 18:50:15 +0000710 }
711 return;
712 }
713
714 // No more messages to send so close the connection if necessary
715 if (keepAlive)
716 {
717 conn->state = ConnState::idle;
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530718 }
719 else
720 {
Carson Labradof52c03c2022-03-23 18:50:15 +0000721 // Abort the connection since server is not keep-alive enabled
722 conn->state = ConnState::abortConnection;
723 conn->doClose();
AppaRao Puli2a5689a2020-04-29 15:24:31 +0530724 }
AppaRao Pulibd030d02020-03-20 03:34:29 +0530725 }
726
Ed Tanous4a7fbef2024-04-06 16:03:49 -0700727 void sendData(std::string&& data, const boost::urls::url_view_base& destUri,
Carson Labrado244256c2022-04-27 17:16:32 +0000728 const boost::beast::http::fields& httpHeader,
729 const boost::beast::http::verb verb,
Ed Tanous6b3db602022-06-28 19:41:44 -0700730 const std::function<void(Response&)>& resHandler)
Ayushi Smritife44eb02020-05-15 15:24:45 +0530731 {
Carson Labrado244256c2022-04-27 17:16:32 +0000732 // Construct the request to be sent
Ed Tanousb2896142024-01-31 15:25:47 -0800733 boost::beast::http::request<bmcweb::HttpBody> thisReq(
Ed Tanousa716aa72023-08-01 11:35:53 -0700734 verb, destUri.encoded_target(), 11, "", httpHeader);
735 thisReq.set(boost::beast::http::field::host,
736 destUri.encoded_host_address());
Carson Labrado244256c2022-04-27 17:16:32 +0000737 thisReq.keep_alive(true);
Ed Tanous52e31622024-01-23 16:31:11 -0800738 thisReq.body().str() = std::move(data);
Carson Labrado244256c2022-04-27 17:16:32 +0000739 thisReq.prepare_payload();
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700740 auto cb = std::bind_front(&ConnectionPool::afterSendData,
741 weak_from_this(), resHandler);
Carson Labradof52c03c2022-03-23 18:50:15 +0000742 // Reuse an existing connection if one is available
743 for (unsigned int i = 0; i < connections.size(); i++)
744 {
745 auto conn = connections[i];
746 if ((conn->state == ConnState::idle) ||
747 (conn->state == ConnState::initialized) ||
748 (conn->state == ConnState::closed))
749 {
Carson Labrado244256c2022-04-27 17:16:32 +0000750 conn->req = std::move(thisReq);
Carson Labradof52c03c2022-03-23 18:50:15 +0000751 conn->callback = std::move(cb);
Ed Tanousa716aa72023-08-01 11:35:53 -0700752 std::string commonMsg = std::format("{} from pool {}", i, id);
Carson Labradof52c03c2022-03-23 18:50:15 +0000753
754 if (conn->state == ConnState::idle)
755 {
Ed Tanous62598e32023-07-17 17:06:25 -0700756 BMCWEB_LOG_DEBUG("Grabbing idle connection {}", commonMsg);
Carson Labradof52c03c2022-03-23 18:50:15 +0000757 conn->sendMessage();
758 }
759 else
760 {
Ed Tanous62598e32023-07-17 17:06:25 -0700761 BMCWEB_LOG_DEBUG("Reusing existing connection {}",
762 commonMsg);
Abhilash Raju2ecde742024-06-01 02:01:01 -0500763 conn->restartConnection();
Carson Labradof52c03c2022-03-23 18:50:15 +0000764 }
765 return;
766 }
767 }
768
Ed Tanous27b0cf92023-08-07 12:02:40 -0700769 // All connections in use so create a new connection or add request
770 // to the queue
Carson Labradod14a48f2023-02-22 00:24:54 +0000771 if (connections.size() < connPolicy->maxConnections)
Carson Labradof52c03c2022-03-23 18:50:15 +0000772 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700773 BMCWEB_LOG_DEBUG("Adding new connection to pool {}", id);
Carson Labradof52c03c2022-03-23 18:50:15 +0000774 auto conn = addConnection();
Carson Labrado244256c2022-04-27 17:16:32 +0000775 conn->req = std::move(thisReq);
Carson Labradof52c03c2022-03-23 18:50:15 +0000776 conn->callback = std::move(cb);
Carson Labradof52c03c2022-03-23 18:50:15 +0000777 conn->doResolve();
778 }
779 else if (requestQueue.size() < maxRequestQueueSize)
780 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700781 BMCWEB_LOG_DEBUG("Max pool size reached. Adding data to queue {}",
782 id);
Carson Labradod14a48f2023-02-22 00:24:54 +0000783 requestQueue.emplace_back(std::move(thisReq), std::move(cb));
Carson Labradof52c03c2022-03-23 18:50:15 +0000784 }
785 else
786 {
Ed Tanous27b0cf92023-08-07 12:02:40 -0700787 // If we can't buffer the request then we should let the
788 // callback handle a 429 Too Many Requests dummy response
Ed Tanous6ea90762024-04-07 08:38:44 -0700789 BMCWEB_LOG_ERROR("{} request queue full. Dropping request.", id);
Carson Labrado43e14d32022-11-09 00:25:20 +0000790 Response dummyRes;
791 dummyRes.result(boost::beast::http::status::too_many_requests);
792 resHandler(dummyRes);
Carson Labradof52c03c2022-03-23 18:50:15 +0000793 }
Ayushi Smritife44eb02020-05-15 15:24:45 +0530794 }
795
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700796 // Callback to be called once the request has been sent
797 static void afterSendData(const std::weak_ptr<ConnectionPool>& weakSelf,
798 const std::function<void(Response&)>& resHandler,
799 bool keepAlive, uint32_t connId, Response& res)
800 {
801 // Allow provided callback to perform additional processing of the
802 // request
803 resHandler(res);
804
805 // If requests remain in the queue then we want to reuse this
806 // connection to send the next request
807 std::shared_ptr<ConnectionPool> self = weakSelf.lock();
808 if (!self)
809 {
Ed Tanous62598e32023-07-17 17:06:25 -0700810 BMCWEB_LOG_CRITICAL("{} Failed to capture connection",
811 logPtr(self.get()));
Ed Tanous3d36e3a2022-08-19 15:54:04 -0700812 return;
813 }
814
815 self->sendNext(keepAlive, connId);
816 }
817
Carson Labradof52c03c2022-03-23 18:50:15 +0000818 std::shared_ptr<ConnectionInfo>& addConnection()
Ayushi Smritife44eb02020-05-15 15:24:45 +0530819 {
Carson Labradof52c03c2022-03-23 18:50:15 +0000820 unsigned int newId = static_cast<unsigned int>(connections.size());
821
AppaRao Pulie38778a2022-06-27 23:09:03 +0000822 auto& ret = connections.emplace_back(std::make_shared<ConnectionInfo>(
Ed Tanous19bb3622024-07-05 10:07:40 -0500823 ioc, id, connPolicy, destIP, verifyCert, newId));
Carson Labradof52c03c2022-03-23 18:50:15 +0000824
Ed Tanousa716aa72023-08-01 11:35:53 -0700825 BMCWEB_LOG_DEBUG("Added connection {} to pool {}",
826 connections.size() - 1, id);
Carson Labradof52c03c2022-03-23 18:50:15 +0000827
828 return ret;
829 }
830
831 public:
Carson Labradod14a48f2023-02-22 00:24:54 +0000832 explicit ConnectionPool(
833 boost::asio::io_context& iocIn, const std::string& idIn,
834 const std::shared_ptr<ConnectionPolicy>& connPolicyIn,
Ed Tanous19bb3622024-07-05 10:07:40 -0500835 const boost::urls::url_view_base& destIPIn,
836 ensuressl::VerifyCertificate verifyCertIn) :
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400837 ioc(iocIn), id(idIn), connPolicy(connPolicyIn), destIP(destIPIn),
Ed Tanous19bb3622024-07-05 10:07:40 -0500838 verifyCert(verifyCertIn)
Carson Labradof52c03c2022-03-23 18:50:15 +0000839 {
Ed Tanousa716aa72023-08-01 11:35:53 -0700840 BMCWEB_LOG_DEBUG("Initializing connection pool for {}", id);
Carson Labradof52c03c2022-03-23 18:50:15 +0000841
842 // Initialize the pool with a single connection
843 addConnection();
Ayushi Smritife44eb02020-05-15 15:24:45 +0530844 }
AppaRao Pulibd030d02020-03-20 03:34:29 +0530845};
846
Carson Labradof52c03c2022-03-23 18:50:15 +0000847class HttpClient
848{
849 private:
850 std::unordered_map<std::string, std::shared_ptr<ConnectionPool>>
851 connectionPools;
Ed Tanousf8ca6d72022-06-28 12:12:03 -0700852 boost::asio::io_context& ioc;
Carson Labradod14a48f2023-02-22 00:24:54 +0000853 std::shared_ptr<ConnectionPolicy> connPolicy;
Carson Labradof52c03c2022-03-23 18:50:15 +0000854
Carson Labrado039a47e2022-04-05 16:03:20 +0000855 // Used as a dummy callback by sendData() in order to call
856 // sendDataWithCallback()
Ed Tanous02cad962022-06-30 16:50:15 -0700857 static void genericResHandler(const Response& res)
Carson Labrado039a47e2022-04-05 16:03:20 +0000858 {
Ed Tanous62598e32023-07-17 17:06:25 -0700859 BMCWEB_LOG_DEBUG("Response handled with return code: {}",
Ed Tanousa716aa72023-08-01 11:35:53 -0700860 res.resultInt());
Ed Tanous4ee8e212022-05-28 09:42:51 -0700861 }
Carson Labrado039a47e2022-04-05 16:03:20 +0000862
Carson Labradof52c03c2022-03-23 18:50:15 +0000863 public:
Carson Labradod14a48f2023-02-22 00:24:54 +0000864 HttpClient() = delete;
Ed Tanousf8ca6d72022-06-28 12:12:03 -0700865 explicit HttpClient(boost::asio::io_context& iocIn,
866 const std::shared_ptr<ConnectionPolicy>& connPolicyIn) :
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400867 ioc(iocIn), connPolicy(connPolicyIn)
Carson Labradod14a48f2023-02-22 00:24:54 +0000868 {}
Ed Tanousf8ca6d72022-06-28 12:12:03 -0700869
Carson Labradof52c03c2022-03-23 18:50:15 +0000870 HttpClient(const HttpClient&) = delete;
871 HttpClient& operator=(const HttpClient&) = delete;
872 HttpClient(HttpClient&&) = delete;
873 HttpClient& operator=(HttpClient&&) = delete;
874 ~HttpClient() = default;
875
Ed Tanousa716aa72023-08-01 11:35:53 -0700876 // Send a request to destIP where additional processing of the
Carson Labrado039a47e2022-04-05 16:03:20 +0000877 // result is not required
Ed Tanous4a7fbef2024-04-06 16:03:49 -0700878 void sendData(std::string&& data, const boost::urls::url_view_base& destUri,
Ed Tanous19bb3622024-07-05 10:07:40 -0500879 ensuressl::VerifyCertificate verifyCert,
Carson Labradof52c03c2022-03-23 18:50:15 +0000880 const boost::beast::http::fields& httpHeader,
Carson Labradod14a48f2023-02-22 00:24:54 +0000881 const boost::beast::http::verb verb)
Carson Labradof52c03c2022-03-23 18:50:15 +0000882 {
AppaRao Pulie38778a2022-06-27 23:09:03 +0000883 const std::function<void(Response&)> cb = genericResHandler;
Ed Tanous19bb3622024-07-05 10:07:40 -0500884 sendDataWithCallback(std::move(data), destUri, verifyCert, httpHeader,
885 verb, cb);
Carson Labrado039a47e2022-04-05 16:03:20 +0000886 }
887
Ed Tanousa716aa72023-08-01 11:35:53 -0700888 // Send request to destIP and use the provided callback to
Carson Labrado039a47e2022-04-05 16:03:20 +0000889 // handle the response
Ed Tanous4a7fbef2024-04-06 16:03:49 -0700890 void sendDataWithCallback(std::string&& data,
891 const boost::urls::url_view_base& destUrl,
Ed Tanous19bb3622024-07-05 10:07:40 -0500892 ensuressl::VerifyCertificate verifyCert,
Carson Labrado039a47e2022-04-05 16:03:20 +0000893 const boost::beast::http::fields& httpHeader,
Carson Labrado244256c2022-04-27 17:16:32 +0000894 const boost::beast::http::verb verb,
Ed Tanous6b3db602022-06-28 19:41:44 -0700895 const std::function<void(Response&)>& resHandler)
Carson Labrado039a47e2022-04-05 16:03:20 +0000896 {
Ed Tanous19bb3622024-07-05 10:07:40 -0500897 std::string_view verify = "ssl_verify";
898 if (verifyCert == ensuressl::VerifyCertificate::NoVerify)
899 {
900 verify = "ssl no verify";
901 }
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400902 std::string clientKey =
903 std::format("{}{}://{}", verify, destUrl.scheme(),
904 destUrl.encoded_host_and_port());
Carson Labradod14a48f2023-02-22 00:24:54 +0000905 auto pool = connectionPools.try_emplace(clientKey);
906 if (pool.first->second == nullptr)
Carson Labradof52c03c2022-03-23 18:50:15 +0000907 {
Carson Labradod14a48f2023-02-22 00:24:54 +0000908 pool.first->second = std::make_shared<ConnectionPool>(
Ed Tanous19bb3622024-07-05 10:07:40 -0500909 ioc, clientKey, connPolicy, destUrl, verifyCert);
Carson Labradof52c03c2022-03-23 18:50:15 +0000910 }
Ed Tanous27b0cf92023-08-07 12:02:40 -0700911 // Send the data using either the existing connection pool or the
912 // newly created connection pool
Ed Tanousa716aa72023-08-01 11:35:53 -0700913 pool.first->second->sendData(std::move(data), destUrl, httpHeader, verb,
Carson Labradod14a48f2023-02-22 00:24:54 +0000914 resHandler);
Carson Labradof52c03c2022-03-23 18:50:15 +0000915 }
916};
AppaRao Pulibd030d02020-03-20 03:34:29 +0530917} // namespace crow