← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/counted_lock.py

  • Committer: Robert Collins
  • Date: 2006-02-15 08:11:37 UTC
  • mto: (1534.1.24 integration)
  • mto: This revision was merged to the branch mainline in revision 1554.
  • Revision ID: robertc@robertcollins.net-20060215081137-4c27377517e96dd1
Make format 4/5/6 branches share a single LockableFiles instance across wt/branch/repository.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/counted_lock.py
1
 
# Copyright (C) 2007, 2008 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""Counted lock class"""
18
 
 
19
 
 
20
 
from bzrlib import (
21
 
    errors,
22
 
    )
23
 
 
24
 
 
25
 
class CountedLock(object):
26
 
    """Decorator around a lock that makes it reentrant.
27
 
 
28
 
    This can be used with any object that provides a basic Lock interface,
29
 
    including LockDirs and OS file locks.
30
 
 
31
 
    :ivar _token: While a write lock is held, this is the token 
32
 
        for it.
33
 
    """
34
 
 
35
 
    def __init__(self, real_lock):
36
 
        self._real_lock = real_lock
37
 
        self._lock_mode = None
38
 
        self._lock_count = 0
39
 
 
40
 
    def __repr__(self):
41
 
        return "%s(%r)" % (self.__class__.__name__,
42
 
            self._real_lock)
43
 
 
44
 
    def break_lock(self):
45
 
        self._real_lock.break_lock()
46
 
        self._lock_mode = None
47
 
        self._lock_count = 0
48
 
 
49
 
    def get_physical_lock_status(self):
50
 
        """Return physical lock status.
51
 
 
52
 
        Returns true if a lock is held on the transport. If no lock is held, or
53
 
        the underlying locking mechanism does not support querying lock
54
 
        status, false is returned.
55
 
        """
56
 
        try:
57
 
            return self._real_lock.peek() is not None
58
 
        except NotImplementedError:
59
 
            return False
60
 
 
61
 
    def is_locked(self):
62
 
        return self._lock_mode is not None
63
 
 
64
 
    def lock_read(self):
65
 
        """Acquire the lock in read mode.
66
 
 
67
 
        If the lock is already held in either read or write mode this
68
 
        increments the count and succeeds.  If the lock is not already held,
69
 
        it is taken in read mode.
70
 
        """
71
 
        if self._lock_mode:
72
 
            self._lock_count += 1
73
 
        else:
74
 
            self._real_lock.lock_read()
75
 
            self._lock_count = 1
76
 
            self._lock_mode = 'r'
77
 
 
78
 
    def lock_write(self, token=None):
79
 
        """Acquire the lock in write mode.
80
 
 
81
 
        If the lock was originally acquired in read mode this will fail.
82
 
 
83
 
        :param token: If given and the lock is already held, 
84
 
            then validate that we already hold the real
85
 
            lock with this token.
86
 
 
87
 
        :returns: The token from the underlying lock.
88
 
        """
89
 
        if self._lock_count == 0:
90
 
            self._token = self._real_lock.lock_write(token=token)
91
 
            self._lock_mode = 'w'
92
 
            self._lock_count += 1
93
 
            return self._token
94
 
        elif self._lock_mode != 'w':
95
 
            raise errors.ReadOnlyError(self)
96
 
        else:
97
 
            self._real_lock.validate_token(token)
98
 
            self._lock_count += 1
99
 
            return self._token
100
 
 
101
 
    def unlock(self):
102
 
        if self._lock_count == 0:
103
 
            raise errors.LockNotHeld(self)
104
 
        elif self._lock_count == 1:
105
 
            # these are decremented first; if we fail to unlock the most
106
 
            # reasonable assumption is that we still don't have the lock
107
 
            # anymore
108
 
            self._lock_mode = None
109
 
            self._lock_count -= 1
110
 
            self._real_lock.unlock()
111
 
        else:
112
 
            self._lock_count -= 1