construct/include/ircd/run.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.

#define HAVE_IRCD_RUN_H

// Forward declarations for because ctx.h is included after runlevel.h.
namespace ircd::ctx
{
	struct dock;
}

/// Library control details and patch-panel. This namespace contains the
/// current runlevel state for the library and provides callback interfaces
/// which can be notified for, or augment the behavior of runlevel transitions
/// (i.e when the lib is being initialized for service or shutting down, etc).
namespace ircd::run
{
	enum class level :int;
	template<class> struct barrier;
	struct changed;

	string_view reflect(const enum level &);

	// Access to the current runlevel indicator.
	extern const enum level &level;

	// Access to the desired runlevel. When this differs from the current
	// level, a command to change the runlevel has been given but not all
	// tasks have completed at the current runlevel.
	extern const enum level &chadburn;
}

/// The run::level allows all observers to know the coarse state of IRCd and to
/// react accordingly. This can be used by the embedder of libircd to know
/// when it's safe to use or delete libircd resources. It is also used
/// similarly by the library and its modules. Only one runlevel is active at
/// any time.
///
/// * HALT is the off mode. Nothing is/will be running in libircd until
/// an invocation of ircd::init();
///
/// * READY is the state after calling ircd::init(). Leaving READY is done with
/// the user either calling their ios.run() to start executing tasks or calling
/// ircd::quit() to HALT again.
///
/// * START indicates the daemon is executing its startup procedures. Leaving
/// the START state occurs internally when there is success or a fatal error.
///
/// * RUN is the service mode. Full client and application functionality exists
/// in this mode. Leaving the RUN mode is done with ircd::quit();
///
/// * QUIT indicates the daemon is executing the shutdown procedures. This
/// will eventually return back to the HALT state.
///
/// * FAULT is a special mode indicating something really bad. The exact
/// details of this mode are ambiguous. Users do not have to handle this.
///
enum class ircd::run::level
:int
{
	FAULT    = -1,   ///<           Unrecoverable fault.
	HALT     = 0,    ///<   X <--   IRCd Powered off.
	READY    = 1,    ///<   |   |   Ready for user to run ios event loop.
	START    = 2,    ///<   |   |   Starting internal subsystems.
	RUN      = 3,    ///<   O   |   IRCd in service.
	QUIT     = 4,    ///<   >---^   Clean shutdown starting.
};

/// An instance of this class registers itself to be called back when
/// the ircd::run::level has changed. The context for this callback differs
/// based on the level argument; not all invocations are on an ircd::ctx, etc.
///
/// Note: Its destructor will access a list in libircd; after a callback
/// for a HALT do not unload libircd.so until destructing this object.
///
struct ircd::run::changed
:instance_list<ircd::run::changed>
{
	using handler_proto = void (const enum level &);

	static const enum level single_sentinel
	{
		std::numeric_limits<std::underlying_type<enum level>::type>::max()
	};

	static ctx::dock dock;

	enum level single
	{
		single_sentinel
	};

	std::function<void ()> handler_one;
	std::function<handler_proto> handler
	{
		[this](const auto &level)
		{
			if(single == single_sentinel || single != level)
				return;

			if(likely(handler_one))
				handler_one();
		}
	};

	/// The handler function will be called back for any run::level change while
	/// this instance remains in scope.
	changed(decltype(handler) function) noexcept
	:handler{std::move(function)}
	{}

	/// The handler function will be called back for the specific run::level
	/// change while this instance remains in scope.
	changed(const enum level &single, decltype(handler_one) function) noexcept
	:single{single}
	,handler_one{std::move(function)}
	{}

	/// Default construction for no-op
	changed() noexcept;
	~changed() noexcept;

	// convenience to wait on the dock for the levels
	static void wait(const std::initializer_list<enum level> &);
};

/// Tool to yield a context until the run::level is RUN or QUIT. Once either is
/// satisfied (or if already satisfied) the run::level is checked to be RUN
/// otherwise an exception is thrown.
///
template<class E>
struct [[gnu::visibility("internal")]]
ircd::run::barrier
{
	template<class... args>
	barrier(args&&... a)
	{
		changed::wait({level::RUN, level::QUIT});
		if(unlikely(level != level::RUN))
			throw E
			{
				std::forward<args>(a)...
			};
	}
};