← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/counted_lock.py

Merge up bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/counted_lock.py
1
 
# Copyright (C) 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Counted lock class"""
18
18
 
19
 
from __future__ import absolute_import
20
19
 
21
 
from bzrlib import (
22
 
    errors,
 
20
from bzrlib.errors import (
 
21
    LockError,
 
22
    ReadOnlyError,
23
23
    )
24
24
 
25
25
 
 
26
# TODO: Pass through lock tokens on lock_write and read, and return them...
 
27
#
 
28
# TODO: Allow upgrading read locks to write?  Conceptually difficult.
 
29
 
 
30
 
26
31
class CountedLock(object):
27
32
    """Decorator around a lock that makes it reentrant.
28
33
 
29
34
    This can be used with any object that provides a basic Lock interface,
30
35
    including LockDirs and OS file locks.
31
 
 
32
 
    :ivar _token: While a write lock is held, this is the token 
33
 
        for it.
34
36
    """
35
37
 
36
38
    def __init__(self, real_lock):
38
40
        self._lock_mode = None
39
41
        self._lock_count = 0
40
42
 
41
 
    def __repr__(self):
42
 
        return "%s(%r)" % (self.__class__.__name__,
43
 
            self._real_lock)
44
 
 
45
43
    def break_lock(self):
46
44
        self._real_lock.break_lock()
47
45
        self._lock_mode = None
48
46
        self._lock_count = 0
49
47
 
50
 
    def get_physical_lock_status(self):
51
 
        """Return physical lock status.
52
 
 
53
 
        Returns true if a lock is held on the transport. If no lock is held, or
54
 
        the underlying locking mechanism does not support querying lock
55
 
        status, false is returned.
56
 
        """
57
 
        try:
58
 
            return self._real_lock.peek() is not None
59
 
        except NotImplementedError:
60
 
            return False
61
 
 
62
48
    def is_locked(self):
63
49
        return self._lock_mode is not None
64
50
 
76
62
            self._lock_count = 1
77
63
            self._lock_mode = 'r'
78
64
 
79
 
    def lock_write(self, token=None):
 
65
    def lock_write(self):
80
66
        """Acquire the lock in write mode.
81
67
 
82
68
        If the lock was originally acquired in read mode this will fail.
83
 
 
84
 
        :param token: If given and the lock is already held, 
85
 
            then validate that we already hold the real
86
 
            lock with this token.
87
 
 
88
 
        :returns: The token from the underlying lock.
89
69
        """
90
70
        if self._lock_count == 0:
91
 
            self._token = self._real_lock.lock_write(token=token)
 
71
            self._real_lock.lock_write()
92
72
            self._lock_mode = 'w'
93
 
            self._lock_count += 1
94
 
            return self._token
95
73
        elif self._lock_mode != 'w':
96
 
            raise errors.ReadOnlyError(self)
97
 
        else:
98
 
            self._real_lock.validate_token(token)
99
 
            self._lock_count += 1
100
 
            return self._token
 
74
            raise ReadOnlyError(self)
 
75
        self._lock_count += 1
101
76
 
102
77
    def unlock(self):
103
78
        if self._lock_count == 0:
104
 
            raise errors.LockNotHeld(self)
 
79
            raise LockError("%s not locked" % (self,))
105
80
        elif self._lock_count == 1:
106
 
            # these are decremented first; if we fail to unlock the most
107
 
            # reasonable assumption is that we still don't have the lock
108
 
            # anymore
 
81
            self._real_lock.unlock()
109
82
            self._lock_mode = None
110
 
            self._lock_count -= 1
111
 
            self._real_lock.unlock()
112
 
        else:
113
 
            self._lock_count -= 1
 
83
        self._lock_count -= 1