← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-25 00:02:51 UTC
  • mfrom: (5106.1.1 version-bump)
  • Revision ID: pqm@pqm.ubuntu.com-20100325000251-bwsv5c5d3l9x3lnn
(Jelmer) Bump API version for 2.2.0.

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 __future__ import absolute_import
 
17
from cStringIO import StringIO
18
18
 
19
19
from bzrlib.lazy_import import lazy_import
20
20
lazy_import(globals(), """
 
21
import codecs
21
22
import warnings
22
23
 
23
24
from bzrlib import (
33
34
from bzrlib.decorators import (
34
35
    only_raises,
35
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)
36
62
 
37
63
 
38
64
class LockableFiles(object):
49
75
    This class is now deprecated; code should move to using the Transport
50
76
    directly for file operations and using the lock or CountedLock for
51
77
    locking.
52
 
 
 
78
    
53
79
    :ivar _lock: The real underlying lock (e.g. a LockDir)
54
 
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
55
 
        of times the lock has been taken (and not yet released) *by this
56
 
        process*, through this particular object instance.
57
 
    :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.
58
82
    """
59
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
 
60
89
    def __init__(self, transport, lock_name, lock_class):
61
90
        """Create a LockableFiles group
62
91
 
70
99
        self.lock_name = lock_name
71
100
        self._transaction = None
72
101
        self._lock_mode = None
73
 
        self._lock_count = 0
 
102
        self._lock_warner = _LockWarner(repr(self))
74
103
        self._find_modes()
75
104
        esc_name = self._escape(lock_name)
76
105
        self._lock = lock_class(transport, esc_name,
89
118
    def __repr__(self):
90
119
        return '%s(%r)' % (self.__class__.__name__,
91
120
                           self._transport)
92
 
 
93
121
    def __str__(self):
94
122
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
95
123
 
153
181
        some other way, and need to synchronise this object's state with that
154
182
        fact.
155
183
        """
 
184
        # TODO: Upgrade locking to support using a Transport,
 
185
        # and potentially a remote locking protocol
156
186
        if self._lock_mode:
157
 
            if (self._lock_mode != 'w'
158
 
                or not self.get_transaction().writeable()):
 
187
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
159
188
                raise errors.ReadOnlyError(self)
160
189
            self._lock.validate_token(token)
161
 
            self._lock_count += 1
 
190
            self._lock_warner.lock_count += 1
162
191
            return self._token_from_lock
163
192
        else:
164
193
            token_from_lock = self._lock.lock_write(token=token)
165
194
            #traceback.print_stack()
166
195
            self._lock_mode = 'w'
167
 
            self._lock_count = 1
 
196
            self._lock_warner.lock_count = 1
168
197
            self._set_write_transaction()
169
198
            self._token_from_lock = token_from_lock
170
199
            return token_from_lock
173
202
        if self._lock_mode:
174
203
            if self._lock_mode not in ('r', 'w'):
175
204
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
176
 
            self._lock_count += 1
 
205
            self._lock_warner.lock_count += 1
177
206
        else:
178
207
            self._lock.lock_read()
179
208
            #traceback.print_stack()
180
209
            self._lock_mode = 'r'
181
 
            self._lock_count = 1
 
210
            self._lock_warner.lock_count = 1
182
211
            self._set_read_transaction()
183
212
 
184
213
    def _set_read_transaction(self):
195
224
    def unlock(self):
196
225
        if not self._lock_mode:
197
226
            return lock.cant_unlock_not_held(self)
198
 
        if self._lock_count > 1:
199
 
            self._lock_count -= 1
 
227
        if self._lock_warner.lock_count > 1:
 
228
            self._lock_warner.lock_count -= 1
200
229
        else:
201
230
            #traceback.print_stack()
202
231
            self._finish_transaction()
203
232
            try:
204
233
                self._lock.unlock()
205
234
            finally:
206
 
                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
207
240
 
208
241
    def is_locked(self):
209
242
        """Return true if this LockableFiles group is locked"""
210
 
        return self._lock_count >= 1
 
243
        return self._lock_warner.lock_count >= 1
211
244
 
212
245
    def get_physical_lock_status(self):
213
246
        """Return physical lock status.
299
332
    def validate_token(self, token):
300
333
        if token is not None:
301
334
            raise errors.TokenLockingNotSupported(self)
 
335