diff options
Diffstat (limited to 'src/util/fs_helpers.h')
-rw-r--r-- | src/util/fs_helpers.h | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/src/util/fs_helpers.h b/src/util/fs_helpers.h new file mode 100644 index 0000000000..e7db01a89b --- /dev/null +++ b/src/util/fs_helpers.h @@ -0,0 +1,63 @@ +// Copyright (c) 2009-2010 Satoshi Nakamoto +// Copyright (c) 2009-2023 The Bitcoin Core developers +// Distributed under the MIT software license, see the accompanying +// file COPYING or http://www.opensource.org/licenses/mit-license.php. + +#ifndef BITCOIN_UTIL_FS_HELPERS_H +#define BITCOIN_UTIL_FS_HELPERS_H + +#include <util/fs.h> + +#include <cstdint> +#include <cstdio> +#include <iosfwd> +#include <limits> + +/** + * Ensure file contents are fully committed to disk, using a platform-specific + * feature analogous to fsync(). + */ +bool FileCommit(FILE* file); + +/** + * Sync directory contents. This is required on some environments to ensure that + * newly created files are committed to disk. + */ +void DirectoryCommit(const fs::path& dirname); + +bool TruncateFile(FILE* file, unsigned int length); +int RaiseFileDescriptorLimit(int nMinFD); +void AllocateFileRange(FILE* file, unsigned int offset, unsigned int length); + +/** + * Rename src to dest. + * @return true if the rename was successful. + */ +[[nodiscard]] bool RenameOver(fs::path src, fs::path dest); + +bool LockDirectory(const fs::path& directory, const fs::path& lockfile_name, bool probe_only = false); +void UnlockDirectory(const fs::path& directory, const fs::path& lockfile_name); +bool DirIsWritable(const fs::path& directory); +bool CheckDiskSpace(const fs::path& dir, uint64_t additional_bytes = 0); + +/** Get the size of a file by scanning it. + * + * @param[in] path The file path + * @param[in] max Stop seeking beyond this limit + * @return The file size or max + */ +std::streampos GetFileSize(const char* path, std::streamsize max = std::numeric_limits<std::streamsize>::max()); + +/** Release all directory locks. This is used for unit testing only, at runtime + * the global destructor will take care of the locks. + */ +void ReleaseDirectoryLocks(); + +bool TryCreateDirectories(const fs::path& p); +fs::path GetDefaultDataDir(); + +#ifdef WIN32 +fs::path GetSpecialFolderPath(int nFolder, bool fCreate = true); +#endif + +#endif // BITCOIN_UTIL_FS_HELPERS_H |