construct/include/ircd/net/socket.h

/*
 * Copyright (C) 2016 Charybdis Development Team
 * Copyright (C) 2016 Jason Volk <jason@zemos.net>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice is present in all copies.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once
#define HAVE_IRCD_NET_SOCKET_H

// This file is not included with the IRCd standard include stack because
// it requires symbols we can't forward declare without boost headers. It
// is part of the <ircd/asio.h> stack which can be included in your
// definition file if you need low level access to this socket API. The
// client.h still offers higher level access to sockets without requiring
// boost headers; please check that for satisfaction before including this.

namespace ircd::net
{
	namespace ip = asio::ip;
	using boost::system::error_code;
	using asio::steady_timer;

	struct socket;

	extern asio::ssl::context sslv23_client;

	uint16_t port(const ip::tcp::endpoint &);
	ip::address addr(const ip::tcp::endpoint &);
	std::string host(const ip::tcp::endpoint &);

	std::string string(const ip::address &);
	std::string string(const ip::tcp::endpoint &);
}

namespace ircd
{
	using net::error_code;
	using net::string;
	using net::addr;
	using net::host;
	using net::port;
}

struct ircd::net::socket
:std::enable_shared_from_this<ircd::net::socket>
{
	struct io;
	struct stat;
	struct scope_timeout;
	enum class dc;

	struct stat
	{
		size_t bytes {0};
		size_t calls {0};
	};

	using message_flags = boost::asio::socket_base::message_flags;
	using handshake_type = asio::ssl::stream<ip::tcp::socket>::handshake_type;
	using handler = std::function<void (const error_code &) noexcept>;
	using xfer_handler = std::function<void (const error_code &, const size_t &) noexcept>;

	ip::tcp::socket sd;
	asio::ssl::stream<ip::tcp::socket &> ssl;
	steady_timer timer;
	stat in, out;
	bool timedout;

	void call_user(const handler &, const error_code &) noexcept;
	bool handle_error(const error_code &ec);
	void handle_timeout(std::weak_ptr<socket> wp, const error_code &ec) noexcept;
	void handle(std::weak_ptr<socket>, handler, const error_code &, const size_t &) noexcept;

  public:
	// Getters for boost socket struct
	operator const ip::tcp::socket &() const     { return sd;                                      }
	operator ip::tcp::socket &()                 { return sd;                                      }

	// Observers
	ip::tcp::endpoint remote() const;            // getpeername(); throws if not conn
	ip::tcp::endpoint local() const;             // getsockname(); throws if not conn/bound
	bool connected() const noexcept;             // false on any sock errs
	size_t available() const;                    // throws on errors; use friend variant for noex..

	// low level read suite
	template<class iov> auto read_some(const iov &, xfer_handler);
	template<class iov> auto read_some(const iov &, error_code &);
	template<class iov> auto read_some(const iov &);
	template<class iov> auto read(const iov &, xfer_handler);
	template<class iov> auto read(const iov &, error_code &);
	template<class iov> auto read(const iov &);

	// low level write suite
	template<class iov> auto write_some(const iov &, xfer_handler);
	template<class iov> auto write_some(const iov &, error_code &);
	template<class iov> auto write_some(const iov &);
	template<class iov> auto write(const iov &, xfer_handler);
	template<class iov> auto write(const iov &, error_code &);
	template<class iov> auto write(const iov &);

	// Timer for this socket
	void set_timeout(const milliseconds &, handler);
	void set_timeout(const milliseconds &);
	error_code cancel_timeout() noexcept;

	// Asynchronous callback when socket ready for read
	void operator()(const milliseconds &timeout, handler);
	void operator()(handler);
	bool cancel() noexcept;

	// Connect to host; synchronous (yield) and asynchronous (callback) variants
	void connect(const ip::tcp::endpoint &ep, const milliseconds &timeout, handler callback);
	void connect(const ip::tcp::endpoint &ep, const milliseconds &timeout = 30000ms);
	void connect(const net::remote &, const milliseconds &timeout = 30000ms);
	void disconnect(const dc &type);

	// Construct, resolve and connect client socket to remote host (yields)
	socket(const net::remote &,
	       const milliseconds &timeout           = 30000ms,
	       asio::ssl::context &ssl               = sslv23_client,
	       boost::asio::io_service *const &ios   = ircd::ios);

	// Construct and connect client socket to remote host (yields)
	socket(const ip::tcp::endpoint &remote,
	       const milliseconds &timeout           = 30000ms,
	       asio::ssl::context &ssl               = sslv23_client,
	       boost::asio::io_service *const &ios   = ircd::ios);

	// Construct socket only
	socket(asio::ssl::context &ssl               = sslv23_client,
	       boost::asio::io_service *const &ios   = ircd::ios);

	// Socket cannot be copied or moved; must be constructed as shared ptr
	socket(socket &&) = delete;
	socket(const socket &) = delete;
	~socket() noexcept;
};

class ircd::net::socket::scope_timeout
{
	socket *s {nullptr};

  public:
	bool cancel() noexcept;   // invoke timer.cancel() before dtor
	bool release();           // cancels the cancel;

	scope_timeout(socket &, const milliseconds &timeout, socket::handler handler);
	scope_timeout(socket &, const milliseconds &timeout);
	scope_timeout() = default;
	scope_timeout(scope_timeout &&) noexcept;
	scope_timeout(const scope_timeout &) = delete;
	scope_timeout &operator=(scope_timeout &&) noexcept;
	scope_timeout &operator=(const scope_timeout &) = delete;
	~scope_timeout() noexcept;
};

class ircd::net::socket::io
{
	struct socket &sock;
	struct stat &stat;
	size_t bytes;

  public:
	operator size_t() const;

	io(struct socket &, struct stat &, const size_t &bytes);
	io(struct socket &, struct stat &, const std::function<size_t ()> &closure);
};

enum class ircd::net::socket::dc
{
	RST,                // hardest disconnect
	FIN,                // graceful shutdown both directions
	FIN_SEND,           // graceful shutdown send side
	FIN_RECV,           // graceful shutdown recv side
	SSL_NOTIFY,         // SSL close_notify (async, errors ignored)
	SSL_NOTIFY_YIELD,   // SSL close_notify (yields context, throws)
};

template<class iov>
auto
ircd::net::socket::write(const iov &bufs)
{
	return io(*this, out, [&]
	{
		return async_write(ssl, bufs, asio::transfer_all(), yield_context{to_asio{}});
	});
}

template<class iov>
auto
ircd::net::socket::write(const iov &bufs,
                         error_code &ec)
{
	return io(*this, out, [&]
	{
		return async_write(ssl, bufs, asio::transfer_all(), yield_context{to_asio{}}[ec]);
	});
}

template<class iov>
auto
ircd::net::socket::write(const iov &bufs,
                         xfer_handler handler)
{
	async_write(ssl, bufs, asio::transfer_all(), [this, handler(std::move(handler))]
	(const error_code &ec, const size_t &bytes)
	noexcept
	{
		io{*this, out, bytes};
		handler(ec, bytes);
	});
}

template<class iov>
auto
ircd::net::socket::write_some(const iov &bufs)
{
	return io(*this, out, [&]
	{
		return ssl.async_write_some(bufs, yield_context{to_asio{}});
	});
}

template<class iov>
auto
ircd::net::socket::write_some(const iov &bufs,
                              error_code &ec)
{
	return io(*this, out, [&]
	{
		return ssl.async_write_some(bufs, yield_context{to_asio{}}[ec]);
	});
}

template<class iov>
auto
ircd::net::socket::write_some(const iov &bufs,
                              xfer_handler handler)
{
	ssl.async_write_some(bufs, [this, handler(std::move(handler))]
	(const error_code &ec, const size_t &bytes)
	noexcept
	{
		io{*this, out, bytes};
		handler(ec, bytes);
	});
}

template<class iov>
auto
ircd::net::socket::read(const iov &bufs)
{
	return io(*this, in, [&]
	{
		const size_t ret(async_read(ssl, bufs, yield_context{to_asio{}}));

		if(unlikely(!ret))
			throw boost::system::system_error(boost::asio::error::eof);

		return ret;
	});
}

template<class iov>
auto
ircd::net::socket::read(const iov &bufs,
                        error_code &ec)
{
	return io(*this, in, [&]
	{
		return async_read(ssl, bufs, yield_context{to_asio{}}[ec]);
	});
}

template<class iov>
auto
ircd::net::socket::read(const iov &bufs,
                        xfer_handler handler)
{
	async_read(ssl, bufs, [this, handler(std::move(handler))]
	(const error_code &ec, const size_t &bytes)
	noexcept
	{
		io{*this, in, bytes};
		handler(ec, bytes);
	});
}

template<class iov>
auto
ircd::net::socket::read_some(const iov &bufs)
{
	return io(*this, in, [&]
	{
		const size_t ret(ssl.async_read_some(bufs, yield_context{to_asio{}}));

		if(unlikely(!ret))
			throw boost::system::system_error(boost::asio::error::eof);

		return ret;
	});
}

template<class iov>
auto
ircd::net::socket::read_some(const iov &bufs,
                             error_code &ec)
{
	return io(*this, in, [&]
	{
		return ssl.async_read_some(bufs, yield_context{to_asio{}}[ec]);
	});
}

template<class iov>
auto
ircd::net::socket::read_some(const iov &bufs,
                             xfer_handler handler)
{
	ssl.async_read_some(bufs, [this, handler(std::move(handler))]
	(const error_code &ec, const size_t &bytes)
	noexcept
	{
		io{*this, in, bytes};
		handler(ec, bytes);
	});
}