← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Jelmer Vernooij
  • Date: 2009-02-10 04:10:44 UTC
  • mto: This revision was merged to the branch mainline in revision 3995.
  • Revision ID: jelmer@samba.org-20090210041044-42lmb09hskt9lt9l
Review from Ian.

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, 2006, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from cStringIO import StringIO
16
18
 
17
19
from bzrlib.lazy_import import lazy_import
18
20
lazy_import(globals(), """
20
22
import warnings
21
23
 
22
24
from bzrlib import (
23
 
    counted_lock,
24
25
    errors,
25
 
    lock,
26
26
    osutils,
27
27
    transactions,
28
28
    urlutils,
30
30
""")
31
31
 
32
32
from bzrlib.decorators import (
33
 
    only_raises,
 
33
    needs_read_lock,
 
34
    needs_write_lock,
 
35
    )
 
36
from bzrlib.symbol_versioning import (
 
37
    deprecated_in,
 
38
    deprecated_method,
34
39
    )
35
40
 
36
41
 
38
43
# somewhat redundant with what's done in LockDir; the main difference is that
39
44
# LockableFiles permits reentrancy.
40
45
 
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
46
class LockableFiles(object):
59
47
    """Object representing a set of related files locked within the same scope.
60
48
 
61
 
    This coordinates access to the lock along with providing a transaction.
 
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.
62
54
 
63
55
    LockableFiles manage a lock count and can be locked repeatedly by
64
56
    a single caller.  (The underlying lock implementation generally does not
65
57
    support this.)
66
58
 
67
59
    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.
68
67
 
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
 
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 
71
70
    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.
76
71
    """
77
72
 
78
73
    # _lock_mode: None, or 'r' or 'w'
79
74
 
80
75
    # _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
 
 
 
76
    # times the lock has been taken *by this process*.   
 
77
    
83
78
    def __init__(self, transport, lock_name, lock_class):
84
79
        """Create a LockableFiles group
85
80
 
86
 
        :param transport: Transport pointing to the directory holding the
 
81
        :param transport: Transport pointing to the directory holding the 
87
82
            control files and lock.
88
83
        :param lock_name: Name of the lock guarding these files.
89
84
        :param lock_class: Class of lock strategy to use: typically
93
88
        self.lock_name = lock_name
94
89
        self._transaction = None
95
90
        self._lock_mode = None
96
 
        self._lock_warner = _LockWarner(repr(self))
 
91
        self._lock_count = 0
97
92
        self._find_modes()
98
93
        esc_name = self._escape(lock_name)
99
94
        self._lock = lock_class(transport, esc_name,
100
95
                                file_modebits=self._file_mode,
101
96
                                dir_modebits=self._dir_mode)
102
 
        self._counted_lock = counted_lock.CountedLock(self._lock)
103
97
 
104
98
    def create_lock(self):
105
99
        """Create the lock.
115
109
    def __str__(self):
116
110
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
117
111
 
 
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_creation_modes.
 
135
        
 
136
        :deprecated: Replaced by BzrDir._find_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
141
138
        try:
142
139
            st = self._transport.stat('.')
143
140
        except errors.TransportNotPossible:
152
149
            # Remove the sticky and execute bits for files
153
150
            self._file_mode = self._dir_mode & ~07111
154
151
 
 
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
 
155
227
    def leave_in_place(self):
156
228
        """Set this LockableFiles to not clear the physical lock on unlock."""
157
229
        self._lock.leave_in_place()
162
234
 
163
235
    def lock_write(self, token=None):
164
236
        """Lock this group of files for writing.
165
 
 
 
237
        
166
238
        :param token: if this is already locked, then lock_write will fail
167
239
            unless the token matches the existing lock.
168
240
        :returns: a token if this instance supports tokens, otherwise None.
181
253
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
182
254
                raise errors.ReadOnlyError(self)
183
255
            self._lock.validate_token(token)
184
 
            self._lock_warner.lock_count += 1
 
256
            self._lock_count += 1
185
257
            return self._token_from_lock
186
258
        else:
187
259
            token_from_lock = self._lock.lock_write(token=token)
188
260
            #traceback.print_stack()
189
261
            self._lock_mode = 'w'
190
 
            self._lock_warner.lock_count = 1
191
 
            self._set_write_transaction()
 
262
            self._lock_count = 1
 
263
            self._set_transaction(transactions.WriteTransaction())
192
264
            self._token_from_lock = token_from_lock
193
265
            return token_from_lock
194
266
 
196
268
        if self._lock_mode:
197
269
            if self._lock_mode not in ('r', 'w'):
198
270
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
199
 
            self._lock_warner.lock_count += 1
 
271
            self._lock_count += 1
200
272
        else:
201
273
            self._lock.lock_read()
202
274
            #traceback.print_stack()
203
275
            self._lock_mode = 'r'
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)
 
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
                        
218
281
    def unlock(self):
219
282
        if not self._lock_mode:
220
 
            return lock.cant_unlock_not_held(self)
221
 
        if self._lock_warner.lock_count > 1:
222
 
            self._lock_warner.lock_count -= 1
 
283
            raise errors.LockNotHeld(self)
 
284
        if self._lock_count > 1:
 
285
            self._lock_count -= 1
223
286
        else:
224
287
            #traceback.print_stack()
225
288
            self._finish_transaction()
226
289
            try:
227
290
                self._lock.unlock()
228
291
            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
 
292
                self._lock_mode = self._lock_count = None
234
293
 
235
294
    def is_locked(self):
236
295
        """Return true if this LockableFiles group is locked"""
237
 
        return self._lock_warner.lock_count >= 1
 
296
        return self._lock_count >= 1
238
297
 
239
298
    def get_physical_lock_status(self):
240
299
        """Return physical lock status.
241
 
 
 
300
        
242
301
        Returns true if a lock is held on the transport. If no lock is held, or
243
302
        the underlying locking mechanism does not support querying lock
244
303
        status, false is returned.
326
385
    def validate_token(self, token):
327
386
        if token is not None:
328
387
            raise errors.TokenLockingNotSupported(self)
329
 
 
 
388