Bitcoin Core  27.99.0
P2P Digital Currency
fs_helpers.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2023 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_UTIL_FS_HELPERS_H
7 #define BITCOIN_UTIL_FS_HELPERS_H
8 
9 #include <util/fs.h>
10 
11 #include <cstdint>
12 #include <cstdio>
13 #include <iosfwd>
14 #include <limits>
15 
20 bool FileCommit(FILE* file);
21 
26 void DirectoryCommit(const fs::path& dirname);
27 
28 bool TruncateFile(FILE* file, unsigned int length);
29 int RaiseFileDescriptorLimit(int nMinFD);
30 void AllocateFileRange(FILE* file, unsigned int offset, unsigned int length);
31 
36 [[nodiscard]] bool RenameOver(fs::path src, fs::path dest);
37 
38 namespace util {
39 enum class LockResult {
40  Success,
41  ErrorWrite,
42  ErrorLock,
43 };
44 [[nodiscard]] LockResult LockDirectory(const fs::path& directory, const fs::path& lockfile_name, bool probe_only = false);
45 } // namespace util
46 void UnlockDirectory(const fs::path& directory, const fs::path& lockfile_name);
47 bool CheckDiskSpace(const fs::path& dir, uint64_t additional_bytes = 0);
48 
55 std::streampos GetFileSize(const char* path, std::streamsize max = std::numeric_limits<std::streamsize>::max());
56 
61 
62 bool TryCreateDirectories(const fs::path& p);
64 
65 #ifdef WIN32
66 fs::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
67 #endif
68 
69 #endif // BITCOIN_UTIL_FS_HELPERS_H
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:33
fs::path GetDefaultDataDir()
Definition: args.cpp:697
bool RenameOver(fs::path src, fs::path dest)
Rename src to dest.
Definition: fs_helpers.cpp:248
int RaiseFileDescriptorLimit(int nMinFD)
this function tries to raise the file descriptor limit to the requested number.
Definition: fs_helpers.cpp:162
std::streampos GetFileSize(const char *path, std::streamsize max=std::numeric_limits< std::streamsize >::max())
Get the size of a file by scanning it.
Definition: fs_helpers.cpp:100
void DirectoryCommit(const fs::path &dirname)
Sync directory contents.
Definition: fs_helpers.cpp:138
void ReleaseDirectoryLocks()
Release all directory locks.
Definition: fs_helpers.cpp:86
bool TryCreateDirectories(const fs::path &p)
Ignores exceptions thrown by create_directories if the requested directory exists.
Definition: fs_helpers.cpp:260
void AllocateFileRange(FILE *file, unsigned int offset, unsigned int length)
this function tries to make a particular range of a file allocated (corresponding to disk space) it i...
Definition: fs_helpers.cpp:186
bool TruncateFile(FILE *file, unsigned int length)
Definition: fs_helpers.cpp:149
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes=0)
Definition: fs_helpers.cpp:92
bool FileCommit(FILE *file)
Ensure file contents are fully committed to disk, using a platform-specific feature analogous to fsyn...
Definition: fs_helpers.cpp:107
void UnlockDirectory(const fs::path &directory, const fs::path &lockfile_name)
Definition: fs_helpers.cpp:80
LockResult
Definition: fs_helpers.h:39
LockResult LockDirectory(const fs::path &directory, const fs::path &lockfile_name, bool probe_only)
Definition: fs_helpers.cpp:52