← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

Add a NEWS entry and prepare submission.

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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from cStringIO import StringIO
 
18
 
17
19
from bzrlib.lazy_import import lazy_import
18
20
lazy_import(globals(), """
 
21
import codecs
19
22
import warnings
20
23
 
21
24
from bzrlib import (
31
34
from bzrlib.decorators import (
32
35
    only_raises,
33
36
    )
 
37
from bzrlib.symbol_versioning import (
 
38
    deprecated_in,
 
39
    deprecated_method,
 
40
    )
 
41
 
 
42
 
 
43
# XXX: The tracking here of lock counts and whether the lock is held is
 
44
# somewhat redundant with what's done in LockDir; the main difference is that
 
45
# LockableFiles permits reentrancy.
 
46
 
 
47
class _LockWarner(object):
 
48
    """Hold a counter for a lock and warn if GCed while the count is >= 1.
 
49
 
 
50
    This is separate from LockableFiles because putting a __del__ on
 
51
    LockableFiles can result in uncollectable cycles.
 
52
    """
 
53
 
 
54
    def __init__(self, repr):
 
55
        self.lock_count = 0
 
56
        self.repr = repr
 
57
 
 
58
    def __del__(self):
 
59
        if self.lock_count >= 1:
 
60
            # There should have been a try/finally to unlock this.
 
61
            warnings.warn("%r was gc'd while locked" % self.repr)
34
62
 
35
63
 
36
64
class LockableFiles(object):
47
75
    This class is now deprecated; code should move to using the Transport
48
76
    directly for file operations and using the lock or CountedLock for
49
77
    locking.
50
 
 
 
78
    
51
79
    :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'
 
80
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
 
81
        can be re-entered.
56
82
    """
57
83
 
 
84
    # _lock_mode: None, or 'r' or 'w'
 
85
 
 
86
    # _lock_count: If _lock_mode is true, a positive count of the number of
 
87
    # times the lock has been taken *by this process*.
 
88
 
58
89
    def __init__(self, transport, lock_name, lock_class):
59
90
        """Create a LockableFiles group
60
91
 
68
99
        self.lock_name = lock_name
69
100
        self._transaction = None
70
101
        self._lock_mode = None
71
 
        self._lock_count = 0
 
102
        self._lock_warner = _LockWarner(repr(self))
72
103
        self._find_modes()
73
104
        esc_name = self._escape(lock_name)
74
105
        self._lock = lock_class(transport, esc_name,
87
118
    def __repr__(self):
88
119
        return '%s(%r)' % (self.__class__.__name__,
89
120
                           self._transport)
90
 
 
91
121
    def __str__(self):
92
122
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
93
123
 
151
181
        some other way, and need to synchronise this object's state with that
152
182
        fact.
153
183
        """
 
184
        # TODO: Upgrade locking to support using a Transport,
 
185
        # and potentially a remote locking protocol
154
186
        if self._lock_mode:
155
 
            if (self._lock_mode != 'w'
156
 
                or not self.get_transaction().writeable()):
 
187
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
157
188
                raise errors.ReadOnlyError(self)
158
189
            self._lock.validate_token(token)
159
 
            self._lock_count += 1
 
190
            self._lock_warner.lock_count += 1
160
191
            return self._token_from_lock
161
192
        else:
162
193
            token_from_lock = self._lock.lock_write(token=token)
163
194
            #traceback.print_stack()
164
195
            self._lock_mode = 'w'
165
 
            self._lock_count = 1
 
196
            self._lock_warner.lock_count = 1
166
197
            self._set_write_transaction()
167
198
            self._token_from_lock = token_from_lock
168
199
            return token_from_lock
171
202
        if self._lock_mode:
172
203
            if self._lock_mode not in ('r', 'w'):
173
204
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
174
 
            self._lock_count += 1
 
205
            self._lock_warner.lock_count += 1
175
206
        else:
176
207
            self._lock.lock_read()
177
208
            #traceback.print_stack()
178
209
            self._lock_mode = 'r'
179
 
            self._lock_count = 1
 
210
            self._lock_warner.lock_count = 1
180
211
            self._set_read_transaction()
181
212
 
182
213
    def _set_read_transaction(self):
193
224
    def unlock(self):
194
225
        if not self._lock_mode:
195
226
            return lock.cant_unlock_not_held(self)
196
 
        if self._lock_count > 1:
197
 
            self._lock_count -= 1
 
227
        if self._lock_warner.lock_count > 1:
 
228
            self._lock_warner.lock_count -= 1
198
229
        else:
199
230
            #traceback.print_stack()
200
231
            self._finish_transaction()
201
232
            try:
202
233
                self._lock.unlock()
203
234
            finally:
204
 
                self._lock_mode = self._lock_count = None
 
235
                self._lock_mode = self._lock_warner.lock_count = None
 
236
 
 
237
    @property
 
238
    def _lock_count(self):
 
239
        return self._lock_warner.lock_count
205
240
 
206
241
    def is_locked(self):
207
242
        """Return true if this LockableFiles group is locked"""
208
 
        return self._lock_count >= 1
 
243
        return self._lock_warner.lock_count >= 1
209
244
 
210
245
    def get_physical_lock_status(self):
211
246
        """Return physical lock status.
297
332
    def validate_token(self, token):
298
333
        if token is not None:
299
334
            raise errors.TokenLockingNotSupported(self)
 
335