← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-10 15:46:03 UTC
  • mfrom: (4985.3.21 update)
  • mto: This revision was merged to the branch mainline in revision 5021.
  • Revision ID: v.ladeuil+lp@free.fr-20100210154603-k4no1gvfuqpzrw7p
https://launchpad.net/bugs/113809
Update performs two merges in a more logical order but stop on 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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
from cStringIO import StringIO
18
18
 
22
22
import warnings
23
23
 
24
24
from bzrlib import (
 
25
    counted_lock,
25
26
    errors,
 
27
    lock,
26
28
    osutils,
27
29
    transactions,
28
30
    urlutils,
30
32
""")
31
33
 
32
34
from bzrlib.decorators import (
33
 
    needs_read_lock,
34
 
    needs_write_lock,
 
35
    only_raises,
35
36
    )
36
37
from bzrlib.symbol_versioning import (
37
38
    deprecated_in,
43
44
# somewhat redundant with what's done in LockDir; the main difference is that
44
45
# LockableFiles permits reentrancy.
45
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)
 
62
 
 
63
 
46
64
class LockableFiles(object):
47
65
    """Object representing a set of related files locked within the same scope.
48
66
 
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.
 
67
    This coordinates access to the lock along with providing a transaction.
54
68
 
55
69
    LockableFiles manage a lock count and can be locked repeatedly by
56
70
    a single caller.  (The underlying lock implementation generally does not
57
71
    support this.)
58
72
 
59
73
    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
74
 
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 
 
75
    This class is now deprecated; code should move to using the Transport
 
76
    directly for file operations and using the lock or CountedLock for
70
77
    locking.
 
78
    
 
79
    :ivar _lock: The real underlying lock (e.g. a LockDir)
 
80
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
 
81
        can be re-entered.
71
82
    """
72
83
 
73
84
    # _lock_mode: None, or 'r' or 'w'
74
85
 
75
86
    # _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
 
    
 
87
    # times the lock has been taken *by this process*.
 
88
 
78
89
    def __init__(self, transport, lock_name, lock_class):
79
90
        """Create a LockableFiles group
80
91
 
81
 
        :param transport: Transport pointing to the directory holding the 
 
92
        :param transport: Transport pointing to the directory holding the
82
93
            control files and lock.
83
94
        :param lock_name: Name of the lock guarding these files.
84
95
        :param lock_class: Class of lock strategy to use: typically
88
99
        self.lock_name = lock_name
89
100
        self._transaction = None
90
101
        self._lock_mode = None
91
 
        self._lock_count = 0
 
102
        self._lock_warner = _LockWarner(repr(self))
92
103
        self._find_modes()
93
104
        esc_name = self._escape(lock_name)
94
105
        self._lock = lock_class(transport, esc_name,
95
106
                                file_modebits=self._file_mode,
96
107
                                dir_modebits=self._dir_mode)
 
108
        self._counted_lock = counted_lock.CountedLock(self._lock)
97
109
 
98
110
    def create_lock(self):
99
111
        """Create the lock.
109
121
    def __str__(self):
110
122
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
111
123
 
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
124
    def break_lock(self):
119
125
        """Break the lock of this lockable files group if it is held.
120
126
 
132
138
 
133
139
    def _find_modes(self):
134
140
        """Determine the appropriate modes for files and directories.
135
 
        
136
 
        :deprecated: Replaced by BzrDir._find_modes.
 
141
 
 
142
        :deprecated: Replaced by BzrDir._find_creation_modes.
137
143
        """
 
144
        # XXX: The properties created by this can be removed or deprecated
 
145
        # once all the _get_text_store methods etc no longer use them.
 
146
        # -- mbp 20080512
138
147
        try:
139
148
            st = self._transport.stat('.')
140
149
        except errors.TransportNotPossible:
149
158
            # Remove the sticky and execute bits for files
150
159
            self._file_mode = self._dir_mode & ~07111
151
160
 
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
161
    def leave_in_place(self):
228
162
        """Set this LockableFiles to not clear the physical lock on unlock."""
229
163
        self._lock.leave_in_place()
234
168
 
235
169
    def lock_write(self, token=None):
236
170
        """Lock this group of files for writing.
237
 
        
 
171
 
238
172
        :param token: if this is already locked, then lock_write will fail
239
173
            unless the token matches the existing lock.
240
174
        :returns: a token if this instance supports tokens, otherwise None.
253
187
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
254
188
                raise errors.ReadOnlyError(self)
255
189
            self._lock.validate_token(token)
256
 
            self._lock_count += 1
 
190
            self._lock_warner.lock_count += 1
257
191
            return self._token_from_lock
258
192
        else:
259
193
            token_from_lock = self._lock.lock_write(token=token)
260
194
            #traceback.print_stack()
261
195
            self._lock_mode = 'w'
262
 
            self._lock_count = 1
263
 
            self._set_transaction(transactions.WriteTransaction())
 
196
            self._lock_warner.lock_count = 1
 
197
            self._set_write_transaction()
264
198
            self._token_from_lock = token_from_lock
265
199
            return token_from_lock
266
200
 
268
202
        if self._lock_mode:
269
203
            if self._lock_mode not in ('r', 'w'):
270
204
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
271
 
            self._lock_count += 1
 
205
            self._lock_warner.lock_count += 1
272
206
        else:
273
207
            self._lock.lock_read()
274
208
            #traceback.print_stack()
275
209
            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
 
                        
 
210
            self._lock_warner.lock_count = 1
 
211
            self._set_read_transaction()
 
212
 
 
213
    def _set_read_transaction(self):
 
214
        """Setup a read transaction."""
 
215
        self._set_transaction(transactions.ReadOnlyTransaction())
 
216
        # 5K may be excessive, but hey, its a knob.
 
217
        self.get_transaction().set_cache_size(5000)
 
218
 
 
219
    def _set_write_transaction(self):
 
220
        """Setup a write transaction."""
 
221
        self._set_transaction(transactions.WriteTransaction())
 
222
 
 
223
    @only_raises(errors.LockNotHeld, errors.LockBroken)
281
224
    def unlock(self):
282
225
        if not self._lock_mode:
283
 
            raise errors.LockNotHeld(self)
284
 
        if self._lock_count > 1:
285
 
            self._lock_count -= 1
 
226
            return lock.cant_unlock_not_held(self)
 
227
        if self._lock_warner.lock_count > 1:
 
228
            self._lock_warner.lock_count -= 1
286
229
        else:
287
230
            #traceback.print_stack()
288
231
            self._finish_transaction()
289
232
            try:
290
233
                self._lock.unlock()
291
234
            finally:
292
 
                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
293
240
 
294
241
    def is_locked(self):
295
242
        """Return true if this LockableFiles group is locked"""
296
 
        return self._lock_count >= 1
 
243
        return self._lock_warner.lock_count >= 1
297
244
 
298
245
    def get_physical_lock_status(self):
299
246
        """Return physical lock status.
300
 
        
 
247
 
301
248
        Returns true if a lock is held on the transport. If no lock is held, or
302
249
        the underlying locking mechanism does not support querying lock
303
250
        status, false is returned.
385
332
    def validate_token(self, token):
386
333
        if token is not None:
387
334
            raise errors.TokenLockingNotSupported(self)
388
 
        
 
335