lib/Support/LockFileManager.cpp

   1 //===--- LockFileManager.cpp - File-level Locking Utility------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 #include "llvm/Support/LockFileManager.h"
  10 #include "llvm/ADT/STLExtras.h"
  11 #include "llvm/ADT/StringExtras.h"
  12 #include "llvm/Support/FileSystem.h"
  13 #include "llvm/Support/MemoryBuffer.h"
  14 #include "llvm/Support/raw_ostream.h"
  15 #include <sys/stat.h>
  16 #include <sys/types.h>
  17 #if LLVM_ON_WIN32
  18 #include <windows.h>
  19 #endif
  20 #if LLVM_ON_UNIX
  21 #include <unistd.h>
  22 #endif
  23 using namespace llvm;
  24
  25 /// \brief Attempt to read the lock file with the given name, if it exists.
  26 ///
  27 /// \param LockFileName The name of the lock file to read.
  28 ///
  29 /// \returns The process ID of the process that owns this lock file
  30 Optional<std::pair<std::string, int> >
  31 LockFileManager::readLockFile(StringRef LockFileName) {
  32   // Check whether the lock file exists. If not, clearly there's nothing
  33   // to read, so we just return.
  34   if (!sys::fs::exists(LockFileName))
  35     return None;
  36
  37   // Read the owning host and PID out of the lock file. If it appears that the
  38   // owning process is dead, the lock file is invalid.
  39   OwningPtr<MemoryBuffer> MB;
  40   if (MemoryBuffer::getFile(LockFileName, MB))
  41     return None;
  42
  43   StringRef Hostname;
  44   StringRef PIDStr;
  45   std::tie(Hostname, PIDStr) = getToken(MB->getBuffer(), " ");
  46   PIDStr = PIDStr.substr(PIDStr.find_first_not_of(" "));
  47   int PID;
  48   if (!PIDStr.getAsInteger(10, PID))
  49     return std::make_pair(std::string(Hostname), PID);
  50
  51   // Delete the lock file. It's invalid anyway.
  52   sys::fs::remove(LockFileName);
  53   return None;
  54 }
  55
  56 bool LockFileManager::processStillExecuting(StringRef Hostname, int PID) {
  57 #if LLVM_ON_UNIX && !defined(__ANDROID__)
  58   char MyHostname[256];
  59   MyHostname[255] = 0;
  60   MyHostname[0] = 0;
  61   gethostname(MyHostname, 255);
  62   // Check whether the process is dead. If so, we're done.
  63   if (MyHostname == Hostname && getsid(PID) == -1 && errno == ESRCH)
  64     return false;
  65 #endif
  66
  67   return true;
  68 }
  69
  70 LockFileManager::LockFileManager(StringRef FileName)
  71 {
  72   this->FileName = FileName;
  73   LockFileName = FileName;
  74   LockFileName += ".lock";
  75
  76   // If the lock file already exists, don't bother to try to create our own
  77   // lock file; it won't work anyway. Just figure out who owns this lock file.
  78   if ((Owner = readLockFile(LockFileName)))
  79     return;
  80
  81   // Create a lock file that is unique to this instance.
  82   UniqueLockFileName = LockFileName;
  83   UniqueLockFileName += "-%%%%%%%%";
  84   int UniqueLockFileID;
  85   if (error_code EC
  86         = sys::fs::createUniqueFile(UniqueLockFileName.str(),
  87                                     UniqueLockFileID,
  88                                     UniqueLockFileName)) {
  89     Error = EC;
  90     return;
  91   }
  92
  93   // Write our process ID to our unique lock file.
  94   {
  95     raw_fd_ostream Out(UniqueLockFileID, /*shouldClose=*/true);
  96
  97 #if LLVM_ON_UNIX
  98     // FIXME: move getpid() call into LLVM
  99     char hostname[256];
 100     hostname[255] = 0;
 101     hostname[0] = 0;
 102     gethostname(hostname, 255);
 103     Out << hostname << ' ' << getpid();
 104 #else
 105     Out << "localhost 1";
 106 #endif
 107     Out.close();
 108
 109     if (Out.has_error()) {
 110       // We failed to write out PID, so make up an excuse, remove the
 111       // unique lock file, and fail.
 112       Error = make_error_code(errc::no_space_on_device);
 113       sys::fs::remove(UniqueLockFileName.c_str());
 114       return;
 115     }
 116   }
 117
 118   // Create a hard link from the lock file name. If this succeeds, we're done.
 119   error_code EC
 120     = sys::fs::create_hard_link(UniqueLockFileName.str(),
 121                                       LockFileName.str());
 122   if (EC == errc::success)
 123     return;
 124
 125   // Creating the hard link failed.
 126
 127 #ifdef LLVM_ON_UNIX
 128   // The creation of the hard link may appear to fail, but if stat'ing the
 129   // unique file returns a link count of 2, then we can still declare success.
 130   struct stat StatBuf;
 131   if (stat(UniqueLockFileName.c_str(), &StatBuf) == 0 &&
 132       StatBuf.st_nlink == 2)
 133     return;
 134 #endif
 135
 136   // Someone else managed to create the lock file first. Wipe out our unique
 137   // lock file (it's useless now) and read the process ID from the lock file.
 138   sys::fs::remove(UniqueLockFileName.str());
 139   if ((Owner = readLockFile(LockFileName)))
 140     return;
 141
 142   // There is a lock file that nobody owns; try to clean it up and report
 143   // an error.
 144   sys::fs::remove(LockFileName.str());
 145   Error = EC;
 146 }
 147
 148 LockFileManager::LockFileState LockFileManager::getState() const {
 149   if (Owner)
 150     return LFS_Shared;
 151
 152   if (Error)
 153     return LFS_Error;
 154
 155   return LFS_Owned;
 156 }
 157
 158 LockFileManager::~LockFileManager() {
 159   if (getState() != LFS_Owned)
 160     return;
 161
 162   // Since we own the lock, remove the lock file and our own unique lock file.
 163   sys::fs::remove(LockFileName.str());
 164   sys::fs::remove(UniqueLockFileName.str());
 165 }
 166
 167 void LockFileManager::waitForUnlock() {
 168   if (getState() != LFS_Shared)
 169     return;
 170
 171 #if LLVM_ON_WIN32
 172   unsigned long Interval = 1;
 173 #else
 174   struct timespec Interval;
 175   Interval.tv_sec = 0;
 176   Interval.tv_nsec = 1000000;
 177 #endif
 178   // Don't wait more than five minutes for the file to appear.
 179   unsigned MaxSeconds = 300;
 180   bool LockFileGone = false;
 181   do {
 182     // Sleep for the designated interval, to allow the owning process time to
 183     // finish up and remove the lock file.
 184     // FIXME: Should we hook in to system APIs to get a notification when the
 185     // lock file is deleted?
 186 #if LLVM_ON_WIN32
 187     Sleep(Interval);
 188 #else
 189     nanosleep(&Interval, NULL);
 190 #endif
 191     bool LockFileJustDisappeared = false;
 192
 193     // If the lock file is still expected to be there, check whether it still
 194     // is.
 195     if (!LockFileGone) {
 196       bool Exists;
 197       if (!sys::fs::exists(LockFileName.str(), Exists) && !Exists) {
 198         LockFileGone = true;
 199         LockFileJustDisappeared = true;
 200       }
 201     }
 202
 203     // If the lock file is no longer there, check if the original file is
 204     // available now.
 205     if (LockFileGone) {
 206       if (sys::fs::exists(FileName.str())) {
 207         return;
 208       }
 209
 210       // The lock file is gone, so now we're waiting for the original file to
 211       // show up. If this just happened, reset our waiting intervals and keep
 212       // waiting.
 213       if (LockFileJustDisappeared) {
 214         MaxSeconds = 5;
 215
 216 #if LLVM_ON_WIN32
 217         Interval = 1;
 218 #else
 219         Interval.tv_sec = 0;
 220         Interval.tv_nsec = 1000000;
 221 #endif
 222         continue;
 223       }
 224     }
 225
 226     // If we're looking for the lock file to disappear, but the process
 227     // owning the lock died without cleaning up, just bail out.
 228     if (!LockFileGone &&
 229         !processStillExecuting((*Owner).first, (*Owner).second)) {
 230       return;
 231     }
 232
 233     // Exponentially increase the time we wait for the lock to be removed.
 234 #if LLVM_ON_WIN32
 235     Interval *= 2;
 236 #else
 237     Interval.tv_sec *= 2;
 238     Interval.tv_nsec *= 2;
 239     if (Interval.tv_nsec >= 1000000000) {
 240       ++Interval.tv_sec;
 241       Interval.tv_nsec -= 1000000000;
 242     }
 243 #endif
 244   } while (
 245 #if LLVM_ON_WIN32
 246            Interval < MaxSeconds * 1000
 247 #else
 248            Interval.tv_sec < (time_t)MaxSeconds
 249 #endif
 250            );
 251
 252   // Give up.
 253 }