0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-11 08:02:59 +01:00
construct/ircd/ircd.cc

516 lines
13 KiB
C++
Raw Normal View History

2018-02-04 03:22:01 +01:00
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
2018-02-04 03:22:01 +01:00
// 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
2018-02-04 03:22:01 +01:00
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
namespace ircd
{
std::string _origin; // user's supplied param
std::string _servername; // user's supplied param
ctx::ctx *main_context; // Main program loop
static void main() noexcept;
}
decltype(ircd::soft_assert)
ircd::soft_assert
{
{ "name", "ircd.soft_assert" },
{ "default", false },
{ "persist", false },
};
decltype(ircd::write_avoid)
ircd::write_avoid
{
{ "name", "ircd.write_avoid" },
{ "default", false },
{ "persist", false },
};
decltype(ircd::read_only)
ircd::read_only
{
{ "name", "ircd.read_only" },
{ "default", false },
{ "persist", false },
};
decltype(ircd::debugmode)
ircd::debugmode
{
{ "name", "ircd.debugmode" },
{ "default", false },
{ "persist", false },
};
decltype(ircd::restart)
ircd::restart
{
{ "name", "ircd.restart" },
{ "default", false },
{ "persist", false },
};
/// Sets up the IRCd and its main context, then returns without blocking.
//
2017-12-29 23:53:39 +01:00
/// Pass your io_context instance, it will share it with the rest of your program.
/// An exception will be thrown on error.
///
/// This function will setup the main program loop of libircd. The execution will
2017-12-29 23:53:39 +01:00
/// occur when your io_context.run() or poll() is further invoked.
///
/// init() can only be called from a run::level::HALT state
void
ircd::init(boost::asio::io_context &user_ios,
const string_view &origin,
const string_view &servername)
2017-09-30 08:04:41 +02:00
try
{
// This function must only be called from a HALT state.
if(run::level != run::level::HALT)
2018-01-22 09:25:08 +01:00
throw error
{
"Cannot init() IRCd from runlevel %s", reflect(run::level)
2018-01-22 09:25:08 +01:00
};
// Check that the supplied origin string is properly formatted.
if(!rfc3986::valid_remote(std::nothrow, origin))
throw user_error
{
"The 'origin' argument \"%s\" is not a valid hostname.", origin
};
// Check that the supplied servername string is properly formatted.
if(!rfc3986::valid_remote(std::nothrow, servername))
throw user_error
{
"The 'servername' argument \"%s\" is not a valid hostname.", servername
};
2017-09-30 08:04:41 +02:00
// Save the params used for m::init later.
_origin = std::string{origin};
_servername = std::string{servername};
2018-08-17 19:55:22 +02:00
// Setup the core event loop system starting with the user's supplied ios.
ios::init(user_ios);
2018-03-02 09:35:02 +01:00
// The log is available. but it is console-only until conf opens files.
log::init();
2018-05-08 01:13:16 +02:00
log::mark("DEADSTART"); // 6600
2018-01-17 12:55:36 +01:00
// This starts off the log with library information.
info::dump();
2017-11-30 19:26:13 +01:00
// Setup the main context, which is a new stack executing the function
// ircd::main(). The main_context is the first ircd::ctx to be spawned
// and will be the last to finish.
//
2017-12-29 23:53:39 +01:00
// The context::POST will delay this spawn until the next io_context
// event slice, so no context switch will occur here. Note that POST has
// to be used here because: A. This init() function is executing on the
// main stack, and context switches can only occur between context stacks,
2017-12-29 23:53:39 +01:00
// not between contexts and the main stack. B. The user's io_context may or
// may not even be running yet anyway.
//
// (debug compilation) The context::SLICE_EXEMPT flag exempts the context
// from assertions that it's not blocking the process with excessive CPU
// usage or long syscall. Main context can't meet this requirement.
//
context main_context
{
"main", 256_KiB, &ircd::main, context::POST | context::SLICE_EXEMPT
};
// The default behavior for ircd::context is to join the ctx on dtor. We
// can't have that here because this is strictly an asynchronous function
// on the main stack. Under normal circumstances, the mc will be entered
// and be able to delete this pointer itself when it finishes. Otherwise
// this must be manually deleted with assurance that mc will never enter.
ircd::main_context = main_context.detach();
// Finally, without prior exception, the commitment to run::level::READY
// is made here. The user can now invoke their ios.run(), or, if they
// have already, IRCd will begin main execution shortly...
run::set(run::level::READY);
}
2017-09-30 08:04:41 +02:00
catch(const std::exception &e)
{
throw;
}
/// Notifies IRCd to shutdown. A shutdown will occur asynchronously and this
/// function will return immediately. A runlevel change to HALT will be
/// indicated when IRCd has no more work for the ios. When the HALT state
/// is observed the user is free to destruct all resources related to libircd.
///
/// This function is the proper way to shutdown libircd after an init(), and while
2017-12-29 23:53:39 +01:00
/// your io_context.run() is invoked without stopping your io_context shared by
/// other activities unrelated to libircd. If your io_context has no other activities
/// the run() will then return immediately after IRCd posts its transition to
/// the HALT state.
///
bool
ircd::quit()
noexcept
{
log::debug
{
"IRCd quit requested from runlevel:%s ctx:%p main_context:%p",
reflect(run::level),
(const void *)ctx::current,
(const void *)main_context
};
if(main_context) switch(run::level)
{
case run::level::READY:
{
ctx::terminate(*main_context);
main_context = nullptr;
ircd::run::set(run::level::HALT);
return true;
}
case run::level::START:
{
ctx::terminate(*main_context);
main_context = nullptr;
ircd::run::set(run::level::QUIT);
return true;
}
case run::level::RUN:
{
ctx::notify(*main_context);
main_context = nullptr;
return true;
}
case run::level::HALT:
case run::level::QUIT:
case run::level::FAULT:
return false;
}
return false;
}
/// Notifies IRCd that execution is being resumed after a significant gap.
/// Basically this is connected to a SIGCONT handler and beneficial after
/// user stops, debugging and ACPI suspensions, etc. It is not required at
/// this time, but its connection is advised for best behavior.
void
ircd::cont()
noexcept
{
log::debug
{
"IRCd cont requested from runlevel:%s ctx:%p main_context:%p",
reflect(run::level),
(const void *)ctx::current,
(const void *)main_context
};
switch(run::level)
{
case run::level::HALT:
case run::level::READY:
case run::level::FAULT:
return;
case run::level::START:
case run::level::QUIT:
return;
case run::level::RUN:
break;
}
log::notice
{
"IRCd resuming service in runlevel:%s.",
reflect(run::level),
};
}
/// Main context; Main program. Do not call this function directly.
///
/// This function manages the lifetime for all resources and subsystems
/// that don't/can't have their own static initialization. When this
/// function is entered, subsystem init objects are constructed on the
/// frame. The lifetime of those objects is the handle to the lifetime
/// of the subsystem, so destruction will shut down that subsystem.
///
/// The status of this function and IRCd overall can be observed through
/// the ircd::runlevel. The ircd::run::changed callback can be set
/// to be notified on a runlevel change. The user should wait for a runlevel
/// of HALT before destroying IRCd related resources and stopping their
2017-12-29 23:53:39 +01:00
/// io_context from running more jobs.
///
void
ircd::main()
noexcept try
{
// Resamples the thread this context was executed on which should be where
// the user ran ios.run(). The user may have invoked ios.run() on multiple
// threads, but we consider this one thread a main thread for now...
ircd::ios::main_thread_id = std::this_thread::get_id();
// When this function completes without exception, subsystems are done shutting down and IRCd
// transitions to HALT.
const unwind::defer halted{[]
2017-09-30 08:04:41 +02:00
{
run::set(run::level::HALT);
2017-09-30 08:04:41 +02:00
}};
// When this function is entered IRCd will transition to START indicating
// that subsystems are initializing.
run::set(run::level::START);
// These objects are the init()'s and fini()'s for each subsystem.
// Appearing here ties their life to the main context. Initialization can
// also occur in ircd::init() or static initialization itself if either are
// more appropriate.
2019-04-02 20:09:37 +02:00
prof::init _prof_; // Profiling related
fs::init _fs_; // Local filesystem
magic::init _magic_; // libmagic
ctx::ole::init _ole_; // Thread OffLoad Engine
openssl::init _ossl_; // openssl crypto
2017-09-30 08:04:41 +02:00
net::init _net_; // Networking
2017-09-08 11:19:26 +02:00
db::init _db_; // RocksDB
server::init _server_; // Server related
client::init _client_; // Client related
js::init _js_; // SpiderMonkey
2018-08-17 19:55:22 +02:00
m::init _matrix_ // Matrix
{
string_view{_origin},
string_view{_servername}
2018-08-17 19:55:22 +02:00
};
// Any deinits which have to be done with all subsystems intact
const unwind shutdown{[&]
{
_matrix_.close();
server::interrupt_all();
client::terminate_all();
client::close_all();
server::close_all();
server::wait_all();
client::wait_all();
}};
// IRCd will now transition to the RUN state indicating full functionality.
run::set(run::level::RUN);
// This call blocks until the main context is notified or interrupted etc.
// Waiting here will hold open this stack with all of the above objects
// living on it.
run::changed::dock.wait([]
{
return !main_context;
});
ircd::run::set(run::level::QUIT);
}
catch(const http::error &e) // <-- m::error
2018-09-21 23:59:58 +02:00
{
log::critical
{
"IRCd main :%s %s", e.what(), e.content
2018-09-21 23:59:58 +02:00
};
}
catch(const std::exception &e)
{
log::critical
{
"IRCd main :%s", e.what()
};
}
catch(const ctx::terminated &)
{
return;
}
catch(...)
{
2018-01-22 09:25:08 +01:00
log::critical
{
"IRCd main error."
2018-01-22 09:25:08 +01:00
};
}
/// IRCd uptime in seconds
ircd::seconds
ircd::uptime()
{
return seconds(ircd::time() - info::startup_time);
}
///////////////////////////////////////////////////////////////////////////////
//
// ircd/run.h
//
namespace ircd::run
{
static enum level _level;
}
decltype(ircd::run::level)
ircd::run::level
{
_level
};
//
// run::changed
//
template<>
decltype(ircd::run::changed::allocator)
ircd::util::instance_list<ircd::run::changed>::allocator
{};
template<>
decltype(ircd::run::changed::list)
ircd::util::instance_list<ircd::run::changed>::list
{
allocator
};
decltype(ircd::run::changed::dock)
ircd::run::changed::dock;
//
// run::changed::changed
//
ircd::run::changed::changed(handler function)
:handler
{
std::move(function)
}
{
}
ircd::run::changed::~changed()
noexcept
{
}
/// The notification will be posted to the io_context. This is important to
/// prevent the callback from continuing execution on some ircd::ctx stack and
/// instead invoke their function on the main stack in their own io_context
/// event slice.
bool
ircd::run::set(const enum level &new_level)
try
{
if(level == new_level)
return false;
log::debug
{
"IRCd level transition from '%s' to '%s' (notifying %zu)",
reflect(level),
reflect(new_level),
changed::list.size()
};
_level = new_level;
changed::dock.notify_all();
// This latch is used to block this call when setting the level
// from an ircd::ctx. If the level is set from the main stack then
// the caller will have to do synchronization themselves.
ctx::latch latch
{
bool(ctx::current) // latch has count of 1 if we're on an ircd::ctx
};
// This function will notify the user of the change to IRCd. When there
// are listeners, function is posted to the io_context ensuring THERE IS
// NO CONTINUATION ON THIS STACK by the user.
const auto call_users{[new_level, &latch, latching(!latch.is_ready())]
{
assert(new_level == run::level);
log::notice
{
"IRCd %s", reflect(new_level)
};
if(new_level == level::HALT)
log::fini();
else
log::flush();
for(const auto &handler : changed::list) try
{
(*handler)(new_level);
}
catch(const std::exception &e)
{
log::critical
{
"Runlevel change to %s handler(%p) :%s",
reflect(new_level),
handler,
e.what()
};
}
if(latching)
latch.count_down();
}};
static ios::descriptor descriptor
{
"ircd::run::set"
};
if(changed::list.size() && ctx::current)
ircd::post(descriptor, call_users);
else
call_users();
if(ctx::current)
latch.wait();
return true;
}
catch(const std::exception &e)
{
log::critical
{
"IRCd level change to '%s': %s",
reflect(new_level),
e.what()
};
ircd::terminate();
return false;
}
ircd::string_view
ircd::run::reflect(const enum run::level &level)
{
switch(level)
{
case level::HALT: return "HALT";
case level::READY: return "READY";
case level::START: return "START";
case level::RUN: return "RUN";
case level::QUIT: return "QUIT";
case level::FAULT: return "FAULT";
}
return "??????";
}