blob: 57e4fbd84cd954630b846d4424a0e91813341119 [file] [log] [blame]
//===--- LockFileManager.h - File-level locking utility ---------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#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 {
/// Describes the state of a lock file.
enum LockFileState {
/// The lock file has been created and is owned by this instance
/// of the object.
/// The lock file already exists and is owned by some other
/// instance.
/// An error occurred while trying to create or find the lock
/// file.
/// Describes the result of waiting for the owner to release the lock.
enum WaitForUnlockResult {
/// The lock was released successfully.
/// Owner died while holding the lock.
/// Reached timeout while waiting for the owner to release the lock.
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);
LockFileManager(StringRef FileName);
/// 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.
WaitForUnlockResult waitForUnlock();
/// 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