summaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/include/llvm/Support/LockFileManager.h
diff options
context:
space:
mode:
authorDevtools Arcadia <[email protected]>2022-02-07 18:08:42 +0300
committerDevtools Arcadia <[email protected]>2022-02-07 18:08:42 +0300
commit1110808a9d39d4b808aef724c861a2e1a38d2a69 (patch)
treee26c9fed0de5d9873cce7e00bc214573dc2195b7 /contrib/libs/llvm12/include/llvm/Support/LockFileManager.h
intermediate changes
ref:cde9a383711a11544ce7e107a78147fb96cc4029
Diffstat (limited to 'contrib/libs/llvm12/include/llvm/Support/LockFileManager.h')
-rw-r--r--contrib/libs/llvm12/include/llvm/Support/LockFileManager.h111
1 files changed, 111 insertions, 0 deletions
diff --git a/contrib/libs/llvm12/include/llvm/Support/LockFileManager.h b/contrib/libs/llvm12/include/llvm/Support/LockFileManager.h
new file mode 100644
index 00000000000..e60ff8c32c9
--- /dev/null
+++ b/contrib/libs/llvm12/include/llvm/Support/LockFileManager.h
@@ -0,0 +1,111 @@
+#pragma once
+
+#ifdef __GNUC__
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wunused-parameter"
+#endif
+
+//===--- LockFileManager.h - File-level locking utility ---------*- C++ -*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+#ifndef LLVM_SUPPORT_LOCKFILEMANAGER_H
+#define LLVM_SUPPORT_LOCKFILEMANAGER_H
+
+#include "llvm/ADT/Optional.h"
+#include "llvm/ADT/SmallString.h"
+#include <system_error>
+#include <utility> // for std::pair
+
+namespace llvm {
+class StringRef;
+
+/// Class that manages the creation of a lock file to aid
+/// implicit coordination between different processes.
+///
+/// The implicit coordination works by creating a ".lock" file alongside
+/// the file that we're coordinating for, using the atomicity of the file
+/// system to ensure that only a single process can create that ".lock" file.
+/// When the lock file is removed, the owning process has finished the
+/// operation.
+class LockFileManager {
+public:
+ /// Describes the state of a lock file.
+ enum LockFileState {
+ /// The lock file has been created and is owned by this instance
+ /// of the object.
+ LFS_Owned,
+ /// The lock file already exists and is owned by some other
+ /// instance.
+ LFS_Shared,
+ /// An error occurred while trying to create or find the lock
+ /// file.
+ LFS_Error
+ };
+
+ /// Describes the result of waiting for the owner to release the lock.
+ enum WaitForUnlockResult {
+ /// The lock was released successfully.
+ Res_Success,
+ /// Owner died while holding the lock.
+ Res_OwnerDied,
+ /// Reached timeout while waiting for the owner to release the lock.
+ Res_Timeout
+ };
+
+private:
+ SmallString<128> FileName;
+ SmallString<128> LockFileName;
+ SmallString<128> UniqueLockFileName;
+
+ Optional<std::pair<std::string, int> > Owner;
+ std::error_code ErrorCode;
+ std::string ErrorDiagMsg;
+
+ LockFileManager(const LockFileManager &) = delete;
+ LockFileManager &operator=(const LockFileManager &) = delete;
+
+ static Optional<std::pair<std::string, int> >
+ readLockFile(StringRef LockFileName);
+
+ static bool processStillExecuting(StringRef Hostname, int PID);
+
+public:
+
+ LockFileManager(StringRef FileName);
+ ~LockFileManager();
+
+ /// Determine the state of the lock file.
+ LockFileState getState() const;
+
+ operator LockFileState() const { return getState(); }
+
+ /// For a shared lock, wait until the owner releases the lock.
+ /// Total timeout for the file to appear is ~1.5 minutes.
+ /// \param MaxSeconds the maximum total wait time in seconds.
+ WaitForUnlockResult waitForUnlock(const unsigned MaxSeconds = 90);
+
+ /// Remove the lock file. This may delete a different lock file than
+ /// the one previously read if there is a race.
+ std::error_code unsafeRemoveLockFile();
+
+ /// Get error message, or "" if there is no error.
+ std::string getErrorMessage() const;
+
+ /// Set error and error message
+ void setError(const std::error_code &EC, StringRef ErrorMsg = "") {
+ ErrorCode = EC;
+ ErrorDiagMsg = ErrorMsg.str();
+ }
+};
+
+} // end namespace llvm
+
+#endif // LLVM_SUPPORT_LOCKFILEMANAGER_H
+
+#ifdef __GNUC__
+#pragma GCC diagnostic pop
+#endif