lock: turn prepinherit/reacquire into a single context manager

Review feedback from Pierre-Yves David. This makes the overall code cleaner and
less error-prone, and makes a previously explicitly checked error state
impossible.

mercurial/lock.py

@@ -1,231 +1,230 b''
 # lock.py - simple advisory locking scheme for mercurial
 #
 # Copyright 2005, 2006 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
+import contextlib
 import errno
 import os
 import socket
 import time
 import warnings
 
 from . import (
     error,
     util,
 )
 
 class lock(object):
     '''An advisory lock held by one process to control access to a set
     of files.  Non-cooperating processes or incorrectly written scripts
     can ignore Mercurial's locking scheme and stomp all over the
     repository, so don't do that.
 
     Typically used via localrepository.lock() to lock the repository
     store (.hg/store/) or localrepository.wlock() to lock everything
     else under .hg/.'''
 
     # lock is symlink on platforms that support it, file on others.
 
     # symlink is used because create of directory entry and contents
     # are atomic even over nfs.
 
     # old-style lock: symlink to pid
     # new-style lock: symlink to hostname:pid
 
     _host = None
 
     def __init__(self, vfs, file, timeout=-1, releasefn=None, acquirefn=None,
                  desc=None, parentlock=None):
         self.vfs = vfs
         self.f = file
         self.held = 0
         self.timeout = timeout
         self.releasefn = releasefn
         self.acquirefn = acquirefn
         self.desc = desc
         self.parentlock = parentlock
         self._parentheld = False
         self._inherited = False
         self.postrelease  = []
         self.pid = self._getpid()
         self.delay = self.lock()
         if self.acquirefn:
             self.acquirefn()
 
     def __del__(self):
         if self.held:
             warnings.warn("use lock.release instead of del lock",
                     category=DeprecationWarning,
                     stacklevel=2)
 
             # ensure the lock will be removed
             # even if recursive locking did occur
             self.held = 1
 
         self.release()
 
     def _getpid(self):
         # wrapper around os.getpid() to make testing easier
         return os.getpid()
 
     def lock(self):
         timeout = self.timeout
         while True:
             try:
                 self._trylock()
                 return self.timeout - timeout
             except error.LockHeld as inst:
                 if timeout != 0:
                     time.sleep(1)
                     if timeout > 0:
                         timeout -= 1
                     continue
                 raise error.LockHeld(errno.ETIMEDOUT, inst.filename, self.desc,
                                      inst.locker)
 
     def _trylock(self):
         if self.held:
             self.held += 1
             return
         if lock._host is None:
             lock._host = socket.gethostname()
         lockname = '%s:%s' % (lock._host, self.pid)
         retry = 5
         while not self.held and retry:
             retry -= 1
             try:
                 self.vfs.makelock(lockname, self.f)
                 self.held = 1
             except (OSError, IOError) as why:
                 if why.errno == errno.EEXIST:
                     locker = self._readlock()
                     # special case where a parent process holds the lock -- this
                     # is different from the pid being different because we do
                     # want the unlock and postrelease functions to be called,
                     # but the lockfile to not be removed.
                     if locker == self.parentlock:
                         self._parentheld = True
                         self.held = 1
                         return
                     locker = self._testlock(locker)
                     if locker is not None:
                         raise error.LockHeld(errno.EAGAIN,
                                              self.vfs.join(self.f), self.desc,
                                              locker)
                 else:
                     raise error.LockUnavailable(why.errno, why.strerror,
                                                 why.filename, self.desc)
 
     def _readlock(self):
         """read lock and return its value
 
         Returns None if no lock exists, pid for old-style locks, and host:pid
         for new-style locks.
         """
         try:
             return self.vfs.readlock(self.f)
         except (OSError, IOError) as why:
             if why.errno == errno.ENOENT:
                 return None
             raise
 
     def _testlock(self, locker):
         if locker is None:
             return None
         try:
             host, pid = locker.split(":", 1)
         except ValueError:
             return locker
         if host != lock._host:
             return locker
         try:
             pid = int(pid)
         except ValueError:
             return locker
         if util.testpid(pid):
             return locker
         # if locker dead, break lock.  must do this with another lock
         # held, or can race and break valid lock.
         try:
             l = lock(self.vfs, self.f + '.break', timeout=0)
             self.vfs.unlink(self.f)
             l.release()
         except error.LockError:
             return locker
 
     def testlock(self):
         """return id of locker if lock is valid, else None.
 
         If old-style lock, we cannot tell what machine locker is on.
         with new-style lock, if locker is on this machine, we can
         see if locker is alive.  If locker is on this machine but
         not alive, we can safely break lock.
 
         The lock file is only deleted when None is returned.
 
         """
         locker = self._readlock()
         return self._testlock(locker)
 
-    def prepinherit(self):
-        """prepare for the lock to be inherited by a Mercurial subprocess
+    @contextlib.contextmanager
+    def inherit(self):
+        """context for the lock to be inherited by a Mercurial subprocess.
 
-        Returns a string that will be recognized by the lock in the
-        subprocess. Communicating this string to the subprocess needs to be done
-        separately -- typically by an environment variable.
+        Yields a string that will be recognized by the lock in the subprocess.
+        Communicating this string to the subprocess needs to be done separately
+        -- typically by an environment variable.
         """
         if not self.held:
             raise error.LockInheritanceContractViolation(
-                'prepinherit can only be called while lock is held')
+                'inherit can only be called while lock is held')
         if self._inherited:
             raise error.LockInheritanceContractViolation(
-                'prepinherit cannot be called while lock is already inherited')
+                'inherit cannot be called while lock is already inherited')
         if self.releasefn:
             self.releasefn()
         if self._parentheld:
             lockname = self.parentlock
         else:
             lockname = '%s:%s' % (lock._host, self.pid)
         self._inherited = True
-        return lockname
-
-    def reacquire(self):
-        if not self._inherited:
-            raise error.LockInheritanceContractViolation(
-                'reacquire can only be called after prepinherit')
+        try:
+            yield lockname
+        finally:
         if self.acquirefn:
             self.acquirefn()
         self._inherited = False
 
     def release(self):
         """release the lock and execute callback function if any
 
         If the lock has been acquired multiple times, the actual release is
         delayed to the last release call."""
         if self.held > 1:
             self.held -= 1
         elif self.held == 1:
             self.held = 0
             if self._getpid() != self.pid:
                 # we forked, and are not the parent
                 return
             try:
                 if self.releasefn:
                     self.releasefn()
             finally:
                 if not self._parentheld:
                     try:
                         self.vfs.unlink(self.f)
                     except OSError:
                         pass
             for callback in self.postrelease:
                 callback()
 
 def release(*locks):
     for lock in locks:
         if lock is not None:
             lock.release()

tests/test-lock.py

@@ -1,256 +1,254 b''
 from __future__ import absolute_import
 
 import copy
 import os
 import silenttestrunner
 import tempfile
 import types
 import unittest
 
 from mercurial import (
     lock,
     scmutil,
 )
 
 testlockname = 'testlock'
 
 # work around http://bugs.python.org/issue1515
 if types.MethodType not in copy._deepcopy_dispatch:
     def _deepcopy_method(x, memo):
         return type(x)(x.im_func, copy.deepcopy(x.im_self, memo), x.im_class)
     copy._deepcopy_dispatch[types.MethodType] = _deepcopy_method
 
 class lockwrapper(lock.lock):
     def __init__(self, pidoffset, *args, **kwargs):
         # lock.lock.__init__() calls lock(), so the pidoffset assignment needs
         # to be earlier
         self._pidoffset = pidoffset
         super(lockwrapper, self).__init__(*args, **kwargs)
     def _getpid(self):
         return os.getpid() + self._pidoffset
 
 class teststate(object):
     def __init__(self, testcase, dir, pidoffset=0):
         self._testcase = testcase
         self._acquirecalled = False
         self._releasecalled = False
         self._postreleasecalled = False
         self.vfs = scmutil.vfs(dir, audit=False)
         self._pidoffset = pidoffset
 
     def makelock(self, *args, **kwargs):
         l = lockwrapper(self._pidoffset, self.vfs, testlockname,
                         releasefn=self.releasefn, acquirefn=self.acquirefn,
                         *args, **kwargs)
         l.postrelease.append(self.postreleasefn)
         return l
 
     def acquirefn(self):
         self._acquirecalled = True
 
     def releasefn(self):
         self._releasecalled = True
 
     def postreleasefn(self):
         self._postreleasecalled = True
 
     def assertacquirecalled(self, called):
         self._testcase.assertEqual(
             self._acquirecalled, called,
             'expected acquire to be %s but was actually %s' % (
                 self._tocalled(called),
                 self._tocalled(self._acquirecalled),
             ))
 
     def resetacquirefn(self):
         self._acquirecalled = False
 
     def assertreleasecalled(self, called):
         self._testcase.assertEqual(
             self._releasecalled, called,
             'expected release to be %s but was actually %s' % (
                 self._tocalled(called),
                 self._tocalled(self._releasecalled),
             ))
 
     def assertpostreleasecalled(self, called):
         self._testcase.assertEqual(
             self._postreleasecalled, called,
             'expected postrelease to be %s but was actually %s' % (
                 self._tocalled(called),
                 self._tocalled(self._postreleasecalled),
             ))
 
     def assertlockexists(self, exists):
         actual = self.vfs.lexists(testlockname)
         self._testcase.assertEqual(
             actual, exists,
             'expected lock to %s but actually did %s' % (
                 self._toexists(exists),
                 self._toexists(actual),
             ))
 
     def _tocalled(self, called):
         if called:
             return 'called'
         else:
             return 'not called'
 
     def _toexists(self, exists):
         if exists:
             return 'exist'
         else:
             return 'not exist'
 
 class testlock(unittest.TestCase):
     def testlock(self):
         state = teststate(self, tempfile.mkdtemp(dir=os.getcwd()))
         lock = state.makelock()
         state.assertacquirecalled(True)
         lock.release()
         state.assertreleasecalled(True)
         state.assertpostreleasecalled(True)
         state.assertlockexists(False)
 
     def testrecursivelock(self):
         state = teststate(self, tempfile.mkdtemp(dir=os.getcwd()))
         lock = state.makelock()
         state.assertacquirecalled(True)
 
         state.resetacquirefn()
         lock.lock()
         # recursive lock should not call acquirefn again
         state.assertacquirecalled(False)
 
         lock.release() # brings lock refcount down from 2 to 1
         state.assertreleasecalled(False)
         state.assertpostreleasecalled(False)
         state.assertlockexists(True)
 
         lock.release() # releases the lock
         state.assertreleasecalled(True)
         state.assertpostreleasecalled(True)
         state.assertlockexists(False)
 
     def testlockfork(self):
         state = teststate(self, tempfile.mkdtemp(dir=os.getcwd()))
         lock = state.makelock()
         state.assertacquirecalled(True)
 
         # fake a fork
         forklock = copy.deepcopy(lock)
         forklock._pidoffset = 1
         forklock.release()
         state.assertreleasecalled(False)
         state.assertpostreleasecalled(False)
         state.assertlockexists(True)
 
         # release the actual lock
         lock.release()
         state.assertreleasecalled(True)
         state.assertpostreleasecalled(True)
         state.assertlockexists(False)
 
     def testinheritlock(self):
         d = tempfile.mkdtemp(dir=os.getcwd())
         parentstate = teststate(self, d)
         parentlock = parentstate.makelock()
         parentstate.assertacquirecalled(True)
 
         # set up lock inheritance
-        lockname = parentlock.prepinherit()
+        with parentlock.inherit() as lockname:
         parentstate.assertreleasecalled(True)
         parentstate.assertpostreleasecalled(False)
         parentstate.assertlockexists(True)
 
         childstate = teststate(self, d, pidoffset=1)
         childlock = childstate.makelock(parentlock=lockname)
         childstate.assertacquirecalled(True)
 
-        # release the child lock -- the lock file should still exist on disk
         childlock.release()
         childstate.assertreleasecalled(True)
         childstate.assertpostreleasecalled(True)
         childstate.assertlockexists(True)
 
         parentstate.resetacquirefn()
-        parentlock.reacquire()
+
         parentstate.assertacquirecalled(True)
 
         parentlock.release()
         parentstate.assertreleasecalled(True)
         parentstate.assertpostreleasecalled(True)
         parentstate.assertlockexists(False)
 
     def testmultilock(self):
         d = tempfile.mkdtemp(dir=os.getcwd())
         state0 = teststate(self, d)
         lock0 = state0.makelock()
         state0.assertacquirecalled(True)
 
-        lock0name = lock0.prepinherit()
+        with lock0.inherit() as lock0name:
         state0.assertreleasecalled(True)
         state0.assertpostreleasecalled(False)
         state0.assertlockexists(True)
 
         state1 = teststate(self, d, pidoffset=1)
         lock1 = state1.makelock(parentlock=lock0name)
         state1.assertacquirecalled(True)
 
         # from within lock1, acquire another lock
-        lock1name = lock1.prepinherit()
-        # since the file on disk is lock0's this should have the same name
+            with lock1.inherit() as lock1name:
+                # since the file on disk is lock0's this should have the same
+                # name
         self.assertEqual(lock0name, lock1name)
 
         state2 = teststate(self, d, pidoffset=2)
         lock2 = state2.makelock(parentlock=lock1name)
         state2.assertacquirecalled(True)
 
         lock2.release()
         state2.assertreleasecalled(True)
         state2.assertpostreleasecalled(True)
         state2.assertlockexists(True)
 
         state1.resetacquirefn()
-        lock1.reacquire()
+
         state1.assertacquirecalled(True)
 
         lock1.release()
         state1.assertreleasecalled(True)
         state1.assertpostreleasecalled(True)
         state1.assertlockexists(True)
 
-        lock0.reacquire()
         lock0.release()
 
     def testinheritlockfork(self):
         d = tempfile.mkdtemp(dir=os.getcwd())
         parentstate = teststate(self, d)
         parentlock = parentstate.makelock()
         parentstate.assertacquirecalled(True)
 
         # set up lock inheritance
-        lockname = parentlock.prepinherit()
+        with parentlock.inherit() as lockname:
         childstate = teststate(self, d, pidoffset=1)
         childlock = childstate.makelock(parentlock=lockname)
         childstate.assertacquirecalled(True)
 
         # fork the child lock
         forkchildlock = copy.deepcopy(childlock)
         forkchildlock._pidoffset += 1
         forkchildlock.release()
         childstate.assertreleasecalled(False)
         childstate.assertpostreleasecalled(False)
         childstate.assertlockexists(True)
 
         # release the child lock
         childlock.release()
         childstate.assertreleasecalled(True)
         childstate.assertpostreleasecalled(True)
         childstate.assertlockexists(True)
 
-        parentlock.reacquire()
         parentlock.release()
 
 if __name__ == '__main__':
     silenttestrunner.main(__name__)