← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

Latest bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2006 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
16
 
17
17
"""On-disk mutex protecting a resource
18
18
 
21
21
internal locks (such as flock etc) because they can be seen across all
22
22
transports, including http.
23
23
 
24
 
Objects can be read if there is only physical read access; therefore
 
24
Objects can be read if there is only physical read access; therefore 
25
25
readers can never be required to create a lock, though they will
26
26
check whether a writer is using the lock.  Writers can't detect
27
27
whether anyone else is reading from the resource as they write.
56
56
 
57
57
The desired characteristics are:
58
58
 
59
 
* Locks are not reentrant.  (That is, a client that tries to take a
 
59
* Locks are not reentrant.  (That is, a client that tries to take a 
60
60
  lock it already holds may deadlock or fail.)
61
61
* Stale locks can be guessed at by a heuristic
62
62
* Lost locks can be broken by any client
78
78
and deadlocks will likely occur if the locks are aliased.
79
79
 
80
80
In the future we may add a "freshen" method which can be called
81
 
by a lock holder to check that their lock has not been broken, and to
 
81
by a lock holder to check that their lock has not been broken, and to 
82
82
update the timestamp within it.
83
83
 
84
84
Example usage:
88
88
>>> t = MemoryTransport()
89
89
>>> l = LockDir(t, 'sample-lock')
90
90
>>> l.create()
91
 
>>> token = l.wait_lock()
 
91
>>> l.wait_lock()
92
92
>>> # do something here
93
93
>>> l.unlock()
94
94
 
95
95
"""
96
96
 
97
 
 
98
 
# TODO: We sometimes have the problem that our attempt to rename '1234' to
99
 
# 'held' fails because the transport server moves into an existing directory,
100
 
# rather than failing the rename.  If we made the info file name the same as
101
 
# the locked directory name we would avoid this problem because moving into
102
 
# the held directory would implicitly clash.  However this would not mesh with
103
 
# the existing locking code and needs a new format of the containing object.
104
 
# -- robertc, mbp 20070628
105
 
 
106
97
import os
107
98
import time
 
99
from warnings import warn
 
100
from StringIO import StringIO
108
101
 
109
 
from bzrlib import (
110
 
    debug,
111
 
    errors,
112
 
    lock,
113
 
    osutils,
114
 
    )
115
102
import bzrlib.config
116
 
from bzrlib.decorators import only_raises
117
103
from bzrlib.errors import (
118
104
        DirectoryNotEmpty,
119
105
        FileExists,
120
106
        LockBreakMismatch,
121
107
        LockBroken,
122
108
        LockContention,
123
 
        LockFailed,
 
109
        LockError,
124
110
        LockNotHeld,
125
111
        NoSuchFile,
126
 
        PathError,
127
 
        ResourceBusy,
128
 
        TransportError,
 
112
        UnlockableTransport,
129
113
        )
130
 
from bzrlib.trace import mutter, note
131
 
from bzrlib.osutils import format_delta, rand_chars, get_host_name
132
 
import bzrlib.ui
133
 
 
134
 
from bzrlib.lazy_import import lazy_import
135
 
lazy_import(globals(), """
136
 
from bzrlib import rio
137
 
""")
 
114
from bzrlib.transport import Transport
 
115
from bzrlib.osutils import rand_chars
 
116
from bzrlib.rio import RioWriter, read_stanza, Stanza
138
117
 
139
118
# XXX: At the moment there is no consideration of thread safety on LockDir
140
119
# objects.  This should perhaps be updated - e.g. if two threads try to take a
141
120
# lock at the same time they should *both* get it.  But then that's unlikely
142
121
# to be a good idea.
143
122
 
 
123
# TODO: Transport could offer a simpler put() method that avoids the
 
124
# rename-into-place for cases like creating the lock template, where there is
 
125
# no chance that the file already exists.
 
126
 
144
127
# TODO: Perhaps store some kind of note like the bzr command line in the lock
145
128
# info?
146
129
 
150
133
# TODO: Make sure to pass the right file and directory mode bits to all
151
134
# files/dirs created.
152
135
 
153
 
 
154
136
_DEFAULT_TIMEOUT_SECONDS = 300
155
 
_DEFAULT_POLL_SECONDS = 1.0
156
 
 
157
 
 
158
 
class LockDir(lock.Lock):
159
 
    """Write-lock guarding access to data.
160
 
    """
 
137
_DEFAULT_POLL_SECONDS = 0.5
 
138
 
 
139
class LockDir(object):
 
140
    """Write-lock guarding access to data."""
161
141
 
162
142
    __INFO_NAME = '/info'
163
143
 
168
148
 
169
149
        :param transport: Transport which will contain the lock
170
150
 
171
 
        :param path: Path to the lock within the base directory of the
 
151
        :param path: Path to the lock within the base directory of the 
172
152
            transport.
173
153
        """
 
154
        assert isinstance(transport, Transport), \
 
155
            ("not a transport: %r" % transport)
174
156
        self.transport = transport
175
157
        self.path = path
176
158
        self._lock_held = False
177
 
        self._locked_via_token = False
178
159
        self._fake_read_lock = False
179
160
        self._held_dir = path + '/held'
180
161
        self._held_info_path = self._held_dir + self.__INFO_NAME
181
162
        self._file_modebits = file_modebits
182
163
        self._dir_modebits = dir_modebits
183
 
 
184
 
        self._report_function = note
 
164
        self.nonce = rand_chars(20)
185
165
 
186
166
    def __repr__(self):
187
167
        return '%s(%s%s)' % (self.__class__.__name__,
190
170
 
191
171
    is_held = property(lambda self: self._lock_held)
192
172
 
193
 
    def create(self, mode=None):
 
173
    def create(self):
194
174
        """Create the on-disk lock.
195
175
 
196
 
        This is typically only called when the object/directory containing the
 
176
        This is typically only called when the object/directory containing the 
197
177
        directory is first created.  The lock is not held when it's created.
198
178
        """
199
 
        self._trace("create lock directory")
200
 
        try:
201
 
            self.transport.mkdir(self.path, mode=mode)
202
 
        except (TransportError, PathError), e:
203
 
            raise LockFailed(self, e)
204
 
 
205
 
 
206
 
    def _attempt_lock(self):
207
 
        """Make the pending directory and attempt to rename into place.
208
 
 
209
 
        If the rename succeeds, we read back the info file to check that we
210
 
        really got the lock.
211
 
 
212
 
        If we fail to acquire the lock, this method is responsible for
213
 
        cleaning up the pending directory if possible.  (But it doesn't do
214
 
        that yet.)
215
 
 
216
 
        :returns: The nonce of the lock, if it was successfully acquired.
217
 
 
218
 
        :raises LockContention: If the lock is held by someone else.  The exception
219
 
            contains the info of the current holder of the lock.
 
179
        if self.transport.is_readonly():
 
180
            raise UnlockableTransport(self.transport)
 
181
        self.transport.mkdir(self.path)
 
182
 
 
183
    def attempt_lock(self):
 
184
        """Take the lock; fail if it's already held.
 
185
        
 
186
        If you wish to block until the lock can be obtained, call wait_lock()
 
187
        instead.
220
188
        """
221
 
        self._trace("lock_write...")
222
 
        start_time = time.time()
223
 
        try:
224
 
            tmpname = self._create_pending_dir()
225
 
        except (errors.TransportError, PathError), e:
226
 
            self._trace("... failed to create pending dir, %s", e)
227
 
            raise LockFailed(self, e)
228
 
        try:
 
189
        if self._fake_read_lock:
 
190
            raise LockContention(self)
 
191
        if self.transport.is_readonly():
 
192
            raise UnlockableTransport(self.transport)
 
193
        try:
 
194
            tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
 
195
            self.transport.mkdir(tmpname)
 
196
            sio = StringIO()
 
197
            self._prepare_info(sio)
 
198
            sio.seek(0)
 
199
            self.transport.put(tmpname + self.__INFO_NAME, sio)
229
200
            self.transport.rename(tmpname, self._held_dir)
230
 
        except (errors.TransportError, PathError, DirectoryNotEmpty,
231
 
                FileExists, ResourceBusy), e:
232
 
            self._trace("... contention, %s", e)
233
 
            self._remove_pending_dir(tmpname)
234
 
            raise LockContention(self)
235
 
        except Exception, e:
236
 
            self._trace("... lock failed, %s", e)
237
 
            self._remove_pending_dir(tmpname)
238
 
            raise
239
 
        # We must check we really got the lock, because Launchpad's sftp
240
 
        # server at one time had a bug were the rename would successfully
241
 
        # move the new directory into the existing directory, which was
242
 
        # incorrect.  It's possible some other servers or filesystems will
243
 
        # have a similar bug allowing someone to think they got the lock
244
 
        # when it's already held.
245
 
        #
246
 
        # See <https://bugs.edge.launchpad.net/bzr/+bug/498378> for one case.
247
 
        #
248
 
        # Strictly the check is unnecessary and a waste of time for most
249
 
        # people, but probably worth trapping if something is wrong.
250
 
        info = self.peek()
251
 
        self._trace("after locking, info=%r", info)
252
 
        if info is None:
253
 
            raise LockFailed(self, "lock was renamed into place, but "
254
 
                "now is missing!")
255
 
        if info['nonce'] != self.nonce:
256
 
            self._trace("rename succeeded, "
257
 
                "but lock is still held by someone else")
258
 
            raise LockContention(self)
259
 
        self._lock_held = True
260
 
        self._trace("... lock succeeded after %dms",
261
 
                (time.time() - start_time) * 1000)
262
 
        return self.nonce
263
 
 
264
 
    def _remove_pending_dir(self, tmpname):
265
 
        """Remove the pending directory
266
 
 
267
 
        This is called if we failed to rename into place, so that the pending
268
 
        dirs don't clutter up the lockdir.
269
 
        """
270
 
        self._trace("remove %s", tmpname)
271
 
        try:
272
 
            self.transport.delete(tmpname + self.__INFO_NAME)
273
 
            self.transport.rmdir(tmpname)
274
 
        except PathError, e:
275
 
            note("error removing pending lock: %s", e)
276
 
 
277
 
    def _create_pending_dir(self):
278
 
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
279
 
        try:
280
 
            self.transport.mkdir(tmpname)
281
 
        except NoSuchFile:
282
 
            # This may raise a FileExists exception
283
 
            # which is okay, it will be caught later and determined
284
 
            # to be a LockContention.
285
 
            self._trace("lock directory does not exist, creating it")
286
 
            self.create(mode=self._dir_modebits)
287
 
            # After creating the lock directory, try again
288
 
            self.transport.mkdir(tmpname)
289
 
        self.nonce = rand_chars(20)
290
 
        info_bytes = self._prepare_info()
291
 
        # We use put_file_non_atomic because we just created a new unique
292
 
        # directory so we don't have to worry about files existing there.
293
 
        # We'll rename the whole directory into place to get atomic
294
 
        # properties
295
 
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
296
 
                                            info_bytes)
297
 
        return tmpname
298
 
 
299
 
    @only_raises(LockNotHeld, LockBroken)
 
201
            self._lock_held = True
 
202
            self.confirm()
 
203
            return
 
204
        except (DirectoryNotEmpty, FileExists), e:
 
205
            pass
 
206
        # fall through to here on contention
 
207
        raise LockContention(self)
 
208
 
300
209
    def unlock(self):
301
210
        """Release a held lock
302
211
        """
304
213
            self._fake_read_lock = False
305
214
            return
306
215
        if not self._lock_held:
307
 
            return lock.cant_unlock_not_held(self)
308
 
        if self._locked_via_token:
309
 
            self._locked_via_token = False
310
 
            self._lock_held = False
311
 
        else:
312
 
            old_nonce = self.nonce
313
 
            # rename before deleting, because we can't atomically remove the
314
 
            # whole tree
315
 
            start_time = time.time()
316
 
            self._trace("unlocking")
317
 
            tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
318
 
            # gotta own it to unlock
319
 
            self.confirm()
320
 
            self.transport.rename(self._held_dir, tmpname)
321
 
            self._lock_held = False
322
 
            self.transport.delete(tmpname + self.__INFO_NAME)
323
 
            try:
324
 
                self.transport.rmdir(tmpname)
325
 
            except DirectoryNotEmpty, e:
326
 
                # There might have been junk left over by a rename that moved
327
 
                # another locker within the 'held' directory.  do a slower
328
 
                # deletion where we list the directory and remove everything
329
 
                # within it.
330
 
                #
331
 
                # Maybe this should be broader to allow for ftp servers with
332
 
                # non-specific error messages?
333
 
                self._trace("doing recursive deletion of non-empty directory "
334
 
                        "%s", tmpname)
335
 
                self.transport.delete_tree(tmpname)
336
 
            self._trace("... unlock succeeded after %dms",
337
 
                    (time.time() - start_time) * 1000)
338
 
            result = lock.LockResult(self.transport.abspath(self.path),
339
 
                                     old_nonce)
340
 
            for hook in self.hooks['lock_released']:
341
 
                hook(result)
342
 
 
343
 
    def break_lock(self):
344
 
        """Break a lock not held by this instance of LockDir.
345
 
 
346
 
        This is a UI centric function: it uses the bzrlib.ui.ui_factory to
347
 
        prompt for input if a lock is detected and there is any doubt about
348
 
        it possibly being still active.
349
 
        """
350
 
        self._check_not_locked()
351
 
        holder_info = self.peek()
352
 
        if holder_info is not None:
353
 
            lock_info = '\n'.join(self._format_lock_info(holder_info))
354
 
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
355
 
                self.force_break(holder_info)
 
216
            raise LockNotHeld(self)
 
217
        # rename before deleting, because we can't atomically remove the whole
 
218
        # tree
 
219
        tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
 
220
        self.transport.rename(self._held_dir, tmpname)
 
221
        self._lock_held = False
 
222
        self.transport.delete(tmpname + self.__INFO_NAME)
 
223
        self.transport.rmdir(tmpname)
356
224
 
357
225
    def force_break(self, dead_holder_info):
358
226
        """Release a lock held by another process.
367
235
        LockBreakMismatch is raised.
368
236
 
369
237
        After the lock is broken it will not be held by any process.
370
 
        It is possible that another process may sneak in and take the
 
238
        It is possible that another process may sneak in and take the 
371
239
        lock before the breaking process acquires it.
372
240
        """
373
241
        if not isinstance(dead_holder_info, dict):
374
242
            raise ValueError("dead_holder_info: %r" % dead_holder_info)
375
 
        self._check_not_locked()
 
243
        if self._lock_held:
 
244
            raise AssertionError("can't break own lock: %r" % self)
376
245
        current_info = self.peek()
377
246
        if current_info is None:
378
247
            # must have been recently released
382
251
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
383
252
        self.transport.rename(self._held_dir, tmpname)
384
253
        # check that we actually broke the right lock, not someone else;
385
 
        # there's a small race window between checking it and doing the
 
254
        # there's a small race window between checking it and doing the 
386
255
        # rename.
387
256
        broken_info_path = tmpname + self.__INFO_NAME
388
257
        broken_info = self._read_info_file(broken_info_path)
390
259
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
391
260
        self.transport.delete(broken_info_path)
392
261
        self.transport.rmdir(tmpname)
393
 
        result = lock.LockResult(self.transport.abspath(self.path),
394
 
                                 current_info.get('nonce'))
395
 
        for hook in self.hooks['lock_broken']:
396
 
            hook(result)
397
 
 
398
 
    def _check_not_locked(self):
399
 
        """If the lock is held by this instance, raise an error."""
400
 
        if self._lock_held:
401
 
            raise AssertionError("can't break own lock: %r" % self)
402
262
 
403
263
    def confirm(self):
404
264
        """Make sure that the lock is still held by this locker.
407
267
        or if the lock has been affected by a bug.
408
268
 
409
269
        If the lock is not thought to be held, raises LockNotHeld.  If
410
 
        the lock is thought to be held but has been broken, raises
 
270
        the lock is thought to be held but has been broken, raises 
411
271
        LockBroken.
412
272
        """
413
273
        if not self._lock_held:
419
279
        if info.get('nonce') != self.nonce:
420
280
            # there is a lock, but not ours
421
281
            raise LockBroken(self)
422
 
 
 
282
        
423
283
    def _read_info_file(self, path):
424
284
        """Read one given info file.
425
285
 
426
286
        peek() reads the info file of the lock holder, if any.
427
287
        """
428
 
        return self._parse_info(self.transport.get_bytes(path))
 
288
        return self._parse_info(self.transport.get(path))
429
289
 
430
290
    def peek(self):
431
291
        """Check if the lock is held by anyone.
432
 
 
 
292
        
433
293
        If it is held, this returns the lock info structure as a rio Stanza,
434
294
        which contains some information about the current lock holder.
435
295
        Otherwise returns None.
436
296
        """
437
297
        try:
438
298
            info = self._read_info_file(self._held_info_path)
439
 
            self._trace("peek -> held")
 
299
            assert isinstance(info, dict), \
 
300
                    "bad parse result %r" % info
440
301
            return info
441
302
        except NoSuchFile, e:
442
 
            self._trace("peek -> not held")
 
303
            return None
443
304
 
444
 
    def _prepare_info(self):
 
305
    def _prepare_info(self, outf):
445
306
        """Write information about a pending lock to a temporary file.
446
307
        """
 
308
        import socket
447
309
        # XXX: is creating this here inefficient?
448
310
        config = bzrlib.config.GlobalConfig()
449
 
        try:
450
 
            user = config.user_email()
451
 
        except errors.NoEmailInUsername:
452
 
            user = config.username()
453
 
        s = rio.Stanza(hostname=get_host_name(),
 
311
        s = Stanza(hostname=socket.gethostname(),
454
312
                   pid=str(os.getpid()),
455
313
                   start_time=str(int(time.time())),
456
314
                   nonce=self.nonce,
457
 
                   user=user,
 
315
                   user=config.user_email(),
458
316
                   )
459
 
        return s.to_string()
460
 
 
461
 
    def _parse_info(self, info_bytes):
462
 
        # TODO: Handle if info_bytes is empty
463
 
        return rio.read_stanza(osutils.split_lines(info_bytes)).as_dict()
464
 
 
465
 
    def attempt_lock(self):
466
 
        """Take the lock; fail if it's already held.
467
 
 
468
 
        If you wish to block until the lock can be obtained, call wait_lock()
469
 
        instead.
470
 
 
471
 
        :return: The lock token.
472
 
        :raises LockContention: if the lock is held by someone else.
473
 
        """
474
 
        if self._fake_read_lock:
475
 
            raise LockContention(self)
476
 
        result = self._attempt_lock()
477
 
        hook_result = lock.LockResult(self.transport.abspath(self.path),
478
 
                self.nonce)
479
 
        for hook in self.hooks['lock_acquired']:
480
 
            hook(hook_result)
481
 
        return result
482
 
 
483
 
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
 
317
        RioWriter(outf).write_stanza(s)
 
318
 
 
319
    def _parse_info(self, info_file):
 
320
        return read_stanza(info_file.readlines()).as_dict()
 
321
 
 
322
    def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
 
323
                  poll=_DEFAULT_POLL_SECONDS):
484
324
        """Wait a certain period for a lock.
485
325
 
486
326
        If the lock can be acquired within the bounded time, it
488
328
        is raised.  Either way, this function should return within
489
329
        approximately `timeout` seconds.  (It may be a bit more if
490
330
        a transport operation takes a long time to complete.)
491
 
 
492
 
        :param timeout: Approximate maximum amount of time to wait for the
493
 
        lock, in seconds.
494
 
 
495
 
        :param poll: Delay in seconds between retrying the lock.
496
 
 
497
 
        :param max_attempts: Maximum number of times to try to lock.
498
 
 
499
 
        :return: The lock token.
500
331
        """
501
 
        if timeout is None:
502
 
            timeout = _DEFAULT_TIMEOUT_SECONDS
503
 
        if poll is None:
504
 
            poll = _DEFAULT_POLL_SECONDS
505
 
        # XXX: the transport interface doesn't let us guard against operations
506
 
        # there taking a long time, so the total elapsed time or poll interval
507
 
        # may be more than was requested.
 
332
        # XXX: the transport interface doesn't let us guard 
 
333
        # against operations there taking a long time.
508
334
        deadline = time.time() + timeout
509
 
        deadline_str = None
510
 
        last_info = None
511
 
        attempt_count = 0
512
335
        while True:
513
 
            attempt_count += 1
514
336
            try:
515
 
                return self.attempt_lock()
 
337
                self.attempt_lock()
 
338
                return
516
339
            except LockContention:
517
 
                # possibly report the blockage, then try again
518
340
                pass
519
 
            # TODO: In a few cases, we find out that there's contention by
520
 
            # reading the held info and observing that it's not ours.  In
521
 
            # those cases it's a bit redundant to read it again.  However,
522
 
            # the normal case (??) is that the rename fails and so we
523
 
            # don't know who holds the lock.  For simplicity we peek
524
 
            # always.
525
 
            new_info = self.peek()
526
 
            if new_info is not None and new_info != last_info:
527
 
                if last_info is None:
528
 
                    start = 'Unable to obtain'
529
 
                else:
530
 
                    start = 'Lock owner changed for'
531
 
                last_info = new_info
532
 
                formatted_info = self._format_lock_info(new_info)
533
 
                if deadline_str is None:
534
 
                    deadline_str = time.strftime('%H:%M:%S',
535
 
                                                 time.localtime(deadline))
536
 
                lock_url = self.transport.abspath(self.path)
537
 
                # See <https://bugs.edge.launchpad.net/bzr/+bug/250451>
538
 
                # the URL here is sometimes not one that is useful to the
539
 
                # user, perhaps being wrapped in a lp-%d or chroot decorator,
540
 
                # especially if this error is issued from the server.
541
 
                self._report_function('%s %s\n'
542
 
                    '%s\n' # held by
543
 
                    '%s\n' # locked ... ago
544
 
                    'Will continue to try until %s, unless '
545
 
                    'you press Ctrl-C.\n'
546
 
                    'See "bzr help break-lock" for more.',
547
 
                    start,
548
 
                    formatted_info[0],
549
 
                    formatted_info[1],
550
 
                    formatted_info[2],
551
 
                    deadline_str,
552
 
                    )
553
 
 
554
 
            if (max_attempts is not None) and (attempt_count >= max_attempts):
555
 
                self._trace("exceeded %d attempts")
556
 
                raise LockContention(self)
557
341
            if time.time() + poll < deadline:
558
 
                self._trace("waiting %ss", poll)
559
342
                time.sleep(poll)
560
343
            else:
561
 
                self._trace("timeout after waiting %ss", timeout)
562
344
                raise LockContention(self)
563
345
 
564
 
    def leave_in_place(self):
565
 
        self._locked_via_token = True
566
 
 
567
 
    def dont_leave_in_place(self):
568
 
        self._locked_via_token = False
569
 
 
570
 
    def lock_write(self, token=None):
571
 
        """Wait for and acquire the lock.
572
 
 
573
 
        :param token: if this is already locked, then lock_write will fail
574
 
            unless the token matches the existing lock.
575
 
        :returns: a token if this instance supports tokens, otherwise None.
576
 
        :raises TokenLockingNotSupported: when a token is given but this
577
 
            instance doesn't support using token locks.
578
 
        :raises MismatchedToken: if the specified token doesn't match the token
579
 
            of the existing lock.
580
 
 
581
 
        A token should be passed in if you know that you have locked the object
582
 
        some other way, and need to synchronise this object's state with that
583
 
        fact.
584
 
 
585
 
        XXX: docstring duplicated from LockableFiles.lock_write.
586
 
        """
587
 
        if token is not None:
588
 
            self.validate_token(token)
589
 
            self.nonce = token
590
 
            self._lock_held = True
591
 
            self._locked_via_token = True
592
 
            return token
593
 
        else:
594
 
            return self.wait_lock()
 
346
    def lock_write(self):
 
347
        """Wait for and acquire the lock."""
 
348
        self.attempt_lock()
595
349
 
596
350
    def lock_read(self):
597
 
        """Compatibility-mode shared lock.
 
351
        """Compatability-mode shared lock.
598
352
 
599
 
        LockDir doesn't support shared read-only locks, so this
 
353
        LockDir doesn't support shared read-only locks, so this 
600
354
        just pretends that the lock is taken but really does nothing.
601
355
        """
602
 
        # At the moment Branches are commonly locked for read, but
 
356
        # At the moment Branches are commonly locked for read, but 
603
357
        # we can't rely on that remotely.  Once this is cleaned up,
604
 
        # reenable this warning to prevent it coming back in
 
358
        # reenable this warning to prevent it coming back in 
605
359
        # -- mbp 20060303
606
360
        ## warn("LockDir.lock_read falls back to write lock")
607
361
        if self._lock_held or self._fake_read_lock:
608
362
            raise LockContention(self)
609
363
        self._fake_read_lock = True
610
364
 
611
 
    def _format_lock_info(self, info):
612
 
        """Turn the contents of peek() into something for the user"""
613
 
        lock_url = self.transport.abspath(self.path)
614
 
        delta = time.time() - int(info['start_time'])
615
 
        return [
616
 
            'lock %s' % (lock_url,),
617
 
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
618
 
            'locked %s' % (format_delta(delta),),
619
 
            ]
620
 
 
621
 
    def validate_token(self, token):
622
 
        if token is not None:
623
 
            info = self.peek()
624
 
            if info is None:
625
 
                # Lock isn't held
626
 
                lock_token = None
627
 
            else:
628
 
                lock_token = info.get('nonce')
629
 
            if token != lock_token:
630
 
                raise errors.TokenMismatch(token, lock_token)
631
 
            else:
632
 
                self._trace("revalidated by token %r", token)
633
 
 
634
 
    def _trace(self, format, *args):
635
 
        if 'lock' not in debug.debug_flags:
636
 
            return
637
 
        mutter(str(self) + ": " + (format % args))
 
365
    def wait(self, timeout=20, poll=0.5):
 
366
        """Wait a certain period for a lock to be released."""
 
367
        # XXX: the transport interface doesn't let us guard 
 
368
        # against operations there taking a long time.
 
369
        deadline = time.time() + timeout
 
370
        while True:
 
371
            if self.peek():
 
372
                return
 
373
            if time.time() + poll < deadline:
 
374
                time.sleep(poll)
 
375
            else:
 
376
                raise LockContention(self)
 
377