monero/src/common/util.h

212 lines
6.1 KiB
C
Raw Normal View History

// Copyright (c) 2014-2017, The Monero Project
2014-07-23 13:03:52 +00:00
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
// of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be
// used to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
//
// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
2014-03-03 22:07:58 +00:00
#pragma once
#include <boost/thread/locks.hpp>
#include <boost/thread/mutex.hpp>
#include <system_error>
#include <csignal>
#include <cstdio>
#include <functional>
#include <memory>
#include <string>
2014-03-03 22:07:58 +00:00
#ifdef _WIN32
#include "windows.h"
#include "misc_log_ex.h"
#endif
2014-03-03 22:07:58 +00:00
#include "crypto/hash.h"
2014-09-10 00:18:23 +00:00
/*! \brief Various Tools
*
*
*
*/
2014-03-03 22:07:58 +00:00
namespace tools
{
//! Functional class for closing C file handles.
struct close_file
{
void operator()(std::FILE* handle) const noexcept
{
if (handle)
{
std::fclose(handle);
}
}
};
//! A file restricted to process owner AND process. Deletes file on destruction.
class private_file {
std::unique_ptr<std::FILE, close_file> m_handle;
std::string m_filename;
private_file(std::FILE* handle, std::string&& filename) noexcept;
public:
//! `handle() == nullptr && filename.empty()`.
private_file() noexcept;
/*! \return File only readable by owner and only used by this process
OR `private_file{}` on error. */
static private_file create(std::string filename);
private_file(private_file&&) = default;
private_file& operator=(private_file&&) = default;
//! Deletes `filename()` and closes `handle()`.
~private_file() noexcept;
std::FILE* handle() const noexcept { return m_handle.get(); }
const std::string& filename() const noexcept { return m_filename; }
};
2014-09-10 00:18:23 +00:00
/*! \brief Returns the default data directory.
*
* \details Windows < Vista: C:\\Documents and Settings\\Username\\Application Data\\CRYPTONOTE_NAME
*
* Windows >= Vista: C:\\Users\\Username\\AppData\\Roaming\\CRYPTONOTE_NAME
*
* Mac: ~/Library/Application Support/CRYPTONOTE_NAME
*
* Unix: ~/.CRYPTONOTE_NAME
*/
2014-03-03 22:07:58 +00:00
std::string get_default_data_dir();
2014-09-10 00:18:23 +00:00
2015-03-20 20:40:54 +00:00
#ifdef WIN32
/**
* @brief
*
* @param nfolder
* @param iscreate
*
* @return
*/
std::string get_special_folder_path(int nfolder, bool iscreate);
#endif
2014-09-11 14:36:39 +00:00
/*! \brief Returns the OS version string
2014-09-10 00:18:23 +00:00
*
* \details This is a wrapper around the primitives
* get_windows_version_display_string() and
* get_nix_version_display_string()
*/
2014-03-03 22:07:58 +00:00
std::string get_os_version_string();
2014-09-10 00:18:23 +00:00
2014-09-11 14:36:39 +00:00
/*! \brief creates directories for a path
2014-09-10 00:18:23 +00:00
*
* wrapper around boost::filesyste::create_directories.
* (ensure-directory-exists): greenspun's tenth rule in action!
*/
2014-03-03 22:07:58 +00:00
bool create_directories_if_necessary(const std::string& path);
2014-09-10 00:18:23 +00:00
/*! \brief std::rename wrapper for nix and something strange for windows.
*/
2014-03-03 22:07:58 +00:00
std::error_code replace_file(const std::string& replacement_name, const std::string& replaced_name);
bool sanitize_locale();
bool on_startup();
2014-09-11 14:36:39 +00:00
/*! \brief Defines a signal handler for win32 and *nix
2014-09-10 00:18:23 +00:00
*/
2014-03-20 11:46:11 +00:00
class signal_handler
{
public:
2014-09-10 00:18:23 +00:00
/*! \brief installs a signal handler */
2014-03-20 11:46:11 +00:00
template<typename T>
static bool install(T t)
{
#if defined(WIN32)
bool r = TRUE == ::SetConsoleCtrlHandler(&win_handler, TRUE);
if (r)
{
m_handler = t;
}
return r;
#else
/* Only blocks SIGINT, SIGTERM and SIGPIPE */
2014-03-20 11:46:11 +00:00
signal(SIGINT, posix_handler);
signal(SIGTERM, posix_handler);
signal(SIGPIPE, SIG_IGN);
2014-03-20 11:46:11 +00:00
m_handler = t;
return true;
#endif
}
private:
#if defined(WIN32)
2014-09-11 14:36:39 +00:00
/*! \brief Handler for win */
2014-05-03 16:19:43 +00:00
static BOOL WINAPI win_handler(DWORD type)
2014-03-20 11:46:11 +00:00
{
if (CTRL_C_EVENT == type || CTRL_BREAK_EVENT == type)
{
handle_signal(type);
2014-03-20 11:46:11 +00:00
}
else
{
Change logging to easylogging++ This replaces the epee and data_loggers logging systems with a single one, and also adds filename:line and explicit severity levels. Categories may be defined, and logging severity set by category (or set of categories). epee style 0-4 log level maps to a sensible severity configuration. Log files now also rotate when reaching 100 MB. To select which logs to output, use the MONERO_LOGS environment variable, with a comma separated list of categories (globs are supported), with their requested severity level after a colon. If a log matches more than one such setting, the last one in the configuration string applies. A few examples: This one is (mostly) silent, only outputting fatal errors: MONERO_LOGS=*:FATAL This one is very verbose: MONERO_LOGS=*:TRACE This one is totally silent (logwise): MONERO_LOGS="" This one outputs all errors and warnings, except for the "verify" category, which prints just fatal errors (the verify category is used for logs about incoming transactions and blocks, and it is expected that some/many will fail to verify, hence we don't want the spam): MONERO_LOGS=*:WARNING,verify:FATAL Log levels are, in decreasing order of priority: FATAL, ERROR, WARNING, INFO, DEBUG, TRACE Subcategories may be added using prefixes and globs. This example will output net.p2p logs at the TRACE level, but all other net* logs only at INFO: MONERO_LOGS=*:ERROR,net*:INFO,net.p2p:TRACE Logs which are intended for the user (which Monero was using a lot through epee, but really isn't a nice way to go things) should use the "global" category. There are a few helper macros for using this category, eg: MGINFO("this shows up by default") or MGINFO_RED("this is red"), to try to keep a similar look and feel for now. Existing epee log macros still exist, and map to the new log levels, but since they're used as a "user facing" UI element as much as a logging system, they often don't map well to log severities (ie, a log level 0 log may be an error, or may be something we want the user to see, such as an important info). In those cases, I tried to use the new macros. In other cases, I left the existing macros in. When modifying logs, it is probably best to switch to the new macros with explicit levels. The --log-level options and set_log commands now also accept category settings, in addition to the epee style log levels.
2017-01-01 16:34:23 +00:00
MGINFO_RED("Got control signal " << type << ". Exiting without saving...");
2014-03-20 11:46:11 +00:00
return FALSE;
}
return TRUE;
}
#else
2014-09-11 14:36:39 +00:00
/*! \brief handler for NIX */
static void posix_handler(int type)
2014-03-20 11:46:11 +00:00
{
handle_signal(type);
2014-03-20 11:46:11 +00:00
}
#endif
2014-09-11 14:36:39 +00:00
/*! \brief calles m_handler */
static void handle_signal(int type)
2014-03-20 11:46:11 +00:00
{
static boost::mutex m_mutex;
boost::unique_lock<boost::mutex> lock(m_mutex);
m_handler(type);
2014-03-20 11:46:11 +00:00
}
2014-09-11 14:36:39 +00:00
/*! \brief where the installed handler is stored */
static std::function<void(int)> m_handler;
2014-03-20 11:46:11 +00:00
};
void set_strict_default_file_permissions(bool strict);
void set_max_concurrency(unsigned n);
unsigned get_max_concurrency();
bool is_local_address(const std::string &address);
int vercmp(const char *v0, const char *v1); // returns < 0, 0, > 0, similar to strcmp, but more human friendly than lexical - does not attempt to validate
2017-02-20 20:46:50 +00:00
bool sha256sum(const uint8_t *data, size_t len, crypto::hash &hash);
2017-02-20 20:46:50 +00:00
bool sha256sum(const std::string &filename, crypto::hash &hash);
2014-03-03 22:07:58 +00:00
}