llvm::LockFileManager Class Reference

Class that manages the creation of a lock file to aid implicit coordination between different processes. More...

#include <LockFileManager.h>

List of all members.

Public Types
enum	LockFileState { LFS_Owned, LFS_Shared, LFS_Error }
	Describes the state of a lock file. More...
enum	WaitForUnlockResult { Res_Success, Res_OwnerDied, Res_Timeout }
	Describes the result of waiting for the owner to release the lock. More...
Public Member Functions
	LockFileManager (StringRef FileName)
	~LockFileManager ()
LockFileState	getState () const
	Determine the state of the lock file.
	operator LockFileState () const
WaitForUnlockResult	waitForUnlock ()
	For a shared lock, wait until the owner releases the lock.

---

Detailed Description

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.

Definition at line 27 of file LockFileManager.h.

---

Member Enumeration Documentation

enum llvm::LockFileManager::LockFileState

Describes the state of a lock file.

Enumerator:

LFS_Owned	The lock file has been created and is owned by this instance of the object.
LFS_Shared	The lock file already exists and is owned by some other instance.
LFS_Error	An error occurred while trying to create or find the lock file.

Definition at line 30 of file LockFileManager.h.

enum llvm::LockFileManager::WaitForUnlockResult

Describes the result of waiting for the owner to release the lock.

Enumerator:

Res_Success	The lock was released successfully.
Res_OwnerDied	Owner died while holding the lock.
Res_Timeout	Reached timeout while waiting for the owner to release the lock.

Definition at line 43 of file LockFileManager.h.

---

Constructor & Destructor Documentation

LockFileManager::LockFileManager

(

StringRef

FileName

)

Definition at line 74 of file LockFileManager.cpp.

References llvm::SmallString< InternalLen >::c_str(), llvm::raw_fd_ostream::close(), llvm::sys::fs::create_link(), llvm::sys::fs::createUniqueFile(), llvm::sys::fs::exists(), llvm::file_exists, llvm::raw_fd_ostream::has_error(), llvm::sys::fs::make_absolute(), llvm::make_error_code(), llvm::no_space_on_device, llvm::sys::fs::remove(), llvm::LibFunc::remove, llvm::StringRef::str(), and llvm::SmallString< InternalLen >::str().

LockFileManager::~LockFileManager

(

)

Definition at line 169 of file LockFileManager.cpp.

References getState(), LFS_Owned, llvm::LibFunc::remove, llvm::StringRef::str(), and llvm::SmallString< InternalLen >::str().

---

Member Function Documentation

LockFileManager::LockFileState LockFileManager::getState

(

)

const

Determine the state of the lock file.

Definition at line 159 of file LockFileManager.cpp.

References LFS_Error, LFS_Owned, and LFS_Shared.

Referenced by operator LockFileState(), waitForUnlock(), and ~LockFileManager().

llvm::LockFileManager::operator LockFileState

(

)

const [inline]

Definition at line 76 of file LockFileManager.h.

References getState().

LockFileManager::WaitForUnlockResult LockFileManager::waitForUnlock

(

)

For a shared lock, wait until the owner releases the lock.

Definition at line 178 of file LockFileManager.cpp.

References llvm::sys::fs::access(), llvm::sys::fs::Exist, llvm::sys::fs::exists(), getState(), LFS_Shared, llvm::no_such_file_or_directory, Res_OwnerDied, Res_Success, Res_Timeout, and llvm::SmallString< InternalLen >::str().

---

The documentation for this class was generated from the following files:

• LockFileManager.h
• LockFileManager.cpp