blob: 61c65dabae3c9d785d59f201e55f7441c5ed116e [file] [log] [blame]
//===--- LockFileManager.h - File-level locking utility ---------*- C++ -*-===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringRef.h"
#include <system_error>
#include <utility> // for std::pair
namespace llvm {
/// \brief 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 {
/// \brief Describes the state of a lock file.
enum LockFileState {
/// \brief The lock file has been created and is owned by this instance
/// of the object.
/// \brief The lock file already exists and is owned by some other
/// instance.
/// \brief An error occurred while trying to create or find the lock
/// file.
/// \brief Describes the result of waiting for the owner to release the lock.
enum WaitForUnlockResult {
/// \brief The lock was released successfully.
/// \brief Owner died while holding the lock.
/// \brief 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;
Optional<std::error_code> Error;
LockFileManager(const LockFileManager &) LLVM_DELETED_FUNCTION;
LockFileManager &operator=(const LockFileManager &) LLVM_DELETED_FUNCTION;
static Optional<std::pair<std::string, int> >
readLockFile(StringRef LockFileName);
static bool processStillExecuting(StringRef Hostname, int PID);
LockFileManager(StringRef FileName);
/// \brief Determine the state of the lock file.
LockFileState getState() const;
operator LockFileState() const { return getState(); }
/// \brief For a shared lock, wait until the owner releases the lock.
WaitForUnlockResult waitForUnlock();
} // end namespace llvm