Move file related utilities to files.hpp

nano/core_test/block_store.cpp

@@ -1,6 +1,7 @@
 #include <nano/crypto_lib/random_pool.hpp>
 #include <nano/lib/block_type.hpp>
 #include <nano/lib/blocks.hpp>
+#include <nano/lib/files.hpp>
 #include <nano/lib/lmdbconfig.hpp>
 #include <nano/lib/logging.hpp>
 #include <nano/lib/stats.hpp>

nano/core_test/entry.cpp

@@ -1,3 +1,4 @@
+#include <nano/lib/files.hpp>
 #include <nano/lib/logging.hpp>
 #include <nano/lib/memory.hpp>
 #include <nano/secure/utility.hpp>

nano/core_test/utility.cpp

@@ -1,3 +1,4 @@
+#include <nano/lib/files.hpp>
 #include <nano/lib/optional_ptr.hpp>
 #include <nano/lib/rate_limiting.hpp>
 #include <nano/lib/relaxed_atomic.hpp>

nano/lib/CMakeLists.txt

@@ -51,6 +51,8 @@ add_library(
   epochs.hpp
   errors.hpp
   errors.cpp
+  files.hpp
+  files.cpp
   fwd.hpp
   id_dispenser.hpp
   interval.hpp

nano/lib/assert.cpp

@@ -1,6 +1,9 @@
 #include <nano/lib/assert.hpp>
+#include <nano/lib/files.hpp>
 #include <nano/lib/stacktrace.hpp>
 
+#include <boost/dll/runtime_symbol_info.hpp>
+
 #include <iostream>
 
 /*

nano/lib/files.cpp

@@ -0,0 +1,85 @@
+#include <nano/lib/files.hpp>
+
+#include <cstddef>
+#include <cstring>
+#include <fstream>
+#include <iostream>
+#include <limits>
+#include <sstream>
+#include <string_view>
+#include <thread>
+
+#ifndef _WIN32
+#include <sys/resource.h>
+#endif
+
+std::size_t nano::get_file_descriptor_limit ()
+{
+	std::size_t fd_limit = std::numeric_limits<std::size_t>::max ();
+#ifndef _WIN32
+	rlimit limit{};
+	if (getrlimit (RLIMIT_NOFILE, &limit) == 0)
+	{
+		fd_limit = static_cast<std::size_t> (limit.rlim_cur);
+	}
+#endif
+	return fd_limit;
+}
+
+void nano::set_file_descriptor_limit (std::size_t limit)
+{
+#ifndef _WIN32
+	rlimit fd_limit{};
+	if (-1 == getrlimit (RLIMIT_NOFILE, &fd_limit))
+	{
+		std::cerr << "WARNING: Unable to get current limits for the number of open file descriptors: " << std::strerror (errno);
+		return;
+	}
+
+	if (fd_limit.rlim_cur >= limit)
+	{
+		return;
+	}
+
+	fd_limit.rlim_cur = std::min (static_cast<rlim_t> (limit), fd_limit.rlim_max);
+	if (-1 == setrlimit (RLIMIT_NOFILE, &fd_limit))
+	{
+		std::cerr << "WARNING: Unable to set limits for the number of open file descriptors: " << std::strerror (errno);
+		return;
+	}
+#endif
+}
+
+void nano::initialize_file_descriptor_limit ()
+{
+	nano::set_file_descriptor_limit (DEFAULT_FILE_DESCRIPTOR_LIMIT);
+	auto limit = nano::get_file_descriptor_limit ();
+	if (limit < DEFAULT_FILE_DESCRIPTOR_LIMIT)
+	{
+		std::cerr << "WARNING: Current file descriptor limit of " << limit << " is lower than the " << DEFAULT_FILE_DESCRIPTOR_LIMIT << " recommended. Node was unable to change it." << std::endl;
+	}
+}
+
+void nano::remove_all_files_in_dir (std::filesystem::path const & dir)
+{
+	for (auto & p : std::filesystem::directory_iterator (dir))
+	{
+		auto path = p.path ();
+		if (std::filesystem::is_regular_file (path))
+		{
+			std::filesystem::remove (path);
+		}
+	}
+}
+
+void nano::move_all_files_to_dir (std::filesystem::path const & from, std::filesystem::path const & to)
+{
+	for (auto & p : std::filesystem::directory_iterator (from))
+	{
+		auto path = p.path ();
+		if (std::filesystem::is_regular_file (path))
+		{
+			std::filesystem::rename (path, to / path.filename ());
+		}
+	}
+}

nano/lib/files.hpp

@@ -0,0 +1,48 @@
+#pragma once
+
+#include <filesystem>
+
+namespace nano
+{
+/*
+ * Functions for managing filesystem permissions, platform specific
+ */
+void set_umask ();
+void set_secure_perm_directory (std::filesystem::path const & path);
+void set_secure_perm_directory (std::filesystem::path const & path, std::error_code & ec);
+void set_secure_perm_file (std::filesystem::path const & path);
+void set_secure_perm_file (std::filesystem::path const & path, std::error_code & ec);
+
+/*
+ * Function to check if running Windows as an administrator
+ */
+bool is_windows_elevated ();
+
+/*
+ * Function to check if the Windows Event log registry key exists
+ */
+bool event_log_reg_entry_exists ();
+
+/*
+ * Create the load memory addresses for the executable and shared libraries.
+ */
+void create_load_memory_address_files ();
+
+/**
+ * Some systems, especially in virtualized environments, may have very low file descriptor limits,
+ * causing the node to fail. This function attempts to query the limit and returns the value. If the
+ * limit cannot be queried, or running on a Windows system, this returns max-value of std::size_t.
+ * Increasing the limit programmatically can be done only for the soft limit, the hard one requiring
+ * super user permissions to modify.
+ */
+std::size_t get_file_descriptor_limit ();
+void set_file_descriptor_limit (std::size_t limit);
+/**
+ * This should be called from entry points. It sets the file descriptor limit to the maximum allowed and logs any errors.
+ */
+constexpr std::size_t DEFAULT_FILE_DESCRIPTOR_LIMIT = 16384;
+void initialize_file_descriptor_limit ();
+
+void remove_all_files_in_dir (std::filesystem::path const & dir);
+void move_all_files_to_dir (std::filesystem::path const & from, std::filesystem::path const & to);
+}

nano/lib/jsonconfig.cpp

@@ -1,4 +1,5 @@
 #include <nano/boost/asio/ip/address_v6.hpp>
+#include <nano/lib/files.hpp>
 #include <nano/lib/jsonconfig.hpp>
 
 #include <boost/property_tree/json_parser.hpp>

nano/lib/jsonconfig.hpp

@@ -7,6 +7,7 @@
 #include <boost/lexical_cast.hpp>
 #include <boost/property_tree/ptree.hpp>
 
+#include <filesystem>
 #include <fstream>
 
 namespace boost

nano/lib/plat/default/debugging.cpp

@@ -1,3 +1,4 @@
+#include <nano/lib/files.hpp>
 #include <nano/lib/utility.hpp>
 
 void nano::create_load_memory_address_files ()

nano/lib/plat/linux/debugging.cpp

@@ -1,3 +1,4 @@
+#include <nano/lib/files.hpp>
 #include <nano/lib/utility.hpp>
 
 #include <cstring>

nano/lib/plat/posix/perms.cpp

@@ -1,3 +1,4 @@
+#include <nano/lib/files.hpp>
 #include <nano/lib/utility.hpp>
 
 #include <sys/stat.h>

nano/lib/plat/windows/perms.cpp

@@ -1,3 +1,4 @@
+#include <nano/lib/files.hpp>
 #include <nano/lib/utility.hpp>
 
 // clang-format off

nano/lib/plat/windows/priority.cpp

@@ -1,4 +1,5 @@
 #include <windows.h>
+
 namespace nano
 {
 void work_thread_reprioritize ()

nano/lib/tomlconfig.cpp

@@ -1,4 +1,5 @@
 #include <nano/boost/asio/ip/address_v6.hpp>
+#include <nano/lib/files.hpp>
 #include <nano/lib/tomlconfig.hpp>
 
 nano::tomlconfig::tomlconfig () :

nano/lib/tomlconfig.hpp

@@ -6,6 +6,8 @@
 #include <boost/lexical_cast.hpp>
 #include <boost/optional.hpp>
 
+#include <filesystem>
+
 #include <cpptoml.h>
 
 namespace boost

nano/lib/utility.cpp

@@ -1,92 +1,7 @@
-#include <nano/lib/stacktrace.hpp>
 #include <nano/lib/utility.hpp>
 
-#include <boost/dll/runtime_symbol_info.hpp>
 #include <boost/program_options.hpp>
 
-#include <cstddef>
-#include <fstream>
-#include <iostream>
-#include <limits>
-#include <sstream>
-#include <string_view>
-#include <thread>
-
-#ifndef _WIN32
-#include <sys/resource.h>
-#endif
-
-std::size_t nano::get_file_descriptor_limit ()
-{
-	std::size_t fd_limit = std::numeric_limits<std::size_t>::max ();
-#ifndef _WIN32
-	rlimit limit{};
-	if (getrlimit (RLIMIT_NOFILE, &limit) == 0)
-	{
-		fd_limit = static_cast<std::size_t> (limit.rlim_cur);
-	}
-#endif
-	return fd_limit;
-}
-
-void nano::set_file_descriptor_limit (std::size_t limit)
-{
-#ifndef _WIN32
-	rlimit fd_limit{};
-	if (-1 == getrlimit (RLIMIT_NOFILE, &fd_limit))
-	{
-		std::cerr << "WARNING: Unable to get current limits for the number of open file descriptors: " << std::strerror (errno);
-		return;
-	}
-
-	if (fd_limit.rlim_cur >= limit)
-	{
-		return;
-	}
-
-	fd_limit.rlim_cur = std::min (static_cast<rlim_t> (limit), fd_limit.rlim_max);
-	if (-1 == setrlimit (RLIMIT_NOFILE, &fd_limit))
-	{
-		std::cerr << "WARNING: Unable to set limits for the number of open file descriptors: " << std::strerror (errno);
-		return;
-	}
-#endif
-}
-
-void nano::initialize_file_descriptor_limit ()
-{
-	nano::set_file_descriptor_limit (DEFAULT_FILE_DESCRIPTOR_LIMIT);
-	auto limit = nano::get_file_descriptor_limit ();
-	if (limit < DEFAULT_FILE_DESCRIPTOR_LIMIT)
-	{
-		std::cerr << "WARNING: Current file descriptor limit of " << limit << " is lower than the " << DEFAULT_FILE_DESCRIPTOR_LIMIT << " recommended. Node was unable to change it." << std::endl;
-	}
-}
-
-void nano::remove_all_files_in_dir (std::filesystem::path const & dir)
-{
-	for (auto & p : std::filesystem::directory_iterator (dir))
-	{
-		auto path = p.path ();
-		if (std::filesystem::is_regular_file (path))
-		{
-			std::filesystem::remove (path);
-		}
-	}
-}
-
-void nano::move_all_files_to_dir (std::filesystem::path const & from, std::filesystem::path const & to)
-{
-	for (auto & p : std::filesystem::directory_iterator (from))
-	{
-		auto path = p.path ();
-		if (std::filesystem::is_regular_file (path))
-		{
-			std::filesystem::rename (path, to / path.filename ());
-		}
-	}
-}
-
 // Issue #3748
 void nano::sort_options_description (const boost::program_options::options_description & source, boost::program_options::options_description & target)
 {

nano/lib/utility.hpp

@@ -6,10 +6,7 @@
 
 #include <boost/lexical_cast.hpp>
 
-#include <cassert>
-#include <filesystem>
 #include <functional>
-#include <mutex>
 #include <sstream>
 #include <vector>
 
@@ -31,48 +28,6 @@ namespace nano
 // Lower priority of calling work generating thread
 void work_thread_reprioritize ();
 
-/*
- * Functions for managing filesystem permissions, platform specific
- */
-void set_umask ();
-void set_secure_perm_directory (std::filesystem::path const & path);
-void set_secure_perm_directory (std::filesystem::path const & path, std::error_code & ec);
-void set_secure_perm_file (std::filesystem::path const & path);
-void set_secure_perm_file (std::filesystem::path const & path, std::error_code & ec);
-
-/*
- * Function to check if running Windows as an administrator
- */
-bool is_windows_elevated ();
-
-/*
- * Function to check if the Windows Event log registry key exists
- */
-bool event_log_reg_entry_exists ();
-
-/*
- * Create the load memory addresses for the executable and shared libraries.
- */
-void create_load_memory_address_files ();
-
-/**
- * Some systems, especially in virtualized environments, may have very low file descriptor limits,
- * causing the node to fail. This function attempts to query the limit and returns the value. If the
- * limit cannot be queried, or running on a Windows system, this returns max-value of std::size_t.
- * Increasing the limit programmatically can be done only for the soft limit, the hard one requiring
- * super user permissions to modify.
- */
-std::size_t get_file_descriptor_limit ();
-void set_file_descriptor_limit (std::size_t limit);
-/**
- * This should be called from entry points. It sets the file descriptor limit to the maximum allowed and logs any errors.
- */
-constexpr std::size_t DEFAULT_FILE_DESCRIPTOR_LIMIT = 16384;
-void initialize_file_descriptor_limit ();
-
-void remove_all_files_in_dir (std::filesystem::path const & dir);
-void move_all_files_to_dir (std::filesystem::path const & from, std::filesystem::path const & to);
-
 template <class InputIt, class OutputIt, class Pred, class Func>
 void transform_if (InputIt first, InputIt last, OutputIt dest, Pred pred, Func transform)
 {

nano/nano_node/daemon.cpp

@@ -1,4 +1,5 @@
 #include <nano/boost/process/child.hpp>
+#include <nano/lib/files.hpp>
 #include <nano/lib/signal_manager.hpp>
 #include <nano/lib/stacktrace.hpp>
 #include <nano/lib/thread_runner.hpp>

nano/nano_node/entry.cpp

@@ -2,6 +2,7 @@
 #include <nano/lib/block_type.hpp>
 #include <nano/lib/blocks.hpp>
 #include <nano/lib/cli.hpp>
+#include <nano/lib/files.hpp>
 #include <nano/lib/thread_runner.hpp>
 #include <nano/lib/utility.hpp>
 #include <nano/lib/work_version.hpp>