← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

(gz) Fix test failure on alpha by correcting format string for
 gc_chk_sha1_record (Martin [gz])

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008, 2009 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
16
16
 
17
17
from bzrlib.lazy_import import lazy_import
18
18
lazy_import(globals(), """
 
19
import codecs
19
20
import warnings
20
21
 
21
22
from bzrlib import (
33
34
    )
34
35
 
35
36
 
 
37
# XXX: The tracking here of lock counts and whether the lock is held is
 
38
# somewhat redundant with what's done in LockDir; the main difference is that
 
39
# LockableFiles permits reentrancy.
 
40
 
 
41
class _LockWarner(object):
 
42
    """Hold a counter for a lock and warn if GCed while the count is >= 1.
 
43
 
 
44
    This is separate from LockableFiles because putting a __del__ on
 
45
    LockableFiles can result in uncollectable cycles.
 
46
    """
 
47
 
 
48
    def __init__(self, repr):
 
49
        self.lock_count = 0
 
50
        self.repr = repr
 
51
 
 
52
    def __del__(self):
 
53
        if self.lock_count >= 1:
 
54
            # There should have been a try/finally to unlock this.
 
55
            warnings.warn("%r was gc'd while locked" % self.repr)
 
56
 
 
57
 
36
58
class LockableFiles(object):
37
59
    """Object representing a set of related files locked within the same scope.
38
60
 
47
69
    This class is now deprecated; code should move to using the Transport
48
70
    directly for file operations and using the lock or CountedLock for
49
71
    locking.
50
 
 
 
72
    
51
73
    :ivar _lock: The real underlying lock (e.g. a LockDir)
52
 
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
53
 
        of times the lock has been taken (and not yet released) *by this
54
 
        process*, through this particular object instance.
55
 
    :ivar _lock_mode: None, or 'r' or 'w'
 
74
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
 
75
        can be re-entered.
56
76
    """
57
77
 
 
78
    # _lock_mode: None, or 'r' or 'w'
 
79
 
 
80
    # _lock_count: If _lock_mode is true, a positive count of the number of
 
81
    # times the lock has been taken *by this process*.
 
82
 
58
83
    def __init__(self, transport, lock_name, lock_class):
59
84
        """Create a LockableFiles group
60
85
 
68
93
        self.lock_name = lock_name
69
94
        self._transaction = None
70
95
        self._lock_mode = None
71
 
        self._lock_count = 0
 
96
        self._lock_warner = _LockWarner(repr(self))
72
97
        self._find_modes()
73
98
        esc_name = self._escape(lock_name)
74
99
        self._lock = lock_class(transport, esc_name,
87
112
    def __repr__(self):
88
113
        return '%s(%r)' % (self.__class__.__name__,
89
114
                           self._transport)
90
 
 
91
115
    def __str__(self):
92
116
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
93
117
 
151
175
        some other way, and need to synchronise this object's state with that
152
176
        fact.
153
177
        """
 
178
        # TODO: Upgrade locking to support using a Transport,
 
179
        # and potentially a remote locking protocol
154
180
        if self._lock_mode:
155
 
            if (self._lock_mode != 'w'
156
 
                or not self.get_transaction().writeable()):
 
181
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
157
182
                raise errors.ReadOnlyError(self)
158
183
            self._lock.validate_token(token)
159
 
            self._lock_count += 1
 
184
            self._lock_warner.lock_count += 1
160
185
            return self._token_from_lock
161
186
        else:
162
187
            token_from_lock = self._lock.lock_write(token=token)
163
188
            #traceback.print_stack()
164
189
            self._lock_mode = 'w'
165
 
            self._lock_count = 1
 
190
            self._lock_warner.lock_count = 1
166
191
            self._set_write_transaction()
167
192
            self._token_from_lock = token_from_lock
168
193
            return token_from_lock
171
196
        if self._lock_mode:
172
197
            if self._lock_mode not in ('r', 'w'):
173
198
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
174
 
            self._lock_count += 1
 
199
            self._lock_warner.lock_count += 1
175
200
        else:
176
201
            self._lock.lock_read()
177
202
            #traceback.print_stack()
178
203
            self._lock_mode = 'r'
179
 
            self._lock_count = 1
 
204
            self._lock_warner.lock_count = 1
180
205
            self._set_read_transaction()
181
206
 
182
207
    def _set_read_transaction(self):
193
218
    def unlock(self):
194
219
        if not self._lock_mode:
195
220
            return lock.cant_unlock_not_held(self)
196
 
        if self._lock_count > 1:
197
 
            self._lock_count -= 1
 
221
        if self._lock_warner.lock_count > 1:
 
222
            self._lock_warner.lock_count -= 1
198
223
        else:
199
224
            #traceback.print_stack()
200
225
            self._finish_transaction()
201
226
            try:
202
227
                self._lock.unlock()
203
228
            finally:
204
 
                self._lock_mode = self._lock_count = None
 
229
                self._lock_mode = self._lock_warner.lock_count = None
 
230
 
 
231
    @property
 
232
    def _lock_count(self):
 
233
        return self._lock_warner.lock_count
205
234
 
206
235
    def is_locked(self):
207
236
        """Return true if this LockableFiles group is locked"""
208
 
        return self._lock_count >= 1
 
237
        return self._lock_warner.lock_count >= 1
209
238
 
210
239
    def get_physical_lock_status(self):
211
240
        """Return physical lock status.
297
326
    def validate_token(self, token):
298
327
        if token is not None:
299
328
            raise errors.TokenLockingNotSupported(self)
 
329