Bitcoin Core  25.99.0
P2P Digital Currency
Functions
fs_helpers.h File Reference
#include <util/fs.h>
#include <cstdint>
#include <cstdio>
#include <iosfwd>
#include <limits>
Include dependency graph for fs_helpers.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

bool FileCommit (FILE *file)
 Ensure file contents are fully committed to disk, using a platform-specific feature analogous to fsync(). More...
 
void DirectoryCommit (const fs::path &dirname)
 Sync directory contents. More...
 
bool TruncateFile (FILE *file, unsigned int length)
 
int RaiseFileDescriptorLimit (int nMinFD)
 this function tries to raise the file descriptor limit to the requested number. More...
 
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 is advisory, and the range specified in the arguments will never contain live data More...
 
bool RenameOver (fs::path src, fs::path dest)
 Rename src to dest. More...
 
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)
 
std::streampos GetFileSize (const char *path, std::streamsize max=std::numeric_limits< std::streamsize >::max())
 Get the size of a file by scanning it. More...
 
void ReleaseDirectoryLocks ()
 Release all directory locks. More...
 
bool TryCreateDirectories (const fs::path &p)
 Ignores exceptions thrown by create_directories if the requested directory exists. More...
 
fs::path GetDefaultDataDir ()
 

Function Documentation

◆ AllocateFileRange()

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 is advisory, and the range specified in the arguments will never contain live data

Definition at line 199 of file fs_helpers.cpp.

Here is the caller graph for this function:

◆ CheckDiskSpace()

bool CheckDiskSpace ( const fs::path dir,
uint64_t  additional_bytes = 0 
)

Definition at line 105 of file fs_helpers.cpp.

Here is the caller graph for this function:

◆ DirectoryCommit()

void DirectoryCommit ( const fs::path dirname)

Sync directory contents.

This is required on some environments to ensure that newly created files are committed to disk.

Definition at line 151 of file fs_helpers.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DirIsWritable()

bool DirIsWritable ( const fs::path directory)

Definition at line 92 of file fs_helpers.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FileCommit()

bool FileCommit ( FILE *  file)

Ensure file contents are fully committed to disk, using a platform-specific feature analogous to fsync().

Definition at line 120 of file fs_helpers.cpp.

Here is the caller graph for this function:

◆ GetDefaultDataDir()

fs::path GetDefaultDataDir ( )

Definition at line 686 of file args.cpp.

Here is the caller graph for this function:

◆ GetFileSize()

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

Get the size of a file by scanning it.

Parameters
[in]pathThe file path
[in]maxStop seeking beyond this limit
Returns
The file size or max

Definition at line 113 of file fs_helpers.cpp.

Here is the caller graph for this function:

◆ LockDirectory()

bool LockDirectory ( const fs::path directory,
const fs::path lockfile_name,
bool  probe_only = false 
)

Definition at line 56 of file fs_helpers.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RaiseFileDescriptorLimit()

int RaiseFileDescriptorLimit ( int  nMinFD)

this function tries to raise the file descriptor limit to the requested number.

It returns the actual file descriptor limit (which may be more or less than nMinFD)

Definition at line 175 of file fs_helpers.cpp.

Here is the caller graph for this function:

◆ ReleaseDirectoryLocks()

void ReleaseDirectoryLocks ( )

Release all directory locks.

This is used for unit testing only, at runtime the global destructor will take care of the locks.

Definition at line 86 of file fs_helpers.cpp.

Here is the caller graph for this function:

◆ RenameOver()

bool RenameOver ( fs::path  src,
fs::path  dest 
)

Rename src to dest.

Returns
true if the rename was successful.

Definition at line 261 of file fs_helpers.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TruncateFile()

bool TruncateFile ( FILE *  file,
unsigned int  length 
)

Definition at line 162 of file fs_helpers.cpp.

Here is the caller graph for this function:

◆ TryCreateDirectories()

bool TryCreateDirectories ( const fs::path p)

Ignores exceptions thrown by create_directories if the requested directory exists.

Specifically handles case where path p exists, but it wasn't possible for the user to write to the parent directory.

Definition at line 284 of file fs_helpers.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ UnlockDirectory()

void UnlockDirectory ( const fs::path directory,
const fs::path lockfile_name 
)

Definition at line 80 of file fs_helpers.cpp.

Here is the call graph for this function:
Here is the caller graph for this function: