mirror of
https://github.com/XRPLF/rippled.git
synced 2026-06-03 08:46:46 +00:00
667 lines
19 KiB
C++
667 lines
19 KiB
C++
#include <test/jtx/envconfig.h>
|
|
|
|
#include <xrpl/basics/make_SSLContext.h>
|
|
#include <xrpl/beast/core/CurrentThreadName.h>
|
|
#include <xrpl/beast/unit_test/suite.h>
|
|
|
|
#include <boost/asio/basic_waitable_timer.hpp>
|
|
#include <boost/asio/bind_executor.hpp>
|
|
#include <boost/asio/buffer.hpp>
|
|
#include <boost/asio/error.hpp>
|
|
#include <boost/asio/executor_work_guard.hpp>
|
|
#include <boost/asio/io_context.hpp>
|
|
#include <boost/asio/ip/address.hpp>
|
|
#include <boost/asio/ip/tcp.hpp>
|
|
#include <boost/asio/post.hpp>
|
|
#include <boost/asio/read_until.hpp>
|
|
#include <boost/asio/ssl/context.hpp>
|
|
#include <boost/asio/ssl/stream.hpp>
|
|
#include <boost/asio/strand.hpp>
|
|
#include <boost/asio/streambuf.hpp>
|
|
#include <boost/asio/write.hpp>
|
|
#include <boost/optional/optional.hpp>
|
|
#include <boost/system/detail/error_code.hpp>
|
|
|
|
#include <cassert>
|
|
#include <chrono>
|
|
#include <condition_variable>
|
|
#include <cstddef>
|
|
#include <functional>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <mutex>
|
|
#include <ostream>
|
|
#include <string>
|
|
#include <thread>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
namespace xrpl {
|
|
/*
|
|
|
|
Findings from the test:
|
|
|
|
If the remote host calls async_shutdown then the local host's
|
|
async_read will complete with eof.
|
|
|
|
If both hosts call async_shutdown then the calls to async_shutdown
|
|
will complete with eof.
|
|
|
|
*/
|
|
|
|
class short_read_test : public beast::unit_test::suite
|
|
{
|
|
private:
|
|
using io_context_type = boost::asio::io_context;
|
|
using strand_type = boost::asio::strand<io_context_type::executor_type>;
|
|
using timer_type = boost::asio::basic_waitable_timer<std::chrono::steady_clock>;
|
|
using acceptor_type = boost::asio::ip::tcp::acceptor;
|
|
using socket_type = boost::asio::ip::tcp::socket;
|
|
using stream_type = boost::asio::ssl::stream<socket_type&>;
|
|
using error_code = boost::system::error_code;
|
|
using endpoint_type = boost::asio::ip::tcp::endpoint;
|
|
using address_type = boost::asio::ip::address;
|
|
|
|
io_context_type io_context_;
|
|
boost::optional<boost::asio::executor_work_guard<boost::asio::io_context::executor_type>> work_;
|
|
std::thread thread_;
|
|
std::shared_ptr<boost::asio::ssl::context> context_;
|
|
|
|
template <class Streambuf>
|
|
static void
|
|
write(Streambuf& sb, std::string const& s)
|
|
{
|
|
using boost::asio::buffer;
|
|
using boost::asio::buffer_copy;
|
|
using boost::asio::buffer_size;
|
|
boost::asio::const_buffer const buf(s.data(), s.size());
|
|
sb.commit(buffer_copy(sb.prepare(buffer_size(buf)), buf));
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
|
|
class Base
|
|
{
|
|
protected:
|
|
class Child
|
|
{
|
|
private:
|
|
Base& base_;
|
|
|
|
public:
|
|
explicit Child(Base& base) : base_(base)
|
|
{
|
|
}
|
|
|
|
virtual ~Child()
|
|
{
|
|
base_.remove(this);
|
|
}
|
|
|
|
virtual void
|
|
close() = 0;
|
|
};
|
|
|
|
private:
|
|
std::mutex mutex_;
|
|
std::condition_variable cond_;
|
|
std::map<Child*, std::weak_ptr<Child>> list_;
|
|
bool closed_ = false;
|
|
|
|
public:
|
|
~Base()
|
|
{
|
|
// Derived class must call wait() in the destructor
|
|
assert(list_.empty());
|
|
}
|
|
|
|
void
|
|
add(std::shared_ptr<Child> const& child)
|
|
{
|
|
std::scoped_lock const lock(mutex_);
|
|
list_.emplace(child.get(), child);
|
|
}
|
|
|
|
void
|
|
remove(Child* child)
|
|
{
|
|
std::scoped_lock const lock(mutex_);
|
|
list_.erase(child);
|
|
if (list_.empty())
|
|
cond_.notify_one();
|
|
}
|
|
|
|
void
|
|
close()
|
|
{
|
|
std::vector<std::shared_ptr<Child>> v;
|
|
{
|
|
std::scoped_lock const lock(mutex_);
|
|
v.reserve(list_.size());
|
|
if (closed_)
|
|
return;
|
|
closed_ = true;
|
|
for (auto const& c : list_)
|
|
{
|
|
if (auto p = c.second.lock())
|
|
{
|
|
p->close();
|
|
// Must destroy shared_ptr outside the
|
|
// lock otherwise deadlock from the
|
|
// managed object's destructor.
|
|
v.emplace_back(std::move(p));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void
|
|
wait()
|
|
{
|
|
std::unique_lock<std::mutex> lock(mutex_);
|
|
while (!list_.empty())
|
|
cond_.wait(lock);
|
|
}
|
|
};
|
|
|
|
//--------------------------------------------------------------------------
|
|
|
|
class Server : public Base
|
|
{
|
|
private:
|
|
short_read_test& test_;
|
|
endpoint_type endpoint_;
|
|
|
|
struct Acceptor : Child, std::enable_shared_from_this<Acceptor>
|
|
{
|
|
Server& server_;
|
|
short_read_test& test_;
|
|
acceptor_type acceptor_;
|
|
socket_type socket_;
|
|
strand_type strand_;
|
|
|
|
explicit Acceptor(Server& server)
|
|
: Child(server)
|
|
, server_(server)
|
|
, test_(server_.test_)
|
|
, acceptor_(
|
|
test_.io_context_,
|
|
endpoint_type(boost::asio::ip::make_address(test::getEnvLocalhostAddr()), 0))
|
|
, socket_(test_.io_context_)
|
|
, strand_(boost::asio::make_strand(test_.io_context_))
|
|
{
|
|
acceptor_.listen();
|
|
server_.endpoint_ = acceptor_.local_endpoint();
|
|
}
|
|
|
|
void
|
|
close() override
|
|
{
|
|
if (!strand_.running_in_this_thread())
|
|
{
|
|
post(strand_, std::bind(&Acceptor::close, shared_from_this()));
|
|
return;
|
|
}
|
|
acceptor_.close();
|
|
}
|
|
|
|
void
|
|
run()
|
|
{
|
|
acceptor_.async_accept(
|
|
socket_,
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Acceptor::on_accept, shared_from_this(), std::placeholders::_1)));
|
|
}
|
|
|
|
void
|
|
fail(std::string const& what, error_code ec)
|
|
{
|
|
if (acceptor_.is_open())
|
|
{
|
|
if (ec != boost::asio::error::operation_aborted)
|
|
test_.log << what << ": " << ec.message() << std::endl;
|
|
acceptor_.close();
|
|
}
|
|
}
|
|
|
|
void
|
|
on_accept(error_code ec)
|
|
{
|
|
if (ec)
|
|
{
|
|
fail("accept", ec);
|
|
return;
|
|
}
|
|
auto const p = std::make_shared<Connection>(server_, std::move(socket_));
|
|
server_.add(p);
|
|
p->run();
|
|
acceptor_.async_accept(
|
|
socket_,
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Acceptor::on_accept, shared_from_this(), std::placeholders::_1)));
|
|
}
|
|
};
|
|
|
|
struct Connection : Child, std::enable_shared_from_this<Connection>
|
|
{
|
|
Server& server_;
|
|
short_read_test& test_;
|
|
socket_type socket_;
|
|
stream_type stream_;
|
|
strand_type strand_;
|
|
timer_type timer_;
|
|
boost::asio::streambuf buf_;
|
|
|
|
Connection(Server& server, socket_type&& socket)
|
|
: Child(server)
|
|
, server_(server)
|
|
, test_(server_.test_)
|
|
, socket_(std::move(socket))
|
|
, stream_(socket_, *test_.context_)
|
|
, strand_(boost::asio::make_strand(test_.io_context_))
|
|
, timer_(test_.io_context_)
|
|
{
|
|
}
|
|
|
|
void
|
|
close() override
|
|
{
|
|
if (!strand_.running_in_this_thread())
|
|
{
|
|
post(strand_, std::bind(&Connection::close, shared_from_this()));
|
|
return;
|
|
}
|
|
if (socket_.is_open())
|
|
{
|
|
socket_.close();
|
|
timer_.cancel();
|
|
}
|
|
}
|
|
|
|
void
|
|
run()
|
|
{
|
|
timer_.expires_after(std::chrono::seconds(3));
|
|
timer_.async_wait(bind_executor(
|
|
strand_,
|
|
std::bind(&Connection::on_timer, shared_from_this(), std::placeholders::_1)));
|
|
stream_.async_handshake(
|
|
stream_type::server,
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_handshake, shared_from_this(), std::placeholders::_1)));
|
|
}
|
|
|
|
void
|
|
fail(std::string const& what, error_code ec)
|
|
{
|
|
if (socket_.is_open())
|
|
{
|
|
if (ec != boost::asio::error::operation_aborted)
|
|
test_.log << "[server] " << what << ": " << ec.message() << std::endl;
|
|
socket_.close();
|
|
timer_.cancel();
|
|
}
|
|
}
|
|
|
|
void
|
|
on_timer(error_code ec)
|
|
{
|
|
if (ec == boost::asio::error::operation_aborted)
|
|
return;
|
|
if (ec)
|
|
{
|
|
fail("timer", ec);
|
|
return;
|
|
}
|
|
test_.log << "[server] timeout" << std::endl;
|
|
socket_.close();
|
|
}
|
|
|
|
void
|
|
on_handshake(error_code ec)
|
|
{
|
|
if (ec)
|
|
{
|
|
fail("handshake", ec);
|
|
return;
|
|
}
|
|
#if 1
|
|
boost::asio::async_read_until(
|
|
stream_,
|
|
buf_,
|
|
"\n",
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_read,
|
|
shared_from_this(),
|
|
std::placeholders::_1,
|
|
std::placeholders::_2)));
|
|
#else
|
|
close();
|
|
#endif
|
|
}
|
|
|
|
void
|
|
on_read(error_code ec, std::size_t bytes_transferred)
|
|
{
|
|
if (ec == boost::asio::error::eof)
|
|
{
|
|
server_.test_.log << "[server] read: EOF" << std::endl;
|
|
stream_.async_shutdown(bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_shutdown, shared_from_this(), std::placeholders::_1)));
|
|
return;
|
|
}
|
|
if (ec)
|
|
{
|
|
fail("read", ec);
|
|
return;
|
|
}
|
|
|
|
buf_.commit(bytes_transferred);
|
|
buf_.consume(bytes_transferred);
|
|
write(buf_, "BYE\n");
|
|
boost::asio::async_write(
|
|
stream_,
|
|
buf_.data(),
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_write,
|
|
shared_from_this(),
|
|
std::placeholders::_1,
|
|
std::placeholders::_2)));
|
|
}
|
|
|
|
void
|
|
on_write(error_code ec, std::size_t bytes_transferred)
|
|
{
|
|
buf_.consume(bytes_transferred);
|
|
if (ec)
|
|
{
|
|
fail("write", ec);
|
|
return;
|
|
}
|
|
stream_.async_shutdown(bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_shutdown, shared_from_this(), std::placeholders::_1)));
|
|
}
|
|
|
|
void
|
|
on_shutdown(error_code ec)
|
|
{
|
|
if (ec)
|
|
{
|
|
fail("shutdown", ec);
|
|
return;
|
|
}
|
|
socket_.close();
|
|
timer_.cancel();
|
|
}
|
|
};
|
|
|
|
public:
|
|
explicit Server(short_read_test& test) : test_(test)
|
|
{
|
|
auto const p = std::make_shared<Acceptor>(*this);
|
|
add(p);
|
|
p->run();
|
|
}
|
|
|
|
~Server()
|
|
{
|
|
close();
|
|
wait();
|
|
}
|
|
|
|
[[nodiscard]] endpoint_type const&
|
|
endpoint() const
|
|
{
|
|
return endpoint_;
|
|
}
|
|
};
|
|
|
|
//--------------------------------------------------------------------------
|
|
class Client : public Base
|
|
|
|
{
|
|
private:
|
|
short_read_test& test_;
|
|
|
|
struct Connection : Child, std::enable_shared_from_this<Connection>
|
|
{
|
|
Client& client_;
|
|
short_read_test& test_;
|
|
socket_type socket_;
|
|
stream_type stream_;
|
|
strand_type strand_;
|
|
timer_type timer_;
|
|
boost::asio::streambuf buf_;
|
|
endpoint_type const& ep_;
|
|
|
|
Connection(Client& client, endpoint_type const& ep)
|
|
: Child(client)
|
|
, client_(client)
|
|
, test_(client_.test_)
|
|
, socket_(test_.io_context_)
|
|
, stream_(socket_, *test_.context_)
|
|
, strand_(boost::asio::make_strand(test_.io_context_))
|
|
, timer_(test_.io_context_)
|
|
, ep_(ep)
|
|
{
|
|
}
|
|
|
|
void
|
|
close() override
|
|
{
|
|
if (!strand_.running_in_this_thread())
|
|
{
|
|
post(strand_, std::bind(&Connection::close, shared_from_this()));
|
|
return;
|
|
}
|
|
if (socket_.is_open())
|
|
{
|
|
socket_.close();
|
|
timer_.cancel();
|
|
}
|
|
}
|
|
|
|
void
|
|
run(endpoint_type const& ep)
|
|
{
|
|
timer_.expires_after(std::chrono::seconds(3));
|
|
timer_.async_wait(bind_executor(
|
|
strand_,
|
|
std::bind(&Connection::on_timer, shared_from_this(), std::placeholders::_1)));
|
|
socket_.async_connect(
|
|
ep,
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_connect, shared_from_this(), std::placeholders::_1)));
|
|
}
|
|
|
|
void
|
|
fail(std::string const& what, error_code ec)
|
|
{
|
|
if (socket_.is_open())
|
|
{
|
|
if (ec != boost::asio::error::operation_aborted)
|
|
test_.log << "[client] " << what << ": " << ec.message() << std::endl;
|
|
socket_.close();
|
|
timer_.cancel();
|
|
}
|
|
}
|
|
|
|
void
|
|
on_timer(error_code ec)
|
|
{
|
|
if (ec == boost::asio::error::operation_aborted)
|
|
return;
|
|
if (ec)
|
|
{
|
|
fail("timer", ec);
|
|
return;
|
|
}
|
|
test_.log << "[client] timeout";
|
|
socket_.close();
|
|
}
|
|
|
|
void
|
|
on_connect(error_code ec)
|
|
{
|
|
if (ec)
|
|
{
|
|
fail("connect", ec);
|
|
return;
|
|
}
|
|
stream_.async_handshake(
|
|
stream_type::client,
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_handshake, shared_from_this(), std::placeholders::_1)));
|
|
}
|
|
|
|
void
|
|
on_handshake(error_code ec)
|
|
{
|
|
if (ec)
|
|
{
|
|
fail("handshake", ec);
|
|
return;
|
|
}
|
|
write(buf_, "HELLO\n");
|
|
|
|
#if 1
|
|
boost::asio::async_write(
|
|
stream_,
|
|
buf_.data(),
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_write,
|
|
shared_from_this(),
|
|
std::placeholders::_1,
|
|
std::placeholders::_2)));
|
|
#else
|
|
stream_.async_shutdown(bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_shutdown, shared_from_this(), std::placeholders::_1)));
|
|
#endif
|
|
}
|
|
|
|
void
|
|
on_write(error_code ec, std::size_t bytes_transferred)
|
|
{
|
|
buf_.consume(bytes_transferred);
|
|
if (ec)
|
|
{
|
|
fail("write", ec);
|
|
return;
|
|
}
|
|
#if 1
|
|
boost::asio::async_read_until(
|
|
stream_,
|
|
buf_,
|
|
"\n",
|
|
bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_read,
|
|
shared_from_this(),
|
|
std::placeholders::_1,
|
|
std::placeholders::_2)));
|
|
#else
|
|
stream_.async_shutdown(bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_shutdown, shared_from_this(), std::placeholders::_1)));
|
|
#endif
|
|
}
|
|
|
|
void
|
|
on_read(error_code ec, std::size_t bytes_transferred)
|
|
{
|
|
if (ec)
|
|
{
|
|
fail("read", ec);
|
|
return;
|
|
}
|
|
buf_.commit(bytes_transferred);
|
|
stream_.async_shutdown(bind_executor(
|
|
strand_,
|
|
std::bind(
|
|
&Connection::on_shutdown, shared_from_this(), std::placeholders::_1)));
|
|
}
|
|
|
|
void
|
|
on_shutdown(error_code ec)
|
|
{
|
|
if (ec)
|
|
{
|
|
fail("shutdown", ec);
|
|
return;
|
|
}
|
|
socket_.close();
|
|
timer_.cancel();
|
|
}
|
|
};
|
|
|
|
public:
|
|
Client(short_read_test& test, endpoint_type const& ep) : test_(test)
|
|
{
|
|
auto const p = std::make_shared<Connection>(*this, ep);
|
|
add(p);
|
|
p->run(ep);
|
|
}
|
|
|
|
~Client()
|
|
{
|
|
close();
|
|
wait();
|
|
}
|
|
};
|
|
|
|
public:
|
|
short_read_test()
|
|
: work_(io_context_.get_executor())
|
|
, thread_(std::thread([this]() {
|
|
beast::setCurrentThreadName("io_context");
|
|
this->io_context_.run();
|
|
}))
|
|
, context_(make_SSLContext(""))
|
|
{
|
|
}
|
|
|
|
~short_read_test() override
|
|
{
|
|
work_.reset();
|
|
thread_.join();
|
|
}
|
|
|
|
void
|
|
run() override
|
|
{
|
|
Server const s(*this);
|
|
Client c(*this, s.endpoint());
|
|
c.wait();
|
|
pass();
|
|
}
|
|
};
|
|
|
|
BEAST_DEFINE_TESTSUITE(short_read, overlay, xrpl);
|
|
|
|
} // namespace xrpl
|