~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Aaron Bentley
  • Date: 2008-10-16 21:27:10 UTC
  • mfrom: (0.15.26 unshelve)
  • mto: (0.16.74 shelf-ui)
  • mto: This revision was merged to the branch mainline in revision 3820.
  • Revision ID: aaron@aaronbentley.com-20081016212710-h9av3nhk76dvmsv5
Merge with unshelve

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
"""On-disk mutex protecting a resource
 
18
 
 
19
bzr on-disk objects are locked by the existence of a directory with a
 
20
particular name within the control directory.  We use this rather than OS
 
21
internal locks (such as flock etc) because they can be seen across all
 
22
transports, including http.
 
23
 
 
24
Objects can be read if there is only physical read access; therefore 
 
25
readers can never be required to create a lock, though they will
 
26
check whether a writer is using the lock.  Writers can't detect
 
27
whether anyone else is reading from the resource as they write.
 
28
This works because of ordering constraints that make sure readers
 
29
see a consistent view of existing data.
 
30
 
 
31
Waiting for a lock must be done by polling; this can be aborted after
 
32
a timeout.
 
33
 
 
34
Locks must always be explicitly released, typically from a try/finally
 
35
block -- they are not released from a finalizer or when Python
 
36
exits.
 
37
 
 
38
Locks may fail to be released if the process is abruptly terminated
 
39
(machine stop, SIGKILL) or if a remote transport becomes permanently
 
40
disconnected.  There is therefore a method to break an existing lock.
 
41
This should rarely be used, and generally only with user approval.
 
42
Locks contain some information on when the lock was taken and by who
 
43
which may guide in deciding whether it can safely be broken.  (This is
 
44
similar to the messages displayed by emacs and vim.) Note that if the
 
45
lock holder is still alive they will get no notification that the lock
 
46
has been broken and will continue their work -- so it is important to be
 
47
sure they are actually dead.
 
48
 
 
49
A lock is represented on disk by a directory of a particular name,
 
50
containing an information file.  Taking a lock is done by renaming a
 
51
temporary directory into place.  We use temporary directories because
 
52
for all known transports and filesystems we believe that exactly one
 
53
attempt to claim the lock will succeed and the others will fail.  (Files
 
54
won't do because some filesystems or transports only have
 
55
rename-and-overwrite, making it hard to tell who won.)
 
56
 
 
57
The desired characteristics are:
 
58
 
 
59
* Locks are not reentrant.  (That is, a client that tries to take a 
 
60
  lock it already holds may deadlock or fail.)
 
61
* Stale locks can be guessed at by a heuristic
 
62
* Lost locks can be broken by any client
 
63
* Failed lock operations leave little or no mess
 
64
* Deadlocks are avoided by having a timeout always in use, clients
 
65
  desiring indefinite waits can retry or set a silly big timeout.
 
66
 
 
67
Storage formats use the locks, and also need to consider concurrency
 
68
issues underneath the lock.  A format may choose not to use a lock
 
69
at all for some operations.
 
70
 
 
71
LockDirs always operate over a Transport.  The transport may be readonly, in
 
72
which case the lock can be queried but not acquired.
 
73
 
 
74
Locks are identified by a path name, relative to a base transport.
 
75
 
 
76
Calling code will typically want to make sure there is exactly one LockDir
 
77
object per actual lock on disk.  This module does nothing to prevent aliasing
 
78
and deadlocks will likely occur if the locks are aliased.
 
79
 
 
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 
 
82
update the timestamp within it.
 
83
 
 
84
Example usage:
 
85
 
 
86
>>> from bzrlib.transport.memory import MemoryTransport
 
87
>>> # typically will be obtained from a BzrDir, Branch, etc
 
88
>>> t = MemoryTransport()
 
89
>>> l = LockDir(t, 'sample-lock')
 
90
>>> l.create()
 
91
>>> token = l.wait_lock()
 
92
>>> # do something here
 
93
>>> l.unlock()
 
94
 
 
95
"""
 
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
import os
 
107
import time
 
108
 
 
109
from bzrlib import (
 
110
    debug,
 
111
    errors,
 
112
    lock,
 
113
    )
 
114
import bzrlib.config
 
115
from bzrlib.errors import (
 
116
        DirectoryNotEmpty,
 
117
        FileExists,
 
118
        LockBreakMismatch,
 
119
        LockBroken,
 
120
        LockContention,
 
121
        LockFailed,
 
122
        LockNotHeld,
 
123
        NoSuchFile,
 
124
        PathError,
 
125
        ResourceBusy,
 
126
        TransportError,
 
127
        )
 
128
from bzrlib.hooks import Hooks
 
129
from bzrlib.trace import mutter, note
 
130
from bzrlib.osutils import format_delta, rand_chars, get_host_name
 
131
import bzrlib.ui
 
132
 
 
133
from bzrlib.lazy_import import lazy_import
 
134
lazy_import(globals(), """
 
135
from bzrlib import rio
 
136
""")
 
137
 
 
138
# XXX: At the moment there is no consideration of thread safety on LockDir
 
139
# objects.  This should perhaps be updated - e.g. if two threads try to take a
 
140
# lock at the same time they should *both* get it.  But then that's unlikely
 
141
# to be a good idea.
 
142
 
 
143
# TODO: Perhaps store some kind of note like the bzr command line in the lock
 
144
# info?
 
145
 
 
146
# TODO: Some kind of callback run while polling a lock to show progress
 
147
# indicators.
 
148
 
 
149
# TODO: Make sure to pass the right file and directory mode bits to all
 
150
# files/dirs created.
 
151
 
 
152
 
 
153
_DEFAULT_TIMEOUT_SECONDS = 300
 
154
_DEFAULT_POLL_SECONDS = 1.0
 
155
 
 
156
 
 
157
class LockDir(lock.Lock):
 
158
    """Write-lock guarding access to data.
 
159
    """
 
160
 
 
161
    __INFO_NAME = '/info'
 
162
 
 
163
    def __init__(self, transport, path, file_modebits=0644, dir_modebits=0755):
 
164
        """Create a new LockDir object.
 
165
 
 
166
        The LockDir is initially unlocked - this just creates the object.
 
167
 
 
168
        :param transport: Transport which will contain the lock
 
169
 
 
170
        :param path: Path to the lock within the base directory of the 
 
171
            transport.
 
172
        """
 
173
        self.transport = transport
 
174
        self.path = path
 
175
        self._lock_held = False
 
176
        self._locked_via_token = False
 
177
        self._fake_read_lock = False
 
178
        self._held_dir = path + '/held'
 
179
        self._held_info_path = self._held_dir + self.__INFO_NAME
 
180
        self._file_modebits = file_modebits
 
181
        self._dir_modebits = dir_modebits
 
182
 
 
183
        self._report_function = note
 
184
 
 
185
    def __repr__(self):
 
186
        return '%s(%s%s)' % (self.__class__.__name__,
 
187
                             self.transport.base,
 
188
                             self.path)
 
189
 
 
190
    is_held = property(lambda self: self._lock_held)
 
191
 
 
192
    def create(self, mode=None):
 
193
        """Create the on-disk lock.
 
194
 
 
195
        This is typically only called when the object/directory containing the 
 
196
        directory is first created.  The lock is not held when it's created.
 
197
        """
 
198
        self._trace("create lock directory")
 
199
        try:
 
200
            self.transport.mkdir(self.path, mode=mode)
 
201
        except (TransportError, PathError), e:
 
202
            raise LockFailed(self, e)
 
203
 
 
204
 
 
205
    def _attempt_lock(self):
 
206
        """Make the pending directory and attempt to rename into place.
 
207
        
 
208
        If the rename succeeds, we read back the info file to check that we
 
209
        really got the lock.
 
210
 
 
211
        If we fail to acquire the lock, this method is responsible for
 
212
        cleaning up the pending directory if possible.  (But it doesn't do
 
213
        that yet.)
 
214
 
 
215
        :returns: The nonce of the lock, if it was successfully acquired.
 
216
 
 
217
        :raises LockContention: If the lock is held by someone else.  The exception
 
218
            contains the info of the current holder of the lock.
 
219
        """
 
220
        self._trace("lock_write...")
 
221
        start_time = time.time()
 
222
        try:
 
223
            tmpname = self._create_pending_dir()
 
224
        except (errors.TransportError, PathError), e:
 
225
            self._trace("... failed to create pending dir, %s", e)
 
226
            raise LockFailed(self, e)
 
227
        try:
 
228
            self.transport.rename(tmpname, self._held_dir)
 
229
        except (errors.TransportError, PathError, DirectoryNotEmpty,
 
230
                FileExists, ResourceBusy), e:
 
231
            self._trace("... contention, %s", e)
 
232
            self._remove_pending_dir(tmpname)
 
233
            raise LockContention(self)
 
234
        except Exception, e:
 
235
            self._trace("... lock failed, %s", e)
 
236
            self._remove_pending_dir(tmpname)
 
237
            raise
 
238
        # We must check we really got the lock, because Launchpad's sftp
 
239
        # server at one time had a bug were the rename would successfully
 
240
        # move the new directory into the existing directory, which was
 
241
        # incorrect.  It's possible some other servers or filesystems will
 
242
        # have a similar bug allowing someone to think they got the lock
 
243
        # when it's already held.
 
244
        info = self.peek()
 
245
        self._trace("after locking, info=%r", info)
 
246
        if info['nonce'] != self.nonce:
 
247
            self._trace("rename succeeded, "
 
248
                "but lock is still held by someone else")
 
249
            raise LockContention(self)
 
250
        self._lock_held = True
 
251
        self._trace("... lock succeeded after %dms",
 
252
                (time.time() - start_time) * 1000)
 
253
        return self.nonce
 
254
 
 
255
    def _remove_pending_dir(self, tmpname):
 
256
        """Remove the pending directory
 
257
 
 
258
        This is called if we failed to rename into place, so that the pending 
 
259
        dirs don't clutter up the lockdir.
 
260
        """
 
261
        self._trace("remove %s", tmpname)
 
262
        try:
 
263
            self.transport.delete(tmpname + self.__INFO_NAME)
 
264
            self.transport.rmdir(tmpname)
 
265
        except PathError, e:
 
266
            note("error removing pending lock: %s", e)
 
267
 
 
268
    def _create_pending_dir(self):
 
269
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
 
270
        try:
 
271
            self.transport.mkdir(tmpname)
 
272
        except NoSuchFile:
 
273
            # This may raise a FileExists exception
 
274
            # which is okay, it will be caught later and determined
 
275
            # to be a LockContention.
 
276
            self._trace("lock directory does not exist, creating it")
 
277
            self.create(mode=self._dir_modebits)
 
278
            # After creating the lock directory, try again
 
279
            self.transport.mkdir(tmpname)
 
280
        self.nonce = rand_chars(20)
 
281
        info_bytes = self._prepare_info()
 
282
        # We use put_file_non_atomic because we just created a new unique
 
283
        # directory so we don't have to worry about files existing there.
 
284
        # We'll rename the whole directory into place to get atomic
 
285
        # properties
 
286
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
 
287
                                            info_bytes)
 
288
        return tmpname
 
289
 
 
290
    def unlock(self):
 
291
        """Release a held lock
 
292
        """
 
293
        if self._fake_read_lock:
 
294
            self._fake_read_lock = False
 
295
            return
 
296
        if not self._lock_held:
 
297
            raise LockNotHeld(self)
 
298
        if self._locked_via_token:
 
299
            self._locked_via_token = False
 
300
            self._lock_held = False
 
301
        else:
 
302
            old_nonce = self.nonce
 
303
            # rename before deleting, because we can't atomically remove the
 
304
            # whole tree
 
305
            start_time = time.time()
 
306
            self._trace("unlocking")
 
307
            tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
 
308
            # gotta own it to unlock
 
309
            self.confirm()
 
310
            self.transport.rename(self._held_dir, tmpname)
 
311
            self._lock_held = False
 
312
            self.transport.delete(tmpname + self.__INFO_NAME)
 
313
            try:
 
314
                self.transport.rmdir(tmpname)
 
315
            except DirectoryNotEmpty, e:
 
316
                # There might have been junk left over by a rename that moved
 
317
                # another locker within the 'held' directory.  do a slower
 
318
                # deletion where we list the directory and remove everything
 
319
                # within it.
 
320
                #
 
321
                # Maybe this should be broader to allow for ftp servers with
 
322
                # non-specific error messages?
 
323
                self._trace("doing recursive deletion of non-empty directory "
 
324
                        "%s", tmpname)
 
325
                self.transport.delete_tree(tmpname)
 
326
            self._trace("... unlock succeeded after %dms",
 
327
                    (time.time() - start_time) * 1000)
 
328
            result = lock.LockResult(self.transport.abspath(self.path),
 
329
                old_nonce)
 
330
            for hook in self.hooks['lock_released']:
 
331
                hook(result)
 
332
 
 
333
    def break_lock(self):
 
334
        """Break a lock not held by this instance of LockDir.
 
335
 
 
336
        This is a UI centric function: it uses the bzrlib.ui.ui_factory to
 
337
        prompt for input if a lock is detected and there is any doubt about
 
338
        it possibly being still active.
 
339
        """
 
340
        self._check_not_locked()
 
341
        holder_info = self.peek()
 
342
        if holder_info is not None:
 
343
            lock_info = '\n'.join(self._format_lock_info(holder_info))
 
344
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
 
345
                self.force_break(holder_info)
 
346
        
 
347
    def force_break(self, dead_holder_info):
 
348
        """Release a lock held by another process.
 
349
 
 
350
        WARNING: This should only be used when the other process is dead; if
 
351
        it still thinks it has the lock there will be two concurrent writers.
 
352
        In general the user's approval should be sought for lock breaks.
 
353
 
 
354
        dead_holder_info must be the result of a previous LockDir.peek() call;
 
355
        this is used to check that it's still held by the same process that
 
356
        the user decided was dead.  If this is not the current holder,
 
357
        LockBreakMismatch is raised.
 
358
 
 
359
        After the lock is broken it will not be held by any process.
 
360
        It is possible that another process may sneak in and take the 
 
361
        lock before the breaking process acquires it.
 
362
        """
 
363
        if not isinstance(dead_holder_info, dict):
 
364
            raise ValueError("dead_holder_info: %r" % dead_holder_info)
 
365
        self._check_not_locked()
 
366
        current_info = self.peek()
 
367
        if current_info is None:
 
368
            # must have been recently released
 
369
            return
 
370
        if current_info != dead_holder_info:
 
371
            raise LockBreakMismatch(self, current_info, dead_holder_info)
 
372
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
 
373
        self.transport.rename(self._held_dir, tmpname)
 
374
        # check that we actually broke the right lock, not someone else;
 
375
        # there's a small race window between checking it and doing the 
 
376
        # rename.
 
377
        broken_info_path = tmpname + self.__INFO_NAME
 
378
        broken_info = self._read_info_file(broken_info_path)
 
379
        if broken_info != dead_holder_info:
 
380
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
 
381
        self.transport.delete(broken_info_path)
 
382
        self.transport.rmdir(tmpname)
 
383
 
 
384
    def _check_not_locked(self):
 
385
        """If the lock is held by this instance, raise an error."""
 
386
        if self._lock_held:
 
387
            raise AssertionError("can't break own lock: %r" % self)
 
388
 
 
389
    def confirm(self):
 
390
        """Make sure that the lock is still held by this locker.
 
391
 
 
392
        This should only fail if the lock was broken by user intervention,
 
393
        or if the lock has been affected by a bug.
 
394
 
 
395
        If the lock is not thought to be held, raises LockNotHeld.  If
 
396
        the lock is thought to be held but has been broken, raises 
 
397
        LockBroken.
 
398
        """
 
399
        if not self._lock_held:
 
400
            raise LockNotHeld(self)
 
401
        info = self.peek()
 
402
        if info is None:
 
403
            # no lock there anymore!
 
404
            raise LockBroken(self)
 
405
        if info.get('nonce') != self.nonce:
 
406
            # there is a lock, but not ours
 
407
            raise LockBroken(self)
 
408
        
 
409
    def _read_info_file(self, path):
 
410
        """Read one given info file.
 
411
 
 
412
        peek() reads the info file of the lock holder, if any.
 
413
        """
 
414
        return self._parse_info(self.transport.get(path))
 
415
 
 
416
    def peek(self):
 
417
        """Check if the lock is held by anyone.
 
418
        
 
419
        If it is held, this returns the lock info structure as a rio Stanza,
 
420
        which contains some information about the current lock holder.
 
421
        Otherwise returns None.
 
422
        """
 
423
        try:
 
424
            info = self._read_info_file(self._held_info_path)
 
425
            self._trace("peek -> held")
 
426
            return info
 
427
        except NoSuchFile, e:
 
428
            self._trace("peek -> not held")
 
429
 
 
430
    def _prepare_info(self):
 
431
        """Write information about a pending lock to a temporary file.
 
432
        """
 
433
        # XXX: is creating this here inefficient?
 
434
        config = bzrlib.config.GlobalConfig()
 
435
        try:
 
436
            user = config.user_email()
 
437
        except errors.NoEmailInUsername:
 
438
            user = config.username()
 
439
        s = rio.Stanza(hostname=get_host_name(),
 
440
                   pid=str(os.getpid()),
 
441
                   start_time=str(int(time.time())),
 
442
                   nonce=self.nonce,
 
443
                   user=user,
 
444
                   )
 
445
        return s.to_string()
 
446
 
 
447
    def _parse_info(self, info_file):
 
448
        return rio.read_stanza(info_file.readlines()).as_dict()
 
449
 
 
450
    def attempt_lock(self):
 
451
        """Take the lock; fail if it's already held.
 
452
        
 
453
        If you wish to block until the lock can be obtained, call wait_lock()
 
454
        instead.
 
455
 
 
456
        :return: The lock token.
 
457
        :raises LockContention: if the lock is held by someone else.
 
458
        """
 
459
        if self._fake_read_lock:
 
460
            raise LockContention(self)
 
461
        result = self._attempt_lock()
 
462
        hook_result = lock.LockResult(self.transport.abspath(self.path),
 
463
                self.nonce)
 
464
        for hook in self.hooks['lock_acquired']:
 
465
            hook(hook_result)
 
466
        return result
 
467
 
 
468
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
 
469
        """Wait a certain period for a lock.
 
470
 
 
471
        If the lock can be acquired within the bounded time, it
 
472
        is taken and this returns.  Otherwise, LockContention
 
473
        is raised.  Either way, this function should return within
 
474
        approximately `timeout` seconds.  (It may be a bit more if
 
475
        a transport operation takes a long time to complete.)
 
476
 
 
477
        :param timeout: Approximate maximum amount of time to wait for the
 
478
        lock, in seconds.
 
479
         
 
480
        :param poll: Delay in seconds between retrying the lock.
 
481
 
 
482
        :param max_attempts: Maximum number of times to try to lock.
 
483
 
 
484
        :return: The lock token.
 
485
        """
 
486
        if timeout is None:
 
487
            timeout = _DEFAULT_TIMEOUT_SECONDS
 
488
        if poll is None:
 
489
            poll = _DEFAULT_POLL_SECONDS
 
490
        # XXX: the transport interface doesn't let us guard against operations
 
491
        # there taking a long time, so the total elapsed time or poll interval
 
492
        # may be more than was requested.
 
493
        deadline = time.time() + timeout
 
494
        deadline_str = None
 
495
        last_info = None
 
496
        attempt_count = 0
 
497
        while True:
 
498
            attempt_count += 1
 
499
            try:
 
500
                return self.attempt_lock()
 
501
            except LockContention:
 
502
                # possibly report the blockage, then try again
 
503
                pass
 
504
            # TODO: In a few cases, we find out that there's contention by
 
505
            # reading the held info and observing that it's not ours.  In
 
506
            # those cases it's a bit redundant to read it again.  However,
 
507
            # the normal case (??) is that the rename fails and so we
 
508
            # don't know who holds the lock.  For simplicity we peek
 
509
            # always.
 
510
            new_info = self.peek()
 
511
            if new_info is not None and new_info != last_info:
 
512
                if last_info is None:
 
513
                    start = 'Unable to obtain'
 
514
                else:
 
515
                    start = 'Lock owner changed for'
 
516
                last_info = new_info
 
517
                formatted_info = self._format_lock_info(new_info)
 
518
                if deadline_str is None:
 
519
                    deadline_str = time.strftime('%H:%M:%S',
 
520
                                                 time.localtime(deadline))
 
521
                lock_url = self.transport.abspath(self.path)
 
522
                self._report_function('%s %s\n'
 
523
                                      '%s\n' # held by
 
524
                                      '%s\n' # locked ... ago
 
525
                                      'Will continue to try until %s, unless '
 
526
                                      'you press Ctrl-C\n'
 
527
                                      'If you\'re sure that it\'s not being '
 
528
                                      'modified, use bzr break-lock %s',
 
529
                                      start,
 
530
                                      formatted_info[0],
 
531
                                      formatted_info[1],
 
532
                                      formatted_info[2],
 
533
                                      deadline_str,
 
534
                                      lock_url)
 
535
 
 
536
            if (max_attempts is not None) and (attempt_count >= max_attempts):
 
537
                self._trace("exceeded %d attempts")
 
538
                raise LockContention(self)
 
539
            if time.time() + poll < deadline:
 
540
                self._trace("waiting %ss", poll)
 
541
                time.sleep(poll)
 
542
            else:
 
543
                self._trace("timeout after waiting %ss", timeout)
 
544
                raise LockContention(self)
 
545
    
 
546
    def leave_in_place(self):
 
547
        self._locked_via_token = True
 
548
 
 
549
    def dont_leave_in_place(self):
 
550
        self._locked_via_token = False
 
551
 
 
552
    def lock_write(self, token=None):
 
553
        """Wait for and acquire the lock.
 
554
        
 
555
        :param token: if this is already locked, then lock_write will fail
 
556
            unless the token matches the existing lock.
 
557
        :returns: a token if this instance supports tokens, otherwise None.
 
558
        :raises TokenLockingNotSupported: when a token is given but this
 
559
            instance doesn't support using token locks.
 
560
        :raises MismatchedToken: if the specified token doesn't match the token
 
561
            of the existing lock.
 
562
 
 
563
        A token should be passed in if you know that you have locked the object
 
564
        some other way, and need to synchronise this object's state with that
 
565
        fact.
 
566
         
 
567
        XXX: docstring duplicated from LockableFiles.lock_write.
 
568
        """
 
569
        if token is not None:
 
570
            self.validate_token(token)
 
571
            self.nonce = token
 
572
            self._lock_held = True
 
573
            self._locked_via_token = True
 
574
            return token
 
575
        else:
 
576
            return self.wait_lock()
 
577
 
 
578
    def lock_read(self):
 
579
        """Compatibility-mode shared lock.
 
580
 
 
581
        LockDir doesn't support shared read-only locks, so this 
 
582
        just pretends that the lock is taken but really does nothing.
 
583
        """
 
584
        # At the moment Branches are commonly locked for read, but 
 
585
        # we can't rely on that remotely.  Once this is cleaned up,
 
586
        # reenable this warning to prevent it coming back in 
 
587
        # -- mbp 20060303
 
588
        ## warn("LockDir.lock_read falls back to write lock")
 
589
        if self._lock_held or self._fake_read_lock:
 
590
            raise LockContention(self)
 
591
        self._fake_read_lock = True
 
592
 
 
593
    def _format_lock_info(self, info):
 
594
        """Turn the contents of peek() into something for the user"""
 
595
        lock_url = self.transport.abspath(self.path)
 
596
        delta = time.time() - int(info['start_time'])
 
597
        return [
 
598
            'lock %s' % (lock_url,),
 
599
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
 
600
            'locked %s' % (format_delta(delta),),
 
601
            ]
 
602
 
 
603
    def validate_token(self, token):
 
604
        if token is not None:
 
605
            info = self.peek()
 
606
            if info is None:
 
607
                # Lock isn't held
 
608
                lock_token = None
 
609
            else:
 
610
                lock_token = info.get('nonce')
 
611
            if token != lock_token:
 
612
                raise errors.TokenMismatch(token, lock_token)
 
613
            else:
 
614
                self._trace("revalidated by token %r", token)
 
615
 
 
616
    def _trace(self, format, *args):
 
617
        if 'lock' not in debug.debug_flags:
 
618
            return
 
619
        mutter(str(self) + ": " + (format % args))