nix-super/src/libstore/pathlocks.cc

203 lines
5.3 KiB
C++
Raw Normal View History

#include "pathlocks.hh"
#include "util.hh"
2003-09-11 11:31:29 +03:00
#include <cerrno>
#include <cstdlib>
2003-09-11 11:31:29 +03:00
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
namespace nix {
2006-06-20 20:48:10 +03:00
int openLockFile(const Path & path, bool create)
{
AutoCloseFD fd;
fd = open(path.c_str(), O_RDWR | (create ? O_CREAT : 0), 0600);
2006-06-20 20:48:10 +03:00
if (fd == -1 && (create || errno != ENOENT))
2014-08-20 18:00:17 +03:00
throw SysError(format("opening lock file %1%") % path);
2006-06-20 20:48:10 +03:00
closeOnExec(fd);
2006-06-20 20:48:10 +03:00
return fd.borrow();
}
void deleteLockFile(const Path & path, int fd)
2006-06-20 20:48:10 +03:00
{
/* Get rid of the lock file. Have to be careful not to introduce
races. Write a (meaningless) token to the file to indicate to
2006-06-20 20:48:10 +03:00
other processes waiting on this lock that the lock is stale
(deleted). */
unlink(path.c_str());
writeFull(fd, "d");
2006-06-20 20:48:10 +03:00
/* Note that the result of unlink() is ignored; removing the lock
file is an optimisation, not a necessity. */
}
bool lockFile(int fd, LockType lockType, bool wait)
{
struct flock lock;
if (lockType == ltRead) lock.l_type = F_RDLCK;
else if (lockType == ltWrite) lock.l_type = F_WRLCK;
else if (lockType == ltNone) lock.l_type = F_UNLCK;
else abort();
lock.l_whence = SEEK_SET;
lock.l_start = 0;
lock.l_len = 0; /* entire file */
if (wait) {
while (fcntl(fd, F_SETLKW, &lock) != 0) {
checkInterrupt();
if (errno != EINTR)
throw SysError(format("acquiring/releasing lock"));
}
} else {
while (fcntl(fd, F_SETLK, &lock) != 0) {
checkInterrupt();
if (errno == EACCES || errno == EAGAIN) return false;
2015-07-17 20:24:28 +03:00
if (errno != EINTR)
throw SysError(format("acquiring/releasing lock"));
}
}
return true;
}
/* This enables us to check whether are not already holding a lock on
a file ourselves. POSIX locks (fcntl) suck in this respect: if we
close a descriptor, the previous lock will be closed as well. And
there is no way to query whether we already have a lock (F_GETLK
only works on locks held by other processes). */
static StringSet lockedPaths; /* !!! not thread-safe */
PathLocks::PathLocks()
2003-11-21 18:05:19 +02:00
: deletePaths(false)
{
}
PathLocks::PathLocks(const PathSet & paths, const string & waitMsg)
: deletePaths(false)
{
lockPaths(paths, waitMsg);
}
bool PathLocks::lockPaths(const PathSet & _paths,
const string & waitMsg, bool wait)
{
assert(fds.empty());
2015-07-17 20:24:28 +03:00
/* Note that `fds' is built incrementally so that the destructor
will only release those locks that we have already acquired. */
/* Sort the paths. This assures that locks are always acquired in
the same order, thus preventing deadlocks. */
Paths paths(_paths.begin(), _paths.end());
paths.sort();
2015-07-17 20:24:28 +03:00
/* Acquire the lock for each path. */
2015-07-17 20:24:28 +03:00
for (auto & path : paths) {
checkInterrupt();
Path lockPath = path + ".lock";
2014-08-20 18:00:17 +03:00
debug(format("locking path %1%") % path);
if (lockedPaths.find(lockPath) != lockedPaths.end())
throw Error("deadlock: trying to re-acquire self-held lock");
AutoCloseFD fd;
2015-07-17 20:24:28 +03:00
while (1) {
/* Open/create the lock file. */
2015-07-17 20:24:28 +03:00
fd = openLockFile(lockPath, true);
/* Acquire an exclusive lock. */
if (!lockFile(fd, ltWrite, false)) {
if (wait) {
if (waitMsg != "") printMsg(lvlError, waitMsg);
lockFile(fd, ltWrite, true);
} else {
/* Failed to lock this path; release all other
locks. */
unlock();
return false;
}
}
2014-08-20 18:00:17 +03:00
debug(format("lock acquired on %1%") % lockPath);
/* Check that the lock file hasn't become stale (i.e.,
hasn't been unlinked). */
struct stat st;
if (fstat(fd, &st) == -1)
2014-08-20 18:00:17 +03:00
throw SysError(format("statting lock file %1%") % lockPath);
if (st.st_size != 0)
/* This lock file has been unlinked, so we're holding
a lock on a deleted file. This means that other
processes may create and acquire a lock on
`lockPath', and proceed. So we must retry. */
2014-08-20 18:00:17 +03:00
debug(format("open lock file %1% has become stale") % lockPath);
else
break;
}
/* Use borrow so that the descriptor isn't closed. */
fds.push_back(FDPair(fd.borrow(), lockPath));
lockedPaths.insert(lockPath);
}
return true;
}
PathLocks::~PathLocks()
{
try {
unlock();
} catch (...) {
ignoreException();
}
}
void PathLocks::unlock()
{
2015-07-17 20:24:28 +03:00
for (auto & i : fds) {
if (deletePaths) deleteLockFile(i.second, i.first);
2006-06-20 20:48:10 +03:00
2015-07-17 20:24:28 +03:00
lockedPaths.erase(i.second);
if (close(i.first) == -1)
printMsg(lvlError,
2015-07-17 20:24:28 +03:00
format("error (ignored): cannot close lock file on %1%") % i.second);
2006-06-20 20:48:10 +03:00
2015-07-17 20:24:28 +03:00
debug(format("lock released on %1%") % i.second);
2003-11-21 18:05:19 +02:00
}
fds.clear();
2003-11-21 18:05:19 +02:00
}
void PathLocks::setDeletion(bool deletePaths)
{
this->deletePaths = deletePaths;
}
bool pathIsLockedByMe(const Path & path)
{
Path lockPath = path + ".lock";
return lockedPaths.find(lockPath) != lockedPaths.end();
}
2015-07-17 20:24:28 +03:00
}