construct/include/ircd/asio.h

// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 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. The
// full license for this software is available in the LICENSE file.

#ifndef HAVE_IRCD_ASIO_H
#define HAVE_IRCD_ASIO_H

///
/// Boost library
///
/// It is better to add a boost header which we have omitted here rather than
/// in your definition file, and then #include <ircd/asio.h>. This is because
/// we can compose a precompiled header for your definition file much easier
/// this way.
///

// ircd.h is included here so that it can be compiled into this header. Then
// this becomes the single leading precompiled header.
#include <ircd/ircd.h>

// Boost preambles
#include <boost/version.hpp>
#include <boost/config.hpp>

// Workarounds / fixes
#if BOOST_VERSION >= 107000
namespace boost
{
	using std::begin;
	using std::end;
}
#endif

#include <RB_INC_SIGNAL_H
#include <RB_INC_SYS_MMAN_H
#include <RB_INC_SYS_EVENT_H
#include <RB_INC_SYS_EPOLL_H
#include <RB_INC_SYS_TIMERFD_H
#include <RB_INC_SYS_EVENTFD_H

// Workaround io_uring_service::get_sqe() bug; see below
#if defined(HAVE_LIBURING_H) \
&& IRCD_USE_URING == 1 \
&& BOOST_VERSION <= 108100
	#define LIBURING_INTERNAL
#endif

#include <RB_INC_LIBURING_H

#pragma GCC visibility push(internal)
#include <boost/throw_exception.hpp>
#pragma GCC visibility pop

#include <boost/system/system_error.hpp>
#include <boost/date_time/posix_time/ptime.hpp>

// In boost 1.78+ io_uring(7) becomes the core event loop replacing epoll(7)
// and used for network operations.
#if defined(HAVE_LIBURING_H) \
&& IRCD_USE_URING == 1 \
&& BOOST_VERSION >= 107800
#define BOOST_ASIO_HAS_IO_URING
#define BOOST_ASIO_DISABLE_EPOLL
#define IRCD_USE_ASIO_IO_URING 1
#else
#define IRCD_USE_ASIO_IO_URING 0
#endif

// In boost 1.79+ asio implements some filesystem operations we can use. While
// these are available in 1.78 they were buggy for our purposes until 1.79.
#if IRCD_USE_ASIO_IO_URING && BOOST_VERSION >= 107900
#define IRCD_USE_ASIO_READ 1
#define IRCD_USE_ASIO_WRITE 1
#else
#define IRCD_USE_ASIO_READ 0
#define IRCD_USE_ASIO_WRITE 0
#endif

#include <boost/asio/detail/config.hpp>
#include <boost/asio/detail/socket_types.hpp>
#include <boost/asio/ssl/detail/openssl_types.hpp>
#include <boost/context/stack_context.hpp>
#include <boost/coroutine/coroutine.hpp>

#if defined(BOOST_ASIO_HAS_EPOLL) \
|| defined(BOOST_ASIO_HAS_KQUEUE) \
|| defined(BOOST_ASIO_HAS_IO_URING)
#pragma GCC visibility push(protected)
#else
#pragma GCC visibility push(default)
#endif
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wnull-dereference"
#include <boost/asio.hpp>
#include <boost/asio/io_service.hpp>
#include <boost/asio/steady_timer.hpp>
#include <boost/asio/spawn.hpp>
#include <boost/asio/ssl.hpp>
#pragma GCC diagnostic pop
#pragma GCC visibility pop

// Template-specializations for some functions we may redefine (interpose).
// Declarations are needed for template instantiation in PCH and with LTO.
#if defined(BOOST_ASIO_HAS_EPOLL)
namespace boost::asio::detail
{
	using epoll_time_traits = asio::time_traits<posix_time::ptime>;

	template<> std::size_t
	epoll_reactor::cancel_timer(timer_queue<epoll_time_traits> &,
	                            typename timer_queue<epoll_time_traits>::per_timer_data &,
	                            std::size_t max);
}
#endif

// Boost version dependent behavior for getting the io_service/io_context
// abstract executor (recent versions) or the derived instance (old versions).
namespace ircd::ios
{
	extern asio::executor user, main;
	extern std::optional<asio::io_context::strand> primary;

	#if BOOST_VERSION >= 107000 && BOOST_VERSION < 107400
	asio::executor &get() noexcept;
	#else
	asio::io_context &get() noexcept;
	#endif
}

// The following IRCd headers are not included in the main stdinc.h list of
// includes because they require boost directly or symbols which we cannot
// forward declare. You should include this in your definition file if you
// need these low-level interfaces.

// Context system headers depending on boost.
#include <ircd/ctx/continuation.h>

// Network system headers depending on boost.
#include <ircd/net/asio.h>

#if BOOST_VERSION >= 107000 && BOOST_VERSION < 107400
inline boost::asio::executor &
ircd::ios::get()
noexcept
{
	assert(bool(main));
	return main;
}
#else
inline boost::asio::io_context &
ircd::ios::get()
noexcept
{
	auto &context(mutable_cast(main.context()));
	return static_cast<asio::io_context &>(context);
}
#endif

// Workaround for bug in io_uring_service::get_sqe(). We have to aim upstream
// because we can't get to it directly; this won't affect other users in the
// address space; if LIBURING_INTERNAL ever has another meaning sometime in
// the future hopefully the boost version will be ancient history by then...
#if defined(LIBURING_INTERNAL)
inline struct io_uring_sqe *
io_uring_get_sqe(struct io_uring *const ring)
{
	struct io_uring_sqe *sqe;
	if(likely(sqe = _io_uring_get_sqe(ring)))
		::io_uring_sqe_set_data(sqe, nullptr);

	return sqe;
}
#endif

#endif HAVE_IRCD_ASIO_H