memgraph/src/memgraph_bolt.cpp

116 lines
4.0 KiB
C++
Raw Normal View History

#include <experimental/filesystem>
#include <iostream>
#include <gflags/gflags.h>
#include <glog/logging.h>
#include "communication/bolt/v1/session.hpp"
#include "communication/server.hpp"
#include "config.hpp"
#include "io/network/network_endpoint.hpp"
#include "io/network/network_error.hpp"
#include "io/network/socket.hpp"
#include "utils/flag_validation.hpp"
#include "utils/scheduler.hpp"
#include "utils/signals/handler.hpp"
#include "utils/stacktrace.hpp"
#include "utils/sysinfo/memory.hpp"
2017-01-13 17:47:17 +08:00
#include "utils/terminate_handler.hpp"
#include "version.hpp"
namespace fs = std::experimental::filesystem;
using communication::bolt::SessionData;
using io::network::NetworkEndpoint;
using io::network::Socket;
using SessionT = communication::bolt::Session<Socket>;
using ResultStreamT = SessionT::ResultStreamT;
using ServerT = communication::Server<SessionT, SessionData>;
DEFINE_string(interface, "0.0.0.0",
"Communication interface on which to listen.");
DEFINE_string(port, "7687", "Communication port on which to listen.");
DEFINE_VALIDATED_int32(num_workers,
std::max(std::thread::hardware_concurrency(), 1U),
"Number of workers", FLAG_IN_RANGE(1, INT32_MAX));
DEFINE_string(log_file, "", "Path to where the log should be stored.");
DEFINE_string(log_link_basename, "",
"Basename used for symlink creation to the last log file.");
DEFINE_uint64(memory_warning_threshold, 1024,
"Memory warning treshold, in MB. If Memgraph detects there is "
"less available RAM available it will log a warning. Set to 0 to "
"disable.");
int main(int argc, char **argv) {
google::SetUsageMessage("Memgraph database server");
gflags::SetVersionString(version_string);
// Load config before parsing arguments, so that flags from the command line
// overwrite the config.
LoadConfig();
gflags::ParseCommandLineFlags(&argc, &argv, true);
google::InitGoogleLogging(argv[0]);
google::SetLogDestination(google::INFO, FLAGS_log_file.c_str());
google::SetLogSymlink(google::INFO, FLAGS_log_link_basename.c_str());
// Unhandled exception handler init.
std::set_terminate(&terminate_handler);
// Signal handling init.
SignalHandler::register_handler(Signal::SegmentationFault, []() {
Fix errors with handling SIGSEGV and SIGABRT Summary: There were a couple of issues with handling the above 2 signals. 1) Calling `std::exit` from a signal handler is undefined behaviour. The only defined way for a signal handler to stop the program is calling one of: `std::_Exit`, `std::abort` or `std::quick_exit`. Neither of them will completely clean the resources, so a clean exit is not possible. Since SIGSEGV and SIGABRT happen in extraordinary circumstances that we wish to debug 99% of the time, it makes sense to generate a core dump which can be inspected by a debugger. Of the 3 termination functions, only `std::abort` will generate a core dump, so it makes sense to use that to stop the program. Also, since we are now aborting as is the default behaviour on SIGSEGV and SIGABRT, it becomes questionable why have a custom handler at all. 2) Raising an exception inside a signal handler is undefined behaviour Although the handler by itself does not raise an exception, it is possible for the logging facility to raise one. This is a real case when logging a stack trace in particular. Stack trace is generated by creating a string "<function name> <line location>". It is possible that a function name will contain '{}' somewhere inside. This is usually the case with anonymous functions. The generated string is then passed to logging, which uses the `fmt` library to fill '{}' with remaining arguments. Since only a single argument (the stack trace string) is passed for formatting, naturally the `fmt::format` throws an exception, that it is missing a format argument. We could provide an overload which takes a single string, but that defeats the purpose of `fmt::format` raising an exception in regular code if we forget to pass an argument. Another solution is to escape the whole stack trace string, so it is valid for formatting, but this only complicates the handler even further. The simplest solution is to send the stack trace to `stderr` and avoid logging altogether. Simplify Shutdown, so it can be used in a signal handler Reviewers: florijan, mferencevic, buda, mislav.bradac Reviewed By: mferencevic, buda Subscribers: pullbot Differential Revision: https://phabricator.memgraph.io/D474
2017-06-14 22:37:23 +08:00
// Log that we got SIGSEGV and abort the program, because returning from
// SIGSEGV handler is undefined behaviour.
std::cerr << "SegmentationFault signal raised" << std::endl;
std::abort(); // This will continue into our SIGABRT handler.
});
SignalHandler::register_handler(Signal::Abort, []() {
Fix errors with handling SIGSEGV and SIGABRT Summary: There were a couple of issues with handling the above 2 signals. 1) Calling `std::exit` from a signal handler is undefined behaviour. The only defined way for a signal handler to stop the program is calling one of: `std::_Exit`, `std::abort` or `std::quick_exit`. Neither of them will completely clean the resources, so a clean exit is not possible. Since SIGSEGV and SIGABRT happen in extraordinary circumstances that we wish to debug 99% of the time, it makes sense to generate a core dump which can be inspected by a debugger. Of the 3 termination functions, only `std::abort` will generate a core dump, so it makes sense to use that to stop the program. Also, since we are now aborting as is the default behaviour on SIGSEGV and SIGABRT, it becomes questionable why have a custom handler at all. 2) Raising an exception inside a signal handler is undefined behaviour Although the handler by itself does not raise an exception, it is possible for the logging facility to raise one. This is a real case when logging a stack trace in particular. Stack trace is generated by creating a string "<function name> <line location>". It is possible that a function name will contain '{}' somewhere inside. This is usually the case with anonymous functions. The generated string is then passed to logging, which uses the `fmt` library to fill '{}' with remaining arguments. Since only a single argument (the stack trace string) is passed for formatting, naturally the `fmt::format` throws an exception, that it is missing a format argument. We could provide an overload which takes a single string, but that defeats the purpose of `fmt::format` raising an exception in regular code if we forget to pass an argument. Another solution is to escape the whole stack trace string, so it is valid for formatting, but this only complicates the handler even further. The simplest solution is to send the stack trace to `stderr` and avoid logging altogether. Simplify Shutdown, so it can be used in a signal handler Reviewers: florijan, mferencevic, buda, mislav.bradac Reviewed By: mferencevic, buda Subscribers: pullbot Differential Revision: https://phabricator.memgraph.io/D474
2017-06-14 22:37:23 +08:00
// Log the stacktrace and let the abort continue.
Stacktrace stacktrace;
std::cerr << "Abort signal raised" << std::endl
<< stacktrace.dump() << std::endl;
});
// Initialize bolt session data (GraphDb and Interpreter).
SessionData session_data;
// Initialize endpoint.
NetworkEndpoint endpoint = [&] {
try {
return NetworkEndpoint(FLAGS_interface, FLAGS_port);
} catch (io::network::NetworkEndpointException &e) {
LOG(FATAL) << e.what();
}
}();
// Initialize server.
ServerT server(endpoint, session_data);
auto shutdown = [&server, &session_data]() {
// Server needs to be shutdown first and then the database. This prevents a
// race condition when a transaction is accepted during server shutdown.
server.Shutdown();
session_data.db.Shutdown();
};
// register SIGTERM handler
SignalHandler::register_handler(Signal::Terminate, shutdown);
// register SIGINT handler
SignalHandler::register_handler(Signal::Interupt, shutdown);
// Start memory warning logger.
Scheduler mem_log_scheduler;
if (FLAGS_memory_warning_threshold > 0) {
mem_log_scheduler.Run(std::chrono::seconds(3), [] {
auto free_ram_mb = utils::AvailableMem() / 1024;
if (free_ram_mb < FLAGS_memory_warning_threshold)
LOG(WARNING) << "Running out of available RAM, only " << free_ram_mb
<< " MB left.";
});
}
// Start worker threads.
server.Start(FLAGS_num_workers);
return 0;
}