Index: llvm/trunk/include/llvm/Support/FileUtilities.h =================================================================== --- llvm/trunk/include/llvm/Support/FileUtilities.h +++ llvm/trunk/include/llvm/Support/FileUtilities.h @@ -14,6 +14,8 @@ #ifndef LLVM_SUPPORT_FILEUTILITIES_H #define LLVM_SUPPORT_FILEUTILITIES_H +#include "llvm/ADT/StringRef.h" +#include "llvm/Support/Errc.h" #include "llvm/Support/FileSystem.h" #include "llvm/Support/Path.h" @@ -72,6 +74,11 @@ /// will not be removed when the object is destroyed. void releaseFile() { DeleteIt = false; } }; + + /// Creates a unique file with name according to the given \p TempPathModel, + /// writes content of \p Buffer to the file and renames it to \p FinalPath. + llvm::Error writeFileAtomically(StringRef TempPathModel, StringRef FinalPath, + StringRef Buffer); } // End llvm namespace #endif Index: llvm/trunk/lib/Support/FileUtilities.cpp =================================================================== --- llvm/trunk/lib/Support/FileUtilities.cpp +++ llvm/trunk/lib/Support/FileUtilities.cpp @@ -15,6 +15,7 @@ #include "llvm/ADT/SmallString.h" #include "llvm/Support/ErrorOr.h" #include "llvm/Support/MemoryBuffer.h" +#include "llvm/Support/Path.h" #include "llvm/Support/raw_ostream.h" #include #include @@ -264,3 +265,37 @@ return CompareFailed; } + +Error llvm::writeFileAtomically(StringRef TempPathModel, StringRef FinalPath, + StringRef Buffer) { + SmallString<128> GeneratedUniqPath; + int TempFD; + if (const std::error_code Error = sys::fs::createUniqueFile( + TempPathModel.str(), TempFD, GeneratedUniqPath)) { + return createStringError( + Error, "failed to create temporary file with model \"%s\"", + TempPathModel.str().c_str()); + } + + raw_fd_ostream OS(TempFD, /*shouldClose=*/true); + OS.write(Buffer.data(), Buffer.size()); + OS.close(); + TempFD = -1; + + if (OS.has_error()) { + const std::error_code Error = OS.error(); + OS.clear_error(); + return createStringError(Error, "failed to write to \"%s\"", + GeneratedUniqPath.c_str()); + } + + if (const std::error_code Error = + sys::fs::rename(/*from=*/GeneratedUniqPath.c_str(), + /*to=*/FinalPath.str().c_str())) { + return createStringError(Error, "failed to rename file \"%s\" to \"%s\"", + GeneratedUniqPath.c_str(), + FinalPath.str().c_str()); + } + + return Error::success(); +} Index: llvm/trunk/unittests/Support/CMakeLists.txt =================================================================== --- llvm/trunk/unittests/Support/CMakeLists.txt +++ llvm/trunk/unittests/Support/CMakeLists.txt @@ -33,6 +33,7 @@ FileCheckTest.cpp FileCollectorTest.cpp FileOutputBufferTest.cpp + FileUtilitiesTest.cpp FormatVariadicTest.cpp GlobPatternTest.cpp Host.cpp Index: llvm/trunk/unittests/Support/FileUtilitiesTest.cpp =================================================================== --- llvm/trunk/unittests/Support/FileUtilitiesTest.cpp +++ llvm/trunk/unittests/Support/FileUtilitiesTest.cpp @@ -0,0 +1,52 @@ +//===- llvm/unittest/Support/FileUtilitiesTest.cpp - unit tests -----------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#include "llvm/Support/FileUtilities.h" +#include "llvm/Support/Errc.h" +#include "llvm/Support/ErrorHandling.h" +#include "llvm/Support/FileSystem.h" +#include "llvm/Support/MemoryBuffer.h" +#include "llvm/Support/Path.h" +#include "gtest/gtest.h" +#include + +using namespace llvm; +using namespace llvm::sys; + +#define ASSERT_NO_ERROR(x) \ + if (std::error_code ASSERT_NO_ERROR_ec = x) { \ + SmallString<128> MessageStorage; \ + raw_svector_ostream Message(MessageStorage); \ + Message << #x ": did not return errc::success.\n" \ + << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \ + << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \ + GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \ + } else { \ + } + +namespace { +TEST(writeFileAtomicallyTest, Test) { + // Create unique temporary directory for these tests + SmallString<128> RootTestDirectory; + ASSERT_NO_ERROR( + fs::createUniqueDirectory("writeFileAtomicallyTest", RootTestDirectory)); + + SmallString<128> FinalTestfilePath(RootTestDirectory); + sys::path::append(FinalTestfilePath, "foo.txt"); + const std::string TempUniqTestFileModel = FinalTestfilePath.str().str() + "-%%%%%%%%"; + const std::string TestfileContent = "fooFOOfoo"; + + llvm::Error Err = llvm::writeFileAtomically(TempUniqTestFileModel, FinalTestfilePath, TestfileContent); + ASSERT_FALSE(static_cast(Err)); + + std::ifstream FinalFileStream(FinalTestfilePath.str()); + std::string FinalFileContent; + FinalFileStream >> FinalFileContent; + ASSERT_EQ(FinalFileContent, TestfileContent); +} +} // anonymous namespace