← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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
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
 
17
from __future__ import absolute_import
18
18
 
19
19
from bzrlib.lazy_import import lazy_import
20
20
lazy_import(globals(), """
21
 
import codecs
22
21
import warnings
23
22
 
24
23
from bzrlib import (
25
24
    counted_lock,
26
25
    errors,
 
26
    lock,
27
27
    osutils,
28
28
    transactions,
29
29
    urlutils,
31
31
""")
32
32
 
33
33
from bzrlib.decorators import (
34
 
    needs_read_lock,
35
 
    needs_write_lock,
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
    only_raises,
 
35
    )
62
36
 
63
37
 
64
38
class LockableFiles(object):
65
39
    """Object representing a set of related files locked within the same scope.
66
40
 
67
 
    These files are used by a WorkingTree, Repository or Branch, and should
68
 
    generally only be touched by that object.
69
 
 
70
 
    LockableFiles also provides some policy on top of Transport for encoding
71
 
    control files as utf-8.
 
41
    This coordinates access to the lock along with providing a transaction.
72
42
 
73
43
    LockableFiles manage a lock count and can be locked repeatedly by
74
44
    a single caller.  (The underlying lock implementation generally does not
76
46
 
77
47
    Instances of this class are often called control_files.
78
48
 
79
 
    This object builds on top of a Transport, which is used to actually write
80
 
    the files to disk, and an OSLock or LockDir, which controls how access to
81
 
    the files is controlled.  The particular type of locking used is set when
82
 
    the object is constructed.  In older formats OSLocks are used everywhere.
83
 
    in newer formats a LockDir is used for Repositories and Branches, and
84
 
    OSLocks for the local filesystem.
85
 
 
86
49
    This class is now deprecated; code should move to using the Transport
87
50
    directly for file operations and using the lock or CountedLock for
88
51
    locking.
89
 
    
 
52
 
90
53
    :ivar _lock: The real underlying lock (e.g. a LockDir)
91
 
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
92
 
        can be re-entered.
 
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'
93
58
    """
94
59
 
95
 
    # _lock_mode: None, or 'r' or 'w'
96
 
 
97
 
    # _lock_count: If _lock_mode is true, a positive count of the number of
98
 
    # times the lock has been taken *by this process*.
99
 
 
100
60
    def __init__(self, transport, lock_name, lock_class):
101
61
        """Create a LockableFiles group
102
62
 
110
70
        self.lock_name = lock_name
111
71
        self._transaction = None
112
72
        self._lock_mode = None
113
 
        self._lock_warner = _LockWarner(repr(self))
 
73
        self._lock_count = 0
114
74
        self._find_modes()
115
75
        esc_name = self._escape(lock_name)
116
76
        self._lock = lock_class(transport, esc_name,
129
89
    def __repr__(self):
130
90
        return '%s(%r)' % (self.__class__.__name__,
131
91
                           self._transport)
 
92
 
132
93
    def __str__(self):
133
94
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
134
95
 
150
111
    def _find_modes(self):
151
112
        """Determine the appropriate modes for files and directories.
152
113
 
153
 
        :deprecated: Replaced by BzrDir._find_modes.
 
114
        :deprecated: Replaced by BzrDir._find_creation_modes.
154
115
        """
155
116
        # XXX: The properties created by this can be removed or deprecated
156
117
        # once all the _get_text_store methods etc no longer use them.
169
130
            # Remove the sticky and execute bits for files
170
131
            self._file_mode = self._dir_mode & ~07111
171
132
 
172
 
    @deprecated_method(deprecated_in((1, 6, 0)))
173
 
    def controlfilename(self, file_or_path):
174
 
        """Return location relative to branch.
175
 
 
176
 
        :deprecated: Use Transport methods instead.
177
 
        """
178
 
        return self._transport.abspath(self._escape(file_or_path))
179
 
 
180
 
    @needs_read_lock
181
 
    @deprecated_method(deprecated_in((1, 5, 0)))
182
 
    def get(self, relpath):
183
 
        """Get a file as a bytestream.
184
 
 
185
 
        :deprecated: Use a Transport instead of LockableFiles.
186
 
        """
187
 
        relpath = self._escape(relpath)
188
 
        return self._transport.get(relpath)
189
 
 
190
 
    @needs_read_lock
191
 
    @deprecated_method(deprecated_in((1, 5, 0)))
192
 
    def get_utf8(self, relpath):
193
 
        """Get a file as a unicode stream.
194
 
 
195
 
        :deprecated: Use a Transport instead of LockableFiles.
196
 
        """
197
 
        relpath = self._escape(relpath)
198
 
        # DO NOT introduce an errors=replace here.
199
 
        return codecs.getreader('utf-8')(self._transport.get(relpath))
200
 
 
201
 
    @needs_write_lock
202
 
    @deprecated_method(deprecated_in((1, 6, 0)))
203
 
    def put(self, path, file):
204
 
        """Write a file.
205
 
 
206
 
        :param path: The path to put the file, relative to the .bzr control
207
 
                     directory
208
 
        :param file: A file-like or string object whose contents should be copied.
209
 
 
210
 
        :deprecated: Use Transport methods instead.
211
 
        """
212
 
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
213
 
 
214
 
    @needs_write_lock
215
 
    @deprecated_method(deprecated_in((1, 6, 0)))
216
 
    def put_bytes(self, path, a_string):
217
 
        """Write a string of bytes.
218
 
 
219
 
        :param path: The path to put the bytes, relative to the transport root.
220
 
        :param a_string: A string object, whose exact bytes are to be copied.
221
 
 
222
 
        :deprecated: Use Transport methods instead.
223
 
        """
224
 
        self._transport.put_bytes(self._escape(path), a_string,
225
 
                                  mode=self._file_mode)
226
 
 
227
 
    @needs_write_lock
228
 
    @deprecated_method(deprecated_in((1, 6, 0)))
229
 
    def put_utf8(self, path, a_string):
230
 
        """Write a string, encoding as utf-8.
231
 
 
232
 
        :param path: The path to put the string, relative to the transport root.
233
 
        :param string: A string or unicode object whose contents should be copied.
234
 
 
235
 
        :deprecated: Use Transport methods instead.
236
 
        """
237
 
        # IterableFile would not be needed if Transport.put took iterables
238
 
        # instead of files.  ADHB 2005-12-25
239
 
        # RBC 20060103 surely its not needed anyway, with codecs transcode
240
 
        # file support ?
241
 
        # JAM 20060103 We definitely don't want encode(..., 'replace')
242
 
        # these are valuable files which should have exact contents.
243
 
        if not isinstance(a_string, basestring):
244
 
            raise errors.BzrBadParameterNotString(a_string)
245
 
        self.put_bytes(path, a_string.encode('utf-8'))
246
 
 
247
133
    def leave_in_place(self):
248
134
        """Set this LockableFiles to not clear the physical lock on unlock."""
249
135
        self._lock.leave_in_place()
267
153
        some other way, and need to synchronise this object's state with that
268
154
        fact.
269
155
        """
270
 
        # TODO: Upgrade locking to support using a Transport,
271
 
        # and potentially a remote locking protocol
272
156
        if self._lock_mode:
273
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
157
            if (self._lock_mode != 'w'
 
158
                or not self.get_transaction().writeable()):
274
159
                raise errors.ReadOnlyError(self)
275
160
            self._lock.validate_token(token)
276
 
            self._lock_warner.lock_count += 1
 
161
            self._lock_count += 1
277
162
            return self._token_from_lock
278
163
        else:
279
164
            token_from_lock = self._lock.lock_write(token=token)
280
165
            #traceback.print_stack()
281
166
            self._lock_mode = 'w'
282
 
            self._lock_warner.lock_count = 1
 
167
            self._lock_count = 1
283
168
            self._set_write_transaction()
284
169
            self._token_from_lock = token_from_lock
285
170
            return token_from_lock
288
173
        if self._lock_mode:
289
174
            if self._lock_mode not in ('r', 'w'):
290
175
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
291
 
            self._lock_warner.lock_count += 1
 
176
            self._lock_count += 1
292
177
        else:
293
178
            self._lock.lock_read()
294
179
            #traceback.print_stack()
295
180
            self._lock_mode = 'r'
296
 
            self._lock_warner.lock_count = 1
 
181
            self._lock_count = 1
297
182
            self._set_read_transaction()
298
183
 
299
184
    def _set_read_transaction(self):
306
191
        """Setup a write transaction."""
307
192
        self._set_transaction(transactions.WriteTransaction())
308
193
 
 
194
    @only_raises(errors.LockNotHeld, errors.LockBroken)
309
195
    def unlock(self):
310
196
        if not self._lock_mode:
311
 
            raise errors.LockNotHeld(self)
312
 
        if self._lock_warner.lock_count > 1:
313
 
            self._lock_warner.lock_count -= 1
 
197
            return lock.cant_unlock_not_held(self)
 
198
        if self._lock_count > 1:
 
199
            self._lock_count -= 1
314
200
        else:
315
201
            #traceback.print_stack()
316
202
            self._finish_transaction()
317
203
            try:
318
204
                self._lock.unlock()
319
205
            finally:
320
 
                self._lock_mode = self._lock_warner.lock_count = None
321
 
 
322
 
    @property
323
 
    def _lock_count(self):
324
 
        return self._lock_warner.lock_count
 
206
                self._lock_mode = self._lock_count = None
325
207
 
326
208
    def is_locked(self):
327
209
        """Return true if this LockableFiles group is locked"""
328
 
        return self._lock_warner.lock_count >= 1
 
210
        return self._lock_count >= 1
329
211
 
330
212
    def get_physical_lock_status(self):
331
213
        """Return physical lock status.
417
299
    def validate_token(self, token):
418
300
        if token is not None:
419
301
            raise errors.TokenLockingNotSupported(self)
420