Merge pull request #10685 from siddhantk232/fs-cleanup

inline the usage of `nix::renameFile`, `nix::getFileType` and `nix::copyFile`
This commit is contained in:
Eelco Dolstra 2024-05-13 14:12:10 +02:00 committed by GitHub
commit 56abd341bb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 31 additions and 46 deletions

View file

@ -225,7 +225,7 @@ void LocalStore::findRoots(const Path & path, std::filesystem::file_type type, R
try { try {
if (type == std::filesystem::file_type::unknown) if (type == std::filesystem::file_type::unknown)
type = getFileType(path); type = std::filesystem::symlink_status(path).type();
if (type == std::filesystem::file_type::directory) { if (type == std::filesystem::file_type::directory) {
for (auto & i : readDirectory(path)) for (auto & i : readDirectory(path))

View file

@ -12,7 +12,7 @@ void IndirectRootStore::makeSymlink(const Path & link, const Path & target)
createSymlink(target, tempLink); createSymlink(target, tempLink);
/* Atomically replace the old one. */ /* Atomically replace the old one. */
renameFile(tempLink, link); std::filesystem::rename(tempLink, link);
} }
Path IndirectRootStore::addPermRoot(const StorePath & storePath, const Path & _gcRoot) Path IndirectRootStore::addPermRoot(const StorePath & storePath, const Path & _gcRoot)

View file

@ -64,7 +64,7 @@ protected:
AutoDelete del(tmp, false); AutoDelete del(tmp, false);
StreamToSourceAdapter source(istream); StreamToSourceAdapter source(istream);
writeFile(tmp, source); writeFile(tmp, source);
renameFile(tmp, path2); std::filesystem::rename(tmp, path2);
del.cancel(); del.cancel();
} }

View file

@ -1779,7 +1779,7 @@ void LocalStore::addBuildLog(const StorePath & drvPath, std::string_view log)
writeFile(tmpFile, compress("bzip2", log)); writeFile(tmpFile, compress("bzip2", log));
renameFile(tmpFile, logPath); std::filesystem::rename(tmpFile, logPath);
} }
std::optional<std::string> LocalStore::getVersion() std::optional<std::string> LocalStore::getVersion()

View file

@ -783,7 +783,7 @@ static void movePath(const Path & src, const Path & dst)
if (changePerm) if (changePerm)
chmod_(src, st.st_mode | S_IWUSR); chmod_(src, st.st_mode | S_IWUSR);
renameFile(src, dst); std::filesystem::rename(src, dst);
if (changePerm) if (changePerm)
chmod_(dst, st.st_mode); chmod_(dst, st.st_mode);

View file

@ -285,7 +285,7 @@ static void movePath(const Path & src, const Path & dst)
if (changePerm) if (changePerm)
chmod_(src, st.st_mode | S_IWUSR); chmod_(src, st.st_mode | S_IWUSR);
renameFile(src, dst); std::filesystem::rename(src, dst);
if (changePerm) if (changePerm)
chmod_(dst, st.st_mode); chmod_(dst, st.st_mode);
@ -372,7 +372,7 @@ bool LocalDerivationGoal::cleanupDecideWhetherDiskFull()
if (buildMode != bmCheck && status.known->isValid()) continue; if (buildMode != bmCheck && status.known->isValid()) continue;
auto p = worker.store.toRealPath(status.known->path); auto p = worker.store.toRealPath(status.known->path);
if (pathExists(chrootRootDir + p)) if (pathExists(chrootRootDir + p))
renameFile((chrootRootDir + p), p); std::filesystem::rename((chrootRootDir + p), p);
} }
return diskFull; return diskFull;
@ -421,7 +421,9 @@ static void doBind(const Path & source, const Path & target, bool optional = fal
} else if (S_ISLNK(st.st_mode)) { } else if (S_ISLNK(st.st_mode)) {
// Symlinks can (apparently) not be bind-mounted, so just copy it // Symlinks can (apparently) not be bind-mounted, so just copy it
createDirs(dirOf(target)); createDirs(dirOf(target));
copyFile(source, target, /* andDelete */ false); copyFile(
std::filesystem::path(source),
std::filesystem::path(target), false);
} else { } else {
createDirs(dirOf(target)); createDirs(dirOf(target));
writeFile(target, ""); writeFile(target, "");
@ -2568,8 +2570,11 @@ SingleDrvOutputs LocalDerivationGoal::registerOutputs()
// Replace the output by a fresh copy of itself to make sure // Replace the output by a fresh copy of itself to make sure
// that there's no stale file descriptor pointing to it // that there's no stale file descriptor pointing to it
Path tmpOutput = actualPath + ".tmp"; Path tmpOutput = actualPath + ".tmp";
copyFile(actualPath, tmpOutput, true); copyFile(
renameFile(tmpOutput, actualPath); std::filesystem::path(actualPath),
std::filesystem::path(tmpOutput), true);
std::filesystem::rename(tmpOutput, actualPath);
auto newInfo0 = newInfoFromCA(DerivationOutput::CAFloating { auto newInfo0 = newInfoFromCA(DerivationOutput::CAFloating {
.method = dof.ca.method, .method = dof.ca.method,

View file

@ -24,7 +24,7 @@ void builtinUnpackChannel(
auto entries = readDirectory(out); auto entries = readDirectory(out);
if (entries.size() != 1) if (entries.size() != 1)
throw Error("channel tarball '%s' contains more than one file", src); throw Error("channel tarball '%s' contains more than one file", src);
renameFile(entries[0].path().string(), (out + "/" + channelName)); std::filesystem::rename(entries[0].path().string(), (out + "/" + channelName));
} }
} }

View file

@ -236,12 +236,6 @@ std::vector<fs::directory_entry> readDirectory(const Path & path)
} }
fs::file_type getFileType(const Path & path)
{
return fs::symlink_status(path).type();
}
std::string readFile(const Path & path) std::string readFile(const Path & path)
{ {
AutoCloseFD fd = toDescriptor(open(path.c_str(), O_RDONLY AutoCloseFD fd = toDescriptor(open(path.c_str(), O_RDONLY
@ -588,7 +582,7 @@ void replaceSymlink(const Path & target, const Path & link)
throw; throw;
} }
renameFile(tmp, link); std::filesystem::rename(tmp, link);
break; break;
} }
@ -611,29 +605,29 @@ static void setWriteTime(const fs::path & p, const struct stat & st)
} }
#endif #endif
void copy(const fs::directory_entry & from, const fs::path & to, bool andDelete) void copyFile(const fs::path & from, const fs::path & to, bool andDelete)
{ {
#ifndef _WIN32 #ifndef _WIN32
// TODO: Rewrite the `is_*` to use `symlink_status()` // TODO: Rewrite the `is_*` to use `symlink_status()`
auto statOfFrom = lstat(from.path().c_str()); auto statOfFrom = lstat(from.c_str());
#endif #endif
auto fromStatus = from.symlink_status(); auto fromStatus = fs::symlink_status(from);
// Mark the directory as writable so that we can delete its children // Mark the directory as writable so that we can delete its children
if (andDelete && fs::is_directory(fromStatus)) { if (andDelete && fs::is_directory(fromStatus)) {
fs::permissions(from.path(), fs::perms::owner_write, fs::perm_options::add | fs::perm_options::nofollow); fs::permissions(from, fs::perms::owner_write, fs::perm_options::add | fs::perm_options::nofollow);
} }
if (fs::is_symlink(fromStatus) || fs::is_regular_file(fromStatus)) { if (fs::is_symlink(fromStatus) || fs::is_regular_file(fromStatus)) {
fs::copy(from.path(), to, fs::copy_options::copy_symlinks | fs::copy_options::overwrite_existing); fs::copy(from, to, fs::copy_options::copy_symlinks | fs::copy_options::overwrite_existing);
} else if (fs::is_directory(fromStatus)) { } else if (fs::is_directory(fromStatus)) {
fs::create_directory(to); fs::create_directory(to);
for (auto & entry : fs::directory_iterator(from.path())) { for (auto & entry : fs::directory_iterator(from)) {
copy(entry, to / entry.path().filename(), andDelete); copyFile(entry, to / entry.path().filename(), andDelete);
} }
} else { } else {
throw Error("file '%s' has an unsupported type", from.path()); throw Error("file '%s' has an unsupported type", from);
} }
#ifndef _WIN32 #ifndef _WIN32
@ -641,25 +635,15 @@ void copy(const fs::directory_entry & from, const fs::path & to, bool andDelete)
#endif #endif
if (andDelete) { if (andDelete) {
if (!fs::is_symlink(fromStatus)) if (!fs::is_symlink(fromStatus))
fs::permissions(from.path(), fs::perms::owner_write, fs::perm_options::add | fs::perm_options::nofollow); fs::permissions(from, fs::perms::owner_write, fs::perm_options::add | fs::perm_options::nofollow);
fs::remove(from.path()); fs::remove(from);
} }
} }
void copyFile(const Path & oldPath, const Path & newPath, bool andDelete)
{
return copy(fs::directory_entry(fs::path(oldPath)), fs::path(newPath), andDelete);
}
void renameFile(const Path & oldName, const Path & newName)
{
fs::rename(oldName, newName);
}
void moveFile(const Path & oldName, const Path & newName) void moveFile(const Path & oldName, const Path & newName)
{ {
try { try {
renameFile(oldName, newName); std::filesystem::rename(oldName, newName);
} catch (fs::filesystem_error & e) { } catch (fs::filesystem_error & e) {
auto oldPath = fs::path(oldName); auto oldPath = fs::path(oldName);
auto newPath = fs::path(newName); auto newPath = fs::path(newName);
@ -673,8 +657,8 @@ void moveFile(const Path & oldName, const Path & newName)
if (e.code().value() == EXDEV) { if (e.code().value() == EXDEV) {
fs::remove(newPath); fs::remove(newPath);
warn("Cant rename %s as %s, copying instead", oldName, newName); warn("Cant rename %s as %s, copying instead", oldName, newName);
copy(fs::directory_entry(oldPath), tempCopyTarget, true); copyFile(oldPath, tempCopyTarget, true);
renameFile( std::filesystem::rename(
os_string_to_string(PathViewNG { tempCopyTarget }), os_string_to_string(PathViewNG { tempCopyTarget }),
os_string_to_string(PathViewNG { newPath })); os_string_to_string(PathViewNG { newPath }));
} }

View file

@ -128,8 +128,6 @@ Descriptor openDirectory(const std::filesystem::path & path);
*/ */
std::vector<std::filesystem::directory_entry> readDirectory(const Path & path); std::vector<std::filesystem::directory_entry> readDirectory(const Path & path);
std::filesystem::file_type getFileType(const Path & path);
/** /**
* Read the contents of a file into a string. * Read the contents of a file into a string.
*/ */
@ -177,8 +175,6 @@ void createSymlink(const Path & target, const Path & link);
*/ */
void replaceSymlink(const Path & target, const Path & link); void replaceSymlink(const Path & target, const Path & link);
void renameFile(const Path & src, const Path & dst);
/** /**
* Similar to 'renameFile', but fallback to a copy+remove if `src` and `dst` * Similar to 'renameFile', but fallback to a copy+remove if `src` and `dst`
* are on a different filesystem. * are on a different filesystem.
@ -194,7 +190,7 @@ void moveFile(const Path & src, const Path & dst);
* with the guaranty that the destination will be fresh, with no stale inode * with the guaranty that the destination will be fresh, with no stale inode
* or file descriptor pointing to it). * or file descriptor pointing to it).
*/ */
void copyFile(const Path & oldPath, const Path & newPath, bool andDelete); void copyFile(const std::filesystem::path & from, const std::filesystem::path & to, bool andDelete);
/** /**
* Automatic cleanup of resources. * Automatic cleanup of resources.