← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
20
19
import warnings
21
20
 
22
21
from bzrlib import (
34
33
    )
35
34
 
36
35
 
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
 
 
58
36
class LockableFiles(object):
59
37
    """Object representing a set of related files locked within the same scope.
60
38
 
69
47
    This class is now deprecated; code should move to using the Transport
70
48
    directly for file operations and using the lock or CountedLock for
71
49
    locking.
72
 
    
 
50
 
73
51
    :ivar _lock: The real underlying lock (e.g. a LockDir)
74
 
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
75
 
        can be re-entered.
 
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'
76
56
    """
77
57
 
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
 
 
83
58
    def __init__(self, transport, lock_name, lock_class):
84
59
        """Create a LockableFiles group
85
60
 
93
68
        self.lock_name = lock_name
94
69
        self._transaction = None
95
70
        self._lock_mode = None
96
 
        self._lock_warner = _LockWarner(repr(self))
 
71
        self._lock_count = 0
97
72
        self._find_modes()
98
73
        esc_name = self._escape(lock_name)
99
74
        self._lock = lock_class(transport, esc_name,
112
87
    def __repr__(self):
113
88
        return '%s(%r)' % (self.__class__.__name__,
114
89
                           self._transport)
 
90
 
115
91
    def __str__(self):
116
92
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
117
93
 
175
151
        some other way, and need to synchronise this object's state with that
176
152
        fact.
177
153
        """
178
 
        # TODO: Upgrade locking to support using a Transport,
179
 
        # and potentially a remote locking protocol
180
154
        if self._lock_mode:
181
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
155
            if (self._lock_mode != 'w'
 
156
                or not self.get_transaction().writeable()):
182
157
                raise errors.ReadOnlyError(self)
183
158
            self._lock.validate_token(token)
184
 
            self._lock_warner.lock_count += 1
 
159
            self._lock_count += 1
185
160
            return self._token_from_lock
186
161
        else:
187
162
            token_from_lock = self._lock.lock_write(token=token)
188
163
            #traceback.print_stack()
189
164
            self._lock_mode = 'w'
190
 
            self._lock_warner.lock_count = 1
 
165
            self._lock_count = 1
191
166
            self._set_write_transaction()
192
167
            self._token_from_lock = token_from_lock
193
168
            return token_from_lock
196
171
        if self._lock_mode:
197
172
            if self._lock_mode not in ('r', 'w'):
198
173
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
199
 
            self._lock_warner.lock_count += 1
 
174
            self._lock_count += 1
200
175
        else:
201
176
            self._lock.lock_read()
202
177
            #traceback.print_stack()
203
178
            self._lock_mode = 'r'
204
 
            self._lock_warner.lock_count = 1
 
179
            self._lock_count = 1
205
180
            self._set_read_transaction()
206
181
 
207
182
    def _set_read_transaction(self):
218
193
    def unlock(self):
219
194
        if not self._lock_mode:
220
195
            return lock.cant_unlock_not_held(self)
221
 
        if self._lock_warner.lock_count > 1:
222
 
            self._lock_warner.lock_count -= 1
 
196
        if self._lock_count > 1:
 
197
            self._lock_count -= 1
223
198
        else:
224
199
            #traceback.print_stack()
225
200
            self._finish_transaction()
226
201
            try:
227
202
                self._lock.unlock()
228
203
            finally:
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
 
204
                self._lock_mode = self._lock_count = None
234
205
 
235
206
    def is_locked(self):
236
207
        """Return true if this LockableFiles group is locked"""
237
 
        return self._lock_warner.lock_count >= 1
 
208
        return self._lock_count >= 1
238
209
 
239
210
    def get_physical_lock_status(self):
240
211
        """Return physical lock status.
326
297
    def validate_token(self, token):
327
298
        if token is not None:
328
299
            raise errors.TokenLockingNotSupported(self)
329