← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

Merge sftp-leaks into catch-them-all resolving conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006, 2008 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
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
from bzrlib.lazy_import import lazy_import
20
18
lazy_import(globals(), """
22
20
import warnings
23
21
 
24
22
from bzrlib import (
 
23
    counted_lock,
25
24
    errors,
 
25
    lock,
26
26
    osutils,
27
27
    transactions,
28
28
    urlutils,
30
30
""")
31
31
 
32
32
from bzrlib.decorators import (
33
 
    needs_read_lock,
34
 
    needs_write_lock,
35
 
    )
36
 
from bzrlib.symbol_versioning import (
37
 
    deprecated_in,
38
 
    deprecated_method,
 
33
    only_raises,
39
34
    )
40
35
 
41
36
 
43
38
# somewhat redundant with what's done in LockDir; the main difference is that
44
39
# LockableFiles permits reentrancy.
45
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
 
46
58
class LockableFiles(object):
47
59
    """Object representing a set of related files locked within the same scope.
48
60
 
49
 
    These files are used by a WorkingTree, Repository or Branch, and should
50
 
    generally only be touched by that object.
51
 
 
52
 
    LockableFiles also provides some policy on top of Transport for encoding
53
 
    control files as utf-8.
 
61
    This coordinates access to the lock along with providing a transaction.
54
62
 
55
63
    LockableFiles manage a lock count and can be locked repeatedly by
56
64
    a single caller.  (The underlying lock implementation generally does not
57
65
    support this.)
58
66
 
59
67
    Instances of this class are often called control_files.
60
 
    
61
 
    This object builds on top of a Transport, which is used to actually write
62
 
    the files to disk, and an OSLock or LockDir, which controls how access to
63
 
    the files is controlled.  The particular type of locking used is set when
64
 
    the object is constructed.  In older formats OSLocks are used everywhere.
65
 
    in newer formats a LockDir is used for Repositories and Branches, and 
66
 
    OSLocks for the local filesystem.
67
68
 
68
 
    This class is now deprecated; code should move to using the Transport 
69
 
    directly for file operations and using the lock or CountedLock for 
 
69
    This class is now deprecated; code should move to using the Transport
 
70
    directly for file operations and using the lock or CountedLock for
70
71
    locking.
 
72
    
 
73
    :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.
71
76
    """
72
77
 
73
78
    # _lock_mode: None, or 'r' or 'w'
74
79
 
75
80
    # _lock_count: If _lock_mode is true, a positive count of the number of
76
 
    # times the lock has been taken *by this process*.   
77
 
    
 
81
    # times the lock has been taken *by this process*.
 
82
 
78
83
    def __init__(self, transport, lock_name, lock_class):
79
84
        """Create a LockableFiles group
80
85
 
81
 
        :param transport: Transport pointing to the directory holding the 
 
86
        :param transport: Transport pointing to the directory holding the
82
87
            control files and lock.
83
88
        :param lock_name: Name of the lock guarding these files.
84
89
        :param lock_class: Class of lock strategy to use: typically
88
93
        self.lock_name = lock_name
89
94
        self._transaction = None
90
95
        self._lock_mode = None
91
 
        self._lock_count = 0
 
96
        self._lock_warner = _LockWarner(repr(self))
92
97
        self._find_modes()
93
98
        esc_name = self._escape(lock_name)
94
99
        self._lock = lock_class(transport, esc_name,
95
100
                                file_modebits=self._file_mode,
96
101
                                dir_modebits=self._dir_mode)
 
102
        self._counted_lock = counted_lock.CountedLock(self._lock)
97
103
 
98
104
    def create_lock(self):
99
105
        """Create the lock.
109
115
    def __str__(self):
110
116
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
111
117
 
112
 
    def __del__(self):
113
 
        if self.is_locked():
114
 
            # do not automatically unlock; there should have been a
115
 
            # try/finally to unlock this.
116
 
            warnings.warn("%r was gc'd while locked" % self)
117
 
 
118
118
    def break_lock(self):
119
119
        """Break the lock of this lockable files group if it is held.
120
120
 
132
132
 
133
133
    def _find_modes(self):
134
134
        """Determine the appropriate modes for files and directories.
135
 
        
136
 
        :deprecated: Replaced by BzrDir._find_modes.
 
135
 
 
136
        :deprecated: Replaced by BzrDir._find_creation_modes.
137
137
        """
 
138
        # XXX: The properties created by this can be removed or deprecated
 
139
        # once all the _get_text_store methods etc no longer use them.
 
140
        # -- mbp 20080512
138
141
        try:
139
142
            st = self._transport.stat('.')
140
143
        except errors.TransportNotPossible:
149
152
            # Remove the sticky and execute bits for files
150
153
            self._file_mode = self._dir_mode & ~07111
151
154
 
152
 
    @deprecated_method(deprecated_in((1, 6, 0)))
153
 
    def controlfilename(self, file_or_path):
154
 
        """Return location relative to branch.
155
 
        
156
 
        :deprecated: Use Transport methods instead.
157
 
        """
158
 
        return self._transport.abspath(self._escape(file_or_path))
159
 
 
160
 
    @needs_read_lock
161
 
    @deprecated_method(deprecated_in((1, 5, 0)))
162
 
    def get(self, relpath):
163
 
        """Get a file as a bytestream.
164
 
        
165
 
        :deprecated: Use a Transport instead of LockableFiles.
166
 
        """
167
 
        relpath = self._escape(relpath)
168
 
        return self._transport.get(relpath)
169
 
 
170
 
    @needs_read_lock
171
 
    @deprecated_method(deprecated_in((1, 5, 0)))
172
 
    def get_utf8(self, relpath):
173
 
        """Get a file as a unicode stream.
174
 
        
175
 
        :deprecated: Use a Transport instead of LockableFiles.
176
 
        """
177
 
        relpath = self._escape(relpath)
178
 
        # DO NOT introduce an errors=replace here.
179
 
        return codecs.getreader('utf-8')(self._transport.get(relpath))
180
 
 
181
 
    @needs_write_lock
182
 
    @deprecated_method(deprecated_in((1, 6, 0)))
183
 
    def put(self, path, file):
184
 
        """Write a file.
185
 
        
186
 
        :param path: The path to put the file, relative to the .bzr control
187
 
                     directory
188
 
        :param file: A file-like or string object whose contents should be copied.
189
 
 
190
 
        :deprecated: Use Transport methods instead.
191
 
        """
192
 
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
193
 
 
194
 
    @needs_write_lock
195
 
    @deprecated_method(deprecated_in((1, 6, 0)))
196
 
    def put_bytes(self, path, a_string):
197
 
        """Write a string of bytes.
198
 
 
199
 
        :param path: The path to put the bytes, relative to the transport root.
200
 
        :param a_string: A string object, whose exact bytes are to be copied.
201
 
 
202
 
        :deprecated: Use Transport methods instead.
203
 
        """
204
 
        self._transport.put_bytes(self._escape(path), a_string,
205
 
                                  mode=self._file_mode)
206
 
 
207
 
    @needs_write_lock
208
 
    @deprecated_method(deprecated_in((1, 6, 0)))
209
 
    def put_utf8(self, path, a_string):
210
 
        """Write a string, encoding as utf-8.
211
 
 
212
 
        :param path: The path to put the string, relative to the transport root.
213
 
        :param string: A string or unicode object whose contents should be copied.
214
 
 
215
 
        :deprecated: Use Transport methods instead.
216
 
        """
217
 
        # IterableFile would not be needed if Transport.put took iterables
218
 
        # instead of files.  ADHB 2005-12-25
219
 
        # RBC 20060103 surely its not needed anyway, with codecs transcode
220
 
        # file support ?
221
 
        # JAM 20060103 We definitely don't want encode(..., 'replace')
222
 
        # these are valuable files which should have exact contents.
223
 
        if not isinstance(a_string, basestring):
224
 
            raise errors.BzrBadParameterNotString(a_string)
225
 
        self.put_bytes(path, a_string.encode('utf-8'))
226
 
 
227
155
    def leave_in_place(self):
228
156
        """Set this LockableFiles to not clear the physical lock on unlock."""
229
157
        self._lock.leave_in_place()
234
162
 
235
163
    def lock_write(self, token=None):
236
164
        """Lock this group of files for writing.
237
 
        
 
165
 
238
166
        :param token: if this is already locked, then lock_write will fail
239
167
            unless the token matches the existing lock.
240
168
        :returns: a token if this instance supports tokens, otherwise None.
253
181
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
254
182
                raise errors.ReadOnlyError(self)
255
183
            self._lock.validate_token(token)
256
 
            self._lock_count += 1
 
184
            self._lock_warner.lock_count += 1
257
185
            return self._token_from_lock
258
186
        else:
259
187
            token_from_lock = self._lock.lock_write(token=token)
260
188
            #traceback.print_stack()
261
189
            self._lock_mode = 'w'
262
 
            self._lock_count = 1
263
 
            self._set_transaction(transactions.WriteTransaction())
 
190
            self._lock_warner.lock_count = 1
 
191
            self._set_write_transaction()
264
192
            self._token_from_lock = token_from_lock
265
193
            return token_from_lock
266
194
 
268
196
        if self._lock_mode:
269
197
            if self._lock_mode not in ('r', 'w'):
270
198
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
271
 
            self._lock_count += 1
 
199
            self._lock_warner.lock_count += 1
272
200
        else:
273
201
            self._lock.lock_read()
274
202
            #traceback.print_stack()
275
203
            self._lock_mode = 'r'
276
 
            self._lock_count = 1
277
 
            self._set_transaction(transactions.ReadOnlyTransaction())
278
 
            # 5K may be excessive, but hey, its a knob.
279
 
            self.get_transaction().set_cache_size(5000)
280
 
                        
 
204
            self._lock_warner.lock_count = 1
 
205
            self._set_read_transaction()
 
206
 
 
207
    def _set_read_transaction(self):
 
208
        """Setup a read transaction."""
 
209
        self._set_transaction(transactions.ReadOnlyTransaction())
 
210
        # 5K may be excessive, but hey, its a knob.
 
211
        self.get_transaction().set_cache_size(5000)
 
212
 
 
213
    def _set_write_transaction(self):
 
214
        """Setup a write transaction."""
 
215
        self._set_transaction(transactions.WriteTransaction())
 
216
 
 
217
    @only_raises(errors.LockNotHeld, errors.LockBroken)
281
218
    def unlock(self):
282
219
        if not self._lock_mode:
283
 
            raise errors.LockNotHeld(self)
284
 
        if self._lock_count > 1:
285
 
            self._lock_count -= 1
 
220
            return lock.cant_unlock_not_held(self)
 
221
        if self._lock_warner.lock_count > 1:
 
222
            self._lock_warner.lock_count -= 1
286
223
        else:
287
224
            #traceback.print_stack()
288
225
            self._finish_transaction()
289
226
            try:
290
227
                self._lock.unlock()
291
228
            finally:
292
 
                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
293
234
 
294
235
    def is_locked(self):
295
236
        """Return true if this LockableFiles group is locked"""
296
 
        return self._lock_count >= 1
 
237
        return self._lock_warner.lock_count >= 1
297
238
 
298
239
    def get_physical_lock_status(self):
299
240
        """Return physical lock status.
300
 
        
 
241
 
301
242
        Returns true if a lock is held on the transport. If no lock is held, or
302
243
        the underlying locking mechanism does not support querying lock
303
244
        status, false is returned.
385
326
    def validate_token(self, token):
386
327
        if token is not None:
387
328
            raise errors.TokenLockingNotSupported(self)
388
 
        
 
329