← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

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