fs_helpers.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-present 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 <ios>
#include <limits>
#include <optional>
#include <string>
 
#ifdef __APPLE__
enum class FSType {
    EXFAT,
    OTHER,
    ERROR
};

FSType GetFilesystemType(const fs::path& path);
#endif

bool FileCommit(FILE* file);

void DirectoryCommit(const fs::path& dirname);
 
bool TruncateFile(FILE* file, uint64_t length);

inline int FileSeek64(FILE* file, int64_t offset, int origin)
{
#if defined(WIN32)
    return _fseeki64(file, offset, origin);
#else
    return std::fseek(file, offset, origin);
#endif
}

inline int64_t FileTell64(FILE* file)
{
#if defined(WIN32)
    return _ftelli64(file);
#else
    return std::ftell(file);
#endif
}

int RaiseFileDescriptorLimit(int min_fd);
 
void AllocateFileRange(FILE* file, uint64_t offset, unsigned int length);

[[nodiscard]] bool RenameOver(fs::path src, fs::path dest);
 
namespace util {
enum class LockResult {
    Success,
    ErrorWrite,
    ErrorLock,
};
[[nodiscard]] LockResult LockDirectory(const fs::path& directory, const fs::path& lockfile_name, bool probe_only = false);
} // namespace util
void UnlockDirectory(const fs::path& directory, const fs::path& lockfile_name);
bool CheckDiskSpace(const fs::path& dir, uint64_t additional_bytes = 0);

std::streampos GetFileSize(const char* path, std::streamsize max = std::numeric_limits<std::streamsize>::max());

void ReleaseDirectoryLocks();
 
bool TryCreateDirectories(const fs::path& p);
fs::path GetDefaultDataDir();

std::string PermsToSymbolicString(fs::perms p);
std::optional<fs::perms> InterpretPermString(const std::string& s);

bool IsDirWritable(const fs::path& dir_path);
 
#ifdef WIN32
fs::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
#endif
 
#endif // BITCOIN_UTIL_FS_HELPERS_H