← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/counted_lock.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

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
19
 
20
 
from bzrlib import (
21
 
    errors,
 
20
from bzrlib.errors import (
 
21
    LockError,
 
22
    ReadOnlyError,
22
23
    )
23
24
 
24
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
 
25
31
class CountedLock(object):
26
32
    """Decorator around a lock that makes it reentrant.
27
33
 
28
34
    This can be used with any object that provides a basic Lock interface,
29
35
    including LockDirs and OS file locks.
30
 
 
31
 
    :ivar _token: While a write lock is held, this is the token 
32
 
        for it.
33
36
    """
34
37
 
35
38
    def __init__(self, real_lock):
37
40
        self._lock_mode = None
38
41
        self._lock_count = 0
39
42
 
40
 
    def __repr__(self):
41
 
        return "%s(%r)" % (self.__class__.__name__,
42
 
            self._real_lock)
43
 
 
44
43
    def break_lock(self):
45
44
        self._real_lock.break_lock()
46
45
        self._lock_mode = None
47
46
        self._lock_count = 0
48
47
 
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
48
    def is_locked(self):
62
49
        return self._lock_mode is not None
63
50
 
69
56
        it is taken in read mode.
70
57
        """
71
58
        if self._lock_mode:
 
59
            assert self._lock_mode in ('r', 'w'), \
 
60
                   "invalid lock mode %r" % self._lock_mode
72
61
            self._lock_count += 1
73
62
        else:
 
63
            assert self._lock_count == 0
74
64
            self._real_lock.lock_read()
75
65
            self._lock_count = 1
76
66
            self._lock_mode = 'r'
77
67
 
78
 
    def lock_write(self, token=None):
 
68
    def lock_write(self):
79
69
        """Acquire the lock in write mode.
80
70
 
81
71
        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
72
        """
89
73
        if self._lock_count == 0:
90
 
            self._token = self._real_lock.lock_write(token=token)
 
74
            assert self._lock_mode is None
 
75
            self._real_lock.lock_write()
91
76
            self._lock_mode = 'w'
92
 
            self._lock_count += 1
93
 
            return self._token
94
77
        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
 
78
            raise ReadOnlyError(self)
 
79
        self._lock_count += 1
100
80
 
101
81
    def unlock(self):
102
82
        if self._lock_count == 0:
103
 
            raise errors.LockNotHeld(self)
 
83
            raise LockError("%s not locked" % (self,))
104
84
        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
 
85
            self._real_lock.unlock()
108
86
            self._lock_mode = None
109
 
            self._lock_count -= 1
110
 
            self._real_lock.unlock()
111
 
        else:
112
 
            self._lock_count -= 1
 
87
        self._lock_count -= 1